Interface UpdateDomainConfigRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateDomainConfigRequest.Builder,
,UpdateDomainConfigRequest> OpenSearchRequest.Builder
,SdkBuilder<UpdateDomainConfigRequest.Builder,
,UpdateDomainConfigRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateDomainConfigRequest
-
Method Summary
Modifier and TypeMethodDescriptionaccessPolicies
(String accessPolicies) Identity and Access Management (IAM) access policy as a JSON-formatted string.advancedOptions
(Map<String, String> advancedOptions) Key-value pairs to specify advanced configuration options.advancedSecurityOptions
(Consumer<AdvancedSecurityOptionsInput.Builder> advancedSecurityOptions) Options for fine-grained access control.advancedSecurityOptions
(AdvancedSecurityOptionsInput advancedSecurityOptions) Options for fine-grained access control.autoTuneOptions
(Consumer<AutoTuneOptions.Builder> autoTuneOptions) Options for Auto-Tune.autoTuneOptions
(AutoTuneOptions autoTuneOptions) Options for Auto-Tune.clusterConfig
(Consumer<ClusterConfig.Builder> clusterConfig) Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.clusterConfig
(ClusterConfig clusterConfig) Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.cognitoOptions
(Consumer<CognitoOptions.Builder> cognitoOptions) Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.cognitoOptions
(CognitoOptions cognitoOptions) Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.domainEndpointOptions
(Consumer<DomainEndpointOptions.Builder> domainEndpointOptions) Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.domainEndpointOptions
(DomainEndpointOptions domainEndpointOptions) Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.domainName
(String domainName) The name of the domain that you're updating.This flag, when set to True, specifies whether theUpdateDomain
request should return the results of a dry run analysis without actually applying the change.dryRunMode
(String dryRunMode) The type of dry run to perform.dryRunMode
(DryRunMode dryRunMode) The type of dry run to perform.ebsOptions
(Consumer<EBSOptions.Builder> ebsOptions) The type and size of the EBS volume to attach to instances in the domain.ebsOptions
(EBSOptions ebsOptions) The type and size of the EBS volume to attach to instances in the domain.encryptionAtRestOptions
(Consumer<EncryptionAtRestOptions.Builder> encryptionAtRestOptions) Encryption at rest options for the domain.encryptionAtRestOptions
(EncryptionAtRestOptions encryptionAtRestOptions) Encryption at rest options for the domain.ipAddressType
(String ipAddressType) Specify either dual stack or IPv4 as your IP address type.ipAddressType
(IPAddressType ipAddressType) Specify either dual stack or IPv4 as your IP address type.logPublishingOptions
(Map<LogType, LogPublishingOption> logPublishingOptions) Options to publish OpenSearch logs to Amazon CloudWatch Logs.logPublishingOptionsWithStrings
(Map<String, LogPublishingOption> logPublishingOptions) Options to publish OpenSearch logs to Amazon CloudWatch Logs.nodeToNodeEncryptionOptions
(Consumer<NodeToNodeEncryptionOptions.Builder> nodeToNodeEncryptionOptions) Node-to-node encryption options for the domain.nodeToNodeEncryptionOptions
(NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions) Node-to-node encryption options for the domain.offPeakWindowOptions
(Consumer<OffPeakWindowOptions.Builder> offPeakWindowOptions) Off-peak window options for the domain.offPeakWindowOptions
(OffPeakWindowOptions offPeakWindowOptions) Off-peak window options for the domain.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.snapshotOptions
(Consumer<SnapshotOptions.Builder> snapshotOptions) Option to set the time, in UTC format, for the daily automated snapshot.snapshotOptions
(SnapshotOptions snapshotOptions) Option to set the time, in UTC format, for the daily automated snapshot.softwareUpdateOptions
(Consumer<SoftwareUpdateOptions.Builder> softwareUpdateOptions) Service software update options for the domain.softwareUpdateOptions
(SoftwareUpdateOptions softwareUpdateOptions) Service software update options for the domain.vpcOptions
(Consumer<VPCOptions.Builder> vpcOptions) Options to specify the subnets and security groups for a VPC endpoint.vpcOptions
(VPCOptions vpcOptions) Options to specify the subnets and security groups for a VPC endpoint.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.opensearch.model.OpenSearchRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
domainName
The name of the domain that you're updating.
- Parameters:
domainName
- The name of the domain that you're updating.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clusterConfig
Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.
- Parameters:
clusterConfig
- Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clusterConfig
default UpdateDomainConfigRequest.Builder clusterConfig(Consumer<ClusterConfig.Builder> clusterConfig) Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.
This is a convenience method that creates an instance of theClusterConfig.Builder
avoiding the need to create one manually viaClusterConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toclusterConfig(ClusterConfig)
.- Parameters:
clusterConfig
- a consumer that will call methods onClusterConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ebsOptions
The type and size of the EBS volume to attach to instances in the domain.
- Parameters:
ebsOptions
- The type and size of the EBS volume to attach to instances in the domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ebsOptions
The type and size of the EBS volume to attach to instances in the domain.
This is a convenience method that creates an instance of theEBSOptions.Builder
avoiding the need to create one manually viaEBSOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toebsOptions(EBSOptions)
.- Parameters:
ebsOptions
- a consumer that will call methods onEBSOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
snapshotOptions
Option to set the time, in UTC format, for the daily automated snapshot. Default value is
0
hours.- Parameters:
snapshotOptions
- Option to set the time, in UTC format, for the daily automated snapshot. Default value is0
hours.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotOptions
default UpdateDomainConfigRequest.Builder snapshotOptions(Consumer<SnapshotOptions.Builder> snapshotOptions) Option to set the time, in UTC format, for the daily automated snapshot. Default value is
This is a convenience method that creates an instance of the0
hours.SnapshotOptions.Builder
avoiding the need to create one manually viaSnapshotOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosnapshotOptions(SnapshotOptions)
.- Parameters:
snapshotOptions
- a consumer that will call methods onSnapshotOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theVPCOptions.Builder
avoiding the need to create one manually viaVPCOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovpcOptions(VPCOptions)
.- Parameters:
vpcOptions
- a consumer that will call methods onVPCOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
cognitoOptions
Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
- Parameters:
cognitoOptions
- Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cognitoOptions
default UpdateDomainConfigRequest.Builder cognitoOptions(Consumer<CognitoOptions.Builder> cognitoOptions) Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
This is a convenience method that creates an instance of theCognitoOptions.Builder
avoiding the need to create one manually viaCognitoOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocognitoOptions(CognitoOptions)
.- Parameters:
cognitoOptions
- a consumer that will call methods onCognitoOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
accessPolicies
Identity and Access Management (IAM) access policy as a JSON-formatted string.
- Parameters:
accessPolicies
- Identity and Access Management (IAM) access policy as a JSON-formatted string.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
logPublishingOptionsWithStrings
UpdateDomainConfigRequest.Builder logPublishingOptionsWithStrings(Map<String, LogPublishingOption> logPublishingOptions) Options to publish OpenSearch logs to Amazon CloudWatch Logs.
- Parameters:
logPublishingOptions
- Options to publish OpenSearch logs to Amazon CloudWatch Logs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logPublishingOptions
UpdateDomainConfigRequest.Builder logPublishingOptions(Map<LogType, LogPublishingOption> logPublishingOptions) Options to publish OpenSearch logs to Amazon CloudWatch Logs.
- Parameters:
logPublishingOptions
- Options to publish OpenSearch logs to Amazon CloudWatch Logs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionAtRestOptions
UpdateDomainConfigRequest.Builder encryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions) Encryption at rest options for the domain.
- Parameters:
encryptionAtRestOptions
- Encryption at rest options for the domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionAtRestOptions
default UpdateDomainConfigRequest.Builder encryptionAtRestOptions(Consumer<EncryptionAtRestOptions.Builder> encryptionAtRestOptions) Encryption at rest options for the domain.
This is a convenience method that creates an instance of theEncryptionAtRestOptions.Builder
avoiding the need to create one manually viaEncryptionAtRestOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toencryptionAtRestOptions(EncryptionAtRestOptions)
.- Parameters:
encryptionAtRestOptions
- a consumer that will call methods onEncryptionAtRestOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
domainEndpointOptions
UpdateDomainConfigRequest.Builder domainEndpointOptions(DomainEndpointOptions domainEndpointOptions) Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
- Parameters:
domainEndpointOptions
- Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domainEndpointOptions
default UpdateDomainConfigRequest.Builder domainEndpointOptions(Consumer<DomainEndpointOptions.Builder> domainEndpointOptions) Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
This is a convenience method that creates an instance of theDomainEndpointOptions.Builder
avoiding the need to create one manually viaDomainEndpointOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todomainEndpointOptions(DomainEndpointOptions)
.- Parameters:
domainEndpointOptions
- a consumer that will call methods onDomainEndpointOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
nodeToNodeEncryptionOptions
UpdateDomainConfigRequest.Builder nodeToNodeEncryptionOptions(NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions) Node-to-node encryption options for the domain.
- Parameters:
nodeToNodeEncryptionOptions
- Node-to-node encryption options for the domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nodeToNodeEncryptionOptions
default UpdateDomainConfigRequest.Builder nodeToNodeEncryptionOptions(Consumer<NodeToNodeEncryptionOptions.Builder> nodeToNodeEncryptionOptions) Node-to-node encryption options for the domain.
This is a convenience method that creates an instance of theNodeToNodeEncryptionOptions.Builder
avoiding the need to create one manually viaNodeToNodeEncryptionOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonodeToNodeEncryptionOptions(NodeToNodeEncryptionOptions)
.- Parameters:
nodeToNodeEncryptionOptions
- a consumer that will call methods onNodeToNodeEncryptionOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
advancedSecurityOptions
UpdateDomainConfigRequest.Builder advancedSecurityOptions(AdvancedSecurityOptionsInput advancedSecurityOptions) Options for fine-grained access control.
- Parameters:
advancedSecurityOptions
- Options for fine-grained access control.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
advancedSecurityOptions
default UpdateDomainConfigRequest.Builder advancedSecurityOptions(Consumer<AdvancedSecurityOptionsInput.Builder> advancedSecurityOptions) Options for fine-grained access control.
This is a convenience method that creates an instance of theAdvancedSecurityOptionsInput.Builder
avoiding the need to create one manually viaAdvancedSecurityOptionsInput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toadvancedSecurityOptions(AdvancedSecurityOptionsInput)
.- Parameters:
advancedSecurityOptions
- a consumer that will call methods onAdvancedSecurityOptionsInput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
autoTuneOptions
Options for Auto-Tune.
- Parameters:
autoTuneOptions
- Options for Auto-Tune.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoTuneOptions
default UpdateDomainConfigRequest.Builder autoTuneOptions(Consumer<AutoTuneOptions.Builder> autoTuneOptions) Options for Auto-Tune.
This is a convenience method that creates an instance of theAutoTuneOptions.Builder
avoiding the need to create one manually viaAutoTuneOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toautoTuneOptions(AutoTuneOptions)
.- Parameters:
autoTuneOptions
- a consumer that will call methods onAutoTuneOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
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. A dry run determines what type of deployment the update will cause.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
offPeakWindowOptions
Off-peak window options for the domain.
- Parameters:
offPeakWindowOptions
- Off-peak window options for the domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
offPeakWindowOptions
default UpdateDomainConfigRequest.Builder offPeakWindowOptions(Consumer<OffPeakWindowOptions.Builder> offPeakWindowOptions) Off-peak window options for the domain.
This is a convenience method that creates an instance of theOffPeakWindowOptions.Builder
avoiding the need to create one manually viaOffPeakWindowOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooffPeakWindowOptions(OffPeakWindowOptions)
.- Parameters:
offPeakWindowOptions
- a consumer that will call methods onOffPeakWindowOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
softwareUpdateOptions
UpdateDomainConfigRequest.Builder softwareUpdateOptions(SoftwareUpdateOptions softwareUpdateOptions) Service software update options for the domain.
- Parameters:
softwareUpdateOptions
- Service software update options for the domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
softwareUpdateOptions
default UpdateDomainConfigRequest.Builder softwareUpdateOptions(Consumer<SoftwareUpdateOptions.Builder> softwareUpdateOptions) Service software update options for the domain.
This is a convenience method that creates an instance of theSoftwareUpdateOptions.Builder
avoiding the need to create one manually viaSoftwareUpdateOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosoftwareUpdateOptions(SoftwareUpdateOptions)
.- Parameters:
softwareUpdateOptions
- a consumer that will call methods onSoftwareUpdateOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
UpdateDomainConfigRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateDomainConfigRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-