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)
Create a new `AWS::IoTTwinMaker::ComponentType`.
func NewCfnEntity_Override ¶
func NewCfnEntity_Override(c CfnEntity, scope constructs.Construct, id *string, props *CfnEntityProps)
Create a new `AWS::IoTTwinMaker::Entity`.
func NewCfnScene_Override ¶
func NewCfnScene_Override(c CfnScene, scope constructs.Construct, id *string, props *CfnSceneProps)
Create a new `AWS::IoTTwinMaker::Scene`.
func NewCfnSyncJob_Override ¶ added in v2.56.0
func NewCfnSyncJob_Override(c CfnSyncJob, scope constructs.Construct, id *string, props *CfnSyncJobProps)
Create a new `AWS::IoTTwinMaker::SyncJob`.
func NewCfnWorkspace_Override ¶
func NewCfnWorkspace_Override(c CfnWorkspace, scope constructs.Construct, id *string, props *CfnWorkspaceProps)
Create a new `AWS::IoTTwinMaker::Workspace`.
Types ¶
type CfnComponentType ¶
type CfnComponentType interface { awscdk.CfnResource awscdk.IInspectable // The ARN of the component type. AttrArn() *string // The date and time when the component type was created. AttrCreationDateTime() *string // A boolean value that specifies whether the component type is abstract. AttrIsAbstract() awscdk.IResolvable // A boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run. AttrIsSchemaInitialized() awscdk.IResolvable 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. // // Each string in the mapping must be unique to this object. // // For information on the FunctionResponse object see the [FunctionResponse](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_FunctionResponse.html) API reference. Functions() interface{} SetFunctions(val interface{}) // A boolean value that specifies whether an entity can have more than one component of this type. IsSingleton() interface{} SetIsSingleton(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // An object that maps strings to the property definitions in the component type. // // Each string in the mapping must be unique to this object. // // For information about the PropertyDefinitionResponse object, see the [PropertyDefinitionResponse](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_PropertyDefinitionResponse.html) API reference. PropertyDefinitions() interface{} SetPropertyDefinitions(val interface{}) // `AWS::IoTTwinMaker::ComponentType.PropertyGroups`. 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 // The ComponentType tags. Tags() awscdk.TagManager // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The ID of the workspace. WorkspaceId() *string SetWorkspaceId(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. 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{}) }
A CloudFormation `AWS::IoTTwinMaker::ComponentType`.
Use the `AWS::IoTTwinMaker::ComponentType` resource to declare a component type.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var dataTypeProperty_ dataTypeProperty var dataValueProperty_ dataValueProperty 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": &RelationshipValueProperty{ "targetComponentName": jsii.String("targetComponentName"), "targetEntityId": jsii.String("targetEntityId"), }, "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": &RelationshipValueProperty{ "targetComponentName": jsii.String("targetComponentName"), "targetEntityId": jsii.String("targetEntityId"), }, "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
Create a new `AWS::IoTTwinMaker::ComponentType`.
type CfnComponentTypeProps ¶
type CfnComponentTypeProps struct { // The ID of the component type. ComponentTypeId *string `field:"required" json:"componentTypeId" yaml:"componentTypeId"` // The ID of the workspace. WorkspaceId *string `field:"required" json:"workspaceId" yaml:"workspaceId"` // The description of the component type. Description *string `field:"optional" json:"description" yaml:"description"` // The name of the parent component type that this component type extends. ExtendsFrom *[]*string `field:"optional" json:"extendsFrom" yaml:"extendsFrom"` // An object that maps strings to the functions in the component type. // // Each string in the mapping must be unique to this object. // // For information on the FunctionResponse object see the [FunctionResponse](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_FunctionResponse.html) API reference. Functions interface{} `field:"optional" json:"functions" yaml:"functions"` // A boolean value that specifies whether an entity can have more than one component of this type. IsSingleton interface{} `field:"optional" json:"isSingleton" yaml:"isSingleton"` // An object that maps strings to the property definitions in the component type. // // Each string in the mapping must be unique to this object. // // For information about the PropertyDefinitionResponse object, see the [PropertyDefinitionResponse](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_PropertyDefinitionResponse.html) API reference. PropertyDefinitions interface{} `field:"optional" json:"propertyDefinitions" yaml:"propertyDefinitions"` // `AWS::IoTTwinMaker::ComponentType.PropertyGroups`. PropertyGroups interface{} `field:"optional" json:"propertyGroups" yaml:"propertyGroups"` // The ComponentType tags. Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnComponentType`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var dataTypeProperty_ dataTypeProperty var dataValueProperty_ dataValueProperty 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": &RelationshipValueProperty{ "targetComponentName": jsii.String("targetComponentName"), "targetEntityId": jsii.String("targetEntityId"), }, "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": &RelationshipValueProperty{ "targetComponentName": jsii.String("targetComponentName"), "targetEntityId": jsii.String("targetEntityId"), }, "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. IsNative interface{} `field:"optional" json:"isNative" yaml:"isNative"` // The Lambda function associated with the data connector. Lambda interface{} `field:"optional" json:"lambda" yaml:"lambda"` }
The data connector.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dataConnectorProperty := &dataConnectorProperty{ isNative: jsii.Boolean(false), lambda: &lambdaFunctionProperty{ arn: jsii.String("arn"), }, }
type CfnComponentType_DataTypeProperty ¶
type CfnComponentType_DataTypeProperty struct { // The underlying type of the data type. // // Valid Values: `RELATIONSHIP | STRING | LONG | BOOLEAN | INTEGER | DOUBLE | LIST | MAP`. Type *string `field:"required" json:"type" yaml:"type"` // The allowed values for this data type. AllowedValues interface{} `field:"optional" json:"allowedValues" yaml:"allowedValues"` // The nested type in the data type. NestedType interface{} `field:"optional" json:"nestedType" yaml:"nestedType"` // A relationship that associates a component with another component. Relationship interface{} `field:"optional" json:"relationship" yaml:"relationship"` // The unit of measure used in this data type. UnitOfMeasure *string `field:"optional" json:"unitOfMeasure" yaml:"unitOfMeasure"` }
An object that specifies the data type of a property.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var dataTypeProperty_ dataTypeProperty var dataValueProperty_ dataValueProperty 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: &relationshipValueProperty{ targetComponentName: jsii.String("targetComponentName"), targetEntityId: jsii.String("targetEntityId"), }, stringValue: jsii.String("stringValue"), }, }, nestedType: &dataTypeProperty{ type: jsii.String("type"), // the properties below are optional allowedValues: []interface{}{ &dataValueProperty{ booleanValue: jsii.Boolean(false), doubleValue: jsii.Number(123), expression: jsii.String("expression"), integerValue: jsii.Number(123), listValue: []interface{}{ dataValueProperty_, }, longValue: jsii.Number(123), mapValue: map[string]interface{}{ "mapValueKey": dataValueProperty_, }, relationshipValue: &relationshipValueProperty{ targetComponentName: jsii.String("targetComponentName"), targetEntityId: jsii.String("targetEntityId"), }, stringValue: jsii.String("stringValue"), }, }, nestedType: dataTypeProperty_, relationship: &relationshipProperty{ relationshipType: jsii.String("relationshipType"), targetComponentTypeId: jsii.String("targetComponentTypeId"), }, unitOfMeasure: jsii.String("unitOfMeasure"), }, relationship: &relationshipProperty{ relationshipType: jsii.String("relationshipType"), targetComponentTypeId: jsii.String("targetComponentTypeId"), }, unitOfMeasure: jsii.String("unitOfMeasure"), }
type CfnComponentType_DataValueProperty ¶
type CfnComponentType_DataValueProperty struct { // A boolean value. BooleanValue interface{} `field:"optional" json:"booleanValue" yaml:"booleanValue"` // A double value. DoubleValue *float64 `field:"optional" json:"doubleValue" yaml:"doubleValue"` // An expression that produces the value. Expression *string `field:"optional" json:"expression" yaml:"expression"` // An integer value. IntegerValue *float64 `field:"optional" json:"integerValue" yaml:"integerValue"` // A list of multiple values. ListValue interface{} `field:"optional" json:"listValue" yaml:"listValue"` // A long value. LongValue *float64 `field:"optional" json:"longValue" yaml:"longValue"` // An object that maps strings to multiple `DataValue` objects. MapValue interface{} `field:"optional" json:"mapValue" yaml:"mapValue"` // A value that relates a component to another component. RelationshipValue interface{} `field:"optional" json:"relationshipValue" yaml:"relationshipValue"` // A string value. StringValue *string `field:"optional" json:"stringValue" yaml:"stringValue"` }
An object that specifies a value for a property.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var dataValueProperty_ dataValueProperty dataValueProperty := &dataValueProperty{ booleanValue: jsii.Boolean(false), doubleValue: jsii.Number(123), expression: jsii.String("expression"), integerValue: jsii.Number(123), listValue: []interface{}{ &dataValueProperty{ booleanValue: jsii.Boolean(false), doubleValue: jsii.Number(123), expression: jsii.String("expression"), integerValue: jsii.Number(123), listValue: []interface{}{ dataValueProperty_, }, longValue: jsii.Number(123), mapValue: map[string]interface{}{ "mapValueKey": dataValueProperty_, }, relationshipValue: &relationshipValueProperty{ targetComponentName: jsii.String("targetComponentName"), targetEntityId: jsii.String("targetEntityId"), }, stringValue: jsii.String("stringValue"), }, }, longValue: jsii.Number(123), mapValue: map[string]interface{}{ "mapValueKey": &dataValueProperty{ "booleanValue": jsii.Boolean(false), "doubleValue": jsii.Number(123), "expression": jsii.String("expression"), "integerValue": jsii.Number(123), "listValue": []interface{}{ dataValueProperty_, }, "longValue": jsii.Number(123), "mapValue": map[string]interface{}{ "mapValueKey": dataValueProperty_, }, "relationshipValue": &relationshipValueProperty{ "targetComponentName": jsii.String("targetComponentName"), "targetEntityId": jsii.String("targetEntityId"), }, "stringValue": jsii.String("stringValue"), }, }, relationshipValue: &relationshipValueProperty{ targetComponentName: jsii.String("targetComponentName"), targetEntityId: jsii.String("targetEntityId"), }, stringValue: jsii.String("stringValue"), }
type CfnComponentType_ErrorProperty ¶ added in v2.55.0
type CfnComponentType_ErrorProperty struct { // `CfnComponentType.ErrorProperty.Code`. Code *string `field:"optional" json:"code" yaml:"code"` // `CfnComponentType.ErrorProperty.Message`. Message *string `field:"optional" json:"message" yaml:"message"` }
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. ImplementedBy interface{} `field:"optional" json:"implementedBy" yaml:"implementedBy"` // The required properties of the function. RequiredProperties *[]*string `field:"optional" json:"requiredProperties" yaml:"requiredProperties"` // The scope of the function. Scope *string `field:"optional" json:"scope" yaml:"scope"` }
The function body.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" functionProperty := &functionProperty{ implementedBy: &dataConnectorProperty{ isNative: jsii.Boolean(false), lambda: &lambdaFunctionProperty{ arn: jsii.String("arn"), }, }, requiredProperties: []*string{ jsii.String("requiredProperties"), }, scope: jsii.String("scope"), }
type CfnComponentType_LambdaFunctionProperty ¶
type CfnComponentType_LambdaFunctionProperty struct { // The Lambda function ARN. Arn *string `field:"required" json:"arn" yaml:"arn"` }
The Lambda function.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" lambdaFunctionProperty := &lambdaFunctionProperty{ arn: jsii.String("arn"), }
type CfnComponentType_PropertyDefinitionProperty ¶
type CfnComponentType_PropertyDefinitionProperty struct { // A mapping that specifies configuration information about the property. Configurations interface{} `field:"optional" json:"configurations" yaml:"configurations"` // `CfnComponentType.PropertyDefinitionProperty.DataType`. DataType interface{} `field:"optional" json:"dataType" yaml:"dataType"` // A boolean value that specifies whether the property ID comes from an external data store. DefaultValue interface{} `field:"optional" json:"defaultValue" yaml:"defaultValue"` // A boolean value that specifies whether the property ID comes from an external data store. IsExternalId interface{} `field:"optional" json:"isExternalId" yaml:"isExternalId"` // A boolean value that specifies whether the property is required in an entity. IsRequiredInEntity interface{} `field:"optional" json:"isRequiredInEntity" yaml:"isRequiredInEntity"` // A boolean value that specifies whether the property is stored externally. IsStoredExternally interface{} `field:"optional" json:"isStoredExternally" yaml:"isStoredExternally"` // A boolean value that specifies whether the property consists of time series data. IsTimeSeries interface{} `field:"optional" json:"isTimeSeries" yaml:"isTimeSeries"` }
PropertyDefinition is an object that maps strings to the property definitions in the component type.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var dataTypeProperty_ dataTypeProperty var dataValueProperty_ dataValueProperty 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: &relationshipValueProperty{ targetComponentName: jsii.String("targetComponentName"), targetEntityId: jsii.String("targetEntityId"), }, 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: &relationshipValueProperty{ targetComponentName: jsii.String("targetComponentName"), targetEntityId: jsii.String("targetEntityId"), }, 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 { // `CfnComponentType.PropertyGroupProperty.GroupType`. GroupType *string `field:"optional" json:"groupType" yaml:"groupType"` // `CfnComponentType.PropertyGroupProperty.PropertyNames`. PropertyNames *[]*string `field:"optional" json:"propertyNames" yaml:"propertyNames"` }
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. RelationshipType *string `field:"optional" json:"relationshipType" yaml:"relationshipType"` // The ID of the target component type associated with this relationship. TargetComponentTypeId *string `field:"optional" json:"targetComponentTypeId" yaml:"targetComponentTypeId"` }
An object that specifies a relationship with another component type.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" relationshipProperty := &relationshipProperty{ relationshipType: jsii.String("relationshipType"), targetComponentTypeId: jsii.String("targetComponentTypeId"), }
type CfnComponentType_RelationshipValueProperty ¶ added in v2.55.0
type CfnComponentType_RelationshipValueProperty struct { // `CfnComponentType.RelationshipValueProperty.TargetComponentName`. TargetComponentName *string `field:"optional" json:"targetComponentName" yaml:"targetComponentName"` // `CfnComponentType.RelationshipValueProperty.TargetEntityId`. TargetEntityId *string `field:"optional" json:"targetEntityId" yaml:"targetEntityId"` }
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 { // `CfnComponentType.StatusProperty.Error`. Error interface{} `field:"optional" json:"error" yaml:"error"` // `CfnComponentType.StatusProperty.State`. State *string `field:"optional" json:"state" yaml:"state"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" 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 // 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 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. // // Each string in the mapping must be unique to this object. // // For information on the component object see the [component](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_ComponentResponse.html) API reference. Components() interface{} SetComponents(val interface{}) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The description of the entity. Description() *string SetDescription(val *string) // The entity ID. EntityId() *string SetEntityId(val *string) // The entity name. EntityName() *string SetEntityName(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The ID of the parent entity. ParentEntityId() *string SetParentEntityId(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Metadata that you can use to manage the entity. Tags() awscdk.TagManager // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The ID of the workspace. WorkspaceId() *string SetWorkspaceId(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. 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{}) }
A CloudFormation `AWS::IoTTwinMaker::Entity`.
Use the `AWS::IoTTwinMaker::Entity` resource to declare an entity.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var dataTypeProperty_ dataTypeProperty var dataValueProperty_ dataValueProperty 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": &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": &RelationshipValueProperty{ "targetComponentName": jsii.String("targetComponentName"), "targetEntityId": jsii.String("targetEntityId"), }, "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": &RelationshipValueProperty{ "targetComponentName": jsii.String("targetComponentName"), "targetEntityId": jsii.String("targetEntityId"), }, "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), }, "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": &RelationshipValueProperty{ "targetComponentName": jsii.String("targetComponentName"), "targetEntityId": jsii.String("targetEntityId"), }, "stringValue": jsii.String("stringValue"), }, }, }, "propertyGroups": map[string]interface{}{ "propertyGroupsKey": &PropertyGroupProperty{ "groupType": jsii.String("groupType"), "propertyNames": []*string{ jsii.String("propertyNames"), }, }, }, "status": &StatusProperty{ "error": &ErrorProperty{ "code": jsii.String("code"), "message": jsii.String("message"), }, "state": jsii.String("state"), }, }, }, description: jsii.String("description"), entityId: jsii.String("entityId"), parentEntityId: jsii.String("parentEntityId"), tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
func NewCfnEntity ¶
func NewCfnEntity(scope constructs.Construct, id *string, props *CfnEntityProps) CfnEntity
Create a new `AWS::IoTTwinMaker::Entity`.
type CfnEntityProps ¶
type CfnEntityProps struct { // The entity name. EntityName *string `field:"required" json:"entityName" yaml:"entityName"` // The ID of the workspace. WorkspaceId *string `field:"required" json:"workspaceId" yaml:"workspaceId"` // An object that maps strings to the components in the entity. // // Each string in the mapping must be unique to this object. // // For information on the component object see the [component](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_ComponentResponse.html) API reference. Components interface{} `field:"optional" json:"components" yaml:"components"` // The description of the entity. Description *string `field:"optional" json:"description" yaml:"description"` // The entity ID. EntityId *string `field:"optional" json:"entityId" yaml:"entityId"` // The ID of the parent entity. ParentEntityId *string `field:"optional" json:"parentEntityId" yaml:"parentEntityId"` // Metadata that you can use to manage the entity. Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnEntity`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var dataTypeProperty_ dataTypeProperty var dataValueProperty_ dataValueProperty 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": &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": &RelationshipValueProperty{ "targetComponentName": jsii.String("targetComponentName"), "targetEntityId": jsii.String("targetEntityId"), }, "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": &RelationshipValueProperty{ "targetComponentName": jsii.String("targetComponentName"), "targetEntityId": jsii.String("targetEntityId"), }, "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), }, "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": &RelationshipValueProperty{ "targetComponentName": jsii.String("targetComponentName"), "targetEntityId": jsii.String("targetEntityId"), }, "stringValue": jsii.String("stringValue"), }, }, }, "propertyGroups": map[string]interface{}{ "propertyGroupsKey": &PropertyGroupProperty{ "groupType": jsii.String("groupType"), "propertyNames": []*string{ jsii.String("propertyNames"), }, }, }, "status": &StatusProperty{ "error": &ErrorProperty{ "code": jsii.String("code"), "message": jsii.String("message"), }, "state": jsii.String("state"), }, }, }, description: jsii.String("description"), entityId: jsii.String("entityId"), parentEntityId: jsii.String("parentEntityId"), tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
type CfnEntity_ComponentProperty ¶
type CfnEntity_ComponentProperty struct { // The name of the component. ComponentName *string `field:"optional" json:"componentName" yaml:"componentName"` // The ID of the ComponentType. ComponentTypeId *string `field:"optional" json:"componentTypeId" yaml:"componentTypeId"` // The name of the property definition set in the request. DefinedIn *string `field:"optional" json:"definedIn" yaml:"definedIn"` // The description of the component. Description *string `field:"optional" json:"description" yaml:"description"` // An object that maps strings to the properties to set in the component type. // // Each string in the mapping must be unique to this object. Properties interface{} `field:"optional" json:"properties" yaml:"properties"` // `CfnEntity.ComponentProperty.PropertyGroups`. PropertyGroups interface{} `field:"optional" json:"propertyGroups" yaml:"propertyGroups"` // The status of the component. Status interface{} `field:"optional" json:"status" yaml:"status"` }
The entity componenet.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var dataTypeProperty_ dataTypeProperty var dataValueProperty_ dataValueProperty 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": &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": &RelationshipValueProperty{ "targetComponentName": jsii.String("targetComponentName"), "targetEntityId": jsii.String("targetEntityId"), }, "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": &RelationshipValueProperty{ "targetComponentName": jsii.String("targetComponentName"), "targetEntityId": jsii.String("targetEntityId"), }, "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), }, "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": &RelationshipValueProperty{ "targetComponentName": jsii.String("targetComponentName"), "targetEntityId": jsii.String("targetEntityId"), }, "stringValue": jsii.String("stringValue"), }, }, }, propertyGroups: map[string]interface{}{ "propertyGroupsKey": &PropertyGroupProperty{ "groupType": jsii.String("groupType"), "propertyNames": []*string{ jsii.String("propertyNames"), }, }, }, status: &statusProperty{ error: &errorProperty{ code: jsii.String("code"), message: jsii.String("message"), }, state: jsii.String("state"), }, }
type CfnEntity_DataTypeProperty ¶ added in v2.55.0
type CfnEntity_DataTypeProperty struct { // `CfnEntity.DataTypeProperty.AllowedValues`. AllowedValues interface{} `field:"optional" json:"allowedValues" yaml:"allowedValues"` // `CfnEntity.DataTypeProperty.NestedType`. NestedType interface{} `field:"optional" json:"nestedType" yaml:"nestedType"` // `CfnEntity.DataTypeProperty.Relationship`. Relationship interface{} `field:"optional" json:"relationship" yaml:"relationship"` // `CfnEntity.DataTypeProperty.Type`. Type *string `field:"optional" json:"type" yaml:"type"` // `CfnEntity.DataTypeProperty.UnitOfMeasure`. UnitOfMeasure *string `field:"optional" json:"unitOfMeasure" yaml:"unitOfMeasure"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var dataTypeProperty_ dataTypeProperty var dataValueProperty_ dataValueProperty 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: &relationshipValueProperty{ targetComponentName: jsii.String("targetComponentName"), targetEntityId: jsii.String("targetEntityId"), }, stringValue: jsii.String("stringValue"), }, }, nestedType: &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: &relationshipValueProperty{ targetComponentName: jsii.String("targetComponentName"), targetEntityId: jsii.String("targetEntityId"), }, stringValue: jsii.String("stringValue"), }, }, nestedType: dataTypeProperty_, relationship: &relationshipProperty{ relationshipType: jsii.String("relationshipType"), targetComponentTypeId: jsii.String("targetComponentTypeId"), }, type: jsii.String("type"), unitOfMeasure: jsii.String("unitOfMeasure"), }, 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. BooleanValue interface{} `field:"optional" json:"booleanValue" yaml:"booleanValue"` // A double value. DoubleValue *float64 `field:"optional" json:"doubleValue" yaml:"doubleValue"` // An expression that produces the value. Expression *string `field:"optional" json:"expression" yaml:"expression"` // An integer value. IntegerValue *float64 `field:"optional" json:"integerValue" yaml:"integerValue"` // A list of multiple values. ListValue interface{} `field:"optional" json:"listValue" yaml:"listValue"` // A long value. LongValue *float64 `field:"optional" json:"longValue" yaml:"longValue"` // An object that maps strings to multiple DataValue objects. MapValue interface{} `field:"optional" json:"mapValue" yaml:"mapValue"` // A value that relates a component to another component. RelationshipValue interface{} `field:"optional" json:"relationshipValue" yaml:"relationshipValue"` // A string value. StringValue *string `field:"optional" json:"stringValue" yaml:"stringValue"` }
An object that specifies a value for a property.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var dataValueProperty_ dataValueProperty dataValueProperty := &dataValueProperty{ booleanValue: jsii.Boolean(false), doubleValue: jsii.Number(123), expression: jsii.String("expression"), integerValue: jsii.Number(123), listValue: []interface{}{ &dataValueProperty{ booleanValue: jsii.Boolean(false), doubleValue: jsii.Number(123), expression: jsii.String("expression"), integerValue: jsii.Number(123), listValue: []interface{}{ dataValueProperty_, }, longValue: jsii.Number(123), mapValue: map[string]interface{}{ "mapValueKey": dataValueProperty_, }, relationshipValue: &relationshipValueProperty{ targetComponentName: jsii.String("targetComponentName"), targetEntityId: jsii.String("targetEntityId"), }, stringValue: jsii.String("stringValue"), }, }, longValue: jsii.Number(123), mapValue: map[string]interface{}{ "mapValueKey": &dataValueProperty{ "booleanValue": jsii.Boolean(false), "doubleValue": jsii.Number(123), "expression": jsii.String("expression"), "integerValue": jsii.Number(123), "listValue": []interface{}{ dataValueProperty_, }, "longValue": jsii.Number(123), "mapValue": map[string]interface{}{ "mapValueKey": dataValueProperty_, }, "relationshipValue": &relationshipValueProperty{ "targetComponentName": jsii.String("targetComponentName"), "targetEntityId": jsii.String("targetEntityId"), }, "stringValue": jsii.String("stringValue"), }, }, relationshipValue: &relationshipValueProperty{ targetComponentName: jsii.String("targetComponentName"), targetEntityId: jsii.String("targetEntityId"), }, stringValue: jsii.String("stringValue"), }
type CfnEntity_DefinitionProperty ¶ added in v2.55.0
type CfnEntity_DefinitionProperty struct { // `CfnEntity.DefinitionProperty.Configuration`. Configuration interface{} `field:"optional" json:"configuration" yaml:"configuration"` // `CfnEntity.DefinitionProperty.DataType`. DataType interface{} `field:"optional" json:"dataType" yaml:"dataType"` // `CfnEntity.DefinitionProperty.DefaultValue`. DefaultValue interface{} `field:"optional" json:"defaultValue" yaml:"defaultValue"` // `CfnEntity.DefinitionProperty.IsExternalId`. IsExternalId interface{} `field:"optional" json:"isExternalId" yaml:"isExternalId"` // `CfnEntity.DefinitionProperty.IsFinal`. IsFinal interface{} `field:"optional" json:"isFinal" yaml:"isFinal"` // `CfnEntity.DefinitionProperty.IsImported`. IsImported interface{} `field:"optional" json:"isImported" yaml:"isImported"` // `CfnEntity.DefinitionProperty.IsInherited`. IsInherited interface{} `field:"optional" json:"isInherited" yaml:"isInherited"` // `CfnEntity.DefinitionProperty.IsRequiredInEntity`. IsRequiredInEntity interface{} `field:"optional" json:"isRequiredInEntity" yaml:"isRequiredInEntity"` // `CfnEntity.DefinitionProperty.IsStoredExternally`. IsStoredExternally interface{} `field:"optional" json:"isStoredExternally" yaml:"isStoredExternally"` // `CfnEntity.DefinitionProperty.IsTimeSeries`. IsTimeSeries interface{} `field:"optional" json:"isTimeSeries" yaml:"isTimeSeries"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var dataTypeProperty_ dataTypeProperty var dataValueProperty_ dataValueProperty 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: &relationshipValueProperty{ targetComponentName: jsii.String("targetComponentName"), targetEntityId: jsii.String("targetEntityId"), }, 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: &relationshipValueProperty{ targetComponentName: jsii.String("targetComponentName"), targetEntityId: jsii.String("targetEntityId"), }, 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 { // `CfnEntity.ErrorProperty.Code`. Code *string `field:"optional" json:"code" yaml:"code"` // `CfnEntity.ErrorProperty.Message`. Message *string `field:"optional" json:"message" yaml:"message"` }
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 { // `CfnEntity.PropertyGroupProperty.GroupType`. GroupType *string `field:"optional" json:"groupType" yaml:"groupType"` // `CfnEntity.PropertyGroupProperty.PropertyNames`. PropertyNames *[]*string `field:"optional" json:"propertyNames" yaml:"propertyNames"` }
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. Definition interface{} `field:"optional" json:"definition" yaml:"definition"` // An object that contains information about a value for a time series property. Value interface{} `field:"optional" json:"value" yaml:"value"` }
An object that sets information about a property.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var dataTypeProperty_ dataTypeProperty var dataValueProperty_ dataValueProperty propertyProperty := &propertyProperty{ definition: &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: &relationshipValueProperty{ targetComponentName: jsii.String("targetComponentName"), targetEntityId: jsii.String("targetEntityId"), }, 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: &relationshipValueProperty{ targetComponentName: jsii.String("targetComponentName"), targetEntityId: jsii.String("targetEntityId"), }, 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), }, 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: &relationshipValueProperty{ targetComponentName: jsii.String("targetComponentName"), targetEntityId: jsii.String("targetEntityId"), }, stringValue: jsii.String("stringValue"), }, }
type CfnEntity_RelationshipProperty ¶ added in v2.55.0
type CfnEntity_RelationshipProperty struct { // `CfnEntity.RelationshipProperty.RelationshipType`. RelationshipType *string `field:"optional" json:"relationshipType" yaml:"relationshipType"` // `CfnEntity.RelationshipProperty.TargetComponentTypeId`. TargetComponentTypeId *string `field:"optional" json:"targetComponentTypeId" yaml:"targetComponentTypeId"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" relationshipProperty := &relationshipProperty{ relationshipType: jsii.String("relationshipType"), targetComponentTypeId: jsii.String("targetComponentTypeId"), }
type CfnEntity_RelationshipValueProperty ¶ added in v2.55.0
type CfnEntity_RelationshipValueProperty struct { // `CfnEntity.RelationshipValueProperty.TargetComponentName`. TargetComponentName *string `field:"optional" json:"targetComponentName" yaml:"targetComponentName"` // `CfnEntity.RelationshipValueProperty.TargetEntityId`. TargetEntityId *string `field:"optional" json:"targetEntityId" yaml:"targetEntityId"` }
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. Error interface{} `field:"optional" json:"error" yaml:"error"` // The current state of the entity, component, component type, or workspace. // // Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | ERROR`. State *string `field:"optional" json:"state" yaml:"state"` }
The current status of the entity.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" statusProperty := &statusProperty{ error: &errorProperty{ code: jsii.String("code"), message: jsii.String("message"), }, state: jsii.String("state"), }
type CfnScene ¶
type CfnScene interface { awscdk.CfnResource awscdk.IInspectable // The scene ARN. AttrArn() *string // The date and time when the scene was created. AttrCreationDateTime() *string // The scene the update time. AttrUpdateDateTime() *string // A list of capabilities that the scene uses to render. Capabilities() *[]*string SetCapabilities(val *[]*string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The relative path that specifies the location of the content definition file. ContentLocation() *string SetContentLocation(val *string) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The description of this scene. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The scene ID. SceneId() *string SetSceneId(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The ComponentType tags. Tags() awscdk.TagManager // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The ID of the workspace. WorkspaceId() *string SetWorkspaceId(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. 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{}) }
A CloudFormation `AWS::IoTTwinMaker::Scene`.
Use the `AWS::IoTTwinMaker::Scene` resource to declare a scene.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnScene := awscdk.Aws_iottwinmaker.NewCfnScene(this, jsii.String("MyCfnScene"), &cfnSceneProps{ contentLocation: jsii.String("contentLocation"), sceneId: jsii.String("sceneId"), workspaceId: jsii.String("workspaceId"), // the properties below are optional capabilities: []*string{ jsii.String("capabilities"), }, description: jsii.String("description"), tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
func NewCfnScene ¶
func NewCfnScene(scope constructs.Construct, id *string, props *CfnSceneProps) CfnScene
Create a new `AWS::IoTTwinMaker::Scene`.
type CfnSceneProps ¶
type CfnSceneProps struct { // The relative path that specifies the location of the content definition file. ContentLocation *string `field:"required" json:"contentLocation" yaml:"contentLocation"` // The scene ID. SceneId *string `field:"required" json:"sceneId" yaml:"sceneId"` // The ID of the workspace. WorkspaceId *string `field:"required" json:"workspaceId" yaml:"workspaceId"` // A list of capabilities that the scene uses to render. Capabilities *[]*string `field:"optional" json:"capabilities" yaml:"capabilities"` // The description of this scene. Description *string `field:"optional" json:"description" yaml:"description"` // The ComponentType tags. Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnScene`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSceneProps := &cfnSceneProps{ contentLocation: jsii.String("contentLocation"), sceneId: jsii.String("sceneId"), workspaceId: jsii.String("workspaceId"), // the properties below are optional capabilities: []*string{ jsii.String("capabilities"), }, description: jsii.String("description"), tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
type CfnSyncJob ¶ added in v2.56.0
type CfnSyncJob interface { awscdk.CfnResource awscdk.IInspectable AttrArn() *string AttrCreationDateTime() *string AttrState() *string AttrUpdateDateTime() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // 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 // `AWS::IoTTwinMaker::SyncJob.SyncRole`. SyncRole() *string SetSyncRole(val *string) // `AWS::IoTTwinMaker::SyncJob.SyncSource`. SyncSource() *string SetSyncSource(val *string) // `AWS::IoTTwinMaker::SyncJob.Tags`. Tags() awscdk.TagManager // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // `AWS::IoTTwinMaker::SyncJob.WorkspaceId`. WorkspaceId() *string SetWorkspaceId(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. 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{}) }
A CloudFormation `AWS::IoTTwinMaker::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"), }, })
func NewCfnSyncJob ¶ added in v2.56.0
func NewCfnSyncJob(scope constructs.Construct, id *string, props *CfnSyncJobProps) CfnSyncJob
Create a new `AWS::IoTTwinMaker::SyncJob`.
type CfnSyncJobProps ¶ added in v2.56.0
type CfnSyncJobProps struct { // `AWS::IoTTwinMaker::SyncJob.SyncRole`. SyncRole *string `field:"required" json:"syncRole" yaml:"syncRole"` // `AWS::IoTTwinMaker::SyncJob.SyncSource`. SyncSource *string `field:"required" json:"syncSource" yaml:"syncSource"` // `AWS::IoTTwinMaker::SyncJob.WorkspaceId`. WorkspaceId *string `field:"required" json:"workspaceId" yaml:"workspaceId"` // `AWS::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"), }, }
type CfnWorkspace ¶
type CfnWorkspace interface { awscdk.CfnResource awscdk.IInspectable // The workspace ARN. AttrArn() *string // The date and time the workspace was created. AttrCreationDateTime() *string // The date and time the workspace was updated. AttrUpdateDateTime() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The description of the workspace. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The ARN of the execution role associated with the workspace. Role() *string SetRole(val *string) // The ARN of the S3 bucket where resources associated with the workspace are stored. S3Location() *string SetS3Location(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Metadata that you can use to manage the workspace. Tags() awscdk.TagManager // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The ID of the workspace. WorkspaceId() *string SetWorkspaceId(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. 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{}) }
A CloudFormation `AWS::IoTTwinMaker::Workspace`.
Use the `AWS::IoTTwinMaker::Workspace` resource to declare a workspace.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnWorkspace := awscdk.Aws_iottwinmaker.NewCfnWorkspace(this, jsii.String("MyCfnWorkspace"), &cfnWorkspaceProps{ role: jsii.String("role"), s3Location: jsii.String("s3Location"), workspaceId: jsii.String("workspaceId"), // the properties below are optional description: jsii.String("description"), tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
func NewCfnWorkspace ¶
func NewCfnWorkspace(scope constructs.Construct, id *string, props *CfnWorkspaceProps) CfnWorkspace
Create a new `AWS::IoTTwinMaker::Workspace`.
type CfnWorkspaceProps ¶
type CfnWorkspaceProps struct { // The ARN of the execution role associated with the workspace. Role *string `field:"required" json:"role" yaml:"role"` // The ARN of the S3 bucket where resources associated with the workspace are stored. S3Location *string `field:"required" json:"s3Location" yaml:"s3Location"` // The ID of the workspace. WorkspaceId *string `field:"required" json:"workspaceId" yaml:"workspaceId"` // The description of the workspace. Description *string `field:"optional" json:"description" yaml:"description"` // Metadata that you can use to manage the workspace. Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnWorkspace`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnWorkspaceProps := &cfnWorkspaceProps{ role: jsii.String("role"), s3Location: jsii.String("s3Location"), workspaceId: jsii.String("workspaceId"), // the properties below are optional description: jsii.String("description"), tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
Source Files ¶
- awsiottwinmaker.go
- awsiottwinmaker_CfnComponentType.go
- awsiottwinmaker_CfnComponentTypeProps.go
- awsiottwinmaker_CfnComponentType_DataConnectorProperty.go
- awsiottwinmaker_CfnComponentType_DataTypeProperty.go
- awsiottwinmaker_CfnComponentType_DataValueProperty.go
- awsiottwinmaker_CfnComponentType_ErrorProperty.go
- awsiottwinmaker_CfnComponentType_FunctionProperty.go
- awsiottwinmaker_CfnComponentType_LambdaFunctionProperty.go
- awsiottwinmaker_CfnComponentType_PropertyDefinitionProperty.go
- awsiottwinmaker_CfnComponentType_PropertyGroupProperty.go
- awsiottwinmaker_CfnComponentType_RelationshipProperty.go
- awsiottwinmaker_CfnComponentType_RelationshipValueProperty.go
- awsiottwinmaker_CfnComponentType_StatusProperty.go
- awsiottwinmaker_CfnComponentType__runtime_type_checks.go
- awsiottwinmaker_CfnEntity.go
- awsiottwinmaker_CfnEntityProps.go
- awsiottwinmaker_CfnEntity_ComponentProperty.go
- awsiottwinmaker_CfnEntity_DataTypeProperty.go
- awsiottwinmaker_CfnEntity_DataValueProperty.go
- awsiottwinmaker_CfnEntity_DefinitionProperty.go
- awsiottwinmaker_CfnEntity_ErrorProperty.go
- awsiottwinmaker_CfnEntity_PropertyGroupProperty.go
- awsiottwinmaker_CfnEntity_PropertyProperty.go
- awsiottwinmaker_CfnEntity_RelationshipProperty.go
- awsiottwinmaker_CfnEntity_RelationshipValueProperty.go
- awsiottwinmaker_CfnEntity_StatusProperty.go
- awsiottwinmaker_CfnEntity__runtime_type_checks.go
- awsiottwinmaker_CfnScene.go
- awsiottwinmaker_CfnSceneProps.go
- awsiottwinmaker_CfnScene__runtime_type_checks.go
- awsiottwinmaker_CfnSyncJob.go
- awsiottwinmaker_CfnSyncJobProps.go
- awsiottwinmaker_CfnSyncJob__runtime_type_checks.go
- awsiottwinmaker_CfnWorkspace.go
- awsiottwinmaker_CfnWorkspaceProps.go
- awsiottwinmaker_CfnWorkspace__runtime_type_checks.go