interface SuiteDefinitionConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.IoTCoreDeviceAdvisor.CfnSuiteDefinition.SuiteDefinitionConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsiotcoredeviceadvisor#CfnSuiteDefinition_SuiteDefinitionConfigurationProperty`
Java	`software.amazon.awscdk.services.iotcoredeviceadvisor.CfnSuiteDefinition.SuiteDefinitionConfigurationProperty`
Python	`aws_cdk.aws_iotcoredeviceadvisor.CfnSuiteDefinition.SuiteDefinitionConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_iotcoredeviceadvisor` » `CfnSuiteDefinition` » `SuiteDefinitionConfigurationProperty`

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotcoredeviceadvisor as iotcoredeviceadvisor } from 'aws-cdk-lib';
const suiteDefinitionConfigurationProperty: iotcoredeviceadvisor.CfnSuiteDefinition.SuiteDefinitionConfigurationProperty = {
  devicePermissionRoleArn: 'devicePermissionRoleArn',
  rootGroup: 'rootGroup',

  // the properties below are optional
  devices: [{
    certificateArn: 'certificateArn',
    thingArn: 'thingArn',
  }],
  intendedForQualification: false,
  suiteDefinitionName: 'suiteDefinitionName',
};

Properties

Name	Type	Description
devicePermissionRoleArn	`string`	Gets the device permission ARN.
rootGroup	`string`	Gets the test suite root group.
devices?	`IResolvable` `\| (IResolvable` `\|` `DeviceUnderTestProperty)[]`	Gets the devices configured.
intendedForQualification?	`boolean \|` `IResolvable`	Gets the tests intended for qualification in a suite.
suiteDefinitionName?	`string`	Gets the suite definition name.

devicePermissionRoleArn

Type: string

Gets the device permission ARN.

This is a required parameter.

rootGroup

Type: string

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.

devices?

Type: IResolvable | (IResolvable | DeviceUnderTestProperty)[] (optional)

Gets the devices configured.

intendedForQualification?

Type: boolean | IResolvable (optional)

Gets the tests intended for qualification in a suite.

suiteDefinitionName?

Type: string (optional)

Gets the suite definition name.

This is a required parameter.