com.amazonaws.services.opensearch.model

Class UpdateDomainConfigRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.opensearch.model.UpdateDomainConfigRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateDomainConfigRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

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

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateDomainConfigRequest()

Method Summary

Modifier and Type	Method and Description
UpdateDomainConfigRequest	addAdvancedOptionsEntry(String key, String value) Add a single AdvancedOptions entry
UpdateDomainConfigRequest	addLogPublishingOptionsEntry(String key, LogPublishingOption value) Add a single LogPublishingOptions entry
UpdateDomainConfigRequest	clearAdvancedOptionsEntries() Removes all the entries added into AdvancedOptions.
UpdateDomainConfigRequest	clearLogPublishingOptionsEntries() Removes all the entries added into LogPublishingOptions.
UpdateDomainConfigRequest	clone()
boolean	equals(Object obj)
String	getAccessPolicies() IAM access policy as a JSON-formatted string.
Map<String,String>	getAdvancedOptions() Modifies the advanced option to allow references to indices in an HTTP request body.
AdvancedSecurityOptionsInput	getAdvancedSecurityOptions() Specifies advanced security options.
AutoTuneOptions	getAutoTuneOptions() Specifies Auto-Tune options.
ClusterConfig	getClusterConfig() The type and number of instances to instantiate for the domain cluster.
CognitoOptions	getCognitoOptions() Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication.
DomainEndpointOptions	getDomainEndpointOptions() Options to specify configuration that will be applied to the domain endpoint.
String	getDomainName() The name of the domain you're updating.
Boolean	getDryRun() This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) without actually applying the change.
EBSOptions	getEBSOptions() Specify the type and size of the EBS volume to use.
EncryptionAtRestOptions	getEncryptionAtRestOptions() Specifies encryption of data at rest options.
Map<String,LogPublishingOption>	getLogPublishingOptions() Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.
NodeToNodeEncryptionOptions	getNodeToNodeEncryptionOptions() Specifies node-to-node encryption options.
SnapshotOptions	getSnapshotOptions() Option to set the time, in UTC format, for the daily automated snapshot.
VPCOptions	getVPCOptions() Options to specify the subnets and security groups for the VPC endpoint.
int	hashCode()
Boolean	isDryRun() This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) without actually applying the change.
void	setAccessPolicies(String accessPolicies) IAM access policy as a JSON-formatted string.
void	setAdvancedOptions(Map<String,String> advancedOptions) Modifies the advanced option to allow references to indices in an HTTP request body.
void	setAdvancedSecurityOptions(AdvancedSecurityOptionsInput advancedSecurityOptions) Specifies advanced security options.
void	setAutoTuneOptions(AutoTuneOptions autoTuneOptions) Specifies Auto-Tune options.
void	setClusterConfig(ClusterConfig clusterConfig) The type and number of instances to instantiate for the domain cluster.
void	setCognitoOptions(CognitoOptions cognitoOptions) Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication.
void	setDomainEndpointOptions(DomainEndpointOptions domainEndpointOptions) Options to specify configuration that will be applied to the domain endpoint.
void	setDomainName(String domainName) The name of the domain you're updating.
void	setDryRun(Boolean dryRun) This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) without actually applying the change.
void	setEBSOptions(EBSOptions eBSOptions) Specify the type and size of the EBS volume to use.
void	setEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions) Specifies encryption of data at rest options.
void	setLogPublishingOptions(Map<String,LogPublishingOption> logPublishingOptions) Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.
void	setNodeToNodeEncryptionOptions(NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions) Specifies node-to-node encryption options.
void	setSnapshotOptions(SnapshotOptions snapshotOptions) Option to set the time, in UTC format, for the daily automated snapshot.
void	setVPCOptions(VPCOptions vPCOptions) Options to specify the subnets and security groups for the VPC endpoint.
String	toString() Returns a string representation of this object.
UpdateDomainConfigRequest	withAccessPolicies(String accessPolicies) IAM access policy as a JSON-formatted string.
UpdateDomainConfigRequest	withAdvancedOptions(Map<String,String> advancedOptions) Modifies the advanced option to allow references to indices in an HTTP request body.
UpdateDomainConfigRequest	withAdvancedSecurityOptions(AdvancedSecurityOptionsInput advancedSecurityOptions) Specifies advanced security options.
UpdateDomainConfigRequest	withAutoTuneOptions(AutoTuneOptions autoTuneOptions) Specifies Auto-Tune options.
UpdateDomainConfigRequest	withClusterConfig(ClusterConfig clusterConfig) The type and number of instances to instantiate for the domain cluster.
UpdateDomainConfigRequest	withCognitoOptions(CognitoOptions cognitoOptions) Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication.
UpdateDomainConfigRequest	withDomainEndpointOptions(DomainEndpointOptions domainEndpointOptions) Options to specify configuration that will be applied to the domain endpoint.
UpdateDomainConfigRequest	withDomainName(String domainName) The name of the domain you're updating.
UpdateDomainConfigRequest	withDryRun(Boolean dryRun) This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) without actually applying the change.
UpdateDomainConfigRequest	withEBSOptions(EBSOptions eBSOptions) Specify the type and size of the EBS volume to use.
UpdateDomainConfigRequest	withEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions) Specifies encryption of data at rest options.
UpdateDomainConfigRequest	withLogPublishingOptions(Map<String,LogPublishingOption> logPublishingOptions) Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.
UpdateDomainConfigRequest	withNodeToNodeEncryptionOptions(NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions) Specifies node-to-node encryption options.
UpdateDomainConfigRequest	withSnapshotOptions(SnapshotOptions snapshotOptions) Option to set the time, in UTC format, for the daily automated snapshot.
UpdateDomainConfigRequest	withVPCOptions(VPCOptions vPCOptions) Options to specify the subnets and security groups for the VPC endpoint.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateDomainConfigRequest

public UpdateDomainConfigRequest()

Method Detail

setDomainName

public void setDomainName(String domainName)

The name of the domain you're updating.

Parameters:

domainName - The name of the domain you're updating.

getDomainName

public String getDomainName()

The name of the domain you're updating.

Returns:

The name of the domain you're updating.

withDomainName

public UpdateDomainConfigRequest withDomainName(String domainName)

The name of the domain you're updating.

Parameters:

domainName - The name of the domain you're updating.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClusterConfig

public void setClusterConfig(ClusterConfig clusterConfig)

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

Parameters:

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

getClusterConfig

public ClusterConfig getClusterConfig()

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.

withClusterConfig

public UpdateDomainConfigRequest withClusterConfig(ClusterConfig clusterConfig)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setEBSOptions

public void setEBSOptions(EBSOptions eBSOptions)

Specify the type and size of the EBS volume to use.

Parameters:

eBSOptions - Specify the type and size of the EBS volume to use.

getEBSOptions

public EBSOptions getEBSOptions()

Specify the type and size of the EBS volume to use.

Returns:

Specify the type and size of the EBS volume to use.

withEBSOptions

public UpdateDomainConfigRequest withEBSOptions(EBSOptions eBSOptions)

Specify the type and size of the EBS volume to use.

Parameters:

eBSOptions - Specify the type and size of the EBS volume to use.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSnapshotOptions

public void setSnapshotOptions(SnapshotOptions 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 is 0 hours.

getSnapshotOptions

public SnapshotOptions getSnapshotOptions()

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.

withSnapshotOptions

public UpdateDomainConfigRequest withSnapshotOptions(SnapshotOptions 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 is 0 hours.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVPCOptions

public void setVPCOptions(VPCOptions vPCOptions)

Options to specify the subnets and security groups for the 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 the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

getVPCOptions

public VPCOptions getVPCOptions()

Options to specify the subnets and security groups for the 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 the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

withVPCOptions

public UpdateDomainConfigRequest withVPCOptions(VPCOptions vPCOptions)

Options to specify the subnets and security groups for the 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 the 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.

setCognitoOptions

public void setCognitoOptions(CognitoOptions cognitoOptions)

Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

Parameters:

cognitoOptions - Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

getCognitoOptions

public CognitoOptions getCognitoOptions()

Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

Returns:

Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

withCognitoOptions

public UpdateDomainConfigRequest withCognitoOptions(CognitoOptions cognitoOptions)

Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

Parameters:

cognitoOptions - Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

Returns:

Returns a reference to this object so that method calls can be chained together.

getAdvancedOptions

public Map<String,String> getAdvancedOptions()

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 Advanced options for more information.

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 Advanced options for more information.

setAdvancedOptions

public void setAdvancedOptions(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 Advanced options for more information.

Parameters:

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 Advanced options for more information.

withAdvancedOptions

public UpdateDomainConfigRequest withAdvancedOptions(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 Advanced options for more information.

Parameters:

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 Advanced options for more information.

Returns:

Returns a reference to this object so that method calls can be chained together.

addAdvancedOptionsEntry

public UpdateDomainConfigRequest addAdvancedOptionsEntry(String key,
                                                         String value)

Add a single AdvancedOptions entry

See Also:

withAdvancedOptions(java.util.Map<java.lang.String, java.lang.String>)

clearAdvancedOptionsEntries

public UpdateDomainConfigRequest clearAdvancedOptionsEntries()

Removes all the entries added into AdvancedOptions.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAccessPolicies

public void setAccessPolicies(String accessPolicies)

IAM access policy as a JSON-formatted string.

Parameters:

accessPolicies - IAM access policy as a JSON-formatted string.

getAccessPolicies

public String getAccessPolicies()

IAM access policy as a JSON-formatted string.

Returns:

IAM access policy as a JSON-formatted string.

withAccessPolicies

public UpdateDomainConfigRequest withAccessPolicies(String accessPolicies)

IAM access policy as a JSON-formatted string.

Parameters:

accessPolicies - IAM access policy as a JSON-formatted string.

Returns:

Returns a reference to this object so that method calls can be chained together.

getLogPublishingOptions

public Map<String,LogPublishingOption> getLogPublishingOptions()

Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.

Returns:

Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.

setLogPublishingOptions

public void setLogPublishingOptions(Map<String,LogPublishingOption> logPublishingOptions)

Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.

Parameters:

logPublishingOptions - Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.

withLogPublishingOptions

public UpdateDomainConfigRequest withLogPublishingOptions(Map<String,LogPublishingOption> logPublishingOptions)

Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.

Parameters:

logPublishingOptions - Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.

Returns:

Returns a reference to this object so that method calls can be chained together.

addLogPublishingOptionsEntry

public UpdateDomainConfigRequest addLogPublishingOptionsEntry(String key,
                                                              LogPublishingOption value)

Add a single LogPublishingOptions entry

See Also:

withLogPublishingOptions(java.util.Map<java.lang.String, com.amazonaws.services.opensearch.model.LogPublishingOption>)

clearLogPublishingOptionsEntries

public UpdateDomainConfigRequest clearLogPublishingOptionsEntries()

Removes all the entries added into LogPublishingOptions.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEncryptionAtRestOptions

public void setEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions)

Specifies encryption of data at rest options.

Parameters:

encryptionAtRestOptions - Specifies encryption of data at rest options.

getEncryptionAtRestOptions

public EncryptionAtRestOptions getEncryptionAtRestOptions()

Specifies encryption of data at rest options.

Returns:

Specifies encryption of data at rest options.

withEncryptionAtRestOptions

public UpdateDomainConfigRequest withEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions)

Specifies encryption of data at rest options.

Parameters:

encryptionAtRestOptions - Specifies encryption of data at rest options.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDomainEndpointOptions

public void setDomainEndpointOptions(DomainEndpointOptions domainEndpointOptions)

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

Parameters:

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

getDomainEndpointOptions

public DomainEndpointOptions getDomainEndpointOptions()

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.

withDomainEndpointOptions

public UpdateDomainConfigRequest withDomainEndpointOptions(DomainEndpointOptions domainEndpointOptions)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setNodeToNodeEncryptionOptions

public void setNodeToNodeEncryptionOptions(NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions)

Specifies node-to-node encryption options.

Parameters:

nodeToNodeEncryptionOptions - Specifies node-to-node encryption options.

getNodeToNodeEncryptionOptions

public NodeToNodeEncryptionOptions getNodeToNodeEncryptionOptions()

Specifies node-to-node encryption options.

Returns:

Specifies node-to-node encryption options.

withNodeToNodeEncryptionOptions

public UpdateDomainConfigRequest withNodeToNodeEncryptionOptions(NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions)

Specifies node-to-node encryption options.

Parameters:

nodeToNodeEncryptionOptions - Specifies node-to-node encryption options.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAdvancedSecurityOptions

public void setAdvancedSecurityOptions(AdvancedSecurityOptionsInput advancedSecurityOptions)

Specifies advanced security options.

Parameters:

advancedSecurityOptions - Specifies advanced security options.

getAdvancedSecurityOptions

public AdvancedSecurityOptionsInput getAdvancedSecurityOptions()

Specifies advanced security options.

Returns:

Specifies advanced security options.

withAdvancedSecurityOptions

public UpdateDomainConfigRequest withAdvancedSecurityOptions(AdvancedSecurityOptionsInput advancedSecurityOptions)

Specifies advanced security options.

Parameters:

advancedSecurityOptions - Specifies advanced security options.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAutoTuneOptions

public void setAutoTuneOptions(AutoTuneOptions autoTuneOptions)

Specifies Auto-Tune options.

Parameters:

autoTuneOptions - Specifies Auto-Tune options.

getAutoTuneOptions

public AutoTuneOptions getAutoTuneOptions()

Specifies Auto-Tune options.

Returns:

Specifies Auto-Tune options.

withAutoTuneOptions

public UpdateDomainConfigRequest withAutoTuneOptions(AutoTuneOptions autoTuneOptions)

Specifies Auto-Tune options.

Parameters:

autoTuneOptions - Specifies Auto-Tune options.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDryRun

public void setDryRun(Boolean dryRun)

This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) without actually applying the change.

Parameters:

dryRun - This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) without actually applying the change.

getDryRun

public Boolean getDryRun()

This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) without actually applying the change.

Returns:

This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) without actually applying the change.

withDryRun

public UpdateDomainConfigRequest withDryRun(Boolean dryRun)

This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) without actually applying the change.

Parameters:

dryRun - This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) without actually applying the change.

Returns:

Returns a reference to this object so that method calls can be chained together.

isDryRun

public Boolean isDryRun()

This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) without actually applying the change.

Returns:

This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) without actually applying the change.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateDomainConfigRequest clone()

Overrides:

clone in class AmazonWebServiceRequest