Class: AWSCDK::IoT::CfnFleetMetric

Inherits:
CfnResource
  • Object
show all
Includes:
AWSCDK::IInspectable, AWSCDK::ITaggable, AWSCDK::Interfaces::AWSIot::IFleetMetricRef
Defined in:
io_t/cfn_fleet_metric.rb

Overview

Use the AWS::IoT::FleetMetric resource to declare a fleet metric.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnFleetMetric

Create a new AWS::IoT::FleetMetric.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::IoT::CfnFleetMetricProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'io_t/cfn_fleet_metric.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::IoT::CfnFleetMetricProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90LkNmbkZsZWV0TWV0cmljUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


184
185
186
 
# File 'io_t/cfn_fleet_metric.rb', line 184

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_iot.CfnFleetMetric", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_fleet_metric(x) ⇒ Boolean

Checks whether the given object is a CfnFleetMetric.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


86
87
88
89
 
# File 'io_t/cfn_fleet_metric.rb', line 86

def self.is_cfn_fleet_metric(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iot.CfnFleetMetric", "isCfnFleetMetric", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
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
 
# File 'io_t/cfn_fleet_metric.rb', line 26

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_creation_date => { kind: :property, name: "attrCreationDate", is_optional: false },
    :attr_last_modified_date => { kind: :property, name: "attrLastModifiedDate", is_optional: false },
    :attr_metric_arn => { kind: :property, name: "attrMetricArn", is_optional: false },
    :attr_version => { kind: :property, name: "attrVersion", is_optional: false },
    :fleet_metric_ref => { kind: :property, name: "fleetMetricRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :metric_name => { kind: :property, name: "metricName", is_optional: false },
    :aggregation_field => { kind: :property, name: "aggregationField", is_optional: true },
    :aggregation_type => { kind: :property, name: "aggregationType", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :index_name => { kind: :property, name: "indexName", is_optional: true },
    :period => { kind: :property, name: "period", is_optional: true },
    :query_string => { kind: :property, name: "queryString", is_optional: true },
    :query_version => { kind: :property, name: "queryVersion", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :unit => { kind: :property, name: "unit", 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

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



388
389
390
391
 
# File 'io_t/cfn_fleet_metric.rb', line 388

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.

Parameters:



400
401
402
403
 
# File 'io_t/cfn_fleet_metric.rb', line 400

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

Deprecated.

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.

Parameters:



410
411
412
413
 
# File 'io_t/cfn_fleet_metric.rb', line 410

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.

Parameters:

  • key (String)
  • value (Object)

See Also:



421
422
423
424
425
 
# File 'io_t/cfn_fleet_metric.rb', line 421

def add_metadata(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.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


478
479
480
481
482
 
# File 'io_t/cfn_fleet_metric.rb', line 478

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.

Parameters:

  • property_path (String) —

    The path to the property.



488
489
490
491
 
# File 'io_t/cfn_fleet_metric.rb', line 488

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).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



500
501
502
503
504
 
# File 'io_t/cfn_fleet_metric.rb', line 500

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

#aggregation_field ⇒ String?

The field to aggregate.

Returns:

  • (String, nil) 


245
246
247
 
# File 'io_t/cfn_fleet_metric.rb', line 245

def aggregation_field()
  jsii_get_property("aggregationField")
end

#aggregation_field=(value) ⇒ Object 



249
250
251
252
 
# File 'io_t/cfn_fleet_metric.rb', line 249

def aggregation_field=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "aggregationField") unless value.nil?
  jsii_set_property("aggregationField", value)
end

#aggregation_type ⇒ AWSCDK::IResolvable, ...

The type of the aggregation query.

Returns:



257
258
259
 
# File 'io_t/cfn_fleet_metric.rb', line 257

def aggregation_type()
  jsii_get_property("aggregationType")
end

#aggregation_type=(value) ⇒ Object 



261
262
263
264
265
 
# File 'io_t/cfn_fleet_metric.rb', line 261

def aggregation_type=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::IoT::CfnFleetMetric::AggregationTypeProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3QuQ2ZuRmxlZXRNZXRyaWMuQWdncmVnYXRpb25UeXBlUHJvcGVydHkifV19fQ==")), "aggregationType") unless value.nil?
  jsii_set_property("aggregationType", 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.

Parameters:



513
514
515
516
 
# File 'io_t/cfn_fleet_metric.rb', line 513

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:

Parameters:

See Also:



535
536
537
538
539
540
 
# File 'io_t/cfn_fleet_metric.rb', line 535

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_creation_date ⇒ AWSCDK::IResolvable

The time the fleet metric was created.

Returns:



191
192
193
 
# File 'io_t/cfn_fleet_metric.rb', line 191

def attr_creation_date()
  jsii_get_property("attrCreationDate")
end

#attr_last_modified_date ⇒ AWSCDK::IResolvable

The time the fleet metric was last modified.

Returns:



198
199
200
 
# File 'io_t/cfn_fleet_metric.rb', line 198

def attr_last_modified_date()
  jsii_get_property("attrLastModifiedDate")
end

#attr_metric_arn ⇒ String

The Amazon Resource Name (ARN) of the fleet metric.

Returns:

  • (String) 


205
206
207
 
# File 'io_t/cfn_fleet_metric.rb', line 205

def attr_metric_arn()
  jsii_get_property("attrMetricArn")
end

#attr_version ⇒ AWSCDK::IResolvable

The fleet metric version.

Returns:



212
213
214
 
# File 'io_t/cfn_fleet_metric.rb', line 212

def attr_version()
  jsii_get_property("attrVersion")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



137
138
139
 
# File 'io_t/cfn_fleet_metric.rb', line 137

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


142
143
144
 
# File 'io_t/cfn_fleet_metric.rb', line 142

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


544
545
546
547
 
# File 'io_t/cfn_fleet_metric.rb', line 544

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}

Returns:

  • (Hash{String => String}) 


147
148
149
 
# File 'io_t/cfn_fleet_metric.rb', line 147

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


154
155
156
 
# File 'io_t/cfn_fleet_metric.rb', line 154

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


99
100
101
 
# File 'io_t/cfn_fleet_metric.rb', line 99

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The fleet metric description.

Returns:

  • (String, nil) 


270
271
272
 
# File 'io_t/cfn_fleet_metric.rb', line 270

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



274
275
276
277
 
# File 'io_t/cfn_fleet_metric.rb', line 274

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



159
160
161
 
# File 'io_t/cfn_fleet_metric.rb', line 159

def env()
  jsii_get_property("env")
end

#fleet_metric_ref ⇒ AWSCDK::Interfaces::AWSIot::FleetMetricReference

A reference to a FleetMetric resource.

Returns:



219
220
221
 
# File 'io_t/cfn_fleet_metric.rb', line 219

def fleet_metric_ref()
  jsii_get_property("fleetMetricRef")
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.

Parameters:

Returns:



557
558
559
560
561
 
# File 'io_t/cfn_fleet_metric.rb', line 557

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.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



568
569
570
571
 
# File 'io_t/cfn_fleet_metric.rb', line 568

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#index_name ⇒ String?

The name of the index to search.

Returns:

  • (String, nil) 


282
283
284
 
# File 'io_t/cfn_fleet_metric.rb', line 282

def index_name()
  jsii_get_property("indexName")
end

#index_name=(value) ⇒ Object 



286
287
288
289
 
# File 'io_t/cfn_fleet_metric.rb', line 286

def index_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "indexName") unless value.nil?
  jsii_set_property("indexName", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



638
639
640
641
 
# File 'io_t/cfn_fleet_metric.rb', line 638

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).

Returns:

  • (String) 


111
112
113
 
# File 'io_t/cfn_fleet_metric.rb', line 111

def logical_id()
  jsii_get_property("logicalId")
end

#metric_name ⇒ String

The name of the fleet metric to create.

Returns:

  • (String) 


233
234
235
 
# File 'io_t/cfn_fleet_metric.rb', line 233

def metric_name()
  jsii_get_property("metricName")
end

#metric_name=(value) ⇒ Object 



237
238
239
240
 
# File 'io_t/cfn_fleet_metric.rb', line 237

def metric_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName")
  jsii_set_property("metricName", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


94
95
96
 
# File 'io_t/cfn_fleet_metric.rb', line 94

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.

Returns:



579
580
581
 
# File 'io_t/cfn_fleet_metric.rb', line 579

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.

Returns:



586
587
588
 
# File 'io_t/cfn_fleet_metric.rb', line 586

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.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



379
380
381
382
 
# File 'io_t/cfn_fleet_metric.rb', line 379

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

#period ⇒ Numeric?

The time in seconds between fleet metric emissions.

Returns:

  • (Numeric, nil) 


294
295
296
 
# File 'io_t/cfn_fleet_metric.rb', line 294

def period()
  jsii_get_property("period")
end

#period=(value) ⇒ Object 



298
299
300
301
 
# File 'io_t/cfn_fleet_metric.rb', line 298

def period=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "period") unless value.nil?
  jsii_set_property("period", value)
end

#query_string ⇒ String?

The search query string.

Returns:

  • (String, nil) 


306
307
308
 
# File 'io_t/cfn_fleet_metric.rb', line 306

def query_string()
  jsii_get_property("queryString")
end

#query_string=(value) ⇒ Object 



310
311
312
313
 
# File 'io_t/cfn_fleet_metric.rb', line 310

def query_string=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "queryString") unless value.nil?
  jsii_set_property("queryString", value)
end

#query_version ⇒ String?

The query version.

Returns:

  • (String, nil) 


318
319
320
 
# File 'io_t/cfn_fleet_metric.rb', line 318

def query_version()
  jsii_get_property("queryVersion")
end

#query_version=(value) ⇒ Object 



322
323
324
325
 
# File 'io_t/cfn_fleet_metric.rb', line 322

def query_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "queryVersion") unless value.nil?
  jsii_set_property("queryVersion", 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 }).

Returns:

  • (String) 


130
131
132
 
# File 'io_t/cfn_fleet_metric.rb', line 130

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.

Parameters:



597
598
599
600
 
# File 'io_t/cfn_fleet_metric.rb', line 597

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}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


604
605
606
607
 
# File 'io_t/cfn_fleet_metric.rb', line 604

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.

Parameters:



614
615
616
617
618
 
# File 'io_t/cfn_fleet_metric.rb', line 614

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.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



623
624
625
 
# File 'io_t/cfn_fleet_metric.rb', line 623

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



120
121
122
 
# File 'io_t/cfn_fleet_metric.rb', line 120

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



226
227
228
 
# File 'io_t/cfn_fleet_metric.rb', line 226

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Metadata which can be used to manage the fleet metric.

Returns:



330
331
332
 
# File 'io_t/cfn_fleet_metric.rb', line 330

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



334
335
336
337
338
 
# File 'io_t/cfn_fleet_metric.rb', line 334

def tags_raw=(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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



355
356
357
 
# File 'io_t/cfn_fleet_metric.rb', line 355

def to_string()
  jsii_call_method("toString", [])
end

#unit ⇒ String?

Used to support unit transformation such as milliseconds to seconds.

Returns:

  • (String, nil) 


343
344
345
 
# File 'io_t/cfn_fleet_metric.rb', line 343

def unit()
  jsii_get_property("unit")
end

#unit=(value) ⇒ Object 



347
348
349
350
 
# File 'io_t/cfn_fleet_metric.rb', line 347

def unit=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "unit") unless value.nil?
  jsii_set_property("unit", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


167
168
169
 
# File 'io_t/cfn_fleet_metric.rb', line 167

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.

Returns:

  • (Hash{String => Object}) 


177
178
179
 
# File 'io_t/cfn_fleet_metric.rb', line 177

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


629
630
631
632
 
# File 'io_t/cfn_fleet_metric.rb', line 629

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.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


368
369
370
371
372
373
 
# File 'io_t/cfn_fleet_metric.rb', line 368

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