Skip to content
v2.277.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.

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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appsync as appsync

rds_http_endpoint_config_property = appsync.CfnDataSource.RdsHttpEndpointConfigProperty(
    aws_region="awsRegion",
    aws_secret_store_arn="awsSecretStoreArn",
    db_cluster_identifier="dbClusterIdentifier",

    # the properties below are optional
    database_name="databaseName",
    schema="schema"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.appsync.*;

RdsHttpEndpointConfigProperty rdsHttpEndpointConfigProperty = RdsHttpEndpointConfigProperty.builder()
        .awsRegion("awsRegion")
        .awsSecretStoreArn("awsSecretStoreArn")
        .dbClusterIdentifier("dbClusterIdentifier")

        // the properties below are optional
        .databaseName("databaseName")
        .schema("schema")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppSync;

var rdsHttpEndpointConfigProperty = new RdsHttpEndpointConfigProperty {
    AwsRegion = "awsRegion",
    AwsSecretStoreArn = "awsSecretStoreArn",
    DbClusterIdentifier = "dbClusterIdentifier",

    // the properties below are optional
    DatabaseName = "databaseName",
    Schema = "schema"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

rdsHttpEndpointConfigProperty := &RdsHttpEndpointConfigProperty{
	AwsRegion: jsii.String("awsRegion"),
	AwsSecretStoreArn: jsii.String("awsSecretStoreArn"),
	DbClusterIdentifier: jsii.String("dbClusterIdentifier"),

	// the properties below are optional
	DatabaseName: jsii.String("databaseName"),
	Schema: jsii.String("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.