class CfnSAMLProviderPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.IAM.Mixins.CfnSAMLProviderPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiam/mixins#CfnSAMLProviderPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.iam.mixins.CfnSAMLProviderPropsMixin
Python	aws_cdk.mixins_preview.aws_iam.mixins.CfnSAMLProviderPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_iam » mixins » CfnSAMLProviderPropsMixin

Implements IMixin

Extends Mixin

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-samlprovider.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as iam_mixins } from '@aws-cdk/mixins-preview/aws-iam';
const cfnSAMLProviderPropsMixin = new iam_mixins.CfnSAMLProviderPropsMixin({
  addPrivateKey: 'addPrivateKey',
  assertionEncryptionMode: 'assertionEncryptionMode',
  name: 'name',
  privateKeyList: [{
    keyId: 'keyId',
    timestamp: 'timestamp',
  }],
  removePrivateKey: 'removePrivateKey',
  samlMetadataDocument: 'samlMetadataDocument',
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnSAMLProviderPropsMixin(props: CfnSAMLProviderMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnSAMLProviderMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::IAM::SAMLProvider.

Properties

Name	Type	Description
props	CfnSAMLProviderMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnSAMLProviderMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.