Package software.amazon.awscdk.services.iot

Class CfnSoftwarePackageVersion.Builder

java.lang.Object

software.amazon.awscdk.services.iot.CfnSoftwarePackageVersion.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSoftwarePackageVersion>

Enclosing class:

CfnSoftwarePackageVersion

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

A fluent builder for CfnSoftwarePackageVersion.

Method Summary

Modifier and Type	Method	Description
CfnSoftwarePackageVersion.Builder	artifact(IResolvable artifact)	The artifact location of the package version.
CfnSoftwarePackageVersion.Builder	artifact(CfnSoftwarePackageVersion.PackageVersionArtifactProperty artifact)	The artifact location of the package version.
CfnSoftwarePackageVersion.Builder	attributes(Map<String,String> attributes)	Metadata that can be used to define a package version’s configuration.
CfnSoftwarePackageVersion.Builder	attributes(IResolvable attributes)	Metadata that can be used to define a package version’s configuration.
CfnSoftwarePackageVersion	build()
static CfnSoftwarePackageVersion.Builder	create(software.constructs.Construct scope, String id)
CfnSoftwarePackageVersion.Builder	description(String description)	A summary of the package version being created.
CfnSoftwarePackageVersion.Builder	packageName(String packageName)	The name of the associated software package.
CfnSoftwarePackageVersion.Builder	recipe(String recipe)	The inline json job document associated with a software package version.
CfnSoftwarePackageVersion.Builder	sbom(IResolvable sbom)	The sbom zip archive location of the package version.
CfnSoftwarePackageVersion.Builder	sbom(CfnSoftwarePackageVersion.SbomProperty sbom)	The sbom zip archive location of the package version.
CfnSoftwarePackageVersion.Builder	tags(List<? extends CfnTag> tags)	Metadata that can be used to manage the package version.
CfnSoftwarePackageVersion.Builder	versionName(String versionName)	The name of the new package version.

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 CfnSoftwarePackageVersion.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnSoftwarePackageVersion.Builder.

packageName

@Stability(Stable)
public CfnSoftwarePackageVersion.Builder packageName(String packageName)

The name of the associated software package.

Parameters:

packageName - The name of the associated software package. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-packagename

artifact

@Stability(Stable)
public CfnSoftwarePackageVersion.Builder artifact(IResolvable artifact)

The artifact location of the package version.

Parameters:

artifact - The artifact location of the package version. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-artifact

artifact

@Stability(Stable)
public CfnSoftwarePackageVersion.Builder artifact(CfnSoftwarePackageVersion.PackageVersionArtifactProperty artifact)

The artifact location of the package version.

Parameters:

artifact - The artifact location of the package version. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-artifact

attributes

@Stability(Stable)
public CfnSoftwarePackageVersion.Builder attributes(Map<String,String> attributes)

Metadata that can be used to define a package version’s configuration.

For example, the S3 file location, configuration options that are being sent to the device or fleet.

The combined size of all the attributes on a package version is limited to 3KB.

Parameters:

attributes - Metadata that can be used to define a package version’s configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-attributes

attributes

@Stability(Stable)
public CfnSoftwarePackageVersion.Builder attributes(IResolvable attributes)

Metadata that can be used to define a package version’s configuration.

For example, the S3 file location, configuration options that are being sent to the device or fleet.

The combined size of all the attributes on a package version is limited to 3KB.

Parameters:

attributes - Metadata that can be used to define a package version’s configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-attributes

description

@Stability(Stable)
public CfnSoftwarePackageVersion.Builder description(String description)

A summary of the package version being created.

This can be used to outline the package's contents or purpose.

Parameters:

description - A summary of the package version being created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-description

recipe

@Stability(Stable)
public CfnSoftwarePackageVersion.Builder recipe(String recipe)

The inline json job document associated with a software package version.

Parameters:

recipe - The inline json job document associated with a software package version. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-recipe

sbom

@Stability(Stable)
public CfnSoftwarePackageVersion.Builder sbom(IResolvable sbom)

The sbom zip archive location of the package version.

Parameters:

sbom - The sbom zip archive location of the package version. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-sbom

sbom

@Stability(Stable)
public CfnSoftwarePackageVersion.Builder sbom(CfnSoftwarePackageVersion.SbomProperty sbom)

The sbom zip archive location of the package version.

Parameters:

sbom - The sbom zip archive location of the package version. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-sbom

tags

@Stability(Stable)
public CfnSoftwarePackageVersion.Builder tags(List<? extends CfnTag> tags)

Metadata that can be used to manage the package version.

Parameters:

tags - Metadata that can be used to manage the package version. This parameter is required.

Returns:

this

See Also:

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

versionName

@Stability(Stable)
public CfnSoftwarePackageVersion.Builder versionName(String versionName)

The name of the new package version.

Parameters:

versionName - The name of the new package version. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-versionname

build

@Stability(Stable)
public CfnSoftwarePackageVersion build()

Specified by:

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

Returns:

a newly built instance of CfnSoftwarePackageVersion.