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

Inherits:

Struct

• Object
• Struct
• Aws::IoTDeviceAdvisor::Types::SuiteDefinitionConfiguration

Defined in:

gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/types.rb

Overview

Gets the suite definition configuration.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #device_permission_role_arn ⇒ String

  Gets the device permission ARN.

• #devices ⇒ Array<Types::DeviceUnderTest>

  Gets the devices configured.

• #intended_for_qualification ⇒ Boolean

  Gets the tests intended for qualification in a suite.

• #is_long_duration_test ⇒ Boolean

  Verifies if the test suite is a long duration test.

• #protocol ⇒ String

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

• #root_group ⇒ String

  Gets the test suite root group.

• #suite_definition_name ⇒ String

  Gets the suite definition name.

Instance Attribute Details

#device_permission_role_arn ⇒ String

Gets the device permission ARN. This is a required parameter.

Returns:

• (String)

# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/types.rb', line 546

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

#devices ⇒ Array<Types::DeviceUnderTest>

Gets the devices configured.

Returns:

• (Array<Types::DeviceUnderTest>)

# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/types.rb', line 546

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_qualification ⇒ Boolean

Gets the tests intended for qualification in a suite.

Returns:

• (Boolean)

# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/types.rb', line 546

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_test ⇒ Boolean

Verifies if the test suite is a long duration test.

Returns:

• (Boolean)

# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/types.rb', line 546

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

#protocol ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/types.rb', line 546

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_group ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/types.rb', line 546

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_name ⇒ String

Gets the suite definition name. This is a required parameter.

Returns:

• (String)

# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/types.rb', line 546

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