Class: AWSCDK::IoTFleetWise::CfnCampaign
- Inherits:
-
CfnResource
- Object
- CfnResource
- AWSCDK::IoTFleetWise::CfnCampaign
- Includes:
- AWSCDK::IInspectable, AWSCDK::ITaggable, AWSCDK::Interfaces::AWSIotfleetwise::ICampaignRef
- Defined in:
- io_t_fleet_wise/cfn_campaign.rb
Overview
Creates an orchestration of data collection rules.
The AWS IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how to collect and transfer data to the cloud. You create campaigns in the cloud. After you or your team approve campaigns, AWS IoT FleetWise automatically deploys them to vehicles.
For more information, see Campaigns in the AWS IoT FleetWise Developer Guide .
Access to certain AWS IoT FleetWise features is currently gated. For more information, see AWS Region and feature availability in the AWS IoT FleetWise Developer Guide .
Class Method Summary collapse
- .arn_for_campaign(resource) ⇒ String
-
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
-
.from_campaign_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSIotfleetwise::ICampaignRef
Creates a new ICampaignRef from an ARN.
-
.from_campaign_name(scope, id, campaign_name) ⇒ AWSCDK::Interfaces::AWSIotfleetwise::ICampaignRef
Creates a new ICampaignRef from a campaignName.
-
.is_cfn_campaign(x) ⇒ Boolean
Checks whether the given object is a CfnCampaign.
- .jsii_overridable_methods ⇒ Object
Instance Method Summary collapse
-
#action ⇒ String?
Specifies how to update a campaign.
- #action=(value) ⇒ Object
-
#add_deletion_override(path) ⇒ void
Syntactic sugar for
addOverride(path, undefined). -
#add_dependency(target) ⇒ void
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
-
#add_depends_on(target) ⇒ void
deprecated
Deprecated.
use addDependency
-
#add_metadata(key, value) ⇒ void
Add a value to the CloudFormation Resource Metadata.
-
#add_override(path, value) ⇒ void
Adds an override to the synthesized CloudFormation resource.
-
#add_property_deletion_override(property_path) ⇒ void
Adds an override that deletes the value of a property from the resource definition.
-
#add_property_override(property_path, value) ⇒ void
Adds an override to a resource property.
-
#apply_cross_stack_reference_strength(strength) ⇒ void
Sets the cross-stack reference strength for this resource.
-
#apply_removal_policy(policy = nil, options = nil) ⇒ void
Sets the deletion policy of the resource based on the removal policy specified.
-
#attr_arn ⇒ String
The Amazon Resource Name (ARN) of the campaign.
-
#attr_creation_time ⇒ String
The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
-
#attr_last_modification_time ⇒ String
The last time the campaign was modified.
-
#attr_status ⇒ String
The state of the campaign.
-
#campaign_ref ⇒ AWSCDK::Interfaces::AWSIotfleetwise::CampaignReference
A reference to a Campaign resource.
-
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
- #cfn_properties ⇒ Hash{String => Object}
- #cfn_property_name(cdk_property_name) ⇒ String?
- #cfn_property_names ⇒ Hash{String => String}
-
#cfn_resource_type ⇒ String
AWS resource type.
-
#collection_scheme ⇒ AWSCDK::IResolvable, AWSCDK::IoTFleetWise::CfnCampaign::CollectionSchemeProperty
The data collection scheme associated with the campaign.
- #collection_scheme=(value) ⇒ Object
-
#compression ⇒ String?
Whether to compress signals before transmitting data to AWS IoT FleetWise .
- #compression=(value) ⇒ Object
- #creation_stack ⇒ Array<String>
-
#data_destination_configs ⇒ AWSCDK::IResolvable, ...
The destination where the campaign sends data.
- #data_destination_configs=(value) ⇒ Object
-
#data_extra_dimensions ⇒ Array<String>?
A list of vehicle attributes to associate with a campaign.
- #data_extra_dimensions=(value) ⇒ Object
-
#data_partitions ⇒ AWSCDK::IResolvable, ...
The data partitions associated with the signals collected from the vehicle.
- #data_partitions=(value) ⇒ Object
-
#description ⇒ String?
The description of the campaign.
- #description=(value) ⇒ Object
-
#diagnostics_mode ⇒ String?
Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .
- #diagnostics_mode=(value) ⇒ Object
- #env ⇒ AWSCDK::Interfaces::ResourceEnvironment
-
#expiry_time ⇒ String?
The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).
- #expiry_time=(value) ⇒ Object
-
#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference
Returns a token for an runtime attribute of this resource.
-
#get_metadata(key) ⇒ Object
Retrieve a value value from the CloudFormation Resource Metadata.
-
#initialize(scope, id, props) ⇒ CfnCampaign
constructor
Create a new
AWS::IoTFleetWise::Campaign. -
#inspect(inspector) ⇒ void
Examines the CloudFormation resource and discloses attributes.
-
#logical_id ⇒ String
The logical ID for this CloudFormation stack element.
-
#name ⇒ String
The name of a campaign.
- #name=(value) ⇒ Object
-
#node ⇒ Constructs::Node
The tree node.
-
#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>
Retrieves an array of resources this resource depends on.
-
#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>
Get a shallow copy of dependencies between this resource and other resources in the same stack.
-
#override_logical_id(new_logical_id) ⇒ void
Overrides the auto-generated logical ID with a specific ID.
-
#post_trigger_collection_duration ⇒ Numeric?
How long (in milliseconds) to collect raw data after a triggering event initiates the collection.
- #post_trigger_collection_duration=(value) ⇒ Object
-
#priority ⇒ Numeric?
A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.
- #priority=(value) ⇒ Object
-
#ref ⇒ String
Return a string that will be resolved to a CloudFormation
{ Ref }for this element. -
#remove_dependency(target) ⇒ void
Indicates that this resource no longer depends on another resource.
- #render_properties(props) ⇒ Hash{String => Object}
-
#replace_dependency(target, new_target) ⇒ void
Replaces one dependency with another.
-
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
-
#signal_catalog_arn ⇒ String
The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.
- #signal_catalog_arn=(value) ⇒ Object
-
#signals_to_collect ⇒ AWSCDK::IResolvable, ...
A list of information about signals to collect.
- #signals_to_collect=(value) ⇒ Object
-
#signals_to_fetch ⇒ AWSCDK::IResolvable, ...
A list of information about signals to fetch.
- #signals_to_fetch=(value) ⇒ Object
-
#spooling_mode ⇒ String?
Whether to store collected data after a vehicle lost a connection with the cloud.
- #spooling_mode=(value) ⇒ Object
-
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
-
#start_time ⇒ String?
The time, in milliseconds, to deliver a campaign after it was approved.
- #start_time=(value) ⇒ Object
-
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
-
#tags_raw ⇒ Array<AWSCDK::CfnTag>?
Metadata that can be used to manage the campaign.
- #tags_raw=(value) ⇒ Object
-
#target_arn ⇒ String
The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.
- #target_arn=(value) ⇒ Object
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#updated_properites ⇒ Hash{String => Object}
deprecated
Deprecated.
use
updatedPropertiesReturn properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource. -
#updated_properties ⇒ Hash{String => Object}
Return properties modified after initiation.
- #validate_properties(_properties) ⇒ void
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Constructor Details
#initialize(scope, id, props) ⇒ CfnCampaign
Create a new AWS::IoTFleetWise::Campaign.
24 25 26 27 28 29 30 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 24 def initialize(scope, id, props) props = props.is_a?(Hash) ? ::AWSCDK::IoTFleetWise::CfnCampaignProps.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope") Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id") Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90ZmxlZXR3aXNlLkNmbkNhbXBhaWduUHJvcHMifQ==")), "props") Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props) end |
Class Method Details
.arn_for_campaign(resource) ⇒ String
99 100 101 102 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 99 def self.arn_for_campaign(resource) Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pb3RmbGVldHdpc2UuSUNhbXBhaWduUmVmIn0=")), "resource") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotfleetwise.CfnCampaign", "arnForCampaign", [resource]) end |
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
232 233 234 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 232 def self.CFN_RESOURCE_TYPE_NAME() Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_iotfleetwise.CfnCampaign", "CFN_RESOURCE_TYPE_NAME") end |
.from_campaign_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSIotfleetwise::ICampaignRef
Creates a new ICampaignRef from an ARN.
110 111 112 113 114 115 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 110 def self.from_campaign_arn(scope, id, arn) Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope") Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id") Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotfleetwise.CfnCampaign", "fromCampaignArn", [scope, id, arn]) end |
.from_campaign_name(scope, id, campaign_name) ⇒ AWSCDK::Interfaces::AWSIotfleetwise::ICampaignRef
Creates a new ICampaignRef from a campaignName.
123 124 125 126 127 128 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 123 def self.from_campaign_name(scope, id, campaign_name) Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope") Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id") Jsii::Type.check_type(campaign_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "campaignName") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotfleetwise.CfnCampaign", "fromCampaignName", [scope, id, campaign_name]) end |
.is_cfn_campaign(x) ⇒ Boolean
Checks whether the given object is a CfnCampaign.
134 135 136 137 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 134 def self.is_cfn_campaign(x) Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotfleetwise.CfnCampaign", "isCfnCampaign", [x]) end |
.jsii_overridable_methods ⇒ Object
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 32 def self.jsii_overridable_methods { :node => { kind: :property, name: "node", is_optional: false }, :creation_stack => { kind: :property, name: "creationStack", is_optional: false }, :logical_id => { kind: :property, name: "logicalId", is_optional: false }, :stack => { kind: :property, name: "stack", is_optional: false }, :ref => { kind: :property, name: "ref", is_optional: false }, :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false }, :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false }, :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false }, :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false }, :env => { kind: :property, name: "env", is_optional: false }, :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false }, :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false }, :attr_arn => { kind: :property, name: "attrArn", is_optional: false }, :attr_creation_time => { kind: :property, name: "attrCreationTime", is_optional: false }, :attr_last_modification_time => { kind: :property, name: "attrLastModificationTime", is_optional: false }, :attr_status => { kind: :property, name: "attrStatus", is_optional: false }, :campaign_ref => { kind: :property, name: "campaignRef", is_optional: false }, :tags => { kind: :property, name: "tags", is_optional: false }, :collection_scheme => { kind: :property, name: "collectionScheme", is_optional: false }, :name => { kind: :property, name: "name", is_optional: false }, :signal_catalog_arn => { kind: :property, name: "signalCatalogArn", is_optional: false }, :target_arn => { kind: :property, name: "targetArn", is_optional: false }, :action => { kind: :property, name: "action", is_optional: true }, :compression => { kind: :property, name: "compression", is_optional: true }, :data_destination_configs => { kind: :property, name: "dataDestinationConfigs", is_optional: true }, :data_extra_dimensions => { kind: :property, name: "dataExtraDimensions", is_optional: true }, :data_partitions => { kind: :property, name: "dataPartitions", is_optional: true }, :description => { kind: :property, name: "description", is_optional: true }, :diagnostics_mode => { kind: :property, name: "diagnosticsMode", is_optional: true }, :expiry_time => { kind: :property, name: "expiryTime", is_optional: true }, :post_trigger_collection_duration => { kind: :property, name: "postTriggerCollectionDuration", is_optional: true }, :priority => { kind: :property, name: "priority", is_optional: true }, :signals_to_collect => { kind: :property, name: "signalsToCollect", is_optional: true }, :signals_to_fetch => { kind: :property, name: "signalsToFetch", is_optional: true }, :spooling_mode => { kind: :property, name: "spoolingMode", is_optional: true }, :start_time => { kind: :property, name: "startTime", is_optional: true }, :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true }, :to_string => { kind: :method, name: "toString", is_optional: false }, :with => { kind: :method, name: "with", is_optional: false }, :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false }, :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false }, :add_dependency => { kind: :method, name: "addDependency", is_optional: false }, :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false }, :add_metadata => { kind: :method, name: "addMetadata", is_optional: false }, :add_override => { kind: :method, name: "addOverride", is_optional: false }, :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false }, :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false }, :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false }, :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false }, :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false }, :get_att => { kind: :method, name: "getAtt", is_optional: false }, :get_metadata => { kind: :method, name: "getMetadata", is_optional: false }, :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false }, :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false }, :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false }, :render_properties => { kind: :method, name: "renderProperties", is_optional: false }, :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false }, :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false }, :validate_properties => { kind: :method, name: "validateProperties", is_optional: false }, :inspect => { kind: :method, name: "inspect", is_optional: false }, } end |
Instance Method Details
#action ⇒ String?
Specifies how to update a campaign.
The action can be one of the following:.
334 335 336 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 334 def action() jsii_get_property("action") end |
#action=(value) ⇒ Object
338 339 340 341 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 338 def action=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "action") unless value.nil? jsii_set_property("action", value) end |
#add_deletion_override(path) ⇒ void
This method returns an undefined value.
Syntactic sugar for addOverride(path, undefined).
550 551 552 553 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 550 def add_deletion_override(path) Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path") jsii_call_method("addDeletionOverride", [path]) end |
#add_dependency(target) ⇒ void
This method returns an undefined value.
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.
562 563 564 565 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 562 def add_dependency(target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") jsii_call_method("addDependency", [target]) end |
#add_depends_on(target) ⇒ void
use addDependency
This method returns an undefined value.
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
572 573 574 575 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 572 def add_depends_on(target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") jsii_call_method("addDependsOn", [target]) end |
#add_metadata(key, value) ⇒ void
This method returns an undefined value.
Add a value to the CloudFormation Resource Metadata.
583 584 585 586 587 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 583 def (key, value) Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key") Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value") jsii_call_method("addMetadata", [key, value]) end |
#add_override(path, value) ⇒ void
This method returns an undefined value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use add_property_override 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,
# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to add_override 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.
640 641 642 643 644 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 640 def add_override(path, value) Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path") Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value") jsii_call_method("addOverride", [path, value]) end |
#add_property_deletion_override(property_path) ⇒ void
This method returns an undefined value.
Adds an override that deletes the value of a property from the resource definition.
650 651 652 653 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 650 def add_property_deletion_override(property_path) Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath") jsii_call_method("addPropertyDeletionOverride", [property_path]) end |
#add_property_override(property_path, value) ⇒ void
This method returns an undefined value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
662 663 664 665 666 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 662 def add_property_override(property_path, value) Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath") Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value") jsii_call_method("addPropertyOverride", [property_path, value]) end |
#apply_cross_stack_reference_strength(strength) ⇒ void
This method returns an undefined value.
Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
675 676 677 678 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 675 def apply_cross_stack_reference_strength(strength) Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength") jsii_call_method("applyCrossStackReferenceStrength", [strength]) end |
#apply_removal_policy(policy = nil, options = nil) ⇒ void
This method returns an undefined value.
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT). A list of resources that support this policy
can be found in the following link:
697 698 699 700 701 702 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 697 def apply_removal_policy(policy = nil, = nil) Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil? = .is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless .nil? jsii_call_method("applyRemovalPolicy", [policy, ]) end |
#attr_arn ⇒ String
The Amazon Resource Name (ARN) of the campaign.
239 240 241 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 239 def attr_arn() jsii_get_property("attrArn") end |
#attr_creation_time ⇒ String
The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
246 247 248 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 246 def attr_creation_time() jsii_get_property("attrCreationTime") end |
#attr_last_modification_time ⇒ String
The last time the campaign was modified.
253 254 255 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 253 def attr_last_modification_time() jsii_get_property("attrLastModificationTime") end |
#attr_status ⇒ String
The state of the campaign.
The status can be one of: CREATING , WAITING_FOR_APPROVAL , RUNNING , and SUSPENDED .
262 263 264 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 262 def attr_status() jsii_get_property("attrStatus") end |
#campaign_ref ⇒ AWSCDK::Interfaces::AWSIotfleetwise::CampaignReference
A reference to a Campaign resource.
269 270 271 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 269 def campaign_ref() jsii_get_property("campaignRef") end |
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
185 186 187 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 185 def () jsii_get_property("cfnOptions") end |
#cfn_properties ⇒ Hash{String => Object}
190 191 192 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 190 def cfn_properties() jsii_get_property("cfnProperties") end |
#cfn_property_name(cdk_property_name) ⇒ String?
706 707 708 709 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 706 def cfn_property_name(cdk_property_name) Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName") jsii_call_method("cfnPropertyName", [cdk_property_name]) end |
#cfn_property_names ⇒ Hash{String => String}
195 196 197 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 195 def cfn_property_names() jsii_get_property("cfnPropertyNames") end |
#cfn_resource_type ⇒ String
AWS resource type.
202 203 204 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 202 def cfn_resource_type() jsii_get_property("cfnResourceType") end |
#collection_scheme ⇒ AWSCDK::IResolvable, AWSCDK::IoTFleetWise::CfnCampaign::CollectionSchemeProperty
The data collection scheme associated with the campaign.
283 284 285 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 283 def collection_scheme() jsii_get_property("collectionScheme") end |
#collection_scheme=(value) ⇒ Object
287 288 289 290 291 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 287 def collection_scheme=(value) value = value.is_a?(Hash) ? ::AWSCDK::IoTFleetWise::CfnCampaign::CollectionSchemeProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3RmbGVldHdpc2UuQ2ZuQ2FtcGFpZ24uQ29sbGVjdGlvblNjaGVtZVByb3BlcnR5In1dfX0=")), "collectionScheme") jsii_set_property("collectionScheme", value) end |
#compression ⇒ String?
Whether to compress signals before transmitting data to AWS IoT FleetWise .
346 347 348 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 346 def compression() jsii_get_property("compression") end |
#compression=(value) ⇒ Object
350 351 352 353 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 350 def compression=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "compression") unless value.nil? jsii_set_property("compression", value) end |
#creation_stack ⇒ Array<String>
147 148 149 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 147 def creation_stack() jsii_get_property("creationStack") end |
#data_destination_configs ⇒ AWSCDK::IResolvable, ...
The destination where the campaign sends data.
358 359 360 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 358 def data_destination_configs() jsii_get_property("dataDestinationConfigs") end |
#data_destination_configs=(value) ⇒ Object
362 363 364 365 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 362 def data_destination_configs=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90ZmxlZXR3aXNlLkNmbkNhbXBhaWduLkRhdGFEZXN0aW5hdGlvbkNvbmZpZ1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "dataDestinationConfigs") unless value.nil? jsii_set_property("dataDestinationConfigs", value) end |
#data_extra_dimensions ⇒ Array<String>?
A list of vehicle attributes to associate with a campaign.
370 371 372 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 370 def data_extra_dimensions() jsii_get_property("dataExtraDimensions") end |
#data_extra_dimensions=(value) ⇒ Object
374 375 376 377 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 374 def data_extra_dimensions=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "dataExtraDimensions") unless value.nil? jsii_set_property("dataExtraDimensions", value) end |
#data_partitions ⇒ AWSCDK::IResolvable, ...
The data partitions associated with the signals collected from the vehicle.
382 383 384 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 382 def data_partitions() jsii_get_property("dataPartitions") end |
#data_partitions=(value) ⇒ Object
386 387 388 389 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 386 def data_partitions=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90ZmxlZXR3aXNlLkNmbkNhbXBhaWduLkRhdGFQYXJ0aXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "dataPartitions") unless value.nil? jsii_set_property("dataPartitions", value) end |
#description ⇒ String?
The description of the campaign.
394 395 396 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 394 def description() jsii_get_property("description") end |
#description=(value) ⇒ Object
398 399 400 401 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 398 def description=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil? jsii_set_property("description", value) end |
#diagnostics_mode ⇒ String?
Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .
406 407 408 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 406 def diagnostics_mode() jsii_get_property("diagnosticsMode") end |
#diagnostics_mode=(value) ⇒ Object
410 411 412 413 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 410 def diagnostics_mode=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "diagnosticsMode") unless value.nil? jsii_set_property("diagnosticsMode", value) end |
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
207 208 209 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 207 def env() jsii_get_property("env") end |
#expiry_time ⇒ String?
The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).
418 419 420 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 418 def expiry_time() jsii_get_property("expiryTime") end |
#expiry_time=(value) ⇒ Object
422 423 424 425 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 422 def expiry_time=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "expiryTime") unless value.nil? jsii_set_property("expiryTime", value) end |
#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference
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.
719 720 721 722 723 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 719 def get_att(attribute_name, type_hint = nil) Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName") Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil? jsii_call_method("getAtt", [attribute_name, type_hint]) end |
#get_metadata(key) ⇒ Object
Retrieve a value value from the CloudFormation Resource Metadata.
730 731 732 733 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 730 def (key) Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key") jsii_call_method("getMetadata", [key]) end |
#inspect(inspector) ⇒ void
This method returns an undefined value.
Examines the CloudFormation resource and discloses attributes.
800 801 802 803 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 800 def inspect(inspector) Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector") jsii_call_method("inspect", [inspector]) end |
#logical_id ⇒ 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 override_logical_id(new_logical_id).
159 160 161 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 159 def logical_id() jsii_get_property("logicalId") end |
#name ⇒ String
The name of a campaign.
296 297 298 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 296 def name() jsii_get_property("name") end |
#name=(value) ⇒ Object
300 301 302 303 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 300 def name=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") jsii_set_property("name", value) end |
#node ⇒ Constructs::Node
The tree node.
142 143 144 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 142 def node() jsii_get_property("node") end |
#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
741 742 743 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 741 def obtain_dependencies() jsii_call_method("obtainDependencies", []) end |
#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>
Get a shallow copy of dependencies between this resource and other resources in the same stack.
748 749 750 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 748 def obtain_resource_dependencies() jsii_call_method("obtainResourceDependencies", []) end |
#override_logical_id(new_logical_id) ⇒ void
This method returns an undefined value.
Overrides the auto-generated logical ID with a specific ID.
541 542 543 544 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 541 def override_logical_id(new_logical_id) Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId") jsii_call_method("overrideLogicalId", [new_logical_id]) end |
#post_trigger_collection_duration ⇒ Numeric?
How long (in milliseconds) to collect raw data after a triggering event initiates the collection.
430 431 432 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 430 def post_trigger_collection_duration() jsii_get_property("postTriggerCollectionDuration") end |
#post_trigger_collection_duration=(value) ⇒ Object
434 435 436 437 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 434 def post_trigger_collection_duration=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "postTriggerCollectionDuration") unless value.nil? jsii_set_property("postTriggerCollectionDuration", value) end |
#priority ⇒ Numeric?
A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.
442 443 444 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 442 def priority() jsii_get_property("priority") end |
#priority=(value) ⇒ Object
446 447 448 449 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 446 def priority=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "priority") unless value.nil? jsii_set_property("priority", value) end |
#ref ⇒ 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 }).
178 179 180 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 178 def ref() jsii_get_property("ref") end |
#remove_dependency(target) ⇒ void
This method returns an undefined value.
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
759 760 761 762 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 759 def remove_dependency(target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") jsii_call_method("removeDependency", [target]) end |
#render_properties(props) ⇒ Hash{String => Object}
766 767 768 769 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 766 def render_properties(props) Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props") jsii_call_method("renderProperties", [props]) end |
#replace_dependency(target, new_target) ⇒ void
This method returns an undefined value.
Replaces one dependency with another.
776 777 778 779 780 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 776 def replace_dependency(target, new_target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget") jsii_call_method("replaceDependency", [target, new_target]) end |
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
785 786 787 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 785 def should_synthesize() jsii_call_method("shouldSynthesize", []) end |
#signal_catalog_arn ⇒ String
The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.
308 309 310 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 308 def signal_catalog_arn() jsii_get_property("signalCatalogArn") end |
#signal_catalog_arn=(value) ⇒ Object
312 313 314 315 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 312 def signal_catalog_arn=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "signalCatalogArn") jsii_set_property("signalCatalogArn", value) end |
#signals_to_collect ⇒ AWSCDK::IResolvable, ...
A list of information about signals to collect.
454 455 456 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 454 def signals_to_collect() jsii_get_property("signalsToCollect") end |
#signals_to_collect=(value) ⇒ Object
458 459 460 461 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 458 def signals_to_collect=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90ZmxlZXR3aXNlLkNmbkNhbXBhaWduLlNpZ25hbEluZm9ybWF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "signalsToCollect") unless value.nil? jsii_set_property("signalsToCollect", value) end |
#signals_to_fetch ⇒ AWSCDK::IResolvable, ...
A list of information about signals to fetch.
466 467 468 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 466 def signals_to_fetch() jsii_get_property("signalsToFetch") end |
#signals_to_fetch=(value) ⇒ Object
470 471 472 473 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 470 def signals_to_fetch=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90ZmxlZXR3aXNlLkNmbkNhbXBhaWduLlNpZ25hbEZldGNoSW5mb3JtYXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "signalsToFetch") unless value.nil? jsii_set_property("signalsToFetch", value) end |
#spooling_mode ⇒ String?
Whether to store collected data after a vehicle lost a connection with the cloud.
478 479 480 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 478 def spooling_mode() jsii_get_property("spoolingMode") end |
#spooling_mode=(value) ⇒ Object
482 483 484 485 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 482 def spooling_mode=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "spoolingMode") unless value.nil? jsii_set_property("spoolingMode", value) end |
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
168 169 170 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 168 def stack() jsii_get_property("stack") end |
#start_time ⇒ String?
The time, in milliseconds, to deliver a campaign after it was approved.
If it's not specified, 0 is used.
492 493 494 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 492 def start_time() jsii_get_property("startTime") end |
#start_time=(value) ⇒ Object
496 497 498 499 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 496 def start_time=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "startTime") unless value.nil? jsii_set_property("startTime", value) end |
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
276 277 278 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 276 def () jsii_get_property("tags") end |
#tags_raw ⇒ Array<AWSCDK::CfnTag>?
Metadata that can be used to manage the campaign.
504 505 506 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 504 def () jsii_get_property("tagsRaw") end |
#tags_raw=(value) ⇒ Object
508 509 510 511 512 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 508 def (value) value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil? jsii_set_property("tagsRaw", value) end |
#target_arn ⇒ String
The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.
320 321 322 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 320 def target_arn() jsii_get_property("targetArn") end |
#target_arn=(value) ⇒ Object
324 325 326 327 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 324 def target_arn=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "targetArn") jsii_set_property("targetArn", value) end |
#to_string ⇒ String
Returns a string representation of this construct.
517 518 519 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 517 def to_string() jsii_call_method("toString", []) end |
#updated_properites ⇒ Hash{String => Object}
use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.
Deprecated.
215 216 217 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 215 def updated_properites() jsii_get_property("updatedProperites") end |
#updated_properties ⇒ Hash{String => Object}
Return properties modified after initiation.
Resources that expose mutable properties should override this function to collect and return the properties object for this resource.
225 226 227 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 225 def updated_properties() jsii_get_property("updatedProperties") end |
#validate_properties(_properties) ⇒ void
This method returns an undefined value.
791 792 793 794 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 791 def validate_properties(_properties) Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties") jsii_call_method("validateProperties", [_properties]) end |
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
530 531 532 533 534 535 |
# File 'io_t_fleet_wise/cfn_campaign.rb', line 530 def with(*mixins) mixins.each_with_index do |item, index| Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]") end jsii_call_method("with", [*mixins]) end |