AWS CDK Reference

Appearance

v2.274.0

CfnUserPoolRegionalConfigurationAttachmentProps Struct ​

Properties for defining a CfnUserPoolRegionalConfigurationAttachment.

Source
Generated code
Type last changed
v2.262.0 · 22 Jul 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const cfnUserPoolRegionalConfigurationAttachmentProps: cognito.CfnUserPoolRegionalConfigurationAttachmentProps = {
  userPoolId: 'userPoolId',

  // the properties below are optional
  emailConfiguration: {
    configurationSet: 'configurationSet',
    emailSendingAccount: 'emailSendingAccount',
    from: 'from',
    replyToEmailAddress: 'replyToEmailAddress',
    sourceArn: 'sourceArn',
  },
  lambdaConfig: {
    createAuthChallenge: 'createAuthChallenge',
    customEmailSender: {
      lambdaArn: 'lambdaArn',
      lambdaVersion: 'lambdaVersion',
    },
    customMessage: 'customMessage',
    customSmsSender: {
      lambdaArn: 'lambdaArn',
      lambdaVersion: 'lambdaVersion',
    },
    defineAuthChallenge: 'defineAuthChallenge',
    inboundFederation: {
      lambdaArn: 'lambdaArn',
      lambdaVersion: 'lambdaVersion',
    },
    kmsKeyId: 'kmsKeyId',
    postAuthentication: 'postAuthentication',
    postConfirmation: 'postConfirmation',
    preAuthentication: 'preAuthentication',
    preSignUp: 'preSignUp',
    preTokenGeneration: 'preTokenGeneration',
    preTokenGenerationConfig: {
      lambdaArn: 'lambdaArn',
      lambdaVersion: 'lambdaVersion',
    },
    userMigration: 'userMigration',
    verifyAuthChallengeResponse: 'verifyAuthChallengeResponse',
  },
  smsConfiguration: {
    eumsSms: {
      callerArn: 'callerArn',

      // the properties below are optional
      configurationSetName: 'configurationSetName',
      externalId: 'externalId',
      inEntityId: 'inEntityId',
      inTemplateId: 'inTemplateId',
      originationIdentity: 'originationIdentity',
      region: 'region',
    },
    externalId: 'externalId',
    snsCallerArn: 'snsCallerArn',
    snsRegion: 'snsRegion',
  },
  status: 'status',
  userPoolTags: {
    userPoolTagsKey: 'userPoolTags',
  },
};

Properties ​

emailConfigurationoptionalIResolvable | CfnUserPoolRegionalConfigurationAttachment.EmailConfigurationPropertyemail_configurationoptionaltyping.Union[IResolvable, EmailConfigurationProperty]emailConfigurationoptionalIResolvableEmailConfigurationoptionalIResolvableEmailConfigurationoptionalinterface{}#
lambdaConfigoptionalIResolvable | CfnUserPoolRegionalConfigurationAttachment.LambdaConfigPropertylambda_configoptionaltyping.Union[IResolvable, LambdaConfigProperty]lambdaConfigoptionalIResolvableLambdaConfigoptionalIResolvableLambdaConfigoptionalinterface{}#
smsConfigurationoptionalIResolvable | CfnUserPoolRegionalConfigurationAttachment.SmsConfigurationPropertysms_configurationoptionaltyping.Union[IResolvable, SmsConfigurationProperty]smsConfigurationoptionalIResolvableSmsConfigurationoptionalIResolvableSmsConfigurationoptionalinterface{}#
statusoptionalstringstatusoptionalstrstatusoptionalStringStatusoptionalstringStatusoptional*string#
The status of the replica.

Set to ACTIVE or INACTIVE.

userPoolIdstringuser_pool_idstruserPoolIdStringUserPoolIdstringUserPoolId*stringrequired#
userPoolTagsoptional{ [key: string]: string }user_pool_tagsoptionaltyping.Mapping[str, str]userPoolTagsoptionalMap<String, String>UserPoolTagsoptionalIDictionary<string, string>UserPoolTagsoptional*map[string]*string#