Class: Aws::DocDBElastic::Types::Cluster

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

Overview

Returns information about a specific elastic cluster.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#admin_user_name ⇒ String

The name of the elastic cluster administrator.

Returns:

  • (String) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 167

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.

Returns:

  • (String) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 167

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.

Returns:

  • (Integer) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 167

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.

Returns:

  • (String) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 167

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.

Returns:

  • (String) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 167

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.

Returns:

  • (String) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 167

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

Returns:

  • (String) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 167

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.

Returns:

  • (String) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 167

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.

Returns:

  • (String) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 167

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

Returns:

  • (String) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 167

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.

Returns:

  • (Integer) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 167

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.

Returns:

  • (Integer) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 167

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.

Returns:

  • (Integer) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 167

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.

Returns:



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 167

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.

Returns:

  • (String) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 167

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.

Returns:

  • (Array<String>) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 167

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.

Returns:

  • (Array<String>) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 167

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