cognito

package
v3.38.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 13, 2021 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetUserPoolsArgs

type GetUserPoolsArgs struct {
	// Name of the cognito user pools. Name is not a unique attribute for cognito user pool, so multiple pools might be returned with given name.
	Name string `pulumi:"name"`
}

A collection of arguments for invoking getUserPools.

type GetUserPoolsResult

type GetUserPoolsResult struct {
	Arns []string `pulumi:"arns"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The list of cognito user pool ids.
	Ids  []string `pulumi:"ids"`
	Name string   `pulumi:"name"`
}

A collection of values returned by getUserPools.

func GetUserPools

func GetUserPools(ctx *pulumi.Context, args *GetUserPoolsArgs, opts ...pulumi.InvokeOption) (*GetUserPoolsResult, error)

Use this data source to get a list of cognito user pools.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/apigateway"
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/cognito"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		selectedRestApi, err := apigateway.LookupRestApi(ctx, &apigateway.LookupRestApiArgs{
			Name: _var.Api_gateway_name,
		}, nil)
		if err != nil {
			return err
		}
		selectedUserPools, err := cognito.GetUserPools(ctx, &cognito.GetUserPoolsArgs{
			Name: _var.Cognito_user_pool_name,
		}, nil)
		if err != nil {
			return err
		}
		_, err = apigateway.NewAuthorizer(ctx, "cognito", &apigateway.AuthorizerArgs{
			Type:         pulumi.String("COGNITO_USER_POOLS"),
			RestApi:      pulumi.String(selectedRestApi.Id),
			ProviderArns: toPulumiStringArray(selectedUserPools.Arns),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
func toPulumiStringArray(arr []string) pulumi.StringArray {
	var pulumiArr pulumi.StringArray
	for _, v := range arr {
		pulumiArr = append(pulumiArr, pulumi.String(v))
	}
	return pulumiArr
}

```

type IdentityPool

type IdentityPool struct {
	pulumi.CustomResourceState

	// Whether the identity pool supports unauthenticated logins or not.
	AllowUnauthenticatedIdentities pulumi.BoolPtrOutput `pulumi:"allowUnauthenticatedIdentities"`
	// The ARN of the identity pool.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// An array of Amazon Cognito Identity user pools and their client IDs.
	CognitoIdentityProviders IdentityPoolCognitoIdentityProviderArrayOutput `pulumi:"cognitoIdentityProviders"`
	// The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your
	// backend and the Cognito service to communicate about the developer provider.
	DeveloperProviderName pulumi.StringPtrOutput `pulumi:"developerProviderName"`
	// The Cognito Identity Pool name.
	IdentityPoolName pulumi.StringOutput `pulumi:"identityPoolName"`
	// Set of OpendID Connect provider ARNs.
	OpenidConnectProviderArns pulumi.StringArrayOutput `pulumi:"openidConnectProviderArns"`
	// An array of Amazon Resource Names (ARNs) of the SAML provider for your identity.
	SamlProviderArns pulumi.StringArrayOutput `pulumi:"samlProviderArns"`
	// Key-Value pairs mapping provider names to provider app IDs.
	SupportedLoginProviders pulumi.StringMapOutput `pulumi:"supportedLoginProviders"`
	// A map of tags to assign to the Identity Pool.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

Provides an AWS Cognito Identity Pool.

## Import

Cognito Identity Pool can be imported using the name, e.g.

```sh

$ pulumi import aws:cognito/identityPool:IdentityPool mypool <identity-pool-id>

```

func GetIdentityPool

func GetIdentityPool(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *IdentityPoolState, opts ...pulumi.ResourceOption) (*IdentityPool, error)

GetIdentityPool gets an existing IdentityPool resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewIdentityPool

func NewIdentityPool(ctx *pulumi.Context,
	name string, args *IdentityPoolArgs, opts ...pulumi.ResourceOption) (*IdentityPool, error)

NewIdentityPool registers a new resource with the given unique name, arguments, and options.

func (*IdentityPool) ElementType added in v3.13.0

func (*IdentityPool) ElementType() reflect.Type

func (*IdentityPool) ToIdentityPoolOutput added in v3.13.0

func (i *IdentityPool) ToIdentityPoolOutput() IdentityPoolOutput

func (*IdentityPool) ToIdentityPoolOutputWithContext added in v3.13.0

func (i *IdentityPool) ToIdentityPoolOutputWithContext(ctx context.Context) IdentityPoolOutput

func (*IdentityPool) ToIdentityPoolPtrOutput added in v3.25.0

func (i *IdentityPool) ToIdentityPoolPtrOutput() IdentityPoolPtrOutput

func (*IdentityPool) ToIdentityPoolPtrOutputWithContext added in v3.25.0

func (i *IdentityPool) ToIdentityPoolPtrOutputWithContext(ctx context.Context) IdentityPoolPtrOutput

type IdentityPoolArgs

type IdentityPoolArgs struct {
	// Whether the identity pool supports unauthenticated logins or not.
	AllowUnauthenticatedIdentities pulumi.BoolPtrInput
	// An array of Amazon Cognito Identity user pools and their client IDs.
	CognitoIdentityProviders IdentityPoolCognitoIdentityProviderArrayInput
	// The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your
	// backend and the Cognito service to communicate about the developer provider.
	DeveloperProviderName pulumi.StringPtrInput
	// The Cognito Identity Pool name.
	IdentityPoolName pulumi.StringInput
	// Set of OpendID Connect provider ARNs.
	OpenidConnectProviderArns pulumi.StringArrayInput
	// An array of Amazon Resource Names (ARNs) of the SAML provider for your identity.
	SamlProviderArns pulumi.StringArrayInput
	// Key-Value pairs mapping provider names to provider app IDs.
	SupportedLoginProviders pulumi.StringMapInput
	// A map of tags to assign to the Identity Pool.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a IdentityPool resource.

func (IdentityPoolArgs) ElementType

func (IdentityPoolArgs) ElementType() reflect.Type

type IdentityPoolArray added in v3.25.0

type IdentityPoolArray []IdentityPoolInput

func (IdentityPoolArray) ElementType added in v3.25.0

func (IdentityPoolArray) ElementType() reflect.Type

func (IdentityPoolArray) ToIdentityPoolArrayOutput added in v3.25.0

func (i IdentityPoolArray) ToIdentityPoolArrayOutput() IdentityPoolArrayOutput

func (IdentityPoolArray) ToIdentityPoolArrayOutputWithContext added in v3.25.0

func (i IdentityPoolArray) ToIdentityPoolArrayOutputWithContext(ctx context.Context) IdentityPoolArrayOutput

type IdentityPoolArrayInput added in v3.25.0

type IdentityPoolArrayInput interface {
	pulumi.Input

	ToIdentityPoolArrayOutput() IdentityPoolArrayOutput
	ToIdentityPoolArrayOutputWithContext(context.Context) IdentityPoolArrayOutput
}

IdentityPoolArrayInput is an input type that accepts IdentityPoolArray and IdentityPoolArrayOutput values. You can construct a concrete instance of `IdentityPoolArrayInput` via:

IdentityPoolArray{ IdentityPoolArgs{...} }

type IdentityPoolArrayOutput added in v3.25.0

type IdentityPoolArrayOutput struct{ *pulumi.OutputState }

func (IdentityPoolArrayOutput) ElementType added in v3.25.0

func (IdentityPoolArrayOutput) ElementType() reflect.Type

func (IdentityPoolArrayOutput) Index added in v3.25.0

func (IdentityPoolArrayOutput) ToIdentityPoolArrayOutput added in v3.25.0

func (o IdentityPoolArrayOutput) ToIdentityPoolArrayOutput() IdentityPoolArrayOutput

func (IdentityPoolArrayOutput) ToIdentityPoolArrayOutputWithContext added in v3.25.0

func (o IdentityPoolArrayOutput) ToIdentityPoolArrayOutputWithContext(ctx context.Context) IdentityPoolArrayOutput

type IdentityPoolCognitoIdentityProvider

type IdentityPoolCognitoIdentityProvider struct {
	// The client ID for the Amazon Cognito Identity User Pool.
	ClientId *string `pulumi:"clientId"`
	// The provider name for an Amazon Cognito Identity User Pool.
	ProviderName *string `pulumi:"providerName"`
	// Whether server-side token validation is enabled for the identity provider’s token or not.
	ServerSideTokenCheck *bool `pulumi:"serverSideTokenCheck"`
}

type IdentityPoolCognitoIdentityProviderArgs

type IdentityPoolCognitoIdentityProviderArgs struct {
	// The client ID for the Amazon Cognito Identity User Pool.
	ClientId pulumi.StringPtrInput `pulumi:"clientId"`
	// The provider name for an Amazon Cognito Identity User Pool.
	ProviderName pulumi.StringPtrInput `pulumi:"providerName"`
	// Whether server-side token validation is enabled for the identity provider’s token or not.
	ServerSideTokenCheck pulumi.BoolPtrInput `pulumi:"serverSideTokenCheck"`
}

func (IdentityPoolCognitoIdentityProviderArgs) ElementType

func (IdentityPoolCognitoIdentityProviderArgs) ToIdentityPoolCognitoIdentityProviderOutput

func (i IdentityPoolCognitoIdentityProviderArgs) ToIdentityPoolCognitoIdentityProviderOutput() IdentityPoolCognitoIdentityProviderOutput

func (IdentityPoolCognitoIdentityProviderArgs) ToIdentityPoolCognitoIdentityProviderOutputWithContext

func (i IdentityPoolCognitoIdentityProviderArgs) ToIdentityPoolCognitoIdentityProviderOutputWithContext(ctx context.Context) IdentityPoolCognitoIdentityProviderOutput

type IdentityPoolCognitoIdentityProviderArray

type IdentityPoolCognitoIdentityProviderArray []IdentityPoolCognitoIdentityProviderInput

func (IdentityPoolCognitoIdentityProviderArray) ElementType

func (IdentityPoolCognitoIdentityProviderArray) ToIdentityPoolCognitoIdentityProviderArrayOutput

func (i IdentityPoolCognitoIdentityProviderArray) ToIdentityPoolCognitoIdentityProviderArrayOutput() IdentityPoolCognitoIdentityProviderArrayOutput

func (IdentityPoolCognitoIdentityProviderArray) ToIdentityPoolCognitoIdentityProviderArrayOutputWithContext

func (i IdentityPoolCognitoIdentityProviderArray) ToIdentityPoolCognitoIdentityProviderArrayOutputWithContext(ctx context.Context) IdentityPoolCognitoIdentityProviderArrayOutput

type IdentityPoolCognitoIdentityProviderArrayInput

type IdentityPoolCognitoIdentityProviderArrayInput interface {
	pulumi.Input

	ToIdentityPoolCognitoIdentityProviderArrayOutput() IdentityPoolCognitoIdentityProviderArrayOutput
	ToIdentityPoolCognitoIdentityProviderArrayOutputWithContext(context.Context) IdentityPoolCognitoIdentityProviderArrayOutput
}

IdentityPoolCognitoIdentityProviderArrayInput is an input type that accepts IdentityPoolCognitoIdentityProviderArray and IdentityPoolCognitoIdentityProviderArrayOutput values. You can construct a concrete instance of `IdentityPoolCognitoIdentityProviderArrayInput` via:

IdentityPoolCognitoIdentityProviderArray{ IdentityPoolCognitoIdentityProviderArgs{...} }

type IdentityPoolCognitoIdentityProviderArrayOutput

type IdentityPoolCognitoIdentityProviderArrayOutput struct{ *pulumi.OutputState }

func (IdentityPoolCognitoIdentityProviderArrayOutput) ElementType

func (IdentityPoolCognitoIdentityProviderArrayOutput) Index

func (IdentityPoolCognitoIdentityProviderArrayOutput) ToIdentityPoolCognitoIdentityProviderArrayOutput

func (o IdentityPoolCognitoIdentityProviderArrayOutput) ToIdentityPoolCognitoIdentityProviderArrayOutput() IdentityPoolCognitoIdentityProviderArrayOutput

func (IdentityPoolCognitoIdentityProviderArrayOutput) ToIdentityPoolCognitoIdentityProviderArrayOutputWithContext

func (o IdentityPoolCognitoIdentityProviderArrayOutput) ToIdentityPoolCognitoIdentityProviderArrayOutputWithContext(ctx context.Context) IdentityPoolCognitoIdentityProviderArrayOutput

type IdentityPoolCognitoIdentityProviderInput

type IdentityPoolCognitoIdentityProviderInput interface {
	pulumi.Input

	ToIdentityPoolCognitoIdentityProviderOutput() IdentityPoolCognitoIdentityProviderOutput
	ToIdentityPoolCognitoIdentityProviderOutputWithContext(context.Context) IdentityPoolCognitoIdentityProviderOutput
}

IdentityPoolCognitoIdentityProviderInput is an input type that accepts IdentityPoolCognitoIdentityProviderArgs and IdentityPoolCognitoIdentityProviderOutput values. You can construct a concrete instance of `IdentityPoolCognitoIdentityProviderInput` via:

IdentityPoolCognitoIdentityProviderArgs{...}

type IdentityPoolCognitoIdentityProviderOutput

type IdentityPoolCognitoIdentityProviderOutput struct{ *pulumi.OutputState }

func (IdentityPoolCognitoIdentityProviderOutput) ClientId

The client ID for the Amazon Cognito Identity User Pool.

func (IdentityPoolCognitoIdentityProviderOutput) ElementType

func (IdentityPoolCognitoIdentityProviderOutput) ProviderName

The provider name for an Amazon Cognito Identity User Pool.

func (IdentityPoolCognitoIdentityProviderOutput) ServerSideTokenCheck

Whether server-side token validation is enabled for the identity provider’s token or not.

func (IdentityPoolCognitoIdentityProviderOutput) ToIdentityPoolCognitoIdentityProviderOutput

func (o IdentityPoolCognitoIdentityProviderOutput) ToIdentityPoolCognitoIdentityProviderOutput() IdentityPoolCognitoIdentityProviderOutput

func (IdentityPoolCognitoIdentityProviderOutput) ToIdentityPoolCognitoIdentityProviderOutputWithContext

func (o IdentityPoolCognitoIdentityProviderOutput) ToIdentityPoolCognitoIdentityProviderOutputWithContext(ctx context.Context) IdentityPoolCognitoIdentityProviderOutput

type IdentityPoolInput added in v3.13.0

type IdentityPoolInput interface {
	pulumi.Input

	ToIdentityPoolOutput() IdentityPoolOutput
	ToIdentityPoolOutputWithContext(ctx context.Context) IdentityPoolOutput
}

type IdentityPoolMap added in v3.25.0

type IdentityPoolMap map[string]IdentityPoolInput

func (IdentityPoolMap) ElementType added in v3.25.0

func (IdentityPoolMap) ElementType() reflect.Type

func (IdentityPoolMap) ToIdentityPoolMapOutput added in v3.25.0

func (i IdentityPoolMap) ToIdentityPoolMapOutput() IdentityPoolMapOutput

func (IdentityPoolMap) ToIdentityPoolMapOutputWithContext added in v3.25.0

func (i IdentityPoolMap) ToIdentityPoolMapOutputWithContext(ctx context.Context) IdentityPoolMapOutput

type IdentityPoolMapInput added in v3.25.0

type IdentityPoolMapInput interface {
	pulumi.Input

	ToIdentityPoolMapOutput() IdentityPoolMapOutput
	ToIdentityPoolMapOutputWithContext(context.Context) IdentityPoolMapOutput
}

IdentityPoolMapInput is an input type that accepts IdentityPoolMap and IdentityPoolMapOutput values. You can construct a concrete instance of `IdentityPoolMapInput` via:

IdentityPoolMap{ "key": IdentityPoolArgs{...} }

type IdentityPoolMapOutput added in v3.25.0

type IdentityPoolMapOutput struct{ *pulumi.OutputState }

func (IdentityPoolMapOutput) ElementType added in v3.25.0

func (IdentityPoolMapOutput) ElementType() reflect.Type

func (IdentityPoolMapOutput) MapIndex added in v3.25.0

func (IdentityPoolMapOutput) ToIdentityPoolMapOutput added in v3.25.0

func (o IdentityPoolMapOutput) ToIdentityPoolMapOutput() IdentityPoolMapOutput

func (IdentityPoolMapOutput) ToIdentityPoolMapOutputWithContext added in v3.25.0

func (o IdentityPoolMapOutput) ToIdentityPoolMapOutputWithContext(ctx context.Context) IdentityPoolMapOutput

type IdentityPoolOutput added in v3.13.0

type IdentityPoolOutput struct {
	*pulumi.OutputState
}

func (IdentityPoolOutput) ElementType added in v3.13.0

func (IdentityPoolOutput) ElementType() reflect.Type

func (IdentityPoolOutput) ToIdentityPoolOutput added in v3.13.0

func (o IdentityPoolOutput) ToIdentityPoolOutput() IdentityPoolOutput

func (IdentityPoolOutput) ToIdentityPoolOutputWithContext added in v3.13.0

func (o IdentityPoolOutput) ToIdentityPoolOutputWithContext(ctx context.Context) IdentityPoolOutput

func (IdentityPoolOutput) ToIdentityPoolPtrOutput added in v3.25.0

func (o IdentityPoolOutput) ToIdentityPoolPtrOutput() IdentityPoolPtrOutput

func (IdentityPoolOutput) ToIdentityPoolPtrOutputWithContext added in v3.25.0

func (o IdentityPoolOutput) ToIdentityPoolPtrOutputWithContext(ctx context.Context) IdentityPoolPtrOutput

type IdentityPoolPtrInput added in v3.25.0

type IdentityPoolPtrInput interface {
	pulumi.Input

	ToIdentityPoolPtrOutput() IdentityPoolPtrOutput
	ToIdentityPoolPtrOutputWithContext(ctx context.Context) IdentityPoolPtrOutput
}

type IdentityPoolPtrOutput added in v3.25.0

type IdentityPoolPtrOutput struct {
	*pulumi.OutputState
}

func (IdentityPoolPtrOutput) ElementType added in v3.25.0

func (IdentityPoolPtrOutput) ElementType() reflect.Type

func (IdentityPoolPtrOutput) ToIdentityPoolPtrOutput added in v3.25.0

func (o IdentityPoolPtrOutput) ToIdentityPoolPtrOutput() IdentityPoolPtrOutput

func (IdentityPoolPtrOutput) ToIdentityPoolPtrOutputWithContext added in v3.25.0

func (o IdentityPoolPtrOutput) ToIdentityPoolPtrOutputWithContext(ctx context.Context) IdentityPoolPtrOutput

type IdentityPoolRoleAttachment

type IdentityPoolRoleAttachment struct {
	pulumi.CustomResourceState

	// An identity pool ID in the format REGION:GUID.
	IdentityPoolId pulumi.StringOutput `pulumi:"identityPoolId"`
	// A List of Role Mapping.
	RoleMappings IdentityPoolRoleAttachmentRoleMappingArrayOutput `pulumi:"roleMappings"`
	// The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.
	Roles pulumi.StringMapOutput `pulumi:"roles"`
}

Provides an AWS Cognito Identity Pool Roles Attachment.

## Example Usage

```go package main

import (

"fmt"

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/cognito"
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/iam"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		mainIdentityPool, err := cognito.NewIdentityPool(ctx, "mainIdentityPool", &cognito.IdentityPoolArgs{
			IdentityPoolName:               pulumi.String("identity pool"),
			AllowUnauthenticatedIdentities: pulumi.Bool(false),
			SupportedLoginProviders: pulumi.StringMap{
				"graph.facebook.com": pulumi.String("7346241598935555"),
			},
		})
		if err != nil {
			return err
		}
		authenticatedRole, err := iam.NewRole(ctx, "authenticatedRole", &iam.RoleArgs{
			AssumeRolePolicy: mainIdentityPool.ID().ApplyT(func(id string) (string, error) {
				return fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v", "{\n", "  \"Version\": \"2012-10-17\",\n", "  \"Statement\": [\n", "    {\n", "      \"Effect\": \"Allow\",\n", "      \"Principal\": {\n", "        \"Federated\": \"cognito-identity.amazonaws.com\"\n", "      },\n", "      \"Action\": \"sts:AssumeRoleWithWebIdentity\",\n", "      \"Condition\": {\n", "        \"StringEquals\": {\n", "          \"cognito-identity.amazonaws.com:aud\": \"", id, "\"\n", "        },\n", "        \"ForAnyValue:StringLike\": {\n", "          \"cognito-identity.amazonaws.com:amr\": \"authenticated\"\n", "        }\n", "      }\n", "    }\n", "  ]\n", "}\n"), nil
			}).(pulumi.StringOutput),
		})
		if err != nil {
			return err
		}
		_, err = iam.NewRolePolicy(ctx, "authenticatedRolePolicy", &iam.RolePolicyArgs{
			Role:   authenticatedRole.ID(),
			Policy: pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v", "{\n", "  \"Version\": \"2012-10-17\",\n", "  \"Statement\": [\n", "    {\n", "      \"Effect\": \"Allow\",\n", "      \"Action\": [\n", "        \"mobileanalytics:PutEvents\",\n", "        \"cognito-sync:*\",\n", "        \"cognito-identity:*\"\n", "      ],\n", "      \"Resource\": [\n", "        \"*\"\n", "      ]\n", "    }\n", "  ]\n", "}\n")),
		})
		if err != nil {
			return err
		}
		_, err = cognito.NewIdentityPoolRoleAttachment(ctx, "mainIdentityPoolRoleAttachment", &cognito.IdentityPoolRoleAttachmentArgs{
			IdentityPoolId: mainIdentityPool.ID(),
			RoleMappings: cognito.IdentityPoolRoleAttachmentRoleMappingArray{
				&cognito.IdentityPoolRoleAttachmentRoleMappingArgs{
					IdentityProvider:        pulumi.String("graph.facebook.com"),
					AmbiguousRoleResolution: pulumi.String("AuthenticatedRole"),
					Type:                    pulumi.String("Rules"),
					MappingRules: cognito.IdentityPoolRoleAttachmentRoleMappingMappingRuleArray{
						&cognito.IdentityPoolRoleAttachmentRoleMappingMappingRuleArgs{
							Claim:     pulumi.String("isAdmin"),
							MatchType: pulumi.String("Equals"),
							RoleArn:   authenticatedRole.Arn,
							Value:     pulumi.String("paid"),
						},
					},
				},
			},
			Roles: pulumi.StringMap{
				"authenticated": authenticatedRole.Arn,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Cognito Identity Pool Roles Attachment can be imported using the Identity Pool id, e.g.

```sh

$ pulumi import aws:cognito/identityPoolRoleAttachment:IdentityPoolRoleAttachment example <identity-pool-id>

```

func GetIdentityPoolRoleAttachment

func GetIdentityPoolRoleAttachment(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *IdentityPoolRoleAttachmentState, opts ...pulumi.ResourceOption) (*IdentityPoolRoleAttachment, error)

GetIdentityPoolRoleAttachment gets an existing IdentityPoolRoleAttachment resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewIdentityPoolRoleAttachment

func NewIdentityPoolRoleAttachment(ctx *pulumi.Context,
	name string, args *IdentityPoolRoleAttachmentArgs, opts ...pulumi.ResourceOption) (*IdentityPoolRoleAttachment, error)

NewIdentityPoolRoleAttachment registers a new resource with the given unique name, arguments, and options.

func (*IdentityPoolRoleAttachment) ElementType added in v3.13.0

func (*IdentityPoolRoleAttachment) ElementType() reflect.Type

func (*IdentityPoolRoleAttachment) ToIdentityPoolRoleAttachmentOutput added in v3.13.0

func (i *IdentityPoolRoleAttachment) ToIdentityPoolRoleAttachmentOutput() IdentityPoolRoleAttachmentOutput

func (*IdentityPoolRoleAttachment) ToIdentityPoolRoleAttachmentOutputWithContext added in v3.13.0

func (i *IdentityPoolRoleAttachment) ToIdentityPoolRoleAttachmentOutputWithContext(ctx context.Context) IdentityPoolRoleAttachmentOutput

func (*IdentityPoolRoleAttachment) ToIdentityPoolRoleAttachmentPtrOutput added in v3.25.0

func (i *IdentityPoolRoleAttachment) ToIdentityPoolRoleAttachmentPtrOutput() IdentityPoolRoleAttachmentPtrOutput

func (*IdentityPoolRoleAttachment) ToIdentityPoolRoleAttachmentPtrOutputWithContext added in v3.25.0

func (i *IdentityPoolRoleAttachment) ToIdentityPoolRoleAttachmentPtrOutputWithContext(ctx context.Context) IdentityPoolRoleAttachmentPtrOutput

type IdentityPoolRoleAttachmentArgs

type IdentityPoolRoleAttachmentArgs struct {
	// An identity pool ID in the format REGION:GUID.
	IdentityPoolId pulumi.StringInput
	// A List of Role Mapping.
	RoleMappings IdentityPoolRoleAttachmentRoleMappingArrayInput
	// The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.
	Roles pulumi.StringMapInput
}

The set of arguments for constructing a IdentityPoolRoleAttachment resource.

func (IdentityPoolRoleAttachmentArgs) ElementType

type IdentityPoolRoleAttachmentArray added in v3.25.0

type IdentityPoolRoleAttachmentArray []IdentityPoolRoleAttachmentInput

func (IdentityPoolRoleAttachmentArray) ElementType added in v3.25.0

func (IdentityPoolRoleAttachmentArray) ToIdentityPoolRoleAttachmentArrayOutput added in v3.25.0

func (i IdentityPoolRoleAttachmentArray) ToIdentityPoolRoleAttachmentArrayOutput() IdentityPoolRoleAttachmentArrayOutput

func (IdentityPoolRoleAttachmentArray) ToIdentityPoolRoleAttachmentArrayOutputWithContext added in v3.25.0

func (i IdentityPoolRoleAttachmentArray) ToIdentityPoolRoleAttachmentArrayOutputWithContext(ctx context.Context) IdentityPoolRoleAttachmentArrayOutput

type IdentityPoolRoleAttachmentArrayInput added in v3.25.0

type IdentityPoolRoleAttachmentArrayInput interface {
	pulumi.Input

	ToIdentityPoolRoleAttachmentArrayOutput() IdentityPoolRoleAttachmentArrayOutput
	ToIdentityPoolRoleAttachmentArrayOutputWithContext(context.Context) IdentityPoolRoleAttachmentArrayOutput
}

IdentityPoolRoleAttachmentArrayInput is an input type that accepts IdentityPoolRoleAttachmentArray and IdentityPoolRoleAttachmentArrayOutput values. You can construct a concrete instance of `IdentityPoolRoleAttachmentArrayInput` via:

IdentityPoolRoleAttachmentArray{ IdentityPoolRoleAttachmentArgs{...} }

type IdentityPoolRoleAttachmentArrayOutput added in v3.25.0

type IdentityPoolRoleAttachmentArrayOutput struct{ *pulumi.OutputState }

func (IdentityPoolRoleAttachmentArrayOutput) ElementType added in v3.25.0

func (IdentityPoolRoleAttachmentArrayOutput) Index added in v3.25.0

func (IdentityPoolRoleAttachmentArrayOutput) ToIdentityPoolRoleAttachmentArrayOutput added in v3.25.0

func (o IdentityPoolRoleAttachmentArrayOutput) ToIdentityPoolRoleAttachmentArrayOutput() IdentityPoolRoleAttachmentArrayOutput

func (IdentityPoolRoleAttachmentArrayOutput) ToIdentityPoolRoleAttachmentArrayOutputWithContext added in v3.25.0

func (o IdentityPoolRoleAttachmentArrayOutput) ToIdentityPoolRoleAttachmentArrayOutputWithContext(ctx context.Context) IdentityPoolRoleAttachmentArrayOutput

type IdentityPoolRoleAttachmentInput added in v3.13.0

type IdentityPoolRoleAttachmentInput interface {
	pulumi.Input

	ToIdentityPoolRoleAttachmentOutput() IdentityPoolRoleAttachmentOutput
	ToIdentityPoolRoleAttachmentOutputWithContext(ctx context.Context) IdentityPoolRoleAttachmentOutput
}

type IdentityPoolRoleAttachmentMap added in v3.25.0

type IdentityPoolRoleAttachmentMap map[string]IdentityPoolRoleAttachmentInput

func (IdentityPoolRoleAttachmentMap) ElementType added in v3.25.0

func (IdentityPoolRoleAttachmentMap) ToIdentityPoolRoleAttachmentMapOutput added in v3.25.0

func (i IdentityPoolRoleAttachmentMap) ToIdentityPoolRoleAttachmentMapOutput() IdentityPoolRoleAttachmentMapOutput

func (IdentityPoolRoleAttachmentMap) ToIdentityPoolRoleAttachmentMapOutputWithContext added in v3.25.0

func (i IdentityPoolRoleAttachmentMap) ToIdentityPoolRoleAttachmentMapOutputWithContext(ctx context.Context) IdentityPoolRoleAttachmentMapOutput

type IdentityPoolRoleAttachmentMapInput added in v3.25.0

type IdentityPoolRoleAttachmentMapInput interface {
	pulumi.Input

	ToIdentityPoolRoleAttachmentMapOutput() IdentityPoolRoleAttachmentMapOutput
	ToIdentityPoolRoleAttachmentMapOutputWithContext(context.Context) IdentityPoolRoleAttachmentMapOutput
}

IdentityPoolRoleAttachmentMapInput is an input type that accepts IdentityPoolRoleAttachmentMap and IdentityPoolRoleAttachmentMapOutput values. You can construct a concrete instance of `IdentityPoolRoleAttachmentMapInput` via:

IdentityPoolRoleAttachmentMap{ "key": IdentityPoolRoleAttachmentArgs{...} }

type IdentityPoolRoleAttachmentMapOutput added in v3.25.0

type IdentityPoolRoleAttachmentMapOutput struct{ *pulumi.OutputState }

func (IdentityPoolRoleAttachmentMapOutput) ElementType added in v3.25.0

func (IdentityPoolRoleAttachmentMapOutput) MapIndex added in v3.25.0

func (IdentityPoolRoleAttachmentMapOutput) ToIdentityPoolRoleAttachmentMapOutput added in v3.25.0

func (o IdentityPoolRoleAttachmentMapOutput) ToIdentityPoolRoleAttachmentMapOutput() IdentityPoolRoleAttachmentMapOutput

func (IdentityPoolRoleAttachmentMapOutput) ToIdentityPoolRoleAttachmentMapOutputWithContext added in v3.25.0

func (o IdentityPoolRoleAttachmentMapOutput) ToIdentityPoolRoleAttachmentMapOutputWithContext(ctx context.Context) IdentityPoolRoleAttachmentMapOutput

type IdentityPoolRoleAttachmentOutput added in v3.13.0

type IdentityPoolRoleAttachmentOutput struct {
	*pulumi.OutputState
}

func (IdentityPoolRoleAttachmentOutput) ElementType added in v3.13.0

func (IdentityPoolRoleAttachmentOutput) ToIdentityPoolRoleAttachmentOutput added in v3.13.0

func (o IdentityPoolRoleAttachmentOutput) ToIdentityPoolRoleAttachmentOutput() IdentityPoolRoleAttachmentOutput

func (IdentityPoolRoleAttachmentOutput) ToIdentityPoolRoleAttachmentOutputWithContext added in v3.13.0

func (o IdentityPoolRoleAttachmentOutput) ToIdentityPoolRoleAttachmentOutputWithContext(ctx context.Context) IdentityPoolRoleAttachmentOutput

func (IdentityPoolRoleAttachmentOutput) ToIdentityPoolRoleAttachmentPtrOutput added in v3.25.0

func (o IdentityPoolRoleAttachmentOutput) ToIdentityPoolRoleAttachmentPtrOutput() IdentityPoolRoleAttachmentPtrOutput

func (IdentityPoolRoleAttachmentOutput) ToIdentityPoolRoleAttachmentPtrOutputWithContext added in v3.25.0

func (o IdentityPoolRoleAttachmentOutput) ToIdentityPoolRoleAttachmentPtrOutputWithContext(ctx context.Context) IdentityPoolRoleAttachmentPtrOutput

type IdentityPoolRoleAttachmentPtrInput added in v3.25.0

type IdentityPoolRoleAttachmentPtrInput interface {
	pulumi.Input

	ToIdentityPoolRoleAttachmentPtrOutput() IdentityPoolRoleAttachmentPtrOutput
	ToIdentityPoolRoleAttachmentPtrOutputWithContext(ctx context.Context) IdentityPoolRoleAttachmentPtrOutput
}

type IdentityPoolRoleAttachmentPtrOutput added in v3.25.0

type IdentityPoolRoleAttachmentPtrOutput struct {
	*pulumi.OutputState
}

func (IdentityPoolRoleAttachmentPtrOutput) ElementType added in v3.25.0

func (IdentityPoolRoleAttachmentPtrOutput) ToIdentityPoolRoleAttachmentPtrOutput added in v3.25.0

func (o IdentityPoolRoleAttachmentPtrOutput) ToIdentityPoolRoleAttachmentPtrOutput() IdentityPoolRoleAttachmentPtrOutput

func (IdentityPoolRoleAttachmentPtrOutput) ToIdentityPoolRoleAttachmentPtrOutputWithContext added in v3.25.0

func (o IdentityPoolRoleAttachmentPtrOutput) ToIdentityPoolRoleAttachmentPtrOutputWithContext(ctx context.Context) IdentityPoolRoleAttachmentPtrOutput

type IdentityPoolRoleAttachmentRoleMapping

type IdentityPoolRoleAttachmentRoleMapping struct {
	// Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type. `Required` if you specify Token or Rules as the Type.
	AmbiguousRoleResolution *string `pulumi:"ambiguousRoleResolution"`
	// A string identifying the identity provider, for example, "graph.facebook.com" or "cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id".
	IdentityProvider string `pulumi:"identityProvider"`
	// The Rules Configuration to be used for mapping users to roles. You can specify up to 25 rules per identity provider. Rules are evaluated in order. The first one to match specifies the role.
	MappingRules []IdentityPoolRoleAttachmentRoleMappingMappingRule `pulumi:"mappingRules"`
	// The role mapping type.
	Type string `pulumi:"type"`
}

type IdentityPoolRoleAttachmentRoleMappingArgs

type IdentityPoolRoleAttachmentRoleMappingArgs struct {
	// Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type. `Required` if you specify Token or Rules as the Type.
	AmbiguousRoleResolution pulumi.StringPtrInput `pulumi:"ambiguousRoleResolution"`
	// A string identifying the identity provider, for example, "graph.facebook.com" or "cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id".
	IdentityProvider pulumi.StringInput `pulumi:"identityProvider"`
	// The Rules Configuration to be used for mapping users to roles. You can specify up to 25 rules per identity provider. Rules are evaluated in order. The first one to match specifies the role.
	MappingRules IdentityPoolRoleAttachmentRoleMappingMappingRuleArrayInput `pulumi:"mappingRules"`
	// The role mapping type.
	Type pulumi.StringInput `pulumi:"type"`
}

func (IdentityPoolRoleAttachmentRoleMappingArgs) ElementType

func (IdentityPoolRoleAttachmentRoleMappingArgs) ToIdentityPoolRoleAttachmentRoleMappingOutput

func (i IdentityPoolRoleAttachmentRoleMappingArgs) ToIdentityPoolRoleAttachmentRoleMappingOutput() IdentityPoolRoleAttachmentRoleMappingOutput

func (IdentityPoolRoleAttachmentRoleMappingArgs) ToIdentityPoolRoleAttachmentRoleMappingOutputWithContext

func (i IdentityPoolRoleAttachmentRoleMappingArgs) ToIdentityPoolRoleAttachmentRoleMappingOutputWithContext(ctx context.Context) IdentityPoolRoleAttachmentRoleMappingOutput

type IdentityPoolRoleAttachmentRoleMappingArray

type IdentityPoolRoleAttachmentRoleMappingArray []IdentityPoolRoleAttachmentRoleMappingInput

func (IdentityPoolRoleAttachmentRoleMappingArray) ElementType

func (IdentityPoolRoleAttachmentRoleMappingArray) ToIdentityPoolRoleAttachmentRoleMappingArrayOutput

func (i IdentityPoolRoleAttachmentRoleMappingArray) ToIdentityPoolRoleAttachmentRoleMappingArrayOutput() IdentityPoolRoleAttachmentRoleMappingArrayOutput

func (IdentityPoolRoleAttachmentRoleMappingArray) ToIdentityPoolRoleAttachmentRoleMappingArrayOutputWithContext

func (i IdentityPoolRoleAttachmentRoleMappingArray) ToIdentityPoolRoleAttachmentRoleMappingArrayOutputWithContext(ctx context.Context) IdentityPoolRoleAttachmentRoleMappingArrayOutput

type IdentityPoolRoleAttachmentRoleMappingArrayInput

type IdentityPoolRoleAttachmentRoleMappingArrayInput interface {
	pulumi.Input

	ToIdentityPoolRoleAttachmentRoleMappingArrayOutput() IdentityPoolRoleAttachmentRoleMappingArrayOutput
	ToIdentityPoolRoleAttachmentRoleMappingArrayOutputWithContext(context.Context) IdentityPoolRoleAttachmentRoleMappingArrayOutput
}

IdentityPoolRoleAttachmentRoleMappingArrayInput is an input type that accepts IdentityPoolRoleAttachmentRoleMappingArray and IdentityPoolRoleAttachmentRoleMappingArrayOutput values. You can construct a concrete instance of `IdentityPoolRoleAttachmentRoleMappingArrayInput` via:

IdentityPoolRoleAttachmentRoleMappingArray{ IdentityPoolRoleAttachmentRoleMappingArgs{...} }

type IdentityPoolRoleAttachmentRoleMappingArrayOutput

type IdentityPoolRoleAttachmentRoleMappingArrayOutput struct{ *pulumi.OutputState }

func (IdentityPoolRoleAttachmentRoleMappingArrayOutput) ElementType

func (IdentityPoolRoleAttachmentRoleMappingArrayOutput) Index

func (IdentityPoolRoleAttachmentRoleMappingArrayOutput) ToIdentityPoolRoleAttachmentRoleMappingArrayOutput

func (o IdentityPoolRoleAttachmentRoleMappingArrayOutput) ToIdentityPoolRoleAttachmentRoleMappingArrayOutput() IdentityPoolRoleAttachmentRoleMappingArrayOutput

func (IdentityPoolRoleAttachmentRoleMappingArrayOutput) ToIdentityPoolRoleAttachmentRoleMappingArrayOutputWithContext

func (o IdentityPoolRoleAttachmentRoleMappingArrayOutput) ToIdentityPoolRoleAttachmentRoleMappingArrayOutputWithContext(ctx context.Context) IdentityPoolRoleAttachmentRoleMappingArrayOutput

type IdentityPoolRoleAttachmentRoleMappingInput

type IdentityPoolRoleAttachmentRoleMappingInput interface {
	pulumi.Input

	ToIdentityPoolRoleAttachmentRoleMappingOutput() IdentityPoolRoleAttachmentRoleMappingOutput
	ToIdentityPoolRoleAttachmentRoleMappingOutputWithContext(context.Context) IdentityPoolRoleAttachmentRoleMappingOutput
}

IdentityPoolRoleAttachmentRoleMappingInput is an input type that accepts IdentityPoolRoleAttachmentRoleMappingArgs and IdentityPoolRoleAttachmentRoleMappingOutput values. You can construct a concrete instance of `IdentityPoolRoleAttachmentRoleMappingInput` via:

IdentityPoolRoleAttachmentRoleMappingArgs{...}

type IdentityPoolRoleAttachmentRoleMappingMappingRule

type IdentityPoolRoleAttachmentRoleMappingMappingRule struct {
	// The claim name that must be present in the token, for example, "isAdmin" or "paid".
	Claim string `pulumi:"claim"`
	// The match condition that specifies how closely the claim value in the IdP token must match Value.
	MatchType string `pulumi:"matchType"`
	// The role ARN.
	RoleArn string `pulumi:"roleArn"`
	// A brief string that the claim must match, for example, "paid" or "yes".
	Value string `pulumi:"value"`
}

type IdentityPoolRoleAttachmentRoleMappingMappingRuleArgs

type IdentityPoolRoleAttachmentRoleMappingMappingRuleArgs struct {
	// The claim name that must be present in the token, for example, "isAdmin" or "paid".
	Claim pulumi.StringInput `pulumi:"claim"`
	// The match condition that specifies how closely the claim value in the IdP token must match Value.
	MatchType pulumi.StringInput `pulumi:"matchType"`
	// The role ARN.
	RoleArn pulumi.StringInput `pulumi:"roleArn"`
	// A brief string that the claim must match, for example, "paid" or "yes".
	Value pulumi.StringInput `pulumi:"value"`
}

func (IdentityPoolRoleAttachmentRoleMappingMappingRuleArgs) ElementType

func (IdentityPoolRoleAttachmentRoleMappingMappingRuleArgs) ToIdentityPoolRoleAttachmentRoleMappingMappingRuleOutput

func (i IdentityPoolRoleAttachmentRoleMappingMappingRuleArgs) ToIdentityPoolRoleAttachmentRoleMappingMappingRuleOutput() IdentityPoolRoleAttachmentRoleMappingMappingRuleOutput

func (IdentityPoolRoleAttachmentRoleMappingMappingRuleArgs) ToIdentityPoolRoleAttachmentRoleMappingMappingRuleOutputWithContext

func (i IdentityPoolRoleAttachmentRoleMappingMappingRuleArgs) ToIdentityPoolRoleAttachmentRoleMappingMappingRuleOutputWithContext(ctx context.Context) IdentityPoolRoleAttachmentRoleMappingMappingRuleOutput

type IdentityPoolRoleAttachmentRoleMappingMappingRuleArray

type IdentityPoolRoleAttachmentRoleMappingMappingRuleArray []IdentityPoolRoleAttachmentRoleMappingMappingRuleInput

func (IdentityPoolRoleAttachmentRoleMappingMappingRuleArray) ElementType

func (IdentityPoolRoleAttachmentRoleMappingMappingRuleArray) ToIdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutput

func (i IdentityPoolRoleAttachmentRoleMappingMappingRuleArray) ToIdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutput() IdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutput

func (IdentityPoolRoleAttachmentRoleMappingMappingRuleArray) ToIdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutputWithContext

func (i IdentityPoolRoleAttachmentRoleMappingMappingRuleArray) ToIdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutputWithContext(ctx context.Context) IdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutput

type IdentityPoolRoleAttachmentRoleMappingMappingRuleArrayInput

type IdentityPoolRoleAttachmentRoleMappingMappingRuleArrayInput interface {
	pulumi.Input

	ToIdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutput() IdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutput
	ToIdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutputWithContext(context.Context) IdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutput
}

IdentityPoolRoleAttachmentRoleMappingMappingRuleArrayInput is an input type that accepts IdentityPoolRoleAttachmentRoleMappingMappingRuleArray and IdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutput values. You can construct a concrete instance of `IdentityPoolRoleAttachmentRoleMappingMappingRuleArrayInput` via:

IdentityPoolRoleAttachmentRoleMappingMappingRuleArray{ IdentityPoolRoleAttachmentRoleMappingMappingRuleArgs{...} }

type IdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutput

type IdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutput struct{ *pulumi.OutputState }

func (IdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutput) ElementType

func (IdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutput) Index

func (IdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutput) ToIdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutput

func (IdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutput) ToIdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutputWithContext

func (o IdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutput) ToIdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutputWithContext(ctx context.Context) IdentityPoolRoleAttachmentRoleMappingMappingRuleArrayOutput

type IdentityPoolRoleAttachmentRoleMappingMappingRuleInput

type IdentityPoolRoleAttachmentRoleMappingMappingRuleInput interface {
	pulumi.Input

	ToIdentityPoolRoleAttachmentRoleMappingMappingRuleOutput() IdentityPoolRoleAttachmentRoleMappingMappingRuleOutput
	ToIdentityPoolRoleAttachmentRoleMappingMappingRuleOutputWithContext(context.Context) IdentityPoolRoleAttachmentRoleMappingMappingRuleOutput
}

IdentityPoolRoleAttachmentRoleMappingMappingRuleInput is an input type that accepts IdentityPoolRoleAttachmentRoleMappingMappingRuleArgs and IdentityPoolRoleAttachmentRoleMappingMappingRuleOutput values. You can construct a concrete instance of `IdentityPoolRoleAttachmentRoleMappingMappingRuleInput` via:

IdentityPoolRoleAttachmentRoleMappingMappingRuleArgs{...}

type IdentityPoolRoleAttachmentRoleMappingMappingRuleOutput

type IdentityPoolRoleAttachmentRoleMappingMappingRuleOutput struct{ *pulumi.OutputState }

func (IdentityPoolRoleAttachmentRoleMappingMappingRuleOutput) Claim

The claim name that must be present in the token, for example, "isAdmin" or "paid".

func (IdentityPoolRoleAttachmentRoleMappingMappingRuleOutput) ElementType

func (IdentityPoolRoleAttachmentRoleMappingMappingRuleOutput) MatchType

The match condition that specifies how closely the claim value in the IdP token must match Value.

func (IdentityPoolRoleAttachmentRoleMappingMappingRuleOutput) RoleArn

The role ARN.

func (IdentityPoolRoleAttachmentRoleMappingMappingRuleOutput) ToIdentityPoolRoleAttachmentRoleMappingMappingRuleOutput

func (IdentityPoolRoleAttachmentRoleMappingMappingRuleOutput) ToIdentityPoolRoleAttachmentRoleMappingMappingRuleOutputWithContext

func (o IdentityPoolRoleAttachmentRoleMappingMappingRuleOutput) ToIdentityPoolRoleAttachmentRoleMappingMappingRuleOutputWithContext(ctx context.Context) IdentityPoolRoleAttachmentRoleMappingMappingRuleOutput

func (IdentityPoolRoleAttachmentRoleMappingMappingRuleOutput) Value

A brief string that the claim must match, for example, "paid" or "yes".

type IdentityPoolRoleAttachmentRoleMappingOutput

type IdentityPoolRoleAttachmentRoleMappingOutput struct{ *pulumi.OutputState }

func (IdentityPoolRoleAttachmentRoleMappingOutput) AmbiguousRoleResolution

Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type. `Required` if you specify Token or Rules as the Type.

func (IdentityPoolRoleAttachmentRoleMappingOutput) ElementType

func (IdentityPoolRoleAttachmentRoleMappingOutput) IdentityProvider

A string identifying the identity provider, for example, "graph.facebook.com" or "cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id".

func (IdentityPoolRoleAttachmentRoleMappingOutput) MappingRules

The Rules Configuration to be used for mapping users to roles. You can specify up to 25 rules per identity provider. Rules are evaluated in order. The first one to match specifies the role.

func (IdentityPoolRoleAttachmentRoleMappingOutput) ToIdentityPoolRoleAttachmentRoleMappingOutput

func (o IdentityPoolRoleAttachmentRoleMappingOutput) ToIdentityPoolRoleAttachmentRoleMappingOutput() IdentityPoolRoleAttachmentRoleMappingOutput

func (IdentityPoolRoleAttachmentRoleMappingOutput) ToIdentityPoolRoleAttachmentRoleMappingOutputWithContext

func (o IdentityPoolRoleAttachmentRoleMappingOutput) ToIdentityPoolRoleAttachmentRoleMappingOutputWithContext(ctx context.Context) IdentityPoolRoleAttachmentRoleMappingOutput

func (IdentityPoolRoleAttachmentRoleMappingOutput) Type

The role mapping type.

type IdentityPoolRoleAttachmentState

type IdentityPoolRoleAttachmentState struct {
	// An identity pool ID in the format REGION:GUID.
	IdentityPoolId pulumi.StringPtrInput
	// A List of Role Mapping.
	RoleMappings IdentityPoolRoleAttachmentRoleMappingArrayInput
	// The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.
	Roles pulumi.StringMapInput
}

func (IdentityPoolRoleAttachmentState) ElementType

type IdentityPoolState

type IdentityPoolState struct {
	// Whether the identity pool supports unauthenticated logins or not.
	AllowUnauthenticatedIdentities pulumi.BoolPtrInput
	// The ARN of the identity pool.
	Arn pulumi.StringPtrInput
	// An array of Amazon Cognito Identity user pools and their client IDs.
	CognitoIdentityProviders IdentityPoolCognitoIdentityProviderArrayInput
	// The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your
	// backend and the Cognito service to communicate about the developer provider.
	DeveloperProviderName pulumi.StringPtrInput
	// The Cognito Identity Pool name.
	IdentityPoolName pulumi.StringPtrInput
	// Set of OpendID Connect provider ARNs.
	OpenidConnectProviderArns pulumi.StringArrayInput
	// An array of Amazon Resource Names (ARNs) of the SAML provider for your identity.
	SamlProviderArns pulumi.StringArrayInput
	// Key-Value pairs mapping provider names to provider app IDs.
	SupportedLoginProviders pulumi.StringMapInput
	// A map of tags to assign to the Identity Pool.
	Tags pulumi.StringMapInput
}

func (IdentityPoolState) ElementType

func (IdentityPoolState) ElementType() reflect.Type

type IdentityProvider

type IdentityProvider struct {
	pulumi.CustomResourceState

	// The map of attribute mapping of user pool attributes. [AttributeMapping in AWS API documentation](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateIdentityProvider.html#CognitoUserPools-CreateIdentityProvider-request-AttributeMapping)
	AttributeMapping pulumi.StringMapOutput `pulumi:"attributeMapping"`
	// The list of identity providers.
	IdpIdentifiers pulumi.StringArrayOutput `pulumi:"idpIdentifiers"`
	// The map of identity details, such as access token
	ProviderDetails pulumi.StringMapOutput `pulumi:"providerDetails"`
	// The provider name
	ProviderName pulumi.StringOutput `pulumi:"providerName"`
	// The provider type.  [See AWS API for valid values](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateIdentityProvider.html#CognitoUserPools-CreateIdentityProvider-request-ProviderType)
	ProviderType pulumi.StringOutput `pulumi:"providerType"`
	// The user pool id
	UserPoolId pulumi.StringOutput `pulumi:"userPoolId"`
}

Provides a Cognito User Identity Provider resource.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/cognito"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := cognito.NewUserPool(ctx, "example", &cognito.UserPoolArgs{
			AutoVerifiedAttributes: pulumi.StringArray{
				pulumi.String("email"),
			},
		})
		if err != nil {
			return err
		}
		_, err = cognito.NewIdentityProvider(ctx, "exampleProvider", &cognito.IdentityProviderArgs{
			UserPoolId:   example.ID(),
			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
	})
}

```

## Import

`aws_cognito_identity_provider` resources can be imported using their User Pool ID and Provider Name, e.g.

```sh

$ pulumi import aws:cognito/identityProvider:IdentityProvider example xxx_yyyyy:example

```

func GetIdentityProvider

func GetIdentityProvider(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *IdentityProviderState, opts ...pulumi.ResourceOption) (*IdentityProvider, error)

GetIdentityProvider gets an existing IdentityProvider resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewIdentityProvider

func NewIdentityProvider(ctx *pulumi.Context,
	name string, args *IdentityProviderArgs, opts ...pulumi.ResourceOption) (*IdentityProvider, error)

NewIdentityProvider registers a new resource with the given unique name, arguments, and options.

func (*IdentityProvider) ElementType added in v3.13.0

func (*IdentityProvider) ElementType() reflect.Type

func (*IdentityProvider) ToIdentityProviderOutput added in v3.13.0

func (i *IdentityProvider) ToIdentityProviderOutput() IdentityProviderOutput

func (*IdentityProvider) ToIdentityProviderOutputWithContext added in v3.13.0

func (i *IdentityProvider) ToIdentityProviderOutputWithContext(ctx context.Context) IdentityProviderOutput

func (*IdentityProvider) ToIdentityProviderPtrOutput added in v3.25.0

func (i *IdentityProvider) ToIdentityProviderPtrOutput() IdentityProviderPtrOutput

func (*IdentityProvider) ToIdentityProviderPtrOutputWithContext added in v3.25.0

func (i *IdentityProvider) ToIdentityProviderPtrOutputWithContext(ctx context.Context) IdentityProviderPtrOutput

type IdentityProviderArgs

type IdentityProviderArgs struct {
	// The map of attribute mapping of user pool attributes. [AttributeMapping in AWS API documentation](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateIdentityProvider.html#CognitoUserPools-CreateIdentityProvider-request-AttributeMapping)
	AttributeMapping pulumi.StringMapInput
	// The list of identity providers.
	IdpIdentifiers pulumi.StringArrayInput
	// The map of identity details, such as access token
	ProviderDetails pulumi.StringMapInput
	// The provider name
	ProviderName pulumi.StringInput
	// The provider type.  [See AWS API for valid values](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateIdentityProvider.html#CognitoUserPools-CreateIdentityProvider-request-ProviderType)
	ProviderType pulumi.StringInput
	// The user pool id
	UserPoolId pulumi.StringInput
}

The set of arguments for constructing a IdentityProvider resource.

func (IdentityProviderArgs) ElementType

func (IdentityProviderArgs) ElementType() reflect.Type

type IdentityProviderArray added in v3.25.0

type IdentityProviderArray []IdentityProviderInput

func (IdentityProviderArray) ElementType added in v3.25.0

func (IdentityProviderArray) ElementType() reflect.Type

func (IdentityProviderArray) ToIdentityProviderArrayOutput added in v3.25.0

func (i IdentityProviderArray) ToIdentityProviderArrayOutput() IdentityProviderArrayOutput

func (IdentityProviderArray) ToIdentityProviderArrayOutputWithContext added in v3.25.0

func (i IdentityProviderArray) ToIdentityProviderArrayOutputWithContext(ctx context.Context) IdentityProviderArrayOutput

type IdentityProviderArrayInput added in v3.25.0

type IdentityProviderArrayInput interface {
	pulumi.Input

	ToIdentityProviderArrayOutput() IdentityProviderArrayOutput
	ToIdentityProviderArrayOutputWithContext(context.Context) IdentityProviderArrayOutput
}

IdentityProviderArrayInput is an input type that accepts IdentityProviderArray and IdentityProviderArrayOutput values. You can construct a concrete instance of `IdentityProviderArrayInput` via:

IdentityProviderArray{ IdentityProviderArgs{...} }

type IdentityProviderArrayOutput added in v3.25.0

type IdentityProviderArrayOutput struct{ *pulumi.OutputState }

func (IdentityProviderArrayOutput) ElementType added in v3.25.0

func (IdentityProviderArrayOutput) Index added in v3.25.0

func (IdentityProviderArrayOutput) ToIdentityProviderArrayOutput added in v3.25.0

func (o IdentityProviderArrayOutput) ToIdentityProviderArrayOutput() IdentityProviderArrayOutput

func (IdentityProviderArrayOutput) ToIdentityProviderArrayOutputWithContext added in v3.25.0

func (o IdentityProviderArrayOutput) ToIdentityProviderArrayOutputWithContext(ctx context.Context) IdentityProviderArrayOutput

type IdentityProviderInput added in v3.13.0

type IdentityProviderInput interface {
	pulumi.Input

	ToIdentityProviderOutput() IdentityProviderOutput
	ToIdentityProviderOutputWithContext(ctx context.Context) IdentityProviderOutput
}

type IdentityProviderMap added in v3.25.0

type IdentityProviderMap map[string]IdentityProviderInput

func (IdentityProviderMap) ElementType added in v3.25.0

func (IdentityProviderMap) ElementType() reflect.Type

func (IdentityProviderMap) ToIdentityProviderMapOutput added in v3.25.0

func (i IdentityProviderMap) ToIdentityProviderMapOutput() IdentityProviderMapOutput

func (IdentityProviderMap) ToIdentityProviderMapOutputWithContext added in v3.25.0

func (i IdentityProviderMap) ToIdentityProviderMapOutputWithContext(ctx context.Context) IdentityProviderMapOutput

type IdentityProviderMapInput added in v3.25.0

type IdentityProviderMapInput interface {
	pulumi.Input

	ToIdentityProviderMapOutput() IdentityProviderMapOutput
	ToIdentityProviderMapOutputWithContext(context.Context) IdentityProviderMapOutput
}

IdentityProviderMapInput is an input type that accepts IdentityProviderMap and IdentityProviderMapOutput values. You can construct a concrete instance of `IdentityProviderMapInput` via:

IdentityProviderMap{ "key": IdentityProviderArgs{...} }

type IdentityProviderMapOutput added in v3.25.0

type IdentityProviderMapOutput struct{ *pulumi.OutputState }

func (IdentityProviderMapOutput) ElementType added in v3.25.0

func (IdentityProviderMapOutput) ElementType() reflect.Type

func (IdentityProviderMapOutput) MapIndex added in v3.25.0

func (IdentityProviderMapOutput) ToIdentityProviderMapOutput added in v3.25.0

func (o IdentityProviderMapOutput) ToIdentityProviderMapOutput() IdentityProviderMapOutput

func (IdentityProviderMapOutput) ToIdentityProviderMapOutputWithContext added in v3.25.0

func (o IdentityProviderMapOutput) ToIdentityProviderMapOutputWithContext(ctx context.Context) IdentityProviderMapOutput

type IdentityProviderOutput added in v3.13.0

type IdentityProviderOutput struct {
	*pulumi.OutputState
}

func (IdentityProviderOutput) ElementType added in v3.13.0

func (IdentityProviderOutput) ElementType() reflect.Type

func (IdentityProviderOutput) ToIdentityProviderOutput added in v3.13.0

func (o IdentityProviderOutput) ToIdentityProviderOutput() IdentityProviderOutput

func (IdentityProviderOutput) ToIdentityProviderOutputWithContext added in v3.13.0

func (o IdentityProviderOutput) ToIdentityProviderOutputWithContext(ctx context.Context) IdentityProviderOutput

func (IdentityProviderOutput) ToIdentityProviderPtrOutput added in v3.25.0

func (o IdentityProviderOutput) ToIdentityProviderPtrOutput() IdentityProviderPtrOutput

func (IdentityProviderOutput) ToIdentityProviderPtrOutputWithContext added in v3.25.0

func (o IdentityProviderOutput) ToIdentityProviderPtrOutputWithContext(ctx context.Context) IdentityProviderPtrOutput

type IdentityProviderPtrInput added in v3.25.0

type IdentityProviderPtrInput interface {
	pulumi.Input

	ToIdentityProviderPtrOutput() IdentityProviderPtrOutput
	ToIdentityProviderPtrOutputWithContext(ctx context.Context) IdentityProviderPtrOutput
}

type IdentityProviderPtrOutput added in v3.25.0

type IdentityProviderPtrOutput struct {
	*pulumi.OutputState
}

func (IdentityProviderPtrOutput) ElementType added in v3.25.0

func (IdentityProviderPtrOutput) ElementType() reflect.Type

func (IdentityProviderPtrOutput) ToIdentityProviderPtrOutput added in v3.25.0

func (o IdentityProviderPtrOutput) ToIdentityProviderPtrOutput() IdentityProviderPtrOutput

func (IdentityProviderPtrOutput) ToIdentityProviderPtrOutputWithContext added in v3.25.0

func (o IdentityProviderPtrOutput) ToIdentityProviderPtrOutputWithContext(ctx context.Context) IdentityProviderPtrOutput

type IdentityProviderState

type IdentityProviderState struct {
	// The map of attribute mapping of user pool attributes. [AttributeMapping in AWS API documentation](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateIdentityProvider.html#CognitoUserPools-CreateIdentityProvider-request-AttributeMapping)
	AttributeMapping pulumi.StringMapInput
	// The list of identity providers.
	IdpIdentifiers pulumi.StringArrayInput
	// The map of identity details, such as access token
	ProviderDetails pulumi.StringMapInput
	// The provider name
	ProviderName pulumi.StringPtrInput
	// The provider type.  [See AWS API for valid values](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateIdentityProvider.html#CognitoUserPools-CreateIdentityProvider-request-ProviderType)
	ProviderType pulumi.StringPtrInput
	// The user pool id
	UserPoolId pulumi.StringPtrInput
}

func (IdentityProviderState) ElementType

func (IdentityProviderState) ElementType() reflect.Type

type ResourceServer

type ResourceServer struct {
	pulumi.CustomResourceState

	// An identifier for the resource server.
	Identifier pulumi.StringOutput `pulumi:"identifier"`
	// A name for the resource server.
	Name pulumi.StringOutput `pulumi:"name"`
	// A list of all scopes configured for this resource server in the format identifier/scope_name.
	ScopeIdentifiers pulumi.StringArrayOutput `pulumi:"scopeIdentifiers"`
	// A list of Authorization Scope.
	Scopes     ResourceServerScopeArrayOutput `pulumi:"scopes"`
	UserPoolId pulumi.StringOutput            `pulumi:"userPoolId"`
}

Provides a Cognito Resource Server.

## Example Usage ### Create a basic resource server

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/cognito"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		pool, err := cognito.NewUserPool(ctx, "pool", nil)
		if err != nil {
			return err
		}
		_, err = cognito.NewResourceServer(ctx, "resource", &cognito.ResourceServerArgs{
			Identifier: pulumi.String("https://example.com"),
			UserPoolId: pool.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Create a resource server with sample-scope

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/cognito"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		pool, err := cognito.NewUserPool(ctx, "pool", nil)
		if err != nil {
			return err
		}
		_, err = cognito.NewResourceServer(ctx, "resource", &cognito.ResourceServerArgs{
			Identifier: pulumi.String("https://example.com"),
			Scopes: cognito.ResourceServerScopeArray{
				&cognito.ResourceServerScopeArgs{
					ScopeName:        pulumi.String("sample-scope"),
					ScopeDescription: pulumi.String("a Sample Scope Description"),
				},
			},
			UserPoolId: pool.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

`aws_cognito_resource_server` can be imported using their User Pool ID and Identifier, e.g.

```sh

$ pulumi import aws:cognito/resourceServer:ResourceServer example xxx_yyyyy|https://example.com

```

func GetResourceServer

func GetResourceServer(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ResourceServerState, opts ...pulumi.ResourceOption) (*ResourceServer, error)

GetResourceServer gets an existing ResourceServer resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewResourceServer

func NewResourceServer(ctx *pulumi.Context,
	name string, args *ResourceServerArgs, opts ...pulumi.ResourceOption) (*ResourceServer, error)

NewResourceServer registers a new resource with the given unique name, arguments, and options.

func (*ResourceServer) ElementType added in v3.13.0

func (*ResourceServer) ElementType() reflect.Type

func (*ResourceServer) ToResourceServerOutput added in v3.13.0

func (i *ResourceServer) ToResourceServerOutput() ResourceServerOutput

func (*ResourceServer) ToResourceServerOutputWithContext added in v3.13.0

func (i *ResourceServer) ToResourceServerOutputWithContext(ctx context.Context) ResourceServerOutput

func (*ResourceServer) ToResourceServerPtrOutput added in v3.25.0

func (i *ResourceServer) ToResourceServerPtrOutput() ResourceServerPtrOutput

func (*ResourceServer) ToResourceServerPtrOutputWithContext added in v3.25.0

func (i *ResourceServer) ToResourceServerPtrOutputWithContext(ctx context.Context) ResourceServerPtrOutput

type ResourceServerArgs

type ResourceServerArgs struct {
	// An identifier for the resource server.
	Identifier pulumi.StringInput
	// A name for the resource server.
	Name pulumi.StringPtrInput
	// A list of Authorization Scope.
	Scopes     ResourceServerScopeArrayInput
	UserPoolId pulumi.StringInput
}

The set of arguments for constructing a ResourceServer resource.

func (ResourceServerArgs) ElementType

func (ResourceServerArgs) ElementType() reflect.Type

type ResourceServerArray added in v3.25.0

type ResourceServerArray []ResourceServerInput

func (ResourceServerArray) ElementType added in v3.25.0

func (ResourceServerArray) ElementType() reflect.Type

func (ResourceServerArray) ToResourceServerArrayOutput added in v3.25.0

func (i ResourceServerArray) ToResourceServerArrayOutput() ResourceServerArrayOutput

func (ResourceServerArray) ToResourceServerArrayOutputWithContext added in v3.25.0

func (i ResourceServerArray) ToResourceServerArrayOutputWithContext(ctx context.Context) ResourceServerArrayOutput

type ResourceServerArrayInput added in v3.25.0

type ResourceServerArrayInput interface {
	pulumi.Input

	ToResourceServerArrayOutput() ResourceServerArrayOutput
	ToResourceServerArrayOutputWithContext(context.Context) ResourceServerArrayOutput
}

ResourceServerArrayInput is an input type that accepts ResourceServerArray and ResourceServerArrayOutput values. You can construct a concrete instance of `ResourceServerArrayInput` via:

ResourceServerArray{ ResourceServerArgs{...} }

type ResourceServerArrayOutput added in v3.25.0

type ResourceServerArrayOutput struct{ *pulumi.OutputState }

func (ResourceServerArrayOutput) ElementType added in v3.25.0

func (ResourceServerArrayOutput) ElementType() reflect.Type

func (ResourceServerArrayOutput) Index added in v3.25.0

func (ResourceServerArrayOutput) ToResourceServerArrayOutput added in v3.25.0

func (o ResourceServerArrayOutput) ToResourceServerArrayOutput() ResourceServerArrayOutput

func (ResourceServerArrayOutput) ToResourceServerArrayOutputWithContext added in v3.25.0

func (o ResourceServerArrayOutput) ToResourceServerArrayOutputWithContext(ctx context.Context) ResourceServerArrayOutput

type ResourceServerInput added in v3.13.0

type ResourceServerInput interface {
	pulumi.Input

	ToResourceServerOutput() ResourceServerOutput
	ToResourceServerOutputWithContext(ctx context.Context) ResourceServerOutput
}

type ResourceServerMap added in v3.25.0

type ResourceServerMap map[string]ResourceServerInput

func (ResourceServerMap) ElementType added in v3.25.0

func (ResourceServerMap) ElementType() reflect.Type

func (ResourceServerMap) ToResourceServerMapOutput added in v3.25.0

func (i ResourceServerMap) ToResourceServerMapOutput() ResourceServerMapOutput

func (ResourceServerMap) ToResourceServerMapOutputWithContext added in v3.25.0

func (i ResourceServerMap) ToResourceServerMapOutputWithContext(ctx context.Context) ResourceServerMapOutput

type ResourceServerMapInput added in v3.25.0

type ResourceServerMapInput interface {
	pulumi.Input

	ToResourceServerMapOutput() ResourceServerMapOutput
	ToResourceServerMapOutputWithContext(context.Context) ResourceServerMapOutput
}

ResourceServerMapInput is an input type that accepts ResourceServerMap and ResourceServerMapOutput values. You can construct a concrete instance of `ResourceServerMapInput` via:

ResourceServerMap{ "key": ResourceServerArgs{...} }

type ResourceServerMapOutput added in v3.25.0

type ResourceServerMapOutput struct{ *pulumi.OutputState }

func (ResourceServerMapOutput) ElementType added in v3.25.0

func (ResourceServerMapOutput) ElementType() reflect.Type

func (ResourceServerMapOutput) MapIndex added in v3.25.0

func (ResourceServerMapOutput) ToResourceServerMapOutput added in v3.25.0

func (o ResourceServerMapOutput) ToResourceServerMapOutput() ResourceServerMapOutput

func (ResourceServerMapOutput) ToResourceServerMapOutputWithContext added in v3.25.0

func (o ResourceServerMapOutput) ToResourceServerMapOutputWithContext(ctx context.Context) ResourceServerMapOutput

type ResourceServerOutput added in v3.13.0

type ResourceServerOutput struct {
	*pulumi.OutputState
}

func (ResourceServerOutput) ElementType added in v3.13.0

func (ResourceServerOutput) ElementType() reflect.Type

func (ResourceServerOutput) ToResourceServerOutput added in v3.13.0

func (o ResourceServerOutput) ToResourceServerOutput() ResourceServerOutput

func (ResourceServerOutput) ToResourceServerOutputWithContext added in v3.13.0

func (o ResourceServerOutput) ToResourceServerOutputWithContext(ctx context.Context) ResourceServerOutput

func (ResourceServerOutput) ToResourceServerPtrOutput added in v3.25.0

func (o ResourceServerOutput) ToResourceServerPtrOutput() ResourceServerPtrOutput

func (ResourceServerOutput) ToResourceServerPtrOutputWithContext added in v3.25.0

func (o ResourceServerOutput) ToResourceServerPtrOutputWithContext(ctx context.Context) ResourceServerPtrOutput

type ResourceServerPtrInput added in v3.25.0

type ResourceServerPtrInput interface {
	pulumi.Input

	ToResourceServerPtrOutput() ResourceServerPtrOutput
	ToResourceServerPtrOutputWithContext(ctx context.Context) ResourceServerPtrOutput
}

type ResourceServerPtrOutput added in v3.25.0

type ResourceServerPtrOutput struct {
	*pulumi.OutputState
}

func (ResourceServerPtrOutput) ElementType added in v3.25.0

func (ResourceServerPtrOutput) ElementType() reflect.Type

func (ResourceServerPtrOutput) ToResourceServerPtrOutput added in v3.25.0

func (o ResourceServerPtrOutput) ToResourceServerPtrOutput() ResourceServerPtrOutput

func (ResourceServerPtrOutput) ToResourceServerPtrOutputWithContext added in v3.25.0

func (o ResourceServerPtrOutput) ToResourceServerPtrOutputWithContext(ctx context.Context) ResourceServerPtrOutput

type ResourceServerScope

type ResourceServerScope struct {
	// The scope description.
	ScopeDescription string `pulumi:"scopeDescription"`
	// The scope name.
	ScopeName string `pulumi:"scopeName"`
}

type ResourceServerScopeArgs

type ResourceServerScopeArgs struct {
	// The scope description.
	ScopeDescription pulumi.StringInput `pulumi:"scopeDescription"`
	// The scope name.
	ScopeName pulumi.StringInput `pulumi:"scopeName"`
}

func (ResourceServerScopeArgs) ElementType

func (ResourceServerScopeArgs) ElementType() reflect.Type

func (ResourceServerScopeArgs) ToResourceServerScopeOutput

func (i ResourceServerScopeArgs) ToResourceServerScopeOutput() ResourceServerScopeOutput

func (ResourceServerScopeArgs) ToResourceServerScopeOutputWithContext

func (i ResourceServerScopeArgs) ToResourceServerScopeOutputWithContext(ctx context.Context) ResourceServerScopeOutput

type ResourceServerScopeArray

type ResourceServerScopeArray []ResourceServerScopeInput

func (ResourceServerScopeArray) ElementType

func (ResourceServerScopeArray) ElementType() reflect.Type

func (ResourceServerScopeArray) ToResourceServerScopeArrayOutput

func (i ResourceServerScopeArray) ToResourceServerScopeArrayOutput() ResourceServerScopeArrayOutput

func (ResourceServerScopeArray) ToResourceServerScopeArrayOutputWithContext

func (i ResourceServerScopeArray) ToResourceServerScopeArrayOutputWithContext(ctx context.Context) ResourceServerScopeArrayOutput

type ResourceServerScopeArrayInput

type ResourceServerScopeArrayInput interface {
	pulumi.Input

	ToResourceServerScopeArrayOutput() ResourceServerScopeArrayOutput
	ToResourceServerScopeArrayOutputWithContext(context.Context) ResourceServerScopeArrayOutput
}

ResourceServerScopeArrayInput is an input type that accepts ResourceServerScopeArray and ResourceServerScopeArrayOutput values. You can construct a concrete instance of `ResourceServerScopeArrayInput` via:

ResourceServerScopeArray{ ResourceServerScopeArgs{...} }

type ResourceServerScopeArrayOutput

type ResourceServerScopeArrayOutput struct{ *pulumi.OutputState }

func (ResourceServerScopeArrayOutput) ElementType

func (ResourceServerScopeArrayOutput) Index

func (ResourceServerScopeArrayOutput) ToResourceServerScopeArrayOutput

func (o ResourceServerScopeArrayOutput) ToResourceServerScopeArrayOutput() ResourceServerScopeArrayOutput

func (ResourceServerScopeArrayOutput) ToResourceServerScopeArrayOutputWithContext

func (o ResourceServerScopeArrayOutput) ToResourceServerScopeArrayOutputWithContext(ctx context.Context) ResourceServerScopeArrayOutput

type ResourceServerScopeInput

type ResourceServerScopeInput interface {
	pulumi.Input

	ToResourceServerScopeOutput() ResourceServerScopeOutput
	ToResourceServerScopeOutputWithContext(context.Context) ResourceServerScopeOutput
}

ResourceServerScopeInput is an input type that accepts ResourceServerScopeArgs and ResourceServerScopeOutput values. You can construct a concrete instance of `ResourceServerScopeInput` via:

ResourceServerScopeArgs{...}

type ResourceServerScopeOutput

type ResourceServerScopeOutput struct{ *pulumi.OutputState }

func (ResourceServerScopeOutput) ElementType

func (ResourceServerScopeOutput) ElementType() reflect.Type

func (ResourceServerScopeOutput) ScopeDescription

func (o ResourceServerScopeOutput) ScopeDescription() pulumi.StringOutput

The scope description.

func (ResourceServerScopeOutput) ScopeName

The scope name.

func (ResourceServerScopeOutput) ToResourceServerScopeOutput

func (o ResourceServerScopeOutput) ToResourceServerScopeOutput() ResourceServerScopeOutput

func (ResourceServerScopeOutput) ToResourceServerScopeOutputWithContext

func (o ResourceServerScopeOutput) ToResourceServerScopeOutputWithContext(ctx context.Context) ResourceServerScopeOutput

type ResourceServerState

type ResourceServerState struct {
	// An identifier for the resource server.
	Identifier pulumi.StringPtrInput
	// A name for the resource server.
	Name pulumi.StringPtrInput
	// A list of all scopes configured for this resource server in the format identifier/scope_name.
	ScopeIdentifiers pulumi.StringArrayInput
	// A list of Authorization Scope.
	Scopes     ResourceServerScopeArrayInput
	UserPoolId pulumi.StringPtrInput
}

func (ResourceServerState) ElementType

func (ResourceServerState) ElementType() reflect.Type

type UserGroup

type UserGroup struct {
	pulumi.CustomResourceState

	// The description of the user group.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The name of the user group.
	Name pulumi.StringOutput `pulumi:"name"`
	// The precedence of the user group.
	Precedence pulumi.IntPtrOutput `pulumi:"precedence"`
	// The ARN of the IAM role to be associated with the user group.
	RoleArn pulumi.StringPtrOutput `pulumi:"roleArn"`
	// The user pool ID.
	UserPoolId pulumi.StringOutput `pulumi:"userPoolId"`
}

Provides a Cognito User Group resource.

## Example Usage

```go package main

import (

"fmt"

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/cognito"
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/iam"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		mainUserPool, err := cognito.NewUserPool(ctx, "mainUserPool", nil)
		if err != nil {
			return err
		}
		groupRole, err := iam.NewRole(ctx, "groupRole", &iam.RoleArgs{
			AssumeRolePolicy: pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v", "{\n", "  \"Version\": \"2012-10-17\",\n", "  \"Statement\": [\n", "    {\n", "      \"Sid\": \"\",\n", "      \"Effect\": \"Allow\",\n", "      \"Principal\": {\n", "        \"Federated\": \"cognito-identity.amazonaws.com\"\n", "      },\n", "      \"Action\": \"sts:AssumeRoleWithWebIdentity\",\n", "      \"Condition\": {\n", "        \"StringEquals\": {\n", "          \"cognito-identity.amazonaws.com:aud\": \"us-east-1:12345678-dead-beef-cafe-123456790ab\"\n", "        },\n", "        \"ForAnyValue:StringLike\": {\n", "          \"cognito-identity.amazonaws.com:amr\": \"authenticated\"\n", "        }\n", "      }\n", "    }\n", "  ]\n", "}\n")),
		})
		if err != nil {
			return err
		}
		_, err = cognito.NewUserGroup(ctx, "mainUserGroup", &cognito.UserGroupArgs{
			UserPoolId:  mainUserPool.ID(),
			Description: pulumi.String("Managed by Pulumi"),
			Precedence:  pulumi.Int(42),
			RoleArn:     groupRole.Arn,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Cognito User Groups can be imported using the `user_pool_id`/`name` attributes concatenated, e.g.

```sh

$ pulumi import aws:cognito/userGroup:UserGroup group us-east-1_vG78M4goG/user-group

```

func GetUserGroup

func GetUserGroup(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *UserGroupState, opts ...pulumi.ResourceOption) (*UserGroup, error)

GetUserGroup gets an existing UserGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewUserGroup

func NewUserGroup(ctx *pulumi.Context,
	name string, args *UserGroupArgs, opts ...pulumi.ResourceOption) (*UserGroup, error)

NewUserGroup registers a new resource with the given unique name, arguments, and options.

func (*UserGroup) ElementType added in v3.13.0

func (*UserGroup) ElementType() reflect.Type

func (*UserGroup) ToUserGroupOutput added in v3.13.0

func (i *UserGroup) ToUserGroupOutput() UserGroupOutput

func (*UserGroup) ToUserGroupOutputWithContext added in v3.13.0

func (i *UserGroup) ToUserGroupOutputWithContext(ctx context.Context) UserGroupOutput

func (*UserGroup) ToUserGroupPtrOutput added in v3.25.0

func (i *UserGroup) ToUserGroupPtrOutput() UserGroupPtrOutput

func (*UserGroup) ToUserGroupPtrOutputWithContext added in v3.25.0

func (i *UserGroup) ToUserGroupPtrOutputWithContext(ctx context.Context) UserGroupPtrOutput

type UserGroupArgs

type UserGroupArgs struct {
	// The description of the user group.
	Description pulumi.StringPtrInput
	// The name of the user group.
	Name pulumi.StringPtrInput
	// The precedence of the user group.
	Precedence pulumi.IntPtrInput
	// The ARN of the IAM role to be associated with the user group.
	RoleArn pulumi.StringPtrInput
	// The user pool ID.
	UserPoolId pulumi.StringInput
}

The set of arguments for constructing a UserGroup resource.

func (UserGroupArgs) ElementType

func (UserGroupArgs) ElementType() reflect.Type

type UserGroupArray added in v3.25.0

type UserGroupArray []UserGroupInput

func (UserGroupArray) ElementType added in v3.25.0

func (UserGroupArray) ElementType() reflect.Type

func (UserGroupArray) ToUserGroupArrayOutput added in v3.25.0

func (i UserGroupArray) ToUserGroupArrayOutput() UserGroupArrayOutput

func (UserGroupArray) ToUserGroupArrayOutputWithContext added in v3.25.0

func (i UserGroupArray) ToUserGroupArrayOutputWithContext(ctx context.Context) UserGroupArrayOutput

type UserGroupArrayInput added in v3.25.0

type UserGroupArrayInput interface {
	pulumi.Input

	ToUserGroupArrayOutput() UserGroupArrayOutput
	ToUserGroupArrayOutputWithContext(context.Context) UserGroupArrayOutput
}

UserGroupArrayInput is an input type that accepts UserGroupArray and UserGroupArrayOutput values. You can construct a concrete instance of `UserGroupArrayInput` via:

UserGroupArray{ UserGroupArgs{...} }

type UserGroupArrayOutput added in v3.25.0

type UserGroupArrayOutput struct{ *pulumi.OutputState }

func (UserGroupArrayOutput) ElementType added in v3.25.0

func (UserGroupArrayOutput) ElementType() reflect.Type

func (UserGroupArrayOutput) Index added in v3.25.0

func (UserGroupArrayOutput) ToUserGroupArrayOutput added in v3.25.0

func (o UserGroupArrayOutput) ToUserGroupArrayOutput() UserGroupArrayOutput

func (UserGroupArrayOutput) ToUserGroupArrayOutputWithContext added in v3.25.0

func (o UserGroupArrayOutput) ToUserGroupArrayOutputWithContext(ctx context.Context) UserGroupArrayOutput

type UserGroupInput added in v3.13.0

type UserGroupInput interface {
	pulumi.Input

	ToUserGroupOutput() UserGroupOutput
	ToUserGroupOutputWithContext(ctx context.Context) UserGroupOutput
}

type UserGroupMap added in v3.25.0

type UserGroupMap map[string]UserGroupInput

func (UserGroupMap) ElementType added in v3.25.0

func (UserGroupMap) ElementType() reflect.Type

func (UserGroupMap) ToUserGroupMapOutput added in v3.25.0

func (i UserGroupMap) ToUserGroupMapOutput() UserGroupMapOutput

func (UserGroupMap) ToUserGroupMapOutputWithContext added in v3.25.0

func (i UserGroupMap) ToUserGroupMapOutputWithContext(ctx context.Context) UserGroupMapOutput

type UserGroupMapInput added in v3.25.0

type UserGroupMapInput interface {
	pulumi.Input

	ToUserGroupMapOutput() UserGroupMapOutput
	ToUserGroupMapOutputWithContext(context.Context) UserGroupMapOutput
}

UserGroupMapInput is an input type that accepts UserGroupMap and UserGroupMapOutput values. You can construct a concrete instance of `UserGroupMapInput` via:

UserGroupMap{ "key": UserGroupArgs{...} }

type UserGroupMapOutput added in v3.25.0

type UserGroupMapOutput struct{ *pulumi.OutputState }

func (UserGroupMapOutput) ElementType added in v3.25.0

func (UserGroupMapOutput) ElementType() reflect.Type

func (UserGroupMapOutput) MapIndex added in v3.25.0

func (UserGroupMapOutput) ToUserGroupMapOutput added in v3.25.0

func (o UserGroupMapOutput) ToUserGroupMapOutput() UserGroupMapOutput

func (UserGroupMapOutput) ToUserGroupMapOutputWithContext added in v3.25.0

func (o UserGroupMapOutput) ToUserGroupMapOutputWithContext(ctx context.Context) UserGroupMapOutput

type UserGroupOutput added in v3.13.0

type UserGroupOutput struct {
	*pulumi.OutputState
}

func (UserGroupOutput) ElementType added in v3.13.0

func (UserGroupOutput) ElementType() reflect.Type

func (UserGroupOutput) ToUserGroupOutput added in v3.13.0

func (o UserGroupOutput) ToUserGroupOutput() UserGroupOutput

func (UserGroupOutput) ToUserGroupOutputWithContext added in v3.13.0

func (o UserGroupOutput) ToUserGroupOutputWithContext(ctx context.Context) UserGroupOutput

func (UserGroupOutput) ToUserGroupPtrOutput added in v3.25.0

func (o UserGroupOutput) ToUserGroupPtrOutput() UserGroupPtrOutput

func (UserGroupOutput) ToUserGroupPtrOutputWithContext added in v3.25.0

func (o UserGroupOutput) ToUserGroupPtrOutputWithContext(ctx context.Context) UserGroupPtrOutput

type UserGroupPtrInput added in v3.25.0

type UserGroupPtrInput interface {
	pulumi.Input

	ToUserGroupPtrOutput() UserGroupPtrOutput
	ToUserGroupPtrOutputWithContext(ctx context.Context) UserGroupPtrOutput
}

type UserGroupPtrOutput added in v3.25.0

type UserGroupPtrOutput struct {
	*pulumi.OutputState
}

func (UserGroupPtrOutput) ElementType added in v3.25.0

func (UserGroupPtrOutput) ElementType() reflect.Type

func (UserGroupPtrOutput) ToUserGroupPtrOutput added in v3.25.0

func (o UserGroupPtrOutput) ToUserGroupPtrOutput() UserGroupPtrOutput

func (UserGroupPtrOutput) ToUserGroupPtrOutputWithContext added in v3.25.0

func (o UserGroupPtrOutput) ToUserGroupPtrOutputWithContext(ctx context.Context) UserGroupPtrOutput

type UserGroupState

type UserGroupState struct {
	// The description of the user group.
	Description pulumi.StringPtrInput
	// The name of the user group.
	Name pulumi.StringPtrInput
	// The precedence of the user group.
	Precedence pulumi.IntPtrInput
	// The ARN of the IAM role to be associated with the user group.
	RoleArn pulumi.StringPtrInput
	// The user pool ID.
	UserPoolId pulumi.StringPtrInput
}

func (UserGroupState) ElementType

func (UserGroupState) ElementType() reflect.Type

type UserPool

type UserPool struct {
	pulumi.CustomResourceState

	// Configuration block to define which verified available method a user can use to recover their forgotten password. Detailed below.
	AccountRecoverySetting UserPoolAccountRecoverySettingPtrOutput `pulumi:"accountRecoverySetting"`
	// Configuration block for creating a new user profile. Detailed below.
	AdminCreateUserConfig UserPoolAdminCreateUserConfigOutput `pulumi:"adminCreateUserConfig"`
	// Attributes supported as an alias for this user pool. Valid values: `phoneNumber`, `email`, or `preferredUsername`. Conflicts with `usernameAttributes`.
	AliasAttributes pulumi.StringArrayOutput `pulumi:"aliasAttributes"`
	// ARN of the user pool.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// Attributes to be auto-verified. Valid values: `email`, `phoneNumber`.
	AutoVerifiedAttributes pulumi.StringArrayOutput `pulumi:"autoVerifiedAttributes"`
	// Date the user pool was created.
	CreationDate pulumi.StringOutput `pulumi:"creationDate"`
	// Configuration block for the user pool's device tracking. Detailed below.
	DeviceConfiguration UserPoolDeviceConfigurationPtrOutput `pulumi:"deviceConfiguration"`
	// Configuration block for configuring email. Detailed below.
	EmailConfiguration UserPoolEmailConfigurationPtrOutput `pulumi:"emailConfiguration"`
	// String representing the email verification message. Conflicts with `verificationMessageTemplate` configuration block `emailMessage` argument.
	EmailVerificationMessage pulumi.StringOutput `pulumi:"emailVerificationMessage"`
	// String representing the email verification subject. Conflicts with `verificationMessageTemplate` configuration block `emailSubject` argument.
	EmailVerificationSubject pulumi.StringOutput `pulumi:"emailVerificationSubject"`
	// Endpoint name of the user pool. Example format: `cognito-idp.REGION.amazonaws.com/xxxx_yyyyy`
	Endpoint pulumi.StringOutput `pulumi:"endpoint"`
	// Configuration block for the AWS Lambda triggers associated with the user pool. Detailed below.
	LambdaConfig UserPoolLambdaConfigOutput `pulumi:"lambdaConfig"`
	// Date the user pool was last modified.
	LastModifiedDate pulumi.StringOutput `pulumi:"lastModifiedDate"`
	// Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of `OFF`. Valid values are `OFF` (MFA Tokens are not required), `ON` (MFA is required for all users to sign in; requires at least one of `smsConfiguration` or `softwareTokenMfaConfiguration` to be configured), or `OPTIONAL` (MFA Will be required only for individual users who have MFA Enabled; requires at least one of `smsConfiguration` or `softwareTokenMfaConfiguration` to be configured).
	MfaConfiguration pulumi.StringPtrOutput `pulumi:"mfaConfiguration"`
	// Name of the attribute.
	Name pulumi.StringOutput `pulumi:"name"`
	// Configuration blocked for information about the user pool password policy. Detailed below.
	PasswordPolicy UserPoolPasswordPolicyOutput `pulumi:"passwordPolicy"`
	// Configuration block for the schema attributes of a user pool. Detailed below. Schema attributes from the [standard attribute set](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#cognito-user-pools-standard-attributes) only need to be specified if they are different from the default configuration. Attributes can be added, but not modified or removed. Maximum of 50 attributes.
	Schemas UserPoolSchemaArrayOutput `pulumi:"schemas"`
	// String representing the SMS authentication message. The Message must contain the `{####}` placeholder, which will be replaced with the code.
	SmsAuthenticationMessage pulumi.StringPtrOutput `pulumi:"smsAuthenticationMessage"`
	// Configuration block for Short Message Service (SMS) settings. Detailed below. These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection.
	SmsConfiguration UserPoolSmsConfigurationOutput `pulumi:"smsConfiguration"`
	// String representing the SMS verification message. Conflicts with `verificationMessageTemplate` configuration block `smsMessage` argument.
	SmsVerificationMessage pulumi.StringOutput `pulumi:"smsVerificationMessage"`
	// Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.
	SoftwareTokenMfaConfiguration UserPoolSoftwareTokenMfaConfigurationPtrOutput `pulumi:"softwareTokenMfaConfiguration"`
	// Map of tags to assign to the User Pool.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// Configuration block for user pool add-ons to enable user pool advanced security mode features. Detailed below.
	UserPoolAddOns UserPoolUserPoolAddOnsPtrOutput `pulumi:"userPoolAddOns"`
	// Whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with `aliasAttributes`.
	UsernameAttributes pulumi.StringArrayOutput `pulumi:"usernameAttributes"`
	// Configuration block for username configuration. Detailed below.
	UsernameConfiguration UserPoolUsernameConfigurationPtrOutput `pulumi:"usernameConfiguration"`
	// Configuration block for verification message templates. Detailed below.
	VerificationMessageTemplate UserPoolVerificationMessageTemplateOutput `pulumi:"verificationMessageTemplate"`
}

Provides a Cognito User Pool resource.

## Example Usage ### Basic configuration

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/cognito"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cognito.NewUserPool(ctx, "pool", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Enabling SMS and Software Token Multi-Factor Authentication

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/cognito"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cognito.NewUserPool(ctx, "example", &cognito.UserPoolArgs{
			MfaConfiguration:         pulumi.String("ON"),
			SmsAuthenticationMessage: pulumi.String("Your code is {####}"),
			SmsConfiguration: &cognito.UserPoolSmsConfigurationArgs{
				ExternalId:   pulumi.String("example"),
				SnsCallerArn: pulumi.Any(aws_iam_role.Example.Arn),
			},
			SoftwareTokenMfaConfiguration: &cognito.UserPoolSoftwareTokenMfaConfigurationArgs{
				Enabled: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Using Account Recovery Setting

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/cognito"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cognito.NewUserPool(ctx, "test", &cognito.UserPoolArgs{
			AccountRecoverySetting: &cognito.UserPoolAccountRecoverySettingArgs{
				RecoveryMechanisms: cognito.UserPoolAccountRecoverySettingRecoveryMechanismArray{
					&cognito.UserPoolAccountRecoverySettingRecoveryMechanismArgs{
						Name:     pulumi.String("verified_email"),
						Priority: pulumi.Int(1),
					},
					&cognito.UserPoolAccountRecoverySettingRecoveryMechanismArgs{
						Name:     pulumi.String("verified_phone_number"),
						Priority: pulumi.Int(2),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Cognito User Pools can be imported using the `id`, e.g.

```sh

$ pulumi import aws:cognito/userPool:UserPool pool <id>

```

func GetUserPool

func GetUserPool(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *UserPoolState, opts ...pulumi.ResourceOption) (*UserPool, error)

GetUserPool gets an existing UserPool resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewUserPool

func NewUserPool(ctx *pulumi.Context,
	name string, args *UserPoolArgs, opts ...pulumi.ResourceOption) (*UserPool, error)

NewUserPool registers a new resource with the given unique name, arguments, and options.

func (*UserPool) ElementType added in v3.13.0

func (*UserPool) ElementType() reflect.Type

func (*UserPool) ToUserPoolOutput added in v3.13.0

func (i *UserPool) ToUserPoolOutput() UserPoolOutput

func (*UserPool) ToUserPoolOutputWithContext added in v3.13.0

func (i *UserPool) ToUserPoolOutputWithContext(ctx context.Context) UserPoolOutput

func (*UserPool) ToUserPoolPtrOutput added in v3.25.0

func (i *UserPool) ToUserPoolPtrOutput() UserPoolPtrOutput

func (*UserPool) ToUserPoolPtrOutputWithContext added in v3.25.0

func (i *UserPool) ToUserPoolPtrOutputWithContext(ctx context.Context) UserPoolPtrOutput

type UserPoolAccountRecoverySetting added in v3.17.0

type UserPoolAccountRecoverySetting struct {
	// List of Account Recovery Options of the following structure:
	RecoveryMechanisms []UserPoolAccountRecoverySettingRecoveryMechanism `pulumi:"recoveryMechanisms"`
}

type UserPoolAccountRecoverySettingArgs added in v3.17.0

type UserPoolAccountRecoverySettingArgs struct {
	// List of Account Recovery Options of the following structure:
	RecoveryMechanisms UserPoolAccountRecoverySettingRecoveryMechanismArrayInput `pulumi:"recoveryMechanisms"`
}

func (UserPoolAccountRecoverySettingArgs) ElementType added in v3.17.0

func (UserPoolAccountRecoverySettingArgs) ToUserPoolAccountRecoverySettingOutput added in v3.17.0

func (i UserPoolAccountRecoverySettingArgs) ToUserPoolAccountRecoverySettingOutput() UserPoolAccountRecoverySettingOutput

func (UserPoolAccountRecoverySettingArgs) ToUserPoolAccountRecoverySettingOutputWithContext added in v3.17.0

func (i UserPoolAccountRecoverySettingArgs) ToUserPoolAccountRecoverySettingOutputWithContext(ctx context.Context) UserPoolAccountRecoverySettingOutput

func (UserPoolAccountRecoverySettingArgs) ToUserPoolAccountRecoverySettingPtrOutput added in v3.17.0

func (i UserPoolAccountRecoverySettingArgs) ToUserPoolAccountRecoverySettingPtrOutput() UserPoolAccountRecoverySettingPtrOutput

func (UserPoolAccountRecoverySettingArgs) ToUserPoolAccountRecoverySettingPtrOutputWithContext added in v3.17.0

func (i UserPoolAccountRecoverySettingArgs) ToUserPoolAccountRecoverySettingPtrOutputWithContext(ctx context.Context) UserPoolAccountRecoverySettingPtrOutput

type UserPoolAccountRecoverySettingInput added in v3.17.0

type UserPoolAccountRecoverySettingInput interface {
	pulumi.Input

	ToUserPoolAccountRecoverySettingOutput() UserPoolAccountRecoverySettingOutput
	ToUserPoolAccountRecoverySettingOutputWithContext(context.Context) UserPoolAccountRecoverySettingOutput
}

UserPoolAccountRecoverySettingInput is an input type that accepts UserPoolAccountRecoverySettingArgs and UserPoolAccountRecoverySettingOutput values. You can construct a concrete instance of `UserPoolAccountRecoverySettingInput` via:

UserPoolAccountRecoverySettingArgs{...}

type UserPoolAccountRecoverySettingOutput added in v3.17.0

type UserPoolAccountRecoverySettingOutput struct{ *pulumi.OutputState }

func (UserPoolAccountRecoverySettingOutput) ElementType added in v3.17.0

func (UserPoolAccountRecoverySettingOutput) RecoveryMechanisms added in v3.17.0

List of Account Recovery Options of the following structure:

func (UserPoolAccountRecoverySettingOutput) ToUserPoolAccountRecoverySettingOutput added in v3.17.0

func (o UserPoolAccountRecoverySettingOutput) ToUserPoolAccountRecoverySettingOutput() UserPoolAccountRecoverySettingOutput

func (UserPoolAccountRecoverySettingOutput) ToUserPoolAccountRecoverySettingOutputWithContext added in v3.17.0

func (o UserPoolAccountRecoverySettingOutput) ToUserPoolAccountRecoverySettingOutputWithContext(ctx context.Context) UserPoolAccountRecoverySettingOutput

func (UserPoolAccountRecoverySettingOutput) ToUserPoolAccountRecoverySettingPtrOutput added in v3.17.0

func (o UserPoolAccountRecoverySettingOutput) ToUserPoolAccountRecoverySettingPtrOutput() UserPoolAccountRecoverySettingPtrOutput

func (UserPoolAccountRecoverySettingOutput) ToUserPoolAccountRecoverySettingPtrOutputWithContext added in v3.17.0

func (o UserPoolAccountRecoverySettingOutput) ToUserPoolAccountRecoverySettingPtrOutputWithContext(ctx context.Context) UserPoolAccountRecoverySettingPtrOutput

type UserPoolAccountRecoverySettingPtrInput added in v3.17.0

type UserPoolAccountRecoverySettingPtrInput interface {
	pulumi.Input

	ToUserPoolAccountRecoverySettingPtrOutput() UserPoolAccountRecoverySettingPtrOutput
	ToUserPoolAccountRecoverySettingPtrOutputWithContext(context.Context) UserPoolAccountRecoverySettingPtrOutput
}

UserPoolAccountRecoverySettingPtrInput is an input type that accepts UserPoolAccountRecoverySettingArgs, UserPoolAccountRecoverySettingPtr and UserPoolAccountRecoverySettingPtrOutput values. You can construct a concrete instance of `UserPoolAccountRecoverySettingPtrInput` via:

        UserPoolAccountRecoverySettingArgs{...}

or:

        nil

type UserPoolAccountRecoverySettingPtrOutput added in v3.17.0

type UserPoolAccountRecoverySettingPtrOutput struct{ *pulumi.OutputState }

func (UserPoolAccountRecoverySettingPtrOutput) Elem added in v3.17.0

func (UserPoolAccountRecoverySettingPtrOutput) ElementType added in v3.17.0

func (UserPoolAccountRecoverySettingPtrOutput) RecoveryMechanisms added in v3.17.0

List of Account Recovery Options of the following structure:

func (UserPoolAccountRecoverySettingPtrOutput) ToUserPoolAccountRecoverySettingPtrOutput added in v3.17.0

func (o UserPoolAccountRecoverySettingPtrOutput) ToUserPoolAccountRecoverySettingPtrOutput() UserPoolAccountRecoverySettingPtrOutput

func (UserPoolAccountRecoverySettingPtrOutput) ToUserPoolAccountRecoverySettingPtrOutputWithContext added in v3.17.0

func (o UserPoolAccountRecoverySettingPtrOutput) ToUserPoolAccountRecoverySettingPtrOutputWithContext(ctx context.Context) UserPoolAccountRecoverySettingPtrOutput

type UserPoolAccountRecoverySettingRecoveryMechanism added in v3.17.0

type UserPoolAccountRecoverySettingRecoveryMechanism struct {
	// Name of the attribute.
	Name string `pulumi:"name"`
	// Positive integer specifying priority of a method with 1 being the highest priority.
	Priority int `pulumi:"priority"`
}

type UserPoolAccountRecoverySettingRecoveryMechanismArgs added in v3.17.0

type UserPoolAccountRecoverySettingRecoveryMechanismArgs struct {
	// Name of the attribute.
	Name pulumi.StringInput `pulumi:"name"`
	// Positive integer specifying priority of a method with 1 being the highest priority.
	Priority pulumi.IntInput `pulumi:"priority"`
}

func (UserPoolAccountRecoverySettingRecoveryMechanismArgs) ElementType added in v3.17.0

func (UserPoolAccountRecoverySettingRecoveryMechanismArgs) ToUserPoolAccountRecoverySettingRecoveryMechanismOutput added in v3.17.0

func (i UserPoolAccountRecoverySettingRecoveryMechanismArgs) ToUserPoolAccountRecoverySettingRecoveryMechanismOutput() UserPoolAccountRecoverySettingRecoveryMechanismOutput

func (UserPoolAccountRecoverySettingRecoveryMechanismArgs) ToUserPoolAccountRecoverySettingRecoveryMechanismOutputWithContext added in v3.17.0

func (i UserPoolAccountRecoverySettingRecoveryMechanismArgs) ToUserPoolAccountRecoverySettingRecoveryMechanismOutputWithContext(ctx context.Context) UserPoolAccountRecoverySettingRecoveryMechanismOutput

type UserPoolAccountRecoverySettingRecoveryMechanismArray added in v3.17.0

type UserPoolAccountRecoverySettingRecoveryMechanismArray []UserPoolAccountRecoverySettingRecoveryMechanismInput

func (UserPoolAccountRecoverySettingRecoveryMechanismArray) ElementType added in v3.17.0

func (UserPoolAccountRecoverySettingRecoveryMechanismArray) ToUserPoolAccountRecoverySettingRecoveryMechanismArrayOutput added in v3.17.0

func (i UserPoolAccountRecoverySettingRecoveryMechanismArray) ToUserPoolAccountRecoverySettingRecoveryMechanismArrayOutput() UserPoolAccountRecoverySettingRecoveryMechanismArrayOutput

func (UserPoolAccountRecoverySettingRecoveryMechanismArray) ToUserPoolAccountRecoverySettingRecoveryMechanismArrayOutputWithContext added in v3.17.0

func (i UserPoolAccountRecoverySettingRecoveryMechanismArray) ToUserPoolAccountRecoverySettingRecoveryMechanismArrayOutputWithContext(ctx context.Context) UserPoolAccountRecoverySettingRecoveryMechanismArrayOutput

type UserPoolAccountRecoverySettingRecoveryMechanismArrayInput added in v3.17.0

type UserPoolAccountRecoverySettingRecoveryMechanismArrayInput interface {
	pulumi.Input

	ToUserPoolAccountRecoverySettingRecoveryMechanismArrayOutput() UserPoolAccountRecoverySettingRecoveryMechanismArrayOutput
	ToUserPoolAccountRecoverySettingRecoveryMechanismArrayOutputWithContext(context.Context) UserPoolAccountRecoverySettingRecoveryMechanismArrayOutput
}

UserPoolAccountRecoverySettingRecoveryMechanismArrayInput is an input type that accepts UserPoolAccountRecoverySettingRecoveryMechanismArray and UserPoolAccountRecoverySettingRecoveryMechanismArrayOutput values. You can construct a concrete instance of `UserPoolAccountRecoverySettingRecoveryMechanismArrayInput` via:

UserPoolAccountRecoverySettingRecoveryMechanismArray{ UserPoolAccountRecoverySettingRecoveryMechanismArgs{...} }

type UserPoolAccountRecoverySettingRecoveryMechanismArrayOutput added in v3.17.0

type UserPoolAccountRecoverySettingRecoveryMechanismArrayOutput struct{ *pulumi.OutputState }

func (UserPoolAccountRecoverySettingRecoveryMechanismArrayOutput) ElementType added in v3.17.0

func (UserPoolAccountRecoverySettingRecoveryMechanismArrayOutput) Index added in v3.17.0

func (UserPoolAccountRecoverySettingRecoveryMechanismArrayOutput) ToUserPoolAccountRecoverySettingRecoveryMechanismArrayOutput added in v3.17.0

func (UserPoolAccountRecoverySettingRecoveryMechanismArrayOutput) ToUserPoolAccountRecoverySettingRecoveryMechanismArrayOutputWithContext added in v3.17.0

func (o UserPoolAccountRecoverySettingRecoveryMechanismArrayOutput) ToUserPoolAccountRecoverySettingRecoveryMechanismArrayOutputWithContext(ctx context.Context) UserPoolAccountRecoverySettingRecoveryMechanismArrayOutput

type UserPoolAccountRecoverySettingRecoveryMechanismInput added in v3.17.0

type UserPoolAccountRecoverySettingRecoveryMechanismInput interface {
	pulumi.Input

	ToUserPoolAccountRecoverySettingRecoveryMechanismOutput() UserPoolAccountRecoverySettingRecoveryMechanismOutput
	ToUserPoolAccountRecoverySettingRecoveryMechanismOutputWithContext(context.Context) UserPoolAccountRecoverySettingRecoveryMechanismOutput
}

UserPoolAccountRecoverySettingRecoveryMechanismInput is an input type that accepts UserPoolAccountRecoverySettingRecoveryMechanismArgs and UserPoolAccountRecoverySettingRecoveryMechanismOutput values. You can construct a concrete instance of `UserPoolAccountRecoverySettingRecoveryMechanismInput` via:

UserPoolAccountRecoverySettingRecoveryMechanismArgs{...}

type UserPoolAccountRecoverySettingRecoveryMechanismOutput added in v3.17.0

type UserPoolAccountRecoverySettingRecoveryMechanismOutput struct{ *pulumi.OutputState }

func (UserPoolAccountRecoverySettingRecoveryMechanismOutput) ElementType added in v3.17.0

func (UserPoolAccountRecoverySettingRecoveryMechanismOutput) Name added in v3.17.0

Name of the attribute.

func (UserPoolAccountRecoverySettingRecoveryMechanismOutput) Priority added in v3.17.0

Positive integer specifying priority of a method with 1 being the highest priority.

func (UserPoolAccountRecoverySettingRecoveryMechanismOutput) ToUserPoolAccountRecoverySettingRecoveryMechanismOutput added in v3.17.0

func (UserPoolAccountRecoverySettingRecoveryMechanismOutput) ToUserPoolAccountRecoverySettingRecoveryMechanismOutputWithContext added in v3.17.0

func (o UserPoolAccountRecoverySettingRecoveryMechanismOutput) ToUserPoolAccountRecoverySettingRecoveryMechanismOutputWithContext(ctx context.Context) UserPoolAccountRecoverySettingRecoveryMechanismOutput

type UserPoolAdminCreateUserConfig

type UserPoolAdminCreateUserConfig struct {
	// Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
	AllowAdminCreateUserOnly *bool `pulumi:"allowAdminCreateUserOnly"`
	// Invite message template structure. Detailed below.
	InviteMessageTemplate *UserPoolAdminCreateUserConfigInviteMessageTemplate `pulumi:"inviteMessageTemplate"`
}

type UserPoolAdminCreateUserConfigArgs

type UserPoolAdminCreateUserConfigArgs struct {
	// Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
	AllowAdminCreateUserOnly pulumi.BoolPtrInput `pulumi:"allowAdminCreateUserOnly"`
	// Invite message template structure. Detailed below.
	InviteMessageTemplate UserPoolAdminCreateUserConfigInviteMessageTemplatePtrInput `pulumi:"inviteMessageTemplate"`
}

func (UserPoolAdminCreateUserConfigArgs) ElementType

func (UserPoolAdminCreateUserConfigArgs) ToUserPoolAdminCreateUserConfigOutput

func (i UserPoolAdminCreateUserConfigArgs) ToUserPoolAdminCreateUserConfigOutput() UserPoolAdminCreateUserConfigOutput

func (UserPoolAdminCreateUserConfigArgs) ToUserPoolAdminCreateUserConfigOutputWithContext

func (i UserPoolAdminCreateUserConfigArgs) ToUserPoolAdminCreateUserConfigOutputWithContext(ctx context.Context) UserPoolAdminCreateUserConfigOutput

func (UserPoolAdminCreateUserConfigArgs) ToUserPoolAdminCreateUserConfigPtrOutput

func (i UserPoolAdminCreateUserConfigArgs) ToUserPoolAdminCreateUserConfigPtrOutput() UserPoolAdminCreateUserConfigPtrOutput

func (UserPoolAdminCreateUserConfigArgs) ToUserPoolAdminCreateUserConfigPtrOutputWithContext

func (i UserPoolAdminCreateUserConfigArgs) ToUserPoolAdminCreateUserConfigPtrOutputWithContext(ctx context.Context) UserPoolAdminCreateUserConfigPtrOutput

type UserPoolAdminCreateUserConfigInput

type UserPoolAdminCreateUserConfigInput interface {
	pulumi.Input

	ToUserPoolAdminCreateUserConfigOutput() UserPoolAdminCreateUserConfigOutput
	ToUserPoolAdminCreateUserConfigOutputWithContext(context.Context) UserPoolAdminCreateUserConfigOutput
}

UserPoolAdminCreateUserConfigInput is an input type that accepts UserPoolAdminCreateUserConfigArgs and UserPoolAdminCreateUserConfigOutput values. You can construct a concrete instance of `UserPoolAdminCreateUserConfigInput` via:

UserPoolAdminCreateUserConfigArgs{...}

type UserPoolAdminCreateUserConfigInviteMessageTemplate

type UserPoolAdminCreateUserConfigInviteMessageTemplate struct {
	// Email message template. Must contain the `{####}` placeholder. Conflicts with `emailVerificationMessage` argument.
	EmailMessage *string `pulumi:"emailMessage"`
	// Subject line for the email message template. Conflicts with `emailVerificationSubject` argument.
	EmailSubject *string `pulumi:"emailSubject"`
	// SMS message template. Must contain the `{####}` placeholder. Conflicts with `smsVerificationMessage` argument.
	SmsMessage *string `pulumi:"smsMessage"`
}

type UserPoolAdminCreateUserConfigInviteMessageTemplateArgs

type UserPoolAdminCreateUserConfigInviteMessageTemplateArgs struct {
	// Email message template. Must contain the `{####}` placeholder. Conflicts with `emailVerificationMessage` argument.
	EmailMessage pulumi.StringPtrInput `pulumi:"emailMessage"`
	// Subject line for the email message template. Conflicts with `emailVerificationSubject` argument.
	EmailSubject pulumi.StringPtrInput `pulumi:"emailSubject"`
	// SMS message template. Must contain the `{####}` placeholder. Conflicts with `smsVerificationMessage` argument.
	SmsMessage pulumi.StringPtrInput `pulumi:"smsMessage"`
}

func (UserPoolAdminCreateUserConfigInviteMessageTemplateArgs) ElementType

func (UserPoolAdminCreateUserConfigInviteMessageTemplateArgs) ToUserPoolAdminCreateUserConfigInviteMessageTemplateOutput

func (UserPoolAdminCreateUserConfigInviteMessageTemplateArgs) ToUserPoolAdminCreateUserConfigInviteMessageTemplateOutputWithContext

func (i UserPoolAdminCreateUserConfigInviteMessageTemplateArgs) ToUserPoolAdminCreateUserConfigInviteMessageTemplateOutputWithContext(ctx context.Context) UserPoolAdminCreateUserConfigInviteMessageTemplateOutput

func (UserPoolAdminCreateUserConfigInviteMessageTemplateArgs) ToUserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput

func (i UserPoolAdminCreateUserConfigInviteMessageTemplateArgs) ToUserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput() UserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput

func (UserPoolAdminCreateUserConfigInviteMessageTemplateArgs) ToUserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutputWithContext

func (i UserPoolAdminCreateUserConfigInviteMessageTemplateArgs) ToUserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutputWithContext(ctx context.Context) UserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput

type UserPoolAdminCreateUserConfigInviteMessageTemplateInput

type UserPoolAdminCreateUserConfigInviteMessageTemplateInput interface {
	pulumi.Input

	ToUserPoolAdminCreateUserConfigInviteMessageTemplateOutput() UserPoolAdminCreateUserConfigInviteMessageTemplateOutput
	ToUserPoolAdminCreateUserConfigInviteMessageTemplateOutputWithContext(context.Context) UserPoolAdminCreateUserConfigInviteMessageTemplateOutput
}

UserPoolAdminCreateUserConfigInviteMessageTemplateInput is an input type that accepts UserPoolAdminCreateUserConfigInviteMessageTemplateArgs and UserPoolAdminCreateUserConfigInviteMessageTemplateOutput values. You can construct a concrete instance of `UserPoolAdminCreateUserConfigInviteMessageTemplateInput` via:

UserPoolAdminCreateUserConfigInviteMessageTemplateArgs{...}

type UserPoolAdminCreateUserConfigInviteMessageTemplateOutput

type UserPoolAdminCreateUserConfigInviteMessageTemplateOutput struct{ *pulumi.OutputState }

func (UserPoolAdminCreateUserConfigInviteMessageTemplateOutput) ElementType

func (UserPoolAdminCreateUserConfigInviteMessageTemplateOutput) EmailMessage

Email message template. Must contain the `{####}` placeholder. Conflicts with `emailVerificationMessage` argument.

func (UserPoolAdminCreateUserConfigInviteMessageTemplateOutput) EmailSubject

Subject line for the email message template. Conflicts with `emailVerificationSubject` argument.

func (UserPoolAdminCreateUserConfigInviteMessageTemplateOutput) SmsMessage

SMS message template. Must contain the `{####}` placeholder. Conflicts with `smsVerificationMessage` argument.

func (UserPoolAdminCreateUserConfigInviteMessageTemplateOutput) ToUserPoolAdminCreateUserConfigInviteMessageTemplateOutput

func (UserPoolAdminCreateUserConfigInviteMessageTemplateOutput) ToUserPoolAdminCreateUserConfigInviteMessageTemplateOutputWithContext

func (o UserPoolAdminCreateUserConfigInviteMessageTemplateOutput) ToUserPoolAdminCreateUserConfigInviteMessageTemplateOutputWithContext(ctx context.Context) UserPoolAdminCreateUserConfigInviteMessageTemplateOutput

func (UserPoolAdminCreateUserConfigInviteMessageTemplateOutput) ToUserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput

func (UserPoolAdminCreateUserConfigInviteMessageTemplateOutput) ToUserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutputWithContext

func (o UserPoolAdminCreateUserConfigInviteMessageTemplateOutput) ToUserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutputWithContext(ctx context.Context) UserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput

type UserPoolAdminCreateUserConfigInviteMessageTemplatePtrInput

type UserPoolAdminCreateUserConfigInviteMessageTemplatePtrInput interface {
	pulumi.Input

	ToUserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput() UserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput
	ToUserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutputWithContext(context.Context) UserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput
}

UserPoolAdminCreateUserConfigInviteMessageTemplatePtrInput is an input type that accepts UserPoolAdminCreateUserConfigInviteMessageTemplateArgs, UserPoolAdminCreateUserConfigInviteMessageTemplatePtr and UserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput values. You can construct a concrete instance of `UserPoolAdminCreateUserConfigInviteMessageTemplatePtrInput` via:

        UserPoolAdminCreateUserConfigInviteMessageTemplateArgs{...}

or:

        nil

type UserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput

type UserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput struct{ *pulumi.OutputState }

func (UserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput) Elem

func (UserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput) ElementType

func (UserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput) EmailMessage

Email message template. Must contain the `{####}` placeholder. Conflicts with `emailVerificationMessage` argument.

func (UserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput) EmailSubject

Subject line for the email message template. Conflicts with `emailVerificationSubject` argument.

func (UserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput) SmsMessage

SMS message template. Must contain the `{####}` placeholder. Conflicts with `smsVerificationMessage` argument.

func (UserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput) ToUserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput

func (UserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput) ToUserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutputWithContext

func (o UserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput) ToUserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutputWithContext(ctx context.Context) UserPoolAdminCreateUserConfigInviteMessageTemplatePtrOutput

type UserPoolAdminCreateUserConfigOutput

type UserPoolAdminCreateUserConfigOutput struct{ *pulumi.OutputState }

func (UserPoolAdminCreateUserConfigOutput) AllowAdminCreateUserOnly

func (o UserPoolAdminCreateUserConfigOutput) AllowAdminCreateUserOnly() pulumi.BoolPtrOutput

Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.

func (UserPoolAdminCreateUserConfigOutput) ElementType

func (UserPoolAdminCreateUserConfigOutput) InviteMessageTemplate

Invite message template structure. Detailed below.

func (UserPoolAdminCreateUserConfigOutput) ToUserPoolAdminCreateUserConfigOutput

func (o UserPoolAdminCreateUserConfigOutput) ToUserPoolAdminCreateUserConfigOutput() UserPoolAdminCreateUserConfigOutput

func (UserPoolAdminCreateUserConfigOutput) ToUserPoolAdminCreateUserConfigOutputWithContext

func (o UserPoolAdminCreateUserConfigOutput) ToUserPoolAdminCreateUserConfigOutputWithContext(ctx context.Context) UserPoolAdminCreateUserConfigOutput

func (UserPoolAdminCreateUserConfigOutput) ToUserPoolAdminCreateUserConfigPtrOutput

func (o UserPoolAdminCreateUserConfigOutput) ToUserPoolAdminCreateUserConfigPtrOutput() UserPoolAdminCreateUserConfigPtrOutput

func (UserPoolAdminCreateUserConfigOutput) ToUserPoolAdminCreateUserConfigPtrOutputWithContext

func (o UserPoolAdminCreateUserConfigOutput) ToUserPoolAdminCreateUserConfigPtrOutputWithContext(ctx context.Context) UserPoolAdminCreateUserConfigPtrOutput

type UserPoolAdminCreateUserConfigPtrInput

type UserPoolAdminCreateUserConfigPtrInput interface {
	pulumi.Input

	ToUserPoolAdminCreateUserConfigPtrOutput() UserPoolAdminCreateUserConfigPtrOutput
	ToUserPoolAdminCreateUserConfigPtrOutputWithContext(context.Context) UserPoolAdminCreateUserConfigPtrOutput
}

UserPoolAdminCreateUserConfigPtrInput is an input type that accepts UserPoolAdminCreateUserConfigArgs, UserPoolAdminCreateUserConfigPtr and UserPoolAdminCreateUserConfigPtrOutput values. You can construct a concrete instance of `UserPoolAdminCreateUserConfigPtrInput` via:

        UserPoolAdminCreateUserConfigArgs{...}

or:

        nil

type UserPoolAdminCreateUserConfigPtrOutput

type UserPoolAdminCreateUserConfigPtrOutput struct{ *pulumi.OutputState }

func (UserPoolAdminCreateUserConfigPtrOutput) AllowAdminCreateUserOnly

func (o UserPoolAdminCreateUserConfigPtrOutput) AllowAdminCreateUserOnly() pulumi.BoolPtrOutput

Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.

func (UserPoolAdminCreateUserConfigPtrOutput) Elem

func (UserPoolAdminCreateUserConfigPtrOutput) ElementType

func (UserPoolAdminCreateUserConfigPtrOutput) InviteMessageTemplate

Invite message template structure. Detailed below.

func (UserPoolAdminCreateUserConfigPtrOutput) ToUserPoolAdminCreateUserConfigPtrOutput

func (o UserPoolAdminCreateUserConfigPtrOutput) ToUserPoolAdminCreateUserConfigPtrOutput() UserPoolAdminCreateUserConfigPtrOutput

func (UserPoolAdminCreateUserConfigPtrOutput) ToUserPoolAdminCreateUserConfigPtrOutputWithContext

func (o UserPoolAdminCreateUserConfigPtrOutput) ToUserPoolAdminCreateUserConfigPtrOutputWithContext(ctx context.Context) UserPoolAdminCreateUserConfigPtrOutput

type UserPoolArgs

type UserPoolArgs struct {
	// Configuration block to define which verified available method a user can use to recover their forgotten password. Detailed below.
	AccountRecoverySetting UserPoolAccountRecoverySettingPtrInput
	// Configuration block for creating a new user profile. Detailed below.
	AdminCreateUserConfig UserPoolAdminCreateUserConfigPtrInput
	// Attributes supported as an alias for this user pool. Valid values: `phoneNumber`, `email`, or `preferredUsername`. Conflicts with `usernameAttributes`.
	AliasAttributes pulumi.StringArrayInput
	// Attributes to be auto-verified. Valid values: `email`, `phoneNumber`.
	AutoVerifiedAttributes pulumi.StringArrayInput
	// Configuration block for the user pool's device tracking. Detailed below.
	DeviceConfiguration UserPoolDeviceConfigurationPtrInput
	// Configuration block for configuring email. Detailed below.
	EmailConfiguration UserPoolEmailConfigurationPtrInput
	// String representing the email verification message. Conflicts with `verificationMessageTemplate` configuration block `emailMessage` argument.
	EmailVerificationMessage pulumi.StringPtrInput
	// String representing the email verification subject. Conflicts with `verificationMessageTemplate` configuration block `emailSubject` argument.
	EmailVerificationSubject pulumi.StringPtrInput
	// Configuration block for the AWS Lambda triggers associated with the user pool. Detailed below.
	LambdaConfig UserPoolLambdaConfigPtrInput
	// Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of `OFF`. Valid values are `OFF` (MFA Tokens are not required), `ON` (MFA is required for all users to sign in; requires at least one of `smsConfiguration` or `softwareTokenMfaConfiguration` to be configured), or `OPTIONAL` (MFA Will be required only for individual users who have MFA Enabled; requires at least one of `smsConfiguration` or `softwareTokenMfaConfiguration` to be configured).
	MfaConfiguration pulumi.StringPtrInput
	// Name of the attribute.
	Name pulumi.StringPtrInput
	// Configuration blocked for information about the user pool password policy. Detailed below.
	PasswordPolicy UserPoolPasswordPolicyPtrInput
	// Configuration block for the schema attributes of a user pool. Detailed below. Schema attributes from the [standard attribute set](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#cognito-user-pools-standard-attributes) only need to be specified if they are different from the default configuration. Attributes can be added, but not modified or removed. Maximum of 50 attributes.
	Schemas UserPoolSchemaArrayInput
	// String representing the SMS authentication message. The Message must contain the `{####}` placeholder, which will be replaced with the code.
	SmsAuthenticationMessage pulumi.StringPtrInput
	// Configuration block for Short Message Service (SMS) settings. Detailed below. These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection.
	SmsConfiguration UserPoolSmsConfigurationPtrInput
	// String representing the SMS verification message. Conflicts with `verificationMessageTemplate` configuration block `smsMessage` argument.
	SmsVerificationMessage pulumi.StringPtrInput
	// Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.
	SoftwareTokenMfaConfiguration UserPoolSoftwareTokenMfaConfigurationPtrInput
	// Map of tags to assign to the User Pool.
	Tags pulumi.StringMapInput
	// Configuration block for user pool add-ons to enable user pool advanced security mode features. Detailed below.
	UserPoolAddOns UserPoolUserPoolAddOnsPtrInput
	// Whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with `aliasAttributes`.
	UsernameAttributes pulumi.StringArrayInput
	// Configuration block for username configuration. Detailed below.
	UsernameConfiguration UserPoolUsernameConfigurationPtrInput
	// Configuration block for verification message templates. Detailed below.
	VerificationMessageTemplate UserPoolVerificationMessageTemplatePtrInput
}

The set of arguments for constructing a UserPool resource.

func (UserPoolArgs) ElementType

func (UserPoolArgs) ElementType() reflect.Type

type UserPoolArray added in v3.25.0

type UserPoolArray []UserPoolInput

func (UserPoolArray) ElementType added in v3.25.0

func (UserPoolArray) ElementType() reflect.Type

func (UserPoolArray) ToUserPoolArrayOutput added in v3.25.0

func (i UserPoolArray) ToUserPoolArrayOutput() UserPoolArrayOutput

func (UserPoolArray) ToUserPoolArrayOutputWithContext added in v3.25.0

func (i UserPoolArray) ToUserPoolArrayOutputWithContext(ctx context.Context) UserPoolArrayOutput

type UserPoolArrayInput added in v3.25.0

type UserPoolArrayInput interface {
	pulumi.Input

	ToUserPoolArrayOutput() UserPoolArrayOutput
	ToUserPoolArrayOutputWithContext(context.Context) UserPoolArrayOutput
}

UserPoolArrayInput is an input type that accepts UserPoolArray and UserPoolArrayOutput values. You can construct a concrete instance of `UserPoolArrayInput` via:

UserPoolArray{ UserPoolArgs{...} }

type UserPoolArrayOutput added in v3.25.0

type UserPoolArrayOutput struct{ *pulumi.OutputState }

func (UserPoolArrayOutput) ElementType added in v3.25.0

func (UserPoolArrayOutput) ElementType() reflect.Type

func (UserPoolArrayOutput) Index added in v3.25.0

func (UserPoolArrayOutput) ToUserPoolArrayOutput added in v3.25.0

func (o UserPoolArrayOutput) ToUserPoolArrayOutput() UserPoolArrayOutput

func (UserPoolArrayOutput) ToUserPoolArrayOutputWithContext added in v3.25.0

func (o UserPoolArrayOutput) ToUserPoolArrayOutputWithContext(ctx context.Context) UserPoolArrayOutput

type UserPoolClient

type UserPoolClient struct {
	pulumi.CustomResourceState

	// Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value in `tokenValidityUnits`.
	AccessTokenValidity pulumi.IntPtrOutput `pulumi:"accessTokenValidity"`
	// List of allowed OAuth flows (code, implicit, client_credentials).
	AllowedOauthFlows pulumi.StringArrayOutput `pulumi:"allowedOauthFlows"`
	// Whether the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
	AllowedOauthFlowsUserPoolClient pulumi.BoolPtrOutput `pulumi:"allowedOauthFlowsUserPoolClient"`
	// List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).
	AllowedOauthScopes pulumi.StringArrayOutput `pulumi:"allowedOauthScopes"`
	// Configuration block for Amazon Pinpoint analytics for collecting metrics for this user pool. Detailed below.
	AnalyticsConfiguration UserPoolClientAnalyticsConfigurationPtrOutput `pulumi:"analyticsConfiguration"`
	// List of allowed callback URLs for the identity providers.
	CallbackUrls pulumi.StringArrayOutput `pulumi:"callbackUrls"`
	// Client secret of the user pool client.
	ClientSecret pulumi.StringOutput `pulumi:"clientSecret"`
	// Default redirect URI. Must be in the list of callback URLs.
	DefaultRedirectUri pulumi.StringPtrOutput `pulumi:"defaultRedirectUri"`
	// List of authentication flows (ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH).
	ExplicitAuthFlows pulumi.StringArrayOutput `pulumi:"explicitAuthFlows"`
	// Should an application secret be generated.
	GenerateSecret pulumi.BoolPtrOutput `pulumi:"generateSecret"`
	// Time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value in `tokenValidityUnits`.
	IdTokenValidity pulumi.IntPtrOutput `pulumi:"idTokenValidity"`
	// List of allowed logout URLs for the identity providers.
	LogoutUrls pulumi.StringArrayOutput `pulumi:"logoutUrls"`
	// Name of the application client.
	Name pulumi.StringOutput `pulumi:"name"`
	// Choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to `ENABLED` and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to `LEGACY`, those APIs will return a `UserNotFoundException` exception if the user does not exist in the user pool.
	PreventUserExistenceErrors pulumi.StringOutput `pulumi:"preventUserExistenceErrors"`
	// List of user pool attributes the application client can read from.
	ReadAttributes pulumi.StringArrayOutput `pulumi:"readAttributes"`
	// Time limit in days refresh tokens are valid for.
	RefreshTokenValidity pulumi.IntPtrOutput `pulumi:"refreshTokenValidity"`
	// List of provider names for the identity providers that are supported on this client.
	SupportedIdentityProviders pulumi.StringArrayOutput `pulumi:"supportedIdentityProviders"`
	// Configuration block for units in which the validity times are represented in. Detailed below.
	TokenValidityUnits UserPoolClientTokenValidityUnitsPtrOutput `pulumi:"tokenValidityUnits"`
	// User pool the client belongs to.
	UserPoolId pulumi.StringOutput `pulumi:"userPoolId"`
	// List of user pool attributes the application client can write to.
	WriteAttributes pulumi.StringArrayOutput `pulumi:"writeAttributes"`
}

Provides a Cognito User Pool Client resource.

## Example Usage ### Create a basic user pool client

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/cognito"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		pool, err := cognito.NewUserPool(ctx, "pool", nil)
		if err != nil {
			return err
		}
		_, err = cognito.NewUserPoolClient(ctx, "client", &cognito.UserPoolClientArgs{
			UserPoolId: pool.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Create a user pool client with no SRP authentication

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/cognito"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		pool, err := cognito.NewUserPool(ctx, "pool", nil)
		if err != nil {
			return err
		}
		_, err = cognito.NewUserPoolClient(ctx, "client", &cognito.UserPoolClientArgs{
			UserPoolId:     pool.ID(),
			GenerateSecret: pulumi.Bool(true),
			ExplicitAuthFlows: pulumi.StringArray{
				pulumi.String("ADMIN_NO_SRP_AUTH"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Create a user pool client with pinpoint analytics

```go package main

import (

"fmt"

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws"
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/cognito"
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/iam"
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/pinpoint"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := aws.GetCallerIdentity(ctx, nil, nil)
		if err != nil {
			return err
		}
		testUserPool, err := cognito.NewUserPool(ctx, "testUserPool", nil)
		if err != nil {
			return err
		}
		testApp, err := pinpoint.NewApp(ctx, "testApp", nil)
		if err != nil {
			return err
		}
		testRole, err := iam.NewRole(ctx, "testRole", &iam.RoleArgs{
			AssumeRolePolicy: pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v%v", "{\n", "  \"Version\": \"2012-10-17\",\n", "  \"Statement\": [\n", "    {\n", "      \"Action\": \"sts:AssumeRole\",\n", "      \"Principal\": {\n", "        \"Service\": \"cognito-idp.amazonaws.com\"\n", "      },\n", "      \"Effect\": \"Allow\",\n", "      \"Sid\": \"\"\n", "    }\n", "  ]\n", "}\n")),
		})
		if err != nil {
			return err
		}
		_, err = iam.NewRolePolicy(ctx, "testRolePolicy", &iam.RolePolicyArgs{
			Role: testRole.ID(),
			Policy: testApp.ApplicationId.ApplyT(func(applicationId string) (string, error) {
				return fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v", "{\n", "  \"Version\": \"2012-10-17\",\n", "  \"Statement\": [\n", "    {\n", "      \"Action\": [\n", "        \"mobiletargeting:UpdateEndpoint\",\n", "        \"mobiletargeting:PutItems\"\n", "      ],\n", "      \"Effect\": \"Allow\",\n", "      \"Resource\": \"arn:aws:mobiletargeting:*:", current.AccountId, ":apps/", applicationId, "*\"\n", "    }\n", "  ]\n", "}\n"), nil
			}).(pulumi.StringOutput),
		})
		if err != nil {
			return err
		}
		_, err = cognito.NewUserPoolClient(ctx, "testUserPoolClient", &cognito.UserPoolClientArgs{
			UserPoolId: testUserPool.ID(),
			AnalyticsConfiguration: &cognito.UserPoolClientAnalyticsConfigurationArgs{
				ApplicationId:  testApp.ApplicationId,
				ExternalId:     pulumi.String("some_id"),
				RoleArn:        testRole.Arn,
				UserDataShared: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Cognito User Pool Clients can be imported using the `id` of the Cognito User Pool, and the `id` of the Cognito User Pool Client, e.g.

```sh

$ pulumi import aws:cognito/userPoolClient:UserPoolClient client <user_pool_id>/<user_pool_client_id>

```

func GetUserPoolClient

func GetUserPoolClient(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *UserPoolClientState, opts ...pulumi.ResourceOption) (*UserPoolClient, error)

GetUserPoolClient gets an existing UserPoolClient resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewUserPoolClient

func NewUserPoolClient(ctx *pulumi.Context,
	name string, args *UserPoolClientArgs, opts ...pulumi.ResourceOption) (*UserPoolClient, error)

NewUserPoolClient registers a new resource with the given unique name, arguments, and options.

func (*UserPoolClient) ElementType added in v3.13.0

func (*UserPoolClient) ElementType() reflect.Type

func (*UserPoolClient) ToUserPoolClientOutput added in v3.13.0

func (i *UserPoolClient) ToUserPoolClientOutput() UserPoolClientOutput

func (*UserPoolClient) ToUserPoolClientOutputWithContext added in v3.13.0

func (i *UserPoolClient) ToUserPoolClientOutputWithContext(ctx context.Context) UserPoolClientOutput

func (*UserPoolClient) ToUserPoolClientPtrOutput added in v3.25.0

func (i *UserPoolClient) ToUserPoolClientPtrOutput() UserPoolClientPtrOutput

func (*UserPoolClient) ToUserPoolClientPtrOutputWithContext added in v3.25.0

func (i *UserPoolClient) ToUserPoolClientPtrOutputWithContext(ctx context.Context) UserPoolClientPtrOutput

type UserPoolClientAnalyticsConfiguration

type UserPoolClientAnalyticsConfiguration struct {
	// Application ARN for an Amazon Pinpoint application. Conflicts with `externalId` and `roleArn`.
	ApplicationArn *string `pulumi:"applicationArn"`
	// Application ID for an Amazon Pinpoint application.
	ApplicationId *string `pulumi:"applicationId"`
	// ID for the Analytics Configuration. Conflicts with `applicationArn`.
	ExternalId *string `pulumi:"externalId"`
	// ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics. Conflicts with `applicationArn`.
	RoleArn *string `pulumi:"roleArn"`
	// If set to `true`, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
	UserDataShared *bool `pulumi:"userDataShared"`
}

type UserPoolClientAnalyticsConfigurationArgs

type UserPoolClientAnalyticsConfigurationArgs struct {
	// Application ARN for an Amazon Pinpoint application. Conflicts with `externalId` and `roleArn`.
	ApplicationArn pulumi.StringPtrInput `pulumi:"applicationArn"`
	// Application ID for an Amazon Pinpoint application.
	ApplicationId pulumi.StringPtrInput `pulumi:"applicationId"`
	// ID for the Analytics Configuration. Conflicts with `applicationArn`.
	ExternalId pulumi.StringPtrInput `pulumi:"externalId"`
	// ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics. Conflicts with `applicationArn`.
	RoleArn pulumi.StringPtrInput `pulumi:"roleArn"`
	// If set to `true`, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
	UserDataShared pulumi.BoolPtrInput `pulumi:"userDataShared"`
}

func (UserPoolClientAnalyticsConfigurationArgs) ElementType

func (UserPoolClientAnalyticsConfigurationArgs) ToUserPoolClientAnalyticsConfigurationOutput

func (i UserPoolClientAnalyticsConfigurationArgs) ToUserPoolClientAnalyticsConfigurationOutput() UserPoolClientAnalyticsConfigurationOutput

func (UserPoolClientAnalyticsConfigurationArgs) ToUserPoolClientAnalyticsConfigurationOutputWithContext

func (i UserPoolClientAnalyticsConfigurationArgs) ToUserPoolClientAnalyticsConfigurationOutputWithContext(ctx context.Context) UserPoolClientAnalyticsConfigurationOutput

func (UserPoolClientAnalyticsConfigurationArgs) ToUserPoolClientAnalyticsConfigurationPtrOutput

func (i UserPoolClientAnalyticsConfigurationArgs) ToUserPoolClientAnalyticsConfigurationPtrOutput() UserPoolClientAnalyticsConfigurationPtrOutput

func (UserPoolClientAnalyticsConfigurationArgs) ToUserPoolClientAnalyticsConfigurationPtrOutputWithContext

func (i UserPoolClientAnalyticsConfigurationArgs) ToUserPoolClientAnalyticsConfigurationPtrOutputWithContext(ctx context.Context) UserPoolClientAnalyticsConfigurationPtrOutput

type UserPoolClientAnalyticsConfigurationInput

type UserPoolClientAnalyticsConfigurationInput interface {
	pulumi.Input

	ToUserPoolClientAnalyticsConfigurationOutput() UserPoolClientAnalyticsConfigurationOutput
	ToUserPoolClientAnalyticsConfigurationOutputWithContext(context.Context) UserPoolClientAnalyticsConfigurationOutput
}

UserPoolClientAnalyticsConfigurationInput is an input type that accepts UserPoolClientAnalyticsConfigurationArgs and UserPoolClientAnalyticsConfigurationOutput values. You can construct a concrete instance of `UserPoolClientAnalyticsConfigurationInput` via:

UserPoolClientAnalyticsConfigurationArgs{...}

type UserPoolClientAnalyticsConfigurationOutput

type UserPoolClientAnalyticsConfigurationOutput struct{ *pulumi.OutputState }

func (UserPoolClientAnalyticsConfigurationOutput) ApplicationArn added in v3.30.0

Application ARN for an Amazon Pinpoint application. Conflicts with `externalId` and `roleArn`.

func (UserPoolClientAnalyticsConfigurationOutput) ApplicationId

Application ID for an Amazon Pinpoint application.

func (UserPoolClientAnalyticsConfigurationOutput) ElementType

func (UserPoolClientAnalyticsConfigurationOutput) ExternalId

ID for the Analytics Configuration. Conflicts with `applicationArn`.

func (UserPoolClientAnalyticsConfigurationOutput) RoleArn

ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics. Conflicts with `applicationArn`.

func (UserPoolClientAnalyticsConfigurationOutput) ToUserPoolClientAnalyticsConfigurationOutput

func (o UserPoolClientAnalyticsConfigurationOutput) ToUserPoolClientAnalyticsConfigurationOutput() UserPoolClientAnalyticsConfigurationOutput

func (UserPoolClientAnalyticsConfigurationOutput) ToUserPoolClientAnalyticsConfigurationOutputWithContext

func (o UserPoolClientAnalyticsConfigurationOutput) ToUserPoolClientAnalyticsConfigurationOutputWithContext(ctx context.Context) UserPoolClientAnalyticsConfigurationOutput

func (UserPoolClientAnalyticsConfigurationOutput) ToUserPoolClientAnalyticsConfigurationPtrOutput

func (o UserPoolClientAnalyticsConfigurationOutput) ToUserPoolClientAnalyticsConfigurationPtrOutput() UserPoolClientAnalyticsConfigurationPtrOutput

func (UserPoolClientAnalyticsConfigurationOutput) ToUserPoolClientAnalyticsConfigurationPtrOutputWithContext

func (o UserPoolClientAnalyticsConfigurationOutput) ToUserPoolClientAnalyticsConfigurationPtrOutputWithContext(ctx context.Context) UserPoolClientAnalyticsConfigurationPtrOutput

func (UserPoolClientAnalyticsConfigurationOutput) UserDataShared

If set to `true`, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.

type UserPoolClientAnalyticsConfigurationPtrInput

type UserPoolClientAnalyticsConfigurationPtrInput interface {
	pulumi.Input

	ToUserPoolClientAnalyticsConfigurationPtrOutput() UserPoolClientAnalyticsConfigurationPtrOutput
	ToUserPoolClientAnalyticsConfigurationPtrOutputWithContext(context.Context) UserPoolClientAnalyticsConfigurationPtrOutput
}

UserPoolClientAnalyticsConfigurationPtrInput is an input type that accepts UserPoolClientAnalyticsConfigurationArgs, UserPoolClientAnalyticsConfigurationPtr and UserPoolClientAnalyticsConfigurationPtrOutput values. You can construct a concrete instance of `UserPoolClientAnalyticsConfigurationPtrInput` via:

        UserPoolClientAnalyticsConfigurationArgs{...}

or:

        nil

type UserPoolClientAnalyticsConfigurationPtrOutput

type UserPoolClientAnalyticsConfigurationPtrOutput struct{ *pulumi.OutputState }

func (UserPoolClientAnalyticsConfigurationPtrOutput) ApplicationArn added in v3.30.0

Application ARN for an Amazon Pinpoint application. Conflicts with `externalId` and `roleArn`.

func (UserPoolClientAnalyticsConfigurationPtrOutput) ApplicationId

Application ID for an Amazon Pinpoint application.

func (UserPoolClientAnalyticsConfigurationPtrOutput) Elem

func (UserPoolClientAnalyticsConfigurationPtrOutput) ElementType

func (UserPoolClientAnalyticsConfigurationPtrOutput) ExternalId

ID for the Analytics Configuration. Conflicts with `applicationArn`.

func (UserPoolClientAnalyticsConfigurationPtrOutput) RoleArn

ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics. Conflicts with `applicationArn`.

func (UserPoolClientAnalyticsConfigurationPtrOutput) ToUserPoolClientAnalyticsConfigurationPtrOutput

func (o UserPoolClientAnalyticsConfigurationPtrOutput) ToUserPoolClientAnalyticsConfigurationPtrOutput() UserPoolClientAnalyticsConfigurationPtrOutput

func (UserPoolClientAnalyticsConfigurationPtrOutput) ToUserPoolClientAnalyticsConfigurationPtrOutputWithContext

func (o UserPoolClientAnalyticsConfigurationPtrOutput) ToUserPoolClientAnalyticsConfigurationPtrOutputWithContext(ctx context.Context) UserPoolClientAnalyticsConfigurationPtrOutput

func (UserPoolClientAnalyticsConfigurationPtrOutput) UserDataShared

If set to `true`, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.

type UserPoolClientArgs

type UserPoolClientArgs struct {
	// Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value in `tokenValidityUnits`.
	AccessTokenValidity pulumi.IntPtrInput
	// List of allowed OAuth flows (code, implicit, client_credentials).
	AllowedOauthFlows pulumi.StringArrayInput
	// Whether the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
	AllowedOauthFlowsUserPoolClient pulumi.BoolPtrInput
	// List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).
	AllowedOauthScopes pulumi.StringArrayInput
	// Configuration block for Amazon Pinpoint analytics for collecting metrics for this user pool. Detailed below.
	AnalyticsConfiguration UserPoolClientAnalyticsConfigurationPtrInput
	// List of allowed callback URLs for the identity providers.
	CallbackUrls pulumi.StringArrayInput
	// Default redirect URI. Must be in the list of callback URLs.
	DefaultRedirectUri pulumi.StringPtrInput
	// List of authentication flows (ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH).
	ExplicitAuthFlows pulumi.StringArrayInput
	// Should an application secret be generated.
	GenerateSecret pulumi.BoolPtrInput
	// Time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value in `tokenValidityUnits`.
	IdTokenValidity pulumi.IntPtrInput
	// List of allowed logout URLs for the identity providers.
	LogoutUrls pulumi.StringArrayInput
	// Name of the application client.
	Name pulumi.StringPtrInput
	// Choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to `ENABLED` and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to `LEGACY`, those APIs will return a `UserNotFoundException` exception if the user does not exist in the user pool.
	PreventUserExistenceErrors pulumi.StringPtrInput
	// List of user pool attributes the application client can read from.
	ReadAttributes pulumi.StringArrayInput
	// Time limit in days refresh tokens are valid for.
	RefreshTokenValidity pulumi.IntPtrInput
	// List of provider names for the identity providers that are supported on this client.
	SupportedIdentityProviders pulumi.StringArrayInput
	// Configuration block for units in which the validity times are represented in. Detailed below.
	TokenValidityUnits UserPoolClientTokenValidityUnitsPtrInput
	// User pool the client belongs to.
	UserPoolId pulumi.StringInput
	// List of user pool attributes the application client can write to.
	WriteAttributes pulumi.StringArrayInput
}

The set of arguments for constructing a UserPoolClient resource.

func (UserPoolClientArgs) ElementType

func (UserPoolClientArgs) ElementType() reflect.Type

type UserPoolClientArray added in v3.25.0

type UserPoolClientArray []UserPoolClientInput

func (UserPoolClientArray) ElementType added in v3.25.0

func (UserPoolClientArray) ElementType() reflect.Type

func (UserPoolClientArray) ToUserPoolClientArrayOutput added in v3.25.0

func (i UserPoolClientArray) ToUserPoolClientArrayOutput() UserPoolClientArrayOutput

func (UserPoolClientArray) ToUserPoolClientArrayOutputWithContext added in v3.25.0

func (i UserPoolClientArray) ToUserPoolClientArrayOutputWithContext(ctx context.Context) UserPoolClientArrayOutput

type UserPoolClientArrayInput added in v3.25.0

type UserPoolClientArrayInput interface {
	pulumi.Input

	ToUserPoolClientArrayOutput() UserPoolClientArrayOutput
	ToUserPoolClientArrayOutputWithContext(context.Context) UserPoolClientArrayOutput
}

UserPoolClientArrayInput is an input type that accepts UserPoolClientArray and UserPoolClientArrayOutput values. You can construct a concrete instance of `UserPoolClientArrayInput` via:

UserPoolClientArray{ UserPoolClientArgs{...} }

type UserPoolClientArrayOutput added in v3.25.0

type UserPoolClientArrayOutput struct{ *pulumi.OutputState }

func (UserPoolClientArrayOutput) ElementType added in v3.25.0

func (UserPoolClientArrayOutput) ElementType() reflect.Type

func (UserPoolClientArrayOutput) Index added in v3.25.0

func (UserPoolClientArrayOutput) ToUserPoolClientArrayOutput added in v3.25.0

func (o UserPoolClientArrayOutput) ToUserPoolClientArrayOutput() UserPoolClientArrayOutput

func (UserPoolClientArrayOutput) ToUserPoolClientArrayOutputWithContext added in v3.25.0

func (o UserPoolClientArrayOutput) ToUserPoolClientArrayOutputWithContext(ctx context.Context) UserPoolClientArrayOutput

type UserPoolClientInput added in v3.13.0

type UserPoolClientInput interface {
	pulumi.Input

	ToUserPoolClientOutput() UserPoolClientOutput
	ToUserPoolClientOutputWithContext(ctx context.Context) UserPoolClientOutput
}

type UserPoolClientMap added in v3.25.0

type UserPoolClientMap map[string]UserPoolClientInput

func (UserPoolClientMap) ElementType added in v3.25.0

func (UserPoolClientMap) ElementType() reflect.Type

func (UserPoolClientMap) ToUserPoolClientMapOutput added in v3.25.0

func (i UserPoolClientMap) ToUserPoolClientMapOutput() UserPoolClientMapOutput

func (UserPoolClientMap) ToUserPoolClientMapOutputWithContext added in v3.25.0

func (i UserPoolClientMap) ToUserPoolClientMapOutputWithContext(ctx context.Context) UserPoolClientMapOutput

type UserPoolClientMapInput added in v3.25.0

type UserPoolClientMapInput interface {
	pulumi.Input

	ToUserPoolClientMapOutput() UserPoolClientMapOutput
	ToUserPoolClientMapOutputWithContext(context.Context) UserPoolClientMapOutput
}

UserPoolClientMapInput is an input type that accepts UserPoolClientMap and UserPoolClientMapOutput values. You can construct a concrete instance of `UserPoolClientMapInput` via:

UserPoolClientMap{ "key": UserPoolClientArgs{...} }

type UserPoolClientMapOutput added in v3.25.0

type UserPoolClientMapOutput struct{ *pulumi.OutputState }

func (UserPoolClientMapOutput) ElementType added in v3.25.0

func (UserPoolClientMapOutput) ElementType() reflect.Type

func (UserPoolClientMapOutput) MapIndex added in v3.25.0

func (UserPoolClientMapOutput) ToUserPoolClientMapOutput added in v3.25.0

func (o UserPoolClientMapOutput) ToUserPoolClientMapOutput() UserPoolClientMapOutput

func (UserPoolClientMapOutput) ToUserPoolClientMapOutputWithContext added in v3.25.0

func (o UserPoolClientMapOutput) ToUserPoolClientMapOutputWithContext(ctx context.Context) UserPoolClientMapOutput

type UserPoolClientOutput added in v3.13.0

type UserPoolClientOutput struct {
	*pulumi.OutputState
}

func (UserPoolClientOutput) ElementType added in v3.13.0

func (UserPoolClientOutput) ElementType() reflect.Type

func (UserPoolClientOutput) ToUserPoolClientOutput added in v3.13.0

func (o UserPoolClientOutput) ToUserPoolClientOutput() UserPoolClientOutput

func (UserPoolClientOutput) ToUserPoolClientOutputWithContext added in v3.13.0

func (o UserPoolClientOutput) ToUserPoolClientOutputWithContext(ctx context.Context) UserPoolClientOutput

func (UserPoolClientOutput) ToUserPoolClientPtrOutput added in v3.25.0

func (o UserPoolClientOutput) ToUserPoolClientPtrOutput() UserPoolClientPtrOutput

func (UserPoolClientOutput) ToUserPoolClientPtrOutputWithContext added in v3.25.0

func (o UserPoolClientOutput) ToUserPoolClientPtrOutputWithContext(ctx context.Context) UserPoolClientPtrOutput

type UserPoolClientPtrInput added in v3.25.0

type UserPoolClientPtrInput interface {
	pulumi.Input

	ToUserPoolClientPtrOutput() UserPoolClientPtrOutput
	ToUserPoolClientPtrOutputWithContext(ctx context.Context) UserPoolClientPtrOutput
}

type UserPoolClientPtrOutput added in v3.25.0

type UserPoolClientPtrOutput struct {
	*pulumi.OutputState
}

func (UserPoolClientPtrOutput) ElementType added in v3.25.0

func (UserPoolClientPtrOutput) ElementType() reflect.Type

func (UserPoolClientPtrOutput) ToUserPoolClientPtrOutput added in v3.25.0

func (o UserPoolClientPtrOutput) ToUserPoolClientPtrOutput() UserPoolClientPtrOutput

func (UserPoolClientPtrOutput) ToUserPoolClientPtrOutputWithContext added in v3.25.0

func (o UserPoolClientPtrOutput) ToUserPoolClientPtrOutputWithContext(ctx context.Context) UserPoolClientPtrOutput

type UserPoolClientState

type UserPoolClientState struct {
	// Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value in `tokenValidityUnits`.
	AccessTokenValidity pulumi.IntPtrInput
	// List of allowed OAuth flows (code, implicit, client_credentials).
	AllowedOauthFlows pulumi.StringArrayInput
	// Whether the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
	AllowedOauthFlowsUserPoolClient pulumi.BoolPtrInput
	// List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).
	AllowedOauthScopes pulumi.StringArrayInput
	// Configuration block for Amazon Pinpoint analytics for collecting metrics for this user pool. Detailed below.
	AnalyticsConfiguration UserPoolClientAnalyticsConfigurationPtrInput
	// List of allowed callback URLs for the identity providers.
	CallbackUrls pulumi.StringArrayInput
	// Client secret of the user pool client.
	ClientSecret pulumi.StringPtrInput
	// Default redirect URI. Must be in the list of callback URLs.
	DefaultRedirectUri pulumi.StringPtrInput
	// List of authentication flows (ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH).
	ExplicitAuthFlows pulumi.StringArrayInput
	// Should an application secret be generated.
	GenerateSecret pulumi.BoolPtrInput
	// Time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value in `tokenValidityUnits`.
	IdTokenValidity pulumi.IntPtrInput
	// List of allowed logout URLs for the identity providers.
	LogoutUrls pulumi.StringArrayInput
	// Name of the application client.
	Name pulumi.StringPtrInput
	// Choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to `ENABLED` and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to `LEGACY`, those APIs will return a `UserNotFoundException` exception if the user does not exist in the user pool.
	PreventUserExistenceErrors pulumi.StringPtrInput
	// List of user pool attributes the application client can read from.
	ReadAttributes pulumi.StringArrayInput
	// Time limit in days refresh tokens are valid for.
	RefreshTokenValidity pulumi.IntPtrInput
	// List of provider names for the identity providers that are supported on this client.
	SupportedIdentityProviders pulumi.StringArrayInput
	// Configuration block for units in which the validity times are represented in. Detailed below.
	TokenValidityUnits UserPoolClientTokenValidityUnitsPtrInput
	// User pool the client belongs to.
	UserPoolId pulumi.StringPtrInput
	// List of user pool attributes the application client can write to.
	WriteAttributes pulumi.StringArrayInput
}

func (UserPoolClientState) ElementType

func (UserPoolClientState) ElementType() reflect.Type

type UserPoolClientTokenValidityUnits added in v3.33.0

type UserPoolClientTokenValidityUnits struct {
	// Time unit in for the value in `accessTokenValidity`, defaults to `hours`.
	AccessToken *string `pulumi:"accessToken"`
	// Time unit in for the value in `idTokenValidity`, defaults to `hours`.
	IdToken *string `pulumi:"idToken"`
	// Time unit in for the value in `refreshTokenValidity`, defaults to `days`.
	RefreshToken *string `pulumi:"refreshToken"`
}

type UserPoolClientTokenValidityUnitsArgs added in v3.33.0

type UserPoolClientTokenValidityUnitsArgs struct {
	// Time unit in for the value in `accessTokenValidity`, defaults to `hours`.
	AccessToken pulumi.StringPtrInput `pulumi:"accessToken"`
	// Time unit in for the value in `idTokenValidity`, defaults to `hours`.
	IdToken pulumi.StringPtrInput `pulumi:"idToken"`
	// Time unit in for the value in `refreshTokenValidity`, defaults to `days`.
	RefreshToken pulumi.StringPtrInput `pulumi:"refreshToken"`
}

func (UserPoolClientTokenValidityUnitsArgs) ElementType added in v3.33.0

func (UserPoolClientTokenValidityUnitsArgs) ToUserPoolClientTokenValidityUnitsOutput added in v3.33.0

func (i UserPoolClientTokenValidityUnitsArgs) ToUserPoolClientTokenValidityUnitsOutput() UserPoolClientTokenValidityUnitsOutput

func (UserPoolClientTokenValidityUnitsArgs) ToUserPoolClientTokenValidityUnitsOutputWithContext added in v3.33.0

func (i UserPoolClientTokenValidityUnitsArgs) ToUserPoolClientTokenValidityUnitsOutputWithContext(ctx context.Context) UserPoolClientTokenValidityUnitsOutput

func (UserPoolClientTokenValidityUnitsArgs) ToUserPoolClientTokenValidityUnitsPtrOutput added in v3.33.0

func (i UserPoolClientTokenValidityUnitsArgs) ToUserPoolClientTokenValidityUnitsPtrOutput() UserPoolClientTokenValidityUnitsPtrOutput

func (UserPoolClientTokenValidityUnitsArgs) ToUserPoolClientTokenValidityUnitsPtrOutputWithContext added in v3.33.0

func (i UserPoolClientTokenValidityUnitsArgs) ToUserPoolClientTokenValidityUnitsPtrOutputWithContext(ctx context.Context) UserPoolClientTokenValidityUnitsPtrOutput

type UserPoolClientTokenValidityUnitsInput added in v3.33.0

type UserPoolClientTokenValidityUnitsInput interface {
	pulumi.Input

	ToUserPoolClientTokenValidityUnitsOutput() UserPoolClientTokenValidityUnitsOutput
	ToUserPoolClientTokenValidityUnitsOutputWithContext(context.Context) UserPoolClientTokenValidityUnitsOutput
}

UserPoolClientTokenValidityUnitsInput is an input type that accepts UserPoolClientTokenValidityUnitsArgs and UserPoolClientTokenValidityUnitsOutput values. You can construct a concrete instance of `UserPoolClientTokenValidityUnitsInput` via:

UserPoolClientTokenValidityUnitsArgs{...}

type UserPoolClientTokenValidityUnitsOutput added in v3.33.0

type UserPoolClientTokenValidityUnitsOutput struct{ *pulumi.OutputState }

func (UserPoolClientTokenValidityUnitsOutput) AccessToken added in v3.33.0

Time unit in for the value in `accessTokenValidity`, defaults to `hours`.

func (UserPoolClientTokenValidityUnitsOutput) ElementType added in v3.33.0

func (UserPoolClientTokenValidityUnitsOutput) IdToken added in v3.33.0

Time unit in for the value in `idTokenValidity`, defaults to `hours`.

func (UserPoolClientTokenValidityUnitsOutput) RefreshToken added in v3.33.0

Time unit in for the value in `refreshTokenValidity`, defaults to `days`.

func (UserPoolClientTokenValidityUnitsOutput) ToUserPoolClientTokenValidityUnitsOutput added in v3.33.0

func (o UserPoolClientTokenValidityUnitsOutput) ToUserPoolClientTokenValidityUnitsOutput() UserPoolClientTokenValidityUnitsOutput

func (UserPoolClientTokenValidityUnitsOutput) ToUserPoolClientTokenValidityUnitsOutputWithContext added in v3.33.0

func (o UserPoolClientTokenValidityUnitsOutput) ToUserPoolClientTokenValidityUnitsOutputWithContext(ctx context.Context) UserPoolClientTokenValidityUnitsOutput

func (UserPoolClientTokenValidityUnitsOutput) ToUserPoolClientTokenValidityUnitsPtrOutput added in v3.33.0

func (o UserPoolClientTokenValidityUnitsOutput) ToUserPoolClientTokenValidityUnitsPtrOutput() UserPoolClientTokenValidityUnitsPtrOutput

func (UserPoolClientTokenValidityUnitsOutput) ToUserPoolClientTokenValidityUnitsPtrOutputWithContext added in v3.33.0

func (o UserPoolClientTokenValidityUnitsOutput) ToUserPoolClientTokenValidityUnitsPtrOutputWithContext(ctx context.Context) UserPoolClientTokenValidityUnitsPtrOutput

type UserPoolClientTokenValidityUnitsPtrInput added in v3.33.0

type UserPoolClientTokenValidityUnitsPtrInput interface {
	pulumi.Input

	ToUserPoolClientTokenValidityUnitsPtrOutput() UserPoolClientTokenValidityUnitsPtrOutput
	ToUserPoolClientTokenValidityUnitsPtrOutputWithContext(context.Context) UserPoolClientTokenValidityUnitsPtrOutput
}

UserPoolClientTokenValidityUnitsPtrInput is an input type that accepts UserPoolClientTokenValidityUnitsArgs, UserPoolClientTokenValidityUnitsPtr and UserPoolClientTokenValidityUnitsPtrOutput values. You can construct a concrete instance of `UserPoolClientTokenValidityUnitsPtrInput` via:

        UserPoolClientTokenValidityUnitsArgs{...}

or:

        nil

type UserPoolClientTokenValidityUnitsPtrOutput added in v3.33.0

type UserPoolClientTokenValidityUnitsPtrOutput struct{ *pulumi.OutputState }

func (UserPoolClientTokenValidityUnitsPtrOutput) AccessToken added in v3.33.0

Time unit in for the value in `accessTokenValidity`, defaults to `hours`.

func (UserPoolClientTokenValidityUnitsPtrOutput) Elem added in v3.33.0

func (UserPoolClientTokenValidityUnitsPtrOutput) ElementType added in v3.33.0

func (UserPoolClientTokenValidityUnitsPtrOutput) IdToken added in v3.33.0

Time unit in for the value in `idTokenValidity`, defaults to `hours`.

func (UserPoolClientTokenValidityUnitsPtrOutput) RefreshToken added in v3.33.0

Time unit in for the value in `refreshTokenValidity`, defaults to `days`.

func (UserPoolClientTokenValidityUnitsPtrOutput) ToUserPoolClientTokenValidityUnitsPtrOutput added in v3.33.0

func (o UserPoolClientTokenValidityUnitsPtrOutput) ToUserPoolClientTokenValidityUnitsPtrOutput() UserPoolClientTokenValidityUnitsPtrOutput

func (UserPoolClientTokenValidityUnitsPtrOutput) ToUserPoolClientTokenValidityUnitsPtrOutputWithContext added in v3.33.0

func (o UserPoolClientTokenValidityUnitsPtrOutput) ToUserPoolClientTokenValidityUnitsPtrOutputWithContext(ctx context.Context) UserPoolClientTokenValidityUnitsPtrOutput

type UserPoolDeviceConfiguration

type UserPoolDeviceConfiguration struct {
	// Whether a challenge is required on a new device. Only applicable to a new device.
	ChallengeRequiredOnNewDevice *bool `pulumi:"challengeRequiredOnNewDevice"`
	// Whether a device is only remembered on user prompt. `false` equates to "Always" remember, `true` is "User Opt In," and not using a `deviceConfiguration` block is "No."
	DeviceOnlyRememberedOnUserPrompt *bool `pulumi:"deviceOnlyRememberedOnUserPrompt"`
}

type UserPoolDeviceConfigurationArgs

type UserPoolDeviceConfigurationArgs struct {
	// Whether a challenge is required on a new device. Only applicable to a new device.
	ChallengeRequiredOnNewDevice pulumi.BoolPtrInput `pulumi:"challengeRequiredOnNewDevice"`
	// Whether a device is only remembered on user prompt. `false` equates to "Always" remember, `true` is "User Opt In," and not using a `deviceConfiguration` block is "No."
	DeviceOnlyRememberedOnUserPrompt pulumi.BoolPtrInput `pulumi:"deviceOnlyRememberedOnUserPrompt"`
}

func (UserPoolDeviceConfigurationArgs) ElementType

func (UserPoolDeviceConfigurationArgs) ToUserPoolDeviceConfigurationOutput

func (i UserPoolDeviceConfigurationArgs) ToUserPoolDeviceConfigurationOutput() UserPoolDeviceConfigurationOutput

func (UserPoolDeviceConfigurationArgs) ToUserPoolDeviceConfigurationOutputWithContext

func (i UserPoolDeviceConfigurationArgs) ToUserPoolDeviceConfigurationOutputWithContext(ctx context.Context) UserPoolDeviceConfigurationOutput

func (UserPoolDeviceConfigurationArgs) ToUserPoolDeviceConfigurationPtrOutput

func (i UserPoolDeviceConfigurationArgs) ToUserPoolDeviceConfigurationPtrOutput() UserPoolDeviceConfigurationPtrOutput

func (UserPoolDeviceConfigurationArgs) ToUserPoolDeviceConfigurationPtrOutputWithContext

func (i UserPoolDeviceConfigurationArgs) ToUserPoolDeviceConfigurationPtrOutputWithContext(ctx context.Context) UserPoolDeviceConfigurationPtrOutput

type UserPoolDeviceConfigurationInput

type UserPoolDeviceConfigurationInput interface {
	pulumi.Input

	ToUserPoolDeviceConfigurationOutput() UserPoolDeviceConfigurationOutput
	ToUserPoolDeviceConfigurationOutputWithContext(context.Context) UserPoolDeviceConfigurationOutput
}

UserPoolDeviceConfigurationInput is an input type that accepts UserPoolDeviceConfigurationArgs and UserPoolDeviceConfigurationOutput values. You can construct a concrete instance of `UserPoolDeviceConfigurationInput` via:

UserPoolDeviceConfigurationArgs{...}

type UserPoolDeviceConfigurationOutput

type UserPoolDeviceConfigurationOutput struct{ *pulumi.OutputState }

func (UserPoolDeviceConfigurationOutput) ChallengeRequiredOnNewDevice

func (o UserPoolDeviceConfigurationOutput) ChallengeRequiredOnNewDevice() pulumi.BoolPtrOutput

Whether a challenge is required on a new device. Only applicable to a new device.

func (UserPoolDeviceConfigurationOutput) DeviceOnlyRememberedOnUserPrompt

func (o UserPoolDeviceConfigurationOutput) DeviceOnlyRememberedOnUserPrompt() pulumi.BoolPtrOutput

Whether a device is only remembered on user prompt. `false` equates to "Always" remember, `true` is "User Opt In," and not using a `deviceConfiguration` block is "No."

func (UserPoolDeviceConfigurationOutput) ElementType

func (UserPoolDeviceConfigurationOutput) ToUserPoolDeviceConfigurationOutput

func (o UserPoolDeviceConfigurationOutput) ToUserPoolDeviceConfigurationOutput() UserPoolDeviceConfigurationOutput

func (UserPoolDeviceConfigurationOutput) ToUserPoolDeviceConfigurationOutputWithContext

func (o UserPoolDeviceConfigurationOutput) ToUserPoolDeviceConfigurationOutputWithContext(ctx context.Context) UserPoolDeviceConfigurationOutput

func (UserPoolDeviceConfigurationOutput) ToUserPoolDeviceConfigurationPtrOutput

func (o UserPoolDeviceConfigurationOutput) ToUserPoolDeviceConfigurationPtrOutput() UserPoolDeviceConfigurationPtrOutput

func (UserPoolDeviceConfigurationOutput) ToUserPoolDeviceConfigurationPtrOutputWithContext

func (o UserPoolDeviceConfigurationOutput) ToUserPoolDeviceConfigurationPtrOutputWithContext(ctx context.Context) UserPoolDeviceConfigurationPtrOutput

type UserPoolDeviceConfigurationPtrInput

type UserPoolDeviceConfigurationPtrInput interface {
	pulumi.Input

	ToUserPoolDeviceConfigurationPtrOutput() UserPoolDeviceConfigurationPtrOutput
	ToUserPoolDeviceConfigurationPtrOutputWithContext(context.Context) UserPoolDeviceConfigurationPtrOutput
}

UserPoolDeviceConfigurationPtrInput is an input type that accepts UserPoolDeviceConfigurationArgs, UserPoolDeviceConfigurationPtr and UserPoolDeviceConfigurationPtrOutput values. You can construct a concrete instance of `UserPoolDeviceConfigurationPtrInput` via:

        UserPoolDeviceConfigurationArgs{...}

or:

        nil

type UserPoolDeviceConfigurationPtrOutput

type UserPoolDeviceConfigurationPtrOutput struct{ *pulumi.OutputState }

func (UserPoolDeviceConfigurationPtrOutput) ChallengeRequiredOnNewDevice

func (o UserPoolDeviceConfigurationPtrOutput) ChallengeRequiredOnNewDevice() pulumi.BoolPtrOutput

Whether a challenge is required on a new device. Only applicable to a new device.

func (UserPoolDeviceConfigurationPtrOutput) DeviceOnlyRememberedOnUserPrompt

func (o UserPoolDeviceConfigurationPtrOutput) DeviceOnlyRememberedOnUserPrompt() pulumi.BoolPtrOutput

Whether a device is only remembered on user prompt. `false` equates to "Always" remember, `true` is "User Opt In," and not using a `deviceConfiguration` block is "No."

func (UserPoolDeviceConfigurationPtrOutput) Elem

func (UserPoolDeviceConfigurationPtrOutput) ElementType

func (UserPoolDeviceConfigurationPtrOutput) ToUserPoolDeviceConfigurationPtrOutput

func (o UserPoolDeviceConfigurationPtrOutput) ToUserPoolDeviceConfigurationPtrOutput() UserPoolDeviceConfigurationPtrOutput

func (UserPoolDeviceConfigurationPtrOutput) ToUserPoolDeviceConfigurationPtrOutputWithContext

func (o UserPoolDeviceConfigurationPtrOutput) ToUserPoolDeviceConfigurationPtrOutputWithContext(ctx context.Context) UserPoolDeviceConfigurationPtrOutput

type UserPoolDomain

type UserPoolDomain struct {
	pulumi.CustomResourceState

	// The AWS account ID for the user pool owner.
	AwsAccountId pulumi.StringOutput `pulumi:"awsAccountId"`
	// The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.
	CertificateArn pulumi.StringPtrOutput `pulumi:"certificateArn"`
	// The URL of the CloudFront distribution. This is required to generate the ALIAS `route53.Record`
	CloudfrontDistributionArn pulumi.StringOutput `pulumi:"cloudfrontDistributionArn"`
	// The domain string.
	Domain pulumi.StringOutput `pulumi:"domain"`
	// The S3 bucket where the static files for this domain are stored.
	S3Bucket pulumi.StringOutput `pulumi:"s3Bucket"`
	// The user pool ID.
	UserPoolId pulumi.StringOutput `pulumi:"userPoolId"`
	// The app version.
	Version pulumi.StringOutput `pulumi:"version"`
}

Provides a Cognito User Pool Domain resource.

## Example Usage ### Amazon Cognito domain

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/cognito"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := cognito.NewUserPool(ctx, "example", nil)
		if err != nil {
			return err
		}
		_, err = cognito.NewUserPoolDomain(ctx, "main", &cognito.UserPoolDomainArgs{
			Domain:     pulumi.String("example-domain"),
			UserPoolId: example.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Custom Cognito domain

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/cognito"
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/route53"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleUserPool, err := cognito.NewUserPool(ctx, "exampleUserPool", nil)
		if err != nil {
			return err
		}
		main, err := cognito.NewUserPoolDomain(ctx, "main", &cognito.UserPoolDomainArgs{
			Domain:         pulumi.String("example-domain.example.com"),
			CertificateArn: pulumi.Any(aws_acm_certificate.Cert.Arn),
			UserPoolId:     exampleUserPool.ID(),
		})
		if err != nil {
			return err
		}
		opt0 := "example.com"
		exampleZone, err := route53.LookupZone(ctx, &route53.LookupZoneArgs{
			Name: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		_, err = route53.NewRecord(ctx, "auth_cognito_A", &route53.RecordArgs{
			Name:   main.Domain,
			Type:   pulumi.String("A"),
			ZoneId: pulumi.String(exampleZone.ZoneId),
			Aliases: route53.RecordAliasArray{
				&route53.RecordAliasArgs{
					EvaluateTargetHealth: pulumi.Bool(false),
					Name:                 main.CloudfrontDistributionArn,
					ZoneId:               pulumi.String("Z2FDTNDATAQYW2"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Cognito User Pool Domains can be imported using the `domain`, e.g.

```sh

$ pulumi import aws:cognito/userPoolDomain:UserPoolDomain main <domain>

```

func GetUserPoolDomain

func GetUserPoolDomain(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *UserPoolDomainState, opts ...pulumi.ResourceOption) (*UserPoolDomain, error)

GetUserPoolDomain gets an existing UserPoolDomain resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewUserPoolDomain

func NewUserPoolDomain(ctx *pulumi.Context,
	name string, args *UserPoolDomainArgs, opts ...pulumi.ResourceOption) (*UserPoolDomain, error)

NewUserPoolDomain registers a new resource with the given unique name, arguments, and options.

func (*UserPoolDomain) ElementType added in v3.13.0

func (*UserPoolDomain) ElementType() reflect.Type

func (*UserPoolDomain) ToUserPoolDomainOutput added in v3.13.0

func (i *UserPoolDomain) ToUserPoolDomainOutput() UserPoolDomainOutput

func (*UserPoolDomain) ToUserPoolDomainOutputWithContext added in v3.13.0

func (i *UserPoolDomain) ToUserPoolDomainOutputWithContext(ctx context.Context) UserPoolDomainOutput

func (*UserPoolDomain) ToUserPoolDomainPtrOutput added in v3.25.0

func (i *UserPoolDomain) ToUserPoolDomainPtrOutput() UserPoolDomainPtrOutput

func (*UserPoolDomain) ToUserPoolDomainPtrOutputWithContext added in v3.25.0

func (i *UserPoolDomain) ToUserPoolDomainPtrOutputWithContext(ctx context.Context) UserPoolDomainPtrOutput

type UserPoolDomainArgs

type UserPoolDomainArgs struct {
	// The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.
	CertificateArn pulumi.StringPtrInput
	// The domain string.
	Domain pulumi.StringInput
	// The user pool ID.
	UserPoolId pulumi.StringInput
}

The set of arguments for constructing a UserPoolDomain resource.

func (UserPoolDomainArgs) ElementType

func (UserPoolDomainArgs) ElementType() reflect.Type

type UserPoolDomainArray added in v3.25.0

type UserPoolDomainArray []UserPoolDomainInput

func (UserPoolDomainArray) ElementType added in v3.25.0

func (UserPoolDomainArray) ElementType() reflect.Type

func (UserPoolDomainArray) ToUserPoolDomainArrayOutput added in v3.25.0

func (i UserPoolDomainArray) ToUserPoolDomainArrayOutput() UserPoolDomainArrayOutput

func (UserPoolDomainArray) ToUserPoolDomainArrayOutputWithContext added in v3.25.0

func (i UserPoolDomainArray) ToUserPoolDomainArrayOutputWithContext(ctx context.Context) UserPoolDomainArrayOutput

type UserPoolDomainArrayInput added in v3.25.0

type UserPoolDomainArrayInput interface {
	pulumi.Input

	ToUserPoolDomainArrayOutput() UserPoolDomainArrayOutput
	ToUserPoolDomainArrayOutputWithContext(context.Context) UserPoolDomainArrayOutput
}

UserPoolDomainArrayInput is an input type that accepts UserPoolDomainArray and UserPoolDomainArrayOutput values. You can construct a concrete instance of `UserPoolDomainArrayInput` via:

UserPoolDomainArray{ UserPoolDomainArgs{...} }

type UserPoolDomainArrayOutput added in v3.25.0

type UserPoolDomainArrayOutput struct{ *pulumi.OutputState }

func (UserPoolDomainArrayOutput) ElementType added in v3.25.0

func (UserPoolDomainArrayOutput) ElementType() reflect.Type

func (UserPoolDomainArrayOutput) Index added in v3.25.0

func (UserPoolDomainArrayOutput) ToUserPoolDomainArrayOutput added in v3.25.0

func (o UserPoolDomainArrayOutput) ToUserPoolDomainArrayOutput() UserPoolDomainArrayOutput

func (UserPoolDomainArrayOutput) ToUserPoolDomainArrayOutputWithContext added in v3.25.0

func (o UserPoolDomainArrayOutput) ToUserPoolDomainArrayOutputWithContext(ctx context.Context) UserPoolDomainArrayOutput

type UserPoolDomainInput added in v3.13.0

type UserPoolDomainInput interface {
	pulumi.Input

	ToUserPoolDomainOutput() UserPoolDomainOutput
	ToUserPoolDomainOutputWithContext(ctx context.Context) UserPoolDomainOutput
}

type UserPoolDomainMap added in v3.25.0

type UserPoolDomainMap map[string]UserPoolDomainInput

func (UserPoolDomainMap) ElementType added in v3.25.0

func (UserPoolDomainMap) ElementType() reflect.Type

func (UserPoolDomainMap) ToUserPoolDomainMapOutput added in v3.25.0

func (i UserPoolDomainMap) ToUserPoolDomainMapOutput() UserPoolDomainMapOutput

func (UserPoolDomainMap) ToUserPoolDomainMapOutputWithContext added in v3.25.0

func (i UserPoolDomainMap) ToUserPoolDomainMapOutputWithContext(ctx context.Context) UserPoolDomainMapOutput

type UserPoolDomainMapInput added in v3.25.0

type UserPoolDomainMapInput interface {
	pulumi.Input

	ToUserPoolDomainMapOutput() UserPoolDomainMapOutput
	ToUserPoolDomainMapOutputWithContext(context.Context) UserPoolDomainMapOutput
}

UserPoolDomainMapInput is an input type that accepts UserPoolDomainMap and UserPoolDomainMapOutput values. You can construct a concrete instance of `UserPoolDomainMapInput` via:

UserPoolDomainMap{ "key": UserPoolDomainArgs{...} }

type UserPoolDomainMapOutput added in v3.25.0

type UserPoolDomainMapOutput struct{ *pulumi.OutputState }

func (UserPoolDomainMapOutput) ElementType added in v3.25.0

func (UserPoolDomainMapOutput) ElementType() reflect.Type

func (UserPoolDomainMapOutput) MapIndex added in v3.25.0

func (UserPoolDomainMapOutput) ToUserPoolDomainMapOutput added in v3.25.0

func (o UserPoolDomainMapOutput) ToUserPoolDomainMapOutput() UserPoolDomainMapOutput

func (UserPoolDomainMapOutput) ToUserPoolDomainMapOutputWithContext added in v3.25.0

func (o UserPoolDomainMapOutput) ToUserPoolDomainMapOutputWithContext(ctx context.Context) UserPoolDomainMapOutput

type UserPoolDomainOutput added in v3.13.0

type UserPoolDomainOutput struct {
	*pulumi.OutputState
}

func (UserPoolDomainOutput) ElementType added in v3.13.0

func (UserPoolDomainOutput) ElementType() reflect.Type

func (UserPoolDomainOutput) ToUserPoolDomainOutput added in v3.13.0

func (o UserPoolDomainOutput) ToUserPoolDomainOutput() UserPoolDomainOutput

func (UserPoolDomainOutput) ToUserPoolDomainOutputWithContext added in v3.13.0

func (o UserPoolDomainOutput) ToUserPoolDomainOutputWithContext(ctx context.Context) UserPoolDomainOutput

func (UserPoolDomainOutput) ToUserPoolDomainPtrOutput added in v3.25.0

func (o UserPoolDomainOutput) ToUserPoolDomainPtrOutput() UserPoolDomainPtrOutput

func (UserPoolDomainOutput) ToUserPoolDomainPtrOutputWithContext added in v3.25.0

func (o UserPoolDomainOutput) ToUserPoolDomainPtrOutputWithContext(ctx context.Context) UserPoolDomainPtrOutput

type UserPoolDomainPtrInput added in v3.25.0

type UserPoolDomainPtrInput interface {
	pulumi.Input

	ToUserPoolDomainPtrOutput() UserPoolDomainPtrOutput
	ToUserPoolDomainPtrOutputWithContext(ctx context.Context) UserPoolDomainPtrOutput
}

type UserPoolDomainPtrOutput added in v3.25.0

type UserPoolDomainPtrOutput struct {
	*pulumi.OutputState
}

func (UserPoolDomainPtrOutput) ElementType added in v3.25.0

func (UserPoolDomainPtrOutput) ElementType() reflect.Type

func (UserPoolDomainPtrOutput) ToUserPoolDomainPtrOutput added in v3.25.0

func (o UserPoolDomainPtrOutput) ToUserPoolDomainPtrOutput() UserPoolDomainPtrOutput

func (UserPoolDomainPtrOutput) ToUserPoolDomainPtrOutputWithContext added in v3.25.0

func (o UserPoolDomainPtrOutput) ToUserPoolDomainPtrOutputWithContext(ctx context.Context) UserPoolDomainPtrOutput

type UserPoolDomainState

type UserPoolDomainState struct {
	// The AWS account ID for the user pool owner.
	AwsAccountId pulumi.StringPtrInput
	// The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.
	CertificateArn pulumi.StringPtrInput
	// The URL of the CloudFront distribution. This is required to generate the ALIAS `route53.Record`
	CloudfrontDistributionArn pulumi.StringPtrInput
	// The domain string.
	Domain pulumi.StringPtrInput
	// The S3 bucket where the static files for this domain are stored.
	S3Bucket pulumi.StringPtrInput
	// The user pool ID.
	UserPoolId pulumi.StringPtrInput
	// The app version.
	Version pulumi.StringPtrInput
}

func (UserPoolDomainState) ElementType

func (UserPoolDomainState) ElementType() reflect.Type

type UserPoolEmailConfiguration

type UserPoolEmailConfiguration struct {
	// Email configuration set name from SES.
	ConfigurationSet *string `pulumi:"configurationSet"`
	// Email delivery method to use. `COGNITO_DEFAULT` for the default email functionality built into Cognito or `DEVELOPER` to use your Amazon SES configuration.
	EmailSendingAccount *string `pulumi:"emailSendingAccount"`
	// Sender’s email address or sender’s display name with their email address (e.g. `john@example.com`, `John Smith <john@example.com>` or `\"John Smith Ph.D.\" <john@example.com>`). Escaped double quotes are required around display names that contain certain characters as specified in [RFC 5322](https://tools.ietf.org/html/rfc5322).
	FromEmailAddress *string `pulumi:"fromEmailAddress"`
	// REPLY-TO email address.
	ReplyToEmailAddress *string `pulumi:"replyToEmailAddress"`
	// ARN of the SES verified email identity to to use. Required if `emailSendingAccount` is set to `DEVELOPER`.
	SourceArn *string `pulumi:"sourceArn"`
}

type UserPoolEmailConfigurationArgs

type UserPoolEmailConfigurationArgs struct {
	// Email configuration set name from SES.
	ConfigurationSet pulumi.StringPtrInput `pulumi:"configurationSet"`
	// Email delivery method to use. `COGNITO_DEFAULT` for the default email functionality built into Cognito or `DEVELOPER` to use your Amazon SES configuration.
	EmailSendingAccount pulumi.StringPtrInput `pulumi:"emailSendingAccount"`
	// Sender’s email address or sender’s display name with their email address (e.g. `john@example.com`, `John Smith <john@example.com>` or `\"John Smith Ph.D.\" <john@example.com>`). Escaped double quotes are required around display names that contain certain characters as specified in [RFC 5322](https://tools.ietf.org/html/rfc5322).
	FromEmailAddress pulumi.StringPtrInput `pulumi:"fromEmailAddress"`
	// REPLY-TO email address.
	ReplyToEmailAddress pulumi.StringPtrInput `pulumi:"replyToEmailAddress"`
	// ARN of the SES verified email identity to to use. Required if `emailSendingAccount` is set to `DEVELOPER`.
	SourceArn pulumi.StringPtrInput `pulumi:"sourceArn"`
}

func (UserPoolEmailConfigurationArgs) ElementType

func (UserPoolEmailConfigurationArgs) ToUserPoolEmailConfigurationOutput

func (i UserPoolEmailConfigurationArgs) ToUserPoolEmailConfigurationOutput() UserPoolEmailConfigurationOutput

func (UserPoolEmailConfigurationArgs) ToUserPoolEmailConfigurationOutputWithContext

func (i UserPoolEmailConfigurationArgs) ToUserPoolEmailConfigurationOutputWithContext(ctx context.Context) UserPoolEmailConfigurationOutput

func (UserPoolEmailConfigurationArgs) ToUserPoolEmailConfigurationPtrOutput

func (i UserPoolEmailConfigurationArgs) ToUserPoolEmailConfigurationPtrOutput() UserPoolEmailConfigurationPtrOutput

func (UserPoolEmailConfigurationArgs) ToUserPoolEmailConfigurationPtrOutputWithContext

func (i UserPoolEmailConfigurationArgs) ToUserPoolEmailConfigurationPtrOutputWithContext(ctx context.Context) UserPoolEmailConfigurationPtrOutput

type UserPoolEmailConfigurationInput

type UserPoolEmailConfigurationInput interface {
	pulumi.Input

	ToUserPoolEmailConfigurationOutput() UserPoolEmailConfigurationOutput
	ToUserPoolEmailConfigurationOutputWithContext(context.Context) UserPoolEmailConfigurationOutput
}

UserPoolEmailConfigurationInput is an input type that accepts UserPoolEmailConfigurationArgs and UserPoolEmailConfigurationOutput values. You can construct a concrete instance of `UserPoolEmailConfigurationInput` via:

UserPoolEmailConfigurationArgs{...}

type UserPoolEmailConfigurationOutput

type UserPoolEmailConfigurationOutput struct{ *pulumi.OutputState }

func (UserPoolEmailConfigurationOutput) ConfigurationSet added in v3.33.0

Email configuration set name from SES.

func (UserPoolEmailConfigurationOutput) ElementType

func (UserPoolEmailConfigurationOutput) EmailSendingAccount

Email delivery method to use. `COGNITO_DEFAULT` for the default email functionality built into Cognito or `DEVELOPER` to use your Amazon SES configuration.

func (UserPoolEmailConfigurationOutput) FromEmailAddress

Sender’s email address or sender’s display name with their email address (e.g. `john@example.com`, `John Smith <john@example.com>` or `\"John Smith Ph.D.\" <john@example.com>`). Escaped double quotes are required around display names that contain certain characters as specified in [RFC 5322](https://tools.ietf.org/html/rfc5322).

func (UserPoolEmailConfigurationOutput) ReplyToEmailAddress

REPLY-TO email address.

func (UserPoolEmailConfigurationOutput) SourceArn

ARN of the SES verified email identity to to use. Required if `emailSendingAccount` is set to `DEVELOPER`.

func (UserPoolEmailConfigurationOutput) ToUserPoolEmailConfigurationOutput

func (o UserPoolEmailConfigurationOutput) ToUserPoolEmailConfigurationOutput() UserPoolEmailConfigurationOutput

func (UserPoolEmailConfigurationOutput) ToUserPoolEmailConfigurationOutputWithContext

func (o UserPoolEmailConfigurationOutput) ToUserPoolEmailConfigurationOutputWithContext(ctx context.Context) UserPoolEmailConfigurationOutput

func (UserPoolEmailConfigurationOutput) ToUserPoolEmailConfigurationPtrOutput

func (o UserPoolEmailConfigurationOutput) ToUserPoolEmailConfigurationPtrOutput() UserPoolEmailConfigurationPtrOutput

func (UserPoolEmailConfigurationOutput) ToUserPoolEmailConfigurationPtrOutputWithContext

func (o UserPoolEmailConfigurationOutput) ToUserPoolEmailConfigurationPtrOutputWithContext(ctx context.Context) UserPoolEmailConfigurationPtrOutput

type UserPoolEmailConfigurationPtrInput

type UserPoolEmailConfigurationPtrInput interface {
	pulumi.Input

	ToUserPoolEmailConfigurationPtrOutput() UserPoolEmailConfigurationPtrOutput
	ToUserPoolEmailConfigurationPtrOutputWithContext(context.Context) UserPoolEmailConfigurationPtrOutput
}

UserPoolEmailConfigurationPtrInput is an input type that accepts UserPoolEmailConfigurationArgs, UserPoolEmailConfigurationPtr and UserPoolEmailConfigurationPtrOutput values. You can construct a concrete instance of `UserPoolEmailConfigurationPtrInput` via:

        UserPoolEmailConfigurationArgs{...}

or:

        nil

type UserPoolEmailConfigurationPtrOutput

type UserPoolEmailConfigurationPtrOutput struct{ *pulumi.OutputState }

func (UserPoolEmailConfigurationPtrOutput) ConfigurationSet added in v3.33.0

Email configuration set name from SES.

func (UserPoolEmailConfigurationPtrOutput) Elem

func (UserPoolEmailConfigurationPtrOutput) ElementType

func (UserPoolEmailConfigurationPtrOutput) EmailSendingAccount

Email delivery method to use. `COGNITO_DEFAULT` for the default email functionality built into Cognito or `DEVELOPER` to use your Amazon SES configuration.

func (UserPoolEmailConfigurationPtrOutput) FromEmailAddress

Sender’s email address or sender’s display name with their email address (e.g. `john@example.com`, `John Smith <john@example.com>` or `\"John Smith Ph.D.\" <john@example.com>`). Escaped double quotes are required around display names that contain certain characters as specified in [RFC 5322](https://tools.ietf.org/html/rfc5322).

func (UserPoolEmailConfigurationPtrOutput) ReplyToEmailAddress

REPLY-TO email address.

func (UserPoolEmailConfigurationPtrOutput) SourceArn

ARN of the SES verified email identity to to use. Required if `emailSendingAccount` is set to `DEVELOPER`.

func (UserPoolEmailConfigurationPtrOutput) ToUserPoolEmailConfigurationPtrOutput

func (o UserPoolEmailConfigurationPtrOutput) ToUserPoolEmailConfigurationPtrOutput() UserPoolEmailConfigurationPtrOutput

func (UserPoolEmailConfigurationPtrOutput) ToUserPoolEmailConfigurationPtrOutputWithContext

func (o UserPoolEmailConfigurationPtrOutput) ToUserPoolEmailConfigurationPtrOutputWithContext(ctx context.Context) UserPoolEmailConfigurationPtrOutput

type UserPoolInput added in v3.13.0

type UserPoolInput interface {
	pulumi.Input

	ToUserPoolOutput() UserPoolOutput
	ToUserPoolOutputWithContext(ctx context.Context) UserPoolOutput
}

type UserPoolLambdaConfig

type UserPoolLambdaConfig struct {
	// ARN of the lambda creating an authentication challenge.
	CreateAuthChallenge *string `pulumi:"createAuthChallenge"`
	// Custom Message AWS Lambda trigger.
	CustomMessage *string `pulumi:"customMessage"`
	// Defines the authentication challenge.
	DefineAuthChallenge *string `pulumi:"defineAuthChallenge"`
	// Post-authentication AWS Lambda trigger.
	PostAuthentication *string `pulumi:"postAuthentication"`
	// Post-confirmation AWS Lambda trigger.
	PostConfirmation *string `pulumi:"postConfirmation"`
	// Pre-authentication AWS Lambda trigger.
	PreAuthentication *string `pulumi:"preAuthentication"`
	// Pre-registration AWS Lambda trigger.
	PreSignUp *string `pulumi:"preSignUp"`
	// Allow to customize identity token claims before token generation.
	PreTokenGeneration *string `pulumi:"preTokenGeneration"`
	// User migration Lambda config type.
	UserMigration *string `pulumi:"userMigration"`
	// Verifies the authentication challenge response.
	VerifyAuthChallengeResponse *string `pulumi:"verifyAuthChallengeResponse"`
}

type UserPoolLambdaConfigArgs

type UserPoolLambdaConfigArgs struct {
	// ARN of the lambda creating an authentication challenge.
	CreateAuthChallenge pulumi.StringPtrInput `pulumi:"createAuthChallenge"`
	// Custom Message AWS Lambda trigger.
	CustomMessage pulumi.StringPtrInput `pulumi:"customMessage"`
	// Defines the authentication challenge.
	DefineAuthChallenge pulumi.StringPtrInput `pulumi:"defineAuthChallenge"`
	// Post-authentication AWS Lambda trigger.
	PostAuthentication pulumi.StringPtrInput `pulumi:"postAuthentication"`
	// Post-confirmation AWS Lambda trigger.
	PostConfirmation pulumi.StringPtrInput `pulumi:"postConfirmation"`
	// Pre-authentication AWS Lambda trigger.
	PreAuthentication pulumi.StringPtrInput `pulumi:"preAuthentication"`
	// Pre-registration AWS Lambda trigger.
	PreSignUp pulumi.StringPtrInput `pulumi:"preSignUp"`
	// Allow to customize identity token claims before token generation.
	PreTokenGeneration pulumi.StringPtrInput `pulumi:"preTokenGeneration"`
	// User migration Lambda config type.
	UserMigration pulumi.StringPtrInput `pulumi:"userMigration"`
	// Verifies the authentication challenge response.
	VerifyAuthChallengeResponse pulumi.StringPtrInput `pulumi:"verifyAuthChallengeResponse"`
}

func (UserPoolLambdaConfigArgs) ElementType

func (UserPoolLambdaConfigArgs) ElementType() reflect.Type

func (UserPoolLambdaConfigArgs) ToUserPoolLambdaConfigOutput

func (i UserPoolLambdaConfigArgs) ToUserPoolLambdaConfigOutput() UserPoolLambdaConfigOutput

func (UserPoolLambdaConfigArgs) ToUserPoolLambdaConfigOutputWithContext

func (i UserPoolLambdaConfigArgs) ToUserPoolLambdaConfigOutputWithContext(ctx context.Context) UserPoolLambdaConfigOutput

func (UserPoolLambdaConfigArgs) ToUserPoolLambdaConfigPtrOutput

func (i UserPoolLambdaConfigArgs) ToUserPoolLambdaConfigPtrOutput() UserPoolLambdaConfigPtrOutput

func (UserPoolLambdaConfigArgs) ToUserPoolLambdaConfigPtrOutputWithContext

func (i UserPoolLambdaConfigArgs) ToUserPoolLambdaConfigPtrOutputWithContext(ctx context.Context) UserPoolLambdaConfigPtrOutput

type UserPoolLambdaConfigInput

type UserPoolLambdaConfigInput interface {
	pulumi.Input

	ToUserPoolLambdaConfigOutput() UserPoolLambdaConfigOutput
	ToUserPoolLambdaConfigOutputWithContext(context.Context) UserPoolLambdaConfigOutput
}

UserPoolLambdaConfigInput is an input type that accepts UserPoolLambdaConfigArgs and UserPoolLambdaConfigOutput values. You can construct a concrete instance of `UserPoolLambdaConfigInput` via:

UserPoolLambdaConfigArgs{...}

type UserPoolLambdaConfigOutput

type UserPoolLambdaConfigOutput struct{ *pulumi.OutputState }

func (UserPoolLambdaConfigOutput) CreateAuthChallenge

func (o UserPoolLambdaConfigOutput) CreateAuthChallenge() pulumi.StringPtrOutput

ARN of the lambda creating an authentication challenge.

func (UserPoolLambdaConfigOutput) CustomMessage

Custom Message AWS Lambda trigger.

func (UserPoolLambdaConfigOutput) DefineAuthChallenge

func (o UserPoolLambdaConfigOutput) DefineAuthChallenge() pulumi.StringPtrOutput

Defines the authentication challenge.

func (UserPoolLambdaConfigOutput) ElementType

func (UserPoolLambdaConfigOutput) ElementType() reflect.Type

func (UserPoolLambdaConfigOutput) PostAuthentication

func (o UserPoolLambdaConfigOutput) PostAuthentication() pulumi.StringPtrOutput

Post-authentication AWS Lambda trigger.

func (UserPoolLambdaConfigOutput) PostConfirmation

func (o UserPoolLambdaConfigOutput) PostConfirmation() pulumi.StringPtrOutput

Post-confirmation AWS Lambda trigger.

func (UserPoolLambdaConfigOutput) PreAuthentication

func (o UserPoolLambdaConfigOutput) PreAuthentication() pulumi.StringPtrOutput

Pre-authentication AWS Lambda trigger.

func (UserPoolLambdaConfigOutput) PreSignUp

Pre-registration AWS Lambda trigger.

func (UserPoolLambdaConfigOutput) PreTokenGeneration

func (o UserPoolLambdaConfigOutput) PreTokenGeneration() pulumi.StringPtrOutput

Allow to customize identity token claims before token generation.

func (UserPoolLambdaConfigOutput) ToUserPoolLambdaConfigOutput

func (o UserPoolLambdaConfigOutput) ToUserPoolLambdaConfigOutput() UserPoolLambdaConfigOutput

func (UserPoolLambdaConfigOutput) ToUserPoolLambdaConfigOutputWithContext

func (o UserPoolLambdaConfigOutput) ToUserPoolLambdaConfigOutputWithContext(ctx context.Context) UserPoolLambdaConfigOutput

func (UserPoolLambdaConfigOutput) ToUserPoolLambdaConfigPtrOutput

func (o UserPoolLambdaConfigOutput) ToUserPoolLambdaConfigPtrOutput() UserPoolLambdaConfigPtrOutput

func (UserPoolLambdaConfigOutput) ToUserPoolLambdaConfigPtrOutputWithContext

func (o UserPoolLambdaConfigOutput) ToUserPoolLambdaConfigPtrOutputWithContext(ctx context.Context) UserPoolLambdaConfigPtrOutput

func (UserPoolLambdaConfigOutput) UserMigration

User migration Lambda config type.

func (UserPoolLambdaConfigOutput) VerifyAuthChallengeResponse

func (o UserPoolLambdaConfigOutput) VerifyAuthChallengeResponse() pulumi.StringPtrOutput

Verifies the authentication challenge response.

type UserPoolLambdaConfigPtrInput

type UserPoolLambdaConfigPtrInput interface {
	pulumi.Input

	ToUserPoolLambdaConfigPtrOutput() UserPoolLambdaConfigPtrOutput
	ToUserPoolLambdaConfigPtrOutputWithContext(context.Context) UserPoolLambdaConfigPtrOutput
}

UserPoolLambdaConfigPtrInput is an input type that accepts UserPoolLambdaConfigArgs, UserPoolLambdaConfigPtr and UserPoolLambdaConfigPtrOutput values. You can construct a concrete instance of `UserPoolLambdaConfigPtrInput` via:

        UserPoolLambdaConfigArgs{...}

or:

        nil

type UserPoolLambdaConfigPtrOutput

type UserPoolLambdaConfigPtrOutput struct{ *pulumi.OutputState }

func (UserPoolLambdaConfigPtrOutput) CreateAuthChallenge

func (o UserPoolLambdaConfigPtrOutput) CreateAuthChallenge() pulumi.StringPtrOutput

ARN of the lambda creating an authentication challenge.

func (UserPoolLambdaConfigPtrOutput) CustomMessage

Custom Message AWS Lambda trigger.

func (UserPoolLambdaConfigPtrOutput) DefineAuthChallenge

func (o UserPoolLambdaConfigPtrOutput) DefineAuthChallenge() pulumi.StringPtrOutput

Defines the authentication challenge.

func (UserPoolLambdaConfigPtrOutput) Elem

func (UserPoolLambdaConfigPtrOutput) ElementType

func (UserPoolLambdaConfigPtrOutput) PostAuthentication

func (o UserPoolLambdaConfigPtrOutput) PostAuthentication() pulumi.StringPtrOutput

Post-authentication AWS Lambda trigger.

func (UserPoolLambdaConfigPtrOutput) PostConfirmation

Post-confirmation AWS Lambda trigger.

func (UserPoolLambdaConfigPtrOutput) PreAuthentication

Pre-authentication AWS Lambda trigger.

func (UserPoolLambdaConfigPtrOutput) PreSignUp

Pre-registration AWS Lambda trigger.

func (UserPoolLambdaConfigPtrOutput) PreTokenGeneration

func (o UserPoolLambdaConfigPtrOutput) PreTokenGeneration() pulumi.StringPtrOutput

Allow to customize identity token claims before token generation.

func (UserPoolLambdaConfigPtrOutput) ToUserPoolLambdaConfigPtrOutput

func (o UserPoolLambdaConfigPtrOutput) ToUserPoolLambdaConfigPtrOutput() UserPoolLambdaConfigPtrOutput

func (UserPoolLambdaConfigPtrOutput) ToUserPoolLambdaConfigPtrOutputWithContext

func (o UserPoolLambdaConfigPtrOutput) ToUserPoolLambdaConfigPtrOutputWithContext(ctx context.Context) UserPoolLambdaConfigPtrOutput

func (UserPoolLambdaConfigPtrOutput) UserMigration

User migration Lambda config type.

func (UserPoolLambdaConfigPtrOutput) VerifyAuthChallengeResponse

func (o UserPoolLambdaConfigPtrOutput) VerifyAuthChallengeResponse() pulumi.StringPtrOutput

Verifies the authentication challenge response.

type UserPoolMap added in v3.25.0

type UserPoolMap map[string]UserPoolInput

func (UserPoolMap) ElementType added in v3.25.0

func (UserPoolMap) ElementType() reflect.Type

func (UserPoolMap) ToUserPoolMapOutput added in v3.25.0

func (i UserPoolMap) ToUserPoolMapOutput() UserPoolMapOutput

func (UserPoolMap) ToUserPoolMapOutputWithContext added in v3.25.0

func (i UserPoolMap) ToUserPoolMapOutputWithContext(ctx context.Context) UserPoolMapOutput

type UserPoolMapInput added in v3.25.0

type UserPoolMapInput interface {
	pulumi.Input

	ToUserPoolMapOutput() UserPoolMapOutput
	ToUserPoolMapOutputWithContext(context.Context) UserPoolMapOutput
}

UserPoolMapInput is an input type that accepts UserPoolMap and UserPoolMapOutput values. You can construct a concrete instance of `UserPoolMapInput` via:

UserPoolMap{ "key": UserPoolArgs{...} }

type UserPoolMapOutput added in v3.25.0

type UserPoolMapOutput struct{ *pulumi.OutputState }

func (UserPoolMapOutput) ElementType added in v3.25.0

func (UserPoolMapOutput) ElementType() reflect.Type

func (UserPoolMapOutput) MapIndex added in v3.25.0

func (UserPoolMapOutput) ToUserPoolMapOutput added in v3.25.0

func (o UserPoolMapOutput) ToUserPoolMapOutput() UserPoolMapOutput

func (UserPoolMapOutput) ToUserPoolMapOutputWithContext added in v3.25.0

func (o UserPoolMapOutput) ToUserPoolMapOutputWithContext(ctx context.Context) UserPoolMapOutput

type UserPoolOutput added in v3.13.0

type UserPoolOutput struct {
	*pulumi.OutputState
}

func (UserPoolOutput) ElementType added in v3.13.0

func (UserPoolOutput) ElementType() reflect.Type

func (UserPoolOutput) ToUserPoolOutput added in v3.13.0

func (o UserPoolOutput) ToUserPoolOutput() UserPoolOutput

func (UserPoolOutput) ToUserPoolOutputWithContext added in v3.13.0

func (o UserPoolOutput) ToUserPoolOutputWithContext(ctx context.Context) UserPoolOutput

func (UserPoolOutput) ToUserPoolPtrOutput added in v3.25.0

func (o UserPoolOutput) ToUserPoolPtrOutput() UserPoolPtrOutput

func (UserPoolOutput) ToUserPoolPtrOutputWithContext added in v3.25.0

func (o UserPoolOutput) ToUserPoolPtrOutputWithContext(ctx context.Context) UserPoolPtrOutput

type UserPoolPasswordPolicy

type UserPoolPasswordPolicy struct {
	// Minimum length of the password policy that you have set.
	MinimumLength *int `pulumi:"minimumLength"`
	// Whether you have required users to use at least one lowercase letter in their password.
	RequireLowercase *bool `pulumi:"requireLowercase"`
	// Whether you have required users to use at least one number in their password.
	RequireNumbers *bool `pulumi:"requireNumbers"`
	// Whether you have required users to use at least one symbol in their password.
	RequireSymbols *bool `pulumi:"requireSymbols"`
	// Whether you have required users to use at least one uppercase letter in their password.
	RequireUppercase *bool `pulumi:"requireUppercase"`
	// In the password policy you have set, refers to the number of days a temporary password is valid. If the user does not sign-in during this time, their password will need to be reset by an administrator.
	TemporaryPasswordValidityDays *int `pulumi:"temporaryPasswordValidityDays"`
}

type UserPoolPasswordPolicyArgs

type UserPoolPasswordPolicyArgs struct {
	// Minimum length of the password policy that you have set.
	MinimumLength pulumi.IntPtrInput `pulumi:"minimumLength"`
	// Whether you have required users to use at least one lowercase letter in their password.
	RequireLowercase pulumi.BoolPtrInput `pulumi:"requireLowercase"`
	// Whether you have required users to use at least one number in their password.
	RequireNumbers pulumi.BoolPtrInput `pulumi:"requireNumbers"`
	// Whether you have required users to use at least one symbol in their password.
	RequireSymbols pulumi.BoolPtrInput `pulumi:"requireSymbols"`
	// Whether you have required users to use at least one uppercase letter in their password.
	RequireUppercase pulumi.BoolPtrInput `pulumi:"requireUppercase"`
	// In the password policy you have set, refers to the number of days a temporary password is valid. If the user does not sign-in during this time, their password will need to be reset by an administrator.
	TemporaryPasswordValidityDays pulumi.IntPtrInput `pulumi:"temporaryPasswordValidityDays"`
}

func (UserPoolPasswordPolicyArgs) ElementType

func (UserPoolPasswordPolicyArgs) ElementType() reflect.Type

func (UserPoolPasswordPolicyArgs) ToUserPoolPasswordPolicyOutput

func (i UserPoolPasswordPolicyArgs) ToUserPoolPasswordPolicyOutput() UserPoolPasswordPolicyOutput

func (UserPoolPasswordPolicyArgs) ToUserPoolPasswordPolicyOutputWithContext

func (i UserPoolPasswordPolicyArgs) ToUserPoolPasswordPolicyOutputWithContext(ctx context.Context) UserPoolPasswordPolicyOutput

func (UserPoolPasswordPolicyArgs) ToUserPoolPasswordPolicyPtrOutput

func (i UserPoolPasswordPolicyArgs) ToUserPoolPasswordPolicyPtrOutput() UserPoolPasswordPolicyPtrOutput

func (UserPoolPasswordPolicyArgs) ToUserPoolPasswordPolicyPtrOutputWithContext

func (i UserPoolPasswordPolicyArgs) ToUserPoolPasswordPolicyPtrOutputWithContext(ctx context.Context) UserPoolPasswordPolicyPtrOutput

type UserPoolPasswordPolicyInput

type UserPoolPasswordPolicyInput interface {
	pulumi.Input

	ToUserPoolPasswordPolicyOutput() UserPoolPasswordPolicyOutput
	ToUserPoolPasswordPolicyOutputWithContext(context.Context) UserPoolPasswordPolicyOutput
}

UserPoolPasswordPolicyInput is an input type that accepts UserPoolPasswordPolicyArgs and UserPoolPasswordPolicyOutput values. You can construct a concrete instance of `UserPoolPasswordPolicyInput` via:

UserPoolPasswordPolicyArgs{...}

type UserPoolPasswordPolicyOutput

type UserPoolPasswordPolicyOutput struct{ *pulumi.OutputState }

func (UserPoolPasswordPolicyOutput) ElementType

func (UserPoolPasswordPolicyOutput) MinimumLength

Minimum length of the password policy that you have set.

func (UserPoolPasswordPolicyOutput) RequireLowercase

func (o UserPoolPasswordPolicyOutput) RequireLowercase() pulumi.BoolPtrOutput

Whether you have required users to use at least one lowercase letter in their password.

func (UserPoolPasswordPolicyOutput) RequireNumbers

Whether you have required users to use at least one number in their password.

func (UserPoolPasswordPolicyOutput) RequireSymbols

Whether you have required users to use at least one symbol in their password.

func (UserPoolPasswordPolicyOutput) RequireUppercase

func (o UserPoolPasswordPolicyOutput) RequireUppercase() pulumi.BoolPtrOutput

Whether you have required users to use at least one uppercase letter in their password.

func (UserPoolPasswordPolicyOutput) TemporaryPasswordValidityDays

func (o UserPoolPasswordPolicyOutput) TemporaryPasswordValidityDays() pulumi.IntPtrOutput

In the password policy you have set, refers to the number of days a temporary password is valid. If the user does not sign-in during this time, their password will need to be reset by an administrator.

func (UserPoolPasswordPolicyOutput) ToUserPoolPasswordPolicyOutput

func (o UserPoolPasswordPolicyOutput) ToUserPoolPasswordPolicyOutput() UserPoolPasswordPolicyOutput

func (UserPoolPasswordPolicyOutput) ToUserPoolPasswordPolicyOutputWithContext

func (o UserPoolPasswordPolicyOutput) ToUserPoolPasswordPolicyOutputWithContext(ctx context.Context) UserPoolPasswordPolicyOutput

func (UserPoolPasswordPolicyOutput) ToUserPoolPasswordPolicyPtrOutput

func (o UserPoolPasswordPolicyOutput) ToUserPoolPasswordPolicyPtrOutput() UserPoolPasswordPolicyPtrOutput

func (UserPoolPasswordPolicyOutput) ToUserPoolPasswordPolicyPtrOutputWithContext

func (o UserPoolPasswordPolicyOutput) ToUserPoolPasswordPolicyPtrOutputWithContext(ctx context.Context) UserPoolPasswordPolicyPtrOutput

type UserPoolPasswordPolicyPtrInput

type UserPoolPasswordPolicyPtrInput interface {
	pulumi.Input

	ToUserPoolPasswordPolicyPtrOutput() UserPoolPasswordPolicyPtrOutput
	ToUserPoolPasswordPolicyPtrOutputWithContext(context.Context) UserPoolPasswordPolicyPtrOutput
}

UserPoolPasswordPolicyPtrInput is an input type that accepts UserPoolPasswordPolicyArgs, UserPoolPasswordPolicyPtr and UserPoolPasswordPolicyPtrOutput values. You can construct a concrete instance of `UserPoolPasswordPolicyPtrInput` via:

        UserPoolPasswordPolicyArgs{...}

or:

        nil

type UserPoolPasswordPolicyPtrOutput

type UserPoolPasswordPolicyPtrOutput struct{ *pulumi.OutputState }

func (UserPoolPasswordPolicyPtrOutput) Elem

func (UserPoolPasswordPolicyPtrOutput) ElementType

func (UserPoolPasswordPolicyPtrOutput) MinimumLength

Minimum length of the password policy that you have set.

func (UserPoolPasswordPolicyPtrOutput) RequireLowercase

Whether you have required users to use at least one lowercase letter in their password.

func (UserPoolPasswordPolicyPtrOutput) RequireNumbers

Whether you have required users to use at least one number in their password.

func (UserPoolPasswordPolicyPtrOutput) RequireSymbols

Whether you have required users to use at least one symbol in their password.

func (UserPoolPasswordPolicyPtrOutput) RequireUppercase

Whether you have required users to use at least one uppercase letter in their password.

func (UserPoolPasswordPolicyPtrOutput) TemporaryPasswordValidityDays

func (o UserPoolPasswordPolicyPtrOutput) TemporaryPasswordValidityDays() pulumi.IntPtrOutput

In the password policy you have set, refers to the number of days a temporary password is valid. If the user does not sign-in during this time, their password will need to be reset by an administrator.

func (UserPoolPasswordPolicyPtrOutput) ToUserPoolPasswordPolicyPtrOutput

func (o UserPoolPasswordPolicyPtrOutput) ToUserPoolPasswordPolicyPtrOutput() UserPoolPasswordPolicyPtrOutput

func (UserPoolPasswordPolicyPtrOutput) ToUserPoolPasswordPolicyPtrOutputWithContext

func (o UserPoolPasswordPolicyPtrOutput) ToUserPoolPasswordPolicyPtrOutputWithContext(ctx context.Context) UserPoolPasswordPolicyPtrOutput

type UserPoolPtrInput added in v3.25.0

type UserPoolPtrInput interface {
	pulumi.Input

	ToUserPoolPtrOutput() UserPoolPtrOutput
	ToUserPoolPtrOutputWithContext(ctx context.Context) UserPoolPtrOutput
}

type UserPoolPtrOutput added in v3.25.0

type UserPoolPtrOutput struct {
	*pulumi.OutputState
}

func (UserPoolPtrOutput) ElementType added in v3.25.0

func (UserPoolPtrOutput) ElementType() reflect.Type

func (UserPoolPtrOutput) ToUserPoolPtrOutput added in v3.25.0

func (o UserPoolPtrOutput) ToUserPoolPtrOutput() UserPoolPtrOutput

func (UserPoolPtrOutput) ToUserPoolPtrOutputWithContext added in v3.25.0

func (o UserPoolPtrOutput) ToUserPoolPtrOutputWithContext(ctx context.Context) UserPoolPtrOutput

type UserPoolSchema

type UserPoolSchema struct {
	// Attribute data type. Must be one of `Boolean`, `Number`, `String`, `DateTime`.
	AttributeDataType string `pulumi:"attributeDataType"`
	// Whether the attribute type is developer only.
	DeveloperOnlyAttribute *bool `pulumi:"developerOnlyAttribute"`
	// Whether the attribute can be changed once it has been created.
	Mutable *bool `pulumi:"mutable"`
	// Name of the attribute.
	Name string `pulumi:"name"`
	// Configuration block for the constraints for an attribute of the number type. Detailed below.
	NumberAttributeConstraints *UserPoolSchemaNumberAttributeConstraints `pulumi:"numberAttributeConstraints"`
	// Whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.
	Required *bool `pulumi:"required"`
	// Constraints for an attribute of the string type. Detailed below.
	StringAttributeConstraints *UserPoolSchemaStringAttributeConstraints `pulumi:"stringAttributeConstraints"`
}

type UserPoolSchemaArgs

type UserPoolSchemaArgs struct {
	// Attribute data type. Must be one of `Boolean`, `Number`, `String`, `DateTime`.
	AttributeDataType pulumi.StringInput `pulumi:"attributeDataType"`
	// Whether the attribute type is developer only.
	DeveloperOnlyAttribute pulumi.BoolPtrInput `pulumi:"developerOnlyAttribute"`
	// Whether the attribute can be changed once it has been created.
	Mutable pulumi.BoolPtrInput `pulumi:"mutable"`
	// Name of the attribute.
	Name pulumi.StringInput `pulumi:"name"`
	// Configuration block for the constraints for an attribute of the number type. Detailed below.
	NumberAttributeConstraints UserPoolSchemaNumberAttributeConstraintsPtrInput `pulumi:"numberAttributeConstraints"`
	// Whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.
	Required pulumi.BoolPtrInput `pulumi:"required"`
	// Constraints for an attribute of the string type. Detailed below.
	StringAttributeConstraints UserPoolSchemaStringAttributeConstraintsPtrInput `pulumi:"stringAttributeConstraints"`
}

func (UserPoolSchemaArgs) ElementType

func (UserPoolSchemaArgs) ElementType() reflect.Type

func (UserPoolSchemaArgs) ToUserPoolSchemaOutput

func (i UserPoolSchemaArgs) ToUserPoolSchemaOutput() UserPoolSchemaOutput

func (UserPoolSchemaArgs) ToUserPoolSchemaOutputWithContext

func (i UserPoolSchemaArgs) ToUserPoolSchemaOutputWithContext(ctx context.Context) UserPoolSchemaOutput

type UserPoolSchemaArray

type UserPoolSchemaArray []UserPoolSchemaInput

func (UserPoolSchemaArray) ElementType

func (UserPoolSchemaArray) ElementType() reflect.Type

func (UserPoolSchemaArray) ToUserPoolSchemaArrayOutput

func (i UserPoolSchemaArray) ToUserPoolSchemaArrayOutput() UserPoolSchemaArrayOutput

func (UserPoolSchemaArray) ToUserPoolSchemaArrayOutputWithContext

func (i UserPoolSchemaArray) ToUserPoolSchemaArrayOutputWithContext(ctx context.Context) UserPoolSchemaArrayOutput

type UserPoolSchemaArrayInput

type UserPoolSchemaArrayInput interface {
	pulumi.Input

	ToUserPoolSchemaArrayOutput() UserPoolSchemaArrayOutput
	ToUserPoolSchemaArrayOutputWithContext(context.Context) UserPoolSchemaArrayOutput
}

UserPoolSchemaArrayInput is an input type that accepts UserPoolSchemaArray and UserPoolSchemaArrayOutput values. You can construct a concrete instance of `UserPoolSchemaArrayInput` via:

UserPoolSchemaArray{ UserPoolSchemaArgs{...} }

type UserPoolSchemaArrayOutput

type UserPoolSchemaArrayOutput struct{ *pulumi.OutputState }

func (UserPoolSchemaArrayOutput) ElementType

func (UserPoolSchemaArrayOutput) ElementType() reflect.Type

func (UserPoolSchemaArrayOutput) Index

func (UserPoolSchemaArrayOutput) ToUserPoolSchemaArrayOutput

func (o UserPoolSchemaArrayOutput) ToUserPoolSchemaArrayOutput() UserPoolSchemaArrayOutput

func (UserPoolSchemaArrayOutput) ToUserPoolSchemaArrayOutputWithContext

func (o UserPoolSchemaArrayOutput) ToUserPoolSchemaArrayOutputWithContext(ctx context.Context) UserPoolSchemaArrayOutput

type UserPoolSchemaInput

type UserPoolSchemaInput interface {
	pulumi.Input

	ToUserPoolSchemaOutput() UserPoolSchemaOutput
	ToUserPoolSchemaOutputWithContext(context.Context) UserPoolSchemaOutput
}

UserPoolSchemaInput is an input type that accepts UserPoolSchemaArgs and UserPoolSchemaOutput values. You can construct a concrete instance of `UserPoolSchemaInput` via:

UserPoolSchemaArgs{...}

type UserPoolSchemaNumberAttributeConstraints

type UserPoolSchemaNumberAttributeConstraints struct {
	// Maximum value of an attribute that is of the number data type.
	MaxValue *string `pulumi:"maxValue"`
	// Minimum value of an attribute that is of the number data type.
	MinValue *string `pulumi:"minValue"`
}

type UserPoolSchemaNumberAttributeConstraintsArgs

type UserPoolSchemaNumberAttributeConstraintsArgs struct {
	// Maximum value of an attribute that is of the number data type.
	MaxValue pulumi.StringPtrInput `pulumi:"maxValue"`
	// Minimum value of an attribute that is of the number data type.
	MinValue pulumi.StringPtrInput `pulumi:"minValue"`
}

func (UserPoolSchemaNumberAttributeConstraintsArgs) ElementType

func (UserPoolSchemaNumberAttributeConstraintsArgs) ToUserPoolSchemaNumberAttributeConstraintsOutput

func (i UserPoolSchemaNumberAttributeConstraintsArgs) ToUserPoolSchemaNumberAttributeConstraintsOutput() UserPoolSchemaNumberAttributeConstraintsOutput

func (UserPoolSchemaNumberAttributeConstraintsArgs) ToUserPoolSchemaNumberAttributeConstraintsOutputWithContext

func (i UserPoolSchemaNumberAttributeConstraintsArgs) ToUserPoolSchemaNumberAttributeConstraintsOutputWithContext(ctx context.Context) UserPoolSchemaNumberAttributeConstraintsOutput

func (UserPoolSchemaNumberAttributeConstraintsArgs) ToUserPoolSchemaNumberAttributeConstraintsPtrOutput

func (i UserPoolSchemaNumberAttributeConstraintsArgs) ToUserPoolSchemaNumberAttributeConstraintsPtrOutput() UserPoolSchemaNumberAttributeConstraintsPtrOutput

func (UserPoolSchemaNumberAttributeConstraintsArgs) ToUserPoolSchemaNumberAttributeConstraintsPtrOutputWithContext

func (i UserPoolSchemaNumberAttributeConstraintsArgs) ToUserPoolSchemaNumberAttributeConstraintsPtrOutputWithContext(ctx context.Context) UserPoolSchemaNumberAttributeConstraintsPtrOutput

type UserPoolSchemaNumberAttributeConstraintsInput

type UserPoolSchemaNumberAttributeConstraintsInput interface {
	pulumi.Input

	ToUserPoolSchemaNumberAttributeConstraintsOutput() UserPoolSchemaNumberAttributeConstraintsOutput
	ToUserPoolSchemaNumberAttributeConstraintsOutputWithContext(context.Context) UserPoolSchemaNumberAttributeConstraintsOutput
}

UserPoolSchemaNumberAttributeConstraintsInput is an input type that accepts UserPoolSchemaNumberAttributeConstraintsArgs and UserPoolSchemaNumberAttributeConstraintsOutput values. You can construct a concrete instance of `UserPoolSchemaNumberAttributeConstraintsInput` via:

UserPoolSchemaNumberAttributeConstraintsArgs{...}

type UserPoolSchemaNumberAttributeConstraintsOutput

type UserPoolSchemaNumberAttributeConstraintsOutput struct{ *pulumi.OutputState }

func (UserPoolSchemaNumberAttributeConstraintsOutput) ElementType

func (UserPoolSchemaNumberAttributeConstraintsOutput) MaxValue

Maximum value of an attribute that is of the number data type.

func (UserPoolSchemaNumberAttributeConstraintsOutput) MinValue

Minimum value of an attribute that is of the number data type.

func (UserPoolSchemaNumberAttributeConstraintsOutput) ToUserPoolSchemaNumberAttributeConstraintsOutput

func (o UserPoolSchemaNumberAttributeConstraintsOutput) ToUserPoolSchemaNumberAttributeConstraintsOutput() UserPoolSchemaNumberAttributeConstraintsOutput

func (UserPoolSchemaNumberAttributeConstraintsOutput) ToUserPoolSchemaNumberAttributeConstraintsOutputWithContext

func (o UserPoolSchemaNumberAttributeConstraintsOutput) ToUserPoolSchemaNumberAttributeConstraintsOutputWithContext(ctx context.Context) UserPoolSchemaNumberAttributeConstraintsOutput

func (UserPoolSchemaNumberAttributeConstraintsOutput) ToUserPoolSchemaNumberAttributeConstraintsPtrOutput

func (o UserPoolSchemaNumberAttributeConstraintsOutput) ToUserPoolSchemaNumberAttributeConstraintsPtrOutput() UserPoolSchemaNumberAttributeConstraintsPtrOutput

func (UserPoolSchemaNumberAttributeConstraintsOutput) ToUserPoolSchemaNumberAttributeConstraintsPtrOutputWithContext

func (o UserPoolSchemaNumberAttributeConstraintsOutput) ToUserPoolSchemaNumberAttributeConstraintsPtrOutputWithContext(ctx context.Context) UserPoolSchemaNumberAttributeConstraintsPtrOutput

type UserPoolSchemaNumberAttributeConstraintsPtrInput

type UserPoolSchemaNumberAttributeConstraintsPtrInput interface {
	pulumi.Input

	ToUserPoolSchemaNumberAttributeConstraintsPtrOutput() UserPoolSchemaNumberAttributeConstraintsPtrOutput
	ToUserPoolSchemaNumberAttributeConstraintsPtrOutputWithContext(context.Context) UserPoolSchemaNumberAttributeConstraintsPtrOutput
}

UserPoolSchemaNumberAttributeConstraintsPtrInput is an input type that accepts UserPoolSchemaNumberAttributeConstraintsArgs, UserPoolSchemaNumberAttributeConstraintsPtr and UserPoolSchemaNumberAttributeConstraintsPtrOutput values. You can construct a concrete instance of `UserPoolSchemaNumberAttributeConstraintsPtrInput` via:

        UserPoolSchemaNumberAttributeConstraintsArgs{...}

or:

        nil

type UserPoolSchemaNumberAttributeConstraintsPtrOutput

type UserPoolSchemaNumberAttributeConstraintsPtrOutput struct{ *pulumi.OutputState }

func (UserPoolSchemaNumberAttributeConstraintsPtrOutput) Elem

func (UserPoolSchemaNumberAttributeConstraintsPtrOutput) ElementType

func (UserPoolSchemaNumberAttributeConstraintsPtrOutput) MaxValue

Maximum value of an attribute that is of the number data type.

func (UserPoolSchemaNumberAttributeConstraintsPtrOutput) MinValue

Minimum value of an attribute that is of the number data type.

func (UserPoolSchemaNumberAttributeConstraintsPtrOutput) ToUserPoolSchemaNumberAttributeConstraintsPtrOutput

func (o UserPoolSchemaNumberAttributeConstraintsPtrOutput) ToUserPoolSchemaNumberAttributeConstraintsPtrOutput() UserPoolSchemaNumberAttributeConstraintsPtrOutput

func (UserPoolSchemaNumberAttributeConstraintsPtrOutput) ToUserPoolSchemaNumberAttributeConstraintsPtrOutputWithContext

func (o UserPoolSchemaNumberAttributeConstraintsPtrOutput) ToUserPoolSchemaNumberAttributeConstraintsPtrOutputWithContext(ctx context.Context) UserPoolSchemaNumberAttributeConstraintsPtrOutput

type UserPoolSchemaOutput

type UserPoolSchemaOutput struct{ *pulumi.OutputState }

func (UserPoolSchemaOutput) AttributeDataType

func (o UserPoolSchemaOutput) AttributeDataType() pulumi.StringOutput

Attribute data type. Must be one of `Boolean`, `Number`, `String`, `DateTime`.

func (UserPoolSchemaOutput) DeveloperOnlyAttribute

func (o UserPoolSchemaOutput) DeveloperOnlyAttribute() pulumi.BoolPtrOutput

Whether the attribute type is developer only.

func (UserPoolSchemaOutput) ElementType

func (UserPoolSchemaOutput) ElementType() reflect.Type

func (UserPoolSchemaOutput) Mutable

Whether the attribute can be changed once it has been created.

func (UserPoolSchemaOutput) Name

Name of the attribute.

func (UserPoolSchemaOutput) NumberAttributeConstraints

Configuration block for the constraints for an attribute of the number type. Detailed below.

func (UserPoolSchemaOutput) Required

Whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.

func (UserPoolSchemaOutput) StringAttributeConstraints

Constraints for an attribute of the string type. Detailed below.

func (UserPoolSchemaOutput) ToUserPoolSchemaOutput

func (o UserPoolSchemaOutput) ToUserPoolSchemaOutput() UserPoolSchemaOutput

func (UserPoolSchemaOutput) ToUserPoolSchemaOutputWithContext

func (o UserPoolSchemaOutput) ToUserPoolSchemaOutputWithContext(ctx context.Context) UserPoolSchemaOutput

type UserPoolSchemaStringAttributeConstraints

type UserPoolSchemaStringAttributeConstraints struct {
	// Maximum length of an attribute value of the string type.
	MaxLength *string `pulumi:"maxLength"`
	// Minimum length of an attribute value of the string type.
	MinLength *string `pulumi:"minLength"`
}

type UserPoolSchemaStringAttributeConstraintsArgs

type UserPoolSchemaStringAttributeConstraintsArgs struct {
	// Maximum length of an attribute value of the string type.
	MaxLength pulumi.StringPtrInput `pulumi:"maxLength"`
	// Minimum length of an attribute value of the string type.
	MinLength pulumi.StringPtrInput `pulumi:"minLength"`
}

func (UserPoolSchemaStringAttributeConstraintsArgs) ElementType

func (UserPoolSchemaStringAttributeConstraintsArgs) ToUserPoolSchemaStringAttributeConstraintsOutput

func (i UserPoolSchemaStringAttributeConstraintsArgs) ToUserPoolSchemaStringAttributeConstraintsOutput() UserPoolSchemaStringAttributeConstraintsOutput

func (UserPoolSchemaStringAttributeConstraintsArgs) ToUserPoolSchemaStringAttributeConstraintsOutputWithContext

func (i UserPoolSchemaStringAttributeConstraintsArgs) ToUserPoolSchemaStringAttributeConstraintsOutputWithContext(ctx context.Context) UserPoolSchemaStringAttributeConstraintsOutput

func (UserPoolSchemaStringAttributeConstraintsArgs) ToUserPoolSchemaStringAttributeConstraintsPtrOutput

func (i UserPoolSchemaStringAttributeConstraintsArgs) ToUserPoolSchemaStringAttributeConstraintsPtrOutput() UserPoolSchemaStringAttributeConstraintsPtrOutput

func (UserPoolSchemaStringAttributeConstraintsArgs) ToUserPoolSchemaStringAttributeConstraintsPtrOutputWithContext

func (i UserPoolSchemaStringAttributeConstraintsArgs) ToUserPoolSchemaStringAttributeConstraintsPtrOutputWithContext(ctx context.Context) UserPoolSchemaStringAttributeConstraintsPtrOutput

type UserPoolSchemaStringAttributeConstraintsInput

type UserPoolSchemaStringAttributeConstraintsInput interface {
	pulumi.Input

	ToUserPoolSchemaStringAttributeConstraintsOutput() UserPoolSchemaStringAttributeConstraintsOutput
	ToUserPoolSchemaStringAttributeConstraintsOutputWithContext(context.Context) UserPoolSchemaStringAttributeConstraintsOutput
}

UserPoolSchemaStringAttributeConstraintsInput is an input type that accepts UserPoolSchemaStringAttributeConstraintsArgs and UserPoolSchemaStringAttributeConstraintsOutput values. You can construct a concrete instance of `UserPoolSchemaStringAttributeConstraintsInput` via:

UserPoolSchemaStringAttributeConstraintsArgs{...}

type UserPoolSchemaStringAttributeConstraintsOutput

type UserPoolSchemaStringAttributeConstraintsOutput struct{ *pulumi.OutputState }

func (UserPoolSchemaStringAttributeConstraintsOutput) ElementType

func (UserPoolSchemaStringAttributeConstraintsOutput) MaxLength

Maximum length of an attribute value of the string type.

func (UserPoolSchemaStringAttributeConstraintsOutput) MinLength

Minimum length of an attribute value of the string type.

func (UserPoolSchemaStringAttributeConstraintsOutput) ToUserPoolSchemaStringAttributeConstraintsOutput

func (o UserPoolSchemaStringAttributeConstraintsOutput) ToUserPoolSchemaStringAttributeConstraintsOutput() UserPoolSchemaStringAttributeConstraintsOutput

func (UserPoolSchemaStringAttributeConstraintsOutput) ToUserPoolSchemaStringAttributeConstraintsOutputWithContext

func (o UserPoolSchemaStringAttributeConstraintsOutput) ToUserPoolSchemaStringAttributeConstraintsOutputWithContext(ctx context.Context) UserPoolSchemaStringAttributeConstraintsOutput

func (UserPoolSchemaStringAttributeConstraintsOutput) ToUserPoolSchemaStringAttributeConstraintsPtrOutput

func (o UserPoolSchemaStringAttributeConstraintsOutput) ToUserPoolSchemaStringAttributeConstraintsPtrOutput() UserPoolSchemaStringAttributeConstraintsPtrOutput

func (UserPoolSchemaStringAttributeConstraintsOutput) ToUserPoolSchemaStringAttributeConstraintsPtrOutputWithContext

func (o UserPoolSchemaStringAttributeConstraintsOutput) ToUserPoolSchemaStringAttributeConstraintsPtrOutputWithContext(ctx context.Context) UserPoolSchemaStringAttributeConstraintsPtrOutput

type UserPoolSchemaStringAttributeConstraintsPtrInput

type UserPoolSchemaStringAttributeConstraintsPtrInput interface {
	pulumi.Input

	ToUserPoolSchemaStringAttributeConstraintsPtrOutput() UserPoolSchemaStringAttributeConstraintsPtrOutput
	ToUserPoolSchemaStringAttributeConstraintsPtrOutputWithContext(context.Context) UserPoolSchemaStringAttributeConstraintsPtrOutput
}

UserPoolSchemaStringAttributeConstraintsPtrInput is an input type that accepts UserPoolSchemaStringAttributeConstraintsArgs, UserPoolSchemaStringAttributeConstraintsPtr and UserPoolSchemaStringAttributeConstraintsPtrOutput values. You can construct a concrete instance of `UserPoolSchemaStringAttributeConstraintsPtrInput` via:

        UserPoolSchemaStringAttributeConstraintsArgs{...}

or:

        nil

type UserPoolSchemaStringAttributeConstraintsPtrOutput

type UserPoolSchemaStringAttributeConstraintsPtrOutput struct{ *pulumi.OutputState }

func (UserPoolSchemaStringAttributeConstraintsPtrOutput) Elem

func (UserPoolSchemaStringAttributeConstraintsPtrOutput) ElementType

func (UserPoolSchemaStringAttributeConstraintsPtrOutput) MaxLength

Maximum length of an attribute value of the string type.

func (UserPoolSchemaStringAttributeConstraintsPtrOutput) MinLength

Minimum length of an attribute value of the string type.

func (UserPoolSchemaStringAttributeConstraintsPtrOutput) ToUserPoolSchemaStringAttributeConstraintsPtrOutput

func (o UserPoolSchemaStringAttributeConstraintsPtrOutput) ToUserPoolSchemaStringAttributeConstraintsPtrOutput() UserPoolSchemaStringAttributeConstraintsPtrOutput

func (UserPoolSchemaStringAttributeConstraintsPtrOutput) ToUserPoolSchemaStringAttributeConstraintsPtrOutputWithContext

func (o UserPoolSchemaStringAttributeConstraintsPtrOutput) ToUserPoolSchemaStringAttributeConstraintsPtrOutputWithContext(ctx context.Context) UserPoolSchemaStringAttributeConstraintsPtrOutput

type UserPoolSmsConfiguration

type UserPoolSmsConfiguration struct {
	// External ID used in IAM role trust relationships. For more information about using external IDs, see [How to Use an External ID When Granting Access to Your AWS Resources to a Third Party](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html).
	ExternalId string `pulumi:"externalId"`
	// ARN of the Amazon SNS caller. This is usually the IAM role that you've given Cognito permission to assume.
	SnsCallerArn string `pulumi:"snsCallerArn"`
}

type UserPoolSmsConfigurationArgs

type UserPoolSmsConfigurationArgs struct {
	// External ID used in IAM role trust relationships. For more information about using external IDs, see [How to Use an External ID When Granting Access to Your AWS Resources to a Third Party](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html).
	ExternalId pulumi.StringInput `pulumi:"externalId"`
	// ARN of the Amazon SNS caller. This is usually the IAM role that you've given Cognito permission to assume.
	SnsCallerArn pulumi.StringInput `pulumi:"snsCallerArn"`
}

func (UserPoolSmsConfigurationArgs) ElementType

func (UserPoolSmsConfigurationArgs) ToUserPoolSmsConfigurationOutput

func (i UserPoolSmsConfigurationArgs) ToUserPoolSmsConfigurationOutput() UserPoolSmsConfigurationOutput

func (UserPoolSmsConfigurationArgs) ToUserPoolSmsConfigurationOutputWithContext

func (i UserPoolSmsConfigurationArgs) ToUserPoolSmsConfigurationOutputWithContext(ctx context.Context) UserPoolSmsConfigurationOutput

func (UserPoolSmsConfigurationArgs) ToUserPoolSmsConfigurationPtrOutput

func (i UserPoolSmsConfigurationArgs) ToUserPoolSmsConfigurationPtrOutput() UserPoolSmsConfigurationPtrOutput

func (UserPoolSmsConfigurationArgs) ToUserPoolSmsConfigurationPtrOutputWithContext

func (i UserPoolSmsConfigurationArgs) ToUserPoolSmsConfigurationPtrOutputWithContext(ctx context.Context) UserPoolSmsConfigurationPtrOutput

type UserPoolSmsConfigurationInput

type UserPoolSmsConfigurationInput interface {
	pulumi.Input

	ToUserPoolSmsConfigurationOutput() UserPoolSmsConfigurationOutput
	ToUserPoolSmsConfigurationOutputWithContext(context.Context) UserPoolSmsConfigurationOutput
}

UserPoolSmsConfigurationInput is an input type that accepts UserPoolSmsConfigurationArgs and UserPoolSmsConfigurationOutput values. You can construct a concrete instance of `UserPoolSmsConfigurationInput` via:

UserPoolSmsConfigurationArgs{...}

type UserPoolSmsConfigurationOutput

type UserPoolSmsConfigurationOutput struct{ *pulumi.OutputState }

func (UserPoolSmsConfigurationOutput) ElementType

func (UserPoolSmsConfigurationOutput) ExternalId

External ID used in IAM role trust relationships. For more information about using external IDs, see [How to Use an External ID When Granting Access to Your AWS Resources to a Third Party](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html).

func (UserPoolSmsConfigurationOutput) SnsCallerArn

ARN of the Amazon SNS caller. This is usually the IAM role that you've given Cognito permission to assume.

func (UserPoolSmsConfigurationOutput) ToUserPoolSmsConfigurationOutput

func (o UserPoolSmsConfigurationOutput) ToUserPoolSmsConfigurationOutput() UserPoolSmsConfigurationOutput

func (UserPoolSmsConfigurationOutput) ToUserPoolSmsConfigurationOutputWithContext

func (o UserPoolSmsConfigurationOutput) ToUserPoolSmsConfigurationOutputWithContext(ctx context.Context) UserPoolSmsConfigurationOutput

func (UserPoolSmsConfigurationOutput) ToUserPoolSmsConfigurationPtrOutput

func (o UserPoolSmsConfigurationOutput) ToUserPoolSmsConfigurationPtrOutput() UserPoolSmsConfigurationPtrOutput

func (UserPoolSmsConfigurationOutput) ToUserPoolSmsConfigurationPtrOutputWithContext

func (o UserPoolSmsConfigurationOutput) ToUserPoolSmsConfigurationPtrOutputWithContext(ctx context.Context) UserPoolSmsConfigurationPtrOutput

type UserPoolSmsConfigurationPtrInput

type UserPoolSmsConfigurationPtrInput interface {
	pulumi.Input

	ToUserPoolSmsConfigurationPtrOutput() UserPoolSmsConfigurationPtrOutput
	ToUserPoolSmsConfigurationPtrOutputWithContext(context.Context) UserPoolSmsConfigurationPtrOutput
}

UserPoolSmsConfigurationPtrInput is an input type that accepts UserPoolSmsConfigurationArgs, UserPoolSmsConfigurationPtr and UserPoolSmsConfigurationPtrOutput values. You can construct a concrete instance of `UserPoolSmsConfigurationPtrInput` via:

        UserPoolSmsConfigurationArgs{...}

or:

        nil

type UserPoolSmsConfigurationPtrOutput

type UserPoolSmsConfigurationPtrOutput struct{ *pulumi.OutputState }

func (UserPoolSmsConfigurationPtrOutput) Elem

func (UserPoolSmsConfigurationPtrOutput) ElementType

func (UserPoolSmsConfigurationPtrOutput) ExternalId

External ID used in IAM role trust relationships. For more information about using external IDs, see [How to Use an External ID When Granting Access to Your AWS Resources to a Third Party](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html).

func (UserPoolSmsConfigurationPtrOutput) SnsCallerArn

ARN of the Amazon SNS caller. This is usually the IAM role that you've given Cognito permission to assume.

func (UserPoolSmsConfigurationPtrOutput) ToUserPoolSmsConfigurationPtrOutput

func (o UserPoolSmsConfigurationPtrOutput) ToUserPoolSmsConfigurationPtrOutput() UserPoolSmsConfigurationPtrOutput

func (UserPoolSmsConfigurationPtrOutput) ToUserPoolSmsConfigurationPtrOutputWithContext

func (o UserPoolSmsConfigurationPtrOutput) ToUserPoolSmsConfigurationPtrOutputWithContext(ctx context.Context) UserPoolSmsConfigurationPtrOutput

type UserPoolSoftwareTokenMfaConfiguration

type UserPoolSoftwareTokenMfaConfiguration struct {
	// Boolean whether to enable software token Multi-Factor (MFA) tokens, such as Time-based One-Time Password (TOTP). To disable software token MFA When `smsConfiguration` is not present, the `mfaConfiguration` argument must be set to `OFF` and the `softwareTokenMfaConfiguration` configuration block must be fully removed.
	Enabled bool `pulumi:"enabled"`
}

type UserPoolSoftwareTokenMfaConfigurationArgs

type UserPoolSoftwareTokenMfaConfigurationArgs struct {
	// Boolean whether to enable software token Multi-Factor (MFA) tokens, such as Time-based One-Time Password (TOTP). To disable software token MFA When `smsConfiguration` is not present, the `mfaConfiguration` argument must be set to `OFF` and the `softwareTokenMfaConfiguration` configuration block must be fully removed.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
}

func (UserPoolSoftwareTokenMfaConfigurationArgs) ElementType

func (UserPoolSoftwareTokenMfaConfigurationArgs) ToUserPoolSoftwareTokenMfaConfigurationOutput

func (i UserPoolSoftwareTokenMfaConfigurationArgs) ToUserPoolSoftwareTokenMfaConfigurationOutput() UserPoolSoftwareTokenMfaConfigurationOutput

func (UserPoolSoftwareTokenMfaConfigurationArgs) ToUserPoolSoftwareTokenMfaConfigurationOutputWithContext

func (i UserPoolSoftwareTokenMfaConfigurationArgs) ToUserPoolSoftwareTokenMfaConfigurationOutputWithContext(ctx context.Context) UserPoolSoftwareTokenMfaConfigurationOutput

func (UserPoolSoftwareTokenMfaConfigurationArgs) ToUserPoolSoftwareTokenMfaConfigurationPtrOutput

func (i UserPoolSoftwareTokenMfaConfigurationArgs) ToUserPoolSoftwareTokenMfaConfigurationPtrOutput() UserPoolSoftwareTokenMfaConfigurationPtrOutput

func (UserPoolSoftwareTokenMfaConfigurationArgs) ToUserPoolSoftwareTokenMfaConfigurationPtrOutputWithContext

func (i UserPoolSoftwareTokenMfaConfigurationArgs) ToUserPoolSoftwareTokenMfaConfigurationPtrOutputWithContext(ctx context.Context) UserPoolSoftwareTokenMfaConfigurationPtrOutput

type UserPoolSoftwareTokenMfaConfigurationInput

type UserPoolSoftwareTokenMfaConfigurationInput interface {
	pulumi.Input

	ToUserPoolSoftwareTokenMfaConfigurationOutput() UserPoolSoftwareTokenMfaConfigurationOutput
	ToUserPoolSoftwareTokenMfaConfigurationOutputWithContext(context.Context) UserPoolSoftwareTokenMfaConfigurationOutput
}

UserPoolSoftwareTokenMfaConfigurationInput is an input type that accepts UserPoolSoftwareTokenMfaConfigurationArgs and UserPoolSoftwareTokenMfaConfigurationOutput values. You can construct a concrete instance of `UserPoolSoftwareTokenMfaConfigurationInput` via:

UserPoolSoftwareTokenMfaConfigurationArgs{...}

type UserPoolSoftwareTokenMfaConfigurationOutput

type UserPoolSoftwareTokenMfaConfigurationOutput struct{ *pulumi.OutputState }

func (UserPoolSoftwareTokenMfaConfigurationOutput) ElementType

func (UserPoolSoftwareTokenMfaConfigurationOutput) Enabled

Boolean whether to enable software token Multi-Factor (MFA) tokens, such as Time-based One-Time Password (TOTP). To disable software token MFA When `smsConfiguration` is not present, the `mfaConfiguration` argument must be set to `OFF` and the `softwareTokenMfaConfiguration` configuration block must be fully removed.

func (UserPoolSoftwareTokenMfaConfigurationOutput) ToUserPoolSoftwareTokenMfaConfigurationOutput

func (o UserPoolSoftwareTokenMfaConfigurationOutput) ToUserPoolSoftwareTokenMfaConfigurationOutput() UserPoolSoftwareTokenMfaConfigurationOutput

func (UserPoolSoftwareTokenMfaConfigurationOutput) ToUserPoolSoftwareTokenMfaConfigurationOutputWithContext

func (o UserPoolSoftwareTokenMfaConfigurationOutput) ToUserPoolSoftwareTokenMfaConfigurationOutputWithContext(ctx context.Context) UserPoolSoftwareTokenMfaConfigurationOutput

func (UserPoolSoftwareTokenMfaConfigurationOutput) ToUserPoolSoftwareTokenMfaConfigurationPtrOutput

func (o UserPoolSoftwareTokenMfaConfigurationOutput) ToUserPoolSoftwareTokenMfaConfigurationPtrOutput() UserPoolSoftwareTokenMfaConfigurationPtrOutput

func (UserPoolSoftwareTokenMfaConfigurationOutput) ToUserPoolSoftwareTokenMfaConfigurationPtrOutputWithContext

func (o UserPoolSoftwareTokenMfaConfigurationOutput) ToUserPoolSoftwareTokenMfaConfigurationPtrOutputWithContext(ctx context.Context) UserPoolSoftwareTokenMfaConfigurationPtrOutput

type UserPoolSoftwareTokenMfaConfigurationPtrInput

type UserPoolSoftwareTokenMfaConfigurationPtrInput interface {
	pulumi.Input

	ToUserPoolSoftwareTokenMfaConfigurationPtrOutput() UserPoolSoftwareTokenMfaConfigurationPtrOutput
	ToUserPoolSoftwareTokenMfaConfigurationPtrOutputWithContext(context.Context) UserPoolSoftwareTokenMfaConfigurationPtrOutput
}

UserPoolSoftwareTokenMfaConfigurationPtrInput is an input type that accepts UserPoolSoftwareTokenMfaConfigurationArgs, UserPoolSoftwareTokenMfaConfigurationPtr and UserPoolSoftwareTokenMfaConfigurationPtrOutput values. You can construct a concrete instance of `UserPoolSoftwareTokenMfaConfigurationPtrInput` via:

        UserPoolSoftwareTokenMfaConfigurationArgs{...}

or:

        nil

type UserPoolSoftwareTokenMfaConfigurationPtrOutput

type UserPoolSoftwareTokenMfaConfigurationPtrOutput struct{ *pulumi.OutputState }

func (UserPoolSoftwareTokenMfaConfigurationPtrOutput) Elem

func (UserPoolSoftwareTokenMfaConfigurationPtrOutput) ElementType

func (UserPoolSoftwareTokenMfaConfigurationPtrOutput) Enabled

Boolean whether to enable software token Multi-Factor (MFA) tokens, such as Time-based One-Time Password (TOTP). To disable software token MFA When `smsConfiguration` is not present, the `mfaConfiguration` argument must be set to `OFF` and the `softwareTokenMfaConfiguration` configuration block must be fully removed.

func (UserPoolSoftwareTokenMfaConfigurationPtrOutput) ToUserPoolSoftwareTokenMfaConfigurationPtrOutput

func (o UserPoolSoftwareTokenMfaConfigurationPtrOutput) ToUserPoolSoftwareTokenMfaConfigurationPtrOutput() UserPoolSoftwareTokenMfaConfigurationPtrOutput

func (UserPoolSoftwareTokenMfaConfigurationPtrOutput) ToUserPoolSoftwareTokenMfaConfigurationPtrOutputWithContext

func (o UserPoolSoftwareTokenMfaConfigurationPtrOutput) ToUserPoolSoftwareTokenMfaConfigurationPtrOutputWithContext(ctx context.Context) UserPoolSoftwareTokenMfaConfigurationPtrOutput

type UserPoolState

type UserPoolState struct {
	// Configuration block to define which verified available method a user can use to recover their forgotten password. Detailed below.
	AccountRecoverySetting UserPoolAccountRecoverySettingPtrInput
	// Configuration block for creating a new user profile. Detailed below.
	AdminCreateUserConfig UserPoolAdminCreateUserConfigPtrInput
	// Attributes supported as an alias for this user pool. Valid values: `phoneNumber`, `email`, or `preferredUsername`. Conflicts with `usernameAttributes`.
	AliasAttributes pulumi.StringArrayInput
	// ARN of the user pool.
	Arn pulumi.StringPtrInput
	// Attributes to be auto-verified. Valid values: `email`, `phoneNumber`.
	AutoVerifiedAttributes pulumi.StringArrayInput
	// Date the user pool was created.
	CreationDate pulumi.StringPtrInput
	// Configuration block for the user pool's device tracking. Detailed below.
	DeviceConfiguration UserPoolDeviceConfigurationPtrInput
	// Configuration block for configuring email. Detailed below.
	EmailConfiguration UserPoolEmailConfigurationPtrInput
	// String representing the email verification message. Conflicts with `verificationMessageTemplate` configuration block `emailMessage` argument.
	EmailVerificationMessage pulumi.StringPtrInput
	// String representing the email verification subject. Conflicts with `verificationMessageTemplate` configuration block `emailSubject` argument.
	EmailVerificationSubject pulumi.StringPtrInput
	// Endpoint name of the user pool. Example format: `cognito-idp.REGION.amazonaws.com/xxxx_yyyyy`
	Endpoint pulumi.StringPtrInput
	// Configuration block for the AWS Lambda triggers associated with the user pool. Detailed below.
	LambdaConfig UserPoolLambdaConfigPtrInput
	// Date the user pool was last modified.
	LastModifiedDate pulumi.StringPtrInput
	// Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of `OFF`. Valid values are `OFF` (MFA Tokens are not required), `ON` (MFA is required for all users to sign in; requires at least one of `smsConfiguration` or `softwareTokenMfaConfiguration` to be configured), or `OPTIONAL` (MFA Will be required only for individual users who have MFA Enabled; requires at least one of `smsConfiguration` or `softwareTokenMfaConfiguration` to be configured).
	MfaConfiguration pulumi.StringPtrInput
	// Name of the attribute.
	Name pulumi.StringPtrInput
	// Configuration blocked for information about the user pool password policy. Detailed below.
	PasswordPolicy UserPoolPasswordPolicyPtrInput
	// Configuration block for the schema attributes of a user pool. Detailed below. Schema attributes from the [standard attribute set](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#cognito-user-pools-standard-attributes) only need to be specified if they are different from the default configuration. Attributes can be added, but not modified or removed. Maximum of 50 attributes.
	Schemas UserPoolSchemaArrayInput
	// String representing the SMS authentication message. The Message must contain the `{####}` placeholder, which will be replaced with the code.
	SmsAuthenticationMessage pulumi.StringPtrInput
	// Configuration block for Short Message Service (SMS) settings. Detailed below. These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection.
	SmsConfiguration UserPoolSmsConfigurationPtrInput
	// String representing the SMS verification message. Conflicts with `verificationMessageTemplate` configuration block `smsMessage` argument.
	SmsVerificationMessage pulumi.StringPtrInput
	// Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.
	SoftwareTokenMfaConfiguration UserPoolSoftwareTokenMfaConfigurationPtrInput
	// Map of tags to assign to the User Pool.
	Tags pulumi.StringMapInput
	// Configuration block for user pool add-ons to enable user pool advanced security mode features. Detailed below.
	UserPoolAddOns UserPoolUserPoolAddOnsPtrInput
	// Whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with `aliasAttributes`.
	UsernameAttributes pulumi.StringArrayInput
	// Configuration block for username configuration. Detailed below.
	UsernameConfiguration UserPoolUsernameConfigurationPtrInput
	// Configuration block for verification message templates. Detailed below.
	VerificationMessageTemplate UserPoolVerificationMessageTemplatePtrInput
}

func (UserPoolState) ElementType

func (UserPoolState) ElementType() reflect.Type

type UserPoolUICustomization added in v3.31.0

type UserPoolUICustomization struct {
	pulumi.CustomResourceState

	// The client ID for the client app. Defaults to `ALL`. If `ALL` is specified, the `css` and/or `imageFile` settings will be used for every client that has no UI customization set previously.
	ClientId pulumi.StringPtrOutput `pulumi:"clientId"`
	// The creation date in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) for the UI customization.
	CreationDate pulumi.StringOutput `pulumi:"creationDate"`
	// The CSS values in the UI customization, provided as a String. At least one of `css` or `imageFile` is required.
	Css pulumi.StringPtrOutput `pulumi:"css"`
	// The CSS version number.
	CssVersion pulumi.StringOutput `pulumi:"cssVersion"`
	// The uploaded logo image for the UI customization, provided as a base64-encoded String. Drift detection is not possible for this argument. At least one of `css` or `imageFile` is required.
	ImageFile pulumi.StringPtrOutput `pulumi:"imageFile"`
	// The logo image URL for the UI customization.
	ImageUrl pulumi.StringOutput `pulumi:"imageUrl"`
	// The last-modified date in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) for the UI customization.
	LastModifiedDate pulumi.StringOutput `pulumi:"lastModifiedDate"`
	// The user pool ID for the user pool.
	UserPoolId pulumi.StringOutput `pulumi:"userPoolId"`
}

Provides a Cognito User Pool UI Customization resource.

> **Note:** To use this resource, the user pool must have a domain associated with it. For more information, see the Amazon Cognito Developer Guide on [Customizing the Built-in Sign-In and Sign-up Webpages](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-ui-customization.html).

## Example Usage

## Import

Cognito User Pool UI Customizations can be imported using the `user_pool_id` and `client_id` separated by `,`, e.g.

```sh

$ pulumi import aws:cognito/userPoolUICustomization:UserPoolUICustomization example us-west-2_ZCTarbt5C,12bu4fuk3mlgqa2rtrujgp6egq

```

func GetUserPoolUICustomization added in v3.31.0

func GetUserPoolUICustomization(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *UserPoolUICustomizationState, opts ...pulumi.ResourceOption) (*UserPoolUICustomization, error)

GetUserPoolUICustomization gets an existing UserPoolUICustomization resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewUserPoolUICustomization added in v3.31.0

func NewUserPoolUICustomization(ctx *pulumi.Context,
	name string, args *UserPoolUICustomizationArgs, opts ...pulumi.ResourceOption) (*UserPoolUICustomization, error)

NewUserPoolUICustomization registers a new resource with the given unique name, arguments, and options.

func (*UserPoolUICustomization) ElementType added in v3.31.0

func (*UserPoolUICustomization) ElementType() reflect.Type

func (*UserPoolUICustomization) ToUserPoolUICustomizationOutput added in v3.31.0

func (i *UserPoolUICustomization) ToUserPoolUICustomizationOutput() UserPoolUICustomizationOutput

func (*UserPoolUICustomization) ToUserPoolUICustomizationOutputWithContext added in v3.31.0

func (i *UserPoolUICustomization) ToUserPoolUICustomizationOutputWithContext(ctx context.Context) UserPoolUICustomizationOutput

func (*UserPoolUICustomization) ToUserPoolUICustomizationPtrOutput added in v3.31.0

func (i *UserPoolUICustomization) ToUserPoolUICustomizationPtrOutput() UserPoolUICustomizationPtrOutput

func (*UserPoolUICustomization) ToUserPoolUICustomizationPtrOutputWithContext added in v3.31.0

func (i *UserPoolUICustomization) ToUserPoolUICustomizationPtrOutputWithContext(ctx context.Context) UserPoolUICustomizationPtrOutput

type UserPoolUICustomizationArgs added in v3.31.0

type UserPoolUICustomizationArgs struct {
	// The client ID for the client app. Defaults to `ALL`. If `ALL` is specified, the `css` and/or `imageFile` settings will be used for every client that has no UI customization set previously.
	ClientId pulumi.StringPtrInput
	// The CSS values in the UI customization, provided as a String. At least one of `css` or `imageFile` is required.
	Css pulumi.StringPtrInput
	// The uploaded logo image for the UI customization, provided as a base64-encoded String. Drift detection is not possible for this argument. At least one of `css` or `imageFile` is required.
	ImageFile pulumi.StringPtrInput
	// The user pool ID for the user pool.
	UserPoolId pulumi.StringInput
}

The set of arguments for constructing a UserPoolUICustomization resource.

func (UserPoolUICustomizationArgs) ElementType added in v3.31.0

type UserPoolUICustomizationArray added in v3.31.0

type UserPoolUICustomizationArray []UserPoolUICustomizationInput

func (UserPoolUICustomizationArray) ElementType added in v3.31.0

func (UserPoolUICustomizationArray) ToUserPoolUICustomizationArrayOutput added in v3.31.0

func (i UserPoolUICustomizationArray) ToUserPoolUICustomizationArrayOutput() UserPoolUICustomizationArrayOutput

func (UserPoolUICustomizationArray) ToUserPoolUICustomizationArrayOutputWithContext added in v3.31.0

func (i UserPoolUICustomizationArray) ToUserPoolUICustomizationArrayOutputWithContext(ctx context.Context) UserPoolUICustomizationArrayOutput

type UserPoolUICustomizationArrayInput added in v3.31.0

type UserPoolUICustomizationArrayInput interface {
	pulumi.Input

	ToUserPoolUICustomizationArrayOutput() UserPoolUICustomizationArrayOutput
	ToUserPoolUICustomizationArrayOutputWithContext(context.Context) UserPoolUICustomizationArrayOutput
}

UserPoolUICustomizationArrayInput is an input type that accepts UserPoolUICustomizationArray and UserPoolUICustomizationArrayOutput values. You can construct a concrete instance of `UserPoolUICustomizationArrayInput` via:

UserPoolUICustomizationArray{ UserPoolUICustomizationArgs{...} }

type UserPoolUICustomizationArrayOutput added in v3.31.0

type UserPoolUICustomizationArrayOutput struct{ *pulumi.OutputState }

func (UserPoolUICustomizationArrayOutput) ElementType added in v3.31.0

func (UserPoolUICustomizationArrayOutput) Index added in v3.31.0

func (UserPoolUICustomizationArrayOutput) ToUserPoolUICustomizationArrayOutput added in v3.31.0

func (o UserPoolUICustomizationArrayOutput) ToUserPoolUICustomizationArrayOutput() UserPoolUICustomizationArrayOutput

func (UserPoolUICustomizationArrayOutput) ToUserPoolUICustomizationArrayOutputWithContext added in v3.31.0

func (o UserPoolUICustomizationArrayOutput) ToUserPoolUICustomizationArrayOutputWithContext(ctx context.Context) UserPoolUICustomizationArrayOutput

type UserPoolUICustomizationInput added in v3.31.0

type UserPoolUICustomizationInput interface {
	pulumi.Input

	ToUserPoolUICustomizationOutput() UserPoolUICustomizationOutput
	ToUserPoolUICustomizationOutputWithContext(ctx context.Context) UserPoolUICustomizationOutput
}

type UserPoolUICustomizationMap added in v3.31.0

type UserPoolUICustomizationMap map[string]UserPoolUICustomizationInput

func (UserPoolUICustomizationMap) ElementType added in v3.31.0

func (UserPoolUICustomizationMap) ElementType() reflect.Type

func (UserPoolUICustomizationMap) ToUserPoolUICustomizationMapOutput added in v3.31.0

func (i UserPoolUICustomizationMap) ToUserPoolUICustomizationMapOutput() UserPoolUICustomizationMapOutput

func (UserPoolUICustomizationMap) ToUserPoolUICustomizationMapOutputWithContext added in v3.31.0

func (i UserPoolUICustomizationMap) ToUserPoolUICustomizationMapOutputWithContext(ctx context.Context) UserPoolUICustomizationMapOutput

type UserPoolUICustomizationMapInput added in v3.31.0

type UserPoolUICustomizationMapInput interface {
	pulumi.Input

	ToUserPoolUICustomizationMapOutput() UserPoolUICustomizationMapOutput
	ToUserPoolUICustomizationMapOutputWithContext(context.Context) UserPoolUICustomizationMapOutput
}

UserPoolUICustomizationMapInput is an input type that accepts UserPoolUICustomizationMap and UserPoolUICustomizationMapOutput values. You can construct a concrete instance of `UserPoolUICustomizationMapInput` via:

UserPoolUICustomizationMap{ "key": UserPoolUICustomizationArgs{...} }

type UserPoolUICustomizationMapOutput added in v3.31.0

type UserPoolUICustomizationMapOutput struct{ *pulumi.OutputState }

func (UserPoolUICustomizationMapOutput) ElementType added in v3.31.0

func (UserPoolUICustomizationMapOutput) MapIndex added in v3.31.0

func (UserPoolUICustomizationMapOutput) ToUserPoolUICustomizationMapOutput added in v3.31.0

func (o UserPoolUICustomizationMapOutput) ToUserPoolUICustomizationMapOutput() UserPoolUICustomizationMapOutput

func (UserPoolUICustomizationMapOutput) ToUserPoolUICustomizationMapOutputWithContext added in v3.31.0

func (o UserPoolUICustomizationMapOutput) ToUserPoolUICustomizationMapOutputWithContext(ctx context.Context) UserPoolUICustomizationMapOutput

type UserPoolUICustomizationOutput added in v3.31.0

type UserPoolUICustomizationOutput struct {
	*pulumi.OutputState
}

func (UserPoolUICustomizationOutput) ElementType added in v3.31.0

func (UserPoolUICustomizationOutput) ToUserPoolUICustomizationOutput added in v3.31.0

func (o UserPoolUICustomizationOutput) ToUserPoolUICustomizationOutput() UserPoolUICustomizationOutput

func (UserPoolUICustomizationOutput) ToUserPoolUICustomizationOutputWithContext added in v3.31.0

func (o UserPoolUICustomizationOutput) ToUserPoolUICustomizationOutputWithContext(ctx context.Context) UserPoolUICustomizationOutput

func (UserPoolUICustomizationOutput) ToUserPoolUICustomizationPtrOutput added in v3.31.0

func (o UserPoolUICustomizationOutput) ToUserPoolUICustomizationPtrOutput() UserPoolUICustomizationPtrOutput

func (UserPoolUICustomizationOutput) ToUserPoolUICustomizationPtrOutputWithContext added in v3.31.0

func (o UserPoolUICustomizationOutput) ToUserPoolUICustomizationPtrOutputWithContext(ctx context.Context) UserPoolUICustomizationPtrOutput

type UserPoolUICustomizationPtrInput added in v3.31.0

type UserPoolUICustomizationPtrInput interface {
	pulumi.Input

	ToUserPoolUICustomizationPtrOutput() UserPoolUICustomizationPtrOutput
	ToUserPoolUICustomizationPtrOutputWithContext(ctx context.Context) UserPoolUICustomizationPtrOutput
}

type UserPoolUICustomizationPtrOutput added in v3.31.0

type UserPoolUICustomizationPtrOutput struct {
	*pulumi.OutputState
}

func (UserPoolUICustomizationPtrOutput) ElementType added in v3.31.0

func (UserPoolUICustomizationPtrOutput) ToUserPoolUICustomizationPtrOutput added in v3.31.0

func (o UserPoolUICustomizationPtrOutput) ToUserPoolUICustomizationPtrOutput() UserPoolUICustomizationPtrOutput

func (UserPoolUICustomizationPtrOutput) ToUserPoolUICustomizationPtrOutputWithContext added in v3.31.0

func (o UserPoolUICustomizationPtrOutput) ToUserPoolUICustomizationPtrOutputWithContext(ctx context.Context) UserPoolUICustomizationPtrOutput

type UserPoolUICustomizationState added in v3.31.0

type UserPoolUICustomizationState struct {
	// The client ID for the client app. Defaults to `ALL`. If `ALL` is specified, the `css` and/or `imageFile` settings will be used for every client that has no UI customization set previously.
	ClientId pulumi.StringPtrInput
	// The creation date in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) for the UI customization.
	CreationDate pulumi.StringPtrInput
	// The CSS values in the UI customization, provided as a String. At least one of `css` or `imageFile` is required.
	Css pulumi.StringPtrInput
	// The CSS version number.
	CssVersion pulumi.StringPtrInput
	// The uploaded logo image for the UI customization, provided as a base64-encoded String. Drift detection is not possible for this argument. At least one of `css` or `imageFile` is required.
	ImageFile pulumi.StringPtrInput
	// The logo image URL for the UI customization.
	ImageUrl pulumi.StringPtrInput
	// The last-modified date in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) for the UI customization.
	LastModifiedDate pulumi.StringPtrInput
	// The user pool ID for the user pool.
	UserPoolId pulumi.StringPtrInput
}

func (UserPoolUICustomizationState) ElementType added in v3.31.0

type UserPoolUserPoolAddOns

type UserPoolUserPoolAddOns struct {
	// Mode for advanced security, must be one of `OFF`, `AUDIT` or `ENFORCED`.
	AdvancedSecurityMode string `pulumi:"advancedSecurityMode"`
}

type UserPoolUserPoolAddOnsArgs

type UserPoolUserPoolAddOnsArgs struct {
	// Mode for advanced security, must be one of `OFF`, `AUDIT` or `ENFORCED`.
	AdvancedSecurityMode pulumi.StringInput `pulumi:"advancedSecurityMode"`
}

func (UserPoolUserPoolAddOnsArgs) ElementType

func (UserPoolUserPoolAddOnsArgs) ElementType() reflect.Type

func (UserPoolUserPoolAddOnsArgs) ToUserPoolUserPoolAddOnsOutput

func (i UserPoolUserPoolAddOnsArgs) ToUserPoolUserPoolAddOnsOutput() UserPoolUserPoolAddOnsOutput

func (UserPoolUserPoolAddOnsArgs) ToUserPoolUserPoolAddOnsOutputWithContext

func (i UserPoolUserPoolAddOnsArgs) ToUserPoolUserPoolAddOnsOutputWithContext(ctx context.Context) UserPoolUserPoolAddOnsOutput

func (UserPoolUserPoolAddOnsArgs) ToUserPoolUserPoolAddOnsPtrOutput

func (i UserPoolUserPoolAddOnsArgs) ToUserPoolUserPoolAddOnsPtrOutput() UserPoolUserPoolAddOnsPtrOutput

func (UserPoolUserPoolAddOnsArgs) ToUserPoolUserPoolAddOnsPtrOutputWithContext

func (i UserPoolUserPoolAddOnsArgs) ToUserPoolUserPoolAddOnsPtrOutputWithContext(ctx context.Context) UserPoolUserPoolAddOnsPtrOutput

type UserPoolUserPoolAddOnsInput

type UserPoolUserPoolAddOnsInput interface {
	pulumi.Input

	ToUserPoolUserPoolAddOnsOutput() UserPoolUserPoolAddOnsOutput
	ToUserPoolUserPoolAddOnsOutputWithContext(context.Context) UserPoolUserPoolAddOnsOutput
}

UserPoolUserPoolAddOnsInput is an input type that accepts UserPoolUserPoolAddOnsArgs and UserPoolUserPoolAddOnsOutput values. You can construct a concrete instance of `UserPoolUserPoolAddOnsInput` via:

UserPoolUserPoolAddOnsArgs{...}

type UserPoolUserPoolAddOnsOutput

type UserPoolUserPoolAddOnsOutput struct{ *pulumi.OutputState }

func (UserPoolUserPoolAddOnsOutput) AdvancedSecurityMode

func (o UserPoolUserPoolAddOnsOutput) AdvancedSecurityMode() pulumi.StringOutput

Mode for advanced security, must be one of `OFF`, `AUDIT` or `ENFORCED`.

func (UserPoolUserPoolAddOnsOutput) ElementType

func (UserPoolUserPoolAddOnsOutput) ToUserPoolUserPoolAddOnsOutput

func (o UserPoolUserPoolAddOnsOutput) ToUserPoolUserPoolAddOnsOutput() UserPoolUserPoolAddOnsOutput

func (UserPoolUserPoolAddOnsOutput) ToUserPoolUserPoolAddOnsOutputWithContext

func (o UserPoolUserPoolAddOnsOutput) ToUserPoolUserPoolAddOnsOutputWithContext(ctx context.Context) UserPoolUserPoolAddOnsOutput

func (UserPoolUserPoolAddOnsOutput) ToUserPoolUserPoolAddOnsPtrOutput

func (o UserPoolUserPoolAddOnsOutput) ToUserPoolUserPoolAddOnsPtrOutput() UserPoolUserPoolAddOnsPtrOutput

func (UserPoolUserPoolAddOnsOutput) ToUserPoolUserPoolAddOnsPtrOutputWithContext

func (o UserPoolUserPoolAddOnsOutput) ToUserPoolUserPoolAddOnsPtrOutputWithContext(ctx context.Context) UserPoolUserPoolAddOnsPtrOutput

type UserPoolUserPoolAddOnsPtrInput

type UserPoolUserPoolAddOnsPtrInput interface {
	pulumi.Input

	ToUserPoolUserPoolAddOnsPtrOutput() UserPoolUserPoolAddOnsPtrOutput
	ToUserPoolUserPoolAddOnsPtrOutputWithContext(context.Context) UserPoolUserPoolAddOnsPtrOutput
}

UserPoolUserPoolAddOnsPtrInput is an input type that accepts UserPoolUserPoolAddOnsArgs, UserPoolUserPoolAddOnsPtr and UserPoolUserPoolAddOnsPtrOutput values. You can construct a concrete instance of `UserPoolUserPoolAddOnsPtrInput` via:

        UserPoolUserPoolAddOnsArgs{...}

or:

        nil

type UserPoolUserPoolAddOnsPtrOutput

type UserPoolUserPoolAddOnsPtrOutput struct{ *pulumi.OutputState }

func (UserPoolUserPoolAddOnsPtrOutput) AdvancedSecurityMode

func (o UserPoolUserPoolAddOnsPtrOutput) AdvancedSecurityMode() pulumi.StringPtrOutput

Mode for advanced security, must be one of `OFF`, `AUDIT` or `ENFORCED`.

func (UserPoolUserPoolAddOnsPtrOutput) Elem

func (UserPoolUserPoolAddOnsPtrOutput) ElementType

func (UserPoolUserPoolAddOnsPtrOutput) ToUserPoolUserPoolAddOnsPtrOutput

func (o UserPoolUserPoolAddOnsPtrOutput) ToUserPoolUserPoolAddOnsPtrOutput() UserPoolUserPoolAddOnsPtrOutput

func (UserPoolUserPoolAddOnsPtrOutput) ToUserPoolUserPoolAddOnsPtrOutputWithContext

func (o UserPoolUserPoolAddOnsPtrOutput) ToUserPoolUserPoolAddOnsPtrOutputWithContext(ctx context.Context) UserPoolUserPoolAddOnsPtrOutput

type UserPoolUsernameConfiguration

type UserPoolUsernameConfiguration struct {
	// Whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.
	CaseSensitive bool `pulumi:"caseSensitive"`
}

type UserPoolUsernameConfigurationArgs

type UserPoolUsernameConfigurationArgs struct {
	// Whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.
	CaseSensitive pulumi.BoolInput `pulumi:"caseSensitive"`
}

func (UserPoolUsernameConfigurationArgs) ElementType

func (UserPoolUsernameConfigurationArgs) ToUserPoolUsernameConfigurationOutput

func (i UserPoolUsernameConfigurationArgs) ToUserPoolUsernameConfigurationOutput() UserPoolUsernameConfigurationOutput

func (UserPoolUsernameConfigurationArgs) ToUserPoolUsernameConfigurationOutputWithContext

func (i UserPoolUsernameConfigurationArgs) ToUserPoolUsernameConfigurationOutputWithContext(ctx context.Context) UserPoolUsernameConfigurationOutput

func (UserPoolUsernameConfigurationArgs) ToUserPoolUsernameConfigurationPtrOutput

func (i UserPoolUsernameConfigurationArgs) ToUserPoolUsernameConfigurationPtrOutput() UserPoolUsernameConfigurationPtrOutput

func (UserPoolUsernameConfigurationArgs) ToUserPoolUsernameConfigurationPtrOutputWithContext

func (i UserPoolUsernameConfigurationArgs) ToUserPoolUsernameConfigurationPtrOutputWithContext(ctx context.Context) UserPoolUsernameConfigurationPtrOutput

type UserPoolUsernameConfigurationInput

type UserPoolUsernameConfigurationInput interface {
	pulumi.Input

	ToUserPoolUsernameConfigurationOutput() UserPoolUsernameConfigurationOutput
	ToUserPoolUsernameConfigurationOutputWithContext(context.Context) UserPoolUsernameConfigurationOutput
}

UserPoolUsernameConfigurationInput is an input type that accepts UserPoolUsernameConfigurationArgs and UserPoolUsernameConfigurationOutput values. You can construct a concrete instance of `UserPoolUsernameConfigurationInput` via:

UserPoolUsernameConfigurationArgs{...}

type UserPoolUsernameConfigurationOutput

type UserPoolUsernameConfigurationOutput struct{ *pulumi.OutputState }

func (UserPoolUsernameConfigurationOutput) CaseSensitive

Whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.

func (UserPoolUsernameConfigurationOutput) ElementType

func (UserPoolUsernameConfigurationOutput) ToUserPoolUsernameConfigurationOutput

func (o UserPoolUsernameConfigurationOutput) ToUserPoolUsernameConfigurationOutput() UserPoolUsernameConfigurationOutput

func (UserPoolUsernameConfigurationOutput) ToUserPoolUsernameConfigurationOutputWithContext

func (o UserPoolUsernameConfigurationOutput) ToUserPoolUsernameConfigurationOutputWithContext(ctx context.Context) UserPoolUsernameConfigurationOutput

func (UserPoolUsernameConfigurationOutput) ToUserPoolUsernameConfigurationPtrOutput

func (o UserPoolUsernameConfigurationOutput) ToUserPoolUsernameConfigurationPtrOutput() UserPoolUsernameConfigurationPtrOutput

func (UserPoolUsernameConfigurationOutput) ToUserPoolUsernameConfigurationPtrOutputWithContext

func (o UserPoolUsernameConfigurationOutput) ToUserPoolUsernameConfigurationPtrOutputWithContext(ctx context.Context) UserPoolUsernameConfigurationPtrOutput

type UserPoolUsernameConfigurationPtrInput

type UserPoolUsernameConfigurationPtrInput interface {
	pulumi.Input

	ToUserPoolUsernameConfigurationPtrOutput() UserPoolUsernameConfigurationPtrOutput
	ToUserPoolUsernameConfigurationPtrOutputWithContext(context.Context) UserPoolUsernameConfigurationPtrOutput
}

UserPoolUsernameConfigurationPtrInput is an input type that accepts UserPoolUsernameConfigurationArgs, UserPoolUsernameConfigurationPtr and UserPoolUsernameConfigurationPtrOutput values. You can construct a concrete instance of `UserPoolUsernameConfigurationPtrInput` via:

        UserPoolUsernameConfigurationArgs{...}

or:

        nil

type UserPoolUsernameConfigurationPtrOutput

type UserPoolUsernameConfigurationPtrOutput struct{ *pulumi.OutputState }

func (UserPoolUsernameConfigurationPtrOutput) CaseSensitive

Whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.

func (UserPoolUsernameConfigurationPtrOutput) Elem

func (UserPoolUsernameConfigurationPtrOutput) ElementType

func (UserPoolUsernameConfigurationPtrOutput) ToUserPoolUsernameConfigurationPtrOutput

func (o UserPoolUsernameConfigurationPtrOutput) ToUserPoolUsernameConfigurationPtrOutput() UserPoolUsernameConfigurationPtrOutput

func (UserPoolUsernameConfigurationPtrOutput) ToUserPoolUsernameConfigurationPtrOutputWithContext

func (o UserPoolUsernameConfigurationPtrOutput) ToUserPoolUsernameConfigurationPtrOutputWithContext(ctx context.Context) UserPoolUsernameConfigurationPtrOutput

type UserPoolVerificationMessageTemplate

type UserPoolVerificationMessageTemplate struct {
	// Default email option. Must be either `CONFIRM_WITH_CODE` or `CONFIRM_WITH_LINK`. Defaults to `CONFIRM_WITH_CODE`.
	DefaultEmailOption *string `pulumi:"defaultEmailOption"`
	// Email message template. Must contain the `{####}` placeholder. Conflicts with `emailVerificationMessage` argument.
	EmailMessage *string `pulumi:"emailMessage"`
	// Email message template for sending a confirmation link to the user, it must contain the `{##Click Here##}` placeholder.
	EmailMessageByLink *string `pulumi:"emailMessageByLink"`
	// Subject line for the email message template. Conflicts with `emailVerificationSubject` argument.
	EmailSubject *string `pulumi:"emailSubject"`
	// Subject line for the email message template for sending a confirmation link to the user.
	EmailSubjectByLink *string `pulumi:"emailSubjectByLink"`
	// SMS message template. Must contain the `{####}` placeholder. Conflicts with `smsVerificationMessage` argument.
	SmsMessage *string `pulumi:"smsMessage"`
}

type UserPoolVerificationMessageTemplateArgs

type UserPoolVerificationMessageTemplateArgs struct {
	// Default email option. Must be either `CONFIRM_WITH_CODE` or `CONFIRM_WITH_LINK`. Defaults to `CONFIRM_WITH_CODE`.
	DefaultEmailOption pulumi.StringPtrInput `pulumi:"defaultEmailOption"`
	// Email message template. Must contain the `{####}` placeholder. Conflicts with `emailVerificationMessage` argument.
	EmailMessage pulumi.StringPtrInput `pulumi:"emailMessage"`
	// Email message template for sending a confirmation link to the user, it must contain the `{##Click Here##}` placeholder.
	EmailMessageByLink pulumi.StringPtrInput `pulumi:"emailMessageByLink"`
	// Subject line for the email message template. Conflicts with `emailVerificationSubject` argument.
	EmailSubject pulumi.StringPtrInput `pulumi:"emailSubject"`
	// Subject line for the email message template for sending a confirmation link to the user.
	EmailSubjectByLink pulumi.StringPtrInput `pulumi:"emailSubjectByLink"`
	// SMS message template. Must contain the `{####}` placeholder. Conflicts with `smsVerificationMessage` argument.
	SmsMessage pulumi.StringPtrInput `pulumi:"smsMessage"`
}

func (UserPoolVerificationMessageTemplateArgs) ElementType

func (UserPoolVerificationMessageTemplateArgs) ToUserPoolVerificationMessageTemplateOutput

func (i UserPoolVerificationMessageTemplateArgs) ToUserPoolVerificationMessageTemplateOutput() UserPoolVerificationMessageTemplateOutput

func (UserPoolVerificationMessageTemplateArgs) ToUserPoolVerificationMessageTemplateOutputWithContext

func (i UserPoolVerificationMessageTemplateArgs) ToUserPoolVerificationMessageTemplateOutputWithContext(ctx context.Context) UserPoolVerificationMessageTemplateOutput

func (UserPoolVerificationMessageTemplateArgs) ToUserPoolVerificationMessageTemplatePtrOutput

func (i UserPoolVerificationMessageTemplateArgs) ToUserPoolVerificationMessageTemplatePtrOutput() UserPoolVerificationMessageTemplatePtrOutput

func (UserPoolVerificationMessageTemplateArgs) ToUserPoolVerificationMessageTemplatePtrOutputWithContext

func (i UserPoolVerificationMessageTemplateArgs) ToUserPoolVerificationMessageTemplatePtrOutputWithContext(ctx context.Context) UserPoolVerificationMessageTemplatePtrOutput

type UserPoolVerificationMessageTemplateInput

type UserPoolVerificationMessageTemplateInput interface {
	pulumi.Input

	ToUserPoolVerificationMessageTemplateOutput() UserPoolVerificationMessageTemplateOutput
	ToUserPoolVerificationMessageTemplateOutputWithContext(context.Context) UserPoolVerificationMessageTemplateOutput
}

UserPoolVerificationMessageTemplateInput is an input type that accepts UserPoolVerificationMessageTemplateArgs and UserPoolVerificationMessageTemplateOutput values. You can construct a concrete instance of `UserPoolVerificationMessageTemplateInput` via:

UserPoolVerificationMessageTemplateArgs{...}

type UserPoolVerificationMessageTemplateOutput

type UserPoolVerificationMessageTemplateOutput struct{ *pulumi.OutputState }

func (UserPoolVerificationMessageTemplateOutput) DefaultEmailOption

Default email option. Must be either `CONFIRM_WITH_CODE` or `CONFIRM_WITH_LINK`. Defaults to `CONFIRM_WITH_CODE`.

func (UserPoolVerificationMessageTemplateOutput) ElementType

func (UserPoolVerificationMessageTemplateOutput) EmailMessage

Email message template. Must contain the `{####}` placeholder. Conflicts with `emailVerificationMessage` argument.

Email message template for sending a confirmation link to the user, it must contain the `{##Click Here##}` placeholder.

func (UserPoolVerificationMessageTemplateOutput) EmailSubject

Subject line for the email message template. Conflicts with `emailVerificationSubject` argument.

Subject line for the email message template for sending a confirmation link to the user.

func (UserPoolVerificationMessageTemplateOutput) SmsMessage

SMS message template. Must contain the `{####}` placeholder. Conflicts with `smsVerificationMessage` argument.

func (UserPoolVerificationMessageTemplateOutput) ToUserPoolVerificationMessageTemplateOutput

func (o UserPoolVerificationMessageTemplateOutput) ToUserPoolVerificationMessageTemplateOutput() UserPoolVerificationMessageTemplateOutput

func (UserPoolVerificationMessageTemplateOutput) ToUserPoolVerificationMessageTemplateOutputWithContext

func (o UserPoolVerificationMessageTemplateOutput) ToUserPoolVerificationMessageTemplateOutputWithContext(ctx context.Context) UserPoolVerificationMessageTemplateOutput

func (UserPoolVerificationMessageTemplateOutput) ToUserPoolVerificationMessageTemplatePtrOutput

func (o UserPoolVerificationMessageTemplateOutput) ToUserPoolVerificationMessageTemplatePtrOutput() UserPoolVerificationMessageTemplatePtrOutput

func (UserPoolVerificationMessageTemplateOutput) ToUserPoolVerificationMessageTemplatePtrOutputWithContext

func (o UserPoolVerificationMessageTemplateOutput) ToUserPoolVerificationMessageTemplatePtrOutputWithContext(ctx context.Context) UserPoolVerificationMessageTemplatePtrOutput

type UserPoolVerificationMessageTemplatePtrInput

type UserPoolVerificationMessageTemplatePtrInput interface {
	pulumi.Input

	ToUserPoolVerificationMessageTemplatePtrOutput() UserPoolVerificationMessageTemplatePtrOutput
	ToUserPoolVerificationMessageTemplatePtrOutputWithContext(context.Context) UserPoolVerificationMessageTemplatePtrOutput
}

UserPoolVerificationMessageTemplatePtrInput is an input type that accepts UserPoolVerificationMessageTemplateArgs, UserPoolVerificationMessageTemplatePtr and UserPoolVerificationMessageTemplatePtrOutput values. You can construct a concrete instance of `UserPoolVerificationMessageTemplatePtrInput` via:

        UserPoolVerificationMessageTemplateArgs{...}

or:

        nil

type UserPoolVerificationMessageTemplatePtrOutput

type UserPoolVerificationMessageTemplatePtrOutput struct{ *pulumi.OutputState }

func (UserPoolVerificationMessageTemplatePtrOutput) DefaultEmailOption

Default email option. Must be either `CONFIRM_WITH_CODE` or `CONFIRM_WITH_LINK`. Defaults to `CONFIRM_WITH_CODE`.

func (UserPoolVerificationMessageTemplatePtrOutput) Elem

func (UserPoolVerificationMessageTemplatePtrOutput) ElementType

func (UserPoolVerificationMessageTemplatePtrOutput) EmailMessage

Email message template. Must contain the `{####}` placeholder. Conflicts with `emailVerificationMessage` argument.

Email message template for sending a confirmation link to the user, it must contain the `{##Click Here##}` placeholder.

func (UserPoolVerificationMessageTemplatePtrOutput) EmailSubject

Subject line for the email message template. Conflicts with `emailVerificationSubject` argument.

Subject line for the email message template for sending a confirmation link to the user.

func (UserPoolVerificationMessageTemplatePtrOutput) SmsMessage

SMS message template. Must contain the `{####}` placeholder. Conflicts with `smsVerificationMessage` argument.

func (UserPoolVerificationMessageTemplatePtrOutput) ToUserPoolVerificationMessageTemplatePtrOutput

func (o UserPoolVerificationMessageTemplatePtrOutput) ToUserPoolVerificationMessageTemplatePtrOutput() UserPoolVerificationMessageTemplatePtrOutput

func (UserPoolVerificationMessageTemplatePtrOutput) ToUserPoolVerificationMessageTemplatePtrOutputWithContext

func (o UserPoolVerificationMessageTemplatePtrOutput) ToUserPoolVerificationMessageTemplatePtrOutputWithContext(ctx context.Context) UserPoolVerificationMessageTemplatePtrOutput

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL