Package software.amazon.awscdk.services.iotcoredeviceadvisor

Class CfnSuiteDefinition

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iotcoredeviceadvisor.CfnSuiteDefinition
All Implemented Interfaces:
IInspectable, ITaggable, ISuiteDefinitionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:40.259Z") @Stability(Stable) public class CfnSuiteDefinition extends CfnResource implements IInspectable, ISuiteDefinitionRef, ITaggable
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();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnSuiteDefinitionProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromSuiteDefinitionArn

      @Stability(Stable) @NotNull public static ISuiteDefinitionRef fromSuiteDefinitionArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new ISuiteDefinitionRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromSuiteDefinitionId

      @Stability(Stable) @NotNull public static ISuiteDefinitionRef fromSuiteDefinitionId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String suiteDefinitionId)
      Creates a new ISuiteDefinitionRef from a suiteDefinitionId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      suiteDefinitionId - This parameter is required.

    • 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

    • getSuiteDefinitionRef

      @Stability(Stable) @NotNull public SuiteDefinitionReference getSuiteDefinitionRef()
      A reference to a SuiteDefinition resource.
      Specified by:
      getSuiteDefinitionRef in interface ISuiteDefinitionRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getSuiteDefinitionConfiguration

      @Stability(Stable) @NotNull public Object getSuiteDefinitionConfiguration()
      Gets the suite definition configuration.

    • setSuiteDefinitionConfiguration

      @Stability(Stable) public void setSuiteDefinitionConfiguration(@NotNull Object value)
      Gets the suite definition configuration.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Metadata that can be used to manage the the Suite Definition.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Metadata that can be used to manage the the Suite Definition.