Class: Aws::RDS::DBCluster

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
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) 


19
20
21
22
23
24
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 19

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

Instance Method Details

#allocated_storage ⇒ Integer

For all database engines except Amazon Aurora, ‘AllocatedStorage` specifies the allocated storage size in gigabytes (GB). For Aurora, `AllocatedStorage` always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.

Returns:

  • (Integer) 


39
40
41
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 39

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:



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

def associated_roles
  data.associated_roles
end

#availability_zones ⇒ Array<String>

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

Returns:

  • (Array<String>) 


46
47
48
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 46

def availability_zones
  data.availability_zones
end

#backup_retention_period ⇒ Integer

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

Returns:

  • (Integer) 


53
54
55
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 53

def backup_retention_period
  data.backup_retention_period
end

#character_set_name ⇒ String

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

Returns:

  • (String) 


60
61
62
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 60

def character_set_name
  data.character_set_name
end

#client ⇒ Client

Returns:



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

def client
  @client
end

#clone_group_id ⇒ String

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

Returns:

  • (String) 


268
269
270
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 268

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) 


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

def cluster_create_time
  data.cluster_create_time
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,
  source_region: "String",
})

Parameters:

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

    ({})

Options Hash (options):

  • :availability_zones (Array<String>) —

    A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see [Regions and Availability Zones].

    [1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html

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

    ^

  • :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 alpha-numeric characters. If you do not provide a name, Amazon RDS will not 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 this argument is omitted, ‘default.aurora5.6` will be used.

    Constraints:

    • Must be 1 to 255 alphanumeric characters

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

  • :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 contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. 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`

  • :engine_version (String) —

    The version number of the database engine to use.

    Aurora

    Example: ‘5.6.10a`

  • :port (Integer) —

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

    Default: ‘3306`

  • :master_username (String) —

    The name of the master user for the DB cluster.

    Constraints:

    • Must be 1 to 16 alphanumeric characters.

    • First character must be a letter.

    • Cannot 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 cannot be removed from an option group. The option group cannot 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.

    Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see [ Adjusting the Preferred Maintenance Window] in the *Amazon RDS User Guide.*

    Constraints:

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

    • Times should be in Universal Coordinated Time (UTC).

    • Must not conflict with the preferred maintenance window.

    • Must be at least 30 minutes.

    [1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html

  • :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`

    Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see [ Adjusting the Preferred Maintenance Window] in the *Amazon RDS User Guide.*

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

    Constraints: Minimum 30-minute window.

    [1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html

  • :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>) —

    A list of tags.

  • :storage_encrypted (Boolean) —

    Specifies whether the DB cluster is encrypted.

  • :kms_key_id (String) —

    The 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 the ‘StorageEncrypted` parameter is true, and you do not specify a value for the `KmsKeyId` parameter, 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 will be 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 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 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].

    [1]: docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html [2]: docs.aws.amazon.com/general/latest/gr/signature-version-4.html

  • :enable_iam_database_authentication (Boolean) —

    A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

    Default: ‘false`

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



548
549
550
551
552
553
554
555
556
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 548

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 alphanumeric characters or hyphens.

    • First character must be a letter.

    • Cannot 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:



586
587
588
589
590
591
592
593
594
595
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 586

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

#data ⇒ Types::DBCluster

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

Returns:



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

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.



310
311
312
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 310

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) 


68
69
70
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 68

def database_name
  data.database_name
end

#db_cluster_arn ⇒ String

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

Returns:

  • (String) 


246
247
248
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 246

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:



206
207
208
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 206

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:



171
172
173
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 171

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) 


75
76
77
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 75

def db_cluster_parameter_group
  data.db_cluster_parameter_group
end

#db_cluster_resource_id ⇒ String

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

Returns:

  • (String) 


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

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) 


83
84
85
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 83

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

    Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If ‘true` is specified, no DB cluster snapshot is created. If `false` is specified, a DB cluster snapshot is created before the DB cluster is deleted.

    <note markdown=“1”> You must specify a ‘FinalDBSnapshotIdentifier` parameter if `SkipFinalSnapshot` is `false`.

    </note>

    Default: ‘false`

  • :final_db_snapshot_identifier (String) —

    The DB cluster snapshot identifier of the new DB cluster snapshot created when ‘SkipFinalSnapshot` is set to `false`.

    <note markdown=“1”> Specifying this parameter and also setting the ‘SkipFinalShapshot` parameter to true results in an error.

    </note>

    Constraints:

    • Must be 1 to 255 alphanumeric characters

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

Returns:



633
634
635
636
637
638
639
640
641
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 633

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

#earliest_restorable_time ⇒ Time

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

Returns:

  • (Time) 


102
103
104
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 102

def earliest_restorable_time
  data.earliest_restorable_time
end

#endpoint ⇒ String

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

Returns:

  • (String) 


109
110
111
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 109

def endpoint
  data.endpoint
end

#engine ⇒ String

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

Returns:

  • (String) 


140
141
142
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 140

def engine
  data.engine
end

#engine_version ⇒ String

Indicates the database engine version.

Returns:

  • (String) 


146
147
148
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 146

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.][1

    Example: 2009-07-08T18:00Z

    [1]: en.wikipedia.org/wiki/ISO_8601

  • :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.][1

    Example: 2009-07-08T18:00Z

    [1]: en.wikipedia.org/wiki/ISO_8601

  • :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 is not currently supported.

Returns:



988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 988

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:



655
656
657
658
659
660
661
662
663
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 655

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

#hosted_zone_id ⇒ String

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

Returns:

  • (String) 


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

def hosted_zone_id
  data.hosted_zone_id
end

#iam_database_authentication_enabled ⇒ Boolean

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

Returns:

  • (Boolean) 


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

def iam_database_authentication_enabled
  data.iam_database_authentication_enabled
end

#id ⇒ String Also known as: db_cluster_identifier

Returns:

  • (String) 


29
30
31
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 29

def id
  @id
end

#identifiers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1174
1175
1176
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 1174

def identifiers
  { id: @id }
end

#kms_key_id ⇒ String

If ‘StorageEncrypted` is true, the KMS key identifier for the encrypted DB cluster.

Returns:

  • (String) 


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

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) 


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

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) 


292
293
294
295
296
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 292

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) 


165
166
167
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 165

def master_username
  data.master_username
end

#members ⇒ DBInstance::Collection

Returns:



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 1012

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,
})

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 alphanumeric characters or hyphens

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    Example: ‘my-cluster2`

  • :apply_immediately (Boolean) —

    A value that specifies 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 set to `false`, changes to the DB cluster are applied during the next maintenance window.

    The ‘ApplyImmediately` parameter only affects the `NewDBClusterIdentifier` and `MasterUserPassword` values. If you set the `ApplyImmediately` parameter value to false, then changes to the `NewDBClusterIdentifier` and `MasterUserPassword` values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the `ApplyImmediately` parameter.

    Default: ‘false`

  • :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 does not result in an outage except in the following case, and the change is applied during the next maintenance window unless the ‘ApplyImmediately` parameter is set to `true` 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 cannot be removed from an option group. The option group cannot 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.

    Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see [ Adjusting the Preferred Maintenance Window] in the *Amazon RDS User Guide.*

    Constraints:

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

    • Times should be in Universal Coordinated Time (UTC).

    • Must not conflict with the preferred maintenance window.

    • Must be at least 30 minutes.

    [1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html

  • :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`

    Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see [ Adjusting the Preferred Maintenance Window] in the *Amazon RDS User Guide.*

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

    Constraints: Minimum 30-minute window.

    [1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html

  • :enable_iam_database_authentication (Boolean) —

    A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

    Default: ‘false`

Returns:



796
797
798
799
800
801
802
803
804
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 796

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) 


133
134
135
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 133

def multi_az
  data.multi_az
end

#option_groups ⇒ OptionGroup::Collection

Returns:



1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 1025

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:



1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 1038

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) 


95
96
97
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 95

def percent_progress
  data.percent_progress
end

#port ⇒ Integer

Specifies the port that the database engine is listening on.

Returns:

  • (Integer) 


159
160
161
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 159

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) 


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

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) 


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

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


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

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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

Returns:

  • (String) 


126
127
128
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 126

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) 


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

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,
})

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 alphanumeric characters or hyphens

    • First character must be a letter

    • Cannot 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 cannot 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 is not provided

    • Cannot be specified if ‘UseLatestRestorableTime` parameter is true

    • Cannot be specified if ‘RestoreType` parameter is `copy-on-write`

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

  • :use_latest_restorable_time (Boolean) —

    A value that is set to ‘true` to restore the DB cluster to the latest restorable backup time, and `false` otherwise.

    Default: ‘false`

    Constraints: Cannot be specified if ‘RestoreToTime` parameter is provided.

  • :port (Integer) —

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

    Constraints: Value must be ‘1150-65535`

    Default: The same port as the original DB cluster.

  • :db_subnet_group_name (String) —

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

    Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

    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.

  • :kms_key_id (String) —

    The 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 will be encrypted with the KMS key identified by the ‘KmsKeyId` parameter.

    If you do not specify a value for the ‘KmsKeyId` parameter, then the following will occur:

    • 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 is not encrypted, then the restored DB cluster is not encrypted.

    If ‘DBClusterIdentifier` refers to a DB cluster that is not encrypted, then the restore request is rejected.

  • :enable_iam_database_authentication (Boolean) —

    A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

    Default: ‘false`

Returns:



931
932
933
934
935
936
937
938
939
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 931

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

#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
    },
  ],
  max_records: 1,
  marker: "String",
  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 cannot be used in conjunction with the ‘DBClusterIdentifier` parameter. This value is stored as a lowercase string.

    Constraints:

    • Must be 1 to 255 alphanumeric characters

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    • 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 setting the `IncludeShared` parameter to `true`. You can include public DB cluster snapshots with these results by setting the `IncludePublic` parameter to `true`.

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

    This parameter is not currently supported.

  • :max_records (Integer) —

    The maximum number of records to include in the response. If more records exist than the specified ‘MaxRecords` value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • :marker (String) —

    An optional pagination token provided by a previous ‘DescribeDBClusterSnapshots` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.

  • :include_shared (Boolean) —

    Set this value to ‘true` to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to `false`. The default is `false`.

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

    Set this value to ‘true` to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to `false`. The default is `false`. The default is false.

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

Returns:



1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 1142

def snapshots(options = {})
  batches = Enumerator.new do |y|
    batch = []
    options = options.merge(db_cluster_identifier: @id)
    resp = @client.describe_db_cluster_snapshots(options)
    resp.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
  DBClusterSnapshot::Collection.new(batches)
end

#status ⇒ String

Specifies the current state of this DB cluster.

Returns:

  • (String) 


89
90
91
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 89

def status
  data.status
end

#storage_encrypted ⇒ Boolean

Specifies whether the DB cluster is encrypted.

Returns:

  • (Boolean) 


225
226
227
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 225

def storage_encrypted
  data.storage_encrypted
end

#subnet_group ⇒ DBSubnetGroup?

Returns:



1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 1161

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

#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>

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

Returns:



212
213
214
 
# File 'lib/aws-sdk-rds/db_cluster.rb', line 212

def vpc_security_groups
  data.vpc_security_groups
end