cognito

package
v0.18.1 Latest Latest
Warning

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

 Go to latest Published: Apr 5, 2019 License: Apache-2.0 Imports: 2 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 interface{}
}

A collection of arguments for invoking getUserPools.

type GetUserPoolsResult 

type GetUserPoolsResult struct {
	Arns interface{}
	// The list of cognito user pool ids.
	Ids interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getUserPools.

func LookupUserPools 

func LookupUserPools(ctx *pulumi.Context, args *GetUserPoolsArgs) (*GetUserPoolsResult, error)

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

type IdentityPool 

type IdentityPool struct {
	// contains filtered or unexported fields
}

Provides an AWS Cognito Identity Pool.

func GetIdentityPool 

func GetIdentityPool(ctx *pulumi.Context,
	name string, id pulumi.ID, state *IdentityPoolState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*IdentityPool, error)

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

func (*IdentityPool) AllowUnauthenticatedIdentities 

func (r *IdentityPool) AllowUnauthenticatedIdentities() *pulumi.BoolOutput

Whether the identity pool supports unauthenticated logins or not.

func (*IdentityPool) Arn 

func (r *IdentityPool) Arn() *pulumi.StringOutput

The ARN of the identity pool.

func (*IdentityPool) CognitoIdentityProviders 

func (r *IdentityPool) CognitoIdentityProviders() *pulumi.ArrayOutput

An array of Amazon Cognito Identity user pools and their client IDs.

func (*IdentityPool) DeveloperProviderName 

func (r *IdentityPool) DeveloperProviderName() *pulumi.StringOutput

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.

func (*IdentityPool) ID 

func (r *IdentityPool) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*IdentityPool) IdentityPoolName 

func (r *IdentityPool) IdentityPoolName() *pulumi.StringOutput

The Cognito Identity Pool name.

func (*IdentityPool) OpenidConnectProviderArns 

func (r *IdentityPool) OpenidConnectProviderArns() *pulumi.ArrayOutput

A list of OpendID Connect provider ARNs.

func (*IdentityPool) SamlProviderArns 

func (r *IdentityPool) SamlProviderArns() *pulumi.ArrayOutput

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity.

func (*IdentityPool) SupportedLoginProviders 

func (r *IdentityPool) SupportedLoginProviders() *pulumi.MapOutput

Key-Value pairs mapping provider names to provider app IDs.

func (*IdentityPool) URN 

func (r *IdentityPool) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type IdentityPoolArgs 

type IdentityPoolArgs struct {
	// Whether the identity pool supports unauthenticated logins or not.
	AllowUnauthenticatedIdentities interface{}
	// An array of Amazon Cognito Identity user pools and their client IDs.
	CognitoIdentityProviders interface{}
	// 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 interface{}
	// The Cognito Identity Pool name.
	IdentityPoolName interface{}
	// A list of OpendID Connect provider ARNs.
	OpenidConnectProviderArns interface{}
	// An array of Amazon Resource Names (ARNs) of the SAML provider for your identity.
	SamlProviderArns interface{}
	// Key-Value pairs mapping provider names to provider app IDs.
	SupportedLoginProviders interface{}
}

The set of arguments for constructing a IdentityPool resource.

type IdentityPoolRoleAttachment 

type IdentityPoolRoleAttachment struct {
	// contains filtered or unexported fields
}

Provides an AWS Cognito Identity Pool Roles Attachment.

func GetIdentityPoolRoleAttachment 

func GetIdentityPoolRoleAttachment(ctx *pulumi.Context,
	name string, id pulumi.ID, state *IdentityPoolRoleAttachmentState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*IdentityPoolRoleAttachment, error)

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

func (*IdentityPoolRoleAttachment) ID 

func (r *IdentityPoolRoleAttachment) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*IdentityPoolRoleAttachment) IdentityPoolId 

func (r *IdentityPoolRoleAttachment) IdentityPoolId() *pulumi.StringOutput

An identity pool ID in the format REGION:GUID.

func (*IdentityPoolRoleAttachment) RoleMappings 

func (r *IdentityPoolRoleAttachment) RoleMappings() *pulumi.ArrayOutput

A List of Role Mapping.

func (*IdentityPoolRoleAttachment) Roles 

func (r *IdentityPoolRoleAttachment) Roles() *pulumi.Output

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.

func (*IdentityPoolRoleAttachment) URN 

func (r *IdentityPoolRoleAttachment) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type IdentityPoolRoleAttachmentArgs 

type IdentityPoolRoleAttachmentArgs struct {
	// An identity pool ID in the format REGION:GUID.
	IdentityPoolId interface{}
	// A List of Role Mapping.
	RoleMappings interface{}
	// 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 interface{}
}

The set of arguments for constructing a IdentityPoolRoleAttachment resource.

type IdentityPoolRoleAttachmentState 

type IdentityPoolRoleAttachmentState struct {
	// An identity pool ID in the format REGION:GUID.
	IdentityPoolId interface{}
	// A List of Role Mapping.
	RoleMappings interface{}
	// 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 interface{}
}

Input properties used for looking up and filtering IdentityPoolRoleAttachment resources.

type IdentityPoolState 

type IdentityPoolState struct {
	// Whether the identity pool supports unauthenticated logins or not.
	AllowUnauthenticatedIdentities interface{}
	// The ARN of the identity pool.
	Arn interface{}
	// An array of Amazon Cognito Identity user pools and their client IDs.
	CognitoIdentityProviders interface{}
	// 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 interface{}
	// The Cognito Identity Pool name.
	IdentityPoolName interface{}
	// A list of OpendID Connect provider ARNs.
	OpenidConnectProviderArns interface{}
	// An array of Amazon Resource Names (ARNs) of the SAML provider for your identity.
	SamlProviderArns interface{}
	// Key-Value pairs mapping provider names to provider app IDs.
	SupportedLoginProviders interface{}
}

Input properties used for looking up and filtering IdentityPool resources.

type IdentityProvider 

type IdentityProvider struct {
	// contains filtered or unexported fields
}

Provides a Cognito User Identity Provider resource.

func GetIdentityProvider 

func GetIdentityProvider(ctx *pulumi.Context,
	name string, id pulumi.ID, state *IdentityProviderState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*IdentityProvider, error)

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

func (*IdentityProvider) AttributeMapping 

func (r *IdentityProvider) AttributeMapping() *pulumi.MapOutput

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)

func (*IdentityProvider) ID 

func (r *IdentityProvider) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*IdentityProvider) IdpIdentifiers 

func (r *IdentityProvider) IdpIdentifiers() *pulumi.ArrayOutput

The list of identity providers.

func (*IdentityProvider) ProviderDetails 

func (r *IdentityProvider) ProviderDetails() *pulumi.MapOutput

The map of identity details, such as access token

func (*IdentityProvider) ProviderName 

func (r *IdentityProvider) ProviderName() *pulumi.StringOutput

The provider name

func (*IdentityProvider) ProviderType 

func (r *IdentityProvider) ProviderType() *pulumi.StringOutput

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)

func (*IdentityProvider) URN 

func (r *IdentityProvider) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*IdentityProvider) UserPoolId 

func (r *IdentityProvider) UserPoolId() *pulumi.StringOutput

The user pool id

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 interface{}
	// The list of identity providers.
	IdpIdentifiers interface{}
	// The map of identity details, such as access token
	ProviderDetails interface{}
	// The provider name
	ProviderName interface{}
	// 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 interface{}
	// The user pool id
	UserPoolId interface{}
}

The set of arguments for constructing a IdentityProvider resource.

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 interface{}
	// The list of identity providers.
	IdpIdentifiers interface{}
	// The map of identity details, such as access token
	ProviderDetails interface{}
	// The provider name
	ProviderName interface{}
	// 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 interface{}
	// The user pool id
	UserPoolId interface{}
}

Input properties used for looking up and filtering IdentityProvider resources.

type ResourceServer 

type ResourceServer struct {
	// contains filtered or unexported fields
}

Provides a Cognito Resource Server.

func GetResourceServer 

func GetResourceServer(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ResourceServerState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*ResourceServer, error)

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

func (*ResourceServer) ID 

func (r *ResourceServer) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*ResourceServer) Identifier 

func (r *ResourceServer) Identifier() *pulumi.StringOutput

An identifier for the resource server.

func (*ResourceServer) Name 

func (r *ResourceServer) Name() *pulumi.StringOutput

A name for the resource server.

func (*ResourceServer) ScopeIdentifiers 

func (r *ResourceServer) ScopeIdentifiers() *pulumi.ArrayOutput

A list of all scopes configured for this resource server in the format identifier/scope_name.

func (*ResourceServer) Scopes 

func (r *ResourceServer) Scopes() *pulumi.ArrayOutput

A list of Authorization Scope.

func (*ResourceServer) URN 

func (r *ResourceServer) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*ResourceServer) UserPoolId 

func (r *ResourceServer) UserPoolId() *pulumi.StringOutput

type ResourceServerArgs 

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

The set of arguments for constructing a ResourceServer resource.

type ResourceServerState 

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

Input properties used for looking up and filtering ResourceServer resources.

type UserGroup 

type UserGroup struct {
	// contains filtered or unexported fields
}

Provides a Cognito User Group resource.

func GetUserGroup 

func GetUserGroup(ctx *pulumi.Context,
	name string, id pulumi.ID, state *UserGroupState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*UserGroup, error)

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

func (*UserGroup) Description 

func (r *UserGroup) Description() *pulumi.StringOutput

The description of the user group.

func (*UserGroup) ID 

func (r *UserGroup) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*UserGroup) Name 

func (r *UserGroup) Name() *pulumi.StringOutput

The name of the user group.

func (*UserGroup) Precedence 

func (r *UserGroup) Precedence() *pulumi.IntOutput

The precedence of the user group.

func (*UserGroup) RoleArn 

func (r *UserGroup) RoleArn() *pulumi.StringOutput

The ARN of the IAM role to be associated with the user group.

func (*UserGroup) URN 

func (r *UserGroup) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*UserGroup) UserPoolId 

func (r *UserGroup) UserPoolId() *pulumi.StringOutput

The user pool ID.

type UserGroupArgs 

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

The set of arguments for constructing a UserGroup resource.

type UserGroupState 

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

Input properties used for looking up and filtering UserGroup resources.

type UserPool 

type UserPool struct {
	// contains filtered or unexported fields
}

Provides a Cognito User Pool resource.

func GetUserPool 

func GetUserPool(ctx *pulumi.Context,
	name string, id pulumi.ID, state *UserPoolState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*UserPool, error)

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

func (*UserPool) AdminCreateUserConfig 

func (r *UserPool) AdminCreateUserConfig() *pulumi.Output

The configuration for AdminCreateUser requests.

func (*UserPool) AliasAttributes 

func (r *UserPool) AliasAttributes() *pulumi.ArrayOutput

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username. Conflicts with `username_attributes`.

func (*UserPool) Arn 

func (r *UserPool) Arn() *pulumi.StringOutput

The ARN of the user pool.

func (*UserPool) AutoVerifiedAttributes 

func (r *UserPool) AutoVerifiedAttributes() *pulumi.ArrayOutput

The attributes to be auto-verified. Possible values: email, phone_number.

func (*UserPool) CreationDate 

func (r *UserPool) CreationDate() *pulumi.StringOutput

The date the user pool was created.

func (*UserPool) DeviceConfiguration 

func (r *UserPool) DeviceConfiguration() *pulumi.Output

The configuration for the user pool's device tracking.

func (*UserPool) EmailConfiguration 

func (r *UserPool) EmailConfiguration() *pulumi.Output

The Email Configuration.

func (*UserPool) EmailVerificationMessage 

func (r *UserPool) EmailVerificationMessage() *pulumi.StringOutput

A string representing the email verification message. Conflicts with `verification_message_template` configuration block `email_message` argument.

func (*UserPool) EmailVerificationSubject 

func (r *UserPool) EmailVerificationSubject() *pulumi.StringOutput

A string representing the email verification subject. Conflicts with `verification_message_template` configuration block `email_subject` argument.

func (*UserPool) Endpoint 

func (r *UserPool) Endpoint() *pulumi.StringOutput

The endpoint name of the user pool. Example format: cognito-idp.REGION.amazonaws.com/xxxx_yyyyy

func (*UserPool) ID 

func (r *UserPool) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*UserPool) LambdaConfig 

func (r *UserPool) LambdaConfig() *pulumi.Output

A container for the AWS Lambda triggers associated with the user pool.

func (*UserPool) LastModifiedDate 

func (r *UserPool) LastModifiedDate() *pulumi.StringOutput

The date the user pool was last modified.

func (*UserPool) MfaConfiguration 

func (r *UserPool) MfaConfiguration() *pulumi.StringOutput

Set to enable multi-factor authentication. Must be one of the following values (ON, OFF, OPTIONAL)

func (*UserPool) Name 

func (r *UserPool) Name() *pulumi.StringOutput

The name of the attribute.

func (*UserPool) PasswordPolicy 

func (r *UserPool) PasswordPolicy() *pulumi.Output

A container for information about the user pool password policy.

func (*UserPool) Schemas 

func (r *UserPool) Schemas() *pulumi.ArrayOutput

A container with the schema attributes of a user pool. Maximum of 50 attributes.

func (*UserPool) SmsAuthenticationMessage 

func (r *UserPool) SmsAuthenticationMessage() *pulumi.StringOutput

A string representing the SMS authentication message.

func (*UserPool) SmsConfiguration 

func (r *UserPool) SmsConfiguration() *pulumi.Output

The SMS Configuration.

func (*UserPool) SmsVerificationMessage 

func (r *UserPool) SmsVerificationMessage() *pulumi.StringOutput

A string representing the SMS verification message. Conflicts with `verification_message_template` configuration block `sms_message` argument.

func (*UserPool) Tags 

func (r *UserPool) Tags() *pulumi.MapOutput

A mapping of tags to assign to the User Pool.

func (*UserPool) URN 

func (r *UserPool) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*UserPool) UserPoolAddOns added in v0.16.9 

func (r *UserPool) UserPoolAddOns() *pulumi.Output

Configuration block for user pool add-ons to enable user pool advanced security mode features.

func (*UserPool) UsernameAttributes 

func (r *UserPool) UsernameAttributes() *pulumi.ArrayOutput

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with `alias_attributes`.

func (*UserPool) VerificationMessageTemplate 

func (r *UserPool) VerificationMessageTemplate() *pulumi.Output

The verification message templates configuration.

type UserPoolArgs 

type UserPoolArgs struct {
	// The configuration for AdminCreateUser requests.
	AdminCreateUserConfig interface{}
	// Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username. Conflicts with `username_attributes`.
	AliasAttributes interface{}
	// The attributes to be auto-verified. Possible values: email, phone_number.
	AutoVerifiedAttributes interface{}
	// The configuration for the user pool's device tracking.
	DeviceConfiguration interface{}
	// The Email Configuration.
	EmailConfiguration interface{}
	// A string representing the email verification message. Conflicts with `verification_message_template` configuration block `email_message` argument.
	EmailVerificationMessage interface{}
	// A string representing the email verification subject. Conflicts with `verification_message_template` configuration block `email_subject` argument.
	EmailVerificationSubject interface{}
	// A container for the AWS Lambda triggers associated with the user pool.
	LambdaConfig interface{}
	// Set to enable multi-factor authentication. Must be one of the following values (ON, OFF, OPTIONAL)
	MfaConfiguration interface{}
	// The name of the attribute.
	Name interface{}
	// A container for information about the user pool password policy.
	PasswordPolicy interface{}
	// A container with the schema attributes of a user pool. Maximum of 50 attributes.
	Schemas interface{}
	// A string representing the SMS authentication message.
	SmsAuthenticationMessage interface{}
	// The SMS Configuration.
	SmsConfiguration interface{}
	// A string representing the SMS verification message. Conflicts with `verification_message_template` configuration block `sms_message` argument.
	SmsVerificationMessage interface{}
	// A mapping of tags to assign to the User Pool.
	Tags interface{}
	// Configuration block for user pool add-ons to enable user pool advanced security mode features.
	UserPoolAddOns interface{}
	// Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with `alias_attributes`.
	UsernameAttributes interface{}
	// The verification message templates configuration.
	VerificationMessageTemplate interface{}
}

The set of arguments for constructing a UserPool resource.

type UserPoolClient 

type UserPoolClient struct {
	// contains filtered or unexported fields
}

Provides a Cognito User Pool Client resource.

func GetUserPoolClient 

func GetUserPoolClient(ctx *pulumi.Context,
	name string, id pulumi.ID, state *UserPoolClientState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*UserPoolClient, error)

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

func (*UserPoolClient) AllowedOauthFlows 

func (r *UserPoolClient) AllowedOauthFlows() *pulumi.ArrayOutput

List of allowed OAuth flows (code, implicit, client_credentials).

func (*UserPoolClient) AllowedOauthFlowsUserPoolClient 

func (r *UserPoolClient) AllowedOauthFlowsUserPoolClient() *pulumi.BoolOutput

Whether the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

func (*UserPoolClient) AllowedOauthScopes 

func (r *UserPoolClient) AllowedOauthScopes() *pulumi.ArrayOutput

List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).

func (*UserPoolClient) CallbackUrls 

func (r *UserPoolClient) CallbackUrls() *pulumi.ArrayOutput

List of allowed callback URLs for the identity providers.

func (*UserPoolClient) ClientSecret 

func (r *UserPoolClient) ClientSecret() *pulumi.StringOutput

The client secret of the user pool client.

func (*UserPoolClient) DefaultRedirectUri 

func (r *UserPoolClient) DefaultRedirectUri() *pulumi.StringOutput

The default redirect URI. Must be in the list of callback URLs.

func (*UserPoolClient) ExplicitAuthFlows 

func (r *UserPoolClient) ExplicitAuthFlows() *pulumi.ArrayOutput

List of authentication flows (ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH).

func (*UserPoolClient) GenerateSecret 

func (r *UserPoolClient) GenerateSecret() *pulumi.BoolOutput

Should an application secret be generated.

func (*UserPoolClient) ID 

func (r *UserPoolClient) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*UserPoolClient) LogoutUrls 

func (r *UserPoolClient) LogoutUrls() *pulumi.ArrayOutput

List of allowed logout URLs for the identity providers.

func (*UserPoolClient) Name 

func (r *UserPoolClient) Name() *pulumi.StringOutput

The name of the application client.

func (*UserPoolClient) ReadAttributes 

func (r *UserPoolClient) ReadAttributes() *pulumi.ArrayOutput

List of user pool attributes the application client can read from.

func (*UserPoolClient) RefreshTokenValidity 

func (r *UserPoolClient) RefreshTokenValidity() *pulumi.IntOutput

The time limit in days refresh tokens are valid for.

func (*UserPoolClient) SupportedIdentityProviders 

func (r *UserPoolClient) SupportedIdentityProviders() *pulumi.ArrayOutput

List of provider names for the identity providers that are supported on this client.

func (*UserPoolClient) URN 

func (r *UserPoolClient) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*UserPoolClient) UserPoolId 

func (r *UserPoolClient) UserPoolId() *pulumi.StringOutput

The user pool the client belongs to.

func (*UserPoolClient) WriteAttributes 

func (r *UserPoolClient) WriteAttributes() *pulumi.ArrayOutput

List of user pool attributes the application client can write to.

type UserPoolClientArgs 

type UserPoolClientArgs struct {
	// List of allowed OAuth flows (code, implicit, client_credentials).
	AllowedOauthFlows interface{}
	// Whether the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
	AllowedOauthFlowsUserPoolClient interface{}
	// List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).
	AllowedOauthScopes interface{}
	// List of allowed callback URLs for the identity providers.
	CallbackUrls interface{}
	// The default redirect URI. Must be in the list of callback URLs.
	DefaultRedirectUri interface{}
	// List of authentication flows (ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH).
	ExplicitAuthFlows interface{}
	// Should an application secret be generated.
	GenerateSecret interface{}
	// List of allowed logout URLs for the identity providers.
	LogoutUrls interface{}
	// The name of the application client.
	Name interface{}
	// List of user pool attributes the application client can read from.
	ReadAttributes interface{}
	// The time limit in days refresh tokens are valid for.
	RefreshTokenValidity interface{}
	// List of provider names for the identity providers that are supported on this client.
	SupportedIdentityProviders interface{}
	// The user pool the client belongs to.
	UserPoolId interface{}
	// List of user pool attributes the application client can write to.
	WriteAttributes interface{}
}

The set of arguments for constructing a UserPoolClient resource.

type UserPoolClientState 

type UserPoolClientState struct {
	// List of allowed OAuth flows (code, implicit, client_credentials).
	AllowedOauthFlows interface{}
	// Whether the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
	AllowedOauthFlowsUserPoolClient interface{}
	// List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).
	AllowedOauthScopes interface{}
	// List of allowed callback URLs for the identity providers.
	CallbackUrls interface{}
	// The client secret of the user pool client.
	ClientSecret interface{}
	// The default redirect URI. Must be in the list of callback URLs.
	DefaultRedirectUri interface{}
	// List of authentication flows (ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH).
	ExplicitAuthFlows interface{}
	// Should an application secret be generated.
	GenerateSecret interface{}
	// List of allowed logout URLs for the identity providers.
	LogoutUrls interface{}
	// The name of the application client.
	Name interface{}
	// List of user pool attributes the application client can read from.
	ReadAttributes interface{}
	// The time limit in days refresh tokens are valid for.
	RefreshTokenValidity interface{}
	// List of provider names for the identity providers that are supported on this client.
	SupportedIdentityProviders interface{}
	// The user pool the client belongs to.
	UserPoolId interface{}
	// List of user pool attributes the application client can write to.
	WriteAttributes interface{}
}

Input properties used for looking up and filtering UserPoolClient resources.

type UserPoolDomain 

type UserPoolDomain struct {
	// contains filtered or unexported fields
}

Provides a Cognito User Pool Domain resource.

func GetUserPoolDomain 

func GetUserPoolDomain(ctx *pulumi.Context,
	name string, id pulumi.ID, state *UserPoolDomainState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*UserPoolDomain, error)

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

func (*UserPoolDomain) AwsAccountId 

func (r *UserPoolDomain) AwsAccountId() *pulumi.StringOutput

The AWS account ID for the user pool owner.

func (*UserPoolDomain) CertificateArn added in v0.16.2 

func (r *UserPoolDomain) CertificateArn() *pulumi.StringOutput

The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.

func (*UserPoolDomain) CloudfrontDistributionArn 

func (r *UserPoolDomain) CloudfrontDistributionArn() *pulumi.StringOutput

The ARN of the CloudFront distribution.

func (*UserPoolDomain) Domain 

func (r *UserPoolDomain) Domain() *pulumi.StringOutput

The domain string.

func (*UserPoolDomain) ID 

func (r *UserPoolDomain) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*UserPoolDomain) S3Bucket 

func (r *UserPoolDomain) S3Bucket() *pulumi.StringOutput

The S3 bucket where the static files for this domain are stored.

func (*UserPoolDomain) URN 

func (r *UserPoolDomain) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*UserPoolDomain) UserPoolId 

func (r *UserPoolDomain) UserPoolId() *pulumi.StringOutput

The user pool ID.

func (*UserPoolDomain) Version 

func (r *UserPoolDomain) Version() *pulumi.StringOutput

The app version.

type UserPoolDomainArgs 

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

The set of arguments for constructing a UserPoolDomain resource.

type UserPoolDomainState 

type UserPoolDomainState struct {
	// The AWS account ID for the user pool owner.
	AwsAccountId interface{}
	// The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.
	CertificateArn interface{}
	// The ARN of the CloudFront distribution.
	CloudfrontDistributionArn interface{}
	// The domain string.
	Domain interface{}
	// The S3 bucket where the static files for this domain are stored.
	S3Bucket interface{}
	// The user pool ID.
	UserPoolId interface{}
	// The app version.
	Version interface{}
}

Input properties used for looking up and filtering UserPoolDomain resources.

type UserPoolState 

type UserPoolState struct {
	// The configuration for AdminCreateUser requests.
	AdminCreateUserConfig interface{}
	// Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username. Conflicts with `username_attributes`.
	AliasAttributes interface{}
	// The ARN of the user pool.
	Arn interface{}
	// The attributes to be auto-verified. Possible values: email, phone_number.
	AutoVerifiedAttributes interface{}
	// The date the user pool was created.
	CreationDate interface{}
	// The configuration for the user pool's device tracking.
	DeviceConfiguration interface{}
	// The Email Configuration.
	EmailConfiguration interface{}
	// A string representing the email verification message. Conflicts with `verification_message_template` configuration block `email_message` argument.
	EmailVerificationMessage interface{}
	// A string representing the email verification subject. Conflicts with `verification_message_template` configuration block `email_subject` argument.
	EmailVerificationSubject interface{}
	// The endpoint name of the user pool. Example format: cognito-idp.REGION.amazonaws.com/xxxx_yyyyy
	Endpoint interface{}
	// A container for the AWS Lambda triggers associated with the user pool.
	LambdaConfig interface{}
	// The date the user pool was last modified.
	LastModifiedDate interface{}
	// Set to enable multi-factor authentication. Must be one of the following values (ON, OFF, OPTIONAL)
	MfaConfiguration interface{}
	// The name of the attribute.
	Name interface{}
	// A container for information about the user pool password policy.
	PasswordPolicy interface{}
	// A container with the schema attributes of a user pool. Maximum of 50 attributes.
	Schemas interface{}
	// A string representing the SMS authentication message.
	SmsAuthenticationMessage interface{}
	// The SMS Configuration.
	SmsConfiguration interface{}
	// A string representing the SMS verification message. Conflicts with `verification_message_template` configuration block `sms_message` argument.
	SmsVerificationMessage interface{}
	// A mapping of tags to assign to the User Pool.
	Tags interface{}
	// Configuration block for user pool add-ons to enable user pool advanced security mode features.
	UserPoolAddOns interface{}
	// Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with `alias_attributes`.
	UsernameAttributes interface{}
	// The verification message templates configuration.
	VerificationMessageTemplate interface{}
}

Input properties used for looking up and filtering UserPool resources.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.