software.amazon.awscdk.services.iam

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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.723Z")
 @Stability(value=Stable)
public class CfnOIDCProvider
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IAM::OIDCProvider`.

Creates 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 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 .

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")
         .thumbprintList(List.of("thumbprintList"))
         // the properties below are optional
         .clientIdList(List.of("clientIdList"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .url("url")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnOIDCProvider.Builder A fluent builder for CfnOIDCProvider.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnOIDCProvider(software.constructs.Construct scope, String id, CfnOIDCProviderProps props) Create a new `AWS::IAM::OIDCProvider`.
protected	CfnOIDCProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnOIDCProvider(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() Returns the Amazon Resource Name (ARN) for the specified `AWS::IAM::OIDCProvider` resource.
protected Map<String,Object>	getCfnProperties()
List<String>	getClientIdList() A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object.
TagManager	getTags() A list of tags that are attached to the specified IAM OIDC provider.
List<String>	getThumbprintList() A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object.
String	getUrl() The URL that the IAM OIDC provider resource object is associated with.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	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	setThumbprintList(List<String> value) A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object.
void	setUrl(String value) The URL that the IAM OIDC provider resource object is associated with.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnOIDCProvider

protected CfnOIDCProvider(software.amazon.jsii.JsiiObjectRef objRef)

CfnOIDCProvider

protected CfnOIDCProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnOIDCProvider

@Stability(value=Stable)
public CfnOIDCProvider(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnOIDCProviderProps props)

Create a new `AWS::IAM::OIDCProvider`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

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

getThumbprintList

@Stability(value=Stable)
 @NotNull
public List<String> getThumbprintList()

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

For more information, see CreateOpenIDConnectProvider .

setThumbprintList

@Stability(value=Stable)
public void setThumbprintList(@NotNull
                                                       List<String> value)

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

For more information, see CreateOpenIDConnectProvider .

getClientIdList

@Stability(value=Stable)
 @Nullable
public List<String> getClientIdList()

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

For more information, see CreateOpenIDConnectProvider .

setClientIdList

@Stability(value=Stable)
public void setClientIdList(@Nullable
                                                     List<String> value)

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

For more information, see CreateOpenIDConnectProvider .

getUrl

@Stability(value=Stable)
 @Nullable
public String getUrl()

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

For more information, see CreateOpenIDConnectProvider .

setUrl

@Stability(value=Stable)
public void setUrl(@Nullable
                                            String value)

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

For more information, see CreateOpenIDConnectProvider .