Class CfnIdentityProviderConfig
Associates an identity provider configuration to a cluster.
Inherited Members
Namespace: Amazon.CDK.AWS.EKS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnIdentityProviderConfig : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnIdentityProviderConfig
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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 Role
and ClusterRole
objects, assign permissions to them, and then bind them to the identities using Kubernetes RoleBinding
and ClusterRoleBinding
objects. For more information see Using RBAC Authorization in the Kubernetes documentation.
CloudformationResource: AWS::EKS::IdentityProviderConfig
ExampleMetadata: fixture=_generated
Examples
// 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 cfnIdentityProviderConfig = new CfnIdentityProviderConfig(this, "MyCfnIdentityProviderConfig", 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"
} }
});
Synopsis
Constructors
CfnIdentityProviderConfig(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnIdentityProviderConfig(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnIdentityProviderConfig(Construct, String, ICfnIdentityProviderConfigProps) |
Properties
AttrIdentityProviderConfigArn | The Amazon Resource Name (ARN) associated with the identity provider config. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ClusterName | The name of your cluster. |
IdentityProviderConfigName | The name of the configuration. |
Oidc | An object representing an OpenID Connect (OIDC) identity provider configuration. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | Metadata that assists with categorization and organization. |
Type | The type of the identity provider configuration. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnIdentityProviderConfig(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnIdentityProviderConfig(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnIdentityProviderConfig(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnIdentityProviderConfig(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnIdentityProviderConfig(Construct, String, ICfnIdentityProviderConfigProps)
public CfnIdentityProviderConfig(Construct scope, string id, ICfnIdentityProviderConfigProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnIdentityProviderConfigProps
Resource properties.
Properties
AttrIdentityProviderConfigArn
The Amazon Resource Name (ARN) associated with the identity provider config.
public virtual string AttrIdentityProviderConfigArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: IdentityProviderConfigArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ClusterName
The name of your cluster.
public virtual string ClusterName { get; set; }
Property Value
System.String
IdentityProviderConfigName
The name of the configuration.
public virtual string IdentityProviderConfigName { get; set; }
Property Value
System.String
Oidc
An object representing an OpenID Connect (OIDC) identity provider configuration.
public virtual object Oidc { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Metadata that assists with categorization and organization.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Type
The type of the identity provider configuration.
public virtual string Type { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>