Package software.amazon.awscdk.services.dax

Class CfnCluster

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.dax.CfnCluster
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.237Z") @Stability(Stable) public class CfnCluster extends CfnResource implements IInspectable
A CloudFormation AWS::DAX::Cluster.

Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.

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;
 CfnCluster cfnCluster = CfnCluster.Builder.create(this, "MyCfnCluster")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCluster

      protected CfnCluster(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCluster

      protected CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCluster

      @Stability(Stable) public CfnCluster(@NotNull Construct scope, @NotNull String id, @NotNull CfnClusterProps props)
      Create a new AWS::DAX::Cluster.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Returns the ARN of the DAX cluster. For example:.

      { "Fn::GetAtt": [" MyDAXCluster ", "Arn"] }

      Returns a value similar to the following:

      arn:aws:dax:us-east-1:111122223333:cache/MyDAXCluster

    • getAttrClusterDiscoveryEndpoint

      @Stability(Stable) @NotNull public String getAttrClusterDiscoveryEndpoint()
      Returns the endpoint of the DAX cluster. For example:.

      { "Fn::GetAtt": [" MyDAXCluster ", "ClusterDiscoveryEndpoint"] }

      Returns a value similar to the following:

      mydaxcluster.0h3d6x.clustercfg.dax.use1.cache.amazonaws.com:8111

    • getAttrClusterDiscoveryEndpointUrl

      @Stability(Stable) @NotNull public String getAttrClusterDiscoveryEndpointUrl()
      Returns the endpoint URL of the DAX cluster.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      A set of tags to associate with the DAX cluster.

    • getIamRoleArn

      @Stability(Stable) @NotNull public String 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.

    • setIamRoleArn

      @Stability(Stable) public void setIamRoleArn(@NotNull String value)
      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.

    • getNodeType

      @Stability(Stable) @NotNull public String getNodeType()
      The node type for the nodes in the cluster.

      (All nodes in a DAX cluster are of the same type.)

    • setNodeType

      @Stability(Stable) public void setNodeType(@NotNull String value)
      The node type for the nodes in the cluster.

      (All nodes in a DAX cluster are of the same type.)

    • getReplicationFactor

      @Stability(Stable) @NotNull public Number 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 the ReplicationFactor .

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

    • setReplicationFactor

      @Stability(Stable) public void setReplicationFactor(@NotNull Number value)
      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.

    • getAvailabilityZones

      @Stability(Stable) @Nullable public List<String> 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.

    • setAvailabilityZones

      @Stability(Stable) public void setAvailabilityZones(@Nullable List<String> value)
      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.

    • getClusterEndpointEncryptionType

      @Stability(Stable) @Nullable public String 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 .

    • setClusterEndpointEncryptionType

      @Stability(Stable) public void setClusterEndpointEncryptionType(@Nullable String value)
      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 .

    • getClusterName

      @Stability(Stable) @Nullable public String getClusterName()
      The name of the DAX cluster.

    • setClusterName

      @Stability(Stable) public void setClusterName(@Nullable String value)
      The name of the DAX cluster.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the cluster.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the cluster.

    • getNotificationTopicArn

      @Stability(Stable) @Nullable public String 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.

    • setNotificationTopicArn

      @Stability(Stable) public void setNotificationTopicArn(@Nullable String value)
      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.

    • getParameterGroupName

      @Stability(Stable) @Nullable public String getParameterGroupName()
      The parameter group to be associated with the DAX cluster.

    • setParameterGroupName

      @Stability(Stable) public void setParameterGroupName(@Nullable String value)
      The parameter group to be associated with the DAX cluster.

    • getPreferredMaintenanceWindow

      @Stability(Stable) @Nullable public String 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.

    • setPreferredMaintenanceWindow

      @Stability(Stable) public void setPreferredMaintenanceWindow(@Nullable String value)
      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.

    • getSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> 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.

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@Nullable List<String> value)
      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.

    • getSseSpecification

      @Stability(Stable) @Nullable public Object getSseSpecification()
      Represents the settings used to enable server-side encryption on the cluster.

    • setSseSpecification

      @Stability(Stable) public void setSseSpecification(@Nullable CfnCluster.SSESpecificationProperty value)
      Represents the settings used to enable server-side encryption on the cluster.

    • setSseSpecification

      @Stability(Stable) public void setSseSpecification(@Nullable IResolvable value)
      Represents the settings used to enable server-side encryption on the cluster.

    • getSubnetGroupName

      @Stability(Stable) @Nullable public String 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.

    • setSubnetGroupName

      @Stability(Stable) public void setSubnetGroupName(@Nullable String value)
      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.