Class: Aws::RDS::Types::DBClusterSnapshot

Inherits:

Struct

Object
Struct
Aws::RDS::Types::DBClusterSnapshot

show all

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

Overview

Contains the details for an Amazon RDS DB cluster snapshot

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#allocated_storage ⇒ Integer
The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
#availability_zones ⇒ Array<String>
The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
#backup_retention_period ⇒ Integer
The number of days for which automatic DB snapshots are retained.
#cluster_create_time ⇒ Time
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
#db_cluster_identifier ⇒ String
The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
#db_cluster_resource_id ⇒ String
The resource ID of the DB cluster that this DB cluster snapshot was created from.
#db_cluster_snapshot_arn ⇒ String
The Amazon Resource Name (ARN) for the DB cluster snapshot.
#db_cluster_snapshot_identifier ⇒ String
The identifier for the DB cluster snapshot.
#db_system_id ⇒ String
Reserved for future use.
#engine ⇒ String
The name of the database engine for this DB cluster snapshot.
#engine_mode ⇒ String
The engine mode of the database engine for this DB cluster snapshot.
#engine_version ⇒ String
The version of the database engine for this DB cluster snapshot.
#iam_database_authentication_enabled ⇒ Boolean
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
#kms_key_id ⇒ String
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
#license_model ⇒ String
The license model information for this DB cluster snapshot.
#master_username ⇒ String
The master username for this DB cluster snapshot.
#percent_progress ⇒ Integer
The percentage of the estimated data that has been transferred.
#port ⇒ Integer
The port that the DB cluster was listening on at the time of the snapshot.
#preferred_backup_window ⇒ String
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
#snapshot_create_time ⇒ Time
The time when the snapshot was taken, in Universal Coordinated Time (UTC).
#snapshot_type ⇒ String
The type of the DB cluster snapshot.
#source_db_cluster_snapshot_arn ⇒ String
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
#status ⇒ String
The status of this DB cluster snapshot.
#storage_encrypted ⇒ Boolean
Indicates whether the DB cluster snapshot is encrypted.
#storage_encryption_type ⇒ String
The type of encryption used to protect data at rest in the DB cluster snapshot.
#storage_throughput ⇒ Integer
The storage throughput for the DB cluster snapshot.
#storage_type ⇒ String
The storage type associated with the DB cluster snapshot.
#tag_list ⇒ Array<Types::Tag>
A list of tags.
#vpc_id ⇒ String
The VPC ID associated with the DB cluster snapshot.

Instance Attribute Details

#allocated_storage ⇒ `Integer`

The allocated storage size of the DB cluster snapshot in gibibytes (GiB).

Returns:

(Integer)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zones ⇒ `Array<String>`

The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

Returns:

(Array<String>)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#backup_retention_period ⇒ `Integer`

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

Returns:

(Integer)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_create_time ⇒ `Time`

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

Returns:

(Time)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_identifier ⇒ `String`

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

Returns:

(String)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_resource_id ⇒ `String`

The resource ID of the DB cluster that this DB cluster snapshot was created from.

Returns:

(String)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_snapshot_arn ⇒ `String`

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

Returns:

(String)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_snapshot_identifier ⇒ `String`

The identifier for the DB cluster snapshot.

Returns:

(String)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#db_system_id ⇒ `String`

Reserved for future use.

Returns:

(String)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ `String`

The name of the database engine for this DB cluster snapshot.

Returns:

(String)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#engine_mode ⇒ `String`

The engine mode of the database engine for this DB cluster snapshot.

Returns:

(String)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ `String`

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

Returns:

(String)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

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

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `String`

If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster 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 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8989

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#license_model ⇒ `String`

The license model information for this DB cluster snapshot.

Returns:

(String)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#master_username ⇒ `String`

The master username for this DB cluster snapshot.

Returns:

(String)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#percent_progress ⇒ `Integer`

The percentage of the estimated data that has been transferred.

Returns:

(Integer)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ `Integer`

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

Returns:

(Integer)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

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

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_create_time ⇒ `Time`

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

Returns:

(Time)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_type ⇒ `String`

The type of the DB cluster snapshot.

Returns:

(String)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#source_db_cluster_snapshot_arn ⇒ `String`

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

Returns:

(String)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The status of this DB cluster snapshot. Valid statuses are the following:

available
copying
creating

Returns:

(String)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#storage_encrypted ⇒ `Boolean`

Indicates whether the DB cluster snapshot is encrypted.

Returns:

(Boolean)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#storage_encryption_type ⇒ `String`

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

none - The DB cluster snapshot is not encrypted.
sse-rds - The DB cluster snapshot is encrypted using an Amazon Web Services owned KMS key.
sse-kms - The DB cluster snapshot is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.

Returns:

(String)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#storage_throughput ⇒ `Integer`

The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

This setting is only for non-Aurora Multi-AZ DB clusters.

Returns:

(Integer)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ `String`

The storage type associated with the DB cluster snapshot.

This setting is only for Aurora DB clusters.

Returns:

(String)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :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 or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

Returns:

(Array<Types::Tag>)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ `String`

The VPC ID associated with the DB cluster snapshot.

Returns:

(String)

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

class DBClusterSnapshot < Struct.new(
  :availability_zones,
  :db_cluster_snapshot_identifier,
  :db_cluster_identifier,
  :snapshot_create_time,
  :engine,
  :engine_mode,
  :allocated_storage,
  :status,
  :port,
  :vpc_id,
  :cluster_create_time,
  :master_username,
  :engine_version,
  :license_model,
  :snapshot_type,
  :percent_progress,
  :storage_encrypted,
  :storage_encryption_type,
  :backup_retention_period,
  :preferred_backup_window,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list,
  :storage_type,
  :storage_throughput,
  :db_cluster_resource_id,
  :db_system_id)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::RDS::Types::DBClusterSnapshot

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storage ⇒ Integer

#availability_zones ⇒ Array<String>

#backup_retention_period ⇒ Integer

#cluster_create_time ⇒ Time

#db_cluster_identifier ⇒ String

#db_cluster_resource_id ⇒ String

#db_cluster_snapshot_arn ⇒ String

#db_cluster_snapshot_identifier ⇒ String

#db_system_id ⇒ String

#engine ⇒ String

#engine_mode ⇒ String

#engine_version ⇒ String

#iam_database_authentication_enabled ⇒ Boolean

#kms_key_id ⇒ String

#license_model ⇒ String

#master_username ⇒ String

#percent_progress ⇒ Integer

#port ⇒ Integer

#preferred_backup_window ⇒ String

#snapshot_create_time ⇒ Time

#snapshot_type ⇒ String

#source_db_cluster_snapshot_arn ⇒ String

#status ⇒ String

#storage_encrypted ⇒ Boolean

#storage_encryption_type ⇒ String

#storage_throughput ⇒ Integer

#storage_type ⇒ String

#tag_list ⇒ Array<Types::Tag>

#vpc_id ⇒ String

#allocated_storage ⇒ `Integer`

#availability_zones ⇒ `Array<String>`

#backup_retention_period ⇒ `Integer`

#cluster_create_time ⇒ `Time`

#db_cluster_identifier ⇒ `String`

#db_cluster_resource_id ⇒ `String`

#db_cluster_snapshot_arn ⇒ `String`

#db_cluster_snapshot_identifier ⇒ `String`

#db_system_id ⇒ `String`

#engine ⇒ `String`

#engine_mode ⇒ `String`

#engine_version ⇒ `String`

#iam_database_authentication_enabled ⇒ `Boolean`

#kms_key_id ⇒ `String`

#license_model ⇒ `String`

#master_username ⇒ `String`

#percent_progress ⇒ `Integer`

#port ⇒ `Integer`

#preferred_backup_window ⇒ `String`

#snapshot_create_time ⇒ `Time`

#snapshot_type ⇒ `String`

#source_db_cluster_snapshot_arn ⇒ `String`

#status ⇒ `String`

#storage_encrypted ⇒ `Boolean`

#storage_encryption_type ⇒ `String`

#storage_throughput ⇒ `Integer`

#storage_type ⇒ `String`

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

#vpc_id ⇒ `String`