Class AccessControlApplication
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AccessControlApplication.Builder,AccessControlApplication>
An access control application. It defines how an external client signs in to Quick Sight with OAuth 2.0. Client secret values are never included.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal StringThe ID of the access control application.final Stringarn()The ARN of the access control application.The authentication protocol that the access control application uses.final StringThe authentication protocol that the access control application uses.builder()final InstantThe time when the access control application was created.final StringThe description of the access control application.final booleanfinal booleanequalsBySdkFields(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 inthashCode()final StringThe ARN of the Amazon Web Services IAM Identity Center application that Quick Sight manages for this access control application.final IdpAuthorizingConfigThe identity provider configuration of the access control application.final InstantThe time when the access control application was last updated.final Stringname()The name of the access control application.final StringThe Quick Sight namespace that the access control application belongs to.The Quick Sight authentication configuration of the access control application.static Class<? extends AccessControlApplication.Builder> status()The status of the access control application.final StringThe status of the access control application.final StringThe tenant URL of the access control application.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
applicationId
The ID of the access control application.
- Returns:
- The ID of the access control application.
-
arn
The ARN of the access control application.
- Returns:
- The ARN of the access control application.
-
name
The name of the access control application.
- Returns:
- The name of the access control application.
-
namespace
The Quick Sight namespace that the access control application belongs to.
- Returns:
- The Quick Sight namespace that the access control application belongs to.
-
authenticationType
The authentication protocol that the access control application uses.
If the service returns an enum value that is not available in the current SDK version,
authenticationTypewill returnAccessControlApplicationAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthenticationTypeAsString().- Returns:
- The authentication protocol that the access control application uses.
- See Also:
-
authenticationTypeAsString
The authentication protocol that the access control application uses.
If the service returns an enum value that is not available in the current SDK version,
authenticationTypewill returnAccessControlApplicationAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthenticationTypeAsString().- Returns:
- The authentication protocol that the access control application uses.
- See Also:
-
status
The status of the access control application.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnAccessControlApplicationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the access control application.
- See Also:
-
statusAsString
The status of the access control application.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnAccessControlApplicationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the access control application.
- See Also:
-
createdTime
The time when the access control application was created.
- Returns:
- The time when the access control application was created.
-
lastUpdatedTime
The time when the access control application was last updated.
- Returns:
- The time when the access control application was last updated.
-
tenantUrl
The tenant URL of the access control application. This URL hosts the OAuth 2.0 and OpenID Connect endpoints for the application, such as
/authorize,/token,/.well-known/openid-configuration, and/jwks.- Returns:
- The tenant URL of the access control application. This URL hosts the OAuth 2.0 and OpenID Connect
endpoints for the application, such as
/authorize,/token,/.well-known/openid-configuration, and/jwks.
-
description
The description of the access control application.
- Returns:
- The description of the access control application.
-
idcApplicationArn
The ARN of the Amazon Web Services IAM Identity Center application that Quick Sight manages for this access control application. This value is present when the
IdpAuthorizingTypeisIDC_AUTH_CODE, or when a trusted token issuer is configured.- Returns:
- The ARN of the Amazon Web Services IAM Identity Center application that Quick Sight manages for this
access control application. This value is present when the
IdpAuthorizingTypeisIDC_AUTH_CODE, or when a trusted token issuer is configured.
-
idpAuthorizingConfiguration
The identity provider configuration of the access control application. Client secret values are never included.
- Returns:
- The identity provider configuration of the access control application. Client secret values are never included.
-
quickAuthenticationConfiguration
The Quick Sight authentication configuration of the access control application. Client secret values are never included.
- Returns:
- The Quick Sight authentication configuration of the access control application. Client secret values are never included.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<AccessControlApplication.Builder,AccessControlApplication> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-