class CfnDeploymentPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.GreengrassV2.Mixins.CfnDeploymentPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsgreengrassv2/mixins#CfnDeploymentPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.greengrassv2.mixins.CfnDeploymentPropsMixin
Python	aws_cdk.mixins_preview.aws_greengrassv2.mixins.CfnDeploymentPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_greengrassv2 » mixins » CfnDeploymentPropsMixin

Implements IMixin

Extends Mixin

Creates a continuous deployment for a target, which is a AWS IoT Greengrass core device or group of core devices.

When you add a new core device to a group of core devices that has a deployment, AWS IoT Greengrass deploys that group's deployment to the new device.

You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. AWS IoT Greengrass applies the new deployment to the target devices.

You can only add, update, or delete up to 10 deployments at a time to a single target.

Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment. This operation returns the revision number of the new deployment when you create it.

For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide .

Deployment resources are deleted when you delete stacks. To keep the deployments in a stack, you must specify "DeletionPolicy": "Retain" on each deployment resource in the stack template that you want to keep. For more information, see DeletionPolicy .

You can only delete up to 10 deployment resources at a time. If you delete more than 10 resources, you receive an error.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as greengrassv2_mixins } from '@aws-cdk/mixins-preview/aws-greengrassv2';

declare const rateIncreaseCriteria: any;
const cfnDeploymentPropsMixin = new greengrassv2_mixins.CfnDeploymentPropsMixin({
  components: {
    componentsKey: {
      componentVersion: 'componentVersion',
      configurationUpdate: {
        merge: 'merge',
        reset: ['reset'],
      },
      runWith: {
        posixUser: 'posixUser',
        systemResourceLimits: {
          cpus: 123,
          memory: 123,
        },
        windowsUser: 'windowsUser',
      },
    },
  },
  deploymentName: 'deploymentName',
  deploymentPolicies: {
    componentUpdatePolicy: {
      action: 'action',
      timeoutInSeconds: 123,
    },
    configurationValidationPolicy: {
      timeoutInSeconds: 123,
    },
    failureHandlingPolicy: 'failureHandlingPolicy',
  },
  iotJobConfiguration: {
    abortConfig: {
      criteriaList: [{
        action: 'action',
        failureType: 'failureType',
        minNumberOfExecutedThings: 123,
        thresholdPercentage: 123,
      }],
    },
    jobExecutionsRolloutConfig: {
      exponentialRate: {
        baseRatePerMinute: 123,
        incrementFactor: 123,
        rateIncreaseCriteria: rateIncreaseCriteria,
      },
      maximumPerMinute: 123,
    },
    timeoutConfig: {
      inProgressTimeoutInMinutes: 123,
    },
  },
  parentTargetArn: 'parentTargetArn',
  tags: {
    tagsKey: 'tags',
  },
  targetArn: 'targetArn',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnDeploymentPropsMixin(props: CfnDeploymentMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnDeploymentMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::GreengrassV2::Deployment.

Properties

Name	Type	Description
props	CfnDeploymentMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnDeploymentMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.