Class AppSyncRdsDataSourceProps

Properties for an AppSync RDS datasource Aurora Serverless V1.

Inheritance

object

AppSyncRdsDataSourceProps

Implements

IAppSyncRdsDataSourceProps

IAppSyncBackedDataSourceProps

IAppSyncBaseDataSourceProps

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 AppSyncRdsDataSourceProps : IAppSyncRdsDataSourceProps, IAppSyncBackedDataSourceProps, IAppSyncBaseDataSourceProps

Syntax (vb)

Public Class AppSyncRdsDataSourceProps Implements IAppSyncRdsDataSourceProps, IAppSyncBackedDataSourceProps, IAppSyncBaseDataSourceProps

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;

            IApi api;
            Role role;
            Secret secret;
            ServerlessCluster serverlessCluster;

            var appSyncRdsDataSourceProps = new AppSyncRdsDataSourceProps {
                Api = api,
                SecretStore = secret,
                ServerlessCluster = serverlessCluster,

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

Synopsis

Constructors

AppSyncRdsDataSourceProps()

Properties for an AppSync RDS datasource Aurora Serverless V1.

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

AppSyncRdsDataSourceProps()

Properties for an AppSync RDS datasource Aurora Serverless V1.

public AppSyncRdsDataSourceProps()

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;

            IApi api;
            Role role;
            Secret secret;
            ServerlessCluster serverlessCluster;

            var appSyncRdsDataSourceProps = new AppSyncRdsDataSourceProps {
                Api = api,
                SecretStore = secret,
                ServerlessCluster = serverlessCluster,

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

Properties

Api

The API to attach this data source to.

public IApi Api { get; set; }

Property Value

IApi

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

The only allowed pattern is: {[_A-Za-z][_0-9A-Za-z]*}. Any invalid characters will be automatically removed.

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 IServerlessCluster ServerlessCluster { get; set; }

Property Value

IServerlessCluster

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

IAppSyncRdsDataSourceProps

IAppSyncBackedDataSourceProps

IAppSyncBaseDataSourceProps