Class RdsDataSourceProps
(experimental) Properties for an AppSync RDS datasource.
Inheritance
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.AWS.AppSync.dll
Syntax (csharp)
public class RdsDataSourceProps : Object, IRdsDataSourceProps, IBackedDataSourceProps, IBaseDataSourceProps
Syntax (vb)
Public Class RdsDataSourceProps
Inherits Object
Implements IRdsDataSourceProps, IBackedDataSourceProps, IBaseDataSourceProps
Remarks
Stability: Experimental
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;
GraphqlApi graphqlApi;
Role role;
Secret secret;
ServerlessCluster serverlessCluster;
var rdsDataSourceProps = new RdsDataSourceProps {
Api = graphqlApi,
SecretStore = secret,
ServerlessCluster = serverlessCluster,
// the properties below are optional
DatabaseName = "databaseName",
Description = "description",
Name = "name",
ServiceRole = role
};
Synopsis
Constructors
RdsDataSourceProps() |
Properties
Api | (experimental) The API to attach this data source to. |
DatabaseName | (experimental) The name of the database to use within the cluster. |
Description | (experimental) the description of the data source. |
Name | (experimental) The name of the data source. |
SecretStore | (experimental) The secret containing the credentials for the database. |
ServerlessCluster | (experimental) The serverless cluster to call to interact with this data source. |
ServiceRole | (experimental) The IAM service role to be assumed by AppSync to interact with the data source. |
Constructors
RdsDataSourceProps()
public RdsDataSourceProps()
Properties
Api
(experimental) The API to attach this data source to.
public IGraphqlApi Api { get; set; }
Property Value
Remarks
Stability: Experimental
DatabaseName
(experimental) The name of the database to use within the cluster.
public string DatabaseName { get; set; }
Property Value
System.String
Remarks
Default: - None
Stability: Experimental
Description
(experimental) the description of the data source.
public string Description { get; set; }
Property Value
System.String
Remarks
Default: - None
Stability: Experimental
Name
(experimental) The name of the data source.
public string Name { get; set; }
Property Value
System.String
Remarks
Default: - id of data source
Stability: Experimental
SecretStore
(experimental) The secret containing the credentials for the database.
public ISecret SecretStore { get; set; }
Property Value
Remarks
Stability: Experimental
ServerlessCluster
(experimental) The serverless cluster to call to interact with this data source.
public IServerlessCluster ServerlessCluster { get; set; }
Property Value
Remarks
Stability: Experimental
ServiceRole
(experimental) The IAM service role to be assumed by AppSync to interact with the data source.
public IRole ServiceRole { get; set; }
Property Value
Remarks
Default: - Create a new role
Stability: Experimental