interface CfnIdentityProviderConfigProps

Language	Type name
.NET	Amazon.CDK.AWS.EKS.Legacy.CfnIdentityProviderConfigProps
Java	software.amazon.awscdk.services.eks.legacy.CfnIdentityProviderConfigProps
Python	aws_cdk.aws_eks_legacy.CfnIdentityProviderConfigProps
TypeScript	@aws-cdk/aws-eks-legacy » 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 * as eks_legacy from '@aws-cdk/aws-eks-legacy';
const cfnIdentityProviderConfigProps: eks_legacy.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

Name	Type	Description
clusterName	string	The cluster that the configuration is associated to.
type	string	The type of the identity provider configuration.
identityProviderConfigName?	string	The name of the configuration.
oidc?	IResolvable | OidcIdentityProviderConfigProperty	An 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.