software_package_versions

Creates, updates, deletes or gets a software_package_version resource or lists software_package_versions in a region

Overview

Name	software_package_versions
Type	Resource
Description	resource definition
Id	awscc.iot.software_package_versions

Fields

get (all properties)

Name	Datatype	Description
attributes	object
▶artifact	object	The artifact location of the package version
description	string
error_reason	string
package_name	string
package_version_arn	string
recipe	string	The inline json job document associated with a software package version
▶sbom	object	The sbom zip archive location of the package version
sbom_validation_status	string	The validation status of the Sbom file
status	string
▶tags	array	An array of key-value pairs to apply to this resource.
version_name	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
package_name	string
version_name	string
region	string	AWS region.

For more information, see AWS::IoT::SoftwarePackageVersion.

Methods

Name	Resource	Accessible by	Required Params
create_resource	software_package_versions	INSERT	PackageName, region
delete_resource	software_package_versions	DELETE	Identifier, region
update_resource	software_package_versions	UPDATE	Identifier, PatchDocument, region
list_resources	software_package_versions_list_only	SELECT	region
get_resource	software_package_versions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual software_package_version.

SELECT
  region,
  attributes,
  artifact,
  description,
  error_reason,
  package_name,
  package_version_arn,
  recipe,
  sbom,
  sbom_validation_status,
  status,
  tags,
  version_name
FROM awscc.iot.software_package_versions
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ package_name }}|{{ version_name }}';

list (identifiers only)

Lists all software_package_versions in a region.

SELECT
  region,
  package_name,
  version_name
FROM awscc.iot.software_package_versions_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new software_package_version resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.iot.software_package_versions (
  PackageName,
  region
)
SELECT
  '{{ package_name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.iot.software_package_versions (
  Attributes,
  Artifact,
  Description,
  PackageName,
  Recipe,
  Sbom,
  Tags,
  VersionName,
  region
)
SELECT
  '{{ attributes }}',
  '{{ artifact }}',
  '{{ description }}',
  '{{ package_name }}',
  '{{ recipe }}',
  '{{ sbom }}',
  '{{ tags }}',
  '{{ version_name }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: software_package_version
    props:
      - name: attributes
        value: {}
      - name: artifact
        value:
          s3_location:
            bucket: '{{ bucket }}'
            key: '{{ key }}'
            version: '{{ version }}'
      - name: description
        value: '{{ description }}'
      - name: package_name
        value: '{{ package_name }}'
      - name: recipe
        value: '{{ recipe }}'
      - name: sbom
        value:
          s3_location: null
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: version_name
        value: '{{ version_name }}'

UPDATE example

Use the following StackQL query and manifest file to update a software_package_version resource, using stack-deploy.

/*+ update */
UPDATE awscc.iot.software_package_versions
SET PatchDocument = string('{{ {
    "Attributes": attributes,
    "Artifact": artifact,
    "Description": description,
    "Recipe": recipe,
    "Sbom": sbom,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ package_name }}|{{ version_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.iot.software_package_versions
WHERE
  Identifier = '{{ package_name }}|{{ version_name }}' AND
  region = 'us-east-1';

Permissions

To operate on the software_package_versions resource, the following permissions are required:

Create

iot:CreatePackageVersion,
iot:GetPackageVersion,
iot:ListTagsForResource,
iot:TagResource,
iot:GetIndexingConfiguration,
s3:GetObjectVersion,
iot:AssociateSbomWithPackageVersion

Read

iot:GetPackageVersion,
iot:ListTagsForResource

Update

iot:UpdatePackageVersion,
iot:GetPackageVersion,
iot:ListTagsForResource,
iot:TagResource,
iot:UntagResource,
iot:GetIndexingConfiguration,
s3:GetObjectVersion,
iot:AssociateSbomWithPackageVersion,
iot:DisassociateSbomFromPackageVersion

Delete

iot:DeletePackageVersion,
iot:UpdatePackageVersion,
iot:GetPackageVersion,
iot:GetIndexingConfiguration

List

iot:ListPackageVersions