software.amazon.awssdk.services.securityhub.model

Class AwsElasticsearchDomainDetails

java.lang.Object

software.amazon.awssdk.services.securityhub.model.AwsElasticsearchDomainDetails

All Implemented Interfaces:

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

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

Information about an Elasticsearch domain.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AwsElasticsearchDomainDetails.Builder

Method Summary

Modifier and Type	Method and Description
String	accessPolicies() IAM policy document specifying the access policies for the new Elasticsearch domain.
static AwsElasticsearchDomainDetails.Builder	builder()
AwsElasticsearchDomainDomainEndpointOptions	domainEndpointOptions() Additional options for the domain endpoint.
String	domainId() Unique identifier for an Elasticsearch domain.
String	domainName() Name of an Elasticsearch domain.
AwsElasticsearchDomainElasticsearchClusterConfigDetails	elasticsearchClusterConfig() Information about an OpenSearch cluster configuration.
String	elasticsearchVersion() OpenSearch version.
AwsElasticsearchDomainEncryptionAtRestOptions	encryptionAtRestOptions() Details about the configuration for encryption at rest.
String	endpoint() Domain-specific endpoint used to submit index, search, and data upload requests to an Elasticsearch domain.
Map<String,String>	endpoints() The key-value pair that exists if the Elasticsearch domain uses VPC endpoints.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEndpoints() For responses, this returns true if the service returned a value for the Endpoints property.
int	hashCode()
AwsElasticsearchDomainLogPublishingOptions	logPublishingOptions() Configures the CloudWatch Logs to publish for the Elasticsearch domain.
AwsElasticsearchDomainNodeToNodeEncryptionOptions	nodeToNodeEncryptionOptions() Details about the configuration for node-to-node encryption.
List<SdkField<?>>	sdkFields()
static Class<? extends AwsElasticsearchDomainDetails.Builder>	serializableBuilderClass()
AwsElasticsearchDomainServiceSoftwareOptions	serviceSoftwareOptions() Information about the status of a domain relative to the latest service software.
AwsElasticsearchDomainDetails.Builder	toBuilder()
String	toString() Returns a string representation of this object.
AwsElasticsearchDomainVPCOptions	vpcOptions() Information that OpenSearch 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

accessPolicies

public final String accessPolicies()

IAM policy document specifying the access policies for the new Elasticsearch domain.

Returns:

IAM policy document specifying the access policies for the new Elasticsearch domain.

domainEndpointOptions

public final AwsElasticsearchDomainDomainEndpointOptions domainEndpointOptions()

Additional options for the domain endpoint.

Returns:

Additional options for the domain endpoint.

domainId

public final String domainId()

Unique identifier for an Elasticsearch domain.

Returns:

Unique identifier for an Elasticsearch domain.

domainName

public final String domainName()

Name of an Elasticsearch domain.

Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

Domain names must start with a lowercase letter and must be between 3 and 28 characters.

Valid characters are a-z (lowercase only), 0-9, and – (hyphen).

Returns:

Name of an Elasticsearch domain.

Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

Domain names must start with a lowercase letter and must be between 3 and 28 characters.

Valid characters are a-z (lowercase only), 0-9, and – (hyphen).

endpoint

public final String endpoint()

Domain-specific endpoint used to submit index, search, and data upload requests to an Elasticsearch domain.

The endpoint is a service URL.

Returns:

Domain-specific endpoint used to submit index, search, and data upload requests to an Elasticsearch domain.

The endpoint is a service URL.

hasEndpoints

public final boolean hasEndpoints()

For responses, this returns true if the service returned a value for the Endpoints 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.

endpoints

public final Map<String,String> endpoints()

The key-value pair that exists if the Elasticsearch domain uses VPC endpoints.

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 hasEndpoints() method.

Returns:

The key-value pair that exists if the Elasticsearch domain uses VPC endpoints.

elasticsearchVersion

public final String elasticsearchVersion()

OpenSearch version.

Returns:

OpenSearch version.

elasticsearchClusterConfig

public final AwsElasticsearchDomainElasticsearchClusterConfigDetails elasticsearchClusterConfig()

Information about an OpenSearch cluster configuration.

Returns:

Information about an OpenSearch cluster configuration.

encryptionAtRestOptions

public final AwsElasticsearchDomainEncryptionAtRestOptions encryptionAtRestOptions()

Details about the configuration for encryption at rest.

Returns:

Details about the configuration for encryption at rest.

logPublishingOptions

public final AwsElasticsearchDomainLogPublishingOptions logPublishingOptions()

Configures the CloudWatch Logs to publish for the Elasticsearch domain.

Returns:

Configures the CloudWatch Logs to publish for the Elasticsearch domain.

nodeToNodeEncryptionOptions

public final AwsElasticsearchDomainNodeToNodeEncryptionOptions nodeToNodeEncryptionOptions()

Details about the configuration for node-to-node encryption.

Returns:

Details about the configuration for node-to-node encryption.

serviceSoftwareOptions

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

vpcOptions

public final AwsElasticsearchDomainVPCOptions vpcOptions()

Information that OpenSearch derives based on VPCOptions for the domain.

Returns:

Information that OpenSearch derives based on VPCOptions for the domain.

toBuilder

public AwsElasticsearchDomainDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsElasticsearchDomainDetails.Builder,AwsElasticsearchDomainDetails>

builder

public static AwsElasticsearchDomainDetails.Builder builder()

serializableBuilderClass

public static Class<? extends AwsElasticsearchDomainDetails.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