Class UpdateDomainConfigRequest

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("software.amazon.awssdk:codegen") public final class UpdateDomainConfigRequest extends OpenSearchRequest implements ToCopyableBuilder<UpdateDomainConfigRequest.Builder,UpdateDomainConfigRequest>

Container for the request parameters to the UpdateDomain operation.

  • Method Details

    • 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.

    • ipAddressType

      public final IPAddressType ipAddressType()

      Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If your IP address type is currently set to dual stack, you can't change it.

      If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IPAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

      Returns:
      Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If your IP address type is currently set to dual stack, you can't change it.
      See Also:

    • ipAddressTypeAsString

      public final String ipAddressTypeAsString()

      Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If your IP address type is currently set to dual stack, you can't change it.

      If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IPAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

      Returns:
      Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If your IP address type is currently set to dual stack, you can't change it.
      See Also:

    • 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:

    • 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:

    • 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.

    • aimlOptions

      public final AIMLOptionsInput aimlOptions()

      Options for all machine learning features for the specified domain.

      Returns:
      Options for all machine learning features for the specified domain.

    • toBuilder

      public UpdateDomainConfigRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateDomainConfigRequest.Builder,UpdateDomainConfigRequest>
      Specified by:
      toBuilder in class OpenSearchRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.