Interface Configuration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Configuration.Builder,
,Configuration> SdkBuilder<Configuration.Builder,
,Configuration> SdkPojo
- Enclosing class:
Configuration
-
Method Summary
Modifier and TypeMethodDescriptiondefault Configuration.Builder
cognitoUserPoolConfiguration
(Consumer<CognitoUserPoolConfiguration.Builder> cognitoUserPoolConfiguration) Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities.cognitoUserPoolConfiguration
(CognitoUserPoolConfiguration cognitoUserPoolConfiguration) Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities.default Configuration.Builder
openIdConnectConfiguration
(Consumer<OpenIdConnectConfiguration.Builder> openIdConnectConfiguration) Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities.openIdConnectConfiguration
(OpenIdConnectConfiguration openIdConnectConfiguration) Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities.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 Details
-
cognitoUserPoolConfiguration
Configuration.Builder cognitoUserPoolConfiguration(CognitoUserPoolConfiguration cognitoUserPoolConfiguration) Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool and one or more application client IDs.
Example:
"configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}}
- Parameters:
cognitoUserPoolConfiguration
- Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool and one or more application client IDs.Example:
"configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}}
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cognitoUserPoolConfiguration
default Configuration.Builder cognitoUserPoolConfiguration(Consumer<CognitoUserPoolConfiguration.Builder> cognitoUserPoolConfiguration) Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool and one or more application client IDs.
Example:
This is a convenience method that creates an instance of the"configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}}
CognitoUserPoolConfiguration.Builder
avoiding the need to create one manually viaCognitoUserPoolConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocognitoUserPoolConfiguration(CognitoUserPoolConfiguration)
.- Parameters:
cognitoUserPoolConfiguration
- a consumer that will call methods onCognitoUserPoolConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
openIdConnectConfiguration
Configuration.Builder openIdConnectConfiguration(OpenIdConnectConfiguration openIdConnectConfiguration) Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.
Example:
"configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}
- Parameters:
openIdConnectConfiguration
- Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.Example:
"configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
openIdConnectConfiguration
default Configuration.Builder openIdConnectConfiguration(Consumer<OpenIdConnectConfiguration.Builder> openIdConnectConfiguration) Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.
Example:
This is a convenience method that creates an instance of the"configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}
OpenIdConnectConfiguration.Builder
avoiding the need to create one manually viaOpenIdConnectConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toopenIdConnectConfiguration(OpenIdConnectConfiguration)
.- Parameters:
openIdConnectConfiguration
- a consumer that will call methods onOpenIdConnectConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-