interface CfnUserPoolRegionalConfigurationAttachmentProps

Language	Type name
.NET	Amazon.CDK.AWS.Cognito.CfnUserPoolRegionalConfigurationAttachmentProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPoolRegionalConfigurationAttachmentProps
Java	software.amazon.awscdk.services.cognito.CfnUserPoolRegionalConfigurationAttachmentProps
Python	aws_cdk.aws_cognito.CfnUserPoolRegionalConfigurationAttachmentProps
TypeScript	aws-cdk-lib » aws_cognito » CfnUserPoolRegionalConfigurationAttachmentProps

Properties for defining a CfnUserPoolRegionalConfigurationAttachment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolregionalconfigurationattachment.html

Example

// 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: {
    externalId: 'externalId',
    snsCallerArn: 'snsCallerArn',
    snsRegion: 'snsRegion',
  },
  status: 'status',
  userPoolTags: {
    userPoolTagsKey: 'userPoolTags',
  },
};

Properties

Name	Type	Description
userPoolId	string
emailConfiguration?	IResolvable | EmailConfigurationProperty
lambdaConfig?	IResolvable | LambdaConfigProperty
smsConfiguration?	IResolvable | SmsConfigurationProperty
status?	string	The status of the replica.
userPoolTags?	{ [string]: string }

---

userPoolId

Type: string

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolregionalconfigurationattachment.html#cfn-cognito-userpoolregionalconfigurationattachment-userpoolid

---

emailConfiguration?

Type: IResolvable | EmailConfigurationProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolregionalconfigurationattachment.html#cfn-cognito-userpoolregionalconfigurationattachment-emailconfiguration

---

lambdaConfig?

Type: IResolvable | LambdaConfigProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolregionalconfigurationattachment.html#cfn-cognito-userpoolregionalconfigurationattachment-lambdaconfig

---

smsConfiguration?

Type: IResolvable | SmsConfigurationProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolregionalconfigurationattachment.html#cfn-cognito-userpoolregionalconfigurationattachment-smsconfiguration

---

status?

Type: string (optional)

The status of the replica.

Set to ACTIVE or INACTIVE.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolregionalconfigurationattachment.html#cfn-cognito-userpoolregionalconfigurationattachment-status

---

userPoolTags?

Type: { [string]: string } (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolregionalconfigurationattachment.html#cfn-cognito-userpoolregionalconfigurationattachment-userpooltags