1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. dax
  6. getCluster

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
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 dictionary
    data "aws-native_dax_get_cluster" "name" {
        # arguments
    }

    The following arguments are supported:

    ClusterName string
    The name of the DAX cluster.
    ClusterName string
    The name of the DAX cluster.
    cluster_name string
    The name of the DAX cluster.
    clusterName String
    The name of the DAX cluster.
    clusterName string
    The name of the DAX cluster.
    cluster_name str
    The name of the DAX cluster.
    clusterName 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

    AvailabilityZones 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 ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.
    ClusterDiscoveryEndpoint string

    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

    ClusterDiscoveryEndpointUrl string
    Returns the endpoint URL of the DAX cluster.
    Description string
    The description of the cluster.
    NotificationTopicArn string

    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.

    ParameterGroupName string
    The parameter group to be associated with the DAX cluster.
    PreferredMaintenanceWindow string
    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.
    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. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor .

    AWS recommends that you have at least two read replicas per cluster.

    SecurityGroupIds List<string>

    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.

    Tags object

    A set of tags to associate with the DAX cluster.

    Search the CloudFormation User Guide for AWS::DAX::Cluster for 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

    AvailabilityZones []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 ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.
    ClusterDiscoveryEndpoint string

    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

    ClusterDiscoveryEndpointUrl string
    Returns the endpoint URL of the DAX cluster.
    Description string
    The description of the cluster.
    NotificationTopicArn string

    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.

    ParameterGroupName string
    The parameter group to be associated with the DAX cluster.
    PreferredMaintenanceWindow string
    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.
    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. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor .

    AWS recommends that you have at least two read replicas per cluster.

    SecurityGroupIds []string

    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.

    Tags interface{}

    A set of tags to associate with the DAX cluster.

    Search the CloudFormation User Guide for AWS::DAX::Cluster for 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 ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.
    cluster_discovery_endpoint string

    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_endpoint_url string
    Returns the endpoint URL of the DAX cluster.
    description string
    The description of the cluster.
    notification_topic_arn string

    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_name string
    The parameter group to be associated with the DAX cluster.
    preferred_maintenance_window string
    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 ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor .

    AWS recommends that you have at least two read replicas per cluster.

    security_group_ids list(string)

    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.

    tags any

    A set of tags to associate with the DAX cluster.

    Search the CloudFormation User Guide for AWS::DAX::Cluster for 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

    availabilityZones 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 ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.
    clusterDiscoveryEndpoint String

    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

    clusterDiscoveryEndpointUrl String
    Returns the endpoint URL of the DAX cluster.
    description String
    The description of the cluster.
    notificationTopicArn String

    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.

    parameterGroupName String
    The parameter group to be associated with the DAX cluster.
    preferredMaintenanceWindow String
    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.
    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. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor .

    AWS recommends that you have at least two read replicas per cluster.

    securityGroupIds List<String>

    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.

    tags Object

    A set of tags to associate with the DAX cluster.

    Search the CloudFormation User Guide for AWS::DAX::Cluster for 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

    availabilityZones 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 ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.
    clusterDiscoveryEndpoint string

    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

    clusterDiscoveryEndpointUrl string
    Returns the endpoint URL of the DAX cluster.
    description string
    The description of the cluster.
    notificationTopicArn string

    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.

    parameterGroupName string
    The parameter group to be associated with the DAX cluster.
    preferredMaintenanceWindow string
    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.
    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. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor .

    AWS recommends that you have at least two read replicas per cluster.

    securityGroupIds string[]

    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.

    tags any

    A set of tags to associate with the DAX cluster.

    Search the CloudFormation User Guide for AWS::DAX::Cluster for 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 ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.
    cluster_discovery_endpoint str

    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_endpoint_url str
    Returns the endpoint URL of the DAX cluster.
    description str
    The description of the cluster.
    notification_topic_arn str

    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_name str
    The parameter group to be associated with the DAX cluster.
    preferred_maintenance_window str
    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 ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor .

    AWS recommends that you have at least two read replicas per cluster.

    security_group_ids Sequence[str]

    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.

    tags Any

    A set of tags to associate with the DAX cluster.

    Search the CloudFormation User Guide for AWS::DAX::Cluster for 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

    availabilityZones 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 ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.
    clusterDiscoveryEndpoint String

    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

    clusterDiscoveryEndpointUrl String
    Returns the endpoint URL of the DAX cluster.
    description String
    The description of the cluster.
    notificationTopicArn String

    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.

    parameterGroupName String
    The parameter group to be associated with the DAX cluster.
    preferredMaintenanceWindow String
    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.
    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. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor .

    AWS recommends that you have at least two read replicas per cluster.

    securityGroupIds List<String>

    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.

    tags Any

    A set of tags to associate with the DAX cluster.

    Search the CloudFormation User Guide for AWS::DAX::Cluster for more information about the expected schema for this property.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial