Interface CognitoIdentityProvider.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<CognitoIdentityProvider.Builder,CognitoIdentityProvider>,SdkBuilder<CognitoIdentityProvider.Builder,CognitoIdentityProvider>,SdkPojo
- Enclosing class:
- CognitoIdentityProvider
public static interface CognitoIdentityProvider.Builder extends SdkPojo, CopyableBuilder<CognitoIdentityProvider.Builder,CognitoIdentityProvider>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CognitoIdentityProvider.BuilderclientId(String clientId)The client ID for the Amazon Cognito user pool.CognitoIdentityProvider.BuilderproviderName(String providerName)The provider name for an Amazon Cognito user pool.CognitoIdentityProvider.BuilderserverSideTokenCheck(Boolean serverSideTokenCheck)TRUE if server-side token validation is enabled for the identity provider’s token.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
providerName
CognitoIdentityProvider.Builder providerName(String providerName)
The provider name for an Amazon Cognito user pool. For example,
cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.- Parameters:
providerName- The provider name for an Amazon Cognito user pool. For example,cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientId
CognitoIdentityProvider.Builder clientId(String clientId)
The client ID for the Amazon Cognito user pool.
- Parameters:
clientId- The client ID for the Amazon Cognito user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serverSideTokenCheck
CognitoIdentityProvider.Builder serverSideTokenCheck(Boolean serverSideTokenCheck)
TRUE if server-side token validation is enabled for the identity provider’s token.
Once you set
ServerSideTokenCheckto TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.
- Parameters:
serverSideTokenCheck- TRUE if server-side token validation is enabled for the identity provider’s token.Once you set
ServerSideTokenCheckto TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-