Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-eks-identityproviderconfig.json
Parent schema serverless-framework-configuration
Type: object

An object representing an Amazon EKS IdentityProviderConfig.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-eks.git

Properties

ClusterName string | Aws_CF_FunctionString required

The name of the identity provider configuration.

Type string | Aws_CF_FunctionString required

The type of the identity provider configuration.

IdentityProviderConfigName string | Aws_CF_FunctionString

The name of the OIDC provider configuration.

Oidc object

An object representing an OpenID Connect (OIDC) configuration.

7 nested properties
ClientId string | Aws_CF_FunctionString required

This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider.

IssuerUrl string | Aws_CF_FunctionString required

The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens.

GroupsClaim string | Aws_CF_FunctionString

The JWT claim that the provider uses to return your groups.

GroupsPrefix string | Aws_CF_FunctionString

The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups).

RequiredClaims RequiredClaim[]
uniqueItems=true
UsernameClaim string | Aws_CF_FunctionString

The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

UsernamePrefix string | Aws_CF_FunctionString

The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing.

Tags Tag[]

An array of key-value pairs to apply to this resource.

uniqueItems=true

Definitions

Tag object

A key-value pair to associate with a resource.

Key string | Aws_CF_FunctionString required

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string | Aws_CF_FunctionString required

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

RequiredClaim object

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.

Key string | Aws_CF_FunctionString required

The key of the requiredClaims.

Value string | Aws_CF_FunctionString required

The value for the requiredClaims.

OidcIdentityProviderConfig object

An object representing an OpenID Connect (OIDC) configuration.

ClientId string | Aws_CF_FunctionString required

This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider.

IssuerUrl string | Aws_CF_FunctionString required

The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens.

GroupsClaim string | Aws_CF_FunctionString

The JWT claim that the provider uses to return your groups.

GroupsPrefix string | Aws_CF_FunctionString

The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups).

RequiredClaims RequiredClaim[]
uniqueItems=true
UsernameClaim string | Aws_CF_FunctionString

The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

UsernamePrefix string | Aws_CF_FunctionString

The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing.