Class CfnSAMLProvider
Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.
Inherited Members
Namespace: Amazon.CDK.AWS.IAM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSAMLProvider : CfnResource, IInspectable, ITaggableSyntax (vb)
Public Class CfnSAMLProvider
Inherits CfnResource
Implements IInspectable, ITaggableRemarks
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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-samlprovider.html
CloudformationResource: AWS::IAM::SAMLProvider
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IAM;
var cfnSAMLProvider = new CfnSAMLProvider(this, "MyCfnSAMLProvider", new CfnSAMLProviderProps {
SamlMetadataDocument = "samlMetadataDocument",
// the properties below are optional
Name = "name",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});Synopsis
Constructors
| CfnSAMLProvider(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
| CfnSAMLProvider(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
| CfnSAMLProvider(Construct, String, ICfnSAMLProviderProps) |
Properties
| AttrArn | Returns the Amazon Resource Name (ARN) for the specified |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | |
| Name | The name of the provider to create. |
| 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. |
| Tags | Tag Manager which manages the tags for this resource. |
| TagsRaw | A list of tags that you want to attach to the new IAM SAML provider. |
Methods
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSAMLProvider(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSAMLProvider(ByRefValue reference)Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSAMLProvider(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSAMLProvider(DeputyBase.DeputyProps props)Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnSAMLProvider(Construct, String, ICfnSAMLProviderProps)
public CfnSAMLProvider(Construct scope, string id, ICfnSAMLProviderProps props)Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnSAMLProviderProps
Resource properties.
Properties
AttrArn
Returns the Amazon Resource Name (ARN) for the specified AWS::IAM::SAMLProvider resource.
public virtual string AttrArn { get; }Property Value
System.String
Remarks
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Name
The name of the provider to create.
public virtual string Name { get; set; }Property Value
System.String
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.
public virtual string SamlMetadataDocument { get; set; }Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }Property Value
TagsRaw
A list of tags that you want to attach to the new IAM SAML provider.
public virtual ICfnTag[] TagsRaw { get; set; }Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>