Show / Hide Table of Contents

Interface CfnSuiteDefinitionPropsMixin.ISuiteDefinitionConfigurationProperty

The configuration of the Suite Definition. Listed below are the required elements of the SuiteDefinitionConfiguration .

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.IoTCoreDeviceAdvisor
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public interface CfnSuiteDefinitionPropsMixin.ISuiteDefinitionConfigurationProperty
Syntax (vb)
Public Interface CfnSuiteDefinitionPropsMixin.ISuiteDefinitionConfigurationProperty
Remarks

    This is a required element.

    Type: String

      Not a required element.

      Type: List of devices under test

        Not a required element.

        Type: Boolean

          This is a required element.

          Type: String

            This is a required element.

            Type: String

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

            ExampleMetadata: fixture=_generated

            Examples
            // The code below shows an example of how to instantiate this type.
                         // The values are placeholders you should change.
                         using Amazon.CDK.CfnPropertyMixins.AWS.IoTCoreDeviceAdvisor;
            
                         var suiteDefinitionConfigurationProperty = new SuiteDefinitionConfigurationProperty {
                             DevicePermissionRoleArn = "devicePermissionRoleArn",
                             Devices = new [] { new DeviceUnderTestProperty {
                                 CertificateArn = "certificateArn",
                                 ThingArn = "thingArn"
                             } },
                             IntendedForQualification = false,
                             RootGroup = "rootGroup",
                             SuiteDefinitionName = "suiteDefinitionName"
                         };

            Synopsis

            Properties

            DevicePermissionRoleArn

            Gets the device permission ARN.

            Devices

            Gets the devices configured.

            IntendedForQualification

            Gets the tests intended for qualification in a suite.

            RootGroup

            Gets the test suite root group.

            SuiteDefinitionName

            Gets the suite definition name.

            Properties

            DevicePermissionRoleArn

            Gets the device permission ARN.

            string? DevicePermissionRoleArn { get; }
            Property Value

            string

            Remarks

            This is a required parameter.

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

            Devices

            Gets the devices configured.

            object? Devices { get; }
            Property Value

            object

            Remarks

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

            Type union: either IResolvable or (either IResolvable or CfnSuiteDefinitionPropsMixin.IDeviceUnderTestProperty)[]

            IntendedForQualification

            Gets the tests intended for qualification in a suite.

            object? IntendedForQualification { get; }
            Property Value

            object

            Remarks

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

            Type union: either bool or IResolvable

            RootGroup

            Gets the test suite root group.

            string? RootGroup { get; }
            Property Value

            string

            Remarks

            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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration.html#cfn-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration-rootgroup

            SuiteDefinitionName

            Gets the suite definition name.

            string? SuiteDefinitionName { get; }
            Property Value

            string

            Remarks

            This is a required parameter.

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

            Back to top Generated by DocFX