Class: Aws::RDS::DBSnapshot

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

Overview

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBSnapshot.html

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) 


13
14
15
 
# File 'sig/db_snapshot.rbs', line 13

def initialize: (String instance_id, String snapshot_id, Hash[Symbol, untyped] options) -> void
| (instance_id: String, snapshot_id: String, ?client: Client) -> void
| (Hash[Symbol, untyped] args) -> void

Instance Method Details

#additional_storage_volumes ⇒ Array<Types::AdditionalStorageVolume>

The additional storage volumes associated with the DB snapshot. RDS supports additional storage volumes for RDS for Oracle and RDS for SQL Server.

Returns:



137
 
# File 'sig/db_snapshot.rbs', line 137

def additional_storage_volumes: () -> ::Array[Types::AdditionalStorageVolume]

#allocated_storage ⇒ Integer

Specifies the allocated storage size in gibibytes (GiB).

Returns:

  • (Integer) 


32
 
# File 'sig/db_snapshot.rbs', line 32

def allocated_storage: () -> ::Integer

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

Examples:

Request syntax with placeholder values


db_snapshot.attributes()

Parameters:

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

    ({})

Returns:



286
 
# File 'sig/db_snapshot.rbs', line 286

def attributes: (

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


41
 
# File 'sig/db_snapshot.rbs', line 41

def availability_zone: () -> ::String

#backup_retention_period ⇒ Integer

The number of days for which automatic DB snapshots are retained.

Returns:

  • (Integer) 


92
 
# File 'sig/db_snapshot.rbs', line 92

def backup_retention_period: () -> ::Integer

#client ⇒ Client

Returns:



343
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 343

def client: () -> Client

#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: "SensitiveString",
  option_group_name: "String",
  target_custom_availability_zone: "String",
  snapshot_target: "String",
  copy_option_group: false,
  snapshot_availability_zone: "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 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 or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora 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.

  • :snapshot_target (String) —

    Configures the location where RDS will store copied snapshots.

    Valid Values:

    • local (Dedicated Local Zone)

    • outposts (Amazon Web Services Outposts)

    • region (Amazon Web Services Region)

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

  • :snapshot_availability_zone (String) —

    Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone.

  • :source_region (String) —

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

Returns:



167
 
# File 'sig/db_snapshot.rbs', line 167

def copy: (

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



156
 
# File 'sig/db_snapshot.rbs', line 156

def create: (

#data ⇒ Types::DBSnapshot

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

Returns:



149
 
# File 'sig/db_snapshot.rbs', line 149

def data: () -> Types::DBSnapshot

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



152
 
# File 'sig/db_snapshot.rbs', line 152

def data_loaded?: () -> bool

#db_snapshot_arn ⇒ String

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

Returns:

  • (String) 


101
 
# File 'sig/db_snapshot.rbs', line 101

def db_snapshot_arn: () -> ::String

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


128
 
# File 'sig/db_snapshot.rbs', line 128

def db_system_id: () -> ::String

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


113
 
# File 'sig/db_snapshot.rbs', line 113

def dbi_resource_id: () -> ::String

#dedicated_log_volume ⇒ Boolean

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

Returns:

  • (Boolean) 


134
 
# File 'sig/db_snapshot.rbs', line 134

def dedicated_log_volume: () -> bool

#delete(options = {}) ⇒ DBSnapshot

Examples:

Request syntax with placeholder values


db_snapshot.delete()

Parameters:

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

    ({})

Returns:



188
 
# File 'sig/db_snapshot.rbs', line 188

def delete: (

#encrypted ⇒ Boolean

Indicates whether the DB snapshot is encrypted.

Returns:

  • (Boolean) 


86
 
# File 'sig/db_snapshot.rbs', line 86

def encrypted: () -> bool

#engine ⇒ String

Specifies the name of the database engine.

Returns:

  • (String) 


29
 
# File 'sig/db_snapshot.rbs', line 29

def engine: () -> ::String

#engine_version ⇒ String

Specifies the version of the database engine.

Returns:

  • (String) 


53
 
# File 'sig/db_snapshot.rbs', line 53

def engine_version: () -> ::String

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



291
 
# File 'sig/db_snapshot.rbs', line 291

def events: (

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


107
 
# File 'sig/db_snapshot.rbs', line 107

def iam_database_authentication_enabled: () -> bool

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


1625
1626
1627
1628
1629
1630
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 1625

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

#instance ⇒ DBInstance

Returns:



306
 
# File 'sig/db_snapshot.rbs', line 306

def instance: () -> DBInstance

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


47
 
# File 'sig/db_snapshot.rbs', line 47

def instance_create_time: () -> ::Time

#instance_id ⇒ String Also known as: db_instance_identifier

Returns:

  • (String) 


18
 
# File 'sig/db_snapshot.rbs', line 18

def instance_id: () -> String

#iops ⇒ Integer

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

Returns:

  • (Integer) 


62
 
# File 'sig/db_snapshot.rbs', line 62

def iops: () -> ::Integer

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


98
 
# File 'sig/db_snapshot.rbs', line 98

def kms_key_id: () -> ::String

#license_model ⇒ String

License model information for the restored DB instance.

Returns:

  • (String) 


56
 
# File 'sig/db_snapshot.rbs', line 56

def license_model: () -> ::String

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


145
 
# File 'sig/db_snapshot.rbs', line 145

def load: () -> self

#master_username ⇒ String

Provides the master username for the DB snapshot.

Returns:

  • (String) 


50
 
# File 'sig/db_snapshot.rbs', line 50

def master_username: () -> ::String

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


131
 
# File 'sig/db_snapshot.rbs', line 131

def multi_tenant: () -> bool

#option_group ⇒ OptionGroup?

Returns:



309
 
# File 'sig/db_snapshot.rbs', line 309

def option_group: () -> OptionGroup?

#option_group_name ⇒ String

Provides the option group name for the DB snapshot.

Returns:

  • (String) 


68
 
# File 'sig/db_snapshot.rbs', line 68

def option_group_name: () -> ::String

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


122
 
# File 'sig/db_snapshot.rbs', line 122

def original_snapshot_create_time: () -> ::Time

#percent_progress ⇒ Integer

The percentage of the estimated data that has been transferred.

Returns:

  • (Integer) 


71
 
# File 'sig/db_snapshot.rbs', line 71

def percent_progress: () -> ::Integer

#port ⇒ Integer

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

Returns:

  • (Integer) 


38
 
# File 'sig/db_snapshot.rbs', line 38

def port: () -> ::Integer

#preferred_backup_window ⇒ String

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Returns:

  • (String) 


95
 
# File 'sig/db_snapshot.rbs', line 95

def preferred_backup_window: () -> ::String

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



110
 
# File 'sig/db_snapshot.rbs', line 110

def processor_features: () -> ::Array[Types::ProcessorFeature]

#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,
  storage_throughput: 1,
  option_group_name: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  storage_type: "String",
  tde_credential_arn: "String",
  tde_credential_password: "SensitiveString",
  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,
  network_type: "String",
  backup_target: "String",
  custom_iam_instance_profile: "String",
  allocated_storage: 1,
  db_cluster_snapshot_identifier: "String",
  backup_retention_period: 1,
  preferred_backup_window: "String",
  dedicated_log_volume: false,
  ca_certificate_identifier: "String",
  engine_lifecycle_support: "String",
  additional_storage_volumes: [
    {
      volume_name: "String", # required
      allocated_storage: 1,
      iops: 1,
      max_allocated_storage: 1,
      storage_throughput: 1,
      storage_type: "String",
    },
  ],
  tag_specifications: [
    {
      resource_type: "String",
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  manage_master_user_password: false,
  master_user_secret_kms_key_id: "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.

    For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

  • :license_model (String) —

    License model information for the restored DB instance.

    License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide.

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

    Valid Values:

    • RDS for Db2 - bring-your-own-license | marketplace-license

    • RDS for MariaDB - general-public-license

    • RDS for Microsoft SQL Server - license-included | bring-your-own-media

    • RDS for MySQL - general-public-license

    • RDS for Oracle - bring-your-own-license | license-included

    • RDS for PostgreSQL - postgresql-license

    Default: Same as the source.

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

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

  • :storage_throughput (Integer) —

    Specifies the storage throughput value for the DB instance.

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

  • :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 or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora 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 gp3

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

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

  • :backup_target (String) —

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

    Possible values are local (Dedicated Local Zone), 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.

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

  • :allocated_storage (Integer) —

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

    This setting isn't valid for RDS for SQL Server.

    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.

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

  • :backup_retention_period (Integer) —

    The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

    Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

    This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

    Default: Uses existing setting

    Constraints:

    • Must be a value from 0 to 35.

    • Can't be set to 0 if the DB instance is a source to read replicas.

    • Can't be set to 0 for an RDS Custom for Oracle DB instance.

  • :preferred_backup_window (String) —

    The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

    This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

    Constraints:

    • Must be in the format hh24:mi-hh24:mi.

    • Must be in Universal Coordinated Time (UTC).

    • Must not conflict with the preferred maintenance window.

    • Must be at least 30 minutes.

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

  • :engine_lifecycle_support (String) —

    The life cycle type for this DB instance.

    By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.

    You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide.

    This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.

    Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

    Default: open-source-rds-extended-support

  • :additional_storage_volumes (Array<Types::AdditionalStorageVolume>) —

    A list of additional storage volumes to create for the DB instance. You can create up to three additional storage volumes using the names rdsdbdata2, rdsdbdata3, and rdsdbdata4. Additional storage volumes are supported for RDS for Oracle and RDS for SQL Server DB instances only.

  • :tag_specifications (Array<Types::TagSpecification>) —

    Tags to assign to resources associated with the DB instance.

    Valid Values:

    • auto-backup - The DB instance's automated backup.

    ^

  • :manage_master_user_password (Boolean) —

    Specifies whether to manage the master user password with Amazon Web Services Secrets Manager in the restored DB instance.

    For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

    Constraints:

    • Applies to RDS for Oracle only.

    ^

  • :master_user_secret_kms_key_id (String) —

    The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

    This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.

    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

    If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

    There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

Returns:



193
 
# File 'sig/db_snapshot.rbs', line 193

def restore: (

#snapshot_availability_zone ⇒ String

Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone.

Returns:

  • (String) 


140
 
# File 'sig/db_snapshot.rbs', line 140

def snapshot_availability_zone: () -> ::String

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


26
 
# File 'sig/db_snapshot.rbs', line 26

def snapshot_create_time: () -> ::Time

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


125
 
# File 'sig/db_snapshot.rbs', line 125

def snapshot_database_time: () -> ::Time

#snapshot_id ⇒ String Also known as: db_snapshot_identifier

Returns:

  • (String) 


22
 
# File 'sig/db_snapshot.rbs', line 22

def snapshot_id: () -> String

#snapshot_target ⇒ String

Specifies where manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.

Returns:

  • (String) 


119
 
# File 'sig/db_snapshot.rbs', line 119

def snapshot_target: () -> ::String

#snapshot_type ⇒ String

Provides the type of the DB snapshot.

Returns:

  • (String) 


59
 
# File 'sig/db_snapshot.rbs', line 59

def snapshot_type: () -> ::String

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


77
 
# File 'sig/db_snapshot.rbs', line 77

def source_db_snapshot_identifier: () -> ::String

#source_region ⇒ String

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

Returns:

  • (String) 


74
 
# File 'sig/db_snapshot.rbs', line 74

def source_region: () -> ::String

#status ⇒ String

Specifies the status of this DB snapshot.

Returns:

  • (String) 


35
 
# File 'sig/db_snapshot.rbs', line 35

def status: () -> ::String

#storage_encryption_type ⇒ String

The type of encryption used to protect data at rest in the DB snapshot. Possible values:

  • none - The DB snapshot is not encrypted.

  • sse-rds - The DB snapshot is encrypted using an Amazon Web Services owned KMS key.

  • sse-kms - The DB snapshot is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.

Returns:

  • (String) 


89
 
# File 'sig/db_snapshot.rbs', line 89

def storage_encryption_type: () -> ("none" | "sse-kms" | "sse-rds")

#storage_throughput ⇒ Integer

Specifies the storage throughput for the DB snapshot.

Returns:

  • (Integer) 


65
 
# File 'sig/db_snapshot.rbs', line 65

def storage_throughput: () -> ::Integer

#storage_type ⇒ String

Specifies the storage type associated with DB snapshot.

Returns:

  • (String) 


80
 
# File 'sig/db_snapshot.rbs', line 80

def storage_type: () -> ::String

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



274
 
# File 'sig/db_snapshot.rbs', line 274

def subscribe_to: (

#tag_list ⇒ Array<Types::Tag>

A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

Returns:



116
 
# File 'sig/db_snapshot.rbs', line 116

def tag_list: () -> ::Array[Types::Tag]

#tde_credential_arn ⇒ String

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

Returns:

  • (String) 


83
 
# File 'sig/db_snapshot.rbs', line 83

def tde_credential_arn: () -> ::String

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


104
 
# File 'sig/db_snapshot.rbs', line 104

def timezone: () -> ::String

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



280
 
# File 'sig/db_snapshot.rbs', line 280

def unsubscribe_from: (

#vpc_id ⇒ String

Provides the VPC ID associated with the DB snapshot.

Returns:

  • (String) 


44
 
# File 'sig/db_snapshot.rbs', line 44

def vpc_id: () -> ::String

#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



457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/aws-sdk-rds/db_snapshot.rb', line 457

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.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end