Class CfnUserPoolIdentityProvider

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnUserPoolIdentityProvider

Implements

IInspectable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

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(Construct, string, ICfnUserPoolIdentityProviderProps)

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

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	The `AWS::Cognito::UserPoolIdentityProvider` resource creates an identity provider for a user pool.
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>)	The `AWS::Cognito::UserPoolIdentityProvider` resource creates an identity provider for a user pool.

Constructors

CfnUserPoolIdentityProvider(Construct, string, ICfnUserPoolIdentityProviderProps)

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

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

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnUserPoolIdentityProviderProps: Resource properties.

Remarks

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

CloudformationResource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: fixture=_generated

Properties

AttributeMapping

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

public virtual object? AttributeMapping { get; set; }

Property Value

object

Remarks

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

CloudformationResource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

CloudformationResource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: fixture=_generated

CfnProperties

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

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

CloudformationResource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: fixture=_generated

IdpIdentifiers

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

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

Property Value

string[]

Remarks

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

CloudformationResource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: fixture=_generated

ProviderDetails

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

public virtual object ProviderDetails { get; set; }

Property Value

object

Remarks

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

CloudformationResource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: fixture=_generated

ProviderName

The name that you want to assign to the IdP.

public virtual string ProviderName { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: fixture=_generated

ProviderType

The type of IdP that you want to add.

public virtual string ProviderType { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: fixture=_generated

UserPoolId

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

public virtual string UserPoolId { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: fixture=_generated

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.

Remarks

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

CloudformationResource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

CloudformationResource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: fixture=_generated

Implements

IInspectable