Class IdentityProvider

Provides a Cognito User Identity Provider resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.Cognito.UserPool("example", new Aws.Cognito.UserPoolArgs
    {
        AutoVerifiedAttributes = 
        {
            "email",
        },
    });
    var exampleProvider = new Aws.Cognito.IdentityProvider("exampleProvider", new Aws.Cognito.IdentityProviderArgs
    {
        AttributeMapping = 
        {
            { "email", "email" },
            { "username", "sub" },
        },
        ProviderDetails = 
        {
            { "authorize_scopes", "email" },
            { "client_id", "your client_id" },
            { "client_secret", "your client_secret" },
        },
        ProviderName = "Google",
        ProviderType = "Google",
        UserPoolId = example.Id,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

IdentityProvider

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Cognito

Assembly: Pulumi.Aws.dll

Syntax

public class IdentityProvider : CustomResource

Constructors

IdentityProvider(String, IdentityProviderArgs, CustomResourceOptions)

Create a IdentityProvider resource with the given unique name, arguments, and options.

Declaration

public IdentityProvider(string name, IdentityProviderArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
IdentityProviderArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AttributeMapping

The map of attribute mapping of user pool attributes. AttributeMapping in AWS API documentation

Declaration

public Output<ImmutableDictionary<string, string>> AttributeMapping { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

IdpIdentifiers

The list of identity providers.

Declaration

public Output<ImmutableArray<string>> IdpIdentifiers { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

ProviderDetails

The map of identity details, such as access token

Declaration

public Output<ImmutableDictionary<string, object>> ProviderDetails { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

ProviderName

The provider name

Declaration

public Output<string> ProviderName { get; }

Property Value

Type	Description
Output<System.String>

ProviderType

The provider type. See AWS API for valid values

Declaration

public Output<string> ProviderType { get; }

Property Value

Type	Description
Output<System.String>

UserPoolId

The user pool id

Declaration

public Output<string> UserPoolId { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, IdentityProviderState, CustomResourceOptions)

Get an existing IdentityProvider resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static IdentityProvider Get(string name, Input<string> id, IdentityProviderState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
IdentityProviderState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
IdentityProvider