1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. glue
  5. getTrigger

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

aws-native.glue.getTrigger

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

    Resource Type definition for AWS::Glue::Trigger

    Using getTrigger

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getTrigger(args: GetTriggerArgs, opts?: InvokeOptions): Promise<GetTriggerResult>
    function getTriggerOutput(args: GetTriggerOutputArgs, opts?: InvokeOptions): Output<GetTriggerResult>
    def get_trigger(name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetTriggerResult
    def get_trigger_output(name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetTriggerResult]
    func LookupTrigger(ctx *Context, args *LookupTriggerArgs, opts ...InvokeOption) (*LookupTriggerResult, error)
    func LookupTriggerOutput(ctx *Context, args *LookupTriggerOutputArgs, opts ...InvokeOption) LookupTriggerResultOutput

    > Note: This function is named LookupTrigger in the Go SDK.

    public static class GetTrigger 
    {
        public static Task<GetTriggerResult> InvokeAsync(GetTriggerArgs args, InvokeOptions? opts = null)
        public static Output<GetTriggerResult> Invoke(GetTriggerInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTriggerResult> getTrigger(GetTriggerArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:glue:getTrigger
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the trigger.
    Name string
    The name of the trigger.
    name String
    The name of the trigger.
    name string
    The name of the trigger.
    name str
    The name of the trigger.
    name String
    The name of the trigger.

    getTrigger Result

    The following output properties are available:

    Actions List<Pulumi.AwsNative.Glue.Outputs.TriggerAction>
    The actions initiated by this trigger.
    Description string
    A description of this trigger.
    EventBatchingCondition Pulumi.AwsNative.Glue.Outputs.TriggerEventBatchingCondition
    Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
    Predicate Pulumi.AwsNative.Glue.Outputs.TriggerPredicate
    The predicate of this trigger, which defines when it will fire.
    Schedule string
    A cron expression used to specify the schedule.
    Tags object

    The tags to use with this trigger.

    Search the CloudFormation User Guide for AWS::Glue::Trigger for more information about the expected schema for this property.

    Actions []TriggerAction
    The actions initiated by this trigger.
    Description string
    A description of this trigger.
    EventBatchingCondition TriggerEventBatchingCondition
    Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
    Predicate TriggerPredicate
    The predicate of this trigger, which defines when it will fire.
    Schedule string
    A cron expression used to specify the schedule.
    Tags interface{}

    The tags to use with this trigger.

    Search the CloudFormation User Guide for AWS::Glue::Trigger for more information about the expected schema for this property.

    actions List<TriggerAction>
    The actions initiated by this trigger.
    description String
    A description of this trigger.
    eventBatchingCondition TriggerEventBatchingCondition
    Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
    predicate TriggerPredicate
    The predicate of this trigger, which defines when it will fire.
    schedule String
    A cron expression used to specify the schedule.
    tags Object

    The tags to use with this trigger.

    Search the CloudFormation User Guide for AWS::Glue::Trigger for more information about the expected schema for this property.

    actions TriggerAction[]
    The actions initiated by this trigger.
    description string
    A description of this trigger.
    eventBatchingCondition TriggerEventBatchingCondition
    Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
    predicate TriggerPredicate
    The predicate of this trigger, which defines when it will fire.
    schedule string
    A cron expression used to specify the schedule.
    tags any

    The tags to use with this trigger.

    Search the CloudFormation User Guide for AWS::Glue::Trigger for more information about the expected schema for this property.

    actions Sequence[TriggerAction]
    The actions initiated by this trigger.
    description str
    A description of this trigger.
    event_batching_condition TriggerEventBatchingCondition
    Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
    predicate TriggerPredicate
    The predicate of this trigger, which defines when it will fire.
    schedule str
    A cron expression used to specify the schedule.
    tags Any

    The tags to use with this trigger.

    Search the CloudFormation User Guide for AWS::Glue::Trigger for more information about the expected schema for this property.

    actions List<Property Map>
    The actions initiated by this trigger.
    description String
    A description of this trigger.
    eventBatchingCondition Property Map
    Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
    predicate Property Map
    The predicate of this trigger, which defines when it will fire.
    schedule String
    A cron expression used to specify the schedule.
    tags Any

    The tags to use with this trigger.

    Search the CloudFormation User Guide for AWS::Glue::Trigger for more information about the expected schema for this property.

    Supporting Types

    TriggerAction

    Arguments object
    The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
    CrawlerName string
    The name of the crawler to be used with this action.
    JobName string
    The name of a job to be executed.
    NotificationProperty Pulumi.AwsNative.Glue.Inputs.TriggerNotificationProperty
    Specifies configuration properties of a job run notification.
    SecurityConfiguration string
    The name of the SecurityConfiguration structure to be used with this action.
    Timeout int
    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.
    Arguments interface{}
    The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
    CrawlerName string
    The name of the crawler to be used with this action.
    JobName string
    The name of a job to be executed.
    NotificationProperty TriggerNotificationProperty
    Specifies configuration properties of a job run notification.
    SecurityConfiguration string
    The name of the SecurityConfiguration structure to be used with this action.
    Timeout int
    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.
    arguments Object
    The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
    crawlerName String
    The name of the crawler to be used with this action.
    jobName String
    The name of a job to be executed.
    notificationProperty TriggerNotificationProperty
    Specifies configuration properties of a job run notification.
    securityConfiguration String
    The name of the SecurityConfiguration structure to be used with this action.
    timeout Integer
    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.
    arguments any
    The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
    crawlerName string
    The name of the crawler to be used with this action.
    jobName string
    The name of a job to be executed.
    notificationProperty TriggerNotificationProperty
    Specifies configuration properties of a job run notification.
    securityConfiguration string
    The name of the SecurityConfiguration structure to be used with this action.
    timeout number
    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.
    arguments Any
    The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
    crawler_name str
    The name of the crawler to be used with this action.
    job_name str
    The name of a job to be executed.
    notification_property TriggerNotificationProperty
    Specifies configuration properties of a job run notification.
    security_configuration str
    The name of the SecurityConfiguration structure to be used with this action.
    timeout int
    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.
    arguments Any
    The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
    crawlerName String
    The name of the crawler to be used with this action.
    jobName String
    The name of a job to be executed.
    notificationProperty Property Map
    Specifies configuration properties of a job run notification.
    securityConfiguration String
    The name of the SecurityConfiguration structure to be used with this action.
    timeout Number
    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.

    TriggerCondition

    CrawlState string
    The state of the crawler to which this condition applies.
    CrawlerName string
    The name of the crawler to which this condition applies.
    JobName string
    The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
    LogicalOperator string
    A logical operator.
    State string
    The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT, and FAILED.
    CrawlState string
    The state of the crawler to which this condition applies.
    CrawlerName string
    The name of the crawler to which this condition applies.
    JobName string
    The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
    LogicalOperator string
    A logical operator.
    State string
    The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT, and FAILED.
    crawlState String
    The state of the crawler to which this condition applies.
    crawlerName String
    The name of the crawler to which this condition applies.
    jobName String
    The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
    logicalOperator String
    A logical operator.
    state String
    The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT, and FAILED.
    crawlState string
    The state of the crawler to which this condition applies.
    crawlerName string
    The name of the crawler to which this condition applies.
    jobName string
    The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
    logicalOperator string
    A logical operator.
    state string
    The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT, and FAILED.
    crawl_state str
    The state of the crawler to which this condition applies.
    crawler_name str
    The name of the crawler to which this condition applies.
    job_name str
    The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
    logical_operator str
    A logical operator.
    state str
    The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT, and FAILED.
    crawlState String
    The state of the crawler to which this condition applies.
    crawlerName String
    The name of the crawler to which this condition applies.
    jobName String
    The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
    logicalOperator String
    A logical operator.
    state String
    The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT, and FAILED.

    TriggerEventBatchingCondition

    BatchSize int
    Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
    BatchWindow int
    Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
    BatchSize int
    Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
    BatchWindow int
    Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
    batchSize Integer
    Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
    batchWindow Integer
    Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
    batchSize number
    Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
    batchWindow number
    Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
    batch_size int
    Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
    batch_window int
    Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
    batchSize Number
    Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
    batchWindow Number
    Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.

    TriggerNotificationProperty

    NotifyDelayAfter int
    After a job run starts, the number of minutes to wait before sending a job run delay notification
    NotifyDelayAfter int
    After a job run starts, the number of minutes to wait before sending a job run delay notification
    notifyDelayAfter Integer
    After a job run starts, the number of minutes to wait before sending a job run delay notification
    notifyDelayAfter number
    After a job run starts, the number of minutes to wait before sending a job run delay notification
    notify_delay_after int
    After a job run starts, the number of minutes to wait before sending a job run delay notification
    notifyDelayAfter Number
    After a job run starts, the number of minutes to wait before sending a job run delay notification

    TriggerPredicate

    Conditions List<Pulumi.AwsNative.Glue.Inputs.TriggerCondition>
    A list of the conditions that determine when the trigger will fire.
    Logical string
    An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
    Conditions []TriggerCondition
    A list of the conditions that determine when the trigger will fire.
    Logical string
    An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
    conditions List<TriggerCondition>
    A list of the conditions that determine when the trigger will fire.
    logical String
    An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
    conditions TriggerCondition[]
    A list of the conditions that determine when the trigger will fire.
    logical string
    An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
    conditions Sequence[TriggerCondition]
    A list of the conditions that determine when the trigger will fire.
    logical str
    An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
    conditions List<Property Map>
    A list of the conditions that determine when the trigger will fire.
    logical String
    An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi