CfnJobProps
- class aws_cdk.aws_iot.CfnJobProps(*, 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:
objectProperties for defining a
CfnJob.- Parameters:
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.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html
- 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_props = iot.CfnJobProps( 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 ) )
Attributes
- abort_config
The criteria that determine when and how a job abort takes place.
- 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.
Required if you don’t specify a value for documentSource.
- 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.
The link is an Amazon S3 object URL and is required if you don’t specify a value for document.
- 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.
We recommend using a UUID. Alpha-numeric characters, ‘-’ and ‘_’ are valid for use here.
- job_template_arn
The ARN of the job template used to create the job.
- presigned_url_config
Configuration for pre-signed S3 URLs.
- 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.
- 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.