awsiotcoredeviceadvisor

Documentation

Index

• func CfnSuiteDefinition_CFN_RESOURCE_TYPE_NAME() *string
• func CfnSuiteDefinition_IsCfnElement(x interface{}) *bool
• func CfnSuiteDefinition_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnSuiteDefinition_IsConstruct(x interface{}) *bool
• func NewCfnSuiteDefinition_Override(c CfnSuiteDefinition, scope awscdk.Construct, id *string, ...)
• type CfnSuiteDefinition
  • func NewCfnSuiteDefinition(scope awscdk.Construct, id *string, props *CfnSuiteDefinitionProps) CfnSuiteDefinition
• type CfnSuiteDefinitionProps

Functions

func CfnSuiteDefinition_CFN_RESOURCE_TYPE_NAME

func CfnSuiteDefinition_CFN_RESOURCE_TYPE_NAME() *string

func CfnSuiteDefinition_IsCfnElement

func CfnSuiteDefinition_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnSuiteDefinition_IsCfnResource

func CfnSuiteDefinition_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnSuiteDefinition_IsConstruct

func CfnSuiteDefinition_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnSuiteDefinition_Override

func NewCfnSuiteDefinition_Override(c CfnSuiteDefinition, scope awscdk.Construct, id *string, props *CfnSuiteDefinitionProps)

Create a new `AWS::IoTCoreDeviceAdvisor::SuiteDefinition`.

Types

type CfnSuiteDefinition

type CfnSuiteDefinition interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrSuiteDefinitionArn() *string
	AttrSuiteDefinitionId() *string
	AttrSuiteDefinitionVersion() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	SuiteDefinitionConfiguration() interface{}
	SetSuiteDefinitionConfiguration(val interface{})
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoTCoreDeviceAdvisor::SuiteDefinition`.

Creates a Device Advisor test suite.

Requires permission to access the [CreateSuiteDefinition](https://docs.aws.amazon.com//service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

TODO: EXAMPLE

func NewCfnSuiteDefinition

func NewCfnSuiteDefinition(scope awscdk.Construct, id *string, props *CfnSuiteDefinitionProps) CfnSuiteDefinition

Create a new `AWS::IoTCoreDeviceAdvisor::SuiteDefinition`.

type CfnSuiteDefinitionProps

type CfnSuiteDefinitionProps struct {
	// 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](https://docs.aws.amazon.com/iot/latest/apireference/API_iotdeviceadvisor_DeviceUnderTest.html)
	//
	// 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](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html) .
	//
	// This is a required element.
	//
	// *Type:* String
	// - ***suiteDefinitionName*** - The Suite Definition Configuration name.
	//
	// This is a required element.
	//
	// *Type:* String
	SuiteDefinitionConfiguration interface{} `json:"suiteDefinitionConfiguration" yaml:"suiteDefinitionConfiguration"`
	// Metadata that can be used to manage the the Suite Definition.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnSuiteDefinition`.

TODO: EXAMPLE