UpdateDomainConfigRequest (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.UpdateDomainConfigRequest

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

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

Container for the request parameters to the UpdateDomain operation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateDomainConfigRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`accessPolicies()` Identity and Access Management (IAM) access policy as a JSON-formatted string.
`Map<String,String>`	`advancedOptions()` Key-value pairs to specify advanced configuration options.
`AdvancedSecurityOptionsInput`	`advancedSecurityOptions()` Options for fine-grained access control.
`AutoTuneOptions`	`autoTuneOptions()` Options for Auto-Tune.
`static UpdateDomainConfigRequest.Builder`	`builder()`
`ClusterConfig`	`clusterConfig()` Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.
`CognitoOptions`	`cognitoOptions()` Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
`DomainEndpointOptions`	`domainEndpointOptions()` Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
`String`	`domainName()` The name of the domain that you're updating.
`Boolean`	`dryRun()` This flag, when set to True, specifies whether the `UpdateDomain` request should return the results of a dry run analysis without actually applying the change.
`DryRunMode`	`dryRunMode()` The type of dry run to perform.
`String`	`dryRunModeAsString()` The type of dry run to perform.
`EBSOptions`	`ebsOptions()` The type and size of the EBS volume to attach to instances in the domain.
`EncryptionAtRestOptions`	`encryptionAtRestOptions()` Encryption at rest options for the 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.
`Map<LogType,LogPublishingOption>`	`logPublishingOptions()` Options to publish OpenSearch logs to Amazon CloudWatch Logs.
`Map<String,LogPublishingOption>`	`logPublishingOptionsAsStrings()` Options to publish OpenSearch logs to Amazon CloudWatch Logs.
`NodeToNodeEncryptionOptions`	`nodeToNodeEncryptionOptions()` Node-to-node encryption options for the domain.
`OffPeakWindowOptions`	`offPeakWindowOptions()` Off-peak window options for the domain.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateDomainConfigRequest.Builder>`	`serializableBuilderClass()`
`SnapshotOptions`	`snapshotOptions()` Option to set the time, in UTC format, for the daily automated snapshot.
`SoftwareUpdateOptions`	`softwareUpdateOptions()` Service software update options for the domain.
`UpdateDomainConfigRequest.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 domain that you're updating.
    
    Returns:
    
    The name of the domain that you're updating.
  - clusterConfig
```
public final ClusterConfig clusterConfig()
```
    Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.
    
    Returns:
    
    Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.
  - ebsOptions
```
public final EBSOptions ebsOptions()
```
    The type and size of the EBS volume to attach to instances in the domain.
    
    Returns:
    
    The type and size of the EBS volume to attach to instances in the domain.
  - snapshotOptions
```
public final SnapshotOptions snapshotOptions()
```
    Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.
    
    Returns:
    
    Option to set the time, in UTC format, for 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()
```
    Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
    
    Returns:
    
    Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
  - 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()
```
    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.
    For more information, see Advanced cluster parameters.
    
    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:
    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.
    
    For more information, see Advanced cluster parameters.
  - accessPolicies
```
public final String accessPolicies()
```
    Identity and Access Management (IAM) access policy as a JSON-formatted string.
    
    Returns:
    
    Identity and Access Management (IAM) access policy as a JSON-formatted string.
  - logPublishingOptions
```
public final Map<LogType,LogPublishingOption> logPublishingOptions()
```
    Options to publish OpenSearch logs to Amazon CloudWatch Logs.
    
    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:
    
    Options to publish OpenSearch logs to Amazon CloudWatch Logs.
  - 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()
```
    Options to publish OpenSearch logs to Amazon CloudWatch Logs.
    
    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:
    
    Options to publish OpenSearch logs to Amazon CloudWatch Logs.
  - encryptionAtRestOptions
```
public final EncryptionAtRestOptions encryptionAtRestOptions()
```
    Encryption at rest options for the domain.
    
    Returns:
    
    Encryption at rest options for the domain.
  - domainEndpointOptions
```
public final DomainEndpointOptions domainEndpointOptions()
```
    Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
    
    Returns:
    
    Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
  - nodeToNodeEncryptionOptions
```
public final NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions()
```
    Node-to-node encryption options for the domain.
    
    Returns:
    
    Node-to-node encryption options for the domain.
  - advancedSecurityOptions
```
public final AdvancedSecurityOptionsInput advancedSecurityOptions()
```
    Options for fine-grained access control.
    
    Returns:
    
    Options for fine-grained access control.
  - autoTuneOptions
```
public final AutoTuneOptions autoTuneOptions()
```
    Options for Auto-Tune.
    
    Returns:
    
    Options for Auto-Tune.
  - dryRun
```
public final Boolean dryRun()
```
    This flag, when set to True, specifies whether the UpdateDomain request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause.
    
    Returns:
    
    This flag, when set to True, specifies whether the UpdateDomain request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause.
  - dryRunMode
```
public final DryRunMode dryRunMode()
```
    The type of dry run to perform.
    - Basic only returns the type of deployment (blue/green or dynamic) that the update will cause.
    - Verbose runs an additional check to validate the changes you're making. For more information, see Validating a domain update.
    If the service returns an enum value that is not available in the current SDK version, dryRunMode will return DryRunMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dryRunModeAsString().
    Returns:
    The type of dry run to perform.
    
    Basic only returns the type of deployment (blue/green or dynamic) that the update will cause.
    
    Verbose runs an additional check to validate the changes you're making. For more information, see Validating a domain update.
    See Also:
    
    DryRunMode
  - dryRunModeAsString
```
public final String dryRunModeAsString()
```
    The type of dry run to perform.
    - Basic only returns the type of deployment (blue/green or dynamic) that the update will cause.
    - Verbose runs an additional check to validate the changes you're making. For more information, see Validating a domain update.
    If the service returns an enum value that is not available in the current SDK version, dryRunMode will return DryRunMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dryRunModeAsString().
    Returns:
    The type of dry run to perform.
    
    Basic only returns the type of deployment (blue/green or dynamic) that the update will cause.
    
    Verbose runs an additional check to validate the changes you're making. For more information, see Validating a domain update.
    See Also:
    
    DryRunMode
  - offPeakWindowOptions
```
public final OffPeakWindowOptions offPeakWindowOptions()
```
    Off-peak window options for the domain.
    
    Returns:
    
    Off-peak window options for the domain.
  - softwareUpdateOptions
```
public final SoftwareUpdateOptions softwareUpdateOptions()
```
    Service software update options for the domain.
    
    Returns:
    
    Service software update options for the domain.
  - toBuilder
```
public UpdateDomainConfigRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateDomainConfigRequest.Builder,UpdateDomainConfigRequest>
    
    Specified by:
    
    toBuilder in class OpenSearchRequest
  - builder
```
public static UpdateDomainConfigRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateDomainConfigRequest.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 UpdateDomainConfigRequest

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

clusterConfig

ebsOptions

snapshotOptions

vpcOptions

cognitoOptions

hasAdvancedOptions

advancedOptions

accessPolicies

logPublishingOptions

hasLogPublishingOptions

logPublishingOptionsAsStrings

encryptionAtRestOptions

domainEndpointOptions

nodeToNodeEncryptionOptions

advancedSecurityOptions

autoTuneOptions

dryRun

dryRunMode

dryRunModeAsString

offPeakWindowOptions

softwareUpdateOptions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields