Class CfnUserPoolIdentityProvider

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

A CloudFormation AWS::Cognito::UserPoolIdentityProvider.

public class CfnUserPoolIdentityProvider : CfnResource, IInspectable

Inheritance

object

CfnUserPoolIdentityProvider

Implements

IInspectable

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 {
                 ProviderName = "providerName",
                 ProviderType = "providerType",
                 UserPoolId = "userPoolId",

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

Remarks

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

CloudformationResource: AWS::Cognito::UserPoolIdentityProvider

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

ExampleMetadata: fixture=_generated

Constructors

CfnUserPoolIdentityProvider(Construct, string, ICfnUserPoolIdentityProviderProps)

Create a new AWS::Cognito::UserPoolIdentityProvider.

public CfnUserPoolIdentityProvider(Construct scope, string id, ICfnUserPoolIdentityProviderProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id string

• scoped id of the resource.

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

object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-attributemapping

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

IdpIdentifiers

A list of IdP identifiers.

public virtual string[]? IdpIdentifiers { get; set; }

Property Value

string[]

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-idpidentifiers

ProviderDetails

The IdP details. The following list describes the provider detail keys for each IdP type.

public virtual object ProviderDetails { get; set; }

Property Value

object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-providerdetails

ProviderName

The IdP name.

public virtual string ProviderName { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-providername

ProviderType

The IdP type.

public virtual string ProviderType { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-providertype

UserPoolId

The user pool ID.

public virtual string UserPoolId { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-userpoolid

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 IDictionary<string, object>

Returns

IDictionary<string, object>