interface SamlProviderProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.IAM.SamlProviderProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsiam#SamlProviderProps |
![]() | software.amazon.awscdk.services.iam.SamlProviderProps |
![]() | aws_cdk.aws_iam.SamlProviderProps |
![]() | aws-cdk-lib » aws_iam » SamlProviderProps |
Properties for a SAML provider.
Example
const provider = new iam.SamlProvider(this, 'Provider', {
metadataDocument: iam.SamlMetadataDocument.fromFile('/path/to/saml-metadata-document.xml'),
});
new iam.Role(this, 'Role', {
assumedBy: new iam.SamlConsolePrincipal(provider),
});
Properties
Name | Type | Description |
---|---|---|
metadata | Saml | 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. |
name? | string | The name of the provider to create. |
metadataDocument
Type:
Saml
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.
name?
Type:
string
(optional, default: a CloudFormation generated name)
The name of the provider to create.
This parameter allows a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
Length must be between 1 and 128 characters.