Package software.amazon.awscdk.services.dax

Class CfnCluster

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.dax.CfnCluster
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-24T21:00:27.968Z") @Stability(Stable) public class CfnCluster extends CfnResource implements IInspectable, ITaggable
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();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnClusterProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getIamRoleArn

      @Stability(Stable) @NotNull public String getIamRoleArn()
      A valid Amazon Resource Name (ARN) that identifies an IAM role.

    • setIamRoleArn

      @Stability(Stable) public void setIamRoleArn(@NotNull String value)
      A valid Amazon Resource Name (ARN) that identifies an IAM role.

    • getNodeType

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

    • setNodeType

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

    • getReplicationFactor

      @Stability(Stable) @NotNull public Number getReplicationFactor()
      The number of nodes in the DAX cluster.

    • setReplicationFactor

      @Stability(Stable) public void setReplicationFactor(@NotNull Number value)
      The number of nodes in the DAX 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.

    • 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.

    • getClusterEndpointEncryptionType

      @Stability(Stable) @Nullable public String getClusterEndpointEncryptionType()
      The encryption type of the cluster's endpoint.

      Available values are:.

    • setClusterEndpointEncryptionType

      @Stability(Stable) public void setClusterEndpointEncryptionType(@Nullable String value)
      The encryption type of the cluster's endpoint.

      Available values are:.

    • 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.

    • 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.

    • 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.

    • setPreferredMaintenanceWindow

      @Stability(Stable) public void setPreferredMaintenanceWindow(@Nullable String value)
      A range of time when maintenance of DAX cluster software will be performed.

    • getSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getSecurityGroupIds()
      A list of security group IDs to be assigned to each node in the DAX cluster.

    • 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.

    • 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 IResolvable value)
      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.

    • getSubnetGroupName

      @Stability(Stable) @Nullable public String getSubnetGroupName()
      The name of the subnet group to be used for the replication group.

    • setSubnetGroupName

      @Stability(Stable) public void setSubnetGroupName(@Nullable String value)
      The name of the subnet group to be used for the replication group.

    • getTagsRaw

      @Stability(Stable) @Nullable public Object getTagsRaw()
      A set of tags to associate with the DAX cluster.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Object value)
      A set of tags to associate with the DAX cluster.