Package software.amazon.awscdk.services.iot

Interface CfnSoftwarePackageVersionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSoftwarePackageVersionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-12-01T16:02:22.510Z")
@Stability(Stable)
public interface CfnSoftwarePackageVersionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSoftwarePackageVersion.

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.iot.*;
 CfnSoftwarePackageVersionProps cfnSoftwarePackageVersionProps = CfnSoftwarePackageVersionProps.builder()
         .packageName("packageName")
         // the properties below are optional
         .artifact(PackageVersionArtifactProperty.builder()
                 .s3Location(S3LocationProperty.builder()
                         .bucket("bucket")
                         .key("key")
                         .version("version")
                         .build())
                 .build())
         .attributes(Map.of(
                 "attributesKey", "attributes"))
         .description("description")
         .recipe("recipe")
         .sbom(SbomProperty.builder()
                 .s3Location(S3LocationProperty.builder()
                         .bucket("bucket")
                         .key("key")
                         .version("version")
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .versionName("versionName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSoftwarePackageVersionProps.Builder	A builder for CfnSoftwarePackageVersionProps
static final class	CfnSoftwarePackageVersionProps.Jsii$Proxy	An implementation for CfnSoftwarePackageVersionProps

Method Summary

Modifier and Type	Method	Description
static CfnSoftwarePackageVersionProps.Builder	builder()
default Object	getArtifact()	The artifact location of the package version.
default Object	getAttributes()	Metadata that can be used to define a package version’s configuration.
default String	getDescription()	A summary of the package version being created.
String	getPackageName()	The name of the associated software package.
default String	getRecipe()	The inline json job document associated with a software package version.
default Object	getSbom()	The sbom zip archive location of the package version.
default List<CfnTag>	getTags()	Metadata that can be used to manage the package version.
default String	getVersionName()	The name of the new package version.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPackageName

@Stability(Stable)
@NotNull
String getPackageName()

The name of the associated software package.

See Also:

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

getArtifact

@Stability(Stable)
@Nullable
default Object getArtifact()

The artifact location of the package version.

Returns union: either IResolvable or CfnSoftwarePackageVersion.PackageVersionArtifactProperty

See Also:

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

getAttributes

@Stability(Stable)
@Nullable
default Object getAttributes()

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.

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A summary of the package version being created.

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

See Also:

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

getRecipe

@Stability(Stable)
@Nullable
default String getRecipe()

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

See Also:

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

getSbom

@Stability(Stable)
@Nullable
default Object getSbom()

The sbom zip archive location of the package version.

Returns union: either IResolvable or CfnSoftwarePackageVersion.SbomProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Metadata that can be used to manage the package version.

See Also:

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

getVersionName

@Stability(Stable)
@Nullable
default String getVersionName()

The name of the new package version.

See Also:

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

builder

@Stability(Stable)
static CfnSoftwarePackageVersionProps.Builder builder()

Returns:

a CfnSoftwarePackageVersionProps.Builder of CfnSoftwarePackageVersionProps