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

Class: Aws::SecurityHub::Types::AwsRdsDbClusterDetails

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

Overview

Note:

When passing AwsRdsDbClusterDetails as input to an Aws::Client method, you can use a vanilla Hash:

{
  allocated_storage: 1,
  availability_zones: ["NonEmptyString"],
  backup_retention_period: 1,
  database_name: "NonEmptyString",
  status: "NonEmptyString",
  endpoint: "NonEmptyString",
  reader_endpoint: "NonEmptyString",
  custom_endpoints: ["NonEmptyString"],
  multi_az: false,
  engine: "NonEmptyString",
  engine_version: "NonEmptyString",
  port: 1,
  master_username: "NonEmptyString",
  preferred_backup_window: "NonEmptyString",
  preferred_maintenance_window: "NonEmptyString",
  read_replica_identifiers: ["NonEmptyString"],
  vpc_security_groups: [
    {
      vpc_security_group_id: "NonEmptyString",
      status: "NonEmptyString",
    },
  ],
  hosted_zone_id: "NonEmptyString",
  storage_encrypted: false,
  kms_key_id: "NonEmptyString",
  db_cluster_resource_id: "NonEmptyString",
  associated_roles: [
    {
      role_arn: "NonEmptyString",
      status: "NonEmptyString",
    },
  ],
  cluster_create_time: "NonEmptyString",
  enabled_cloud_watch_logs_exports: ["NonEmptyString"],
  engine_mode: "NonEmptyString",
  deletion_protection: false,
  http_endpoint_enabled: false,
  activity_stream_status: "NonEmptyString",
  copy_tags_to_snapshot: false,
  cross_account_clone: false,
  domain_memberships: [
    {
      domain: "NonEmptyString",
      status: "NonEmptyString",
      fqdn: "NonEmptyString",
      iam_role_name: "NonEmptyString",
    },
  ],
  db_cluster_parameter_group: "NonEmptyString",
  db_subnet_group: "NonEmptyString",
  db_cluster_option_group_memberships: [
    {
      db_cluster_option_group_name: "NonEmptyString",
      status: "NonEmptyString",
    },
  ],
  db_cluster_identifier: "NonEmptyString",
  db_cluster_members: [
    {
      is_cluster_writer: false,
      promotion_tier: 1,
      db_instance_identifier: "NonEmptyString",
      db_cluster_parameter_group_status: "NonEmptyString",
    },
  ],
  iam_database_authentication_enabled: false,
}

Information about an Amazon RDS DB cluster.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#activity_stream_status ⇒ String

The status of the database activity stream.

Returns:

  • (String) —

    The status of the database activity stream.

#allocated_storage ⇒ Integer

For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).

Returns:

  • (Integer) —

    For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).

#associated_roles ⇒ Array<Types::AwsRdsDbClusterAssociatedRole>

A list of the IAM roles that are associated with the DB cluster.

Returns:

#availability_zones ⇒ Array<String>

A list of Availability Zones (AZs) where instances in the DB cluster can be created.

Returns:

  • (Array<String>) —

    A list of Availability Zones (AZs) where instances in the DB cluster can be created.

#backup_retention_period ⇒ Integer

The number of days for which automated backups are retained.

Returns:

  • (Integer) —

    The number of days for which automated backups are retained.

#cluster_create_time ⇒ String

Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).

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 cluster was created, in Universal Coordinated Time (UTC).

#copy_tags_to_snapshot ⇒ Boolean

Whether tags are copied from the DB cluster to snapshots of the DB cluster.

Returns:

  • (Boolean) —

    Whether tags are copied from the DB cluster to snapshots of the DB cluster.

#cross_account_clone ⇒ Boolean

Whether the DB cluster is a clone of a DB cluster owned by a different AWS account.

Returns:

  • (Boolean) —

    Whether the DB cluster is a clone of a DB cluster owned by a different AWS account.

#custom_endpoints ⇒ Array<String>

A list of custom endpoints for the DB cluster.

Returns:

  • (Array<String>) —

    A list of custom endpoints for the DB cluster.

#database_name ⇒ String

The name of the database.

Returns:

  • (String) —

    The name of the database.

#db_cluster_identifier ⇒ String

The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster.

Returns:

  • (String) —

    The DB cluster identifier that the user assigned to the cluster.

#db_cluster_members ⇒ Array<Types::AwsRdsDbClusterMember>

The list of instances that make up the DB cluster.

Returns:

#db_cluster_option_group_memberships ⇒ Array<Types::AwsRdsDbClusterOptionGroupMembership>

The list of option group memberships for this DB cluster.

Returns:

#db_cluster_parameter_group ⇒ String

The name of the DB cluster parameter group for the DB cluster.

Returns:

  • (String) —

    The name of the DB cluster parameter group for the DB cluster.

#db_cluster_resource_id ⇒ String

The identifier of the DB cluster. The identifier must be unique within each AWS Region and is immutable.

Returns:

  • (String) —

    The identifier of the DB cluster.

#db_subnet_group ⇒ String

The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.

Returns:

  • (String) —

    The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.

#deletion_protection ⇒ Boolean

Whether the DB cluster has deletion protection enabled.

Returns:

  • (Boolean) —

    Whether the DB cluster has deletion protection enabled.

#domain_memberships ⇒ Array<Types::AwsRdsDbDomainMembership>

The Active Directory domain membership records that are associated with the DB cluster.

Returns:

#enabled_cloud_watch_logs_exports ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#endpoint ⇒ String

The connection endpoint for the primary instance of the DB cluster.

Returns:

  • (String) —

    The connection endpoint for the primary instance of the DB cluster.

#engine ⇒ String

The name of the database engine to use for this DB cluster.

Returns:

  • (String) —

    The name of the database engine to use for this DB cluster.

#engine_mode ⇒ String

The database engine mode of the DB cluster.

Returns:

  • (String) —

    The database engine mode of the DB cluster.

#engine_version ⇒ String

The version number of the database engine to use.

Returns:

  • (String) —

    The version number of the database engine to use.

#hosted_zone_id ⇒ String

Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone.

Returns:

  • (String) —

    Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone.

#http_endpoint_enabled ⇒ Boolean

Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

Returns:

  • (Boolean) —

    Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

#iam_database_authentication_enabled ⇒ Boolean

Whether the mapping of IAM accounts to database accounts is enabled.

Returns:

  • (Boolean) —

    Whether the mapping of IAM accounts to database accounts is enabled.

#kms_key_id ⇒ String

The ARN of the AWS KMS master key that is used to encrypt the database instances in the DB cluster.

Returns:

  • (String) —

    The ARN of the AWS KMS master key that is used to encrypt the database instances in the DB cluster.

#master_username ⇒ String

The name of the master user for the DB cluster.

Returns:

  • (String) —

    The name of the master user for the DB cluster.

#multi_az ⇒ Boolean

Whether the DB cluster has instances in multiple Availability Zones.

Returns:

  • (Boolean) —

    Whether the DB cluster has instances in multiple Availability Zones.

#port ⇒ Integer

The port number on which the DB instances in the DB cluster accept connections.

Returns:

  • (Integer) —

    The port number on which the DB instances in the DB cluster accept connections.

#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).

#read_replica_identifiers ⇒ Array<String>

The identifiers of the read replicas that are associated with this DB cluster.

Returns:

  • (Array<String>) —

    The identifiers of the read replicas that are associated with this DB cluster.

#reader_endpoint ⇒ String

The reader endpoint for the DB cluster.

Returns:

  • (String) —

    The reader endpoint for the DB cluster.

#status ⇒ String

The current status of this DB cluster.

Returns:

  • (String) —

    The current status of this DB cluster.

#storage_encrypted ⇒ Boolean

Whether the DB cluster is encrypted.

Returns:

  • (Boolean) —

    Whether the DB cluster is encrypted.

#vpc_security_groups ⇒ Array<Types::AwsRdsDbInstanceVpcSecurityGroup>

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

Returns: