Skip to content
v2.276.0

RelationalDatabaseConfigProperty Struct ​

Use the RelationalDatabaseConfig property type to specify RelationalDatabaseConfig for an AWS AppSync data source.

RelationalDatabaseConfig is a property of the AWS::AppSync::DataSource property type.

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 relationalDatabaseConfigProperty: appsync.CfnDataSource.RelationalDatabaseConfigProperty = {
  relationalDatabaseSourceType: 'relationalDatabaseSourceType',

  // the properties below are optional
  rdsHttpEndpointConfig: {
    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

relational_database_config_property = appsync.CfnDataSource.RelationalDatabaseConfigProperty(
    relational_database_source_type="relationalDatabaseSourceType",

    # the properties below are optional
    rds_http_endpoint_config=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.*;

RelationalDatabaseConfigProperty relationalDatabaseConfigProperty = RelationalDatabaseConfigProperty.builder()
        .relationalDatabaseSourceType("relationalDatabaseSourceType")

        // the properties below are optional
        .rdsHttpEndpointConfig(RdsHttpEndpointConfigProperty.builder()
                .awsRegion("awsRegion")
                .awsSecretStoreArn("awsSecretStoreArn")
                .dbClusterIdentifier("dbClusterIdentifier")

                // the properties below are optional
                .databaseName("databaseName")
                .schema("schema")
                .build())
        .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 relationalDatabaseConfigProperty = new RelationalDatabaseConfigProperty {
    RelationalDatabaseSourceType = "relationalDatabaseSourceType",

    // the properties below are optional
    RdsHttpEndpointConfig = 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"

relationalDatabaseConfigProperty := &RelationalDatabaseConfigProperty{
	RelationalDatabaseSourceType: jsii.String("relationalDatabaseSourceType"),

	// the properties below are optional
	RdsHttpEndpointConfig: &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 ​

rdsHttpEndpointConfigoptionalIResolvable | CfnDataSource.RdsHttpEndpointConfigPropertyrds_http_endpoint_configoptionaltyping.Union[IResolvable, RdsHttpEndpointConfigProperty]rdsHttpEndpointConfigoptionalIResolvableRdsHttpEndpointConfigoptionalIResolvableRdsHttpEndpointConfigoptionalinterface{}#
Information about the Amazon RDS resource.
relationalDatabaseSourceTypestringrelational_database_source_typestrrelationalDatabaseSourceTypeStringRelationalDatabaseSourceTypestringRelationalDatabaseSourceType*stringrequired#
The type of relational data source.