awsiottwinmaker

package
v2.24.0 Latest Latest
Warning

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

Go to latest
Published: May 12, 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:

(Read the CDK Contributing Guide 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.

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

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.

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

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.

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

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.

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

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
	AttrArn() *string
	AttrCreationDateTime() *string
	AttrIsAbstract() awscdk.IResolvable
	AttrIsSchemaInitialized() awscdk.IResolvable
	AttrUpdateDateTime() *string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// `AWS::IoTTwinMaker::ComponentType.ComponentTypeId`.
	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
	// `AWS::IoTTwinMaker::ComponentType.Description`.
	Description() *string
	SetDescription(val *string)
	// `AWS::IoTTwinMaker::ComponentType.ExtendsFrom`.
	ExtendsFrom() *[]*string
	SetExtendsFrom(val *[]*string)
	// `AWS::IoTTwinMaker::ComponentType.Functions`.
	Functions() interface{}
	SetFunctions(val interface{})
	// `AWS::IoTTwinMaker::ComponentType.IsSingleton`.
	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
	// `AWS::IoTTwinMaker::ComponentType.PropertyDefinitions`.
	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
	// `AWS::IoTTwinMaker::ComponentType.Tags`.
	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{}
	// `AWS::IoTTwinMaker::ComponentType.WorkspaceId`.
	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`).
	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`.

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 {
	// `AWS::IoTTwinMaker::ComponentType.ComponentTypeId`.
	ComponentTypeId *string `field:"required" json:"componentTypeId" yaml:"componentTypeId"`
	// `AWS::IoTTwinMaker::ComponentType.WorkspaceId`.
	WorkspaceId *string `field:"required" json:"workspaceId" yaml:"workspaceId"`
	// `AWS::IoTTwinMaker::ComponentType.Description`.
	Description *string `field:"optional" json:"description" yaml:"description"`
	// `AWS::IoTTwinMaker::ComponentType.ExtendsFrom`.
	ExtendsFrom *[]*string `field:"optional" json:"extendsFrom" yaml:"extendsFrom"`
	// `AWS::IoTTwinMaker::ComponentType.Functions`.
	Functions interface{} `field:"optional" json:"functions" yaml:"functions"`
	// `AWS::IoTTwinMaker::ComponentType.IsSingleton`.
	IsSingleton interface{} `field:"optional" json:"isSingleton" yaml:"isSingleton"`
	// `AWS::IoTTwinMaker::ComponentType.PropertyDefinitions`.
	PropertyDefinitions interface{} `field:"optional" json:"propertyDefinitions" yaml:"propertyDefinitions"`
	// `AWS::IoTTwinMaker::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 {
	// `CfnComponentType.DataConnectorProperty.IsNative`.
	IsNative interface{} `field:"optional" json:"isNative" yaml:"isNative"`
	// `CfnComponentType.DataConnectorProperty.Lambda`.
	Lambda interface{} `field:"optional" json:"lambda" yaml:"lambda"`
}

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 {
	// `CfnComponentType.DataTypeProperty.Type`.
	Type *string `field:"required" json:"type" yaml:"type"`
	// `CfnComponentType.DataTypeProperty.AllowedValues`.
	AllowedValues interface{} `field:"optional" json:"allowedValues" yaml:"allowedValues"`
	// `CfnComponentType.DataTypeProperty.NestedType`.
	NestedType interface{} `field:"optional" json:"nestedType" yaml:"nestedType"`
	// `CfnComponentType.DataTypeProperty.Relationship`.
	Relationship interface{} `field:"optional" json:"relationship" yaml:"relationship"`
	// `CfnComponentType.DataTypeProperty.UnitOfMeasure`.
	UnitOfMeasure *string `field:"optional" json:"unitOfMeasure" yaml:"unitOfMeasure"`
}

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 {
	// `CfnComponentType.DataValueProperty.BooleanValue`.
	BooleanValue interface{} `field:"optional" json:"booleanValue" yaml:"booleanValue"`
	// `CfnComponentType.DataValueProperty.DoubleValue`.
	DoubleValue *float64 `field:"optional" json:"doubleValue" yaml:"doubleValue"`
	// `CfnComponentType.DataValueProperty.Expression`.
	Expression *string `field:"optional" json:"expression" yaml:"expression"`
	// `CfnComponentType.DataValueProperty.IntegerValue`.
	IntegerValue *float64 `field:"optional" json:"integerValue" yaml:"integerValue"`
	// `CfnComponentType.DataValueProperty.ListValue`.
	ListValue interface{} `field:"optional" json:"listValue" yaml:"listValue"`
	// `CfnComponentType.DataValueProperty.LongValue`.
	LongValue *float64 `field:"optional" json:"longValue" yaml:"longValue"`
	// `CfnComponentType.DataValueProperty.MapValue`.
	MapValue interface{} `field:"optional" json:"mapValue" yaml:"mapValue"`
	// `CfnComponentType.DataValueProperty.RelationshipValue`.
	RelationshipValue interface{} `field:"optional" json:"relationshipValue" yaml:"relationshipValue"`
	// `CfnComponentType.DataValueProperty.StringValue`.
	StringValue *string `field:"optional" json:"stringValue" yaml:"stringValue"`
}

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 {
	// `CfnComponentType.FunctionProperty.ImplementedBy`.
	ImplementedBy interface{} `field:"optional" json:"implementedBy" yaml:"implementedBy"`
	// `CfnComponentType.FunctionProperty.RequiredProperties`.
	RequiredProperties *[]*string `field:"optional" json:"requiredProperties" yaml:"requiredProperties"`
	// `CfnComponentType.FunctionProperty.Scope`.
	Scope *string `field:"optional" json:"scope" yaml:"scope"`
}

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 {
	// `CfnComponentType.LambdaFunctionProperty.Arn`.
	Arn *string `field:"required" json:"arn" yaml:"arn"`
}

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 {
	// `CfnComponentType.PropertyDefinitionProperty.Configurations`.
	Configurations interface{} `field:"optional" json:"configurations" yaml:"configurations"`
	// `CfnComponentType.PropertyDefinitionProperty.DataType`.
	DataType interface{} `field:"optional" json:"dataType" yaml:"dataType"`
	// `CfnComponentType.PropertyDefinitionProperty.DefaultValue`.
	DefaultValue interface{} `field:"optional" json:"defaultValue" yaml:"defaultValue"`
	// `CfnComponentType.PropertyDefinitionProperty.IsExternalId`.
	IsExternalId interface{} `field:"optional" json:"isExternalId" yaml:"isExternalId"`
	// `CfnComponentType.PropertyDefinitionProperty.IsRequiredInEntity`.
	IsRequiredInEntity interface{} `field:"optional" json:"isRequiredInEntity" yaml:"isRequiredInEntity"`
	// `CfnComponentType.PropertyDefinitionProperty.IsStoredExternally`.
	IsStoredExternally interface{} `field:"optional" json:"isStoredExternally" yaml:"isStoredExternally"`
	// `CfnComponentType.PropertyDefinitionProperty.IsTimeSeries`.
	IsTimeSeries interface{} `field:"optional" json:"isTimeSeries" yaml:"isTimeSeries"`
}

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 {
	// `CfnComponentType.RelationshipProperty.RelationshipType`.
	RelationshipType *string `field:"optional" json:"relationshipType" yaml:"relationshipType"`
	// `CfnComponentType.RelationshipProperty.TargetComponentTypeId`.
	TargetComponentTypeId *string `field:"optional" json:"targetComponentTypeId" yaml:"targetComponentTypeId"`
}

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
	AttrArn() *string
	AttrCreationDateTime() *string
	AttrHasChildEntities() awscdk.IResolvable
	AttrUpdateDateTime() *string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// `AWS::IoTTwinMaker::Entity.Components`.
	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
	// `AWS::IoTTwinMaker::Entity.Description`.
	Description() *string
	SetDescription(val *string)
	// `AWS::IoTTwinMaker::Entity.EntityId`.
	EntityId() *string
	SetEntityId(val *string)
	// `AWS::IoTTwinMaker::Entity.EntityName`.
	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
	// `AWS::IoTTwinMaker::Entity.ParentEntityId`.
	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
	// `AWS::IoTTwinMaker::Entity.Tags`.
	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{}
	// `AWS::IoTTwinMaker::Entity.WorkspaceId`.
	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`).
	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`.

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 {
	// `AWS::IoTTwinMaker::Entity.EntityName`.
	EntityName *string `field:"required" json:"entityName" yaml:"entityName"`
	// `AWS::IoTTwinMaker::Entity.WorkspaceId`.
	WorkspaceId *string `field:"required" json:"workspaceId" yaml:"workspaceId"`
	// `AWS::IoTTwinMaker::Entity.Components`.
	Components interface{} `field:"optional" json:"components" yaml:"components"`
	// `AWS::IoTTwinMaker::Entity.Description`.
	Description *string `field:"optional" json:"description" yaml:"description"`
	// `AWS::IoTTwinMaker::Entity.EntityId`.
	EntityId *string `field:"optional" json:"entityId" yaml:"entityId"`
	// `AWS::IoTTwinMaker::Entity.ParentEntityId`.
	ParentEntityId *string `field:"optional" json:"parentEntityId" yaml:"parentEntityId"`
	// `AWS::IoTTwinMaker::Entity.Tags`.
	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 {
	// `CfnEntity.ComponentProperty.ComponentName`.
	ComponentName *string `field:"optional" json:"componentName" yaml:"componentName"`
	// `CfnEntity.ComponentProperty.ComponentTypeId`.
	ComponentTypeId *string `field:"optional" json:"componentTypeId" yaml:"componentTypeId"`
	// `CfnEntity.ComponentProperty.DefinedIn`.
	DefinedIn *string `field:"optional" json:"definedIn" yaml:"definedIn"`
	// `CfnEntity.ComponentProperty.Description`.
	Description *string `field:"optional" json:"description" yaml:"description"`
	// `CfnEntity.ComponentProperty.Properties`.
	Properties interface{} `field:"optional" json:"properties" yaml:"properties"`
	// `CfnEntity.ComponentProperty.Status`.
	Status interface{} `field:"optional" json:"status" yaml:"status"`
}

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 {
	// `CfnEntity.DataValueProperty.BooleanValue`.
	BooleanValue interface{} `field:"optional" json:"booleanValue" yaml:"booleanValue"`
	// `CfnEntity.DataValueProperty.DoubleValue`.
	DoubleValue *float64 `field:"optional" json:"doubleValue" yaml:"doubleValue"`
	// `CfnEntity.DataValueProperty.Expression`.
	Expression *string `field:"optional" json:"expression" yaml:"expression"`
	// `CfnEntity.DataValueProperty.IntegerValue`.
	IntegerValue *float64 `field:"optional" json:"integerValue" yaml:"integerValue"`
	// `CfnEntity.DataValueProperty.ListValue`.
	ListValue interface{} `field:"optional" json:"listValue" yaml:"listValue"`
	// `CfnEntity.DataValueProperty.LongValue`.
	LongValue *float64 `field:"optional" json:"longValue" yaml:"longValue"`
	// `CfnEntity.DataValueProperty.MapValue`.
	MapValue interface{} `field:"optional" json:"mapValue" yaml:"mapValue"`
	// `CfnEntity.DataValueProperty.RelationshipValue`.
	RelationshipValue interface{} `field:"optional" json:"relationshipValue" yaml:"relationshipValue"`
	// `CfnEntity.DataValueProperty.StringValue`.
	StringValue *string `field:"optional" json:"stringValue" yaml:"stringValue"`
}

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 {
	// `CfnEntity.PropertyProperty.Definition`.
	Definition interface{} `field:"optional" json:"definition" yaml:"definition"`
	// `CfnEntity.PropertyProperty.Value`.
	Value interface{} `field:"optional" json:"value" yaml:"value"`
}

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 {
	// `CfnEntity.StatusProperty.Error`.
	Error interface{} `field:"optional" json:"error" yaml:"error"`
	// `CfnEntity.StatusProperty.State`.
	State *string `field:"optional" json:"state" yaml:"state"`
}

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
	AttrArn() *string
	AttrCreationDateTime() *string
	AttrUpdateDateTime() *string
	// `AWS::IoTTwinMaker::Scene.Capabilities`.
	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
	// `AWS::IoTTwinMaker::Scene.ContentLocation`.
	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
	// `AWS::IoTTwinMaker::Scene.Description`.
	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
	// `AWS::IoTTwinMaker::Scene.SceneId`.
	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
	// `AWS::IoTTwinMaker::Scene.Tags`.
	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{}
	// `AWS::IoTTwinMaker::Scene.WorkspaceId`.
	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`).
	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`.

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 {
	// `AWS::IoTTwinMaker::Scene.ContentLocation`.
	ContentLocation *string `field:"required" json:"contentLocation" yaml:"contentLocation"`
	// `AWS::IoTTwinMaker::Scene.SceneId`.
	SceneId *string `field:"required" json:"sceneId" yaml:"sceneId"`
	// `AWS::IoTTwinMaker::Scene.WorkspaceId`.
	WorkspaceId *string `field:"required" json:"workspaceId" yaml:"workspaceId"`
	// `AWS::IoTTwinMaker::Scene.Capabilities`.
	Capabilities *[]*string `field:"optional" json:"capabilities" yaml:"capabilities"`
	// `AWS::IoTTwinMaker::Scene.Description`.
	Description *string `field:"optional" json:"description" yaml:"description"`
	// `AWS::IoTTwinMaker::Scene.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
	AttrArn() *string
	AttrCreationDateTime() *string
	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
	// `AWS::IoTTwinMaker::Workspace.Description`.
	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
	// `AWS::IoTTwinMaker::Workspace.Role`.
	Role() *string
	SetRole(val *string)
	// `AWS::IoTTwinMaker::Workspace.S3Location`.
	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
	// `AWS::IoTTwinMaker::Workspace.Tags`.
	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{}
	// `AWS::IoTTwinMaker::Workspace.WorkspaceId`.
	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`).
	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`.

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 {
	// `AWS::IoTTwinMaker::Workspace.Role`.
	Role *string `field:"required" json:"role" yaml:"role"`
	// `AWS::IoTTwinMaker::Workspace.S3Location`.
	S3Location *string `field:"required" json:"s3Location" yaml:"s3Location"`
	// `AWS::IoTTwinMaker::Workspace.WorkspaceId`.
	WorkspaceId *string `field:"required" json:"workspaceId" yaml:"workspaceId"`
	// `AWS::IoTTwinMaker::Workspace.Description`.
	Description *string `field:"optional" json:"description" yaml:"description"`
	// `AWS::IoTTwinMaker::Workspace.Tags`.
	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"),
	},
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL