Package software.amazon.awscdk.services.greengrassv2

Class CfnDeployment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.greengrassv2.CfnDeployment
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.104Z") @Stability(Stable) public class CfnDeployment extends CfnResource implements IInspectable
A CloudFormation AWS::GreengrassV2::Deployment.

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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.greengrassv2.*;
 Object rateIncreaseCriteria;
 CfnDeployment cfnDeployment = CfnDeployment.Builder.create(this, "MyCfnDeployment")
         .targetArn("targetArn")
         // the properties below are optional
         .components(Map.of(
                 "componentsKey", ComponentDeploymentSpecificationProperty.builder()
                         .componentVersion("componentVersion")
                         .configurationUpdate(ComponentConfigurationUpdateProperty.builder()
                                 .merge("merge")
                                 .reset(List.of("reset"))
                                 .build())
                         .runWith(ComponentRunWithProperty.builder()
                                 .posixUser("posixUser")
                                 .systemResourceLimits(SystemResourceLimitsProperty.builder()
                                         .cpus(123)
                                         .memory(123)
                                         .build())
                                 .windowsUser("windowsUser")
                                 .build())
                         .build()))
         .deploymentName("deploymentName")
         .deploymentPolicies(DeploymentPoliciesProperty.builder()
                 .componentUpdatePolicy(DeploymentComponentUpdatePolicyProperty.builder()
                         .action("action")
                         .timeoutInSeconds(123)
                         .build())
                 .configurationValidationPolicy(DeploymentConfigurationValidationPolicyProperty.builder()
                         .timeoutInSeconds(123)
                         .build())
                 .failureHandlingPolicy("failureHandlingPolicy")
                 .build())
         .iotJobConfiguration(DeploymentIoTJobConfigurationProperty.builder()
                 .abortConfig(IoTJobAbortConfigProperty.builder()
                         .criteriaList(List.of(IoTJobAbortCriteriaProperty.builder()
                                 .action("action")
                                 .failureType("failureType")
                                 .minNumberOfExecutedThings(123)
                                 .thresholdPercentage(123)
                                 .build()))
                         .build())
                 .jobExecutionsRolloutConfig(IoTJobExecutionsRolloutConfigProperty.builder()
                         .exponentialRate(IoTJobExponentialRolloutRateProperty.builder()
                                 .baseRatePerMinute(123)
                                 .incrementFactor(123)
                                 .rateIncreaseCriteria(rateIncreaseCriteria)
                                 .build())
                         .maximumPerMinute(123)
                         .build())
                 .timeoutConfig(IoTJobTimeoutConfigProperty.builder()
                         .inProgressTimeoutInMinutes(123)
                         .build())
                 .build())
         .parentTargetArn("parentTargetArn")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDeployment

      protected CfnDeployment(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDeployment

      protected CfnDeployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDeployment

      @Stability(Stable) public CfnDeployment(@NotNull Construct scope, @NotNull String id, @NotNull CfnDeploymentProps props)
      Create a new AWS::GreengrassV2::Deployment.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrDeploymentId

      @Stability(Stable) @NotNull public String getAttrDeploymentId()
      The ID of the deployment.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Application-specific metadata to attach to the deployment.

      You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tag your AWS IoT Greengrass Version 2 resources in the AWS IoT Greengrass V2 Developer Guide .

      This Json property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags implementations in AWS CloudFormation templates. 

       "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
 }

    • getTargetArn

      @Stability(Stable) @NotNull public String getTargetArn()
      The ARN of the target AWS IoT thing or thing group.

    • setTargetArn

      @Stability(Stable) public void setTargetArn(@NotNull String value)
      The ARN of the target AWS IoT thing or thing group.

    • getComponents

      @Stability(Stable) @Nullable public Object getComponents()
      The components to deploy.

      This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.

    • setComponents

      @Stability(Stable) public void setComponents(@Nullable IResolvable value)
      The components to deploy.

      This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.

    • setComponents

      @Stability(Stable) public void setComponents(@Nullable Map<String,Object> value)
      The components to deploy.

      This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.

    • getDeploymentName

      @Stability(Stable) @Nullable public String getDeploymentName()
      The name of the deployment.

    • setDeploymentName

      @Stability(Stable) public void setDeploymentName(@Nullable String value)
      The name of the deployment.

    • getDeploymentPolicies

      @Stability(Stable) @Nullable public Object getDeploymentPolicies()
      The deployment policies for the deployment.

      These policies define how the deployment updates components and handles failure.

    • setDeploymentPolicies

      @Stability(Stable) public void setDeploymentPolicies(@Nullable IResolvable value)
      The deployment policies for the deployment.

      These policies define how the deployment updates components and handles failure.

    • setDeploymentPolicies

      @Stability(Stable) public void setDeploymentPolicies(@Nullable CfnDeployment.DeploymentPoliciesProperty value)
      The deployment policies for the deployment.

      These policies define how the deployment updates components and handles failure.

    • getIotJobConfiguration

      @Stability(Stable) @Nullable public Object getIotJobConfiguration()
      The job configuration for the deployment configuration.

      The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

    • setIotJobConfiguration

      @Stability(Stable) public void setIotJobConfiguration(@Nullable IResolvable value)
      The job configuration for the deployment configuration.

      The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

    • setIotJobConfiguration

      @Stability(Stable) public void setIotJobConfiguration(@Nullable CfnDeployment.DeploymentIoTJobConfigurationProperty value)
      The job configuration for the deployment configuration.

      The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

    • getParentTargetArn

      @Stability(Stable) @Nullable public String getParentTargetArn()
      The parent deployment's ARN for a subdeployment.

    • setParentTargetArn

      @Stability(Stable) public void setParentTargetArn(@Nullable String value)
      The parent deployment's ARN for a subdeployment.