Interface ICfnUserPoolIdentityProviderProps

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Properties for defining a CfnUserPoolIdentityProvider.

public interface ICfnUserPoolIdentityProviderProps

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

Properties

AttributeMapping

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

object? AttributeMapping { get; }

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.

string[]? IdpIdentifiers { get; }

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.

object? ProviderDetails { get; }

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.

string ProviderName { get; }

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.

string ProviderType { get; }

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.

string UserPoolId { get; }

Property Value

string

Remarks

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