You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SecurityHub::Types::AwsRdsDbInstanceDetails

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AwsRdsDbInstanceDetails as input to an Aws::Client method, you can use a vanilla 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,
}

Contains the details of an Amazon RDS DB instance.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storage ⇒ Integer

The amount of storage (in gigabytes) to initially allocate for the DB instance.

Returns:

  • (Integer) —

    The amount of storage (in gigabytes) to initially allocate for the DB instance.

#associated_roles ⇒ Array<Types::AwsRdsDbInstanceAssociatedRole>

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

Returns:

#auto_minor_version_upgrade ⇒ Boolean

Indicates whether minor version patches are applied automatically.

Returns:

  • (Boolean) —

    Indicates whether minor version patches are applied automatically.

#availability_zone ⇒ String

The Availability Zone where the DB instance will be created.

Returns:

  • (String) —

    The Availability Zone where the DB instance will be created.

#backup_retention_period ⇒ Integer

The number of days for which to retain automated backups.

Returns:

  • (Integer) —

    The number of days for which to retain automated backups.

#ca_certificate_identifier ⇒ String

The identifier of the CA certificate for this DB instance.

Returns:

  • (String) —

    The identifier of the CA certificate for this DB instance.

#character_set_name ⇒ String

The name of the character set that this DB instance is associated with.

Returns:

  • (String) —

    The name of the character set that this DB instance is associated with.

#copy_tags_to_snapshot ⇒ Boolean

Whether to copy resource tags to snapshots of the DB instance.

Returns:

  • (Boolean) —

    Whether to copy resource tags to snapshots of the DB instance.

#db_cluster_identifier ⇒ String

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.

Returns:

  • (String) —

    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.

#db_instance_class ⇒ String

Contains the name of the compute and memory capacity class of the DB instance.

Returns:

  • (String) —

    Contains the name of the compute and memory capacity class of the DB instance.

#db_instance_identifier ⇒ String

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

Returns:

  • (String) —

    Contains a user-supplied database identifier.

#db_instance_port ⇒ Integer

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.

Returns:

  • (Integer) —

    Specifies the port that the DB instance listens on.

#db_instance_status ⇒ String

The current status of the DB instance.

Returns:

  • (String) —

    The current status of the DB instance.

#db_name ⇒ String

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.

Returns:

  • (String) —

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

#db_parameter_groups ⇒ Array<Types::AwsRdsDbParameterGroup>

A list of the DB parameter groups to assign to the DB instance.

Returns:

#db_security_groups ⇒ Array<String>

A list of the DB security groups to assign to the DB instance.

Returns:

  • (Array<String>) —

    A list of the DB security groups to assign to the DB instance.

#db_subnet_group ⇒ Types::AwsRdsDbSubnetGroup

Information about the subnet group that is associated with the DB instance.

Returns:

#dbi_resource_id ⇒ String

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

Returns:

  • (String) —

    The AWS Region-unique, immutable identifier for the DB instance.

#deletion_protection ⇒ Boolean

Indicates whether the DB instance has deletion protection enabled.

When deletion protection is enabled, the database cannot be deleted.

Returns:

  • (Boolean) —

    Indicates whether the DB instance has deletion protection enabled.

#domain_memberships ⇒ Array<Types::AwsRdsDbDomainMembership>

The Active Directory domain membership records associated with the DB instance.

Returns:

#enabled_cloud_watch_logs_exports ⇒ Array<String>

A list of log types that this DB instance is configured to export to CloudWatch Logs.

Returns:

  • (Array<String>) —

    A list of log types that this DB instance is configured to export to CloudWatch Logs.

#endpoint ⇒ Types::AwsRdsDbInstanceEndpoint

Specifies the connection endpoint.

Returns:

#engine ⇒ String

Provides the name of the database engine to use for this DB instance.

Returns:

  • (String) —

    Provides the name of the database engine to use for this DB instance.

#engine_version ⇒ String

Indicates the database engine version.

Returns:

  • (String) —

    Indicates the database engine version.

#enhanced_monitoring_resource_arn ⇒ String

The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.

Returns:

  • (String) —

    The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.

#iam_database_authentication_enabled ⇒ Boolean

True if mapping of AWS Identity and Access Management (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

Returns:

  • (Boolean) —

    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

#instance_create_time ⇒ String

Indicates when the DB instance was created.

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

Returns:

  • (String) —

    Indicates when the DB instance was created.

#iops ⇒ Integer

Specifies the provisioned IOPS (I/O operations per second) for this DB instance.

Returns:

  • (Integer) —

    Specifies the provisioned IOPS (I/O operations per second) for this DB instance.

#kms_key_id ⇒ String

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.

Returns:

  • (String) —

    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.

#latest_restorable_time ⇒ String

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. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Returns:

  • (String) —

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

#license_model ⇒ String

License model information for this DB instance.

Returns:

  • (String) —

    License model information for this DB instance.

#listener_endpoint ⇒ Types::AwsRdsDbInstanceEndpoint

Specifies the connection endpoint.

Returns:

#master_username ⇒ String

The master user name of the DB instance.

Returns:

  • (String) —

    The master user name of the DB instance.

#max_allocated_storage ⇒ Integer

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

Returns:

  • (Integer) —

    The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

#monitoring_interval ⇒ Integer

The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.

Returns:

  • (Integer) —

    The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.

#monitoring_role_arn ⇒ String

The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.

Returns:

  • (String) —

    The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.

#multi_az ⇒ Boolean

Whether the DB instance is a multiple Availability Zone deployment.

Returns:

  • (Boolean) —

    Whether the DB instance is a multiple Availability Zone deployment.

#option_group_memberships ⇒ Array<Types::AwsRdsDbOptionGroupMembership>

The list of option group memberships for this DB instance.

Returns:

#pending_modified_values ⇒ Types::AwsRdsDbPendingModifiedValues

Changes to the DB instance that are currently pending.

Returns:

#performance_insights_enabled ⇒ Boolean

Indicates whether Performance Insights is enabled for the DB instance.

Returns:

  • (Boolean) —

    Indicates whether Performance Insights is enabled for the DB instance.

#performance_insights_kms_key_id ⇒ String

The identifier of the AWS KMS key used to encrypt the Performance Insights data.

Returns:

  • (String) —

    The identifier of the AWS KMS key used to encrypt the Performance Insights data.

#performance_insights_retention_period ⇒ Integer

The number of days to retain Performance Insights data.

Returns:

  • (Integer) —

    The number of days to retain Performance Insights data.

#preferred_backup_window ⇒ String

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.

Returns:

  • (String) —

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

#preferred_maintenance_window ⇒ String

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.

Returns:

  • (String) —

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

#processor_features ⇒ Array<Types::AwsRdsDbProcessorFeature>

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Returns:

#promotion_tier ⇒ Integer

The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.

Returns:

  • (Integer) —

    The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.

#publicly_accessible ⇒ Boolean

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.

Returns:

  • (Boolean) —

    Specifies the accessibility options for the DB instance.

#read_replica_db_cluster_identifiers ⇒ Array<String>

List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.

Returns:

  • (Array<String>) —

    List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.

#read_replica_db_instance_identifiers ⇒ Array<String>

List of identifiers of the read replicas associated with this DB instance.

Returns:

  • (Array<String>) —

    List of identifiers of the read replicas associated with this DB instance.

#read_replica_source_db_instance_identifier ⇒ String

If this DB instance is a read replica, contains the identifier of the source DB instance.

Returns:

  • (String) —

    If this DB instance is a read replica, contains the identifier of the source DB instance.

#secondary_availability_zone ⇒ String

For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.

Returns:

  • (String) —

    For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.

#status_infos ⇒ Array<Types::AwsRdsDbStatusInfo>

The status of a read replica. If the instance isn\'t a read replica, this is empty.

Returns:

#storage_encrypted ⇒ Boolean

Specifies whether the DB instance is encrypted.

Returns:

  • (Boolean) —

    Specifies whether the DB instance is encrypted.

#storage_type ⇒ String

The storage type for the DB instance.

Returns:

  • (String) —

    The storage type for the DB instance.

#tde_credential_arn ⇒ String

The ARN from the key store with which the instance is associated for TDE encryption.

Returns:

  • (String) —

    The ARN from the key store with which the instance is associated for TDE encryption.

#timezone ⇒ String

The time zone of the DB instance.

Returns:

  • (String) —

    The time zone of the DB instance.

#vpc_security_groups ⇒ Array<Types::AwsRdsDbInstanceVpcSecurityGroup>

A list of VPC security groups that the DB instance belongs to.

Returns: