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

Class: Aws::RDS::DBCluster

Inherits:
Aws::Resources::Resource show all
Defined in:
(unknown)

Instance Attribute Summary collapse

Attributes inherited from Aws::Resources::Resource

#client, #identifiers

Instance Method Summary collapse

Methods inherited from Aws::Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Aws::Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

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

Overloads:

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

    Parameters:

    • id (String)

    Options Hash (options):

    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

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

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#allocated_storageInteger (readonly)

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)

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

#associated_rolesArray<Types::DBClusterRole> (readonly)

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

Returns:

  • (Array<Types::DBClusterRole>)

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

#availability_zonesArray<String> (readonly)

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

Returns:

  • (Array<String>)

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

#backup_retention_periodInteger (readonly)

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

Returns:

  • (Integer)

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

#character_set_nameString (readonly)

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

Returns:

  • (String)

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

#clone_group_idString (readonly)

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

Returns:

  • (String)

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

#cluster_create_timeTime (readonly)

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

Returns:

  • (Time)

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

#database_nameString (readonly)

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

Returns:

  • (String)

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

#db_cluster_arnString (readonly)

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

Returns:

  • (String)

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

#db_cluster_identifierString (readonly)

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

Returns:

  • (String)

    Contains a user-supplied DB cluster identifier.

#db_cluster_membersArray<Types::DBClusterMember> (readonly)

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

Returns:

#db_cluster_option_group_membershipsArray<Types::DBClusterOptionGroupStatus> (readonly)

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

Returns:

#db_cluster_parameter_groupString (readonly)

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

Returns:

  • (String)

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

#db_cluster_resource_idString (readonly)

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)

    The region-unique, immutable identifier for the DB cluster.

#db_subnet_groupString (readonly)

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

Returns:

  • (String)

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

#earliest_restorable_timeTime (readonly)

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

Returns:

  • (Time)

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

#endpointString (readonly)

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

Returns:

  • (String)

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

#engineString (readonly)

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

Returns:

  • (String)

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

#engine_versionString (readonly)

Indicates the database engine version.

Returns:

  • (String)

    Indicates the database engine version.

#hosted_zone_idString (readonly)

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

Returns:

  • (String)

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

#iam_database_authentication_enabledBoolean (readonly)

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

Returns:

  • (Boolean)

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

#idString (readonly)

Returns:

  • (String)

#kms_key_idString (readonly)

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

Returns:

  • (String)

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

#latest_restorable_timeTime (readonly)

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

Returns:

  • (Time)

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

#master_usernameString (readonly)

Contains the master username for the DB cluster.

Returns:

  • (String)

    Contains the master username for the DB cluster.

#multi_azBoolean (readonly)

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

Returns:

  • (Boolean)

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

#percent_progressString (readonly)

Specifies the progress of the operation as a percentage.

Returns:

  • (String)

    Specifies the progress of the operation as a percentage.

#portInteger (readonly)

Specifies the port that the database engine is listening on.

Returns:

  • (Integer)

    Specifies the port that the database engine is listening on.

#preferred_backup_windowString (readonly)

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

Returns:

  • (String)

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

#preferred_maintenance_windowString (readonly)

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

Returns:

  • (String)

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

#read_replica_identifiersArray<String> (readonly)

Contains one or more identifiers of the Read Replicas associated with this DB cluster.

Returns:

  • (Array<String>)

    Contains one or more identifiers of the Read Replicas associated with this DB cluster.

#reader_endpointString (readonly)

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)

    The reader endpoint for the DB cluster.

#replication_source_identifierString (readonly)

Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.

Returns:

  • (String)

    Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.

#statusString (readonly)

Specifies the current state of this DB cluster.

Returns:

  • (String)

    Specifies the current state of this DB cluster.

#storage_encryptedBoolean (readonly)

Specifies whether the DB cluster is encrypted.

Returns:

  • (Boolean)

    Specifies whether the DB cluster is encrypted.

#vpc_security_groupsArray<Types::VpcSecurityGroupMembership> (readonly)

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

Returns:

Instance Method Details

#create(options = {}) ⇒ DBCluster

Examples:

Request syntax example with placeholder values


dbcluster.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,
  destination_region: "String",
  source_region: "String",
})

Basic usage

dbcluster = dbcluster.create(options)
dbcluster.id
#=> "dbcluster-id"

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.

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

    • If supplied, must match the name of an existing DBClusterParameterGroup.

    ^

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

  • :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 letters or numbers.

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

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

  • :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 an encryption key is not 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 true and ReplicationSourceIdentifier is not 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 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.

  • :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 region which you are copying an encrypted snapshot from.

    This is a required paramter that allows SDK to compute a pre-signed Url and populate PreSignedURL parameter on your behalf.

Returns:

See Also:

#create_snapshot(options = {}) ⇒ DBClusterSnapshot

Examples:

Request syntax example with placeholder values


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

Basic usage

dbclustersnapshot = dbcluster.create_snapshot(options)
dbclustersnapshot.snapshot_id
#=> "dbclustersnapshot-snapshot-id"

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.

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

See Also:

#delete(options = {}) ⇒ DBCluster

Examples:

Request syntax example with placeholder values


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

Basic usage

dbcluster = dbcluster.delete(options)
dbcluster.id
#=> "dbcluster-id"

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.

    You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false.

    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.

    Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

    Constraints:

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

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

Returns:

See Also:

#events(options = {}) ⇒ Collection<Event>

Returns a Collection of Event resources. No API requests are made until you call an enumerable method on the collection. Client#describe_events will be called multiple times until every Event has been yielded.

Examples:

Request syntax example with placeholder values


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

Enumerating Event resources.

dbcluster.events.each do |event|
  # yields each event
end

Enumerating Event resources with a limit.

dbcluster.events.limit(10).each do |event|
  # yields at most 10 events
end

Options Hash (options):

  • :start_time (Time)

    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)

    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 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 DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

See Also:

#failover(options = {}) ⇒ DBCluster

Examples:

Request syntax example with placeholder values


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

Basic usage

dbcluster = dbcluster.failover(options)
dbcluster.id
#=> "dbcluster-id"

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:

See Also:

#membersArray<DBInstance>?

Returns:

#modify(options = {}) ⇒ DBCluster

Examples:

Request syntax example with placeholder values


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

Basic usage

dbcluster = dbcluster.modify(options)
dbcluster.id
#=> "dbcluster-id"

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

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

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

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

See Also:

#option_groupsArray<OptionGroup>?

Returns:

#parameter_groupDBClusterParameterGroup?

Returns:

#restore(options = {}) ⇒ DBCluster

Examples:

Request syntax example with placeholder values


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

Basic usage

dbcluster = dbcluster.restore(options)
dbcluster.id
#=> "dbcluster-id"

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

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

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

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

See Also:

#snapshots(options = {}) ⇒ Collection<DBClusterSnapshot>

Returns a Collection of Aws::RDS::DBClusterSnapshot resources. No API requests are made until you call an enumerable method on the collection. Client#describe_db_cluster_snapshots will be called multiple times until every Aws::RDS::DBClusterSnapshot has been yielded.

Examples:

Request syntax example with placeholder values


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

Enumerating Aws::RDS::DBClusterSnapshot resources.

dbcluster.snapshots.each do |dbclustersnapshot|
  # yields each dbclustersnapshot
end

Enumerating Aws::RDS::DBClusterSnapshot resources with a limit.

dbcluster.snapshots.limit(10).each do |dbclustersnapshot|
  # yields at most 10 snapshots
end

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:

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

See Also:

#subnet_groupDBSubnetGroup?

Returns: