Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. appsync
  6. getApiCache

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

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

aws-native.appsync.getApiCache

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.85.0
published on Monday, Nov 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::AppSync::ApiCache

    Using getApiCache

    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 getApiCache(args: GetApiCacheArgs, opts?: InvokeOptions): Promise<GetApiCacheResult>
function getApiCacheOutput(args: GetApiCacheOutputArgs, opts?: InvokeOutputOptions): Output<GetApiCacheResult>
    def get_api_cache(id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetApiCacheResult
def get_api_cache_output(id: pulumi.Input[Optional[str]] = None,
                  opts: Optional[InvokeOutputOptions] = None) -> Output[GetApiCacheResult]
    func LookupApiCache(ctx *Context, args *LookupApiCacheArgs, opts ...InvokeOption) (*LookupApiCacheResult, error)
func LookupApiCacheOutput(ctx *Context, args *LookupApiCacheOutputArgs, opts ...InvokeOption) LookupApiCacheResultOutput

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

    public static class GetApiCache 
{
    public static Task<GetApiCacheResult> InvokeAsync(GetApiCacheArgs args, InvokeOptions? opts = null)
    public static Output<GetApiCacheResult> Invoke(GetApiCacheInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetApiCacheResult> Invoke(GetApiCacheInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetApiCacheResult> getApiCache(GetApiCacheArgs args, InvokeOptions options)
public static Output<GetApiCacheResult> getApiCache(GetApiCacheArgs args, InvokeOptions options)
public static Output<GetApiCacheResult> getApiCache(GetApiCacheArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:appsync:getApiCache
  arguments:
    # arguments dictionary
    data "aws-native_appsync_get_api_cache" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    The CloudFormation primary identifier for an ApiCache. Mirrors ApiId once the resource exists; populated by the handler. Customers should reference the ApiCache by ApiId.
    Id string
    The CloudFormation primary identifier for an ApiCache. Mirrors ApiId once the resource exists; populated by the handler. Customers should reference the ApiCache by ApiId.
    id string
    The CloudFormation primary identifier for an ApiCache. Mirrors ApiId once the resource exists; populated by the handler. Customers should reference the ApiCache by ApiId.
    id String
    The CloudFormation primary identifier for an ApiCache. Mirrors ApiId once the resource exists; populated by the handler. Customers should reference the ApiCache by ApiId.
    id string
    The CloudFormation primary identifier for an ApiCache. Mirrors ApiId once the resource exists; populated by the handler. Customers should reference the ApiCache by ApiId.
    id str
    The CloudFormation primary identifier for an ApiCache. Mirrors ApiId once the resource exists; populated by the handler. Customers should reference the ApiCache by ApiId.
    id String
    The CloudFormation primary identifier for an ApiCache. Mirrors ApiId once the resource exists; populated by the handler. Customers should reference the ApiCache by ApiId.

    getApiCache Result

    The following output properties are available:

    ApiCachingBehavior string
    Caching behavior, such as FULL_REQUEST_CACHING, PER_RESOLVER_CACHING, or OPERATION_LEVEL_CACHING
    HealthMetricsConfig string
    Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include NetworkBandwidthOutAllowanceExceeded and EngineCPUUtilization
    Id string
    The CloudFormation primary identifier for an ApiCache. Mirrors ApiId once the resource exists; populated by the handler. Customers should reference the ApiCache by ApiId.
    Ttl int
    TTL in seconds for cache entries. Valid values are 1-3600.
    Type string
    The cache instance type, such as SMALL, LARGE and LARGE_4X
    ApiCachingBehavior string
    Caching behavior, such as FULL_REQUEST_CACHING, PER_RESOLVER_CACHING, or OPERATION_LEVEL_CACHING
    HealthMetricsConfig string
    Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include NetworkBandwidthOutAllowanceExceeded and EngineCPUUtilization
    Id string
    The CloudFormation primary identifier for an ApiCache. Mirrors ApiId once the resource exists; populated by the handler. Customers should reference the ApiCache by ApiId.
    Ttl int
    TTL in seconds for cache entries. Valid values are 1-3600.
    Type string
    The cache instance type, such as SMALL, LARGE and LARGE_4X
    api_caching_behavior string
    Caching behavior, such as FULL_REQUEST_CACHING, PER_RESOLVER_CACHING, or OPERATION_LEVEL_CACHING
    health_metrics_config string
    Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include NetworkBandwidthOutAllowanceExceeded and EngineCPUUtilization
    id string
    The CloudFormation primary identifier for an ApiCache. Mirrors ApiId once the resource exists; populated by the handler. Customers should reference the ApiCache by ApiId.
    ttl number
    TTL in seconds for cache entries. Valid values are 1-3600.
    type string
    The cache instance type, such as SMALL, LARGE and LARGE_4X
    apiCachingBehavior String
    Caching behavior, such as FULL_REQUEST_CACHING, PER_RESOLVER_CACHING, or OPERATION_LEVEL_CACHING
    healthMetricsConfig String
    Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include NetworkBandwidthOutAllowanceExceeded and EngineCPUUtilization
    id String
    The CloudFormation primary identifier for an ApiCache. Mirrors ApiId once the resource exists; populated by the handler. Customers should reference the ApiCache by ApiId.
    ttl Integer
    TTL in seconds for cache entries. Valid values are 1-3600.
    type String
    The cache instance type, such as SMALL, LARGE and LARGE_4X
    apiCachingBehavior string
    Caching behavior, such as FULL_REQUEST_CACHING, PER_RESOLVER_CACHING, or OPERATION_LEVEL_CACHING
    healthMetricsConfig string
    Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include NetworkBandwidthOutAllowanceExceeded and EngineCPUUtilization
    id string
    The CloudFormation primary identifier for an ApiCache. Mirrors ApiId once the resource exists; populated by the handler. Customers should reference the ApiCache by ApiId.
    ttl number
    TTL in seconds for cache entries. Valid values are 1-3600.
    type string
    The cache instance type, such as SMALL, LARGE and LARGE_4X
    api_caching_behavior str
    Caching behavior, such as FULL_REQUEST_CACHING, PER_RESOLVER_CACHING, or OPERATION_LEVEL_CACHING
    health_metrics_config str
    Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include NetworkBandwidthOutAllowanceExceeded and EngineCPUUtilization
    id str
    The CloudFormation primary identifier for an ApiCache. Mirrors ApiId once the resource exists; populated by the handler. Customers should reference the ApiCache by ApiId.
    ttl int
    TTL in seconds for cache entries. Valid values are 1-3600.
    type str
    The cache instance type, such as SMALL, LARGE and LARGE_4X
    apiCachingBehavior String
    Caching behavior, such as FULL_REQUEST_CACHING, PER_RESOLVER_CACHING, or OPERATION_LEVEL_CACHING
    healthMetricsConfig String
    Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include NetworkBandwidthOutAllowanceExceeded and EngineCPUUtilization
    id String
    The CloudFormation primary identifier for an ApiCache. Mirrors ApiId once the resource exists; populated by the handler. Customers should reference the ApiCache by ApiId.
    ttl Number
    TTL in seconds for cache entries. Valid values are 1-3600.
    type String
    The cache instance type, such as SMALL, LARGE and LARGE_4X

    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.85.0
    published on Monday, Nov 2, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial