aws-cdk-lib.aws_cognito.CfnUserPool

class CfnUserPool (construct)

LanguageType name
.NETAmazon.CDK.AWS.Cognito.CfnUserPool
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPool
Javasoftware.amazon.awscdk.services.cognito.CfnUserPool
Pythonaws_cdk.aws_cognito.CfnUserPool
TypeScript aws-cdk-lib » aws_cognito » CfnUserPool

Implements IConstruct, IDependable, IInspectable

A CloudFormation AWS::Cognito::UserPool.

The AWS::Cognito::UserPool resource creates an Amazon Cognito user pool. For more information on working with Amazon Cognito user pools, see Amazon Cognito User Pools and CreateUserPool .

If you don't specify a value for a parameter, Amazon Cognito sets it to a default value.

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';

declare const userPoolTags: any;
const cfnUserPool = new cognito.CfnUserPool(this, 'MyCfnUserPool', /* all optional props */ {
  accountRecoverySetting: {
    recoveryMechanisms: [{
      name: 'name',
      priority: 123,
    }],
  },
  adminCreateUserConfig: {
    allowAdminCreateUserOnly: false,
    inviteMessageTemplate: {
      emailMessage: 'emailMessage',
      emailSubject: 'emailSubject',
      smsMessage: 'smsMessage',
    },
    unusedAccountValidityDays: 123,
  },
  aliasAttributes: ['aliasAttributes'],
  autoVerifiedAttributes: ['autoVerifiedAttributes'],
  deletionProtection: 'deletionProtection',
  deviceConfiguration: {
    challengeRequiredOnNewDevice: false,
    deviceOnlyRememberedOnUserPrompt: false,
  },
  emailConfiguration: {
    configurationSet: 'configurationSet',
    emailSendingAccount: 'emailSendingAccount',
    from: 'from',
    replyToEmailAddress: 'replyToEmailAddress',
    sourceArn: 'sourceArn',
  },
  emailVerificationMessage: 'emailVerificationMessage',
  emailVerificationSubject: 'emailVerificationSubject',
  enabledMfas: ['enabledMfas'],
  lambdaConfig: {
    createAuthChallenge: 'createAuthChallenge',
    customEmailSender: {
      lambdaArn: 'lambdaArn',
      lambdaVersion: 'lambdaVersion',
    },
    customMessage: 'customMessage',
    customSmsSender: {
      lambdaArn: 'lambdaArn',
      lambdaVersion: 'lambdaVersion',
    },
    defineAuthChallenge: 'defineAuthChallenge',
    kmsKeyId: 'kmsKeyId',
    postAuthentication: 'postAuthentication',
    postConfirmation: 'postConfirmation',
    preAuthentication: 'preAuthentication',
    preSignUp: 'preSignUp',
    preTokenGeneration: 'preTokenGeneration',
    userMigration: 'userMigration',
    verifyAuthChallengeResponse: 'verifyAuthChallengeResponse',
  },
  mfaConfiguration: 'mfaConfiguration',
  policies: {
    passwordPolicy: {
      minimumLength: 123,
      requireLowercase: false,
      requireNumbers: false,
      requireSymbols: false,
      requireUppercase: false,
      temporaryPasswordValidityDays: 123,
    },
  },
  schema: [{
    attributeDataType: 'attributeDataType',
    developerOnlyAttribute: false,
    mutable: false,
    name: 'name',
    numberAttributeConstraints: {
      maxValue: 'maxValue',
      minValue: 'minValue',
    },
    required: false,
    stringAttributeConstraints: {
      maxLength: 'maxLength',
      minLength: 'minLength',
    },
  }],
  smsAuthenticationMessage: 'smsAuthenticationMessage',
  smsConfiguration: {
    externalId: 'externalId',
    snsCallerArn: 'snsCallerArn',
    snsRegion: 'snsRegion',
  },
  smsVerificationMessage: 'smsVerificationMessage',
  userAttributeUpdateSettings: {
    attributesRequireVerificationBeforeUpdate: ['attributesRequireVerificationBeforeUpdate'],
  },
  usernameAttributes: ['usernameAttributes'],
  usernameConfiguration: {
    caseSensitive: false,
  },
  userPoolAddOns: {
    advancedSecurityMode: 'advancedSecurityMode',
  },
  userPoolName: 'userPoolName',
  userPoolTags: userPoolTags,
  verificationMessageTemplate: {
    defaultEmailOption: 'defaultEmailOption',
    emailMessage: 'emailMessage',
    emailMessageByLink: 'emailMessageByLink',
    emailSubject: 'emailSubject',
    emailSubjectByLink: 'emailSubjectByLink',
    smsMessage: 'smsMessage',
  },
});

Initializer

new CfnUserPool(scope: Construct, id: string, props?: CfnUserPoolProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnUserPoolProps — - resource properties.

Create a new AWS::Cognito::UserPool.

Construct Props

NameTypeDescription
accountRecoverySetting?IResolvable | AccountRecoverySettingPropertyUse this setting to define which verified available method a user can use to recover their password when they call ForgotPassword .
adminCreateUserConfig?IResolvable | AdminCreateUserConfigPropertyThe configuration for creating a new user profile.
aliasAttributes?string[]Attributes supported as an alias for this user pool. Possible values: phone_number , email , or preferred_username .
autoVerifiedAttributes?string[]The attributes to be auto-verified.
deletionProtection?stringWhen active, DeletionProtection prevents accidental deletion of your user pool.
deviceConfiguration?IResolvable | DeviceConfigurationPropertyThe device-remembering configuration for a user pool.
emailConfiguration?IResolvable | EmailConfigurationPropertyThe email configuration of your user pool.
emailVerificationMessage?stringThis parameter is no longer used.
emailVerificationSubject?stringThis parameter is no longer used.
enabledMfas?string[]Enables MFA on a specified user pool.
lambdaConfig?IResolvable | LambdaConfigPropertyThe Lambda trigger configuration information for the new user pool.
mfaConfiguration?stringThe multi-factor authentication (MFA) configuration. Valid values include:.
policies?IResolvable | PoliciesPropertyThe policy associated with a user pool.
schema?IResolvable | IResolvable | SchemaAttributeProperty[]The schema attributes for the new user pool. These attributes can be standard or custom attributes.
smsAuthenticationMessage?stringA string representing the SMS authentication message.
smsConfiguration?IResolvable | SmsConfigurationPropertyThe SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service.
smsVerificationMessage?stringThis parameter is no longer used.
userAttributeUpdateSettings?IResolvable | UserAttributeUpdateSettingsPropertyThe settings for updates to user attributes.
userPoolAddOns?IResolvable | UserPoolAddOnsPropertyEnables advanced security risk detection.
userPoolName?stringA string used to name the user pool.
userPoolTags?anyThe tag keys and values to assign to the user pool.
usernameAttributes?string[]Determines whether email addresses or phone numbers can be specified as user names when a user signs up.
usernameConfiguration?IResolvable | UsernameConfigurationPropertyYou can choose to set case sensitivity on the username input for the selected sign-in option.
verificationMessageTemplate?IResolvable | VerificationMessageTemplatePropertyThe template for the verification message that the user sees when the app requests permission to access the user's information.

accountRecoverySetting?

Type: IResolvable | AccountRecoverySettingProperty (optional)

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword .

It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.


adminCreateUserConfig?

Type: IResolvable | AdminCreateUserConfigProperty (optional)

The configuration for creating a new user profile.


aliasAttributes?

Type: string[] (optional)

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

This user pool property cannot be updated.


autoVerifiedAttributes?

Type: string[] (optional)

The attributes to be auto-verified.

Possible values: email , phone_number .


deletionProtection?

Type: string (optional)

When active, DeletionProtection prevents accidental deletion of your user pool.

Before you can delete a user pool that you have protected against deletion, you must 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.


deviceConfiguration?

Type: IResolvable | DeviceConfigurationProperty (optional)

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.


emailConfiguration?

Type: IResolvable | EmailConfigurationProperty (optional)

The email configuration of your user pool.

The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.


emailVerificationMessage?

Type: string (optional)

This parameter is no longer used.

See VerificationMessageTemplateType .


emailVerificationSubject?

Type: string (optional)

This parameter is no longer used.

See VerificationMessageTemplateType .


enabledMfas?

Type: string[] (optional)

Enables MFA on a specified user pool.

To disable all MFAs after it has been enabled, set MfaConfiguration to “OFF” and remove EnabledMfas. MFAs can only be all disabled if MfaConfiguration is OFF. Once SMS_MFA is enabled, SMS_MFA can only be disabled by setting MfaConfiguration to “OFF”. Can be one of the following values:

  • SMS_MFA - Enables SMS MFA for the user pool. SMS_MFA can only be enabled if SMS configuration is provided.
  • SOFTWARE_TOKEN_MFA - Enables software token MFA for the user pool.

Allowed values: SMS_MFA | SOFTWARE_TOKEN_MFA


lambdaConfig?

Type: IResolvable | LambdaConfigProperty (optional)

The Lambda trigger configuration information for the new user pool.

In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.

For more information on using the Lambda API to add permission, see AddPermission .

For adding permission using the AWS CLI , see add-permission .


mfaConfiguration?

Type: string (optional)

The multi-factor authentication (MFA) configuration. Valid values include:.

  • OFF MFA won't be used for any users.
  • ON MFA is required for all users to sign in.
  • OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

policies?

Type: IResolvable | PoliciesProperty (optional)

The policy associated with a user pool.


schema?

Type: IResolvable | IResolvable | SchemaAttributeProperty[] (optional)

The schema attributes for the new user pool. These attributes can be standard or custom attributes.

During a user pool update, you can add new schema attributes but you cannot modify or delete an existing schema attribute.


smsAuthenticationMessage?

Type: string (optional)

A string representing the SMS authentication message.


smsConfiguration?

Type: IResolvable | SmsConfigurationProperty (optional)

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service.

To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account .


smsVerificationMessage?

Type: string (optional)

This parameter is no longer used.

See VerificationMessageTemplateType .


userAttributeUpdateSettings?

Type: IResolvable | UserAttributeUpdateSettingsProperty (optional)

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. For more information, see Verifying updates to email addresses and phone numbers .


userPoolAddOns?

Type: IResolvable | UserPoolAddOnsProperty (optional)

Enables advanced security risk detection.

Set the key AdvancedSecurityMode to the value "AUDIT".


userPoolName?

Type: string (optional)

A string used to name the user pool.


userPoolTags?

Type: any (optional)

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.


usernameAttributes?

Type: string[] (optional)

Determines whether email addresses or phone numbers can be specified as user names when a user signs up.

Possible values: phone_number or email .

This user pool property cannot be updated.


usernameConfiguration?

Type: IResolvable | UsernameConfigurationProperty (optional)

You can choose to set case sensitivity on the username input for the selected sign-in option.

For example, when this is set to False , users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set.


verificationMessageTemplate?

Type: IResolvable | VerificationMessageTemplateProperty (optional)

The template for the verification message that the user sees when the app requests permission to access the user's information.

Properties

NameTypeDescription
attrArnstringThe Amazon Resource Name (ARN) of the user pool, such as arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341 .
attrProviderNamestringThe provider name of the Amazon Cognito user pool, specified as a String .
attrProviderUrlstringThe URL of the provider of the Amazon Cognito user pool, specified as a String .
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeNodeThe tree node.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
stackStackThe stack in which this element is defined.
tagsTagManagerThe tag keys and values to assign to the user pool.
accountRecoverySetting?IResolvable | AccountRecoverySettingPropertyUse this setting to define which verified available method a user can use to recover their password when they call ForgotPassword .
adminCreateUserConfig?IResolvable | AdminCreateUserConfigPropertyThe configuration for creating a new user profile.
aliasAttributes?string[]Attributes supported as an alias for this user pool. Possible values: phone_number , email , or preferred_username .
autoVerifiedAttributes?string[]The attributes to be auto-verified.
deletionProtection?stringWhen active, DeletionProtection prevents accidental deletion of your user pool.
deviceConfiguration?IResolvable | DeviceConfigurationPropertyThe device-remembering configuration for a user pool.
emailConfiguration?IResolvable | EmailConfigurationPropertyThe email configuration of your user pool.
emailVerificationMessage?stringThis parameter is no longer used.
emailVerificationSubject?stringThis parameter is no longer used.
enabledMfas?string[]Enables MFA on a specified user pool.
lambdaConfig?IResolvable | LambdaConfigPropertyThe Lambda trigger configuration information for the new user pool.
mfaConfiguration?stringThe multi-factor authentication (MFA) configuration. Valid values include:.
policies?IResolvable | PoliciesPropertyThe policy associated with a user pool.
schema?IResolvable | IResolvable | SchemaAttributeProperty[]The schema attributes for the new user pool. These attributes can be standard or custom attributes.
smsAuthenticationMessage?stringA string representing the SMS authentication message.
smsConfiguration?IResolvable | SmsConfigurationPropertyThe SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service.
smsVerificationMessage?stringThis parameter is no longer used.
userAttributeUpdateSettings?IResolvable | UserAttributeUpdateSettingsPropertyThe settings for updates to user attributes.
userPoolAddOns?IResolvable | UserPoolAddOnsPropertyEnables advanced security risk detection.
userPoolName?stringA string used to name the user pool.
usernameAttributes?string[]Determines whether email addresses or phone numbers can be specified as user names when a user signs up.
usernameConfiguration?IResolvable | UsernameConfigurationPropertyYou can choose to set case sensitivity on the username input for the selected sign-in option.
verificationMessageTemplate?IResolvable | VerificationMessageTemplatePropertyThe template for the verification message that the user sees when the app requests permission to access the user's information.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrArn

Type: string

The Amazon Resource Name (ARN) of the user pool, such as arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341 .


attrProviderName

Type: string

The provider name of the Amazon Cognito user pool, specified as a String .


attrProviderUrl

Type: string

The URL of the provider of the Amazon Cognito user pool, specified as a String .


cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.


cfnProperties

Type: { [string]: any }


cfnResourceType

Type: string

AWS resource type.


creationStack

Type: string[]


logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


node

Type: Node

The tree node.


ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).


tags

Type: TagManager

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.


accountRecoverySetting?

Type: IResolvable | AccountRecoverySettingProperty (optional)

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword .

It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.


adminCreateUserConfig?

Type: IResolvable | AdminCreateUserConfigProperty (optional)

The configuration for creating a new user profile.


aliasAttributes?

Type: string[] (optional)

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

This user pool property cannot be updated.


autoVerifiedAttributes?

Type: string[] (optional)

The attributes to be auto-verified.

Possible values: email , phone_number .


deletionProtection?

Type: string (optional)

When active, DeletionProtection prevents accidental deletion of your user pool.

Before you can delete a user pool that you have protected against deletion, you must 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.


deviceConfiguration?

Type: IResolvable | DeviceConfigurationProperty (optional)

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.


emailConfiguration?

Type: IResolvable | EmailConfigurationProperty (optional)

The email configuration of your user pool.

The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.


emailVerificationMessage?

Type: string (optional)

This parameter is no longer used.

See VerificationMessageTemplateType .


emailVerificationSubject?

Type: string (optional)

This parameter is no longer used.

See VerificationMessageTemplateType .


enabledMfas?

Type: string[] (optional)

Enables MFA on a specified user pool.

To disable all MFAs after it has been enabled, set MfaConfiguration to “OFF” and remove EnabledMfas. MFAs can only be all disabled if MfaConfiguration is OFF. Once SMS_MFA is enabled, SMS_MFA can only be disabled by setting MfaConfiguration to “OFF”. Can be one of the following values:

  • SMS_MFA - Enables SMS MFA for the user pool. SMS_MFA can only be enabled if SMS configuration is provided.
  • SOFTWARE_TOKEN_MFA - Enables software token MFA for the user pool.

Allowed values: SMS_MFA | SOFTWARE_TOKEN_MFA


lambdaConfig?

Type: IResolvable | LambdaConfigProperty (optional)

The Lambda trigger configuration information for the new user pool.

In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.

For more information on using the Lambda API to add permission, see AddPermission .

For adding permission using the AWS CLI , see add-permission .


mfaConfiguration?

Type: string (optional)

The multi-factor authentication (MFA) configuration. Valid values include:.

  • OFF MFA won't be used for any users.
  • ON MFA is required for all users to sign in.
  • OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

policies?

Type: IResolvable | PoliciesProperty (optional)

The policy associated with a user pool.


schema?

Type: IResolvable | IResolvable | SchemaAttributeProperty[] (optional)

The schema attributes for the new user pool. These attributes can be standard or custom attributes.

During a user pool update, you can add new schema attributes but you cannot modify or delete an existing schema attribute.


smsAuthenticationMessage?

Type: string (optional)

A string representing the SMS authentication message.


smsConfiguration?

Type: IResolvable | SmsConfigurationProperty (optional)

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service.

To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account .


smsVerificationMessage?

Type: string (optional)

This parameter is no longer used.

See VerificationMessageTemplateType .


userAttributeUpdateSettings?

Type: IResolvable | UserAttributeUpdateSettingsProperty (optional)

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. For more information, see Verifying updates to email addresses and phone numbers .


userPoolAddOns?

Type: IResolvable | UserPoolAddOnsProperty (optional)

Enables advanced security risk detection.

Set the key AdvancedSecurityMode to the value "AUDIT".


userPoolName?

Type: string (optional)

A string used to name the user pool.


usernameAttributes?

Type: string[] (optional)

Determines whether email addresses or phone numbers can be specified as user names when a user signs up.

Possible values: phone_number or email .

This user pool property cannot be updated.


usernameConfiguration?

Type: IResolvable | UsernameConfigurationProperty (optional)

You can choose to set case sensitivity on the username input for the selected sign-in option.

For example, when this is set to False , users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set.


verificationMessageTemplate?

Type: IResolvable | VerificationMessageTemplateProperty (optional)

The template for the verification message that the user sees when the app requests permission to access the user's information.


static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependency(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
obtainDependencies()Retrieves an array of resources this resource depends on.
obtainResourceDependencies()Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)Replaces one dependency with another.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).


addDependency(target)

public addDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.


addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.


addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.


addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.


addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).


applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

  • policy RemovalPolicy
  • options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options


getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

  • attributeName string — The name of the attribute.
  • typeHint ResolutionTypeHint

Returns

  • Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.


getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.


obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

  • Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.


obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

  • CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.


overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.


removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.


replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

  • target CfnResource — The dependency to replace.
  • newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }