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) Specifies the access policies for the domain.
default DomainConfig.Builder	accessPolicies(Consumer<AccessPoliciesStatus.Builder> accessPolicies) Specifies the access policies for the domain.
DomainConfig.Builder	advancedOptions(AdvancedOptionsStatus advancedOptions) Key-value pairs to specify advanced configuration options.
default DomainConfig.Builder	advancedOptions(Consumer<AdvancedOptionsStatus.Builder> advancedOptions) Key-value pairs to specify advanced configuration options.
DomainConfig.Builder	advancedSecurityOptions(AdvancedSecurityOptionsStatus advancedSecurityOptions) Container for fine-grained access control settings for the domain.
default DomainConfig.Builder	advancedSecurityOptions(Consumer<AdvancedSecurityOptionsStatus.Builder> advancedSecurityOptions) Container for fine-grained access control settings for the domain.
DomainConfig.Builder	autoTuneOptions(AutoTuneOptionsStatus autoTuneOptions) Container for Auto-Tune settings for the domain.
default DomainConfig.Builder	autoTuneOptions(Consumer<AutoTuneOptionsStatus.Builder> autoTuneOptions) Container for Auto-Tune settings for the domain.
DomainConfig.Builder	changeProgressDetails(ChangeProgressDetails changeProgressDetails) Container for information about the progress of an existing configuration change.
default DomainConfig.Builder	changeProgressDetails(Consumer<ChangeProgressDetails.Builder> changeProgressDetails) Container for information about the progress of an existing configuration change.
DomainConfig.Builder	clusterConfig(ClusterConfigStatus clusterConfig) Container for the cluster configuration of a the domain.
default DomainConfig.Builder	clusterConfig(Consumer<ClusterConfigStatus.Builder> clusterConfig) Container for the cluster configuration of a the domain.
DomainConfig.Builder	cognitoOptions(CognitoOptionsStatus cognitoOptions) Container for Amazon Cognito options for the domain.
default DomainConfig.Builder	cognitoOptions(Consumer<CognitoOptionsStatus.Builder> cognitoOptions) Container for Amazon Cognito options for the domain.
default DomainConfig.Builder	domainEndpointOptions(Consumer<DomainEndpointOptionsStatus.Builder> domainEndpointOptions) Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
DomainConfig.Builder	domainEndpointOptions(DomainEndpointOptionsStatus domainEndpointOptions) Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
default DomainConfig.Builder	ebsOptions(Consumer<EBSOptionsStatus.Builder> ebsOptions) Container for EBS options configured for the domain.
DomainConfig.Builder	ebsOptions(EBSOptionsStatus ebsOptions) Container for EBS options configured for the domain.
default DomainConfig.Builder	encryptionAtRestOptions(Consumer<EncryptionAtRestOptionsStatus.Builder> encryptionAtRestOptions) Key-value pairs to enable encryption at rest.
DomainConfig.Builder	encryptionAtRestOptions(EncryptionAtRestOptionsStatus encryptionAtRestOptions) Key-value pairs to enable encryption at rest.
default DomainConfig.Builder	engineVersion(Consumer<VersionStatus.Builder> engineVersion) The OpenSearch or Elasticsearch version that the domain is running.
DomainConfig.Builder	engineVersion(VersionStatus engineVersion) The OpenSearch or Elasticsearch version that the domain is running.
default DomainConfig.Builder	logPublishingOptions(Consumer<LogPublishingOptionsStatus.Builder> logPublishingOptions) Key-value pairs to configure log publishing.
DomainConfig.Builder	logPublishingOptions(LogPublishingOptionsStatus logPublishingOptions) Key-value pairs to configure log publishing.
default DomainConfig.Builder	nodeToNodeEncryptionOptions(Consumer<NodeToNodeEncryptionOptionsStatus.Builder> nodeToNodeEncryptionOptions) Whether node-to-node encryption is enabled or disabled.
DomainConfig.Builder	nodeToNodeEncryptionOptions(NodeToNodeEncryptionOptionsStatus nodeToNodeEncryptionOptions) Whether node-to-node encryption is enabled or disabled.
default DomainConfig.Builder	offPeakWindowOptions(Consumer<OffPeakWindowOptionsStatus.Builder> offPeakWindowOptions) Container for off-peak window options for the domain.
DomainConfig.Builder	offPeakWindowOptions(OffPeakWindowOptionsStatus offPeakWindowOptions) Container for off-peak window options for the domain.
default DomainConfig.Builder	snapshotOptions(Consumer<SnapshotOptionsStatus.Builder> snapshotOptions) DEPRECATED.
DomainConfig.Builder	snapshotOptions(SnapshotOptionsStatus snapshotOptions) DEPRECATED.
default DomainConfig.Builder	softwareUpdateOptions(Consumer<SoftwareUpdateOptionsStatus.Builder> softwareUpdateOptions) Software update options for the domain.
DomainConfig.Builder	softwareUpdateOptions(SoftwareUpdateOptionsStatus softwareUpdateOptions) Software update options for the domain.
default DomainConfig.Builder	vpcOptions(Consumer<VPCDerivedInfoStatus.Builder> vpcOptions) The current VPC options for the domain and the status of any updates to their configuration.
DomainConfig.Builder	vpcOptions(VPCDerivedInfoStatus vpcOptions) The current VPC options for the domain and the status of any updates to their configuration.

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)

The OpenSearch or Elasticsearch version that the domain is running.

Parameters:

engineVersion - The OpenSearch or Elasticsearch version that the domain is running.

Returns:

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

engineVersion

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

The OpenSearch or Elasticsearch version that the domain is running.

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)

Container for the cluster configuration of a the domain.

Parameters:

clusterConfig - Container for the cluster configuration of a 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)

Container for the cluster configuration of a 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)

Container for EBS options configured for the domain.

Parameters:

ebsOptions - Container for EBS options configured 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)

Container for EBS options configured 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)

Specifies the access policies for the domain.

Parameters:

accessPolicies - Specifies the access policies for the domain.

Returns:

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

accessPolicies

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

Specifies the access policies for the domain.

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)

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

Parameters:

snapshotOptions - DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

Returns:

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

snapshotOptions

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

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

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 current VPC options for the domain and the status of any updates to their configuration.

Parameters:

vpcOptions - The current VPC options for the domain and the status of any updates to their configuration.

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 current VPC options for the domain and the status of any updates to their configuration.

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)

Container for Amazon Cognito options for the domain.

Parameters:

cognitoOptions - Container for Amazon Cognito options for the domain.

Returns:

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

cognitoOptions

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

Container for Amazon Cognito options for the domain.

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)

Key-value pairs to enable encryption at rest.

Parameters:

encryptionAtRestOptions - Key-value pairs to enable encryption at rest.

Returns:

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

encryptionAtRestOptions

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

Key-value pairs to enable encryption at rest.

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)

Whether node-to-node encryption is enabled or disabled.

Parameters:

nodeToNodeEncryptionOptions - Whether node-to-node encryption is enabled or disabled.

Returns:

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

nodeToNodeEncryptionOptions

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

Whether node-to-node encryption is enabled or disabled.

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)

Key-value pairs to specify advanced configuration options. For more information, see Advanced options.

Parameters:

advancedOptions - Key-value pairs to specify advanced configuration options. For more information, see Advanced options.

Returns:

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

advancedOptions

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

Key-value pairs to specify advanced configuration options. For more information, see Advanced options.

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)

Key-value pairs to configure log publishing.

Parameters:

logPublishingOptions - Key-value pairs to configure log publishing.

Returns:

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

logPublishingOptions

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

Key-value pairs to configure log publishing.

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)

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

Parameters:

domainEndpointOptions - Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

Returns:

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

domainEndpointOptions

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

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

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)

Container for fine-grained access control settings for the domain.

Parameters:

advancedSecurityOptions - Container for fine-grained access control settings 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)

Container for fine-grained access control settings 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)

Container for Auto-Tune settings for the domain.

Parameters:

autoTuneOptions - Container for Auto-Tune settings 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)

Container for Auto-Tune settings 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)

Container for information about the progress of an existing configuration change.

Parameters:

changeProgressDetails - Container for information about the progress of an existing 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)

Container for information about the progress of an existing 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)

offPeakWindowOptions

DomainConfig.Builder offPeakWindowOptions(OffPeakWindowOptionsStatus offPeakWindowOptions)

Container for off-peak window options for the domain.

Parameters:

offPeakWindowOptions - Container for off-peak window options for the domain.

Returns:

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

offPeakWindowOptions

default DomainConfig.Builder offPeakWindowOptions(Consumer<OffPeakWindowOptionsStatus.Builder> offPeakWindowOptions)

Container for off-peak window options for the domain.

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

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

Parameters:

offPeakWindowOptions - a consumer that will call methods on OffPeakWindowOptionsStatus.Builder

Returns:

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

See Also:

offPeakWindowOptions(OffPeakWindowOptionsStatus)

softwareUpdateOptions

DomainConfig.Builder softwareUpdateOptions(SoftwareUpdateOptionsStatus softwareUpdateOptions)

Software update options for the domain.

Parameters:

softwareUpdateOptions - Software update options for the domain.

Returns:

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

softwareUpdateOptions

default DomainConfig.Builder softwareUpdateOptions(Consumer<SoftwareUpdateOptionsStatus.Builder> softwareUpdateOptions)

Software update options for the domain.

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

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

Parameters:

softwareUpdateOptions - a consumer that will call methods on SoftwareUpdateOptionsStatus.Builder

Returns:

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

See Also:

softwareUpdateOptions(SoftwareUpdateOptionsStatus)