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

Class: Aws::DocDB::Types::DBClusterSnapshot

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zonesArray<String>

Provides the list of Amazon EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

Returns:

  • (Array<String>)

    Provides the list of Amazon EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

#cluster_create_timeTime

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

Returns:

  • (Time)

    Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

#db_cluster_identifierString

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

Returns:

  • (String)

    Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

#db_cluster_snapshot_arnString

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

Returns:

  • (String)

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

#db_cluster_snapshot_identifierString

Specifies the identifier for the DB cluster snapshot.

Returns:

  • (String)

    Specifies the identifier for the DB cluster snapshot.

#engineString

Specifies the name of the database engine.

Returns:

  • (String)

    Specifies the name of the database engine.

#engine_versionString

Provides the version of the database engine for this DB cluster snapshot.

Returns:

  • (String)

    Provides the version of the database engine for this DB cluster snapshot.

#kms_key_idString

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

Returns:

  • (String)

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

#master_usernameString

Provides the master user name for the DB cluster snapshot.

Returns:

  • (String)

    Provides the master user name for the DB cluster snapshot.

#percent_progressInteger

Specifies the percentage of the estimated data that has been transferred.

Returns:

  • (Integer)

    Specifies the percentage of the estimated data that has been transferred.

#portInteger

Specifies the port that the DB cluster was listening on at the time of the snapshot.

Returns:

  • (Integer)

    Specifies the port that the DB cluster was listening on at the time of the snapshot.

#snapshot_create_timeTime

Provides the time when the snapshot was taken, in UTC.

Returns:

  • (Time)

    Provides the time when the snapshot was taken, in UTC.

#snapshot_typeString

Provides the type of the DB cluster snapshot.

Returns:

  • (String)

    Provides the type of the DB cluster snapshot.

#source_db_cluster_snapshot_arnString

If the DB cluster snapshot was copied from a source DB cluster snapshot, the ARN for the source DB cluster snapshot; otherwise, a null value.

Returns:

  • (String)

    If the DB cluster snapshot was copied from a source DB cluster snapshot, the ARN for the source DB cluster snapshot; otherwise, a null value.

#statusString

Specifies the status of this DB cluster snapshot.

Returns:

  • (String)

    Specifies the status of this DB cluster snapshot.

#storage_encryptedBoolean

Specifies whether the DB cluster snapshot is encrypted.

Returns:

  • (Boolean)

    Specifies whether the DB cluster snapshot is encrypted.

#vpc_idString

Provides the virtual private cloud (VPC) ID that is associated with the DB cluster snapshot.

Returns:

  • (String)

    Provides the virtual private cloud (VPC) ID that is associated with the DB cluster snapshot.