Class: Aws::RDS::DBSnapshot

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-rds/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) 


24
25
26
27
28
29
30
31
 
# File 'gems/aws-sdk-rds/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

Instance Method Details

#allocated_storage ⇒ Integer

Specifies the allocated storage size in gibibytes (GiB).

Returns:

  • (Integer) 


62
63
64
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 62

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:



1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 1237

def attributes(options = {})
  batches = Enumerator.new do |y|
    batch = []
    options = options.merge(db_snapshot_identifier: @snapshot_id)
    resp = Aws::Plugins::UserAgent.feature('resource') do
      @client.describe_db_snapshot_attributes(options)
    end
    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) 


82
83
84
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 82

def availability_zone
  data[:availability_zone]
end

#client ⇒ Client

Returns:



294
295
296
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 294

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",
  target_custom_availability_zone: "String",
  copy_option_group: false,
  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 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 KMS key.

    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 KMS key. 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 an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.

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

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

  • :copy_tags (Boolean) —

    Specifies whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags aren't copied.

  • :pre_signed_url (String) —

    When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.

    This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.

    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 CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. 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 operation 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 operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot operation 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 KMS key identifier for the KMS key 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 operation that is called in the destination Amazon Web Services Region, and the operation 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) and Signature Version 4 Signing Process.

    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 presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

  • :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 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 in the Amazon RDS User Guide.

  • :target_custom_availability_zone (String) —

    The external custom Availability Zone (CAZ) identifier for the target CAZ.

    Example: rds-caz-aiqhTgQv.

  • :copy_option_group (Boolean) —

    Specifies whether to copy the DB option group associated with the source DB snapshot to the target Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with cross-account snapshot copy calls.

  • :source_region (String) —

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

Returns:



626
627
628
629
630
631
632
633
634
635
636
637
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 626

def copy(options = {})
  options = options.merge(source_db_snapshot_identifier: @snapshot_id)
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.copy_db_snapshot(options)
  end
  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:



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 448

def create(options = {})
  options = options.merge(
    db_instance_identifier: @instance_id,
    db_snapshot_identifier: @snapshot_id
  )
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.create_db_snapshot(options)
  end
  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:



316
317
318
319
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 316

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.



324
325
326
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 324

def data_loaded?
  !!@data
end

#db_snapshot_arn ⇒ String

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

Returns:

  • (String) 


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

def db_snapshot_arn
  data[:db_snapshot_arn]
end

#db_system_id ⇒ String

The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.

Returns:

  • (String) 


272
273
274
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 272

def db_system_id
  data[:db_system_id]
end

#dbi_resource_id ⇒ String

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

Returns:

  • (String) 


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

def dbi_resource_id
  data[:dbi_resource_id]
end

#dedicated_log_volume ⇒ Boolean

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

Returns:

  • (Boolean) 


279
280
281
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 279

def dedicated_log_volume
  data[:dedicated_log_volume]
end

#delete(options = {}) ⇒ DBSnapshot

Examples:

Request syntax with placeholder values


db_snapshot.delete()

Parameters:

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

    ({})

Returns:



644
645
646
647
648
649
650
651
652
653
654
655
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 644

def delete(options = {})
  options = options.merge(db_snapshot_identifier: @snapshot_id)
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.delete_db_snapshot(options)
  end
  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

Indicates whether the DB snapshot is encrypted.

Returns:

  • (Boolean) 


172
173
174
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 172

def encrypted
  data[:encrypted]
end

#engine ⇒ String

Specifies the name of the database engine.

Returns:

  • (String) 


56
57
58
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 56

def engine
  data[:engine]
end

#engine_version ⇒ String

Specifies the version of the database engine.

Returns:

  • (String) 


107
108
109
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 107

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.

    Example: 2009-07-08T18:00Z

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

    Example: 2009-07-08T18:00Z

  • :duration (Integer) —

    The number of minutes to retrieve events for.

    Default: 60

  • :event_categories (Array<String>) —

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

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

    This parameter isn't currently supported.

Returns:



1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 1302

def events(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(
      source_type: "db-snapshot",
      source_identifier: @snapshot_id
    )
    resp = Aws::Plugins::UserAgent.feature('resource') do
      @client.describe_events(options)
    end
    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

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

Returns:

  • (Boolean) 


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

def iam_database_authentication_enabled
  data[:iam_database_authentication_enabled]
end

#instance ⇒ DBInstance

Returns:



1328
1329
1330
1331
1332
1333
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 1328

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

#instance_create_time ⇒ Time

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

Returns:

  • (Time) 


95
96
97
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 95

def instance_create_time
  data[:instance_create_time]
end

#instance_id ⇒ String Also known as: db_instance_identifier

Returns:

  • (String) 


36
37
38
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 36

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) 


126
127
128
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 126

def iops
  data[:iops]
end

#kms_key_id ⇒ String

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

Returns:

  • (String) 


182
183
184
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 182

def kms_key_id
  data[:kms_key_id]
end

#license_model ⇒ String

License model information for the restored DB instance.

Returns:

  • (String) 


113
114
115
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 113

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) 


304
305
306
307
308
309
310
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 304

def load
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.describe_db_snapshots(db_snapshot_identifier: @snapshot_id)
  end
  @data = resp.db_snapshots[0]
  self
end

#master_username ⇒ String

Provides the master username for the DB snapshot.

Returns:

  • (String) 


101
102
103
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 101

def master_username
  data[:master_username]
end

#multi_tenant ⇒ Boolean

Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

Returns:

  • (Boolean) 


287
288
289
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 287

def multi_tenant
  data[:multi_tenant]
end

#option_group ⇒ OptionGroup?

Returns:



1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 1336

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) 


132
133
134
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 132

def option_group_name
  data[:option_group_name]
end

#original_snapshot_create_time ⇒ Time

Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

Returns:

  • (Time) 


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

def original_snapshot_create_time
  data[:original_snapshot_create_time]
end

#percent_progress ⇒ Integer

The percentage of the estimated data that has been transferred.

Returns:

  • (Integer) 


138
139
140
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 138

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) 


75
76
77
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 75

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:



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

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",
  domain_fqdn: "String",
  domain_ou: "String",
  domain_auth_secret_arn: "String",
  domain_dns_ips: ["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,
  custom_iam_instance_profile: "String",
  backup_target: "String",
  network_type: "String",
  storage_throughput: 1,
  db_cluster_snapshot_identifier: "String",
  allocated_storage: 1,
  dedicated_log_volume: false,
  ca_certificate_identifier: "String",
})

Parameters:

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

    ({})

Options Hash (options):

  • :db_instance_identifier (required, String) —

    The 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 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 in the Amazon RDS User Guide.

    Default: The same DBInstanceClass as the original DB instance.

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

  • :db_subnet_group_name (String) —

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

    Constraints:

    • If supplied, must match the name of an existing DB subnet group.

    ^

    Example: mydbsubnetgroup

  • :multi_az (Boolean) —

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

    This setting doesn't apply to RDS Custom.

    Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

  • :publicly_accessible (Boolean) —

    Specifies whether the DB instance is publicly accessible.

    When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves 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. 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.

  • :auto_minor_version_upgrade (Boolean) —

    Specifies whether to automatically apply minor version upgrades to the DB instance during the maintenance window.

    If you restore an RDS Custom DB instance, you must disable this parameter.

  • :license_model (String) —

    License model information for the restored DB instance.

    This setting doesn't apply to RDS Custom.

    Default: Same as source.

    Valid Values: license-included | bring-your-own-license | general-public-license

  • :db_name (String) —

    The name of the database for the restored DB instance.

    This parameter only applies to RDS for Oracle and RDS for SQL Server DB instances. It doesn't apply to the other engines or to RDS Custom DB instances.

  • :engine (String) —

    The database engine to use for the new instance.

    This setting doesn't apply to RDS Custom.

    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:

    • db2-ae

    • db2-se

    • mariadb

    • mysql

    • oracle-ee

    • oracle-ee-cdb

    • oracle-se2

    • oracle-se2-cdb

    • 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 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 in the Amazon RDS User Guide.

    Constraints: Must be an integer greater than 1000.

  • :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 after it is associated with a DB instance.

    This setting doesn't apply to RDS Custom.

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

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

  • :storage_type (String) —

    Specifies the storage type to be associated with the DB instance.

    Valid Values: gp2 | gp3 | io1 | io2 | standard

    If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified, otherwise gp2

  • :tde_credential_arn (String) —

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

    This setting doesn't apply to RDS Custom.

  • :tde_credential_password (String) —

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

    This setting doesn't apply to RDS Custom.

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

    The Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

    For more information, see Kerberos Authentication in the Amazon RDS User Guide.

    This setting doesn't apply to RDS Custom.

  • :domain_fqdn (String) —

    The fully qualified domain name (FQDN) of an Active Directory domain.

    Constraints:

    • Can't be longer than 64 characters.

    ^

    Example: mymanagedADtest.mymanagedAD.mydomain

  • :domain_ou (String) —

    The Active Directory organizational unit for your DB instance to join.

    Constraints:

    • Must be in the distinguished name format.

    • Can't be longer than 64 characters.

    Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

  • :domain_auth_secret_arn (String) —

    The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

    Constraints:

    • Can't be longer than 64 characters.

    ^

    Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456

  • :domain_dns_ips (Array<String>) —

    The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

    Constraints:

    • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    ^

    Example: 123.124.125.126,234.235.236.237

  • :copy_tags_to_snapshot (Boolean) —

    Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance.

    In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.

    For more information, see Copying tags to DB instance snapshots in the Amazon RDS User Guide.

  • :domain_iam_role_name (String) —

    The name of the IAM role to use when making API calls to the Directory Service.

    This setting doesn't apply to RDS Custom DB instances.

  • :enable_iam_database_authentication (Boolean) —

    Specifies 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 in the Amazon RDS User Guide.

    This setting doesn't apply to RDS Custom.

  • :enable_cloudwatch_logs_exports (Array<String>) —

    The list of logs for the restored DB instance to export to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

    This setting doesn't apply to RDS Custom.

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

    This setting doesn't apply to RDS Custom.

  • :use_default_processor_features (Boolean) —

    Specifies whether the DB instance class of the DB instance uses its default processor features.

    This setting doesn't apply to RDS Custom.

  • :db_parameter_group_name (String) —

    The name of the DB parameter group to associate with this DB instance.

    If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup for the specified DB engine.

    This setting doesn't apply to RDS Custom.

    Constraints:

    • If supplied, must match the name of an existing DB parameter group.

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

    • First character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

  • :deletion_protection (Boolean) —

    Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.

  • :enable_customer_owned_ip (Boolean) —

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

    This setting doesn't apply to RDS Custom.

    For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

    For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

  • :custom_iam_instance_profile (String) —

    The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

    • The profile must exist in your account.

    • The profile must have an IAM role that Amazon EC2 has permissions to assume.

    • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

    This setting is required for RDS Custom.

  • :backup_target (String) —

    Specifies where automated backups and manual snapshots are stored for the restored DB instance.

    Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

    For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

  • :network_type (String) —

    The network type of the DB instance.

    Valid Values:

    • IPV4

    • DUAL

    The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

    For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

  • :storage_throughput (Integer) —

    Specifies the storage throughput value for the DB instance.

    This setting doesn't apply to RDS Custom or Amazon Aurora.

  • :db_cluster_snapshot_identifier (String) —

    The identifier for the Multi-AZ DB cluster snapshot to restore from.

    For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

    Constraints:

    • Must match the identifier of an existing Multi-AZ DB cluster snapshot.

    • Can't be specified when DBSnapshotIdentifier is specified.

    • Must be specified when DBSnapshotIdentifier isn't specified.

    • If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.

    • Can't be the identifier of an Aurora DB cluster snapshot.

  • :allocated_storage (Integer) —

    The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

    Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.

  • :dedicated_log_volume (Boolean) —

    Specifies whether to enable a dedicated log volume (DLV) for the DB instance.

  • :ca_certificate_identifier (String) —

    The CA certificate identifier to use for the DB instance's server certificate.

    This setting doesn't apply to RDS Custom DB instances.

    For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

Returns:



1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 1174

def restore(options = {})
  options = options.merge(db_snapshot_identifier: @snapshot_id)
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.restore_db_instance_from_db_snapshot(options)
  end
  DBInstance.new(
    id: resp.data.db_instance.db_instance_identifier,
    data: resp.data.db_instance,
    client: @client
  )
end

#snapshot_create_time ⇒ Time

Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

Returns:

  • (Time) 


50
51
52
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 50

def snapshot_create_time
  data[:snapshot_create_time]
end

#snapshot_database_time ⇒ Time

The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

Returns:

  • (Time) 


251
252
253
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 251

def snapshot_database_time
  data[:snapshot_database_time]
end

#snapshot_id ⇒ String Also known as: db_snapshot_identifier

Returns:

  • (String) 


42
43
44
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 42

def snapshot_id
  @snapshot_id
end

#snapshot_target ⇒ String

Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

Returns:

  • (String) 


258
259
260
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 258

def snapshot_target
  data[:snapshot_target]
end

#snapshot_type ⇒ String

Provides the type of the DB snapshot.

Returns:

  • (String) 


119
120
121
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 119

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 a value in the case of a cross-account or cross-Region copy.

Returns:

  • (String) 


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

def source_db_snapshot_identifier
  data[:source_db_snapshot_identifier]
end

#source_region ⇒ String

The Amazon Web Services Region that the DB snapshot was created in or copied from.

Returns:

  • (String) 


145
146
147
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 145

def source_region
  data[:source_region]
end

#status ⇒ String

Specifies the status of this DB snapshot.

Returns:

  • (String) 


68
69
70
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 68

def status
  data[:status]
end

#storage_throughput ⇒ Integer

Specifies the storage throughput for the DB snapshot.

Returns:

  • (Integer) 


264
265
266
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 264

def storage_throughput
  data[:storage_throughput]
end

#storage_type ⇒ String

Specifies the storage type associated with DB snapshot.

Returns:

  • (String) 


159
160
161
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 159

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:



1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 1196

def subscribe_to(options = {})
  options = options.merge(source_identifier: @snapshot_id)
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.add_source_identifier_to_subscription(options)
  end
  EventSubscription.new(
    name: resp.data.event_subscription.cust_subscription_id,
    data: resp.data.event_subscription,
    client: @client
  )
end

#tag_list ⇒ Array<Types::Tag>

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

Returns:



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

def tag_list
  data[:tag_list]
end

#tde_credential_arn ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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:



1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 1218

def unsubscribe_from(options = {})
  options = options.merge(source_identifier: @snapshot_id)
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.remove_source_identifier_from_subscription(options)
  end
  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) 


88
89
90
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 88

def vpc_id
  data[:vpc_id]
end

#wait_until(options = {}) {|resource| ... } ⇒ 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) 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

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

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

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



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 408

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::Plugins::UserAgent.feature('resource') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end