Package software.amazon.awscdk.services.iotcoredeviceadvisor

Class CfnSuiteDefinition

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iotcoredeviceadvisor.CfnSuiteDefinition
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.807Z") @Stability(Stable) public class CfnSuiteDefinition extends CfnResource implements IInspectable
A CloudFormation AWS::IoTCoreDeviceAdvisor::SuiteDefinition.

Creates a Device Advisor test suite.

Requires permission to access the CreateSuiteDefinition action.

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;
 CfnSuiteDefinition cfnSuiteDefinition = CfnSuiteDefinition.Builder.create(this, "MyCfnSuiteDefinition")
         .suiteDefinitionConfiguration(suiteDefinitionConfiguration)
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSuiteDefinition

      protected CfnSuiteDefinition(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSuiteDefinition

      protected CfnSuiteDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSuiteDefinition

      @Stability(Stable) public CfnSuiteDefinition(@NotNull Construct scope, @NotNull String id, @NotNull CfnSuiteDefinitionProps props)
      Create a new AWS::IoTCoreDeviceAdvisor::SuiteDefinition.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrSuiteDefinitionArn

      @Stability(Stable) @NotNull public String getAttrSuiteDefinitionArn()
      The Arn of the Suite Definition.

    • getAttrSuiteDefinitionId

      @Stability(Stable) @NotNull public String getAttrSuiteDefinitionId()
      The version of the Suite Definition.

    • getAttrSuiteDefinitionVersion

      @Stability(Stable) @NotNull public String getAttrSuiteDefinitionVersion()
      The ID of the Suite Definition.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Metadata that can be used to manage the the Suite Definition.

    • getSuiteDefinitionConfiguration

      @Stability(Stable) @NotNull public 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

    • setSuiteDefinitionConfiguration

      @Stability(Stable) public void setSuiteDefinitionConfiguration(@NotNull Object value)
      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