Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

2.187.0

interface CfnSAMLProviderProps

LanguageType name
.NETAmazon.CDK.AWS.IAM.CfnSAMLProviderProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiam#CfnSAMLProviderProps
Javasoftware.amazon.awscdk.services.iam.CfnSAMLProviderProps
Pythonaws_cdk.aws_iam.CfnSAMLProviderProps
TypeScript aws-cdk-lib » aws_iam » CfnSAMLProviderProps

Properties for defining a CfnSAMLProvider.

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 { aws_iam as iam } from 'aws-cdk-lib';
const cfnSAMLProviderProps: iam.CfnSAMLProviderProps = {
  addPrivateKey: 'addPrivateKey',
  assertionEncryptionMode: 'assertionEncryptionMode',
  name: 'name',
  privateKeyList: [{
    keyId: 'keyId',
    timestamp: 'timestamp',
  }],
  removePrivateKey: 'removePrivateKey',
  samlMetadataDocument: 'samlMetadataDocument',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
addPrivateKey?stringSpecifies the new private key from your external identity provider.
assertionEncryptionMode?stringSpecifies the encryption setting for the SAML provider.
name?stringThe name of the provider to create.
privateKeyList?IResolvable | IResolvable | SAMLPrivateKeyProperty[]The private key metadata for the SAML provider.
removePrivateKey?stringThe Key ID of the private key to remove.
samlMetadataDocument?stringAn XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.
tags?CfnTag[]A list of tags that you want to attach to the new IAM SAML provider.

addPrivateKey?

Type: string (optional)

Specifies the new private key from your external identity provider.

The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.

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

assertionEncryptionMode?

Type: string (optional)

Specifies the encryption setting for the SAML provider.

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

name?

Type: string (optional)

The name of the provider to create.

This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

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

privateKeyList?

Type: IResolvable | IResolvable | SAMLPrivateKeyProperty[] (optional)

The private key metadata for the SAML provider.

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

removePrivateKey?

Type: string (optional)

The Key ID of the private key to remove.

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

samlMetadataDocument?

Type: string (optional)

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

For more information, see 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#cfn-iam-samlprovider-samlmetadatadocument

tags?

Type: CfnTag[] (optional)

A list of tags that you want to attach to the new IAM SAML provider.

Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide .

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

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

← PreviousNext →