Package software.amazon.awscdk.services.greengrassv2

Class CfnDeploymentProps.Builder

java.lang.Object

software.amazon.awscdk.services.greengrassv2.CfnDeploymentProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDeploymentProps>

Enclosing interface:

CfnDeploymentProps

@Stability(Stable)
public static final class CfnDeploymentProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDeploymentProps>

A builder for CfnDeploymentProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDeploymentProps	build()	Builds the configured instance.
CfnDeploymentProps.Builder	components(Map<String,? extends Object> components)	Sets the value of CfnDeploymentProps.getComponents()
CfnDeploymentProps.Builder	components(IResolvable components)	Sets the value of CfnDeploymentProps.getComponents()
CfnDeploymentProps.Builder	deploymentName(String deploymentName)	Sets the value of CfnDeploymentProps.getDeploymentName()
CfnDeploymentProps.Builder	deploymentPolicies(IResolvable deploymentPolicies)	Sets the value of CfnDeploymentProps.getDeploymentPolicies()
CfnDeploymentProps.Builder	deploymentPolicies(CfnDeployment.DeploymentPoliciesProperty deploymentPolicies)	Sets the value of CfnDeploymentProps.getDeploymentPolicies()
CfnDeploymentProps.Builder	iotJobConfiguration(IResolvable iotJobConfiguration)	Sets the value of CfnDeploymentProps.getIotJobConfiguration()
CfnDeploymentProps.Builder	iotJobConfiguration(CfnDeployment.DeploymentIoTJobConfigurationProperty iotJobConfiguration)	Sets the value of CfnDeploymentProps.getIotJobConfiguration()
CfnDeploymentProps.Builder	parentTargetArn(String parentTargetArn)	Sets the value of CfnDeploymentProps.getParentTargetArn()
CfnDeploymentProps.Builder	tags(Map<String,String> tags)	Sets the value of CfnDeploymentProps.getTags()
CfnDeploymentProps.Builder	targetArn(String targetArn)	Sets the value of CfnDeploymentProps.getTargetArn()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

targetArn

@Stability(Stable)
public CfnDeploymentProps.Builder targetArn(String targetArn)

Sets the value of CfnDeploymentProps.getTargetArn()

Parameters:

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

Returns:

this

components

@Stability(Stable)
public CfnDeploymentProps.Builder components(IResolvable components)

Sets the value of CfnDeploymentProps.getComponents()

Parameters:

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.

Returns:

this

components

@Stability(Stable)
public CfnDeploymentProps.Builder components(Map<String,? extends Object> components)

Sets the value of CfnDeploymentProps.getComponents()

Parameters:

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.

Returns:

this

deploymentName

@Stability(Stable)
public CfnDeploymentProps.Builder deploymentName(String deploymentName)

Sets the value of CfnDeploymentProps.getDeploymentName()

Parameters:

deploymentName - The name of the deployment.

Returns:

this

deploymentPolicies

@Stability(Stable)
public CfnDeploymentProps.Builder deploymentPolicies(IResolvable deploymentPolicies)

Sets the value of CfnDeploymentProps.getDeploymentPolicies()

Parameters:

deploymentPolicies - The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.

Returns:

this

deploymentPolicies

@Stability(Stable)
public CfnDeploymentProps.Builder deploymentPolicies(CfnDeployment.DeploymentPoliciesProperty deploymentPolicies)

Sets the value of CfnDeploymentProps.getDeploymentPolicies()

Parameters:

deploymentPolicies - The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.

Returns:

this

iotJobConfiguration

@Stability(Stable)
public CfnDeploymentProps.Builder iotJobConfiguration(IResolvable iotJobConfiguration)

Sets the value of CfnDeploymentProps.getIotJobConfiguration()

Parameters:

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

Returns:

this

iotJobConfiguration

@Stability(Stable)
public CfnDeploymentProps.Builder iotJobConfiguration(CfnDeployment.DeploymentIoTJobConfigurationProperty iotJobConfiguration)

Sets the value of CfnDeploymentProps.getIotJobConfiguration()

Parameters:

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

Returns:

this

parentTargetArn

@Stability(Stable)
public CfnDeploymentProps.Builder parentTargetArn(String parentTargetArn)

Sets the value of CfnDeploymentProps.getParentTargetArn()

Parameters:

parentTargetArn - The parent deployment's ARN for a subdeployment.

Returns:

this

tags

@Stability(Stable)
public CfnDeploymentProps.Builder tags(Map<String,String> tags)

Sets the value of CfnDeploymentProps.getTags()

Parameters:

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"
             }
             

Returns:

this

build

@Stability(Stable)
public CfnDeploymentProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDeploymentProps>

Returns:

a new instance of CfnDeploymentProps

Throws:

NullPointerException - if any required attribute was not provided