aws-cdk-lib.aws_eks.CfnIdentityProviderConfigProps

interface CfnIdentityProviderConfigProps

LanguageType name
.NETAmazon.CDK.AWS.EKS.CfnIdentityProviderConfigProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awseks#CfnIdentityProviderConfigProps
Javasoftware.amazon.awscdk.services.eks.CfnIdentityProviderConfigProps
Pythonaws_cdk.aws_eks.CfnIdentityProviderConfigProps
TypeScript aws-cdk-lib » aws_eks » CfnIdentityProviderConfigProps

Properties for defining a CfnIdentityProviderConfig.

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

NameTypeDescription
clusterNamestringThe cluster that the configuration is associated to.
typestringThe type of the identity provider configuration.
identityProviderConfigName?stringThe name of the configuration.
oidc?IResolvable | OidcIdentityProviderConfigPropertyAn object representing an OpenID Connect (OIDC) identity provider configuration.
tags?CfnTag[]The metadata to apply to the provider configuration to assist with categorization and organization.

clusterName

Type: string

The cluster that the configuration is associated to.


type

Type: string

The type of the identity provider configuration.

The only type available is oidc .


identityProviderConfigName?

Type: string (optional)

The name of the configuration.


oidc?

Type: IResolvable | OidcIdentityProviderConfigProperty (optional)

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


tags?

Type: CfnTag[] (optional)

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.