Package software.amazon.awscdk.cfnpropertymixins.services.iam

Class CfnOIDCProviderPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.iam.CfnOIDCProviderPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:59.996Z") @Stability(Stable) public class CfnOIDCProviderPropsMixin extends Mixin implements software.constructs.IMixin
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.cfnpropertymixins.services.iam.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnOIDCProviderPropsMixin cfnOIDCProviderPropsMixin = CfnOIDCProviderPropsMixin.Builder.create(CfnOIDCProviderMixinProps.builder()
         .clientIdList(List.of("clientIdList"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .thumbprintList(List.of("thumbprintList"))
         .url("url")
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnOIDCProviderPropsMixin

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

    • CfnOIDCProviderPropsMixin

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

    • CfnOIDCProviderPropsMixin

      @Stability(Stable) public CfnOIDCProviderPropsMixin(@NotNull CfnOIDCProviderMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::IAM::OIDCProvider.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnOIDCProviderPropsMixin

      @Stability(Stable) public CfnOIDCProviderPropsMixin(@NotNull CfnOIDCProviderMixinProps props)
      Create a mixin to apply properties to AWS::IAM::OIDCProvider.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnOIDCProviderMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()