software.amazon.awssdk.services.securityhub.model

Class AwsOpenSearchServiceDomainDetails

java.lang.Object

software.amazon.awssdk.services.securityhub.model.AwsOpenSearchServiceDomainDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AwsOpenSearchServiceDomainDetails.Builder,AwsOpenSearchServiceDomainDetails>

@Generated(value="software.amazon.awssdk:codegen")
public final class AwsOpenSearchServiceDomainDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AwsOpenSearchServiceDomainDetails.Builder,AwsOpenSearchServiceDomainDetails>

Information about an Amazon OpenSearch Service domain.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AwsOpenSearchServiceDomainDetails.Builder

Method Summary

Modifier and Type	Method and Description
String	accessPolicies() IAM policy document that specifies the access policies for the OpenSearch Service domain.
AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails	advancedSecurityOptions() Specifies options for fine-grained access control.
String	arn() The ARN of the OpenSearch Service domain.
static AwsOpenSearchServiceDomainDetails.Builder	builder()
AwsOpenSearchServiceDomainClusterConfigDetails	clusterConfig() Details about the configuration of an OpenSearch cluster.
String	domainEndpoint() The domain endpoint.
AwsOpenSearchServiceDomainDomainEndpointOptionsDetails	domainEndpointOptions() Additional options for the domain endpoint.
Map<String,String>	domainEndpoints() The domain endpoints.
String	domainName() The name of the endpoint.
AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails	encryptionAtRestOptions() Details about the configuration for encryption at rest.
String	engineVersion() The version of the domain engine.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDomainEndpoints() For responses, this returns true if the service returned a value for the DomainEndpoints property.
int	hashCode()
String	id() The identifier of the domain.
AwsOpenSearchServiceDomainLogPublishingOptionsDetails	logPublishingOptions() Configures the CloudWatch Logs to publish for the OpenSearch domain.
AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails	nodeToNodeEncryptionOptions() Details about the configuration for node-to-node encryption.
List<SdkField<?>>	sdkFields()
static Class<? extends AwsOpenSearchServiceDomainDetails.Builder>	serializableBuilderClass()
AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails	serviceSoftwareOptions() Information about the status of a domain relative to the latest service software.
AwsOpenSearchServiceDomainDetails.Builder	toBuilder()
String	toString() Returns a string representation of this object.
AwsOpenSearchServiceDomainVpcOptionsDetails	vpcOptions() Information that OpenSearch Service derives based on VPCOptions for the domain.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

arn

public final String arn()

The ARN of the OpenSearch Service domain.

Returns:

The ARN of the OpenSearch Service domain.

accessPolicies

public final String 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

public final String domainName()

The name of the endpoint.

Returns:

The name of the endpoint.

id

public final String id()

The identifier of the domain.

Returns:

The identifier of the domain.

domainEndpoint

public final String domainEndpoint()

The domain endpoint.

Returns:

The domain endpoint.

engineVersion

public final String engineVersion()

The version of the domain engine.

Returns:

The version of the domain engine.

encryptionAtRestOptions

public final AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails 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

public final AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails 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

public final AwsOpenSearchServiceDomainClusterConfigDetails clusterConfig()

Details about the configuration of an OpenSearch cluster.

Returns:

Details about the configuration of an OpenSearch cluster.

domainEndpointOptions

public final AwsOpenSearchServiceDomainDomainEndpointOptionsDetails domainEndpointOptions()

Additional options for the domain endpoint.

Returns:

Additional options for the domain endpoint.

vpcOptions

public final AwsOpenSearchServiceDomainVpcOptionsDetails 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

public final AwsOpenSearchServiceDomainLogPublishingOptionsDetails 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 the isEmpty() 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

public final Map<String,String> 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

public final AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails advancedSecurityOptions()

Specifies options for fine-grained access control.

Returns:

Specifies options for fine-grained access control.

toBuilder

public AwsOpenSearchServiceDomainDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsOpenSearchServiceDomainDetails.Builder,AwsOpenSearchServiceDomainDetails>

builder

public static AwsOpenSearchServiceDomainDetails.Builder builder()

serializableBuilderClass

public static Class<? extends AwsOpenSearchServiceDomainDetails.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo