Class CfnOIDCProvider
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.iam.CfnOIDCProvider
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-12T12:32:03.890Z")
@Stability(Stable)
public class CfnOIDCProvider
extends CfnResource
implements IInspectable, ITaggable
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:
- The URL of the OIDC identity provider (IdP) to trust
- A list of client IDs (also known as audiences) that identify the application or applications that are allowed to authenticate using the OIDC provider
- A list of tags that are attached to the specified IAM OIDC provider
- A list of thumbprints of one or more server certificates that the IdP uses
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 URL of the OIDC identity provider (IdP) to trust
- A list of client IDs (also known as audiences) that replaces the existing list of client IDs associated with the OIDC IdP
- A list of tags that replaces the existing list of tags attached to the specified IAM OIDC provider
- A list of thumbprints that replaces the existing list of server certificates thumbprints that the IdP uses
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 CreateOpenIDConnectProvider operation to highly privileged users.
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.iam.*; CfnOIDCProvider cfnOIDCProvider = CfnOIDCProvider.Builder.create(this, "MyCfnOIDCProvider") .clientIdList(List.of("clientIdList")) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .thumbprintList(List.of("thumbprintList")) .url("url") .build();
- See Also:
-
Nested Class Summary
Nested ClassesNested 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
CfnOIDCProvider
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnOIDCProvider
(software.amazon.jsii.JsiiObjectRef objRef) CfnOIDCProvider
(software.constructs.Construct scope, String id) CfnOIDCProvider
(software.constructs.Construct scope, String id, CfnOIDCProviderProps props) -
Method Summary
Modifier and TypeMethodDescriptionReturns the Amazon Resource Name (ARN) for the specifiedAWS::IAM::OIDCProvider
resource.A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object.getTags()
Tag Manager which manages the tags for this resource.A list of tags that are attached to the specified IAM OIDC provider.A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object.getUrl()
The URL that the IAM OIDC provider resource object is associated with.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setClientIdList
(List<String> value) A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object.void
setTagsRaw
(List<CfnTag> value) A list of tags that are attached to the specified IAM OIDC provider.void
setThumbprintList
(List<String> value) A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object.void
The URL that the IAM OIDC provider resource object is associated with.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
-
CfnOIDCProvider
protected CfnOIDCProvider(software.amazon.jsii.JsiiObjectRef objRef) -
CfnOIDCProvider
protected CfnOIDCProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnOIDCProvider
@Stability(Stable) public CfnOIDCProvider(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnOIDCProviderProps 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.
-
CfnOIDCProvider
@Stability(Stable) public CfnOIDCProvider(@NotNull software.constructs.Construct scope, @NotNull String id) - 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.
-
-
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.
-
getAttrArn
Returns the Amazon Resource Name (ARN) for the specifiedAWS::IAM::OIDCProvider
resource. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getClientIdList
A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object. -
setClientIdList
A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object. -
getTagsRaw
A list of tags that are attached to the specified IAM OIDC provider. -
setTagsRaw
A list of tags that are attached to the specified IAM OIDC provider. -
getThumbprintList
A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object. -
setThumbprintList
A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object. -
getUrl
The URL that the IAM OIDC provider resource object is associated with. -
setUrl
The URL that the IAM OIDC provider resource object is associated with.
-