software.amazon.awscdk.services.eks.legacy

Class CfnIdentityProviderConfig

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.eks.legacy.CfnIdentityProviderConfig

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:26.893Z")
public class CfnIdentityProviderConfig
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EKS::IdentityProviderConfig`.

Associate an identity provider configuration to a cluster.

If you want to authenticate identities using an identity provider, you can create an identity provider configuration and associate it to your cluster. After configuring authentication to your cluster you can create Kubernetes roles and clusterroles to assign permissions to the roles, and then bind the roles to the identities using Kubernetes rolebindings and clusterrolebindings . For more information see Using RBAC Authorization in the Kubernetes documentation.

Example:

 // 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.legacy.*;
 CfnIdentityProviderConfig cfnIdentityProviderConfig = CfnIdentityProviderConfig.Builder.create(this, "MyCfnIdentityProviderConfig")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnIdentityProviderConfig.Builder A fluent builder for CfnIdentityProviderConfig.
static interface	CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty An object that represents the configuration for an OpenID Connect (OIDC) identity provider.
static interface	CfnIdentityProviderConfig.RequiredClaimProperty A key-value pair that describes a required claim in the identity token.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnIdentityProviderConfig(Construct scope, java.lang.String id, CfnIdentityProviderConfigProps props) Create a new `AWS::EKS::IdentityProviderConfig`.
protected	CfnIdentityProviderConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnIdentityProviderConfig(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrIdentityProviderConfigArn() The Amazon Resource Name (ARN) associated with the identity provider config.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getClusterName() The cluster that the configuration is associated to.
java.lang.String	getIdentityProviderConfigName() The name of the configuration.
java.lang.Object	getOidc() An object that represents an OpenID Connect (OIDC) identity provider configuration.
TagManager	getTags() The metadata to apply to the provider configuration to assist with categorization and organization.
java.lang.String	getType() The type of the identity provider configuration.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setClusterName(java.lang.String value) The cluster that the configuration is associated to.
void	setIdentityProviderConfigName(java.lang.String value) The name of the configuration.
void	setOidc(CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty value) An object that represents an OpenID Connect (OIDC) identity provider configuration.
void	setOidc(IResolvable value) An object that represents an OpenID Connect (OIDC) identity provider configuration.
void	setType(java.lang.String value) The type of the identity provider configuration.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnIdentityProviderConfig

protected CfnIdentityProviderConfig(software.amazon.jsii.JsiiObjectRef objRef)

CfnIdentityProviderConfig

protected CfnIdentityProviderConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnIdentityProviderConfig

public CfnIdentityProviderConfig(Construct scope,
                                 java.lang.String id,
                                 CfnIdentityProviderConfigProps props)

Create a new `AWS::EKS::IdentityProviderConfig`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrIdentityProviderConfigArn

public java.lang.String getAttrIdentityProviderConfigArn()

The Amazon Resource Name (ARN) associated with the identity provider config.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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.

getClusterName

public java.lang.String getClusterName()

The cluster that the configuration is associated to.

setClusterName

public void setClusterName(java.lang.String value)

The cluster that the configuration is associated to.

getType

public java.lang.String getType()

The type of the identity provider configuration.

The only type available is oidc .

setType

public void setType(java.lang.String value)

The type of the identity provider configuration.

The only type available is oidc .

getIdentityProviderConfigName

public java.lang.String getIdentityProviderConfigName()

The name of the configuration.

setIdentityProviderConfigName

public void setIdentityProviderConfigName(java.lang.String value)

The name of the configuration.

getOidc

public java.lang.Object getOidc()

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

setOidc

public void setOidc(IResolvable value)

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

setOidc

public void setOidc(CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty value)

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