Class AwsElasticsearchDomainDetails
- java.lang.Object
-
- software.amazon.awssdk.services.securityhub.model.AwsElasticsearchDomainDetails
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AwsElasticsearchDomainDetails.Builder,AwsElasticsearchDomainDetails>
@Generated("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 Description static interfaceAwsElasticsearchDomainDetails.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringaccessPolicies()IAM policy document specifying the access policies for the new Elasticsearch domain.static AwsElasticsearchDomainDetails.Builderbuilder()AwsElasticsearchDomainDomainEndpointOptionsdomainEndpointOptions()Additional options for the domain endpoint.StringdomainId()Unique identifier for an Elasticsearch domain.StringdomainName()Name of an Elasticsearch domain.AwsElasticsearchDomainElasticsearchClusterConfigDetailselasticsearchClusterConfig()Information about an OpenSearch cluster configuration.StringelasticsearchVersion()OpenSearch version.AwsElasticsearchDomainEncryptionAtRestOptionsencryptionAtRestOptions()Details about the configuration for encryption at rest.Stringendpoint()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.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasEndpoints()For responses, this returns true if the service returned a value for the Endpoints property.inthashCode()AwsElasticsearchDomainLogPublishingOptionslogPublishingOptions()Configures the CloudWatch Logs to publish for the Elasticsearch domain.AwsElasticsearchDomainNodeToNodeEncryptionOptionsnodeToNodeEncryptionOptions()Details about the configuration for node-to-node encryption.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends AwsElasticsearchDomainDetails.Builder>serializableBuilderClass()AwsElasticsearchDomainServiceSoftwareOptionsserviceSoftwareOptions()Information about the status of a domain relative to the latest service software.AwsElasticsearchDomainDetails.BuildertoBuilder()StringtoString()Returns a string representation of this object.AwsElasticsearchDomainVPCOptionsvpcOptions()Information that OpenSearch derives based onVPCOptionsfor 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 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.
-
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
VPCOptionsfor the domain.- Returns:
- Information that OpenSearch derives based on
VPCOptionsfor the domain.
-
toBuilder
public AwsElasticsearchDomainDetails.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AwsElasticsearchDomainDetails.Builder,AwsElasticsearchDomainDetails>
-
builder
public static AwsElasticsearchDomainDetails.Builder builder()
-
serializableBuilderClass
public static Class<? extends AwsElasticsearchDomainDetails.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-