Class CfnJobTemplateProps
Properties for defining a CfnJobTemplate
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.AWS.IoT.dll
Syntax (csharp)
public class CfnJobTemplateProps : Object, ICfnJobTemplateProps
Syntax (vb)
Public Class CfnJobTemplateProps
Inherits Object
Implements ICfnJobTemplateProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-jobtemplate.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoT;
var abortConfig;
var jobExecutionsRolloutConfig;
var presignedUrlConfig;
var timeoutConfig;
var cfnJobTemplateProps = new CfnJobTemplateProps {
Description = "description",
JobTemplateId = "jobTemplateId",
// the properties below are optional
AbortConfig = abortConfig,
Document = "document",
DocumentSource = "documentSource",
JobArn = "jobArn",
JobExecutionsRetryConfig = new JobExecutionsRetryConfigProperty {
RetryCriteriaList = new [] { new RetryCriteriaProperty {
FailureType = "failureType",
NumberOfRetries = 123
} }
},
JobExecutionsRolloutConfig = jobExecutionsRolloutConfig,
MaintenanceWindows = new [] { new MaintenanceWindowProperty {
DurationInMinutes = 123,
StartTime = "startTime"
} },
PresignedUrlConfig = presignedUrlConfig,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TimeoutConfig = timeoutConfig
};
Synopsis
Constructors
CfnJobTemplateProps() |
Properties
AbortConfig | The criteria that determine when and how a job abort takes place. |
Description | A description of the job template. |
Document | The job document. |
DocumentSource | An S3 link to the job document to use in the template. |
JobArn | The ARN of the job to use as the basis for the job template. |
JobExecutionsRetryConfig | Allows you to create the criteria to retry a job. |
JobExecutionsRolloutConfig | Allows you to create a staged rollout of a job. |
JobTemplateId | A unique identifier for the job template. |
MaintenanceWindows | 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. |
PresignedUrlConfig | Configuration for pre-signed S3 URLs. |
Tags | Metadata that can be used to manage the job template. |
TimeoutConfig | Specifies the amount of time each device has to finish its execution of the job. |
Constructors
CfnJobTemplateProps()
public CfnJobTemplateProps()
Properties
AbortConfig
The criteria that determine when and how a job abort takes place.
public object AbortConfig { get; set; }
Property Value
System.Object
Remarks
Description
A description of the job template.
public string Description { get; set; }
Property Value
System.String
Remarks
Document
The job document.
public string Document { get; set; }
Property Value
System.String
Remarks
Required if you don't specify a value for documentSource
.
DocumentSource
An S3 link to the job document to use in the template.
public string DocumentSource { get; set; }
Property Value
System.String
Remarks
Required if you don't specify a value for document
.
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.
JobArn
The ARN of the job to use as the basis for the job template.
public string JobArn { get; set; }
Property Value
System.String
Remarks
JobExecutionsRetryConfig
Allows you to create the criteria to retry a job.
public object JobExecutionsRetryConfig { get; set; }
Property Value
System.Object
Remarks
JobExecutionsRolloutConfig
Allows you to create a staged rollout of a job.
public object JobExecutionsRolloutConfig { get; set; }
Property Value
System.Object
Remarks
JobTemplateId
A unique identifier for the job template.
public string JobTemplateId { get; set; }
Property Value
System.String
Remarks
We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
MaintenanceWindows
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.
public object MaintenanceWindows { get; set; }
Property Value
System.Object
Remarks
PresignedUrlConfig
Configuration for pre-signed S3 URLs.
public object PresignedUrlConfig { get; set; }
Property Value
System.Object
Remarks
Tags
Metadata that can be used to manage the job template.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
TimeoutConfig
Specifies the amount of time each device has to finish its execution of the job.
public object TimeoutConfig { get; set; }
Property Value
System.Object
Remarks
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
.