IdentityProvider class
Provides a Cognito User Identity Provider resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.cognito.UserPool("example", {
name: "example-pool",
autoVerifiedAttributes: ["email"],
});
const exampleProvider = new aws.cognito.IdentityProvider("example_provider", {
userPoolId: example.id,
providerName: "Google",
providerType: "Google",
providerDetails: {
authorize_scopes: "email",
client_id: "your client_id",
client_secret: "your client_secret",
},
attributeMapping: {
email: "email",
username: "sub",
},
});
import pulumi
import pulumi_aws as aws
example = aws.cognito.UserPool("example",
name="example-pool",
auto_verified_attributes=["email"])
example_provider = aws.cognito.IdentityProvider("example_provider",
user_pool_id=example.id,
provider_name="Google",
provider_type="Google",
provider_details={
"authorize_scopes": "email",
"client_id": "your client_id",
"client_secret": "your client_secret",
},
attribute_mapping={
"email": "email",
"username": "sub",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Cognito.UserPool("example", new()
{
Name = "example-pool",
AutoVerifiedAttributes = new[]
{
"email",
},
});
var exampleProvider = new Aws.Cognito.IdentityProvider("example_provider", new()
{
UserPoolId = example.Id,
ProviderName = "Google",
ProviderType = "Google",
ProviderDetails =
{
{ "authorize_scopes", "email" },
{ "client_id", "your client_id" },
{ "client_secret", "your client_secret" },
},
AttributeMapping =
{
{ "email", "email" },
{ "username", "sub" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cognito"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := cognito.NewUserPool(ctx, "example", &cognito.UserPoolArgs{
Name: pulumi.String("example-pool"),
AutoVerifiedAttributes: pulumi.StringArray{
pulumi.String("email"),
},
})
if err != nil {
return err
}
_, err = cognito.NewIdentityProvider(ctx, "example_provider", &cognito.IdentityProviderArgs{
UserPoolId: example.ID().ToIDOutput().ToStringOutput(),
ProviderName: pulumi.String("Google"),
ProviderType: pulumi.String("Google"),
ProviderDetails: pulumi.StringMap{
"authorize_scopes": pulumi.String("email"),
"client_id": pulumi.String("your client_id"),
"client_secret": pulumi.String("your client_secret"),
},
AttributeMapping: pulumi.StringMap{
"email": pulumi.String("email"),
"username": pulumi.String("sub"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_cognito_userpool" "example" {
name = "example-pool"
auto_verified_attributes = ["email"]
}
resource "aws_cognito_identityprovider" "example_provider" {
user_pool_id = aws_cognito_userpool.example.id
provider_name = "Google"
provider_type = "Google"
provider_details = {
"authorize_scopes" = "email"
"client_id" = "your client_id"
"client_secret" = "your client_secret"
}
attribute_mapping = {
"email" = "email"
"username" = "sub"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cognito.UserPool;
import com.pulumi.aws.cognito.UserPoolArgs;
import com.pulumi.aws.cognito.IdentityProvider;
import com.pulumi.aws.cognito.IdentityProviderArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new UserPool("example", UserPoolArgs.builder()
.name("example-pool")
.autoVerifiedAttributes("email")
.build());
var exampleProvider = new IdentityProvider("exampleProvider", IdentityProviderArgs.builder()
.userPoolId(example.id())
.providerName("Google")
.providerType("Google")
.providerDetails(Map.ofEntries(
Map.entry("authorize_scopes", "email"),
Map.entry("client_id", "your client_id"),
Map.entry("client_secret", "your client_secret")
))
.attributeMapping(Map.ofEntries(
Map.entry("email", "email"),
Map.entry("username", "sub")
))
.build());
}
}
resources:
example:
type: aws:cognito:UserPool
properties:
name: example-pool
autoVerifiedAttributes:
- email
exampleProvider:
type: aws:cognito:IdentityProvider
name: example_provider
properties:
userPoolId: ${example.id}
providerName: Google
providerType: Google
providerDetails:
authorize_scopes: email
client_id: your client_id
client_secret: your client_secret
attributeMapping:
email: email
username: sub
Import
Using pulumi import, import aws.cognito.IdentityProvider resources using their User Pool ID and Provider Name. For example:
$ pulumi import aws:cognito/identityProvider:IdentityProvider example us-west-2_abc123:CorpAD
Constructors
- IdentityProvider(String name, {IdentityProviderArgs? args, CustomResourceOptions? options})
-
Creates a new IdentityProvider.
nameThe Pulumi resource name.argsArguments used to configure this IdentityProvider. The set of arguments for IdentityProvider.optionsResource options controlling this resource's behavior. - IdentityProvider.reference(String urn)
- Creates a typed reference to an existing IdentityProvider resource.
Properties
-
attributeMapping
↔ Output<
Map< String, String> > -
The map of attribute mapping of user pool attributes. AttributeMapping in AWS API documentation
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
idpIdentifiers
↔ Output<
List< String> ?> -
The list of identity providers.
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
providerDetails
↔ Output<
Map< String, String> > -
The map of identity details, such as access token
latefinal
-
providerName
↔ Output<
String> -
The provider name
latefinal
-
providerType
↔ Output<
String> -
The provider type. See AWS API for valid values
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
userPoolId
↔ Output<
String> -
The user pool id
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {IdentityProviderState? state, CustomResourceOptions? options}) → IdentityProvider -
Gets an existing IdentityProvider resource's state with the given
nameandid.