Class: Aws::DAX::Types::CreateClusterRequest

Inherits:

Struct

Object
Struct
Aws::DAX::Types::CreateClusterRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-dax/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#availability_zones ⇒ Array<String>

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated.
#cluster_endpoint_encryption_type ⇒ String

The type of encryption the cluster’s endpoint should support.
#cluster_name ⇒ String

The cluster identifier.
#description ⇒ String

A description of the cluster.
#iam_role_arn ⇒ String

A valid Amazon Resource Name (ARN) that identifies an IAM role.
#node_type ⇒ String

The compute and memory capacity of the nodes in the cluster.
#notification_topic_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
#parameter_group_name ⇒ String

The parameter group to be associated with the DAX cluster.
#preferred_maintenance_window ⇒ String

Specifies the weekly time range during which maintenance on the DAX cluster is performed.
#replication_factor ⇒ Integer

The number of nodes in the DAX cluster.
#security_group_ids ⇒ Array<String>

A list of security group IDs to be assigned to each node in the DAX cluster.
#sse_specification ⇒ Types::SSESpecification

Represents the settings used to enable server-side encryption on the cluster.
#subnet_group_name ⇒ String

The name of the subnet group to be used for the replication group.
#tags ⇒ Array<Types::Tag>

A set of tags to associate with the DAX cluster.

Instance Attribute Details

#availability_zones ⇒ `Array<String>`

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ‘ReplicationFactor` parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

Returns:

(Array<String>)

# File 'lib/aws-sdk-dax/types.rb', line 279

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :node_type,
  :description,
  :replication_factor,
  :availability_zones,
  :subnet_group_name,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :iam_role_arn,
  :parameter_group_name,
  :tags,
  :sse_specification,
  :cluster_endpoint_encryption_type)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_endpoint_encryption_type ⇒ `String`

The type of encryption the cluster’s endpoint should support. Values are:

‘NONE` for no encryption
‘TLS` for Transport Layer Security

Returns:

(String)

# File 'lib/aws-sdk-dax/types.rb', line 279

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :node_type,
  :description,
  :replication_factor,
  :availability_zones,
  :subnet_group_name,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :iam_role_arn,
  :parameter_group_name,
  :tags,
  :sse_specification,
  :cluster_endpoint_encryption_type)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_name ⇒ `String`

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

A name must contain from 1 to 20 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.

Returns:

(String)

# File 'lib/aws-sdk-dax/types.rb', line 279

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :node_type,
  :description,
  :replication_factor,
  :availability_zones,
  :subnet_group_name,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :iam_role_arn,
  :parameter_group_name,
  :tags,
  :sse_specification,
  :cluster_endpoint_encryption_type)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A description of the cluster.

Returns:

(String)

# File 'lib/aws-sdk-dax/types.rb', line 279

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :node_type,
  :description,
  :replication_factor,
  :availability_zones,
  :subnet_group_name,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :iam_role_arn,
  :parameter_group_name,
  :tags,
  :sse_specification,
  :cluster_endpoint_encryption_type)
  SENSITIVE = []
  include Aws::Structure
end

#iam_role_arn ⇒ `String`

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role’s permissions to access DynamoDB on your behalf.

Returns:

(String)

# File 'lib/aws-sdk-dax/types.rb', line 279

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :node_type,
  :description,
  :replication_factor,
  :availability_zones,
  :subnet_group_name,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :iam_role_arn,
  :parameter_group_name,
  :tags,
  :sse_specification,
  :cluster_endpoint_encryption_type)
  SENSITIVE = []
  include Aws::Structure
end

#node_type ⇒ `String`

The compute and memory capacity of the nodes in the cluster.

Returns:

(String)

# File 'lib/aws-sdk-dax/types.rb', line 279

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :node_type,
  :description,
  :replication_factor,
  :availability_zones,
  :subnet_group_name,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :iam_role_arn,
  :parameter_group_name,
  :tags,
  :sse_specification,
  :cluster_endpoint_encryption_type)
  SENSITIVE = []
  include Aws::Structure
end

#notification_topic_arn ⇒ `String`

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

<note markdown=“1”> The Amazon SNS topic owner must be same as the DAX cluster owner.

</note>

Returns:

(String)

# File 'lib/aws-sdk-dax/types.rb', line 279

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :node_type,
  :description,
  :replication_factor,
  :availability_zones,
  :subnet_group_name,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :iam_role_arn,
  :parameter_group_name,
  :tags,
  :sse_specification,
  :cluster_endpoint_encryption_type)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_group_name ⇒ `String`

The parameter group to be associated with the DAX cluster.

Returns:

(String)

# File 'lib/aws-sdk-dax/types.rb', line 279

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :node_type,
  :description,
  :replication_factor,
  :availability_zones,
  :subnet_group_name,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :iam_role_arn,
  :parameter_group_name,
  :tags,
  :sse_specification,
  :cluster_endpoint_encryption_type)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_window ⇒ `String`

Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ‘ddd` are:

‘sun`
‘mon`
‘tue`
‘wed`
‘thu`
‘fri`
‘sat`

Example: ‘sun:05:00-sun:09:00`

<note markdown=“1”> If you don’t specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

</note>

Returns:

(String)

# File 'lib/aws-sdk-dax/types.rb', line 279

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :node_type,
  :description,
  :replication_factor,
  :availability_zones,
  :subnet_group_name,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :iam_role_arn,
  :parameter_group_name,
  :tags,
  :sse_specification,
  :cluster_endpoint_encryption_type)
  SENSITIVE = []
  include Aws::Structure
end

#replication_factor ⇒ `Integer`

The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ‘ReplicationFactor` to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). `If the AvailabilityZones` parameter is provided, its length must equal the `ReplicationFactor`.

<note markdown=“1”> AWS recommends that you have at least two read replicas per cluster.

</note>

Returns:

(Integer)

# File 'lib/aws-sdk-dax/types.rb', line 279

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :node_type,
  :description,
  :replication_factor,
  :availability_zones,
  :subnet_group_name,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :iam_role_arn,
  :parameter_group_name,
  :tags,
  :sse_specification,
  :cluster_endpoint_encryption_type)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ `Array<String>`

A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

If this parameter is not specified, DAX assigns the default VPC security group to each node.

Returns:

(Array<String>)

# File 'lib/aws-sdk-dax/types.rb', line 279

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :node_type,
  :description,
  :replication_factor,
  :availability_zones,
  :subnet_group_name,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :iam_role_arn,
  :parameter_group_name,
  :tags,
  :sse_specification,
  :cluster_endpoint_encryption_type)
  SENSITIVE = []
  include Aws::Structure
end

#sse_specification ⇒ `Types::SSESpecification`

Represents the settings used to enable server-side encryption on the cluster.

Returns:

(Types::SSESpecification)

# File 'lib/aws-sdk-dax/types.rb', line 279

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :node_type,
  :description,
  :replication_factor,
  :availability_zones,
  :subnet_group_name,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :iam_role_arn,
  :parameter_group_name,
  :tags,
  :sse_specification,
  :cluster_endpoint_encryption_type)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_group_name ⇒ `String`

The name of the subnet group to be used for the replication group.

DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

Returns:

(String)

# File 'lib/aws-sdk-dax/types.rb', line 279

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :node_type,
  :description,
  :replication_factor,
  :availability_zones,
  :subnet_group_name,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :iam_role_arn,
  :parameter_group_name,
  :tags,
  :sse_specification,
  :cluster_endpoint_encryption_type)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

A set of tags to associate with the DAX cluster.

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-dax/types.rb', line 279

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :node_type,
  :description,
  :replication_factor,
  :availability_zones,
  :subnet_group_name,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :iam_role_arn,
  :parameter_group_name,
  :tags,
  :sse_specification,
  :cluster_endpoint_encryption_type)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::DAX::Types::CreateClusterRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zones ⇒ Array<String>

#cluster_endpoint_encryption_type ⇒ String

#cluster_name ⇒ String

#description ⇒ String

#iam_role_arn ⇒ String

#node_type ⇒ String

#notification_topic_arn ⇒ String

#parameter_group_name ⇒ String

#preferred_maintenance_window ⇒ String

#replication_factor ⇒ Integer

#security_group_ids ⇒ Array<String>

#sse_specification ⇒ Types::SSESpecification

#subnet_group_name ⇒ String

#tags ⇒ Array<Types::Tag>

#availability_zones ⇒ `Array<String>`

#cluster_endpoint_encryption_type ⇒ `String`

#cluster_name ⇒ `String`

#description ⇒ `String`

#iam_role_arn ⇒ `String`

#node_type ⇒ `String`

#notification_topic_arn ⇒ `String`

#parameter_group_name ⇒ `String`

#preferred_maintenance_window ⇒ `String`

#replication_factor ⇒ `Integer`

#security_group_ids ⇒ `Array<String>`

#sse_specification ⇒ `Types::SSESpecification`

#subnet_group_name ⇒ `String`

#tags ⇒ `Array<Types::Tag>`