You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Contains the result of a successful invocation of the following actions:

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storageInteger

Specifies the allocated storage size in gigabytes (GB).

Returns:

  • (Integer)

    Specifies the allocated storage size in gigabytes (GB).

#availability_zoneString

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_identifierString

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_arnString

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

Returns:

  • (String)

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

#db_snapshot_identifierString

Specifies the identifier for the DB snapshot.

Returns:

  • (String)

    Specifies the identifier for the DB snapshot.

#encryptedBoolean

Specifies whether the DB snapshot is encrypted.

Returns:

  • (Boolean)

    Specifies whether the DB snapshot is encrypted.

#engineString

Specifies the name of the database engine.

Returns:

  • (String)

    Specifies the name of the database engine.

#engine_versionString

Specifies the version of the database engine.

Returns:

  • (String)

    Specifies the version of the database engine.

#iam_database_authentication_enabledBoolean

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

Returns:

  • (Boolean)

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

#instance_create_timeTime

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

Returns:

  • (Time)

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

#iopsInteger

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_idString

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

Returns:

  • (String)

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

#license_modelString

License model information for the restored DB instance.

Returns:

  • (String)

    License model information for the restored DB instance.

#master_usernameString

Provides the master username for the DB snapshot.

Returns:

  • (String)

    Provides the master username for the DB snapshot.

#option_group_nameString

Provides the option group name for the DB snapshot.

Returns:

  • (String)

    Provides the option group name for the DB snapshot.

#percent_progressInteger

The percentage of the estimated data that has been transferred.

Returns:

  • (Integer)

    The percentage of the estimated data that has been transferred.

#portInteger

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.

#snapshot_create_timeTime

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

Returns:

  • (Time)

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

#snapshot_typeString

Provides the type of the DB snapshot.

Returns:

  • (String)

    Provides the type of the DB snapshot.

#source_db_snapshot_identifierString

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_regionString

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.

#statusString

Specifies the status of this DB snapshot.

Returns:

  • (String)

    Specifies the status of this DB snapshot.

#storage_typeString

Specifies the storage type associated with DB snapshot.

Returns:

  • (String)

    Specifies the storage type associated with DB snapshot.

#tde_credential_arnString

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.

#timezoneString

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_idString

Provides the VPC ID associated with the DB snapshot.

Returns:

  • (String)

    Provides the VPC ID associated with the DB snapshot.