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

Class CertificateBasedAuthProperties

java.lang.Object

software.amazon.awssdk.services.appstream.model.CertificateBasedAuthProperties

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CertificateBasedAuthProperties.Builder,CertificateBasedAuthProperties>

@Generated("software.amazon.awssdk:codegen")
public final class CertificateBasedAuthProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CertificateBasedAuthProperties.Builder,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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CertificateBasedAuthProperties.Builder

Method Summary

Modifier and Type	Method	Description
static CertificateBasedAuthProperties.Builder	builder()
String	certificateAuthorityArn()	The ARN of the AWS Certificate Manager Private CA resource.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CertificateBasedAuthProperties.Builder>	serializableBuilderClass()
CertificateBasedAuthStatus	status()	The status of the certificate-based authentication properties.
String	statusAsString()	The status of the certificate-based authentication properties.
CertificateBasedAuthProperties.Builder	toBuilder()
String	toString()	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

status

public final CertificateBasedAuthStatus status()

The status of the certificate-based authentication properties.

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

Returns:

The status of the certificate-based authentication properties.

See Also:

CertificateBasedAuthStatus

statusAsString

public final String statusAsString()

The status of the certificate-based authentication properties.

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

Returns:

The status of the certificate-based authentication properties.

See Also:

CertificateBasedAuthStatus

certificateAuthorityArn

public final String certificateAuthorityArn()

The ARN of the AWS Certificate Manager Private CA resource.

Returns:

The ARN of the AWS Certificate Manager Private CA resource.

toBuilder

public CertificateBasedAuthProperties.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CertificateBasedAuthProperties.Builder,CertificateBasedAuthProperties>

builder

public static CertificateBasedAuthProperties.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo