Class AwsOpenSearchServiceDomainDetails
- java.lang.Object
-
- software.amazon.awssdk.services.securityhub.model.AwsOpenSearchServiceDomainDetails
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AwsOpenSearchServiceDomainDetails.Builder,AwsOpenSearchServiceDomainDetails>
@Generated("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 Description static interfaceAwsOpenSearchServiceDomainDetails.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringaccessPolicies()IAM policy document that specifies the access policies for the OpenSearch Service domain.AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetailsadvancedSecurityOptions()Specifies options for fine-grained access control.Stringarn()The ARN of the OpenSearch Service domain.static AwsOpenSearchServiceDomainDetails.Builderbuilder()AwsOpenSearchServiceDomainClusterConfigDetailsclusterConfig()Details about the configuration of an OpenSearch cluster.StringdomainEndpoint()The domain endpoint.AwsOpenSearchServiceDomainDomainEndpointOptionsDetailsdomainEndpointOptions()Additional options for the domain endpoint.Map<String,String>domainEndpoints()The domain endpoints.StringdomainName()The name of the endpoint.AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetailsencryptionAtRestOptions()Details about the configuration for encryption at rest.StringengineVersion()The version of the domain engine.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasDomainEndpoints()For responses, this returns true if the service returned a value for the DomainEndpoints property.inthashCode()Stringid()The identifier of the domain.AwsOpenSearchServiceDomainLogPublishingOptionsDetailslogPublishingOptions()Configures the CloudWatch Logs to publish for the OpenSearch domain.AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetailsnodeToNodeEncryptionOptions()Details about the configuration for node-to-node encryption.List<SdkField<?>>sdkFields()static Class<? extends AwsOpenSearchServiceDomainDetails.Builder>serializableBuilderClass()AwsOpenSearchServiceDomainServiceSoftwareOptionsDetailsserviceSoftwareOptions()Information about the status of a domain relative to the latest service software.AwsOpenSearchServiceDomainDetails.BuildertoBuilder()StringtoString()Returns a string representation of this object.AwsOpenSearchServiceDomainVpcOptionsDetailsvpcOptions()Information that OpenSearch Service 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
-
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
VPCOptionsfor the domain.- Returns:
- Information that OpenSearch Service derives based on
VPCOptionsfor 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 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
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:
toBuilderin interfaceToCopyableBuilder<AwsOpenSearchServiceDomainDetails.Builder,AwsOpenSearchServiceDomainDetails>
-
builder
public static AwsOpenSearchServiceDomainDetails.Builder builder()
-
serializableBuilderClass
public static Class<? extends AwsOpenSearchServiceDomainDetails.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.
-
-