Package software.amazon.awscdk.services.greengrassv2

Class CfnDeployment.Builder

java.lang.Object
software.amazon.awscdk.services.greengrassv2.CfnDeployment.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDeployment>
Enclosing class:
CfnDeployment
@Stability(Stable) public static final class CfnDeployment.Builder extends Object implements software.amazon.jsii.Builder<CfnDeployment>
A fluent builder for CfnDeployment.

  • Method Details

    • create

      @Stability(Stable) public static CfnDeployment.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnDeployment.Builder.

    • targetArn

      @Stability(Stable) public CfnDeployment.Builder targetArn(String targetArn)
      The ARN of the target AWS IoT thing or thing group.

      Parameters:
      targetArn - The ARN of the target AWS IoT thing or thing group. This parameter is required.
      Returns:
      this

    • components

      @Stability(Stable) public CfnDeployment.Builder components(IResolvable components)
      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.

      Parameters:
      components - The components to deploy. This parameter is required.
      Returns:
      this

    • components

      @Stability(Stable) public CfnDeployment.Builder components(Map<String,? extends Object> components)
      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.

      Parameters:
      components - The components to deploy. This parameter is required.
      Returns:
      this

    • deploymentName

      @Stability(Stable) public CfnDeployment.Builder deploymentName(String deploymentName)
      The name of the deployment.

      Parameters:
      deploymentName - The name of the deployment. This parameter is required.
      Returns:
      this

    • deploymentPolicies

      @Stability(Stable) public CfnDeployment.Builder deploymentPolicies(IResolvable deploymentPolicies)
      The deployment policies for the deployment.

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

      Parameters:
      deploymentPolicies - The deployment policies for the deployment. This parameter is required.
      Returns:
      this

    • deploymentPolicies

      @Stability(Stable) public CfnDeployment.Builder deploymentPolicies(CfnDeployment.DeploymentPoliciesProperty deploymentPolicies)
      The deployment policies for the deployment.

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

      Parameters:
      deploymentPolicies - The deployment policies for the deployment. This parameter is required.
      Returns:
      this

    • iotJobConfiguration

      @Stability(Stable) public CfnDeployment.Builder iotJobConfiguration(IResolvable iotJobConfiguration)
      The job configuration for the deployment configuration.

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

      Parameters:
      iotJobConfiguration - The job configuration for the deployment configuration. This parameter is required.
      Returns:
      this

    • iotJobConfiguration

      @Stability(Stable) public CfnDeployment.Builder iotJobConfiguration(CfnDeployment.DeploymentIoTJobConfigurationProperty iotJobConfiguration)
      The job configuration for the deployment configuration.

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

      Parameters:
      iotJobConfiguration - The job configuration for the deployment configuration. This parameter is required.
      Returns:
      this

    • parentTargetArn

      @Stability(Stable) public CfnDeployment.Builder parentTargetArn(String parentTargetArn)
      The parent deployment's ARN for a subdeployment.

      Parameters:
      parentTargetArn - The parent deployment's ARN for a subdeployment. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnDeployment.Builder tags(Map<String,String> tags)
      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"
 }

      Parameters:
      tags - Application-specific metadata to attach to the deployment. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnDeployment build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDeployment>
      Returns:
      a newly built instance of CfnDeployment.