@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DomainConfig extends Object implements Serializable, Cloneable, StructuredPojo
Container for the configuration of an OpenSearch Service domain.
Constructor and Description |
---|
DomainConfig() |
Modifier and Type | Method and Description |
---|---|
DomainConfig |
clone() |
boolean |
equals(Object obj) |
AccessPoliciesStatus |
getAccessPolicies()
Specifies the access policies for the domain.
|
AdvancedOptionsStatus |
getAdvancedOptions()
Key-value pairs to specify advanced configuration options.
|
AdvancedSecurityOptionsStatus |
getAdvancedSecurityOptions()
Container for fine-grained access control settings for the domain.
|
AIMLOptionsStatus |
getAIMLOptions()
Container for parameters required to enable all machine learning features.
|
AutoTuneOptionsStatus |
getAutoTuneOptions()
Container for Auto-Tune settings for the domain.
|
ChangeProgressDetails |
getChangeProgressDetails()
Container for information about the progress of an existing configuration change.
|
ClusterConfigStatus |
getClusterConfig()
Container for the cluster configuration of a the domain.
|
CognitoOptionsStatus |
getCognitoOptions()
Container for Amazon Cognito options for the domain.
|
DomainEndpointOptionsStatus |
getDomainEndpointOptions()
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
|
EBSOptionsStatus |
getEBSOptions()
Container for EBS options configured for the domain.
|
EncryptionAtRestOptionsStatus |
getEncryptionAtRestOptions()
Key-value pairs to enable encryption at rest.
|
VersionStatus |
getEngineVersion()
The OpenSearch or Elasticsearch version that the domain is running.
|
IPAddressTypeStatus |
getIPAddressType()
Choose either dual stack or IPv4 as your IP address type.
|
LogPublishingOptionsStatus |
getLogPublishingOptions()
Key-value pairs to configure log publishing.
|
List<ModifyingProperties> |
getModifyingProperties()
Information about the domain properties that are currently being modified.
|
NodeToNodeEncryptionOptionsStatus |
getNodeToNodeEncryptionOptions()
Whether node-to-node encryption is enabled or disabled.
|
OffPeakWindowOptionsStatus |
getOffPeakWindowOptions()
Container for off-peak window options for the domain.
|
SnapshotOptionsStatus |
getSnapshotOptions()
DEPRECATED.
|
SoftwareUpdateOptionsStatus |
getSoftwareUpdateOptions()
Software update options for the domain.
|
VPCDerivedInfoStatus |
getVPCOptions()
The current VPC options for the domain and the status of any updates to their configuration.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAccessPolicies(AccessPoliciesStatus accessPolicies)
Specifies the access policies for the domain.
|
void |
setAdvancedOptions(AdvancedOptionsStatus advancedOptions)
Key-value pairs to specify advanced configuration options.
|
void |
setAdvancedSecurityOptions(AdvancedSecurityOptionsStatus advancedSecurityOptions)
Container for fine-grained access control settings for the domain.
|
void |
setAIMLOptions(AIMLOptionsStatus aIMLOptions)
Container for parameters required to enable all machine learning features.
|
void |
setAutoTuneOptions(AutoTuneOptionsStatus autoTuneOptions)
Container for Auto-Tune settings for the domain.
|
void |
setChangeProgressDetails(ChangeProgressDetails changeProgressDetails)
Container for information about the progress of an existing configuration change.
|
void |
setClusterConfig(ClusterConfigStatus clusterConfig)
Container for the cluster configuration of a the domain.
|
void |
setCognitoOptions(CognitoOptionsStatus cognitoOptions)
Container for Amazon Cognito options for the domain.
|
void |
setDomainEndpointOptions(DomainEndpointOptionsStatus domainEndpointOptions)
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
|
void |
setEBSOptions(EBSOptionsStatus eBSOptions)
Container for EBS options configured for the domain.
|
void |
setEncryptionAtRestOptions(EncryptionAtRestOptionsStatus encryptionAtRestOptions)
Key-value pairs to enable encryption at rest.
|
void |
setEngineVersion(VersionStatus engineVersion)
The OpenSearch or Elasticsearch version that the domain is running.
|
void |
setIPAddressType(IPAddressTypeStatus iPAddressType)
Choose either dual stack or IPv4 as your IP address type.
|
void |
setLogPublishingOptions(LogPublishingOptionsStatus logPublishingOptions)
Key-value pairs to configure log publishing.
|
void |
setModifyingProperties(Collection<ModifyingProperties> modifyingProperties)
Information about the domain properties that are currently being modified.
|
void |
setNodeToNodeEncryptionOptions(NodeToNodeEncryptionOptionsStatus nodeToNodeEncryptionOptions)
Whether node-to-node encryption is enabled or disabled.
|
void |
setOffPeakWindowOptions(OffPeakWindowOptionsStatus offPeakWindowOptions)
Container for off-peak window options for the domain.
|
void |
setSnapshotOptions(SnapshotOptionsStatus snapshotOptions)
DEPRECATED.
|
void |
setSoftwareUpdateOptions(SoftwareUpdateOptionsStatus softwareUpdateOptions)
Software update options for the domain.
|
void |
setVPCOptions(VPCDerivedInfoStatus vPCOptions)
The current VPC options for the domain and the status of any updates to their configuration.
|
String |
toString()
Returns a string representation of this object.
|
DomainConfig |
withAccessPolicies(AccessPoliciesStatus accessPolicies)
Specifies the access policies for the domain.
|
DomainConfig |
withAdvancedOptions(AdvancedOptionsStatus advancedOptions)
Key-value pairs to specify advanced configuration options.
|
DomainConfig |
withAdvancedSecurityOptions(AdvancedSecurityOptionsStatus advancedSecurityOptions)
Container for fine-grained access control settings for the domain.
|
DomainConfig |
withAIMLOptions(AIMLOptionsStatus aIMLOptions)
Container for parameters required to enable all machine learning features.
|
DomainConfig |
withAutoTuneOptions(AutoTuneOptionsStatus autoTuneOptions)
Container for Auto-Tune settings for the domain.
|
DomainConfig |
withChangeProgressDetails(ChangeProgressDetails changeProgressDetails)
Container for information about the progress of an existing configuration change.
|
DomainConfig |
withClusterConfig(ClusterConfigStatus clusterConfig)
Container for the cluster configuration of a the domain.
|
DomainConfig |
withCognitoOptions(CognitoOptionsStatus cognitoOptions)
Container for Amazon Cognito options for the domain.
|
DomainConfig |
withDomainEndpointOptions(DomainEndpointOptionsStatus domainEndpointOptions)
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
|
DomainConfig |
withEBSOptions(EBSOptionsStatus eBSOptions)
Container for EBS options configured for the domain.
|
DomainConfig |
withEncryptionAtRestOptions(EncryptionAtRestOptionsStatus encryptionAtRestOptions)
Key-value pairs to enable encryption at rest.
|
DomainConfig |
withEngineVersion(VersionStatus engineVersion)
The OpenSearch or Elasticsearch version that the domain is running.
|
DomainConfig |
withIPAddressType(IPAddressTypeStatus iPAddressType)
Choose either dual stack or IPv4 as your IP address type.
|
DomainConfig |
withLogPublishingOptions(LogPublishingOptionsStatus logPublishingOptions)
Key-value pairs to configure log publishing.
|
DomainConfig |
withModifyingProperties(Collection<ModifyingProperties> modifyingProperties)
Information about the domain properties that are currently being modified.
|
DomainConfig |
withModifyingProperties(ModifyingProperties... modifyingProperties)
Information about the domain properties that are currently being modified.
|
DomainConfig |
withNodeToNodeEncryptionOptions(NodeToNodeEncryptionOptionsStatus nodeToNodeEncryptionOptions)
Whether node-to-node encryption is enabled or disabled.
|
DomainConfig |
withOffPeakWindowOptions(OffPeakWindowOptionsStatus offPeakWindowOptions)
Container for off-peak window options for the domain.
|
DomainConfig |
withSnapshotOptions(SnapshotOptionsStatus snapshotOptions)
DEPRECATED.
|
DomainConfig |
withSoftwareUpdateOptions(SoftwareUpdateOptionsStatus softwareUpdateOptions)
Software update options for the domain.
|
DomainConfig |
withVPCOptions(VPCDerivedInfoStatus vPCOptions)
The current VPC options for the domain and the status of any updates to their configuration.
|
public void setEngineVersion(VersionStatus engineVersion)
The OpenSearch or Elasticsearch version that the domain is running.
engineVersion
- The OpenSearch or Elasticsearch version that the domain is running.public VersionStatus getEngineVersion()
The OpenSearch or Elasticsearch version that the domain is running.
public DomainConfig withEngineVersion(VersionStatus engineVersion)
The OpenSearch or Elasticsearch version that the domain is running.
engineVersion
- The OpenSearch or Elasticsearch version that the domain is running.public void setClusterConfig(ClusterConfigStatus clusterConfig)
Container for the cluster configuration of a the domain.
clusterConfig
- Container for the cluster configuration of a the domain.public ClusterConfigStatus getClusterConfig()
Container for the cluster configuration of a the domain.
public DomainConfig withClusterConfig(ClusterConfigStatus clusterConfig)
Container for the cluster configuration of a the domain.
clusterConfig
- Container for the cluster configuration of a the domain.public void setEBSOptions(EBSOptionsStatus eBSOptions)
Container for EBS options configured for the domain.
eBSOptions
- Container for EBS options configured for the domain.public EBSOptionsStatus getEBSOptions()
Container for EBS options configured for the domain.
public DomainConfig withEBSOptions(EBSOptionsStatus eBSOptions)
Container for EBS options configured for the domain.
eBSOptions
- Container for EBS options configured for the domain.public void setAccessPolicies(AccessPoliciesStatus accessPolicies)
Specifies the access policies for the domain.
accessPolicies
- Specifies the access policies for the domain.public AccessPoliciesStatus getAccessPolicies()
Specifies the access policies for the domain.
public DomainConfig withAccessPolicies(AccessPoliciesStatus accessPolicies)
Specifies the access policies for the domain.
accessPolicies
- Specifies the access policies for the domain.public void setIPAddressType(IPAddressTypeStatus iPAddressType)
Choose 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 you set your IP address type to dual stack, you can't change your address type later.
iPAddressType
- Choose 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 you set your IP address type to dual
stack, you can't change your address type later.public IPAddressTypeStatus getIPAddressType()
Choose 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 you set your IP address type to dual stack, you can't change your address type later.
public DomainConfig withIPAddressType(IPAddressTypeStatus iPAddressType)
Choose 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 you set your IP address type to dual stack, you can't change your address type later.
iPAddressType
- Choose 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 you set your IP address type to dual
stack, you can't change your address type later.public void setSnapshotOptions(SnapshotOptionsStatus snapshotOptions)
DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
snapshotOptions
- DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.public SnapshotOptionsStatus getSnapshotOptions()
DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
public DomainConfig withSnapshotOptions(SnapshotOptionsStatus snapshotOptions)
DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
snapshotOptions
- DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.public void setVPCOptions(VPCDerivedInfoStatus vPCOptions)
The current VPC options for the domain and the status of any updates to their configuration.
vPCOptions
- The current VPC options for the domain and the status of any updates to their configuration.public VPCDerivedInfoStatus getVPCOptions()
The current VPC options for the domain and the status of any updates to their configuration.
public DomainConfig withVPCOptions(VPCDerivedInfoStatus vPCOptions)
The current VPC options for the domain and the status of any updates to their configuration.
vPCOptions
- The current VPC options for the domain and the status of any updates to their configuration.public void setCognitoOptions(CognitoOptionsStatus cognitoOptions)
Container for Amazon Cognito options for the domain.
cognitoOptions
- Container for Amazon Cognito options for the domain.public CognitoOptionsStatus getCognitoOptions()
Container for Amazon Cognito options for the domain.
public DomainConfig withCognitoOptions(CognitoOptionsStatus cognitoOptions)
Container for Amazon Cognito options for the domain.
cognitoOptions
- Container for Amazon Cognito options for the domain.public void setEncryptionAtRestOptions(EncryptionAtRestOptionsStatus encryptionAtRestOptions)
Key-value pairs to enable encryption at rest.
encryptionAtRestOptions
- Key-value pairs to enable encryption at rest.public EncryptionAtRestOptionsStatus getEncryptionAtRestOptions()
Key-value pairs to enable encryption at rest.
public DomainConfig withEncryptionAtRestOptions(EncryptionAtRestOptionsStatus encryptionAtRestOptions)
Key-value pairs to enable encryption at rest.
encryptionAtRestOptions
- Key-value pairs to enable encryption at rest.public void setNodeToNodeEncryptionOptions(NodeToNodeEncryptionOptionsStatus nodeToNodeEncryptionOptions)
Whether node-to-node encryption is enabled or disabled.
nodeToNodeEncryptionOptions
- Whether node-to-node encryption is enabled or disabled.public NodeToNodeEncryptionOptionsStatus getNodeToNodeEncryptionOptions()
Whether node-to-node encryption is enabled or disabled.
public DomainConfig withNodeToNodeEncryptionOptions(NodeToNodeEncryptionOptionsStatus nodeToNodeEncryptionOptions)
Whether node-to-node encryption is enabled or disabled.
nodeToNodeEncryptionOptions
- Whether node-to-node encryption is enabled or disabled.public void setAdvancedOptions(AdvancedOptionsStatus advancedOptions)
Key-value pairs to specify advanced configuration options. For more information, see Advanced options.
advancedOptions
- Key-value pairs to specify advanced configuration options. For more information, see Advanced options.public AdvancedOptionsStatus getAdvancedOptions()
Key-value pairs to specify advanced configuration options. For more information, see Advanced options.
public DomainConfig withAdvancedOptions(AdvancedOptionsStatus advancedOptions)
Key-value pairs to specify advanced configuration options. For more information, see Advanced options.
advancedOptions
- Key-value pairs to specify advanced configuration options. For more information, see Advanced options.public void setLogPublishingOptions(LogPublishingOptionsStatus logPublishingOptions)
Key-value pairs to configure log publishing.
logPublishingOptions
- Key-value pairs to configure log publishing.public LogPublishingOptionsStatus getLogPublishingOptions()
Key-value pairs to configure log publishing.
public DomainConfig withLogPublishingOptions(LogPublishingOptionsStatus logPublishingOptions)
Key-value pairs to configure log publishing.
logPublishingOptions
- Key-value pairs to configure log publishing.public void setDomainEndpointOptions(DomainEndpointOptionsStatus domainEndpointOptions)
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
domainEndpointOptions
- Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.public DomainEndpointOptionsStatus getDomainEndpointOptions()
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
public DomainConfig withDomainEndpointOptions(DomainEndpointOptionsStatus domainEndpointOptions)
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
domainEndpointOptions
- Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.public void setAdvancedSecurityOptions(AdvancedSecurityOptionsStatus advancedSecurityOptions)
Container for fine-grained access control settings for the domain.
advancedSecurityOptions
- Container for fine-grained access control settings for the domain.public AdvancedSecurityOptionsStatus getAdvancedSecurityOptions()
Container for fine-grained access control settings for the domain.
public DomainConfig withAdvancedSecurityOptions(AdvancedSecurityOptionsStatus advancedSecurityOptions)
Container for fine-grained access control settings for the domain.
advancedSecurityOptions
- Container for fine-grained access control settings for the domain.public void setAutoTuneOptions(AutoTuneOptionsStatus autoTuneOptions)
Container for Auto-Tune settings for the domain.
autoTuneOptions
- Container for Auto-Tune settings for the domain.public AutoTuneOptionsStatus getAutoTuneOptions()
Container for Auto-Tune settings for the domain.
public DomainConfig withAutoTuneOptions(AutoTuneOptionsStatus autoTuneOptions)
Container for Auto-Tune settings for the domain.
autoTuneOptions
- Container for Auto-Tune settings for the domain.public void setChangeProgressDetails(ChangeProgressDetails changeProgressDetails)
Container for information about the progress of an existing configuration change.
changeProgressDetails
- Container for information about the progress of an existing configuration change.public ChangeProgressDetails getChangeProgressDetails()
Container for information about the progress of an existing configuration change.
public DomainConfig withChangeProgressDetails(ChangeProgressDetails changeProgressDetails)
Container for information about the progress of an existing configuration change.
changeProgressDetails
- Container for information about the progress of an existing configuration change.public void setOffPeakWindowOptions(OffPeakWindowOptionsStatus offPeakWindowOptions)
Container for off-peak window options for the domain.
offPeakWindowOptions
- Container for off-peak window options for the domain.public OffPeakWindowOptionsStatus getOffPeakWindowOptions()
Container for off-peak window options for the domain.
public DomainConfig withOffPeakWindowOptions(OffPeakWindowOptionsStatus offPeakWindowOptions)
Container for off-peak window options for the domain.
offPeakWindowOptions
- Container for off-peak window options for the domain.public void setSoftwareUpdateOptions(SoftwareUpdateOptionsStatus softwareUpdateOptions)
Software update options for the domain.
softwareUpdateOptions
- Software update options for the domain.public SoftwareUpdateOptionsStatus getSoftwareUpdateOptions()
Software update options for the domain.
public DomainConfig withSoftwareUpdateOptions(SoftwareUpdateOptionsStatus softwareUpdateOptions)
Software update options for the domain.
softwareUpdateOptions
- Software update options for the domain.public List<ModifyingProperties> getModifyingProperties()
Information about the domain properties that are currently being modified.
public void setModifyingProperties(Collection<ModifyingProperties> modifyingProperties)
Information about the domain properties that are currently being modified.
modifyingProperties
- Information about the domain properties that are currently being modified.public DomainConfig withModifyingProperties(ModifyingProperties... modifyingProperties)
Information about the domain properties that are currently being modified.
NOTE: This method appends the values to the existing list (if any). Use
setModifyingProperties(java.util.Collection)
or withModifyingProperties(java.util.Collection)
if you want to override the existing values.
modifyingProperties
- Information about the domain properties that are currently being modified.public DomainConfig withModifyingProperties(Collection<ModifyingProperties> modifyingProperties)
Information about the domain properties that are currently being modified.
modifyingProperties
- Information about the domain properties that are currently being modified.public void setAIMLOptions(AIMLOptionsStatus aIMLOptions)
Container for parameters required to enable all machine learning features.
aIMLOptions
- Container for parameters required to enable all machine learning features.public AIMLOptionsStatus getAIMLOptions()
Container for parameters required to enable all machine learning features.
public DomainConfig withAIMLOptions(AIMLOptionsStatus aIMLOptions)
Container for parameters required to enable all machine learning features.
aIMLOptions
- Container for parameters required to enable all machine learning features.public String toString()
toString
in class Object
Object.toString()
public DomainConfig clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.