Class: Aws::DocDBElastic::Types::RestoreClusterFromSnapshotInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_name ⇒ String

The name of the elastic cluster.

Returns:

  • (String) 


881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 881

class RestoreClusterFromSnapshotInput < Struct.new(
  :cluster_name,
  :kms_key_id,
  :shard_capacity,
  :shard_instance_count,
  :snapshot_arn,
  :subnet_ids,
  :tags,
  :vpc_security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.

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) 


881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 881

class RestoreClusterFromSnapshotInput < Struct.new(
  :cluster_name,
  :kms_key_id,
  :shard_capacity,
  :shard_instance_count,
  :snapshot_arn,
  :subnet_ids,
  :tags,
  :vpc_security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#shard_capacity ⇒ Integer

The capacity of each shard in the new restored elastic cluster.

Returns:

  • (Integer) 


881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 881

class RestoreClusterFromSnapshotInput < Struct.new(
  :cluster_name,
  :kms_key_id,
  :shard_capacity,
  :shard_instance_count,
  :snapshot_arn,
  :subnet_ids,
  :tags,
  :vpc_security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#shard_instance_count ⇒ Integer

The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

Returns:

  • (Integer) 


881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 881

class RestoreClusterFromSnapshotInput < Struct.new(
  :cluster_name,
  :kms_key_id,
  :shard_capacity,
  :shard_instance_count,
  :snapshot_arn,
  :subnet_ids,
  :tags,
  :vpc_security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_arn ⇒ String

The ARN identifier of the elastic cluster snapshot.

Returns:

  • (String) 


881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 881

class RestoreClusterFromSnapshotInput < Struct.new(
  :cluster_name,
  :kms_key_id,
  :shard_capacity,
  :shard_instance_count,
  :snapshot_arn,
  :subnet_ids,
  :tags,
  :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>) 


881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 881

class RestoreClusterFromSnapshotInput < Struct.new(
  :cluster_name,
  :kms_key_id,
  :shard_capacity,
  :shard_instance_count,
  :snapshot_arn,
  :subnet_ids,
  :tags,
  :vpc_security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.

Returns:

  • (Hash<String,String>) 


881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 881

class RestoreClusterFromSnapshotInput < Struct.new(
  :cluster_name,
  :kms_key_id,
  :shard_capacity,
  :shard_instance_count,
  :snapshot_arn,
  :subnet_ids,
  :tags,
  :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>) 


881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 881

class RestoreClusterFromSnapshotInput < Struct.new(
  :cluster_name,
  :kms_key_id,
  :shard_capacity,
  :shard_instance_count,
  :snapshot_arn,
  :subnet_ids,
  :tags,
  :vpc_security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end