OidcIdentityProviderConfigProperty Struct
An object representing the configuration for an OpenID Connect (OIDC) identity provider.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eks_v2 as eks_v2 } from 'aws-cdk-lib';
const oidcIdentityProviderConfigProperty: eks_v2.CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty = {
clientId: 'clientId',
issuerUrl: 'issuerUrl',
// the properties below are optional
groupsClaim: 'groupsClaim',
groupsPrefix: 'groupsPrefix',
requiredClaims: [{
key: 'key',
value: 'value',
}],
usernameClaim: 'usernameClaim',
usernamePrefix: 'usernamePrefix',
};
Properties
This is also known as *audience* .
The ID of the client application that makes authentication requests to the OIDC identity provider.
groupsClaimoptionalstringgroups_claimoptionalstrgroupsClaimoptionalStringGroupsClaimoptionalstringGroupsClaimoptional*string#The JSON web token (JWT) claim that the provider uses to return your groups.
groupsPrefixoptionalstringgroups_prefixoptionalstrgroupsPrefixoptionalStringGroupsPrefixoptionalstringGroupsPrefixoptional*string#The prefix that is prepended to group claims to prevent clashes with existing names (such as `system:` groups).
For example, the value oidc: creates group names like oidc:engineering and oidc:infra . The prefix can't contain system:
The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens.
requiredClaimsoptionalIResolvable | IResolvable | CfnIdentityProviderConfig.RequiredClaimProperty[]required_claimsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, RequiredClaimProperty]]]requiredClaimsoptionalIResolvableRequiredClaimsoptionalIResolvableRequiredClaimsoptionalinterface{}#The key-value pairs that describe required claims in the identity token.
If set, each claim is verified to be present in the token with a matching value.
usernameClaimoptionalstringusername_claimoptionalstrusernameClaimoptionalStringUsernameClaimoptionalstringUsernameClaimoptional*string#The JSON Web token (JWT) claim that is used as the username.
usernamePrefixoptionalstringusername_prefixoptionalstrusernamePrefixoptionalStringUsernamePrefixoptionalstringUsernamePrefixoptional*string#The prefix that is prepended to username claims to prevent clashes with existing names.
The prefix can't contain system: