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

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.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	PackageName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

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 data__Identifier = '<PackageName>|<VersionName>';

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 
'{{ PackageName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.iot.software_package_versions (
 Attributes,
 Artifact,
 Description,
 PackageName,
 Recipe,
 Sbom,
 Tags,
 VersionName,
 region
)
SELECT 
 '{{ Attributes }}',
 '{{ Artifact }}',
 '{{ Description }}',
 '{{ PackageName }}',
 '{{ Recipe }}',
 '{{ Sbom }}',
 '{{ Tags }}',
 '{{ VersionName }}',
 '{{ 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:
          S3Location:
            Bucket: '{{ Bucket }}'
            Key: '{{ Key }}'
            Version: '{{ Version }}'
      - name: Description
        value: '{{ Description }}'
      - name: PackageName
        value: '{{ PackageName }}'
      - name: Recipe
        value: '{{ Recipe }}'
      - name: Sbom
        value:
          S3Location: null
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: VersionName
        value: '{{ VersionName }}'

DELETE example

/*+ delete */
DELETE FROM awscc.iot.software_package_versions
WHERE data__Identifier = '<PackageName|VersionName>'
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