Class: Aws::DocDBElastic::Types::CreateClusterInput

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:admin_user_password]

Instance Attribute Summary collapse

Instance Attribute Details

#admin_user_name ⇒ String

The name of the Amazon DocumentDB elastic clusters administrator.

Constraints:

  • Must be from 1 to 63 letters or numbers.

  • The first character must be a letter.

  • Cannot be a reserved word.

Returns:

  • (String) 


497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 497

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

#admin_user_password ⇒ String

The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.

Constraints:

  • Must contain from 8 to 100 characters.

  • Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).

Returns:

  • (String) 


497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 497

class CreateClusterInput < Struct.new(
  :admin_user_name,
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_name,
  :kms_key_id,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :tags,
  :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) 


497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 497

class CreateClusterInput < Struct.new(
  :admin_user_name,
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_name,
  :kms_key_id,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :tags,
  :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) 


497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 497

class CreateClusterInput < Struct.new(
  :admin_user_name,
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_name,
  :kms_key_id,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :tags,
  :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) 


497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 497

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

#cluster_name ⇒ String

The name of the new elastic cluster. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster

Returns:

  • (String) 


497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 497

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

#kms_key_id ⇒ String

The KMS key identifier to use to encrypt the new elastic 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, 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) 


497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 497

class CreateClusterInput < Struct.new(
  :admin_user_name,
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_name,
  :kms_key_id,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :tags,
  :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) 


497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 497

class CreateClusterInput < Struct.new(
  :admin_user_name,
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_name,
  :kms_key_id,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :tags,
  :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) 


497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 497

class CreateClusterInput < Struct.new(
  :admin_user_name,
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_name,
  :kms_key_id,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :tags,
  :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) 


497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 497

class CreateClusterInput < Struct.new(
  :admin_user_name,
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_name,
  :kms_key_id,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :tags,
  :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) 


497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 497

class CreateClusterInput < Struct.new(
  :admin_user_name,
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_name,
  :kms_key_id,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :tags,
  :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) 


497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 497

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

#subnet_ids ⇒ Array<String>

The Amazon EC2 subnet IDs for the new elastic cluster.

Returns:

  • (Array<String>) 


497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 497

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

#tags ⇒ Hash<String,String>

The tags to be assigned to the new elastic cluster.

Returns:

  • (Hash<String,String>) 


497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 497

class CreateClusterInput < Struct.new(
  :admin_user_name,
  :admin_user_password,
  :auth_type,
  :backup_retention_period,
  :client_token,
  :cluster_name,
  :kms_key_id,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :shard_capacity,
  :shard_count,
  :shard_instance_count,
  :subnet_ids,
  :tags,
  :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 new elastic cluster.

Returns:

  • (Array<String>) 


497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/types.rb', line 497

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