Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. elasticache
  6. getCacheCluster

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

Viewing docs for AWS Cloud Control v1.68.0
published on Monday, Jun 1, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.elasticache.getCacheCluster

aws-native logo

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

Viewing docs for AWS Cloud Control v1.68.0
published on Monday, Jun 1, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource type definition for AWS::ElastiCache::CacheCluster

    Using getCacheCluster

    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 getCacheCluster(args: GetCacheClusterArgs, opts?: InvokeOptions): Promise<GetCacheClusterResult>
function getCacheClusterOutput(args: GetCacheClusterOutputArgs, opts?: InvokeOptions): Output<GetCacheClusterResult>
    def get_cache_cluster(cluster_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetCacheClusterResult
def get_cache_cluster_output(cluster_name: pulumi.Input[Optional[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetCacheClusterResult]
    func LookupCacheCluster(ctx *Context, args *LookupCacheClusterArgs, opts ...InvokeOption) (*LookupCacheClusterResult, error)
func LookupCacheClusterOutput(ctx *Context, args *LookupCacheClusterOutputArgs, opts ...InvokeOption) LookupCacheClusterResultOutput

    > Note: This function is named LookupCacheCluster in the Go SDK.

    public static class GetCacheCluster 
{
    public static Task<GetCacheClusterResult> InvokeAsync(GetCacheClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetCacheClusterResult> Invoke(GetCacheClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCacheClusterResult> getCacheCluster(GetCacheClusterArgs args, InvokeOptions options)
public static Output<GetCacheClusterResult> getCacheCluster(GetCacheClusterArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:elasticache:getCacheCluster
  arguments:
    # arguments dictionary
    data "aws-native_elasticache_getcachecluster" "name" {
    # arguments
}

    The following arguments are supported:

    ClusterName string
    A name for the cache cluster.
    ClusterName string
    A name for the cache cluster.
    cluster_name string
    A name for the cache cluster.
    clusterName String
    A name for the cache cluster.
    clusterName string
    A name for the cache cluster.
    cluster_name str
    A name for the cache cluster.
    clusterName String
    A name for the cache cluster.

    getCacheCluster Result

    The following output properties are available:

    AutoMinorVersionUpgrade bool
    If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign.
    AzMode string
    Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
    CacheNodeType string
    The compute and memory capacity of the nodes in the node group (shard).
    CacheParameterGroupName string
    The name of the parameter group to associate with this cluster.
    ConfigurationEndpoint Pulumi.AwsNative.ElastiCache.Outputs.CacheClusterEndpoint
    Specifies the ConfigurationEndpoint address and port
    EngineVersion string
    The version number of the cache engine to be used for this cluster
    IpDiscovery string
    The Ip Discovery parameter for cachecluster.
    LogDeliveryConfigurations List<Pulumi.AwsNative.ElastiCache.Outputs.CacheClusterLogDeliveryConfigurationRequest>
    Specifies the destination, format and type of the logs
    NotificationTopicArn string
    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
    NumCacheNodes int
    The number of cache nodes that the cache cluster should have.
    PreferredAvailabilityZones List<string>
    A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.
    PreferredMaintenanceWindow string
    Specifies the weekly time range during which maintenance on the cluster is performed.
    RedisEndpoint Pulumi.AwsNative.ElastiCache.Outputs.CacheClusterEndpoint
    Specifies the RedisEndPoint address and port
    SnapshotRetentionLimit int
    The number of days for which ElastiCache retains automatic snapshots before deleting them.
    SnapshotWindow string
    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A list of tags to be added to this resource.
    TransitEncryptionEnabled bool
    A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created
    VpcSecurityGroupIds List<string>
    One or more VPC security groups associated with the cluster.
    AutoMinorVersionUpgrade bool
    If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign.
    AzMode string
    Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
    CacheNodeType string
    The compute and memory capacity of the nodes in the node group (shard).
    CacheParameterGroupName string
    The name of the parameter group to associate with this cluster.
    ConfigurationEndpoint CacheClusterEndpoint
    Specifies the ConfigurationEndpoint address and port
    EngineVersion string
    The version number of the cache engine to be used for this cluster
    IpDiscovery string
    The Ip Discovery parameter for cachecluster.
    LogDeliveryConfigurations []CacheClusterLogDeliveryConfigurationRequest
    Specifies the destination, format and type of the logs
    NotificationTopicArn string
    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
    NumCacheNodes int
    The number of cache nodes that the cache cluster should have.
    PreferredAvailabilityZones []string
    A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.
    PreferredMaintenanceWindow string
    Specifies the weekly time range during which maintenance on the cluster is performed.
    RedisEndpoint CacheClusterEndpoint
    Specifies the RedisEndPoint address and port
    SnapshotRetentionLimit int
    The number of days for which ElastiCache retains automatic snapshots before deleting them.
    SnapshotWindow string
    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
    Tags Tag
    A list of tags to be added to this resource.
    TransitEncryptionEnabled bool
    A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created
    VpcSecurityGroupIds []string
    One or more VPC security groups associated with the cluster.
    auto_minor_version_upgrade bool
    If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign.
    az_mode string
    Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
    cache_node_type string
    The compute and memory capacity of the nodes in the node group (shard).
    cache_parameter_group_name string
    The name of the parameter group to associate with this cluster.
    configuration_endpoint object
    Specifies the ConfigurationEndpoint address and port
    engine_version string
    The version number of the cache engine to be used for this cluster
    ip_discovery string
    The Ip Discovery parameter for cachecluster.
    log_delivery_configurations list(object)
    Specifies the destination, format and type of the logs
    notification_topic_arn string
    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
    num_cache_nodes number
    The number of cache nodes that the cache cluster should have.
    preferred_availability_zones list(string)
    A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.
    preferred_maintenance_window string
    Specifies the weekly time range during which maintenance on the cluster is performed.
    redis_endpoint object
    Specifies the RedisEndPoint address and port
    snapshot_retention_limit number
    The number of days for which ElastiCache retains automatic snapshots before deleting them.
    snapshot_window string
    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
    tags list(object)
    A list of tags to be added to this resource.
    transit_encryption_enabled bool
    A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created
    vpc_security_group_ids list(string)
    One or more VPC security groups associated with the cluster.
    autoMinorVersionUpgrade Boolean
    If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign.
    azMode String
    Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
    cacheNodeType String
    The compute and memory capacity of the nodes in the node group (shard).
    cacheParameterGroupName String
    The name of the parameter group to associate with this cluster.
    configurationEndpoint CacheClusterEndpoint
    Specifies the ConfigurationEndpoint address and port
    engineVersion String
    The version number of the cache engine to be used for this cluster
    ipDiscovery String
    The Ip Discovery parameter for cachecluster.
    logDeliveryConfigurations List<CacheClusterLogDeliveryConfigurationRequest>
    Specifies the destination, format and type of the logs
    notificationTopicArn String
    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
    numCacheNodes Integer
    The number of cache nodes that the cache cluster should have.
    preferredAvailabilityZones List<String>
    A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.
    preferredMaintenanceWindow String
    Specifies the weekly time range during which maintenance on the cluster is performed.
    redisEndpoint CacheClusterEndpoint
    Specifies the RedisEndPoint address and port
    snapshotRetentionLimit Integer
    The number of days for which ElastiCache retains automatic snapshots before deleting them.
    snapshotWindow String
    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
    tags List<Tag>
    A list of tags to be added to this resource.
    transitEncryptionEnabled Boolean
    A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created
    vpcSecurityGroupIds List<String>
    One or more VPC security groups associated with the cluster.
    autoMinorVersionUpgrade boolean
    If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign.
    azMode string
    Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
    cacheNodeType string
    The compute and memory capacity of the nodes in the node group (shard).
    cacheParameterGroupName string
    The name of the parameter group to associate with this cluster.
    configurationEndpoint CacheClusterEndpoint
    Specifies the ConfigurationEndpoint address and port
    engineVersion string
    The version number of the cache engine to be used for this cluster
    ipDiscovery string
    The Ip Discovery parameter for cachecluster.
    logDeliveryConfigurations CacheClusterLogDeliveryConfigurationRequest[]
    Specifies the destination, format and type of the logs
    notificationTopicArn string
    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
    numCacheNodes number
    The number of cache nodes that the cache cluster should have.
    preferredAvailabilityZones string[]
    A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.
    preferredMaintenanceWindow string
    Specifies the weekly time range during which maintenance on the cluster is performed.
    redisEndpoint CacheClusterEndpoint
    Specifies the RedisEndPoint address and port
    snapshotRetentionLimit number
    The number of days for which ElastiCache retains automatic snapshots before deleting them.
    snapshotWindow string
    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
    tags Tag[]
    A list of tags to be added to this resource.
    transitEncryptionEnabled boolean
    A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created
    vpcSecurityGroupIds string[]
    One or more VPC security groups associated with the cluster.
    auto_minor_version_upgrade bool
    If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign.
    az_mode str
    Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
    cache_node_type str
    The compute and memory capacity of the nodes in the node group (shard).
    cache_parameter_group_name str
    The name of the parameter group to associate with this cluster.
    configuration_endpoint CacheClusterEndpoint
    Specifies the ConfigurationEndpoint address and port
    engine_version str
    The version number of the cache engine to be used for this cluster
    ip_discovery str
    The Ip Discovery parameter for cachecluster.
    log_delivery_configurations Sequence[CacheClusterLogDeliveryConfigurationRequest]
    Specifies the destination, format and type of the logs
    notification_topic_arn str
    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
    num_cache_nodes int
    The number of cache nodes that the cache cluster should have.
    preferred_availability_zones Sequence[str]
    A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.
    preferred_maintenance_window str
    Specifies the weekly time range during which maintenance on the cluster is performed.
    redis_endpoint CacheClusterEndpoint
    Specifies the RedisEndPoint address and port
    snapshot_retention_limit int
    The number of days for which ElastiCache retains automatic snapshots before deleting them.
    snapshot_window str
    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
    tags Sequence[root_Tag]
    A list of tags to be added to this resource.
    transit_encryption_enabled bool
    A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created
    vpc_security_group_ids Sequence[str]
    One or more VPC security groups associated with the cluster.
    autoMinorVersionUpgrade Boolean
    If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign.
    azMode String
    Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
    cacheNodeType String
    The compute and memory capacity of the nodes in the node group (shard).
    cacheParameterGroupName String
    The name of the parameter group to associate with this cluster.
    configurationEndpoint Property Map
    Specifies the ConfigurationEndpoint address and port
    engineVersion String
    The version number of the cache engine to be used for this cluster
    ipDiscovery String
    The Ip Discovery parameter for cachecluster.
    logDeliveryConfigurations List<Property Map>
    Specifies the destination, format and type of the logs
    notificationTopicArn String
    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
    numCacheNodes Number
    The number of cache nodes that the cache cluster should have.
    preferredAvailabilityZones List<String>
    A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.
    preferredMaintenanceWindow String
    Specifies the weekly time range during which maintenance on the cluster is performed.
    redisEndpoint Property Map
    Specifies the RedisEndPoint address and port
    snapshotRetentionLimit Number
    The number of days for which ElastiCache retains automatic snapshots before deleting them.
    snapshotWindow String
    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
    tags List<Property Map>
    A list of tags to be added to this resource.
    transitEncryptionEnabled Boolean
    A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created
    vpcSecurityGroupIds List<String>
    One or more VPC security groups associated with the cluster.

    Supporting Types

    CacheClusterCloudWatchLogsDestinationDetails

    LogGroup string
    The name of the CloudWatch Logs log group.
    LogGroup string
    The name of the CloudWatch Logs log group.
    log_group string
    The name of the CloudWatch Logs log group.
    logGroup String
    The name of the CloudWatch Logs log group.
    logGroup string
    The name of the CloudWatch Logs log group.
    log_group str
    The name of the CloudWatch Logs log group.
    logGroup String
    The name of the CloudWatch Logs log group.

    CacheClusterDestinationDetails

    CloudWatchLogsDetails CacheClusterCloudWatchLogsDestinationDetails
    The configuration details of the CloudWatch Logs destination
    KinesisFirehoseDetails CacheClusterKinesisFirehoseDestinationDetails
    The configuration details of the Kinesis Data Firehose destination.
    cloud_watch_logs_details object
    The configuration details of the CloudWatch Logs destination
    kinesis_firehose_details object
    The configuration details of the Kinesis Data Firehose destination.
    cloudWatchLogsDetails CacheClusterCloudWatchLogsDestinationDetails
    The configuration details of the CloudWatch Logs destination
    kinesisFirehoseDetails CacheClusterKinesisFirehoseDestinationDetails
    The configuration details of the Kinesis Data Firehose destination.
    cloudWatchLogsDetails CacheClusterCloudWatchLogsDestinationDetails
    The configuration details of the CloudWatch Logs destination
    kinesisFirehoseDetails CacheClusterKinesisFirehoseDestinationDetails
    The configuration details of the Kinesis Data Firehose destination.
    cloud_watch_logs_details CacheClusterCloudWatchLogsDestinationDetails
    The configuration details of the CloudWatch Logs destination
    kinesis_firehose_details CacheClusterKinesisFirehoseDestinationDetails
    The configuration details of the Kinesis Data Firehose destination.
    cloudWatchLogsDetails Property Map
    The configuration details of the CloudWatch Logs destination
    kinesisFirehoseDetails Property Map
    The configuration details of the Kinesis Data Firehose destination.

    CacheClusterEndpoint

    Address string
    Port string
    Address string
    Port string
    address string
    port string
    address String
    port String
    address string
    port string
    address str
    port str
    address String
    port String

    CacheClusterKinesisFirehoseDestinationDetails

    DeliveryStream string
    The name of the Kinesis Data Firehose delivery stream
    DeliveryStream string
    The name of the Kinesis Data Firehose delivery stream
    delivery_stream string
    The name of the Kinesis Data Firehose delivery stream
    deliveryStream String
    The name of the Kinesis Data Firehose delivery stream
    deliveryStream string
    The name of the Kinesis Data Firehose delivery stream
    delivery_stream str
    The name of the Kinesis Data Firehose delivery stream
    deliveryStream String
    The name of the Kinesis Data Firehose delivery stream

    CacheClusterLogDeliveryConfigurationRequest

    DestinationDetails Pulumi.AwsNative.ElastiCache.Inputs.CacheClusterDestinationDetails
    Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
    DestinationType string
    Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type.
    LogFormat string
    Valid values are either json or text
    LogType string
    Valid value is either slow-log, which refers to slow-log or engine-log
    DestinationDetails CacheClusterDestinationDetails
    Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
    DestinationType string
    Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type.
    LogFormat string
    Valid values are either json or text
    LogType string
    Valid value is either slow-log, which refers to slow-log or engine-log
    destination_details object
    Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
    destination_type string
    Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type.
    log_format string
    Valid values are either json or text
    log_type string
    Valid value is either slow-log, which refers to slow-log or engine-log
    destinationDetails CacheClusterDestinationDetails
    Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
    destinationType String
    Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type.
    logFormat String
    Valid values are either json or text
    logType String
    Valid value is either slow-log, which refers to slow-log or engine-log
    destinationDetails CacheClusterDestinationDetails
    Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
    destinationType string
    Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type.
    logFormat string
    Valid values are either json or text
    logType string
    Valid value is either slow-log, which refers to slow-log or engine-log
    destination_details CacheClusterDestinationDetails
    Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
    destination_type str
    Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type.
    log_format str
    Valid values are either json or text
    log_type str
    Valid value is either slow-log, which refers to slow-log or engine-log
    destinationDetails Property Map
    Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
    destinationType String
    Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type.
    logFormat String
    Valid values are either json or text
    logType String
    Valid value is either slow-log, which refers to slow-log or engine-log

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

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

    Viewing docs for AWS Cloud Control v1.68.0
    published on Monday, Jun 1, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial