AWS CDK Reference

Appearance

v2.275.0

CfnIdentityProviderConfigProps Struct ​

Properties for defining a CfnIdentityProviderConfig.

Source
Generated code
Type last changed
v2.268.0 · 2 Sep 2026

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 cfnIdentityProviderConfigProps: eks_v2.CfnIdentityProviderConfigProps = {
  clusterName: 'clusterName',
  type: 'type',

  // the properties below are optional
  identityProviderConfigName: 'identityProviderConfigName',
  oidc: {
    clientId: 'clientId',
    issuerUrl: 'issuerUrl',

    // the properties below are optional
    groupsClaim: 'groupsClaim',
    groupsPrefix: 'groupsPrefix',
    requiredClaims: [{
      key: 'key',
      value: 'value',
    }],
    usernameClaim: 'usernameClaim',
    usernamePrefix: 'usernamePrefix',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

clusterNamestringcluster_namestrclusterNameStringClusterNamestringClusterName*stringrequired#
The name of your cluster.
identityProviderConfigNameoptionalstringidentity_provider_config_nameoptionalstridentityProviderConfigNameoptionalStringIdentityProviderConfigNameoptionalstringIdentityProviderConfigNameoptional*string#
The name of the configuration.
oidcoptionalIResolvable | CfnIdentityProviderConfig.OidcIdentityProviderConfigPropertyoidcoptionaltyping.Union[IResolvable, OidcIdentityProviderConfigProperty]oidcoptionalIResolvableOidcoptionalIResolvableOidcoptionalinterface{}#
An object representing an OpenID Connect (OIDC) identity provider configuration.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
Metadata that assists with categorization and organization.

Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or AWS resources.

typestringtypestrtypeStringTypestringType*stringrequired#
The type of the identity provider configuration.

The only type available is oidc .