Package software.amazon.awscdk.mixins.preview.services.iam.mixins

Class CfnSAMLProviderPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.mixins.preview.core.Mixin
software.amazon.awscdk.mixins.preview.services.iam.mixins.CfnSAMLProviderPropsMixin
All Implemented Interfaces:
IMixin, software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:26.854Z") @Stability(Stable) public class CfnSAMLProviderPropsMixin extends Mixin implements IMixin
Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.

The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy. Such a policy can enable federated users who sign in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS .

When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.

This operation requires Signature Version 4 .

For more information, see Enabling SAML 2.0 federated users to access the AWS Management Console and About SAML 2.0-based federation in the IAM User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.mixins.preview.mixins.*;
 import software.amazon.awscdk.mixins.preview.services.iam.mixins.*;
 CfnSAMLProviderPropsMixin cfnSAMLProviderPropsMixin = CfnSAMLProviderPropsMixin.Builder.create(CfnSAMLProviderMixinProps.builder()
         .addPrivateKey("addPrivateKey")
         .assertionEncryptionMode("assertionEncryptionMode")
         .name("name")
         .privateKeyList(List.of(SAMLPrivateKeyProperty.builder()
                 .keyId("keyId")
                 .timestamp("timestamp")
                 .build()))
         .removePrivateKey("removePrivateKey")
         .samlMetadataDocument("samlMetadataDocument")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(PropertyMergeStrategy.OVERRIDE)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

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

  • Constructor Details

    • CfnSAMLProviderPropsMixin

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

    • CfnSAMLProviderPropsMixin

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

    • CfnSAMLProviderPropsMixin

      @Stability(Stable) public CfnSAMLProviderPropsMixin(@NotNull CfnSAMLProviderMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::IAM::SAMLProvider.

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

    • CfnSAMLProviderPropsMixin

      @Stability(Stable) public CfnSAMLProviderPropsMixin(@NotNull CfnSAMLProviderMixinProps props)
      Create a mixin to apply properties to AWS::IAM::SAMLProvider.

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

  • Method Details

    • applyTo

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

      Specified by:
      applyTo in interface 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 IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

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

    • getStrategy

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