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

Class OpenSearchActionProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<OpenSearchActionProps>

Enclosing interface:

OpenSearchActionProps

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

A builder for OpenSearchActionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OpenSearchActionProps	build()	Builds the configured instance.
OpenSearchActionProps.Builder	id(String id)	Sets the value of OpenSearchActionProps.getId()
OpenSearchActionProps.Builder	index(String index)	Sets the value of OpenSearchActionProps.getIndex()
OpenSearchActionProps.Builder	role(IRole role)	Sets the value of CommonActionProps.getRole()
OpenSearchActionProps.Builder	type(String type)	Sets the value of OpenSearchActionProps.getType()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

id

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

Sets the value of OpenSearchActionProps.getId()

Parameters:

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

Returns:

this

index

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

Sets the value of OpenSearchActionProps.getIndex()

Parameters:

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

Returns:

this

type

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

Sets the value of OpenSearchActionProps.getType()

Parameters:

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

Returns:

this

role

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

Sets the value of CommonActionProps.getRole()

Parameters:

role - The IAM role that allows access to AWS service.

Returns:

this

build

@Stability(Experimental)
public OpenSearchActionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of OpenSearchActionProps

Throws:

NullPointerException - if any required attribute was not provided