Documentation
¶
Index ¶
- func CfnComponentType_CFN_RESOURCE_TYPE_NAME() *string
- func CfnComponentType_IsCfnElement(x interface{}) *bool
- func CfnComponentType_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnComponentType_IsConstruct(x interface{}) *bool
- func CfnEntity_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEntity_IsCfnElement(x interface{}) *bool
- func CfnEntity_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnEntity_IsConstruct(x interface{}) *bool
- func CfnScene_CFN_RESOURCE_TYPE_NAME() *string
- func CfnScene_IsCfnElement(x interface{}) *bool
- func CfnScene_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnScene_IsConstruct(x interface{}) *bool
- func CfnSyncJob_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSyncJob_IsCfnElement(x interface{}) *bool
- func CfnSyncJob_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSyncJob_IsConstruct(x interface{}) *bool
- func CfnWorkspace_CFN_RESOURCE_TYPE_NAME() *string
- func CfnWorkspace_IsCfnElement(x interface{}) *bool
- func CfnWorkspace_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnWorkspace_IsConstruct(x interface{}) *bool
- func NewCfnComponentType_Override(c CfnComponentType, scope constructs.Construct, id *string, ...)
- func NewCfnEntity_Override(c CfnEntity, scope constructs.Construct, id *string, props *CfnEntityProps)
- func NewCfnScene_Override(c CfnScene, scope constructs.Construct, id *string, props *CfnSceneProps)
- func NewCfnSyncJob_Override(c CfnSyncJob, scope constructs.Construct, id *string, props *CfnSyncJobProps)
- func NewCfnWorkspace_Override(c CfnWorkspace, scope constructs.Construct, id *string, ...)
- type CfnComponentType
- type CfnComponentTypeProps
- type CfnComponentType_DataConnectorProperty
- type CfnComponentType_DataTypeProperty
- type CfnComponentType_DataValueProperty
- type CfnComponentType_ErrorProperty
- type CfnComponentType_FunctionProperty
- type CfnComponentType_LambdaFunctionProperty
- type CfnComponentType_PropertyDefinitionProperty
- type CfnComponentType_PropertyGroupProperty
- type CfnComponentType_RelationshipProperty
- type CfnComponentType_RelationshipValueProperty
- type CfnComponentType_StatusProperty
- type CfnEntity
- type CfnEntityProps
- type CfnEntity_ComponentProperty
- type CfnEntity_DataTypeProperty
- type CfnEntity_DataValueProperty
- type CfnEntity_DefinitionProperty
- type CfnEntity_ErrorProperty
- type CfnEntity_PropertyGroupProperty
- type CfnEntity_PropertyProperty
- type CfnEntity_RelationshipProperty
- type CfnEntity_RelationshipValueProperty
- type CfnEntity_StatusProperty
- type CfnScene
- type CfnSceneProps
- type CfnSyncJob
- type CfnSyncJobProps
- type CfnWorkspace
- type CfnWorkspaceProps
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 CfnSyncJob_CFN_RESOURCE_TYPE_NAME ¶ added in v2.56.0
func CfnSyncJob_CFN_RESOURCE_TYPE_NAME() *string
func CfnSyncJob_IsCfnElement ¶ added in v2.56.0
func CfnSyncJob_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 CfnSyncJob_IsCfnResource ¶ added in v2.56.0
func CfnSyncJob_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnSyncJob_IsConstruct ¶ added in v2.56.0
func CfnSyncJob_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)
func NewCfnEntity_Override ¶
func NewCfnEntity_Override(c CfnEntity, scope constructs.Construct, id *string, props *CfnEntityProps)
func NewCfnScene_Override ¶
func NewCfnScene_Override(c CfnScene, scope constructs.Construct, id *string, props *CfnSceneProps)
func NewCfnSyncJob_Override ¶ added in v2.56.0
func NewCfnSyncJob_Override(c CfnSyncJob, scope constructs.Construct, id *string, props *CfnSyncJobProps)
func NewCfnWorkspace_Override ¶
func NewCfnWorkspace_Override(c CfnWorkspace, scope constructs.Construct, id *string, props *CfnWorkspaceProps)
Types ¶
type CfnComponentType ¶
type CfnComponentType interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// 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 status.
AttrStatus() awscdk.IResolvable
AttrStatusError() awscdk.IResolvable
AttrStatusErrorCode() *string
AttrStatusErrorMessage() *string
AttrStatusState() *string
// 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.
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.
PropertyDefinitions() interface{}
SetPropertyDefinitions(val interface{})
// An object that maps strings to the property groups in the component type.
PropertyGroups() interface{}
SetPropertyGroups(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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The ComponentType tags.
TagsRaw() *map[string]*string
SetTagsRaw(val *map[string]*string)
// 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 that contains the component type.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
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),
},
},
PropertyGroups: map[string]interface{}{
"propertyGroupsKey": &PropertyGroupProperty{
"groupType": jsii.String("groupType"),
"propertyNames": []*string{
jsii.String("propertyNames"),
},
},
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
func NewCfnComponentType ¶
func NewCfnComponentType(scope constructs.Construct, id *string, props *CfnComponentTypeProps) CfnComponentType
type CfnComponentTypeProps ¶
type CfnComponentTypeProps struct {
// The ID of the component type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-componenttypeid
//
ComponentTypeId *string `field:"required" json:"componentTypeId" yaml:"componentTypeId"`
// The ID of the workspace that contains the component type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-workspaceid
//
WorkspaceId *string `field:"required" json:"workspaceId" yaml:"workspaceId"`
// The description of the component type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The name of the parent component type that this component type extends.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-extendsfrom
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-functions
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-issingleton
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-propertydefinitions
//
PropertyDefinitions interface{} `field:"optional" json:"propertyDefinitions" yaml:"propertyDefinitions"`
// An object that maps strings to the property groups in the component type.
//
// Each string in the mapping must be unique to this object.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-propertygroups
//
PropertyGroups interface{} `field:"optional" json:"propertyGroups" yaml:"propertyGroups"`
// The ComponentType tags.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-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),
},
},
PropertyGroups: map[string]interface{}{
"propertyGroupsKey": &PropertyGroupProperty{
"groupType": jsii.String("groupType"),
"propertyNames": []*string{
jsii.String("propertyNames"),
},
},
},
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-dataconnector.html#cfn-iottwinmaker-componenttype-dataconnector-isnative
//
IsNative interface{} `field:"optional" json:"isNative" yaml:"isNative"`
// The Lambda function associated with the data connector.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-dataconnector.html#cfn-iottwinmaker-componenttype-dataconnector-lambda
//
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`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datatype.html#cfn-iottwinmaker-componenttype-datatype-type
//
Type *string `field:"required" json:"type" yaml:"type"`
// The allowed values for this data type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datatype.html#cfn-iottwinmaker-componenttype-datatype-allowedvalues
//
AllowedValues interface{} `field:"optional" json:"allowedValues" yaml:"allowedValues"`
// The nested type in the data type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datatype.html#cfn-iottwinmaker-componenttype-datatype-nestedtype
//
NestedType interface{} `field:"optional" json:"nestedType" yaml:"nestedType"`
// A relationship that associates a component with another component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datatype.html#cfn-iottwinmaker-componenttype-datatype-relationship
//
Relationship interface{} `field:"optional" json:"relationship" yaml:"relationship"`
// The unit of measure used in this data type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datatype.html#cfn-iottwinmaker-componenttype-datatype-unitofmeasure
//
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_,
Relationship: &RelationshipProperty{
RelationshipType: jsii.String("relationshipType"),
TargetComponentTypeId: jsii.String("targetComponentTypeId"),
},
UnitOfMeasure: jsii.String("unitOfMeasure"),
}
type CfnComponentType_DataValueProperty ¶
type CfnComponentType_DataValueProperty struct {
// A boolean value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datavalue.html#cfn-iottwinmaker-componenttype-datavalue-booleanvalue
//
BooleanValue interface{} `field:"optional" json:"booleanValue" yaml:"booleanValue"`
// A double value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datavalue.html#cfn-iottwinmaker-componenttype-datavalue-doublevalue
//
DoubleValue *float64 `field:"optional" json:"doubleValue" yaml:"doubleValue"`
// An expression that produces the value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datavalue.html#cfn-iottwinmaker-componenttype-datavalue-expression
//
Expression *string `field:"optional" json:"expression" yaml:"expression"`
// An integer value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datavalue.html#cfn-iottwinmaker-componenttype-datavalue-integervalue
//
IntegerValue *float64 `field:"optional" json:"integerValue" yaml:"integerValue"`
// A list of multiple values.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datavalue.html#cfn-iottwinmaker-componenttype-datavalue-listvalue
//
ListValue interface{} `field:"optional" json:"listValue" yaml:"listValue"`
// A long value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datavalue.html#cfn-iottwinmaker-componenttype-datavalue-longvalue
//
LongValue *float64 `field:"optional" json:"longValue" yaml:"longValue"`
// An object that maps strings to multiple `DataValue` objects.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datavalue.html#cfn-iottwinmaker-componenttype-datavalue-mapvalue
//
MapValue interface{} `field:"optional" json:"mapValue" yaml:"mapValue"`
// A value that relates a component to another component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datavalue.html#cfn-iottwinmaker-componenttype-datavalue-relationshipvalue
//
RelationshipValue interface{} `field:"optional" json:"relationshipValue" yaml:"relationshipValue"`
// A string value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datavalue.html#cfn-iottwinmaker-componenttype-datavalue-stringvalue
//
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_,
},
LongValue: jsii.Number(123),
MapValue: map[string]interface{}{
"mapValueKey": dataValueProperty_,
},
RelationshipValue: relationshipValue,
StringValue: jsii.String("stringValue"),
}
type CfnComponentType_ErrorProperty ¶ added in v2.55.0
type CfnComponentType_ErrorProperty struct {
// The component type error code.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-error.html#cfn-iottwinmaker-componenttype-error-code
//
Code *string `field:"optional" json:"code" yaml:"code"`
// The component type error message.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-error.html#cfn-iottwinmaker-componenttype-error-message
//
Message *string `field:"optional" json:"message" yaml:"message"`
}
The component type error.
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"
errorProperty := &ErrorProperty{
Code: jsii.String("code"),
Message: jsii.String("message"),
}
type CfnComponentType_FunctionProperty ¶
type CfnComponentType_FunctionProperty struct {
// The data connector.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-function.html#cfn-iottwinmaker-componenttype-function-implementedby
//
ImplementedBy interface{} `field:"optional" json:"implementedBy" yaml:"implementedBy"`
// The required properties of the function.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-function.html#cfn-iottwinmaker-componenttype-function-requiredproperties
//
RequiredProperties *[]*string `field:"optional" json:"requiredProperties" yaml:"requiredProperties"`
// The scope of the function.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-function.html#cfn-iottwinmaker-componenttype-function-scope
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-lambdafunction.html#cfn-iottwinmaker-componenttype-lambdafunction-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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-configurations
//
Configurations interface{} `field:"optional" json:"configurations" yaml:"configurations"`
// An object that specifies the data type of a property.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-datatype
//
DataType interface{} `field:"optional" json:"dataType" yaml:"dataType"`
// A boolean value that specifies whether the property ID comes from an external data store.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-defaultvalue
//
DefaultValue interface{} `field:"optional" json:"defaultValue" yaml:"defaultValue"`
// A Boolean value that specifies whether the property ID comes from an external data store.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-isexternalid
//
IsExternalId interface{} `field:"optional" json:"isExternalId" yaml:"isExternalId"`
// A boolean value that specifies whether the property is required in an entity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-isrequiredinentity
//
IsRequiredInEntity interface{} `field:"optional" json:"isRequiredInEntity" yaml:"isRequiredInEntity"`
// A boolean value that specifies whether the property is stored externally.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-isstoredexternally
//
IsStoredExternally interface{} `field:"optional" json:"isStoredExternally" yaml:"isStoredExternally"`
// A boolean value that specifies whether the property consists of time series data.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-istimeseries
//
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_PropertyGroupProperty ¶ added in v2.54.0
type CfnComponentType_PropertyGroupProperty struct {
// The group type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertygroup.html#cfn-iottwinmaker-componenttype-propertygroup-grouptype
//
GroupType *string `field:"optional" json:"groupType" yaml:"groupType"`
// The property names.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertygroup.html#cfn-iottwinmaker-componenttype-propertygroup-propertynames
//
PropertyNames *[]*string `field:"optional" json:"propertyNames" yaml:"propertyNames"`
}
The property group.
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"
propertyGroupProperty := &PropertyGroupProperty{
GroupType: jsii.String("groupType"),
PropertyNames: []*string{
jsii.String("propertyNames"),
},
}
type CfnComponentType_RelationshipProperty ¶
type CfnComponentType_RelationshipProperty struct {
// The type of the relationship.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-relationship.html#cfn-iottwinmaker-componenttype-relationship-relationshiptype
//
RelationshipType *string `field:"optional" json:"relationshipType" yaml:"relationshipType"`
// The ID of the target component type associated with this relationship.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-relationship.html#cfn-iottwinmaker-componenttype-relationship-targetcomponenttypeid
//
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 CfnComponentType_RelationshipValueProperty ¶ added in v2.55.0
type CfnComponentType_RelationshipValueProperty struct {
// The target component name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-relationshipvalue.html#cfn-iottwinmaker-componenttype-relationshipvalue-targetcomponentname
//
TargetComponentName *string `field:"optional" json:"targetComponentName" yaml:"targetComponentName"`
// The target entity Id.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-relationshipvalue.html#cfn-iottwinmaker-componenttype-relationshipvalue-targetentityid
//
TargetEntityId *string `field:"optional" json:"targetEntityId" yaml:"targetEntityId"`
}
The component type relationship 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"
relationshipValueProperty := &RelationshipValueProperty{
TargetComponentName: jsii.String("targetComponentName"),
TargetEntityId: jsii.String("targetEntityId"),
}
type CfnComponentType_StatusProperty ¶ added in v2.55.0
type CfnComponentType_StatusProperty struct {
// The component type error.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-status.html#cfn-iottwinmaker-componenttype-status-error
//
Error interface{} `field:"optional" json:"error" yaml:"error"`
// The component type status state.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-status.html#cfn-iottwinmaker-componenttype-status-state
//
State *string `field:"optional" json:"state" yaml:"state"`
}
The component type 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"
statusProperty := &StatusProperty{
Error: &ErrorProperty{
Code: jsii.String("code"),
Message: jsii.String("message"),
},
State: jsii.String("state"),
}
type CfnEntity ¶
type CfnEntity interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// 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 entity status.
AttrStatus() awscdk.IResolvable
AttrStatusError() awscdk.IResolvable
AttrStatusErrorCode() *string
AttrStatusErrorMessage() *string
AttrStatusState() *string
// 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.
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 ID of the entity.
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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// Metadata that you can use to manage the entity.
TagsRaw() *map[string]*string
SetTagsRaw(val *map[string]*string)
// 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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
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"),
},
},
},
"propertyGroups": map[string]interface{}{
"propertyGroupsKey": &PropertyGroupProperty{
"groupType": jsii.String("groupType"),
"propertyNames": []*string{
jsii.String("propertyNames"),
},
},
},
"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"),
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html
func NewCfnEntity ¶
func NewCfnEntity(scope constructs.Construct, id *string, props *CfnEntityProps) CfnEntity
type CfnEntityProps ¶
type CfnEntityProps struct {
// The entity name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html#cfn-iottwinmaker-entity-entityname
//
EntityName *string `field:"required" json:"entityName" yaml:"entityName"`
// The ID of the workspace.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html#cfn-iottwinmaker-entity-workspaceid
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html#cfn-iottwinmaker-entity-components
//
Components interface{} `field:"optional" json:"components" yaml:"components"`
// The description of the entity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html#cfn-iottwinmaker-entity-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The ID of the entity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html#cfn-iottwinmaker-entity-entityid
//
EntityId *string `field:"optional" json:"entityId" yaml:"entityId"`
// The ID of the parent entity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html#cfn-iottwinmaker-entity-parententityid
//
ParentEntityId *string `field:"optional" json:"parentEntityId" yaml:"parentEntityId"`
// Metadata that you can use to manage the entity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html#cfn-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"),
},
},
},
"propertyGroups": map[string]interface{}{
"propertyGroupsKey": &PropertyGroupProperty{
"groupType": jsii.String("groupType"),
"propertyNames": []*string{
jsii.String("propertyNames"),
},
},
},
"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"),
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html
type CfnEntity_ComponentProperty ¶
type CfnEntity_ComponentProperty struct {
// The name of the component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-componentname
//
ComponentName *string `field:"optional" json:"componentName" yaml:"componentName"`
// The ID of the component type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-componenttypeid
//
ComponentTypeId *string `field:"optional" json:"componentTypeId" yaml:"componentTypeId"`
// The name of the property definition set in the request.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-definedin
//
DefinedIn *string `field:"optional" json:"definedIn" yaml:"definedIn"`
// The description of the component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-description
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-properties
//
Properties interface{} `field:"optional" json:"properties" yaml:"properties"`
// An object that maps strings to the property groups in the component type.
//
// Each string in the mapping must be unique to this object.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-propertygroups
//
PropertyGroups interface{} `field:"optional" json:"propertyGroups" yaml:"propertyGroups"`
// The status of the component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-status
//
Status interface{} `field:"optional" json:"status" yaml:"status"`
}
The entity component.
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"),
},
},
},
PropertyGroups: map[string]interface{}{
"propertyGroupsKey": &PropertyGroupProperty{
"groupType": jsii.String("groupType"),
"propertyNames": []*string{
jsii.String("propertyNames"),
},
},
},
Status: &StatusProperty{
Error: error,
State: jsii.String("state"),
},
}
type CfnEntity_DataTypeProperty ¶ added in v2.55.0
type CfnEntity_DataTypeProperty struct {
// The allowed values.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datatype.html#cfn-iottwinmaker-entity-datatype-allowedvalues
//
AllowedValues interface{} `field:"optional" json:"allowedValues" yaml:"allowedValues"`
// The nested type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datatype.html#cfn-iottwinmaker-entity-datatype-nestedtype
//
NestedType interface{} `field:"optional" json:"nestedType" yaml:"nestedType"`
// The relationship.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datatype.html#cfn-iottwinmaker-entity-datatype-relationship
//
Relationship interface{} `field:"optional" json:"relationship" yaml:"relationship"`
// The entity type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datatype.html#cfn-iottwinmaker-entity-datatype-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
// The unit of measure.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datatype.html#cfn-iottwinmaker-entity-datatype-unitofmeasure
//
UnitOfMeasure *string `field:"optional" json:"unitOfMeasure" yaml:"unitOfMeasure"`
}
The entity data 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{}
dataTypeProperty := &dataTypeProperty{
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"),
},
Type: jsii.String("type"),
UnitOfMeasure: jsii.String("unitOfMeasure"),
}
type CfnEntity_DataValueProperty ¶
type CfnEntity_DataValueProperty struct {
// A boolean value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html#cfn-iottwinmaker-entity-datavalue-booleanvalue
//
BooleanValue interface{} `field:"optional" json:"booleanValue" yaml:"booleanValue"`
// A double value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html#cfn-iottwinmaker-entity-datavalue-doublevalue
//
DoubleValue *float64 `field:"optional" json:"doubleValue" yaml:"doubleValue"`
// An expression that produces the value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html#cfn-iottwinmaker-entity-datavalue-expression
//
Expression *string `field:"optional" json:"expression" yaml:"expression"`
// An integer value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html#cfn-iottwinmaker-entity-datavalue-integervalue
//
IntegerValue *float64 `field:"optional" json:"integerValue" yaml:"integerValue"`
// A list of multiple values.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html#cfn-iottwinmaker-entity-datavalue-listvalue
//
ListValue interface{} `field:"optional" json:"listValue" yaml:"listValue"`
// A long value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html#cfn-iottwinmaker-entity-datavalue-longvalue
//
LongValue *float64 `field:"optional" json:"longValue" yaml:"longValue"`
// An object that maps strings to multiple DataValue objects.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html#cfn-iottwinmaker-entity-datavalue-mapvalue
//
MapValue interface{} `field:"optional" json:"mapValue" yaml:"mapValue"`
// A value that relates a component to another component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html#cfn-iottwinmaker-entity-datavalue-relationshipvalue
//
RelationshipValue interface{} `field:"optional" json:"relationshipValue" yaml:"relationshipValue"`
// A string value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html#cfn-iottwinmaker-entity-datavalue-stringvalue
//
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_,
},
LongValue: jsii.Number(123),
MapValue: map[string]interface{}{
"mapValueKey": dataValueProperty_,
},
RelationshipValue: relationshipValue,
StringValue: jsii.String("stringValue"),
}
type CfnEntity_DefinitionProperty ¶ added in v2.55.0
type CfnEntity_DefinitionProperty struct {
// The configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-definition.html#cfn-iottwinmaker-entity-definition-configuration
//
Configuration interface{} `field:"optional" json:"configuration" yaml:"configuration"`
// The data type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-definition.html#cfn-iottwinmaker-entity-definition-datatype
//
DataType interface{} `field:"optional" json:"dataType" yaml:"dataType"`
// The default value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-definition.html#cfn-iottwinmaker-entity-definition-defaultvalue
//
DefaultValue interface{} `field:"optional" json:"defaultValue" yaml:"defaultValue"`
// Displays if the entity has a external Id.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-definition.html#cfn-iottwinmaker-entity-definition-isexternalid
//
IsExternalId interface{} `field:"optional" json:"isExternalId" yaml:"isExternalId"`
// Displays if the entity is final.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-definition.html#cfn-iottwinmaker-entity-definition-isfinal
//
IsFinal interface{} `field:"optional" json:"isFinal" yaml:"isFinal"`
// Displays if the entity is imported.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-definition.html#cfn-iottwinmaker-entity-definition-isimported
//
IsImported interface{} `field:"optional" json:"isImported" yaml:"isImported"`
// Displays if the entity is inherited.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-definition.html#cfn-iottwinmaker-entity-definition-isinherited
//
IsInherited interface{} `field:"optional" json:"isInherited" yaml:"isInherited"`
// Displays if the entity is a required entity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-definition.html#cfn-iottwinmaker-entity-definition-isrequiredinentity
//
IsRequiredInEntity interface{} `field:"optional" json:"isRequiredInEntity" yaml:"isRequiredInEntity"`
// Displays if the entity is tored externally.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-definition.html#cfn-iottwinmaker-entity-definition-isstoredexternally
//
IsStoredExternally interface{} `field:"optional" json:"isStoredExternally" yaml:"isStoredExternally"`
// Displays if the entity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-definition.html#cfn-iottwinmaker-entity-definition-istimeseries
//
IsTimeSeries interface{} `field:"optional" json:"isTimeSeries" yaml:"isTimeSeries"`
}
The entity definition.
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{}
definitionProperty := &DefinitionProperty{
Configuration: map[string]*string{
"configurationKey": jsii.String("configuration"),
},
DataType: &dataTypeProperty{
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"),
},
Type: jsii.String("type"),
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),
IsFinal: jsii.Boolean(false),
IsImported: jsii.Boolean(false),
IsInherited: jsii.Boolean(false),
IsRequiredInEntity: jsii.Boolean(false),
IsStoredExternally: jsii.Boolean(false),
IsTimeSeries: jsii.Boolean(false),
}
type CfnEntity_ErrorProperty ¶ added in v2.55.0
type CfnEntity_ErrorProperty struct {
// The entity error code.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-error.html#cfn-iottwinmaker-entity-error-code
//
Code *string `field:"optional" json:"code" yaml:"code"`
// The entity error message.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-error.html#cfn-iottwinmaker-entity-error-message
//
Message *string `field:"optional" json:"message" yaml:"message"`
}
The entity error.
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"
errorProperty := &ErrorProperty{
Code: jsii.String("code"),
Message: jsii.String("message"),
}
type CfnEntity_PropertyGroupProperty ¶ added in v2.54.0
type CfnEntity_PropertyGroupProperty struct {
// The group type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-propertygroup.html#cfn-iottwinmaker-entity-propertygroup-grouptype
//
GroupType *string `field:"optional" json:"groupType" yaml:"groupType"`
// The property names.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-propertygroup.html#cfn-iottwinmaker-entity-propertygroup-propertynames
//
PropertyNames *[]*string `field:"optional" json:"propertyNames" yaml:"propertyNames"`
}
The property group.
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"
propertyGroupProperty := &PropertyGroupProperty{
GroupType: jsii.String("groupType"),
PropertyNames: []*string{
jsii.String("propertyNames"),
},
}
type CfnEntity_PropertyProperty ¶
type CfnEntity_PropertyProperty struct {
// An object that specifies information about a property.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-property.html#cfn-iottwinmaker-entity-property-definition
//
Definition interface{} `field:"optional" json:"definition" yaml:"definition"`
// An object that contains information about a value for a time series property.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-property.html#cfn-iottwinmaker-entity-property-value
//
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_RelationshipProperty ¶ added in v2.55.0
type CfnEntity_RelationshipProperty struct {
// The relationship type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-relationship.html#cfn-iottwinmaker-entity-relationship-relationshiptype
//
RelationshipType *string `field:"optional" json:"relationshipType" yaml:"relationshipType"`
// the component type Id target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-relationship.html#cfn-iottwinmaker-entity-relationship-targetcomponenttypeid
//
TargetComponentTypeId *string `field:"optional" json:"targetComponentTypeId" yaml:"targetComponentTypeId"`
}
The entity relationship.
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_RelationshipValueProperty ¶ added in v2.55.0
type CfnEntity_RelationshipValueProperty struct {
// The target component name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-relationshipvalue.html#cfn-iottwinmaker-entity-relationshipvalue-targetcomponentname
//
TargetComponentName *string `field:"optional" json:"targetComponentName" yaml:"targetComponentName"`
// The target entity Id.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-relationshipvalue.html#cfn-iottwinmaker-entity-relationshipvalue-targetentityid
//
TargetEntityId *string `field:"optional" json:"targetEntityId" yaml:"targetEntityId"`
}
The entity relationship.
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"
relationshipValueProperty := &RelationshipValueProperty{
TargetComponentName: jsii.String("targetComponentName"),
TargetEntityId: jsii.String("targetEntityId"),
}
type CfnEntity_StatusProperty ¶
type CfnEntity_StatusProperty struct {
// The error message.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-status.html#cfn-iottwinmaker-entity-status-error
//
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`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-status.html#cfn-iottwinmaker-entity-status-state
//
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
awscdk.ITaggable
// The scene ARN.
AttrArn() *string
// The date and time when the scene was created.
AttrCreationDateTime() *string
// The generated scene metadata.
AttrGeneratedSceneMetadata() awscdk.IResolvable
// 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 ID of the scene.
SceneId() *string
SetSceneId(val *string)
// The scene metadata.
SceneMetadata() interface{}
SetSceneMetadata(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The ComponentType tags.
TagsRaw() *map[string]*string
SetTagsRaw(val *map[string]*string)
// 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 scene.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
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"),
SceneMetadata: map[string]*string{
"sceneMetadataKey": jsii.String("sceneMetadata"),
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-scene.html
func NewCfnScene ¶
func NewCfnScene(scope constructs.Construct, id *string, props *CfnSceneProps) CfnScene
type CfnSceneProps ¶
type CfnSceneProps struct {
// The relative path that specifies the location of the content definition file.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-scene.html#cfn-iottwinmaker-scene-contentlocation
//
ContentLocation *string `field:"required" json:"contentLocation" yaml:"contentLocation"`
// The ID of the scene.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-scene.html#cfn-iottwinmaker-scene-sceneid
//
SceneId *string `field:"required" json:"sceneId" yaml:"sceneId"`
// The ID of the scene.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-scene.html#cfn-iottwinmaker-scene-workspaceid
//
WorkspaceId *string `field:"required" json:"workspaceId" yaml:"workspaceId"`
// A list of capabilities that the scene uses to render.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-scene.html#cfn-iottwinmaker-scene-capabilities
//
Capabilities *[]*string `field:"optional" json:"capabilities" yaml:"capabilities"`
// The description of this scene.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-scene.html#cfn-iottwinmaker-scene-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The scene metadata.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-scene.html#cfn-iottwinmaker-scene-scenemetadata
//
SceneMetadata interface{} `field:"optional" json:"sceneMetadata" yaml:"sceneMetadata"`
// The ComponentType tags.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-scene.html#cfn-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"),
SceneMetadata: map[string]*string{
"sceneMetadataKey": jsii.String("sceneMetadata"),
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-scene.html
type CfnSyncJob ¶ added in v2.56.0
type CfnSyncJob interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The SyncJob ARN.
AttrArn() *string
// The creation date and time of the SyncJob.
AttrCreationDateTime() *string
// The SyncJob's state.
AttrState() *string
// The update date and 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
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The SyncJob IAM role.
SyncRole() *string
SetSyncRole(val *string)
// The sync source.
SyncSource() *string
SetSyncSource(val *string)
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// Metadata you can use to manage the SyncJob.
TagsRaw() *map[string]*string
SetTagsRaw(val *map[string]*string)
// 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 that contains the sync job.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
The SyncJob.
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"
cfnSyncJob := awscdk.Aws_iottwinmaker.NewCfnSyncJob(this, jsii.String("MyCfnSyncJob"), &CfnSyncJobProps{
SyncRole: jsii.String("syncRole"),
SyncSource: jsii.String("syncSource"),
WorkspaceId: jsii.String("workspaceId"),
// the properties below are optional
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-syncjob.html
func NewCfnSyncJob ¶ added in v2.56.0
func NewCfnSyncJob(scope constructs.Construct, id *string, props *CfnSyncJobProps) CfnSyncJob
type CfnSyncJobProps ¶ added in v2.56.0
type CfnSyncJobProps struct {
// The SyncJob IAM role.
//
// This IAM role is used by the sync job to read from the syncSource, and create, update or delete the corresponding resources.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-syncjob.html#cfn-iottwinmaker-syncjob-syncrole
//
SyncRole *string `field:"required" json:"syncRole" yaml:"syncRole"`
// The sync source.
//
// > Currently the only supported syncSoucre is `SITEWISE` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-syncjob.html#cfn-iottwinmaker-syncjob-syncsource
//
SyncSource *string `field:"required" json:"syncSource" yaml:"syncSource"`
// The ID of the workspace that contains the sync job.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-syncjob.html#cfn-iottwinmaker-syncjob-workspaceid
//
WorkspaceId *string `field:"required" json:"workspaceId" yaml:"workspaceId"`
// Metadata you can use to manage the SyncJob.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-syncjob.html#cfn-iottwinmaker-syncjob-tags
//
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnSyncJob`.
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"
cfnSyncJobProps := &CfnSyncJobProps{
SyncRole: jsii.String("syncRole"),
SyncSource: jsii.String("syncSource"),
WorkspaceId: jsii.String("workspaceId"),
// the properties below are optional
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-syncjob.html
type CfnWorkspace ¶
type CfnWorkspace interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// 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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// Metadata that you can use to manage the workspace.
TagsRaw() *map[string]*string
SetTagsRaw(val *map[string]*string)
// 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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
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
type CfnWorkspaceProps ¶
type CfnWorkspaceProps struct {
// The ARN of the execution role associated with the workspace.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html#cfn-iottwinmaker-workspace-role
//
Role *string `field:"required" json:"role" yaml:"role"`
// The ARN of the S3 bucket where resources associated with the workspace are stored.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html#cfn-iottwinmaker-workspace-s3location
//
S3Location *string `field:"required" json:"s3Location" yaml:"s3Location"`
// The ID of the workspace.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html#cfn-iottwinmaker-workspace-workspaceid
//
WorkspaceId *string `field:"required" json:"workspaceId" yaml:"workspaceId"`
// The description of the workspace.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html#cfn-iottwinmaker-workspace-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Metadata that you can use to manage the workspace.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html#cfn-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"),
},
}
Source Files
¶
- CfnComponentType.go
- CfnComponentTypeProps.go
- CfnComponentType_DataConnectorProperty.go
- CfnComponentType_DataTypeProperty.go
- CfnComponentType_DataValueProperty.go
- CfnComponentType_ErrorProperty.go
- CfnComponentType_FunctionProperty.go
- CfnComponentType_LambdaFunctionProperty.go
- CfnComponentType_PropertyDefinitionProperty.go
- CfnComponentType_PropertyGroupProperty.go
- CfnComponentType_RelationshipProperty.go
- CfnComponentType_RelationshipValueProperty.go
- CfnComponentType_StatusProperty.go
- CfnComponentType__checks.go
- CfnEntity.go
- CfnEntityProps.go
- CfnEntity_ComponentProperty.go
- CfnEntity_DataTypeProperty.go
- CfnEntity_DataValueProperty.go
- CfnEntity_DefinitionProperty.go
- CfnEntity_ErrorProperty.go
- CfnEntity_PropertyGroupProperty.go
- CfnEntity_PropertyProperty.go
- CfnEntity_RelationshipProperty.go
- CfnEntity_RelationshipValueProperty.go
- CfnEntity_StatusProperty.go
- CfnEntity__checks.go
- CfnScene.go
- CfnSceneProps.go
- CfnScene__checks.go
- CfnSyncJob.go
- CfnSyncJobProps.go
- CfnSyncJob__checks.go
- CfnWorkspace.go
- CfnWorkspaceProps.go
- CfnWorkspace__checks.go
- main.go