Package software.amazon.awscdk.cfnpropertymixins.services.iot

Class CfnJobTemplateMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.iot.CfnJobTemplateMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnJobTemplateMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnJobTemplateMixinProps

@Stability(Stable)
@Internal
public static final class CfnJobTemplateMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnJobTemplateMixinProps

An implementation for CfnJobTemplateMixinProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.iot.CfnJobTemplateMixinProps

CfnJobTemplateMixinProps.Builder, CfnJobTemplateMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnJobTemplateMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnJobTemplateMixinProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAbortConfig()	The criteria that determine when and how a job abort takes place.
final String	getDescription()	A description of the job template.
final List<String>	getDestinationPackageVersions()	The package version Amazon Resource Names (ARNs) that are installed on the device’s reserved named shadow ( $package ) when the job successfully completes.
final String	getDocument()	The job document.
final String	getDocumentSource()	An S3 link, or S3 object URL, to the job document.
final String	getJobArn()	The ARN of the job to use as the basis for the job template.
final Object	getJobExecutionsRetryConfig()	Allows you to create the criteria to retry a job.
final Object	getJobExecutionsRolloutConfig()	Allows you to create a staged rollout of a job.
final String	getJobTemplateId()	A unique identifier for the job template.
final Object	getMaintenanceWindows()	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.
final Object	getPresignedUrlConfig()	Configuration for pre-signed S3 URLs.
final List<CfnTag>	getTags()	Metadata that can be used to manage the job template.
final Object	getTimeoutConfig()	Specifies the amount of time each device has to finish its execution of the job.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnJobTemplateMixinProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnJobTemplateMixinProps.Builder.

Method Details

getAbortConfig

public final Object getAbortConfig()

Description copied from interface: CfnJobTemplateMixinProps

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

Specified by:

getAbortConfig in interface CfnJobTemplateMixinProps

See Also:

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

getDescription

public final String getDescription()

Description copied from interface: CfnJobTemplateMixinProps

A description of the job template.

Specified by:

getDescription in interface CfnJobTemplateMixinProps

See Also:

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

getDestinationPackageVersions

public final List<String> getDestinationPackageVersions()

Description copied from interface: CfnJobTemplateMixinProps

The package version Amazon Resource Names (ARNs) that are installed on the device’s reserved named shadow ( $package ) when the job successfully completes.

Note: Up to 25 package version ARNS are allowed.

Specified by:

getDestinationPackageVersions in interface CfnJobTemplateMixinProps

See Also:

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

getDocument

public final String getDocument()

Description copied from interface: CfnJobTemplateMixinProps

The job document.

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

Specified by:

getDocument in interface CfnJobTemplateMixinProps

See Also:

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

getDocumentSource

public final String getDocumentSource()

Description copied from interface: CfnJobTemplateMixinProps

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 .

For example, --document-source https://s3. *region-code* .amazonaws.com/example-firmware/device-firmware.1.0

For more information, see Methods for accessing a bucket .

Specified by:

getDocumentSource in interface CfnJobTemplateMixinProps

See Also:

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

getJobArn

public final String getJobArn()

Description copied from interface: CfnJobTemplateMixinProps

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

Specified by:

getJobArn in interface CfnJobTemplateMixinProps

See Also:

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

getJobExecutionsRetryConfig

public final Object getJobExecutionsRetryConfig()

Description copied from interface: CfnJobTemplateMixinProps

Allows you to create the criteria to retry a job.

Returns union: either IResolvable or CfnJobTemplatePropsMixin.JobExecutionsRetryConfigProperty

Specified by:

getJobExecutionsRetryConfig in interface CfnJobTemplateMixinProps

See Also:

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

getJobExecutionsRolloutConfig

public final Object getJobExecutionsRolloutConfig()

Description copied from interface: CfnJobTemplateMixinProps

Allows you to create a staged rollout of a job.

Specified by:

getJobExecutionsRolloutConfig in interface CfnJobTemplateMixinProps

See Also:

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

getJobTemplateId

public final String getJobTemplateId()

Description copied from interface: CfnJobTemplateMixinProps

A unique identifier for the job template.

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

Specified by:

getJobTemplateId in interface CfnJobTemplateMixinProps

See Also:

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

getMaintenanceWindows

public final Object getMaintenanceWindows()

Description copied from interface: CfnJobTemplateMixinProps

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnJobTemplatePropsMixin.MaintenanceWindowProperty>

Specified by:

getMaintenanceWindows in interface CfnJobTemplateMixinProps

See Also:

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

getPresignedUrlConfig

public final Object getPresignedUrlConfig()

Description copied from interface: CfnJobTemplateMixinProps

Configuration for pre-signed S3 URLs.

Specified by:

getPresignedUrlConfig in interface CfnJobTemplateMixinProps

See Also:

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

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnJobTemplateMixinProps

Metadata that can be used to manage the job template.

Specified by:

getTags in interface CfnJobTemplateMixinProps

See Also:

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

getTimeoutConfig

public final Object getTimeoutConfig()

Description copied from interface: CfnJobTemplateMixinProps

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 .

Specified by:

getTimeoutConfig in interface CfnJobTemplateMixinProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object