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	awscc.iotcoredeviceadvisor.suite_definitions

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
suite_definition_id	string	The unique identifier for the suite definition.
region	string	AWS region.

For more information, see AWS::IoTCoreDeviceAdvisor::SuiteDefinition.

Methods

Name	Resource	Accessible by	Required Params
create_resource	suite_definitions	INSERT	SuiteDefinitionConfiguration, region
delete_resource	suite_definitions	DELETE	Identifier, region
update_resource	suite_definitions	UPDATE	Identifier, PatchDocument, region
list_resources	suite_definitions_list_only	SELECT	region
get_resource	suite_definitions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual suite_definition.

SELECT
  region,
  suite_definition_configuration,
  suite_definition_id,
  suite_definition_arn,
  suite_definition_version,
  tags
FROM awscc.iotcoredeviceadvisor.suite_definitions
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ suite_definition_id }}';

list (identifiers only)

Lists all suite_definitions in a region.

SELECT
  region,
  suite_definition_id
FROM awscc.iotcoredeviceadvisor.suite_definitions_list_only
WHERE
  region = 'us-east-1';

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 awscc.iotcoredeviceadvisor.suite_definitions (
  SuiteDefinitionConfiguration,
  region
)
SELECT
  '{{ suite_definition_configuration }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.iotcoredeviceadvisor.suite_definitions (
  SuiteDefinitionConfiguration,
  Tags,
  region
)
SELECT
  '{{ suite_definition_configuration }}',
  '{{ 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: suite_definition_configuration
        value:
          device_permission_role_arn: '{{ device_permission_role_arn }}'
          devices:
            - certificate_arn: '{{ certificate_arn }}'
              thing_arn: '{{ thing_arn }}'
          intended_for_qualification: '{{ intended_for_qualification }}'
          root_group: '{{ root_group }}'
          suite_definition_name: '{{ suite_definition_name }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.iotcoredeviceadvisor.suite_definitions
SET PatchDocument = string('{{ {
    "SuiteDefinitionConfiguration": suite_definition_configuration,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ suite_definition_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.iotcoredeviceadvisor.suite_definitions
WHERE
  Identifier = '{{ suite_definition_id }}' 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:ListThingPrincipals,
iot:ListThings,
iotdeviceadvisor:CreateSuiteDefinition,
iotdeviceadvisor:TagResource,
iam:PassRole

Read

iotdeviceadvisor:GetSuiteDefinition,
iot:ListTagsForResource

Update

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

Delete

iotdeviceadvisor:GetSuiteDefinition,
iotdeviceadvisor:DeleteSuiteDefinition

List

iotdeviceadvisor:ListSuiteDefinitions