Package software.amazon.awssdk.services.verifiedpermissions.model

Interface ConfigurationDetail.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ConfigurationDetail.Builder,ConfigurationDetail>, SdkBuilder<ConfigurationDetail.Builder,ConfigurationDetail>, SdkPojo

Enclosing class:

ConfigurationDetail

public static interface ConfigurationDetail.Builder
extends SdkPojo, CopyableBuilder<ConfigurationDetail.Builder,ConfigurationDetail>

Method Summary

Modifier and Type	Method	Description
default ConfigurationDetail.Builder	cognitoUserPoolConfiguration(Consumer<CognitoUserPoolConfigurationDetail.Builder> cognitoUserPoolConfiguration)	Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities.
ConfigurationDetail.Builder	cognitoUserPoolConfiguration(CognitoUserPoolConfigurationDetail cognitoUserPoolConfiguration)	Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities.
default ConfigurationDetail.Builder	openIdConnectConfiguration(Consumer<OpenIdConnectConfigurationDetail.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.
ConfigurationDetail.Builder	openIdConnectConfiguration(OpenIdConnectConfigurationDetail 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, sdkFields

Method Detail

cognitoUserPoolConfiguration

ConfigurationDetail.Builder cognitoUserPoolConfiguration(CognitoUserPoolConfigurationDetail 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, the policy store entity that you want to assign to user groups, 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, the policy store entity that you want to assign to user groups, 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 ConfigurationDetail.Builder cognitoUserPoolConfiguration(Consumer<CognitoUserPoolConfigurationDetail.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, the policy store entity that you want to assign to user groups, 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"}}}

This is a convenience method that creates an instance of the CognitoUserPoolConfigurationDetail.Builder avoiding the need to create one manually via CognitoUserPoolConfigurationDetail.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cognitoUserPoolConfiguration(CognitoUserPoolConfigurationDetail).

Parameters:

cognitoUserPoolConfiguration - a consumer that will call methods on CognitoUserPoolConfigurationDetail.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

cognitoUserPoolConfiguration(CognitoUserPoolConfigurationDetail)

openIdConnectConfiguration

ConfigurationDetail.Builder openIdConnectConfiguration(OpenIdConnectConfigurationDetail 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 ConfigurationDetail.Builder openIdConnectConfiguration(Consumer<OpenIdConnectConfigurationDetail.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: "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"}}}

This is a convenience method that creates an instance of the OpenIdConnectConfigurationDetail.Builder avoiding the need to create one manually via OpenIdConnectConfigurationDetail.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to openIdConnectConfiguration(OpenIdConnectConfigurationDetail).

Parameters:

openIdConnectConfiguration - a consumer that will call methods on OpenIdConnectConfigurationDetail.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

openIdConnectConfiguration(OpenIdConnectConfigurationDetail)