AWS CDK Reference

Appearance

v2.274.0

RdsHttpEndpointConfigProperty Struct ​

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

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

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
const rdsHttpEndpointConfigProperty: appsync.CfnDataSource.RdsHttpEndpointConfigProperty = {
  awsRegion: 'awsRegion',
  awsSecretStoreArn: 'awsSecretStoreArn',
  dbClusterIdentifier: 'dbClusterIdentifier',

  // the properties below are optional
  databaseName: 'databaseName',
  schema: 'schema',
};

Properties ​

awsRegionstringaws_regionstrawsRegionStringAwsRegionstringAwsRegion*stringrequired#
AWS Region for RDS HTTP endpoint.
awsSecretStoreArnstringaws_secret_store_arnstrawsSecretStoreArnStringAwsSecretStoreArnstringAwsSecretStoreArn*stringrequired#
The ARN for database credentials stored in AWS Secrets Manager .
databaseNameoptionalstringdatabase_nameoptionalstrdatabaseNameoptionalStringDatabaseNameoptionalstringDatabaseNameoptional*string#
Logical database name.
dbClusterIdentifierstringdb_cluster_identifierstrdbClusterIdentifierStringDbClusterIdentifierstringDbClusterIdentifier*stringrequired#
Amazon RDS cluster Amazon Resource Name (ARN).
schemaoptionalstringschemaoptionalstrschemaoptionalStringSchemaoptionalstringSchemaoptional*string#
Logical schema name.