Package software.amazon.awscdk.services.iot

Class CfnJobProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.iot.CfnJobProps.Jsii$Proxy

All Implemented Interfaces:

CfnJobProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnJobProps

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

An implementation for CfnJobProps

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.services.iot.CfnJobProps

CfnJobProps.Builder, CfnJobProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnJobProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnJobProps.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 short text description of the job.
final List<String>	getDestinationPackageVersions()	The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
final String	getDocument()	The job document.
final Object	getDocumentParameters()	Parameters of an Amazon Web Services managed template that you can specify to create the job document.
final String	getDocumentSource()	An S3 link, or S3 object URL, to the job document.
final Object	getJobExecutionsRetryConfig()	The configuration that determines how many retries are allowed for each failure type for a job.
final Object	getJobExecutionsRolloutConfig()	Allows you to create a staged rollout of a job.
final String	getJobId()	A job identifier which must be unique for your AWS account.
final String	getJobTemplateArn()	The ARN of the job template used to create the job.
final Object	getPresignedUrlConfig()	Configuration for pre-signed S3 URLs.
final Object	getSchedulingConfig()	Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group.
final List<CfnTag>	getTags()	Metadata which can be used to manage the job.
final List<String>	getTargets()	A list of things and thing groups to which the job should be sent.
final String	getTargetSelection()	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).
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(CfnJobProps.Builder builder)

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

Method Details

getJobId

public final String getJobId()

Description copied from interface: CfnJobProps

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.

Specified by:

getJobId in interface CfnJobProps

See Also:

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

getTargets

public final List<String> getTargets()

Description copied from interface: CfnJobProps

A list of things and thing groups to which the job should be sent.

Specified by:

getTargets in interface CfnJobProps

See Also:

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

getAbortConfig

public final Object getAbortConfig()

Description copied from interface: CfnJobProps

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

Returns union: either IResolvable or CfnJob.AbortConfigProperty

Specified by:

getAbortConfig in interface CfnJobProps

See Also:

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

getDescription

public final String getDescription()

Description copied from interface: CfnJobProps

A short text description of the job.

Specified by:

getDescription in interface CfnJobProps

See Also:

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

getDestinationPackageVersions

public final List<String> getDestinationPackageVersions()

Description copied from interface: CfnJobProps

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.

Specified by:

getDestinationPackageVersions in interface CfnJobProps

See Also:

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

getDocument

public final String getDocument()

Description copied from interface: CfnJobProps

The job document.

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

Specified by:

getDocument in interface CfnJobProps

See Also:

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

getDocumentParameters

public final Object getDocumentParameters()

Description copied from interface: CfnJobProps

Parameters of an Amazon Web Services managed template that you can specify to create the job document.

Returns union: either IResolvable or Mapinvalid input: '<'String, String>

Specified by:

getDocumentParameters in interface CfnJobProps

See Also:

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

getDocumentSource

public final String getDocumentSource()

Description copied from interface: CfnJobProps

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.

Specified by:

getDocumentSource in interface CfnJobProps

See Also:

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

getJobExecutionsRetryConfig

public final Object getJobExecutionsRetryConfig()

Description copied from interface: CfnJobProps

The configuration that determines how many retries are allowed for each failure type for a job.

Returns union: either IResolvable or CfnJob.JobExecutionsRetryConfigProperty

Specified by:

getJobExecutionsRetryConfig in interface CfnJobProps

See Also:

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

getJobExecutionsRolloutConfig

public final Object getJobExecutionsRolloutConfig()

Description copied from interface: CfnJobProps

Allows you to create a staged rollout of a job.

Returns union: either IResolvable or CfnJob.JobExecutionsRolloutConfigProperty

Specified by:

getJobExecutionsRolloutConfig in interface CfnJobProps

See Also:

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

getJobTemplateArn

public final String getJobTemplateArn()

Description copied from interface: CfnJobProps

The ARN of the job template used to create the job.

Specified by:

getJobTemplateArn in interface CfnJobProps

See Also:

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

getPresignedUrlConfig

public final Object getPresignedUrlConfig()

Description copied from interface: CfnJobProps

Configuration for pre-signed S3 URLs.

Returns union: either IResolvable or CfnJob.PresignedUrlConfigProperty

Specified by:

getPresignedUrlConfig in interface CfnJobProps

See Also:

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

getSchedulingConfig

public final Object getSchedulingConfig()

Description copied from interface: CfnJobProps

Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group.

Returns union: either IResolvable or CfnJob.SchedulingConfigProperty

Specified by:

getSchedulingConfig in interface CfnJobProps

See Also:

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

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnJobProps

Metadata which can be used to manage the job.

Specified by:

getTags in interface CfnJobProps

See Also:

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

getTargetSelection

public final String getTargetSelection()

Description copied from interface: CfnJobProps

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

Specified by:

getTargetSelection in interface CfnJobProps

See Also:

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

getTimeoutConfig

public final Object getTimeoutConfig()

Description copied from interface: CfnJobProps

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

Returns union: either IResolvable or CfnJob.TimeoutConfigProperty

Specified by:

getTimeoutConfig in interface CfnJobProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-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