software_packages

Creates, updates, deletes or gets a software_package resource or lists software_packages in a region

Overview

Name	software_packages
Type	Resource
Description	resource definition
Id	aws.iot.software_packages

Fields

Name	Datatype	Description
description	string
package_arn	string
package_name	string
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	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 software_packages in a region.

SELECT
region,
description,
package_arn,
package_name,
tags
FROM aws.iot.software_packages
WHERE region = 'us-east-1';

Gets all properties from an individual software_package.

SELECT
region,
description,
package_arn,
package_name,
tags
FROM aws.iot.software_packages
WHERE region = 'us-east-1' AND data__Identifier = '<PackageName>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.iot.software_packages (
 Description,
 PackageName,
 Tags,
 region
)
SELECT 
'{{ Description }}',
 '{{ PackageName }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iot.software_packages (
 Description,
 PackageName,
 Tags,
 region
)
SELECT 
 '{{ Description }}',
 '{{ PackageName }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: software_package
    props:
      - name: Description
        value: '{{ Description }}'
      - name: PackageName
        value: '{{ PackageName }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.iot.software_packages
WHERE data__Identifier = '<PackageName>'
AND region = 'us-east-1';

Permissions

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

Create

iot:CreatePackage,
iot:GetPackage,
iot:TagResource,
iot:GetIndexingConfiguration

Read

iot:GetPackage,
iot:ListTagsForResource

Update

iot:CreatePackage,
iot:UpdatePackage,
iot:GetPackage,
iot:ListTagsForResource,
iot:TagResource,
iot:UntagResource,
iot:GetIndexingConfiguration

Delete

iot:DeletePackage,
iot:DeletePackageVersion,
iot:GetPackage,
iot:GetPackageVersion,
iot:UpdatePackage,
iot:UpdatePackageVersion,
iot:GetIndexingConfiguration,
iot:ListPackageVersions

List

iot:ListPackages