Class CfnUserPoolIdentityProvider

The AWS::Cognito::UserPoolIdentityProvider resource creates an identity provider for a user pool.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnUserPoolIdentityProvider
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnUserPoolIdentityProvider : CfnResource, IInspectable
Syntax (vb)
Public Class CfnUserPoolIdentityProvider
    Inherits CfnResource
    Implements IInspectable
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html

CloudformationResource: AWS::Cognito::UserPoolIdentityProvider

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.Cognito;

var attributeMapping;
var providerDetails;

var cfnUserPoolIdentityProvider = new CfnUserPoolIdentityProvider(this, "MyCfnUserPoolIdentityProvider", new CfnUserPoolIdentityProviderProps {
    ProviderDetails = providerDetails,
    ProviderName = "providerName",
    ProviderType = "providerType",
    UserPoolId = "userPoolId",

    // the properties below are optional
    AttributeMapping = attributeMapping,
    IdpIdentifiers = new [] { "idpIdentifiers" }
});

Synopsis

Constructors

CfnUserPoolIdentityProvider(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnUserPoolIdentityProvider(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnUserPoolIdentityProvider(Construct, String, ICfnUserPoolIdentityProviderProps)

Properties

AttributeMapping

A mapping of IdP attributes to standard and custom user pool attributes.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
IdpIdentifiers

An array of IdP identifiers, for example "IdPIdentifiers": [ "MyIdP", "MyIdP2" ] .
ProviderDetails

The scopes, URLs, and identifiers for your external identity provider.
ProviderName

The name that you want to assign to the IdP.
ProviderType

The type of IdP that you want to add.
UserPoolId

The Id of the user pool where you want to create an IdP.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnUserPoolIdentityProvider(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnUserPoolIdentityProvider(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnUserPoolIdentityProvider(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnUserPoolIdentityProvider(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnUserPoolIdentityProvider(Construct, String, ICfnUserPoolIdentityProviderProps)

public CfnUserPoolIdentityProvider(Construct scope, string id, ICfnUserPoolIdentityProviderProps 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 ICfnUserPoolIdentityProviderProps

Resource properties.

Properties

AttributeMapping

A mapping of IdP attributes to standard and custom user pool attributes.

public virtual object AttributeMapping { get; set; }
Property Value

System.Object

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

IdpIdentifiers

An array of IdP identifiers, for example &quot;IdPIdentifiers&quot;: [ &quot;MyIdP&quot;, &quot;MyIdP2&quot; ] .

public virtual string[] IdpIdentifiers { get; set; }
Property Value

System.String[]

ProviderDetails

The scopes, URLs, and identifiers for your external identity provider.

public virtual object ProviderDetails { get; set; }
Property Value

System.Object

ProviderName

The name that you want to assign to the IdP.

public virtual string ProviderName { get; set; }
Property Value

System.String

ProviderType

The type of IdP that you want to add.

public virtual string ProviderType { get; set; }
Property Value

System.String

UserPoolId

The Id of the user pool where you want to create an IdP.

public virtual string UserPoolId { get; set; }
Property Value

System.String

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>

Overrides

Implements