@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateDomainRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateDomainRequest() |
Modifier and Type | Method and Description |
---|---|
CreateDomainRequest |
addAdvancedOptionsEntry(String key,
String value)
Add a single AdvancedOptions entry
|
CreateDomainRequest |
addLogPublishingOptionsEntry(String key,
LogPublishingOption value)
Add a single LogPublishingOptions entry
|
CreateDomainRequest |
clearAdvancedOptionsEntries()
Removes all the entries added into AdvancedOptions.
|
CreateDomainRequest |
clearLogPublishingOptionsEntries()
Removes all the entries added into LogPublishingOptions.
|
CreateDomainRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getAccessPolicies()
IAM access policy as a JSON-formatted string.
|
Map<String,String> |
getAdvancedOptions()
Option to allow references to indices in an HTTP request body.
|
AdvancedSecurityOptionsInput |
getAdvancedSecurityOptions()
Specifies advanced security options.
|
AutoTuneOptionsInput |
getAutoTuneOptions()
Specifies Auto-Tune options.
|
ClusterConfig |
getClusterConfig()
Configuration options for a domain.
|
CognitoOptions |
getCognitoOptions()
Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication.
|
DomainEndpointOptions |
getDomainEndpointOptions()
Options to specify configurations that will be applied to the domain endpoint.
|
String |
getDomainName()
The name of the Amazon OpenSearch Service domain you're creating.
|
EBSOptions |
getEBSOptions()
Options to enable, disable, and specify the type and size of EBS storage volumes.
|
EncryptionAtRestOptions |
getEncryptionAtRestOptions()
Options for encryption of data at rest.
|
String |
getEngineVersion()
String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch
Service domain.
|
Map<String,LogPublishingOption> |
getLogPublishingOptions()
Map of
LogType and LogPublishingOption , each containing options to publish a given type
of OpenSearch log. |
NodeToNodeEncryptionOptions |
getNodeToNodeEncryptionOptions()
Node-to-node encryption options.
|
SnapshotOptions |
getSnapshotOptions()
Option to set time, in UTC format, of the daily automated snapshot.
|
List<Tag> |
getTagList()
A list of
Tag added during domain creation. |
VPCOptions |
getVPCOptions()
Options to specify the subnets and security groups for a VPC endpoint.
|
int |
hashCode() |
void |
setAccessPolicies(String accessPolicies)
IAM access policy as a JSON-formatted string.
|
void |
setAdvancedOptions(Map<String,String> advancedOptions)
Option to allow references to indices in an HTTP request body.
|
void |
setAdvancedSecurityOptions(AdvancedSecurityOptionsInput advancedSecurityOptions)
Specifies advanced security options.
|
void |
setAutoTuneOptions(AutoTuneOptionsInput autoTuneOptions)
Specifies Auto-Tune options.
|
void |
setClusterConfig(ClusterConfig clusterConfig)
Configuration options for a domain.
|
void |
setCognitoOptions(CognitoOptions cognitoOptions)
Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication.
|
void |
setDomainEndpointOptions(DomainEndpointOptions domainEndpointOptions)
Options to specify configurations that will be applied to the domain endpoint.
|
void |
setDomainName(String domainName)
The name of the Amazon OpenSearch Service domain you're creating.
|
void |
setEBSOptions(EBSOptions eBSOptions)
Options to enable, disable, and specify the type and size of EBS storage volumes.
|
void |
setEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions)
Options for encryption of data at rest.
|
void |
setEngineVersion(String engineVersion)
String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch
Service domain.
|
void |
setLogPublishingOptions(Map<String,LogPublishingOption> logPublishingOptions)
Map of
LogType and LogPublishingOption , each containing options to publish a given type
of OpenSearch log. |
void |
setNodeToNodeEncryptionOptions(NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions)
Node-to-node encryption options.
|
void |
setSnapshotOptions(SnapshotOptions snapshotOptions)
Option to set time, in UTC format, of the daily automated snapshot.
|
void |
setTagList(Collection<Tag> tagList)
A list of
Tag added during domain creation. |
void |
setVPCOptions(VPCOptions vPCOptions)
Options to specify the subnets and security groups for a VPC endpoint.
|
String |
toString()
Returns a string representation of this object.
|
CreateDomainRequest |
withAccessPolicies(String accessPolicies)
IAM access policy as a JSON-formatted string.
|
CreateDomainRequest |
withAdvancedOptions(Map<String,String> advancedOptions)
Option to allow references to indices in an HTTP request body.
|
CreateDomainRequest |
withAdvancedSecurityOptions(AdvancedSecurityOptionsInput advancedSecurityOptions)
Specifies advanced security options.
|
CreateDomainRequest |
withAutoTuneOptions(AutoTuneOptionsInput autoTuneOptions)
Specifies Auto-Tune options.
|
CreateDomainRequest |
withClusterConfig(ClusterConfig clusterConfig)
Configuration options for a domain.
|
CreateDomainRequest |
withCognitoOptions(CognitoOptions cognitoOptions)
Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication.
|
CreateDomainRequest |
withDomainEndpointOptions(DomainEndpointOptions domainEndpointOptions)
Options to specify configurations that will be applied to the domain endpoint.
|
CreateDomainRequest |
withDomainName(String domainName)
The name of the Amazon OpenSearch Service domain you're creating.
|
CreateDomainRequest |
withEBSOptions(EBSOptions eBSOptions)
Options to enable, disable, and specify the type and size of EBS storage volumes.
|
CreateDomainRequest |
withEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions)
Options for encryption of data at rest.
|
CreateDomainRequest |
withEngineVersion(String engineVersion)
String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch
Service domain.
|
CreateDomainRequest |
withLogPublishingOptions(Map<String,LogPublishingOption> logPublishingOptions)
Map of
LogType and LogPublishingOption , each containing options to publish a given type
of OpenSearch log. |
CreateDomainRequest |
withNodeToNodeEncryptionOptions(NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions)
Node-to-node encryption options.
|
CreateDomainRequest |
withSnapshotOptions(SnapshotOptions snapshotOptions)
Option to set time, in UTC format, of the daily automated snapshot.
|
CreateDomainRequest |
withTagList(Collection<Tag> tagList)
A list of
Tag added during domain creation. |
CreateDomainRequest |
withTagList(Tag... tagList)
A list of
Tag added during domain creation. |
CreateDomainRequest |
withVPCOptions(VPCOptions vPCOptions)
Options to specify the subnets and security groups for a VPC endpoint.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setDomainName(String domainName)
The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
domainName
- The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the
domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can
contain the following characters: a-z (lowercase), 0-9, and - (hyphen).public String getDomainName()
The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
public CreateDomainRequest withDomainName(String domainName)
The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
domainName
- The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the
domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can
contain the following characters: a-z (lowercase), 0-9, and - (hyphen).public void setEngineVersion(String engineVersion)
String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon 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 Amazon
OpenSearch Service domain. For example, "OpenSearch_1.0" or "Elasticsearch_7.9". For more information, see
Creating and managing Amazon OpenSearch Service domains .public String getEngineVersion()
String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain. For example, "OpenSearch_1.0" or "Elasticsearch_7.9". For more information, see Creating and managing Amazon OpenSearch Service domains .
public CreateDomainRequest withEngineVersion(String engineVersion)
String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon 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 Amazon
OpenSearch Service domain. For example, "OpenSearch_1.0" or "Elasticsearch_7.9". For more information, see
Creating and managing Amazon OpenSearch Service domains .public void setClusterConfig(ClusterConfig clusterConfig)
Configuration options for a domain. Specifies the instance type and number of instances in the domain.
clusterConfig
- Configuration options for a domain. Specifies the instance type and number of instances in the domain.public ClusterConfig getClusterConfig()
Configuration options for a domain. Specifies the instance type and number of instances in the domain.
public CreateDomainRequest withClusterConfig(ClusterConfig clusterConfig)
Configuration options for a domain. Specifies the instance type and number of instances in the domain.
clusterConfig
- Configuration options for a domain. Specifies the instance type and number of instances in the domain.public void setEBSOptions(EBSOptions eBSOptions)
Options to enable, disable, and specify the type and size of EBS storage volumes.
eBSOptions
- Options to enable, disable, and specify the type and size of EBS storage volumes.public EBSOptions getEBSOptions()
Options to enable, disable, and specify the type and size of EBS storage volumes.
public CreateDomainRequest withEBSOptions(EBSOptions eBSOptions)
Options to enable, disable, and specify the type and size of EBS storage volumes.
eBSOptions
- Options to enable, disable, and specify the type and size of EBS storage volumes.public void setAccessPolicies(String accessPolicies)
IAM access policy as a JSON-formatted string.
accessPolicies
- IAM access policy as a JSON-formatted string.public String getAccessPolicies()
IAM access policy as a JSON-formatted string.
public CreateDomainRequest withAccessPolicies(String accessPolicies)
IAM access policy as a JSON-formatted string.
accessPolicies
- IAM access policy as a JSON-formatted string.public void setSnapshotOptions(SnapshotOptions snapshotOptions)
Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.
snapshotOptions
- Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.public SnapshotOptions getSnapshotOptions()
Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.
public CreateDomainRequest withSnapshotOptions(SnapshotOptions snapshotOptions)
Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.
snapshotOptions
- Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.public void setVPCOptions(VPCOptions vPCOptions)
Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
vPCOptions
- Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .public VPCOptions getVPCOptions()
Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
public CreateDomainRequest withVPCOptions(VPCOptions vPCOptions)
Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
vPCOptions
- Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .public void setCognitoOptions(CognitoOptions cognitoOptions)
Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
cognitoOptions
- Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more
information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.public CognitoOptions getCognitoOptions()
Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
public CreateDomainRequest withCognitoOptions(CognitoOptions cognitoOptions)
Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
cognitoOptions
- Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more
information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.public void setEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions)
Options for encryption of data at rest.
encryptionAtRestOptions
- Options for encryption of data at rest.public EncryptionAtRestOptions getEncryptionAtRestOptions()
Options for encryption of data at rest.
public CreateDomainRequest withEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions)
Options for encryption of data at rest.
encryptionAtRestOptions
- Options for encryption of data at rest.public void setNodeToNodeEncryptionOptions(NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions)
Node-to-node encryption options.
nodeToNodeEncryptionOptions
- Node-to-node encryption options.public NodeToNodeEncryptionOptions getNodeToNodeEncryptionOptions()
Node-to-node encryption options.
public CreateDomainRequest withNodeToNodeEncryptionOptions(NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions)
Node-to-node encryption options.
nodeToNodeEncryptionOptions
- Node-to-node encryption options.public Map<String,String> getAdvancedOptions()
Option to allow references to indices in an HTTP request body. Must be false
when configuring access
to individual sub-resources. By default, the value is true
. See Advanced cluster parameters for more information.
false
when
configuring access to individual sub-resources. By default, the value is true
. See Advanced cluster parameters for more information.public void setAdvancedOptions(Map<String,String> advancedOptions)
Option to allow references to indices in an HTTP request body. Must be false
when configuring access
to individual sub-resources. By default, the value is true
. See Advanced cluster parameters for more information.
advancedOptions
- Option to allow references to indices in an HTTP request body. Must be false
when configuring
access to individual sub-resources. By default, the value is true
. See Advanced cluster parameters for more information.public CreateDomainRequest withAdvancedOptions(Map<String,String> advancedOptions)
Option to allow references to indices in an HTTP request body. Must be false
when configuring access
to individual sub-resources. By default, the value is true
. See Advanced cluster parameters for more information.
advancedOptions
- Option to allow references to indices in an HTTP request body. Must be false
when configuring
access to individual sub-resources. By default, the value is true
. See Advanced cluster parameters for more information.public CreateDomainRequest addAdvancedOptionsEntry(String key, String value)
public CreateDomainRequest clearAdvancedOptionsEntries()
public Map<String,LogPublishingOption> getLogPublishingOptions()
Map of LogType
and LogPublishingOption
, each containing options to publish a given type
of OpenSearch log.
LogType
and LogPublishingOption
, each containing options to publish a
given type of OpenSearch log.public void setLogPublishingOptions(Map<String,LogPublishingOption> logPublishingOptions)
Map of LogType
and LogPublishingOption
, each containing options to publish a given type
of OpenSearch log.
logPublishingOptions
- Map of LogType
and LogPublishingOption
, each containing options to publish a
given type of OpenSearch log.public CreateDomainRequest withLogPublishingOptions(Map<String,LogPublishingOption> logPublishingOptions)
Map of LogType
and LogPublishingOption
, each containing options to publish a given type
of OpenSearch log.
logPublishingOptions
- Map of LogType
and LogPublishingOption
, each containing options to publish a
given type of OpenSearch log.public CreateDomainRequest addLogPublishingOptionsEntry(String key, LogPublishingOption value)
public CreateDomainRequest clearLogPublishingOptionsEntries()
public void setDomainEndpointOptions(DomainEndpointOptions domainEndpointOptions)
Options to specify configurations that will be applied to the domain endpoint.
domainEndpointOptions
- Options to specify configurations that will be applied to the domain endpoint.public DomainEndpointOptions getDomainEndpointOptions()
Options to specify configurations that will be applied to the domain endpoint.
public CreateDomainRequest withDomainEndpointOptions(DomainEndpointOptions domainEndpointOptions)
Options to specify configurations that will be applied to the domain endpoint.
domainEndpointOptions
- Options to specify configurations that will be applied to the domain endpoint.public void setAdvancedSecurityOptions(AdvancedSecurityOptionsInput advancedSecurityOptions)
Specifies advanced security options.
advancedSecurityOptions
- Specifies advanced security options.public AdvancedSecurityOptionsInput getAdvancedSecurityOptions()
Specifies advanced security options.
public CreateDomainRequest withAdvancedSecurityOptions(AdvancedSecurityOptionsInput advancedSecurityOptions)
Specifies advanced security options.
advancedSecurityOptions
- Specifies advanced security options.public List<Tag> getTagList()
A list of Tag
added during domain creation.
Tag
added during domain creation.public void setTagList(Collection<Tag> tagList)
A list of Tag
added during domain creation.
tagList
- A list of Tag
added during domain creation.public CreateDomainRequest withTagList(Tag... tagList)
A list of Tag
added during domain creation.
NOTE: This method appends the values to the existing list (if any). Use
setTagList(java.util.Collection)
or withTagList(java.util.Collection)
if you want to override
the existing values.
tagList
- A list of Tag
added during domain creation.public CreateDomainRequest withTagList(Collection<Tag> tagList)
A list of Tag
added during domain creation.
tagList
- A list of Tag
added during domain creation.public void setAutoTuneOptions(AutoTuneOptionsInput autoTuneOptions)
Specifies Auto-Tune options.
autoTuneOptions
- Specifies Auto-Tune options.public AutoTuneOptionsInput getAutoTuneOptions()
Specifies Auto-Tune options.
public CreateDomainRequest withAutoTuneOptions(AutoTuneOptionsInput autoTuneOptions)
Specifies Auto-Tune options.
autoTuneOptions
- Specifies Auto-Tune options.public String toString()
toString
in class Object
Object.toString()
public CreateDomainRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()