You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass CreateClusterRequest data as a hash:

{
  cluster_name: "String", # required
  node_type: "String", # required
  description: "String",
  replication_factor: 1, # required
  availability_zones: ["String"],
  subnet_group_name: "String",
  security_group_ids: ["String"],
  preferred_maintenance_window: "String",
  notification_topic_arn: "String",
  iam_role_arn: "String", # required
  parameter_group_name: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  sse_specification: {
    enabled: false, # required
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zonesArray<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>)


266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 266

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)
  include Aws::Structure
end

#cluster_nameString

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)


266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 266

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)
  include Aws::Structure
end

#descriptionString

A description of the cluster.

Returns:

  • (String)


266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 266

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)
  include Aws::Structure
end

#iam_role_arnString

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)


266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 266

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)
  include Aws::Structure
end

#node_typeString

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

Returns:

  • (String)


266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 266

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)
  include Aws::Structure
end

#notification_topic_arnString

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

The Amazon SNS topic owner must be same as the DAX cluster owner.

Returns:

  • (String)


266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 266

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)
  include Aws::Structure
end

#parameter_group_nameString

The parameter group to be associated with the DAX cluster.

Returns:

  • (String)


266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 266

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)
  include Aws::Structure
end

#preferred_maintenance_windowString

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

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.

Returns:

  • (String)


266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 266

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)
  include Aws::Structure
end

#replication_factorInteger

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.

AWS recommends that you have at least two read replicas per cluster.

Returns:

  • (Integer)


266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 266

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)
  include Aws::Structure
end

#security_group_idsArray<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>)


266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 266

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)
  include Aws::Structure
end

#sse_specificationTypes::SSESpecification

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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 266

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)
  include Aws::Structure
end

#subnet_group_nameString

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)


266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 266

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)
  include Aws::Structure
end

#tagsArray<Types::Tag>

A set of tags to associate with the DAX cluster.

Returns:



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 266

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)
  include Aws::Structure
end