Package software.amazon.awscdk.services.iot

Class CfnSoftwarePackageVersion

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iot.CfnSoftwarePackageVersion
All Implemented Interfaces:
IInspectable, ITaggableV2, ISoftwarePackageVersionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:40.135Z") @Stability(Stable) public class CfnSoftwarePackageVersion extends CfnResource implements IInspectable, ISoftwarePackageVersionRef, ITaggableV2
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 and Creating a software package and package version in the AWS IoT Developer Guide . See also, CreatePackageVersion 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 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 . To change the package version state after it’s created, use the UpdatePackageVersionAPI command.

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.*;
 CfnSoftwarePackageVersion cfnSoftwarePackageVersion = CfnSoftwarePackageVersion.Builder.create(this, "MyCfnSoftwarePackageVersion")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSoftwarePackageVersion

      protected CfnSoftwarePackageVersion(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSoftwarePackageVersion

      protected CfnSoftwarePackageVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSoftwarePackageVersion

      @Stability(Stable) public CfnSoftwarePackageVersion(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSoftwarePackageVersionProps props)
      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.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrErrorReason

      @Stability(Stable) @NotNull public String getAttrErrorReason()
      Error reason for a package version failure during creation or update.

    • getAttrPackageVersionArn

      @Stability(Stable) @NotNull public String getAttrPackageVersionArn()
      The Amazon Resource Name (ARN) for the package.

    • getAttrSbomValidationStatus

      @Stability(Stable) @NotNull public String getAttrSbomValidationStatus()
      The validation status of the Sbom file.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the package version.

      For more information, see Package version lifecycle .

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getSoftwarePackageVersionRef

      @Stability(Stable) @NotNull public SoftwarePackageVersionReference getSoftwarePackageVersionRef()
      A reference to a SoftwarePackageVersion resource.
      Specified by:
      getSoftwarePackageVersionRef in interface ISoftwarePackageVersionRef

    • getPackageName

      @Stability(Stable) @NotNull public String getPackageName()
      The name of the associated software package.

    • setPackageName

      @Stability(Stable) public void setPackageName(@NotNull String value)
      The name of the associated software package.

    • getArtifact

      @Stability(Stable) @Nullable public Object getArtifact()
      The artifact location of the package version.

      Returns union: either IResolvable or CfnSoftwarePackageVersion.PackageVersionArtifactProperty

    • setArtifact

      @Stability(Stable) public void setArtifact(@Nullable IResolvable value)
      The artifact location of the package version.

    • setArtifact

      @Stability(Stable) public void setArtifact(@Nullable CfnSoftwarePackageVersion.PackageVersionArtifactProperty value)
      The artifact location of the package version.

    • getAttributes

      @Stability(Stable) @Nullable public Object getAttributes()
      Metadata that can be used to define a package version’s configuration.

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

    • setAttributes

      @Stability(Stable) public void setAttributes(@Nullable Map<String,String> value)
      Metadata that can be used to define a package version’s configuration.

    • setAttributes

      @Stability(Stable) public void setAttributes(@Nullable IResolvable value)
      Metadata that can be used to define a package version’s configuration.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A summary of the package version being created.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A summary of the package version being created.

    • getRecipe

      @Stability(Stable) @Nullable public String getRecipe()
      The inline json job document associated with a software package version.

    • setRecipe

      @Stability(Stable) public void setRecipe(@Nullable String value)
      The inline json job document associated with a software package version.

    • getSbom

      @Stability(Stable) @Nullable public Object getSbom()
      The sbom zip archive location of the package version.

      Returns union: either IResolvable or CfnSoftwarePackageVersion.SbomProperty

    • setSbom

      @Stability(Stable) public void setSbom(@Nullable IResolvable value)
      The sbom zip archive location of the package version.

    • setSbom

      @Stability(Stable) public void setSbom(@Nullable CfnSoftwarePackageVersion.SbomProperty value)
      The sbom zip archive location of the package version.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Metadata that can be used to manage the package version.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Metadata that can be used to manage the package version.

    • getVersionName

      @Stability(Stable) @Nullable public String getVersionName()
      The name of the new package version.

    • setVersionName

      @Stability(Stable) public void setVersionName(@Nullable String value)
      The name of the new package version.