CfnJob

class aws_cdk.aws_iot.CfnJob(scope, id, *, job_id, targets, abort_config=None, description=None, destination_package_versions=None, document=None, document_parameters=None, document_source=None, job_executions_retry_config=None, job_executions_rollout_config=None, job_template_arn=None, presigned_url_config=None, scheduling_config=None, tags=None, target_selection=None, timeout_config=None)

Bases: CfnResource

Use the AWS::IoT::Job resource to declare an AWS IoT job.

A job can be used to define a set of remote operations that are sent to and run on one or more devices (things or thing groups) connected to AWS IoT.

See:

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

CloudformationResource:

AWS::IoT::Job

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# 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

cfn_job = iot.CfnJob(self, "MyCfnJob",
    job_id="jobId",
    targets=["targets"],

    # the properties below are optional
    abort_config=iot.CfnJob.AbortConfigProperty(
        criteria_list=[iot.CfnJob.AbortCriteriaProperty(
            action="action",
            failure_type="failureType",
            min_number_of_executed_things=123,
            threshold_percentage=123
        )]
    ),
    description="description",
    destination_package_versions=["destinationPackageVersions"],
    document="document",
    document_parameters={
        "document_parameters_key": "documentParameters"
    },
    document_source="documentSource",
    job_executions_retry_config=iot.CfnJob.JobExecutionsRetryConfigProperty(
        criteria_list=[iot.CfnJob.RetryCriteriaProperty(
            failure_type="failureType",
            number_of_retries=123
        )]
    ),
    job_executions_rollout_config=iot.CfnJob.JobExecutionsRolloutConfigProperty(
        exponential_rate=iot.CfnJob.ExponentialRolloutRateProperty(
            base_rate_per_minute=123,
            increment_factor=123,
            rate_increase_criteria=iot.CfnJob.RateIncreaseCriteriaProperty(
                number_of_notified_things=123,
                number_of_succeeded_things=123
            )
        ),
        maximum_per_minute=123
    ),
    job_template_arn="jobTemplateArn",
    presigned_url_config=iot.CfnJob.PresignedUrlConfigProperty(
        expires_in_sec=123,
        role_arn="roleArn"
    ),
    scheduling_config=iot.CfnJob.SchedulingConfigProperty(
        end_behavior="endBehavior",
        end_time="endTime",
        maintenance_windows=[iot.CfnJob.MaintenanceWindowProperty(
            duration_in_minutes=123,
            start_time="startTime"
        )],
        start_time="startTime"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    target_selection="targetSelection",
    timeout_config=iot.CfnJob.TimeoutConfigProperty(
        in_progress_timeout_in_minutes=123
    )
)

Create a new AWS::IoT::Job.

Parameters:

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

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

  • job_id (str) – A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, ‘-’ and ‘_’ are valid for use here.

  • targets (Sequence[str]) – A list of things and thing groups to which the job should be sent.

  • abort_config (Union[IResolvable, AbortConfigProperty, Dict[str, Any], None]) – The criteria that determine when and how a job abort takes place.

  • description (Optional[str]) – A short text description of the job.

  • destination_package_versions (Optional[Sequence[str]]) – The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.

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

  • document_parameters (Union[IResolvable, Mapping[str, str], None]) – Parameters of an Amazon Web Services managed template that you can specify to create the job document.

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

  • job_executions_retry_config (Union[IResolvable, JobExecutionsRetryConfigProperty, Dict[str, Any], None]) – The configuration that determines how many retries are allowed for each failure type for a job.

  • job_executions_rollout_config (Union[IResolvable, JobExecutionsRolloutConfigProperty, Dict[str, Any], None]) – Allows you to create a staged rollout of a job.

  • job_template_arn (Optional[str]) – The ARN of the job template used to create the job.

  • presigned_url_config (Union[IResolvable, PresignedUrlConfigProperty, Dict[str, Any], None]) – Configuration for pre-signed S3 URLs.

  • scheduling_config (Union[IResolvable, SchedulingConfigProperty, Dict[str, Any], None]) – Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group.

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

  • target_selection (Optional[str]) – Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT).

  • timeout_config (Union[IResolvable, TimeoutConfigProperty, Dict[str, Any], None]) – Specifies the amount of time each device has to finish its execution of the job.

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)

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

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

Parameters:

target (CfnResource)

Deprecated:

Use addResourceDependency instead.

Stability:

deprecated

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.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

Parameters:

target (CfnResource)

Deprecated:

Use addResourceDependency instead.

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

add_resource_dependency(target, reason=None)

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.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

Parameters:
Return type:

None

apply_cross_stack_reference_strength(strength)

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:

strength (ReferenceStrength) –

  • The reference strength to use for this resource.

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

cfn_property_name(cdk_property_name)
Parameters:

cdk_property_name (str)

Return type:

Optional[str]

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 and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

Return type:

List[Union[Stack, 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)

(deprecated) 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)

Deprecated:

Use removeResourceDependency instead

Stability:

deprecated

Return type:

None

remove_resource_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

with_(*mixins)

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 (IMixin)

Return type:

IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::IoT::Job'
abort_config

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

attr_arn

The Amazon Resource Name (ARN) of the job.

CloudformationAttribute:

Arn

attr_created_at

The time when the job was created, in ISO 8601 date-time format.

CloudformationAttribute:

CreatedAt

cdk_tag_manager

Tag Manager which manages the tags for this resource.

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 short text description of the job.

destination_package_versions

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.

document

The job document.

document_parameters

Parameters of an Amazon Web Services managed template that you can specify to create the job document.

document_source

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

env
job_executions_retry_config

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

job_executions_rollout_config

Allows you to create a staged rollout of a job.

job_id

A job identifier which must be unique for your AWS account.

job_ref

A reference to a Job resource.

job_template_arn

The ARN of the job template used to create the job.

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.

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

scheduling_config

Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group.

stack

The stack in which this element is defined.

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

tags

Metadata which can be used to manage the job.

target_selection

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT).

targets

A list of things and thing groups to which the job should be sent.

timeout_config

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

Static Methods

classmethod arn_for_job(resource)
Parameters:

resource (IJobRef)

Return type:

str

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_job(x)

Checks whether the given object is a CfnJob.

Parameters:

x (Any)

Return type:

bool

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 CfnJob.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-job-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.CfnJob.AbortConfigProperty(
    criteria_list=[iot.CfnJob.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-job-abortconfig.html#cfn-iot-job-abortconfig-criterialist

AbortCriteriaProperty

class CfnJob.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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-job-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.CfnJob.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-job-abortcriteria.html#cfn-iot-job-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-job-abortcriteria.html#cfn-iot-job-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-job-abortcriteria.html#cfn-iot-job-abortcriteria-minnumberofexecutedthings

threshold_percentage

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

See:

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

ExponentialRolloutRateProperty

class CfnJob.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.

  • increment_factor (Union[int, float]) – The exponential factor to increase the rate of rollout for a job.

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-job-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.CfnJob.ExponentialRolloutRateProperty(
    base_rate_per_minute=123,
    increment_factor=123,
    rate_increase_criteria=iot.CfnJob.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.

See:

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

increment_factor

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

See:

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

rate_increase_criteria

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

See:

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

JobExecutionsRetryConfigProperty

class CfnJob.JobExecutionsRetryConfigProperty(*, criteria_list)

Bases: object

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

Parameters:

criteria_list (Union[IResolvable, Sequence[Union[IResolvable, RetryCriteriaProperty, Dict[str, Any]]]]) – 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-job-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.CfnJob.JobExecutionsRetryConfigProperty(
    criteria_list=[iot.CfnJob.RetryCriteriaProperty(
        failure_type="failureType",
        number_of_retries=123
    )]
)

Attributes

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-job-jobexecutionsretryconfig.html#cfn-iot-job-jobexecutionsretryconfig-criterialist

JobExecutionsRolloutConfigProperty

class CfnJob.JobExecutionsRolloutConfigProperty(*, exponential_rate=None, maximum_per_minute=None)

Bases: object

Allows you to create a staged rollout of a job.

Parameters:

  • exponential_rate (Union[IResolvable, ExponentialRolloutRateProperty, Dict[str, Any], None]) – Allows you to create an exponential rate of rollout for a job.

  • 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-job-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.CfnJob.JobExecutionsRolloutConfigProperty(
    exponential_rate=iot.CfnJob.ExponentialRolloutRateProperty(
        base_rate_per_minute=123,
        increment_factor=123,
        rate_increase_criteria=iot.CfnJob.RateIncreaseCriteriaProperty(
            number_of_notified_things=123,
            number_of_succeeded_things=123
        )
    ),
    maximum_per_minute=123
)

Attributes

exponential_rate

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

See:

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

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-job-jobexecutionsrolloutconfig.html#cfn-iot-job-jobexecutionsrolloutconfig-maximumperminute

MaintenanceWindowProperty

class CfnJob.MaintenanceWindowProperty(*, duration_in_minutes, start_time)

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]) – Displays the duration of the next maintenance window.

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-job-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.CfnJob.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-job-maintenancewindow.html#cfn-iot-job-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-job-maintenancewindow.html#cfn-iot-job-maintenancewindow-starttime

PresignedUrlConfigProperty

class CfnJob.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.

  • role_arn (Optional[str]) – The ARN of an IAM role that grants permission to download files from the S3 bucket where the job data/updates are stored.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-job-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.CfnJob.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.

See:

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

role_arn

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

See:

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

RateIncreaseCriteriaProperty

class CfnJob.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-job-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.CfnJob.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-job-rateincreasecriteria.html#cfn-iot-job-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-job-rateincreasecriteria.html#cfn-iot-job-rateincreasecriteria-numberofsucceededthings

RetryCriteriaProperty

class CfnJob.RetryCriteriaProperty(*, failure_type, number_of_retries)

Bases: object

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

Parameters:

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

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-job-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.CfnJob.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-job-retrycriteria.html#cfn-iot-job-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-job-retrycriteria.html#cfn-iot-job-retrycriteria-numberofretries

SchedulingConfigProperty

class CfnJob.SchedulingConfigProperty(*, end_behavior=None, end_time=None, maintenance_windows=None, start_time=None)

Bases: object

Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group.

Parameters:

  • end_behavior (Optional[str]) – Specifies the end behavior for all job executions after a job reaches the selected endTime.

  • end_time (Optional[str]) – The time a job will stop rollout of the job document to all devices in the target group for 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.

  • start_time (Optional[str]) – The time a job will begin rollout of the job document to all devices in the target group for a job.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-job-schedulingconfig.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

scheduling_config_property = iot.CfnJob.SchedulingConfigProperty(
    end_behavior="endBehavior",
    end_time="endTime",
    maintenance_windows=[iot.CfnJob.MaintenanceWindowProperty(
        duration_in_minutes=123,
        start_time="startTime"
    )],
    start_time="startTime"
)

Attributes

end_behavior

Specifies the end behavior for all job executions after a job reaches the selected endTime.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-job-schedulingconfig.html#cfn-iot-job-schedulingconfig-endbehavior

end_time

The time a job will stop rollout of the job document to all devices in the target group for a job.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-job-schedulingconfig.html#cfn-iot-job-schedulingconfig-endtime

maintenance_windows

An optional configuration within the SchedulingConfig to setup a recurring maintenance window.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-job-schedulingconfig.html#cfn-iot-job-schedulingconfig-maintenancewindows

start_time

The time a job will begin rollout of the job document to all devices in the target group for a job.

See:

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

TimeoutConfigProperty

class CfnJob.TimeoutConfigProperty(*, in_progress_timeout_in_minutes=None)

Bases: object

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

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-job-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.CfnJob.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).

See:

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