Class Configuration
- java.lang.Object
-
- software.amazon.awssdk.services.verifiedpermissions.model.Configuration
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Configuration.Builder,Configuration>
@Generated("software.amazon.awssdk:codegen") public final class Configuration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Configuration.Builder,Configuration>
Contains configuration information used when creating a new identity source.
This data type is used as a request parameter for the CreateIdentitySource operation.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceConfiguration.Builderstatic classConfiguration.Type
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Configuration.Builderbuilder()CognitoUserPoolConfigurationcognitoUserPoolConfiguration()Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)static ConfigurationfromCognitoUserPoolConfiguration(Consumer<CognitoUserPoolConfiguration.Builder> cognitoUserPoolConfiguration)Create an instance of this class withcognitoUserPoolConfiguration()initialized to the given value.static ConfigurationfromCognitoUserPoolConfiguration(CognitoUserPoolConfiguration cognitoUserPoolConfiguration)Create an instance of this class withcognitoUserPoolConfiguration()initialized to the given value.static ConfigurationfromOpenIdConnectConfiguration(Consumer<OpenIdConnectConfiguration.Builder> openIdConnectConfiguration)Create an instance of this class withopenIdConnectConfiguration()initialized to the given value.static ConfigurationfromOpenIdConnectConfiguration(OpenIdConnectConfiguration openIdConnectConfiguration)Create an instance of this class withopenIdConnectConfiguration()initialized to the given value.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()OpenIdConnectConfigurationopenIdConnectConfiguration()Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities.List<SdkField<?>>sdkFields()static Class<? extends Configuration.Builder>serializableBuilderClass()Configuration.BuildertoBuilder()StringtoString()Returns a string representation of this object.Configuration.Typetype()Retrieve an enum value representing which member of this object is populated.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
cognitoUserPoolConfiguration
public final 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"}}}- Returns:
- 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"}}}
-
openIdConnectConfiguration
public final 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"}}}- Returns:
- 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"}}}
-
toBuilder
public Configuration.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Configuration.Builder,Configuration>
-
builder
public static Configuration.Builder builder()
-
serializableBuilderClass
public static Class<? extends Configuration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
fromCognitoUserPoolConfiguration
public static Configuration fromCognitoUserPoolConfiguration(CognitoUserPoolConfiguration cognitoUserPoolConfiguration)
Create an instance of this class withcognitoUserPoolConfiguration()initialized to the given value.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"}}}
-
fromCognitoUserPoolConfiguration
public static Configuration fromCognitoUserPoolConfiguration(Consumer<CognitoUserPoolConfiguration.Builder> cognitoUserPoolConfiguration)
Create an instance of this class withcognitoUserPoolConfiguration()initialized to the given value.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"}}}
-
fromOpenIdConnectConfiguration
public static Configuration fromOpenIdConnectConfiguration(OpenIdConnectConfiguration openIdConnectConfiguration)
Create an instance of this class withopenIdConnectConfiguration()initialized to the given value.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"}}}
-
fromOpenIdConnectConfiguration
public static Configuration fromOpenIdConnectConfiguration(Consumer<OpenIdConnectConfiguration.Builder> openIdConnectConfiguration)
Create an instance of this class withopenIdConnectConfiguration()initialized to the given value.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"}}}
-
type
public Configuration.Type type()
Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will beConfiguration.Type.UNKNOWN_TO_SDK_VERSIONif the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will beConfiguration.Type.UNKNOWN_TO_SDK_VERSIONif zero members are set, andnullif more than one member is set.
-
-