Package software.amazon.awssdk.services.opensearch.model

Interface CreateDomainRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateDomainRequest

public static interface CreateDomainRequest.Builder
extends OpenSearchRequest.Builder, SdkPojo, CopyableBuilder<CreateDomainRequest.Builder,CreateDomainRequest>

Method Summary

Modifier and Type	Method	Description
CreateDomainRequest.Builder	accessPolicies(String accessPolicies)	Identity and Access Management (IAM) policy document specifying the access policies for the new domain.
CreateDomainRequest.Builder	advancedOptions(Map<String,String> advancedOptions)	Key-value pairs to specify advanced configuration options.
default CreateDomainRequest.Builder	advancedSecurityOptions(Consumer<AdvancedSecurityOptionsInput.Builder> advancedSecurityOptions)	Options for fine-grained access control.
CreateDomainRequest.Builder	advancedSecurityOptions(AdvancedSecurityOptionsInput advancedSecurityOptions)	Options for fine-grained access control.
default CreateDomainRequest.Builder	autoTuneOptions(Consumer<AutoTuneOptionsInput.Builder> autoTuneOptions)	Options for Auto-Tune.
CreateDomainRequest.Builder	autoTuneOptions(AutoTuneOptionsInput autoTuneOptions)	Options for Auto-Tune.
default CreateDomainRequest.Builder	clusterConfig(Consumer<ClusterConfig.Builder> clusterConfig)	Container for the cluster configuration of a domain.
CreateDomainRequest.Builder	clusterConfig(ClusterConfig clusterConfig)	Container for the cluster configuration of a domain.
default CreateDomainRequest.Builder	cognitoOptions(Consumer<CognitoOptions.Builder> cognitoOptions)	Key-value pairs to configure Amazon Cognito authentication.
CreateDomainRequest.Builder	cognitoOptions(CognitoOptions cognitoOptions)	Key-value pairs to configure Amazon Cognito authentication.
default CreateDomainRequest.Builder	domainEndpointOptions(Consumer<DomainEndpointOptions.Builder> domainEndpointOptions)	Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
CreateDomainRequest.Builder	domainEndpointOptions(DomainEndpointOptions domainEndpointOptions)	Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
CreateDomainRequest.Builder	domainName(String domainName)	Name of the OpenSearch Service domain to create.
default CreateDomainRequest.Builder	ebsOptions(Consumer<EBSOptions.Builder> ebsOptions)	Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
CreateDomainRequest.Builder	ebsOptions(EBSOptions ebsOptions)	Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
default CreateDomainRequest.Builder	encryptionAtRestOptions(Consumer<EncryptionAtRestOptions.Builder> encryptionAtRestOptions)	Key-value pairs to enable encryption at rest.
CreateDomainRequest.Builder	encryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions)	Key-value pairs to enable encryption at rest.
CreateDomainRequest.Builder	engineVersion(String engineVersion)	String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain.
CreateDomainRequest.Builder	ipAddressType(String ipAddressType)	Specify either dual stack or IPv4 as your IP address type.
CreateDomainRequest.Builder	ipAddressType(IPAddressType ipAddressType)	Specify either dual stack or IPv4 as your IP address type.
CreateDomainRequest.Builder	logPublishingOptions(Map<LogType,LogPublishingOption> logPublishingOptions)	Key-value pairs to configure log publishing.
CreateDomainRequest.Builder	logPublishingOptionsWithStrings(Map<String,LogPublishingOption> logPublishingOptions)	Key-value pairs to configure log publishing.
default CreateDomainRequest.Builder	nodeToNodeEncryptionOptions(Consumer<NodeToNodeEncryptionOptions.Builder> nodeToNodeEncryptionOptions)	Enables node-to-node encryption.
CreateDomainRequest.Builder	nodeToNodeEncryptionOptions(NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions)	Enables node-to-node encryption.
default CreateDomainRequest.Builder	offPeakWindowOptions(Consumer<OffPeakWindowOptions.Builder> offPeakWindowOptions)	Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment.
CreateDomainRequest.Builder	offPeakWindowOptions(OffPeakWindowOptions offPeakWindowOptions)	Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment.
CreateDomainRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateDomainRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateDomainRequest.Builder	snapshotOptions(Consumer<SnapshotOptions.Builder> snapshotOptions)	DEPRECATED.
CreateDomainRequest.Builder	snapshotOptions(SnapshotOptions snapshotOptions)	DEPRECATED.
default CreateDomainRequest.Builder	softwareUpdateOptions(Consumer<SoftwareUpdateOptions.Builder> softwareUpdateOptions)	Software update options for the domain.
CreateDomainRequest.Builder	softwareUpdateOptions(SoftwareUpdateOptions softwareUpdateOptions)	Software update options for the domain.
CreateDomainRequest.Builder	tagList(Collection<Tag> tagList)	List of tags to add to the domain upon creation.
CreateDomainRequest.Builder	tagList(Consumer<Tag.Builder>... tagList)	List of tags to add to the domain upon creation.
CreateDomainRequest.Builder	tagList(Tag... tagList)	List of tags to add to the domain upon creation.
default CreateDomainRequest.Builder	vpcOptions(Consumer<VPCOptions.Builder> vpcOptions)	Container for the values required to configure VPC access domains.
CreateDomainRequest.Builder	vpcOptions(VPCOptions vpcOptions)	Container for the values required to configure VPC access domains.

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, sdkFields

Method Details

domainName

CreateDomainRequest.Builder domainName(String domainName)

Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

Parameters:

domainName - Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

Returns:

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

engineVersion

CreateDomainRequest.Builder engineVersion(String engineVersion)

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9. For more information, see Creating and managing Amazon OpenSearch Service domains.

Parameters:

engineVersion - String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9. For more information, see Creating and managing Amazon OpenSearch Service domains.

Returns:

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

clusterConfig

CreateDomainRequest.Builder clusterConfig(ClusterConfig clusterConfig)

Container for the cluster configuration of a domain.

Parameters:

clusterConfig - Container for the cluster configuration of a domain.

Returns:

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

clusterConfig

default CreateDomainRequest.Builder clusterConfig(Consumer<ClusterConfig.Builder> clusterConfig)

Container for the cluster configuration of a domain.

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

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

Parameters:

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

Returns:

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

See Also:

• clusterConfig(ClusterConfig)

ebsOptions

CreateDomainRequest.Builder ebsOptions(EBSOptions ebsOptions)

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

Parameters:

ebsOptions - Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

Returns:

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

ebsOptions

default CreateDomainRequest.Builder ebsOptions(Consumer<EBSOptions.Builder> ebsOptions)

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

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

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

Parameters:

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

Returns:

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

See Also:

• ebsOptions(EBSOptions)

accessPolicies

CreateDomainRequest.Builder accessPolicies(String accessPolicies)

Identity and Access Management (IAM) policy document specifying the access policies for the new domain.

Parameters:

accessPolicies - Identity and Access Management (IAM) policy document specifying the access policies for the new domain.

Returns:

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

ipAddressType

CreateDomainRequest.Builder ipAddressType(String ipAddressType)

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.

Parameters:

ipAddressType - Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.

Returns:

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

See Also:

• IPAddressType
• IPAddressType

ipAddressType

CreateDomainRequest.Builder ipAddressType(IPAddressType ipAddressType)

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.

Parameters:

ipAddressType - Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.

Returns:

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

See Also:

• IPAddressType
• IPAddressType

snapshotOptions

CreateDomainRequest.Builder snapshotOptions(SnapshotOptions snapshotOptions)

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

Parameters:

snapshotOptions - DEPRECATED. Container for the 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 CreateDomainRequest.Builder snapshotOptions(Consumer<SnapshotOptions.Builder> snapshotOptions)

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

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

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

Parameters:

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

Returns:

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

See Also:

• snapshotOptions(SnapshotOptions)

vpcOptions

CreateDomainRequest.Builder vpcOptions(VPCOptions vpcOptions)

Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

Parameters:

vpcOptions - Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. 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 CreateDomainRequest.Builder vpcOptions(Consumer<VPCOptions.Builder> vpcOptions)

Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

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

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

Parameters:

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

Returns:

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

See Also:

• vpcOptions(VPCOptions)

cognitoOptions

CreateDomainRequest.Builder cognitoOptions(CognitoOptions cognitoOptions)

Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

Parameters:

cognitoOptions - Key-value pairs to configure Amazon Cognito authentication. 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 CreateDomainRequest.Builder cognitoOptions(Consumer<CognitoOptions.Builder> cognitoOptions)

Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

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

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

Parameters:

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

Returns:

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

See Also:

• cognitoOptions(CognitoOptions)

encryptionAtRestOptions

CreateDomainRequest.Builder encryptionAtRestOptions(EncryptionAtRestOptions 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 CreateDomainRequest.Builder encryptionAtRestOptions(Consumer<EncryptionAtRestOptions.Builder> encryptionAtRestOptions)

Key-value pairs to enable encryption at rest.

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

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

Parameters:

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

Returns:

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

See Also:

• encryptionAtRestOptions(EncryptionAtRestOptions)

nodeToNodeEncryptionOptions

CreateDomainRequest.Builder nodeToNodeEncryptionOptions(NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions)

Enables node-to-node encryption.

Parameters:

nodeToNodeEncryptionOptions - Enables node-to-node encryption.

Returns:

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

nodeToNodeEncryptionOptions

default CreateDomainRequest.Builder nodeToNodeEncryptionOptions(Consumer<NodeToNodeEncryptionOptions.Builder> nodeToNodeEncryptionOptions)

Enables node-to-node encryption.

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

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

Parameters:

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

Returns:

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

See Also:

• nodeToNodeEncryptionOptions(NodeToNodeEncryptionOptions)

advancedOptions

CreateDomainRequest.Builder advancedOptions(Map<String,String> advancedOptions)

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

• "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.

• "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.

• "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.

• "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters.

Parameters:

advancedOptions - Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

• "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.

• "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.

• "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.

• "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters.

Returns:

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

logPublishingOptionsWithStrings

CreateDomainRequest.Builder logPublishingOptionsWithStrings(Map<String,LogPublishingOption> 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

CreateDomainRequest.Builder logPublishingOptions(Map<LogType,LogPublishingOption> 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.

domainEndpointOptions

CreateDomainRequest.Builder domainEndpointOptions(DomainEndpointOptions 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 CreateDomainRequest.Builder domainEndpointOptions(Consumer<DomainEndpointOptions.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 DomainEndpointOptions.Builder avoiding the need to create one manually via DomainEndpointOptions.builder().

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

Parameters:

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

Returns:

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

See Also:

• domainEndpointOptions(DomainEndpointOptions)

advancedSecurityOptions

CreateDomainRequest.Builder advancedSecurityOptions(AdvancedSecurityOptionsInput advancedSecurityOptions)

Options for fine-grained access control.

Parameters:

advancedSecurityOptions - Options for fine-grained access control.

Returns:

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

advancedSecurityOptions

default CreateDomainRequest.Builder advancedSecurityOptions(Consumer<AdvancedSecurityOptionsInput.Builder> advancedSecurityOptions)

Options for fine-grained access control.

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

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

Parameters:

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

Returns:

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

See Also:

• advancedSecurityOptions(AdvancedSecurityOptionsInput)

tagList

CreateDomainRequest.Builder tagList(Collection<Tag> tagList)

List of tags to add to the domain upon creation.

Parameters:

tagList - List of tags to add to the domain upon creation.

Returns:

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

tagList

CreateDomainRequest.Builder tagList(Tag... tagList)

List of tags to add to the domain upon creation.

Parameters:

tagList - List of tags to add to the domain upon creation.

Returns:

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

tagList

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

List of tags to add to the domain upon creation.

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>)

autoTuneOptions

CreateDomainRequest.Builder autoTuneOptions(AutoTuneOptionsInput autoTuneOptions)

Options for Auto-Tune.

Parameters:

autoTuneOptions - Options for Auto-Tune.

Returns:

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

autoTuneOptions

default CreateDomainRequest.Builder autoTuneOptions(Consumer<AutoTuneOptionsInput.Builder> autoTuneOptions)

Options for Auto-Tune.

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

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

Parameters:

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

Returns:

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

See Also:

• autoTuneOptions(AutoTuneOptionsInput)

offPeakWindowOptions

CreateDomainRequest.Builder offPeakWindowOptions(OffPeakWindowOptions offPeakWindowOptions)

Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.

Parameters:

offPeakWindowOptions - Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.

Returns:

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

offPeakWindowOptions

default CreateDomainRequest.Builder offPeakWindowOptions(Consumer<OffPeakWindowOptions.Builder> offPeakWindowOptions)

Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.

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

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

Parameters:

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

Returns:

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

See Also:

• offPeakWindowOptions(OffPeakWindowOptions)

softwareUpdateOptions

CreateDomainRequest.Builder softwareUpdateOptions(SoftwareUpdateOptions 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 CreateDomainRequest.Builder softwareUpdateOptions(Consumer<SoftwareUpdateOptions.Builder> softwareUpdateOptions)

Software update options for the domain.

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

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

Parameters:

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

Returns:

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

See Also:

• softwareUpdateOptions(SoftwareUpdateOptions)

overrideConfiguration

CreateDomainRequest.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

CreateDomainRequest.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.