Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. dax
  5. Cluster

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi
pulumi/pulumi-aws

aws.dax.Cluster

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi
pulumi/pulumi-aws

    Provides a DAX Cluster resource.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var bar = new Aws.Dax.Cluster("bar", new()
    {
        ClusterName = "cluster-example",
        IamRoleArn = data.Aws_iam_role.Example.Arn,
        NodeType = "dax.r4.large",
        ReplicationFactor = 1,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/dax"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dax.NewCluster(ctx, "bar", &dax.ClusterArgs{
			ClusterName:       pulumi.String("cluster-example"),
			IamRoleArn:        pulumi.Any(data.Aws_iam_role.Example.Arn),
			NodeType:          pulumi.String("dax.r4.large"),
			ReplicationFactor: pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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(data.aws_iam_role().example().arn())
            .nodeType("dax.r4.large")
            .replicationFactor(1)
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

bar = aws.dax.Cluster("bar",
    cluster_name="cluster-example",
    iam_role_arn=data["aws_iam_role"]["example"]["arn"],
    node_type="dax.r4.large",
    replication_factor=1)

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const bar = new aws.dax.Cluster("bar", {
    clusterName: "cluster-example",
    iamRoleArn: data.aws_iam_role.example.arn,
    nodeType: "dax.r4.large",
    replicationFactor: 1,
});

    resources:
  bar:
    type: aws:dax:Cluster
    properties:
      clusterName: cluster-example
      iamRoleArn: ${data.aws_iam_role.example.arn}
      nodeType: dax.r4.large
      replicationFactor: 1

    Create Cluster Resource

    new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
    @overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            availability_zones: Optional[Sequence[str]] = None,
            cluster_endpoint_encryption_type: Optional[str] = None,
            cluster_name: Optional[str] = None,
            description: Optional[str] = None,
            iam_role_arn: Optional[str] = None,
            maintenance_window: Optional[str] = None,
            node_type: Optional[str] = None,
            notification_topic_arn: Optional[str] = None,
            parameter_group_name: Optional[str] = None,
            replication_factor: Optional[int] = None,
            security_group_ids: Optional[Sequence[str]] = None,
            server_side_encryption: Optional[ClusterServerSideEncryptionArgs] = None,
            subnet_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)
    func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

    type: aws:dax:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Cluster Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Cluster resource accepts the following input properties:

    ClusterName string

    Group identifier. DAX converts this name to lowercase

    IamRoleArn string

    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

    NodeType string

    The compute and memory capacity of the nodes. See Nodes for supported node types

    ReplicationFactor int

    The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas

    AvailabilityZones List<string>

    List of Availability Zones in which the nodes will be created

    ClusterEndpointEncryptionType string

    The type of encryption the cluster's endpoint should support. Valid values are: NONE and TLS. Default value is NONE.

    Description string

    Description for the cluster

    MaintenanceWindow string

    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

    NotificationTopicArn string

    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 string

    Name of the parameter group to associate with this DAX cluster

    SecurityGroupIds List<string>

    One or more VPC security groups associated with the cluster

    ServerSideEncryption ClusterServerSideEncryption

    Encrypt at rest options

    SubnetGroupName string

    Name of the subnet group to be used for the cluster

    Tags Dictionary<string, string>

    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.

    ClusterName string

    Group identifier. DAX converts this name to lowercase

    IamRoleArn string

    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

    NodeType string

    The compute and memory capacity of the nodes. See Nodes for supported node types

    ReplicationFactor int

    The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas

    AvailabilityZones []string

    List of Availability Zones in which the nodes will be created

    ClusterEndpointEncryptionType string

    The type of encryption the cluster's endpoint should support. Valid values are: NONE and TLS. Default value is NONE.

    Description string

    Description for the cluster

    MaintenanceWindow string

    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

    NotificationTopicArn string

    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 string

    Name of the parameter group to associate with this DAX cluster

    SecurityGroupIds []string

    One or more VPC security groups associated with the cluster

    ServerSideEncryption ClusterServerSideEncryptionArgs

    Encrypt at rest options

    SubnetGroupName string

    Name of the subnet group to be used for the cluster

    Tags map[string]string

    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.

    clusterName String

    Group identifier. DAX converts this name to lowercase

    iamRoleArn String

    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

    nodeType String

    The compute and memory capacity of the nodes. See Nodes for supported node types

    replicationFactor Integer

    The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas

    availabilityZones List<String>

    List of Availability Zones in which the nodes will be created

    clusterEndpointEncryptionType String

    The type of encryption the cluster's endpoint should support. Valid values are: NONE and TLS. Default value is NONE.

    description String

    Description for the cluster

    maintenanceWindow String

    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

    notificationTopicArn String

    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 String

    Name of the parameter group to associate with this DAX cluster

    securityGroupIds List<String>

    One or more VPC security groups associated with the cluster

    serverSideEncryption ClusterServerSideEncryption

    Encrypt at rest options

    subnetGroupName String

    Name of the subnet group to be used for the cluster

    tags Map<String,String>

    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.

    clusterName string

    Group identifier. DAX converts this name to lowercase

    iamRoleArn string

    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

    nodeType string

    The compute and memory capacity of the nodes. See Nodes for supported node types

    replicationFactor number

    The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas

    availabilityZones string[]

    List of Availability Zones in which the nodes will be created

    clusterEndpointEncryptionType string

    The type of encryption the cluster's endpoint should support. Valid values are: NONE and TLS. Default value is NONE.

    description string

    Description for the cluster

    maintenanceWindow string

    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

    notificationTopicArn string

    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 string

    Name of the parameter group to associate with this DAX cluster

    securityGroupIds string[]

    One or more VPC security groups associated with the cluster

    serverSideEncryption ClusterServerSideEncryption

    Encrypt at rest options

    subnetGroupName string

    Name of the subnet group to be used for the cluster

    tags {[key: string]: string}

    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.

    cluster_name str

    Group identifier. DAX converts this name to lowercase

    iam_role_arn str

    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

    node_type str

    The compute and memory capacity of the nodes. See Nodes for supported node types

    replication_factor int

    The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas

    availability_zones Sequence[str]

    List of Availability Zones in which the nodes will be created

    cluster_endpoint_encryption_type str

    The type of encryption the cluster's endpoint should support. Valid values are: NONE and TLS. Default value is NONE.

    description str

    Description for the cluster

    maintenance_window str

    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

    notification_topic_arn str

    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

    parameter_group_name str

    Name of the parameter group to associate with this DAX cluster

    security_group_ids Sequence[str]

    One or more VPC security groups associated with the cluster

    server_side_encryption ClusterServerSideEncryptionArgs

    Encrypt at rest options

    subnet_group_name str

    Name of the subnet group to be used for the cluster

    tags Mapping[str, str]

    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.

    clusterName String

    Group identifier. DAX converts this name to lowercase

    iamRoleArn String

    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

    nodeType String

    The compute and memory capacity of the nodes. See Nodes for supported node types

    replicationFactor Number

    The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas

    availabilityZones List<String>

    List of Availability Zones in which the nodes will be created

    clusterEndpointEncryptionType String

    The type of encryption the cluster's endpoint should support. Valid values are: NONE and TLS. Default value is NONE.

    description String

    Description for the cluster

    maintenanceWindow String

    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

    notificationTopicArn String

    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 String

    Name of the parameter group to associate with this DAX cluster

    securityGroupIds List<String>

    One or more VPC security groups associated with the cluster

    serverSideEncryption Property Map

    Encrypt at rest options

    subnetGroupName String

    Name of the subnet group to be used for the cluster

    tags Map<String>

    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

    Arn string

    The ARN of the DAX cluster

    ClusterAddress string

    The DNS name of the DAX cluster without the port appended

    ConfigurationEndpoint string

    The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number

    Id string

    The provider-assigned unique ID for this managed resource.

    Nodes List<ClusterNode>

    List of node objects including id, address, port and availability_zone. Referenceable e.g., as ${aws_dax_cluster.test.nodes.0.address}

    Port int

    The port used by the configuration endpoint

    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Arn string

    The ARN of the DAX cluster

    ClusterAddress string

    The DNS name of the DAX cluster without the port appended

    ConfigurationEndpoint string

    The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number

    Id string

    The provider-assigned unique ID for this managed resource.

    Nodes []ClusterNode

    List of node objects including id, address, port and availability_zone. Referenceable e.g., as ${aws_dax_cluster.test.nodes.0.address}

    Port int

    The port used by the configuration endpoint

    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    The ARN of the DAX cluster

    clusterAddress String

    The DNS name of the DAX cluster without the port appended

    configurationEndpoint String

    The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number

    id String

    The provider-assigned unique ID for this managed resource.

    nodes List<ClusterNode>

    List of node objects including id, address, port and availability_zone. Referenceable e.g., as ${aws_dax_cluster.test.nodes.0.address}

    port Integer

    The port used by the configuration endpoint

    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn string

    The ARN of the DAX cluster

    clusterAddress string

    The DNS name of the DAX cluster without the port appended

    configurationEndpoint string

    The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number

    id string

    The provider-assigned unique ID for this managed resource.

    nodes ClusterNode[]

    List of node objects including id, address, port and availability_zone. Referenceable e.g., as ${aws_dax_cluster.test.nodes.0.address}

    port number

    The port used by the configuration endpoint

    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn str

    The ARN of the DAX cluster

    cluster_address str

    The DNS name of the DAX cluster without the port appended

    configuration_endpoint str

    The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number

    id str

    The provider-assigned unique ID for this managed resource.

    nodes Sequence[ClusterNode]

    List of node objects including id, address, port and availability_zone. Referenceable e.g., as ${aws_dax_cluster.test.nodes.0.address}

    port int

    The port used by the configuration endpoint

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    The ARN of the DAX cluster

    clusterAddress String

    The DNS name of the DAX cluster without the port appended

    configurationEndpoint String

    The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number

    id String

    The provider-assigned unique ID for this managed resource.

    nodes List<Property Map>

    List of node objects including id, address, port and availability_zone. Referenceable e.g., as ${aws_dax_cluster.test.nodes.0.address}

    port Number

    The port used by the configuration endpoint

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Look up Existing Cluster Resource

    Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ClusterState, opts?: CustomResourceOptions): Cluster
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        availability_zones: Optional[Sequence[str]] = None,
        cluster_address: Optional[str] = None,
        cluster_endpoint_encryption_type: Optional[str] = None,
        cluster_name: Optional[str] = None,
        configuration_endpoint: Optional[str] = None,
        description: Optional[str] = None,
        iam_role_arn: Optional[str] = None,
        maintenance_window: Optional[str] = None,
        node_type: Optional[str] = None,
        nodes: Optional[Sequence[ClusterNodeArgs]] = None,
        notification_topic_arn: Optional[str] = None,
        parameter_group_name: Optional[str] = None,
        port: Optional[int] = None,
        replication_factor: Optional[int] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        server_side_encryption: Optional[ClusterServerSideEncryptionArgs] = None,
        subnet_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Cluster
    func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
    public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
    public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string

    The ARN of the DAX cluster

    AvailabilityZones List<string>

    List of Availability Zones in which the nodes will be created

    ClusterAddress string

    The DNS name of the DAX cluster without the port appended

    ClusterEndpointEncryptionType string

    The type of encryption the cluster's endpoint should support. Valid values are: NONE and TLS. Default value is NONE.

    ClusterName string

    Group identifier. DAX converts this name to lowercase

    ConfigurationEndpoint string

    The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number

    Description string

    Description for the cluster

    IamRoleArn string

    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 string

    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 string

    The compute and memory capacity of the nodes. See Nodes for supported node types

    Nodes List<ClusterNode>

    List of node objects including id, address, port and availability_zone. Referenceable e.g., as ${aws_dax_cluster.test.nodes.0.address}

    NotificationTopicArn string

    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 string

    Name of the parameter group to associate with this DAX cluster

    Port int

    The port used by the configuration endpoint

    ReplicationFactor int

    The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas

    SecurityGroupIds List<string>

    One or more VPC security groups associated with the cluster

    ServerSideEncryption ClusterServerSideEncryption

    Encrypt at rest options

    SubnetGroupName string

    Name of the subnet group to be used for the cluster

    Tags Dictionary<string, string>

    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 Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Arn string

    The ARN of the DAX cluster

    AvailabilityZones []string

    List of Availability Zones in which the nodes will be created

    ClusterAddress string

    The DNS name of the DAX cluster without the port appended

    ClusterEndpointEncryptionType string

    The type of encryption the cluster's endpoint should support. Valid values are: NONE and TLS. Default value is NONE.

    ClusterName string

    Group identifier. DAX converts this name to lowercase

    ConfigurationEndpoint string

    The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number

    Description string

    Description for the cluster

    IamRoleArn string

    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 string

    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 string

    The compute and memory capacity of the nodes. See Nodes for supported node types

    Nodes []ClusterNodeArgs

    List of node objects including id, address, port and availability_zone. Referenceable e.g., as ${aws_dax_cluster.test.nodes.0.address}

    NotificationTopicArn string

    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 string

    Name of the parameter group to associate with this DAX cluster

    Port int

    The port used by the configuration endpoint

    ReplicationFactor int

    The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas

    SecurityGroupIds []string

    One or more VPC security groups associated with the cluster

    ServerSideEncryption ClusterServerSideEncryptionArgs

    Encrypt at rest options

    SubnetGroupName string

    Name of the subnet group to be used for the cluster

    Tags map[string]string

    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 map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    The ARN of the DAX cluster

    availabilityZones List<String>

    List of Availability Zones in which the nodes will be created

    clusterAddress String

    The DNS name of the DAX cluster without the port appended

    clusterEndpointEncryptionType String

    The type of encryption the cluster's endpoint should support. Valid values are: NONE and TLS. Default value is NONE.

    clusterName String

    Group identifier. DAX converts this name to lowercase

    configurationEndpoint String

    The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number

    description String

    Description for the cluster

    iamRoleArn String

    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 String

    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 String

    The compute and memory capacity of the nodes. See Nodes for supported node types

    nodes List<ClusterNode>

    List of node objects including id, address, port and availability_zone. Referenceable e.g., as ${aws_dax_cluster.test.nodes.0.address}

    notificationTopicArn String

    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 String

    Name of the parameter group to associate with this DAX cluster

    port Integer

    The port used by the configuration endpoint

    replicationFactor Integer

    The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas

    securityGroupIds List<String>

    One or more VPC security groups associated with the cluster

    serverSideEncryption ClusterServerSideEncryption

    Encrypt at rest options

    subnetGroupName String

    Name of the subnet group to be used for the cluster

    tags Map<String,String>

    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 Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn string

    The ARN of the DAX cluster

    availabilityZones string[]

    List of Availability Zones in which the nodes will be created

    clusterAddress string

    The DNS name of the DAX cluster without the port appended

    clusterEndpointEncryptionType string

    The type of encryption the cluster's endpoint should support. Valid values are: NONE and TLS. Default value is NONE.

    clusterName string

    Group identifier. DAX converts this name to lowercase

    configurationEndpoint string

    The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number

    description string

    Description for the cluster

    iamRoleArn string

    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 string

    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 string

    The compute and memory capacity of the nodes. See Nodes for supported node types

    nodes ClusterNode[]

    List of node objects including id, address, port and availability_zone. Referenceable e.g., as ${aws_dax_cluster.test.nodes.0.address}

    notificationTopicArn string

    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 string

    Name of the parameter group to associate with this DAX cluster

    port number

    The port used by the configuration endpoint

    replicationFactor number

    The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas

    securityGroupIds string[]

    One or more VPC security groups associated with the cluster

    serverSideEncryption ClusterServerSideEncryption

    Encrypt at rest options

    subnetGroupName string

    Name of the subnet group to be used for the cluster

    tags {[key: string]: string}

    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 {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn str

    The ARN of the DAX cluster

    availability_zones Sequence[str]

    List of Availability Zones in which the nodes will be created

    cluster_address str

    The DNS name of the DAX cluster without the port appended

    cluster_endpoint_encryption_type str

    The type of encryption the cluster's endpoint should support. Valid values are: NONE and TLS. Default value is NONE.

    cluster_name str

    Group identifier. DAX converts this name to lowercase

    configuration_endpoint str

    The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number

    description str

    Description for the cluster

    iam_role_arn str

    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

    maintenance_window str

    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

    node_type str

    The compute and memory capacity of the nodes. See Nodes for supported node types

    nodes Sequence[ClusterNodeArgs]

    List of node objects including id, address, port and availability_zone. Referenceable e.g., as ${aws_dax_cluster.test.nodes.0.address}

    notification_topic_arn str

    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

    parameter_group_name str

    Name of the parameter group to associate with this DAX cluster

    port int

    The port used by the configuration endpoint

    replication_factor int

    The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas

    security_group_ids Sequence[str]

    One or more VPC security groups associated with the cluster

    server_side_encryption ClusterServerSideEncryptionArgs

    Encrypt at rest options

    subnet_group_name str

    Name of the subnet group to be used for the cluster

    tags Mapping[str, str]

    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.

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    The ARN of the DAX cluster

    availabilityZones List<String>

    List of Availability Zones in which the nodes will be created

    clusterAddress String

    The DNS name of the DAX cluster without the port appended

    clusterEndpointEncryptionType String

    The type of encryption the cluster's endpoint should support. Valid values are: NONE and TLS. Default value is NONE.

    clusterName String

    Group identifier. DAX converts this name to lowercase

    configurationEndpoint String

    The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number

    description String

    Description for the cluster

    iamRoleArn String

    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 String

    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 String

    The compute and memory capacity of the nodes. See Nodes for supported node types

    nodes List<Property Map>

    List of node objects including id, address, port and availability_zone. Referenceable e.g., as ${aws_dax_cluster.test.nodes.0.address}

    notificationTopicArn String

    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 String

    Name of the parameter group to associate with this DAX cluster

    port Number

    The port used by the configuration endpoint

    replicationFactor Number

    The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas

    securityGroupIds List<String>

    One or more VPC security groups associated with the cluster

    serverSideEncryption Property Map

    Encrypt at rest options

    subnetGroupName String

    Name of the subnet group to be used for the cluster

    tags Map<String>

    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 Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Supporting Types

    ClusterNode, ClusterNodeArgs

    Address string
    AvailabilityZone string
    Id string
    Port int

    The port used by the configuration endpoint

    Address string
    AvailabilityZone string
    Id string
    Port int

    The port used by the configuration endpoint

    address String
    availabilityZone String
    id String
    port Integer

    The port used by the configuration endpoint

    address string
    availabilityZone string
    id string
    port number

    The port used by the configuration endpoint

    address str
    availability_zone str
    id str
    port int

    The port used by the configuration endpoint

    address String
    availabilityZone String
    id String
    port Number

    The port used by the configuration endpoint

    ClusterServerSideEncryption, ClusterServerSideEncryptionArgs

    Enabled bool

    Whether to enable encryption at rest. Defaults to false.

    Enabled bool

    Whether to enable encryption at rest. Defaults to false.

    enabled Boolean

    Whether to enable encryption at rest. Defaults to false.

    enabled boolean

    Whether to enable encryption at rest. Defaults to false.

    enabled bool

    Whether to enable encryption at rest. Defaults to false.

    enabled Boolean

    Whether to enable encryption at rest. Defaults to false.

    Import

    Using pulumi import, import DAX Clusters using the cluster_name. For example:

     $ pulumi import aws:dax/cluster:Cluster my_cluster my_cluster

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi
    pulumi/pulumi-aws