class Aws::SecurityHub::Types::AwsRdsDbInstanceDetails

Contains the details of an Amazon RDS DB instance.

@note When making an API call, you may pass AwsRdsDbInstanceDetails

data as a hash:

    {
      associated_roles: [
        {
          role_arn: "NonEmptyString",
          feature_name: "NonEmptyString",
          status: "NonEmptyString",
        },
      ],
      ca_certificate_identifier: "NonEmptyString",
      db_cluster_identifier: "NonEmptyString",
      db_instance_identifier: "NonEmptyString",
      db_instance_class: "NonEmptyString",
      db_instance_port: 1,
      dbi_resource_id: "NonEmptyString",
      db_name: "NonEmptyString",
      deletion_protection: false,
      endpoint: {
        address: "NonEmptyString",
        port: 1,
        hosted_zone_id: "NonEmptyString",
      },
      engine: "NonEmptyString",
      engine_version: "NonEmptyString",
      iam_database_authentication_enabled: false,
      instance_create_time: "NonEmptyString",
      kms_key_id: "NonEmptyString",
      publicly_accessible: false,
      storage_encrypted: false,
      tde_credential_arn: "NonEmptyString",
      vpc_security_groups: [
        {
          vpc_security_group_id: "NonEmptyString",
          status: "NonEmptyString",
        },
      ],
      multi_az: false,
      enhanced_monitoring_resource_arn: "NonEmptyString",
      db_instance_status: "NonEmptyString",
      master_username: "NonEmptyString",
      allocated_storage: 1,
      preferred_backup_window: "NonEmptyString",
      backup_retention_period: 1,
      db_security_groups: ["NonEmptyString"],
      db_parameter_groups: [
        {
          db_parameter_group_name: "NonEmptyString",
          parameter_apply_status: "NonEmptyString",
        },
      ],
      availability_zone: "NonEmptyString",
      db_subnet_group: {
        db_subnet_group_name: "NonEmptyString",
        db_subnet_group_description: "NonEmptyString",
        vpc_id: "NonEmptyString",
        subnet_group_status: "NonEmptyString",
        subnets: [
          {
            subnet_identifier: "NonEmptyString",
            subnet_availability_zone: {
              name: "NonEmptyString",
            },
            subnet_status: "NonEmptyString",
          },
        ],
        db_subnet_group_arn: "NonEmptyString",
      },
      preferred_maintenance_window: "NonEmptyString",
      pending_modified_values: {
        db_instance_class: "NonEmptyString",
        allocated_storage: 1,
        master_user_password: "NonEmptyString",
        port: 1,
        backup_retention_period: 1,
        multi_az: false,
        engine_version: "NonEmptyString",
        license_model: "NonEmptyString",
        iops: 1,
        db_instance_identifier: "NonEmptyString",
        storage_type: "NonEmptyString",
        ca_certificate_identifier: "NonEmptyString",
        db_subnet_group_name: "NonEmptyString",
        pending_cloud_watch_logs_exports: {
          log_types_to_enable: ["NonEmptyString"],
          log_types_to_disable: ["NonEmptyString"],
        },
        processor_features: [
          {
            name: "NonEmptyString",
            value: "NonEmptyString",
          },
        ],
      },
      latest_restorable_time: "NonEmptyString",
      auto_minor_version_upgrade: false,
      read_replica_source_db_instance_identifier: "NonEmptyString",
      read_replica_db_instance_identifiers: ["NonEmptyString"],
      read_replica_db_cluster_identifiers: ["NonEmptyString"],
      license_model: "NonEmptyString",
      iops: 1,
      option_group_memberships: [
        {
          option_group_name: "NonEmptyString",
          status: "NonEmptyString",
        },
      ],
      character_set_name: "NonEmptyString",
      secondary_availability_zone: "NonEmptyString",
      status_infos: [
        {
          status_type: "NonEmptyString",
          normal: false,
          status: "NonEmptyString",
          message: "NonEmptyString",
        },
      ],
      storage_type: "NonEmptyString",
      domain_memberships: [
        {
          domain: "NonEmptyString",
          status: "NonEmptyString",
          fqdn: "NonEmptyString",
          iam_role_name: "NonEmptyString",
        },
      ],
      copy_tags_to_snapshot: false,
      monitoring_interval: 1,
      monitoring_role_arn: "NonEmptyString",
      promotion_tier: 1,
      timezone: "NonEmptyString",
      performance_insights_enabled: false,
      performance_insights_kms_key_id: "NonEmptyString",
      performance_insights_retention_period: 1,
      enabled_cloud_watch_logs_exports: ["NonEmptyString"],
      processor_features: [
        {
          name: "NonEmptyString",
          value: "NonEmptyString",
        },
      ],
      listener_endpoint: {
        address: "NonEmptyString",
        port: 1,
        hosted_zone_id: "NonEmptyString",
      },
      max_allocated_storage: 1,
    }

@!attribute [rw] associated_roles

The IAM roles associated with the DB instance.
@return [Array<Types::AwsRdsDbInstanceAssociatedRole>]

@!attribute [rw] ca_certificate_identifier

The identifier of the CA certificate for this DB instance.
@return [String]

@!attribute [rw] db_cluster_identifier

If the DB instance is a member of a DB cluster, contains the name of
the DB cluster that the DB instance is a member of.
@return [String]

@!attribute [rw] db_instance_identifier

Contains a user-supplied database identifier. This identifier is the
unique key that identifies a DB instance.
@return [String]

@!attribute [rw] db_instance_class

Contains the name of the compute and memory capacity class of the DB
instance.
@return [String]

@!attribute [rw] db_instance_port

Specifies the port that the DB instance listens on. If the DB
instance is part of a DB cluster, this can be a different port than
the DB cluster port.
@return [Integer]

@!attribute [rw] dbi_resource_id

The Amazon Web Services Region-unique, immutable identifier for the
DB instance. This identifier is found in CloudTrail log entries
whenever the KMS key for the DB instance is accessed.
@return [String]

@!attribute [rw] db_name

The meaning of this parameter differs according to the database
engine you use.

**MySQL, MariaDB, SQL Server, PostgreSQL**

Contains the name of the initial database of this instance that was
provided at create time, if one was specified when the DB instance
was created. This same name is returned for the life of the DB
instance.

**Oracle**

Contains the Oracle System ID (SID) of the created DB instance. Not
shown when the returned parameters do not apply to an Oracle DB
instance.
@return [String]

@!attribute [rw] deletion_protection

Indicates whether the DB instance has deletion protection enabled.

When deletion protection is enabled, the database cannot be deleted.
@return [Boolean]

@!attribute [rw] endpoint

Specifies the connection endpoint.
@return [Types::AwsRdsDbInstanceEndpoint]

@!attribute [rw] engine

Provides the name of the database engine to use for this DB
instance.
@return [String]

@!attribute [rw] engine_version

Indicates the database engine version.
@return [String]

@!attribute [rw] iam_database_authentication_enabled

True if mapping of IAM accounts to database accounts is enabled, and
otherwise false.

IAM database authentication can be enabled for the following
database engines.

* For MySQL 5.6, minor version 5.6.34 or higher

* For MySQL 5.7, minor version 5.7.16 or higher

* Aurora 5.6 or higher
@return [Boolean]

@!attribute [rw] instance_create_time

Indicates when the DB instance was created.

Uses the `date-time` format specified in [RFC 3339 section 5.6,
Internet Date/Time Format][1]. The value cannot contain spaces. For
example, `2020-03-22T13:22:13.933Z`.

[1]: https://tools.ietf.org/html/rfc3339#section-5.6
@return [String]

@!attribute [rw] kms_key_id

If `StorageEncrypted` is true, the KMS key identifier for the
encrypted DB instance.
@return [String]

@!attribute [rw] publicly_accessible

Specifies the accessibility options for the DB instance.

A value of true specifies an Internet-facing instance with a
publicly resolvable DNS name, which resolves to a public IP address.

A value of false specifies an internal instance with a DNS name that
resolves to a private IP address.
@return [Boolean]

@!attribute [rw] storage_encrypted

Specifies whether the DB instance is encrypted.
@return [Boolean]

@!attribute [rw] tde_credential_arn

The ARN from the key store with which the instance is associated for
TDE encryption.
@return [String]

@!attribute [rw] vpc_security_groups

A list of VPC security groups that the DB instance belongs to.
@return [Array<Types::AwsRdsDbInstanceVpcSecurityGroup>]

@!attribute [rw] multi_az

Whether the DB instance is a multiple Availability Zone deployment.
@return [Boolean]

@!attribute [rw] enhanced_monitoring_resource_arn

The ARN of the CloudWatch Logs log stream that receives the enhanced
monitoring metrics data for the DB instance.
@return [String]

@!attribute [rw] db_instance_status

The current status of the DB instance.
@return [String]

@!attribute [rw] master_username

The master user name of the DB instance.
@return [String]

@!attribute [rw] allocated_storage

The amount of storage (in gigabytes) to initially allocate for the
DB instance.
@return [Integer]

@!attribute [rw] preferred_backup_window

The range of time each day when automated backups are created, if
automated backups are enabled.

Uses the format `HH:MM-HH:MM`. For example, `04:52-05:22`.
@return [String]

@!attribute [rw] backup_retention_period

The number of days for which to retain automated backups.
@return [Integer]

@!attribute [rw] db_security_groups

A list of the DB security groups to assign to the DB instance.
@return [Array<String>]

@!attribute [rw] db_parameter_groups

A list of the DB parameter groups to assign to the DB instance.
@return [Array<Types::AwsRdsDbParameterGroup>]

@!attribute [rw] availability_zone

The Availability Zone where the DB instance will be created.
@return [String]

@!attribute [rw] db_subnet_group

Information about the subnet group that is associated with the DB
instance.
@return [Types::AwsRdsDbSubnetGroup]

@!attribute [rw] preferred_maintenance_window

The weekly time range during which system maintenance can occur, in
Universal Coordinated Time (UTC).

Uses the format `<day>:HH:MM-<day>:HH:MM`.

For the day values, use
`mon`\|`tue`\|`wed`\|`thu`\|`fri`\|`sat`\|`sun`.

For example, `sun:09:32-sun:10:02`.
@return [String]

@!attribute [rw] pending_modified_values

Changes to the DB instance that are currently pending.
@return [Types::AwsRdsDbPendingModifiedValues]

@!attribute [rw] latest_restorable_time

Specifies the latest time to which a database can be restored with
point-in-time restore.

Uses the `date-time` format specified in [RFC 3339 section 5.6,
Internet Date/Time Format][1]. The value cannot contain spaces. For
example, `2020-03-22T13:22:13.933Z`.

[1]: https://tools.ietf.org/html/rfc3339#section-5.6
@return [String]

@!attribute [rw] auto_minor_version_upgrade

Indicates whether minor version patches are applied automatically.
@return [Boolean]

@!attribute [rw] read_replica_source_db_instance_identifier

If this DB instance is a read replica, contains the identifier of
the source DB instance.
@return [String]

@!attribute [rw] read_replica_db_instance_identifiers

List of identifiers of the read replicas associated with this DB
instance.
@return [Array<String>]

@!attribute [rw] read_replica_db_cluster_identifiers

List of identifiers of Aurora DB clusters to which the RDS DB
instance is replicated as a read replica.
@return [Array<String>]

@!attribute [rw] license_model

License model information for this DB instance.
@return [String]

@!attribute [rw] iops

Specifies the provisioned IOPS (I/O operations per second) for this
DB instance.
@return [Integer]

@!attribute [rw] option_group_memberships

The list of option group memberships for this DB instance.
@return [Array<Types::AwsRdsDbOptionGroupMembership>]

@!attribute [rw] character_set_name

The name of the character set that this DB instance is associated
with.
@return [String]

@!attribute [rw] secondary_availability_zone

For a DB instance with multi-Availability Zone support, the name of
the secondary Availability Zone.
@return [String]

@!attribute [rw] status_infos

The status of a read replica. If the instance isn't a read replica,
this is empty.
@return [Array<Types::AwsRdsDbStatusInfo>]

@!attribute [rw] storage_type

The storage type for the DB instance.
@return [String]

@!attribute [rw] domain_memberships

The Active Directory domain membership records associated with the
DB instance.
@return [Array<Types::AwsRdsDbDomainMembership>]

@!attribute [rw] copy_tags_to_snapshot

Whether to copy resource tags to snapshots of the DB instance.
@return [Boolean]

@!attribute [rw] monitoring_interval

The interval, in seconds, between points when enhanced monitoring
metrics are collected for the DB instance.
@return [Integer]

@!attribute [rw] monitoring_role_arn

The ARN for the IAM role that permits Amazon RDS to send enhanced
monitoring metrics to CloudWatch Logs.
@return [String]

@!attribute [rw] promotion_tier

The order in which to promote an Aurora replica to the primary
instance after a failure of the existing primary instance.
@return [Integer]

@!attribute [rw] timezone

The time zone of the DB instance.
@return [String]

@!attribute [rw] performance_insights_enabled

Indicates whether Performance Insights is enabled for the DB
instance.
@return [Boolean]

@!attribute [rw] performance_insights_kms_key_id

The identifier of the KMS key used to encrypt the Performance
Insights data.
@return [String]

@!attribute [rw] performance_insights_retention_period

The number of days to retain Performance Insights data.
@return [Integer]

@!attribute [rw] enabled_cloud_watch_logs_exports

A list of log types that this DB instance is configured to export to
CloudWatch Logs.
@return [Array<String>]

@!attribute [rw] processor_features

The number of CPU cores and the number of threads per core for the
DB instance class of the DB instance.
@return [Array<Types::AwsRdsDbProcessorFeature>]

@!attribute [rw] listener_endpoint

Specifies the connection endpoint.
@return [Types::AwsRdsDbInstanceEndpoint]

@!attribute [rw] max_allocated_storage

The upper limit to which Amazon RDS can automatically scale the
storage of the DB instance.
@return [Integer]

@see docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AwsRdsDbInstanceDetails AWS API Documentation

Constants

SENSITIVE