/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.opensearch.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateDomainRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* 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. *
*/ private String domainName; /** *
* 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.
*
* Container for the cluster configuration of a domain. *
*/ private ClusterConfig clusterConfig; /** ** Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain. *
*/ private EBSOptions eBSOptions; /** ** Identity and Access Management (IAM) policy document specifying the access policies for the new domain. *
*/ private String accessPolicies; /** ** DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes. *
*/ private SnapshotOptions snapshotOptions; /** ** 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. *
*/ private VPCOptions vPCOptions; /** ** Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon * Cognito authentication for OpenSearch Dashboards. *
*/ private CognitoOptions cognitoOptions; /** ** Key-value pairs to enable encryption at rest. *
*/ private EncryptionAtRestOptions encryptionAtRestOptions; /** ** Enables node-to-node encryption. *
*/ private NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions; /** ** 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. *
*/ private java.util.Map* Key-value pairs to configure log publishing. *
*/ private java.util.Map* Additional options for the domain endpoint, such as whether to require HTTPS for all traffic. *
*/ private DomainEndpointOptions domainEndpointOptions; /** ** Options for fine-grained access control. *
*/ private AdvancedSecurityOptionsInput advancedSecurityOptions; /** ** List of tags to add to the domain upon creation. *
*/ private java.util.List* Options for Auto-Tune. *
*/ private AutoTuneOptionsInput autoTuneOptions; /** ** 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. *
*/ private OffPeakWindowOptions offPeakWindowOptions; /** ** Software update options for the domain. *
*/ private SoftwareUpdateOptions softwareUpdateOptions; /** ** 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. *
* * @param 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. */ public void setDomainName(String domainName) { this.domainName = 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. *
* * @return 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. */ public String getDomainName() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDomainRequest withDomainName(String domainName) { setDomainName(domainName); return this; } /** *
* 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.
*
OpenSearch_1.0
or Elasticsearch_7.9
. For more
* information, see Creating and managing Amazon OpenSearch Service domains.
*/
public void setEngineVersion(String engineVersion) {
this.engineVersion = 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.
*
OpenSearch_1.0
or Elasticsearch_7.9
. For more
* information, see Creating and managing Amazon OpenSearch Service domains.
*/
public String getEngineVersion() {
return this.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.
*
OpenSearch_1.0
or Elasticsearch_7.9
. For more
* information, see Creating and managing Amazon OpenSearch Service domains.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDomainRequest withEngineVersion(String engineVersion) {
setEngineVersion(engineVersion);
return this;
}
/**
* * Container for the cluster configuration of a domain. *
* * @param clusterConfig * Container for the cluster configuration of a domain. */ public void setClusterConfig(ClusterConfig clusterConfig) { this.clusterConfig = clusterConfig; } /** ** Container for the cluster configuration of a domain. *
* * @return Container for the cluster configuration of a domain. */ public ClusterConfig getClusterConfig() { return this.clusterConfig; } /** ** Container for the cluster configuration of a domain. *
* * @param clusterConfig * Container for the cluster configuration of a domain. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDomainRequest withClusterConfig(ClusterConfig clusterConfig) { setClusterConfig(clusterConfig); return this; } /** ** Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain. *
* * @param eBSOptions * Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain. */ public void setEBSOptions(EBSOptions eBSOptions) { this.eBSOptions = eBSOptions; } /** ** Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain. *
* * @return Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain. */ public EBSOptions getEBSOptions() { return this.eBSOptions; } /** ** Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain. *
* * @param eBSOptions * Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDomainRequest withEBSOptions(EBSOptions eBSOptions) { setEBSOptions(eBSOptions); return this; } /** ** Identity and Access Management (IAM) policy document specifying the access policies for the new domain. *
* * @param accessPolicies * Identity and Access Management (IAM) policy document specifying the access policies for the new domain. */ public void setAccessPolicies(String accessPolicies) { this.accessPolicies = accessPolicies; } /** ** Identity and Access Management (IAM) policy document specifying the access policies for the new domain. *
* * @return Identity and Access Management (IAM) policy document specifying the access policies for the new domain. */ public String getAccessPolicies() { return this.accessPolicies; } /** ** Identity and Access Management (IAM) policy document specifying the access policies for the new domain. *
* * @param accessPolicies * Identity and Access Management (IAM) policy document specifying the access policies for the new domain. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDomainRequest withAccessPolicies(String accessPolicies) { setAccessPolicies(accessPolicies); return this; } /** ** DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes. *
* * @param snapshotOptions * DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes. */ public void setSnapshotOptions(SnapshotOptions snapshotOptions) { this.snapshotOptions = snapshotOptions; } /** ** DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes. *
* * @return DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes. */ public SnapshotOptions getSnapshotOptions() { return this.snapshotOptions; } /** ** DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes. *
* * @param snapshotOptions * DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDomainRequest withSnapshotOptions(SnapshotOptions snapshotOptions) { setSnapshotOptions(snapshotOptions); return this; } /** ** 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. *
* * @param 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. */ public void setVPCOptions(VPCOptions vPCOptions) { this.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. *
* * @return 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. */ public VPCOptions getVPCOptions() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDomainRequest withVPCOptions(VPCOptions vPCOptions) { setVPCOptions(vPCOptions); return this; } /** ** Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon * Cognito authentication for OpenSearch Dashboards. *
* * @param cognitoOptions * Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring * Amazon Cognito authentication for OpenSearch Dashboards. */ public void setCognitoOptions(CognitoOptions cognitoOptions) { this.cognitoOptions = cognitoOptions; } /** ** Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon * Cognito authentication for OpenSearch Dashboards. *
* * @return Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring * Amazon Cognito authentication for OpenSearch Dashboards. */ public CognitoOptions getCognitoOptions() { return this.cognitoOptions; } /** ** Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon * Cognito authentication for OpenSearch Dashboards. *
* * @param cognitoOptions * Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring * Amazon Cognito authentication for OpenSearch Dashboards. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDomainRequest withCognitoOptions(CognitoOptions cognitoOptions) { setCognitoOptions(cognitoOptions); return this; } /** ** Key-value pairs to enable encryption at rest. *
* * @param encryptionAtRestOptions * Key-value pairs to enable encryption at rest. */ public void setEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions) { this.encryptionAtRestOptions = encryptionAtRestOptions; } /** ** Key-value pairs to enable encryption at rest. *
* * @return Key-value pairs to enable encryption at rest. */ public EncryptionAtRestOptions getEncryptionAtRestOptions() { return this.encryptionAtRestOptions; } /** ** Key-value pairs to enable encryption at rest. *
* * @param encryptionAtRestOptions * Key-value pairs to enable encryption at rest. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDomainRequest withEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions) { setEncryptionAtRestOptions(encryptionAtRestOptions); return this; } /** ** Enables node-to-node encryption. *
* * @param nodeToNodeEncryptionOptions * Enables node-to-node encryption. */ public void setNodeToNodeEncryptionOptions(NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions) { this.nodeToNodeEncryptionOptions = nodeToNodeEncryptionOptions; } /** ** Enables node-to-node encryption. *
* * @return Enables node-to-node encryption. */ public NodeToNodeEncryptionOptions getNodeToNodeEncryptionOptions() { return this.nodeToNodeEncryptionOptions; } /** ** Enables node-to-node encryption. *
* * @param nodeToNodeEncryptionOptions * Enables node-to-node encryption. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDomainRequest withNodeToNodeEncryptionOptions(NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions) { setNodeToNodeEncryptionOptions(nodeToNodeEncryptionOptions); return this; } /** ** 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. *
* * @return 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.
*/
public java.util.Map
* Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:
*
*
*
*
*
* For more information, see Advanced cluster parameters.
*
*
* "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.
*
* "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.
*/
public void setAdvancedOptions(java.util.Map
* Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:
*
*
*
*
*
* For more information, see Advanced cluster parameters.
*
*
* "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.
*
* "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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDomainRequest withAdvancedOptions(java.util.Map
* Key-value pairs to configure log publishing.
*
* Key-value pairs to configure log publishing.
*
* Key-value pairs to configure log publishing.
*
* Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
*
* Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
*
* Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
*
* Options for fine-grained access control.
*
* Options for fine-grained access control.
*
* Options for fine-grained access control.
*
* List of tags to add to the domain upon creation.
*
* List of tags to add to the domain upon creation.
*
* List of tags to add to the domain upon creation.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTagList(java.util.Collection)} or {@link #withTagList(java.util.Collection)} if you want to override
* the existing values.
*
* List of tags to add to the domain upon creation.
*
* Options for Auto-Tune.
*
* Options for Auto-Tune.
*
* Options for Auto-Tune.
*
* 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.
*
* 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.
*
* 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.
*
* Software update options for the domain.
*
* Software update options for the domain.
*
* Software update options for the domain.
*