Class: Aws::DocDBElastic::Types::UpdateClusterInput

Inherits:

Struct

• Object
• Struct
• Aws::DocDBElastic::Types::UpdateClusterInput

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:admin_user_password]

Instance Attribute Summary

• #admin_user_password ⇒ String

  The password associated with the elastic cluster administrator.

• #auth_type ⇒ String

  The authentication type used to determine where to fetch the password used for accessing the elastic cluster.

• #backup_retention_period ⇒ Integer

  The number of days for which automatic snapshots are retained.

• #client_token ⇒ String

  The client token for the elastic cluster.

• #cluster_arn ⇒ String

  The ARN identifier of 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 the 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 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 to associate with the elastic cluster.

Instance Attribute Details

#admin_user_password ⇒ String

The password associated with the elastic cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

Returns:

• (String)

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

class UpdateClusterInput < Struct.new(
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_arn,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = [:admin_user_password]
  include Aws::Structure
end

#auth_type ⇒ String

The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.

Returns:

• (String)

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

class UpdateClusterInput < Struct.new(
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_arn,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = [:admin_user_password]
  include Aws::Structure
end

#backup_retention_period ⇒ Integer

The number of days for which automatic snapshots are retained.

Returns:

• (Integer)

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

class UpdateClusterInput < Struct.new(
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_arn,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = [:admin_user_password]
  include Aws::Structure
end

#client_token ⇒ String

The client token for the elastic cluster.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

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

class UpdateClusterInput < Struct.new(
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_arn,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = [:admin_user_password]
  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 1130

class UpdateClusterInput < Struct.new(
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_arn,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = [:admin_user_password]
  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 the backupRetentionPeriod.

Returns:

• (String)

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

class UpdateClusterInput < Struct.new(
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_arn,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = [:admin_user_password]
  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

Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Returns:

• (String)

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

class UpdateClusterInput < Struct.new(
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_arn,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = [:admin_user_password]
  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)

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

class UpdateClusterInput < Struct.new(
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_arn,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = [:admin_user_password]
  include Aws::Structure
end

#shard_count ⇒ Integer

The number of shards assigned to the elastic cluster. Maximum is 32.

Returns:

• (Integer)

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

class UpdateClusterInput < Struct.new(
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_arn,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = [:admin_user_password]
  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)

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

class UpdateClusterInput < Struct.new(
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_arn,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = [:admin_user_password]
  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 1130

class UpdateClusterInput < Struct.new(
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_arn,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = [:admin_user_password]
  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 1130

class UpdateClusterInput < Struct.new(
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_arn,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :vpc_security_group_ids)
  SENSITIVE = [:admin_user_password]
  include Aws::Structure
end