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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDirectoryConfig.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DirectoryConfig.Builderbuilder()CertificateBasedAuthPropertiescertificateBasedAuthProperties()The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.InstantcreatedTime()The time the directory configuration was created.StringdirectoryName()The fully qualified name of the directory (for example, corp.example.com).booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasOrganizationalUnitDistinguishedNames()For responses, this returns true if the service returned a value for the OrganizationalUnitDistinguishedNames property.List<String>organizationalUnitDistinguishedNames()The distinguished names of the organizational units for computer accounts.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends DirectoryConfig.Builder>serializableBuilderClass()ServiceAccountCredentialsserviceAccountCredentials()The credentials for the service account used by the fleet or image builder to connect to the directory.DirectoryConfig.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
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 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.
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DirectoryConfig.Builder,DirectoryConfig>
-
builder
public static DirectoryConfig.Builder builder()
-
serializableBuilderClass
public static Class<? extends DirectoryConfig.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
-
-