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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storage ⇒ Integer

Specifies the allocated storage size in gibibytes (GiB).

Returns:

  • (Integer) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zones ⇒ Array<String>

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

Returns:

  • (Array<String>) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_create_time ⇒ Time

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

Returns:

  • (Time) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_identifier ⇒ String

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

Returns:

  • (String) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_snapshot_arn ⇒ String

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

Returns:

  • (String) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_snapshot_identifier ⇒ String

Specifies the identifier for the DB cluster snapshot.

Returns:

  • (String) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ String

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

Returns:

  • (String) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#engine_mode ⇒ String

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

Returns:

  • (String) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

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

Returns:

  • (String) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  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) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  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) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#license_model ⇒ String

Provides the license model information for this DB cluster snapshot.

Returns:

  • (String) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#master_username ⇒ String

Provides the master username for this DB cluster snapshot.

Returns:

  • (String) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#percent_progress ⇒ Integer

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

Returns:

  • (Integer) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

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

Returns:

  • (Integer) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_create_time ⇒ Time

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

Returns:

  • (Time) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_type ⇒ String

Provides the type of the DB cluster snapshot.

Returns:

  • (String) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  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) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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

  • `available`

  • `copying`

  • `creating`

Returns:

  • (String) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#storage_encrypted ⇒ Boolean

Specifies whether the DB cluster snapshot is encrypted.

Returns:

  • (Boolean) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#tag_list ⇒ Array<Types::Tag>

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:


6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ String

Provides the VPC ID associated with the DB cluster snapshot.

Returns:

  • (String) 

6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/aws-sdk-rds/types.rb', line 6859

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,
  :kms_key_id,
  :db_cluster_snapshot_arn,
  :source_db_cluster_snapshot_arn,
  :iam_database_authentication_enabled,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end