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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb

Overview

Note:

When making an API call, you may pass CreateTriggerRequest data as a 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, SUCCEEDED, CANCELLED, 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",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#actionsArray<Types::Action>

The actions initiated by this trigger when it fires.

Returns:



3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3244

class CreateTriggerRequest < Struct.new(
  :name,
  :workflow_name,
  :type,
  :schedule,
  :predicate,
  :actions,
  :description,
  :start_on_creation,
  :tags)
  include Aws::Structure
end

#descriptionString

A description of the new trigger.

Returns:

  • (String)


3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3244

class CreateTriggerRequest < Struct.new(
  :name,
  :workflow_name,
  :type,
  :schedule,
  :predicate,
  :actions,
  :description,
  :start_on_creation,
  :tags)
  include Aws::Structure
end

#nameString

The name of the trigger.

Returns:

  • (String)


3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3244

class CreateTriggerRequest < Struct.new(
  :name,
  :workflow_name,
  :type,
  :schedule,
  :predicate,
  :actions,
  :description,
  :start_on_creation,
  :tags)
  include Aws::Structure
end

#predicateTypes::Predicate

A predicate to specify when the new trigger should fire.

This field is required when the trigger type is CONDITIONAL.

Returns:



3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3244

class CreateTriggerRequest < Struct.new(
  :name,
  :workflow_name,
  :type,
  :schedule,
  :predicate,
  :actions,
  :description,
  :start_on_creation,
  :tags)
  include Aws::Structure
end

#scheduleString

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)


3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3244

class CreateTriggerRequest < Struct.new(
  :name,
  :workflow_name,
  :type,
  :schedule,
  :predicate,
  :actions,
  :description,
  :start_on_creation,
  :tags)
  include Aws::Structure
end

#start_on_creationBoolean

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

Returns:

  • (Boolean)


3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3244

class CreateTriggerRequest < Struct.new(
  :name,
  :workflow_name,
  :type,
  :schedule,
  :predicate,
  :actions,
  :description,
  :start_on_creation,
  :tags)
  include Aws::Structure
end

#tagsHash<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>)


3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3244

class CreateTriggerRequest < Struct.new(
  :name,
  :workflow_name,
  :type,
  :schedule,
  :predicate,
  :actions,
  :description,
  :start_on_creation,
  :tags)
  include Aws::Structure
end

#typeString

The type of the new trigger.

Returns:

  • (String)


3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3244

class CreateTriggerRequest < Struct.new(
  :name,
  :workflow_name,
  :type,
  :schedule,
  :predicate,
  :actions,
  :description,
  :start_on_creation,
  :tags)
  include Aws::Structure
end

#workflow_nameString

The name of the workflow associated with the trigger.

Returns:

  • (String)


3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3244

class CreateTriggerRequest < Struct.new(
  :name,
  :workflow_name,
  :type,
  :schedule,
  :predicate,
  :actions,
  :description,
  :start_on_creation,
  :tags)
  include Aws::Structure
end