Class CfnIdentityProviderConfig
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.eks.CfnIdentityProviderConfig
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.92.0 (build db7f27d)",
date="2023-12-06T04:49:38.350Z")
@Stability(Stable)
public class CfnIdentityProviderConfig
extends CfnResource
implements IInspectable, ITaggable
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.*; 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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnIdentityProviderConfig
.static interface
An object representing the configuration for an OpenID Connect (OIDC) identity provider.static interface
A key-value pair that describes a required claim in the identity token.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnIdentityProviderConfig
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnIdentityProviderConfig
(software.amazon.jsii.JsiiObjectRef objRef) CfnIdentityProviderConfig
(software.constructs.Construct scope, String id, CfnIdentityProviderConfigProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) associated with the identity provider config.The cluster that the configuration is associated to.The name of the configuration.getOidc()
An object representing an OpenID Connect (OIDC) identity provider configuration.getTags()
Tag Manager which manages the tags for this resource.The metadata to apply to the provider configuration to assist with categorization and organization.getType()
The type of the identity provider configuration.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setClusterName
(String value) The cluster that the configuration is associated to.void
The name of the configuration.void
setOidc
(IResolvable value) An object representing an OpenID Connect (OIDC) identity provider configuration.void
An object representing an OpenID Connect (OIDC) identity provider configuration.void
setTagsRaw
(List<CfnTag> value) The metadata to apply to the provider configuration to assist with categorization and organization.void
The type of the identity provider configuration.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnIdentityProviderConfig
protected CfnIdentityProviderConfig(software.amazon.jsii.JsiiObjectRef objRef) -
CfnIdentityProviderConfig
protected CfnIdentityProviderConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnIdentityProviderConfig
@Stability(Stable) public CfnIdentityProviderConfig(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIdentityProviderConfigProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrIdentityProviderConfigArn
The Amazon Resource Name (ARN) associated with the identity provider config. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getClusterName
The cluster that the configuration is associated to. -
setClusterName
The cluster that the configuration is associated to. -
getType
The type of the identity provider configuration. -
setType
The type of the identity provider configuration. -
getIdentityProviderConfigName
The name of the configuration. -
setIdentityProviderConfigName
The name of the configuration. -
getOidc
An object representing an OpenID Connect (OIDC) identity provider configuration. -
setOidc
An object representing an OpenID Connect (OIDC) identity provider configuration. -
setOidc
@Stability(Stable) public void setOidc(@Nullable CfnIdentityProviderConfig.OidcIdentityProviderConfigProperty value) An object representing an OpenID Connect (OIDC) identity provider configuration. -
getTagsRaw
The metadata to apply to the provider configuration to assist with categorization and organization. -
setTagsRaw
The metadata to apply to the provider configuration to assist with categorization and organization.
-