Interface CognitoUserPoolConfigurationItem.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<CognitoUserPoolConfigurationItem.Builder,CognitoUserPoolConfigurationItem>,SdkBuilder<CognitoUserPoolConfigurationItem.Builder,CognitoUserPoolConfigurationItem>,SdkPojo
- Enclosing class:
- CognitoUserPoolConfigurationItem
public static interface CognitoUserPoolConfigurationItem.Builder extends SdkPojo, CopyableBuilder<CognitoUserPoolConfigurationItem.Builder,CognitoUserPoolConfigurationItem>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description CognitoUserPoolConfigurationItem.BuilderclientIds(String... clientIds)The unique application client IDs that are associated with the specified Amazon Cognito user pool.CognitoUserPoolConfigurationItem.BuilderclientIds(Collection<String> clientIds)The unique application client IDs that are associated with the specified Amazon Cognito user pool.default CognitoUserPoolConfigurationItem.BuildergroupConfiguration(Consumer<CognitoGroupConfigurationItem.Builder> groupConfiguration)The configuration of the user groups from an Amazon Cognito user pool identity source.CognitoUserPoolConfigurationItem.BuildergroupConfiguration(CognitoGroupConfigurationItem groupConfiguration)The configuration of the user groups from an Amazon Cognito user pool identity source.CognitoUserPoolConfigurationItem.Builderissuer(String issuer)The OpenID Connect (OIDC)issuerID of the Amazon Cognito user pool that contains the identities to be authorized.CognitoUserPoolConfigurationItem.BuilderuserPoolArn(String userPoolArn)The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.-
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, sdkFields
-
-
-
-
Method Detail
-
userPoolArn
CognitoUserPoolConfigurationItem.Builder userPoolArn(String userPoolArn)
The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.
Example:
"userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"- Parameters:
userPoolArn- The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.Example:
"userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientIds
CognitoUserPoolConfigurationItem.Builder clientIds(Collection<String> clientIds)
The unique application client IDs that are associated with the specified Amazon Cognito user pool.
Example:
"clientIds": ["&ExampleCogClientId;"]- Parameters:
clientIds- The unique application client IDs that are associated with the specified Amazon Cognito user pool.Example:
"clientIds": ["&ExampleCogClientId;"]- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientIds
CognitoUserPoolConfigurationItem.Builder clientIds(String... clientIds)
The unique application client IDs that are associated with the specified Amazon Cognito user pool.
Example:
"clientIds": ["&ExampleCogClientId;"]- Parameters:
clientIds- The unique application client IDs that are associated with the specified Amazon Cognito user pool.Example:
"clientIds": ["&ExampleCogClientId;"]- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
issuer
CognitoUserPoolConfigurationItem.Builder issuer(String issuer)
The OpenID Connect (OIDC)
issuerID of the Amazon Cognito user pool that contains the identities to be authorized.Example:
"issuer": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"- Parameters:
issuer- The OpenID Connect (OIDC)issuerID of the Amazon Cognito user pool that contains the identities to be authorized.Example:
"issuer": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
groupConfiguration
CognitoUserPoolConfigurationItem.Builder groupConfiguration(CognitoGroupConfigurationItem groupConfiguration)
The configuration of the user groups from an Amazon Cognito user pool identity source.
- Parameters:
groupConfiguration- The configuration of the user groups from an Amazon Cognito user pool identity source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
groupConfiguration
default CognitoUserPoolConfigurationItem.Builder groupConfiguration(Consumer<CognitoGroupConfigurationItem.Builder> groupConfiguration)
The configuration of the user groups from an Amazon Cognito user pool identity source.
This is a convenience method that creates an instance of theCognitoGroupConfigurationItem.Builderavoiding the need to create one manually viaCognitoGroupConfigurationItem.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed togroupConfiguration(CognitoGroupConfigurationItem).- Parameters:
groupConfiguration- a consumer that will call methods onCognitoGroupConfigurationItem.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
groupConfiguration(CognitoGroupConfigurationItem)
-
-