We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
Resource Type definition for AWS::DAX::Cluster
Create Cluster Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);@overload
def Cluster(resource_name: str,
args: ClusterArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Cluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
iam_role_arn: Optional[str] = None,
replication_factor: Optional[int] = None,
node_type: Optional[str] = None,
description: Optional[str] = None,
availability_zones: Optional[Sequence[str]] = None,
network_type: Optional[str] = None,
cluster_name: Optional[str] = None,
notification_topic_arn: Optional[str] = None,
parameter_group_name: Optional[str] = None,
preferred_maintenance_window: Optional[str] = None,
cluster_endpoint_encryption_type: Optional[str] = None,
security_group_ids: Optional[Sequence[str]] = None,
sse_specification: Optional[ClusterSseSpecificationArgs] = None,
subnet_group_name: Optional[str] = None,
tags: Optional[Any] = 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-native:dax:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_dax_cluster" "name" {
# resource properties
}Parameters
- 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Cluster resource accepts the following input properties:
- Iam
Role stringArn - 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 string - The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
- 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. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set
ReplicationFactorto a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas).If the AvailabilityZonesparameter is provided, its length must equal theReplicationFactor.AWS recommends that you have at least two read replicas per cluster.
- Availability
Zones List<string> - 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
ReplicationFactorparameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability. - Cluster
Endpoint stringEncryption Type 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.- Cluster
Name string - The name of the DAX cluster.
- Description string
- The description of the cluster.
- Network
Type string - The IP address type of the cluster. Values are:
ipv4- IPv4 addresses onlyipv6- IPv6 addresses onlydual_stack- Both IPv4 and IPv6 addresses
- Notification
Topic stringArn 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.
- Parameter
Group stringName - The parameter group to be associated with the DAX cluster.
- Preferred
Maintenance stringWindow - 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. - Security
Group List<string>Ids 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.
- Sse
Specification Pulumi.Aws Native. Dax. Inputs. Cluster Sse Specification - Represents the settings used to enable server-side encryption on the cluster.
- Subnet
Group stringName 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.
- object
A set of tags to associate with the DAX cluster.
Search the CloudFormation User Guide for
AWS::DAX::Clusterfor more information about the expected schema for this property.
- Iam
Role stringArn - 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 string - The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
- 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. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set
ReplicationFactorto a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas).If the AvailabilityZonesparameter is provided, its length must equal theReplicationFactor.AWS recommends that you have at least two read replicas per cluster.
- Availability
Zones []string - 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
ReplicationFactorparameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability. - Cluster
Endpoint stringEncryption Type 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.- Cluster
Name string - The name of the DAX cluster.
- Description string
- The description of the cluster.
- Network
Type string - The IP address type of the cluster. Values are:
ipv4- IPv4 addresses onlyipv6- IPv6 addresses onlydual_stack- Both IPv4 and IPv6 addresses
- Notification
Topic stringArn 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.
- Parameter
Group stringName - The parameter group to be associated with the DAX cluster.
- Preferred
Maintenance stringWindow - 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. - Security
Group []stringIds 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.
- Sse
Specification ClusterSse Specification Args - Represents the settings used to enable server-side encryption on the cluster.
- Subnet
Group stringName 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.
- interface{}
A set of tags to associate with the DAX cluster.
Search the CloudFormation User Guide for
AWS::DAX::Clusterfor more information about the expected schema for this property.
- iam_
role_ stringarn - 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 string - The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
- replication_
factor number 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
ReplicationFactorto a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas).If the AvailabilityZonesparameter is provided, its length must equal theReplicationFactor.AWS recommends that you have at least two read replicas per cluster.
- availability_
zones list(string) - 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
ReplicationFactorparameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability. - cluster_
endpoint_ stringencryption_ type 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.- cluster_
name string - The name of the DAX cluster.
- description string
- The description of the cluster.
- network_
type string - The IP address type of the cluster. Values are:
ipv4- IPv4 addresses onlyipv6- IPv6 addresses onlydual_stack- Both IPv4 and IPv6 addresses
- notification_
topic_ stringarn 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.
- parameter_
group_ stringname - The parameter group to be associated with the DAX cluster.
- preferred_
maintenance_ stringwindow - 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. - security_
group_ list(string)ids 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.
- sse_
specification object - Represents the settings used to enable server-side encryption on the cluster.
- subnet_
group_ stringname 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.
- any
A set of tags to associate with the DAX cluster.
Search the CloudFormation User Guide for
AWS::DAX::Clusterfor more information about the expected schema for this property.
- iam
Role StringArn - 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 String - The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
- replication
Factor Integer 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
ReplicationFactorto a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas).If the AvailabilityZonesparameter is provided, its length must equal theReplicationFactor.AWS recommends that you have at least two read replicas per cluster.
- availability
Zones List<String> - 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
ReplicationFactorparameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability. - cluster
Endpoint StringEncryption Type 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.- cluster
Name String - The name of the DAX cluster.
- description String
- The description of the cluster.
- network
Type String - The IP address type of the cluster. Values are:
ipv4- IPv4 addresses onlyipv6- IPv6 addresses onlydual_stack- Both IPv4 and IPv6 addresses
- notification
Topic StringArn 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.
- parameter
Group StringName - The parameter group to be associated with the DAX cluster.
- preferred
Maintenance StringWindow - 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. - security
Group List<String>Ids 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.
- sse
Specification ClusterSse Specification - Represents the settings used to enable server-side encryption on the cluster.
- subnet
Group StringName 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.
- Object
A set of tags to associate with the DAX cluster.
Search the CloudFormation User Guide for
AWS::DAX::Clusterfor more information about the expected schema for this property.
- iam
Role stringArn - 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 string - The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
- replication
Factor number 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
ReplicationFactorto a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas).If the AvailabilityZonesparameter is provided, its length must equal theReplicationFactor.AWS recommends that you have at least two read replicas per cluster.
- availability
Zones string[] - 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
ReplicationFactorparameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability. - cluster
Endpoint stringEncryption Type 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.- cluster
Name string - The name of the DAX cluster.
- description string
- The description of the cluster.
- network
Type string - The IP address type of the cluster. Values are:
ipv4- IPv4 addresses onlyipv6- IPv6 addresses onlydual_stack- Both IPv4 and IPv6 addresses
- notification
Topic stringArn 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.
- parameter
Group stringName - The parameter group to be associated with the DAX cluster.
- preferred
Maintenance stringWindow - 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. - security
Group string[]Ids 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.
- sse
Specification ClusterSse Specification - Represents the settings used to enable server-side encryption on the cluster.
- subnet
Group stringName 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.
- any
A set of tags to associate with the DAX cluster.
Search the CloudFormation User Guide for
AWS::DAX::Clusterfor more information about the expected schema for this property.
- iam_
role_ strarn - 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 node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
- 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. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set
ReplicationFactorto a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas).If the AvailabilityZonesparameter is provided, its length must equal theReplicationFactor.AWS recommends that you have at least two read replicas per cluster.
- availability_
zones Sequence[str] - 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
ReplicationFactorparameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability. - cluster_
endpoint_ strencryption_ type 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.- cluster_
name str - The name of the DAX cluster.
- description str
- The description of the cluster.
- network_
type str - The IP address type of the cluster. Values are:
ipv4- IPv4 addresses onlyipv6- IPv6 addresses onlydual_stack- Both IPv4 and IPv6 addresses
- notification_
topic_ strarn 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.
- parameter_
group_ strname - The parameter group to be associated with the DAX cluster.
- preferred_
maintenance_ strwindow - 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. - security_
group_ Sequence[str]ids 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.
- sse_
specification ClusterSse Specification Args - Represents the settings used to enable server-side encryption on the cluster.
- subnet_
group_ strname 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.
- Any
A set of tags to associate with the DAX cluster.
Search the CloudFormation User Guide for
AWS::DAX::Clusterfor more information about the expected schema for this property.
- iam
Role StringArn - 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 String - The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
- replication
Factor Number 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
ReplicationFactorto a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas).If the AvailabilityZonesparameter is provided, its length must equal theReplicationFactor.AWS recommends that you have at least two read replicas per cluster.
- availability
Zones List<String> - 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
ReplicationFactorparameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability. - cluster
Endpoint StringEncryption Type 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.- cluster
Name String - The name of the DAX cluster.
- description String
- The description of the cluster.
- network
Type String - The IP address type of the cluster. Values are:
ipv4- IPv4 addresses onlyipv6- IPv6 addresses onlydual_stack- Both IPv4 and IPv6 addresses
- notification
Topic StringArn 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.
- parameter
Group StringName - The parameter group to be associated with the DAX cluster.
- preferred
Maintenance StringWindow - 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. - security
Group List<String>Ids 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.
- sse
Specification Property Map - Represents the settings used to enable server-side encryption on the cluster.
- subnet
Group StringName 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.
- Any
A set of tags to associate with the DAX cluster.
Search the CloudFormation User Guide for
AWS::DAX::Clusterfor more information about the expected schema for this property.
Outputs
All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:
- Arn string
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- Cluster
Discovery stringEndpoint 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- Cluster
Discovery stringEndpoint Url - Returns the endpoint URL of the DAX cluster.
- Id string
- The provider-assigned unique ID for this managed resource.
- Arn string
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- Cluster
Discovery stringEndpoint 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- Cluster
Discovery stringEndpoint Url - Returns the endpoint URL of the DAX cluster.
- Id string
- The provider-assigned unique ID for this managed resource.
- arn string
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- cluster_
discovery_ stringendpoint 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- cluster_
discovery_ stringendpoint_ url - Returns the endpoint URL of the DAX cluster.
- id string
- The provider-assigned unique ID for this managed resource.
- arn String
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- cluster
Discovery StringEndpoint 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- cluster
Discovery StringEndpoint Url - Returns the endpoint URL of the DAX cluster.
- id String
- The provider-assigned unique ID for this managed resource.
- arn string
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- cluster
Discovery stringEndpoint 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- cluster
Discovery stringEndpoint Url - Returns the endpoint URL of the DAX cluster.
- id string
- The provider-assigned unique ID for this managed resource.
- arn str
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- cluster_
discovery_ strendpoint 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- cluster_
discovery_ strendpoint_ url - Returns the endpoint URL of the DAX cluster.
- id str
- The provider-assigned unique ID for this managed resource.
- arn String
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- cluster
Discovery StringEndpoint 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- cluster
Discovery StringEndpoint Url - Returns the endpoint URL of the DAX cluster.
- id String
- The provider-assigned unique ID for this managed resource.
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>, opts?: CustomResourceOptions): Cluster@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> Clusterfunc GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)public static Cluster Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static Cluster get(String name, Output<String> id, CustomResourceOptions options)resources: existingCluster: type: aws-native:dax:Cluster get: id: ${id}import {
to = aws-native_dax_cluster.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state ClusterState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
ClusterSseSpecification, ClusterSseSpecificationArgs
- Sse
Enabled bool - Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.
- Sse
Enabled bool - Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.
- sse_
enabled bool - Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.
- sse
Enabled Boolean - Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.
- sse
Enabled boolean - Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.
- sse_
enabled bool - Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.
- sse
Enabled Boolean - Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi