Class CfnSAMLProviderProps

Properties for defining a CfnSAMLProvider.

Inheritance
System.Object
CfnSAMLProviderProps
Namespace: Amazon.CDK.AWS.IAM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSAMLProviderProps : Object, ICfnSAMLProviderProps
Syntax (vb)
Public Class CfnSAMLProviderProps
    Inherits Object
    Implements ICfnSAMLProviderProps
Remarks

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

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 cfnSAMLProviderProps = new CfnSAMLProviderProps {
    AddPrivateKey = "addPrivateKey",
    AssertionEncryptionMode = "assertionEncryptionMode",
    Name = "name",
    PrivateKeyList = new [] { new SAMLPrivateKeyProperty {
        KeyId = "keyId",
        Timestamp = "timestamp"
    } },
    RemovePrivateKey = "removePrivateKey",
    SamlMetadataDocument = "samlMetadataDocument",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};

Synopsis

Constructors

CfnSAMLProviderProps()

Properties

AddPrivateKey

Specifies the new private key from your external identity provider.
AssertionEncryptionMode

Specifies the encryption setting for the SAML provider.
Name

The name of the provider to create.
PrivateKeyList

The private key metadata for the SAML provider.
RemovePrivateKey

The Key ID of the private key to remove.
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

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

Constructors

CfnSAMLProviderProps()

public CfnSAMLProviderProps()

Properties

AddPrivateKey

Specifies the new private key from your external identity provider.

public string AddPrivateKey { get; set; }
Property Value

System.String

Remarks

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

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

AssertionEncryptionMode

Specifies the encryption setting for the SAML provider.

public string AssertionEncryptionMode { get; set; }
Property Value

System.String

Remarks

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

Name

The name of the provider to create.

public string Name { get; set; }
Property Value

System.String

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-samlprovider.html#cfn-iam-samlprovider-name

PrivateKeyList

The private key metadata for the SAML provider.

public object PrivateKeyList { get; set; }
Property Value

System.Object

Remarks

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

RemovePrivateKey

The Key ID of the private key to remove.

public string RemovePrivateKey { get; set; }
Property Value

System.String

Remarks

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

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 string SamlMetadataDocument { get; set; }
Property Value

System.String

Remarks

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

Tags

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

public ICfnTag[] Tags { get; set; }
Property Value

ICfnTag[]

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-samlprovider.html#cfn-iam-samlprovider-tags

Implements