Class UpdateDomainConfigRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateDomainConfigRequest.Builder,
UpdateDomainConfigRequest>
Container for the request parameters to the UpdateDomain
operation.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
Identity and Access Management (IAM) access policy as a JSON-formatted string.Key-value pairs to specify advanced configuration options.Options for fine-grained access control.final AutoTuneOptions
Options for Auto-Tune.builder()
final ClusterConfig
Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.final CognitoOptions
Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.final DomainEndpointOptions
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.final String
The name of the domain that you're updating.final Boolean
dryRun()
This flag, when set to True, specifies whether theUpdateDomain
request should return the results of a dry run analysis without actually applying the change.final DryRunMode
The type of dry run to perform.final String
The type of dry run to perform.final EBSOptions
The type and size of the EBS volume to attach to instances in the domain.final EncryptionAtRestOptions
Encryption at rest options for the domain.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AdvancedOptions property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LogPublishingOptions property.final IPAddressType
Specify either dual stack or IPv4 as your IP address type.final String
Specify either dual stack or IPv4 as your IP address type.final Map
<LogType, LogPublishingOption> Options to publish OpenSearch logs to Amazon CloudWatch Logs.final Map
<String, LogPublishingOption> Options to publish OpenSearch logs to Amazon CloudWatch Logs.Node-to-node encryption options for the domain.final OffPeakWindowOptions
Off-peak window options for the domain.static Class
<? extends UpdateDomainConfigRequest.Builder> final SnapshotOptions
Option to set the time, in UTC format, for the daily automated snapshot.final SoftwareUpdateOptions
Service software update options for the domain.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
domainName
The name of the domain that you're updating.
- Returns:
- The name of the domain that you're updating.
-
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
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
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
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
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 theisEmpty()
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
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 aTooManyClauses
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 aTooManyClauses
error.
For more information, see Advanced cluster parameters.
-
-
-
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
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 returnIPAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- 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
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 returnIPAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- 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
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 theisEmpty()
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
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
Encryption at rest options for the domain.
- Returns:
- Encryption at rest options for the domain.
-
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
Node-to-node encryption options for the domain.
- Returns:
- Node-to-node encryption options for the domain.
-
advancedSecurityOptions
Options for fine-grained access control.
- Returns:
- Options for fine-grained access control.
-
autoTuneOptions
Options for Auto-Tune.
- Returns:
- Options for Auto-Tune.
-
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
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 returnDryRunMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdryRunModeAsString()
.- 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
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 returnDryRunMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdryRunModeAsString()
.- 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
Off-peak window options for the domain.
- Returns:
- Off-peak window options for the domain.
-
softwareUpdateOptions
Service software update options for the domain.
- Returns:
- Service software update options for the domain.
-
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 interfaceToCopyableBuilder<UpdateDomainConfigRequest.Builder,
UpdateDomainConfigRequest> - Specified by:
toBuilder
in classOpenSearchRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-