AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::IoT::SoftwarePackageVersion

CfnSoftwarePackageVersion

Use the `AWS::IoT::SoftwarePackageVersion` resource to create a software package version. For information about working with software package versions, see [AWS IoT Device Management Software Package Catalog](https://docs.aws.amazon.com/iot/latest/developerguide/software-package-catalog.html) and [Creating a software package and package version](https://docs.aws.amazon.com/iot/latest/developerguide/creating-package-and-version.html) in the *AWS IoT Developer Guide* . See also, [CreatePackageVersion](https://docs.aws.amazon.com/iot/latest/apireference/API_CreatePackageVersion.html) in the *API Guide* . > The associated software package must exist before the package version is created. If you create a software package and package version in the same CloudFormation template, set the software package as a [dependency](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) of the package version. If they are created out of sequence, you will receive an error. > > Package versions and created in a `draft` state, for more information, see [Package version lifecycle](https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle) . To change the package version state after it’s created, use the [UpdatePackageVersionAPI](https://docs.aws.amazon.com/iot/latest/apireference/API_UpdatePackageVersion.html) command.

Import

import { CfnSoftwarePackageVersion } from 'aws-cdk-lib/aws-iot';

Or use the module namespace:

import * as iot from 'aws-cdk-lib/aws-iot';
// iot.CfnSoftwarePackageVersion

Properties

Configuration passed to the constructor as CfnSoftwarePackageVersionProps.

packageNameRequired
string

The name of the associated software package.

artifactOptional
IResolvable | PackageVersionArtifactProperty

The artifact location of the package version.

attributesOptional
{ [key: string]: string } | IResolvable

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.

descriptionOptional
string

A summary of the package version being created. This can be used to outline the package's contents or purpose.

recipeOptional
string

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

sbomOptional
IResolvable | SbomProperty

The sbom zip archive location of the package version.

tagsOptional
CfnTag[]

Metadata that can be used to manage the package version.

versionNameOptional
string

The name of the new package version.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::IoT::SoftwarePackageVersionView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-iot
CFN TypeAWS::IoT::SoftwarePackageVersion
Properties8

Related Constructs

Explore This Service

External Links