Package software.amazon.awscdk.services.iotcoredeviceadvisor

Interface CfnSuiteDefinition.SuiteDefinitionConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSuiteDefinition.SuiteDefinitionConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnSuiteDefinition

@Stability(Stable)
public static interface CfnSuiteDefinition.SuiteDefinitionConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.iotcoredeviceadvisor.*;
 SuiteDefinitionConfigurationProperty suiteDefinitionConfigurationProperty = SuiteDefinitionConfigurationProperty.builder()
         .devicePermissionRoleArn("devicePermissionRoleArn")
         .rootGroup("rootGroup")
         // the properties below are optional
         .devices(List.of(DeviceUnderTestProperty.builder()
                 .certificateArn("certificateArn")
                 .thingArn("thingArn")
                 .build()))
         .intendedForQualification(false)
         .suiteDefinitionName("suiteDefinitionName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSuiteDefinition.SuiteDefinitionConfigurationProperty.Builder	A builder for CfnSuiteDefinition.SuiteDefinitionConfigurationProperty
static final class	CfnSuiteDefinition.SuiteDefinitionConfigurationProperty.Jsii$Proxy	An implementation for CfnSuiteDefinition.SuiteDefinitionConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnSuiteDefinition.SuiteDefinitionConfigurationProperty.Builder	builder()
String	getDevicePermissionRoleArn()	Gets the device permission ARN.
default Object	getDevices()	Gets the devices configured.
default Object	getIntendedForQualification()	Gets the tests intended for qualification in a suite.
String	getRootGroup()	Gets the test suite root group.
default String	getSuiteDefinitionName()	Gets the suite definition name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDevicePermissionRoleArn

@Stability(Stable)
@NotNull
String getDevicePermissionRoleArn()

Gets the device permission ARN.

This is a required parameter.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration.html#cfn-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration-devicepermissionrolearn

getRootGroup

@Stability(Stable)
@NotNull
String getRootGroup()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration.html#cfn-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration-rootgroup

getDevices

@Stability(Stable)
@Nullable
default Object getDevices()

Gets the devices configured.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnSuiteDefinition.DeviceUnderTestProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration.html#cfn-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration-devices

getIntendedForQualification

@Stability(Stable)
@Nullable
default Object getIntendedForQualification()

Gets the tests intended for qualification in a suite.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration.html#cfn-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration-intendedforqualification

getSuiteDefinitionName

@Stability(Stable)
@Nullable
default String getSuiteDefinitionName()

Gets the suite definition name.

This is a required parameter.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration.html#cfn-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration-suitedefinitionname

builder

@Stability(Stable)
static CfnSuiteDefinition.SuiteDefinitionConfigurationProperty.Builder builder()

Returns:

a CfnSuiteDefinition.SuiteDefinitionConfigurationProperty.Builder of CfnSuiteDefinition.SuiteDefinitionConfigurationProperty