class Aws::RDS::DBCluster
Public Class Methods
@overload def initialize(id, options = {})
@param [String] id @option options [Client] :client
@overload def initialize(options = {})
@option options [required, String] :id @option options [Client] :client
# File lib/aws-sdk-rds/db_cluster.rb, line 22 def initialize(*args) options = Hash === args.last ? args.pop.dup : {} @id = extract_id(args, options) @data = options.delete(:data) @client = options.delete(:client) || Client.new(options) @waiter_block_warned = false end
Public Instance Methods
The name of the Amazon Kinesis data stream used for the database activity stream. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 430 def activity_stream_kinesis_stream_name data[:activity_stream_kinesis_stream_name] end
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 423 def activity_stream_kms_key_id data[:activity_stream_kms_key_id] end
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. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 406 def activity_stream_mode data[:activity_stream_mode] end
The status of the database activity stream. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 412 def activity_stream_status data[:activity_stream_status] end
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. @return [Integer]
# File lib/aws-sdk-rds/db_cluster.rb, line 43 def allocated_storage data[:allocated_storage] end
Provides a list of the Amazon Web Services 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 Amazon Web Services on your behalf. @return [Array<Types::DBClusterRole>]
# File lib/aws-sdk-rds/db_cluster.rb, line 274 def associated_roles data[:associated_roles] end
The time when a stopped DB cluster is restarted automatically. @return [Time]
# File lib/aws-sdk-rds/db_cluster.rb, line 99 def automatic_restart_time data[:automatic_restart_time] end
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created. @return [Array<String>]
# File lib/aws-sdk-rds/db_cluster.rb, line 50 def availability_zones data[:availability_zones] end
The number of change records stored for Backtrack. @return [Integer]
# File lib/aws-sdk-rds/db_cluster.rb, line 315 def backtrack_consumed_change_records data[:backtrack_consumed_change_records] end
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled. @return [Integer]
# File lib/aws-sdk-rds/db_cluster.rb, line 309 def backtrack_window data[:backtrack_window] end
Specifies the number of days for which automatic DB snapshots are retained. @return [Integer]
# File lib/aws-sdk-rds/db_cluster.rb, line 57 def backup_retention_period data[:backup_retention_period] end
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*.
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html @return [Integer]
# File lib/aws-sdk-rds/db_cluster.rb, line 344 def capacity data[:capacity] end
If present, specifies the name of the character set that this cluster is associated with. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 64 def character_set_name data[:character_set_name] end
@return [Client]
# File lib/aws-sdk-rds/db_cluster.rb, line 495 def client @client end
Identifies the clone group to which the DB cluster is associated. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 288 def clone_group_id data[:clone_group_id] end
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC). @return [Time]
# File lib/aws-sdk-rds/db_cluster.rb, line 295 def cluster_create_time data[:cluster_create_time] end
@example Request syntax with placeholder values
dbcluster = db_cluster.create({ availability_zones: ["String"], backup_retention_period: 1, character_set_name: "String", database_name: "String", db_cluster_parameter_group_name: "String", vpc_security_group_ids: ["String"], db_subnet_group_name: "String", engine: "String", # required engine_version: "String", port: 1, master_username: "String", master_user_password: "String", option_group_name: "String", preferred_backup_window: "String", preferred_maintenance_window: "String", replication_source_identifier: "String", tags: [ { key: "String", value: "String", }, ], storage_encrypted: false, kms_key_id: "String", pre_signed_url: "String", enable_iam_database_authentication: false, backtrack_window: 1, enable_cloudwatch_logs_exports: ["String"], engine_mode: "String", scaling_configuration: { min_capacity: 1, max_capacity: 1, auto_pause: false, seconds_until_auto_pause: 1, timeout_action: "String", seconds_before_timeout: 1, }, deletion_protection: false, global_cluster_identifier: "String", enable_http_endpoint: false, copy_tags_to_snapshot: false, domain: "String", domain_iam_role_name: "String", enable_global_write_forwarding: false, source_region: "String", })
@param [Hash] options ({}) @option options [Array<String>] :availability_zones
A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see [Choosing the Regions and Availability Zones][1] in the *Amazon Aurora User Guide*. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html
@option options [Integer] :backup_retention_period
The number of days for which automated backups are retained. Default: 1 Constraints: * Must be a value from 1 to 35 ^
@option options [String] :character_set_name
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
@option options [String] :database_name
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.
@option options [String] :db_cluster_parameter_group_name
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. ^
@option options [Array<String>] :vpc_security_group_ids
A list of EC2 VPC security groups to associate with this DB cluster.
@option options [String] :db_subnet_group_name
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`
@option options [required, String] :engine
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`
@option options [String] :engine_version
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`
@option options [Integer] :port
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.
@option options [String] :master_username
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.
@option options [String] :master_user_password
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 options [String] :option_group_name
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.
@option options [String] :preferred_backup_window
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 Amazon Web Services Region. To view the time blocks available, see [ Backup window][1] 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. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
@option options [String] :preferred_maintenance_window
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 Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see [ Adjusting the Preferred DB Cluster Maintenance Window][1] in the *Amazon Aurora User Guide.* Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
@option options [String] :replication_source_identifier
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
@option options [Array<Types::Tag>] :tags
Tags to assign to the DB cluster.
@option options [Boolean] :storage_encrypted
A value that indicates whether the DB cluster is encrypted.
@option options [String] :kms_key_id
The Amazon Web Services KMS key identifier for an encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN. When a CMK isn't specified in `KmsKeyId`\: * If `ReplicationSourceIdentifier` identifies an encrypted source, then Amazon RDS will use the CMK used to encrypt the source. Otherwise, Amazon RDS will use your default CMK. * If the `StorageEncrypted` parameter is enabled and `ReplicationSourceIdentifier` isn't specified, then Amazon RDS will use your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region. If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you must set `KmsKeyId` to a Amazon Web Services KMS key identifier that is valid in the destination Amazon Web Services Region. This CMK is used to encrypt the read replica in that Amazon Web Services Region.
@option options [String] :pre_signed_url
A URL that contains a Signature Version 4 signed request for the `CreateDBCluster` action to be called in the source Amazon Web Services 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 Amazon Web Services Region that contains the encrypted DB cluster to be copied. The pre-signed URL request must contain the following parameter values: * `KmsKeyId` - The Amazon Web Services KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same Amazon Web Services KMS CMK for both the `CreateDBCluster` action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL. * `DestinationRegion` - The name of the Amazon Web Services 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 Amazon Web Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services 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 (Amazon Web Services Signature Version 4)][1] and [ Signature Version 4 Signing Process][2]. <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can specify `SourceRegion` (or `--source-region` for the 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 Amazon Web Services Region. </note> [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
@option options [Boolean] :enable_iam_database_authentication
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information, see [ IAM Database Authentication][1] in the *Amazon Aurora User Guide.* [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
@option options [Integer] :backtrack_window
The target backtrack window, in seconds. To disable backtracking, set this value to 0. <note markdown="1"> Currently, Backtrack is only supported for Aurora MySQL DB clusters. </note> Default: 0 Constraints: * If specified, this value must be set to a number from 0 to 259,200 (72 hours). ^
@option options [Array<String>] :enable_cloudwatch_logs_exports
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][1] in the *Amazon Aurora User Guide*. **Aurora MySQL** Possible values are `audit`, `error`, `general`, and `slowquery`. **Aurora PostgreSQL** Possible value is `postgresql`. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
@option options [String] :engine_mode
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*\: * [ Limitations of Aurora Serverless][1] * [ Limitations of Parallel Query][2] * [ Limitations of Aurora Global Databases][3] * [ Limitations of Multi-Master Clusters][4] [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations [3]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations [4]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations
@option options [Types::ScalingConfiguration] :scaling_configuration
For DB clusters in `serverless` DB engine mode, the scaling properties of the DB cluster.
@option options [Boolean] :deletion_protection
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.
@option options [String] :global_cluster_identifier
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
@option options [Boolean] :enable_http_endpoint
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][1] in the *Amazon Aurora User Guide*. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
@option options [Boolean] :copy_tags_to_snapshot
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.
@option options [String] :domain
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][1] in the *Amazon Aurora User Guide*. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
@option options [String] :domain_iam_role_name
Specify the name of the IAM role to be used when making API calls to the Directory Service.
@option options [Boolean] :enable_global_write_forwarding
A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.
@option options [String] :source_region
The source region of the snapshot. This is only needed when the shapshot is encrypted and in a different region.
@return [DBCluster]
# File lib/aws-sdk-rds/db_cluster.rb, line 1054 def create(options = {}) options = options.merge(db_cluster_identifier: @id) resp = @client.create_db_cluster(options) DBCluster.new( id: resp.data.db_cluster.db_cluster_identifier, data: resp.data.db_cluster, client: @client ) end
@example Request syntax with placeholder values
dbclustersnapshot = db_cluster.create_snapshot({ db_cluster_snapshot_identifier: "String", # required tags: [ { key: "String", value: "String", }, ], })
@param [Hash] options ({}) @option options [required, String] :db_cluster_snapshot_identifier
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`
@option options [Array<Types::Tag>] :tags
The tags to be assigned to the DB cluster snapshot.
@return [DBClusterSnapshot]
# File lib/aws-sdk-rds/db_cluster.rb, line 1092 def create_snapshot(options = {}) options = options.merge(db_cluster_identifier: @id) resp = @client.create_db_cluster_snapshot(options) DBClusterSnapshot.new( cluster_id: resp.data.db_cluster_snapshot.db_cluster_identifier, snapshot_id: resp.data.db_cluster_snapshot.db_cluster_snapshot_identifier, data: resp.data.db_cluster_snapshot, client: @client ) end
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account. @return [Boolean]
# File lib/aws-sdk-rds/db_cluster.rb, line 444 def cross_account_clone data[:cross_account_clone] end
Identifies all custom endpoints associated with the cluster. @return [Array<String>]
# File lib/aws-sdk-rds/db_cluster.rb, line 141 def custom_endpoints data[:custom_endpoints] end
@return [Types::DBCluster]
Returns the data for this {DBCluster}. Calls {Client#describe_db_clusters} if {#data_loaded?} is `false`.
# File lib/aws-sdk-rds/db_cluster.rb, line 515 def data load unless @data @data end
@return [Boolean]
Returns `true` if this resource is loaded. Accessing attributes or {#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-rds/db_cluster.rb, line 523 def data_loaded? !!@data end
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. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 72 def database_name data[:database_name] end
The Amazon Resource
Name (ARN) for the DB cluster. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 265 def db_cluster_arn data[:db_cluster_arn] end
Provides the list of instances that make up the DB cluster. @return [Array<Types::DBClusterMember>]
# File lib/aws-sdk-rds/db_cluster.rb, line 220 def db_cluster_members data[:db_cluster_members] end
Provides the list of option group memberships for this DB cluster. @return [Array<Types::DBClusterOptionGroupStatus>]
# File lib/aws-sdk-rds/db_cluster.rb, line 185 def db_cluster_option_group_memberships data[:db_cluster_option_group_memberships] end
Specifies the name of the DB cluster parameter group for the DB cluster. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 79 def db_cluster_parameter_group data[:db_cluster_parameter_group] end
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS CMK for the DB cluster is accessed. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 259 def db_cluster_resource_id data[:db_cluster_resource_id] end
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 87 def db_subnet_group data[:db_subnet_group] end
@example Request syntax with placeholder values
dbcluster = db_cluster.delete({ skip_final_snapshot: false, final_db_snapshot_identifier: "String", })
@param [Hash] options ({}) @option options [Boolean] :skip_final_snapshot
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. <note markdown="1"> You must specify a `FinalDBSnapshotIdentifier` parameter if `SkipFinalSnapshot` is disabled. </note>
@option options [String] :final_db_snapshot_identifier
The DB cluster snapshot identifier of the new DB cluster snapshot created when `SkipFinalSnapshot` is disabled. <note markdown="1"> Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the `SkipFinalShapshot` parameter results in an error. </note> 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
@return [DBCluster]
# File lib/aws-sdk-rds/db_cluster.rb, line 1140 def delete(options = {}) options = options.merge(db_cluster_identifier: @id) resp = @client.delete_db_cluster(options) DBCluster.new( id: resp.data.db_cluster.db_cluster_identifier, data: resp.data.db_cluster, client: @client ) end
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. @return [Boolean]
# File lib/aws-sdk-rds/db_cluster.rb, line 378 def deletion_protection data[:deletion_protection] end
The Active Directory Domain membership records associated with the DB cluster. @return [Array<Types::DomainMembership>]
# File lib/aws-sdk-rds/db_cluster.rb, line 451 def domain_memberships data[:domain_memberships] end
The earliest time to which a DB cluster can be backtracked. @return [Time]
# File lib/aws-sdk-rds/db_cluster.rb, line 301 def earliest_backtrack_time data[:earliest_backtrack_time] end
The earliest time to which a database can be restored with point-in-time restore. @return [Time]
# File lib/aws-sdk-rds/db_cluster.rb, line 112 def earliest_restorable_time data[:earliest_restorable_time] end
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.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html @return [Array<String>]
# File lib/aws-sdk-rds/db_cluster.rb, line 330 def enabled_cloudwatch_logs_exports data[:enabled_cloudwatch_logs_exports] end
Specifies the connection endpoint for the primary instance of the DB cluster. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 119 def endpoint data[:endpoint] end
The name of the database engine to be used for this DB cluster. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 154 def engine data[:engine] end
The DB engine mode of the DB cluster, either `provisioned`, `serverless`, `parallelquery`, `global`, or `multimaster`.
For more information, see [ CreateDBCluster].
[1]: docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 357 def engine_mode data[:engine_mode] end
Indicates the database engine version. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 160 def engine_version data[:engine_version] end
@example Request syntax with placeholder values
events = db_cluster.events({ start_time: Time.now, end_time: Time.now, duration: 1, event_categories: ["String"], filters: [ { name: "String", # required values: ["String"], # required }, ], })
@param [Hash] options ({}) @option options [Time,DateTime,Date,Integer,String] :start_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.][1] Example: 2009-07-08T18:00Z [1]: http://en.wikipedia.org/wiki/ISO_8601
@option options [Time,DateTime,Date,Integer,String] :end_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.][1] Example: 2009-07-08T18:00Z [1]: http://en.wikipedia.org/wiki/ISO_8601
@option options [Integer] :duration
The number of minutes to retrieve events for. Default: 60
@option options [Array<String>] :event_categories
A list of event categories that trigger notifications for a event notification subscription.
@option options [Array<Types::Filter>] :filters
This parameter isn't currently supported.
@return [Event::Collection]
# File lib/aws-sdk-rds/db_cluster.rb, line 1747 def events(options = {}) batches = Enumerator.new do |y| options = options.merge( source_type: "db-cluster", source_identifier: @id ) resp = @client.describe_events(options) resp.each_page do |page| batch = [] page.data.events.each do |e| batch << Event.new( source_id: e.source_identifier, date: e.date, data: e, client: @client ) end y.yield(batch) end end Event::Collection.new(batches) end
@example Request syntax with placeholder values
dbcluster = db_cluster.failover({ target_db_instance_identifier: "String", })
@param [Hash] options ({}) @option options [String] :target_db_instance_identifier
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`.
@return [DBCluster]
# File lib/aws-sdk-rds/db_cluster.rb, line 1162 def failover(options = {}) options = options.merge(db_cluster_identifier: @id) resp = @client.failover_db_cluster(options) DBCluster.new( id: resp.data.db_cluster.db_cluster_identifier, data: resp.data.db_cluster, client: @client ) end
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. @return [Boolean]
# File lib/aws-sdk-rds/db_cluster.rb, line 480 def global_write_forwarding_requested data[:global_write_forwarding_requested] end
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 470 def global_write_forwarding_status data[:global_write_forwarding_status] end
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 233 def hosted_zone_id data[:hosted_zone_id] end
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*.
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html @return [Boolean]
# File lib/aws-sdk-rds/db_cluster.rb, line 397 def http_endpoint_enabled data[:http_endpoint_enabled] end
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. @return [Boolean]
# File lib/aws-sdk-rds/db_cluster.rb, line 282 def iam_database_authentication_enabled data[:iam_database_authentication_enabled] end
@return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 33 def id @id end
@deprecated @api private
# File lib/aws-sdk-rds/db_cluster.rb, line 1927 def identifiers { id: @id } end
If `StorageEncrypted` is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 250 def kms_key_id data[:kms_key_id] end
Specifies the latest time to which a database can be restored with point-in-time restore. @return [Time]
# File lib/aws-sdk-rds/db_cluster.rb, line 167 def latest_restorable_time data[:latest_restorable_time] end
Loads, or reloads {#data} for the current {DBCluster}. Returns `self` making it possible to chain methods.
db_cluster.reload.data
@return [self]
# File lib/aws-sdk-rds/db_cluster.rb, line 505 def load resp = @client.describe_db_clusters(db_cluster_identifier: @id) @data = resp.db_clusters[0] self end
Contains the master username for the DB cluster. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 179 def master_username data[:master_username] end
@return [DBInstance::Collection]
# File lib/aws-sdk-rds/db_cluster.rb, line 1771 def members batch = [] data[:db_cluster_members].each do |d| batch << DBInstance.new( id: d[:db_instance_identifier], data: d, client: @client ) end DBInstance::Collection.new([batch], size: batch.size) end
@example Request syntax with placeholder values
dbcluster = db_cluster.modify({ new_db_cluster_identifier: "String", apply_immediately: false, backup_retention_period: 1, db_cluster_parameter_group_name: "String", vpc_security_group_ids: ["String"], port: 1, master_user_password: "String", option_group_name: "String", preferred_backup_window: "String", preferred_maintenance_window: "String", enable_iam_database_authentication: false, backtrack_window: 1, cloudwatch_logs_export_configuration: { enable_log_types: ["String"], disable_log_types: ["String"], }, engine_version: "String", allow_major_version_upgrade: false, db_instance_parameter_group_name: "String", domain: "String", domain_iam_role_name: "String", scaling_configuration: { min_capacity: 1, max_capacity: 1, auto_pause: false, seconds_until_auto_pause: 1, timeout_action: "String", seconds_before_timeout: 1, }, deletion_protection: false, enable_http_endpoint: false, copy_tags_to_snapshot: false, enable_global_write_forwarding: false, })
@param [Hash] options ({}) @option options [String] :new_db_cluster_identifier
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`
@option options [Boolean] :apply_immediately
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.
@option options [Integer] :backup_retention_period
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 ^
@option options [String] :db_cluster_parameter_group_name
The name of the DB cluster parameter group to use for the DB cluster.
@option options [Array<String>] :vpc_security_group_ids
A list of VPC security groups that the DB cluster will belong to.
@option options [Integer] :port
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.
@option options [String] :master_user_password
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 options [String] :option_group_name
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.
@option options [String] :preferred_backup_window
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 Amazon Web Services Region. To view the time blocks available, see [ Backup window][1] 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. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
@option options [String] :preferred_maintenance_window
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 Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see [ Adjusting the Preferred DB Cluster Maintenance Window][1] in the *Amazon Aurora User Guide.* Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
@option options [Boolean] :enable_iam_database_authentication
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information, see [ IAM Database Authentication][1] in the *Amazon Aurora User Guide.* [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
@option options [Integer] :backtrack_window
The target backtrack window, in seconds. To disable backtracking, set this value to 0. <note markdown="1"> Currently, Backtrack is only supported for Aurora MySQL DB clusters. </note> Default: 0 Constraints: * If specified, this value must be set to a number from 0 to 259,200 (72 hours). ^
@option options [Types::CloudwatchLogsExportConfiguration] :cloudwatch_logs_export_configuration
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
@option options [String] :engine_version
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"`
@option options [Boolean] :allow_major_version_upgrade
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.
@option options [String] :db_instance_parameter_group_name
The name of the DB parameter group to apply to all instances of the DB cluster. <note markdown="1"> 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. </note> 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.
@option options [String] :domain
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][1] in the *Amazon Aurora User Guide*. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
@option options [String] :domain_iam_role_name
Specify the name of the IAM role to be used when making API calls to the Directory Service.
@option options [Types::ScalingConfiguration] :scaling_configuration
The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in `serverless` DB engine mode.
@option options [Boolean] :deletion_protection
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.
@option options [Boolean] :enable_http_endpoint
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][1] in the *Amazon Aurora User Guide*. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
@option options [Boolean] :copy_tags_to_snapshot
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.
@option options [Boolean] :enable_global_write_forwarding
A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.
@return [DBCluster]
# File lib/aws-sdk-rds/db_cluster.rb, line 1455 def modify(options = {}) options = options.merge(db_cluster_identifier: @id) resp = @client.modify_db_cluster(options) DBCluster.new( id: resp.data.db_cluster.db_cluster_identifier, data: resp.data.db_cluster, client: @client ) end
Specifies whether the DB cluster has instances in multiple Availability Zones. @return [Boolean]
# File lib/aws-sdk-rds/db_cluster.rb, line 148 def multi_az data[:multi_az] end
@return [OptionGroup::Collection]
# File lib/aws-sdk-rds/db_cluster.rb, line 1784 def option_groups batch = [] data[:db_cluster_option_group_memberships].each do |d| batch << OptionGroup.new( name: d[:db_cluster_option_group_name], data: d, client: @client ) end OptionGroup::Collection.new([batch], size: batch.size) end
@return [DBClusterParameterGroup, nil]
# File lib/aws-sdk-rds/db_cluster.rb, line 1797 def parameter_group if data[:db_cluster_parameter_group] DBClusterParameterGroup.new( name: data[:db_cluster_parameter_group], client: @client ) else nil end end
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements. @return [Types::ClusterPendingModifiedValues]
# File lib/aws-sdk-rds/db_cluster.rb, line 488 def pending_modified_values data[:pending_modified_values] end
Specifies the progress of the operation as a percentage. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 105 def percent_progress data[:percent_progress] end
Specifies the port that the database engine is listening on. @return [Integer]
# File lib/aws-sdk-rds/db_cluster.rb, line 173 def port data[:port] end
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 193 def preferred_backup_window data[:preferred_backup_window] end
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 200 def preferred_maintenance_window data[:preferred_maintenance_window] end
Contains one or more identifiers of the read replicas associated with this DB cluster. @return [Array<String>]
# File lib/aws-sdk-rds/db_cluster.rb, line 214 def read_replica_identifiers data[:read_replica_identifiers] end
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. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 135 def reader_endpoint data[:reader_endpoint] end
Contains the identifier of the source DB cluster if this DB cluster is a read replica. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 207 def replication_source_identifier data[:replication_source_identifier] end
@example Request syntax with placeholder values
dbcluster = db_cluster.restore({ db_cluster_identifier: "String", # required restore_type: "String", restore_to_time: Time.now, use_latest_restorable_time: false, port: 1, db_subnet_group_name: "String", option_group_name: "String", vpc_security_group_ids: ["String"], tags: [ { key: "String", value: "String", }, ], kms_key_id: "String", enable_iam_database_authentication: false, backtrack_window: 1, enable_cloudwatch_logs_exports: ["String"], db_cluster_parameter_group_name: "String", deletion_protection: false, copy_tags_to_snapshot: false, domain: "String", domain_iam_role_name: "String", scaling_configuration: { min_capacity: 1, max_capacity: 1, auto_pause: false, seconds_until_auto_pause: 1, timeout_action: "String", seconds_before_timeout: 1, }, engine_mode: "String", })
@param [Hash] options ({}) @option options [required, String] :db_cluster_identifier
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
@option options [String] :restore_type
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.
@option options [Time,DateTime,Date,Integer,String] :restore_to_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`
@option options [Boolean] :use_latest_restorable_time
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.
@option options [Integer] :port
The port number on which the new DB cluster accepts connections. Constraints: A value from `1150-65535`. Default: The default port for the engine.
@option options [String] :db_subnet_group_name
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 options [String] :option_group_name
The name of the option group for the new DB cluster.
@option options [Array<String>] :vpc_security_group_ids
A list of VPC security groups that the new DB cluster belongs to.
@option options [Array<Types::Tag>] :tags
A list of tags. For more information, see [Tagging Amazon RDS Resources][1] in the *Amazon RDS User Guide.* [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
@option options [String] :kms_key_id
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN. You can restore to a new DB cluster and encrypt the new DB cluster with a Amazon Web Services KMS CMK that is different than the Amazon Web Services KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the Amazon Web Services KMS CMK 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 Amazon Web Services KMS CMK 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.
@option options [Boolean] :enable_iam_database_authentication
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information, see [ IAM Database Authentication][1] in the *Amazon Aurora User Guide.* [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
@option options [Integer] :backtrack_window
The target backtrack window, in seconds. To disable backtracking, set this value to 0. <note markdown="1"> Currently, Backtrack is only supported for Aurora MySQL DB clusters. </note> Default: 0 Constraints: * If specified, this value must be set to a number from 0 to 259,200 (72 hours). ^
@option options [Array<String>] :enable_cloudwatch_logs_exports
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][1] in the *Amazon Aurora User Guide*. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
@option options [String] :db_cluster_parameter_group_name
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.
@option options [Boolean] :deletion_protection
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.
@option options [Boolean] :copy_tags_to_snapshot
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.
@option options [String] :domain
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][1] in the *Amazon Aurora User Guide*. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
@option options [String] :domain_iam_role_name
Specify the name of the IAM role to be used when making API calls to the Directory Service.
@option options [Types::ScalingConfiguration] :scaling_configuration
For DB clusters in `serverless` DB engine mode, the scaling properties of the DB cluster.
@option options [String] :engine_mode
The engine mode of the new cluster. Specify `provisioned` or `serverless`, depending on the type of the cluster you are creating. You can create an Aurora Serverless clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or an encrypted provisioned cluster.
@return [DBCluster]
# File lib/aws-sdk-rds/db_cluster.rb, line 1690 def restore(options = {}) options = options.merge(source_db_cluster_identifier: @id) resp = @client.restore_db_cluster_to_point_in_time(options) DBCluster.new( id: resp.data.db_cluster.db_cluster_identifier, data: resp.data.db_cluster, client: @client ) end
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*.
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html @return [Types::ScalingConfigurationInfo]
# File lib/aws-sdk-rds/db_cluster.rb, line 371 def scaling_configuration_info data[:scaling_configuration_info] end
@example Request syntax with placeholder values
snapshots = db_cluster.snapshots({ db_cluster_snapshot_identifier: "String", snapshot_type: "String", filters: [ { name: "String", # required values: ["String"], # required }, ], include_shared: false, include_public: false, })
@param [Hash] options ({}) @option options [String] :db_cluster_snapshot_identifier
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.
@option options [String] :snapshot_type
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 Amazon Web Services account. * `manual` - Return all DB cluster snapshots that have been taken by my Amazon Web Services account. * `shared` - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services 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`.
@option options [Array<Types::Filter>] :filters
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.
@option options [Boolean] :include_shared
A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included. You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the `ModifyDBClusterSnapshotAttribute` API action.
@option options [Boolean] :include_public
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services 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.
@return [DBClusterSnapshot::Collection]
# File lib/aws-sdk-rds/db_cluster.rb, line 1893 def snapshots(options = {}) batches = Enumerator.new do |y| options = options.merge(db_cluster_identifier: @id) resp = @client.describe_db_cluster_snapshots(options) resp.each_page do |page| batch = [] page.data.db_cluster_snapshots.each do |d| batch << DBClusterSnapshot.new( cluster_id: @id, snapshot_id: d.db_cluster_snapshot_identifier, data: d, client: @client ) end y.yield(batch) end end DBClusterSnapshot::Collection.new(batches) end
Specifies the current state of this DB cluster. @return [String]
# File lib/aws-sdk-rds/db_cluster.rb, line 93 def status data[:status] end
Specifies whether the DB cluster is encrypted. @return [Boolean]
# File lib/aws-sdk-rds/db_cluster.rb, line 239 def storage_encrypted data[:storage_encrypted] end
@return [DBSubnetGroup, nil]
# File lib/aws-sdk-rds/db_cluster.rb, line 1914 def subnet_group if data[:db_subnet_group] DBSubnetGroup.new( name: data[:db_subnet_group], client: @client ) else nil end end
A list of tags. For more information, see [Tagging Amazon RDS
Resources] in the *Amazon RDS
User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html @return [Array<Types::Tag>]
# File lib/aws-sdk-rds/db_cluster.rb, line 462 def tag_list data[:tag_list] end
Provides a list of VPC security groups that the DB cluster belongs to. @return [Array<Types::VpcSecurityGroupMembership>]
# File lib/aws-sdk-rds/db_cluster.rb, line 226 def vpc_security_groups data[:vpc_security_groups] end
@deprecated Use [Aws::RDS::Client] wait_until
instead
Waiter polls an API operation until a resource enters a desired state.
@note The waiting operation is performed on a copy. The original resource
remains unchanged.
## Basic Usage
Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.
# polls in a loop until condition is true resource.wait_until(options) {|resource| condition}
## Example
instance.wait_until(max_attempts:10, delay:5) do |instance| instance.state.name == 'running' end
## Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to {#wait_until}:
# poll for ~25 seconds resource.wait_until(max_attempts:5,delay:5) {|resource|...}
## Callbacks
You can be notified before each polling attempt and before each delay. If you throw `:success` or `:failure` from these callbacks, it will terminate the waiter.
started_at = Time.now # poll for 1 hour, instead of a number of attempts proc = Proc.new do |attempts, response| throw :failure if Time.now - started_at > 3600 end # disable max attempts instance.wait_until(before_wait:proc, max_attempts:nil) {...}
## Handling Errors
When a waiter is successful, it returns the Resource
. When a waiter fails, it raises an error.
begin resource.wait_until(...) rescue Aws::Waiters::Errors::WaiterFailed # resource did not enter the desired state in time end
@yieldparam [Resource] resource to be used in the waiting condition.
@raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
terminates because the waiter has entered a state that it will not transition out of, preventing success. yet successful.
@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
encountered while polling for a resource that is not expected.
@raise [NotImplementedError] Raised when the resource does not
@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful
# File lib/aws-sdk-rds/db_cluster.rb, line 607 def wait_until(options = {}, &block) self_copy = self.dup attempts = 0 options[:max_attempts] = 10 unless options.key?(:max_attempts) options[:delay] ||= 10 options[:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == options[:max_attempts] :retry end end Aws::Waiters::Waiter.new(options).wait({}) end
Private Instance Methods
# File lib/aws-sdk-rds/db_cluster.rb, line 1934 def extract_id(args, options) value = args[0] || options.delete(:id) case value when String then value when nil then raise ArgumentError, "missing required option :id" else msg = "expected :id to be a String, got #{value.class}" raise ArgumentError, msg end end