Class UpdateElasticsearchDomainConfigRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.elasticsearch.model.ElasticsearchRequest
software.amazon.awssdk.services.elasticsearch.model.UpdateElasticsearchDomainConfigRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateElasticsearchDomainConfigRequest.Builder,UpdateElasticsearchDomainConfigRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateElasticsearchDomainConfigRequest extends ElasticsearchRequest implements ToCopyableBuilder<UpdateElasticsearchDomainConfigRequest.Builder,UpdateElasticsearchDomainConfigRequest>

Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the type and number of instances in the domain cluster.

  • Method Details

    • domainName

      public final String domainName()

      The name of the Elasticsearch domain that you are updating.

      Returns:
      The name of the Elasticsearch domain that you are updating.

    • elasticsearchClusterConfig

      public final ElasticsearchClusterConfig elasticsearchClusterConfig()

      The type and number of instances to instantiate for the domain cluster.

      Returns:
      The type and number of instances to instantiate for the domain cluster.

    • ebsOptions

      public final EBSOptions ebsOptions()

      Specify the type and size of the EBS volume that you want to use.

      Returns:
      Specify the type and size of the EBS volume that you want to use.

    • 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 VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

      Returns:
      Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

    • cognitoOptions

      public final CognitoOptions cognitoOptions()

      Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

      Returns:
      Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

    • 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()

      Modifies the advanced 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 Configuration Advanced Options 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:
      Modifies the advanced 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 Configuration Advanced Options for more information.

    • accessPolicies

      public final String accessPolicies()

      IAM access policy as a JSON-formatted string.

      Returns:
      IAM access policy as a JSON-formatted string.

    • logPublishingOptions

      public final Map<LogType,LogPublishingOption> logPublishingOptions()

      Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch 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 Elasticsearch 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 Elasticsearch 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 Elasticsearch log.

    • domainEndpointOptions

      public final DomainEndpointOptions domainEndpointOptions()

      Options to specify configuration that will be applied to the domain endpoint.

      Returns:
      Options to specify configuration that will be applied to the domain endpoint.

    • advancedSecurityOptions

      public final AdvancedSecurityOptionsInput advancedSecurityOptions()

      Specifies advanced security options.

      Returns:
      Specifies advanced security options.

    • nodeToNodeEncryptionOptions

      public final NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions()

      Specifies the NodeToNodeEncryptionOptions.

      Returns:
      Specifies the NodeToNodeEncryptionOptions.

    • encryptionAtRestOptions

      public final EncryptionAtRestOptions encryptionAtRestOptions()

      Specifies the Encryption At Rest Options.

      Returns:
      Specifies the Encryption At Rest Options.

    • autoTuneOptions

      public final AutoTuneOptions autoTuneOptions()

      Specifies Auto-Tune options.

      Returns:
      Specifies Auto-Tune options.

    • dryRun

      public final Boolean dryRun()

      This flag, when set to True, specifies whether the UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update.

      Returns:
      This flag, when set to True, specifies whether the UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update.

    • toBuilder

      public UpdateElasticsearchDomainConfigRequest.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<UpdateElasticsearchDomainConfigRequest.Builder,UpdateElasticsearchDomainConfigRequest>
      Specified by:
      toBuilder in class ElasticsearchRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateElasticsearchDomainConfigRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateElasticsearchDomainConfigRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.