Class: AWSCDK::Glue::CfnTrigger::ActionProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
glue/cfn_trigger.rb

Overview

Defines an action to be initiated by a trigger.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arguments: nil, crawler_name: nil, job_name: nil, notification_property: nil, security_configuration: nil, timeout: nil) ⇒ ActionProperty

Returns a new instance of ActionProperty.

Parameters:

  • arguments (Object, nil) (defaults to: nil) —

    The job arguments used when this trigger fires.

  • crawler_name (String, nil) (defaults to: nil) —

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

  • job_name (String, nil) (defaults to: nil) —

    The name of a job to be executed.

  • notification_property (AWSCDK::IResolvable, AWSCDK::Glue::CfnTrigger::NotificationPropertyProperty, nil) (defaults to: nil) —

    Specifies configuration properties of a job run notification.

  • security_configuration (String, nil) (defaults to: nil) —

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

  • timeout (Numeric, nil) (defaults to: nil) —

    The JobRun timeout in minutes.



647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'glue/cfn_trigger.rb', line 647

def initialize(arguments: nil, crawler_name: nil, job_name: nil, notification_property: nil, security_configuration: nil, timeout: nil)
  @arguments = arguments
  Jsii::Type.check_type(@arguments, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "arguments") unless @arguments.nil?
  @crawler_name = crawler_name
  Jsii::Type.check_type(@crawler_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "crawlerName") unless @crawler_name.nil?
  @job_name = job_name
  Jsii::Type.check_type(@job_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jobName") unless @job_name.nil?
  @notification_property = notification_property.is_a?(Hash) ? ::AWSCDK::Glue::CfnTrigger::NotificationPropertyProperty.new(**notification_property.transform_keys(&:to_sym)) : notification_property
  Jsii::Type.check_type(@notification_property, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nbHVlLkNmblRyaWdnZXIuTm90aWZpY2F0aW9uUHJvcGVydHlQcm9wZXJ0eSJ9XX19")), "notificationProperty") unless @notification_property.nil?
  @security_configuration = security_configuration
  Jsii::Type.check_type(@security_configuration, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "securityConfiguration") unless @security_configuration.nil?
  @timeout = timeout
  Jsii::Type.check_type(@timeout, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "timeout") unless @timeout.nil?
end

Instance Attribute Details

#arguments ⇒ Object? (readonly)

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.

Returns:

  • (Object, nil)

See Also:



674
675
676
 
# File 'glue/cfn_trigger.rb', line 674

def arguments
  @arguments
end

#crawler_name ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



679
680
681
 
# File 'glue/cfn_trigger.rb', line 679

def crawler_name
  @crawler_name
end

#job_name ⇒ String? (readonly)

The name of a job to be executed.

Returns:

  • (String, nil)

See Also:



684
685
686
 
# File 'glue/cfn_trigger.rb', line 684

def job_name
  @job_name
end

#notification_property ⇒ AWSCDK::IResolvable, ... (readonly)

Specifies configuration properties of a job run notification.

Returns:

See Also:



689
690
691
 
# File 'glue/cfn_trigger.rb', line 689

def notification_property
  @notification_property
end

#security_configuration ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



694
695
696
 
# File 'glue/cfn_trigger.rb', line 694

def security_configuration
  @security_configuration
end

#timeout ⇒ Numeric? (readonly)

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.

Returns:

  • (Numeric, nil)

See Also:



701
702
703
 
# File 'glue/cfn_trigger.rb', line 701

def timeout
  @timeout
end

Class Method Details

.jsii_properties ⇒ Object 



703
704
705
706
707
708
709
710
711
712
 
# File 'glue/cfn_trigger.rb', line 703

def self.jsii_properties
  {
    :arguments => "arguments",
    :crawler_name => "crawlerName",
    :job_name => "jobName",
    :notification_property => "notificationProperty",
    :security_configuration => "securityConfiguration",
    :timeout => "timeout",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'glue/cfn_trigger.rb', line 714

def to_jsii
  result = {}
  result.merge!({
    "arguments" => @arguments,
    "crawlerName" => @crawler_name,
    "jobName" => @job_name,
    "notificationProperty" => @notification_property,
    "securityConfiguration" => @security_configuration,
    "timeout" => @timeout,
  })
  result.compact
end