You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Glue::Types::CreateTriggerRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateTriggerRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "NameString", # required
  workflow_name: "NameString",
  type: "SCHEDULED", # required, accepts SCHEDULED, CONDITIONAL, ON_DEMAND
  schedule: "GenericString",
  predicate: {
    logical: "AND", # accepts AND, ANY
    conditions: [
      {
        logical_operator: "EQUALS", # accepts EQUALS
        job_name: "NameString",
        state: "STARTING", # accepts STARTING, RUNNING, STOPPING, STOPPED, SUCCEEDED, FAILED, TIMEOUT
        crawler_name: "NameString",
        crawl_state: "RUNNING", # accepts RUNNING, CANCELLING, CANCELLED, SUCCEEDED, FAILED
      },
    ],
  },
  actions: [ # required
    {
      job_name: "NameString",
      arguments: {
        "GenericString" => "GenericString",
      },
      timeout: 1,
      security_configuration: "NameString",
      notification_property: {
        notify_delay_after: 1,
      },
      crawler_name: "NameString",
    },
  ],
  description: "DescriptionString",
  start_on_creation: false,
  tags: {
    "TagKey" => "TagValue",
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#actions ⇒ Array<Types::Action>

The actions initiated by this trigger when it fires.

Returns:

  • (Array<Types::Action>) —

    The actions initiated by this trigger when it fires.

#description ⇒ String

A description of the new trigger.

Returns:

  • (String) —

    A description of the new trigger.

#name ⇒ String

The name of the trigger.

Returns:

  • (String) —

    The name of the trigger.

#predicate ⇒ Types::Predicate

A predicate to specify when the new trigger should fire.

This field is required when the trigger type is CONDITIONAL.

Returns:

  • (Types::Predicate) —

    A predicate to specify when the new trigger should fire.

#schedule ⇒ String

A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

This field is required when the trigger type is SCHEDULED.

Returns:

  • (String) —

    A cron expression used to specify the schedule (see [Time-Based Schedules for Jobs and Crawlers][1]. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

#start_on_creation ⇒ Boolean

Set to true to start SCHEDULED and CONDITIONAL triggers when created. True is not supported for ON_DEMAND triggers.

Returns:

  • (Boolean) —

    Set to true to start SCHEDULED and CONDITIONAL triggers when created.

#tags ⇒ Hash<String,String>

The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

Returns:

  • (Hash<String,String>) —

    The tags to use with this trigger.

#type ⇒ String

The type of the new trigger.

Possible values:

  • SCHEDULED
  • CONDITIONAL
  • ON_DEMAND

Returns:

  • (String) —

    The type of the new trigger.

#workflow_name ⇒ String

The name of the workflow associated with the trigger.

Returns:

  • (String) —

    The name of the workflow associated with the trigger.