Class: Aws::IoTDeviceAdvisor::Types::SuiteDefinitionConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/types.rb

Overview

Note:

When making an API call, you may pass SuiteDefinitionConfiguration data as a hash:

{
  suite_definition_name: "SuiteDefinitionName",
  devices: [
    {
      thing_arn: "AmazonResourceName",
      certificate_arn: "AmazonResourceName",
    },
  ],
  intended_for_qualification: false,
  is_long_duration_test: false,
  root_group: "RootGroup",
  device_permission_role_arn: "AmazonResourceName",
  protocol: "MqttV3_1_1", # accepts MqttV3_1_1, MqttV5
}

Gets Suite Definition Configuration.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#device_permission_role_arnString

Gets the device permission ARN.

Returns:

  • (String)


655
656
657
658
659
660
661
662
663
664
665
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/types.rb', line 655

class SuiteDefinitionConfiguration < Struct.new(
  :suite_definition_name,
  :devices,
  :intended_for_qualification,
  :is_long_duration_test,
  :root_group,
  :device_permission_role_arn,
  :protocol)
  SENSITIVE = []
  include Aws::Structure
end

#devicesArray<Types::DeviceUnderTest>

Gets the devices configured.

Returns:



655
656
657
658
659
660
661
662
663
664
665
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/types.rb', line 655

class SuiteDefinitionConfiguration < Struct.new(
  :suite_definition_name,
  :devices,
  :intended_for_qualification,
  :is_long_duration_test,
  :root_group,
  :device_permission_role_arn,
  :protocol)
  SENSITIVE = []
  include Aws::Structure
end

#intended_for_qualificationBoolean

Gets the tests intended for qualification in a suite.

Returns:

  • (Boolean)


655
656
657
658
659
660
661
662
663
664
665
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/types.rb', line 655

class SuiteDefinitionConfiguration < Struct.new(
  :suite_definition_name,
  :devices,
  :intended_for_qualification,
  :is_long_duration_test,
  :root_group,
  :device_permission_role_arn,
  :protocol)
  SENSITIVE = []
  include Aws::Structure
end

#is_long_duration_testBoolean

Verifies if the test suite is a long duration test.

Returns:

  • (Boolean)


655
656
657
658
659
660
661
662
663
664
665
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/types.rb', line 655

class SuiteDefinitionConfiguration < Struct.new(
  :suite_definition_name,
  :devices,
  :intended_for_qualification,
  :is_long_duration_test,
  :root_group,
  :device_permission_role_arn,
  :protocol)
  SENSITIVE = []
  include Aws::Structure
end

#protocolString

Gets the MQTT protocol that is configured in the suite definition.

Returns:

  • (String)


655
656
657
658
659
660
661
662
663
664
665
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/types.rb', line 655

class SuiteDefinitionConfiguration < Struct.new(
  :suite_definition_name,
  :devices,
  :intended_for_qualification,
  :is_long_duration_test,
  :root_group,
  :device_permission_role_arn,
  :protocol)
  SENSITIVE = []
  include Aws::Structure
end

#root_groupString

Gets test suite root group.

Returns:

  • (String)


655
656
657
658
659
660
661
662
663
664
665
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/types.rb', line 655

class SuiteDefinitionConfiguration < Struct.new(
  :suite_definition_name,
  :devices,
  :intended_for_qualification,
  :is_long_duration_test,
  :root_group,
  :device_permission_role_arn,
  :protocol)
  SENSITIVE = []
  include Aws::Structure
end

#suite_definition_nameString

Gets Suite Definition Configuration name.

Returns:

  • (String)


655
656
657
658
659
660
661
662
663
664
665
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/types.rb', line 655

class SuiteDefinitionConfiguration < Struct.new(
  :suite_definition_name,
  :devices,
  :intended_for_qualification,
  :is_long_duration_test,
  :root_group,
  :device_permission_role_arn,
  :protocol)
  SENSITIVE = []
  include Aws::Structure
end