DomainConfig (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.opensearch.model.DomainConfig

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The configuration of a domain.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

DomainConfig()

Constructors
Constructor and Description
`DomainConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DomainConfig`	`clone()`
`boolean`	`equals(Object obj)`
`AccessPoliciesStatus`	`getAccessPolicies()` IAM access policy as a JSON-formatted string.
`AdvancedOptionsStatus`	`getAdvancedOptions()` The `AdvancedOptions` for the domain.
`AdvancedSecurityOptionsStatus`	`getAdvancedSecurityOptions()` Specifies `AdvancedSecurityOptions` for the domain.
`AutoTuneOptionsStatus`	`getAutoTuneOptions()` Specifies `AutoTuneOptions` for the domain.
`ChangeProgressDetails`	`getChangeProgressDetails()` Specifies change details of the domain configuration change.
`ClusterConfigStatus`	`getClusterConfig()` The `ClusterConfig` for the domain.
`CognitoOptionsStatus`	`getCognitoOptions()` The `CognitoOptions` for the specified domain.
`DomainEndpointOptionsStatus`	`getDomainEndpointOptions()` The `DomainEndpointOptions` for the domain.
`EBSOptionsStatus`	`getEBSOptions()` The `EBSOptions` for the domain.
`EncryptionAtRestOptionsStatus`	`getEncryptionAtRestOptions()` The `EncryptionAtRestOptions` for the domain.
`VersionStatus`	`getEngineVersion()` String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.
`LogPublishingOptionsStatus`	`getLogPublishingOptions()` Log publishing options for the given domain.
`NodeToNodeEncryptionOptionsStatus`	`getNodeToNodeEncryptionOptions()` The `NodeToNodeEncryptionOptions` for the domain.
`SnapshotOptionsStatus`	`getSnapshotOptions()` The `SnapshotOptions` for the domain.
`VPCDerivedInfoStatus`	`getVPCOptions()` The `VPCOptions` for the specified domain.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAccessPolicies(AccessPoliciesStatus accessPolicies)` IAM access policy as a JSON-formatted string.
`void`	`setAdvancedOptions(AdvancedOptionsStatus advancedOptions)` The `AdvancedOptions` for the domain.
`void`	`setAdvancedSecurityOptions(AdvancedSecurityOptionsStatus advancedSecurityOptions)` Specifies `AdvancedSecurityOptions` for the domain.
`void`	`setAutoTuneOptions(AutoTuneOptionsStatus autoTuneOptions)` Specifies `AutoTuneOptions` for the domain.
`void`	`setChangeProgressDetails(ChangeProgressDetails changeProgressDetails)` Specifies change details of the domain configuration change.
`void`	`setClusterConfig(ClusterConfigStatus clusterConfig)` The `ClusterConfig` for the domain.
`void`	`setCognitoOptions(CognitoOptionsStatus cognitoOptions)` The `CognitoOptions` for the specified domain.
`void`	`setDomainEndpointOptions(DomainEndpointOptionsStatus domainEndpointOptions)` The `DomainEndpointOptions` for the domain.
`void`	`setEBSOptions(EBSOptionsStatus eBSOptions)` The `EBSOptions` for the domain.
`void`	`setEncryptionAtRestOptions(EncryptionAtRestOptionsStatus encryptionAtRestOptions)` The `EncryptionAtRestOptions` for the domain.
`void`	`setEngineVersion(VersionStatus engineVersion)` String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.
`void`	`setLogPublishingOptions(LogPublishingOptionsStatus logPublishingOptions)` Log publishing options for the given domain.
`void`	`setNodeToNodeEncryptionOptions(NodeToNodeEncryptionOptionsStatus nodeToNodeEncryptionOptions)` The `NodeToNodeEncryptionOptions` for the domain.
`void`	`setSnapshotOptions(SnapshotOptionsStatus snapshotOptions)` The `SnapshotOptions` for the domain.
`void`	`setVPCOptions(VPCDerivedInfoStatus vPCOptions)` The `VPCOptions` for the specified domain.
`String`	`toString()` Returns a string representation of this object.
`DomainConfig`	`withAccessPolicies(AccessPoliciesStatus accessPolicies)` IAM access policy as a JSON-formatted string.
`DomainConfig`	`withAdvancedOptions(AdvancedOptionsStatus advancedOptions)` The `AdvancedOptions` for the domain.
`DomainConfig`	`withAdvancedSecurityOptions(AdvancedSecurityOptionsStatus advancedSecurityOptions)` Specifies `AdvancedSecurityOptions` for the domain.
`DomainConfig`	`withAutoTuneOptions(AutoTuneOptionsStatus autoTuneOptions)` Specifies `AutoTuneOptions` for the domain.
`DomainConfig`	`withChangeProgressDetails(ChangeProgressDetails changeProgressDetails)` Specifies change details of the domain configuration change.
`DomainConfig`	`withClusterConfig(ClusterConfigStatus clusterConfig)` The `ClusterConfig` for the domain.
`DomainConfig`	`withCognitoOptions(CognitoOptionsStatus cognitoOptions)` The `CognitoOptions` for the specified domain.
`DomainConfig`	`withDomainEndpointOptions(DomainEndpointOptionsStatus domainEndpointOptions)` The `DomainEndpointOptions` for the domain.
`DomainConfig`	`withEBSOptions(EBSOptionsStatus eBSOptions)` The `EBSOptions` for the domain.
`DomainConfig`	`withEncryptionAtRestOptions(EncryptionAtRestOptionsStatus encryptionAtRestOptions)` The `EncryptionAtRestOptions` for the domain.
`DomainConfig`	`withEngineVersion(VersionStatus engineVersion)` String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.
`DomainConfig`	`withLogPublishingOptions(LogPublishingOptionsStatus logPublishingOptions)` Log publishing options for the given domain.
`DomainConfig`	`withNodeToNodeEncryptionOptions(NodeToNodeEncryptionOptionsStatus nodeToNodeEncryptionOptions)` The `NodeToNodeEncryptionOptions` for the domain.
`DomainConfig`	`withSnapshotOptions(SnapshotOptionsStatus snapshotOptions)` The `SnapshotOptions` for the domain.
`DomainConfig`	`withVPCOptions(VPCDerivedInfoStatus vPCOptions)` The `VPCOptions` for the specified domain.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DomainConfig
```
public DomainConfig()
```
- Method Detail
  - setEngineVersion
```
public void setEngineVersion(VersionStatus engineVersion)
```
    String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.
    
    Parameters:
    
    engineVersion - String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.
  - getEngineVersion
```
public VersionStatus getEngineVersion()
```
    String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.
    
    Returns:
    
    String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.
  - withEngineVersion
```
public DomainConfig withEngineVersion(VersionStatus engineVersion)
```
    String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.
    
    Parameters:
    
    engineVersion - String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClusterConfig
```
public void setClusterConfig(ClusterConfigStatus clusterConfig)
```
    The ClusterConfig for the domain.
    
    Parameters:
    
    clusterConfig - The ClusterConfig for the domain.
  - getClusterConfig
```
public ClusterConfigStatus getClusterConfig()
```
    The ClusterConfig for the domain.
    
    Returns:
    
    The ClusterConfig for the domain.
  - withClusterConfig
```
public DomainConfig withClusterConfig(ClusterConfigStatus clusterConfig)
```
    The ClusterConfig for the domain.
    
    Parameters:
    
    clusterConfig - The ClusterConfig for the domain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEBSOptions
```
public void setEBSOptions(EBSOptionsStatus eBSOptions)
```
    The EBSOptions for the domain.
    
    Parameters:
    
    eBSOptions - The EBSOptions for the domain.
  - getEBSOptions
```
public EBSOptionsStatus getEBSOptions()
```
    The EBSOptions for the domain.
    
    Returns:
    
    The EBSOptions for the domain.
  - withEBSOptions
```
public DomainConfig withEBSOptions(EBSOptionsStatus eBSOptions)
```
    The EBSOptions for the domain.
    
    Parameters:
    
    eBSOptions - The EBSOptions for the domain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccessPolicies
```
public void setAccessPolicies(AccessPoliciesStatus accessPolicies)
```
    IAM access policy as a JSON-formatted string.
    
    Parameters:
    
    accessPolicies - IAM access policy as a JSON-formatted string.
  - getAccessPolicies
```
public AccessPoliciesStatus getAccessPolicies()
```
    IAM access policy as a JSON-formatted string.
    
    Returns:
    
    IAM access policy as a JSON-formatted string.
  - withAccessPolicies
```
public DomainConfig withAccessPolicies(AccessPoliciesStatus 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.
  - setSnapshotOptions
```
public void setSnapshotOptions(SnapshotOptionsStatus snapshotOptions)
```
    The SnapshotOptions for the domain.
    
    Parameters:
    
    snapshotOptions - The SnapshotOptions for the domain.
  - getSnapshotOptions
```
public SnapshotOptionsStatus getSnapshotOptions()
```
    The SnapshotOptions for the domain.
    
    Returns:
    
    The SnapshotOptions for the domain.
  - withSnapshotOptions
```
public DomainConfig withSnapshotOptions(SnapshotOptionsStatus snapshotOptions)
```
    The SnapshotOptions for the domain.
    
    Parameters:
    
    snapshotOptions - The SnapshotOptions for the domain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVPCOptions
```
public void setVPCOptions(VPCDerivedInfoStatus vPCOptions)
```
    The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
    
    Parameters:
    
    vPCOptions - The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
  - getVPCOptions
```
public VPCDerivedInfoStatus getVPCOptions()
```
    The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
    
    Returns:
    
    The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
  - withVPCOptions
```
public DomainConfig withVPCOptions(VPCDerivedInfoStatus vPCOptions)
```
    The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
    
    Parameters:
    
    vPCOptions - The VPCOptions for the specified domain. 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(CognitoOptionsStatus cognitoOptions)
```
    The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
    
    Parameters:
    
    cognitoOptions - The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
  - getCognitoOptions
```
public CognitoOptionsStatus getCognitoOptions()
```
    The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
    
    Returns:
    
    The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
  - withCognitoOptions
```
public DomainConfig withCognitoOptions(CognitoOptionsStatus cognitoOptions)
```
    The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
    
    Parameters:
    
    cognitoOptions - The CognitoOptions for the specified domain. 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.
  - setEncryptionAtRestOptions
```
public void setEncryptionAtRestOptions(EncryptionAtRestOptionsStatus encryptionAtRestOptions)
```
    The EncryptionAtRestOptions for the domain.
    
    Parameters:
    
    encryptionAtRestOptions - The EncryptionAtRestOptions for the domain.
  - getEncryptionAtRestOptions
```
public EncryptionAtRestOptionsStatus getEncryptionAtRestOptions()
```
    The EncryptionAtRestOptions for the domain.
    
    Returns:
    
    The EncryptionAtRestOptions for the domain.
  - withEncryptionAtRestOptions
```
public DomainConfig withEncryptionAtRestOptions(EncryptionAtRestOptionsStatus encryptionAtRestOptions)
```
    The EncryptionAtRestOptions for the domain.
    
    Parameters:
    
    encryptionAtRestOptions - The EncryptionAtRestOptions for the domain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNodeToNodeEncryptionOptions
```
public void setNodeToNodeEncryptionOptions(NodeToNodeEncryptionOptionsStatus nodeToNodeEncryptionOptions)
```
    The NodeToNodeEncryptionOptions for the domain.
    
    Parameters:
    
    nodeToNodeEncryptionOptions - The NodeToNodeEncryptionOptions for the domain.
  - getNodeToNodeEncryptionOptions
```
public NodeToNodeEncryptionOptionsStatus getNodeToNodeEncryptionOptions()
```
    The NodeToNodeEncryptionOptions for the domain.
    
    Returns:
    
    The NodeToNodeEncryptionOptions for the domain.
  - withNodeToNodeEncryptionOptions
```
public DomainConfig withNodeToNodeEncryptionOptions(NodeToNodeEncryptionOptionsStatus nodeToNodeEncryptionOptions)
```
    The NodeToNodeEncryptionOptions for the domain.
    
    Parameters:
    
    nodeToNodeEncryptionOptions - The NodeToNodeEncryptionOptions for the domain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAdvancedOptions
```
public void setAdvancedOptions(AdvancedOptionsStatus advancedOptions)
```
    The AdvancedOptions for the domain. See Advanced options for more information.
    
    Parameters:
    
    advancedOptions - The AdvancedOptions for the domain. See Advanced options for more information.
  - getAdvancedOptions
```
public AdvancedOptionsStatus getAdvancedOptions()
```
    The AdvancedOptions for the domain. See Advanced options for more information.
    
    Returns:
    
    The AdvancedOptions for the domain. See Advanced options for more information.
  - withAdvancedOptions
```
public DomainConfig withAdvancedOptions(AdvancedOptionsStatus advancedOptions)
```
    The AdvancedOptions for the domain. See Advanced options for more information.
    
    Parameters:
    
    advancedOptions - The AdvancedOptions for the domain. See Advanced options for more information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLogPublishingOptions
```
public void setLogPublishingOptions(LogPublishingOptionsStatus logPublishingOptions)
```
    Log publishing options for the given domain.
    
    Parameters:
    
    logPublishingOptions - Log publishing options for the given domain.
  - getLogPublishingOptions
```
public LogPublishingOptionsStatus getLogPublishingOptions()
```
    Log publishing options for the given domain.
    
    Returns:
    
    Log publishing options for the given domain.
  - withLogPublishingOptions
```
public DomainConfig withLogPublishingOptions(LogPublishingOptionsStatus logPublishingOptions)
```
    Log publishing options for the given domain.
    
    Parameters:
    
    logPublishingOptions - Log publishing options for the given domain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDomainEndpointOptions
```
public void setDomainEndpointOptions(DomainEndpointOptionsStatus domainEndpointOptions)
```
    The DomainEndpointOptions for the domain.
    
    Parameters:
    
    domainEndpointOptions - The DomainEndpointOptions for the domain.
  - getDomainEndpointOptions
```
public DomainEndpointOptionsStatus getDomainEndpointOptions()
```
    The DomainEndpointOptions for the domain.
    
    Returns:
    
    The DomainEndpointOptions for the domain.
  - withDomainEndpointOptions
```
public DomainConfig withDomainEndpointOptions(DomainEndpointOptionsStatus domainEndpointOptions)
```
    The DomainEndpointOptions for the domain.
    
    Parameters:
    
    domainEndpointOptions - The DomainEndpointOptions for the domain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAdvancedSecurityOptions
```
public void setAdvancedSecurityOptions(AdvancedSecurityOptionsStatus advancedSecurityOptions)
```
    Specifies AdvancedSecurityOptions for the domain.
    
    Parameters:
    
    advancedSecurityOptions - Specifies AdvancedSecurityOptions for the domain.
  - getAdvancedSecurityOptions
```
public AdvancedSecurityOptionsStatus getAdvancedSecurityOptions()
```
    Specifies AdvancedSecurityOptions for the domain.
    
    Returns:
    
    Specifies AdvancedSecurityOptions for the domain.
  - withAdvancedSecurityOptions
```
public DomainConfig withAdvancedSecurityOptions(AdvancedSecurityOptionsStatus advancedSecurityOptions)
```
    Specifies AdvancedSecurityOptions for the domain.
    
    Parameters:
    
    advancedSecurityOptions - Specifies AdvancedSecurityOptions for the domain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAutoTuneOptions
```
public void setAutoTuneOptions(AutoTuneOptionsStatus autoTuneOptions)
```
    Specifies AutoTuneOptions for the domain.
    
    Parameters:
    
    autoTuneOptions - Specifies AutoTuneOptions for the domain.
  - getAutoTuneOptions
```
public AutoTuneOptionsStatus getAutoTuneOptions()
```
    Specifies AutoTuneOptions for the domain.
    
    Returns:
    
    Specifies AutoTuneOptions for the domain.
  - withAutoTuneOptions
```
public DomainConfig withAutoTuneOptions(AutoTuneOptionsStatus autoTuneOptions)
```
    Specifies AutoTuneOptions for the domain.
    
    Parameters:
    
    autoTuneOptions - Specifies AutoTuneOptions for the domain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setChangeProgressDetails
```
public void setChangeProgressDetails(ChangeProgressDetails changeProgressDetails)
```
    Specifies change details of the domain configuration change.
    
    Parameters:
    
    changeProgressDetails - Specifies change details of the domain configuration change.
  - getChangeProgressDetails
```
public ChangeProgressDetails getChangeProgressDetails()
```
    Specifies change details of the domain configuration change.
    
    Returns:
    
    Specifies change details of the domain configuration change.
  - withChangeProgressDetails
```
public DomainConfig withChangeProgressDetails(ChangeProgressDetails changeProgressDetails)
```
    Specifies change details of the domain configuration change.
    
    Parameters:
    
    changeProgressDetails - Specifies change details of the domain configuration change.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 DomainConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class DomainConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DomainConfig

Method Detail

setEngineVersion

getEngineVersion

withEngineVersion

setClusterConfig

getClusterConfig

withClusterConfig

setEBSOptions

getEBSOptions

withEBSOptions

setAccessPolicies

getAccessPolicies

withAccessPolicies

setSnapshotOptions

getSnapshotOptions

withSnapshotOptions

setVPCOptions

getVPCOptions

withVPCOptions

setCognitoOptions

getCognitoOptions

withCognitoOptions

setEncryptionAtRestOptions

getEncryptionAtRestOptions

withEncryptionAtRestOptions

setNodeToNodeEncryptionOptions

getNodeToNodeEncryptionOptions

withNodeToNodeEncryptionOptions

setAdvancedOptions

getAdvancedOptions

withAdvancedOptions

setLogPublishingOptions

getLogPublishingOptions

withLogPublishingOptions

setDomainEndpointOptions

getDomainEndpointOptions

withDomainEndpointOptions

setAdvancedSecurityOptions

getAdvancedSecurityOptions

withAdvancedSecurityOptions

setAutoTuneOptions

getAutoTuneOptions

withAutoTuneOptions

setChangeProgressDetails

getChangeProgressDetails

withChangeProgressDetails

toString

equals

hashCode

clone

marshall