@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:37.904Z") @Stability(value=Stable) public interface CfnClusterProps extends software.amazon.jsii.JsiiSerializable
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();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnClusterProps.Builder
A builder for
CfnClusterProps |
static class |
CfnClusterProps.Jsii$Proxy
An implementation for
CfnClusterProps |
| Modifier and Type | Method and Description |
|---|---|
static CfnClusterProps.Builder |
builder() |
default List<String> |
getAvailabilityZones()
The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated.
|
default String |
getClusterEndpointEncryptionType()
The encryption type of the cluster's endpoint.
|
default String |
getClusterName()
The name of the DAX cluster.
|
default String |
getDescription()
The description of the cluster.
|
String |
getIamRoleArn()
A valid Amazon Resource Name (ARN) that identifies an IAM role.
|
String |
getNodeType()
The node type for the nodes in the cluster.
|
default String |
getNotificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
|
default String |
getParameterGroupName()
The parameter group to be associated with the DAX cluster.
|
default String |
getPreferredMaintenanceWindow()
A range of time when maintenance of DAX cluster software will be performed.
|
Number |
getReplicationFactor()
The number of nodes in the DAX cluster.
|
default List<String> |
getSecurityGroupIds()
A list of security group IDs to be assigned to each node in the DAX cluster.
|
default Object |
getSseSpecification()
Represents the settings used to enable server-side encryption on the cluster.
|
default String |
getSubnetGroupName()
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.
|
@Stability(value=Stable) @NotNull String getIamRoleArn()
At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
@Stability(value=Stable) @NotNull String getNodeType()
(All nodes in a DAX cluster are of the same type.)
@Stability(value=Stable) @NotNull Number getReplicationFactor()
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.
@Stability(value=Stable) @Nullable default List<String> getAvailabilityZones()
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.
@Stability(value=Stable) @Nullable default String getClusterEndpointEncryptionType()
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 .
@Stability(value=Stable) @Nullable default String getClusterName()
@Stability(value=Stable) @Nullable default String getDescription()
@Stability(value=Stable) @Nullable default String getNotificationTopicArn()
The Amazon SNS topic owner must be same as the DAX cluster owner.
@Stability(value=Stable) @Nullable default String getParameterGroupName()
@Stability(value=Stable) @Nullable default String getPreferredMaintenanceWindow()
For example: sun:01:00-sun:09:00 . Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.
@Stability(value=Stable) @Nullable default List<String> getSecurityGroupIds()
(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.
@Stability(value=Stable) @Nullable default Object getSseSpecification()
@Stability(value=Stable) @Nullable default String getSubnetGroupName()
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.
@Stability(value=Stable) @Nullable default Object getTags()
@Stability(value=Stable) static CfnClusterProps.Builder builder()
CfnClusterProps.Builder of CfnClusterPropsCopyright © 2022. All rights reserved.