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

Class: Aws::RDS::Types::DBCluster

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

Overview

Contains the details of an Amazon Aurora DB cluster.

This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#activity_stream_kinesis_stream_name ⇒ String

The name of the Amazon Kinesis data stream used for the database activity stream.

Returns:

  • (String) —

    The name of the Amazon Kinesis data stream used for the database activity stream.

#activity_stream_kms_key_id ⇒ String

The AWS KMS key identifier used for encrypting messages in the database activity stream.

Returns:

  • (String) —

    The AWS KMS key identifier used for encrypting messages in the database activity stream.

#activity_stream_mode ⇒ String

The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

Possible values:

  • sync
  • async

Returns:

  • (String) —

    The mode of the database activity stream.

#activity_stream_status ⇒ String

The status of the database activity stream.

Possible values:

  • stopped
  • starting
  • started
  • stopping

Returns:

  • (String) —

    The status of the database activity stream.

#allocated_storage ⇒ Integer

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn\'t fixed, but instead automatically adjusts as needed.

Returns:

  • (Integer) —

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

#associated_roles ⇒ Array<Types::DBClusterRole>

Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

Returns:

  • (Array<Types::DBClusterRole>) —

    Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.

#availability_zones ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#backtrack_consumed_change_records ⇒ Integer

The number of change records stored for Backtrack.

Returns:

  • (Integer) —

    The number of change records stored for Backtrack.

#backtrack_window ⇒ Integer

The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

Returns:

  • (Integer) —

    The target backtrack window, in seconds.

#backup_retention_period ⇒ Integer

Specifies the number of days for which automatic DB snapshots are retained.

Returns:

  • (Integer) —

    Specifies the number of days for which automatic DB snapshots are retained.

#capacity ⇒ Integer

The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

Returns:

  • (Integer) —

    The current capacity of an Aurora Serverless DB cluster.

#character_set_name ⇒ String

If present, specifies the name of the character set that this cluster is associated with.

Returns:

  • (String) —

    If present, specifies the name of the character set that this cluster is associated with.

#clone_group_id ⇒ String

Identifies the clone group to which the DB cluster is associated.

Returns:

  • (String) —

    Identifies the clone group to which the DB cluster is associated.

#cluster_create_time ⇒ Time

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

Returns:

  • (Time) —

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

#copy_tags_to_snapshot ⇒ Boolean

Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

Returns:

  • (Boolean) —

    Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

#cross_account_clone ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#custom_endpoints ⇒ Array<String>

Identifies all custom endpoints associated with the cluster.

Returns:

  • (Array<String>) —

    Identifies all custom endpoints associated with the cluster.

#database_name ⇒ String

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

Returns:

  • (String) —

    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created.

#db_cluster_arn ⇒ String

The Amazon Resource Name (ARN) for the DB cluster.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) for the DB cluster.

#db_cluster_identifier ⇒ String

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

Returns:

  • (String) —

    Contains a user-supplied DB cluster identifier.

#db_cluster_members ⇒ Array<Types::DBClusterMember>

Provides the list of instances that make up the DB cluster.

Returns:

#db_cluster_option_group_memberships ⇒ Array<Types::DBClusterOptionGroupStatus>

Provides the list of option group memberships for this DB cluster.

Returns:

#db_cluster_parameter_group ⇒ String

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

Returns:

  • (String) —

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

#db_cluster_resource_id ⇒ String

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

Returns:

  • (String) —

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

#db_subnet_group ⇒ String

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

Returns:

  • (String) —

    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

#deletion_protection ⇒ Boolean

Indicates if the DB cluster has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled.

Returns:

  • (Boolean) —

    Indicates if the DB cluster has deletion protection enabled.

#domain_memberships ⇒ Array<Types::DomainMembership>

The Active Directory Domain membership records associated with the DB cluster.

Returns:

  • (Array<Types::DomainMembership>) —

    The Active Directory Domain membership records associated with the DB cluster.

#earliest_backtrack_time ⇒ Time

The earliest time to which a DB cluster can be backtracked.

Returns:

  • (Time) —

    The earliest time to which a DB cluster can be backtracked.

#earliest_restorable_time ⇒ Time

The earliest time to which a database can be restored with point-in-time restore.

Returns:

  • (Time) —

    The earliest time to which a database can be restored with point-in-time restore.

#enabled_cloudwatch_logs_exports ⇒ Array<String>

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

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.

Returns:

  • (Array<String>) —

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

#endpoint ⇒ String

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

Returns:

  • (String) —

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

#engine ⇒ String

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

Returns:

  • (String) —

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

#engine_mode ⇒ String

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Returns:

  • (String) —

    The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

#engine_version ⇒ String

Indicates the database engine version.

Returns:

  • (String) —

    Indicates the database engine version.

#global_write_forwarding_requested ⇒ Boolean

Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

Returns:

  • (Boolean) —

    Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database.

#global_write_forwarding_status ⇒ String

Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

Possible values:

  • enabled
  • disabled
  • enabling
  • disabling
  • unknown

Returns:

  • (String) —

    Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

#hosted_zone_id ⇒ String

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

Returns:

  • (String) —

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

#http_endpoint_enabled ⇒ Boolean

A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

Returns:

  • (Boolean) —

    A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

#iam_database_authentication_enabled ⇒ Boolean

A value that indicates whether the mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

Returns:

  • (Boolean) —

    A value that indicates whether the mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

#kms_key_id ⇒ String

If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.

Returns:

  • (String) —

    If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.

#latest_restorable_time ⇒ Time

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

Returns:

  • (Time) —

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

#master_username ⇒ String

Contains the master username for the DB cluster.

Returns:

  • (String) —

    Contains the master username for the DB cluster.

#multi_az ⇒ Boolean

Specifies whether the DB cluster has instances in multiple Availability Zones.

Returns:

  • (Boolean) —

    Specifies whether the DB cluster has instances in multiple Availability Zones.

#percent_progress ⇒ String

Specifies the progress of the operation as a percentage.

Returns:

  • (String) —

    Specifies the progress of the operation as a percentage.

#port ⇒ Integer

Specifies the port that the database engine is listening on.

Returns:

  • (Integer) —

    Specifies the port that the database engine is listening on.

#preferred_backup_window ⇒ String

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Returns:

  • (String) —

    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

#preferred_maintenance_window ⇒ String

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

Returns:

  • (String) —

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

#read_replica_identifiers ⇒ Array<String>

Contains one or more identifiers of the read replicas associated with this DB cluster.

Returns:

  • (Array<String>) —

    Contains one or more identifiers of the read replicas associated with this DB cluster.

#reader_endpoint ⇒ String

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

Returns:

  • (String) —

    The reader endpoint for the DB cluster.

#replication_source_identifier ⇒ String

Contains the identifier of the source DB cluster if this DB cluster is a read replica.

Returns:

  • (String) —

    Contains the identifier of the source DB cluster if this DB cluster is a read replica.

#scaling_configuration_info ⇒ Types::ScalingConfigurationInfo

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

Returns:

#status ⇒ String

Specifies the current state of this DB cluster.

Returns:

  • (String) —

    Specifies the current state of this DB cluster.

#storage_encrypted ⇒ Boolean

Specifies whether the DB cluster is encrypted.

Returns:

  • (Boolean) —

    Specifies whether the DB cluster is encrypted.

#tag_list ⇒ Array<Types::Tag>

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Returns:

#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>

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

Returns: