software.amazon.awssdk.services.opensearch.model

Interface DomainConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DomainConfig.Builder,DomainConfig>, SdkBuilder<DomainConfig.Builder,DomainConfig>, SdkPojo

Enclosing class:

DomainConfig

public static interface DomainConfig.Builder
extends SdkPojo, CopyableBuilder<DomainConfig.Builder,DomainConfig>

Method Summary

Modifier and Type	Method and Description
DomainConfig.Builder	accessPolicies(AccessPoliciesStatus accessPolicies) IAM access policy as a JSON-formatted string.
default DomainConfig.Builder	accessPolicies(Consumer<AccessPoliciesStatus.Builder> accessPolicies) IAM access policy as a JSON-formatted string.
DomainConfig.Builder	advancedOptions(AdvancedOptionsStatus advancedOptions) The AdvancedOptions for the domain.
default DomainConfig.Builder	advancedOptions(Consumer<AdvancedOptionsStatus.Builder> advancedOptions) The AdvancedOptions for the domain.
DomainConfig.Builder	advancedSecurityOptions(AdvancedSecurityOptionsStatus advancedSecurityOptions) Specifies AdvancedSecurityOptions for the domain.
default DomainConfig.Builder	advancedSecurityOptions(Consumer<AdvancedSecurityOptionsStatus.Builder> advancedSecurityOptions) Specifies AdvancedSecurityOptions for the domain.
DomainConfig.Builder	autoTuneOptions(AutoTuneOptionsStatus autoTuneOptions) Specifies AutoTuneOptions for the domain.
default DomainConfig.Builder	autoTuneOptions(Consumer<AutoTuneOptionsStatus.Builder> autoTuneOptions) Specifies AutoTuneOptions for the domain.
DomainConfig.Builder	changeProgressDetails(ChangeProgressDetails changeProgressDetails) Specifies change details of the domain configuration change.
default DomainConfig.Builder	changeProgressDetails(Consumer<ChangeProgressDetails.Builder> changeProgressDetails) Specifies change details of the domain configuration change.
DomainConfig.Builder	clusterConfig(ClusterConfigStatus clusterConfig) The ClusterConfig for the domain.
default DomainConfig.Builder	clusterConfig(Consumer<ClusterConfigStatus.Builder> clusterConfig) The ClusterConfig for the domain.
DomainConfig.Builder	cognitoOptions(CognitoOptionsStatus cognitoOptions) The CognitoOptions for the specified domain.
default DomainConfig.Builder	cognitoOptions(Consumer<CognitoOptionsStatus.Builder> cognitoOptions) The CognitoOptions for the specified domain.
default DomainConfig.Builder	domainEndpointOptions(Consumer<DomainEndpointOptionsStatus.Builder> domainEndpointOptions) The DomainEndpointOptions for the domain.
DomainConfig.Builder	domainEndpointOptions(DomainEndpointOptionsStatus domainEndpointOptions) The DomainEndpointOptions for the domain.
default DomainConfig.Builder	ebsOptions(Consumer<EBSOptionsStatus.Builder> ebsOptions) The EBSOptions for the domain.
DomainConfig.Builder	ebsOptions(EBSOptionsStatus ebsOptions) The EBSOptions for the domain.
default DomainConfig.Builder	encryptionAtRestOptions(Consumer<EncryptionAtRestOptionsStatus.Builder> encryptionAtRestOptions) The EncryptionAtRestOptions for the domain.
DomainConfig.Builder	encryptionAtRestOptions(EncryptionAtRestOptionsStatus encryptionAtRestOptions) The EncryptionAtRestOptions for the domain.
default DomainConfig.Builder	engineVersion(Consumer<VersionStatus.Builder> engineVersion) String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.
DomainConfig.Builder	engineVersion(VersionStatus engineVersion) String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.
default DomainConfig.Builder	logPublishingOptions(Consumer<LogPublishingOptionsStatus.Builder> logPublishingOptions) Log publishing options for the given domain.
DomainConfig.Builder	logPublishingOptions(LogPublishingOptionsStatus logPublishingOptions) Log publishing options for the given domain.
default DomainConfig.Builder	nodeToNodeEncryptionOptions(Consumer<NodeToNodeEncryptionOptionsStatus.Builder> nodeToNodeEncryptionOptions) The NodeToNodeEncryptionOptions for the domain.
DomainConfig.Builder	nodeToNodeEncryptionOptions(NodeToNodeEncryptionOptionsStatus nodeToNodeEncryptionOptions) The NodeToNodeEncryptionOptions for the domain.
default DomainConfig.Builder	snapshotOptions(Consumer<SnapshotOptionsStatus.Builder> snapshotOptions) The SnapshotOptions for the domain.
DomainConfig.Builder	snapshotOptions(SnapshotOptionsStatus snapshotOptions) The SnapshotOptions for the domain.
default DomainConfig.Builder	vpcOptions(Consumer<VPCDerivedInfoStatus.Builder> vpcOptions) The VPCOptions for the specified domain.
DomainConfig.Builder	vpcOptions(VPCDerivedInfoStatus vpcOptions) The VPCOptions for the specified domain.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

engineVersion

DomainConfig.Builder engineVersion(VersionStatus engineVersion)

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.

Parameters:

engineVersion - String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.

Returns:

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

engineVersion

default DomainConfig.Builder engineVersion(Consumer<VersionStatus.Builder> engineVersion)

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.

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

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

Parameters:

engineVersion - a consumer that will call methods on VersionStatus.Builder

Returns:

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

See Also:

engineVersion(VersionStatus)

clusterConfig

DomainConfig.Builder clusterConfig(ClusterConfigStatus clusterConfig)

The ClusterConfig for the domain.

Parameters:

clusterConfig - The ClusterConfig for the domain.

Returns:

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

clusterConfig

default DomainConfig.Builder clusterConfig(Consumer<ClusterConfigStatus.Builder> clusterConfig)

The ClusterConfig for the domain.

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

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

Parameters:

clusterConfig - a consumer that will call methods on ClusterConfigStatus.Builder

Returns:

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

See Also:

clusterConfig(ClusterConfigStatus)

ebsOptions

DomainConfig.Builder ebsOptions(EBSOptionsStatus ebsOptions)

The EBSOptions for the domain.

Parameters:

ebsOptions - The EBSOptions for the domain.

Returns:

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

ebsOptions

default DomainConfig.Builder ebsOptions(Consumer<EBSOptionsStatus.Builder> ebsOptions)

The EBSOptions for the domain.

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

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

Parameters:

ebsOptions - a consumer that will call methods on EBSOptionsStatus.Builder

Returns:

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

See Also:

ebsOptions(EBSOptionsStatus)

accessPolicies

DomainConfig.Builder accessPolicies(AccessPoliciesStatus accessPolicies)

IAM access policy as a JSON-formatted string.

Parameters:

accessPolicies - IAM access policy as a JSON-formatted string.

Returns:

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

accessPolicies

default DomainConfig.Builder accessPolicies(Consumer<AccessPoliciesStatus.Builder> accessPolicies)

IAM access policy as a JSON-formatted string.

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

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

Parameters:

accessPolicies - a consumer that will call methods on AccessPoliciesStatus.Builder

Returns:

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

See Also:

accessPolicies(AccessPoliciesStatus)

snapshotOptions

DomainConfig.Builder snapshotOptions(SnapshotOptionsStatus snapshotOptions)

The SnapshotOptions for the domain.

Parameters:

snapshotOptions - The SnapshotOptions for the domain.

Returns:

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

snapshotOptions

default DomainConfig.Builder snapshotOptions(Consumer<SnapshotOptionsStatus.Builder> snapshotOptions)

The SnapshotOptions for the domain.

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

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

Parameters:

snapshotOptions - a consumer that will call methods on SnapshotOptionsStatus.Builder

Returns:

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

See Also:

snapshotOptions(SnapshotOptionsStatus)

vpcOptions

DomainConfig.Builder vpcOptions(VPCDerivedInfoStatus vpcOptions)

The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

Parameters:

vpcOptions - The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

Returns:

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

vpcOptions

default DomainConfig.Builder vpcOptions(Consumer<VPCDerivedInfoStatus.Builder> vpcOptions)

The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

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

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

Parameters:

vpcOptions - a consumer that will call methods on VPCDerivedInfoStatus.Builder

Returns:

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

See Also:

vpcOptions(VPCDerivedInfoStatus)

cognitoOptions

DomainConfig.Builder cognitoOptions(CognitoOptionsStatus cognitoOptions)

The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

Parameters:

cognitoOptions - The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

Returns:

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

cognitoOptions

default DomainConfig.Builder cognitoOptions(Consumer<CognitoOptionsStatus.Builder> cognitoOptions)

The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

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

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

Parameters:

cognitoOptions - a consumer that will call methods on CognitoOptionsStatus.Builder

Returns:

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

See Also:

cognitoOptions(CognitoOptionsStatus)

encryptionAtRestOptions

DomainConfig.Builder encryptionAtRestOptions(EncryptionAtRestOptionsStatus encryptionAtRestOptions)

The EncryptionAtRestOptions for the domain.

Parameters:

encryptionAtRestOptions - The EncryptionAtRestOptions for the domain.

Returns:

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

encryptionAtRestOptions

default DomainConfig.Builder encryptionAtRestOptions(Consumer<EncryptionAtRestOptionsStatus.Builder> encryptionAtRestOptions)

The EncryptionAtRestOptions for the domain.

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

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

Parameters:

encryptionAtRestOptions - a consumer that will call methods on EncryptionAtRestOptionsStatus.Builder

Returns:

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

See Also:

encryptionAtRestOptions(EncryptionAtRestOptionsStatus)

nodeToNodeEncryptionOptions

DomainConfig.Builder nodeToNodeEncryptionOptions(NodeToNodeEncryptionOptionsStatus nodeToNodeEncryptionOptions)

The NodeToNodeEncryptionOptions for the domain.

Parameters:

nodeToNodeEncryptionOptions - The NodeToNodeEncryptionOptions for the domain.

Returns:

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

nodeToNodeEncryptionOptions

default DomainConfig.Builder nodeToNodeEncryptionOptions(Consumer<NodeToNodeEncryptionOptionsStatus.Builder> nodeToNodeEncryptionOptions)

The NodeToNodeEncryptionOptions for the domain.

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

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

Parameters:

nodeToNodeEncryptionOptions - a consumer that will call methods on NodeToNodeEncryptionOptionsStatus.Builder

Returns:

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

See Also:

nodeToNodeEncryptionOptions(NodeToNodeEncryptionOptionsStatus)

advancedOptions

DomainConfig.Builder advancedOptions(AdvancedOptionsStatus advancedOptions)

The AdvancedOptions for the domain. See Advanced options for more information.

Parameters:

advancedOptions - The AdvancedOptions for the domain. See Advanced options for more information.

Returns:

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

advancedOptions

default DomainConfig.Builder advancedOptions(Consumer<AdvancedOptionsStatus.Builder> advancedOptions)

The AdvancedOptions for the domain. See Advanced options for more information.

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

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

Parameters:

advancedOptions - a consumer that will call methods on AdvancedOptionsStatus.Builder

Returns:

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

See Also:

advancedOptions(AdvancedOptionsStatus)

logPublishingOptions

DomainConfig.Builder logPublishingOptions(LogPublishingOptionsStatus logPublishingOptions)

Log publishing options for the given domain.

Parameters:

logPublishingOptions - Log publishing options for the given domain.

Returns:

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

logPublishingOptions

default DomainConfig.Builder logPublishingOptions(Consumer<LogPublishingOptionsStatus.Builder> logPublishingOptions)

Log publishing options for the given domain.

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

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

Parameters:

logPublishingOptions - a consumer that will call methods on LogPublishingOptionsStatus.Builder

Returns:

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

See Also:

logPublishingOptions(LogPublishingOptionsStatus)

domainEndpointOptions

DomainConfig.Builder domainEndpointOptions(DomainEndpointOptionsStatus domainEndpointOptions)

The DomainEndpointOptions for the domain.

Parameters:

domainEndpointOptions - The DomainEndpointOptions for the domain.

Returns:

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

domainEndpointOptions

default DomainConfig.Builder domainEndpointOptions(Consumer<DomainEndpointOptionsStatus.Builder> domainEndpointOptions)

The DomainEndpointOptions for the domain.

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

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

Parameters:

domainEndpointOptions - a consumer that will call methods on DomainEndpointOptionsStatus.Builder

Returns:

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

See Also:

domainEndpointOptions(DomainEndpointOptionsStatus)

advancedSecurityOptions

DomainConfig.Builder advancedSecurityOptions(AdvancedSecurityOptionsStatus advancedSecurityOptions)

Specifies AdvancedSecurityOptions for the domain.

Parameters:

advancedSecurityOptions - Specifies AdvancedSecurityOptions for the domain.

Returns:

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

advancedSecurityOptions

default DomainConfig.Builder advancedSecurityOptions(Consumer<AdvancedSecurityOptionsStatus.Builder> advancedSecurityOptions)

Specifies AdvancedSecurityOptions for the domain.

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

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

Parameters:

advancedSecurityOptions - a consumer that will call methods on AdvancedSecurityOptionsStatus.Builder

Returns:

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

See Also:

advancedSecurityOptions(AdvancedSecurityOptionsStatus)

autoTuneOptions

DomainConfig.Builder autoTuneOptions(AutoTuneOptionsStatus autoTuneOptions)

Specifies AutoTuneOptions for the domain.

Parameters:

autoTuneOptions - Specifies AutoTuneOptions for the domain.

Returns:

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

autoTuneOptions

default DomainConfig.Builder autoTuneOptions(Consumer<AutoTuneOptionsStatus.Builder> autoTuneOptions)

Specifies AutoTuneOptions for the domain.

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

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

Parameters:

autoTuneOptions - a consumer that will call methods on AutoTuneOptionsStatus.Builder

Returns:

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

See Also:

autoTuneOptions(AutoTuneOptionsStatus)

changeProgressDetails

DomainConfig.Builder changeProgressDetails(ChangeProgressDetails changeProgressDetails)

Specifies change details of the domain configuration change.

Parameters:

changeProgressDetails - Specifies change details of the domain configuration change.

Returns:

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

changeProgressDetails

default DomainConfig.Builder changeProgressDetails(Consumer<ChangeProgressDetails.Builder> changeProgressDetails)

Specifies change details of the domain configuration change.

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

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

Parameters:

changeProgressDetails - a consumer that will call methods on ChangeProgressDetails.Builder

Returns:

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

See Also:

changeProgressDetails(ChangeProgressDetails)