Class CfnOIDCProvider
A CloudFormation AWS::IAM::OIDCProvider
.
Inherited Members
Namespace: Amazon.CDK.AWS.IAM
Assembly: Amazon.CDK.AWS.IAM.dll
Syntax (csharp)
public class CfnOIDCProvider : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnOIDCProvider
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
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
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"
});
Synopsis
Constructors
CfnOIDCProvider(Construct, String, ICfnOIDCProviderProps) | Create a new |
CfnOIDCProvider(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnOIDCProvider(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | Returns the Amazon Resource Name (ARN) for the specified |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ClientIdList | A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object. |
Tags | A list of tags that are attached to the specified IAM OIDC provider. |
ThumbprintList | A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object. |
Url | The URL that the IAM OIDC provider resource object is associated with. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
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 System.String
- scoped id of the resource.
- props ICfnOIDCProviderProps
- resource properties.
CfnOIDCProvider(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnOIDCProvider(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnOIDCProvider(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnOIDCProvider(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
Returns the Amazon Resource Name (ARN) for the specified AWS::IAM::OIDCProvider
resource.
public virtual string AttrArn { get; }
Property Value
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
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
System.String[]
Remarks
Tags
A list of tags that are attached to the specified IAM OIDC provider.
public virtual TagManager Tags { get; }
Property Value
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 .
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
System.String[]
Remarks
Url
The URL that the IAM OIDC provider resource object is associated with.
public virtual string Url { get; set; }
Property Value
System.String
Remarks
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>