Interface CreateApplicationRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateApplicationRequest.Builder,CreateApplicationRequest>, OpenSearchRequest.Builder, SdkBuilder<CreateApplicationRequest.Builder,CreateApplicationRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateApplicationRequest

@Mutable
@NotThreadSafe
public static interface CreateApplicationRequest.Builder
extends OpenSearchRequest.Builder, SdkPojo, CopyableBuilder<CreateApplicationRequest.Builder,CreateApplicationRequest>

Method Summary

Modifier and Type	Method	Description
CreateApplicationRequest.Builder	appConfigs(Collection<AppConfig> appConfigs)	Configuration settings for the OpenSearch application, including administrative options.
CreateApplicationRequest.Builder	appConfigs(Consumer<AppConfig.Builder>... appConfigs)	Configuration settings for the OpenSearch application, including administrative options.
CreateApplicationRequest.Builder	appConfigs(AppConfig... appConfigs)	Configuration settings for the OpenSearch application, including administrative options.
CreateApplicationRequest.Builder	clientToken(String clientToken)	Unique, case-sensitive identifier to ensure idempotency of the request.
CreateApplicationRequest.Builder	dataSources(Collection<DataSource> dataSources)	The data sources to link to the OpenSearch application.
CreateApplicationRequest.Builder	dataSources(Consumer<DataSource.Builder>... dataSources)	The data sources to link to the OpenSearch application.
CreateApplicationRequest.Builder	dataSources(DataSource... dataSources)	The data sources to link to the OpenSearch application.
default CreateApplicationRequest.Builder	iamIdentityCenterOptions(Consumer<IamIdentityCenterOptionsInput.Builder> iamIdentityCenterOptions)	Configuration settings for integrating Amazon Web Services IAM Identity Center with the OpenSearch application.
CreateApplicationRequest.Builder	iamIdentityCenterOptions(IamIdentityCenterOptionsInput iamIdentityCenterOptions)	Configuration settings for integrating Amazon Web Services IAM Identity Center with the OpenSearch application.
CreateApplicationRequest.Builder	kmsKeyArn(String kmsKeyArn)	The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest.
CreateApplicationRequest.Builder	name(String name)	The unique name of the OpenSearch application.
CreateApplicationRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateApplicationRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateApplicationRequest.Builder	tagList(Collection<Tag> tagList)	Sets the value of the TagList property for this object.
CreateApplicationRequest.Builder	tagList(Consumer<Tag.Builder>... tagList)	Sets the value of the TagList property for this object.
CreateApplicationRequest.Builder	tagList(Tag... tagList)	Sets the value of the TagList property for this object.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.opensearch.model.OpenSearchRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

clientToken

CreateApplicationRequest.Builder clientToken(String clientToken)

Unique, case-sensitive identifier to ensure idempotency of the request.

Parameters:

clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

CreateApplicationRequest.Builder name(String name)

The unique name of the OpenSearch application. Names must be unique within an Amazon Web Services Region for each account.

Parameters:

name - The unique name of the OpenSearch application. Names must be unique within an Amazon Web Services Region for each account.

Returns:

Returns a reference to this object so that method calls can be chained together.

dataSources

CreateApplicationRequest.Builder dataSources(Collection<DataSource> dataSources)

The data sources to link to the OpenSearch application.

Parameters:

dataSources - The data sources to link to the OpenSearch application.

Returns:

Returns a reference to this object so that method calls can be chained together.

dataSources

CreateApplicationRequest.Builder dataSources(DataSource... dataSources)

The data sources to link to the OpenSearch application.

Parameters:

dataSources - The data sources to link to the OpenSearch application.

Returns:

Returns a reference to this object so that method calls can be chained together.

dataSources

CreateApplicationRequest.Builder dataSources(Consumer<DataSource.Builder>... dataSources)

The data sources to link to the OpenSearch application.

This is a convenience method that creates an instance of the DataSource.Builder avoiding the need to create one manually via DataSource.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataSources(List<DataSource>).

Parameters:

dataSources - a consumer that will call methods on DataSource.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• dataSources(java.util.Collection<DataSource>)

iamIdentityCenterOptions

CreateApplicationRequest.Builder iamIdentityCenterOptions(IamIdentityCenterOptionsInput iamIdentityCenterOptions)

Configuration settings for integrating Amazon Web Services IAM Identity Center with the OpenSearch application.

Parameters:

iamIdentityCenterOptions - Configuration settings for integrating Amazon Web Services IAM Identity Center with the OpenSearch application.

Returns:

Returns a reference to this object so that method calls can be chained together.

iamIdentityCenterOptions

default CreateApplicationRequest.Builder iamIdentityCenterOptions(Consumer<IamIdentityCenterOptionsInput.Builder> iamIdentityCenterOptions)

Configuration settings for integrating Amazon Web Services IAM Identity Center with the OpenSearch application.

This is a convenience method that creates an instance of the IamIdentityCenterOptionsInput.Builder avoiding the need to create one manually via IamIdentityCenterOptionsInput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to iamIdentityCenterOptions(IamIdentityCenterOptionsInput).

Parameters:

iamIdentityCenterOptions - a consumer that will call methods on IamIdentityCenterOptionsInput.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• iamIdentityCenterOptions(IamIdentityCenterOptionsInput)

appConfigs

CreateApplicationRequest.Builder appConfigs(Collection<AppConfig> appConfigs)

Configuration settings for the OpenSearch application, including administrative options.

Parameters:

appConfigs - Configuration settings for the OpenSearch application, including administrative options.

Returns:

Returns a reference to this object so that method calls can be chained together.

appConfigs

CreateApplicationRequest.Builder appConfigs(AppConfig... appConfigs)

Configuration settings for the OpenSearch application, including administrative options.

Parameters:

appConfigs - Configuration settings for the OpenSearch application, including administrative options.

Returns:

Returns a reference to this object so that method calls can be chained together.

appConfigs

CreateApplicationRequest.Builder appConfigs(Consumer<AppConfig.Builder>... appConfigs)

Configuration settings for the OpenSearch application, including administrative options.

This is a convenience method that creates an instance of the AppConfig.Builder avoiding the need to create one manually via AppConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to appConfigs(List<AppConfig>).

Parameters:

appConfigs - a consumer that will call methods on AppConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• appConfigs(java.util.Collection<AppConfig>)

tagList

CreateApplicationRequest.Builder tagList(Collection<Tag> tagList)

Sets the value of the TagList property for this object.

Parameters:

tagList - The new value for the TagList property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

tagList

CreateApplicationRequest.Builder tagList(Tag... tagList)

Sets the value of the TagList property for this object.

Parameters:

tagList - The new value for the TagList property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

tagList

CreateApplicationRequest.Builder tagList(Consumer<Tag.Builder>... tagList)

Sets the value of the TagList property for this object. This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagList(List<Tag>).

Parameters:

tagList - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• tagList(java.util.Collection<Tag>)

kmsKeyArn

CreateApplicationRequest.Builder kmsKeyArn(String kmsKeyArn)

The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest. If provided, the application uses your customer-managed key for encryption. If omitted, the application uses an AWS-managed key. The KMS key must be in the same region as the application.

Parameters:

kmsKeyArn - The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest. If provided, the application uses your customer-managed key for encryption. If omitted, the application uses an AWS-managed key. The KMS key must be in the same region as the application.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateApplicationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateApplicationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.