Class RdsDataSource.Builder
java.lang.Object
software.amazon.awscdk.services.appsync.RdsDataSource.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<RdsDataSource>
- Enclosing class:
- RdsDataSource
@Stability(Experimental)
public static final class RdsDataSource.Builder
extends Object
implements software.amazon.jsii.Builder<RdsDataSource>
(experimental) A fluent builder for
RdsDataSource
.-
Method Summary
Modifier and TypeMethodDescriptionapi
(IGraphqlApi api) (experimental) The API to attach this data source to.build()
static RdsDataSource.Builder
databaseName
(String databaseName) (experimental) The name of the database to use within the cluster.description
(String description) (experimental) the description of the data source.(experimental) The name of the data source.secretStore
(ISecret secretStore) (experimental) The secret containing the credentials for the database.serverlessCluster
(IServerlessCluster serverlessCluster) (experimental) The serverless cluster to call to interact with this data source.serviceRole
(IRole serviceRole) (experimental) The IAM service role to be assumed by AppSync to interact with the data source.
-
Method Details
-
create
@Stability(Experimental) public static RdsDataSource.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- This parameter is required.id
- This parameter is required.- Returns:
- a new instance of
RdsDataSource.Builder
.
-
api
(experimental) The API to attach this data source to.- Parameters:
api
- The API to attach this data source to. This parameter is required.- Returns:
this
-
description
(experimental) the description of the data source.Default: - None
- Parameters:
description
- the description of the data source. This parameter is required.- Returns:
this
-
name
(experimental) The name of the data source.Default: - id of data source
- Parameters:
name
- The name of the data source. This parameter is required.- Returns:
this
-
serviceRole
(experimental) The IAM service role to be assumed by AppSync to interact with the data source.Default: - Create a new role
- Parameters:
serviceRole
- The IAM service role to be assumed by AppSync to interact with the data source. This parameter is required.- Returns:
this
-
secretStore
(experimental) The secret containing the credentials for the database.- Parameters:
secretStore
- The secret containing the credentials for the database. This parameter is required.- Returns:
this
-
serverlessCluster
@Stability(Experimental) public RdsDataSource.Builder serverlessCluster(IServerlessCluster serverlessCluster) (experimental) The serverless cluster to call to interact with this data source.- Parameters:
serverlessCluster
- The serverless cluster to call to interact with this data source. This parameter is required.- Returns:
this
-
databaseName
(experimental) The name of the database to use within the cluster.Default: - None
- Parameters:
databaseName
- The name of the database to use within the cluster. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<RdsDataSource>
- Returns:
- a newly built instance of
RdsDataSource
.
-