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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

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",
    },
  ],
}

Contains the details of an Amazon RDS DB instance.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#associated_rolesArray<Types::AwsRdsDbInstanceAssociatedRole>

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



2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2475

class AwsRdsDbInstanceDetails < Struct.new(
  :associated_roles,
  :ca_certificate_identifier,
  :db_cluster_identifier,
  :db_instance_identifier,
  :db_instance_class,
  :db_instance_port,
  :dbi_resource_id,
  :db_name,
  :deletion_protection,
  :endpoint,
  :engine,
  :engine_version,
  :iam_database_authentication_enabled,
  :instance_create_time,
  :kms_key_id,
  :publicly_accessible,
  :storage_encrypted,
  :tde_credential_arn,
  :vpc_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#ca_certificate_identifierString

The identifier of the CA certificate for this DB instance.

Returns:

  • (String)


2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2475

class AwsRdsDbInstanceDetails < Struct.new(
  :associated_roles,
  :ca_certificate_identifier,
  :db_cluster_identifier,
  :db_instance_identifier,
  :db_instance_class,
  :db_instance_port,
  :dbi_resource_id,
  :db_name,
  :deletion_protection,
  :endpoint,
  :engine,
  :engine_version,
  :iam_database_authentication_enabled,
  :instance_create_time,
  :kms_key_id,
  :publicly_accessible,
  :storage_encrypted,
  :tde_credential_arn,
  :vpc_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_identifierString

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)


2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2475

class AwsRdsDbInstanceDetails < Struct.new(
  :associated_roles,
  :ca_certificate_identifier,
  :db_cluster_identifier,
  :db_instance_identifier,
  :db_instance_class,
  :db_instance_port,
  :dbi_resource_id,
  :db_name,
  :deletion_protection,
  :endpoint,
  :engine,
  :engine_version,
  :iam_database_authentication_enabled,
  :instance_create_time,
  :kms_key_id,
  :publicly_accessible,
  :storage_encrypted,
  :tde_credential_arn,
  :vpc_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_classString

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

Returns:

  • (String)


2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2475

class AwsRdsDbInstanceDetails < Struct.new(
  :associated_roles,
  :ca_certificate_identifier,
  :db_cluster_identifier,
  :db_instance_identifier,
  :db_instance_class,
  :db_instance_port,
  :dbi_resource_id,
  :db_name,
  :deletion_protection,
  :endpoint,
  :engine,
  :engine_version,
  :iam_database_authentication_enabled,
  :instance_create_time,
  :kms_key_id,
  :publicly_accessible,
  :storage_encrypted,
  :tde_credential_arn,
  :vpc_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_identifierString

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

Returns:

  • (String)


2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2475

class AwsRdsDbInstanceDetails < Struct.new(
  :associated_roles,
  :ca_certificate_identifier,
  :db_cluster_identifier,
  :db_instance_identifier,
  :db_instance_class,
  :db_instance_port,
  :dbi_resource_id,
  :db_name,
  :deletion_protection,
  :endpoint,
  :engine,
  :engine_version,
  :iam_database_authentication_enabled,
  :instance_create_time,
  :kms_key_id,
  :publicly_accessible,
  :storage_encrypted,
  :tde_credential_arn,
  :vpc_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_portInteger

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)


2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2475

class AwsRdsDbInstanceDetails < Struct.new(
  :associated_roles,
  :ca_certificate_identifier,
  :db_cluster_identifier,
  :db_instance_identifier,
  :db_instance_class,
  :db_instance_port,
  :dbi_resource_id,
  :db_name,
  :deletion_protection,
  :endpoint,
  :engine,
  :engine_version,
  :iam_database_authentication_enabled,
  :instance_create_time,
  :kms_key_id,
  :publicly_accessible,
  :storage_encrypted,
  :tde_credential_arn,
  :vpc_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#db_nameString

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)


2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2475

class AwsRdsDbInstanceDetails < Struct.new(
  :associated_roles,
  :ca_certificate_identifier,
  :db_cluster_identifier,
  :db_instance_identifier,
  :db_instance_class,
  :db_instance_port,
  :dbi_resource_id,
  :db_name,
  :deletion_protection,
  :endpoint,
  :engine,
  :engine_version,
  :iam_database_authentication_enabled,
  :instance_create_time,
  :kms_key_id,
  :publicly_accessible,
  :storage_encrypted,
  :tde_credential_arn,
  :vpc_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#dbi_resource_idString

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)


2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2475

class AwsRdsDbInstanceDetails < Struct.new(
  :associated_roles,
  :ca_certificate_identifier,
  :db_cluster_identifier,
  :db_instance_identifier,
  :db_instance_class,
  :db_instance_port,
  :dbi_resource_id,
  :db_name,
  :deletion_protection,
  :endpoint,
  :engine,
  :engine_version,
  :iam_database_authentication_enabled,
  :instance_create_time,
  :kms_key_id,
  :publicly_accessible,
  :storage_encrypted,
  :tde_credential_arn,
  :vpc_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protectionBoolean

Indicates whether the DB instance has deletion protection enabled.

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

Returns:

  • (Boolean)


2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2475

class AwsRdsDbInstanceDetails < Struct.new(
  :associated_roles,
  :ca_certificate_identifier,
  :db_cluster_identifier,
  :db_instance_identifier,
  :db_instance_class,
  :db_instance_port,
  :dbi_resource_id,
  :db_name,
  :deletion_protection,
  :endpoint,
  :engine,
  :engine_version,
  :iam_database_authentication_enabled,
  :instance_create_time,
  :kms_key_id,
  :publicly_accessible,
  :storage_encrypted,
  :tde_credential_arn,
  :vpc_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#endpointTypes::AwsRdsDbInstanceEndpoint

Specifies the connection endpoint.



2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2475

class AwsRdsDbInstanceDetails < Struct.new(
  :associated_roles,
  :ca_certificate_identifier,
  :db_cluster_identifier,
  :db_instance_identifier,
  :db_instance_class,
  :db_instance_port,
  :dbi_resource_id,
  :db_name,
  :deletion_protection,
  :endpoint,
  :engine,
  :engine_version,
  :iam_database_authentication_enabled,
  :instance_create_time,
  :kms_key_id,
  :publicly_accessible,
  :storage_encrypted,
  :tde_credential_arn,
  :vpc_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#engineString

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

Returns:

  • (String)


2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2475

class AwsRdsDbInstanceDetails < Struct.new(
  :associated_roles,
  :ca_certificate_identifier,
  :db_cluster_identifier,
  :db_instance_identifier,
  :db_instance_class,
  :db_instance_port,
  :dbi_resource_id,
  :db_name,
  :deletion_protection,
  :endpoint,
  :engine,
  :engine_version,
  :iam_database_authentication_enabled,
  :instance_create_time,
  :kms_key_id,
  :publicly_accessible,
  :storage_encrypted,
  :tde_credential_arn,
  :vpc_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionString

Indicates the database engine version.

Returns:

  • (String)


2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2475

class AwsRdsDbInstanceDetails < Struct.new(
  :associated_roles,
  :ca_certificate_identifier,
  :db_cluster_identifier,
  :db_instance_identifier,
  :db_instance_class,
  :db_instance_port,
  :dbi_resource_id,
  :db_name,
  :deletion_protection,
  :endpoint,
  :engine,
  :engine_version,
  :iam_database_authentication_enabled,
  :instance_create_time,
  :kms_key_id,
  :publicly_accessible,
  :storage_encrypted,
  :tde_credential_arn,
  :vpc_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#iam_database_authentication_enabledBoolean

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)


2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2475

class AwsRdsDbInstanceDetails < Struct.new(
  :associated_roles,
  :ca_certificate_identifier,
  :db_cluster_identifier,
  :db_instance_identifier,
  :db_instance_class,
  :db_instance_port,
  :dbi_resource_id,
  :db_name,
  :deletion_protection,
  :endpoint,
  :engine,
  :engine_version,
  :iam_database_authentication_enabled,
  :instance_create_time,
  :kms_key_id,
  :publicly_accessible,
  :storage_encrypted,
  :tde_credential_arn,
  :vpc_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#instance_create_timeString

Provides the date and time the DB instance was created.

Returns:

  • (String)


2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2475

class AwsRdsDbInstanceDetails < Struct.new(
  :associated_roles,
  :ca_certificate_identifier,
  :db_cluster_identifier,
  :db_instance_identifier,
  :db_instance_class,
  :db_instance_port,
  :dbi_resource_id,
  :db_name,
  :deletion_protection,
  :endpoint,
  :engine,
  :engine_version,
  :iam_database_authentication_enabled,
  :instance_create_time,
  :kms_key_id,
  :publicly_accessible,
  :storage_encrypted,
  :tde_credential_arn,
  :vpc_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

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

Returns:

  • (String)


2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2475

class AwsRdsDbInstanceDetails < Struct.new(
  :associated_roles,
  :ca_certificate_identifier,
  :db_cluster_identifier,
  :db_instance_identifier,
  :db_instance_class,
  :db_instance_port,
  :dbi_resource_id,
  :db_name,
  :deletion_protection,
  :endpoint,
  :engine,
  :engine_version,
  :iam_database_authentication_enabled,
  :instance_create_time,
  :kms_key_id,
  :publicly_accessible,
  :storage_encrypted,
  :tde_credential_arn,
  :vpc_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessibleBoolean

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)


2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2475

class AwsRdsDbInstanceDetails < Struct.new(
  :associated_roles,
  :ca_certificate_identifier,
  :db_cluster_identifier,
  :db_instance_identifier,
  :db_instance_class,
  :db_instance_port,
  :dbi_resource_id,
  :db_name,
  :deletion_protection,
  :endpoint,
  :engine,
  :engine_version,
  :iam_database_authentication_enabled,
  :instance_create_time,
  :kms_key_id,
  :publicly_accessible,
  :storage_encrypted,
  :tde_credential_arn,
  :vpc_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#storage_encryptedBoolean

Specifies whether the DB instance is encrypted.

Returns:

  • (Boolean)


2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2475

class AwsRdsDbInstanceDetails < Struct.new(
  :associated_roles,
  :ca_certificate_identifier,
  :db_cluster_identifier,
  :db_instance_identifier,
  :db_instance_class,
  :db_instance_port,
  :dbi_resource_id,
  :db_name,
  :deletion_protection,
  :endpoint,
  :engine,
  :engine_version,
  :iam_database_authentication_enabled,
  :instance_create_time,
  :kms_key_id,
  :publicly_accessible,
  :storage_encrypted,
  :tde_credential_arn,
  :vpc_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#tde_credential_arnString

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

Returns:

  • (String)


2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2475

class AwsRdsDbInstanceDetails < Struct.new(
  :associated_roles,
  :ca_certificate_identifier,
  :db_cluster_identifier,
  :db_instance_identifier,
  :db_instance_class,
  :db_instance_port,
  :dbi_resource_id,
  :db_name,
  :deletion_protection,
  :endpoint,
  :engine,
  :engine_version,
  :iam_database_authentication_enabled,
  :instance_create_time,
  :kms_key_id,
  :publicly_accessible,
  :storage_encrypted,
  :tde_credential_arn,
  :vpc_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_groupsArray<Types::AwsRdsDbInstanceVpcSecurityGroup>

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



2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2475

class AwsRdsDbInstanceDetails < Struct.new(
  :associated_roles,
  :ca_certificate_identifier,
  :db_cluster_identifier,
  :db_instance_identifier,
  :db_instance_class,
  :db_instance_port,
  :dbi_resource_id,
  :db_name,
  :deletion_protection,
  :endpoint,
  :engine,
  :engine_version,
  :iam_database_authentication_enabled,
  :instance_create_time,
  :kms_key_id,
  :publicly_accessible,
  :storage_encrypted,
  :tde_credential_arn,
  :vpc_security_groups)
  SENSITIVE = []
  include Aws::Structure
end