AWS::AppSync::DataSource

AppSync DataSource

Resource Type definition for AWS::AppSync::DataSource

Properties

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

Filter:

Property	Type	Flags
`ApiId`	`string`	RequiredCreate-only
`Name`	`string`	RequiredCreate-only
`Type`	`string`	Required
`Description`	`string`
`DynamoDBConfig`	`DynamoDBConfig`
`ElasticsearchConfig`	`ElasticsearchConfig`	Deprecated
`EventBridgeConfig`	`EventBridgeConfig`
`HttpConfig`	`HttpConfig`
`LambdaConfig`	`LambdaConfig`
`MetricsConfig`	`string`
`OpenSearchServiceConfig`	`OpenSearchServiceConfig`
`RelationalDatabaseConfig`	`RelationalDatabaseConfig`
`ServiceRoleArn`	`string`

Return Values

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

Attribute	Type	Description
`DataSourceArn`	`string`	The Amazon Resource Name (ARN) of the API key, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/datasources/datasourcename.

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

Resources:
  MyResource:
    Type: AWS::AppSync::DataSource
    Properties:
      Type: "value"
      ApiId: "my-apiid"
      Name: "my-name"
      Description: !Ref "AWS::StackName"

Required IAM Permissions

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

create

appsync:CreateDataSourceappsync:GetDataSourceiam:PassRole

read

appsync:GetDataSource

update

appsync:UpdateDataSourceiam:PassRole

delete

appsync:DeleteDataSourceappsync:GetDataSource

list

appsync:ListDataSources

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

Properties14

Required3

TaggingNot supported

Primary IDDataSourceArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

ApiIdName

Related Resources

External Links

AWS Documentation