software.amazon.awscdk.services.glue

Interface CfnTrigger.ActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTrigger.ActionProperty.Jsii$Proxy

Enclosing class:

CfnTrigger

@Stability(value=Stable)
public static interface CfnTrigger.ActionProperty
extends software.amazon.jsii.JsiiSerializable

Defines an action to be initiated by a trigger.

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 arguments_;
 ActionProperty actionProperty = ActionProperty.builder()
         .arguments(arguments_)
         .crawlerName("crawlerName")
         .jobName("jobName")
         .notificationProperty(NotificationPropertyProperty.builder()
                 .notifyDelayAfter(123)
                 .build())
         .securityConfiguration("securityConfiguration")
         .timeout(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnTrigger.ActionProperty.Builder A builder for CfnTrigger.ActionProperty
static class	CfnTrigger.ActionProperty.Jsii$Proxy An implementation for CfnTrigger.ActionProperty

Method Summary

Modifier and Type	Method and Description
static CfnTrigger.ActionProperty.Builder	builder()
default Object	getArguments() The job arguments used when this trigger fires.
default String	getCrawlerName() The name of the crawler to be used with this action.
default String	getJobName() The name of a job to be executed.
default Object	getNotificationProperty() Specifies configuration properties of a job run notification.
default String	getSecurityConfiguration() The name of the `SecurityConfiguration` structure to be used with this action.
default Number	getTimeout() The `JobRun` timeout in minutes.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getArguments

@Stability(value=Stable)
 @Nullable
default Object getArguments()

The job arguments used when this trigger fires.

For this job run, they replace the default arguments set in the job definition itself.

You can specify arguments here that your own job-execution script consumes, in addition to arguments that AWS Glue itself consumes.

For information about how to specify and consume your own job arguments, see Calling AWS Glue APIs in Python in the AWS Glue Developer Guide .

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

getCrawlerName

@Stability(value=Stable)
 @Nullable
default String getCrawlerName()

The name of the crawler to be used with this action.

getJobName

@Stability(value=Stable)
 @Nullable
default String getJobName()

The name of a job to be executed.

getNotificationProperty

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

Specifies configuration properties of a job run notification.

getSecurityConfiguration

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

The name of the `SecurityConfiguration` structure to be used with this action.

getTimeout

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

The `JobRun` timeout in minutes.

This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

builder

@Stability(value=Stable)
static CfnTrigger.ActionProperty.Builder builder()

Returns:

a CfnTrigger.ActionProperty.Builder of CfnTrigger.ActionProperty