AWS::AppSync::ApiKey

AppSync ApiKey

Resource Type definition for AWS::AppSync::ApiKey

Properties

3 configurable properties. 1 required. Click a row to see details.

Filter:

Property	Type	Flags
`ApiId`	`string`	RequiredCreate-only
`Description`	`string`
`Expires`	`number`

Return Values

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

Attribute	Type	Description
`ApiKey`	`string`	-
`ApiKeyId`	`string`	-
`Arn`	`string`	-

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::ApiKey

Resources:
  MyResource:
    Type: AWS::AppSync::ApiKey
    Properties:
      ApiId: "my-apiid"
      Description: !Ref "AWS::StackName"

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

Properties6

Required1

TaggingNot supported

Primary IDApiKeyId

Immutable After Creation

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

ApiId

Related Resources

External Links

AWS Documentation