Package software.amazon.awscdk.services.iot.actions.alpha

Class OpenSearchAction.Builder

java.lang.Object

software.amazon.awscdk.services.iot.actions.alpha.OpenSearchAction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<OpenSearchAction>

Enclosing class:

OpenSearchAction

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

(experimental) A fluent builder for OpenSearchAction.

Method Summary

Modifier and Type	Method	Description
OpenSearchAction	build()
static OpenSearchAction.Builder	create(Domain domain)
OpenSearchAction.Builder	id(String id)	(experimental) The unique identifier for the document you are storing.
OpenSearchAction.Builder	index(String index)	(experimental) The OpenSearch index where you want to store your data.
OpenSearchAction.Builder	role(IRole role)	(experimental) The IAM role that allows access to AWS service.
OpenSearchAction.Builder	type(String type)	(experimental) The type of document you are storing.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Experimental)
public static OpenSearchAction.Builder create(Domain domain)

Parameters:

domain - This parameter is required.

Returns:

a new instance of OpenSearchAction.Builder.

role

@Stability(Experimental)
public OpenSearchAction.Builder role(IRole role)

(experimental) The IAM role that allows access to AWS service.

Default: a new role will be created

Parameters:

role - The IAM role that allows access to AWS service. This parameter is required.

Returns:

this

id

@Stability(Experimental)
public OpenSearchAction.Builder id(String id)

(experimental) The unique identifier for the document you are storing.

Parameters:

id - The unique identifier for the document you are storing. This parameter is required.

Returns:

this

index

@Stability(Experimental)
public OpenSearchAction.Builder index(String index)

(experimental) The OpenSearch index where you want to store your data.

Parameters:

index - The OpenSearch index where you want to store your data. This parameter is required.

Returns:

this

type

@Stability(Experimental)
public OpenSearchAction.Builder type(String type)

(experimental) The type of document you are storing.

Parameters:

type - The type of document you are storing. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public OpenSearchAction build()

Specified by:

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

Returns:

a newly built instance of OpenSearchAction.