Package software.amazon.awscdk.cfnpropertymixins.services.greengrassv2

Class CfnDeploymentPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.greengrassv2.CfnDeploymentPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDeploymentPropsMixin>

Enclosing class:

CfnDeploymentPropsMixin

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

A fluent builder for CfnDeploymentPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnDeploymentPropsMixin	build()
CfnDeploymentPropsMixin.Builder	components(Map<String,? extends Object> components)	The components to deploy.
CfnDeploymentPropsMixin.Builder	components(IResolvable components)	The components to deploy.
static CfnDeploymentPropsMixin.Builder	create()
static CfnDeploymentPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnDeploymentPropsMixin.Builder	deploymentName(String deploymentName)	The name of the deployment.
CfnDeploymentPropsMixin.Builder	deploymentPolicies(CfnDeploymentPropsMixin.DeploymentPoliciesProperty deploymentPolicies)	The deployment policies for the deployment.
CfnDeploymentPropsMixin.Builder	deploymentPolicies(IResolvable deploymentPolicies)	The deployment policies for the deployment.
CfnDeploymentPropsMixin.Builder	iotJobConfiguration(CfnDeploymentPropsMixin.DeploymentIoTJobConfigurationProperty iotJobConfiguration)	The job configuration for the deployment configuration.
CfnDeploymentPropsMixin.Builder	iotJobConfiguration(IResolvable iotJobConfiguration)	The job configuration for the deployment configuration.
CfnDeploymentPropsMixin.Builder	parentTargetArn(String parentTargetArn)	The parent deployment's ARN for a subdeployment.
CfnDeploymentPropsMixin.Builder	tags(Map<String,String> tags)	Application-specific metadata to attach to the deployment.
CfnDeploymentPropsMixin.Builder	targetArn(String targetArn)	The ARN of the target AWS IoT thing or thing group.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnDeploymentPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnDeploymentPropsMixin.Builder.

create

@Stability(Stable)
public static CfnDeploymentPropsMixin.Builder create()

Returns:

a new instance of CfnDeploymentPropsMixin.Builder.

components

@Stability(Stable)
public CfnDeploymentPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-components

components

@Stability(Stable)
public CfnDeploymentPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-components

deploymentName

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

The name of the deployment.

Parameters:

deploymentName - The name of the deployment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-deploymentname

deploymentPolicies

@Stability(Stable)
public CfnDeploymentPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-deploymentpolicies

deploymentPolicies

@Stability(Stable)
public CfnDeploymentPropsMixin.Builder deploymentPolicies(CfnDeploymentPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-deploymentpolicies

iotJobConfiguration

@Stability(Stable)
public CfnDeploymentPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-iotjobconfiguration

iotJobConfiguration

@Stability(Stable)
public CfnDeploymentPropsMixin.Builder iotJobConfiguration(CfnDeploymentPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-iotjobconfiguration

parentTargetArn

@Stability(Stable)
public CfnDeploymentPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-parenttargetarn

tags

@Stability(Stable)
public CfnDeploymentPropsMixin.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 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-tags

targetArn

@Stability(Stable)
public CfnDeploymentPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-targetarn

build

@Stability(Stable)
public CfnDeploymentPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnDeploymentPropsMixin.