Documentation
¶
Index ¶
- func CfnCampaign_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCampaign_IsCfnElement(x interface{}) *bool
- func CfnCampaign_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnCampaign_IsConstruct(x interface{}) *bool
- func CfnDecoderManifest_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDecoderManifest_IsCfnElement(x interface{}) *bool
- func CfnDecoderManifest_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDecoderManifest_IsConstruct(x interface{}) *bool
- func CfnFleet_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFleet_IsCfnElement(x interface{}) *bool
- func CfnFleet_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnFleet_IsConstruct(x interface{}) *bool
- func CfnModelManifest_CFN_RESOURCE_TYPE_NAME() *string
- func CfnModelManifest_IsCfnElement(x interface{}) *bool
- func CfnModelManifest_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnModelManifest_IsConstruct(x interface{}) *bool
- func CfnSignalCatalog_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSignalCatalog_IsCfnElement(x interface{}) *bool
- func CfnSignalCatalog_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSignalCatalog_IsConstruct(x interface{}) *bool
- func CfnVehicle_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVehicle_IsCfnElement(x interface{}) *bool
- func CfnVehicle_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnVehicle_IsConstruct(x interface{}) *bool
- func NewCfnCampaign_Override(c CfnCampaign, scope awscdk.Construct, id *string, props *CfnCampaignProps)
- func NewCfnDecoderManifest_Override(c CfnDecoderManifest, scope awscdk.Construct, id *string, ...)
- func NewCfnFleet_Override(c CfnFleet, scope awscdk.Construct, id *string, props *CfnFleetProps)
- func NewCfnModelManifest_Override(c CfnModelManifest, scope awscdk.Construct, id *string, ...)
- func NewCfnSignalCatalog_Override(c CfnSignalCatalog, scope awscdk.Construct, id *string, ...)
- func NewCfnVehicle_Override(c CfnVehicle, scope awscdk.Construct, id *string, props *CfnVehicleProps)
- type CfnCampaign
- type CfnCampaignProps
- type CfnCampaign_CollectionSchemeProperty
- type CfnCampaign_ConditionBasedCollectionSchemeProperty
- type CfnCampaign_SignalInformationProperty
- type CfnCampaign_TimeBasedCollectionSchemeProperty
- type CfnDecoderManifest
- type CfnDecoderManifestProps
- type CfnDecoderManifest_CanInterfaceProperty
- type CfnDecoderManifest_CanNetworkInterfaceProperty
- type CfnDecoderManifest_CanSignalDecoderProperty
- type CfnDecoderManifest_CanSignalProperty
- type CfnDecoderManifest_ObdInterfaceProperty
- type CfnDecoderManifest_ObdNetworkInterfaceProperty
- type CfnDecoderManifest_ObdSignalDecoderProperty
- type CfnDecoderManifest_ObdSignalProperty
- type CfnFleet
- type CfnFleetProps
- type CfnModelManifest
- type CfnModelManifestProps
- type CfnSignalCatalog
- type CfnSignalCatalogProps
- type CfnSignalCatalog_ActuatorProperty
- type CfnSignalCatalog_AttributeProperty
- type CfnSignalCatalog_BranchProperty
- type CfnSignalCatalog_NodeCountsProperty
- type CfnSignalCatalog_NodeProperty
- type CfnSignalCatalog_SensorProperty
- type CfnVehicle
- type CfnVehicleProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnCampaign_CFN_RESOURCE_TYPE_NAME ¶
func CfnCampaign_CFN_RESOURCE_TYPE_NAME() *string
func CfnCampaign_IsCfnElement ¶
func CfnCampaign_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. Experimental.
func CfnCampaign_IsCfnResource ¶
func CfnCampaign_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnCampaign_IsConstruct ¶
func CfnCampaign_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnDecoderManifest_CFN_RESOURCE_TYPE_NAME ¶
func CfnDecoderManifest_CFN_RESOURCE_TYPE_NAME() *string
func CfnDecoderManifest_IsCfnElement ¶
func CfnDecoderManifest_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. Experimental.
func CfnDecoderManifest_IsCfnResource ¶
func CfnDecoderManifest_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnDecoderManifest_IsConstruct ¶
func CfnDecoderManifest_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnFleet_CFN_RESOURCE_TYPE_NAME ¶
func CfnFleet_CFN_RESOURCE_TYPE_NAME() *string
func CfnFleet_IsCfnElement ¶
func CfnFleet_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. Experimental.
func CfnFleet_IsCfnResource ¶
func CfnFleet_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnFleet_IsConstruct ¶
func CfnFleet_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnModelManifest_CFN_RESOURCE_TYPE_NAME ¶
func CfnModelManifest_CFN_RESOURCE_TYPE_NAME() *string
func CfnModelManifest_IsCfnElement ¶
func CfnModelManifest_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. Experimental.
func CfnModelManifest_IsCfnResource ¶
func CfnModelManifest_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnModelManifest_IsConstruct ¶
func CfnModelManifest_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnSignalCatalog_CFN_RESOURCE_TYPE_NAME ¶
func CfnSignalCatalog_CFN_RESOURCE_TYPE_NAME() *string
func CfnSignalCatalog_IsCfnElement ¶
func CfnSignalCatalog_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. Experimental.
func CfnSignalCatalog_IsCfnResource ¶
func CfnSignalCatalog_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnSignalCatalog_IsConstruct ¶
func CfnSignalCatalog_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnVehicle_CFN_RESOURCE_TYPE_NAME ¶
func CfnVehicle_CFN_RESOURCE_TYPE_NAME() *string
func CfnVehicle_IsCfnElement ¶
func CfnVehicle_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. Experimental.
func CfnVehicle_IsCfnResource ¶
func CfnVehicle_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnVehicle_IsConstruct ¶
func CfnVehicle_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewCfnCampaign_Override ¶
func NewCfnCampaign_Override(c CfnCampaign, scope awscdk.Construct, id *string, props *CfnCampaignProps)
Create a new `AWS::IoTFleetWise::Campaign`.
func NewCfnDecoderManifest_Override ¶
func NewCfnDecoderManifest_Override(c CfnDecoderManifest, scope awscdk.Construct, id *string, props *CfnDecoderManifestProps)
Create a new `AWS::IoTFleetWise::DecoderManifest`.
func NewCfnFleet_Override ¶
func NewCfnFleet_Override(c CfnFleet, scope awscdk.Construct, id *string, props *CfnFleetProps)
Create a new `AWS::IoTFleetWise::Fleet`.
func NewCfnModelManifest_Override ¶
func NewCfnModelManifest_Override(c CfnModelManifest, scope awscdk.Construct, id *string, props *CfnModelManifestProps)
Create a new `AWS::IoTFleetWise::ModelManifest`.
func NewCfnSignalCatalog_Override ¶
func NewCfnSignalCatalog_Override(c CfnSignalCatalog, scope awscdk.Construct, id *string, props *CfnSignalCatalogProps)
Create a new `AWS::IoTFleetWise::SignalCatalog`.
func NewCfnVehicle_Override ¶
func NewCfnVehicle_Override(c CfnVehicle, scope awscdk.Construct, id *string, props *CfnVehicleProps)
Create a new `AWS::IoTFleetWise::Vehicle`.
Types ¶
type CfnCampaign ¶
type CfnCampaign interface {
awscdk.CfnResource
awscdk.IInspectable
// `AWS::IoTFleetWise::Campaign.Action`.
Action() *string
SetAction(val *string)
AttrArn() *string
AttrCreationTime() *string
AttrLastModificationTime() *string
AttrStatus() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// `AWS::IoTFleetWise::Campaign.CollectionScheme`.
CollectionScheme() interface{}
SetCollectionScheme(val interface{})
// `AWS::IoTFleetWise::Campaign.Compression`.
Compression() *string
SetCompression(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.
// Experimental.
CreationStack() *[]*string
// `AWS::IoTFleetWise::Campaign.DataExtraDimensions`.
DataExtraDimensions() *[]*string
SetDataExtraDimensions(val *[]*string)
// `AWS::IoTFleetWise::Campaign.Description`.
Description() *string
SetDescription(val *string)
// `AWS::IoTFleetWise::Campaign.DiagnosticsMode`.
DiagnosticsMode() *string
SetDiagnosticsMode(val *string)
// `AWS::IoTFleetWise::Campaign.ExpiryTime`.
ExpiryTime() *string
SetExpiryTime(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.
// Experimental.
LogicalId() *string
// `AWS::IoTFleetWise::Campaign.Name`.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// `AWS::IoTFleetWise::Campaign.PostTriggerCollectionDuration`.
PostTriggerCollectionDuration() *float64
SetPostTriggerCollectionDuration(val *float64)
// `AWS::IoTFleetWise::Campaign.Priority`.
Priority() *float64
SetPriority(val *float64)
// 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 })`.
// Experimental.
Ref() *string
// `AWS::IoTFleetWise::Campaign.SignalCatalogArn`.
SignalCatalogArn() *string
SetSignalCatalogArn(val *string)
// `AWS::IoTFleetWise::Campaign.SignalsToCollect`.
SignalsToCollect() interface{}
SetSignalsToCollect(val interface{})
// `AWS::IoTFleetWise::Campaign.SpoolingMode`.
SpoolingMode() *string
SetSpoolingMode(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// `AWS::IoTFleetWise::Campaign.StartTime`.
StartTime() *string
SetStartTime(val *string)
// `AWS::IoTFleetWise::Campaign.Tags`.
Tags() awscdk.TagManager
// `AWS::IoTFleetWise::Campaign.TargetArn`.
TargetArn() *string
SetTargetArn(val *string)
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::IoTFleetWise::Campaign`.
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"
cfnCampaign := awscdk.Aws_iotfleetwise.NewCfnCampaign(this, jsii.String("MyCfnCampaign"), &cfnCampaignProps{
action: jsii.String("action"),
collectionScheme: &collectionSchemeProperty{
conditionBasedCollectionScheme: &conditionBasedCollectionSchemeProperty{
expression: jsii.String("expression"),
// the properties below are optional
conditionLanguageVersion: jsii.Number(123),
minimumTriggerIntervalMs: jsii.Number(123),
triggerMode: jsii.String("triggerMode"),
},
timeBasedCollectionScheme: &timeBasedCollectionSchemeProperty{
periodMs: jsii.Number(123),
},
},
name: jsii.String("name"),
signalCatalogArn: jsii.String("signalCatalogArn"),
targetArn: jsii.String("targetArn"),
// the properties below are optional
compression: jsii.String("compression"),
dataExtraDimensions: []*string{
jsii.String("dataExtraDimensions"),
},
description: jsii.String("description"),
diagnosticsMode: jsii.String("diagnosticsMode"),
expiryTime: jsii.String("expiryTime"),
postTriggerCollectionDuration: jsii.Number(123),
priority: jsii.Number(123),
signalsToCollect: []interface{}{
&signalInformationProperty{
name: jsii.String("name"),
// the properties below are optional
maxSampleCount: jsii.Number(123),
minimumSamplingIntervalMs: jsii.Number(123),
},
},
spoolingMode: jsii.String("spoolingMode"),
startTime: jsii.String("startTime"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnCampaign ¶
func NewCfnCampaign(scope awscdk.Construct, id *string, props *CfnCampaignProps) CfnCampaign
Create a new `AWS::IoTFleetWise::Campaign`.
type CfnCampaignProps ¶
type CfnCampaignProps struct {
// `AWS::IoTFleetWise::Campaign.Action`.
Action *string `field:"required" json:"action" yaml:"action"`
// `AWS::IoTFleetWise::Campaign.CollectionScheme`.
CollectionScheme interface{} `field:"required" json:"collectionScheme" yaml:"collectionScheme"`
// `AWS::IoTFleetWise::Campaign.Name`.
Name *string `field:"required" json:"name" yaml:"name"`
// `AWS::IoTFleetWise::Campaign.SignalCatalogArn`.
SignalCatalogArn *string `field:"required" json:"signalCatalogArn" yaml:"signalCatalogArn"`
// `AWS::IoTFleetWise::Campaign.TargetArn`.
TargetArn *string `field:"required" json:"targetArn" yaml:"targetArn"`
// `AWS::IoTFleetWise::Campaign.Compression`.
Compression *string `field:"optional" json:"compression" yaml:"compression"`
// `AWS::IoTFleetWise::Campaign.DataExtraDimensions`.
DataExtraDimensions *[]*string `field:"optional" json:"dataExtraDimensions" yaml:"dataExtraDimensions"`
// `AWS::IoTFleetWise::Campaign.Description`.
Description *string `field:"optional" json:"description" yaml:"description"`
// `AWS::IoTFleetWise::Campaign.DiagnosticsMode`.
DiagnosticsMode *string `field:"optional" json:"diagnosticsMode" yaml:"diagnosticsMode"`
// `AWS::IoTFleetWise::Campaign.ExpiryTime`.
ExpiryTime *string `field:"optional" json:"expiryTime" yaml:"expiryTime"`
// `AWS::IoTFleetWise::Campaign.PostTriggerCollectionDuration`.
PostTriggerCollectionDuration *float64 `field:"optional" json:"postTriggerCollectionDuration" yaml:"postTriggerCollectionDuration"`
// `AWS::IoTFleetWise::Campaign.Priority`.
Priority *float64 `field:"optional" json:"priority" yaml:"priority"`
// `AWS::IoTFleetWise::Campaign.SignalsToCollect`.
SignalsToCollect interface{} `field:"optional" json:"signalsToCollect" yaml:"signalsToCollect"`
// `AWS::IoTFleetWise::Campaign.SpoolingMode`.
SpoolingMode *string `field:"optional" json:"spoolingMode" yaml:"spoolingMode"`
// `AWS::IoTFleetWise::Campaign.StartTime`.
StartTime *string `field:"optional" json:"startTime" yaml:"startTime"`
// `AWS::IoTFleetWise::Campaign.Tags`.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnCampaign`.
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"
cfnCampaignProps := &cfnCampaignProps{
action: jsii.String("action"),
collectionScheme: &collectionSchemeProperty{
conditionBasedCollectionScheme: &conditionBasedCollectionSchemeProperty{
expression: jsii.String("expression"),
// the properties below are optional
conditionLanguageVersion: jsii.Number(123),
minimumTriggerIntervalMs: jsii.Number(123),
triggerMode: jsii.String("triggerMode"),
},
timeBasedCollectionScheme: &timeBasedCollectionSchemeProperty{
periodMs: jsii.Number(123),
},
},
name: jsii.String("name"),
signalCatalogArn: jsii.String("signalCatalogArn"),
targetArn: jsii.String("targetArn"),
// the properties below are optional
compression: jsii.String("compression"),
dataExtraDimensions: []*string{
jsii.String("dataExtraDimensions"),
},
description: jsii.String("description"),
diagnosticsMode: jsii.String("diagnosticsMode"),
expiryTime: jsii.String("expiryTime"),
postTriggerCollectionDuration: jsii.Number(123),
priority: jsii.Number(123),
signalsToCollect: []interface{}{
&signalInformationProperty{
name: jsii.String("name"),
// the properties below are optional
maxSampleCount: jsii.Number(123),
minimumSamplingIntervalMs: jsii.Number(123),
},
},
spoolingMode: jsii.String("spoolingMode"),
startTime: jsii.String("startTime"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnCampaign_CollectionSchemeProperty ¶
type CfnCampaign_CollectionSchemeProperty struct {
// `CfnCampaign.CollectionSchemeProperty.ConditionBasedCollectionScheme`.
ConditionBasedCollectionScheme interface{} `field:"optional" json:"conditionBasedCollectionScheme" yaml:"conditionBasedCollectionScheme"`
// `CfnCampaign.CollectionSchemeProperty.TimeBasedCollectionScheme`.
TimeBasedCollectionScheme interface{} `field:"optional" json:"timeBasedCollectionScheme" yaml:"timeBasedCollectionScheme"`
}
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"
collectionSchemeProperty := &collectionSchemeProperty{
conditionBasedCollectionScheme: &conditionBasedCollectionSchemeProperty{
expression: jsii.String("expression"),
// the properties below are optional
conditionLanguageVersion: jsii.Number(123),
minimumTriggerIntervalMs: jsii.Number(123),
triggerMode: jsii.String("triggerMode"),
},
timeBasedCollectionScheme: &timeBasedCollectionSchemeProperty{
periodMs: jsii.Number(123),
},
}
type CfnCampaign_ConditionBasedCollectionSchemeProperty ¶
type CfnCampaign_ConditionBasedCollectionSchemeProperty struct {
// `CfnCampaign.ConditionBasedCollectionSchemeProperty.Expression`.
Expression *string `field:"required" json:"expression" yaml:"expression"`
// `CfnCampaign.ConditionBasedCollectionSchemeProperty.ConditionLanguageVersion`.
ConditionLanguageVersion *float64 `field:"optional" json:"conditionLanguageVersion" yaml:"conditionLanguageVersion"`
// `CfnCampaign.ConditionBasedCollectionSchemeProperty.MinimumTriggerIntervalMs`.
MinimumTriggerIntervalMs *float64 `field:"optional" json:"minimumTriggerIntervalMs" yaml:"minimumTriggerIntervalMs"`
// `CfnCampaign.ConditionBasedCollectionSchemeProperty.TriggerMode`.
TriggerMode *string `field:"optional" json:"triggerMode" yaml:"triggerMode"`
}
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"
conditionBasedCollectionSchemeProperty := &conditionBasedCollectionSchemeProperty{
expression: jsii.String("expression"),
// the properties below are optional
conditionLanguageVersion: jsii.Number(123),
minimumTriggerIntervalMs: jsii.Number(123),
triggerMode: jsii.String("triggerMode"),
}
type CfnCampaign_SignalInformationProperty ¶
type CfnCampaign_SignalInformationProperty struct {
// `CfnCampaign.SignalInformationProperty.Name`.
Name *string `field:"required" json:"name" yaml:"name"`
// `CfnCampaign.SignalInformationProperty.MaxSampleCount`.
MaxSampleCount *float64 `field:"optional" json:"maxSampleCount" yaml:"maxSampleCount"`
// `CfnCampaign.SignalInformationProperty.MinimumSamplingIntervalMs`.
MinimumSamplingIntervalMs *float64 `field:"optional" json:"minimumSamplingIntervalMs" yaml:"minimumSamplingIntervalMs"`
}
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"
signalInformationProperty := &signalInformationProperty{
name: jsii.String("name"),
// the properties below are optional
maxSampleCount: jsii.Number(123),
minimumSamplingIntervalMs: jsii.Number(123),
}
type CfnCampaign_TimeBasedCollectionSchemeProperty ¶
type CfnCampaign_TimeBasedCollectionSchemeProperty struct {
// `CfnCampaign.TimeBasedCollectionSchemeProperty.PeriodMs`.
PeriodMs *float64 `field:"required" json:"periodMs" yaml:"periodMs"`
}
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"
timeBasedCollectionSchemeProperty := &timeBasedCollectionSchemeProperty{
periodMs: jsii.Number(123),
}
type CfnDecoderManifest ¶
type CfnDecoderManifest interface {
awscdk.CfnResource
awscdk.IInspectable
AttrArn() *string
AttrCreationTime() *string
AttrLastModificationTime() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
CreationStack() *[]*string
// `AWS::IoTFleetWise::DecoderManifest.Description`.
Description() *string
SetDescription(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// `AWS::IoTFleetWise::DecoderManifest.ModelManifestArn`.
ModelManifestArn() *string
SetModelManifestArn(val *string)
// `AWS::IoTFleetWise::DecoderManifest.Name`.
Name() *string
SetName(val *string)
// `AWS::IoTFleetWise::DecoderManifest.NetworkInterfaces`.
NetworkInterfaces() interface{}
SetNetworkInterfaces(val interface{})
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// `AWS::IoTFleetWise::DecoderManifest.SignalDecoders`.
SignalDecoders() interface{}
SetSignalDecoders(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// `AWS::IoTFleetWise::DecoderManifest.Status`.
Status() *string
SetStatus(val *string)
// `AWS::IoTFleetWise::DecoderManifest.Tags`.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::IoTFleetWise::DecoderManifest`.
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 networkInterfaces interface{}
var signalDecoders interface{}
cfnDecoderManifest := awscdk.Aws_iotfleetwise.NewCfnDecoderManifest(this, jsii.String("MyCfnDecoderManifest"), &cfnDecoderManifestProps{
modelManifestArn: jsii.String("modelManifestArn"),
name: jsii.String("name"),
// the properties below are optional
description: jsii.String("description"),
networkInterfaces: []interface{}{
networkInterfaces,
},
signalDecoders: []interface{}{
signalDecoders,
},
status: jsii.String("status"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnDecoderManifest ¶
func NewCfnDecoderManifest(scope awscdk.Construct, id *string, props *CfnDecoderManifestProps) CfnDecoderManifest
Create a new `AWS::IoTFleetWise::DecoderManifest`.
type CfnDecoderManifestProps ¶
type CfnDecoderManifestProps struct {
// `AWS::IoTFleetWise::DecoderManifest.ModelManifestArn`.
ModelManifestArn *string `field:"required" json:"modelManifestArn" yaml:"modelManifestArn"`
// `AWS::IoTFleetWise::DecoderManifest.Name`.
Name *string `field:"required" json:"name" yaml:"name"`
// `AWS::IoTFleetWise::DecoderManifest.Description`.
Description *string `field:"optional" json:"description" yaml:"description"`
// `AWS::IoTFleetWise::DecoderManifest.NetworkInterfaces`.
NetworkInterfaces interface{} `field:"optional" json:"networkInterfaces" yaml:"networkInterfaces"`
// `AWS::IoTFleetWise::DecoderManifest.SignalDecoders`.
SignalDecoders interface{} `field:"optional" json:"signalDecoders" yaml:"signalDecoders"`
// `AWS::IoTFleetWise::DecoderManifest.Status`.
Status *string `field:"optional" json:"status" yaml:"status"`
// `AWS::IoTFleetWise::DecoderManifest.Tags`.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnDecoderManifest`.
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 networkInterfaces interface{}
var signalDecoders interface{}
cfnDecoderManifestProps := &cfnDecoderManifestProps{
modelManifestArn: jsii.String("modelManifestArn"),
name: jsii.String("name"),
// the properties below are optional
description: jsii.String("description"),
networkInterfaces: []interface{}{
networkInterfaces,
},
signalDecoders: []interface{}{
signalDecoders,
},
status: jsii.String("status"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnDecoderManifest_CanInterfaceProperty ¶
type CfnDecoderManifest_CanInterfaceProperty struct {
// `CfnDecoderManifest.CanInterfaceProperty.Name`.
Name *string `field:"required" json:"name" yaml:"name"`
// `CfnDecoderManifest.CanInterfaceProperty.ProtocolName`.
ProtocolName *string `field:"optional" json:"protocolName" yaml:"protocolName"`
// `CfnDecoderManifest.CanInterfaceProperty.ProtocolVersion`.
ProtocolVersion *string `field:"optional" json:"protocolVersion" yaml:"protocolVersion"`
}
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"
canInterfaceProperty := &canInterfaceProperty{
name: jsii.String("name"),
// the properties below are optional
protocolName: jsii.String("protocolName"),
protocolVersion: jsii.String("protocolVersion"),
}
type CfnDecoderManifest_CanNetworkInterfaceProperty ¶
type CfnDecoderManifest_CanNetworkInterfaceProperty struct {
// `CfnDecoderManifest.CanNetworkInterfaceProperty.CanInterface`.
CanInterface interface{} `field:"required" json:"canInterface" yaml:"canInterface"`
// `CfnDecoderManifest.CanNetworkInterfaceProperty.InterfaceId`.
InterfaceId *string `field:"required" json:"interfaceId" yaml:"interfaceId"`
// `CfnDecoderManifest.CanNetworkInterfaceProperty.Type`.
Type *string `field:"required" json:"type" yaml:"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"
canNetworkInterfaceProperty := &canNetworkInterfaceProperty{
canInterface: &canInterfaceProperty{
name: jsii.String("name"),
// the properties below are optional
protocolName: jsii.String("protocolName"),
protocolVersion: jsii.String("protocolVersion"),
},
interfaceId: jsii.String("interfaceId"),
type: jsii.String("type"),
}
type CfnDecoderManifest_CanSignalDecoderProperty ¶
type CfnDecoderManifest_CanSignalDecoderProperty struct {
// `CfnDecoderManifest.CanSignalDecoderProperty.CanSignal`.
CanSignal interface{} `field:"required" json:"canSignal" yaml:"canSignal"`
// `CfnDecoderManifest.CanSignalDecoderProperty.FullyQualifiedName`.
FullyQualifiedName *string `field:"required" json:"fullyQualifiedName" yaml:"fullyQualifiedName"`
// `CfnDecoderManifest.CanSignalDecoderProperty.InterfaceId`.
InterfaceId *string `field:"required" json:"interfaceId" yaml:"interfaceId"`
// `CfnDecoderManifest.CanSignalDecoderProperty.Type`.
Type *string `field:"required" json:"type" yaml:"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 factor interface{}
var isBigEndian interface{}
var isSigned interface{}
var length interface{}
var messageId interface{}
var offset interface{}
var startBit interface{}
canSignalDecoderProperty := &canSignalDecoderProperty{
canSignal: &canSignalProperty{
factor: factor,
isBigEndian: isBigEndian,
isSigned: isSigned,
length: length,
messageId: messageId,
offset: offset,
startBit: startBit,
// the properties below are optional
name: jsii.String("name"),
},
fullyQualifiedName: jsii.String("fullyQualifiedName"),
interfaceId: jsii.String("interfaceId"),
type: jsii.String("type"),
}
type CfnDecoderManifest_CanSignalProperty ¶
type CfnDecoderManifest_CanSignalProperty struct {
// `CfnDecoderManifest.CanSignalProperty.Factor`.
Factor interface{} `field:"required" json:"factor" yaml:"factor"`
// `CfnDecoderManifest.CanSignalProperty.IsBigEndian`.
IsBigEndian interface{} `field:"required" json:"isBigEndian" yaml:"isBigEndian"`
// `CfnDecoderManifest.CanSignalProperty.IsSigned`.
IsSigned interface{} `field:"required" json:"isSigned" yaml:"isSigned"`
// `CfnDecoderManifest.CanSignalProperty.Length`.
Length interface{} `field:"required" json:"length" yaml:"length"`
// `CfnDecoderManifest.CanSignalProperty.MessageId`.
MessageId interface{} `field:"required" json:"messageId" yaml:"messageId"`
// `CfnDecoderManifest.CanSignalProperty.Offset`.
Offset interface{} `field:"required" json:"offset" yaml:"offset"`
// `CfnDecoderManifest.CanSignalProperty.StartBit`.
StartBit interface{} `field:"required" json:"startBit" yaml:"startBit"`
// `CfnDecoderManifest.CanSignalProperty.Name`.
Name *string `field:"optional" json:"name" yaml:"name"`
}
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 factor interface{}
var isBigEndian interface{}
var isSigned interface{}
var length interface{}
var messageId interface{}
var offset interface{}
var startBit interface{}
canSignalProperty := &canSignalProperty{
factor: factor,
isBigEndian: isBigEndian,
isSigned: isSigned,
length: length,
messageId: messageId,
offset: offset,
startBit: startBit,
// the properties below are optional
name: jsii.String("name"),
}
type CfnDecoderManifest_ObdInterfaceProperty ¶
type CfnDecoderManifest_ObdInterfaceProperty struct {
// `CfnDecoderManifest.ObdInterfaceProperty.Name`.
Name *string `field:"required" json:"name" yaml:"name"`
// `CfnDecoderManifest.ObdInterfaceProperty.RequestMessageId`.
RequestMessageId interface{} `field:"required" json:"requestMessageId" yaml:"requestMessageId"`
// `CfnDecoderManifest.ObdInterfaceProperty.DtcRequestIntervalSeconds`.
DtcRequestIntervalSeconds interface{} `field:"optional" json:"dtcRequestIntervalSeconds" yaml:"dtcRequestIntervalSeconds"`
// `CfnDecoderManifest.ObdInterfaceProperty.HasTransmissionEcu`.
HasTransmissionEcu interface{} `field:"optional" json:"hasTransmissionEcu" yaml:"hasTransmissionEcu"`
// `CfnDecoderManifest.ObdInterfaceProperty.ObdStandard`.
ObdStandard *string `field:"optional" json:"obdStandard" yaml:"obdStandard"`
// `CfnDecoderManifest.ObdInterfaceProperty.PidRequestIntervalSeconds`.
PidRequestIntervalSeconds interface{} `field:"optional" json:"pidRequestIntervalSeconds" yaml:"pidRequestIntervalSeconds"`
// `CfnDecoderManifest.ObdInterfaceProperty.UseExtendedIds`.
UseExtendedIds interface{} `field:"optional" json:"useExtendedIds" yaml:"useExtendedIds"`
}
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 dtcRequestIntervalSeconds interface{}
var hasTransmissionEcu interface{}
var pidRequestIntervalSeconds interface{}
var requestMessageId interface{}
var useExtendedIds interface{}
obdInterfaceProperty := &obdInterfaceProperty{
name: jsii.String("name"),
requestMessageId: requestMessageId,
// the properties below are optional
dtcRequestIntervalSeconds: dtcRequestIntervalSeconds,
hasTransmissionEcu: hasTransmissionEcu,
obdStandard: jsii.String("obdStandard"),
pidRequestIntervalSeconds: pidRequestIntervalSeconds,
useExtendedIds: useExtendedIds,
}
type CfnDecoderManifest_ObdNetworkInterfaceProperty ¶
type CfnDecoderManifest_ObdNetworkInterfaceProperty struct {
// `CfnDecoderManifest.ObdNetworkInterfaceProperty.InterfaceId`.
InterfaceId *string `field:"required" json:"interfaceId" yaml:"interfaceId"`
// `CfnDecoderManifest.ObdNetworkInterfaceProperty.ObdInterface`.
ObdInterface interface{} `field:"required" json:"obdInterface" yaml:"obdInterface"`
// `CfnDecoderManifest.ObdNetworkInterfaceProperty.Type`.
Type *string `field:"required" json:"type" yaml:"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 dtcRequestIntervalSeconds interface{}
var hasTransmissionEcu interface{}
var pidRequestIntervalSeconds interface{}
var requestMessageId interface{}
var useExtendedIds interface{}
obdNetworkInterfaceProperty := &obdNetworkInterfaceProperty{
interfaceId: jsii.String("interfaceId"),
obdInterface: &obdInterfaceProperty{
name: jsii.String("name"),
requestMessageId: requestMessageId,
// the properties below are optional
dtcRequestIntervalSeconds: dtcRequestIntervalSeconds,
hasTransmissionEcu: hasTransmissionEcu,
obdStandard: jsii.String("obdStandard"),
pidRequestIntervalSeconds: pidRequestIntervalSeconds,
useExtendedIds: useExtendedIds,
},
type: jsii.String("type"),
}
type CfnDecoderManifest_ObdSignalDecoderProperty ¶
type CfnDecoderManifest_ObdSignalDecoderProperty struct {
// `CfnDecoderManifest.ObdSignalDecoderProperty.FullyQualifiedName`.
FullyQualifiedName *string `field:"required" json:"fullyQualifiedName" yaml:"fullyQualifiedName"`
// `CfnDecoderManifest.ObdSignalDecoderProperty.InterfaceId`.
InterfaceId *string `field:"required" json:"interfaceId" yaml:"interfaceId"`
// `CfnDecoderManifest.ObdSignalDecoderProperty.ObdSignal`.
ObdSignal interface{} `field:"required" json:"obdSignal" yaml:"obdSignal"`
// `CfnDecoderManifest.ObdSignalDecoderProperty.Type`.
Type *string `field:"required" json:"type" yaml:"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 bitMaskLength interface{}
var bitRightShift interface{}
var byteLength interface{}
var offset interface{}
var pid interface{}
var pidResponseLength interface{}
var scaling interface{}
var serviceMode interface{}
var startByte interface{}
obdSignalDecoderProperty := &obdSignalDecoderProperty{
fullyQualifiedName: jsii.String("fullyQualifiedName"),
interfaceId: jsii.String("interfaceId"),
obdSignal: &obdSignalProperty{
byteLength: byteLength,
offset: offset,
pid: pid,
pidResponseLength: pidResponseLength,
scaling: scaling,
serviceMode: serviceMode,
startByte: startByte,
// the properties below are optional
bitMaskLength: bitMaskLength,
bitRightShift: bitRightShift,
},
type: jsii.String("type"),
}
type CfnDecoderManifest_ObdSignalProperty ¶
type CfnDecoderManifest_ObdSignalProperty struct {
// `CfnDecoderManifest.ObdSignalProperty.ByteLength`.
ByteLength interface{} `field:"required" json:"byteLength" yaml:"byteLength"`
// `CfnDecoderManifest.ObdSignalProperty.Offset`.
Offset interface{} `field:"required" json:"offset" yaml:"offset"`
// `CfnDecoderManifest.ObdSignalProperty.Pid`.
Pid interface{} `field:"required" json:"pid" yaml:"pid"`
// `CfnDecoderManifest.ObdSignalProperty.PidResponseLength`.
PidResponseLength interface{} `field:"required" json:"pidResponseLength" yaml:"pidResponseLength"`
// `CfnDecoderManifest.ObdSignalProperty.Scaling`.
Scaling interface{} `field:"required" json:"scaling" yaml:"scaling"`
// `CfnDecoderManifest.ObdSignalProperty.ServiceMode`.
ServiceMode interface{} `field:"required" json:"serviceMode" yaml:"serviceMode"`
// `CfnDecoderManifest.ObdSignalProperty.StartByte`.
StartByte interface{} `field:"required" json:"startByte" yaml:"startByte"`
// `CfnDecoderManifest.ObdSignalProperty.BitMaskLength`.
BitMaskLength interface{} `field:"optional" json:"bitMaskLength" yaml:"bitMaskLength"`
// `CfnDecoderManifest.ObdSignalProperty.BitRightShift`.
BitRightShift interface{} `field:"optional" json:"bitRightShift" yaml:"bitRightShift"`
}
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 bitMaskLength interface{}
var bitRightShift interface{}
var byteLength interface{}
var offset interface{}
var pid interface{}
var pidResponseLength interface{}
var scaling interface{}
var serviceMode interface{}
var startByte interface{}
obdSignalProperty := &obdSignalProperty{
byteLength: byteLength,
offset: offset,
pid: pid,
pidResponseLength: pidResponseLength,
scaling: scaling,
serviceMode: serviceMode,
startByte: startByte,
// the properties below are optional
bitMaskLength: bitMaskLength,
bitRightShift: bitRightShift,
}
type CfnFleet ¶
type CfnFleet interface {
awscdk.CfnResource
awscdk.IInspectable
AttrArn() *string
AttrCreationTime() *string
AttrLastModificationTime() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
CreationStack() *[]*string
// `AWS::IoTFleetWise::Fleet.Description`.
Description() *string
SetDescription(val *string)
// `AWS::IoTFleetWise::Fleet.Id`.
Id() *string
SetId(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.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// `AWS::IoTFleetWise::Fleet.SignalCatalogArn`.
SignalCatalogArn() *string
SetSignalCatalogArn(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// `AWS::IoTFleetWise::Fleet.Tags`.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::IoTFleetWise::Fleet`.
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"
cfnFleet := awscdk.Aws_iotfleetwise.NewCfnFleet(this, jsii.String("MyCfnFleet"), &cfnFleetProps{
id: jsii.String("id"),
signalCatalogArn: jsii.String("signalCatalogArn"),
// the properties below are optional
description: jsii.String("description"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnFleet ¶
func NewCfnFleet(scope awscdk.Construct, id *string, props *CfnFleetProps) CfnFleet
Create a new `AWS::IoTFleetWise::Fleet`.
type CfnFleetProps ¶
type CfnFleetProps struct {
// `AWS::IoTFleetWise::Fleet.Id`.
Id *string `field:"required" json:"id" yaml:"id"`
// `AWS::IoTFleetWise::Fleet.SignalCatalogArn`.
SignalCatalogArn *string `field:"required" json:"signalCatalogArn" yaml:"signalCatalogArn"`
// `AWS::IoTFleetWise::Fleet.Description`.
Description *string `field:"optional" json:"description" yaml:"description"`
// `AWS::IoTFleetWise::Fleet.Tags`.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnFleet`.
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"
cfnFleetProps := &cfnFleetProps{
id: jsii.String("id"),
signalCatalogArn: jsii.String("signalCatalogArn"),
// the properties below are optional
description: jsii.String("description"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnModelManifest ¶
type CfnModelManifest interface {
awscdk.CfnResource
awscdk.IInspectable
AttrArn() *string
AttrCreationTime() *string
AttrLastModificationTime() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
CreationStack() *[]*string
// `AWS::IoTFleetWise::ModelManifest.Description`.
Description() *string
SetDescription(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// `AWS::IoTFleetWise::ModelManifest.Name`.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// `AWS::IoTFleetWise::ModelManifest.Nodes`.
Nodes() *[]*string
SetNodes(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 })`.
// Experimental.
Ref() *string
// `AWS::IoTFleetWise::ModelManifest.SignalCatalogArn`.
SignalCatalogArn() *string
SetSignalCatalogArn(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// `AWS::IoTFleetWise::ModelManifest.Status`.
Status() *string
SetStatus(val *string)
// `AWS::IoTFleetWise::ModelManifest.Tags`.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::IoTFleetWise::ModelManifest`.
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"
cfnModelManifest := awscdk.Aws_iotfleetwise.NewCfnModelManifest(this, jsii.String("MyCfnModelManifest"), &cfnModelManifestProps{
name: jsii.String("name"),
signalCatalogArn: jsii.String("signalCatalogArn"),
// the properties below are optional
description: jsii.String("description"),
nodes: []*string{
jsii.String("nodes"),
},
status: jsii.String("status"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnModelManifest ¶
func NewCfnModelManifest(scope awscdk.Construct, id *string, props *CfnModelManifestProps) CfnModelManifest
Create a new `AWS::IoTFleetWise::ModelManifest`.
type CfnModelManifestProps ¶
type CfnModelManifestProps struct {
// `AWS::IoTFleetWise::ModelManifest.Name`.
Name *string `field:"required" json:"name" yaml:"name"`
// `AWS::IoTFleetWise::ModelManifest.SignalCatalogArn`.
SignalCatalogArn *string `field:"required" json:"signalCatalogArn" yaml:"signalCatalogArn"`
// `AWS::IoTFleetWise::ModelManifest.Description`.
Description *string `field:"optional" json:"description" yaml:"description"`
// `AWS::IoTFleetWise::ModelManifest.Nodes`.
Nodes *[]*string `field:"optional" json:"nodes" yaml:"nodes"`
// `AWS::IoTFleetWise::ModelManifest.Status`.
Status *string `field:"optional" json:"status" yaml:"status"`
// `AWS::IoTFleetWise::ModelManifest.Tags`.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnModelManifest`.
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"
cfnModelManifestProps := &cfnModelManifestProps{
name: jsii.String("name"),
signalCatalogArn: jsii.String("signalCatalogArn"),
// the properties below are optional
description: jsii.String("description"),
nodes: []*string{
jsii.String("nodes"),
},
status: jsii.String("status"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnSignalCatalog ¶
type CfnSignalCatalog interface {
awscdk.CfnResource
awscdk.IInspectable
AttrArn() *string
AttrCreationTime() *string
AttrLastModificationTime() *string
AttrNodeCountsTotalActuators() awscdk.IResolvable
AttrNodeCountsTotalAttributes() awscdk.IResolvable
AttrNodeCountsTotalBranches() awscdk.IResolvable
AttrNodeCountsTotalNodes() awscdk.IResolvable
AttrNodeCountsTotalSensors() awscdk.IResolvable
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
CreationStack() *[]*string
// `AWS::IoTFleetWise::SignalCatalog.Description`.
Description() *string
SetDescription(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// `AWS::IoTFleetWise::SignalCatalog.Name`.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// `AWS::IoTFleetWise::SignalCatalog.Nodes`.
Nodes() interface{}
SetNodes(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 })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// `AWS::IoTFleetWise::SignalCatalog.Tags`.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::IoTFleetWise::SignalCatalog`.
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"
cfnSignalCatalog := awscdk.Aws_iotfleetwise.NewCfnSignalCatalog(this, jsii.String("MyCfnSignalCatalog"), &cfnSignalCatalogProps{
description: jsii.String("description"),
name: jsii.String("name"),
nodes: []interface{}{
&nodeProperty{
actuator: &actuatorProperty{
dataType: jsii.String("dataType"),
fullyQualifiedName: jsii.String("fullyQualifiedName"),
// the properties below are optional
allowedValues: []*string{
jsii.String("allowedValues"),
},
assignedValue: jsii.String("assignedValue"),
description: jsii.String("description"),
max: jsii.Number(123),
min: jsii.Number(123),
unit: jsii.String("unit"),
},
attribute: &attributeProperty{
dataType: jsii.String("dataType"),
fullyQualifiedName: jsii.String("fullyQualifiedName"),
// the properties below are optional
allowedValues: []*string{
jsii.String("allowedValues"),
},
assignedValue: jsii.String("assignedValue"),
defaultValue: jsii.String("defaultValue"),
description: jsii.String("description"),
max: jsii.Number(123),
min: jsii.Number(123),
unit: jsii.String("unit"),
},
branch: &branchProperty{
fullyQualifiedName: jsii.String("fullyQualifiedName"),
// the properties below are optional
description: jsii.String("description"),
},
sensor: &sensorProperty{
dataType: jsii.String("dataType"),
fullyQualifiedName: jsii.String("fullyQualifiedName"),
// the properties below are optional
allowedValues: []*string{
jsii.String("allowedValues"),
},
description: jsii.String("description"),
max: jsii.Number(123),
min: jsii.Number(123),
unit: jsii.String("unit"),
},
},
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnSignalCatalog ¶
func NewCfnSignalCatalog(scope awscdk.Construct, id *string, props *CfnSignalCatalogProps) CfnSignalCatalog
Create a new `AWS::IoTFleetWise::SignalCatalog`.
type CfnSignalCatalogProps ¶
type CfnSignalCatalogProps struct {
// `AWS::IoTFleetWise::SignalCatalog.Description`.
Description *string `field:"optional" json:"description" yaml:"description"`
// `AWS::IoTFleetWise::SignalCatalog.Name`.
Name *string `field:"optional" json:"name" yaml:"name"`
// `AWS::IoTFleetWise::SignalCatalog.Nodes`.
Nodes interface{} `field:"optional" json:"nodes" yaml:"nodes"`
// `AWS::IoTFleetWise::SignalCatalog.Tags`.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnSignalCatalog`.
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"
cfnSignalCatalogProps := &cfnSignalCatalogProps{
description: jsii.String("description"),
name: jsii.String("name"),
nodes: []interface{}{
&nodeProperty{
actuator: &actuatorProperty{
dataType: jsii.String("dataType"),
fullyQualifiedName: jsii.String("fullyQualifiedName"),
// the properties below are optional
allowedValues: []*string{
jsii.String("allowedValues"),
},
assignedValue: jsii.String("assignedValue"),
description: jsii.String("description"),
max: jsii.Number(123),
min: jsii.Number(123),
unit: jsii.String("unit"),
},
attribute: &attributeProperty{
dataType: jsii.String("dataType"),
fullyQualifiedName: jsii.String("fullyQualifiedName"),
// the properties below are optional
allowedValues: []*string{
jsii.String("allowedValues"),
},
assignedValue: jsii.String("assignedValue"),
defaultValue: jsii.String("defaultValue"),
description: jsii.String("description"),
max: jsii.Number(123),
min: jsii.Number(123),
unit: jsii.String("unit"),
},
branch: &branchProperty{
fullyQualifiedName: jsii.String("fullyQualifiedName"),
// the properties below are optional
description: jsii.String("description"),
},
sensor: &sensorProperty{
dataType: jsii.String("dataType"),
fullyQualifiedName: jsii.String("fullyQualifiedName"),
// the properties below are optional
allowedValues: []*string{
jsii.String("allowedValues"),
},
description: jsii.String("description"),
max: jsii.Number(123),
min: jsii.Number(123),
unit: jsii.String("unit"),
},
},
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnSignalCatalog_ActuatorProperty ¶
type CfnSignalCatalog_ActuatorProperty struct {
// `CfnSignalCatalog.ActuatorProperty.DataType`.
DataType *string `field:"required" json:"dataType" yaml:"dataType"`
// `CfnSignalCatalog.ActuatorProperty.FullyQualifiedName`.
FullyQualifiedName *string `field:"required" json:"fullyQualifiedName" yaml:"fullyQualifiedName"`
// `CfnSignalCatalog.ActuatorProperty.AllowedValues`.
AllowedValues *[]*string `field:"optional" json:"allowedValues" yaml:"allowedValues"`
// `CfnSignalCatalog.ActuatorProperty.AssignedValue`.
AssignedValue *string `field:"optional" json:"assignedValue" yaml:"assignedValue"`
// `CfnSignalCatalog.ActuatorProperty.Description`.
Description *string `field:"optional" json:"description" yaml:"description"`
// `CfnSignalCatalog.ActuatorProperty.Max`.
Max *float64 `field:"optional" json:"max" yaml:"max"`
// `CfnSignalCatalog.ActuatorProperty.Min`.
Min *float64 `field:"optional" json:"min" yaml:"min"`
// `CfnSignalCatalog.ActuatorProperty.Unit`.
Unit *string `field:"optional" json:"unit" yaml:"unit"`
}
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"
actuatorProperty := &actuatorProperty{
dataType: jsii.String("dataType"),
fullyQualifiedName: jsii.String("fullyQualifiedName"),
// the properties below are optional
allowedValues: []*string{
jsii.String("allowedValues"),
},
assignedValue: jsii.String("assignedValue"),
description: jsii.String("description"),
max: jsii.Number(123),
min: jsii.Number(123),
unit: jsii.String("unit"),
}
type CfnSignalCatalog_AttributeProperty ¶
type CfnSignalCatalog_AttributeProperty struct {
// `CfnSignalCatalog.AttributeProperty.DataType`.
DataType *string `field:"required" json:"dataType" yaml:"dataType"`
// `CfnSignalCatalog.AttributeProperty.FullyQualifiedName`.
FullyQualifiedName *string `field:"required" json:"fullyQualifiedName" yaml:"fullyQualifiedName"`
// `CfnSignalCatalog.AttributeProperty.AllowedValues`.
AllowedValues *[]*string `field:"optional" json:"allowedValues" yaml:"allowedValues"`
// `CfnSignalCatalog.AttributeProperty.AssignedValue`.
AssignedValue *string `field:"optional" json:"assignedValue" yaml:"assignedValue"`
// `CfnSignalCatalog.AttributeProperty.DefaultValue`.
DefaultValue *string `field:"optional" json:"defaultValue" yaml:"defaultValue"`
// `CfnSignalCatalog.AttributeProperty.Description`.
Description *string `field:"optional" json:"description" yaml:"description"`
// `CfnSignalCatalog.AttributeProperty.Max`.
Max *float64 `field:"optional" json:"max" yaml:"max"`
// `CfnSignalCatalog.AttributeProperty.Min`.
Min *float64 `field:"optional" json:"min" yaml:"min"`
// `CfnSignalCatalog.AttributeProperty.Unit`.
Unit *string `field:"optional" json:"unit" yaml:"unit"`
}
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"
attributeProperty := &attributeProperty{
dataType: jsii.String("dataType"),
fullyQualifiedName: jsii.String("fullyQualifiedName"),
// the properties below are optional
allowedValues: []*string{
jsii.String("allowedValues"),
},
assignedValue: jsii.String("assignedValue"),
defaultValue: jsii.String("defaultValue"),
description: jsii.String("description"),
max: jsii.Number(123),
min: jsii.Number(123),
unit: jsii.String("unit"),
}
type CfnSignalCatalog_BranchProperty ¶
type CfnSignalCatalog_BranchProperty struct {
// `CfnSignalCatalog.BranchProperty.FullyQualifiedName`.
FullyQualifiedName *string `field:"required" json:"fullyQualifiedName" yaml:"fullyQualifiedName"`
// `CfnSignalCatalog.BranchProperty.Description`.
Description *string `field:"optional" json:"description" yaml:"description"`
}
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"
branchProperty := &branchProperty{
fullyQualifiedName: jsii.String("fullyQualifiedName"),
// the properties below are optional
description: jsii.String("description"),
}
type CfnSignalCatalog_NodeCountsProperty ¶
type CfnSignalCatalog_NodeCountsProperty struct {
// `CfnSignalCatalog.NodeCountsProperty.TotalActuators`.
TotalActuators *float64 `field:"optional" json:"totalActuators" yaml:"totalActuators"`
// `CfnSignalCatalog.NodeCountsProperty.TotalAttributes`.
TotalAttributes *float64 `field:"optional" json:"totalAttributes" yaml:"totalAttributes"`
// `CfnSignalCatalog.NodeCountsProperty.TotalBranches`.
TotalBranches *float64 `field:"optional" json:"totalBranches" yaml:"totalBranches"`
// `CfnSignalCatalog.NodeCountsProperty.TotalNodes`.
TotalNodes *float64 `field:"optional" json:"totalNodes" yaml:"totalNodes"`
// `CfnSignalCatalog.NodeCountsProperty.TotalSensors`.
TotalSensors *float64 `field:"optional" json:"totalSensors" yaml:"totalSensors"`
}
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"
nodeCountsProperty := &nodeCountsProperty{
totalActuators: jsii.Number(123),
totalAttributes: jsii.Number(123),
totalBranches: jsii.Number(123),
totalNodes: jsii.Number(123),
totalSensors: jsii.Number(123),
}
type CfnSignalCatalog_NodeProperty ¶
type CfnSignalCatalog_NodeProperty struct {
// `CfnSignalCatalog.NodeProperty.Actuator`.
Actuator interface{} `field:"optional" json:"actuator" yaml:"actuator"`
// `CfnSignalCatalog.NodeProperty.Attribute`.
Attribute interface{} `field:"optional" json:"attribute" yaml:"attribute"`
// `CfnSignalCatalog.NodeProperty.Branch`.
Branch interface{} `field:"optional" json:"branch" yaml:"branch"`
// `CfnSignalCatalog.NodeProperty.Sensor`.
Sensor interface{} `field:"optional" json:"sensor" yaml:"sensor"`
}
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"
nodeProperty := &nodeProperty{
actuator: &actuatorProperty{
dataType: jsii.String("dataType"),
fullyQualifiedName: jsii.String("fullyQualifiedName"),
// the properties below are optional
allowedValues: []*string{
jsii.String("allowedValues"),
},
assignedValue: jsii.String("assignedValue"),
description: jsii.String("description"),
max: jsii.Number(123),
min: jsii.Number(123),
unit: jsii.String("unit"),
},
attribute: &attributeProperty{
dataType: jsii.String("dataType"),
fullyQualifiedName: jsii.String("fullyQualifiedName"),
// the properties below are optional
allowedValues: []*string{
jsii.String("allowedValues"),
},
assignedValue: jsii.String("assignedValue"),
defaultValue: jsii.String("defaultValue"),
description: jsii.String("description"),
max: jsii.Number(123),
min: jsii.Number(123),
unit: jsii.String("unit"),
},
branch: &branchProperty{
fullyQualifiedName: jsii.String("fullyQualifiedName"),
// the properties below are optional
description: jsii.String("description"),
},
sensor: &sensorProperty{
dataType: jsii.String("dataType"),
fullyQualifiedName: jsii.String("fullyQualifiedName"),
// the properties below are optional
allowedValues: []*string{
jsii.String("allowedValues"),
},
description: jsii.String("description"),
max: jsii.Number(123),
min: jsii.Number(123),
unit: jsii.String("unit"),
},
}
type CfnSignalCatalog_SensorProperty ¶
type CfnSignalCatalog_SensorProperty struct {
// `CfnSignalCatalog.SensorProperty.DataType`.
DataType *string `field:"required" json:"dataType" yaml:"dataType"`
// `CfnSignalCatalog.SensorProperty.FullyQualifiedName`.
FullyQualifiedName *string `field:"required" json:"fullyQualifiedName" yaml:"fullyQualifiedName"`
// `CfnSignalCatalog.SensorProperty.AllowedValues`.
AllowedValues *[]*string `field:"optional" json:"allowedValues" yaml:"allowedValues"`
// `CfnSignalCatalog.SensorProperty.Description`.
Description *string `field:"optional" json:"description" yaml:"description"`
// `CfnSignalCatalog.SensorProperty.Max`.
Max *float64 `field:"optional" json:"max" yaml:"max"`
// `CfnSignalCatalog.SensorProperty.Min`.
Min *float64 `field:"optional" json:"min" yaml:"min"`
// `CfnSignalCatalog.SensorProperty.Unit`.
Unit *string `field:"optional" json:"unit" yaml:"unit"`
}
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"
sensorProperty := &sensorProperty{
dataType: jsii.String("dataType"),
fullyQualifiedName: jsii.String("fullyQualifiedName"),
// the properties below are optional
allowedValues: []*string{
jsii.String("allowedValues"),
},
description: jsii.String("description"),
max: jsii.Number(123),
min: jsii.Number(123),
unit: jsii.String("unit"),
}
type CfnVehicle ¶
type CfnVehicle interface {
awscdk.CfnResource
awscdk.IInspectable
// `AWS::IoTFleetWise::Vehicle.AssociationBehavior`.
AssociationBehavior() *string
SetAssociationBehavior(val *string)
AttrArn() *string
AttrCreationTime() *string
// `AWS::IoTFleetWise::Vehicle.Attributes`.
Attributes() interface{}
SetAttributes(val interface{})
AttrLastModificationTime() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
CreationStack() *[]*string
// `AWS::IoTFleetWise::Vehicle.DecoderManifestArn`.
DecoderManifestArn() *string
SetDecoderManifestArn(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.
// Experimental.
LogicalId() *string
// `AWS::IoTFleetWise::Vehicle.ModelManifestArn`.
ModelManifestArn() *string
SetModelManifestArn(val *string)
// `AWS::IoTFleetWise::Vehicle.Name`.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// `AWS::IoTFleetWise::Vehicle.Tags`.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::IoTFleetWise::Vehicle`.
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"
cfnVehicle := awscdk.Aws_iotfleetwise.NewCfnVehicle(this, jsii.String("MyCfnVehicle"), &cfnVehicleProps{
decoderManifestArn: jsii.String("decoderManifestArn"),
modelManifestArn: jsii.String("modelManifestArn"),
name: jsii.String("name"),
// the properties below are optional
associationBehavior: jsii.String("associationBehavior"),
attributes: map[string]*string{
"attributesKey": jsii.String("attributes"),
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnVehicle ¶
func NewCfnVehicle(scope awscdk.Construct, id *string, props *CfnVehicleProps) CfnVehicle
Create a new `AWS::IoTFleetWise::Vehicle`.
type CfnVehicleProps ¶
type CfnVehicleProps struct {
// `AWS::IoTFleetWise::Vehicle.DecoderManifestArn`.
DecoderManifestArn *string `field:"required" json:"decoderManifestArn" yaml:"decoderManifestArn"`
// `AWS::IoTFleetWise::Vehicle.ModelManifestArn`.
ModelManifestArn *string `field:"required" json:"modelManifestArn" yaml:"modelManifestArn"`
// `AWS::IoTFleetWise::Vehicle.Name`.
Name *string `field:"required" json:"name" yaml:"name"`
// `AWS::IoTFleetWise::Vehicle.AssociationBehavior`.
AssociationBehavior *string `field:"optional" json:"associationBehavior" yaml:"associationBehavior"`
// `AWS::IoTFleetWise::Vehicle.Attributes`.
Attributes interface{} `field:"optional" json:"attributes" yaml:"attributes"`
// `AWS::IoTFleetWise::Vehicle.Tags`.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnVehicle`.
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"
cfnVehicleProps := &cfnVehicleProps{
decoderManifestArn: jsii.String("decoderManifestArn"),
modelManifestArn: jsii.String("modelManifestArn"),
name: jsii.String("name"),
// the properties below are optional
associationBehavior: jsii.String("associationBehavior"),
attributes: map[string]*string{
"attributesKey": jsii.String("attributes"),
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
Source Files
¶
- awsiotfleetwise.go
- awsiotfleetwise_CfnCampaign.go
- awsiotfleetwise_CfnCampaignProps.go
- awsiotfleetwise_CfnCampaign_CollectionSchemeProperty.go
- awsiotfleetwise_CfnCampaign_ConditionBasedCollectionSchemeProperty.go
- awsiotfleetwise_CfnCampaign_SignalInformationProperty.go
- awsiotfleetwise_CfnCampaign_TimeBasedCollectionSchemeProperty.go
- awsiotfleetwise_CfnCampaign__runtime_type_checks.go
- awsiotfleetwise_CfnDecoderManifest.go
- awsiotfleetwise_CfnDecoderManifestProps.go
- awsiotfleetwise_CfnDecoderManifest_CanInterfaceProperty.go
- awsiotfleetwise_CfnDecoderManifest_CanNetworkInterfaceProperty.go
- awsiotfleetwise_CfnDecoderManifest_CanSignalDecoderProperty.go
- awsiotfleetwise_CfnDecoderManifest_CanSignalProperty.go
- awsiotfleetwise_CfnDecoderManifest_ObdInterfaceProperty.go
- awsiotfleetwise_CfnDecoderManifest_ObdNetworkInterfaceProperty.go
- awsiotfleetwise_CfnDecoderManifest_ObdSignalDecoderProperty.go
- awsiotfleetwise_CfnDecoderManifest_ObdSignalProperty.go
- awsiotfleetwise_CfnDecoderManifest__runtime_type_checks.go
- awsiotfleetwise_CfnFleet.go
- awsiotfleetwise_CfnFleetProps.go
- awsiotfleetwise_CfnFleet__runtime_type_checks.go
- awsiotfleetwise_CfnModelManifest.go
- awsiotfleetwise_CfnModelManifestProps.go
- awsiotfleetwise_CfnModelManifest__runtime_type_checks.go
- awsiotfleetwise_CfnSignalCatalog.go
- awsiotfleetwise_CfnSignalCatalogProps.go
- awsiotfleetwise_CfnSignalCatalog_ActuatorProperty.go
- awsiotfleetwise_CfnSignalCatalog_AttributeProperty.go
- awsiotfleetwise_CfnSignalCatalog_BranchProperty.go
- awsiotfleetwise_CfnSignalCatalog_NodeCountsProperty.go
- awsiotfleetwise_CfnSignalCatalog_NodeProperty.go
- awsiotfleetwise_CfnSignalCatalog_SensorProperty.go
- awsiotfleetwise_CfnSignalCatalog__runtime_type_checks.go
- awsiotfleetwise_CfnVehicle.go
- awsiotfleetwise_CfnVehicleProps.go
- awsiotfleetwise_CfnVehicle__runtime_type_checks.go