public static interface CreateDomainRequest.Builder extends OpenSearchRequest.Builder, SdkPojo, CopyableBuilder<CreateDomainRequest.Builder,CreateDomainRequest>
| Modifier and Type | Method and 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.
|
CreateDomainRequest.Builder |
advancedSecurityOptions(AdvancedSecurityOptionsInput advancedSecurityOptions)
Options for fine-grained access control.
|
default CreateDomainRequest.Builder |
advancedSecurityOptions(Consumer<AdvancedSecurityOptionsInput.Builder> advancedSecurityOptions)
Options for fine-grained access control.
|
CreateDomainRequest.Builder |
autoTuneOptions(AutoTuneOptionsInput autoTuneOptions)
Options for Auto-Tune.
|
default CreateDomainRequest.Builder |
autoTuneOptions(Consumer<AutoTuneOptionsInput.Builder> autoTuneOptions)
Options for Auto-Tune.
|
CreateDomainRequest.Builder |
clusterConfig(ClusterConfig clusterConfig)
Container for the cluster configuration of a domain.
|
default CreateDomainRequest.Builder |
clusterConfig(Consumer<ClusterConfig.Builder> clusterConfig)
Container for the cluster configuration of a domain.
|
CreateDomainRequest.Builder |
cognitoOptions(CognitoOptions cognitoOptions)
Key-value pairs to configure Amazon Cognito authentication.
|
default CreateDomainRequest.Builder |
cognitoOptions(Consumer<CognitoOptions.Builder> 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 |
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(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateDomainRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
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.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateDomainRequest.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.
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.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.
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.CreateDomainRequest.Builder clusterConfig(ClusterConfig clusterConfig)
Container for the cluster configuration of a domain.
clusterConfig - Container for the cluster configuration of a domain.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 theClusterConfig.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).
clusterConfig - a consumer that will call methods on ClusterConfig.BuilderclusterConfig(ClusterConfig)CreateDomainRequest.Builder ebsOptions(EBSOptions ebsOptions)
Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
ebsOptions - Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.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 theEBSOptions.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).
ebsOptions - a consumer that will call methods on EBSOptions.BuilderebsOptions(EBSOptions)CreateDomainRequest.Builder accessPolicies(String accessPolicies)
Identity and Access Management (IAM) policy document specifying the access policies for the new domain.
accessPolicies - Identity and Access Management (IAM) policy document specifying the access policies for the new
domain.CreateDomainRequest.Builder snapshotOptions(SnapshotOptions snapshotOptions)
DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.
snapshotOptions - DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.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 theSnapshotOptions.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).
snapshotOptions - a consumer that will call methods on SnapshotOptions.BuildersnapshotOptions(SnapshotOptions)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.
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.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 theVPCOptions.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).
vpcOptions - a consumer that will call methods on VPCOptions.BuildervpcOptions(VPCOptions)CreateDomainRequest.Builder cognitoOptions(CognitoOptions cognitoOptions)
Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
cognitoOptions - Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.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 theCognitoOptions.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).
cognitoOptions - a consumer that will call methods on CognitoOptions.BuildercognitoOptions(CognitoOptions)CreateDomainRequest.Builder encryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions)
Key-value pairs to enable encryption at rest.
encryptionAtRestOptions - Key-value pairs to enable encryption at rest.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 theEncryptionAtRestOptions.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).
encryptionAtRestOptions - a consumer that will call methods on EncryptionAtRestOptions.BuilderencryptionAtRestOptions(EncryptionAtRestOptions)CreateDomainRequest.Builder nodeToNodeEncryptionOptions(NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions)
Enables node-to-node encryption.
nodeToNodeEncryptionOptions - Enables node-to-node encryption.default CreateDomainRequest.Builder nodeToNodeEncryptionOptions(Consumer<NodeToNodeEncryptionOptions.Builder> nodeToNodeEncryptionOptions)
Enables node-to-node encryption.
This is a convenience method that creates an instance of theNodeToNodeEncryptionOptions.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).
nodeToNodeEncryptionOptions - a consumer that will call methods on NodeToNodeEncryptionOptions.BuildernodeToNodeEncryptionOptions(NodeToNodeEncryptionOptions)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.
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.
CreateDomainRequest.Builder logPublishingOptionsWithStrings(Map<String,LogPublishingOption> logPublishingOptions)
Key-value pairs to configure log publishing.
logPublishingOptions - Key-value pairs to configure log publishing.CreateDomainRequest.Builder logPublishingOptions(Map<LogType,LogPublishingOption> logPublishingOptions)
Key-value pairs to configure log publishing.
logPublishingOptions - Key-value pairs to configure log publishing.CreateDomainRequest.Builder domainEndpointOptions(DomainEndpointOptions domainEndpointOptions)
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
domainEndpointOptions - Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.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 theDomainEndpointOptions.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).
domainEndpointOptions - a consumer that will call methods on DomainEndpointOptions.BuilderdomainEndpointOptions(DomainEndpointOptions)CreateDomainRequest.Builder advancedSecurityOptions(AdvancedSecurityOptionsInput advancedSecurityOptions)
Options for fine-grained access control.
advancedSecurityOptions - Options for fine-grained access control.default CreateDomainRequest.Builder advancedSecurityOptions(Consumer<AdvancedSecurityOptionsInput.Builder> advancedSecurityOptions)
Options for fine-grained access control.
This is a convenience method that creates an instance of theAdvancedSecurityOptionsInput.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).
advancedSecurityOptions - a consumer that will call methods on AdvancedSecurityOptionsInput.BuilderadvancedSecurityOptions(AdvancedSecurityOptionsInput)CreateDomainRequest.Builder tagList(Collection<Tag> tagList)
List of tags to add to the domain upon creation.
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.
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.
This is a convenience method that creates an instance of theTag.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.
tagList - a consumer that will call methods on
Tag.Builder#tagList(java.util.Collection) CreateDomainRequest.Builder autoTuneOptions(AutoTuneOptionsInput autoTuneOptions)
Options for Auto-Tune.
autoTuneOptions - Options for Auto-Tune.default CreateDomainRequest.Builder autoTuneOptions(Consumer<AutoTuneOptionsInput.Builder> autoTuneOptions)
Options for Auto-Tune.
This is a convenience method that creates an instance of theAutoTuneOptionsInput.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).
autoTuneOptions - a consumer that will call methods on AutoTuneOptionsInput.BuilderautoTuneOptions(AutoTuneOptionsInput)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.
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.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 theOffPeakWindowOptions.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).
offPeakWindowOptions - a consumer that will call methods on OffPeakWindowOptions.BuilderoffPeakWindowOptions(OffPeakWindowOptions)CreateDomainRequest.Builder softwareUpdateOptions(SoftwareUpdateOptions softwareUpdateOptions)
Software update options for the domain.
softwareUpdateOptions - Software update options for the domain.default CreateDomainRequest.Builder softwareUpdateOptions(Consumer<SoftwareUpdateOptions.Builder> softwareUpdateOptions)
Software update options for the domain.
This is a convenience method that creates an instance of theSoftwareUpdateOptions.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).
softwareUpdateOptions - a consumer that will call methods on SoftwareUpdateOptions.BuildersoftwareUpdateOptions(SoftwareUpdateOptions)CreateDomainRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateDomainRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.