Interface CfnClusterProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnClusterProps.Jsii$Proxy
CfnCluster
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.dax.*; Object tags; CfnClusterProps cfnClusterProps = CfnClusterProps.builder() .iamRoleArn("iamRoleArn") .nodeType("nodeType") .replicationFactor(123) // the properties below are optional .availabilityZones(List.of("availabilityZones")) .clusterEndpointEncryptionType("clusterEndpointEncryptionType") .clusterName("clusterName") .description("description") .notificationTopicArn("notificationTopicArn") .parameterGroupName("parameterGroupName") .preferredMaintenanceWindow("preferredMaintenanceWindow") .securityGroupIds(List.of("securityGroupIds")) .sseSpecification(SSESpecificationProperty.builder() .sseEnabled(false) .build()) .subnetGroupName("subnetGroupName") .tags(tags) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnClusterProps
static final class
An implementation forCfnClusterProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnClusterProps.Builder
builder()
The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated.default String
The encryption type of the cluster's endpoint.default String
The name of the DAX cluster.default String
The description of the cluster.A valid Amazon Resource Name (ARN) that identifies an IAM role.The node type for the nodes in the cluster.default String
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.default String
The parameter group to be associated with the DAX cluster.default String
A range of time when maintenance of DAX cluster software will be performed.The number of nodes in the DAX cluster.A list of security group IDs to be assigned to each node in the DAX cluster.default Object
Represents the settings used to enable server-side encryption on the cluster.default String
The name of the subnet group to be used for the replication group.default Object
getTags()
A set of tags to associate with the DAX cluster.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getIamRoleArn
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.
- See Also:
-
getNodeType
The node type for the nodes in the cluster.(All nodes in a DAX cluster are of the same type.)
- See Also:
-
getReplicationFactor
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 theReplicationFactor
.AWS recommends that you have at least two read replicas per cluster.
- See Also:
-
getAvailabilityZones
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.- See Also:
-
getClusterEndpointEncryptionType
The encryption type of the cluster's endpoint. Available values are:.NONE
- The cluster's endpoint will be unencrypted.TLS
- The cluster's endpoint will be encrypted with Transport Layer Security, and will provide an x509 certificate for authentication.
The default value is
NONE
.- See Also:
-
getClusterName
The name of the DAX cluster.- See Also:
-
getDescription
The description of the cluster.- See Also:
-
getNotificationTopicArn
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.
- See Also:
-
getParameterGroupName
The parameter group to be associated with the DAX cluster.- See Also:
-
getPreferredMaintenanceWindow
A range of time when maintenance of DAX cluster software will be performed.For example:
sun:01:00-sun:09:00
. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.- See Also:
-
getSecurityGroupIds
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.
- See Also:
-
getSseSpecification
Represents the settings used to enable server-side encryption on the cluster.- See Also:
-
getSubnetGroupName
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.
- See Also:
-
getTags
A set of tags to associate with the DAX cluster.- See Also:
-
builder
- Returns:
- a
CfnClusterProps.Builder
ofCfnClusterProps
-