AWS::AppSync::ApiCache

AppSync ApiCache

Resource Type definition for AWS::AppSync::ApiCache

Properties

7 configurable properties. 4 required. Click a row to see details.

Filter:
PropertyTypeFlags
ApiCachingBehavior
string
Required
ApiId
string
RequiredCreate-only
Ttl
integer
Required
Type
string
Required
AtRestEncryptionEnabled
boolean
Create-only
HealthMetricsConfig
string
TransitEncryptionEnabled
boolean
Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
IdstringThe CloudFormation primary identifier for an ApiCache. Mirrors ApiId once the resource exists; populated by the handler. Customers should reference the ApiCache by ApiId.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::AppSync::ApiCache

Resources:
  MyResource:
    Type: AWS::AppSync::ApiCache
    Properties:
      Type: "value"
      ApiId: "my-apiid"
      ApiCachingBehavior: "value"
      Ttl: 1

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

appsync:CreateApiCacheappsync:GetApiCache

read

appsync:GetApiCache

update

appsync:UpdateApiCacheappsync:GetApiCache

delete

appsync:DeleteApiCache

list

appsync:GetApiCache

Get the AppSync Cheat Sheet

Everything you need to know about AppSync on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceAppSync
Properties8
Required4
TaggingNot supported
Primary IDId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ApiIdAtRestEncryptionEnabledTransitEncryptionEnabled

Related Resources

External Links