Class AwsOpenSearchServiceDomainDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AwsOpenSearchServiceDomainDetails.Builder,
AwsOpenSearchServiceDomainDetails>
Information about an Amazon OpenSearch Service domain.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
IAM policy document that specifies the access policies for the OpenSearch Service domain.Specifies options for fine-grained access control.final String
arn()
The ARN of the OpenSearch Service domain.builder()
Details about the configuration of an OpenSearch cluster.final String
The domain endpoint.Additional options for the domain endpoint.The domain endpoints.final String
The name of the endpoint.Details about the configuration for encryption at rest.final String
The version of the domain engine.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the DomainEndpoints property.final int
hashCode()
final String
id()
The identifier of the domain.Configures the CloudWatch Logs to publish for the OpenSearch domain.Details about the configuration for node-to-node encryption.static Class
<? extends AwsOpenSearchServiceDomainDetails.Builder> Information about the status of a domain relative to the latest service software.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Information that OpenSearch Service derives based onVPCOptions
for the domain.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The ARN of the OpenSearch Service domain.
- Returns:
- The ARN of the OpenSearch Service domain.
-
accessPolicies
IAM policy document that specifies the access policies for the OpenSearch Service domain.
- Returns:
- IAM policy document that specifies the access policies for the OpenSearch Service domain.
-
domainName
The name of the endpoint.
- Returns:
- The name of the endpoint.
-
id
The identifier of the domain.
- Returns:
- The identifier of the domain.
-
domainEndpoint
The domain endpoint.
- Returns:
- The domain endpoint.
-
engineVersion
The version of the domain engine.
- Returns:
- The version of the domain engine.
-
encryptionAtRestOptions
Details about the configuration for encryption at rest.
- Returns:
- Details about the configuration for encryption at rest.
-
nodeToNodeEncryptionOptions
public final AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails nodeToNodeEncryptionOptions()Details about the configuration for node-to-node encryption.
- Returns:
- Details about the configuration for node-to-node encryption.
-
serviceSoftwareOptions
Information about the status of a domain relative to the latest service software.
- Returns:
- Information about the status of a domain relative to the latest service software.
-
clusterConfig
Details about the configuration of an OpenSearch cluster.
- Returns:
- Details about the configuration of an OpenSearch cluster.
-
domainEndpointOptions
Additional options for the domain endpoint.
- Returns:
- Additional options for the domain endpoint.
-
vpcOptions
Information that OpenSearch Service derives based on
VPCOptions
for the domain.- Returns:
- Information that OpenSearch Service derives based on
VPCOptions
for the domain.
-
logPublishingOptions
Configures the CloudWatch Logs to publish for the OpenSearch domain.
- Returns:
- Configures the CloudWatch Logs to publish for the OpenSearch domain.
-
hasDomainEndpoints
public final boolean hasDomainEndpoints()For responses, this returns true if the service returned a value for the DomainEndpoints property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
domainEndpoints
The domain endpoints. Used if the OpenSearch domain resides in a VPC.
This is a map of key-value pairs. The key is always
vpc
. The value is the endpoint.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDomainEndpoints()
method.- Returns:
- The domain endpoints. Used if the OpenSearch domain resides in a VPC.
This is a map of key-value pairs. The key is always
vpc
. The value is the endpoint.
-
advancedSecurityOptions
Specifies options for fine-grained access control.
- Returns:
- Specifies options for fine-grained access control.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AwsOpenSearchServiceDomainDetails.Builder,
AwsOpenSearchServiceDomainDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-