Class: Aws::RDS::Types::DBSnapshot

Inherits:

Struct

Object
Struct
Aws::RDS::Types::DBSnapshot

show all

Includes:: Structure

Defined in:: lib/aws-sdk-rds/types.rb

Overview

Contains the details of an Amazon RDS DB snapshot.

This data type is used as a response element in the ‘DescribeDBSnapshots` action.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#allocated_storage ⇒ Integer

Specifies the allocated storage size in gibibytes (GiB).
#availability_zone ⇒ String

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
#db_instance_identifier ⇒ String

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
#db_snapshot_arn ⇒ String

The Amazon Resource Name (ARN) for the DB snapshot.
#db_snapshot_identifier ⇒ String

Specifies the identifier for the DB snapshot.
#db_system_id ⇒ String

The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files.
#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.
#encrypted ⇒ Boolean

Specifies whether the DB snapshot is encrypted.
#engine ⇒ String

Specifies the name of the database engine.
#engine_version ⇒ String

Specifies the version of the database engine.
#iam_database_authentication_enabled ⇒ Boolean

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
#instance_create_time ⇒ Time

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

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

If ‘Encrypted` is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.
#license_model ⇒ String

License model information for the restored DB instance.
#master_username ⇒ String

Provides the master username for the DB snapshot.
#option_group_name ⇒ String

Provides the option group name for the DB snapshot.
#original_snapshot_create_time ⇒ Time

Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC).
#percent_progress ⇒ Integer

The percentage of the estimated data that has been transferred.
#port ⇒ Integer

Specifies the port that the database engine was listening on at the time of the snapshot.
#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.
#snapshot_create_time ⇒ Time

Specifies when the snapshot was taken in Coordinated Universal Time (UTC).
#snapshot_database_time ⇒ Time

The timestamp of the most recent transaction applied to the database that you’re backing up.
#snapshot_target ⇒ String

Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
#snapshot_type ⇒ String

Provides the type of the DB snapshot.
#source_db_snapshot_identifier ⇒ String

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from.
#source_region ⇒ String

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

Specifies the status of this DB snapshot.
#storage_throughput ⇒ Integer

Specifies the storage throughput for the DB snapshot.
#storage_type ⇒ String

Specifies the storage type associated with DB snapshot.
#tag_list ⇒ Array<Types::Tag>

A list of tags.
#tde_credential_arn ⇒ String

The ARN from the key store with which to associate the instance for TDE encryption.
#timezone ⇒ String

The time zone of the DB snapshot.
#vpc_id ⇒ String

Provides the VPC ID associated with the DB snapshot.

Instance Attribute Details

#allocated_storage ⇒ `Integer`

Specifies the allocated storage size in gibibytes (GiB).

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
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)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_identifier ⇒ `String`

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#db_snapshot_arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#db_snapshot_identifier ⇒ `String`

Specifies the identifier for the DB snapshot.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
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)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
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)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#encrypted ⇒ `Boolean`

Specifies whether the DB snapshot is encrypted.

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ `String`

Specifies the name of the database engine.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ `String`

Specifies the version of the database engine.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#iam_database_authentication_enabled ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
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)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
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)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
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)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#license_model ⇒ `String`

License model information for the restored DB instance.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#master_username ⇒ `String`

Provides the master username for the DB snapshot.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#option_group_name ⇒ `String`

Provides the option group name for the DB snapshot.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
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)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#percent_progress ⇒ `Integer`

The percentage of the estimated data that has been transferred.

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
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:

(Array<Types::ProcessorFeature>)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
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)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
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)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_target ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_type ⇒ `String`

Provides the type of the DB snapshot.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
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)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#source_region ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

Specifies the status of this DB snapshot.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#storage_throughput ⇒ `Integer`

Specifies the storage throughput for the DB snapshot.

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ `String`

Specifies the storage type associated with DB snapshot.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

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

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

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#tde_credential_arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
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)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ `String`

Provides the VPC ID associated with the DB snapshot.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9632

class DBSnapshot < Struct.new(
  :db_snapshot_identifier,
  :db_instance_identifier,
  :snapshot_create_time,
  :engine,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :iops,
  :option_group_name,
  :percent_progress,
  :source_region,
  :source_db_snapshot_identifier,
  :storage_type,
  :tde_credential_arn,
  :encrypted,
  :kms_key_id,
  :db_snapshot_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :processor_features,
  :dbi_resource_id,
  :tag_list,
  :original_snapshot_create_time,
  :snapshot_database_time,
  :snapshot_target,
  :storage_throughput,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::RDS::Types::DBSnapshot

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storage ⇒ Integer

#availability_zone ⇒ String

#db_instance_identifier ⇒ String

#db_snapshot_arn ⇒ String

#db_snapshot_identifier ⇒ String

#db_system_id ⇒ String

#dbi_resource_id ⇒ String

#encrypted ⇒ Boolean

#engine ⇒ String

#engine_version ⇒ String

#iam_database_authentication_enabled ⇒ Boolean

#instance_create_time ⇒ Time

#iops ⇒ Integer

#kms_key_id ⇒ String

#license_model ⇒ String

#master_username ⇒ String

#option_group_name ⇒ String

#original_snapshot_create_time ⇒ Time

#percent_progress ⇒ Integer

#port ⇒ Integer

#processor_features ⇒ Array<Types::ProcessorFeature>

#snapshot_create_time ⇒ Time

#snapshot_database_time ⇒ Time

#snapshot_target ⇒ String

#snapshot_type ⇒ String

#source_db_snapshot_identifier ⇒ String

#source_region ⇒ String

#status ⇒ String

#storage_throughput ⇒ Integer

#storage_type ⇒ String

#tag_list ⇒ Array<Types::Tag>

#tde_credential_arn ⇒ String

#timezone ⇒ String

#vpc_id ⇒ String

#allocated_storage ⇒ `Integer`

#availability_zone ⇒ `String`

#db_instance_identifier ⇒ `String`

#db_snapshot_arn ⇒ `String`

#db_snapshot_identifier ⇒ `String`

#db_system_id ⇒ `String`

#dbi_resource_id ⇒ `String`

#encrypted ⇒ `Boolean`

#engine ⇒ `String`

#engine_version ⇒ `String`

#iam_database_authentication_enabled ⇒ `Boolean`

#instance_create_time ⇒ `Time`

#iops ⇒ `Integer`

#kms_key_id ⇒ `String`

#license_model ⇒ `String`

#master_username ⇒ `String`

#option_group_name ⇒ `String`

#original_snapshot_create_time ⇒ `Time`

#percent_progress ⇒ `Integer`

#port ⇒ `Integer`

#processor_features ⇒ `Array<Types::ProcessorFeature>`

#snapshot_create_time ⇒ `Time`

#snapshot_database_time ⇒ `Time`

#snapshot_target ⇒ `String`

#snapshot_type ⇒ `String`

#source_db_snapshot_identifier ⇒ `String`

#source_region ⇒ `String`

#status ⇒ `String`

#storage_throughput ⇒ `Integer`

#storage_type ⇒ `String`

#tag_list ⇒ `Array<Types::Tag>`

#tde_credential_arn ⇒ `String`

#timezone ⇒ `String`

#vpc_id ⇒ `String`