Class OrganizationDomain

java.lang.Object
software.amazon.awssdk.services.cloudwatchomni.model.OrganizationDomain
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OrganizationDomain.Builder,OrganizationDomain>
@Generated("software.amazon.awssdk:codegen") public final class OrganizationDomain extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OrganizationDomain.Builder,OrganizationDomain>

Detailed information about an organization domain.

See Also:

  • Method Details

    • domainId

      public final String domainId()

      The unique ID of the organization domain.

      Returns:
      The unique ID of the organization domain.

    • domainArn

      public final String domainArn()

      The Amazon Resource Name (ARN) of the organization domain.

      Returns:
      The Amazon Resource Name (ARN) of the organization domain.

    • name

      public final String name()

      A name that identifies the organization domain.

      Returns:
      A name that identifies the organization domain.

    • domainEndpointUrl

      public final String domainEndpointUrl()

      The HTTPS endpoint URL for accessing the organization domain.

      Returns:
      The HTTPS endpoint URL for accessing the organization domain.

    • hasCustomEndpointUrls

      public final boolean hasCustomEndpointUrls()
      For responses, this returns true if the service returned a value for the CustomEndpointUrls 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.

    • customEndpointUrls

      public final List<String> customEndpointUrls()

      Additional endpoint URLs derived from the domain name.

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

      Returns:
      Additional endpoint URLs derived from the domain name.

    • organizationId

      public final String organizationId()

      The ID of the AWS Organization that owns the domain.

      Returns:
      The ID of the AWS Organization that owns the domain.

    • ownerAccountId

      public final String ownerAccountId()

      The AWS account ID that owns the organization domain.

      Returns:
      The AWS account ID that owns the organization domain.

    • identityProviders

      public final List<IdentityProvider> identityProviders()

      The identity providers configured for the organization domain.

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

      Returns:
      The identity providers configured for the organization domain.

    • hasIdentityProviders

      public final boolean hasIdentityProviders()
      For responses, this returns true if the service returned a value for the IdentityProviders 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.

    • identityProvidersAsStrings

      public final List<String> identityProvidersAsStrings()

      The identity providers configured for the organization domain.

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

      Returns:
      The identity providers configured for the organization domain.

    • identityProviderConfiguration

      public final IdentityProviderConfiguration identityProviderConfiguration()

      Identity provider configuration for the organization domain.

      Returns:
      Identity provider configuration for the organization domain.

    • identityCenterApplicationArn

      public final String identityCenterApplicationArn()

      The ARN of the Identity Center application. Absent for IAM-only domains.

      Returns:
      The ARN of the Identity Center application. Absent for IAM-only domains.

    • region

      public final String region()

      The Region where this organization domain was created.

      Returns:
      The Region where this organization domain was created.

    • status

      public final DomainStatus status()

      Current status of the organization domain.

      If the service returns an enum value that is not available in the current SDK version, status will return DomainStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Current status of the organization domain.
      See Also:

    • statusAsString

      public final String statusAsString()

      Current status of the organization domain.

      If the service returns an enum value that is not available in the current SDK version, status will return DomainStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Current status of the organization domain.
      See Also:

    • domainAccessRoleArn

      public final String domainAccessRoleArn()

      The ARN of the customer-provided IAM role in the management account used for domain access.

      Returns:
      The ARN of the customer-provided IAM role in the management account used for domain access.

    • createdAt

      public final Instant createdAt()

      The timestamp when the organization domain was created.

      Returns:
      The timestamp when the organization domain was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the organization domain was last updated.

      Returns:
      The timestamp when the organization domain was last updated.

    • toBuilder

      public OrganizationDomain.Builder 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 interface ToCopyableBuilder<OrganizationDomain.Builder,OrganizationDomain>
      Returns:
      a builder for type T

    • builder

      public static OrganizationDomain.Builder builder()

    • serializableBuilderClass

      public static Class<? extends OrganizationDomain.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.