suite_definitions

Creates, updates, deletes or gets a suite_definition resource or lists suite_definitions in a region

Overview

Name	suite_definitions
Type	Resource
Description	An example resource schema demonstrating some basic constructs and validation rules.
Id	aws.iotcoredeviceadvisor.suite_definitions

Fields

Name	Datatype	Description
suite_definition_configuration	object
suite_definition_id	string	The unique identifier for the suite definition.
suite_definition_arn	string	The Amazon Resource name for the suite definition.
suite_definition_version	string	The suite definition version of a test suite.
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	SuiteDefinitionConfiguration, 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 suite_definitions in a region.

SELECT
region,
suite_definition_configuration,
suite_definition_id,
suite_definition_arn,
suite_definition_version,
tags
FROM aws.iotcoredeviceadvisor.suite_definitions
WHERE region = 'us-east-1';

Gets all properties from an individual suite_definition.

SELECT
region,
suite_definition_configuration,
suite_definition_id,
suite_definition_arn,
suite_definition_version,
tags
FROM aws.iotcoredeviceadvisor.suite_definitions
WHERE region = 'us-east-1' AND data__Identifier = '<SuiteDefinitionId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.iotcoredeviceadvisor.suite_definitions (
 SuiteDefinitionConfiguration,
 region
)
SELECT 
'{{ SuiteDefinitionConfiguration }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iotcoredeviceadvisor.suite_definitions (
 SuiteDefinitionConfiguration,
 Tags,
 region
)
SELECT 
 '{{ SuiteDefinitionConfiguration }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: suite_definition
    props:
      - name: SuiteDefinitionConfiguration
        value:
          DevicePermissionRoleArn: '{{ DevicePermissionRoleArn }}'
          Devices:
            - CertificateArn: '{{ CertificateArn }}'
              ThingArn: '{{ ThingArn }}'
          IntendedForQualification: '{{ IntendedForQualification }}'
          RootGroup: '{{ RootGroup }}'
          SuiteDefinitionName: '{{ SuiteDefinitionName }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.iotcoredeviceadvisor.suite_definitions
WHERE data__Identifier = '<SuiteDefinitionId>'
AND region = 'us-east-1';

Permissions

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

Create

iot:DescribeCertificate,
iot:DescribeThing,
iot:GetPolicy,
iot:ListAttachedPolicies,
iot:ListCertificates,
iot:ListPrincipalPolicies,
iot:ListTagsForResource,
iot:ListThingPrincipals,
iot:ListThings,
iotdeviceadvisor:CreateSuiteDefinition,
iotdeviceadvisor:TagResource,
iam:PassRole

Read

iotdeviceadvisor:GetSuiteDefinition,
iotdeviceadvisor:TagResource

Update

iot:DescribeCertificate,
iot:DescribeThing,
iot:GetPolicy,
iot:ListAttachedPolicies,
iot:ListCertificates,
iot:ListPrincipalPolicies,
iot:ListTagsForResource,
iot:ListThingPrincipals,
iot:ListThings,
iotdeviceadvisor:UpdateSuiteDefinition,
iotdeviceadvisor:GetSuiteDefinition,
iotdeviceadvisor:UntagResource,
iotdeviceadvisor:TagResource,
iam:PassRole

Delete

iotdeviceadvisor:GetSuiteDefinition,
iotdeviceadvisor:DeleteSuiteDefinition

List

iotdeviceadvisor:ListSuiteDefinitions