CreateDomainRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.opensearch.model.OpenSearchRequest
    - - software.amazon.awssdk.services.opensearch.model.CreateDomainRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateDomainRequest.Builder,CreateDomainRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateDomainRequest
extends OpenSearchRequest
implements ToCopyableBuilder<CreateDomainRequest.Builder,CreateDomainRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateDomainRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateDomainRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`accessPolicies()` IAM access policy as a JSON-formatted string.
`Map<String,String>`	`advancedOptions()` Option to allow references to indices in an HTTP request body.
`AdvancedSecurityOptionsInput`	`advancedSecurityOptions()` Specifies advanced security options.
`AutoTuneOptionsInput`	`autoTuneOptions()` Specifies Auto-Tune options.
`static CreateDomainRequest.Builder`	`builder()`
`ClusterConfig`	`clusterConfig()` Configuration options for a domain.
`CognitoOptions`	`cognitoOptions()` Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication.
`DomainEndpointOptions`	`domainEndpointOptions()` Options to specify configurations that will be applied to the domain endpoint.
`String`	`domainName()` The name of the Amazon OpenSearch Service domain you're creating.
`EBSOptions`	`ebsOptions()` Options to enable, disable, and specify the type and size of EBS storage volumes.
`EncryptionAtRestOptions`	`encryptionAtRestOptions()` Options for encryption of data at rest.
`String`	`engineVersion()` String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdvancedOptions()` For responses, this returns true if the service returned a value for the AdvancedOptions property.
`int`	`hashCode()`
`boolean`	`hasLogPublishingOptions()` For responses, this returns true if the service returned a value for the LogPublishingOptions property.
`boolean`	`hasTagList()` For responses, this returns true if the service returned a value for the TagList property.
`Map<LogType,LogPublishingOption>`	`logPublishingOptions()` Map of `LogType` and `LogPublishingOption`, each containing options to publish a given type of OpenSearch log.
`Map<String,LogPublishingOption>`	`logPublishingOptionsAsStrings()` Map of `LogType` and `LogPublishingOption`, each containing options to publish a given type of OpenSearch log.
`NodeToNodeEncryptionOptions`	`nodeToNodeEncryptionOptions()` Node-to-node encryption options.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateDomainRequest.Builder>`	`serializableBuilderClass()`
`SnapshotOptions`	`snapshotOptions()` Option to set time, in UTC format, of the daily automated snapshot.
`List<Tag>`	`tagList()` A list of `Tag` added during domain creation.
`CreateDomainRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`VPCOptions`	`vpcOptions()` Options to specify the subnets and security groups for a VPC endpoint.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - domainName
```
public final 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).
    
    Returns:
    
    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).
  - engineVersion
```
public final 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 .
    
    Returns:
    
    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 .
  - clusterConfig
```
public final ClusterConfig clusterConfig()
```
    Configuration options for a domain. Specifies the instance type and number of instances in the domain.
    
    Returns:
    
    Configuration options for a domain. Specifies the instance type and number of instances in the domain.
  - ebsOptions
```
public final EBSOptions ebsOptions()
```
    Options to enable, disable, and specify the type and size of EBS storage volumes.
    
    Returns:
    
    Options to enable, disable, and specify the type and size of EBS storage volumes.
  - accessPolicies
```
public final String accessPolicies()
```
    IAM access policy as a JSON-formatted string.
    
    Returns:
    
    IAM access policy as a JSON-formatted string.
  - snapshotOptions
```
public final SnapshotOptions snapshotOptions()
```
    Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.
    
    Returns:
    
    Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.
  - vpcOptions
```
public final 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 .
    
    Returns:
    
    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 .
  - cognitoOptions
```
public final 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.
    
    Returns:
    
    Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
  - encryptionAtRestOptions
```
public final EncryptionAtRestOptions encryptionAtRestOptions()
```
    Options for encryption of data at rest.
    
    Returns:
    
    Options for encryption of data at rest.
  - nodeToNodeEncryptionOptions
```
public final NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions()
```
    Node-to-node encryption options.
    
    Returns:
    
    Node-to-node encryption options.
  - hasAdvancedOptions
```
public final boolean hasAdvancedOptions()
```
    For responses, this returns true if the service returned a value for the AdvancedOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - advancedOptions
```
public final 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdvancedOptions() method.
    
    Returns:
    
    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.
  - logPublishingOptions
```
public final Map<LogType,LogPublishingOption> logPublishingOptions()
```
    Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLogPublishingOptions() method.
    
    Returns:
    
    Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.
  - hasLogPublishingOptions
```
public final boolean hasLogPublishingOptions()
```
    For responses, this returns true if the service returned a value for the LogPublishingOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - logPublishingOptionsAsStrings
```
public final Map<String,LogPublishingOption> logPublishingOptionsAsStrings()
```
    Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLogPublishingOptions() method.
    
    Returns:
    
    Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.
  - domainEndpointOptions
```
public final DomainEndpointOptions domainEndpointOptions()
```
    Options to specify configurations that will be applied to the domain endpoint.
    
    Returns:
    
    Options to specify configurations that will be applied to the domain endpoint.
  - advancedSecurityOptions
```
public final AdvancedSecurityOptionsInput advancedSecurityOptions()
```
    Specifies advanced security options.
    
    Returns:
    
    Specifies advanced security options.
  - hasTagList
```
public final boolean hasTagList()
```
    For responses, this returns true if the service returned a value for the TagList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tagList
```
public final List<Tag> tagList()
```
    A list of Tag added during domain creation.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagList() method.
    
    Returns:
    
    A list of Tag added during domain creation.
  - autoTuneOptions
```
public final AutoTuneOptionsInput autoTuneOptions()
```
    Specifies Auto-Tune options.
    
    Returns:
    
    Specifies Auto-Tune options.
  - toBuilder
```
public CreateDomainRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateDomainRequest.Builder,CreateDomainRequest>
    
    Specified by:
    
    toBuilder in class OpenSearchRequest
  - builder
```
public static CreateDomainRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateDomainRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateDomainRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

domainName

engineVersion

clusterConfig

ebsOptions

accessPolicies

snapshotOptions

vpcOptions

cognitoOptions

encryptionAtRestOptions

nodeToNodeEncryptionOptions

hasAdvancedOptions

advancedOptions

logPublishingOptions

hasLogPublishingOptions

logPublishingOptionsAsStrings

domainEndpointOptions

advancedSecurityOptions

hasTagList

tagList

autoTuneOptions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields