Class RdsDataSourcePropsV2

Properties for an AppSync RDS datasource Aurora Serverless V2.

Inheritance

object

RdsDataSourcePropsV2

Implements

IRdsDataSourcePropsV2

IBackedDataSourceProps

IBaseDataSourceProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class RdsDataSourcePropsV2 : IRdsDataSourcePropsV2, IBackedDataSourceProps, IBaseDataSourceProps

Syntax (vb)

Public Class RdsDataSourcePropsV2 Implements IRdsDataSourcePropsV2, 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;

            DatabaseCluster databaseCluster;
            IGraphQLApiRef graphQLApiRef;
            Role role;
            Secret secret;

            var rdsDataSourcePropsV2 = new RdsDataSourcePropsV2 {
                Api = graphQLApiRef,
                SecretStore = secret,
                ServerlessCluster = databaseCluster,

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

Synopsis

Constructors

RdsDataSourcePropsV2()

Properties for an AppSync RDS datasource Aurora Serverless V2.

Properties

Api	The API to attach this data source to.
DatabaseName	The name of the database to use within the cluster.
Description	the description of the data source.
Name	The name of the data source.
SecretStore	The secret containing the credentials for the database.
ServerlessCluster	The serverless cluster to call to interact with this data source.
ServiceRole	The IAM service role to be assumed by AppSync to interact with the data source.

Constructors

RdsDataSourcePropsV2()

Properties for an AppSync RDS datasource Aurora Serverless V2.

public RdsDataSourcePropsV2()

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;

            DatabaseCluster databaseCluster;
            IGraphQLApiRef graphQLApiRef;
            Role role;
            Secret secret;

            var rdsDataSourcePropsV2 = new RdsDataSourcePropsV2 {
                Api = graphQLApiRef,
                SecretStore = secret,
                ServerlessCluster = databaseCluster,

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

Properties

Api

The API to attach this data source to.

public IGraphQLApiRef Api { get; set; }

Property Value

IGraphQLApiRef

Remarks

ExampleMetadata: fixture=_generated

DatabaseName

The name of the database to use within the cluster.

public string? DatabaseName { get; set; }

Property Value

string

Remarks

Default: - None

Description

the description of the data source.

public string? Description { get; set; }

Property Value

string

Remarks

Default: - None

Name

The name of the data source.

public string? Name { get; set; }

Property Value

string

Remarks

Default: - id of data source

SecretStore

The secret containing the credentials for the database.

public ISecret SecretStore { get; set; }

Property Value

ISecret

Remarks

ExampleMetadata: fixture=_generated

ServerlessCluster

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

public IDatabaseCluster ServerlessCluster { get; set; }

Property Value

IDatabaseCluster

Remarks

ExampleMetadata: fixture=_generated

ServiceRole

The IAM service role to be assumed by AppSync to interact with the data source.

public IRole? ServiceRole { get; set; }

Property Value

IRole

Remarks

Default: - Create a new role

Implements

IRdsDataSourcePropsV2

IBackedDataSourceProps

IBaseDataSourceProps