prefect 2.24.1 published on Tuesday, Apr 15, 2025 by prefecthq
prefect.getAutomation
Explore with Pulumi AI
Get information about an existing Automation by its ID
For more information, see automate overview.
This feature is available in the following product plan(s): Prefect OSS, Prefect Cloud (Free), Prefect Cloud (Pro), Prefect Cloud (Enterprise).
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as prefect from "@pulumi/prefect";
const test = prefect.getAutomation({
id: "7759cb06-ea19-48fc-b277-61db8bdb3de9",
});
import pulumi
import pulumi_prefect as prefect
test = prefect.get_automation(id="7759cb06-ea19-48fc-b277-61db8bdb3de9")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/prefect/v2/prefect"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := prefect.LookupAutomation(ctx, &prefect.LookupAutomationArgs{
Id: "7759cb06-ea19-48fc-b277-61db8bdb3de9",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Prefect = Pulumi.Prefect;
return await Deployment.RunAsync(() =>
{
var test = Prefect.GetAutomation.Invoke(new()
{
Id = "7759cb06-ea19-48fc-b277-61db8bdb3de9",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.prefect.PrefectFunctions;
import com.pulumi.prefect.inputs.GetAutomationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var test = PrefectFunctions.getAutomation(GetAutomationArgs.builder()
.id("7759cb06-ea19-48fc-b277-61db8bdb3de9")
.build());
}
}
variables:
test:
fn::invoke:
function: prefect:getAutomation
arguments:
id: 7759cb06-ea19-48fc-b277-61db8bdb3de9
Using getAutomation
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 getAutomation(args: GetAutomationArgs, opts?: InvokeOptions): Promise<GetAutomationResult>
function getAutomationOutput(args: GetAutomationOutputArgs, opts?: InvokeOptions): Output<GetAutomationResult>
def get_automation(account_id: Optional[str] = None,
id: Optional[str] = None,
workspace_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAutomationResult
def get_automation_output(account_id: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
workspace_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAutomationResult]
func LookupAutomation(ctx *Context, args *LookupAutomationArgs, opts ...InvokeOption) (*LookupAutomationResult, error)
func LookupAutomationOutput(ctx *Context, args *LookupAutomationOutputArgs, opts ...InvokeOption) LookupAutomationResultOutput
> Note: This function is named LookupAutomation
in the Go SDK.
public static class GetAutomation
{
public static Task<GetAutomationResult> InvokeAsync(GetAutomationArgs args, InvokeOptions? opts = null)
public static Output<GetAutomationResult> Invoke(GetAutomationInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAutomationResult> getAutomation(GetAutomationArgs args, InvokeOptions options)
public static Output<GetAutomationResult> getAutomation(GetAutomationArgs args, InvokeOptions options)
fn::invoke:
function: prefect:index/getAutomation:getAutomation
arguments:
# arguments dictionary
The following arguments are supported:
- Id
This property is required. string - Automation ID (UUID)
- Account
Id string - Account ID (UUID), defaults to the account set in the provider
- Workspace
Id string - Workspace ID (UUID), defaults to the workspace set in the provider
- Id
This property is required. string - Automation ID (UUID)
- Account
Id string - Account ID (UUID), defaults to the account set in the provider
- Workspace
Id string - Workspace ID (UUID), defaults to the workspace set in the provider
- id
This property is required. String - Automation ID (UUID)
- account
Id String - Account ID (UUID), defaults to the account set in the provider
- workspace
Id String - Workspace ID (UUID), defaults to the workspace set in the provider
- id
This property is required. string - Automation ID (UUID)
- account
Id string - Account ID (UUID), defaults to the account set in the provider
- workspace
Id string - Workspace ID (UUID), defaults to the workspace set in the provider
- id
This property is required. str - Automation ID (UUID)
- account_
id str - Account ID (UUID), defaults to the account set in the provider
- workspace_
id str - Workspace ID (UUID), defaults to the workspace set in the provider
- id
This property is required. String - Automation ID (UUID)
- account
Id String - Account ID (UUID), defaults to the account set in the provider
- workspace
Id String - Workspace ID (UUID), defaults to the workspace set in the provider
getAutomation Result
The following output properties are available:
- Actions
List<Get
Automation Action> - List of actions to perform when the automation is triggered
- Actions
On List<GetResolves Automation Actions On Resolf> - List of actions to perform when the automation is triggered
- Actions
On List<GetTriggers Automation Actions On Trigger> - List of actions to perform when the automation is triggered
- Created string
- Timestamp of when the resource was created (RFC3339)
- Description string
- Description of the automation
- Enabled bool
- Whether the automation is enabled
- Id string
- Automation ID (UUID)
- Name string
- Name of the automation
- Trigger
Get
Automation Trigger - The criteria for which events this Automation covers and how it will respond
- Updated string
- Timestamp of when the resource was updated (RFC3339)
- Account
Id string - Account ID (UUID), defaults to the account set in the provider
- Workspace
Id string - Workspace ID (UUID), defaults to the workspace set in the provider
- Actions
[]Get
Automation Action - List of actions to perform when the automation is triggered
- Actions
On []GetResolves Automation Actions On Resolf - List of actions to perform when the automation is triggered
- Actions
On []GetTriggers Automation Actions On Trigger - List of actions to perform when the automation is triggered
- Created string
- Timestamp of when the resource was created (RFC3339)
- Description string
- Description of the automation
- Enabled bool
- Whether the automation is enabled
- Id string
- Automation ID (UUID)
- Name string
- Name of the automation
- Trigger
Get
Automation Trigger - The criteria for which events this Automation covers and how it will respond
- Updated string
- Timestamp of when the resource was updated (RFC3339)
- Account
Id string - Account ID (UUID), defaults to the account set in the provider
- Workspace
Id string - Workspace ID (UUID), defaults to the workspace set in the provider
- actions
List<Get
Automation Action> - List of actions to perform when the automation is triggered
- actions
On List<GetResolves Automation Actions On Resolf> - List of actions to perform when the automation is triggered
- actions
On List<GetTriggers Automation Actions On Trigger> - List of actions to perform when the automation is triggered
- created String
- Timestamp of when the resource was created (RFC3339)
- description String
- Description of the automation
- enabled Boolean
- Whether the automation is enabled
- id String
- Automation ID (UUID)
- name String
- Name of the automation
- trigger
Get
Automation Trigger - The criteria for which events this Automation covers and how it will respond
- updated String
- Timestamp of when the resource was updated (RFC3339)
- account
Id String - Account ID (UUID), defaults to the account set in the provider
- workspace
Id String - Workspace ID (UUID), defaults to the workspace set in the provider
- actions
Get
Automation Action[] - List of actions to perform when the automation is triggered
- actions
On GetResolves Automation Actions On Resolf[] - List of actions to perform when the automation is triggered
- actions
On GetTriggers Automation Actions On Trigger[] - List of actions to perform when the automation is triggered
- created string
- Timestamp of when the resource was created (RFC3339)
- description string
- Description of the automation
- enabled boolean
- Whether the automation is enabled
- id string
- Automation ID (UUID)
- name string
- Name of the automation
- trigger
Get
Automation Trigger - The criteria for which events this Automation covers and how it will respond
- updated string
- Timestamp of when the resource was updated (RFC3339)
- account
Id string - Account ID (UUID), defaults to the account set in the provider
- workspace
Id string - Workspace ID (UUID), defaults to the workspace set in the provider
- actions
Sequence[Get
Automation Action] - List of actions to perform when the automation is triggered
- actions_
on_ Sequence[Getresolves Automation Actions On Resolf] - List of actions to perform when the automation is triggered
- actions_
on_ Sequence[Gettriggers Automation Actions On Trigger] - List of actions to perform when the automation is triggered
- created str
- Timestamp of when the resource was created (RFC3339)
- description str
- Description of the automation
- enabled bool
- Whether the automation is enabled
- id str
- Automation ID (UUID)
- name str
- Name of the automation
- trigger
Get
Automation Trigger - The criteria for which events this Automation covers and how it will respond
- updated str
- Timestamp of when the resource was updated (RFC3339)
- account_
id str - Account ID (UUID), defaults to the account set in the provider
- workspace_
id str - Workspace ID (UUID), defaults to the workspace set in the provider
- actions List<Property Map>
- List of actions to perform when the automation is triggered
- actions
On List<Property Map>Resolves - List of actions to perform when the automation is triggered
- actions
On List<Property Map>Triggers - List of actions to perform when the automation is triggered
- created String
- Timestamp of when the resource was created (RFC3339)
- description String
- Description of the automation
- enabled Boolean
- Whether the automation is enabled
- id String
- Automation ID (UUID)
- name String
- Name of the automation
- trigger Property Map
- The criteria for which events this Automation covers and how it will respond
- updated String
- Timestamp of when the resource was updated (RFC3339)
- account
Id String - Account ID (UUID), defaults to the account set in the provider
- workspace
Id String - Workspace ID (UUID), defaults to the workspace set in the provider
Supporting Types
GetAutomationAction
- Automation
Id This property is required. string - (Automation) ID of the automation to apply this action to
- Block
Document Id This property is required. string - (Webhook / Notification) ID of the block to use
- Body
This property is required. string - (Notification) Body of the notification
- Deployment
Id This property is required. string - (Deployment) ID of the deployment to apply this action to
- Job
Variables This property is required. string - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode()
. - Message
This property is required. string - (Flow Run State Change) Message to associate with the state change
- Name
This property is required. string - (Flow Run State Change) Name of the state to change the flow run to
- Parameters
This property is required. string - (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode()
. - Payload
This property is required. string - (Webhook) Payload to send when calling the webhook
- Source
This property is required. string - (Deployment / Work Pool / Work Queue / Automation) Whether this action applies to a specific selected resource or to a specific resource by ID - 'selected' or 'inferred'
- State
This property is required. string - (Flow Run State Change) Type of state to change the flow run to
- Subject
This property is required. string - (Notification) Subject of the notification
- Type
This property is required. string - The type of action to perform
- Work
Pool Id This property is required. string - (Work Pool) ID of the work pool to apply this action to
- Work
Queue Id This property is required. string - (Work Queue) ID of the work queue to apply this action to
- Automation
Id This property is required. string - (Automation) ID of the automation to apply this action to
- Block
Document Id This property is required. string - (Webhook / Notification) ID of the block to use
- Body
This property is required. string - (Notification) Body of the notification
- Deployment
Id This property is required. string - (Deployment) ID of the deployment to apply this action to
- Job
Variables This property is required. string - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode()
. - Message
This property is required. string - (Flow Run State Change) Message to associate with the state change
- Name
This property is required. string - (Flow Run State Change) Name of the state to change the flow run to
- Parameters
This property is required. string - (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode()
. - Payload
This property is required. string - (Webhook) Payload to send when calling the webhook
- Source
This property is required. string - (Deployment / Work Pool / Work Queue / Automation) Whether this action applies to a specific selected resource or to a specific resource by ID - 'selected' or 'inferred'
- State
This property is required. string - (Flow Run State Change) Type of state to change the flow run to
- Subject
This property is required. string - (Notification) Subject of the notification
- Type
This property is required. string - The type of action to perform
- Work
Pool Id This property is required. string - (Work Pool) ID of the work pool to apply this action to
- Work
Queue Id This property is required. string - (Work Queue) ID of the work queue to apply this action to
- automation
Id This property is required. String - (Automation) ID of the automation to apply this action to
- block
Document Id This property is required. String - (Webhook / Notification) ID of the block to use
- body
This property is required. String - (Notification) Body of the notification
- deployment
Id This property is required. String - (Deployment) ID of the deployment to apply this action to
- job
Variables This property is required. String - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode()
. - message
This property is required. String - (Flow Run State Change) Message to associate with the state change
- name
This property is required. String - (Flow Run State Change) Name of the state to change the flow run to
- parameters
This property is required. String - (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode()
. - payload
This property is required. String - (Webhook) Payload to send when calling the webhook
- source
This property is required. String - (Deployment / Work Pool / Work Queue / Automation) Whether this action applies to a specific selected resource or to a specific resource by ID - 'selected' or 'inferred'
- state
This property is required. String - (Flow Run State Change) Type of state to change the flow run to
- subject
This property is required. String - (Notification) Subject of the notification
- type
This property is required. String - The type of action to perform
- work
Pool Id This property is required. String - (Work Pool) ID of the work pool to apply this action to
- work
Queue Id This property is required. String - (Work Queue) ID of the work queue to apply this action to
- automation
Id This property is required. string - (Automation) ID of the automation to apply this action to
- block
Document Id This property is required. string - (Webhook / Notification) ID of the block to use
- body
This property is required. string - (Notification) Body of the notification
- deployment
Id This property is required. string - (Deployment) ID of the deployment to apply this action to
- job
Variables This property is required. string - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode()
. - message
This property is required. string - (Flow Run State Change) Message to associate with the state change
- name
This property is required. string - (Flow Run State Change) Name of the state to change the flow run to
- parameters
This property is required. string - (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode()
. - payload
This property is required. string - (Webhook) Payload to send when calling the webhook
- source
This property is required. string - (Deployment / Work Pool / Work Queue / Automation) Whether this action applies to a specific selected resource or to a specific resource by ID - 'selected' or 'inferred'
- state
This property is required. string - (Flow Run State Change) Type of state to change the flow run to
- subject
This property is required. string - (Notification) Subject of the notification
- type
This property is required. string - The type of action to perform
- work
Pool Id This property is required. string - (Work Pool) ID of the work pool to apply this action to
- work
Queue Id This property is required. string - (Work Queue) ID of the work queue to apply this action to
- automation_
id This property is required. str - (Automation) ID of the automation to apply this action to
- block_
document_ id This property is required. str - (Webhook / Notification) ID of the block to use
- body
This property is required. str - (Notification) Body of the notification
- deployment_
id This property is required. str - (Deployment) ID of the deployment to apply this action to
- job_
variables This property is required. str - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode()
. - message
This property is required. str - (Flow Run State Change) Message to associate with the state change
- name
This property is required. str - (Flow Run State Change) Name of the state to change the flow run to
- parameters
This property is required. str - (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode()
. - payload
This property is required. str - (Webhook) Payload to send when calling the webhook
- source
This property is required. str - (Deployment / Work Pool / Work Queue / Automation) Whether this action applies to a specific selected resource or to a specific resource by ID - 'selected' or 'inferred'
- state
This property is required. str - (Flow Run State Change) Type of state to change the flow run to
- subject
This property is required. str - (Notification) Subject of the notification
- type
This property is required. str - The type of action to perform
- work_
pool_ id This property is required. str - (Work Pool) ID of the work pool to apply this action to
- work_
queue_ id This property is required. str - (Work Queue) ID of the work queue to apply this action to
- automation
Id This property is required. String - (Automation) ID of the automation to apply this action to
- block
Document Id This property is required. String - (Webhook / Notification) ID of the block to use
- body
This property is required. String - (Notification) Body of the notification
- deployment
Id This property is required. String - (Deployment) ID of the deployment to apply this action to
- job
Variables This property is required. String - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode()
. - message
This property is required. String - (Flow Run State Change) Message to associate with the state change
- name
This property is required. String - (Flow Run State Change) Name of the state to change the flow run to
- parameters
This property is required. String - (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode()
. - payload
This property is required. String - (Webhook) Payload to send when calling the webhook
- source
This property is required. String - (Deployment / Work Pool / Work Queue / Automation) Whether this action applies to a specific selected resource or to a specific resource by ID - 'selected' or 'inferred'
- state
This property is required. String - (Flow Run State Change) Type of state to change the flow run to
- subject
This property is required. String - (Notification) Subject of the notification
- type
This property is required. String - The type of action to perform
- work
Pool Id This property is required. String - (Work Pool) ID of the work pool to apply this action to
- work
Queue Id This property is required. String - (Work Queue) ID of the work queue to apply this action to
GetAutomationActionsOnResolf
- Automation
Id This property is required. string - (Automation) ID of the automation to apply this action to
- Block
Document Id This property is required. string - (Webhook / Notification) ID of the block to use
- Body
This property is required. string - (Notification) Body of the notification
- Deployment
Id This property is required. string - (Deployment) ID of the deployment to apply this action to
- Job
Variables This property is required. string - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode()
. - Message
This property is required. string - (Flow Run State Change) Message to associate with the state change
- Name
This property is required. string - (Flow Run State Change) Name of the state to change the flow run to
- Parameters
This property is required. string - (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode()
. - Payload
This property is required. string - (Webhook) Payload to send when calling the webhook
- Source
This property is required. string - (Deployment / Work Pool / Work Queue / Automation) Whether this action applies to a specific selected resource or to a specific resource by ID - 'selected' or 'inferred'
- State
This property is required. string - (Flow Run State Change) Type of state to change the flow run to
- Subject
This property is required. string - (Notification) Subject of the notification
- Type
This property is required. string - The type of action to perform
- Work
Pool Id This property is required. string - (Work Pool) ID of the work pool to apply this action to
- Work
Queue Id This property is required. string - (Work Queue) ID of the work queue to apply this action to
- Automation
Id This property is required. string - (Automation) ID of the automation to apply this action to
- Block
Document Id This property is required. string - (Webhook / Notification) ID of the block to use
- Body
This property is required. string - (Notification) Body of the notification
- Deployment
Id This property is required. string - (Deployment) ID of the deployment to apply this action to
- Job
Variables This property is required. string - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode()
. - Message
This property is required. string - (Flow Run State Change) Message to associate with the state change
- Name
This property is required. string - (Flow Run State Change) Name of the state to change the flow run to
- Parameters
This property is required. string - (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode()
. - Payload
This property is required. string - (Webhook) Payload to send when calling the webhook
- Source
This property is required. string - (Deployment / Work Pool / Work Queue / Automation) Whether this action applies to a specific selected resource or to a specific resource by ID - 'selected' or 'inferred'
- State
This property is required. string - (Flow Run State Change) Type of state to change the flow run to
- Subject
This property is required. string - (Notification) Subject of the notification
- Type
This property is required. string - The type of action to perform
- Work
Pool Id This property is required. string - (Work Pool) ID of the work pool to apply this action to
- Work
Queue Id This property is required. string - (Work Queue) ID of the work queue to apply this action to
- automation
Id This property is required. String - (Automation) ID of the automation to apply this action to
- block
Document Id This property is required. String - (Webhook / Notification) ID of the block to use
- body
This property is required. String - (Notification) Body of the notification
- deployment
Id This property is required. String - (Deployment) ID of the deployment to apply this action to
- job
Variables This property is required. String - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode()
. - message
This property is required. String - (Flow Run State Change) Message to associate with the state change
- name
This property is required. String - (Flow Run State Change) Name of the state to change the flow run to
- parameters
This property is required. String - (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode()
. - payload
This property is required. String - (Webhook) Payload to send when calling the webhook
- source
This property is required. String - (Deployment / Work Pool / Work Queue / Automation) Whether this action applies to a specific selected resource or to a specific resource by ID - 'selected' or 'inferred'
- state
This property is required. String - (Flow Run State Change) Type of state to change the flow run to
- subject
This property is required. String - (Notification) Subject of the notification
- type
This property is required. String - The type of action to perform
- work
Pool Id This property is required. String - (Work Pool) ID of the work pool to apply this action to
- work
Queue Id This property is required. String - (Work Queue) ID of the work queue to apply this action to
- automation
Id This property is required. string - (Automation) ID of the automation to apply this action to
- block
Document Id This property is required. string - (Webhook / Notification) ID of the block to use
- body
This property is required. string - (Notification) Body of the notification
- deployment
Id This property is required. string - (Deployment) ID of the deployment to apply this action to
- job
Variables This property is required. string - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode()
. - message
This property is required. string - (Flow Run State Change) Message to associate with the state change
- name
This property is required. string - (Flow Run State Change) Name of the state to change the flow run to
- parameters
This property is required. string - (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode()
. - payload
This property is required. string - (Webhook) Payload to send when calling the webhook
- source
This property is required. string - (Deployment / Work Pool / Work Queue / Automation) Whether this action applies to a specific selected resource or to a specific resource by ID - 'selected' or 'inferred'
- state
This property is required. string - (Flow Run State Change) Type of state to change the flow run to
- subject
This property is required. string - (Notification) Subject of the notification
- type
This property is required. string - The type of action to perform
- work
Pool Id This property is required. string - (Work Pool) ID of the work pool to apply this action to
- work
Queue Id This property is required. string - (Work Queue) ID of the work queue to apply this action to
- automation_
id This property is required. str - (Automation) ID of the automation to apply this action to
- block_
document_ id This property is required. str - (Webhook / Notification) ID of the block to use
- body
This property is required. str - (Notification) Body of the notification
- deployment_
id This property is required. str - (Deployment) ID of the deployment to apply this action to
- job_
variables This property is required. str - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode()
. - message
This property is required. str - (Flow Run State Change) Message to associate with the state change
- name
This property is required. str - (Flow Run State Change) Name of the state to change the flow run to
- parameters
This property is required. str - (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode()
. - payload
This property is required. str - (Webhook) Payload to send when calling the webhook
- source
This property is required. str - (Deployment / Work Pool / Work Queue / Automation) Whether this action applies to a specific selected resource or to a specific resource by ID - 'selected' or 'inferred'
- state
This property is required. str - (Flow Run State Change) Type of state to change the flow run to
- subject
This property is required. str - (Notification) Subject of the notification
- type
This property is required. str - The type of action to perform
- work_
pool_ id This property is required. str - (Work Pool) ID of the work pool to apply this action to
- work_
queue_ id This property is required. str - (Work Queue) ID of the work queue to apply this action to
- automation
Id This property is required. String - (Automation) ID of the automation to apply this action to
- block
Document Id This property is required. String - (Webhook / Notification) ID of the block to use
- body
This property is required. String - (Notification) Body of the notification
- deployment
Id This property is required. String - (Deployment) ID of the deployment to apply this action to
- job
Variables This property is required. String - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode()
. - message
This property is required. String - (Flow Run State Change) Message to associate with the state change
- name
This property is required. String - (Flow Run State Change) Name of the state to change the flow run to
- parameters
This property is required. String - (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode()
. - payload
This property is required. String - (Webhook) Payload to send when calling the webhook
- source
This property is required. String - (Deployment / Work Pool / Work Queue / Automation) Whether this action applies to a specific selected resource or to a specific resource by ID - 'selected' or 'inferred'
- state
This property is required. String - (Flow Run State Change) Type of state to change the flow run to
- subject
This property is required. String - (Notification) Subject of the notification
- type
This property is required. String - The type of action to perform
- work
Pool Id This property is required. String - (Work Pool) ID of the work pool to apply this action to
- work
Queue Id This property is required. String - (Work Queue) ID of the work queue to apply this action to
GetAutomationActionsOnTrigger
- Automation
Id This property is required. string - (Automation) ID of the automation to apply this action to
- Block
Document Id This property is required. string - (Webhook / Notification) ID of the block to use
- Body
This property is required. string - (Notification) Body of the notification
- Deployment
Id This property is required. string - (Deployment) ID of the deployment to apply this action to
- Job
Variables This property is required. string - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode()
. - Message
This property is required. string - (Flow Run State Change) Message to associate with the state change
- Name
This property is required. string - (Flow Run State Change) Name of the state to change the flow run to
- Parameters
This property is required. string - (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode()
. - Payload
This property is required. string - (Webhook) Payload to send when calling the webhook
- Source
This property is required. string - (Deployment / Work Pool / Work Queue / Automation) Whether this action applies to a specific selected resource or to a specific resource by ID - 'selected' or 'inferred'
- State
This property is required. string - (Flow Run State Change) Type of state to change the flow run to
- Subject
This property is required. string - (Notification) Subject of the notification
- Type
This property is required. string - The type of action to perform
- Work
Pool Id This property is required. string - (Work Pool) ID of the work pool to apply this action to
- Work
Queue Id This property is required. string - (Work Queue) ID of the work queue to apply this action to
- Automation
Id This property is required. string - (Automation) ID of the automation to apply this action to
- Block
Document Id This property is required. string - (Webhook / Notification) ID of the block to use
- Body
This property is required. string - (Notification) Body of the notification
- Deployment
Id This property is required. string - (Deployment) ID of the deployment to apply this action to
- Job
Variables This property is required. string - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode()
. - Message
This property is required. string - (Flow Run State Change) Message to associate with the state change
- Name
This property is required. string - (Flow Run State Change) Name of the state to change the flow run to
- Parameters
This property is required. string - (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode()
. - Payload
This property is required. string - (Webhook) Payload to send when calling the webhook
- Source
This property is required. string - (Deployment / Work Pool / Work Queue / Automation) Whether this action applies to a specific selected resource or to a specific resource by ID - 'selected' or 'inferred'
- State
This property is required. string - (Flow Run State Change) Type of state to change the flow run to
- Subject
This property is required. string - (Notification) Subject of the notification
- Type
This property is required. string - The type of action to perform
- Work
Pool Id This property is required. string - (Work Pool) ID of the work pool to apply this action to
- Work
Queue Id This property is required. string - (Work Queue) ID of the work queue to apply this action to
- automation
Id This property is required. String - (Automation) ID of the automation to apply this action to
- block
Document Id This property is required. String - (Webhook / Notification) ID of the block to use
- body
This property is required. String - (Notification) Body of the notification
- deployment
Id This property is required. String - (Deployment) ID of the deployment to apply this action to
- job
Variables This property is required. String - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode()
. - message
This property is required. String - (Flow Run State Change) Message to associate with the state change
- name
This property is required. String - (Flow Run State Change) Name of the state to change the flow run to
- parameters
This property is required. String - (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode()
. - payload
This property is required. String - (Webhook) Payload to send when calling the webhook
- source
This property is required. String - (Deployment / Work Pool / Work Queue / Automation) Whether this action applies to a specific selected resource or to a specific resource by ID - 'selected' or 'inferred'
- state
This property is required. String - (Flow Run State Change) Type of state to change the flow run to
- subject
This property is required. String - (Notification) Subject of the notification
- type
This property is required. String - The type of action to perform
- work
Pool Id This property is required. String - (Work Pool) ID of the work pool to apply this action to
- work
Queue Id This property is required. String - (Work Queue) ID of the work queue to apply this action to
- automation
Id This property is required. string - (Automation) ID of the automation to apply this action to
- block
Document Id This property is required. string - (Webhook / Notification) ID of the block to use
- body
This property is required. string - (Notification) Body of the notification
- deployment
Id This property is required. string - (Deployment) ID of the deployment to apply this action to
- job
Variables This property is required. string - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode()
. - message
This property is required. string - (Flow Run State Change) Message to associate with the state change
- name
This property is required. string - (Flow Run State Change) Name of the state to change the flow run to
- parameters
This property is required. string - (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode()
. - payload
This property is required. string - (Webhook) Payload to send when calling the webhook
- source
This property is required. string - (Deployment / Work Pool / Work Queue / Automation) Whether this action applies to a specific selected resource or to a specific resource by ID - 'selected' or 'inferred'
- state
This property is required. string - (Flow Run State Change) Type of state to change the flow run to
- subject
This property is required. string - (Notification) Subject of the notification
- type
This property is required. string - The type of action to perform
- work
Pool Id This property is required. string - (Work Pool) ID of the work pool to apply this action to
- work
Queue Id This property is required. string - (Work Queue) ID of the work queue to apply this action to
- automation_
id This property is required. str - (Automation) ID of the automation to apply this action to
- block_
document_ id This property is required. str - (Webhook / Notification) ID of the block to use
- body
This property is required. str - (Notification) Body of the notification
- deployment_
id This property is required. str - (Deployment) ID of the deployment to apply this action to
- job_
variables This property is required. str - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode()
. - message
This property is required. str - (Flow Run State Change) Message to associate with the state change
- name
This property is required. str - (Flow Run State Change) Name of the state to change the flow run to
- parameters
This property is required. str - (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode()
. - payload
This property is required. str - (Webhook) Payload to send when calling the webhook
- source
This property is required. str - (Deployment / Work Pool / Work Queue / Automation) Whether this action applies to a specific selected resource or to a specific resource by ID - 'selected' or 'inferred'
- state
This property is required. str - (Flow Run State Change) Type of state to change the flow run to
- subject
This property is required. str - (Notification) Subject of the notification
- type
This property is required. str - The type of action to perform
- work_
pool_ id This property is required. str - (Work Pool) ID of the work pool to apply this action to
- work_
queue_ id This property is required. str - (Work Queue) ID of the work queue to apply this action to
- automation
Id This property is required. String - (Automation) ID of the automation to apply this action to
- block
Document Id This property is required. String - (Webhook / Notification) ID of the block to use
- body
This property is required. String - (Notification) Body of the notification
- deployment
Id This property is required. String - (Deployment) ID of the deployment to apply this action to
- job
Variables This property is required. String - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode()
. - message
This property is required. String - (Flow Run State Change) Message to associate with the state change
- name
This property is required. String - (Flow Run State Change) Name of the state to change the flow run to
- parameters
This property is required. String - (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode()
. - payload
This property is required. String - (Webhook) Payload to send when calling the webhook
- source
This property is required. String - (Deployment / Work Pool / Work Queue / Automation) Whether this action applies to a specific selected resource or to a specific resource by ID - 'selected' or 'inferred'
- state
This property is required. String - (Flow Run State Change) Type of state to change the flow run to
- subject
This property is required. String - (Notification) Subject of the notification
- type
This property is required. String - The type of action to perform
- work
Pool Id This property is required. String - (Work Pool) ID of the work pool to apply this action to
- work
Queue Id This property is required. String - (Work Queue) ID of the work queue to apply this action to
GetAutomationTrigger
- Compound
This property is required. GetAutomation Trigger Compound - A composite trigger that requires some number of triggers to have fired within the given time period
- Event
This property is required. GetAutomation Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- Metric
This property is required. GetAutomation Trigger Metric - A trigger that fires based on the results of a metric query
- Sequence
This property is required. GetAutomation Trigger Sequence - A composite trigger that requires triggers to fire in a specific order
- Compound
This property is required. GetAutomation Trigger Compound - A composite trigger that requires some number of triggers to have fired within the given time period
- Event
This property is required. GetAutomation Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- Metric
This property is required. GetAutomation Trigger Metric - A trigger that fires based on the results of a metric query
- Sequence
This property is required. GetAutomation Trigger Sequence - A composite trigger that requires triggers to fire in a specific order
- compound
This property is required. GetAutomation Trigger Compound - A composite trigger that requires some number of triggers to have fired within the given time period
- event
This property is required. GetAutomation Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
This property is required. GetAutomation Trigger Metric - A trigger that fires based on the results of a metric query
- sequence
This property is required. GetAutomation Trigger Sequence - A composite trigger that requires triggers to fire in a specific order
- compound
This property is required. GetAutomation Trigger Compound - A composite trigger that requires some number of triggers to have fired within the given time period
- event
This property is required. GetAutomation Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
This property is required. GetAutomation Trigger Metric - A trigger that fires based on the results of a metric query
- sequence
This property is required. GetAutomation Trigger Sequence - A composite trigger that requires triggers to fire in a specific order
- compound
This property is required. GetAutomation Trigger Compound - A composite trigger that requires some number of triggers to have fired within the given time period
- event
This property is required. GetAutomation Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
This property is required. GetAutomation Trigger Metric - A trigger that fires based on the results of a metric query
- sequence
This property is required. GetAutomation Trigger Sequence - A composite trigger that requires triggers to fire in a specific order
- compound
This property is required. Property Map - A composite trigger that requires some number of triggers to have fired within the given time period
- event
This property is required. Property Map - A trigger that fires based on the presence or absence of events within a given period of time
- metric
This property is required. Property Map - A trigger that fires based on the results of a metric query
- sequence
This property is required. Property Map - A composite trigger that requires triggers to fire in a specific order
GetAutomationTriggerCompound
- Require
This property is required. object - How many triggers must fire ('any', 'all', or a number)
- Triggers
This property is required. List<GetAutomation Trigger Compound Trigger> - The ordered list of triggers that must fire in sequence
- Within
This property is required. double - The time period in seconds over which the events must occur
- Require
This property is required. interface{} - How many triggers must fire ('any', 'all', or a number)
- Triggers
This property is required. []GetAutomation Trigger Compound Trigger - The ordered list of triggers that must fire in sequence
- Within
This property is required. float64 - The time period in seconds over which the events must occur
- require
This property is required. Object - How many triggers must fire ('any', 'all', or a number)
- triggers
This property is required. List<GetAutomation Trigger Compound Trigger> - The ordered list of triggers that must fire in sequence
- within
This property is required. Double - The time period in seconds over which the events must occur
- require
This property is required. any - How many triggers must fire ('any', 'all', or a number)
- triggers
This property is required. GetAutomation Trigger Compound Trigger[] - The ordered list of triggers that must fire in sequence
- within
This property is required. number - The time period in seconds over which the events must occur
- require
This property is required. Any - How many triggers must fire ('any', 'all', or a number)
- triggers
This property is required. Sequence[GetAutomation Trigger Compound Trigger] - The ordered list of triggers that must fire in sequence
- within
This property is required. float - The time period in seconds over which the events must occur
- require
This property is required. Any - How many triggers must fire ('any', 'all', or a number)
- triggers
This property is required. List<Property Map> - The ordered list of triggers that must fire in sequence
- within
This property is required. Number - The time period in seconds over which the events must occur
GetAutomationTriggerCompoundTrigger
- Event
This property is required. GetAutomation Trigger Compound Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- Metric
This property is required. GetAutomation Trigger Compound Trigger Metric - A trigger that fires based on the results of a metric query
- Event
This property is required. GetAutomation Trigger Compound Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- Metric
This property is required. GetAutomation Trigger Compound Trigger Metric - A trigger that fires based on the results of a metric query
- event
This property is required. GetAutomation Trigger Compound Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
This property is required. GetAutomation Trigger Compound Trigger Metric - A trigger that fires based on the results of a metric query
- event
This property is required. GetAutomation Trigger Compound Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
This property is required. GetAutomation Trigger Compound Trigger Metric - A trigger that fires based on the results of a metric query
- event
This property is required. GetAutomation Trigger Compound Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
This property is required. GetAutomation Trigger Compound Trigger Metric - A trigger that fires based on the results of a metric query
- event
This property is required. Property Map - A trigger that fires based on the presence or absence of events within a given period of time
- metric
This property is required. Property Map - A trigger that fires based on the results of a metric query
GetAutomationTriggerCompoundTriggerEvent
- Afters
This property is required. List<string> - The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- Expects
This property is required. List<string> - The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- For
Eaches This property is required. List<string> - Evaluate the trigger separately for each distinct value of these labels on the resource
- Match
This property is required. string - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. string- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - Posture
This property is required. string - The posture of this trigger, either Reactive or Proactive
- Threshold
This property is required. double - The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- Within
This property is required. double - The time period in seconds over which the events must occur
- Afters
This property is required. []string - The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- Expects
This property is required. []string - The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- For
Eaches This property is required. []string - Evaluate the trigger separately for each distinct value of these labels on the resource
- Match
This property is required. string - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. string- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - Posture
This property is required. string - The posture of this trigger, either Reactive or Proactive
- Threshold
This property is required. float64 - The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- Within
This property is required. float64 - The time period in seconds over which the events must occur
- afters
This property is required. List<String> - The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects
This property is required. List<String> - The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for
Eaches This property is required. List<String> - Evaluate the trigger separately for each distinct value of these labels on the resource
- match
This property is required. String - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. String- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - posture
This property is required. String - The posture of this trigger, either Reactive or Proactive
- threshold
This property is required. Double - The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within
This property is required. Double - The time period in seconds over which the events must occur
- afters
This property is required. string[] - The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects
This property is required. string[] - The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for
Eaches This property is required. string[] - Evaluate the trigger separately for each distinct value of these labels on the resource
- match
This property is required. string - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. string- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - posture
This property is required. string - The posture of this trigger, either Reactive or Proactive
- threshold
This property is required. number - The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within
This property is required. number - The time period in seconds over which the events must occur
- afters
This property is required. Sequence[str] - The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects
This property is required. Sequence[str] - The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for_
eaches This property is required. Sequence[str] - Evaluate the trigger separately for each distinct value of these labels on the resource
- match
This property is required. str - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. str- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - posture
This property is required. str - The posture of this trigger, either Reactive or Proactive
- threshold
This property is required. float - The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within
This property is required. float - The time period in seconds over which the events must occur
- afters
This property is required. List<String> - The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects
This property is required. List<String> - The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for
Eaches This property is required. List<String> - Evaluate the trigger separately for each distinct value of these labels on the resource
- match
This property is required. String - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. String- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - posture
This property is required. String - The posture of this trigger, either Reactive or Proactive
- threshold
This property is required. Number - The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within
This property is required. Number - The time period in seconds over which the events must occur
GetAutomationTriggerCompoundTriggerMetric
- Match
This property is required. string - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. string- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - Metric
This property is required. GetAutomation Trigger Compound Trigger Metric Metric
- Match
This property is required. string - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. string- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - Metric
This property is required. GetAutomation Trigger Compound Trigger Metric Metric
- match
This property is required. String - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. String- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - metric
This property is required. GetAutomation Trigger Compound Trigger Metric Metric
- match
This property is required. string - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. string- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - metric
This property is required. GetAutomation Trigger Compound Trigger Metric Metric
- match
This property is required. str - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. str- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - metric
This property is required. GetAutomation Trigger Compound Trigger Metric Metric
- match
This property is required. String - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. String- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - metric
This property is required. Property Map
GetAutomationTriggerCompoundTriggerMetricMetric
- Firing
For This property is required. double - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- Name
This property is required. string - The name of the metric to query
- Operator
This property is required. string - The comparative operator used to evaluate the query result against the threshold value
- Range
This property is required. double - The lookback duration (seconds) for a metric query. This duration is used to determine the time range over which the query will be executed.
- Threshold
This property is required. double - The threshold value against which we'll compare the query results
- Firing
For This property is required. float64 - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- Name
This property is required. string - The name of the metric to query
- Operator
This property is required. string - The comparative operator used to evaluate the query result against the threshold value
- Range
This property is required. float64 - The lookback duration (seconds) for a metric query. This duration is used to determine the time range over which the query will be executed.
- Threshold
This property is required. float64 - The threshold value against which we'll compare the query results
- firing
For This property is required. Double - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name
This property is required. String - The name of the metric to query
- operator
This property is required. String - The comparative operator used to evaluate the query result against the threshold value
- range
This property is required. Double - The lookback duration (seconds) for a metric query. This duration is used to determine the time range over which the query will be executed.
- threshold
This property is required. Double - The threshold value against which we'll compare the query results
- firing
For This property is required. number - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name
This property is required. string - The name of the metric to query
- operator
This property is required. string - The comparative operator used to evaluate the query result against the threshold value
- range
This property is required. number - The lookback duration (seconds) for a metric query. This duration is used to determine the time range over which the query will be executed.
- threshold
This property is required. number - The threshold value against which we'll compare the query results
- firing_
for This property is required. float - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name
This property is required. str - The name of the metric to query
- operator
This property is required. str - The comparative operator used to evaluate the query result against the threshold value
- range
This property is required. float - The lookback duration (seconds) for a metric query. This duration is used to determine the time range over which the query will be executed.
- threshold
This property is required. float - The threshold value against which we'll compare the query results
- firing
For This property is required. Number - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name
This property is required. String - The name of the metric to query
- operator
This property is required. String - The comparative operator used to evaluate the query result against the threshold value
- range
This property is required. Number - The lookback duration (seconds) for a metric query. This duration is used to determine the time range over which the query will be executed.
- threshold
This property is required. Number - The threshold value against which we'll compare the query results
GetAutomationTriggerEvent
- Afters
This property is required. List<string> - The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- Expects
This property is required. List<string> - The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- For
Eaches This property is required. List<string> - Evaluate the trigger separately for each distinct value of these labels on the resource
- Match
This property is required. string - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. string- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - Posture
This property is required. string - The posture of this trigger, either Reactive or Proactive
- Threshold
This property is required. double - The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- Within
This property is required. double - The time period in seconds over which the events must occur
- Afters
This property is required. []string - The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- Expects
This property is required. []string - The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- For
Eaches This property is required. []string - Evaluate the trigger separately for each distinct value of these labels on the resource
- Match
This property is required. string - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. string- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - Posture
This property is required. string - The posture of this trigger, either Reactive or Proactive
- Threshold
This property is required. float64 - The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- Within
This property is required. float64 - The time period in seconds over which the events must occur
- afters
This property is required. List<String> - The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects
This property is required. List<String> - The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for
Eaches This property is required. List<String> - Evaluate the trigger separately for each distinct value of these labels on the resource
- match
This property is required. String - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. String- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - posture
This property is required. String - The posture of this trigger, either Reactive or Proactive
- threshold
This property is required. Double - The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within
This property is required. Double - The time period in seconds over which the events must occur
- afters
This property is required. string[] - The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects
This property is required. string[] - The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for
Eaches This property is required. string[] - Evaluate the trigger separately for each distinct value of these labels on the resource
- match
This property is required. string - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. string- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - posture
This property is required. string - The posture of this trigger, either Reactive or Proactive
- threshold
This property is required. number - The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within
This property is required. number - The time period in seconds over which the events must occur
- afters
This property is required. Sequence[str] - The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects
This property is required. Sequence[str] - The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for_
eaches This property is required. Sequence[str] - Evaluate the trigger separately for each distinct value of these labels on the resource
- match
This property is required. str - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. str- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - posture
This property is required. str - The posture of this trigger, either Reactive or Proactive
- threshold
This property is required. float - The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within
This property is required. float - The time period in seconds over which the events must occur
- afters
This property is required. List<String> - The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects
This property is required. List<String> - The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for
Eaches This property is required. List<String> - Evaluate the trigger separately for each distinct value of these labels on the resource
- match
This property is required. String - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. String- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - posture
This property is required. String - The posture of this trigger, either Reactive or Proactive
- threshold
This property is required. Number - The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within
This property is required. Number - The time period in seconds over which the events must occur
GetAutomationTriggerMetric
- Match
This property is required. string - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. string- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - Metric
This property is required. GetAutomation Trigger Metric Metric
- Match
This property is required. string - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. string- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - Metric
This property is required. GetAutomation Trigger Metric Metric
- match
This property is required. String - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. String- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - metric
This property is required. GetAutomation Trigger Metric Metric
- match
This property is required. string - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. string- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - metric
This property is required. GetAutomation Trigger Metric Metric
- match
This property is required. str - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. str- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - metric
This property is required. GetAutomation Trigger Metric Metric
- match
This property is required. String - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. String- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - metric
This property is required. Property Map
GetAutomationTriggerMetricMetric
- Firing
For This property is required. double - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- Name
This property is required. string - The name of the metric to query
- Operator
This property is required. string - The comparative operator used to evaluate the query result against the threshold value
- Range
This property is required. double - The lookback duration (seconds) for a metric query. This duration is used to determine the time range over which the query will be executed.
- Threshold
This property is required. double - The threshold value against which we'll compare the query results
- Firing
For This property is required. float64 - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- Name
This property is required. string - The name of the metric to query
- Operator
This property is required. string - The comparative operator used to evaluate the query result against the threshold value
- Range
This property is required. float64 - The lookback duration (seconds) for a metric query. This duration is used to determine the time range over which the query will be executed.
- Threshold
This property is required. float64 - The threshold value against which we'll compare the query results
- firing
For This property is required. Double - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name
This property is required. String - The name of the metric to query
- operator
This property is required. String - The comparative operator used to evaluate the query result against the threshold value
- range
This property is required. Double - The lookback duration (seconds) for a metric query. This duration is used to determine the time range over which the query will be executed.
- threshold
This property is required. Double - The threshold value against which we'll compare the query results
- firing
For This property is required. number - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name
This property is required. string - The name of the metric to query
- operator
This property is required. string - The comparative operator used to evaluate the query result against the threshold value
- range
This property is required. number - The lookback duration (seconds) for a metric query. This duration is used to determine the time range over which the query will be executed.
- threshold
This property is required. number - The threshold value against which we'll compare the query results
- firing_
for This property is required. float - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name
This property is required. str - The name of the metric to query
- operator
This property is required. str - The comparative operator used to evaluate the query result against the threshold value
- range
This property is required. float - The lookback duration (seconds) for a metric query. This duration is used to determine the time range over which the query will be executed.
- threshold
This property is required. float - The threshold value against which we'll compare the query results
- firing
For This property is required. Number - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name
This property is required. String - The name of the metric to query
- operator
This property is required. String - The comparative operator used to evaluate the query result against the threshold value
- range
This property is required. Number - The lookback duration (seconds) for a metric query. This duration is used to determine the time range over which the query will be executed.
- threshold
This property is required. Number - The threshold value against which we'll compare the query results
GetAutomationTriggerSequence
- Triggers
This property is required. List<GetAutomation Trigger Sequence Trigger> - The ordered list of triggers that must fire in sequence
- Within
This property is required. double - The time period in seconds over which the events must occur
- Triggers
This property is required. []GetAutomation Trigger Sequence Trigger - The ordered list of triggers that must fire in sequence
- Within
This property is required. float64 - The time period in seconds over which the events must occur
- triggers
This property is required. List<GetAutomation Trigger Sequence Trigger> - The ordered list of triggers that must fire in sequence
- within
This property is required. Double - The time period in seconds over which the events must occur
- triggers
This property is required. GetAutomation Trigger Sequence Trigger[] - The ordered list of triggers that must fire in sequence
- within
This property is required. number - The time period in seconds over which the events must occur
- triggers
This property is required. Sequence[GetAutomation Trigger Sequence Trigger] - The ordered list of triggers that must fire in sequence
- within
This property is required. float - The time period in seconds over which the events must occur
- triggers
This property is required. List<Property Map> - The ordered list of triggers that must fire in sequence
- within
This property is required. Number - The time period in seconds over which the events must occur
GetAutomationTriggerSequenceTrigger
- Event
This property is required. GetAutomation Trigger Sequence Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- Metric
This property is required. GetAutomation Trigger Sequence Trigger Metric - A trigger that fires based on the results of a metric query
- Event
This property is required. GetAutomation Trigger Sequence Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- Metric
This property is required. GetAutomation Trigger Sequence Trigger Metric - A trigger that fires based on the results of a metric query
- event
This property is required. GetAutomation Trigger Sequence Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
This property is required. GetAutomation Trigger Sequence Trigger Metric - A trigger that fires based on the results of a metric query
- event
This property is required. GetAutomation Trigger Sequence Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
This property is required. GetAutomation Trigger Sequence Trigger Metric - A trigger that fires based on the results of a metric query
- event
This property is required. GetAutomation Trigger Sequence Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
This property is required. GetAutomation Trigger Sequence Trigger Metric - A trigger that fires based on the results of a metric query
- event
This property is required. Property Map - A trigger that fires based on the presence or absence of events within a given period of time
- metric
This property is required. Property Map - A trigger that fires based on the results of a metric query
GetAutomationTriggerSequenceTriggerEvent
- Afters
This property is required. List<string> - The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- Expects
This property is required. List<string> - The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- For
Eaches This property is required. List<string> - Evaluate the trigger separately for each distinct value of these labels on the resource
- Match
This property is required. string - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. string- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - Posture
This property is required. string - The posture of this trigger, either Reactive or Proactive
- Threshold
This property is required. double - The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- Within
This property is required. double - The time period in seconds over which the events must occur
- Afters
This property is required. []string - The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- Expects
This property is required. []string - The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- For
Eaches This property is required. []string - Evaluate the trigger separately for each distinct value of these labels on the resource
- Match
This property is required. string - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. string- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - Posture
This property is required. string - The posture of this trigger, either Reactive or Proactive
- Threshold
This property is required. float64 - The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- Within
This property is required. float64 - The time period in seconds over which the events must occur
- afters
This property is required. List<String> - The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects
This property is required. List<String> - The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for
Eaches This property is required. List<String> - Evaluate the trigger separately for each distinct value of these labels on the resource
- match
This property is required. String - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. String- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - posture
This property is required. String - The posture of this trigger, either Reactive or Proactive
- threshold
This property is required. Double - The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within
This property is required. Double - The time period in seconds over which the events must occur
- afters
This property is required. string[] - The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects
This property is required. string[] - The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for
Eaches This property is required. string[] - Evaluate the trigger separately for each distinct value of these labels on the resource
- match
This property is required. string - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. string- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - posture
This property is required. string - The posture of this trigger, either Reactive or Proactive
- threshold
This property is required. number - The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within
This property is required. number - The time period in seconds over which the events must occur
- afters
This property is required. Sequence[str] - The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects
This property is required. Sequence[str] - The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for_
eaches This property is required. Sequence[str] - Evaluate the trigger separately for each distinct value of these labels on the resource
- match
This property is required. str - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. str- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - posture
This property is required. str - The posture of this trigger, either Reactive or Proactive
- threshold
This property is required. float - The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within
This property is required. float - The time period in seconds over which the events must occur
- afters
This property is required. List<String> - The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects
This property is required. List<String> - The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for
Eaches This property is required. List<String> - Evaluate the trigger separately for each distinct value of these labels on the resource
- match
This property is required. String - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. String- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - posture
This property is required. String - The posture of this trigger, either Reactive or Proactive
- threshold
This property is required. Number - The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within
This property is required. Number - The time period in seconds over which the events must occur
GetAutomationTriggerSequenceTriggerMetric
- Match
This property is required. string - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. string- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - Metric
This property is required. GetAutomation Trigger Sequence Trigger Metric Metric
- Match
This property is required. string - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. string- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - Metric
This property is required. GetAutomation Trigger Sequence Trigger Metric Metric
- match
This property is required. String - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. String- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - metric
This property is required. GetAutomation Trigger Sequence Trigger Metric Metric
- match
This property is required. string - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. string- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - metric
This property is required. GetAutomation Trigger Sequence Trigger Metric Metric
- match
This property is required. str - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. str- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - metric
This property is required. GetAutomation Trigger Sequence Trigger Metric Metric
- match
This property is required. String - (JSON) Resource specification labels which this trigger will match. Use
jsonencode()
. This property is required. String- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode()
. - metric
This property is required. Property Map
GetAutomationTriggerSequenceTriggerMetricMetric
- Firing
For This property is required. double - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- Name
This property is required. string - The name of the metric to query
- Operator
This property is required. string - The comparative operator used to evaluate the query result against the threshold value
- Range
This property is required. double - The lookback duration (seconds) for a metric query. This duration is used to determine the time range over which the query will be executed.
- Threshold
This property is required. double - The threshold value against which we'll compare the query results
- Firing
For This property is required. float64 - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- Name
This property is required. string - The name of the metric to query
- Operator
This property is required. string - The comparative operator used to evaluate the query result against the threshold value
- Range
This property is required. float64 - The lookback duration (seconds) for a metric query. This duration is used to determine the time range over which the query will be executed.
- Threshold
This property is required. float64 - The threshold value against which we'll compare the query results
- firing
For This property is required. Double - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name
This property is required. String - The name of the metric to query
- operator
This property is required. String - The comparative operator used to evaluate the query result against the threshold value
- range
This property is required. Double - The lookback duration (seconds) for a metric query. This duration is used to determine the time range over which the query will be executed.
- threshold
This property is required. Double - The threshold value against which we'll compare the query results
- firing
For This property is required. number - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name
This property is required. string - The name of the metric to query
- operator
This property is required. string - The comparative operator used to evaluate the query result against the threshold value
- range
This property is required. number - The lookback duration (seconds) for a metric query. This duration is used to determine the time range over which the query will be executed.
- threshold
This property is required. number - The threshold value against which we'll compare the query results
- firing_
for This property is required. float - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name
This property is required. str - The name of the metric to query
- operator
This property is required. str - The comparative operator used to evaluate the query result against the threshold value
- range
This property is required. float - The lookback duration (seconds) for a metric query. This duration is used to determine the time range over which the query will be executed.
- threshold
This property is required. float - The threshold value against which we'll compare the query results
- firing
For This property is required. Number - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name
This property is required. String - The name of the metric to query
- operator
This property is required. String - The comparative operator used to evaluate the query result against the threshold value
- range
This property is required. Number - The lookback duration (seconds) for a metric query. This duration is used to determine the time range over which the query will be executed.
- threshold
This property is required. Number - The threshold value against which we'll compare the query results
Package Details
- Repository
- prefect prefecthq/terraform-provider-prefect
- License
- Notes
- This Pulumi package is based on the
prefect
Terraform Provider.