Show / Hide Table of Contents

Interface IRdsDataSourceProps

Properties for an AppSync RDS datasource Aurora Serverless V1.

Inherited Members
IBackedDataSourceProps.ServiceRole
IBaseDataSourceProps.Api
IBaseDataSourceProps.Description
IBaseDataSourceProps.Name
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IRdsDataSourceProps : IBackedDataSourceProps, IBaseDataSourceProps
Syntax (vb)
Public Interface IRdsDataSourceProps Inherits IBackedDataSourceProps, IBaseDataSourceProps
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.AppSync;
            using Amazon.CDK.AWS.IAM;
            using Amazon.CDK.AWS.RDS;
            using Amazon.CDK.AWS.SecretsManager;
            using Amazon.CDK.Interfaces.AppSync;

            IGraphQLApiRef graphQLApiRef;
            Role role;
            Secret secret;
            ServerlessCluster serverlessCluster;

            var rdsDataSourceProps = new RdsDataSourceProps {
                Api = graphQLApiRef,
                SecretStore = secret,
                ServerlessCluster = serverlessCluster,

                // the properties below are optional
                DatabaseName = "databaseName",
                Description = "description",
                Name = "name",
                ServiceRole = role
            };

Synopsis

Properties

DatabaseName

The name of the database to use within the cluster.

SecretStore

The secret containing the credentials for the database.

ServerlessCluster

The serverless cluster to call to interact with this data source.

Properties

DatabaseName

The name of the database to use within the cluster.

string? DatabaseName { get; }
Property Value

string

Remarks

Default: - None

SecretStore

The secret containing the credentials for the database.

ISecret SecretStore { get; }
Property Value

ISecret

Remarks

ExampleMetadata: fixture=_generated

ServerlessCluster

The serverless cluster to call to interact with this data source.

IServerlessCluster ServerlessCluster { get; }
Property Value

IServerlessCluster

Remarks

ExampleMetadata: fixture=_generated

Back to top Generated by DocFX