Class: AWSCDK::IoT::CfnJobTemplate

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

Overview

Represents a job template.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnJobTemplate

Create a new AWS::IoT::JobTemplate.

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::CfnJobTemplateProps) —

    Resource properties.



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

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

Class Method Details

.arn_for_job_template(resource) ⇒ String

Parameters:

Returns:

  • (String) 


84
85
86
87
 
# File 'io_t/cfn_job_template.rb', line 84

def self.arn_for_job_template(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pb3QuSUpvYlRlbXBsYXRlUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iot.CfnJobTemplate", "arnForJobTemplate", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


217
218
219
 
# File 'io_t/cfn_job_template.rb', line 217

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

.from_job_template_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSIot::IJobTemplateRef

Creates a new IJobTemplateRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



95
96
97
98
99
100
 
# File 'io_t/cfn_job_template.rb', line 95

def self.from_job_template_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_iot.CfnJobTemplate", "fromJobTemplateArn", [scope, id, arn])
end

.from_job_template_id(scope, id, job_template_id) ⇒ AWSCDK::Interfaces::AWSIot::IJobTemplateRef

Creates a new IJobTemplateRef from a jobTemplateId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • job_template_id (String)

Returns:



108
109
110
111
112
113
 
# File 'io_t/cfn_job_template.rb', line 108

def self.from_job_template_id(scope, id, job_template_id)
  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(job_template_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jobTemplateId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iot.CfnJobTemplate", "fromJobTemplateId", [scope, id, job_template_id])
end

.is_cfn_job_template(x) ⇒ Boolean

Checks whether the given object is a CfnJobTemplate.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_job_template(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iot.CfnJobTemplate", "isCfnJobTemplate", [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_job_template.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_arn => { kind: :property, name: "attrArn", is_optional: false },
    :job_template_ref => { kind: :property, name: "jobTemplateRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :abort_config => { kind: :property, name: "abortConfig", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: false },
    :job_executions_rollout_config => { kind: :property, name: "jobExecutionsRolloutConfig", is_optional: false },
    :job_template_id => { kind: :property, name: "jobTemplateId", is_optional: false },
    :presigned_url_config => { kind: :property, name: "presignedUrlConfig", is_optional: false },
    :timeout_config => { kind: :property, name: "timeoutConfig", is_optional: false },
    :destination_package_versions => { kind: :property, name: "destinationPackageVersions", is_optional: true },
    :document => { kind: :property, name: "document", is_optional: true },
    :document_source => { kind: :property, name: "documentSource", is_optional: true },
    :job_arn => { kind: :property, name: "jobArn", is_optional: true },
    :job_executions_retry_config => { kind: :property, name: "jobExecutionsRetryConfig", is_optional: true },
    :maintenance_windows => { kind: :property, name: "maintenanceWindows", 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

#abort_config ⇒ Object

The criteria that determine when and how a job abort takes place.

Returns:

  • (Object) 


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

def abort_config()
  jsii_get_property("abortConfig")
end

#abort_config=(value) ⇒ Object 



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

def abort_config=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "abortConfig")
  jsii_set_property("abortConfig", value)
end

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



436
437
438
439
 
# File 'io_t/cfn_job_template.rb', line 436

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:



448
449
450
451
 
# File 'io_t/cfn_job_template.rb', line 448

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:



458
459
460
461
 
# File 'io_t/cfn_job_template.rb', line 458

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:



469
470
471
472
473
 
# File 'io_t/cfn_job_template.rb', line 469

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.


526
527
528
529
530
 
# File 'io_t/cfn_job_template.rb', line 526

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.



536
537
538
539
 
# File 'io_t/cfn_job_template.rb', line 536

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.



548
549
550
551
552
 
# File 'io_t/cfn_job_template.rb', line 548

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.

Parameters:



561
562
563
564
 
# File 'io_t/cfn_job_template.rb', line 561

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:



583
584
585
586
587
588
 
# File 'io_t/cfn_job_template.rb', line 583

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_arn ⇒ String

The ARN of the job to use as the basis for the job template.

Returns:

  • (String) 


224
225
226
 
# File 'io_t/cfn_job_template.rb', line 224

def attr_arn()
  jsii_get_property("attrArn")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



170
171
172
 
# File 'io_t/cfn_job_template.rb', line 170

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


175
176
177
 
# File 'io_t/cfn_job_template.rb', line 175

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


592
593
594
595
 
# File 'io_t/cfn_job_template.rb', line 592

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


180
181
182
 
# File 'io_t/cfn_job_template.rb', line 180

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


187
188
189
 
# File 'io_t/cfn_job_template.rb', line 187

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


132
133
134
 
# File 'io_t/cfn_job_template.rb', line 132

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String

A description of the job template.

Returns:

  • (String) 


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

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



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

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

#destination_package_versions ⇒ Array<String>?

The package version Amazon Resource Names (ARNs) that are installed on the device’s reserved named shadow ( $package ) when the job successfully completes.

Returns:

  • (Array<String>, nil) 


317
318
319
 
# File 'io_t/cfn_job_template.rb', line 317

def destination_package_versions()
  jsii_get_property("destinationPackageVersions")
end

#destination_package_versions=(value) ⇒ Object 



321
322
323
324
 
# File 'io_t/cfn_job_template.rb', line 321

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

#document ⇒ String?

The job document.

Returns:

  • (String, nil) 


329
330
331
 
# File 'io_t/cfn_job_template.rb', line 329

def document()
  jsii_get_property("document")
end

#document=(value) ⇒ Object 



333
334
335
336
 
# File 'io_t/cfn_job_template.rb', line 333

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

#document_source ⇒ String?

An S3 link, or S3 object URL, to the job document.

Returns:

  • (String, nil) 


341
342
343
 
# File 'io_t/cfn_job_template.rb', line 341

def document_source()
  jsii_get_property("documentSource")
end

#document_source=(value) ⇒ Object 



345
346
347
348
 
# File 'io_t/cfn_job_template.rb', line 345

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



192
193
194
 
# File 'io_t/cfn_job_template.rb', line 192

def env()
  jsii_get_property("env")
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:



605
606
607
608
609
 
# File 'io_t/cfn_job_template.rb', line 605

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:



616
617
618
619
 
# File 'io_t/cfn_job_template.rb', line 616

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

Parameters:



686
687
688
689
 
# File 'io_t/cfn_job_template.rb', line 686

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#job_arn ⇒ String?

The ARN of the job to use as the basis for the job template.

Returns:

  • (String, nil) 


353
354
355
 
# File 'io_t/cfn_job_template.rb', line 353

def job_arn()
  jsii_get_property("jobArn")
end

#job_arn=(value) ⇒ Object 



357
358
359
360
 
# File 'io_t/cfn_job_template.rb', line 357

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

#job_executions_retry_config ⇒ AWSCDK::IResolvable, ...

Allows you to create the criteria to retry a job.

Returns:



365
366
367
 
# File 'io_t/cfn_job_template.rb', line 365

def job_executions_retry_config()
  jsii_get_property("jobExecutionsRetryConfig")
end

#job_executions_retry_config=(value) ⇒ Object 



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

def job_executions_retry_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::IoT::CfnJobTemplate::JobExecutionsRetryConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3QuQ2ZuSm9iVGVtcGxhdGUuSm9iRXhlY3V0aW9uc1JldHJ5Q29uZmlnUHJvcGVydHkifV19fQ==")), "jobExecutionsRetryConfig") unless value.nil?
  jsii_set_property("jobExecutionsRetryConfig", value)
end

#job_executions_rollout_config ⇒ Object

Allows you to create a staged rollout of a job.

Returns:

  • (Object) 


269
270
271
 
# File 'io_t/cfn_job_template.rb', line 269

def job_executions_rollout_config()
  jsii_get_property("jobExecutionsRolloutConfig")
end

#job_executions_rollout_config=(value) ⇒ Object 



273
274
275
276
 
# File 'io_t/cfn_job_template.rb', line 273

def job_executions_rollout_config=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "jobExecutionsRolloutConfig")
  jsii_set_property("jobExecutionsRolloutConfig", value)
end

#job_template_id ⇒ String

A unique identifier for the job template.

Returns:

  • (String) 


281
282
283
 
# File 'io_t/cfn_job_template.rb', line 281

def job_template_id()
  jsii_get_property("jobTemplateId")
end

#job_template_id=(value) ⇒ Object 



285
286
287
288
 
# File 'io_t/cfn_job_template.rb', line 285

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

#job_template_ref ⇒ AWSCDK::Interfaces::AWSIot::JobTemplateReference

A reference to a JobTemplate resource.

Returns:



231
232
233
 
# File 'io_t/cfn_job_template.rb', line 231

def job_template_ref()
  jsii_get_property("jobTemplateRef")
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) 


144
145
146
 
# File 'io_t/cfn_job_template.rb', line 144

def logical_id()
  jsii_get_property("logicalId")
end

#maintenance_windows ⇒ AWSCDK::IResolvable, ...

An optional configuration within the SchedulingConfig to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.

Returns:



378
379
380
 
# File 'io_t/cfn_job_template.rb', line 378

def maintenance_windows()
  jsii_get_property("maintenanceWindows")
end

#maintenance_windows=(value) ⇒ Object 



382
383
384
385
 
# File 'io_t/cfn_job_template.rb', line 382

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


127
128
129
 
# File 'io_t/cfn_job_template.rb', line 127

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:



627
628
629
 
# File 'io_t/cfn_job_template.rb', line 627

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:



634
635
636
 
# File 'io_t/cfn_job_template.rb', line 634

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.



427
428
429
430
 
# File 'io_t/cfn_job_template.rb', line 427

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

#presigned_url_config ⇒ Object

Configuration for pre-signed S3 URLs.

Returns:

  • (Object) 


293
294
295
 
# File 'io_t/cfn_job_template.rb', line 293

def presigned_url_config()
  jsii_get_property("presignedUrlConfig")
end

#presigned_url_config=(value) ⇒ Object 



297
298
299
300
 
# File 'io_t/cfn_job_template.rb', line 297

def presigned_url_config=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "presignedUrlConfig")
  jsii_set_property("presignedUrlConfig", 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) 


163
164
165
 
# File 'io_t/cfn_job_template.rb', line 163

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:



645
646
647
648
 
# File 'io_t/cfn_job_template.rb', line 645

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


652
653
654
655
 
# File 'io_t/cfn_job_template.rb', line 652

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:



662
663
664
665
666
 
# File 'io_t/cfn_job_template.rb', line 662

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.



671
672
673
 
# File 'io_t/cfn_job_template.rb', line 671

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:



153
154
155
 
# File 'io_t/cfn_job_template.rb', line 153

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Metadata that can be used to manage the job template.

Returns:



390
391
392
 
# File 'io_t/cfn_job_template.rb', line 390

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



394
395
396
397
398
 
# File 'io_t/cfn_job_template.rb', line 394

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

#timeout_config ⇒ Object

Specifies the amount of time each device has to finish its execution of the job.

Returns:

  • (Object) 


305
306
307
 
# File 'io_t/cfn_job_template.rb', line 305

def timeout_config()
  jsii_get_property("timeoutConfig")
end

#timeout_config=(value) ⇒ Object 



309
310
311
312
 
# File 'io_t/cfn_job_template.rb', line 309

def timeout_config=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "timeoutConfig")
  jsii_set_property("timeoutConfig", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



403
404
405
 
# File 'io_t/cfn_job_template.rb', line 403

def to_string()
  jsii_call_method("toString", [])
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}) 


200
201
202
 
# File 'io_t/cfn_job_template.rb', line 200

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


210
211
212
 
# File 'io_t/cfn_job_template.rb', line 210

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


677
678
679
680
 
# File 'io_t/cfn_job_template.rb', line 677

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) 


416
417
418
419
420
421
 
# File 'io_t/cfn_job_template.rb', line 416

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