Class CfnUserPoolIdentityProviderProps

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Properties for defining a CfnUserPoolIdentityProvider.

public class CfnUserPoolIdentityProviderProps : ICfnUserPoolIdentityProviderProps

Inheritance

object

CfnUserPoolIdentityProviderProps

Implements

ICfnUserPoolIdentityProviderProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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

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

Remarks

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

ExampleMetadata: fixture=_generated

Constructors

CfnUserPoolIdentityProviderProps()

public CfnUserPoolIdentityProviderProps()

Properties

AttributeMapping

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

public 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

IdpIdentifiers

A list of IdP identifiers.

public 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 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 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 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 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