AWS::IoTCoreDeviceAdvisor::SuiteDefinition SuiteDefinitionConfiguration - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::IoTCoreDeviceAdvisor::SuiteDefinition 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

Syntax

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

JSON

{
  "DevicePermissionRoleArn" : String,
  "Devices" : [ DeviceUnderTest, ... ],
  "IntendedForQualification" : Boolean,
  "RootGroup" : String,
  "SuiteDefinitionName" : String
}

Properties

DevicePermissionRoleArn

Gets the device permission ARN. This is a required parameter.

Required: Yes

Type: String

Minimum: 20

Maximum: 2048

Update requires: No interruption

Devices

Gets the devices configured.

Required: No

Type: Array of DeviceUnderTest

Minimum: 0

Maximum: 2

Update requires: No interruption

IntendedForQualification

Gets the tests intended for qualification in a suite.

Required: No

Type: Boolean

Update requires: No interruption

RootGroup

Gets the test suite root group. This is a required parameter. For updating or creating the latest qualification suite, if intendedForQualification is set to true, rootGroup can be an empty string. If intendedForQualification is false, rootGroup cannot be an empty string. If rootGroup is empty, and intendedForQualification is set to true, all the qualification tests are included, and the configuration is default.

For a qualification suite, the minimum length is 0, and the maximum is 2048. For a non-qualification suite, the minimum length is 1, and the maximum is 2048.

Required: Yes

Type: String

Minimum: 1

Maximum: 2048

Update requires: No interruption

SuiteDefinitionName

Gets the suite definition name. This is a required parameter.

Required: No

Type: String

Minimum: 1

Maximum: 256

Update requires: No interruption