CfnIdentityProviderConfigProps

class aws_cdk.aws_eks.CfnIdentityProviderConfigProps(*, cluster_name, type, identity_provider_config_name=None, oidc=None, tags=None)

Bases: object

Properties for defining a CfnIdentityProviderConfig.

Parameters
  • cluster_name (str) – The cluster that the configuration is associated to.

  • type (str) – The type of the identity provider configuration. The only type available is oidc .

  • identity_provider_config_name (Optional[str]) – The name of the configuration.

  • oidc (Union[IResolvable, OidcIdentityProviderConfigProperty, Dict[str, Any], None]) – An object representing an OpenID Connect (OIDC) identity provider configuration.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-identityproviderconfig.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.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"
    )]
)

Attributes

cluster_name

The cluster that the configuration is associated to.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-identityproviderconfig.html#cfn-eks-identityproviderconfig-clustername

Return type

str

identity_provider_config_name

The name of the configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-identityproviderconfig.html#cfn-eks-identityproviderconfig-identityproviderconfigname

Return type

Optional[str]

oidc

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-identityproviderconfig.html#cfn-eks-identityproviderconfig-oidc

Return type

Union[IResolvable, OidcIdentityProviderConfigProperty, None]

tags

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-identityproviderconfig.html#cfn-eks-identityproviderconfig-tags

Return type

Optional[List[CfnTag]]

type

The type of the identity provider configuration.

The only type available is oidc .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-identityproviderconfig.html#cfn-eks-identityproviderconfig-type

Return type

str