aws-cdk-lib.aws_appsync.CfnDataSource.RdsHttpEndpointConfigProperty

interface RdsHttpEndpointConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.AppSync.CfnDataSource.RdsHttpEndpointConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappsync#CfnDataSource_RdsHttpEndpointConfigProperty
Javasoftware.amazon.awscdk.services.appsync.CfnDataSource.RdsHttpEndpointConfigProperty
Pythonaws_cdk.aws_appsync.CfnDataSource.RdsHttpEndpointConfigProperty
TypeScript aws-cdk-lib » aws_appsync » CfnDataSource » RdsHttpEndpointConfigProperty

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.

Example

// 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

NameTypeDescription
awsRegionstringAWS Region for RDS HTTP endpoint.
awsSecretStoreArnstringThe ARN for database credentials stored in AWS Secrets Manager .
dbClusterIdentifierstringAmazon RDS cluster Amazon Resource Name (ARN).
databaseName?stringLogical database name.
schema?stringLogical schema name.

awsRegion

Type: string

AWS Region for RDS HTTP endpoint.


awsSecretStoreArn

Type: string

The ARN for database credentials stored in AWS Secrets Manager .


dbClusterIdentifier

Type: string

Amazon RDS cluster Amazon Resource Name (ARN).


databaseName?

Type: string (optional)

Logical database name.


schema?

Type: string (optional)

Logical schema name.