Skip to content
v2.278.0

CfnIdentityProviderConfigProps Struct ​

Properties for defining a CfnIdentityProviderConfig.

Example ​

ts
// 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',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_eks as eks

cfn_identity_provider_config_props = eks.CfnIdentityProviderConfigProps(
    cluster_name="clusterName",
    type="type",

    # the properties below are optional
    identity_provider_config_name="identityProviderConfigName",
    oidc=eks.CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty(
        client_id="clientId",
        issuer_url="issuerUrl",

        # the properties below are optional
        groups_claim="groupsClaim",
        groups_prefix="groupsPrefix",
        required_claims=[eks.CfnIdentityProviderConfig.RequiredClaimProperty(
            key="key",
            value="value"
        )],
        username_claim="usernameClaim",
        username_prefix="usernamePrefix"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.eks.*;

CfnIdentityProviderConfigProps cfnIdentityProviderConfigProps = CfnIdentityProviderConfigProps.builder()
        .clusterName("clusterName")
        .type("type")

        // the properties below are optional
        .identityProviderConfigName("identityProviderConfigName")
        .oidc(OidcIdentityProviderConfigProperty.builder()
                .clientId("clientId")
                .issuerUrl("issuerUrl")

                // the properties below are optional
                .groupsClaim("groupsClaim")
                .groupsPrefix("groupsPrefix")
                .requiredClaims(List.of(RequiredClaimProperty.builder()
                        .key("key")
                        .value("value")
                        .build()))
                .usernameClaim("usernameClaim")
                .usernamePrefix("usernamePrefix")
                .build())
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EKS;

var cfnIdentityProviderConfigProps = new CfnIdentityProviderConfigProps {
    ClusterName = "clusterName",
    Type = "type",

    // the properties below are optional
    IdentityProviderConfigName = "identityProviderConfigName",
    Oidc = new OidcIdentityProviderConfigProperty {
        ClientId = "clientId",
        IssuerUrl = "issuerUrl",

        // the properties below are optional
        GroupsClaim = "groupsClaim",
        GroupsPrefix = "groupsPrefix",
        RequiredClaims = new [] { new RequiredClaimProperty {
            Key = "key",
            Value = "value"
        } },
        UsernameClaim = "usernameClaim",
        UsernamePrefix = "usernamePrefix"
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnIdentityProviderConfigProps := &CfnIdentityProviderConfigProps{
	ClusterName: jsii.String("clusterName"),
	Type: jsii.String("type"),

	// the properties below are optional
	IdentityProviderConfigName: jsii.String("identityProviderConfigName"),
	Oidc: &OidcIdentityProviderConfigProperty{
		ClientId: jsii.String("clientId"),
		IssuerUrl: jsii.String("issuerUrl"),

		// the properties below are optional
		GroupsClaim: jsii.String("groupsClaim"),
		GroupsPrefix: jsii.String("groupsPrefix"),
		RequiredClaims: []interface{}{
			&RequiredClaimProperty{
				Key: jsii.String("key"),
				Value: jsii.String("value"),
			},
		},
		UsernameClaim: jsii.String("usernameClaim"),
		UsernamePrefix: jsii.String("usernamePrefix"),
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

clusterNamestringcluster_namestrclusterNameStringClusterNamestringClusterName*string required #
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*string required #
The type of the identity provider configuration.

The only type available is oidc .