CfnJobTemplate¶

class aws_cdk.aws_iot.CfnJobTemplate(scope, id, *, 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, presigned_url_config=None, tags=None, timeout_config=None)¶

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::IoT::JobTemplate.

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

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_retry_config: Any
# job_executions_rollout_config: Any
# presigned_url_config: Any
# timeout_config: Any

cfn_job_template = iot.CfnJobTemplate(self, "MyCfnJobTemplate",
    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=job_executions_retry_config,
    job_executions_rollout_config=job_executions_rollout_config,
    presigned_url_config=presigned_url_config,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    timeout_config=timeout_config
)

Create a new AWS::IoT::JobTemplate.

Parameters

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
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 (Optional[Any]) – 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.
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 .

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_depends_on(target)¶

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.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)¶

Add a value to the CloudFormation Resource Metadata.

Parameters

key (str) –
value (Any) –

See

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.

Return type: None

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 intermdediate 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

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

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 resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)¶

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.
Return type: Reference

get_metadata(key)¶

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

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.

Return type: Any

inspect(inspector)¶

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

tree inspector to collect and process attributes.

Return type

None

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

to_string()¶

Returns a string representation of this construct.

Return type: str
Returns: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::IoT::JobTemplate'¶

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
Return type: Any

attr_arn¶

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

CloudformationAttribute: Arn
Return type: str

cfn_options¶

Options for this resource, such as condition, update policy etc.

Return type: ICfnResourceOptions

cfn_resource_type¶

AWS resource type.

Return type: str

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.

Return type: List[str]

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
Return type: str

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
Return type: Optional[str]

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
Return type: Optional[str]

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
Return type: Optional[str]

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
Return type: Any

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
Return type: Any

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
Return type: str

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

Return type: str
Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node¶

The construct tree node associated with this construct.

Return type: ConstructNode

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
Return type: Any

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

Return type: str

stack¶

The stack in which this element is defined.

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

Return type: Stack

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
Return type: TagManager

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
Return type: Any

Static Methods

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_resource(construct)¶

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)¶

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool