awsiottwinmaker

package
v2.37.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 10, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

README

AWS::IoTTwinMaker Construct Library

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

import iottwinmaker "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:

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::IoTTwinMaker.

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnComponentType_CFN_RESOURCE_TYPE_NAME 

func CfnComponentType_CFN_RESOURCE_TYPE_NAME() *string

func CfnComponentType_IsCfnElement 

func CfnComponentType_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 CfnComponentType_IsCfnResource 

func CfnComponentType_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnComponentType_IsConstruct 

func CfnComponentType_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

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

func CfnEntity_CFN_RESOURCE_TYPE_NAME 

func CfnEntity_CFN_RESOURCE_TYPE_NAME() *string

func CfnEntity_IsCfnElement 

func CfnEntity_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 CfnEntity_IsCfnResource 

func CfnEntity_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnEntity_IsConstruct 

func CfnEntity_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

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

func CfnScene_CFN_RESOURCE_TYPE_NAME 

func CfnScene_CFN_RESOURCE_TYPE_NAME() *string

func CfnScene_IsCfnElement 

func CfnScene_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 CfnScene_IsCfnResource 

func CfnScene_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnScene_IsConstruct 

func CfnScene_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

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

func CfnWorkspace_CFN_RESOURCE_TYPE_NAME 

func CfnWorkspace_CFN_RESOURCE_TYPE_NAME() *string

func CfnWorkspace_IsCfnElement 

func CfnWorkspace_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 CfnWorkspace_IsCfnResource 

func CfnWorkspace_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnWorkspace_IsConstruct 

func CfnWorkspace_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

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

func NewCfnComponentType_Override 

func NewCfnComponentType_Override(c CfnComponentType, scope constructs.Construct, id *string, props *CfnComponentTypeProps)

Create a new `AWS::IoTTwinMaker::ComponentType`.

func NewCfnEntity_Override 

func NewCfnEntity_Override(c CfnEntity, scope constructs.Construct, id *string, props *CfnEntityProps)

Create a new `AWS::IoTTwinMaker::Entity`.

func NewCfnScene_Override 

func NewCfnScene_Override(c CfnScene, scope constructs.Construct, id *string, props *CfnSceneProps)

Create a new `AWS::IoTTwinMaker::Scene`.

func NewCfnWorkspace_Override 

func NewCfnWorkspace_Override(c CfnWorkspace, scope constructs.Construct, id *string, props *CfnWorkspaceProps)

Create a new `AWS::IoTTwinMaker::Workspace`.

Types

type CfnComponentType 

type CfnComponentType interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The ARN of the component type.
	AttrArn() *string
	// The date and time when the component type was created.
	AttrCreationDateTime() *string
	// A boolean value that specifies whether the component type is abstract.
	AttrIsAbstract() awscdk.IResolvable
	// A boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
	AttrIsSchemaInitialized() awscdk.IResolvable
	// The component type the update time.
	AttrUpdateDateTime() *string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// The ID of the component type.
	ComponentTypeId() *string
	SetComponentTypeId(val *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 description of the component type.
	Description() *string
	SetDescription(val *string)
	// The name of the parent component type that this component type extends.
	ExtendsFrom() *[]*string
	SetExtendsFrom(val *[]*string)
	// An object that maps strings to the functions in the component type.
	//
	// Each string in the mapping must be unique to this object.
	//
	// For information on the FunctionResponse object see the [FunctionResponse](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_FunctionResponse.html) API reference.
	Functions() interface{}
	SetFunctions(val interface{})
	// A boolean value that specifies whether an entity can have more than one component of this type.
	IsSingleton() interface{}
	SetIsSingleton(val interface{})
	// 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
	// An object that maps strings to the property definitions in the component type.
	//
	// Each string in the mapping must be unique to this object.
	//
	// For information about the PropertyDefinitionResponse object, see the [PropertyDefinitionResponse](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_PropertyDefinitionResponse.html) API reference.
	PropertyDefinitions() interface{}
	SetPropertyDefinitions(val interface{})
	// 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 ComponentType tags.
	Tags() awscdk.TagManager
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// 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{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// The ID of the workspace.
	WorkspaceId() *string
	SetWorkspaceId(val *string)
	// 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`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	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::IoTTwinMaker::ComponentType`.

Use the `AWS::IoTTwinMaker::ComponentType` resource to declare a component type.

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 dataTypeProperty_ dataTypeProperty
var dataValueProperty_ dataValueProperty
var relationshipValue interface{}

cfnComponentType := awscdk.Aws_iottwinmaker.NewCfnComponentType(this, jsii.String("MyCfnComponentType"), &cfnComponentTypeProps{
	componentTypeId: jsii.String("componentTypeId"),
	workspaceId: jsii.String("workspaceId"),

	// the properties below are optional
	description: jsii.String("description"),
	extendsFrom: []*string{
		jsii.String("extendsFrom"),
	},
	functions: map[string]interface{}{
		"functionsKey": &FunctionProperty{
			"implementedBy": &DataConnectorProperty{
				"isNative": jsii.Boolean(false),
				"lambda": &LambdaFunctionProperty{
					"arn": jsii.String("arn"),
				},
			},
			"requiredProperties": []*string{
				jsii.String("requiredProperties"),
			},
			"scope": jsii.String("scope"),
		},
	},
	isSingleton: jsii.Boolean(false),
	propertyDefinitions: map[string]interface{}{
		"propertyDefinitionsKey": &PropertyDefinitionProperty{
			"configurations": map[string]*string{
				"configurationsKey": jsii.String("configurations"),
			},
			"dataType": &dataTypeProperty{
				"type": jsii.String("type"),

				// the properties below are optional
				"allowedValues": []interface{}{
					&dataValueProperty{
						"booleanValue": jsii.Boolean(false),
						"doubleValue": jsii.Number(123),
						"expression": jsii.String("expression"),
						"integerValue": jsii.Number(123),
						"listValue": []interface{}{
							dataValueProperty_,
						},
						"longValue": jsii.Number(123),
						"mapValue": map[string]interface{}{
							"mapValueKey": dataValueProperty_,
						},
						"relationshipValue": relationshipValue,
						"stringValue": jsii.String("stringValue"),
					},
				},
				"nestedType": dataTypeProperty_,
				"relationship": &RelationshipProperty{
					"relationshipType": jsii.String("relationshipType"),
					"targetComponentTypeId": jsii.String("targetComponentTypeId"),
				},
				"unitOfMeasure": jsii.String("unitOfMeasure"),
			},
			"defaultValue": &dataValueProperty{
				"booleanValue": jsii.Boolean(false),
				"doubleValue": jsii.Number(123),
				"expression": jsii.String("expression"),
				"integerValue": jsii.Number(123),
				"listValue": []interface{}{
					dataValueProperty_,
				},
				"longValue": jsii.Number(123),
				"mapValue": map[string]interface{}{
					"mapValueKey": dataValueProperty_,
				},
				"relationshipValue": relationshipValue,
				"stringValue": jsii.String("stringValue"),
			},
			"isExternalId": jsii.Boolean(false),
			"isRequiredInEntity": jsii.Boolean(false),
			"isStoredExternally": jsii.Boolean(false),
			"isTimeSeries": jsii.Boolean(false),
		},
	},
	tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
})

func NewCfnComponentType 

func NewCfnComponentType(scope constructs.Construct, id *string, props *CfnComponentTypeProps) CfnComponentType

Create a new `AWS::IoTTwinMaker::ComponentType`.

type CfnComponentTypeProps 

type CfnComponentTypeProps struct {
	// The ID of the component type.
	ComponentTypeId *string `field:"required" json:"componentTypeId" yaml:"componentTypeId"`
	// The ID of the workspace.
	WorkspaceId *string `field:"required" json:"workspaceId" yaml:"workspaceId"`
	// The description of the component type.
	Description *string `field:"optional" json:"description" yaml:"description"`
	// The name of the parent component type that this component type extends.
	ExtendsFrom *[]*string `field:"optional" json:"extendsFrom" yaml:"extendsFrom"`
	// An object that maps strings to the functions in the component type.
	//
	// Each string in the mapping must be unique to this object.
	//
	// For information on the FunctionResponse object see the [FunctionResponse](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_FunctionResponse.html) API reference.
	Functions interface{} `field:"optional" json:"functions" yaml:"functions"`
	// A boolean value that specifies whether an entity can have more than one component of this type.
	IsSingleton interface{} `field:"optional" json:"isSingleton" yaml:"isSingleton"`
	// An object that maps strings to the property definitions in the component type.
	//
	// Each string in the mapping must be unique to this object.
	//
	// For information about the PropertyDefinitionResponse object, see the [PropertyDefinitionResponse](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_PropertyDefinitionResponse.html) API reference.
	PropertyDefinitions interface{} `field:"optional" json:"propertyDefinitions" yaml:"propertyDefinitions"`
	// The ComponentType tags.
	Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `CfnComponentType`.

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 dataTypeProperty_ dataTypeProperty
var dataValueProperty_ dataValueProperty
var relationshipValue interface{}

cfnComponentTypeProps := &cfnComponentTypeProps{
	componentTypeId: jsii.String("componentTypeId"),
	workspaceId: jsii.String("workspaceId"),

	// the properties below are optional
	description: jsii.String("description"),
	extendsFrom: []*string{
		jsii.String("extendsFrom"),
	},
	functions: map[string]interface{}{
		"functionsKey": &FunctionProperty{
			"implementedBy": &DataConnectorProperty{
				"isNative": jsii.Boolean(false),
				"lambda": &LambdaFunctionProperty{
					"arn": jsii.String("arn"),
				},
			},
			"requiredProperties": []*string{
				jsii.String("requiredProperties"),
			},
			"scope": jsii.String("scope"),
		},
	},
	isSingleton: jsii.Boolean(false),
	propertyDefinitions: map[string]interface{}{
		"propertyDefinitionsKey": &PropertyDefinitionProperty{
			"configurations": map[string]*string{
				"configurationsKey": jsii.String("configurations"),
			},
			"dataType": &dataTypeProperty{
				"type": jsii.String("type"),

				// the properties below are optional
				"allowedValues": []interface{}{
					&dataValueProperty{
						"booleanValue": jsii.Boolean(false),
						"doubleValue": jsii.Number(123),
						"expression": jsii.String("expression"),
						"integerValue": jsii.Number(123),
						"listValue": []interface{}{
							dataValueProperty_,
						},
						"longValue": jsii.Number(123),
						"mapValue": map[string]interface{}{
							"mapValueKey": dataValueProperty_,
						},
						"relationshipValue": relationshipValue,
						"stringValue": jsii.String("stringValue"),
					},
				},
				"nestedType": dataTypeProperty_,
				"relationship": &RelationshipProperty{
					"relationshipType": jsii.String("relationshipType"),
					"targetComponentTypeId": jsii.String("targetComponentTypeId"),
				},
				"unitOfMeasure": jsii.String("unitOfMeasure"),
			},
			"defaultValue": &dataValueProperty{
				"booleanValue": jsii.Boolean(false),
				"doubleValue": jsii.Number(123),
				"expression": jsii.String("expression"),
				"integerValue": jsii.Number(123),
				"listValue": []interface{}{
					dataValueProperty_,
				},
				"longValue": jsii.Number(123),
				"mapValue": map[string]interface{}{
					"mapValueKey": dataValueProperty_,
				},
				"relationshipValue": relationshipValue,
				"stringValue": jsii.String("stringValue"),
			},
			"isExternalId": jsii.Boolean(false),
			"isRequiredInEntity": jsii.Boolean(false),
			"isStoredExternally": jsii.Boolean(false),
			"isTimeSeries": jsii.Boolean(false),
		},
	},
	tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
}

type CfnComponentType_DataConnectorProperty 

type CfnComponentType_DataConnectorProperty struct {
	// A boolean value that specifies whether the data connector is native to IoT TwinMaker.
	IsNative interface{} `field:"optional" json:"isNative" yaml:"isNative"`
	// The Lambda function associated with the data connector.
	Lambda interface{} `field:"optional" json:"lambda" yaml:"lambda"`
}

The data connector.

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"

dataConnectorProperty := &dataConnectorProperty{
	isNative: jsii.Boolean(false),
	lambda: &lambdaFunctionProperty{
		arn: jsii.String("arn"),
	},
}

type CfnComponentType_DataTypeProperty 

type CfnComponentType_DataTypeProperty struct {
	// The underlying type of the data type.
	//
	// Valid Values: `RELATIONSHIP | STRING | LONG | BOOLEAN | INTEGER | DOUBLE | LIST | MAP`.
	Type *string `field:"required" json:"type" yaml:"type"`
	// The allowed values for this data type.
	AllowedValues interface{} `field:"optional" json:"allowedValues" yaml:"allowedValues"`
	// The nested type in the data type.
	NestedType interface{} `field:"optional" json:"nestedType" yaml:"nestedType"`
	// A relationship that associates a component with another component.
	Relationship interface{} `field:"optional" json:"relationship" yaml:"relationship"`
	// The unit of measure used in this data type.
	UnitOfMeasure *string `field:"optional" json:"unitOfMeasure" yaml:"unitOfMeasure"`
}

An object that specifies the data type of a property.

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 dataTypeProperty_ dataTypeProperty
var dataValueProperty_ dataValueProperty
var relationshipValue interface{}

dataTypeProperty := &dataTypeProperty{
	type: jsii.String("type"),

	// the properties below are optional
	allowedValues: []interface{}{
		&dataValueProperty{
			booleanValue: jsii.Boolean(false),
			doubleValue: jsii.Number(123),
			expression: jsii.String("expression"),
			integerValue: jsii.Number(123),
			listValue: []interface{}{
				dataValueProperty_,
			},
			longValue: jsii.Number(123),
			mapValue: map[string]interface{}{
				"mapValueKey": dataValueProperty_,
			},
			relationshipValue: relationshipValue,
			stringValue: jsii.String("stringValue"),
		},
	},
	nestedType: &dataTypeProperty{
		type: jsii.String("type"),

		// the properties below are optional
		allowedValues: []interface{}{
			&dataValueProperty{
				booleanValue: jsii.Boolean(false),
				doubleValue: jsii.Number(123),
				expression: jsii.String("expression"),
				integerValue: jsii.Number(123),
				listValue: []interface{}{
					dataValueProperty_,
				},
				longValue: jsii.Number(123),
				mapValue: map[string]interface{}{
					"mapValueKey": dataValueProperty_,
				},
				relationshipValue: relationshipValue,
				stringValue: jsii.String("stringValue"),
			},
		},
		nestedType: dataTypeProperty_,
		relationship: &relationshipProperty{
			relationshipType: jsii.String("relationshipType"),
			targetComponentTypeId: jsii.String("targetComponentTypeId"),
		},
		unitOfMeasure: jsii.String("unitOfMeasure"),
	},
	relationship: &relationshipProperty{
		relationshipType: jsii.String("relationshipType"),
		targetComponentTypeId: jsii.String("targetComponentTypeId"),
	},
	unitOfMeasure: jsii.String("unitOfMeasure"),
}

type CfnComponentType_DataValueProperty 

type CfnComponentType_DataValueProperty struct {
	// A boolean value.
	BooleanValue interface{} `field:"optional" json:"booleanValue" yaml:"booleanValue"`
	// A double value.
	DoubleValue *float64 `field:"optional" json:"doubleValue" yaml:"doubleValue"`
	// An expression that produces the value.
	Expression *string `field:"optional" json:"expression" yaml:"expression"`
	// An integer value.
	IntegerValue *float64 `field:"optional" json:"integerValue" yaml:"integerValue"`
	// A list of multiple values.
	ListValue interface{} `field:"optional" json:"listValue" yaml:"listValue"`
	// A long value.
	LongValue *float64 `field:"optional" json:"longValue" yaml:"longValue"`
	// An object that maps strings to multiple `DataValue` objects.
	MapValue interface{} `field:"optional" json:"mapValue" yaml:"mapValue"`
	// A value that relates a component to another component.
	RelationshipValue interface{} `field:"optional" json:"relationshipValue" yaml:"relationshipValue"`
	// A string value.
	StringValue *string `field:"optional" json:"stringValue" yaml:"stringValue"`
}

An object that specifies a value for a property.

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 dataValueProperty_ dataValueProperty
var relationshipValue interface{}

dataValueProperty := &dataValueProperty{
	booleanValue: jsii.Boolean(false),
	doubleValue: jsii.Number(123),
	expression: jsii.String("expression"),
	integerValue: jsii.Number(123),
	listValue: []interface{}{
		&dataValueProperty{
			booleanValue: jsii.Boolean(false),
			doubleValue: jsii.Number(123),
			expression: jsii.String("expression"),
			integerValue: jsii.Number(123),
			listValue: []interface{}{
				dataValueProperty_,
			},
			longValue: jsii.Number(123),
			mapValue: map[string]interface{}{
				"mapValueKey": dataValueProperty_,
			},
			relationshipValue: relationshipValue,
			stringValue: jsii.String("stringValue"),
		},
	},
	longValue: jsii.Number(123),
	mapValue: map[string]interface{}{
		"mapValueKey": &dataValueProperty{
			"booleanValue": jsii.Boolean(false),
			"doubleValue": jsii.Number(123),
			"expression": jsii.String("expression"),
			"integerValue": jsii.Number(123),
			"listValue": []interface{}{
				dataValueProperty_,
			},
			"longValue": jsii.Number(123),
			"mapValue": map[string]interface{}{
				"mapValueKey": dataValueProperty_,
			},
			"relationshipValue": relationshipValue,
			"stringValue": jsii.String("stringValue"),
		},
	},
	relationshipValue: relationshipValue,
	stringValue: jsii.String("stringValue"),
}

type CfnComponentType_FunctionProperty 

type CfnComponentType_FunctionProperty struct {
	// The data connector.
	ImplementedBy interface{} `field:"optional" json:"implementedBy" yaml:"implementedBy"`
	// The required properties of the function.
	RequiredProperties *[]*string `field:"optional" json:"requiredProperties" yaml:"requiredProperties"`
	// The scope of the function.
	Scope *string `field:"optional" json:"scope" yaml:"scope"`
}

The function body.

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"

functionProperty := &functionProperty{
	implementedBy: &dataConnectorProperty{
		isNative: jsii.Boolean(false),
		lambda: &lambdaFunctionProperty{
			arn: jsii.String("arn"),
		},
	},
	requiredProperties: []*string{
		jsii.String("requiredProperties"),
	},
	scope: jsii.String("scope"),
}

type CfnComponentType_LambdaFunctionProperty 

type CfnComponentType_LambdaFunctionProperty struct {
	// The Lambda function ARN.
	Arn *string `field:"required" json:"arn" yaml:"arn"`
}

The Lambda function.

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"

lambdaFunctionProperty := &lambdaFunctionProperty{
	arn: jsii.String("arn"),
}

type CfnComponentType_PropertyDefinitionProperty 

type CfnComponentType_PropertyDefinitionProperty struct {
	// A mapping that specifies configuration information about the property.
	Configurations interface{} `field:"optional" json:"configurations" yaml:"configurations"`
	// `CfnComponentType.PropertyDefinitionProperty.DataType`.
	DataType interface{} `field:"optional" json:"dataType" yaml:"dataType"`
	// A boolean value that specifies whether the property ID comes from an external data store.
	DefaultValue interface{} `field:"optional" json:"defaultValue" yaml:"defaultValue"`
	// A boolean value that specifies whether the property ID comes from an external data store.
	IsExternalId interface{} `field:"optional" json:"isExternalId" yaml:"isExternalId"`
	// A boolean value that specifies whether the property is required in an entity.
	IsRequiredInEntity interface{} `field:"optional" json:"isRequiredInEntity" yaml:"isRequiredInEntity"`
	// A boolean value that specifies whether the property is stored externally.
	IsStoredExternally interface{} `field:"optional" json:"isStoredExternally" yaml:"isStoredExternally"`
	// A boolean value that specifies whether the property consists of time series data.
	IsTimeSeries interface{} `field:"optional" json:"isTimeSeries" yaml:"isTimeSeries"`
}

PropertyDefinition is an object that maps strings to the property definitions in the component type.

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 dataTypeProperty_ dataTypeProperty
var dataValueProperty_ dataValueProperty
var relationshipValue interface{}

propertyDefinitionProperty := &propertyDefinitionProperty{
	configurations: map[string]*string{
		"configurationsKey": jsii.String("configurations"),
	},
	dataType: &dataTypeProperty{
		type: jsii.String("type"),

		// the properties below are optional
		allowedValues: []interface{}{
			&dataValueProperty{
				booleanValue: jsii.Boolean(false),
				doubleValue: jsii.Number(123),
				expression: jsii.String("expression"),
				integerValue: jsii.Number(123),
				listValue: []interface{}{
					dataValueProperty_,
				},
				longValue: jsii.Number(123),
				mapValue: map[string]interface{}{
					"mapValueKey": dataValueProperty_,
				},
				relationshipValue: relationshipValue,
				stringValue: jsii.String("stringValue"),
			},
		},
		nestedType: dataTypeProperty_,
		relationship: &relationshipProperty{
			relationshipType: jsii.String("relationshipType"),
			targetComponentTypeId: jsii.String("targetComponentTypeId"),
		},
		unitOfMeasure: jsii.String("unitOfMeasure"),
	},
	defaultValue: &dataValueProperty{
		booleanValue: jsii.Boolean(false),
		doubleValue: jsii.Number(123),
		expression: jsii.String("expression"),
		integerValue: jsii.Number(123),
		listValue: []interface{}{
			dataValueProperty_,
		},
		longValue: jsii.Number(123),
		mapValue: map[string]interface{}{
			"mapValueKey": dataValueProperty_,
		},
		relationshipValue: relationshipValue,
		stringValue: jsii.String("stringValue"),
	},
	isExternalId: jsii.Boolean(false),
	isRequiredInEntity: jsii.Boolean(false),
	isStoredExternally: jsii.Boolean(false),
	isTimeSeries: jsii.Boolean(false),
}

type CfnComponentType_RelationshipProperty 

type CfnComponentType_RelationshipProperty struct {
	// The type of the relationship.
	RelationshipType *string `field:"optional" json:"relationshipType" yaml:"relationshipType"`
	// The ID of the target component type associated with this relationship.
	TargetComponentTypeId *string `field:"optional" json:"targetComponentTypeId" yaml:"targetComponentTypeId"`
}

An object that specifies a relationship with another component type.

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"

relationshipProperty := &relationshipProperty{
	relationshipType: jsii.String("relationshipType"),
	targetComponentTypeId: jsii.String("targetComponentTypeId"),
}

type CfnEntity 

type CfnEntity interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The entity ARN.
	AttrArn() *string
	// The date and time the entity was created.
	AttrCreationDateTime() *string
	// A boolean value that specifies whether the entity has child entities or not.
	AttrHasChildEntities() awscdk.IResolvable
	// The date and time when the component type was last updated.
	AttrUpdateDateTime() *string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// An object that maps strings to the components in the entity.
	//
	// Each string in the mapping must be unique to this object.
	//
	// For information on the component object see the [component](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_ComponentResponse.html) API reference.
	Components() interface{}
	SetComponents(val interface{})
	// 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 description of the entity.
	Description() *string
	SetDescription(val *string)
	// The entity ID.
	EntityId() *string
	SetEntityId(val *string)
	// The entity name.
	EntityName() *string
	SetEntityName(val *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
	// The ID of the parent entity.
	ParentEntityId() *string
	SetParentEntityId(val *string)
	// 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
	// Metadata that you can use to manage the entity.
	Tags() awscdk.TagManager
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// 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{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// The ID of the workspace.
	WorkspaceId() *string
	SetWorkspaceId(val *string)
	// 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`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	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::IoTTwinMaker::Entity`.

Use the `AWS::IoTTwinMaker::Entity` resource to declare an entity.

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 dataValueProperty_ dataValueProperty
var definition interface{}
var error interface{}
var relationshipValue interface{}

cfnEntity := awscdk.Aws_iottwinmaker.NewCfnEntity(this, jsii.String("MyCfnEntity"), &cfnEntityProps{
	entityName: jsii.String("entityName"),
	workspaceId: jsii.String("workspaceId"),

	// the properties below are optional
	components: map[string]interface{}{
		"componentsKey": &ComponentProperty{
			"componentName": jsii.String("componentName"),
			"componentTypeId": jsii.String("componentTypeId"),
			"definedIn": jsii.String("definedIn"),
			"description": jsii.String("description"),
			"properties": map[string]interface{}{
				"propertiesKey": &PropertyProperty{
					"definition": definition,
					"value": &dataValueProperty{
						"booleanValue": jsii.Boolean(false),
						"doubleValue": jsii.Number(123),
						"expression": jsii.String("expression"),
						"integerValue": jsii.Number(123),
						"listValue": []interface{}{
							dataValueProperty_,
						},
						"longValue": jsii.Number(123),
						"mapValue": map[string]interface{}{
							"mapValueKey": dataValueProperty_,
						},
						"relationshipValue": relationshipValue,
						"stringValue": jsii.String("stringValue"),
					},
				},
			},
			"status": &StatusProperty{
				"error": error,
				"state": jsii.String("state"),
			},
		},
	},
	description: jsii.String("description"),
	entityId: jsii.String("entityId"),
	parentEntityId: jsii.String("parentEntityId"),
	tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
})

func NewCfnEntity 

func NewCfnEntity(scope constructs.Construct, id *string, props *CfnEntityProps) CfnEntity

Create a new `AWS::IoTTwinMaker::Entity`.

type CfnEntityProps 

type CfnEntityProps struct {
	// The entity name.
	EntityName *string `field:"required" json:"entityName" yaml:"entityName"`
	// The ID of the workspace.
	WorkspaceId *string `field:"required" json:"workspaceId" yaml:"workspaceId"`
	// An object that maps strings to the components in the entity.
	//
	// Each string in the mapping must be unique to this object.
	//
	// For information on the component object see the [component](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_ComponentResponse.html) API reference.
	Components interface{} `field:"optional" json:"components" yaml:"components"`
	// The description of the entity.
	Description *string `field:"optional" json:"description" yaml:"description"`
	// The entity ID.
	EntityId *string `field:"optional" json:"entityId" yaml:"entityId"`
	// The ID of the parent entity.
	ParentEntityId *string `field:"optional" json:"parentEntityId" yaml:"parentEntityId"`
	// Metadata that you can use to manage the entity.
	Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `CfnEntity`.

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 dataValueProperty_ dataValueProperty
var definition interface{}
var error interface{}
var relationshipValue interface{}

cfnEntityProps := &cfnEntityProps{
	entityName: jsii.String("entityName"),
	workspaceId: jsii.String("workspaceId"),

	// the properties below are optional
	components: map[string]interface{}{
		"componentsKey": &ComponentProperty{
			"componentName": jsii.String("componentName"),
			"componentTypeId": jsii.String("componentTypeId"),
			"definedIn": jsii.String("definedIn"),
			"description": jsii.String("description"),
			"properties": map[string]interface{}{
				"propertiesKey": &PropertyProperty{
					"definition": definition,
					"value": &dataValueProperty{
						"booleanValue": jsii.Boolean(false),
						"doubleValue": jsii.Number(123),
						"expression": jsii.String("expression"),
						"integerValue": jsii.Number(123),
						"listValue": []interface{}{
							dataValueProperty_,
						},
						"longValue": jsii.Number(123),
						"mapValue": map[string]interface{}{
							"mapValueKey": dataValueProperty_,
						},
						"relationshipValue": relationshipValue,
						"stringValue": jsii.String("stringValue"),
					},
				},
			},
			"status": &StatusProperty{
				"error": error,
				"state": jsii.String("state"),
			},
		},
	},
	description: jsii.String("description"),
	entityId: jsii.String("entityId"),
	parentEntityId: jsii.String("parentEntityId"),
	tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
}

type CfnEntity_ComponentProperty 

type CfnEntity_ComponentProperty struct {
	// The name of the component.
	ComponentName *string `field:"optional" json:"componentName" yaml:"componentName"`
	// The ID of the ComponentType.
	ComponentTypeId *string `field:"optional" json:"componentTypeId" yaml:"componentTypeId"`
	// The name of the property definition set in the request.
	DefinedIn *string `field:"optional" json:"definedIn" yaml:"definedIn"`
	// The description of the component.
	Description *string `field:"optional" json:"description" yaml:"description"`
	// An object that maps strings to the properties to set in the component type.
	//
	// Each string in the mapping must be unique to this object.
	Properties interface{} `field:"optional" json:"properties" yaml:"properties"`
	// The status of the component.
	Status interface{} `field:"optional" json:"status" yaml:"status"`
}

The entity componenet.

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 dataValueProperty_ dataValueProperty
var definition interface{}
var error interface{}
var relationshipValue interface{}

componentProperty := &componentProperty{
	componentName: jsii.String("componentName"),
	componentTypeId: jsii.String("componentTypeId"),
	definedIn: jsii.String("definedIn"),
	description: jsii.String("description"),
	properties: map[string]interface{}{
		"propertiesKey": &PropertyProperty{
			"definition": definition,
			"value": &dataValueProperty{
				"booleanValue": jsii.Boolean(false),
				"doubleValue": jsii.Number(123),
				"expression": jsii.String("expression"),
				"integerValue": jsii.Number(123),
				"listValue": []interface{}{
					dataValueProperty_,
				},
				"longValue": jsii.Number(123),
				"mapValue": map[string]interface{}{
					"mapValueKey": dataValueProperty_,
				},
				"relationshipValue": relationshipValue,
				"stringValue": jsii.String("stringValue"),
			},
		},
	},
	status: &statusProperty{
		error: error,
		state: jsii.String("state"),
	},
}

type CfnEntity_DataValueProperty 

type CfnEntity_DataValueProperty struct {
	// A boolean value.
	BooleanValue interface{} `field:"optional" json:"booleanValue" yaml:"booleanValue"`
	// A double value.
	DoubleValue *float64 `field:"optional" json:"doubleValue" yaml:"doubleValue"`
	// An expression that produces the value.
	Expression *string `field:"optional" json:"expression" yaml:"expression"`
	// An integer value.
	IntegerValue *float64 `field:"optional" json:"integerValue" yaml:"integerValue"`
	// A list of multiple values.
	ListValue interface{} `field:"optional" json:"listValue" yaml:"listValue"`
	// A long value.
	LongValue *float64 `field:"optional" json:"longValue" yaml:"longValue"`
	// An object that maps strings to multiple DataValue objects.
	MapValue interface{} `field:"optional" json:"mapValue" yaml:"mapValue"`
	// A value that relates a component to another component.
	RelationshipValue interface{} `field:"optional" json:"relationshipValue" yaml:"relationshipValue"`
	// A string value.
	StringValue *string `field:"optional" json:"stringValue" yaml:"stringValue"`
}

An object that specifies a value for a property.

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 dataValueProperty_ dataValueProperty
var relationshipValue interface{}

dataValueProperty := &dataValueProperty{
	booleanValue: jsii.Boolean(false),
	doubleValue: jsii.Number(123),
	expression: jsii.String("expression"),
	integerValue: jsii.Number(123),
	listValue: []interface{}{
		&dataValueProperty{
			booleanValue: jsii.Boolean(false),
			doubleValue: jsii.Number(123),
			expression: jsii.String("expression"),
			integerValue: jsii.Number(123),
			listValue: []interface{}{
				dataValueProperty_,
			},
			longValue: jsii.Number(123),
			mapValue: map[string]interface{}{
				"mapValueKey": dataValueProperty_,
			},
			relationshipValue: relationshipValue,
			stringValue: jsii.String("stringValue"),
		},
	},
	longValue: jsii.Number(123),
	mapValue: map[string]interface{}{
		"mapValueKey": &dataValueProperty{
			"booleanValue": jsii.Boolean(false),
			"doubleValue": jsii.Number(123),
			"expression": jsii.String("expression"),
			"integerValue": jsii.Number(123),
			"listValue": []interface{}{
				dataValueProperty_,
			},
			"longValue": jsii.Number(123),
			"mapValue": map[string]interface{}{
				"mapValueKey": dataValueProperty_,
			},
			"relationshipValue": relationshipValue,
			"stringValue": jsii.String("stringValue"),
		},
	},
	relationshipValue: relationshipValue,
	stringValue: jsii.String("stringValue"),
}

type CfnEntity_PropertyProperty 

type CfnEntity_PropertyProperty struct {
	// An object that specifies information about a property.
	Definition interface{} `field:"optional" json:"definition" yaml:"definition"`
	// An object that contains information about a value for a time series property.
	Value interface{} `field:"optional" json:"value" yaml:"value"`
}

An object that sets information about a property.

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 dataValueProperty_ dataValueProperty
var definition interface{}
var relationshipValue interface{}

propertyProperty := &propertyProperty{
	definition: definition,
	value: &dataValueProperty{
		booleanValue: jsii.Boolean(false),
		doubleValue: jsii.Number(123),
		expression: jsii.String("expression"),
		integerValue: jsii.Number(123),
		listValue: []interface{}{
			dataValueProperty_,
		},
		longValue: jsii.Number(123),
		mapValue: map[string]interface{}{
			"mapValueKey": dataValueProperty_,
		},
		relationshipValue: relationshipValue,
		stringValue: jsii.String("stringValue"),
	},
}

type CfnEntity_StatusProperty 

type CfnEntity_StatusProperty struct {
	// The error message.
	Error interface{} `field:"optional" json:"error" yaml:"error"`
	// The current state of the entity, component, component type, or workspace.
	//
	// Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | ERROR`.
	State *string `field:"optional" json:"state" yaml:"state"`
}

The current status of the entity.

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 error interface{}

statusProperty := &statusProperty{
	error: error,
	state: jsii.String("state"),
}

type CfnScene 

type CfnScene interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The scene ARN.
	AttrArn() *string
	// The date and time when the scene was created.
	AttrCreationDateTime() *string
	// The scene the update time.
	AttrUpdateDateTime() *string
	// A list of capabilities that the scene uses to render.
	Capabilities() *[]*string
	SetCapabilities(val *[]*string)
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// The relative path that specifies the location of the content definition file.
	ContentLocation() *string
	SetContentLocation(val *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 description of this scene.
	Description() *string
	SetDescription(val *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 scene ID.
	SceneId() *string
	SetSceneId(val *string)
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// The ComponentType tags.
	Tags() awscdk.TagManager
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// 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{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// The ID of the workspace.
	WorkspaceId() *string
	SetWorkspaceId(val *string)
	// 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`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	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::IoTTwinMaker::Scene`.

Use the `AWS::IoTTwinMaker::Scene` resource to declare a scene.

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"

cfnScene := awscdk.Aws_iottwinmaker.NewCfnScene(this, jsii.String("MyCfnScene"), &cfnSceneProps{
	contentLocation: jsii.String("contentLocation"),
	sceneId: jsii.String("sceneId"),
	workspaceId: jsii.String("workspaceId"),

	// the properties below are optional
	capabilities: []*string{
		jsii.String("capabilities"),
	},
	description: jsii.String("description"),
	tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
})

func NewCfnScene 

func NewCfnScene(scope constructs.Construct, id *string, props *CfnSceneProps) CfnScene

Create a new `AWS::IoTTwinMaker::Scene`.

type CfnSceneProps 

type CfnSceneProps struct {
	// The relative path that specifies the location of the content definition file.
	ContentLocation *string `field:"required" json:"contentLocation" yaml:"contentLocation"`
	// The scene ID.
	SceneId *string `field:"required" json:"sceneId" yaml:"sceneId"`
	// The ID of the workspace.
	WorkspaceId *string `field:"required" json:"workspaceId" yaml:"workspaceId"`
	// A list of capabilities that the scene uses to render.
	Capabilities *[]*string `field:"optional" json:"capabilities" yaml:"capabilities"`
	// The description of this scene.
	Description *string `field:"optional" json:"description" yaml:"description"`
	// The ComponentType tags.
	Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `CfnScene`.

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"

cfnSceneProps := &cfnSceneProps{
	contentLocation: jsii.String("contentLocation"),
	sceneId: jsii.String("sceneId"),
	workspaceId: jsii.String("workspaceId"),

	// the properties below are optional
	capabilities: []*string{
		jsii.String("capabilities"),
	},
	description: jsii.String("description"),
	tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
}

type CfnWorkspace 

type CfnWorkspace interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The workspace ARN.
	AttrArn() *string
	// The date and time the workspace was created.
	AttrCreationDateTime() *string
	// The date and time the workspace was updated.
	AttrUpdateDateTime() *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 description of the workspace.
	Description() *string
	SetDescription(val *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 ARN of the execution role associated with the workspace.
	Role() *string
	SetRole(val *string)
	// The ARN of the S3 bucket where resources associated with the workspace are stored.
	S3Location() *string
	SetS3Location(val *string)
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// Metadata that you can use to manage the workspace.
	Tags() awscdk.TagManager
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// 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{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// The ID of the workspace.
	WorkspaceId() *string
	SetWorkspaceId(val *string)
	// 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`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	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::IoTTwinMaker::Workspace`.

Use the `AWS::IoTTwinMaker::Workspace` resource to declare a workspace.

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"

cfnWorkspace := awscdk.Aws_iottwinmaker.NewCfnWorkspace(this, jsii.String("MyCfnWorkspace"), &cfnWorkspaceProps{
	role: jsii.String("role"),
	s3Location: jsii.String("s3Location"),
	workspaceId: jsii.String("workspaceId"),

	// the properties below are optional
	description: jsii.String("description"),
	tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
})

func NewCfnWorkspace 

func NewCfnWorkspace(scope constructs.Construct, id *string, props *CfnWorkspaceProps) CfnWorkspace

Create a new `AWS::IoTTwinMaker::Workspace`.

type CfnWorkspaceProps 

type CfnWorkspaceProps struct {
	// The ARN of the execution role associated with the workspace.
	Role *string `field:"required" json:"role" yaml:"role"`
	// The ARN of the S3 bucket where resources associated with the workspace are stored.
	S3Location *string `field:"required" json:"s3Location" yaml:"s3Location"`
	// The ID of the workspace.
	WorkspaceId *string `field:"required" json:"workspaceId" yaml:"workspaceId"`
	// The description of the workspace.
	Description *string `field:"optional" json:"description" yaml:"description"`
	// Metadata that you can use to manage the workspace.
	Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `CfnWorkspace`.

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"

cfnWorkspaceProps := &cfnWorkspaceProps{
	role: jsii.String("role"),
	s3Location: jsii.String("s3Location"),
	workspaceId: jsii.String("workspaceId"),

	// the properties below are optional
	description: jsii.String("description"),
	tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.