@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:28:01.035Z") public class CfnIdentityProviderConfig extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnIdentityProviderConfig(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnIdentityProviderConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnIdentityProviderConfig(Construct scope, java.lang.String id, CfnIdentityProviderConfigProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrIdentityProviderConfigArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
Each tag consists of a key and an optional value. You define both.
public java.lang.String getClusterName()
public void setClusterName(java.lang.String value)
public java.lang.String getType()
The only type available is oidc
.
public void setType(java.lang.String value)
The only type available is oidc
.
public java.lang.String getIdentityProviderConfigName()
public void setIdentityProviderConfigName(java.lang.String value)
public java.lang.Object getOidc()
public void setOidc(IResolvable value)
public void setOidc(CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty value)