software.amazon.awscdk.services.appsync

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(value=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 Type	Method and Description
RdsDataSource.Builder	api(IGraphqlApi api) (experimental) The API to attach this data source to.
RdsDataSource	build()
static RdsDataSource.Builder	create(software.constructs.Construct scope, String id)
RdsDataSource.Builder	databaseName(String databaseName) (experimental) The name of the database to use within the cluster.
RdsDataSource.Builder	description(String description) (experimental) the description of the data source.
RdsDataSource.Builder	name(String name) (experimental) The name of the data source.
RdsDataSource.Builder	secretStore(ISecret secretStore) (experimental) The secret containing the credentials for the database.
RdsDataSource.Builder	serverlessCluster(IServerlessCluster serverlessCluster) (experimental) The serverless cluster to call to interact with this data source.
RdsDataSource.Builder	serviceRole(IRole serviceRole) (experimental) The IAM service role to be assumed by AppSync to interact with the data source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=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

@Stability(value=Experimental)
public RdsDataSource.Builder api(IGraphqlApi 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

@Stability(value=Experimental)
public RdsDataSource.Builder description(String 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

@Stability(value=Experimental)
public RdsDataSource.Builder name(String 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

@Stability(value=Experimental)
public RdsDataSource.Builder serviceRole(IRole 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

@Stability(value=Experimental)
public RdsDataSource.Builder secretStore(ISecret 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(value=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

@Stability(value=Experimental)
public RdsDataSource.Builder databaseName(String 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

@Stability(value=Experimental)
public RdsDataSource build()

Specified by:

build in interface software.amazon.jsii.Builder<RdsDataSource>