Interface ICfnClusterProps
Properties for defining a CfnCluster
.
Namespace: Amazon.CDK.AWS.DAX
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnClusterProps
Syntax (vb)
Public Interface ICfnClusterProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DAX;
var tags;
var cfnClusterProps = new CfnClusterProps {
IamRoleArn = "iamRoleArn",
NodeType = "nodeType",
ReplicationFactor = 123,
// the properties below are optional
AvailabilityZones = new [] { "availabilityZones" },
ClusterEndpointEncryptionType = "clusterEndpointEncryptionType",
ClusterName = "clusterName",
Description = "description",
NotificationTopicArn = "notificationTopicArn",
ParameterGroupName = "parameterGroupName",
PreferredMaintenanceWindow = "preferredMaintenanceWindow",
SecurityGroupIds = new [] { "securityGroupIds" },
SseSpecification = new SSESpecificationProperty {
SseEnabled = false
},
SubnetGroupName = "subnetGroupName",
Tags = tags
};
Synopsis
Properties
AvailabilityZones | The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. |
ClusterEndpointEncryptionType | The encryption type of the cluster's endpoint. Available values are:. |
ClusterName | The name of the DAX cluster. |
Description | The description of the cluster. |
IamRoleArn | A valid Amazon Resource Name (ARN) that identifies an IAM role. |
NodeType | The node type for the nodes in the cluster. |
NotificationTopicArn | The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent. |
ParameterGroupName | The parameter group to be associated with the DAX cluster. |
PreferredMaintenanceWindow | A range of time when maintenance of DAX cluster software will be performed. |
ReplicationFactor | The number of nodes in the DAX cluster. |
SecurityGroupIds | A list of security group IDs to be assigned to each node in the DAX cluster. |
SseSpecification | Represents the settings used to enable server-side encryption on the cluster. |
SubnetGroupName | The name of the subnet group to be used for the replication group. |
Tags | A set of tags to associate with the DAX cluster. |
Properties
AvailabilityZones
The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated.
virtual string[] AvailabilityZones { get; }
Property Value
System.String[]
Remarks
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.
ClusterEndpointEncryptionType
The encryption type of the cluster's endpoint. Available values are:.
virtual string ClusterEndpointEncryptionType { get; }
Property Value
System.String
Remarks
ClusterName
The name of the DAX cluster.
virtual string ClusterName { get; }
Property Value
System.String
Remarks
Description
The description of the cluster.
virtual string Description { get; }
Property Value
System.String
Remarks
IamRoleArn
A valid Amazon Resource Name (ARN) that identifies an IAM role.
string IamRoleArn { get; }
Property Value
System.String
Remarks
At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
NodeType
The node type for the nodes in the cluster.
string NodeType { get; }
Property Value
System.String
Remarks
(All nodes in a DAX cluster are of the same type.)
NotificationTopicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
virtual string NotificationTopicArn { get; }
Property Value
System.String
Remarks
The Amazon SNS topic owner must be same as the DAX cluster owner.
ParameterGroupName
The parameter group to be associated with the DAX cluster.
virtual string ParameterGroupName { get; }
Property Value
System.String
Remarks
PreferredMaintenanceWindow
A range of time when maintenance of DAX cluster software will be performed.
virtual string PreferredMaintenanceWindow { get; }
Property Value
System.String
Remarks
For example: sun:01:00-sun:09:00
. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.
ReplicationFactor
The number of nodes in the DAX cluster.
double ReplicationFactor { get; }
Property Value
System.Double
Remarks
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.
SecurityGroupIds
A list of security group IDs to be assigned to each node in the DAX cluster.
virtual string[] SecurityGroupIds { get; }
Property Value
System.String[]
Remarks
(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.
SseSpecification
Represents the settings used to enable server-side encryption on the cluster.
virtual object SseSpecification { get; }
Property Value
System.Object
Remarks
SubnetGroupName
The name of the subnet group to be used for the replication group.
virtual string SubnetGroupName { get; }
Property Value
System.String
Remarks
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.
Tags
A set of tags to associate with the DAX cluster.
virtual object Tags { get; }
Property Value
System.Object