software.amazon.awscdk.services.glue

Class CfnJob

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.glue.CfnJob

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:06.658Z")
 @Stability(value=Stable)
public class CfnJob
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Glue::Job`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.glue.*;
 Object defaultArguments;
 Object tags;
 CfnJob cfnJob = CfnJob.Builder.create(this, "MyCfnJob")
         .command(JobCommandProperty.builder()
                 .name("name")
                 .pythonVersion("pythonVersion")
                 .scriptLocation("scriptLocation")
                 .build())
         .role("role")
         // the properties below are optional
         .allocatedCapacity(123)
         .connections(ConnectionsListProperty.builder()
                 .connections(List.of("connections"))
                 .build())
         .defaultArguments(defaultArguments)
         .description("description")
         .executionProperty(ExecutionPropertyProperty.builder()
                 .maxConcurrentRuns(123)
                 .build())
         .glueVersion("glueVersion")
         .logUri("logUri")
         .maxCapacity(123)
         .maxRetries(123)
         .name("name")
         .notificationProperty(NotificationPropertyProperty.builder()
                 .notifyDelayAfter(123)
                 .build())
         .numberOfWorkers(123)
         .securityConfiguration("securityConfiguration")
         .tags(tags)
         .timeout(123)
         .workerType("workerType")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnJob.Builder A fluent builder for CfnJob.
static interface	CfnJob.ConnectionsListProperty Example:
static interface	CfnJob.ExecutionPropertyProperty Example:
static interface	CfnJob.JobCommandProperty Example:
static interface	CfnJob.NotificationPropertyProperty Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnJob(software.constructs.Construct scope, String id, CfnJobProps props) Create a new `AWS::Glue::Job`.
protected	CfnJob(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnJob(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Number	getAllocatedCapacity() `AWS::Glue::Job.AllocatedCapacity`.
protected Map<String,Object>	getCfnProperties()
Object	getCommand() `AWS::Glue::Job.Command`.
Object	getConnections() `AWS::Glue::Job.Connections`.
Object	getDefaultArguments() `AWS::Glue::Job.DefaultArguments`.
String	getDescription() `AWS::Glue::Job.Description`.
Object	getExecutionProperty() `AWS::Glue::Job.ExecutionProperty`.
String	getGlueVersion() `AWS::Glue::Job.GlueVersion`.
String	getLogUri() `AWS::Glue::Job.LogUri`.
Number	getMaxCapacity() `AWS::Glue::Job.MaxCapacity`.
Number	getMaxRetries() `AWS::Glue::Job.MaxRetries`.
String	getName() `AWS::Glue::Job.Name`.
Object	getNotificationProperty() `AWS::Glue::Job.NotificationProperty`.
Number	getNumberOfWorkers() `AWS::Glue::Job.NumberOfWorkers`.
String	getRole() `AWS::Glue::Job.Role`.
String	getSecurityConfiguration() `AWS::Glue::Job.SecurityConfiguration`.
TagManager	getTags() `AWS::Glue::Job.Tags`.
Number	getTimeout() `AWS::Glue::Job.Timeout`.
String	getWorkerType() `AWS::Glue::Job.WorkerType`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAllocatedCapacity(Number value) `AWS::Glue::Job.AllocatedCapacity`.
void	setCommand(CfnJob.JobCommandProperty value) `AWS::Glue::Job.Command`.
void	setCommand(IResolvable value) `AWS::Glue::Job.Command`.
void	setConnections(CfnJob.ConnectionsListProperty value) `AWS::Glue::Job.Connections`.
void	setConnections(IResolvable value) `AWS::Glue::Job.Connections`.
void	setDefaultArguments(Object value) `AWS::Glue::Job.DefaultArguments`.
void	setDescription(String value) `AWS::Glue::Job.Description`.
void	setExecutionProperty(CfnJob.ExecutionPropertyProperty value) `AWS::Glue::Job.ExecutionProperty`.
void	setExecutionProperty(IResolvable value) `AWS::Glue::Job.ExecutionProperty`.
void	setGlueVersion(String value) `AWS::Glue::Job.GlueVersion`.
void	setLogUri(String value) `AWS::Glue::Job.LogUri`.
void	setMaxCapacity(Number value) `AWS::Glue::Job.MaxCapacity`.
void	setMaxRetries(Number value) `AWS::Glue::Job.MaxRetries`.
void	setName(String value) `AWS::Glue::Job.Name`.
void	setNotificationProperty(CfnJob.NotificationPropertyProperty value) `AWS::Glue::Job.NotificationProperty`.
void	setNotificationProperty(IResolvable value) `AWS::Glue::Job.NotificationProperty`.
void	setNumberOfWorkers(Number value) `AWS::Glue::Job.NumberOfWorkers`.
void	setRole(String value) `AWS::Glue::Job.Role`.
void	setSecurityConfiguration(String value) `AWS::Glue::Job.SecurityConfiguration`.
void	setTimeout(Number value) `AWS::Glue::Job.Timeout`.
void	setWorkerType(String value) `AWS::Glue::Job.WorkerType`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnJob

protected CfnJob(software.amazon.jsii.JsiiObjectRef objRef)

CfnJob

protected CfnJob(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnJob

@Stability(value=Stable)
public CfnJob(@NotNull
                                       software.constructs.Construct scope,
                                       @NotNull
                                       String id,
                                       @NotNull
                                       CfnJobProps props)

Create a new `AWS::Glue::Job`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAllocatedCapacity

@Stability(value=Stable)
 @Nullable
public Number getAllocatedCapacity()

`AWS::Glue::Job.AllocatedCapacity`.

setAllocatedCapacity

@Stability(value=Stable)
public void setAllocatedCapacity(@Nullable
                                                          Number value)

`AWS::Glue::Job.AllocatedCapacity`.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCommand

@Stability(value=Stable)
 @NotNull
public Object getCommand()

`AWS::Glue::Job.Command`.

setCommand

@Stability(value=Stable)
public void setCommand(@NotNull
                                                CfnJob.JobCommandProperty value)

`AWS::Glue::Job.Command`.

setCommand

@Stability(value=Stable)
public void setCommand(@NotNull
                                                IResolvable value)

`AWS::Glue::Job.Command`.

getConnections

@Stability(value=Stable)
 @Nullable
public Object getConnections()

`AWS::Glue::Job.Connections`.

setConnections

@Stability(value=Stable)
public void setConnections(@Nullable
                                                    CfnJob.ConnectionsListProperty value)

`AWS::Glue::Job.Connections`.

setConnections

@Stability(value=Stable)
public void setConnections(@Nullable
                                                    IResolvable value)

`AWS::Glue::Job.Connections`.

getDefaultArguments

@Stability(value=Stable)
 @NotNull
public Object getDefaultArguments()

`AWS::Glue::Job.DefaultArguments`.

setDefaultArguments

@Stability(value=Stable)
public void setDefaultArguments(@NotNull
                                                         Object value)

`AWS::Glue::Job.DefaultArguments`.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

`AWS::Glue::Job.Description`.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

`AWS::Glue::Job.Description`.

getExecutionProperty

@Stability(value=Stable)
 @Nullable
public Object getExecutionProperty()

`AWS::Glue::Job.ExecutionProperty`.

setExecutionProperty

@Stability(value=Stable)
public void setExecutionProperty(@Nullable
                                                          CfnJob.ExecutionPropertyProperty value)

`AWS::Glue::Job.ExecutionProperty`.

setExecutionProperty

@Stability(value=Stable)
public void setExecutionProperty(@Nullable
                                                          IResolvable value)

`AWS::Glue::Job.ExecutionProperty`.

getGlueVersion

@Stability(value=Stable)
 @Nullable
public String getGlueVersion()

`AWS::Glue::Job.GlueVersion`.

setGlueVersion

@Stability(value=Stable)
public void setGlueVersion(@Nullable
                                                    String value)

`AWS::Glue::Job.GlueVersion`.

getLogUri

@Stability(value=Stable)
 @Nullable
public String getLogUri()

`AWS::Glue::Job.LogUri`.

setLogUri

@Stability(value=Stable)
public void setLogUri(@Nullable
                                               String value)

`AWS::Glue::Job.LogUri`.

getMaxCapacity

@Stability(value=Stable)
 @Nullable
public Number getMaxCapacity()

`AWS::Glue::Job.MaxCapacity`.

setMaxCapacity

@Stability(value=Stable)
public void setMaxCapacity(@Nullable
                                                    Number value)

`AWS::Glue::Job.MaxCapacity`.

getMaxRetries

@Stability(value=Stable)
 @Nullable
public Number getMaxRetries()

`AWS::Glue::Job.MaxRetries`.

setMaxRetries

@Stability(value=Stable)
public void setMaxRetries(@Nullable
                                                   Number value)

`AWS::Glue::Job.MaxRetries`.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

`AWS::Glue::Job.Name`.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

`AWS::Glue::Job.Name`.

getNotificationProperty

@Stability(value=Stable)
 @Nullable
public Object getNotificationProperty()

`AWS::Glue::Job.NotificationProperty`.

setNotificationProperty

@Stability(value=Stable)
public void setNotificationProperty(@Nullable
                                                             CfnJob.NotificationPropertyProperty value)

`AWS::Glue::Job.NotificationProperty`.

setNotificationProperty

@Stability(value=Stable)
public void setNotificationProperty(@Nullable
                                                             IResolvable value)

`AWS::Glue::Job.NotificationProperty`.

getNumberOfWorkers

@Stability(value=Stable)
 @Nullable
public Number getNumberOfWorkers()

`AWS::Glue::Job.NumberOfWorkers`.

setNumberOfWorkers

@Stability(value=Stable)
public void setNumberOfWorkers(@Nullable
                                                        Number value)

`AWS::Glue::Job.NumberOfWorkers`.

getRole

@Stability(value=Stable)
 @NotNull
public String getRole()

`AWS::Glue::Job.Role`.

setRole

@Stability(value=Stable)
public void setRole(@NotNull
                                             String value)

`AWS::Glue::Job.Role`.

getSecurityConfiguration

@Stability(value=Stable)
 @Nullable
public String getSecurityConfiguration()

`AWS::Glue::Job.SecurityConfiguration`.

setSecurityConfiguration

@Stability(value=Stable)
public void setSecurityConfiguration(@Nullable
                                                              String value)

`AWS::Glue::Job.SecurityConfiguration`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::Glue::Job.Tags`.

getTimeout

@Stability(value=Stable)
 @Nullable
public Number getTimeout()

`AWS::Glue::Job.Timeout`.

setTimeout

@Stability(value=Stable)
public void setTimeout(@Nullable
                                                Number value)

`AWS::Glue::Job.Timeout`.

getWorkerType

@Stability(value=Stable)
 @Nullable
public String getWorkerType()

`AWS::Glue::Job.WorkerType`.

setWorkerType

@Stability(value=Stable)
public void setWorkerType(@Nullable
                                                   String value)

`AWS::Glue::Job.WorkerType`.