CfnJobTemplate

class aws_cdk.aws_iot.CfnJobTemplate(scope, id, *, description, job_template_id, abort_config=None, destination_package_versions=None, document=None, document_source=None, job_arn=None, job_executions_retry_config=None, job_executions_rollout_config=None, maintenance_windows=None, presigned_url_config=None, tags=None, timeout_config=None)

Bases: CfnResource

Represents a job template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-jobtemplate.html

CloudformationResource:

AWS::IoT::JobTemplate

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iot as iot

# abort_config: Any
# job_executions_rollout_config: Any
# presigned_url_config: Any
# timeout_config: Any

cfn_job_template = iot.CfnJobTemplate(self, "MyCfnJobTemplate",
    description="description",
    job_template_id="jobTemplateId",

    # the properties below are optional
    abort_config=abort_config,
    destination_package_versions=["destinationPackageVersions"],
    document="document",
    document_source="documentSource",
    job_arn="jobArn",
    job_executions_retry_config=iot.CfnJobTemplate.JobExecutionsRetryConfigProperty(
        retry_criteria_list=[iot.CfnJobTemplate.RetryCriteriaProperty(
            failure_type="failureType",
            number_of_retries=123
        )]
    ),
    job_executions_rollout_config=job_executions_rollout_config,
    maintenance_windows=[iot.CfnJobTemplate.MaintenanceWindowProperty(
        duration_in_minutes=123,
        start_time="startTime"
    )],
    presigned_url_config=presigned_url_config,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    timeout_config=timeout_config
)
Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • description (str) – A description of the job template.

  • job_template_id (str) – A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, “-”, and “_” are valid for use here.

  • abort_config (Any) – The criteria that determine when and how a job abort takes place.

  • destination_package_versions (Optional[Sequence[str]]) – The package version Amazon Resource Names (ARNs) that are installed on the device’s reserved named shadow ( $package ) when the job successfully completes. Note: Up to 25 package version ARNS are allowed.

  • document (Optional[str]) – The job document. Required if you don’t specify a value for documentSource .

  • document_source (Optional[str]) – An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don’t specify a value for document . For example, --document-source https://s3. *region-code* .amazonaws.com/example-firmware/device-firmware.1.0 For more information, see Methods for accessing a bucket .

  • job_arn (Optional[str]) – The ARN of the job to use as the basis for the job template.

  • job_executions_retry_config (Union[IResolvable, JobExecutionsRetryConfigProperty, Dict[str, Any], None]) – Allows you to create the criteria to retry a job.

  • job_executions_rollout_config (Any) – Allows you to create a staged rollout of a job.

  • maintenance_windows (Union[IResolvable, Sequence[Union[IResolvable, MaintenanceWindowProperty, Dict[str, Any]]], None]) – 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.

  • presigned_url_config (Any) – Configuration for pre-signed S3 URLs.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Metadata that can be used to manage the job template.

  • timeout_config (Any) – Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS . If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

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:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

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:

  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

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:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

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:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::IoT::JobTemplate'
abort_config

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

attr_arn

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

CloudformationAttribute:

Arn

cfn_options

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

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description

A description of the job template.

destination_package_versions

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

document

The job document.

document_source

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

job_arn

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

job_executions_retry_config

Allows you to create the criteria to retry a job.

job_executions_rollout_config

Allows you to create a staged rollout of a job.

job_template_id

A unique identifier for the job template.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

maintenance_windows

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.

node

The tree node.

presigned_url_config

Configuration for pre-signed S3 URLs.

ref

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

stack

The stack in which this element is defined.

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

tags

Tag Manager which manages the tags for this resource.

tags_raw

Metadata that can be used to manage the job template.

timeout_config

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

AbortConfigProperty

class CfnJobTemplate.AbortConfigProperty(*, criteria_list)

Bases: object

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

Parameters:

criteria_list (Union[IResolvable, Sequence[Union[IResolvable, AbortCriteriaProperty, Dict[str, Any]]]]) – The list of criteria that determine when and how to abort the job.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iot as iot

abort_config_property = iot.CfnJobTemplate.AbortConfigProperty(
    criteria_list=[iot.CfnJobTemplate.AbortCriteriaProperty(
        action="action",
        failure_type="failureType",
        min_number_of_executed_things=123,
        threshold_percentage=123
    )]
)

Attributes

criteria_list

The list of criteria that determine when and how to abort the job.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortconfig.html#cfn-iot-jobtemplate-abortconfig-criterialist

AbortCriteriaProperty

class CfnJobTemplate.AbortCriteriaProperty(*, action, failure_type, min_number_of_executed_things, threshold_percentage)

Bases: object

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

Parameters:

  • action (str) – The type of job action to take to initiate the job abort.

  • failure_type (str) – The type of job execution failures that can initiate a job abort.

  • min_number_of_executed_things (Union[int, float]) – The minimum number of things which must receive job execution notifications before the job can be aborted.

  • threshold_percentage (Union[int, float]) – The minimum percentage of job execution failures that must occur to initiate the job abort. AWS IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortcriteria.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iot as iot

abort_criteria_property = iot.CfnJobTemplate.AbortCriteriaProperty(
    action="action",
    failure_type="failureType",
    min_number_of_executed_things=123,
    threshold_percentage=123
)

Attributes

action

The type of job action to take to initiate the job abort.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortcriteria.html#cfn-iot-jobtemplate-abortcriteria-action

failure_type

The type of job execution failures that can initiate a job abort.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortcriteria.html#cfn-iot-jobtemplate-abortcriteria-failuretype

min_number_of_executed_things

The minimum number of things which must receive job execution notifications before the job can be aborted.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortcriteria.html#cfn-iot-jobtemplate-abortcriteria-minnumberofexecutedthings

threshold_percentage

The minimum percentage of job execution failures that must occur to initiate the job abort.

AWS IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortcriteria.html#cfn-iot-jobtemplate-abortcriteria-thresholdpercentage

ExponentialRolloutRateProperty

class CfnJobTemplate.ExponentialRolloutRateProperty(*, base_rate_per_minute, increment_factor, rate_increase_criteria)

Bases: object

Allows you to create an exponential rate of rollout for a job.

Parameters:

  • base_rate_per_minute (Union[int, float]) – The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.

  • increment_factor (Union[int, float]) – The exponential factor to increase the rate of rollout for a job. AWS IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

  • rate_increase_criteria (Union[IResolvable, RateIncreaseCriteriaProperty, Dict[str, Any]]) – The criteria to initiate the increase in rate of rollout for a job.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-exponentialrolloutrate.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iot as iot

exponential_rollout_rate_property = iot.CfnJobTemplate.ExponentialRolloutRateProperty(
    base_rate_per_minute=123,
    increment_factor=123,
    rate_increase_criteria=iot.CfnJobTemplate.RateIncreaseCriteriaProperty(
        number_of_notified_things=123,
        number_of_succeeded_things=123
    )
)

Attributes

base_rate_per_minute

The minimum number of things that will be notified of a pending job, per minute at the start of job rollout.

This parameter allows you to define the initial rate of rollout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-exponentialrolloutrate.html#cfn-iot-jobtemplate-exponentialrolloutrate-baserateperminute

increment_factor

The exponential factor to increase the rate of rollout for a job.

AWS IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-exponentialrolloutrate.html#cfn-iot-jobtemplate-exponentialrolloutrate-incrementfactor

rate_increase_criteria

The criteria to initiate the increase in rate of rollout for a job.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-exponentialrolloutrate.html#cfn-iot-jobtemplate-exponentialrolloutrate-rateincreasecriteria

JobExecutionsRetryConfigProperty

class CfnJobTemplate.JobExecutionsRetryConfigProperty(*, retry_criteria_list=None)

Bases: object

The configuration that determines how many retries are allowed for each failure type for a job.

Parameters:

retry_criteria_list (Union[IResolvable, Sequence[Union[IResolvable, RetryCriteriaProperty, Dict[str, Any]]], None]) – The list of criteria that determines how many retries are allowed for each failure type for a job.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-jobexecutionsretryconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iot as iot

job_executions_retry_config_property = iot.CfnJobTemplate.JobExecutionsRetryConfigProperty(
    retry_criteria_list=[iot.CfnJobTemplate.RetryCriteriaProperty(
        failure_type="failureType",
        number_of_retries=123
    )]
)

Attributes

retry_criteria_list

The list of criteria that determines how many retries are allowed for each failure type for a job.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-jobexecutionsretryconfig.html#cfn-iot-jobtemplate-jobexecutionsretryconfig-retrycriterialist

JobExecutionsRolloutConfigProperty

class CfnJobTemplate.JobExecutionsRolloutConfigProperty(*, exponential_rollout_rate=None, maximum_per_minute=None)

Bases: object

Allows you to create a staged rollout of a job.

Parameters:

  • exponential_rollout_rate (Union[IResolvable, ExponentialRolloutRateProperty, Dict[str, Any], None]) – The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.

  • maximum_per_minute (Union[int, float, None]) – The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-jobexecutionsrolloutconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iot as iot

job_executions_rollout_config_property = iot.CfnJobTemplate.JobExecutionsRolloutConfigProperty(
    exponential_rollout_rate=iot.CfnJobTemplate.ExponentialRolloutRateProperty(
        base_rate_per_minute=123,
        increment_factor=123,
        rate_increase_criteria=iot.CfnJobTemplate.RateIncreaseCriteriaProperty(
            number_of_notified_things=123,
            number_of_succeeded_things=123
        )
    ),
    maximum_per_minute=123
)

Attributes

exponential_rollout_rate

The rate of increase for a job rollout.

This parameter allows you to define an exponential rate for a job rollout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-jobexecutionsrolloutconfig.html#cfn-iot-jobtemplate-jobexecutionsrolloutconfig-exponentialrolloutrate

maximum_per_minute

The maximum number of things that will be notified of a pending job, per minute.

This parameter allows you to create a staged rollout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-jobexecutionsrolloutconfig.html#cfn-iot-jobtemplate-jobexecutionsrolloutconfig-maximumperminute

MaintenanceWindowProperty

class CfnJobTemplate.MaintenanceWindowProperty(*, duration_in_minutes=None, start_time=None)

Bases: object

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.

Parameters:

  • duration_in_minutes (Union[int, float, None]) – Displays the duration of the next maintenance window.

  • start_time (Optional[str]) – Displays the start time of the next maintenance window.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-maintenancewindow.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iot as iot

maintenance_window_property = iot.CfnJobTemplate.MaintenanceWindowProperty(
    duration_in_minutes=123,
    start_time="startTime"
)

Attributes

duration_in_minutes

Displays the duration of the next maintenance window.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-maintenancewindow.html#cfn-iot-jobtemplate-maintenancewindow-durationinminutes

start_time

Displays the start time of the next maintenance window.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-maintenancewindow.html#cfn-iot-jobtemplate-maintenancewindow-starttime

PresignedUrlConfigProperty

class CfnJobTemplate.PresignedUrlConfigProperty(*, role_arn, expires_in_sec=None)

Bases: object

Configuration for pre-signed S3 URLs.

Parameters:

  • role_arn (str) – The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files. .. epigraph:: For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the AWS IoT Core developer guide .

  • expires_in_sec (Union[int, float, None]) – How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-presignedurlconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iot as iot

presigned_url_config_property = iot.CfnJobTemplate.PresignedUrlConfigProperty(
    role_arn="roleArn",

    # the properties below are optional
    expires_in_sec=123
)

Attributes

expires_in_sec

How long (in seconds) pre-signed URLs are valid.

Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-presignedurlconfig.html#cfn-iot-jobtemplate-presignedurlconfig-expiresinsec

role_arn

The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored.

The role must also grant permission for IoT to download the files. .. epigraph:

For information about addressing the confused deputy problem, see `cross-service confused deputy prevention <https://docs.aws.amazon.com/iot/latest/developerguide/cross-service-confused-deputy-prevention.html>`_ in the *AWS IoT Core developer guide* .
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-presignedurlconfig.html#cfn-iot-jobtemplate-presignedurlconfig-rolearn

RateIncreaseCriteriaProperty

class CfnJobTemplate.RateIncreaseCriteriaProperty(*, number_of_notified_things=None, number_of_succeeded_things=None)

Bases: object

Allows you to define a criteria to initiate the increase in rate of rollout for a job.

Parameters:

  • number_of_notified_things (Union[int, float, None]) – The threshold for number of notified things that will initiate the increase in rate of rollout.

  • number_of_succeeded_things (Union[int, float, None]) – The threshold for number of succeeded things that will initiate the increase in rate of rollout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-rateincreasecriteria.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iot as iot

rate_increase_criteria_property = iot.CfnJobTemplate.RateIncreaseCriteriaProperty(
    number_of_notified_things=123,
    number_of_succeeded_things=123
)

Attributes

number_of_notified_things

The threshold for number of notified things that will initiate the increase in rate of rollout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-rateincreasecriteria.html#cfn-iot-jobtemplate-rateincreasecriteria-numberofnotifiedthings

number_of_succeeded_things

The threshold for number of succeeded things that will initiate the increase in rate of rollout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-rateincreasecriteria.html#cfn-iot-jobtemplate-rateincreasecriteria-numberofsucceededthings

RetryCriteriaProperty

class CfnJobTemplate.RetryCriteriaProperty(*, failure_type=None, number_of_retries=None)

Bases: object

The criteria that determines how many retries are allowed for each failure type for a job.

Parameters:

  • failure_type (Optional[str]) – The type of job execution failures that can initiate a job retry.

  • number_of_retries (Union[int, float, None]) – The number of retries allowed for a failure type for the job.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-retrycriteria.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iot as iot

retry_criteria_property = iot.CfnJobTemplate.RetryCriteriaProperty(
    failure_type="failureType",
    number_of_retries=123
)

Attributes

failure_type

The type of job execution failures that can initiate a job retry.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-retrycriteria.html#cfn-iot-jobtemplate-retrycriteria-failuretype

number_of_retries

The number of retries allowed for a failure type for the job.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-retrycriteria.html#cfn-iot-jobtemplate-retrycriteria-numberofretries

TimeoutConfigProperty

class CfnJobTemplate.TimeoutConfigProperty(*, in_progress_timeout_in_minutes)

Bases: object

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

A timer is started when the job execution status is set to IN_PROGRESS . If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT .

Parameters:

in_progress_timeout_in_minutes (Union[int, float]) – Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can’t be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-timeoutconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iot as iot

timeout_config_property = iot.CfnJobTemplate.TimeoutConfigProperty(
    in_progress_timeout_in_minutes=123
)

Attributes

in_progress_timeout_in_minutes

Specifies the amount of time, in minutes, this device has to finish execution of this job.

The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can’t be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-timeoutconfig.html#cfn-iot-jobtemplate-timeoutconfig-inprogresstimeoutinminutes