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()
final String	certificateAuthorityArn()	The ARN of the AWS Certificate Manager Private CA resource.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends CertificateBasedAuthProperties.Builder>	serializableBuilderClass()
final CertificateBasedAuthStatus	status()	The status of the certificate-based authentication properties.
final String	statusAsString()	The status of the certificate-based authentication properties.
CertificateBasedAuthProperties.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

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()

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<CertificateBasedAuthProperties.Builder,CertificateBasedAuthProperties>

Returns:

a builder for type T

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)

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.