1.204.0

interface CfnSAMLProviderProps

LanguageType name
.NETAmazon.CDK.AWS.IAM.CfnSAMLProviderProps
Javasoftware.amazon.awscdk.services.iam.CfnSAMLProviderProps
Pythonaws_cdk.aws_iam.CfnSAMLProviderProps
TypeScript @aws-cdk/aws-iam » CfnSAMLProviderProps

Properties for defining a CfnSAMLProvider.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as iam from '@aws-cdk/aws-iam';
const cfnSAMLProviderProps: iam.CfnSAMLProviderProps = {
  samlMetadataDocument: 'samlMetadataDocument',

  // the properties below are optional
  name: 'name',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
samlMetadataDocumentstringAn 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.
name?stringThe name of the provider to create.
tags?CfnTag[]A list of tags that you want to attach to the new IAM SAML provider.

samlMetadataDocument

Type: string

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

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: _+=,.@-

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.

← PreviousNext →