Amazonka.EKS.Types.OidcIdentityProviderConfig

Documentation

data OidcIdentityProviderConfig

An object representing the configuration for an OpenID Connect (OIDC) identity provider.

See: newOidcIdentityProviderConfig smart constructor.

Constructors

OidcIdentityProviderConfig'

Fields

• clientId :: Maybe Text

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

• clusterName :: Maybe Text

  The cluster that the configuration is associated to.

• groupsClaim :: Maybe Text

  The JSON web token (JWT) claim that the provider uses to return your groups.

• groupsPrefix :: Maybe Text

  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:

• identityProviderConfigArn :: Maybe Text

  The ARN of the configuration.

• identityProviderConfigName :: Maybe Text

  The name of the configuration.

• issuerUrl :: Maybe Text

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

• requiredClaims :: Maybe (HashMap Text Text)

  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.

• status :: Maybe ConfigStatus

  The status of the OIDC identity provider.

• tags :: Maybe (HashMap Text Text)

  The metadata to apply to the provider configuration to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.

• usernameClaim :: Maybe Text

  The JSON Web token (JWT) claim that is used as the username.

• usernamePrefix :: Maybe Text

  The prefix that is prepended to username claims to prevent clashes with existing names. The prefix can't contain system:

Instances

FromJSON OidcIdentityProviderConfig

Defined in Amazonka.EKS.Types.OidcIdentityProviderConfig

Methods

parseJSON :: Value -> Parser OidcIdentityProviderConfig

parseJSONList :: Value -> Parser [OidcIdentityProviderConfig]

Generic OidcIdentityProviderConfig

Defined in Amazonka.EKS.Types.OidcIdentityProviderConfig

Associated Types

type Rep OidcIdentityProviderConfig :: Type -> Type

Methods

from :: OidcIdentityProviderConfig -> Rep OidcIdentityProviderConfig x

to :: Rep OidcIdentityProviderConfig x -> OidcIdentityProviderConfig

Read OidcIdentityProviderConfig

Defined in Amazonka.EKS.Types.OidcIdentityProviderConfig

Methods

readsPrec :: Int -> ReadS OidcIdentityProviderConfig

readList :: ReadS [OidcIdentityProviderConfig]

readPrec :: ReadPrec OidcIdentityProviderConfig

readListPrec :: ReadPrec [OidcIdentityProviderConfig]

Show OidcIdentityProviderConfig

Defined in Amazonka.EKS.Types.OidcIdentityProviderConfig

Methods

showsPrec :: Int -> OidcIdentityProviderConfig -> ShowS

show :: OidcIdentityProviderConfig -> String

showList :: [OidcIdentityProviderConfig] -> ShowS

NFData OidcIdentityProviderConfig

Defined in Amazonka.EKS.Types.OidcIdentityProviderConfig

Methods

rnf :: OidcIdentityProviderConfig -> ()

Eq OidcIdentityProviderConfig

Defined in Amazonka.EKS.Types.OidcIdentityProviderConfig

Methods

(==) :: OidcIdentityProviderConfig -> OidcIdentityProviderConfig -> Bool

(/=) :: OidcIdentityProviderConfig -> OidcIdentityProviderConfig -> Bool

Hashable OidcIdentityProviderConfig

Defined in Amazonka.EKS.Types.OidcIdentityProviderConfig

Methods

hashWithSalt :: Int -> OidcIdentityProviderConfig -> Int

hash :: OidcIdentityProviderConfig -> Int

type Rep OidcIdentityProviderConfig

Defined in Amazonka.EKS.Types.OidcIdentityProviderConfig

type Rep OidcIdentityProviderConfig = D1 ('MetaData "OidcIdentityProviderConfig" "Amazonka.EKS.Types.OidcIdentityProviderConfig" "amazonka-eks-2.0-7cAibD4zEbE2zPO6gnUh5m" 'False) (C1 ('MetaCons "OidcIdentityProviderConfig'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "groupsClaim") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "groupsPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "identityProviderConfigArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "identityProviderConfigName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "issuerUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "requiredClaims") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfigStatus)))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "usernameClaim") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "usernamePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newOidcIdentityProviderConfig :: OidcIdentityProviderConfig

Create a value of OidcIdentityProviderConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientId:OidcIdentityProviderConfig', oidcIdentityProviderConfig_clientId - This is also known as audience. The ID of the client application that makes authentication requests to the OIDC identity provider.

$sel:clusterName:OidcIdentityProviderConfig', oidcIdentityProviderConfig_clusterName - The cluster that the configuration is associated to.

$sel:groupsClaim:OidcIdentityProviderConfig', oidcIdentityProviderConfig_groupsClaim - The JSON web token (JWT) claim that the provider uses to return your groups.

$sel:groupsPrefix:OidcIdentityProviderConfig', oidcIdentityProviderConfig_groupsPrefix - 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:

$sel:identityProviderConfigArn:OidcIdentityProviderConfig', oidcIdentityProviderConfig_identityProviderConfigArn - The ARN of the configuration.

$sel:identityProviderConfigName:OidcIdentityProviderConfig', oidcIdentityProviderConfig_identityProviderConfigName - The name of the configuration.

$sel:issuerUrl:OidcIdentityProviderConfig', oidcIdentityProviderConfig_issuerUrl - The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens.

$sel:requiredClaims:OidcIdentityProviderConfig', oidcIdentityProviderConfig_requiredClaims - 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.

$sel:status:OidcIdentityProviderConfig', oidcIdentityProviderConfig_status - The status of the OIDC identity provider.

$sel:tags:OidcIdentityProviderConfig', oidcIdentityProviderConfig_tags - The metadata to apply to the provider configuration to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.

$sel:usernameClaim:OidcIdentityProviderConfig', oidcIdentityProviderConfig_usernameClaim - The JSON Web token (JWT) claim that is used as the username.

$sel:usernamePrefix:OidcIdentityProviderConfig', oidcIdentityProviderConfig_usernamePrefix - The prefix that is prepended to username claims to prevent clashes with existing names. The prefix can't contain system:

oidcIdentityProviderConfig_clientId :: Lens' OidcIdentityProviderConfig (Maybe Text)

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

oidcIdentityProviderConfig_clusterName :: Lens' OidcIdentityProviderConfig (Maybe Text)

The cluster that the configuration is associated to.

oidcIdentityProviderConfig_groupsClaim :: Lens' OidcIdentityProviderConfig (Maybe Text)

The JSON web token (JWT) claim that the provider uses to return your groups.

oidcIdentityProviderConfig_groupsPrefix :: Lens' OidcIdentityProviderConfig (Maybe Text)

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:

oidcIdentityProviderConfig_identityProviderConfigArn :: Lens' OidcIdentityProviderConfig (Maybe Text)

The ARN of the configuration.

oidcIdentityProviderConfig_identityProviderConfigName :: Lens' OidcIdentityProviderConfig (Maybe Text)

The name of the configuration.

oidcIdentityProviderConfig_issuerUrl :: Lens' OidcIdentityProviderConfig (Maybe Text)

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

oidcIdentityProviderConfig_requiredClaims :: Lens' OidcIdentityProviderConfig (Maybe (HashMap Text Text))

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.

oidcIdentityProviderConfig_status :: Lens' OidcIdentityProviderConfig (Maybe ConfigStatus)

The status of the OIDC identity provider.

oidcIdentityProviderConfig_tags :: Lens' OidcIdentityProviderConfig (Maybe (HashMap Text Text))

The metadata to apply to the provider configuration to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.

oidcIdentityProviderConfig_usernameClaim :: Lens' OidcIdentityProviderConfig (Maybe Text)

The JSON Web token (JWT) claim that is used as the username.

oidcIdentityProviderConfig_usernamePrefix :: Lens' OidcIdentityProviderConfig (Maybe Text)

The prefix that is prepended to username claims to prevent clashes with existing names. The prefix can't contain system: