Package software.amazon.awscdk.services.iotcoredeviceadvisor

Interface CfnSuiteDefinitionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSuiteDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:18.431Z")
@Stability(Stable)
public interface CfnSuiteDefinitionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSuiteDefinition.

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.*;
 Object suiteDefinitionConfiguration;
 CfnSuiteDefinitionProps cfnSuiteDefinitionProps = CfnSuiteDefinitionProps.builder()
         .suiteDefinitionConfiguration(suiteDefinitionConfiguration)
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnSuiteDefinitionProps.Builder	builder()
Object	getSuiteDefinitionConfiguration()	The configuration of the Suite Definition.
default List<CfnTag>	getTags()	Metadata that can be used to manage the the Suite Definition.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSuiteDefinitionConfiguration

@Stability(Stable)
@NotNull
Object getSuiteDefinitionConfiguration()

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotcoredeviceadvisor-suitedefinition.html#cfn-iotcoredeviceadvisor-suitedefinition-tags

builder

@Stability(Stable)
static CfnSuiteDefinitionProps.Builder builder()

Returns:

a CfnSuiteDefinitionProps.Builder of CfnSuiteDefinitionProps