Interface AwsOpenSearchServiceDomainDetails.Builder

All Superinterfaces:

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

Enclosing class:

AwsOpenSearchServiceDomainDetails

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

Method Summary

Modifier and Type	Method	Description
AwsOpenSearchServiceDomainDetails.Builder	accessPolicies(String accessPolicies)	IAM policy document that specifies the access policies for the OpenSearch Service domain.
default AwsOpenSearchServiceDomainDetails.Builder	advancedSecurityOptions(Consumer<AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails.Builder> advancedSecurityOptions)	Specifies options for fine-grained access control.
AwsOpenSearchServiceDomainDetails.Builder	advancedSecurityOptions(AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails advancedSecurityOptions)	Specifies options for fine-grained access control.
AwsOpenSearchServiceDomainDetails.Builder	arn(String arn)	The ARN of the OpenSearch Service domain.
default AwsOpenSearchServiceDomainDetails.Builder	clusterConfig(Consumer<AwsOpenSearchServiceDomainClusterConfigDetails.Builder> clusterConfig)	Details about the configuration of an OpenSearch cluster.
AwsOpenSearchServiceDomainDetails.Builder	clusterConfig(AwsOpenSearchServiceDomainClusterConfigDetails clusterConfig)	Details about the configuration of an OpenSearch cluster.
AwsOpenSearchServiceDomainDetails.Builder	domainEndpoint(String domainEndpoint)	The domain endpoint.
default AwsOpenSearchServiceDomainDetails.Builder	domainEndpointOptions(Consumer<AwsOpenSearchServiceDomainDomainEndpointOptionsDetails.Builder> domainEndpointOptions)	Additional options for the domain endpoint.
AwsOpenSearchServiceDomainDetails.Builder	domainEndpointOptions(AwsOpenSearchServiceDomainDomainEndpointOptionsDetails domainEndpointOptions)	Additional options for the domain endpoint.
AwsOpenSearchServiceDomainDetails.Builder	domainEndpoints(Map<String,String> domainEndpoints)	The domain endpoints.
AwsOpenSearchServiceDomainDetails.Builder	domainName(String domainName)	The name of the endpoint.
default AwsOpenSearchServiceDomainDetails.Builder	encryptionAtRestOptions(Consumer<AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails.Builder> encryptionAtRestOptions)	Details about the configuration for encryption at rest.
AwsOpenSearchServiceDomainDetails.Builder	encryptionAtRestOptions(AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails encryptionAtRestOptions)	Details about the configuration for encryption at rest.
AwsOpenSearchServiceDomainDetails.Builder	engineVersion(String engineVersion)	The version of the domain engine.
AwsOpenSearchServiceDomainDetails.Builder	id(String id)	The identifier of the domain.
default AwsOpenSearchServiceDomainDetails.Builder	logPublishingOptions(Consumer<AwsOpenSearchServiceDomainLogPublishingOptionsDetails.Builder> logPublishingOptions)	Configures the CloudWatch Logs to publish for the OpenSearch domain.
AwsOpenSearchServiceDomainDetails.Builder	logPublishingOptions(AwsOpenSearchServiceDomainLogPublishingOptionsDetails logPublishingOptions)	Configures the CloudWatch Logs to publish for the OpenSearch domain.
default AwsOpenSearchServiceDomainDetails.Builder	nodeToNodeEncryptionOptions(Consumer<AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails.Builder> nodeToNodeEncryptionOptions)	Details about the configuration for node-to-node encryption.
AwsOpenSearchServiceDomainDetails.Builder	nodeToNodeEncryptionOptions(AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails nodeToNodeEncryptionOptions)	Details about the configuration for node-to-node encryption.
default AwsOpenSearchServiceDomainDetails.Builder	serviceSoftwareOptions(Consumer<AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails.Builder> serviceSoftwareOptions)	Information about the status of a domain relative to the latest service software.
AwsOpenSearchServiceDomainDetails.Builder	serviceSoftwareOptions(AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails serviceSoftwareOptions)	Information about the status of a domain relative to the latest service software.
default AwsOpenSearchServiceDomainDetails.Builder	vpcOptions(Consumer<AwsOpenSearchServiceDomainVpcOptionsDetails.Builder> vpcOptions)	Information that OpenSearch Service derives based on VPCOptions for the domain.
AwsOpenSearchServiceDomainDetails.Builder	vpcOptions(AwsOpenSearchServiceDomainVpcOptionsDetails vpcOptions)	Information that OpenSearch Service derives based on VPCOptions for the domain.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Details

arn

AwsOpenSearchServiceDomainDetails.Builder arn(String arn)

The ARN of the OpenSearch Service domain.

Parameters:

arn - The ARN of the OpenSearch Service domain.

Returns:

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

accessPolicies

AwsOpenSearchServiceDomainDetails.Builder accessPolicies(String accessPolicies)

IAM policy document that specifies the access policies for the OpenSearch Service domain.

Parameters:

accessPolicies - IAM policy document that specifies the access policies for the OpenSearch Service domain.

Returns:

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

domainName

AwsOpenSearchServiceDomainDetails.Builder domainName(String domainName)

The name of the endpoint.

Parameters:

domainName - The name of the endpoint.

Returns:

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

id

AwsOpenSearchServiceDomainDetails.Builder id(String id)

The identifier of the domain.

Parameters:

id - The identifier of the domain.

Returns:

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

domainEndpoint

AwsOpenSearchServiceDomainDetails.Builder domainEndpoint(String domainEndpoint)

The domain endpoint.

Parameters:

domainEndpoint - The domain endpoint.

Returns:

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

engineVersion

AwsOpenSearchServiceDomainDetails.Builder engineVersion(String engineVersion)

The version of the domain engine.

Parameters:

engineVersion - The version of the domain engine.

Returns:

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

encryptionAtRestOptions

AwsOpenSearchServiceDomainDetails.Builder encryptionAtRestOptions(AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails encryptionAtRestOptions)

Details about the configuration for encryption at rest.

Parameters:

encryptionAtRestOptions - Details about the configuration for encryption at rest.

Returns:

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

encryptionAtRestOptions

default AwsOpenSearchServiceDomainDetails.Builder encryptionAtRestOptions(Consumer<AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails.Builder> encryptionAtRestOptions)

Details about the configuration for encryption at rest.

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

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

Parameters:

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

Returns:

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

See Also:

• encryptionAtRestOptions(AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails)

nodeToNodeEncryptionOptions

AwsOpenSearchServiceDomainDetails.Builder nodeToNodeEncryptionOptions(AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails nodeToNodeEncryptionOptions)

Details about the configuration for node-to-node encryption.

Parameters:

nodeToNodeEncryptionOptions - Details about the configuration for node-to-node encryption.

Returns:

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

nodeToNodeEncryptionOptions

default AwsOpenSearchServiceDomainDetails.Builder nodeToNodeEncryptionOptions(Consumer<AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails.Builder> nodeToNodeEncryptionOptions)

Details about the configuration for node-to-node encryption.

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

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

Parameters:

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

Returns:

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

See Also:

• nodeToNodeEncryptionOptions(AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails)

serviceSoftwareOptions

AwsOpenSearchServiceDomainDetails.Builder serviceSoftwareOptions(AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails serviceSoftwareOptions)

Information about the status of a domain relative to the latest service software.

Parameters:

serviceSoftwareOptions - Information about the status of a domain relative to the latest service software.

Returns:

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

serviceSoftwareOptions

default AwsOpenSearchServiceDomainDetails.Builder serviceSoftwareOptions(Consumer<AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails.Builder> serviceSoftwareOptions)

Information about the status of a domain relative to the latest service software.

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

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

Parameters:

serviceSoftwareOptions - a consumer that will call methods on AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails.Builder

Returns:

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

See Also:

• serviceSoftwareOptions(AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails)

clusterConfig

AwsOpenSearchServiceDomainDetails.Builder clusterConfig(AwsOpenSearchServiceDomainClusterConfigDetails clusterConfig)

Details about the configuration of an OpenSearch cluster.

Parameters:

clusterConfig - Details about the configuration of an OpenSearch cluster.

Returns:

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

clusterConfig

default AwsOpenSearchServiceDomainDetails.Builder clusterConfig(Consumer<AwsOpenSearchServiceDomainClusterConfigDetails.Builder> clusterConfig)

Details about the configuration of an OpenSearch cluster.

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

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

Parameters:

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

Returns:

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

See Also:

• clusterConfig(AwsOpenSearchServiceDomainClusterConfigDetails)

domainEndpointOptions

AwsOpenSearchServiceDomainDetails.Builder domainEndpointOptions(AwsOpenSearchServiceDomainDomainEndpointOptionsDetails domainEndpointOptions)

Additional options for the domain endpoint.

Parameters:

domainEndpointOptions - Additional options for the domain endpoint.

Returns:

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

domainEndpointOptions

default AwsOpenSearchServiceDomainDetails.Builder domainEndpointOptions(Consumer<AwsOpenSearchServiceDomainDomainEndpointOptionsDetails.Builder> domainEndpointOptions)

Additional options for the domain endpoint.

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

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

Parameters:

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

Returns:

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

See Also:

• domainEndpointOptions(AwsOpenSearchServiceDomainDomainEndpointOptionsDetails)

vpcOptions

AwsOpenSearchServiceDomainDetails.Builder vpcOptions(AwsOpenSearchServiceDomainVpcOptionsDetails vpcOptions)

Information that OpenSearch Service derives based on VPCOptions for the domain.

Parameters:

vpcOptions - Information that OpenSearch Service derives based on VPCOptions for the domain.

Returns:

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

vpcOptions

default AwsOpenSearchServiceDomainDetails.Builder vpcOptions(Consumer<AwsOpenSearchServiceDomainVpcOptionsDetails.Builder> vpcOptions)

Information that OpenSearch Service derives based on VPCOptions for the domain.

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

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

Parameters:

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

Returns:

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

See Also:

• vpcOptions(AwsOpenSearchServiceDomainVpcOptionsDetails)

logPublishingOptions

AwsOpenSearchServiceDomainDetails.Builder logPublishingOptions(AwsOpenSearchServiceDomainLogPublishingOptionsDetails logPublishingOptions)

Configures the CloudWatch Logs to publish for the OpenSearch domain.

Parameters:

logPublishingOptions - Configures the CloudWatch Logs to publish for the OpenSearch domain.

Returns:

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

logPublishingOptions

default AwsOpenSearchServiceDomainDetails.Builder logPublishingOptions(Consumer<AwsOpenSearchServiceDomainLogPublishingOptionsDetails.Builder> logPublishingOptions)

Configures the CloudWatch Logs to publish for the OpenSearch domain.

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

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

Parameters:

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

Returns:

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

See Also:

• logPublishingOptions(AwsOpenSearchServiceDomainLogPublishingOptionsDetails)

domainEndpoints

AwsOpenSearchServiceDomainDetails.Builder domainEndpoints(Map<String,String> domainEndpoints)

The domain endpoints. Used if the OpenSearch domain resides in a VPC.

This is a map of key-value pairs. The key is always vpc. The value is the endpoint.

Parameters:

domainEndpoints - The domain endpoints. Used if the OpenSearch domain resides in a VPC.

This is a map of key-value pairs. The key is always vpc. The value is the endpoint.

Returns:

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

advancedSecurityOptions

AwsOpenSearchServiceDomainDetails.Builder advancedSecurityOptions(AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails advancedSecurityOptions)

Specifies options for fine-grained access control.

Parameters:

advancedSecurityOptions - Specifies options for fine-grained access control.

Returns:

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

advancedSecurityOptions

default AwsOpenSearchServiceDomainDetails.Builder advancedSecurityOptions(Consumer<AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails.Builder> advancedSecurityOptions)

Specifies options for fine-grained access control.

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

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

Parameters:

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

Returns:

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

See Also:

• advancedSecurityOptions(AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails)