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	awscc.iot.software_packages

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
package_name	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	software_packages	INSERT	region
delete_resource	software_packages	DELETE	Identifier, region
update_resource	software_packages	UPDATE	Identifier, PatchDocument, region
list_resources	software_packages_list_only	SELECT	region
get_resource	software_packages	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual software_package.

SELECT
  region,
  description,
  package_arn,
  package_name,
  tags
FROM awscc.iot.software_packages
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ package_name }}';

list (identifiers only)

Lists all software_packages in a region.

SELECT
  region,
  package_name
FROM awscc.iot.software_packages_list_only
WHERE
  region = '{{ region }}';

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 awscc.iot.software_packages (
  Description,
  PackageName,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ package_name }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.iot.software_packages (
  Description,
  PackageName,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ package_name }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: package_name
      value: '{{ package_name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.iot.software_packages
SET PatchDocument = string('{{ {
    "Description": description,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ package_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.iot.software_packages
WHERE
  Identifier = '{{ package_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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