CfnJobTemplatePropsMixin

class aws_cdk.mixins_preview.aws_iot.mixins.CfnJobTemplatePropsMixin(props, *, strategy=None)

Bases: Mixin

Represents a job template.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-jobtemplate.html
CloudformationResource:: AWS::IoT::JobTemplate
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_iot import mixins as iot_mixins

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

cfn_job_template_props_mixin = iot_mixins.CfnJobTemplatePropsMixin(iot_mixins.CfnJobTemplateMixinProps(
    abort_config=abort_config,
    description="description",
    destination_package_versions=["destinationPackageVersions"],
    document="document",
    document_source="documentSource",
    job_arn="jobArn",
    job_executions_retry_config=iot_mixins.CfnJobTemplatePropsMixin.JobExecutionsRetryConfigProperty(
        retry_criteria_list=[iot_mixins.CfnJobTemplatePropsMixin.RetryCriteriaProperty(
            failure_type="failureType",
            number_of_retries=123
        )]
    ),
    job_executions_rollout_config=job_executions_rollout_config,
    job_template_id="jobTemplateId",
    maintenance_windows=[iot_mixins.CfnJobTemplatePropsMixin.MaintenanceWindowProperty(
        duration_in_minutes=123,
        start_time="startTime"
    )],
    presigned_url_config=presigned_url_config,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    timeout_config=timeout_config
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoT::JobTemplate.

Parameters:

props (Union[CfnJobTemplateMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['abortConfig', 'description', 'destinationPackageVersions', 'document', 'documentSource', 'jobArn', 'jobExecutionsRetryConfig', 'jobExecutionsRolloutConfig', 'jobTemplateId', 'maintenanceWindows', 'presignedUrlConfig', 'tags', 'timeoutConfig']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AbortConfigProperty

class CfnJobTemplatePropsMixin.AbortConfigProperty(*, criteria_list=None)

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]]], None]) – 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.mixins_preview.aws_iot import mixins as iot_mixins

abort_config_property = iot_mixins.CfnJobTemplatePropsMixin.AbortConfigProperty(
    criteria_list=[iot_mixins.CfnJobTemplatePropsMixin.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 CfnJobTemplatePropsMixin.AbortCriteriaProperty(*, action=None, failure_type=None, min_number_of_executed_things=None, threshold_percentage=None)

Bases: object

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

Parameters:

action (Optional[str]) – The type of job action to take to initiate the job abort.
failure_type (Optional[str]) – The type of job execution failures that can initiate a job abort.
min_number_of_executed_things (Union[int, float, None]) – The minimum number of things which must receive job execution notifications before the job can be aborted.
threshold_percentage (Union[int, float, None]) – 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.mixins_preview.aws_iot import mixins as iot_mixins

abort_criteria_property = iot_mixins.CfnJobTemplatePropsMixin.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 CfnJobTemplatePropsMixin.ExponentialRolloutRateProperty(*, base_rate_per_minute=None, increment_factor=None, rate_increase_criteria=None)

Bases: object

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

Parameters:

base_rate_per_minute (Union[int, float, None]) – 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, None]) – 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], None]) – 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.mixins_preview.aws_iot import mixins as iot_mixins

exponential_rollout_rate_property = iot_mixins.CfnJobTemplatePropsMixin.ExponentialRolloutRateProperty(
    base_rate_per_minute=123,
    increment_factor=123,
    rate_increase_criteria=iot_mixins.CfnJobTemplatePropsMixin.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 CfnJobTemplatePropsMixin.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.mixins_preview.aws_iot import mixins as iot_mixins

job_executions_retry_config_property = iot_mixins.CfnJobTemplatePropsMixin.JobExecutionsRetryConfigProperty(
    retry_criteria_list=[iot_mixins.CfnJobTemplatePropsMixin.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 CfnJobTemplatePropsMixin.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.mixins_preview.aws_iot import mixins as iot_mixins

job_executions_rollout_config_property = iot_mixins.CfnJobTemplatePropsMixin.JobExecutionsRolloutConfigProperty(
    exponential_rollout_rate=iot_mixins.CfnJobTemplatePropsMixin.ExponentialRolloutRateProperty(
        base_rate_per_minute=123,
        increment_factor=123,
        rate_increase_criteria=iot_mixins.CfnJobTemplatePropsMixin.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 CfnJobTemplatePropsMixin.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.mixins_preview.aws_iot import mixins as iot_mixins

maintenance_window_property = iot_mixins.CfnJobTemplatePropsMixin.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 CfnJobTemplatePropsMixin.PresignedUrlConfigProperty(*, expires_in_sec=None, role_arn=None)

Bases: object

Configuration for pre-signed S3 URLs.

Parameters:

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.
role_arn (Optional[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 .

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.mixins_preview.aws_iot import mixins as iot_mixins

presigned_url_config_property = iot_mixins.CfnJobTemplatePropsMixin.PresignedUrlConfigProperty(
    expires_in_sec=123,
    role_arn="roleArn"
)

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 CfnJobTemplatePropsMixin.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.mixins_preview.aws_iot import mixins as iot_mixins

rate_increase_criteria_property = iot_mixins.CfnJobTemplatePropsMixin.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 CfnJobTemplatePropsMixin.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.mixins_preview.aws_iot import mixins as iot_mixins

retry_criteria_property = iot_mixins.CfnJobTemplatePropsMixin.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 CfnJobTemplatePropsMixin.TimeoutConfigProperty(*, in_progress_timeout_in_minutes=None)

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, None]) – 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.mixins_preview.aws_iot import mixins as iot_mixins

timeout_config_property = iot_mixins.CfnJobTemplatePropsMixin.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