Package com.pulumi.aws.dax

Class Cluster

  • public class Cluster
extends com.pulumi.resources.CustomResource
    Provides a DAX Cluster resource. ## Example Usage <!--Start PulumiCodeChooser --> 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.dax.Cluster;
 import com.pulumi.aws.dax.ClusterArgs;
 import java.util.List;
 import java.util.ArrayList;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var bar = new Cluster("bar", ClusterArgs.builder()
             .clusterName("cluster-example")
             .iamRoleArn(example.arn())
             .nodeType("dax.r4.large")
             .replicationFactor(1)
             .build());
 
     }
 }
    <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import DAX Clusters using the `cluster_name`. For example: ```sh $ pulumi import aws:dax/cluster:Cluster my_cluster my_cluster ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Cluster​(java.lang.String name)  
      Cluster​(java.lang.String name, ClusterArgs args)  
      Cluster​(java.lang.String name, ClusterArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> availabilityZones()  
      com.pulumi.core.Output<java.lang.String> clusterAddress()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> clusterEndpointEncryptionType()  
      com.pulumi.core.Output<java.lang.String> clusterName()  
      com.pulumi.core.Output<java.lang.String> configurationEndpoint()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static Cluster get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ClusterState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> iamRoleArn()  
      com.pulumi.core.Output<java.lang.String> maintenanceWindow()  
      com.pulumi.core.Output<java.util.List<ClusterNode>> nodes()  
      com.pulumi.core.Output<java.lang.String> nodeType()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> notificationTopicArn()  
      com.pulumi.core.Output<java.lang.String> parameterGroupName()  
      com.pulumi.core.Output<java.lang.Integer> port()  
      com.pulumi.core.Output<java.lang.Integer> replicationFactor()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> securityGroupIds()  
      com.pulumi.core.Output<java.util.Optional<ClusterServerSideEncryption>> serverSideEncryption()  
      com.pulumi.core.Output<java.lang.String> subnetGroupName()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Cluster

        public Cluster​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Cluster

        public Cluster​(java.lang.String name,
               ClusterArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Cluster

        public Cluster​(java.lang.String name,
               ClusterArgs args,
               @Nullable
               com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        The ARN of the DAX cluster

      • availabilityZones

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> availabilityZones()
        Returns:
        List of Availability Zones in which the nodes will be created

      • clusterAddress

        public com.pulumi.core.Output<java.lang.String> clusterAddress()
        Returns:
        The DNS name of the DAX cluster without the port appended

      • clusterEndpointEncryptionType

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> clusterEndpointEncryptionType()
        Returns:
        The type of encryption the cluster's endpoint should support. Valid values are: `NONE` and `TLS`. Default value is `NONE`.

      • clusterName

        public com.pulumi.core.Output<java.lang.String> clusterName()
        Returns:
        Group identifier. DAX converts this name to lowercase

      • configurationEndpoint

        public com.pulumi.core.Output<java.lang.String> configurationEndpoint()
        Returns:
        The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description for the cluster

      • iamRoleArn

        public com.pulumi.core.Output<java.lang.String> iamRoleArn()
        Returns:
        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

      • maintenanceWindow

        public com.pulumi.core.Output<java.lang.String> maintenanceWindow()
        Returns:
        Specifies the weekly time range for when maintenance on the cluster is performed. The format is `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: `sun:05:00-sun:09:00`

      • nodeType

        public com.pulumi.core.Output<java.lang.String> nodeType()
        Returns:
        The compute and memory capacity of the nodes. See [Nodes](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.concepts.cluster.html#DAX.concepts.nodes) for supported node types

      • nodes

        public com.pulumi.core.Output<java.util.List<ClusterNode>> nodes()
        Returns:
        List of node objects including `id`, `address`, `port` and `availability_zone`. Referenceable e.g., as `${aws_dax_cluster.test.nodes.0.address}`

      • notificationTopicArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> notificationTopicArn()
        Returns:
        An Amazon Resource Name (ARN) of an SNS topic to send DAX notifications to. Example: `arn:aws:sns:us-east-1:012345678999:my_sns_topic`

      • parameterGroupName

        public com.pulumi.core.Output<java.lang.String> parameterGroupName()
        Returns:
        Name of the parameter group to associate with this DAX cluster

      • port

        public com.pulumi.core.Output<java.lang.Integer> port()
        Returns:
        The port used by the configuration endpoint

      • replicationFactor

        public com.pulumi.core.Output<java.lang.Integer> replicationFactor()
        Returns:
        The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas

      • securityGroupIds

        public com.pulumi.core.Output<java.util.List<java.lang.String>> securityGroupIds()
        Returns:
        One or more VPC security groups associated with the cluster

      • serverSideEncryption

        public com.pulumi.core.Output<java.util.Optional<ClusterServerSideEncryption>> serverSideEncryption()
        Returns:
        Encrypt at rest options

      • subnetGroupName

        public com.pulumi.core.Output<java.lang.String> subnetGroupName()
        Returns:
        Name of the subnet group to be used for the cluster

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the resource. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.

      • get

        public static Cluster get​(java.lang.String name,
                          com.pulumi.core.Output<java.lang.String> id,
                          @Nullable
                          ClusterState state,
                          @Nullable
                          com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.