Interface RdsDataSourceProps
- All Superinterfaces:
BackedDataSourceProps
,BaseDataSourceProps
,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
RdsDataSourceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:49.567Z")
@Stability(Experimental)
public interface RdsDataSourceProps
extends software.amazon.jsii.JsiiSerializable, BackedDataSourceProps
(experimental) Properties for an AppSync RDS datasource.
Example:
// 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.*; import software.amazon.awscdk.services.iam.*; import software.amazon.awscdk.services.rds.*; import software.amazon.awscdk.services.secretsmanager.*; GraphqlApi graphqlApi; Role role; Secret secret; ServerlessCluster serverlessCluster; RdsDataSourceProps rdsDataSourceProps = RdsDataSourceProps.builder() .api(graphqlApi) .secretStore(secret) .serverlessCluster(serverlessCluster) // the properties below are optional .databaseName("databaseName") .description("description") .name("name") .serviceRole(role) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forRdsDataSourceProps
static final class
An implementation forRdsDataSourceProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic RdsDataSourceProps.Builder
builder()
default String
(experimental) The name of the database to use within the cluster.(experimental) The secret containing the credentials for the database.(experimental) The serverless cluster to call to interact with this data source.Methods inherited from interface software.amazon.awscdk.services.appsync.BackedDataSourceProps
getServiceRole
Methods inherited from interface software.amazon.awscdk.services.appsync.BaseDataSourceProps
getApi, getDescription, getName
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getSecretStore
(experimental) The secret containing the credentials for the database. -
getServerlessCluster
(experimental) The serverless cluster to call to interact with this data source. -
getDatabaseName
(experimental) The name of the database to use within the cluster.Default: - None
-
builder
- Returns:
- a
RdsDataSourceProps.Builder
ofRdsDataSourceProps
-