awsiotcoredeviceadvisor

README

AWS::IoTCoreDeviceAdvisor Construct Library

This module is part of the AWS Cloud Development Kit project.

import iotcoredeviceadvisor "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

• Search Construct Hub for IoTCoreDeviceAdvisor construct libraries
• Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::IoTCoreDeviceAdvisor resources directly.

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::IoTCoreDeviceAdvisor.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

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 constructs.Construct, id *string, ...)
• type CfnSuiteDefinition
  • func NewCfnSuiteDefinition(scope constructs.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.

func CfnSuiteDefinition_IsCfnResource

func CfnSuiteDefinition_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnSuiteDefinition_IsConstruct

func CfnSuiteDefinition_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func NewCfnSuiteDefinition_Override

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

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

Types

type CfnSuiteDefinition

type CfnSuiteDefinition interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The Arn of the Suite Definition.
	AttrSuiteDefinitionArn() *string
	// The version of the Suite Definition.
	AttrSuiteDefinitionId() *string
	// The ID of the Suite Definition.
	AttrSuiteDefinitionVersion() *string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The tree node.
	Node() constructs.Node
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// 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{}
	SetSuiteDefinitionConfiguration(val interface{})
	// Metadata that can be used to manage the the Suite Definition.
	Tags() awscdk.TagManager
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *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.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var suiteDefinitionConfiguration interface{}

cfnSuiteDefinition := awscdk.Aws_iotcoredeviceadvisor.NewCfnSuiteDefinition(this, jsii.String("MyCfnSuiteDefinition"), &cfnSuiteDefinitionProps{
	suiteDefinitionConfiguration: suiteDefinitionConfiguration,

	// the properties below are optional
	tags: []cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
})

func NewCfnSuiteDefinition

func NewCfnSuiteDefinition(scope constructs.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{} `field:"required" json:"suiteDefinitionConfiguration" yaml:"suiteDefinitionConfiguration"`
	// Metadata that can be used to manage the the Suite Definition.
	Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `CfnSuiteDefinition`.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var suiteDefinitionConfiguration interface{}

cfnSuiteDefinitionProps := &cfnSuiteDefinitionProps{
	suiteDefinitionConfiguration: suiteDefinitionConfiguration,

	// the properties below are optional
	tags: []cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
}