aws-cdk-lib.aws_eks.CfnIdentityProviderConfigProps

CfnIdentityProviderConfigProps Struct

Properties for defining a CfnIdentityProviderConfig.

Source

Generated code

Type last changed

v2.16.0 · 12 Mar 2022

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eks as eks } from 'aws-cdk-lib';
const cfnIdentityProviderConfigProps: eks.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.

identityProviderConfigNamestringidentity_provider_config_namestridentityProviderConfigNameStringIdentityProviderConfigNamestringIdentityProviderConfigName*string#

The name of the configuration.

oidcIResolvable | CfnIdentityProviderConfig.OidcIdentityProviderConfigPropertyoidctyping.Union[IResolvable, OidcIdentityProviderConfigProperty]oidcIResolvableOidcIResolvableOidcinterface{}#

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

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]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 .

Used as props by

• CfnIdentityProviderConfig