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.
Note
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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::IAM::SAMLProvider",
"Properties" : {
"AddPrivateKey" : String,
"AssertionEncryptionMode" : String,
"Name" : String,
"PrivateKeyList" : [ SAMLPrivateKey, ... ],
"RemovePrivateKey" : String,
"SamlMetadataDocument" : String,
"Tags" : [ Tag, ... ]
}
}
YAML
Type: AWS::IAM::SAMLProvider
Properties:
AddPrivateKey: String
AssertionEncryptionMode: String
Name: String
PrivateKeyList:
- SAMLPrivateKey
RemovePrivateKey: String
SamlMetadataDocument: String
Tags:
- Tag
Properties
AddPrivateKey-
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.
Required: No
Type: String
Pattern:
[\u0009\u000A\u000D\u0020-\u00FF]+Minimum:
1Maximum:
16384Update requires: Replacement
AssertionEncryptionMode-
Specifies the encryption setting for the SAML provider.
Required: No
Type: String
Allowed values:
Allowed | RequiredUpdate requires: No interruption
Name-
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: _+=,.@- Required: No
Type: String
Pattern:
[\w._-]+Minimum:
1Maximum:
128Update requires: Replacement
PrivateKeyList-
The private key metadata for the SAML provider.
Required: No
Type: Array of SAMLPrivateKey
Maximum:
2Update requires: No interruption
RemovePrivateKey-
The Key ID of the private key to remove.
Required: No
Type: String
Pattern:
[A-Z0-9]+Minimum:
22Maximum:
64Update requires: Replacement
SamlMetadataDocument-
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
Required: No
Type: String
Minimum:
1000Maximum:
10000000Update requires: No interruption
-
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.
Note
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.
Required: No
Type: Array of Tag
Maximum:
50Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN.
For more information about using the Ref function, see Ref.
Fn::GetAtt
The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.
Arn-
Returns the Amazon Resource Name (ARN) for the specified
AWS::IAM::SAMLProviderresource. SamlProviderUUID-
The unique identifier assigned to the SAML provider.
