Skip to content
v2.275.0

CfnSoftwarePackageVersionProps Struct ​

Properties for defining a CfnSoftwarePackageVersion.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iot as iot } from 'aws-cdk-lib';
const cfnSoftwarePackageVersionProps: iot.CfnSoftwarePackageVersionProps = {
  packageName: 'packageName',

  // the properties below are optional
  artifact: {
    s3Location: {
      bucket: 'bucket',
      key: 'key',
      version: 'version',
    },
  },
  attributes: {
    attributesKey: 'attributes',
  },
  description: 'description',
  recipe: 'recipe',
  sbom: {
    s3Location: {
      bucket: 'bucket',
      key: 'key',
      version: 'version',
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  versionName: 'versionName',
};

Properties ​

artifactoptionalIResolvable | CfnSoftwarePackageVersion.PackageVersionArtifactPropertyartifactoptionaltyping.Union[IResolvable, PackageVersionArtifactProperty]artifactoptionalIResolvableArtifactoptionalIResolvableArtifactoptionalinterface{}#
The artifact location of the package version.
attributesoptionalIResolvable | { [key: string]: string }attributesoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]attributesoptionalIResolvableAttributesoptionalIResolvableAttributesoptionalinterface{}#
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.

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A summary of the package version being created.

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

packageNamestringpackage_namestrpackageNameStringPackageNamestringPackageName*stringrequired#
The name of the associated software package.
recipeoptionalstringrecipeoptionalstrrecipeoptionalStringRecipeoptionalstringRecipeoptional*string#
The inline json job document associated with a software package version.
sbomoptionalIResolvable | CfnSoftwarePackageVersion.SbomPropertysbomoptionaltyping.Union[IResolvable, SbomProperty]sbomoptionalIResolvableSbomoptionalIResolvableSbomoptionalinterface{}#
The sbom zip archive location of the package version.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
Metadata that can be used to manage the package version.
versionNameoptionalstringversion_nameoptionalstrversionNameoptionalStringVersionNameoptionalstringVersionNameoptional*string#
The name of the new package version.