Class CfnJobTemplate

A CloudFormation AWS::IoT::JobTemplate.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnJobTemplate

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.IoT

Assembly: Amazon.CDK.AWS.IoT.dll

Syntax (csharp)

public class CfnJobTemplate : CfnResource, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnJobTemplate
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable

Remarks

Represents a job template.

CloudformationResource: AWS::IoT::JobTemplate

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 cfnJobTemplate = new CfnJobTemplate(this, "MyCfnJobTemplate", 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

CfnJobTemplate(Construct, String, ICfnJobTemplateProps)	Create a new AWS::IoT::JobTemplate.
CfnJobTemplate(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnJobTemplate(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

Properties

AbortConfig	The criteria that determine when and how a job abort takes place.
AttrArn	The ARN of the job to use as the basis for the job template.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
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.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnJobTemplate(Construct, String, ICfnJobTemplateProps)

Create a new AWS::IoT::JobTemplate.

public CfnJobTemplate(Construct scope, string id, ICfnJobTemplateProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id System.String

• scoped id of the resource.

props ICfnJobTemplateProps

• resource properties.

CfnJobTemplate(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnJobTemplate(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnJobTemplate(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnJobTemplate(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

AbortConfig

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

public virtual object AbortConfig { get; set; }

Property Value

System.Object

Remarks

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

AttrArn

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

public virtual string AttrArn { get; }

Property Value

System.String

Remarks

CloudformationAttribute: Arn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

Description

A description of the job template.

public virtual string Description { get; set; }

Property Value

System.String

Remarks

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

Document

The job document.

public virtual string Document { get; set; }

Property Value

System.String

Remarks

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

DocumentSource

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

public virtual 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.

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

JobArn

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

public virtual string JobArn { get; set; }

Property Value

System.String

Remarks

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

JobExecutionsRetryConfig

Allows you to create the criteria to retry a job.

public virtual object JobExecutionsRetryConfig { get; set; }

Property Value

System.Object

Remarks

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

JobExecutionsRolloutConfig

Allows you to create a staged rollout of a job.

public virtual object JobExecutionsRolloutConfig { get; set; }

Property Value

System.Object

Remarks

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

JobTemplateId

A unique identifier for the job template.

public virtual string JobTemplateId { get; set; }

Property Value

System.String

Remarks

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

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 virtual object MaintenanceWindows { get; set; }

Property Value

System.Object

Remarks

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

PresignedUrlConfig

Configuration for pre-signed S3 URLs.

public virtual object PresignedUrlConfig { get; set; }

Property Value

System.Object

Remarks

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.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

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

TimeoutConfig

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

public virtual 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 .

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

• tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable