Package software.amazon.awssdk.services.appstream.model

Class DirectoryConfig

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

Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

See Also:

  • Method Details

    • directoryName

      public final String directoryName()

      The fully qualified name of the directory (for example, corp.example.com).

      Returns:
      The fully qualified name of the directory (for example, corp.example.com).

    • hasOrganizationalUnitDistinguishedNames

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

    • organizationalUnitDistinguishedNames

      public final List<String> organizationalUnitDistinguishedNames()

      The distinguished names of the organizational units for computer accounts.

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

      Returns:
      The distinguished names of the organizational units for computer accounts.

    • serviceAccountCredentials

      public final ServiceAccountCredentials serviceAccountCredentials()

      The credentials for the service account used by the fleet or image builder to connect to the directory.

      Returns:
      The credentials for the service account used by the fleet or image builder to connect to the directory.

    • createdTime

      public final Instant createdTime()

      The time the directory configuration was created.

      Returns:
      The time the directory configuration was created.

    • certificateBasedAuthProperties

      public final CertificateBasedAuthProperties certificateBasedAuthProperties()

      The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.

      Returns:
      The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.

    • toBuilder

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

    • builder

      public static DirectoryConfig.Builder builder()

    • serializableBuilderClass

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