CfnSuiteDefinitionPropsMixin

class aws_cdk.mixins_preview.aws_iotcoredeviceadvisor.mixins.CfnSuiteDefinitionPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a Device Advisor test suite.

Requires permission to access the CreateSuiteDefinition action.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotcoredeviceadvisor-suitedefinition.html
CloudformationResource:: AWS::IoTCoreDeviceAdvisor::SuiteDefinition
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_iotcoredeviceadvisor import mixins as iotcoredeviceadvisor_mixins

# suite_definition_configuration: Any

cfn_suite_definition_props_mixin = iotcoredeviceadvisor_mixins.CfnSuiteDefinitionPropsMixin(iotcoredeviceadvisor_mixins.CfnSuiteDefinitionMixinProps(
    suite_definition_configuration=suite_definition_configuration,
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoTCoreDeviceAdvisor::SuiteDefinition.

Parameters:

props (Union[CfnSuiteDefinitionMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['suiteDefinitionConfiguration', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

DeviceUnderTestProperty

class CfnSuiteDefinitionPropsMixin.DeviceUnderTestProperty(*, certificate_arn=None, thing_arn=None)

Bases: object

Information of a test device.

A thing ARN, certificate ARN or device role ARN is required.

Parameters:

certificate_arn (Optional[str]) – Lists device’s certificate ARN.
thing_arn (Optional[str]) – Lists device’s thing ARN.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotcoredeviceadvisor import mixins as iotcoredeviceadvisor_mixins

device_under_test_property = iotcoredeviceadvisor_mixins.CfnSuiteDefinitionPropsMixin.DeviceUnderTestProperty(
    certificate_arn="certificateArn",
    thing_arn="thingArn"
)

Attributes

certificate_arn

Lists device’s certificate ARN.

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

thing_arn

Lists device’s thing ARN.

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

SuiteDefinitionConfigurationProperty

class CfnSuiteDefinitionPropsMixin.SuiteDefinitionConfigurationProperty(*, device_permission_role_arn=None, devices=None, intended_for_qualification=None, root_group=None, suite_definition_name=None)

Bases: object

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

Parameters:

device_permission_role_arn (Optional[str]) – Gets the device permission ARN. This is a required parameter.
devices (Union[IResolvable, Sequence[Union[IResolvable, DeviceUnderTestProperty, Dict[str, Any]]], None]) – Gets the devices configured.
intended_for_qualification (Union[bool, IResolvable, None]) – Gets the tests intended for qualification in a suite.
root_group (Optional[str]) – 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.
suite_definition_name (Optional[str]) – Gets the suite definition name. This is a required parameter.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotcoredeviceadvisor import mixins as iotcoredeviceadvisor_mixins

suite_definition_configuration_property = iotcoredeviceadvisor_mixins.CfnSuiteDefinitionPropsMixin.SuiteDefinitionConfigurationProperty(
    device_permission_role_arn="devicePermissionRoleArn",
    devices=[iotcoredeviceadvisor_mixins.CfnSuiteDefinitionPropsMixin.DeviceUnderTestProperty(
        certificate_arn="certificateArn",
        thing_arn="thingArn"
    )],
    intended_for_qualification=False,
    root_group="rootGroup",
    suite_definition_name="suiteDefinitionName"
)

Attributes

device_permission_role_arn

Gets the device permission ARN.

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.

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

intended_for_qualification

Gets the tests intended for qualification in a suite.

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

root_group

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

suite_definition_name

Gets the suite definition name.

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