Cluster

Provides a DAX Cluster resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var bar = new Aws.Dax.Cluster("bar", new Aws.Dax.ClusterArgs
        {
            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/v2/go/aws/dax"
    "github.com/pulumi/pulumi/sdk/v2/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.String(data.Aws_iam_role.Example.Arn),
            NodeType:          pulumi.String("dax.r4.large"),
            ReplicationFactor: pulumi.Int(1),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

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: aws_iam_role_example.arn,
    nodeType: "dax.r4.large",
    replicationFactor: 1,
});

Create a Cluster Resource

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);

def Cluster(resource_name, opts=None, availability_zones=None, cluster_name=None, description=None, iam_role_arn=None, maintenance_window=None, node_type=None, notification_topic_arn=None, parameter_group_name=None, replication_factor=None, security_group_ids=None, server_side_encryption=None, subnet_group_name=None, tags=None, __props__=None);

func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)

public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Cluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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
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 ClusterServerSideEncryptionArgs: 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

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
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 map[string]string: A map of tags to assign to the resource

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

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 float: 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 List[str]: List of Availability Zones in which the nodes will be created
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 List[str]: One or more VPC security groups associated with the cluster
server_side_encryption Dict[ClusterServerSideEncryption]: Encrypt at rest options
subnet_group_name str: Name of the subnet group to be used for the cluster
tags Dict[str, str]: A map of tags to assign to the resource

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

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

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

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 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 float: The port used by the configuration endpoint

Look up an 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

static get(resource_name, id, opts=None, arn=None, availability_zones=None, cluster_address=None, cluster_name=None, configuration_endpoint=None, description=None, iam_role_arn=None, maintenance_window=None, node_type=None, nodes=None, notification_topic_arn=None, parameter_group_name=None, port=None, replication_factor=None, security_group_ids=None, server_side_encryption=None, subnet_group_name=None, tags=None, __props__=None);

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)

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.

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
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<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 List<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 Dictionary<string, string>: A map of tags to assign to the resource

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

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

arn str: The ARN of the DAX cluster
availability_zones List[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_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 List[ClusterNode]: 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 float: The port used by the configuration endpoint
replication_factor float: 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 List[str]: One or more VPC security groups associated with the cluster
server_side_encryption Dict[ClusterServerSideEncryption]: Encrypt at rest options
subnet_group_name str: Name of the subnet group to be used for the cluster
tags Dict[str, str]: A map of tags to assign to the resource

Supporting Types

ClusterNode

See the output API doc for this type.

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 number: The port used by the configuration endpoint

address str
availability_zone str
id str
port float: The port used by the configuration endpoint

ClusterServerSideEncryption

See the input and output API doc for this type.

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 bool: Whether to enable encryption at rest. Defaults to false.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud