Class: Aws::DocDBElastic::Types::ClusterSnapshot

Inherits:

Struct

• Object
• Struct
• Aws::DocDBElastic::Types::ClusterSnapshot

Defined in:

gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb

Overview

Returns information about a specific elastic cluster snapshot.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #admin_user_name ⇒ String

  The name of the elastic cluster administrator.

• #cluster_arn ⇒ String

  The ARN identifier of the elastic cluster.

• #cluster_creation_time ⇒ String

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

• #kms_key_id ⇒ String

  The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key.

• #snapshot_arn ⇒ String

  The ARN identifier of the elastic cluster snapshot.

• #snapshot_creation_time ⇒ String

  The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).

• #snapshot_name ⇒ String

  The name of the elastic cluster snapshot.

• #snapshot_type ⇒ String

  The type of cluster snapshots to be returned.

• #status ⇒ String

  The status of the elastic cluster snapshot.

• #subnet_ids ⇒ Array<String>

  The Amazon EC2 subnet IDs for the elastic cluster.

• #vpc_security_group_ids ⇒ Array<String>

  A list of EC2 VPC security groups to associate with the elastic cluster.

Instance Attribute Details

#admin_user_name ⇒ String

The name of the elastic cluster administrator.

Returns:

• (String)

# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 221

class ClusterSnapshot < Struct.new(
  :admin_user_name,
  :cluster_arn,
  :cluster_creation_time,
  :kms_key_id,
  :snapshot_arn,
  :snapshot_creation_time,
  :snapshot_name,
  :snapshot_type,
  :status,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_arn ⇒ String

The ARN identifier of the elastic cluster.

Returns:

• (String)

# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 221

class ClusterSnapshot < Struct.new(
  :admin_user_name,
  :cluster_arn,
  :cluster_creation_time,
  :kms_key_id,
  :snapshot_arn,
  :snapshot_creation_time,
  :snapshot_name,
  :snapshot_type,
  :status,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_creation_time ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 221

class ClusterSnapshot < Struct.new(
  :admin_user_name,
  :cluster_arn,
  :cluster_creation_time,
  :kms_key_id,
  :snapshot_arn,
  :snapshot_creation_time,
  :snapshot_name,
  :snapshot_type,
  :status,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

Returns:

• (String)

# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 221

class ClusterSnapshot < Struct.new(
  :admin_user_name,
  :cluster_arn,
  :cluster_creation_time,
  :kms_key_id,
  :snapshot_arn,
  :snapshot_creation_time,
  :snapshot_name,
  :snapshot_type,
  :status,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_arn ⇒ String

The ARN identifier of the elastic cluster snapshot.

Returns:

• (String)

# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 221

class ClusterSnapshot < Struct.new(
  :admin_user_name,
  :cluster_arn,
  :cluster_creation_time,
  :kms_key_id,
  :snapshot_arn,
  :snapshot_creation_time,
  :snapshot_name,
  :snapshot_type,
  :status,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_creation_time ⇒ String

The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).

Returns:

• (String)

# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 221

class ClusterSnapshot < Struct.new(
  :admin_user_name,
  :cluster_arn,
  :cluster_creation_time,
  :kms_key_id,
  :snapshot_arn,
  :snapshot_creation_time,
  :snapshot_name,
  :snapshot_type,
  :status,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_name ⇒ String

The name of the elastic cluster snapshot.

Returns:

• (String)

# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 221

class ClusterSnapshot < Struct.new(
  :admin_user_name,
  :cluster_arn,
  :cluster_creation_time,
  :kms_key_id,
  :snapshot_arn,
  :snapshot_creation_time,
  :snapshot_name,
  :snapshot_type,
  :status,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_type ⇒ String

The type of cluster snapshots to be returned. You can specify one of the following values:

• automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

• manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

Returns:

• (String)

# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 221

class ClusterSnapshot < Struct.new(
  :admin_user_name,
  :cluster_arn,
  :cluster_creation_time,
  :kms_key_id,
  :snapshot_arn,
  :snapshot_creation_time,
  :snapshot_name,
  :snapshot_type,
  :status,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the elastic cluster snapshot.

Returns:

• (String)

# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 221

class ClusterSnapshot < Struct.new(
  :admin_user_name,
  :cluster_arn,
  :cluster_creation_time,
  :kms_key_id,
  :snapshot_arn,
  :snapshot_creation_time,
  :snapshot_name,
  :snapshot_type,
  :status,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

The Amazon EC2 subnet IDs for the elastic cluster.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 221

class ClusterSnapshot < Struct.new(
  :admin_user_name,
  :cluster_arn,
  :cluster_creation_time,
  :kms_key_id,
  :snapshot_arn,
  :snapshot_creation_time,
  :snapshot_name,
  :snapshot_type,
  :status,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_group_ids ⇒ Array<String>

A list of EC2 VPC security groups to associate with the elastic cluster.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 221

class ClusterSnapshot < Struct.new(
  :admin_user_name,
  :cluster_arn,
  :cluster_creation_time,
  :kms_key_id,
  :snapshot_arn,
  :snapshot_creation_time,
  :snapshot_name,
  :snapshot_type,
  :status,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end