Class: Aws::RDS::DBSnapshot

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-rds/db_snapshot.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(instance_id, snapshot_id, options = {}) ⇒ DBSnapshot #initialize(options = {}) ⇒ DBSnapshot

Returns a new instance of DBSnapshot.

Overloads:

  • #initialize(instance_id, snapshot_id, options = {}) ⇒ DBSnapshot

    Parameters:

    • instance_id (String)
    • snapshot_id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ DBSnapshot

    Options Hash (options):

    • :instance_id (required, String)
    • :snapshot_id (required, String)
    • :client (Client) 


21
22
23
24
25
26
27
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 21

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

Instance Method Details

#allocated_storage ⇒ Integer

Specifies the allocated storage size in gibibytes (GiB).

Returns:

  • (Integer) 


58
59
60
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 58

def allocated_storage
  data[:allocated_storage]
end

#attributes(options = {}) ⇒ DBSnapshotAttribute::Collection

Examples:

Request syntax with placeholder values


db_snapshot.attributes()

Parameters:

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

    ({})

Returns:



853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 853

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

#availability_zone ⇒ String

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

Returns:

  • (String) 


78
79
80
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 78

def availability_zone
  data[:availability_zone]
end

#client ⇒ Client

Returns:



217
218
219
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 217

def client
  @client
end

#copy(options = {}) ⇒ DBSnapshot

Examples:

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

Parameters:

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

    ({})

Options Hash (options):

  • :target_db_snapshot_identifier (required, String) —

    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`

  • :kms_key_id (String) —

    The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don’t specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

    If you copy an encrypted DB snapshot that is shared from another AWS 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 AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can’t use encryption keys from one AWS Region in another AWS Region.

  • :tags (Array<Types::Tag>) —

    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

  • :copy_tags (Boolean) —

    True to copy all tags from the source DB snapshot to the target DB snapshot, and otherwise false. The default is false.

  • :pre_signed_url (String) —

    The URL that contains a Signature Version 4 signed request for the ‘CopyDBSnapshot` API action in the source AWS Region that contains the source DB snapshot to copy.

    You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. You can specify the ‘–source-region` option instead of this parameter when you copy an encrypted DB snapshot from another AWS Region by using the AWS CLI.

    The presigned URL must be a valid request for the ‘CopyDBSnapshot` API action that can be executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values:

    • ‘DestinationRegion` - The AWS Region that the encrypted DB snapshot is copied to. This AWS 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 AWS Region to the us-east-1 AWS Region, then you call the ‘CopyDBSnapshot` action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the `CopyDBSnapshot` action in the us-west-2 AWS Region. For this example, the `DestinationRegion` in the presigned URL must be set to the us-east-1 AWS Region.

    • ‘KmsKeyId` - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the `CopyDBSnapshot` action that is called in the destination AWS 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 AWS Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 AWS 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 (AWS Signature Version 4)] and [Signature Version 4 Signing Process].

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

  • :option_group_name (String) —

    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 AWS 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 AWS Regions. For more information, see [Option Group Considerations] in the *Amazon RDS User Guide.*

    [1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options

  • :destination_region (String)
  • :source_region (String) —

    The source region of the snapshot. This is only needed when the shapshot is encrypted and in a different region.

Returns:



508
509
510
511
512
513
514
515
516
517
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 508

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

#create(options = {}) ⇒ DBSnapshot

Examples:

Request syntax with placeholder values


dbsnapshot = db_snapshot.create({
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

Returns:



365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 365

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

#data ⇒ Types::DBSnapshot

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

Returns:



237
238
239
240
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 237

def data
  load unless @data
  @data
end

#data_loaded? ⇒ Boolean

Returns ‘true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean) —

    Returns ‘true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



245
246
247
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 245

def data_loaded?
  !!@data
end

#db_snapshot_arn ⇒ String

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

Returns:

  • (String) 


180
181
182
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 180

def db_snapshot_arn
  data[:db_snapshot_arn]
end

#dbi_resource_id ⇒ String

The identifier for the source DB instance, which can’t be changed and which is unique to an AWS Region.

Returns:

  • (String) 


210
211
212
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 210

def dbi_resource_id
  data[:dbi_resource_id]
end

#delete(options = {}) ⇒ DBSnapshot

Examples:

Request syntax with placeholder values


db_snapshot.delete()

Parameters:

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

    ({})

Returns:



524
525
526
527
528
529
530
531
532
533
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 524

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

#encrypted ⇒ Boolean

Specifies whether the DB snapshot is encrypted.

Returns:

  • (Boolean) 


167
168
169
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 167

def encrypted
  data[:encrypted]
end

#engine ⇒ String

Specifies the name of the database engine.

Returns:

  • (String) 


52
53
54
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 52

def engine
  data[:engine]
end

#engine_version ⇒ String

Specifies the version of the database engine.

Returns:

  • (String) 


103
104
105
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 103

def engine_version
  data[:engine_version]
end

#events(options = {}) ⇒ Event::Collection

Examples:

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

Parameters:

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

    ({})

Options Hash (options):

  • :start_time (Time, DateTime, Date, Integer, String) —

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the

    ISO8601 Wikipedia page.][1

    Example: 2009-07-08T18:00Z

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

  • :end_time (Time, DateTime, Date, Integer, String) —

    The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the

    ISO8601 Wikipedia page.][1

    Example: 2009-07-08T18:00Z

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

  • :duration (Integer) —

    The number of minutes to retrieve events for.

    Default: 60

  • :event_categories (Array<String>) —

    A list of event categories that trigger notifications for a event notification subscription.

  • :filters (Array<Types::Filter>) —

    This parameter is not currently supported.

Returns:



916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 916

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

#iam_database_authentication_enabled ⇒ Boolean

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

Returns:

  • (Boolean) 


196
197
198
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 196

def iam_database_authentication_enabled
  data[:iam_database_authentication_enabled]
end

#identifiers ⇒ Object

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

Deprecated. 


961
962
963
964
965
966
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 961

def identifiers
  {
    instance_id: @instance_id,
    snapshot_id: @snapshot_id
  }
end

#instance ⇒ DBInstance

Returns:



940
941
942
943
944
945
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 940

def instance
  DBInstance.new(
    id: @instance_id,
    client: @client
  )
end

#instance_create_time ⇒ Time

Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).

Returns:

  • (Time) 


91
92
93
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 91

def instance_create_time
  data[:instance_create_time]
end

#instance_id ⇒ String Also known as: db_instance_identifier

Returns:

  • (String) 


32
33
34
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 32

def instance_id
  @instance_id
end

#iops ⇒ Integer

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

Returns:

  • (Integer) 


122
123
124
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 122

def iops
  data[:iops]
end

#kms_key_id ⇒ String

If ‘Encrypted` is true, the AWS KMS key identifier for the encrypted DB snapshot.

Returns:

  • (String) 


174
175
176
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 174

def kms_key_id
  data[:kms_key_id]
end

#license_model ⇒ String

License model information for the restored DB instance.

Returns:

  • (String) 


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

def license_model
  data[:license_model]
end

#load ⇒ self Also known as: reload

Loads, or reloads #data for the current Aws::RDS::DBSnapshot. Returns ‘self` making it possible to chain methods.

db_snapshot.reload.data

Returns:

  • (self) 


227
228
229
230
231
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 227

def load
  resp = @client.describe_db_snapshots(db_snapshot_identifier: @snapshot_id)
  @data = resp.db_snapshots[0]
  self
end

#master_username ⇒ String

Provides the master username for the DB snapshot.

Returns:

  • (String) 


97
98
99
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 97

def master_username
  data[:master_username]
end

#option_group ⇒ OptionGroup?

Returns:



948
949
950
951
952
953
954
955
956
957
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 948

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

#option_group_name ⇒ String

Provides the option group name for the DB snapshot.

Returns:

  • (String) 


128
129
130
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 128

def option_group_name
  data[:option_group_name]
end

#percent_progress ⇒ Integer

The percentage of the estimated data that has been transferred.

Returns:

  • (Integer) 


134
135
136
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 134

def percent_progress
  data[:percent_progress]
end

#port ⇒ Integer

Specifies the port that the database engine was listening on at the time of the snapshot.

Returns:

  • (Integer) 


71
72
73
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 71

def port
  data[:port]
end

#processor_features ⇒ Array<Types::ProcessorFeature>

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.

Returns:



203
204
205
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 203

def processor_features
  data[:processor_features]
end

#restore(options = {}) ⇒ DBInstance

Examples:

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

Parameters:

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

    ({})

Options Hash (options):

  • :db_instance_identifier (required, String) —

    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`

  • :db_instance_class (String) —

    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 AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB Instance Class] in the *Amazon RDS User Guide.*

    Default: The same DBInstanceClass as the original DB instance.

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

  • :port (Integer) —

    The port number on which the database accepts connections.

    Default: The same port as the original DB instance

    Constraints: Value must be ‘1150-65535`

  • :availability_zone (String) —

    The EC2 Availability Zone that the DB instance is created in.

    Default: A random, system-chosen Availability Zone.

    Constraint: You can’t specify the AvailabilityZone parameter if the MultiAZ parameter is set to ‘true`.

    Example: ‘us-east-1a`

  • :db_subnet_group_name (String) —

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

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    Example: ‘mySubnetgroup`

  • :multi_az (Boolean) —

    Specifies if the DB instance is a Multi-AZ deployment.

    Constraint: You can’t specify the AvailabilityZone parameter if the MultiAZ parameter is set to ‘true`.

  • :publicly_accessible (Boolean) —

    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

  • :auto_minor_version_upgrade (Boolean) —

    Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.

  • :license_model (String) —

    License model information for the restored DB instance.

    Default: Same as source.

    Valid values: ‘license-included` | `bring-your-own-license` | `general-public-license`

  • :db_name (String) —

    The database name for the restored DB instance.

    <note markdown=“1”> This parameter doesn’t apply to the MySQL, PostgreSQL, or MariaDB engines.

    </note>
  • :engine (String) —

    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-se2`

    • ‘oracle-se1`

    • ‘oracle-se`

    • ‘postgres`

    • ‘sqlserver-ee`

    • ‘sqlserver-se`

    • ‘sqlserver-ex`

    • ‘sqlserver-web`

  • :iops (Integer) —

    Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not 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] in the *Amazon RDS User Guide.*

    Constraints: Must be an integer greater than 1000.

    [1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS

  • :option_group_name (String) —

    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

  • :tags (Array<Types::Tag>) —

    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

  • :storage_type (String) —

    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 `standard`

  • :tde_credential_arn (String) —

    The ARN from the key store with which to associate the instance for TDE encryption.

  • :tde_credential_password (String) —

    The password for the given ARN from the key store in order to access the device.

  • :vpc_security_group_ids (Array<String>) —

    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.

  • :domain (String) —

    Specify the Active Directory Domain to restore the instance in.

  • :copy_tags_to_snapshot (Boolean) —

    True to copy all tags from the restored DB instance to snapshots of the DB instance, and otherwise false. The default is false.

  • :domain_iam_role_name (String) —

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

  • :enable_iam_database_authentication (Boolean) —

    True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

    You can enable IAM database authentication for the following database engines

    • For MySQL 5.6, minor version 5.6.34 or higher

    • For MySQL 5.7, minor version 5.7.16 or higher

    Default: ‘false`

  • :enable_cloudwatch_logs_exports (Array<String>) —

    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] in the *Amazon Aurora User Guide*.

    [1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch

  • :processor_features (Array<Types::ProcessorFeature>) —

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

  • :use_default_processor_features (Boolean) —

    A value that specifies that the DB instance class of the DB instance uses its default processor features.

  • :db_parameter_group_name (String) —

    The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified 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.

  • :deletion_protection (Boolean) —

    Indicates if the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false. For more information, see [ Deleting a DB Instance].

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

Returns:



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

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

#snapshot_create_time ⇒ Time

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

Returns:

  • (Time) 


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

def snapshot_create_time
  data[:snapshot_create_time]
end

#snapshot_id ⇒ String Also known as: db_snapshot_identifier

Returns:

  • (String) 


38
39
40
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 38

def snapshot_id
  @snapshot_id
end

#snapshot_type ⇒ String

Provides the type of the DB snapshot.

Returns:

  • (String) 


115
116
117
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 115

def snapshot_type
  data[:snapshot_type]
end

#source_db_snapshot_identifier ⇒ String

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.

Returns:

  • (String) 


148
149
150
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 148

def source_db_snapshot_identifier
  data[:source_db_snapshot_identifier]
end

#source_region ⇒ String

The AWS Region that the DB snapshot was created in or copied from.

Returns:

  • (String) 


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

def source_region
  data[:source_region]
end

#status ⇒ String

Specifies the status of this DB snapshot.

Returns:

  • (String) 


64
65
66
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 64

def status
  data[:status]
end

#storage_type ⇒ String

Specifies the storage type associated with DB snapshot.

Returns:

  • (String) 


154
155
156
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 154

def storage_type
  data[:storage_type]
end

#subscribe_to(options = {}) ⇒ EventSubscription

Examples:

Request syntax with placeholder values


eventsubscription = db_snapshot.subscribe_to({
  subscription_name: "String", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :subscription_name (required, String) —

    The name of the RDS event notification subscription you want to add a source identifier to.

Returns:



816
817
818
819
820
821
822
823
824
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 816

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

#tde_credential_arn ⇒ String

The ARN from the key store with which to associate the instance for TDE encryption.

Returns:

  • (String) 


161
162
163
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 161

def tde_credential_arn
  data[:tde_credential_arn]
end

#timezone ⇒ String

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.

Returns:

  • (String) 


189
190
191
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 189

def timezone
  data[:timezone]
end

#unsubscribe_from(options = {}) ⇒ EventSubscription

Examples:

Request syntax with placeholder values


eventsubscription = db_snapshot.unsubscribe_from({
  subscription_name: "String", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :subscription_name (required, String) —

    The name of the RDS event notification subscription you want to remove a source identifier from.

Returns:



836
837
838
839
840
841
842
843
844
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 836

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

#vpc_id ⇒ String

Provides the VPC ID associated with the DB snapshot.

Returns:

  • (String) 


84
85
86
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 84

def vpc_id
  data[:vpc_id]
end

#wait_until(options = {}, &block) ⇒ Resource

Deprecated.

Use [Aws::RDS::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged

Waiter polls an API operation until a resource enters a desired state.

## 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) {|instance| instance.state.name == 'running' }

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

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10 —

    Maximum number of

  • :delay (Integer) — default: 10 —

    Delay between each

  • :before_attempt (Proc) — default: nil —

    Callback

  • :before_wait (Proc) — default: nil —

    Callback

Returns:

  • (Resource) —

    if the waiter was successful

Raises:

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

  • (Aws::Waiters::Errors::UnexpectedError) —

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError) —

    Raised when the resource does not



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 327

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