class Aws::RDS::DBSnapshot
Public Class Methods
@overload def initialize(instance_id
, snapshot_id
, options = {})
@param [String] instance_id @param [String] snapshot_id @option options [Client] :client
@overload def initialize(options = {})
@option options [required, String] :instance_id @option options [required, String] :snapshot_id @option options [Client] :client
# File lib/aws-sdk-rds/db_snapshot.rb, line 24 def initialize(*args) options = Hash === args.last ? args.pop.dup : {} @instance_id = extract_instance_id(args, options) @snapshot_id = extract_snapshot_id(args, options) @data = options.delete(:data) @client = options.delete(:client) || Client.new(options) @waiter_block_warned = false end
Public Instance Methods
Specifies the allocated storage size in gibibytes (GiB). @return [Integer]
# File lib/aws-sdk-rds/db_snapshot.rb, line 62 def allocated_storage data[:allocated_storage] end
@example Request syntax with placeholder values
db_snapshot.attributes()
@param [Hash] options ({}) @return [DBSnapshotAttribute::Collection]
# File lib/aws-sdk-rds/db_snapshot.rb, line 947 def attributes(options = {}) batches = Enumerator.new do |y| batch = [] options = options.merge(db_snapshot_identifier: @snapshot_id) resp = @client.describe_db_snapshot_attributes(options) resp.data.db_snapshot_attributes_result.db_snapshot_attributes.each do |d| batch << DBSnapshotAttribute.new( snapshot_id: @snapshot_id, name: d.attribute_name, data: d, client: @client ) end y.yield(batch) end DBSnapshotAttribute::Collection.new(batches) end
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot. @return [String]
# File lib/aws-sdk-rds/db_snapshot.rb, line 82 def availability_zone data[:availability_zone] end
@return [Client]
# File lib/aws-sdk-rds/db_snapshot.rb, line 244 def client @client end
@example Request syntax with placeholder values
dbsnapshot = db_snapshot.copy({ target_db_snapshot_identifier: "String", # required kms_key_id: "String", tags: [ { key: "String", value: "String", }, ], copy_tags: false, pre_signed_url: "String", option_group_name: "String", target_custom_availability_zone: "String", source_region: "String", })
@param [Hash] options ({}) @option options [required, String] :target_db_snapshot_identifier
The identifier for the copy of the snapshot. Constraints: * Can't be null, empty, or blank * Must contain from 1 to 255 letters, numbers, or hyphens * First character must be a letter * Can't end with a hyphen or contain two consecutive hyphens Example: `my-db-snapshot`
@option options [String] :kms_key_id
The Amazon Web Services KMS key identifier for an encrypted DB snapshot. 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). If you copy an encrypted DB snapshot from your Amazon Web Services account, you can specify a value for this parameter to encrypt the copy with a new Amazon Web Services KMS CMK. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot. If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, then you must specify a value for this parameter. If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted. If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify a Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.
@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 [Boolean] :copy_tags
A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags are not copied.
@option options [String] :pre_signed_url
The URL that contains a Signature Version 4 signed request for the `CopyDBSnapshot` API action in the source Amazon Web Services Region that contains the source DB snapshot to copy. You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don't specify `PreSignedUrl` when you are copying an encrypted DB snapshot in the same Amazon Web Services Region. The presigned URL must be a valid request for the `CopyDBSnapshot` API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values: * `DestinationRegion` - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services Region is the same one where the `CopyDBSnapshot` action is called that contains this presigned URL. For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the `CopyDBSnapshot` action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the `CopyDBSnapshot` action in the us-west-2 Amazon Web Services Region. For this example, the `DestinationRegion` in the presigned URL must be set to the us-east-1 Amazon Web Services Region. * `KmsKeyId` - The Amazon Web Services KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the `CopyDBSnapshot` action that is called in the destination Amazon Web Services Region, and the action contained in the presigned URL. * `SourceDBSnapshotIdentifier` - The DB snapshot identifier for the encrypted snapshot 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 snapshot from the us-west-2 Amazon Web Services Region, then your `SourceDBSnapshotIdentifier` looks like the following example: `arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115`. 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 [String] :option_group_name
The name of an option group to associate with the copy of the snapshot. Specify this option if you are copying a snapshot from one Amazon Web Services Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across Amazon Web Services Regions. For more information, see [Option group considerations][1] in the *Amazon RDS User Guide.* [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options
@option options [String] :target_custom_availability_zone
The external custom Availability Zone (CAZ) identifier for the target CAZ. Example: `rds-caz-aiqhTgQv`.
@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 [DBSnapshot]
# File lib/aws-sdk-rds/db_snapshot.rb, line 561 def copy(options = {}) options = options.merge(source_db_snapshot_identifier: @snapshot_id) resp = @client.copy_db_snapshot(options) DBSnapshot.new( instance_id: resp.data.db_snapshot.db_instance_identifier, snapshot_id: resp.data.db_snapshot.db_snapshot_identifier, data: resp.data.db_snapshot, client: @client ) end
@example Request syntax with placeholder values
dbsnapshot = db_snapshot.create({ tags: [ { key: "String", value: "String", }, ], })
@param [Hash] options ({}) @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
@return [DBSnapshot]
# File lib/aws-sdk-rds/db_snapshot.rb, line 394 def create(options = {}) options = options.merge( db_instance_identifier: @instance_id, db_snapshot_identifier: @snapshot_id ) resp = @client.create_db_snapshot(options) DBSnapshot.new( instance_id: resp.data.db_snapshot.db_instance_identifier, snapshot_id: resp.data.db_snapshot.db_snapshot_identifier, data: resp.data.db_snapshot, client: @client ) end
@return [Types::DBSnapshot]
Returns the data for this {DBSnapshot}. Calls {Client#describe_db_snapshots} if {#data_loaded?} is `false`.
# File lib/aws-sdk-rds/db_snapshot.rb, line 264 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_snapshot.rb, line 272 def data_loaded? !!@data end
The Amazon Resource
Name (ARN) for the DB snapshot. @return [String]
# File lib/aws-sdk-rds/db_snapshot.rb, line 189 def db_snapshot_arn data[:db_snapshot_arn] end
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region. @return [String]
# File lib/aws-sdk-rds/db_snapshot.rb, line 219 def dbi_resource_id data[:dbi_resource_id] end
@example Request syntax with placeholder values
db_snapshot.delete()
@param [Hash] options ({}) @return [DBSnapshot]
# File lib/aws-sdk-rds/db_snapshot.rb, line 577 def delete(options = {}) options = options.merge(db_snapshot_identifier: @snapshot_id) resp = @client.delete_db_snapshot(options) DBSnapshot.new( instance_id: resp.data.db_snapshot.db_instance_identifier, snapshot_id: resp.data.db_snapshot.db_snapshot_identifier, data: resp.data.db_snapshot, client: @client ) end
Specifies whether the DB snapshot is encrypted. @return [Boolean]
# File lib/aws-sdk-rds/db_snapshot.rb, line 172 def encrypted data[:encrypted] end
Specifies the name of the database engine. @return [String]
# File lib/aws-sdk-rds/db_snapshot.rb, line 56 def engine data[:engine] end
Specifies the version of the database engine. @return [String]
# File lib/aws-sdk-rds/db_snapshot.rb, line 107 def engine_version data[:engine_version] end
@example Request syntax with placeholder values
events = db_snapshot.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_snapshot.rb, line 1010 def events(options = {}) batches = Enumerator.new do |y| options = options.merge( source_type: "db-snapshot", source_identifier: @snapshot_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
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. @return [Boolean]
# File lib/aws-sdk-rds/db_snapshot.rb, line 205 def iam_database_authentication_enabled data[:iam_database_authentication_enabled] end
@deprecated @api private
# File lib/aws-sdk-rds/db_snapshot.rb, line 1055 def identifiers { instance_id: @instance_id, snapshot_id: @snapshot_id } end
@return [DBInstance]
# File lib/aws-sdk-rds/db_snapshot.rb, line 1034 def instance DBInstance.new( id: @instance_id, client: @client ) end
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created. @return [Time]
# File lib/aws-sdk-rds/db_snapshot.rb, line 95 def instance_create_time data[:instance_create_time] end
@return [String]
# File lib/aws-sdk-rds/db_snapshot.rb, line 36 def instance_id @instance_id end
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot. @return [Integer]
# File lib/aws-sdk-rds/db_snapshot.rb, line 126 def iops data[:iops] end
If `Encrypted` is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.
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_snapshot.rb, line 183 def kms_key_id data[:kms_key_id] end
License model information for the restored DB instance. @return [String]
# File lib/aws-sdk-rds/db_snapshot.rb, line 113 def license_model data[:license_model] end
Loads, or reloads {#data} for the current {DBSnapshot}. Returns `self` making it possible to chain methods.
db_snapshot.reload.data
@return [self]
# File lib/aws-sdk-rds/db_snapshot.rb, line 254 def load resp = @client.describe_db_snapshots(db_snapshot_identifier: @snapshot_id) @data = resp.db_snapshots[0] self end
Provides the master username for the DB snapshot. @return [String]
# File lib/aws-sdk-rds/db_snapshot.rb, line 101 def master_username data[:master_username] end
@return [OptionGroup, nil]
# File lib/aws-sdk-rds/db_snapshot.rb, line 1042 def option_group if data[:db_snapshot][:option_group_name] OptionGroup.new( name: data[:db_snapshot][:option_group_name], client: @client ) else nil end end
Provides the option group name for the DB snapshot. @return [String]
# File lib/aws-sdk-rds/db_snapshot.rb, line 132 def option_group_name data[:option_group_name] end
Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied. @return [Time]
# File lib/aws-sdk-rds/db_snapshot.rb, line 237 def original_snapshot_create_time data[:original_snapshot_create_time] end
The percentage of the estimated data that has been transferred. @return [Integer]
# File lib/aws-sdk-rds/db_snapshot.rb, line 138 def percent_progress data[:percent_progress] end
Specifies the port that the database engine was listening on at the time of the snapshot. @return [Integer]
# File lib/aws-sdk-rds/db_snapshot.rb, line 75 def port data[:port] end
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created. @return [Array<Types::ProcessorFeature>]
# File lib/aws-sdk-rds/db_snapshot.rb, line 212 def processor_features data[:processor_features] end
@example Request syntax with placeholder values
dbinstance = db_snapshot.restore({ db_instance_identifier: "String", # required db_instance_class: "String", port: 1, availability_zone: "String", db_subnet_group_name: "String", multi_az: false, publicly_accessible: false, auto_minor_version_upgrade: false, license_model: "String", db_name: "String", engine: "String", iops: 1, option_group_name: "String", tags: [ { key: "String", value: "String", }, ], storage_type: "String", tde_credential_arn: "String", tde_credential_password: "String", vpc_security_group_ids: ["String"], domain: "String", copy_tags_to_snapshot: false, domain_iam_role_name: "String", enable_iam_database_authentication: false, enable_cloudwatch_logs_exports: ["String"], processor_features: [ { name: "String", value: "String", }, ], use_default_processor_features: false, db_parameter_group_name: "String", deletion_protection: false, enable_customer_owned_ip: false, })
@param [Hash] options ({}) @option options [required, String] :db_instance_identifier
Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive. Constraints: * Must contain from 1 to 63 numbers, letters, or hyphens * First character must be a letter * Can't end with a hyphen or contain two consecutive hyphens Example: `my-snapshot-id`
@option options [String] :db_instance_class
The compute and memory capacity of the Amazon RDS DB instance, for example, `db.m4.large`. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB Instance Class][1] in the *Amazon RDS User Guide.* Default: The same DBInstanceClass as the original DB instance. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
@option options [Integer] :port
The port number on which the database accepts connections. Default: The same port as the original DB instance Constraints: Value must be `1150-65535`
@option options [String] :availability_zone
The Availability Zone (AZ) where the DB instance will be created. Default: A random, system-chosen Availability Zone. Constraint: You can't specify the `AvailabilityZone` parameter if the DB instance is a Multi-AZ deployment. Example: `us-east-1a`
@option options [String] :db_subnet_group_name
The DB subnet group name to use for the new instance. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: `mySubnetgroup`
@option options [Boolean] :multi_az
A value that indicates whether the DB instance is a Multi-AZ deployment. Constraint: You can't specify the `AvailabilityZone` parameter if the DB instance is a Multi-AZ deployment.
@option options [Boolean] :publicly_accessible
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
@option options [Boolean] :auto_minor_version_upgrade
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
@option options [String] :license_model
License model information for the restored DB instance. Default: Same as source. Valid values: `license-included` \| `bring-your-own-license` \| `general-public-license`
@option options [String] :db_name
The database name for the restored DB instance. <note markdown="1"> This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. </note>
@option options [String] :engine
The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot. Valid Values: * `mariadb` * `mysql` * `oracle-ee` * `oracle-ee-cdb` * `oracle-se2` * `oracle-se2-cdb` * `postgres` * `sqlserver-ee` * `sqlserver-se` * `sqlserver-ex` * `sqlserver-web`
@option options [Integer] :iops
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts. The provisioned IOPS value must follow the requirements for your database engine. For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance][1] in the *Amazon RDS User Guide.* Constraints: Must be an integer greater than 1000. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
@option options [String] :option_group_name
The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
@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] :storage_type
Specifies the storage type to be associated with the DB instance. Valid values: `standard | gp2 | io1` If you specify `io1`, you must also include a value for the `Iops` parameter. Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
@option options [String] :tde_credential_arn
The ARN from the key store with which to associate the instance for TDE encryption.
@option options [String] :tde_credential_password
The password for the given ARN from the key store in order to access the device.
@option options [Array<String>] :vpc_security_group_ids
A list of EC2 VPC security groups to associate with this DB instance. Default: The default EC2 VPC security group for the DB subnet group's VPC.
@option options [String] :domain
Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see [ Kerberos Authentication][1] in the *Amazon RDS User Guide*. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
@option options [Boolean] :copy_tags_to_snapshot
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
@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_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 about IAM database authentication, see [ IAM Database Authentication for MySQL and PostgreSQL][1] in the *Amazon RDS User Guide.* [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
@option options [Array<String>] :enable_cloudwatch_logs_exports
The list of logs that the restored DB instance 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 RDS User Guide*. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
@option options [Array<Types::ProcessorFeature>] :processor_features
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
@option options [Boolean] :use_default_processor_features
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
@option options [String] :db_parameter_group_name
The name of the DB parameter group to associate with this DB instance. If you do not specify a value for `DBParameterGroupName`, then the default `DBParameterGroup` for the specified DB engine is used. Constraints: * If supplied, must match the name of an existing DBParameterGroup. * 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 instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [ Deleting a DB Instance][1]. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html
@option options [Boolean] :enable_customer_owned_ip
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. A *CoIP* provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. For more information about RDS on Outposts, see [Working with Amazon RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User Guide*. For more information about CoIPs, see [Customer-owned IP addresses][2] in the *Amazon Web Services Outposts User Guide*. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
@return [DBInstance]
# File lib/aws-sdk-rds/db_snapshot.rb, line 890 def restore(options = {}) options = options.merge(db_snapshot_identifier: @snapshot_id) resp = @client.restore_db_instance_from_db_snapshot(options) DBInstance.new( id: resp.data.db_instance.db_instance_identifier, data: resp.data.db_instance, client: @client ) end
Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied. @return [Time]
# File lib/aws-sdk-rds/db_snapshot.rb, line 50 def snapshot_create_time data[:snapshot_create_time] end
@return [String]
# File lib/aws-sdk-rds/db_snapshot.rb, line 42 def snapshot_id @snapshot_id end
Provides the type of the DB snapshot. @return [String]
# File lib/aws-sdk-rds/db_snapshot.rb, line 119 def snapshot_type data[:snapshot_type] end
The DB snapshot Amazon Resource
Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy. @return [String]
# File lib/aws-sdk-rds/db_snapshot.rb, line 153 def source_db_snapshot_identifier data[:source_db_snapshot_identifier] end
The Amazon Web Services Region that the DB snapshot was created in or copied from. @return [String]
# File lib/aws-sdk-rds/db_snapshot.rb, line 145 def source_region data[:source_region] end
Specifies the status of this DB snapshot. @return [String]
# File lib/aws-sdk-rds/db_snapshot.rb, line 68 def status data[:status] end
Specifies the storage type associated with DB snapshot. @return [String]
# File lib/aws-sdk-rds/db_snapshot.rb, line 159 def storage_type data[:storage_type] end
@example Request syntax with placeholder values
eventsubscription = db_snapshot.subscribe_to({ subscription_name: "String", # required })
@param [Hash] options ({}) @option options [required, String] :subscription_name
The name of the RDS event notification subscription you want to add a source identifier to.
@return [EventSubscription]
# File lib/aws-sdk-rds/db_snapshot.rb, line 910 def subscribe_to(options = {}) options = options.merge(source_identifier: @snapshot_id) resp = @client.add_source_identifier_to_subscription(options) EventSubscription.new( name: resp.data.event_subscription.cust_subscription_id, data: resp.data.event_subscription, client: @client ) 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_snapshot.rb, line 230 def tag_list data[:tag_list] end
The ARN from the key store with which to associate the instance for TDE encryption. @return [String]
# File lib/aws-sdk-rds/db_snapshot.rb, line 166 def tde_credential_arn data[:tde_credential_arn] end
The time zone of the DB snapshot. In most cases, the `Timezone` element is empty. `Timezone` content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified. @return [String]
# File lib/aws-sdk-rds/db_snapshot.rb, line 198 def timezone data[:timezone] end
@example Request syntax with placeholder values
eventsubscription = db_snapshot.unsubscribe_from({ subscription_name: "String", # required })
@param [Hash] options ({}) @option options [required, String] :subscription_name
The name of the RDS event notification subscription you want to remove a source identifier from.
@return [EventSubscription]
# File lib/aws-sdk-rds/db_snapshot.rb, line 930 def unsubscribe_from(options = {}) options = options.merge(source_identifier: @snapshot_id) resp = @client.remove_source_identifier_from_subscription(options) EventSubscription.new( name: resp.data.event_subscription.cust_subscription_id, data: resp.data.event_subscription, client: @client ) end
Provides the VPC ID associated with the DB snapshot. @return [String]
# File lib/aws-sdk-rds/db_snapshot.rb, line 88 def vpc_id data[:vpc_id] 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_snapshot.rb, line 356 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_snapshot.rb, line 1065 def extract_instance_id(args, options) value = args[0] || options.delete(:instance_id) case value when String then value when nil then raise ArgumentError, "missing required option :instance_id" else msg = "expected :instance_id to be a String, got #{value.class}" raise ArgumentError, msg end end
# File lib/aws-sdk-rds/db_snapshot.rb, line 1076 def extract_snapshot_id(args, options) value = args[1] || options.delete(:snapshot_id) case value when String then value when nil then raise ArgumentError, "missing required option :snapshot_id" else msg = "expected :snapshot_id to be a String, got #{value.class}" raise ArgumentError, msg end end