Class CfnOIDCProvider

Namespace

Amazon.CDK.AWS.IAM

Assembly

Amazon.CDK.AWS.IAM.dll

A CloudFormation AWS::IAM::OIDCProvider.

public class CfnOIDCProvider : CfnResource, IInspectable

Inheritance

object

CfnOIDCProvider

Implements

IInspectable

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IAM;

             var cfnOIDCProvider = new CfnOIDCProvider(this, "MyCfnOIDCProvider", new CfnOIDCProviderProps {
                 ThumbprintList = new [] { "thumbprintList" },

                 // the properties below are optional
                 ClientIdList = new [] { "clientIdList" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Url = "url"
             });

Remarks

Creates or updates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC) .

The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between AWS and the OIDC provider.

When you create the IAM OIDC provider, you specify the following:

You get all of this information from the OIDC IdP that you want to use to access AWS .

When you update the IAM OIDC provider, you specify the following:

The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateOpenIDConnectProvider.html">CreateOpenIDConnectProvider</a> operation to highly privileged users.

CloudformationResource: AWS::IAM::OIDCProvider

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-oidcprovider.html

ExampleMetadata: fixture=_generated

Constructors

CfnOIDCProvider(Construct, string, ICfnOIDCProviderProps)

Create a new AWS::IAM::OIDCProvider.

public CfnOIDCProvider(Construct scope, string id, ICfnOIDCProviderProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id string

• scoped id of the resource.

props ICfnOIDCProviderProps

• resource properties.

Properties

AttrArn

Returns the Amazon Resource Name (ARN) for the specified AWS::IAM::OIDCProvider resource.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

ClientIdList

A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object.

public virtual string[]? ClientIdList { get; set; }

Property Value

string[]

Remarks

For more information, see CreateOpenIDConnectProvider .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-oidcprovider.html#cfn-iam-oidcprovider-clientidlist

Tags

A list of tags that are attached to the specified IAM OIDC provider.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-oidcprovider.html#cfn-iam-oidcprovider-tags

ThumbprintList

A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object.

public virtual string[] ThumbprintList { get; set; }

Property Value

string[]

Remarks

For more information, see CreateOpenIDConnectProvider .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-oidcprovider.html#cfn-iam-oidcprovider-thumbprintlist

Url

The URL that the IAM OIDC provider resource object is associated with.

public virtual string? Url { get; set; }

Property Value

string

Remarks

For more information, see CreateOpenIDConnectProvider .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-oidcprovider.html#cfn-iam-oidcprovider-url

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 IDictionary<string, object>

Returns

IDictionary<string, object>