v1alpha1

package
v1.0.12 Latest Latest
Warning

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

Go to latest
Published: Jul 22, 2025 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

+k8s:deepcopy-gen=package Package v1alpha1 is the v1alpha1 version of the cognitoidentityprovider.services.k8s.aws API. +groupName=cognitoidentityprovider.services.k8s.aws

Index

Constants

This section is empty.

Variables

View Source
var (
	// GroupVersion is the API Group Version used to register the objects
	GroupVersion = schema.GroupVersion{Group: "cognitoidentityprovider.services.k8s.aws", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

type AccountRecoverySettingType

type AccountRecoverySettingType struct {
	RecoveryMechanisms []*RecoveryOptionType `json:"recoveryMechanisms,omitempty"`
}

The settings for user message delivery in forgot-password operations. Contains preference for email or SMS message delivery of password reset codes, or for admin-only password reset.

This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).

func (*AccountRecoverySettingType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccountRecoverySettingType.

func (*AccountRecoverySettingType) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AccountTakeoverEventActionType

type AccountTakeoverEventActionType string
const (
	AccountTakeoverEventActionType_BLOCK             AccountTakeoverEventActionType = "BLOCK"
	AccountTakeoverEventActionType_MFA_IF_CONFIGURED AccountTakeoverEventActionType = "MFA_IF_CONFIGURED"
	AccountTakeoverEventActionType_MFA_REQUIRED      AccountTakeoverEventActionType = "MFA_REQUIRED"
	AccountTakeoverEventActionType_NO_ACTION         AccountTakeoverEventActionType = "NO_ACTION"
)

type AdminCreateUserConfigType

type AdminCreateUserConfigType struct {
	AllowAdminCreateUserOnly *bool `json:"allowAdminCreateUserOnly,omitempty"`
	// The message template structure.
	InviteMessageTemplate     *MessageTemplateType `json:"inviteMessageTemplate,omitempty"`
	UnusedAccountValidityDays *int64               `json:"unusedAccountValidityDays,omitempty"`
}

The settings for administrator creation of users in a user pool. Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.

This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).

func (*AdminCreateUserConfigType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AdminCreateUserConfigType.

func (*AdminCreateUserConfigType) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AdvancedSecurityEnabledModeType added in v1.0.3

type AdvancedSecurityEnabledModeType string
const (
	AdvancedSecurityEnabledModeType_AUDIT    AdvancedSecurityEnabledModeType = "AUDIT"
	AdvancedSecurityEnabledModeType_ENFORCED AdvancedSecurityEnabledModeType = "ENFORCED"
)

type AdvancedSecurityModeType

type AdvancedSecurityModeType string
const (
	AdvancedSecurityModeType_AUDIT    AdvancedSecurityModeType = "AUDIT"
	AdvancedSecurityModeType_ENFORCED AdvancedSecurityModeType = "ENFORCED"
	AdvancedSecurityModeType_OFF      AdvancedSecurityModeType = "OFF"
)

type AliasAttributeType

type AliasAttributeType string
const (
	AliasAttributeType_email              AliasAttributeType = "email"
	AliasAttributeType_phone_number       AliasAttributeType = "phone_number"
	AliasAttributeType_preferred_username AliasAttributeType = "preferred_username"
)

type AnalyticsConfigurationType

type AnalyticsConfigurationType struct {
	ApplicationARN *string `json:"applicationARN,omitempty"`
	ExternalID     *string `json:"externalID,omitempty"`
	RoleARN        *string `json:"roleARN,omitempty"`
	UserDataShared *bool   `json:"userDataShared,omitempty"`
}

The settings for Amazon Pinpoint analytics configuration. With an analytics configuration, your application can collect user-activity metrics for user notifications with a Amazon Pinpoint campaign.

Amazon Pinpoint isn't available in all Amazon Web Services Regions. For a list of available Regions, see Amazon Cognito and Amazon Pinpoint Region availability (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html#cognito-user-pools-find-region-mappings).

This data type is a request parameter of CreateUserPoolClient (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPoolClient.html) and UpdateUserPoolClient (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPoolClient.html), and a response parameter of DescribeUserPoolClient (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html).

func (*AnalyticsConfigurationType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AnalyticsConfigurationType.

func (*AnalyticsConfigurationType) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AnalyticsMetadataType

type AnalyticsMetadataType struct {
	AnalyticsEndpointID *string `json:"analyticsEndpointID,omitempty"`
}

Information that your application adds to authentication requests. Applies an endpoint ID to the analytics data that your user pool sends to Amazon Pinpoint.

An endpoint ID uniquely identifies a mobile device, email address or phone number that can receive messages from Amazon Pinpoint analytics. For more information about Amazon Web Services Regions that can contain Amazon Pinpoint resources for use with Amazon Cognito user pools, see Using Amazon Pinpoint analytics with Amazon Cognito user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html).

This data type is a request parameter of authentication operations like InitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html), AdminInitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html), RespondToAuthChallenge (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html), and AdminRespondToAuthChallenge (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html).

func (*AnalyticsMetadataType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AnalyticsMetadataType.

func (*AnalyticsMetadataType) DeepCopyInto

func (in *AnalyticsMetadataType) DeepCopyInto(out *AnalyticsMetadataType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AssetCategoryType added in v1.0.3

type AssetCategoryType string
const (
	AssetCategoryType_AUTH_APP_GRAPHIC       AssetCategoryType = "AUTH_APP_GRAPHIC"
	AssetCategoryType_EMAIL_GRAPHIC          AssetCategoryType = "EMAIL_GRAPHIC"
	AssetCategoryType_FAVICON_ICO            AssetCategoryType = "FAVICON_ICO"
	AssetCategoryType_FAVICON_SVG            AssetCategoryType = "FAVICON_SVG"
	AssetCategoryType_FORM_BACKGROUND        AssetCategoryType = "FORM_BACKGROUND"
	AssetCategoryType_IDP_BUTTON_ICON        AssetCategoryType = "IDP_BUTTON_ICON"
	AssetCategoryType_PAGE_BACKGROUND        AssetCategoryType = "PAGE_BACKGROUND"
	AssetCategoryType_PAGE_FOOTER_BACKGROUND AssetCategoryType = "PAGE_FOOTER_BACKGROUND"
	AssetCategoryType_PAGE_HEADER_BACKGROUND AssetCategoryType = "PAGE_HEADER_BACKGROUND"
	AssetCategoryType_PASSKEY_GRAPHIC        AssetCategoryType = "PASSKEY_GRAPHIC"
	AssetCategoryType_PASSWORD_GRAPHIC       AssetCategoryType = "PASSWORD_GRAPHIC"
	AssetCategoryType_SMS_GRAPHIC            AssetCategoryType = "SMS_GRAPHIC"
)

type AssetExtensionType added in v1.0.3

type AssetExtensionType string
const (
	AssetExtensionType_ICO  AssetExtensionType = "ICO"
	AssetExtensionType_JPEG AssetExtensionType = "JPEG"
	AssetExtensionType_PNG  AssetExtensionType = "PNG"
	AssetExtensionType_SVG  AssetExtensionType = "SVG"
	AssetExtensionType_WEBP AssetExtensionType = "WEBP"
)

type AttributeDataType

type AttributeDataType string
const (
	AttributeDataType_Boolean  AttributeDataType = "Boolean"
	AttributeDataType_DateTime AttributeDataType = "DateTime"
	AttributeDataType_Number   AttributeDataType = "Number"
	AttributeDataType_String   AttributeDataType = "String"
)

type AuthEventType

type AuthEventType struct {
	CreationDate *metav1.Time `json:"creationDate,omitempty"`
	EventID      *string      `json:"eventID,omitempty"`
}

One authentication event that Amazon Cognito logged in a user pool with advanced security features active. Contains user and device metadata and a risk assessment from your user pool.

This data type is a request parameter of AdminListUserAuthEvents (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListUserAuthEvents.html).

func (*AuthEventType) DeepCopy

func (in *AuthEventType) DeepCopy() *AuthEventType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthEventType.

func (*AuthEventType) DeepCopyInto

func (in *AuthEventType) DeepCopyInto(out *AuthEventType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AuthFactorType added in v1.0.3

type AuthFactorType string
const (
	AuthFactorType_EMAIL_OTP AuthFactorType = "EMAIL_OTP"
	AuthFactorType_PASSWORD  AuthFactorType = "PASSWORD"
	AuthFactorType_SMS_OTP   AuthFactorType = "SMS_OTP"
	AuthFactorType_WEB_AUTHN AuthFactorType = "WEB_AUTHN"
)

type AuthFlowType

type AuthFlowType string
const (
	AuthFlowType_ADMIN_NO_SRP_AUTH        AuthFlowType = "ADMIN_NO_SRP_AUTH"
	AuthFlowType_ADMIN_USER_PASSWORD_AUTH AuthFlowType = "ADMIN_USER_PASSWORD_AUTH"
	AuthFlowType_CUSTOM_AUTH              AuthFlowType = "CUSTOM_AUTH"
	AuthFlowType_REFRESH_TOKEN            AuthFlowType = "REFRESH_TOKEN"
	AuthFlowType_REFRESH_TOKEN_AUTH       AuthFlowType = "REFRESH_TOKEN_AUTH"
	AuthFlowType_USER_AUTH                AuthFlowType = "USER_AUTH"
	AuthFlowType_USER_PASSWORD_AUTH       AuthFlowType = "USER_PASSWORD_AUTH"
	AuthFlowType_USER_SRP_AUTH            AuthFlowType = "USER_SRP_AUTH"
)

type AuthenticationResultType

type AuthenticationResultType struct {
	ExpiresIn *int64  `json:"expiresIn,omitempty"`
	TokenType *string `json:"tokenType,omitempty"`
}

The object that your application receives after authentication. Contains tokens and information for device authentication.

This data type is a response parameter of authentication operations like InitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html), AdminInitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html), RespondToAuthChallenge (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html), and AdminRespondToAuthChallenge (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html).

func (*AuthenticationResultType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthenticationResultType.

func (*AuthenticationResultType) DeepCopyInto

func (in *AuthenticationResultType) DeepCopyInto(out *AuthenticationResultType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ChallengeName

type ChallengeName string
const (
	ChallengeName_Mfa      ChallengeName = "Mfa"
	ChallengeName_Password ChallengeName = "Password"
)

type ChallengeNameType

type ChallengeNameType string
const (
	ChallengeNameType_ADMIN_NO_SRP_AUTH        ChallengeNameType = "ADMIN_NO_SRP_AUTH"
	ChallengeNameType_CUSTOM_CHALLENGE         ChallengeNameType = "CUSTOM_CHALLENGE"
	ChallengeNameType_DEVICE_PASSWORD_VERIFIER ChallengeNameType = "DEVICE_PASSWORD_VERIFIER"
	ChallengeNameType_DEVICE_SRP_AUTH          ChallengeNameType = "DEVICE_SRP_AUTH"
	ChallengeNameType_EMAIL_OTP                ChallengeNameType = "EMAIL_OTP"
	ChallengeNameType_MFA_SETUP                ChallengeNameType = "MFA_SETUP"
	ChallengeNameType_NEW_PASSWORD_REQUIRED    ChallengeNameType = "NEW_PASSWORD_REQUIRED"
	ChallengeNameType_PASSWORD                 ChallengeNameType = "PASSWORD"
	ChallengeNameType_PASSWORD_SRP             ChallengeNameType = "PASSWORD_SRP"
	ChallengeNameType_PASSWORD_VERIFIER        ChallengeNameType = "PASSWORD_VERIFIER"
	ChallengeNameType_SELECT_CHALLENGE         ChallengeNameType = "SELECT_CHALLENGE"
	ChallengeNameType_SELECT_MFA_TYPE          ChallengeNameType = "SELECT_MFA_TYPE"
	ChallengeNameType_SMS_MFA                  ChallengeNameType = "SMS_MFA"
	ChallengeNameType_SMS_OTP                  ChallengeNameType = "SMS_OTP"
	ChallengeNameType_SOFTWARE_TOKEN_MFA       ChallengeNameType = "SOFTWARE_TOKEN_MFA"
	ChallengeNameType_WEB_AUTHN                ChallengeNameType = "WEB_AUTHN"
)

type ChallengeResponse

type ChallengeResponse string
const (
	ChallengeResponse_Failure ChallengeResponse = "Failure"
	ChallengeResponse_Success ChallengeResponse = "Success"
)

type CloudWatchLogsConfigurationType

type CloudWatchLogsConfigurationType struct {
	LogGroupARN *string `json:"logGroupARN,omitempty"`
}

Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.

This data type is a request parameter of SetLogDeliveryConfiguration (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetLogDeliveryConfiguration.html) and a response parameter of GetLogDeliveryConfiguration (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetLogDeliveryConfiguration.html).

func (*CloudWatchLogsConfigurationType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CloudWatchLogsConfigurationType.

func (*CloudWatchLogsConfigurationType) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CodeDeliveryDetailsType

type CodeDeliveryDetailsType struct {
	Destination *string `json:"destination,omitempty"`
}

The delivery details for an email or SMS message that Amazon Cognito sent for authentication or verification.

This data type is a response parameter of operations that send a code for user profile confirmation, verification, or management, for example ForgotPassword (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html) and SignUp (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SignUp.html).

func (*CodeDeliveryDetailsType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CodeDeliveryDetailsType.

func (*CodeDeliveryDetailsType) DeepCopyInto

func (in *CodeDeliveryDetailsType) DeepCopyInto(out *CodeDeliveryDetailsType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ColorSchemeModeType added in v1.0.3

type ColorSchemeModeType string
const (
	ColorSchemeModeType_DARK    ColorSchemeModeType = "DARK"
	ColorSchemeModeType_DYNAMIC ColorSchemeModeType = "DYNAMIC"
	ColorSchemeModeType_LIGHT   ColorSchemeModeType = "LIGHT"
)

type CompromisedCredentialsEventActionType

type CompromisedCredentialsEventActionType string
const (
	CompromisedCredentialsEventActionType_BLOCK     CompromisedCredentialsEventActionType = "BLOCK"
	CompromisedCredentialsEventActionType_NO_ACTION CompromisedCredentialsEventActionType = "NO_ACTION"
)

type ContextDataType

type ContextDataType struct {
	EncodedData *string `json:"encodedData,omitempty"`
	IPAddress   *string `json:"ipAddress,omitempty"`
	ServerName  *string `json:"serverName,omitempty"`
	ServerPath  *string `json:"serverPath,omitempty"`
}

Contextual user data used for evaluating the risk of an authentication event by user pool threat protection.

This data type is a request parameter of server-side authentication operations like AdminInitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html) and AdminRespondToAuthChallenge (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html).

func (*ContextDataType) DeepCopy

func (in *ContextDataType) DeepCopy() *ContextDataType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ContextDataType.

func (*ContextDataType) DeepCopyInto

func (in *ContextDataType) DeepCopyInto(out *ContextDataType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CustomDomainConfigType

type CustomDomainConfigType struct {
	CertificateARN *string `json:"certificateARN,omitempty"`
}

The configuration for a hosted UI custom domain.

This data type is a request parameter of CreateUserPoolDomain (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPoolDomain.html) and UpdateUserPoolDomain (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPoolDomain.html).

func (*CustomDomainConfigType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomDomainConfigType.

func (*CustomDomainConfigType) DeepCopyInto

func (in *CustomDomainConfigType) DeepCopyInto(out *CustomDomainConfigType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CustomEmailLambdaVersionConfigType

type CustomEmailLambdaVersionConfigType struct {
	LambdaARN     *string `json:"lambdaARN,omitempty"`
	LambdaVersion *string `json:"lambdaVersion,omitempty"`
}

The properties of a custom email sender Lambda trigger.

This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).

func (*CustomEmailLambdaVersionConfigType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomEmailLambdaVersionConfigType.

func (*CustomEmailLambdaVersionConfigType) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CustomEmailSenderLambdaVersionType

type CustomEmailSenderLambdaVersionType string
const (
	CustomEmailSenderLambdaVersionType_V1_0 CustomEmailSenderLambdaVersionType = "V1_0"
)

type CustomSMSLambdaVersionConfigType

type CustomSMSLambdaVersionConfigType struct {
	LambdaARN     *string `json:"lambdaARN,omitempty"`
	LambdaVersion *string `json:"lambdaVersion,omitempty"`
}

The properties of a custom SMS sender Lambda trigger.

This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).

func (*CustomSMSLambdaVersionConfigType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomSMSLambdaVersionConfigType.

func (*CustomSMSLambdaVersionConfigType) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CustomSMSSenderLambdaVersionType

type CustomSMSSenderLambdaVersionType string
const (
	CustomSMSSenderLambdaVersionType_V1_0 CustomSMSSenderLambdaVersionType = "V1_0"
)

type DefaultEmailOptionType

type DefaultEmailOptionType string
const (
	DefaultEmailOptionType_CONFIRM_WITH_CODE DefaultEmailOptionType = "CONFIRM_WITH_CODE"
	DefaultEmailOptionType_CONFIRM_WITH_LINK DefaultEmailOptionType = "CONFIRM_WITH_LINK"
)

type DeletionProtectionType

type DeletionProtectionType string
const (
	DeletionProtectionType_ACTIVE   DeletionProtectionType = "ACTIVE"
	DeletionProtectionType_INACTIVE DeletionProtectionType = "INACTIVE"
)

type DeliveryMediumType

type DeliveryMediumType string
const (
	DeliveryMediumType_EMAIL DeliveryMediumType = "EMAIL"
	DeliveryMediumType_SMS   DeliveryMediumType = "SMS"
)

type DeviceConfigurationType

type DeviceConfigurationType struct {
	ChallengeRequiredOnNewDevice     *bool `json:"challengeRequiredOnNewDevice,omitempty"`
	DeviceOnlyRememberedOnUserPrompt *bool `json:"deviceOnlyRememberedOnUserPrompt,omitempty"`
}

The device-remembering configuration for a user pool. A DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) request returns a null value for this object when the user pool isn't configured to remember devices. When device remembering is active, you can remember a user's device with a ConfirmDevice (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html) API request. Additionally. when the property DeviceOnlyRememberedOnUserPrompt is true, you must follow ConfirmDevice with an UpdateDeviceStatus (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html) API request that sets the user's device to remembered or not_remembered.

To sign in with a remembered device, include DEVICE_KEY in the authentication parameters in your user's InitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html) request. If your app doesn't include a DEVICE_KEY parameter, the response (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html#API_InitiateAuth_ResponseSyntax) from Amazon Cognito includes newly-generated DEVICE_KEY and DEVICE_GROUP_KEY values under NewDeviceMetadata. Store these values to use in future device-authentication requests.

When you provide a value for any property of DeviceConfiguration, you activate the device remembering for the user pool.

This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).

func (*DeviceConfigurationType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeviceConfigurationType.

func (*DeviceConfigurationType) DeepCopyInto

func (in *DeviceConfigurationType) DeepCopyInto(out *DeviceConfigurationType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DeviceRememberedStatusType

type DeviceRememberedStatusType string
const (
	DeviceRememberedStatusType_not_remembered DeviceRememberedStatusType = "not_remembered"
	DeviceRememberedStatusType_remembered     DeviceRememberedStatusType = "remembered"
)

type DeviceSecretVerifierConfigType

type DeviceSecretVerifierConfigType struct {
	PasswordVerifier *string `json:"passwordVerifier,omitempty"`
	Salt             *string `json:"salt,omitempty"`
}

A Secure Remote Password (SRP) value that your application generates when you register a user's device. For more information, see Getting a device key (https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-getting-a-device-key).

This data type is a request parameter of ConfirmDevice (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html).

func (*DeviceSecretVerifierConfigType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeviceSecretVerifierConfigType.

func (*DeviceSecretVerifierConfigType) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DeviceType

type DeviceType struct {
	DeviceCreateDate            *metav1.Time `json:"deviceCreateDate,omitempty"`
	DeviceLastAuthenticatedDate *metav1.Time `json:"deviceLastAuthenticatedDate,omitempty"`
	DeviceLastModifiedDate      *metav1.Time `json:"deviceLastModifiedDate,omitempty"`
}

Information about a user's device that they've registered for device SRP authentication in your application. For more information, see Working with user devices in your user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html).

The data type is a response parameter of AdminGetDevice (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminGetDevice.html), AdminListDevices (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListDevices.html), and GetDevice (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetDevice.html).

func (*DeviceType) DeepCopy

func (in *DeviceType) DeepCopy() *DeviceType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeviceType.

func (*DeviceType) DeepCopyInto

func (in *DeviceType) DeepCopyInto(out *DeviceType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DomainDescriptionType

type DomainDescriptionType struct {
	CloudFrontDistribution *string `json:"cloudFrontDistribution,omitempty"`
	Domain                 *string `json:"domain,omitempty"`
	UserPoolID             *string `json:"userPoolID,omitempty"`
}

A container for information about the user pool domain associated with the hosted UI and OAuth endpoints.

This data type is a response parameter of DescribeUserPoolDomain (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolDomain.html).

func (*DomainDescriptionType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DomainDescriptionType.

func (*DomainDescriptionType) DeepCopyInto

func (in *DomainDescriptionType) DeepCopyInto(out *DomainDescriptionType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DomainStatusType

type DomainStatusType string
const (
	DomainStatusType_ACTIVE   DomainStatusType = "ACTIVE"
	DomainStatusType_CREATING DomainStatusType = "CREATING"
	DomainStatusType_DELETING DomainStatusType = "DELETING"
	DomainStatusType_FAILED   DomainStatusType = "FAILED"
	DomainStatusType_UPDATING DomainStatusType = "UPDATING"
)

type EmailConfigurationType

type EmailConfigurationType struct {
	ConfigurationSet    *string `json:"configurationSet,omitempty"`
	EmailSendingAccount *string `json:"emailSendingAccount,omitempty"`
	From                *string `json:"from,omitempty"`
	ReplyToEmailAddress *string `json:"replyToEmailAddress,omitempty"`
	SourceARN           *string `json:"sourceARN,omitempty"`
}

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.

Amazon Cognito can send email messages with Amazon Simple Email Service resources in the Amazon Web Services Region where you created your user pool, and in alternate Regions in some cases. For more information on the supported Regions, see Email settings for Amazon Cognito user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html).

This data type is a request parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html), UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and SetUserPoolMfaConfig (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html), and a response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html), UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and GetUserPoolMfaConfig (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUserPoolMfaConfig.html).

func (*EmailConfigurationType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EmailConfigurationType.

func (*EmailConfigurationType) DeepCopyInto

func (in *EmailConfigurationType) DeepCopyInto(out *EmailConfigurationType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type EmailMFASettingsType added in v1.0.3

type EmailMFASettingsType struct {
	Enabled      *bool `json:"enabled,omitempty"`
	PreferredMFA *bool `json:"preferredMFA,omitempty"`
}

User preferences for multi-factor authentication with email messages. Activates or deactivates email MFA and sets it as the preferred MFA method when multiple methods are available. To activate this setting, advanced security features (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html) must be active in your user pool.

This data type is a request parameter of SetUserMFAPreference (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html) and AdminSetUserMFAPreference (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html).

func (*EmailMFASettingsType) DeepCopy added in v1.0.3

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EmailMFASettingsType.

func (*EmailMFASettingsType) DeepCopyInto added in v1.0.3

func (in *EmailMFASettingsType) DeepCopyInto(out *EmailMFASettingsType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type EmailSendingAccountType

type EmailSendingAccountType string
const (
	EmailSendingAccountType_COGNITO_DEFAULT EmailSendingAccountType = "COGNITO_DEFAULT"
	EmailSendingAccountType_DEVELOPER       EmailSendingAccountType = "DEVELOPER"
)

type EventContextDataType

type EventContextDataType struct {
	City       *string `json:"city,omitempty"`
	Country    *string `json:"country,omitempty"`
	DeviceName *string `json:"deviceName,omitempty"`
	IPAddress  *string `json:"ipAddress,omitempty"`
	Timezone   *string `json:"timezone,omitempty"`
}

The context data that your application submitted in an authentication request with advanced security features, as displayed in an AdminListUserAuthEvents (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListUserAuthEvents.html) response.

func (*EventContextDataType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EventContextDataType.

func (*EventContextDataType) DeepCopyInto

func (in *EventContextDataType) DeepCopyInto(out *EventContextDataType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type EventFeedbackType

type EventFeedbackType struct {
	FeedbackDate *metav1.Time `json:"feedbackDate,omitempty"`
	Provider     *string      `json:"provider,omitempty"`
}

The feedback that your application submitted to an advanced security features event log, as displayed in an AdminListUserAuthEvents (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListUserAuthEvents.html) response.

func (*EventFeedbackType) DeepCopy

func (in *EventFeedbackType) DeepCopy() *EventFeedbackType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EventFeedbackType.

func (*EventFeedbackType) DeepCopyInto

func (in *EventFeedbackType) DeepCopyInto(out *EventFeedbackType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type EventFilterType

type EventFilterType string
const (
	EventFilterType_PASSWORD_CHANGE EventFilterType = "PASSWORD_CHANGE"
	EventFilterType_SIGN_IN         EventFilterType = "SIGN_IN"
	EventFilterType_SIGN_UP         EventFilterType = "SIGN_UP"
)

type EventResponseType

type EventResponseType string
const (
	EventResponseType_Fail       EventResponseType = "Fail"
	EventResponseType_InProgress EventResponseType = "InProgress"
	EventResponseType_Pass       EventResponseType = "Pass"
)

type EventRiskType

type EventRiskType struct {
	CompromisedCredentialsDetected *bool `json:"compromisedCredentialsDetected,omitempty"`
}

The risk evaluation by adaptive authentication, as displayed in an AdminListUserAuthEvents (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListUserAuthEvents.html) response. Contains evaluations of compromised-credentials detection and assessed risk level and action taken by adaptive authentication.

func (*EventRiskType) DeepCopy

func (in *EventRiskType) DeepCopy() *EventRiskType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EventRiskType.

func (*EventRiskType) DeepCopyInto

func (in *EventRiskType) DeepCopyInto(out *EventRiskType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type EventSourceName

type EventSourceName string
const (
	EventSourceName_userAuthEvents   EventSourceName = "userAuthEvents"
	EventSourceName_userNotification EventSourceName = "userNotification"
)

type EventType

type EventType string
const (
	EventType_ForgotPassword EventType = "ForgotPassword"
	EventType_PasswordChange EventType = "PasswordChange"
	EventType_ResendCode     EventType = "ResendCode"
	EventType_SignIn         EventType = "SignIn"
	EventType_SignUp         EventType = "SignUp"
)

type ExplicitAuthFlowsType

type ExplicitAuthFlowsType string
const (
	ExplicitAuthFlowsType_ADMIN_NO_SRP_AUTH              ExplicitAuthFlowsType = "ADMIN_NO_SRP_AUTH"
	ExplicitAuthFlowsType_ALLOW_ADMIN_USER_PASSWORD_AUTH ExplicitAuthFlowsType = "ALLOW_ADMIN_USER_PASSWORD_AUTH"
	ExplicitAuthFlowsType_ALLOW_CUSTOM_AUTH              ExplicitAuthFlowsType = "ALLOW_CUSTOM_AUTH"
	ExplicitAuthFlowsType_ALLOW_REFRESH_TOKEN_AUTH       ExplicitAuthFlowsType = "ALLOW_REFRESH_TOKEN_AUTH"
	ExplicitAuthFlowsType_ALLOW_USER_AUTH                ExplicitAuthFlowsType = "ALLOW_USER_AUTH"
	ExplicitAuthFlowsType_ALLOW_USER_PASSWORD_AUTH       ExplicitAuthFlowsType = "ALLOW_USER_PASSWORD_AUTH"
	ExplicitAuthFlowsType_ALLOW_USER_SRP_AUTH            ExplicitAuthFlowsType = "ALLOW_USER_SRP_AUTH"
	ExplicitAuthFlowsType_CUSTOM_AUTH_FLOW_ONLY          ExplicitAuthFlowsType = "CUSTOM_AUTH_FLOW_ONLY"
	ExplicitAuthFlowsType_USER_PASSWORD_AUTH             ExplicitAuthFlowsType = "USER_PASSWORD_AUTH"
)

type FeedbackValueType

type FeedbackValueType string
const (
	FeedbackValueType_Invalid FeedbackValueType = "Invalid"
	FeedbackValueType_Valid   FeedbackValueType = "Valid"
)

type FirehoseConfigurationType added in v1.0.3

type FirehoseConfigurationType struct {
	StreamARN *string `json:"streamARN,omitempty"`
}

Configuration for the Amazon Data Firehose stream destination of user activity log export with advanced security features.

func (*FirehoseConfigurationType) DeepCopy added in v1.0.3

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FirehoseConfigurationType.

func (*FirehoseConfigurationType) DeepCopyInto added in v1.0.3

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GroupType

type GroupType struct {
	CreationDate     *metav1.Time `json:"creationDate,omitempty"`
	LastModifiedDate *metav1.Time `json:"lastModifiedDate,omitempty"`
	RoleARN          *string      `json:"roleARN,omitempty"`
	UserPoolID       *string      `json:"userPoolID,omitempty"`
}

A user pool group. Contains details about the group and the way that it contributes to IAM role decisions with identity pools. Identity pools can make decisions about the IAM role to assign based on groups: users get credentials for the role associated with their highest-priority group.

This data type is a response parameter of AdminListGroupsForUser (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListGroupsForUser.html), CreateGroup (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html), GetGroup (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetGroup.html), ListGroups (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListGroups.html), and UpdateGroup (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateGroup.html).

func (*GroupType) DeepCopy

func (in *GroupType) DeepCopy() *GroupType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupType.

func (*GroupType) DeepCopyInto

func (in *GroupType) DeepCopyInto(out *GroupType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type HTTPHeader

type HTTPHeader struct {
	HeaderName  *string `json:"headerName,omitempty"`
	HeaderValue *string `json:"headerValue,omitempty"`
}

The HTTP header in the ContextData parameter.

This data type is a request parameter of server-side authentication operations like AdminInitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html) and AdminRespondToAuthChallenge (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html).

func (*HTTPHeader) DeepCopy

func (in *HTTPHeader) DeepCopy() *HTTPHeader

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPHeader.

func (*HTTPHeader) DeepCopyInto

func (in *HTTPHeader) DeepCopyInto(out *HTTPHeader)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type IdentityProviderType

type IdentityProviderType struct {
	CreationDate     *metav1.Time `json:"creationDate,omitempty"`
	LastModifiedDate *metav1.Time `json:"lastModifiedDate,omitempty"`
	UserPoolID       *string      `json:"userPoolID,omitempty"`
}

A user pool identity provider (IdP). Contains information about a third-party IdP to a user pool, the attributes that it populates to user profiles, and the trust relationship between the IdP and your user pool.

This data type is a response parameter of CreateIdentityProvider (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateIdentityProvider.html), DescribeIdentityProvider (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeIdentityProvider.html), GetIdentityProviderByIdentifier (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetIdentityProviderByIdentifier.html), and UpdateIdentityProvider (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateIdentityProvider.html).

func (*IdentityProviderType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IdentityProviderType.

func (*IdentityProviderType) DeepCopyInto

func (in *IdentityProviderType) DeepCopyInto(out *IdentityProviderType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type IdentityProviderTypeType

type IdentityProviderTypeType string
const (
	IdentityProviderTypeType_Facebook        IdentityProviderTypeType = "Facebook"
	IdentityProviderTypeType_Google          IdentityProviderTypeType = "Google"
	IdentityProviderTypeType_LoginWithAmazon IdentityProviderTypeType = "LoginWithAmazon"
	IdentityProviderTypeType_OIDC            IdentityProviderTypeType = "OIDC"
	IdentityProviderTypeType_SAML            IdentityProviderTypeType = "SAML"
	IdentityProviderTypeType_SignInWithApple IdentityProviderTypeType = "SignInWithApple"
)

type LambdaConfigType

type LambdaConfigType struct {
	CreateAuthChallenge *string `json:"createAuthChallenge,omitempty"`
	// The properties of a custom email sender Lambda trigger.
	//
	// This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html)
	// and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).
	CustomEmailSender *CustomEmailLambdaVersionConfigType `json:"customEmailSender,omitempty"`
	CustomMessage     *string                             `json:"customMessage,omitempty"`
	// The properties of a custom SMS sender Lambda trigger.
	//
	// This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html)
	// and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).
	CustomSMSSender     *CustomSMSLambdaVersionConfigType `json:"customSMSSender,omitempty"`
	DefineAuthChallenge *string                           `json:"defineAuthChallenge,omitempty"`
	KMSKeyID            *string                           `json:"kmsKeyID,omitempty"`
	PostAuthentication  *string                           `json:"postAuthentication,omitempty"`
	PostConfirmation    *string                           `json:"postConfirmation,omitempty"`
	PreAuthentication   *string                           `json:"preAuthentication,omitempty"`
	PreSignUp           *string                           `json:"preSignUp,omitempty"`
	PreTokenGeneration  *string                           `json:"preTokenGeneration,omitempty"`
	// The properties of a pre token generation Lambda trigger.
	//
	// This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html)
	// and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).
	PreTokenGenerationConfig    *PreTokenGenerationVersionConfigType `json:"preTokenGenerationConfig,omitempty"`
	UserMigration               *string                              `json:"userMigration,omitempty"`
	VerifyAuthChallengeResponse *string                              `json:"verifyAuthChallengeResponse,omitempty"`
}

A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.

This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).

func (*LambdaConfigType) DeepCopy

func (in *LambdaConfigType) DeepCopy() *LambdaConfigType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LambdaConfigType.

func (*LambdaConfigType) DeepCopyInto

func (in *LambdaConfigType) DeepCopyInto(out *LambdaConfigType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type LogDeliveryConfigurationType

type LogDeliveryConfigurationType struct {
	UserPoolID *string `json:"userPoolID,omitempty"`
}

The logging parameters of a user pool, as returned in the response to a GetLogDeliveryConfiguration (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetLogDeliveryConfiguration.html) request.

func (*LogDeliveryConfigurationType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LogDeliveryConfigurationType.

func (*LogDeliveryConfigurationType) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type LogLevel

type LogLevel string
const (
	LogLevel_ERROR LogLevel = "ERROR"
	LogLevel_INFO  LogLevel = "INFO"
)

type ManagedLoginBrandingType added in v1.0.3

type ManagedLoginBrandingType struct {
	CreationDate             *metav1.Time `json:"creationDate,omitempty"`
	LastModifiedDate         *metav1.Time `json:"lastModifiedDate,omitempty"`
	UseCognitoProvidedValues *bool        `json:"useCognitoProvidedValues,omitempty"`
	UserPoolID               *string      `json:"userPoolID,omitempty"`
}

A managed login branding style that's assigned to a user pool app client.

This data type is a response parameter of CreateManagedLoginBranding (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateManagedLoginBranding.html), UpdateManagedLoginBranding (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateManagedLoginBranding.html), DescribeManagedLoginBranding (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeManagedLoginBranding.html), and DescribeManagedLoginBrandingByClient (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeManagedLoginBrandingByClient.html).

func (*ManagedLoginBrandingType) DeepCopy added in v1.0.3

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ManagedLoginBrandingType.

func (*ManagedLoginBrandingType) DeepCopyInto added in v1.0.3

func (in *ManagedLoginBrandingType) DeepCopyInto(out *ManagedLoginBrandingType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MessageActionType

type MessageActionType string
const (
	MessageActionType_RESEND   MessageActionType = "RESEND"
	MessageActionType_SUPPRESS MessageActionType = "SUPPRESS"
)

type MessageTemplateType

type MessageTemplateType struct {
	EmailMessage *string `json:"emailMessage,omitempty"`
	EmailSubject *string `json:"emailSubject,omitempty"`
	SMSMessage   *string `json:"sMSMessage,omitempty"`
}

The message template structure.

func (*MessageTemplateType) DeepCopy

func (in *MessageTemplateType) DeepCopy() *MessageTemplateType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MessageTemplateType.

func (*MessageTemplateType) DeepCopyInto

func (in *MessageTemplateType) DeepCopyInto(out *MessageTemplateType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NewDeviceMetadataType

type NewDeviceMetadataType struct {
	DeviceGroupKey *string `json:"deviceGroupKey,omitempty"`
}

Information that your user pool responds with in AuthenticationResultwhen you configure it to remember devices and a user signs in with an unrecognized device. Amazon Cognito presents a new device key that you can use to set up device authentication (https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) in a "Remember me on this device" authentication model.

This data type is a response parameter of authentication operations like InitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html), AdminInitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html), RespondToAuthChallenge (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html), and AdminRespondToAuthChallenge (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html).

func (*NewDeviceMetadataType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NewDeviceMetadataType.

func (*NewDeviceMetadataType) DeepCopyInto

func (in *NewDeviceMetadataType) DeepCopyInto(out *NewDeviceMetadataType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NotifyConfigurationType

type NotifyConfigurationType struct {
	From      *string `json:"from,omitempty"`
	ReplyTo   *string `json:"replyTo,omitempty"`
	SourceARN *string `json:"sourceARN,omitempty"`
}

The configuration for Amazon SES email messages that advanced security features sends to a user when your adaptive authentication automated response has a Notify action.

This data type is a request parameter of SetRiskConfiguration (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html) and a response parameter of DescribeRiskConfiguration (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html).

func (*NotifyConfigurationType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NotifyConfigurationType.

func (*NotifyConfigurationType) DeepCopyInto

func (in *NotifyConfigurationType) DeepCopyInto(out *NotifyConfigurationType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NumberAttributeConstraintsType

type NumberAttributeConstraintsType struct {
	MaxValue *string `json:"maxValue,omitempty"`
	MinValue *string `json:"minValue,omitempty"`
}

The minimum and maximum values of an attribute that is of the number type, for example custom:age.

This data type is part of SchemaAttributeType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SchemaAttributeType.html). It defines the length constraints on number-type attributes that you configure in CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and displays the length constraints of all number-type attributes in the response to DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html)

func (*NumberAttributeConstraintsType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NumberAttributeConstraintsType.

func (*NumberAttributeConstraintsType) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OAuthFlowType

type OAuthFlowType string
const (
	OAuthFlowType_client_credentials OAuthFlowType = "client_credentials"
	OAuthFlowType_code               OAuthFlowType = "code"
	OAuthFlowType_implicit           OAuthFlowType = "implicit"
)

type PasswordPolicyType

type PasswordPolicyType struct {
	MinimumLength                 *int64 `json:"minimumLength,omitempty"`
	RequireLowercase              *bool  `json:"requireLowercase,omitempty"`
	RequireNumbers                *bool  `json:"requireNumbers,omitempty"`
	RequireSymbols                *bool  `json:"requireSymbols,omitempty"`
	RequireUppercase              *bool  `json:"requireUppercase,omitempty"`
	TemporaryPasswordValidityDays *int64 `json:"temporaryPasswordValidityDays,omitempty"`
}

The password policy settings for a user pool, including complexity, history, and length requirements.

This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).

func (*PasswordPolicyType) DeepCopy

func (in *PasswordPolicyType) DeepCopy() *PasswordPolicyType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PasswordPolicyType.

func (*PasswordPolicyType) DeepCopyInto

func (in *PasswordPolicyType) DeepCopyInto(out *PasswordPolicyType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PreTokenGenerationLambdaVersionType

type PreTokenGenerationLambdaVersionType string
const (
	PreTokenGenerationLambdaVersionType_V1_0 PreTokenGenerationLambdaVersionType = "V1_0"
	PreTokenGenerationLambdaVersionType_V2_0 PreTokenGenerationLambdaVersionType = "V2_0"
)

type PreTokenGenerationVersionConfigType

type PreTokenGenerationVersionConfigType struct {
	LambdaARN     *string `json:"lambdaARN,omitempty"`
	LambdaVersion *string `json:"lambdaVersion,omitempty"`
}

The properties of a pre token generation Lambda trigger.

This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).

func (*PreTokenGenerationVersionConfigType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PreTokenGenerationVersionConfigType.

func (*PreTokenGenerationVersionConfigType) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PreventUserExistenceErrorTypes

type PreventUserExistenceErrorTypes string
const (
	PreventUserExistenceErrorTypes_ENABLED PreventUserExistenceErrorTypes = "ENABLED"
	PreventUserExistenceErrorTypes_LEGACY  PreventUserExistenceErrorTypes = "LEGACY"
)

type ProviderDescription

type ProviderDescription struct {
	CreationDate     *metav1.Time `json:"creationDate,omitempty"`
	LastModifiedDate *metav1.Time `json:"lastModifiedDate,omitempty"`
}

The details of a user pool identity provider (IdP), including name and type.

This data type is a response parameter of ListIdentityProviders (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListIdentityProviders.html).

func (*ProviderDescription) DeepCopy

func (in *ProviderDescription) DeepCopy() *ProviderDescription

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderDescription.

func (*ProviderDescription) DeepCopyInto

func (in *ProviderDescription) DeepCopyInto(out *ProviderDescription)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ProviderUserIdentifierType

type ProviderUserIdentifierType struct {
	ProviderAttributeName  *string `json:"providerAttributeName,omitempty"`
	ProviderAttributeValue *string `json:"providerAttributeValue,omitempty"`
}

The characteristics of a source or destination user for linking a federated user profile to a local user profile.

This data type is a request parameter of AdminLinkProviderForUser (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html) and AdminDisableProviderForUser (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminDisableProviderForUser.html).

func (*ProviderUserIdentifierType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderUserIdentifierType.

func (*ProviderUserIdentifierType) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RecoveryOptionNameType

type RecoveryOptionNameType string
const (
	RecoveryOptionNameType_admin_only            RecoveryOptionNameType = "admin_only"
	RecoveryOptionNameType_verified_email        RecoveryOptionNameType = "verified_email"
	RecoveryOptionNameType_verified_phone_number RecoveryOptionNameType = "verified_phone_number"
)

type RecoveryOptionType

type RecoveryOptionType struct {
	Name     *string `json:"name,omitempty"`
	Priority *int64  `json:"priority,omitempty"`
}

A recovery option for a user. The AccountRecoverySettingType data type is an array of this object. Each RecoveryOptionType has a priority property that determines whether it is a primary or secondary option.

For example, if verified_email has a priority of 1 and verified_phone_number has a priority of 2, your user pool sends account-recovery messages to a verified email address but falls back to an SMS message if the user has a verified phone number. The admin_only option prevents self-service account recovery.

This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).

func (*RecoveryOptionType) DeepCopy

func (in *RecoveryOptionType) DeepCopy() *RecoveryOptionType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RecoveryOptionType.

func (*RecoveryOptionType) DeepCopyInto

func (in *RecoveryOptionType) DeepCopyInto(out *RecoveryOptionType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceServerType

type ResourceServerType struct {
	UserPoolID *string `json:"userPoolID,omitempty"`
}

The details of a resource server configuration and associated custom scopes in a user pool.

This data type is a request parameter of CreateResourceServer (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateResourceServer.html) and a response parameter of DescribeResourceServer (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeResourceServer.html).

func (*ResourceServerType) DeepCopy

func (in *ResourceServerType) DeepCopy() *ResourceServerType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceServerType.

func (*ResourceServerType) DeepCopyInto

func (in *ResourceServerType) DeepCopyInto(out *ResourceServerType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RiskConfigurationType

type RiskConfigurationType struct {
	LastModifiedDate *metav1.Time `json:"lastModifiedDate,omitempty"`
	UserPoolID       *string      `json:"userPoolID,omitempty"`
}

The settings of risk configuration for threat protection with advanced security features in a user pool.

This data type is a response parameter of DescribeRiskConfiguration (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html) and SetRiskConfiguration (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html).

func (*RiskConfigurationType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RiskConfigurationType.

func (*RiskConfigurationType) DeepCopyInto

func (in *RiskConfigurationType) DeepCopyInto(out *RiskConfigurationType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RiskDecisionType

type RiskDecisionType string
const (
	RiskDecisionType_AccountTakeover RiskDecisionType = "AccountTakeover"
	RiskDecisionType_Block           RiskDecisionType = "Block"
	RiskDecisionType_NoRisk          RiskDecisionType = "NoRisk"
)

type RiskLevelType

type RiskLevelType string
const (
	RiskLevelType_High   RiskLevelType = "High"
	RiskLevelType_Low    RiskLevelType = "Low"
	RiskLevelType_Medium RiskLevelType = "Medium"
)

type SMSMFASettingsType

type SMSMFASettingsType struct {
	Enabled      *bool `json:"enabled,omitempty"`
	PreferredMFA *bool `json:"preferredMFA,omitempty"`
}

A user's preference for using SMS message multi-factor authentication (MFA). Turns SMS MFA on and off, and can set SMS as preferred when other MFA options are available. You can't turn off SMS MFA for any of your users when MFA is required in your user pool; you can only set the type that your user prefers.

This data type is a request parameter of SetUserMFAPreference (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html) and AdminSetUserMFAPreference (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html).

func (*SMSMFASettingsType) DeepCopy

func (in *SMSMFASettingsType) DeepCopy() *SMSMFASettingsType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SMSMFASettingsType.

func (*SMSMFASettingsType) DeepCopyInto

func (in *SMSMFASettingsType) DeepCopyInto(out *SMSMFASettingsType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SchemaAttributeType

type SchemaAttributeType struct {
	AttributeDataType      *string `json:"attributeDataType,omitempty"`
	DeveloperOnlyAttribute *bool   `json:"developerOnlyAttribute,omitempty"`
	Mutable                *bool   `json:"mutable,omitempty"`
	Name                   *string `json:"name,omitempty"`
	// The minimum and maximum values of an attribute that is of the number type,
	// for example custom:age.
	//
	// This data type is part of SchemaAttributeType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SchemaAttributeType.html).
	// It defines the length constraints on number-type attributes that you configure
	// in CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html)
	// and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and displays the length constraints of all number-type attributes in the
	// response to DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html)
	NumberAttributeConstraints *NumberAttributeConstraintsType `json:"numberAttributeConstraints,omitempty"`
	Required                   *bool                           `json:"required,omitempty"`
	// The minimum and maximum length values of an attribute that is of the string
	// type, for example custom:department.
	//
	// This data type is part of SchemaAttributeType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SchemaAttributeType.html).
	// It defines the length constraints on string-type attributes that you configure
	// in CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html)
	// and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and displays the length constraints of all string-type attributes in the
	// response to DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html)
	StringAttributeConstraints *StringAttributeConstraintsType `json:"stringAttributeConstraints,omitempty"`
}

A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefix, and developer attributes with a dev: prefix. For more information, see User pool attributes (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html).

Developer-only dev: attributes are a legacy feature of user pools, and are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.

This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).

func (*SchemaAttributeType) DeepCopy

func (in *SchemaAttributeType) DeepCopy() *SchemaAttributeType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SchemaAttributeType.

func (*SchemaAttributeType) DeepCopyInto

func (in *SchemaAttributeType) DeepCopyInto(out *SchemaAttributeType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SmsConfigurationType

type SmsConfigurationType struct {
	ExternalID   *string `json:"externalID,omitempty"`
	SNSCallerARN *string `json:"snsCallerARN,omitempty"`
	SNSRegion    *string `json:"snsRegion,omitempty"`
}

User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

This data type is a request parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html), UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and SetUserPoolMfaConfig (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html), and a response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html), UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and GetUserPoolMfaConfig (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUserPoolMfaConfig.html).

func (*SmsConfigurationType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SmsConfigurationType.

func (*SmsConfigurationType) DeepCopyInto

func (in *SmsConfigurationType) DeepCopyInto(out *SmsConfigurationType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SmsMFAConfigType

type SmsMFAConfigType struct {
	SmsAuthenticationMessage *string `json:"smsAuthenticationMessage,omitempty"`
	// User pool configuration for delivery of SMS messages with Amazon Simple Notification
	// Service. To send SMS messages with Amazon SNS in the Amazon Web Services
	// Region that you want, the Amazon Cognito user pool uses an Identity and Access
	// Management (IAM) role in your Amazon Web Services account.
	//
	// This data type is a request parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html),
	// UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and SetUserPoolMfaConfig (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html),
	// and a response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html),
	// UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and GetUserPoolMfaConfig (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUserPoolMfaConfig.html).
	SmsConfiguration *SmsConfigurationType `json:"smsConfiguration,omitempty"`
}

The configuration of multi-factor authentication (MFA) with SMS messages in a user pool.

This data type is a request parameter of SetUserPoolMfaConfig (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html) and a response parameter of GetUserPoolMfaConfig (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUserPoolMfaConfig.html).

func (*SmsMFAConfigType) DeepCopy

func (in *SmsMFAConfigType) DeepCopy() *SmsMFAConfigType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SmsMFAConfigType.

func (*SmsMFAConfigType) DeepCopyInto

func (in *SmsMFAConfigType) DeepCopyInto(out *SmsMFAConfigType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SoftwareTokenMFAConfigType

type SoftwareTokenMFAConfigType struct {
	Enabled *bool `json:"enabled,omitempty"`
}

Settings for time-based one-time password (TOTP) multi-factor authentication (MFA) in a user pool. Enables and disables availability of this feature.

This data type is a request parameter of SetUserPoolMfaConfig (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html) and a response parameter of GetUserPoolMfaConfig (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUserPoolMfaConfig.html).

func (*SoftwareTokenMFAConfigType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SoftwareTokenMFAConfigType.

func (*SoftwareTokenMFAConfigType) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SoftwareTokenMFASettingsType

type SoftwareTokenMFASettingsType struct {
	Enabled      *bool `json:"enabled,omitempty"`
	PreferredMFA *bool `json:"preferredMFA,omitempty"`
}

A user's preference for using time-based one-time password (TOTP) multi-factor authentication (MFA). Turns TOTP MFA on and off, and can set TOTP as preferred when other MFA options are available. You can't turn off TOTP MFA for any of your users when MFA is required in your user pool; you can only set the type that your user prefers.

This data type is a request parameter of SetUserMFAPreference (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html) and AdminSetUserMFAPreference (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html).

func (*SoftwareTokenMFASettingsType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SoftwareTokenMFASettingsType.

func (*SoftwareTokenMFASettingsType) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StatusType

type StatusType string
const (
	StatusType_Disabled StatusType = "Disabled"
	StatusType_Enabled  StatusType = "Enabled"
)

type StringAttributeConstraintsType

type StringAttributeConstraintsType struct {
	MaxLength *string `json:"maxLength,omitempty"`
	MinLength *string `json:"minLength,omitempty"`
}

The minimum and maximum length values of an attribute that is of the string type, for example custom:department.

This data type is part of SchemaAttributeType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SchemaAttributeType.html). It defines the length constraints on string-type attributes that you configure in CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and displays the length constraints of all string-type attributes in the response to DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html)

func (*StringAttributeConstraintsType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StringAttributeConstraintsType.

func (*StringAttributeConstraintsType) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TimeUnitsType

type TimeUnitsType string
const (
	TimeUnitsType_days    TimeUnitsType = "days"
	TimeUnitsType_hours   TimeUnitsType = "hours"
	TimeUnitsType_minutes TimeUnitsType = "minutes"
	TimeUnitsType_seconds TimeUnitsType = "seconds"
)

type UICustomizationType

type UICustomizationType struct {
	CreationDate     *metav1.Time `json:"creationDate,omitempty"`
	LastModifiedDate *metav1.Time `json:"lastModifiedDate,omitempty"`
	UserPoolID       *string      `json:"userPoolID,omitempty"`
}

A container for the UI customization information for the hosted UI in a user pool.

This data type is a response parameter of GetUICustomization (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html).

func (*UICustomizationType) DeepCopy

func (in *UICustomizationType) DeepCopy() *UICustomizationType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UICustomizationType.

func (*UICustomizationType) DeepCopyInto

func (in *UICustomizationType) DeepCopyInto(out *UICustomizationType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type UserAttributeUpdateSettingsType

type UserAttributeUpdateSettingsType struct {
	AttributesRequireVerificationBeforeUpdate []*string `json:"attributesRequireVerificationBeforeUpdate,omitempty"`
}

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate,a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. Formore information, see Verifying updates to email addresses and phone numbers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates).

This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).

func (*UserAttributeUpdateSettingsType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserAttributeUpdateSettingsType.

func (*UserAttributeUpdateSettingsType) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type UserContextDataType

type UserContextDataType struct {
	EncodedData *string `json:"encodedData,omitempty"`
	IPAddress   *string `json:"ipAddress,omitempty"`
}

Contextual data, such as the user's device fingerprint, IP address, or location, used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

This data type is a request parameter of public-client authentication operations like InitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html) and RespondToAuthChallenge (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html).

func (*UserContextDataType) DeepCopy

func (in *UserContextDataType) DeepCopy() *UserContextDataType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserContextDataType.

func (*UserContextDataType) DeepCopyInto

func (in *UserContextDataType) DeepCopyInto(out *UserContextDataType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type UserImportJobStatusType

type UserImportJobStatusType string
const (
	UserImportJobStatusType_Created    UserImportJobStatusType = "Created"
	UserImportJobStatusType_Expired    UserImportJobStatusType = "Expired"
	UserImportJobStatusType_Failed     UserImportJobStatusType = "Failed"
	UserImportJobStatusType_InProgress UserImportJobStatusType = "InProgress"
	UserImportJobStatusType_Pending    UserImportJobStatusType = "Pending"
	UserImportJobStatusType_Stopped    UserImportJobStatusType = "Stopped"
	UserImportJobStatusType_Stopping   UserImportJobStatusType = "Stopping"
	UserImportJobStatusType_Succeeded  UserImportJobStatusType = "Succeeded"
)

type UserImportJobType

type UserImportJobType struct {
	CloudWatchLogsRoleARN *string      `json:"cloudWatchLogsRoleARN,omitempty"`
	CompletionDate        *metav1.Time `json:"completionDate,omitempty"`
	CreationDate          *metav1.Time `json:"creationDate,omitempty"`
	StartDate             *metav1.Time `json:"startDate,omitempty"`
	UserPoolID            *string      `json:"userPoolID,omitempty"`
}

A user import job in a user pool. Describes the status of user import with a CSV file. For more information, see Importing users into user pools from a CSV file (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html).

This data type is a request parameter of CreateUserImportJob (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserImportJob.html), DescribeUserImportJob (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserImportJob.html), ListUserImportJobs (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUserImportJobs.html), StartUserImportJob (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_StartUserImportJob.html), and StopUserImportJob (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_StopUserImportJob.html).

func (*UserImportJobType) DeepCopy

func (in *UserImportJobType) DeepCopy() *UserImportJobType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserImportJobType.

func (*UserImportJobType) DeepCopyInto

func (in *UserImportJobType) DeepCopyInto(out *UserImportJobType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type UserPool

type UserPool struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              UserPoolSpec   `json:"spec,omitempty"`
	Status            UserPoolStatus `json:"status,omitempty"`
}

UserPool is the Schema for the UserPools API +kubebuilder:object:root=true +kubebuilder:subresource:status

func (*UserPool) DeepCopy

func (in *UserPool) DeepCopy() *UserPool

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserPool.

func (*UserPool) DeepCopyInto

func (in *UserPool) DeepCopyInto(out *UserPool)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*UserPool) DeepCopyObject

func (in *UserPool) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type UserPoolAddOnsType

type UserPoolAddOnsType struct {
	AdvancedSecurityMode *string `json:"advancedSecurityMode,omitempty"`
}

User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

For more information, see Adding advanced security to a user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html).

This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).

func (*UserPoolAddOnsType) DeepCopy

func (in *UserPoolAddOnsType) DeepCopy() *UserPoolAddOnsType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserPoolAddOnsType.

func (*UserPoolAddOnsType) DeepCopyInto

func (in *UserPoolAddOnsType) DeepCopyInto(out *UserPoolAddOnsType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type UserPoolClientDescription

type UserPoolClientDescription struct {
	UserPoolID *string `json:"userPoolID,omitempty"`
}

A short description of a user pool app client.

This data type is a response parameter of ListUserPoolClients (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUserPoolClients.html).

func (*UserPoolClientDescription) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserPoolClientDescription.

func (*UserPoolClientDescription) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type UserPoolClientType

type UserPoolClientType struct {
	AllowedOAuthFlowsUserPoolClient          *bool        `json:"allowedOAuthFlowsUserPoolClient,omitempty"`
	CreationDate                             *metav1.Time `json:"creationDate,omitempty"`
	EnablePropagateAdditionalUserContextData *bool        `json:"enablePropagateAdditionalUserContextData,omitempty"`
	EnableTokenRevocation                    *bool        `json:"enableTokenRevocation,omitempty"`
	LastModifiedDate                         *metav1.Time `json:"lastModifiedDate,omitempty"`
	UserPoolID                               *string      `json:"userPoolID,omitempty"`
}

The configuration of a user pool client.

This data type is a request parameter of CreateUserPoolClient (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPoolClient.html) and UpdateUserPoolClient (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPoolClient.html), and a response parameter of DescribeUserPoolClient (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html).

func (*UserPoolClientType) DeepCopy

func (in *UserPoolClientType) DeepCopy() *UserPoolClientType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserPoolClientType.

func (*UserPoolClientType) DeepCopyInto

func (in *UserPoolClientType) DeepCopyInto(out *UserPoolClientType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type UserPoolDescriptionType

type UserPoolDescriptionType struct {
	CreationDate *metav1.Time `json:"creationDate,omitempty"`
	ID           *string      `json:"id,omitempty"`
	// A collection of user pool Lambda triggers. Amazon Cognito invokes triggers
	// at several possible stages of user pool operations. Triggers can modify the
	// outcome of the operations that invoked them.
	//
	// This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html)
	// and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).
	LambdaConfig     *LambdaConfigType `json:"lambdaConfig,omitempty"`
	LastModifiedDate *metav1.Time      `json:"lastModifiedDate,omitempty"`
	Name             *string           `json:"name,omitempty"`
	Status           *string           `json:"status,omitempty"`
}

A short description of a user pool.

This data type is a response parameter of ListUserPools (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUserPools.html).

func (*UserPoolDescriptionType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserPoolDescriptionType.

func (*UserPoolDescriptionType) DeepCopyInto

func (in *UserPoolDescriptionType) DeepCopyInto(out *UserPoolDescriptionType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type UserPoolList

type UserPoolList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []UserPool `json:"items"`
}

UserPoolList contains a list of UserPool +kubebuilder:object:root=true

func (*UserPoolList) DeepCopy

func (in *UserPoolList) DeepCopy() *UserPoolList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserPoolList.

func (*UserPoolList) DeepCopyInto

func (in *UserPoolList) DeepCopyInto(out *UserPoolList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*UserPoolList) DeepCopyObject

func (in *UserPoolList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type UserPoolMFAType

type UserPoolMFAType string
const (
	UserPoolMFAType_OFF      UserPoolMFAType = "OFF"
	UserPoolMFAType_ON       UserPoolMFAType = "ON"
	UserPoolMFAType_OPTIONAL UserPoolMFAType = "OPTIONAL"
)

type UserPoolPolicyType

type UserPoolPolicyType struct {
	// The password policy settings for a user pool, including complexity, history,
	// and length requirements.
	//
	// This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html)
	// and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).
	PasswordPolicy *PasswordPolicyType `json:"passwordPolicy,omitempty"`
}

A list of user pool policies. Contains the policy that sets password-complexity requirements.

This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).

func (*UserPoolPolicyType) DeepCopy

func (in *UserPoolPolicyType) DeepCopy() *UserPoolPolicyType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserPoolPolicyType.

func (*UserPoolPolicyType) DeepCopyInto

func (in *UserPoolPolicyType) DeepCopyInto(out *UserPoolPolicyType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type UserPoolSpec

type UserPoolSpec struct {

	// The available verified method a user can use to recover their password when
	// they call ForgotPassword. You can use this setting to define a preferred
	// method when a user has more than one method available. With this setting,
	// SMS doesn't qualify for a valid password recovery mechanism if the user also
	// has SMS multi-factor authentication (MFA) activated. In the absence of this
	// setting, Amazon Cognito uses the legacy behavior to determine the recovery
	// method where SMS is preferred through email.
	AccountRecoverySetting *AccountRecoverySettingType `json:"accountRecoverySetting,omitempty"`
	// The configuration for AdminCreateUser requests.
	AdminCreateUserConfig *AdminCreateUserConfigType `json:"adminCreateUserConfig,omitempty"`
	// Attributes supported as an alias for this user pool. Possible values: phone_number,
	// email, or preferred_username.
	AliasAttributes []*string `json:"aliasAttributes,omitempty"`
	// The attributes to be auto-verified. Possible values: email, phone_number.
	AutoVerifiedAttributes []*string `json:"autoVerifiedAttributes,omitempty"`
	// When active, DeletionProtection prevents accidental deletion of your userpool.
	// Before you can delete a user pool that you have protected against deletion,
	// youmust deactivate this feature.
	//
	// When you try to delete a protected user pool in a DeleteUserPool API request,
	// Amazon Cognito returns an InvalidParameterException error. To delete a protected
	// user pool, send a new DeleteUserPool request after you deactivate deletion
	// protection in an UpdateUserPool API request.
	DeletionProtection *string `json:"deletionProtection,omitempty"`
	// The device-remembering configuration for a user pool. A null value indicates
	// that you have deactivated device remembering in your user pool.
	//
	// When you provide a value for any DeviceConfiguration field, you activate
	// the Amazon Cognito device-remembering feature.
	DeviceConfiguration *DeviceConfigurationType `json:"deviceConfiguration,omitempty"`
	// The email configuration of your user pool. The email configuration type sets
	// your preferred sending method, Amazon Web Services Region, and sender for
	// messages from your user pool.
	EmailConfiguration *EmailConfigurationType `json:"emailConfiguration,omitempty"`
	// This parameter is no longer used. See VerificationMessageTemplateType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html).
	//
	// Regex Pattern: `^[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*$`
	EmailVerificationMessage *string `json:"emailVerificationMessage,omitempty"`
	// This parameter is no longer used. See VerificationMessageTemplateType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html).
	//
	// Regex Pattern: `^[\p{L}\p{M}\p{S}\p{N}\p{P}\s]+$`
	EmailVerificationSubject *string `json:"emailVerificationSubject,omitempty"`
	// A collection of user pool Lambda triggers. Amazon Cognito invokes triggers
	// at several possible stages of authentication operations. Triggers can modify
	// the outcome of the operations that invoked them.
	LambdaConfig *LambdaConfigType `json:"lambdaConfig,omitempty"`
	// Specifies MFA configuration details.
	MFAConfiguration *string `json:"mfaConfiguration,omitempty"`
	// A string used to name the user pool.
	//
	// Regex Pattern: `^[\w\s+=,.@-]+$`
	// +kubebuilder:validation:Required
	Name *string `json:"name"`
	// The policies associated with the new user pool.
	Policies *UserPoolPolicyType `json:"policies,omitempty"`
	// An array of schema attributes for the new user pool. These attributes can
	// be standard or custom attributes.
	Schema []*SchemaAttributeType `json:"schema,omitempty"`
	// A string representing the SMS authentication message.
	//
	// Regex Pattern: `\{####\}`
	SmsAuthenticationMessage *string `json:"smsAuthenticationMessage,omitempty"`
	// The SMS configuration with the settings that your Amazon Cognito user pool
	// must use to send an SMS message from your Amazon Web Services account through
	// Amazon Simple Notification Service. To send SMS messages with Amazon SNS
	// in the Amazon Web Services Region that you want, the Amazon Cognito user
	// pool uses an Identity and Access Management (IAM) role in your Amazon Web
	// Services account.
	SmsConfiguration *SmsConfigurationType `json:"smsConfiguration,omitempty"`
	// This parameter is no longer used. See VerificationMessageTemplateType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html).
	//
	// Regex Pattern: `\{####\}`
	SmsVerificationMessage *string `json:"smsVerificationMessage,omitempty"`
	// The tags to assign to the user pool.
	Tags map[string]*string `json:"tags,omitempty"`
	// The settings for updates to user attributes. These settings include the property
	// AttributesRequireVerificationBeforeUpdate,a user-pool setting that tells
	// Amazon Cognito how to handle changes to the value of your users' email address
	// and phone number attributes. Formore information, see Verifying updates to
	// email addresses and phone numbers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates).
	UserAttributeUpdateSettings *UserAttributeUpdateSettingsType `json:"userAttributeUpdateSettings,omitempty"`
	// User pool add-ons. Contains settings for activation of advanced security
	// features. To log user security information but take no action, set to AUDIT.
	// To configure automatic security responses to risky traffic to your user pool,
	// set to ENFORCED.
	//
	// For more information, see Adding advanced security to a user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html).
	UserPoolAddOns *UserPoolAddOnsType `json:"userPoolAddOns,omitempty"`
	// The tag keys and values to assign to the user pool. A tag is a label that
	// you can use to categorize and manage user pools in different ways, such as
	// by purpose, owner, environment, or other criteria.
	UserPoolTags map[string]*string `json:"userPoolTags,omitempty"`
	// Specifies whether a user can use an email address or phone number as a username
	// when they sign up.
	UsernameAttributes []*string `json:"usernameAttributes,omitempty"`
	// Case sensitivity on the username input for the selected sign-in option. When
	// case sensitivity is set to False (case insensitive), users can sign in with
	// any combination of capital and lowercase letters. For example, username,
	// USERNAME, or UserName, or for email, email@example.com or EMaiL@eXamplE.Com.
	// For most use cases, set case sensitivity to False (case insensitive) as a
	// best practice. When usernames and email addresses are case insensitive, Amazon
	// Cognito treats any variation in case as the same user, and prevents a case
	// variation from being assigned to the same attribute for a different user.
	//
	// This configuration is immutable after you set it. For more information, see
	// UsernameConfigurationType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html).
	UsernameConfiguration *UsernameConfigurationType `json:"usernameConfiguration,omitempty"`
	// The template for the verification message that your user pool delivers to
	// users who set an email address or phone number attribute.
	//
	// Set the email message type that corresponds to your DefaultEmailOption selection.
	// For CONFIRM_WITH_LINK, specify an EmailMessageByLink and leave EmailMessage
	// blank. For CONFIRM_WITH_CODE, specify an EmailMessage and leave EmailMessageByLink
	// blank. When you supply both parameters with either choice, Amazon Cognito
	// returns an error.
	VerificationMessageTemplate *VerificationMessageTemplateType `json:"verificationMessageTemplate,omitempty"`
}

UserPoolSpec defines the desired state of UserPool.

func (*UserPoolSpec) DeepCopy

func (in *UserPoolSpec) DeepCopy() *UserPoolSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserPoolSpec.

func (*UserPoolSpec) DeepCopyInto

func (in *UserPoolSpec) DeepCopyInto(out *UserPoolSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type UserPoolStatus

type UserPoolStatus struct {
	// All CRs managed by ACK have a common `Status.ACKResourceMetadata` member
	// that is used to contain resource sync state, account ownership,
	// constructed ARN for the resource
	// +kubebuilder:validation:Optional
	ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"`
	// All CRs managed by ACK have a common `Status.Conditions` member that
	// contains a collection of `ackv1alpha1.Condition` objects that describe
	// the various terminal states of the CR and its backend AWS service API
	// resource
	// +kubebuilder:validation:Optional
	Conditions []*ackv1alpha1.Condition `json:"conditions"`
	// The date and time when the item was created. Amazon Cognito returns this
	// timestamp in UNIX epoch time format. Your SDK might render the output in
	// a human-readable format like ISO 8601 or a Java Date object.
	// +kubebuilder:validation:Optional
	CreationDate *metav1.Time `json:"creationDate,omitempty"`
	// A custom domain name that you provide to Amazon Cognito. This parameter applies
	// only if you use a custom domain to host the sign-up and sign-in pages for
	// your application. An example of a custom domain name might be auth.example.com.
	//
	// For more information about adding a custom domain to your user pool, see
	// Using Your Own Domain for the Hosted UI (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html).
	//
	// Regex Pattern: `^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$`
	// +kubebuilder:validation:Optional
	CustomDomain *string `json:"customDomain,omitempty"`
	// The domain prefix, if the user pool has a domain associated with it.
	//
	// Regex Pattern: `^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$`
	// +kubebuilder:validation:Optional
	Domain *string `json:"domain,omitempty"`
	// Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com
	// in CloudTrail for information about problems with user pool email configuration.
	// +kubebuilder:validation:Optional
	EmailConfigurationFailure *string `json:"emailConfigurationFailure,omitempty"`
	// A number estimating the size of the user pool.
	// +kubebuilder:validation:Optional
	EstimatedNumberOfUsers *int64 `json:"estimatedNumberOfUsers,omitempty"`
	// The ID of the user pool.
	//
	// Regex Pattern: `^[\w-]+_[0-9a-zA-Z]+$`
	// +kubebuilder:validation:Optional
	ID *string `json:"id,omitempty"`
	// The date and time when the item was modified. Amazon Cognito returns this
	// timestamp in UNIX epoch time format. Your SDK might render the output in
	// a human-readable format like ISO 8601 or a Java Date object.
	// +kubebuilder:validation:Optional
	LastModifiedDate *metav1.Time `json:"lastModifiedDate,omitempty"`
	// A list of the user attributes and their properties in your user pool. The
	// attribute schema contains standard attributes, custom attributes with a custom:
	// prefix, and developer attributes with a dev: prefix. For more information,
	// see User pool attributes (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html).
	//
	// Developer-only attributes are a legacy feature of user pools, and are read-only
	// to all app clients. You can create and update developer-only attributes only
	// with IAM-authenticated API operations. Use app client read/write permissions
	// instead.
	// +kubebuilder:validation:Optional
	SchemaAttributes []*SchemaAttributeType `json:"schemaAttributes,omitempty"`
	// The reason why the SMS configuration can't send the messages to your users.
	//
	// This message might include comma-separated values to describe why your SMS
	// configuration can't send messages to user pool end users.
	//
	// InvalidSmsRoleAccessPolicyException
	//
	// The Identity and Access Management role that Amazon Cognito uses to send
	// SMS messages isn't properly configured. For more information, see SmsConfigurationType
	// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SmsConfigurationType.html).
	//
	// SNSSandbox
	//
	// The Amazon Web Services account is in the SNS SMS Sandbox and messages will
	// only reach verified end users. This parameter won’t get populated with
	// SNSSandbox if the user creating the user pool doesn’t have SNS permissions.
	// To learn how to move your Amazon Web Services account out of the sandbox,
	// see Moving out of the SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox-moving-to-production.html).
	// +kubebuilder:validation:Optional
	SmsConfigurationFailure *string `json:"smsConfigurationFailure,omitempty"`
	// This parameter is no longer used.
	// +kubebuilder:validation:Optional
	Status *string `json:"status,omitempty"`
}

UserPoolStatus defines the observed state of UserPool

func (*UserPoolStatus) DeepCopy

func (in *UserPoolStatus) DeepCopy() *UserPoolStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserPoolStatus.

func (*UserPoolStatus) DeepCopyInto

func (in *UserPoolStatus) DeepCopyInto(out *UserPoolStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type UserPoolTierType added in v1.0.3

type UserPoolTierType string
const (
	UserPoolTierType_ESSENTIALS UserPoolTierType = "ESSENTIALS"
	UserPoolTierType_LITE       UserPoolTierType = "LITE"
	UserPoolTierType_PLUS       UserPoolTierType = "PLUS"
)

type UserPoolType

type UserPoolType struct {
	// The settings for user message delivery in forgot-password operations. Contains
	// preference for email or SMS message delivery of password reset codes, or
	// for admin-only password reset.
	//
	// This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html)
	// and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).
	AccountRecoverySetting *AccountRecoverySettingType `json:"accountRecoverySetting,omitempty"`
	// The settings for administrator creation of users in a user pool. Contains
	// settings for allowing user sign-up, customizing invitation messages to new
	// users, and the amount of time before temporary passwords expire.
	//
	// This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html)
	// and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).
	AdminCreateUserConfig  *AdminCreateUserConfigType `json:"adminCreateUserConfig,omitempty"`
	AliasAttributes        []*string                  `json:"aliasAttributes,omitempty"`
	ARN                    *string                    `json:"arn,omitempty"`
	AutoVerifiedAttributes []*string                  `json:"autoVerifiedAttributes,omitempty"`
	CreationDate           *metav1.Time               `json:"creationDate,omitempty"`
	CustomDomain           *string                    `json:"customDomain,omitempty"`
	DeletionProtection     *string                    `json:"deletionProtection,omitempty"`
	// The device-remembering configuration for a user pool. A DescribeUserPool
	// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html)
	// request returns a null value for this object when the user pool isn't configured
	// to remember devices. When device remembering is active, you can remember
	// a user's device with a ConfirmDevice (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html)
	// API request. Additionally. when the property DeviceOnlyRememberedOnUserPrompt
	// is true, you must follow ConfirmDevice with an UpdateDeviceStatus (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html)
	// API request that sets the user's device to remembered or not_remembered.
	//
	// To sign in with a remembered device, include DEVICE_KEY in the authentication
	// parameters in your user's InitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html)
	// request. If your app doesn't include a DEVICE_KEY parameter, the response
	// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html#API_InitiateAuth_ResponseSyntax)
	// from Amazon Cognito includes newly-generated DEVICE_KEY and DEVICE_GROUP_KEY
	// values under NewDeviceMetadata. Store these values to use in future device-authentication
	// requests.
	//
	// When you provide a value for any property of DeviceConfiguration, you activate
	// the device remembering for the user pool.
	//
	// This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html)
	// and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).
	DeviceConfiguration *DeviceConfigurationType `json:"deviceConfiguration,omitempty"`
	Domain              *string                  `json:"domain,omitempty"`
	// The email configuration of your user pool. The email configuration type sets
	// your preferred sending method, Amazon Web Services Region, and sender for
	// messages from your user pool.
	//
	// Amazon Cognito can send email messages with Amazon Simple Email Service resources
	// in the Amazon Web Services Region where you created your user pool, and in
	// alternate Regions in some cases. For more information on the supported Regions,
	// see Email settings for Amazon Cognito user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html).
	//
	// This data type is a request parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html),
	// UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and SetUserPoolMfaConfig (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html),
	// and a response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html),
	// UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and GetUserPoolMfaConfig (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUserPoolMfaConfig.html).
	EmailConfiguration        *EmailConfigurationType `json:"emailConfiguration,omitempty"`
	EmailConfigurationFailure *string                 `json:"emailConfigurationFailure,omitempty"`
	EmailVerificationMessage  *string                 `json:"emailVerificationMessage,omitempty"`
	EmailVerificationSubject  *string                 `json:"emailVerificationSubject,omitempty"`
	EstimatedNumberOfUsers    *int64                  `json:"estimatedNumberOfUsers,omitempty"`
	ID                        *string                 `json:"id,omitempty"`
	// A collection of user pool Lambda triggers. Amazon Cognito invokes triggers
	// at several possible stages of user pool operations. Triggers can modify the
	// outcome of the operations that invoked them.
	//
	// This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html)
	// and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).
	LambdaConfig     *LambdaConfigType `json:"lambdaConfig,omitempty"`
	LastModifiedDate *metav1.Time      `json:"lastModifiedDate,omitempty"`
	MFAConfiguration *string           `json:"mfaConfiguration,omitempty"`
	Name             *string           `json:"name,omitempty"`
	// A list of user pool policies. Contains the policy that sets password-complexity
	// requirements.
	//
	// This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html)
	// and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).
	Policies                 *UserPoolPolicyType    `json:"policies,omitempty"`
	SchemaAttributes         []*SchemaAttributeType `json:"schemaAttributes,omitempty"`
	SmsAuthenticationMessage *string                `json:"smsAuthenticationMessage,omitempty"`
	// User pool configuration for delivery of SMS messages with Amazon Simple Notification
	// Service. To send SMS messages with Amazon SNS in the Amazon Web Services
	// Region that you want, the Amazon Cognito user pool uses an Identity and Access
	// Management (IAM) role in your Amazon Web Services account.
	//
	// This data type is a request parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html),
	// UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and SetUserPoolMfaConfig (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html),
	// and a response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html),
	// UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and GetUserPoolMfaConfig (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUserPoolMfaConfig.html).
	SmsConfiguration        *SmsConfigurationType `json:"smsConfiguration,omitempty"`
	SmsConfigurationFailure *string               `json:"smsConfigurationFailure,omitempty"`
	SmsVerificationMessage  *string               `json:"smsVerificationMessage,omitempty"`
	Status                  *string               `json:"status,omitempty"`
	// The settings for updates to user attributes. These settings include the property
	// AttributesRequireVerificationBeforeUpdate,a user-pool setting that tells
	// Amazon Cognito how to handle changes to the value of your users' email address
	// and phone number attributes. Formore information, see Verifying updates to
	// email addresses and phone numbers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates).
	//
	// This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html)
	// and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).
	UserAttributeUpdateSettings *UserAttributeUpdateSettingsType `json:"userAttributeUpdateSettings,omitempty"`
	// User pool add-ons. Contains settings for activation of advanced security
	// features. To log user security information but take no action, set to AUDIT.
	// To configure automatic security responses to risky traffic to your user pool,
	// set to ENFORCED.
	//
	// For more information, see Adding advanced security to a user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html).
	//
	// This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html)
	// and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).
	UserPoolAddOns     *UserPoolAddOnsType `json:"userPoolAddOns,omitempty"`
	UserPoolTags       map[string]*string  `json:"userPoolTags,omitempty"`
	UsernameAttributes []*string           `json:"usernameAttributes,omitempty"`
	// The configuration of a user pool for username case sensitivity.
	//
	// This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html)
	// and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).
	UsernameConfiguration *UsernameConfigurationType `json:"usernameConfiguration,omitempty"`
	// The template for the verification message that your user pool delivers to
	// users who set an email address or phone number attribute.
	//
	// This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html)
	// and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html),
	// and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).
	VerificationMessageTemplate *VerificationMessageTemplateType `json:"verificationMessageTemplate,omitempty"`
}

The configuration of a user pool.

This data type is a response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html), UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).

func (*UserPoolType) DeepCopy

func (in *UserPoolType) DeepCopy() *UserPoolType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserPoolType.

func (*UserPoolType) DeepCopyInto

func (in *UserPoolType) DeepCopyInto(out *UserPoolType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type UserStatusType

type UserStatusType string
const (
	UserStatusType_ARCHIVED              UserStatusType = "ARCHIVED"
	UserStatusType_COMPROMISED           UserStatusType = "COMPROMISED"
	UserStatusType_CONFIRMED             UserStatusType = "CONFIRMED"
	UserStatusType_EXTERNAL_PROVIDER     UserStatusType = "EXTERNAL_PROVIDER"
	UserStatusType_FORCE_CHANGE_PASSWORD UserStatusType = "FORCE_CHANGE_PASSWORD"
	UserStatusType_RESET_REQUIRED        UserStatusType = "RESET_REQUIRED"
	UserStatusType_UNCONFIRMED           UserStatusType = "UNCONFIRMED"
	UserStatusType_UNKNOWN               UserStatusType = "UNKNOWN"
)

type UserType

type UserType struct {
	Enabled              *bool        `json:"enabled,omitempty"`
	UserCreateDate       *metav1.Time `json:"userCreateDate,omitempty"`
	UserLastModifiedDate *metav1.Time `json:"userLastModifiedDate,omitempty"`
}

A user profile in a Amazon Cognito user pool.

This data type is a response parameter to AdminCreateUser (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminCreateUser.html) and ListUsers (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUsers.html).

func (*UserType) DeepCopy

func (in *UserType) DeepCopy() *UserType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserType.

func (*UserType) DeepCopyInto

func (in *UserType) DeepCopyInto(out *UserType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type UserVerificationType added in v1.0.3

type UserVerificationType string
const (
	UserVerificationType_preferred UserVerificationType = "preferred"
	UserVerificationType_required  UserVerificationType = "required"
)

type UsernameAttributeType

type UsernameAttributeType string
const (
	UsernameAttributeType_email        UsernameAttributeType = "email"
	UsernameAttributeType_phone_number UsernameAttributeType = "phone_number"
)

type UsernameConfigurationType

type UsernameConfigurationType struct {
	CaseSensitive *bool `json:"caseSensitive,omitempty"`
}

The configuration of a user pool for username case sensitivity.

This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).

func (*UsernameConfigurationType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UsernameConfigurationType.

func (*UsernameConfigurationType) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VerificationMessageTemplateType

type VerificationMessageTemplateType struct {
	DefaultEmailOption *string `json:"defaultEmailOption,omitempty"`
	EmailMessage       *string `json:"emailMessage,omitempty"`
	EmailMessageByLink *string `json:"emailMessageByLink,omitempty"`
	EmailSubject       *string `json:"emailSubject,omitempty"`
	EmailSubjectByLink *string `json:"emailSubjectByLink,omitempty"`
	SmsMessage         *string `json:"smsMessage,omitempty"`
}

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

This data type is a request and response parameter of CreateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and UpdateUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html), and a response parameter of DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html).

func (*VerificationMessageTemplateType) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VerificationMessageTemplateType.

func (*VerificationMessageTemplateType) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VerifiedAttributeType

type VerifiedAttributeType string
const (
	VerifiedAttributeType_email        VerifiedAttributeType = "email"
	VerifiedAttributeType_phone_number VerifiedAttributeType = "phone_number"
)

type VerifySoftwareTokenResponseType

type VerifySoftwareTokenResponseType string
const (
	VerifySoftwareTokenResponseType_ERROR   VerifySoftwareTokenResponseType = "ERROR"
	VerifySoftwareTokenResponseType_SUCCESS VerifySoftwareTokenResponseType = "SUCCESS"
)

type WebAuthnCredentialDescription added in v1.0.3

type WebAuthnCredentialDescription struct {
	CreatedAt              *metav1.Time `json:"createdAt,omitempty"`
	CredentialID           *string      `json:"credentialID,omitempty"`
	FriendlyCredentialName *string      `json:"friendlyCredentialName,omitempty"`
	RelyingPartyID         *string      `json:"relyingPartyID,omitempty"`
}

The details of a passkey, or webauthN, biometric or security-key authentication factor for a user.

This data type is a response parameter of ListWebAuthnCredentials (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListWebAuthnCredentials.html).

func (*WebAuthnCredentialDescription) DeepCopy added in v1.0.3

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WebAuthnCredentialDescription.

func (*WebAuthnCredentialDescription) DeepCopyInto added in v1.0.3

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Jump to

Keyboard shortcuts

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