component_versions

Creates, updates, deletes or gets a component_version resource or lists component_versions in a region

Overview

Name	component_versions
Type	Resource
Description	Resource for Greengrass component version.
Id	awscc.greengrassv2.component_versions

Fields

get (all properties)

Name	Datatype	Description
arn	string
component_name	string
component_version	string
inline_recipe	string
▶lambda_function	object
tags	object
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

For more information, see AWS::GreengrassV2::ComponentVersion.

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual component_version.

SELECT
  region,
  arn,
  component_name,
  component_version,
  inline_recipe,
  lambda_function,
  tags
FROM awscc.greengrassv2.component_versions
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all component_versions in a region.

SELECT
  region,
  arn
FROM awscc.greengrassv2.component_versions_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.greengrassv2.component_versions (
  InlineRecipe,
  LambdaFunction,
  Tags,
  region
)
SELECT
  '{{ inline_recipe }}',
  '{{ lambda_function }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.greengrassv2.component_versions (
  InlineRecipe,
  LambdaFunction,
  Tags,
  region
)
SELECT
  '{{ inline_recipe }}',
  '{{ lambda_function }}',
  '{{ 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: component_version
  props:
    - name: inline_recipe
      value: '{{ inline_recipe }}'
    - name: lambda_function
      value:
        lambda_arn: '{{ lambda_arn }}'
        component_name: '{{ component_name }}'
        component_version: '{{ component_version }}'
        component_platforms:
          - name: '{{ name }}'
            attributes: {}
        component_dependencies: {}
        component_lambda_parameters:
          event_sources:
            - topic: '{{ topic }}'
              type: '{{ type }}'
          max_queue_size: '{{ max_queue_size }}'
          max_instances_count: '{{ max_instances_count }}'
          max_idle_time_in_seconds: '{{ max_idle_time_in_seconds }}'
          timeout_in_seconds: '{{ timeout_in_seconds }}'
          status_timeout_in_seconds: '{{ status_timeout_in_seconds }}'
          pinned: '{{ pinned }}'
          input_payload_encoding_type: '{{ input_payload_encoding_type }}'
          exec_args:
            - '{{ exec_args[0] }}'
          environment_variables: {}
          linux_process_params:
            isolation_mode: '{{ isolation_mode }}'
            container_params:
              memory_size_in_kb: '{{ memory_size_in_kb }}'
              mount_ro_sysfs: '{{ mount_ro_sysfs }}'
              volumes:
                - source_path: '{{ source_path }}'
                  destination_path: null
                  permission: '{{ permission }}'
                  add_group_owner: '{{ add_group_owner }}'
              devices:
                - path: null
                  permission: null
                  add_group_owner: null
    - name: tags
      value: {}

UPDATE example

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

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

DELETE example

/*+ delete */
DELETE FROM awscc.greengrassv2.component_versions
WHERE
  Identifier = '{{ arn }}' 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 component_versions resource, the following permissions are required:

Create

greengrass:CreateComponentVersion,
greengrass:DescribeComponent,
greengrass:ListTagsForResource,
greengrass:TagResource,
lambda:GetFunction,
s3:GetObject

Read

greengrass:DescribeComponent,
greengrass:ListTagsForResource

Update

greengrass:DescribeComponent,
greengrass:ListTagsForResource,
greengrass:TagResource,
greengrass:UntagResource

Delete

greengrass:DeleteComponent

List

greengrass:ListComponentVersions