@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:36.569Z") public class CfnOIDCProvider extends CfnResource implements IInspectable
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 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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnOIDCProvider.Builder
A fluent builder for
CfnOIDCProvider . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnOIDCProvider(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
Returns the Amazon Resource Name (ARN) for the specified `AWS::IAM::OIDCProvider` resource.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.util.List<java.lang.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.
|
java.util.List<java.lang.String> |
getThumbprintList()
A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object.
|
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setClientIdList(java.util.List<java.lang.String> value)
A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object.
|
void |
setThumbprintList(java.util.List<java.lang.String> value)
A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object.
|
void |
setUrl(java.lang.String value)
The URL that the IAM OIDC provider resource object is associated with.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnOIDCProvider(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnOIDCProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnOIDCProvider(Construct scope, java.lang.String id, CfnOIDCProviderProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide .
public java.util.List<java.lang.String> getThumbprintList()
For more information, see CreateOpenIDConnectProvider .
public void setThumbprintList(java.util.List<java.lang.String> value)
For more information, see CreateOpenIDConnectProvider .
public java.util.List<java.lang.String> getClientIdList()
For more information, see CreateOpenIDConnectProvider .
public void setClientIdList(java.util.List<java.lang.String> value)
For more information, see CreateOpenIDConnectProvider .
public java.lang.String getUrl()
For more information, see CreateOpenIDConnectProvider .
public void setUrl(java.lang.String value)
For more information, see CreateOpenIDConnectProvider .