software.amazon.awscdk.services.appsync

Class OpenSearchDataSource.Builder

java.lang.Object

software.amazon.awscdk.services.appsync.OpenSearchDataSource.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<OpenSearchDataSource>

Enclosing class:

OpenSearchDataSource

@Stability(value=Experimental)
public static final class OpenSearchDataSource.Builder
extends Object
implements software.amazon.jsii.Builder<OpenSearchDataSource>

(experimental) A fluent builder for OpenSearchDataSource.

Method Summary

Modifier and Type	Method and Description
OpenSearchDataSource.Builder	api(IGraphqlApi api) (experimental) The API to attach this data source to.
OpenSearchDataSource	build()
static OpenSearchDataSource.Builder	create(software.constructs.Construct scope, String id)
OpenSearchDataSource.Builder	description(String description) (experimental) the description of the data source.
OpenSearchDataSource.Builder	domain(IDomain domain) (experimental) The OpenSearch domain containing the endpoint for the data source.
OpenSearchDataSource.Builder	name(String name) (experimental) The name of the data source.
OpenSearchDataSource.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 OpenSearchDataSource.Builder create(software.constructs.Construct scope,
                                                                                 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of OpenSearchDataSource.Builder.

api

@Stability(value=Experimental)
public OpenSearchDataSource.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 OpenSearchDataSource.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 OpenSearchDataSource.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 OpenSearchDataSource.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

domain

@Stability(value=Experimental)
public OpenSearchDataSource.Builder domain(IDomain domain)

(experimental) The OpenSearch domain containing the endpoint for the data source.

Parameters:

domain - The OpenSearch domain containing the endpoint for the data source. This parameter is required.

Returns:

this

build

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

Specified by:

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