AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateCluster operation. Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.DAX.AmazonDAXRequest
      Amazon.DAX.Model.CreateClusterRequest

Namespace: Amazon.DAX.Model
Assembly: AWSSDK.DAX.dll
Version: 3.x.y.z

Syntax

C#
public class CreateClusterRequest : AmazonDAXRequest
         IAmazonWebServiceRequest

The CreateClusterRequest type exposes the following members

Constructors

NameDescription
Public Method CreateClusterRequest()

Properties

NameTypeDescription
Public Property AvailabilityZones System.Collections.Generic.List<System.String>

Gets and sets the property AvailabilityZones.

The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs.

Public Property ClusterName System.String

Gets and sets the property ClusterName.

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.

Public Property Description System.String

Gets and sets the property Description.

A description of the cluster.

Public Property IamRoleArn System.String

Gets and sets the property IamRoleArn.

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.

Public Property NodeType System.String

Gets and sets the property NodeType.

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

Public Property NotificationTopicArn System.String

Gets and sets the property NotificationTopicArn.

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.

Public Property ParameterGroupName System.String

Gets and sets the property ParameterGroupName.

The parameter group to be associated with the DAX cluster.

Public Property PreferredMaintenanceWindow System.String

Gets and sets the property PreferredMaintenanceWindow.

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.

Public Property ReplicationFactor System.Int32

Gets and sets the property ReplicationFactor.

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 2 or more.

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

Public Property SecurityGroupIds System.Collections.Generic.List<System.String>

Gets and sets the property SecurityGroupIds.

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.

Public Property SubnetGroupName System.String

Gets and sets the property SubnetGroupName.

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.

Public Property Tags System.Collections.Generic.List<Amazon.DAX.Model.Tag>

Gets and sets the property Tags.

A set of tags to associate with the DAX cluster.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms