AWS::IoTCoreDeviceAdvisor::SuiteDefinition - AWS CloudFormation

AWS::IoTCoreDeviceAdvisor::SuiteDefinition

Creates a Device Advisor test suite.

Requires permission to access the CreateSuiteDefinition action.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::IoTCoreDeviceAdvisor::SuiteDefinition", "Properties" : { "SuiteDefinitionConfiguration" : Json, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::IoTCoreDeviceAdvisor::SuiteDefinition Properties: SuiteDefinitionConfiguration: Json Tags: - Tag

Properties

SuiteDefinitionConfiguration

The configuration of the Suite Definition. Listed below are the required elements of the SuiteDefinitionConfiguration.

devicePermissionRoleArn

The device permission arn.

This is a required element.

Type: String

devices

The list of configured devices under test. For more information on devices under test, see DeviceUnderTest

Not a required element.

Type: List of devices under test

intendedForQualification

The tests intended for qualification in a suite.

Not a required element.

Type: Boolean

rootGroup

The test suite root group. For more information on creating and using root groups see the Device Advisor workflow.

This is a required element.

Type: String

suiteDefinitionName

The Suite Definition Configuration name.

This is a required element.

Type: String

Required: Yes

Type: Json

Update requires: No interruption

Tags

Metadata that can be used to manage the the Suite Definition.

Required: No

Type: List of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Suite Definition name.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

SuiteDefinitionArn

The Arn of the Suite Definition.

SuiteDefinitionId

The version of the Suite Definition.

SuiteDefinitionVersion

The ID of the Suite Definition.

Examples

The following example is a template of a SuiteDefintion.

JSON

{ "Resources": { "TestSuiteDefinition": { "Type": "AWS::IoTCoreDeviceAdvisor::SuiteDefinition", "Properties": { "SuiteDefinitionConfiguration": { "SuiteDefinitionName": "SuiteDefinitionName", "DevicePermissionRoleArn": "arn:aws:iam::123456789012:role/RoleName", "Devices": [ { "ThingArn": "arn:aws:iot:us-east-1:123456789012:thing/ThingName" } ], "RootGroup": "{\n\"configuration\": {},\n\"tests\": [{\n\"name\": \"TestGroup\",\n\"configuration\": {\n\"EXECUTION_TIMEOUT\": \"30\"\n},\n\"tests\": [{\n\"name\": \"MQTTPublishTest\",\n\"configuration\": {\n\"TOPIC_FOR_PUBLISH_VALIDATION\": \"target\"\n},\n\"test\": {\n\"id\": \"MQTT_Publish\",\n\"version\": \"0.0.0\"\n}\n}]\n}]\n}", "IntendedForQualification": false } } } } }

YAML

Resources: TestSuiteDefinition: Type: 'AWS::IoTCoreDeviceAdvisor::SuiteDefinition' Properties: SuiteDefinitionConfiguration: SuiteDefinitionName: "SuiteDefinitionName" DevicePermissionRoleArn: "arn:aws:iam::123456789012:role/RoleName" Devices: - ThingArn: "arn:aws:iot:us-east-1:123456789012:thing/ThingName" RootGroup: '{ "configuration": {}, "tests": [{ "name": "TestGroup", "configuration": { "EXECUTION_TIMEOUT": "30" }, "tests": [{ "name": "MQTTPublishTest", "configuration": { "TOPIC_FOR_PUBLISH_VALIDATION": "target" }, "test": { "id": "MQTT_Publish", "version": "0.0.0" } }] }] }' IntendedForQualification: false