Class: Aws::DocDBElastic::Types::Cluster
- Inherits:
-
Struct
- Object
- Struct
- Aws::DocDBElastic::Types::Cluster
- Defined in:
- gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb
Overview
Returns information about a specific elastic cluster.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#admin_user_name ⇒ String
The name of the elastic cluster administrator.
-
#auth_type ⇒ String
The authentication type for the elastic cluster.
-
#backup_retention_period ⇒ Integer
The number of days for which automatic snapshots are retained.
-
#cluster_arn ⇒ String
The ARN identifier of the elastic cluster.
-
#cluster_endpoint ⇒ String
The URL used to connect to the elastic cluster.
-
#cluster_name ⇒ String
The name of the elastic cluster.
-
#create_time ⇒ String
The time when the elastic cluster was created in Universal Coordinated Time (UTC).
-
#kms_key_id ⇒ String
The KMS key identifier to use to encrypt the elastic cluster.
-
#preferred_backup_window ⇒ String
The daily time range during which automated backups are created if automated backups are enabled, as determined by
backupRetentionPeriod
. -
#preferred_maintenance_window ⇒ String
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
-
#shard_capacity ⇒ Integer
The number of vCPUs assigned to each elastic cluster shard.
-
#shard_count ⇒ Integer
The number of shards assigned to the elastic cluster.
-
#shard_instance_count ⇒ Integer
The number of replica instances applying to all shards in the cluster.
-
#shards ⇒ Array<Types::Shard>
The total number of shards in the cluster.
-
#status ⇒ String
The status of the elastic cluster.
-
#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 associated with thie elastic cluster.
Instance Attribute Details
#admin_user_name ⇒ String
The name of the elastic cluster administrator.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 111 class Cluster < Struct.new( :admin_user_name, :auth_type, :backup_retention_period, :cluster_arn, :cluster_endpoint, :cluster_name, :create_time, :kms_key_id, :preferred_backup_window, :preferred_maintenance_window, :shard_capacity, :shard_count, :shard_instance_count, :shards, :status, :subnet_ids, :vpc_security_group_ids) SENSITIVE = [] include Aws::Structure end |
#auth_type ⇒ String
The authentication type for the elastic cluster.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 111 class Cluster < Struct.new( :admin_user_name, :auth_type, :backup_retention_period, :cluster_arn, :cluster_endpoint, :cluster_name, :create_time, :kms_key_id, :preferred_backup_window, :preferred_maintenance_window, :shard_capacity, :shard_count, :shard_instance_count, :shards, :status, :subnet_ids, :vpc_security_group_ids) SENSITIVE = [] include Aws::Structure end |
#backup_retention_period ⇒ Integer
The number of days for which automatic snapshots are retained.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 111 class Cluster < Struct.new( :admin_user_name, :auth_type, :backup_retention_period, :cluster_arn, :cluster_endpoint, :cluster_name, :create_time, :kms_key_id, :preferred_backup_window, :preferred_maintenance_window, :shard_capacity, :shard_count, :shard_instance_count, :shards, :status, :subnet_ids, :vpc_security_group_ids) SENSITIVE = [] include Aws::Structure end |
#cluster_arn ⇒ String
The ARN identifier of the elastic cluster.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 111 class Cluster < Struct.new( :admin_user_name, :auth_type, :backup_retention_period, :cluster_arn, :cluster_endpoint, :cluster_name, :create_time, :kms_key_id, :preferred_backup_window, :preferred_maintenance_window, :shard_capacity, :shard_count, :shard_instance_count, :shards, :status, :subnet_ids, :vpc_security_group_ids) SENSITIVE = [] include Aws::Structure end |
#cluster_endpoint ⇒ String
The URL used to connect to the elastic cluster.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 111 class Cluster < Struct.new( :admin_user_name, :auth_type, :backup_retention_period, :cluster_arn, :cluster_endpoint, :cluster_name, :create_time, :kms_key_id, :preferred_backup_window, :preferred_maintenance_window, :shard_capacity, :shard_count, :shard_instance_count, :shards, :status, :subnet_ids, :vpc_security_group_ids) SENSITIVE = [] include Aws::Structure end |
#cluster_name ⇒ String
The name of the elastic cluster.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 111 class Cluster < Struct.new( :admin_user_name, :auth_type, :backup_retention_period, :cluster_arn, :cluster_endpoint, :cluster_name, :create_time, :kms_key_id, :preferred_backup_window, :preferred_maintenance_window, :shard_capacity, :shard_count, :shard_instance_count, :shards, :status, :subnet_ids, :vpc_security_group_ids) SENSITIVE = [] include Aws::Structure end |
#create_time ⇒ String
The time when the elastic cluster was created in Universal Coordinated Time (UTC).
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 111 class Cluster < Struct.new( :admin_user_name, :auth_type, :backup_retention_period, :cluster_arn, :cluster_endpoint, :cluster_name, :create_time, :kms_key_id, :preferred_backup_window, :preferred_maintenance_window, :shard_capacity, :shard_count, :shard_instance_count, :shards, :status, :subnet_ids, :vpc_security_group_ids) SENSITIVE = [] include Aws::Structure end |
#kms_key_id ⇒ String
The KMS key identifier to use to encrypt the elastic cluster.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 111 class Cluster < Struct.new( :admin_user_name, :auth_type, :backup_retention_period, :cluster_arn, :cluster_endpoint, :cluster_name, :create_time, :kms_key_id, :preferred_backup_window, :preferred_maintenance_window, :shard_capacity, :shard_count, :shard_instance_count, :shards, :status, :subnet_ids, :vpc_security_group_ids) 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
backupRetentionPeriod
.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 111 class Cluster < Struct.new( :admin_user_name, :auth_type, :backup_retention_period, :cluster_arn, :cluster_endpoint, :cluster_name, :create_time, :kms_key_id, :preferred_backup_window, :preferred_maintenance_window, :shard_capacity, :shard_count, :shard_instance_count, :shards, :status, :subnet_ids, :vpc_security_group_ids) SENSITIVE = [] include Aws::Structure end |
#preferred_maintenance_window ⇒ String
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 111 class Cluster < Struct.new( :admin_user_name, :auth_type, :backup_retention_period, :cluster_arn, :cluster_endpoint, :cluster_name, :create_time, :kms_key_id, :preferred_backup_window, :preferred_maintenance_window, :shard_capacity, :shard_count, :shard_instance_count, :shards, :status, :subnet_ids, :vpc_security_group_ids) SENSITIVE = [] include Aws::Structure end |
#shard_capacity ⇒ Integer
The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 111 class Cluster < Struct.new( :admin_user_name, :auth_type, :backup_retention_period, :cluster_arn, :cluster_endpoint, :cluster_name, :create_time, :kms_key_id, :preferred_backup_window, :preferred_maintenance_window, :shard_capacity, :shard_count, :shard_instance_count, :shards, :status, :subnet_ids, :vpc_security_group_ids) SENSITIVE = [] include Aws::Structure end |
#shard_count ⇒ Integer
The number of shards assigned to the elastic cluster. Maximum is 32.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 111 class Cluster < Struct.new( :admin_user_name, :auth_type, :backup_retention_period, :cluster_arn, :cluster_endpoint, :cluster_name, :create_time, :kms_key_id, :preferred_backup_window, :preferred_maintenance_window, :shard_capacity, :shard_count, :shard_instance_count, :shards, :status, :subnet_ids, :vpc_security_group_ids) SENSITIVE = [] include Aws::Structure end |
#shard_instance_count ⇒ Integer
The number of replica instances applying to all shards in the
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.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 111 class Cluster < Struct.new( :admin_user_name, :auth_type, :backup_retention_period, :cluster_arn, :cluster_endpoint, :cluster_name, :create_time, :kms_key_id, :preferred_backup_window, :preferred_maintenance_window, :shard_capacity, :shard_count, :shard_instance_count, :shards, :status, :subnet_ids, :vpc_security_group_ids) SENSITIVE = [] include Aws::Structure end |
#shards ⇒ Array<Types::Shard>
The total number of shards in the cluster.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 111 class Cluster < Struct.new( :admin_user_name, :auth_type, :backup_retention_period, :cluster_arn, :cluster_endpoint, :cluster_name, :create_time, :kms_key_id, :preferred_backup_window, :preferred_maintenance_window, :shard_capacity, :shard_count, :shard_instance_count, :shards, :status, :subnet_ids, :vpc_security_group_ids) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The status of the elastic cluster.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 111 class Cluster < Struct.new( :admin_user_name, :auth_type, :backup_retention_period, :cluster_arn, :cluster_endpoint, :cluster_name, :create_time, :kms_key_id, :preferred_backup_window, :preferred_maintenance_window, :shard_capacity, :shard_count, :shard_instance_count, :shards, :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.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 111 class Cluster < Struct.new( :admin_user_name, :auth_type, :backup_retention_period, :cluster_arn, :cluster_endpoint, :cluster_name, :create_time, :kms_key_id, :preferred_backup_window, :preferred_maintenance_window, :shard_capacity, :shard_count, :shard_instance_count, :shards, :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 associated with thie elastic cluster.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 111 class Cluster < Struct.new( :admin_user_name, :auth_type, :backup_retention_period, :cluster_arn, :cluster_endpoint, :cluster_name, :create_time, :kms_key_id, :preferred_backup_window, :preferred_maintenance_window, :shard_capacity, :shard_count, :shard_instance_count, :shards, :status, :subnet_ids, :vpc_security_group_ids) SENSITIVE = [] include Aws::Structure end |