CfnJobTemplateProps

class aws_cdk.aws_iot.CfnJobTemplateProps(*, description, job_template_id, abort_config=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: object

Properties for defining a CfnJobTemplate.

Parameters:

  • 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 (Optional[Any]) – The criteria that determine when and how a job abort takes place.

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

  • document_source (Optional[str]) – An S3 link to the job document to use in the template. Required if you don’t specify a value for document . .. epigraph:: If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document. The placeholder link is of the following form: ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/ *bucket* / *key* } where bucket is your bucket name and key is the object in the bucket to which you are linking.

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

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

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

cfn_job_template_props = iot.CfnJobTemplateProps(
    description="description",
    job_template_id="jobTemplateId",

    # the properties below are optional
    abort_config=abort_config,
    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
)

Attributes

abort_config

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

Link:

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

description

A description of the job template.

Link:

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

document

The job document.

Required if you don’t specify a value for documentSource .

Link:

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

document_source

An S3 link to the job document to use in the template.

Required if you don’t specify a value for document . .. epigraph:

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

``${aws:iot:s3-presigned-url:https://s3.amazonaws.com/ *bucket* / *key* }``

where *bucket* is your bucket name and *key* is the object in the bucket to which you are linking.
Link:

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

job_arn

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

Link:

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

job_executions_retry_config

Allows you to create the criteria to retry a job.

Link:

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

job_executions_rollout_config

Allows you to create a staged rollout of a job.

Link:

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

job_template_id

A unique identifier for the job template.

We recommend using a UUID. Alpha-numeric characters, “-”, and “_” are valid for use here.

Link:

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

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.

Link:

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

presigned_url_config

Configuration for pre-signed S3 URLs.

Link:

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

tags

Metadata that can be used to manage the job template.

Link:

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

timeout_config

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 .

Link:

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