Interface CognitoUserPoolConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<CognitoUserPoolConfiguration.Builder,
,CognitoUserPoolConfiguration> SdkBuilder<CognitoUserPoolConfiguration.Builder,
,CognitoUserPoolConfiguration> SdkPojo
- Enclosing class:
CognitoUserPoolConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionThe unique application client IDs that are associated with the specified Amazon Cognito user pool.clientIds
(Collection<String> clientIds) The unique application client IDs that are associated with the specified Amazon Cognito user pool.groupConfiguration
(Consumer<CognitoGroupConfiguration.Builder> groupConfiguration) The configuration of the user groups from an Amazon Cognito user pool identity source.groupConfiguration
(CognitoGroupConfiguration groupConfiguration) The configuration of the user groups from an Amazon Cognito user pool identity source.userPoolArn
(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 Details
-
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
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
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.
-
groupConfiguration
CognitoUserPoolConfiguration.Builder groupConfiguration(CognitoGroupConfiguration 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 CognitoUserPoolConfiguration.Builder groupConfiguration(Consumer<CognitoGroupConfiguration.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 theCognitoGroupConfiguration.Builder
avoiding the need to create one manually viaCognitoGroupConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed togroupConfiguration(CognitoGroupConfiguration)
.- Parameters:
groupConfiguration
- a consumer that will call methods onCognitoGroupConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-