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

#activity_stream_kinesis_stream_name ⇒ String (readonly)

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

Returns:

  • (String) —

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

#activity_stream_kms_key_id ⇒ String (readonly)

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

Returns:

  • (String) —

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

#activity_stream_mode ⇒ String (readonly)

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

Possible values:

  • sync
  • async

Returns:

  • (String) —

    The mode of the database activity stream.

#activity_stream_status ⇒ String (readonly)

The status of the database activity stream.

Possible values:

  • stopped
  • starting
  • started
  • stopping

Returns:

  • (String) —

    The status of the database activity stream.

#allocated_storage ⇒ Integer (readonly)

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

Returns:

  • (Integer) —

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

#associated_roles ⇒ Array<Types::DBClusterRole> (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_zones ⇒ Array<String> (readonly)

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

Returns:

  • (Array<String>) —

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

#backtrack_consumed_change_records ⇒ Integer (readonly)

The number of change records stored for Backtrack.

Returns:

  • (Integer) —

    The number of change records stored for Backtrack.

#backtrack_window ⇒ Integer (readonly)

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

Returns:

  • (Integer) —

    The target backtrack window, in seconds.

#backup_retention_period ⇒ Integer (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.

#capacity ⇒ Integer (readonly)

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

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

Returns:

  • (Integer) —

    The current capacity of an Aurora Serverless DB cluster.

#character_set_name ⇒ String (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_id ⇒ String (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_time ⇒ Time (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).

#copy_tags_to_snapshot ⇒ Boolean (readonly)

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

Returns:

  • (Boolean) —

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

#cross_account_clone ⇒ Boolean (readonly)

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

Returns:

  • (Boolean) —

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

#custom_endpoints ⇒ Array<String> (readonly)

Identifies all custom endpoints associated with the cluster.

Returns:

  • (Array<String>) —

    Identifies all custom endpoints associated with the cluster.

#database_name ⇒ String (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_arn ⇒ String (readonly)

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

Returns:

  • (String) —

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

#db_cluster_identifier ⇒ String (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_members ⇒ Array<Types::DBClusterMember> (readonly)

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

Returns:

#db_cluster_option_group_memberships ⇒ Array<Types::DBClusterOptionGroupStatus> (readonly)

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

Returns:

#db_cluster_parameter_group ⇒ String (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_id ⇒ String (readonly)

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

Returns:

  • (String) —

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

#db_subnet_group ⇒ String (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.

#deletion_protection ⇒ Boolean (readonly)

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

Returns:

  • (Boolean) —

    Indicates if the DB cluster has deletion protection enabled.

#domain_memberships ⇒ Array<Types::DomainMembership> (readonly)

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

Returns:

  • (Array<Types::DomainMembership>) —

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

#earliest_backtrack_time ⇒ Time (readonly)

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

Returns:

  • (Time) —

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

#earliest_restorable_time ⇒ Time (readonly)

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

Returns:

  • (Time) —

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

#enabled_cloudwatch_logs_exports ⇒ Array<String> (readonly)

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

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

Returns:

  • (Array<String>) —

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

#endpoint ⇒ String (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.

#engine ⇒ String (readonly)

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

Returns:

  • (String) —

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

#engine_mode ⇒ String (readonly)

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

For more information, see CreateDBCluster.

Returns:

  • (String) —

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

#engine_version ⇒ String (readonly)

Indicates the database engine version.

Returns:

  • (String) —

    Indicates the database engine version.

#global_write_forwarding_requested ⇒ Boolean (readonly)

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

Returns:

  • (Boolean) —

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

#global_write_forwarding_status ⇒ String (readonly)

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

Possible values:

  • enabled
  • disabled
  • enabling
  • disabling
  • unknown

Returns:

  • (String) —

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

#hosted_zone_id ⇒ String (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.

#http_endpoint_enabled ⇒ Boolean (readonly)

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

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

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

Returns:

  • (Boolean) —

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

#iam_database_authentication_enabled ⇒ Boolean (readonly)

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

Returns:

  • (Boolean) —

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

#id ⇒ String (readonly)

Returns:

  • (String)

#kms_key_id ⇒ String (readonly)

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

Returns:

  • (String) —

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

#latest_restorable_time ⇒ Time (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_username ⇒ String (readonly)

Contains the master username for the DB cluster.

Returns:

  • (String) —

    Contains the master username for the DB cluster.

#multi_az ⇒ Boolean (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_progress ⇒ String (readonly)

Specifies the progress of the operation as a percentage.

Returns:

  • (String) —

    Specifies the progress of the operation as a percentage.

#port ⇒ Integer (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_window ⇒ String (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_window ⇒ String (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_identifiers ⇒ Array<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_endpoint ⇒ String (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 is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

Returns:

  • (String) —

    The reader endpoint for the DB cluster.

#replication_source_identifier ⇒ String (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.

#scaling_configuration_info ⇒ Types::ScalingConfigurationInfo (readonly)

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

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

Returns:

#status ⇒ String (readonly)

Specifies the current state of this DB cluster.

Returns:

  • (String) —

    Specifies the current state of this DB cluster.

#storage_encrypted ⇒ Boolean (readonly)

Specifies whether the DB cluster is encrypted.

Returns:

  • (Boolean) —

    Specifies whether the DB cluster is encrypted.

#tag_list ⇒ Array<Types::Tag> (readonly)

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

Returns:

#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership> (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,
  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,
  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 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 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.

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

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

    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:

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 isn\'t 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 you can retrieve the remaining results.

    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:

#members ⇒ Array<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,
  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,
})

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

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

See Also:

#option_groups ⇒ Array<OptionGroup>?

Returns:

#parameter_group ⇒ DBClusterParameterGroup?

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

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

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

    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:

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

  • :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 you can retrieve the remaining results.

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

    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:

See Also:

#subnet_group ⇒ DBSubnetGroup?

Returns: