# CfnDeploymentGroup

The `AWS::CodeDeploy::DeploymentGroup` resource creates an AWS CodeDeploy deployment group that specifies which instances your application revisions are deployed to, along with other deployment options.

For more information, see [CreateDeploymentGroup](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeploymentGroup.html) in the *CodeDeploy API Reference* .

> Amazon ECS blue/green deployments through CodeDeploy do not use the `AWS::CodeDeploy::DeploymentGroup` resource. To perform Amazon ECS blue/green deployments, use the `AWS::CodeDeploy::BlueGreen` hook. See [Perform Amazon ECS blue/green deployments through CodeDeploy using CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html) for more information.

Extends: Construct › CfnElement › CfnRefElement › CfnResource › CfnDeploymentGroup
Implements: IInspectable, ITaggable, IEnvironmentAware, IDeploymentGroupRef, IConstruct, IDependable

- CloudFormation: [`AWS::CodeDeploy::DeploymentGroup`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-codedeploy-deploymentgroup.html)
- Source: Generated code
- Type last changed: v2.252.0 · 30 Apr 2026

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codedeploy as codedeploy } from 'aws-cdk-lib';
const cfnDeploymentGroup = new codedeploy.CfnDeploymentGroup(this, 'MyCfnDeploymentGroup', {
  applicationName: 'applicationName',
  serviceRoleArn: 'serviceRoleArn',

  // the properties below are optional
  alarmConfiguration: {
    alarms: [{
      name: 'name',
    }],
    enabled: false,
    ignorePollAlarmFailure: false,
  },
  autoRollbackConfiguration: {
    enabled: false,
    events: ['events'],
  },
  autoScalingGroups: ['autoScalingGroups'],
  blueGreenDeploymentConfiguration: {
    deploymentReadyOption: {
      actionOnTimeout: 'actionOnTimeout',
      waitTimeInMinutes: 123,
    },
    greenFleetProvisioningOption: {
      action: 'action',
    },
    terminateBlueInstancesOnDeploymentSuccess: {
      action: 'action',
      terminationWaitTimeInMinutes: 123,
    },
  },
  deployment: {
    revision: {
      gitHubLocation: {
        commitId: 'commitId',
        repository: 'repository',
      },
      revisionType: 'revisionType',
      s3Location: {
        bucket: 'bucket',
        key: 'key',

        // the properties below are optional
        bundleType: 'bundleType',
        eTag: 'eTag',
        version: 'version',
      },
    },

    // the properties below are optional
    description: 'description',
    ignoreApplicationStopFailures: false,
  },
  deploymentConfigName: 'deploymentConfigName',
  deploymentGroupName: 'deploymentGroupName',
  deploymentStyle: {
    deploymentOption: 'deploymentOption',
    deploymentType: 'deploymentType',
  },
  ec2TagFilters: [{
    key: 'key',
    type: 'type',
    value: 'value',
  }],
  ec2TagSet: {
    ec2TagSetList: [{
      ec2TagGroup: [{
        key: 'key',
        type: 'type',
        value: 'value',
      }],
    }],
  },
  ecsServices: [{
    clusterName: 'clusterName',
    serviceName: 'serviceName',
  }],
  loadBalancerInfo: {
    elbInfoList: [{
      name: 'name',
    }],
    targetGroupInfoList: [{
      name: 'name',
    }],
    targetGroupPairInfoList: [{
      prodTrafficRoute: {
        listenerArns: ['listenerArns'],
      },
      targetGroups: [{
        name: 'name',
      }],
      testTrafficRoute: {
        listenerArns: ['listenerArns'],
      },
    }],
  },
  onPremisesInstanceTagFilters: [{
    key: 'key',
    type: 'type',
    value: 'value',
  }],
  onPremisesTagSet: {
    onPremisesTagSetList: [{
      onPremisesTagGroup: [{
        key: 'key',
        type: 'type',
        value: 'value',
      }],
    }],
  },
  outdatedInstancesStrategy: 'outdatedInstancesStrategy',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  terminationHookEnabled: false,
  triggerConfigurations: [{
    triggerEvents: ['triggerEvents'],
    triggerName: 'triggerName',
    triggerTargetArn: 'triggerTargetArn',
  }],
});
```

## Initializer

```ts
new CfnDeploymentGroup(scope: Construct, id: string, props: CfnDeploymentGroupProps)
```

## Construct Props

- `alarmConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.AlarmConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.AlarmConfigurationProperty.html) — Information about the Amazon CloudWatch alarms that are associated with the deployment group.

- `applicationName`: string (required) — The name of an existing CodeDeploy application to associate this deployment group with.

- `autoRollbackConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.AutoRollbackConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.AutoRollbackConfigurationProperty.html) — Information about the automatic rollback configuration that is associated with the deployment group.

  If you specify this property, don't specify the `Deployment` property.

- `autoScalingGroups`: string[] — A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created.

  Duplicates are not allowed.

- `blueGreenDeploymentConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty.html) — Information about blue/green deployment options for a deployment group.

- `deployment`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.DeploymentProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.DeploymentProperty.html) — The application revision to deploy to this deployment group.

  If you specify this property, your target application revision is deployed as soon as the provisioning process is complete. If you specify this property, don't specify the `AutoRollbackConfiguration` property.

- `deploymentConfigName`: string — A deployment configuration name or a predefined configuration name.

  With predefined configurations, you can deploy application revisions to one instance at a time ( `CodeDeployDefault.OneAtATime` ), half of the instances at a time ( `CodeDeployDefault.HalfAtATime` ), or all the instances at once ( `CodeDeployDefault.AllAtOnce` ). For more information and valid values, see [Working with Deployment Configurations](https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html) in the *AWS CodeDeploy User Guide* .

- `deploymentGroupName`: string — A name for the deployment group.

  If you don't specify a name, CloudFormation generates a unique physical ID and uses that ID for the deployment group name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .

  > If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

- `deploymentStyle`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.DeploymentStyleProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.DeploymentStyleProperty.html) — Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer.

  If you specify this property with a blue/green deployment type, don't specify the `AutoScalingGroups` , `LoadBalancerInfo` , or `Deployment` properties.

  > For blue/green deployments, CloudFormation supports deployments on Lambda compute platforms only. You can perform Amazon ECS blue/green deployments using `AWS::CodeDeploy::BlueGreen` hook. See [Perform Amazon ECS blue/green deployments through CodeDeploy using CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html) for more information.

- `ec2TagFilters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.EC2TagFilterProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.EC2TagFilterProperty.html)[] — The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group.

  CodeDeploy includes all Amazon EC2 instances identified by any of the tags you specify in this deployment group. Duplicates are not allowed.

  You can specify `EC2TagFilters` or `Ec2TagSet` , but not both.

- `ec2TagSet`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.EC2TagSetProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.EC2TagSetProperty.html) — Information about groups of tags applied to Amazon EC2 instances.

  The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as `ec2TagFilter` .

- `ecsServices`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.ECSServiceProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.ECSServiceProperty.html)[] — The target Amazon ECS services in the deployment group.

  This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format `<clustername>:<servicename>` .

- `loadBalancerInfo`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.LoadBalancerInfoProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.LoadBalancerInfoProperty.html) — Information about the load balancer to use in a deployment.

  For more information, see [Integrating CodeDeploy with Elastic Load Balancing](https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-elastic-load-balancing.html) in the *AWS CodeDeploy User Guide* .

- `onPremisesInstanceTagFilters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.TagFilterProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.TagFilterProperty.html)[] — The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group.

  CodeDeploy includes all on-premises instances identified by any of the tags you specify in this deployment group. To register on-premises instances with CodeDeploy , see [Working with On-Premises Instances for CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-on-premises.html) in the *AWS CodeDeploy User Guide* . Duplicates are not allowed.

  You can specify `OnPremisesInstanceTagFilters` or `OnPremisesInstanceTagSet` , but not both.

- `onPremisesTagSet`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.OnPremisesTagSetProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.OnPremisesTagSetProperty.html) — Information about groups of tags applied to on-premises instances.

  The deployment group includes only on-premises instances identified by all the tag groups.

  You can specify `OnPremisesInstanceTagFilters` or `OnPremisesInstanceTagSet` , but not both.

- `outdatedInstancesStrategy`: string — Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.

  If this option is set to `UPDATE` or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances.

  If this option is set to `IGNORE` , CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.

- `serviceRoleArn`: string (required) — A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf.

  For more information, see [Create a Service Role for AWS CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/getting-started-create-service-role.html) in the *AWS CodeDeploy User Guide* .

  > In some cases, you might need to add a dependency on the service role's policy. For more information, see IAM role policy in [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) .

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them.

  Each tag consists of a key and an optional value, both of which you define.

- `terminationHookEnabled`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.

  For more information about the termination hook, see [How Amazon EC2 Auto Scaling works with CodeDeploy](https://docs.aws.amazon.com//codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors) in the *AWS CodeDeploy User Guide* .

- `triggerConfigurations`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.TriggerConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.TriggerConfigProperty.html)[] — Information about triggers associated with the deployment group.

  Duplicates are not allowed

## Properties

- `alarmConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.AlarmConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.AlarmConfigurationProperty.html) — Information about the Amazon CloudWatch alarms that are associated with the deployment group.

- `applicationName`: string — The name of an existing CodeDeploy application to associate this deployment group with.

- `autoRollbackConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.AutoRollbackConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.AutoRollbackConfigurationProperty.html) — Information about the automatic rollback configuration that is associated with the deployment group.

- `autoScalingGroups`: string[] — A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created.

- `blueGreenDeploymentConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty.html) — Information about blue/green deployment options for a deployment group.

- `CFN_RESOURCE_TYPE_NAME`: string (static) — The CloudFormation resource type name for this resource class.

- `cfnOptions`: [ICfnResourceOptions](/cdk/api/v2/docs/aws-cdk-lib.ICfnResourceOptions.html) — Options for this resource, such as condition, update policy etc.

- `cfnResourceType`: string — AWS resource type.

- `creationStack`: string[]

- `deployment`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.DeploymentProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.DeploymentProperty.html) — The application revision to deploy to this deployment group.

- `deploymentConfigName`: string — A deployment configuration name or a predefined configuration name.

- `deploymentGroupName`: string — A name for the deployment group.

- `deploymentGroupRef`: [DeploymentGroupReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_codedeploy.DeploymentGroupReference.html) — A reference to a DeploymentGroup resource.

- `deploymentStyle`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.DeploymentStyleProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.DeploymentStyleProperty.html) — Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer.

- `ec2TagFilters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.EC2TagFilterProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.EC2TagFilterProperty.html)[] — The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group.

- `ec2TagSet`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.EC2TagSetProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.EC2TagSetProperty.html) — Information about groups of tags applied to Amazon EC2 instances.

- `ecsServices`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.ECSServiceProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.ECSServiceProperty.html)[] — The target Amazon ECS services in the deployment group.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html)

- `loadBalancerInfo`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.LoadBalancerInfoProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.LoadBalancerInfoProperty.html) — Information about the load balancer to use in a deployment.

- `logicalId`: 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`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `onPremisesInstanceTagFilters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.TagFilterProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.TagFilterProperty.html)[] — The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group.

- `onPremisesTagSet`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.OnPremisesTagSetProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.OnPremisesTagSetProperty.html) — Information about groups of tags applied to on-premises instances.

- `outdatedInstancesStrategy`: string — Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.

- `ref`: 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 })`.

- `serviceRoleArn`: string — A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this element is defined.

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

- `tags`: [TagManager](/cdk/api/v2/docs/aws-cdk-lib.TagManager.html) — Tag Manager which manages the tags for this resource.

- `tagsRaw`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them.

- `terminationHookEnabled`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.

- `triggerConfigurations`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.TriggerConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.TriggerConfigProperty.html)[] — Information about triggers associated with the deployment group.

## Methods

- `addDeletionOverride(path: string): void` — Syntactic sugar for `addOverride(path, undefined)`.

  **Parameters**

  - `path` — The path of the value to delete.

- `addDependency(target: CfnResource): void` — Use `addResourceDependency` instead.

  This method has been renamed to `addResourceDependency` to more clearly
  set it apart from `construct.node.addDependency`. See the documentation
  of that function for more details.

- `addDependsOn(target: CfnResource): void` — Use `addResourceDependency` instead.

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

  This method has been renamed to `addResourceDependency`, which makes it
  more clear that this method operates at a different level from the
  construct-level `construct.node.addDependency()` mechanism.

- `addMetadata(key: string, value: any): void` — Add a value to the CloudFormation Resource Metadata.

- `addOverride(path: string, value: any): void` — 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,
  ```typescript
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
  ```
  would add the overrides
  ```json
  "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.

  **Parameters**

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

- `addPropertyDeletionOverride(propertyPath: string): void` — Adds an override that deletes the value of a property from the resource definition.

  **Parameters**

  - `propertyPath` — The path to the property.

- `addPropertyOverride(propertyPath: string, value: any): void` — Adds an override to a resource property.

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

  **Parameters**

  - `propertyPath` — The path of the property.
  - `value` — The value.

- `addResourceDependency(target: CfnResource, reason?: string): void` — 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.

  This method only adds dependencies between L1 resources. If you are
  looking for a generic construct-to-construct dependency mechanism that works
  for all constructs including L2s, use `construct.node.addDependency` instead.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Sets the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  strength instead of the global default from the consuming stack's context.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void` — 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:

- `cfnPropertyName(cdkPropertyName: string): string`

- `getAtt(attributeName: string, typeHint?: ResolutionTypeHint): 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.

  **Parameters**

  - `attributeName` — The name of the attribute.

- `getMetadata(key: string): any` — Retrieve a value value from the CloudFormation Resource Metadata.

- `inspect(inspector: TreeInspector): void` — Examines the CloudFormation resource and discloses attributes.

  **Parameters**

  - `inspector` — tree inspector to collect and process attributes.

- `isCfnDeploymentGroup(x: any): boolean` (static) — Checks whether the given object is a CfnDeploymentGroup.

- `isCfnElement(x: any): boolean` (static) — Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

  Uses duck-typing instead of `instanceof` to allow stack elements from different
  versions of this library to be included in the same stack.

  **Returns:** The construct as a stack element or undefined if it is not a stack element.

- `isCfnResource(x: any): boolean` (static) — Check whether the given object is a CfnResource.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `obtainDependencies(): Stack | CfnResource[]` — Retrieves an array of resources and stacks this resource depends on.

  For resources depended on directly, returns the `CfnResource` object. For
  dependencies on other stacks, returns the `Stack` object. The order of the
  array is not guaranteed.

- `overrideLogicalId(newLogicalId: string): void` — Overrides the auto-generated logical ID with a specific ID.

  **Parameters**

  - `newLogicalId` — The new logical ID to use for this stack element.

- `removeDependency(target: CfnResource): void` — Use `removeResourceDependency` instead

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

- `removeResourceDependency(target: CfnResource): void` — 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: CfnResource, newTarget: CfnResource): void` — Replaces one dependency with another.

  **Parameters**

  - `target` — The dependency to replace.
  - `newTarget` — The new dependency to add.

- `toString(): string` — Returns a string representation of this construct.

  **Returns:** a string representation of this resource

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.