Class SamlProvider

A SAML provider.

Inheritance

object

Resource

SamlProvider

Implements

ISamlProvider

IResource

IConstruct

IDependable

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.IAM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class SamlProvider : Resource, ISamlProvider, IResource, IConstruct, IDependable

Syntax (vb)

Public Class SamlProvider Inherits Resource Implements ISamlProvider, IResource, IConstruct, IDependable

Remarks

ExampleMetadata: infused

Examples

var provider = new SamlProvider(this, "Provider", new SamlProviderProps {
                MetadataDocument = SamlMetadataDocument.FromFile("/path/to/saml-metadata-document.xml")
            });
            new Role(this, "Role", new RoleProps {
                AssumedBy = new SamlConsolePrincipal(provider)
            });

Synopsis

Constructors

SamlProvider(Construct, string, ISamlProviderProps)

A SAML provider.

Properties

PROPERTY_INJECTION_ID	Uniquely identifies this class.
SamlProviderArn	The Amazon Resource Name (ARN) of the provider.

Methods

FromSamlProviderArn(Construct, string, string)

Import an existing provider.

Constructors

SamlProvider(Construct, string, ISamlProviderProps)

A SAML provider.

public SamlProvider(Construct scope, string id, ISamlProviderProps props)

Parameters

scope Construct

id string

props ISamlProviderProps

Remarks

ExampleMetadata: infused

Examples

var provider = new SamlProvider(this, "Provider", new SamlProviderProps {
                MetadataDocument = SamlMetadataDocument.FromFile("/path/to/saml-metadata-document.xml")
            });
            new Role(this, "Role", new RoleProps {
                AssumedBy = new SamlConsolePrincipal(provider)
            });

Properties

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

ExampleMetadata: infused

SamlProviderArn

The Amazon Resource Name (ARN) of the provider.

public virtual string SamlProviderArn { get; }

Property Value

string

Remarks

ExampleMetadata: infused

Methods

FromSamlProviderArn(Construct, string, string)

Import an existing provider.

public static ISamlProvider FromSamlProviderArn(Construct scope, string id, string samlProviderArn)

Parameters

scope Construct

id string

samlProviderArn string

Returns

ISamlProvider

Remarks

ExampleMetadata: infused

Implements

ISamlProvider

IResource

Constructs.IConstruct

Constructs.IDependable