AWS::AppSync::DataSource RdsHttpEndpointConfig - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::AppSync::DataSource RdsHttpEndpointConfig

Use the RdsHttpEndpointConfig property type to specify the RdsHttpEndpoint for an Amazon AppSync relational database.

RdsHttpEndpointConfig is a property of the Amazon AppSync DataSource RelationalDatabaseConfig resource.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "AwsRegion" : String,
  "AwsSecretStoreArn" : String,
  "DatabaseName" : String,
  "DbClusterIdentifier" : String,
  "Schema" : String
}

YAML

  AwsRegion: String
  AwsSecretStoreArn: String
  DatabaseName: String
  DbClusterIdentifier: String
  Schema: String

Properties

AwsRegion

Amazon Region for RDS HTTP endpoint.

Required: Yes

Type: String

Update requires: No interruption

AwsSecretStoreArn

The ARN for database credentials stored in Amazon Secrets Manager.

Required: Yes

Type: String

Update requires: No interruption

DatabaseName

Logical database name.

Required: No

Type: String

Update requires: No interruption

DbClusterIdentifier

Amazon RDS cluster Amazon Resource Name (ARN).

Required: Yes

Type: String

Update requires: No interruption

Schema

Logical schema name.

Required: No

Type: String

Update requires: No interruption