Class: Aws::RDS::DBCluster

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, options = {}) ⇒ DBCluster #initialize(options = {}) ⇒ DBCluster

Returns a new instance of DBCluster.

Overloads:

  • #initialize(id, options = {}) ⇒ DBCluster

    Parameters:

    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ DBCluster

    Options Hash (options):

    • :id (required, String)
    • :client (Client) 


22
23
24
25
26
27
28
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @id = extract_id(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#activity_stream_kinesis_stream_name ⇒ String

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

Returns:

  • (String) 


414
415
416
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 414

def activity_stream_kinesis_stream_name
  data[:activity_stream_kinesis_stream_name]
end

#activity_stream_kms_key_id ⇒ String

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

Returns:

  • (String) 


407
408
409
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 407

def activity_stream_kms_key_id
  data[:activity_stream_kms_key_id]
end

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

Returns:

  • (String) 


394
395
396
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 394

def activity_stream_mode
  data[:activity_stream_mode]
end

#activity_stream_status ⇒ String

The status of the database activity stream.

Returns:

  • (String) 


400
401
402
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 400

def activity_stream_status
  data[:activity_stream_status]
end

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


43
44
45
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 43

def allocated_storage
  data[:allocated_storage]
end

#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:



263
264
265
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 263

def associated_roles
  data[:associated_roles]
end

#availability_zones ⇒ Array<String>

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

Returns:

  • (Array<String>) 


50
51
52
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 50

def availability_zones
  data[:availability_zones]
end

#backtrack_consumed_change_records ⇒ Integer

The number of change records stored for Backtrack.

Returns:

  • (Integer) 


303
304
305
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 303

def backtrack_consumed_change_records
  data[:backtrack_consumed_change_records]
end

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


297
298
299
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 297

def backtrack_window
  data[:backtrack_window]
end

#backup_retention_period ⇒ Integer

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

Returns:

  • (Integer) 


57
58
59
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 57

def backup_retention_period
  data[:backup_retention_period]
end

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


332
333
334
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 332

def capacity
  data[:capacity]
end

#character_set_name ⇒ String

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

Returns:

  • (String) 


64
65
66
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 64

def character_set_name
  data[:character_set_name]
end

#client ⇒ Client

Returns:



471
472
473
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 471

def client
  @client
end

#clone_group_id ⇒ String

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

Returns:

  • (String) 


276
277
278
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 276

def clone_group_id
  data[:clone_group_id]
end

#cluster_create_time ⇒ Time

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

Returns:

  • (Time) 


283
284
285
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 283

def cluster_create_time
  data[:cluster_create_time]
end

#copy_tags_to_snapshot ⇒ Boolean

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

Returns:

  • (Boolean) 


421
422
423
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 421

def copy_tags_to_snapshot
  data[:copy_tags_to_snapshot]
end

#create(options = {}) ⇒ DBCluster

Examples:

Request syntax with placeholder values


dbcluster = db_cluster.create({
  availability_zones: ["String"],
  backup_retention_period: 1,
  character_set_name: "String",
  database_name: "String",
  db_cluster_parameter_group_name: "String",
  vpc_security_group_ids: ["String"],
  db_subnet_group_name: "String",
  engine: "String", # required
  engine_version: "String",
  port: 1,
  master_username: "String",
  master_user_password: "String",
  option_group_name: "String",
  preferred_backup_window: "String",
  preferred_maintenance_window: "String",
  replication_source_identifier: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  storage_encrypted: false,
  kms_key_id: "String",
  pre_signed_url: "String",
  enable_iam_database_authentication: false,
  backtrack_window: 1,
  enable_cloudwatch_logs_exports: ["String"],
  engine_mode: "String",
  scaling_configuration: {
    min_capacity: 1,
    max_capacity: 1,
    auto_pause: false,
    seconds_until_auto_pause: 1,
    timeout_action: "String",
  },
  deletion_protection: false,
  global_cluster_identifier: "String",
  enable_http_endpoint: false,
  copy_tags_to_snapshot: false,
  domain: "String",
  domain_iam_role_name: "String",
  enable_global_write_forwarding: false,
  source_region: "String",
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :availability_zones (Array<String>) —

    A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

  • :backup_retention_period (Integer) —

    The number of days for which automated backups are retained.

    Default: 1

    Constraints:

    • Must be a value from 1 to 35

    ^

  • :character_set_name (String) —

    A value that indicates that the DB cluster should be associated with the specified CharacterSet.

  • :database_name (String) —

    The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.

  • :db_cluster_parameter_group_name (String) —

    The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.

    Constraints:

    • If supplied, must match the name of an existing DB cluster parameter group.

    ^

  • :vpc_security_group_ids (Array<String>) —

    A list of EC2 VPC security groups to associate with this DB cluster.

  • :db_subnet_group_name (String) —

    A DB subnet group to associate with this DB cluster.

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    Example: mySubnetgroup

  • :engine (required, String) —

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

    Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

  • :engine_version (String) —

    The version number of the database engine to use.

    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

    aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"

    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

    aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

    To list all of the available engine versions for aurora-postgresql, use the following command:

    aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"

    Aurora MySQL

    Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5

    Aurora PostgreSQL

    Example: 9.6.3, 10.7

  • :port (Integer) —

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

    Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

  • :master_username (String) —

    The name of the master user for the DB cluster.

    Constraints:

    • Must be 1 to 16 letters or numbers.

    • First character must be a letter.

    • Can't be a reserved word for the chosen database engine.

  • :master_user_password (String) —

    The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

    Constraints: Must contain from 8 to 41 characters.

  • :option_group_name (String) —

    A value that indicates that the DB cluster should be associated with the specified option group.

    Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

  • :preferred_backup_window (String) —

    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

    Constraints:

    • Must be in the format hh24:mi-hh24:mi.

    • Must be in Universal Coordinated Time (UTC).

    • Must not conflict with the preferred maintenance window.

    • Must be at least 30 minutes.

  • :preferred_maintenance_window (String) —

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

    Format: ddd:hh24:mi-ddd:hh24:mi

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    Constraints: Minimum 30-minute window.

  • :replication_source_identifier (String) —

    The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

  • :tags (Array<Types::Tag>) —

    Tags to assign to the DB cluster.

  • :storage_encrypted (Boolean) —

    A value that indicates whether the DB cluster is encrypted.

  • :kms_key_id (String) —

    The AWS KMS key identifier for an encrypted DB cluster.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

    If an encryption key isn't specified in KmsKeyId:

    • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key.

    • If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default encryption key.

    AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

    If you create a read replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the read replica in that AWS Region.

  • :pre_signed_url (String) —

    A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

    The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

    The pre-signed URL request must contain the following parameter values:

    • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same KMS key for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

    • DestinationRegion - The name of the AWS Region that Aurora read replica will be created in.

    • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

    If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.

  • :enable_iam_database_authentication (Boolean) —

    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

  • :backtrack_window (Integer) —

    The target backtrack window, in seconds. To disable backtracking, set this value to 0.

    Currently, Backtrack is only supported for Aurora MySQL DB clusters.

    Default: 0

    Constraints:

    • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    ^

  • :enable_cloudwatch_logs_exports (Array<String>) —

    The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

    Aurora MySQL

    Possible values are audit, error, general, and slowquery.

    Aurora PostgreSQL

    Possible values are postgresql and upgrade.

  • :engine_mode (String) —

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

    The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.

    The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.

    The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

    For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.

    Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:

  • :scaling_configuration (Types::ScalingConfiguration) —

    For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

  • :deletion_protection (Boolean) —

    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

  • :global_cluster_identifier (String) —

    The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

  • :enable_http_endpoint (Boolean) —

    A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

    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.

  • :copy_tags_to_snapshot (Boolean) —

    A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

  • :domain (String) —

    The Active Directory directory ID to create the DB cluster in.

    For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

  • :domain_iam_role_name (String) —

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

  • :enable_global_write_forwarding (Boolean) —

    A value that indicates whether to enable write operations to be forwarded from this cluster to the primary cluster in an Aurora global database. The resulting changes are replicated back to this cluster. This parameter only applies to DB clusters that are secondary clusters in an Aurora global database. By default, Aurora disallows write operations for secondary clusters.

  • :destination_region (String)
  • :source_region (String) —

    The source region of the snapshot. This is only needed when the shapshot is encrypted and in a different region.

Returns:



1018
1019
1020
1021
1022
1023
1024
1025
1026
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 1018

def create(options = {})
  options = options.merge(db_cluster_identifier: @id)
  resp = @client.create_db_cluster(options)
  DBCluster.new(
    id: resp.data.db_cluster.db_cluster_identifier,
    data: resp.data.db_cluster,
    client: @client
  )
end

#create_snapshot(options = {}) ⇒ DBClusterSnapshot

Examples:

Request syntax with placeholder values


dbclustersnapshot = db_cluster.create_snapshot({
  db_cluster_snapshot_identifier: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :db_cluster_snapshot_identifier (required, String) —

    The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • First character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster1-snapshot1

  • :tags (Array<Types::Tag>) —

    The tags to be assigned to the DB cluster snapshot.

Returns:



1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 1056

def create_snapshot(options = {})
  options = options.merge(db_cluster_identifier: @id)
  resp = @client.create_db_cluster_snapshot(options)
  DBClusterSnapshot.new(
    cluster_id: resp.data.db_cluster_snapshot.db_cluster_identifier,
    snapshot_id: resp.data.db_cluster_snapshot.db_cluster_snapshot_identifier,
    data: resp.data.db_cluster_snapshot,
    client: @client
  )
end

#cross_account_clone ⇒ Boolean

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

Returns:

  • (Boolean) 


428
429
430
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 428

def 
  data[:cross_account_clone]
end

#custom_endpoints ⇒ Array<String>

Identifies all custom endpoints associated with the cluster.

Returns:

  • (Array<String>) 


135
136
137
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 135

def custom_endpoints
  data[:custom_endpoints]
end

#data ⇒ Types::DBCluster

Returns the data for this Aws::RDS::DBCluster. Calls Client#describe_db_clusters if #data_loaded? is false.

Returns:



491
492
493
494
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 491

def data
  load unless @data
  @data
end

#data_loaded? ⇒ Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean) —

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



499
500
501
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 499

def data_loaded?
  !!@data
end

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


72
73
74
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 72

def database_name
  data[:database_name]
end

#db_cluster_arn ⇒ String

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

Returns:

  • (String) 


254
255
256
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 254

def db_cluster_arn
  data[:db_cluster_arn]
end

#db_cluster_members ⇒ Array<Types::DBClusterMember>

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

Returns:



214
215
216
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 214

def db_cluster_members
  data[:db_cluster_members]
end

#db_cluster_option_group_memberships ⇒ Array<Types::DBClusterOptionGroupStatus>

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

Returns:



179
180
181
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 179

def db_cluster_option_group_memberships
  data[:db_cluster_option_group_memberships]
end

#db_cluster_parameter_group ⇒ String

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

Returns:

  • (String) 


79
80
81
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 79

def db_cluster_parameter_group
  data[:db_cluster_parameter_group]
end

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


248
249
250
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 248

def db_cluster_resource_id
  data[:db_cluster_resource_id]
end

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


87
88
89
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 87

def db_subnet_group
  data[:db_subnet_group]
end

#delete(options = {}) ⇒ DBCluster

Examples:

Request syntax with placeholder values


dbcluster = db_cluster.delete({
  skip_final_snapshot: false,
  final_db_snapshot_identifier: "String",
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :skip_final_snapshot (Boolean) —

    A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. By default, this parameter is disabled.

    You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

  • :final_db_snapshot_identifier (String) —

    The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

    Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

    Constraints:

    • Must be 1 to 255 letters, numbers, or hyphens.

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

Returns:



1104
1105
1106
1107
1108
1109
1110
1111
1112
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 1104

def delete(options = {})
  options = options.merge(db_cluster_identifier: @id)
  resp = @client.delete_db_cluster(options)
  DBCluster.new(
    id: resp.data.db_cluster.db_cluster_identifier,
    data: resp.data.db_cluster,
    client: @client
  )
end

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


366
367
368
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 366

def deletion_protection
  data[:deletion_protection]
end

#domain_memberships ⇒ Array<Types::DomainMembership>

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

Returns:



435
436
437
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 435

def domain_memberships
  data[:domain_memberships]
end

#earliest_backtrack_time ⇒ Time

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

Returns:

  • (Time) 


289
290
291
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 289

def earliest_backtrack_time
  data[:earliest_backtrack_time]
end

#earliest_restorable_time ⇒ Time

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

Returns:

  • (Time) 


106
107
108
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 106

def earliest_restorable_time
  data[:earliest_restorable_time]
end

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


318
319
320
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 318

def enabled_cloudwatch_logs_exports
  data[:enabled_cloudwatch_logs_exports]
end

#endpoint ⇒ String

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

Returns:

  • (String) 


113
114
115
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 113

def endpoint
  data[:endpoint]
end

#engine ⇒ String

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

Returns:

  • (String) 


148
149
150
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 148

def engine
  data[:engine]
end

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


345
346
347
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 345

def engine_mode
  data[:engine_mode]
end

#engine_version ⇒ String

Indicates the database engine version.

Returns:

  • (String) 


154
155
156
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 154

def engine_version
  data[:engine_version]
end

#events(options = {}) ⇒ Event::Collection

Examples:

Request syntax with placeholder values


events = db_cluster.events({
  start_time: Time.now,
  end_time: Time.now,
  duration: 1,
  event_categories: ["String"],
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :start_time (Time, DateTime, Date, Integer, String) —

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

  • :end_time (Time, DateTime, Date, Integer, String) —

    The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

  • :duration (Integer) —

    The number of minutes to retrieve events for.

    Default: 60

  • :event_categories (Array<String>) —

    A list of event categories that trigger notifications for a event notification subscription.

  • :filters (Array<Types::Filter>) —

    This parameter isn't currently supported.

Returns:



1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 1683

def events(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(
      source_type: "db-cluster",
      source_identifier: @id
    )
    resp = @client.describe_events(options)
    resp.each_page do |page|
      batch = []
      page.data.events.each do |e|
        batch << Event.new(
          source_id: e.source_identifier,
          date: e.date,
          data: e,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Event::Collection.new(batches)
end

#failover(options = {}) ⇒ DBCluster

Examples:

Request syntax with placeholder values


dbcluster = db_cluster.failover({
  target_db_instance_identifier: "String",
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :target_db_instance_identifier (String) —

    The name of the instance to promote to the primary instance.

    You must specify the instance identifier for an Aurora Replica in the DB cluster. For example, mydbcluster-replica1.

Returns:



1126
1127
1128
1129
1130
1131
1132
1133
1134
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 1126

def failover(options = {})
  options = options.merge(db_cluster_identifier: @id)
  resp = @client.failover_db_cluster(options)
  DBCluster.new(
    id: resp.data.db_cluster.db_cluster_identifier,
    data: resp.data.db_cluster,
    client: @client
  )
end

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


464
465
466
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 464

def global_write_forwarding_requested
  data[:global_write_forwarding_requested]
end

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

Returns:

  • (String) 


454
455
456
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 454

def global_write_forwarding_status
  data[:global_write_forwarding_status]
end

#hosted_zone_id ⇒ String

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

Returns:

  • (String) 


227
228
229
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 227

def hosted_zone_id
  data[:hosted_zone_id]
end

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


385
386
387
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 385

def http_endpoint_enabled
  data[:http_endpoint_enabled]
end

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


270
271
272
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 270

def iam_database_authentication_enabled
  data[:iam_database_authentication_enabled]
end

#id ⇒ String Also known as: db_cluster_identifier

Returns:

  • (String) 


33
34
35
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 33

def id
  @id
end

#kms_key_id ⇒ String

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

Returns:

  • (String) 


240
241
242
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 240

def kms_key_id
  data[:kms_key_id]
end

#latest_restorable_time ⇒ Time

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

Returns:

  • (Time) 


161
162
163
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 161

def latest_restorable_time
  data[:latest_restorable_time]
end

#load ⇒ self Also known as: reload

Loads, or reloads #data for the current Aws::RDS::DBCluster. Returns self making it possible to chain methods.

db_cluster.reload.data

Returns:

  • (self) 


481
482
483
484
485
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 481

def load
  resp = @client.describe_db_clusters(db_cluster_identifier: @id)
  @data = resp.db_clusters[0]
  self
end

#master_username ⇒ String

Contains the master username for the DB cluster.

Returns:

  • (String) 


173
174
175
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 173

def master_username
  data[:master_username]
end

#members ⇒ DBInstance::Collection

Returns:



1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 1707

def members
  batch = []
  data[:db_cluster_members].each do |d|
    batch << DBInstance.new(
      id: d[:db_instance_identifier],
      data: d,
      client: @client
    )
  end
  DBInstance::Collection.new([batch], size: batch.size)
end

#modify(options = {}) ⇒ DBCluster

Examples:

Request syntax with placeholder values


dbcluster = db_cluster.modify({
  new_db_cluster_identifier: "String",
  apply_immediately: false,
  backup_retention_period: 1,
  db_cluster_parameter_group_name: "String",
  vpc_security_group_ids: ["String"],
  port: 1,
  master_user_password: "String",
  option_group_name: "String",
  preferred_backup_window: "String",
  preferred_maintenance_window: "String",
  enable_iam_database_authentication: false,
  backtrack_window: 1,
  cloudwatch_logs_export_configuration: {
    enable_log_types: ["String"],
    disable_log_types: ["String"],
  },
  engine_version: "String",
  allow_major_version_upgrade: false,
  db_instance_parameter_group_name: "String",
  domain: "String",
  domain_iam_role_name: "String",
  scaling_configuration: {
    min_capacity: 1,
    max_capacity: 1,
    auto_pause: false,
    seconds_until_auto_pause: 1,
    timeout_action: "String",
  },
  deletion_protection: false,
  enable_http_endpoint: false,
  copy_tags_to_snapshot: false,
  enable_global_write_forwarding: false,
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :new_db_cluster_identifier (String) —

    The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens

    • The first character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    Example: my-cluster2

  • :apply_immediately (Boolean) —

    A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.

    The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

    By default, this parameter is disabled.

  • :backup_retention_period (Integer) —

    The number of days for which automated backups are retained. You must specify a minimum value of 1.

    Default: 1

    Constraints:

    • Must be a value from 1 to 35

    ^

  • :db_cluster_parameter_group_name (String) —

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

  • :vpc_security_group_ids (Array<String>) —

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

  • :port (Integer) —

    The port number on which the DB cluster accepts connections.

    Constraints: Value must be 1150-65535

    Default: The same port as the original DB cluster.

  • :master_user_password (String) —

    The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

    Constraints: Must contain from 8 to 41 characters.

  • :option_group_name (String) —

    A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

    Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

  • :preferred_backup_window (String) —

    The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

    Constraints:

    • Must be in the format hh24:mi-hh24:mi.

    • Must be in Universal Coordinated Time (UTC).

    • Must not conflict with the preferred maintenance window.

    • Must be at least 30 minutes.

  • :preferred_maintenance_window (String) —

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

    Format: ddd:hh24:mi-ddd:hh24:mi

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    Constraints: Minimum 30-minute window.

  • :enable_iam_database_authentication (Boolean) —

    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

  • :backtrack_window (Integer) —

    The target backtrack window, in seconds. To disable backtracking, set this value to 0.

    Currently, Backtrack is only supported for Aurora MySQL DB clusters.

    Default: 0

    Constraints:

    • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    ^

  • :cloudwatch_logs_export_configuration (Types::CloudwatchLogsExportConfiguration) —

    The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

  • :engine_version (String) —

    The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

    aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"

    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

    aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

    To list all of the available engine versions for aurora-postgresql, use the following command:

    aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"

  • :allow_major_version_upgrade (Boolean) —

    A value that indicates whether major version upgrades are allowed.

    Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

  • :db_instance_parameter_group_name (String) —

    The name of the DB parameter group to apply to all instances of the DB cluster.

    When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately.

    Default: The existing name setting

    Constraints:

    • The DB parameter group must be in the same DB parameter group family as this DB cluster.

    • The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

  • :domain (String) —

    The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.

    For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

  • :domain_iam_role_name (String) —

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

  • :scaling_configuration (Types::ScalingConfiguration) —

    The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

  • :deletion_protection (Boolean) —

    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

  • :enable_http_endpoint (Boolean) —

    A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

    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.

  • :copy_tags_to_snapshot (Boolean) —

    A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

  • :enable_global_write_forwarding (Boolean) —

    A value that indicates whether to enable write operations to be forwarded from this cluster to the primary cluster in an Aurora global database. The resulting changes are replicated back to this cluster. This parameter only applies to DB clusters that are secondary clusters in an Aurora global database. By default, Aurora disallows write operations for secondary clusters.

Returns:



1410
1411
1412
1413
1414
1415
1416
1417
1418
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 1410

def modify(options = {})
  options = options.merge(db_cluster_identifier: @id)
  resp = @client.modify_db_cluster(options)
  DBCluster.new(
    id: resp.data.db_cluster.db_cluster_identifier,
    data: resp.data.db_cluster,
    client: @client
  )
end

#multi_az ⇒ Boolean

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

Returns:

  • (Boolean) 


142
143
144
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 142

def multi_az
  data[:multi_az]
end

#option_groups ⇒ OptionGroup::Collection

Returns:



1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 1720

def option_groups
  batch = []
  data[:db_cluster_option_group_memberships].each do |d|
    batch << OptionGroup.new(
      name: d[:db_cluster_option_group_name],
      data: d,
      client: @client
    )
  end
  OptionGroup::Collection.new([batch], size: batch.size)
end

#parameter_group ⇒ DBClusterParameterGroup?

Returns:



1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 1733

def parameter_group
  if data[:db_cluster_parameter_group]
    DBClusterParameterGroup.new(
      name: data[:db_cluster_parameter_group],
      client: @client
    )
  else
    nil
  end
end

#percent_progress ⇒ String

Specifies the progress of the operation as a percentage.

Returns:

  • (String) 


99
100
101
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 99

def percent_progress
  data[:percent_progress]
end

#port ⇒ Integer

Specifies the port that the database engine is listening on.

Returns:

  • (Integer) 


167
168
169
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 167

def port
  data[:port]
end

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


187
188
189
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 187

def preferred_backup_window
  data[:preferred_backup_window]
end

#preferred_maintenance_window ⇒ String

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

Returns:

  • (String) 


194
195
196
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 194

def preferred_maintenance_window
  data[:preferred_maintenance_window]
end

#read_replica_identifiers ⇒ Array<String>

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

Returns:

  • (Array<String>) 


208
209
210
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 208

def read_replica_identifiers
  data[:read_replica_identifiers]
end

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


129
130
131
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 129

def reader_endpoint
  data[:reader_endpoint]
end

#replication_source_identifier ⇒ String

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

Returns:

  • (String) 


201
202
203
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 201

def replication_source_identifier
  data[:replication_source_identifier]
end

#restore(options = {}) ⇒ DBCluster

Examples:

Request syntax with placeholder values


dbcluster = db_cluster.restore({
  db_cluster_identifier: "String", # required
  restore_type: "String",
  restore_to_time: Time.now,
  use_latest_restorable_time: false,
  port: 1,
  db_subnet_group_name: "String",
  option_group_name: "String",
  vpc_security_group_ids: ["String"],
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  kms_key_id: "String",
  enable_iam_database_authentication: false,
  backtrack_window: 1,
  enable_cloudwatch_logs_exports: ["String"],
  db_cluster_parameter_group_name: "String",
  deletion_protection: false,
  copy_tags_to_snapshot: false,
  domain: "String",
  domain_iam_role_name: "String",
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :db_cluster_identifier (required, String) —

    The name of the new DB cluster to be created.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

  • :restore_type (String) —

    The type of restore to be performed. You can specify one of the following values:

    • full-copy - The new DB cluster is restored as a full copy of the source DB cluster.

    • copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

    Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

    If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

  • :restore_to_time (Time, DateTime, Date, Integer, String) —

    The date and time to restore the DB cluster to.

    Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

    Constraints:

    • Must be before the latest restorable time for the DB instance

    • Must be specified if UseLatestRestorableTime parameter isn't provided

    • Can't be specified if the UseLatestRestorableTime parameter is enabled

    • Can't be specified if the RestoreType parameter is copy-on-write

    Example: 2015-03-07T23:45:00Z

  • :use_latest_restorable_time (Boolean) —

    A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.

    Constraints: Can't be specified if RestoreToTime parameter is provided.

  • :port (Integer) —

    The port number on which the new DB cluster accepts connections.

    Constraints: A value from 1150-65535.

    Default: The default port for the engine.

  • :db_subnet_group_name (String) —

    The DB subnet group name to use for the new DB cluster.

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    Example: mySubnetgroup

  • :option_group_name (String) —

    The name of the option group for the new DB cluster.

  • :vpc_security_group_ids (Array<String>) —

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

  • :tags (Array<Types::Tag>) —

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

  • :kms_key_id (String) —

    The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

    You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

    If you don't specify a value for the KmsKeyId parameter, then the following occurs:

    • If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.

    • If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.

    If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.

  • :enable_iam_database_authentication (Boolean) —

    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

  • :backtrack_window (Integer) —

    The target backtrack window, in seconds. To disable backtracking, set this value to 0.

    Currently, Backtrack is only supported for Aurora MySQL DB clusters.

    Default: 0

    Constraints:

    • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    ^

  • :enable_cloudwatch_logs_exports (Array<String>) —

    The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

  • :db_cluster_parameter_group_name (String) —

    The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

    Constraints:

    • If supplied, must match the name of an existing DB cluster parameter group.

    • Must be 1 to 255 letters, numbers, or hyphens.

    • First character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

  • :deletion_protection (Boolean) —

    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

  • :copy_tags_to_snapshot (Boolean) —

    A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

  • :domain (String) —

    Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

    For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

  • :domain_iam_role_name (String) —

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

Returns:



1626
1627
1628
1629
1630
1631
1632
1633
1634
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 1626

def restore(options = {})
  options = options.merge(source_db_cluster_identifier: @id)
  resp = @client.restore_db_cluster_to_point_in_time(options)
  DBCluster.new(
    id: resp.data.db_cluster.db_cluster_identifier,
    data: resp.data.db_cluster,
    client: @client
  )
end

#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:



359
360
361
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 359

def scaling_configuration_info
  data[:scaling_configuration_info]
end

#snapshots(options = {}) ⇒ DBClusterSnapshot::Collection

Examples:

Request syntax with placeholder values


snapshots = db_cluster.snapshots({
  db_cluster_snapshot_identifier: "String",
  snapshot_type: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  include_shared: false,
  include_public: false,
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :db_cluster_snapshot_identifier (String) —

    A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

    Constraints:

    • If supplied, must match the identifier of an existing DBClusterSnapshot.

    • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

  • :snapshot_type (String) —

    The type of DB cluster snapshots to be returned. You can specify one of the following values:

    • automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.

    • manual - Return all DB cluster snapshots that have been taken by my AWS account.

    • shared - Return all manual DB cluster snapshots that have been shared to my AWS account.

    • public - Return all DB cluster snapshots that have been marked as public.

    If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.

    The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

  • :filters (Array<Types::Filter>) —

    A filter that specifies one or more DB cluster snapshots to describe.

    Supported filters:

    • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).

    • db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

    • snapshot-type - Accepts types of DB cluster snapshots.

    • engine - Accepts names of database engines.

  • :include_shared (Boolean) —

    A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.

    You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.

  • :include_public (Boolean) —

    A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.

    You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

Returns:



1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 1828

def snapshots(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(db_cluster_identifier: @id)
    resp = @client.describe_db_cluster_snapshots(options)
    resp.each_page do |page|
      batch = []
      page.data.db_cluster_snapshots.each do |d|
        batch << DBClusterSnapshot.new(
          cluster_id: @id,
          snapshot_id: d.db_cluster_snapshot_identifier,
          data: d,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  DBClusterSnapshot::Collection.new(batches)
end

#status ⇒ String

Specifies the current state of this DB cluster.

Returns:

  • (String) 


93
94
95
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 93

def status
  data[:status]
end

#storage_encrypted ⇒ Boolean

Specifies whether the DB cluster is encrypted.

Returns:

  • (Boolean) 


233
234
235
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 233

def storage_encrypted
  data[:storage_encrypted]
end

#subnet_group ⇒ DBSubnetGroup?

Returns:



1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 1849

def subnet_group
  if data[:db_subnet_group]
    DBSubnetGroup.new(
      name: data[:db_subnet_group],
      client: @client
    )
  else
    nil
  end
end

#tag_list ⇒ Array<Types::Tag>

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

Returns:



446
447
448
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 446

def tag_list
  data[:tag_list]
end

#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>

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

Returns:



220
221
222
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 220

def vpc_security_groups
  data[:vpc_security_groups]
end

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Deprecated.

Use [Aws::RDS::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged.

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) do |instance|
  instance.state.name == 'running'
end

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10 —

    Maximum number of

  • :delay (Integer) — default: 10 —

    Delay between each

  • :before_attempt (Proc) — default: nil —

    Callback

  • :before_wait (Proc) — default: nil —

    Callback

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

Returns:

  • (Resource) —

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError) —

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError) —

    Raised when the resource does not



583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 583

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end