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

Inherits:

Struct

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

Defined in:

(unknown)

Overview

Contains the details of an Amazon RDS DB snapshot.

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

Returned by:

• CopyDBSnapshotResult#db_snapshot
• CreateDBSnapshotResult#db_snapshot
• Aws::RDS::Types::DeleteDBSnapshotResult#db_snapshot
• ModifyDBSnapshotResult#db_snapshot

See Also:

• AWS API Documentation

Instance Attribute Summary

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

• #dbi_resource_id ⇒ String

  The identifier for the source DB instance, which can\'t be changed and which is unique to an AWS 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 AWS 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 AWS 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.

• #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_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 AWS Region that the DB snapshot was created in or copied from.

• #status ⇒ String

  Specifies the status of this 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) —

  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.

Returns:

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

Returns:

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

Returns:

• (String) —

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

#db_snapshot_identifier ⇒ String

Specifies the identifier for the DB snapshot.

Returns:

• (String) —

  Specifies the identifier for the DB snapshot.

#dbi_resource_id ⇒ String

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

Returns:

• (String) —

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

#encrypted ⇒ Boolean

Specifies whether the DB snapshot is encrypted.

Returns:

• (Boolean) —

  Specifies whether the DB snapshot is encrypted.

#engine ⇒ String

Specifies the name of the database engine.

Returns:

• (String) —

  Specifies the name of the database engine.

#engine_version ⇒ String

Specifies the version of the database engine.

Returns:

• (String) —

  Specifies the version of the database engine.

#iam_database_authentication_enabled ⇒ Boolean

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

Returns:

• (Boolean) —

  True if mapping of AWS 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.

Returns:

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

Returns:

• (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 AWS KMS key identifier for the encrypted DB snapshot.

Returns:

• (String) —

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

#license_model ⇒ String

License model information for the restored DB instance.

Returns:

• (String) —

  License model information for the restored DB instance.

#master_username ⇒ String

Provides the master username for the DB snapshot.

Returns:

• (String) —

  Provides the master username for the DB snapshot.

#option_group_name ⇒ String

Provides the option group name for the DB snapshot.

Returns:

• (String) —

  Provides the option group name for the DB snapshot.

#percent_progress ⇒ Integer

The percentage of the estimated data that has been transferred.

Returns:

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

Returns:

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

Returns:

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

Returns:

• (Time) —

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

#snapshot_type ⇒ String

Provides the type of the DB snapshot.

Returns:

• (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. It only has value in case of cross-customer or cross-region copy.

Returns:

• (String) —

  The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from.

#source_region ⇒ String

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

Returns:

• (String) —

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

#status ⇒ String

Specifies the status of this DB snapshot.

Returns:

• (String) —

  Specifies the status of this DB snapshot.

#storage_type ⇒ String

Specifies the storage type associated with DB snapshot.

Returns:

• (String) —

  Specifies the storage type associated with DB snapshot.

#tag_list ⇒ Array<Types::Tag>

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

Returns:

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

Returns:

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

  The time zone of the DB snapshot.

#vpc_id ⇒ String

Provides the VPC ID associated with the DB snapshot.

Returns:

• (String) —

  Provides the VPC ID associated with the DB snapshot.