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
Using getCluster
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOutputOptions): Output<GetClusterResult>def get_cluster(cluster_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_name: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetClusterResult]func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput> Note: This function is named LookupCluster in the Go SDK.
public static class GetCluster
{
public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOutputOptions options)
fn::invoke:
function: aws-native:dax:getCluster
arguments:
# arguments dictionarydata "aws-native_dax_get_cluster" "name" {
# arguments
}The following arguments are supported:
- Cluster
Name string - The name of the DAX cluster.
- Cluster
Name string - The name of the DAX cluster.
- cluster_
name string - The name of the DAX cluster.
- cluster
Name String - The name of the DAX cluster.
- cluster
Name string - The name of the DAX cluster.
- cluster_
name str - The name of the DAX cluster.
- cluster
Name String - The name of the DAX cluster.
getCluster Result
The following output properties are available:
- 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- 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
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.
- Description string
- The description of the cluster.
- 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. - 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.
- 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.
- 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.
- 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- 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
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.
- Description string
- The description of the cluster.
- 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. - 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.
- 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.
- 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.
- 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- 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_
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.
- description string
- The description of the cluster.
- 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. - 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.
- 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.
- 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.
- 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- 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
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.
- description String
- The description of the cluster.
- 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. - 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.
- 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.
- 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.
- 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- 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
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.
- description string
- The description of the cluster.
- 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. - 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.
- 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.
- 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.
- 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- 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_
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.
- description str
- The description of the cluster.
- 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. - 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.
- 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.
- 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.
- 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- 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
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.
- description String
- The description of the cluster.
- 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. - 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.
- 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.
- 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.
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