prefect 2.90.0 published on Friday, Oct 31, 2025 by prefecthq
prefect.getAutomation
Start a Neo task
Explain and create a prefect.getAutomation resource
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, Hobby, Starter, Team, Pro, 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 dictionaryThe following arguments are supported:
- Id 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 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 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 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 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 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 string - (Automation) ID of the automation to apply this action to
- Block
Document stringId - (Webhook / Notification) ID of the block to use
- Body string
- (Notification) Body of the notification
- Deployment
Id string - (Deployment) ID of the deployment to apply this action to
- Job
Variables string - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode(). - Message string
- (Flow Run State Change) Message to associate with the state change
- Name string
- (Flow Run State Change) Name of the state to change the flow run to
- Parameters string
- (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode(). - Payload string
- (Webhook) Payload to send when calling the webhook
- Source 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 string
- (Flow Run State Change) Type of state to change the flow run to
- Subject string
- (Notification) Subject of the notification
- Type string
- The type of action to perform
- Work
Pool stringId - (Work Pool) ID of the work pool to apply this action to
- Work
Queue stringId - (Work Queue) ID of the work queue to apply this action to
- Automation
Id string - (Automation) ID of the automation to apply this action to
- Block
Document stringId - (Webhook / Notification) ID of the block to use
- Body string
- (Notification) Body of the notification
- Deployment
Id string - (Deployment) ID of the deployment to apply this action to
- Job
Variables string - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode(). - Message string
- (Flow Run State Change) Message to associate with the state change
- Name string
- (Flow Run State Change) Name of the state to change the flow run to
- Parameters string
- (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode(). - Payload string
- (Webhook) Payload to send when calling the webhook
- Source 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 string
- (Flow Run State Change) Type of state to change the flow run to
- Subject string
- (Notification) Subject of the notification
- Type string
- The type of action to perform
- Work
Pool stringId - (Work Pool) ID of the work pool to apply this action to
- Work
Queue stringId - (Work Queue) ID of the work queue to apply this action to
- automation
Id String - (Automation) ID of the automation to apply this action to
- block
Document StringId - (Webhook / Notification) ID of the block to use
- body String
- (Notification) Body of the notification
- deployment
Id String - (Deployment) ID of the deployment to apply this action to
- job
Variables String - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode(). - message String
- (Flow Run State Change) Message to associate with the state change
- name String
- (Flow Run State Change) Name of the state to change the flow run to
- parameters String
- (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode(). - payload String
- (Webhook) Payload to send when calling the webhook
- source 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 String
- (Flow Run State Change) Type of state to change the flow run to
- subject String
- (Notification) Subject of the notification
- type String
- The type of action to perform
- work
Pool StringId - (Work Pool) ID of the work pool to apply this action to
- work
Queue StringId - (Work Queue) ID of the work queue to apply this action to
- automation
Id string - (Automation) ID of the automation to apply this action to
- block
Document stringId - (Webhook / Notification) ID of the block to use
- body string
- (Notification) Body of the notification
- deployment
Id string - (Deployment) ID of the deployment to apply this action to
- job
Variables string - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode(). - message string
- (Flow Run State Change) Message to associate with the state change
- name string
- (Flow Run State Change) Name of the state to change the flow run to
- parameters string
- (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode(). - payload string
- (Webhook) Payload to send when calling the webhook
- source 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 string
- (Flow Run State Change) Type of state to change the flow run to
- subject string
- (Notification) Subject of the notification
- type string
- The type of action to perform
- work
Pool stringId - (Work Pool) ID of the work pool to apply this action to
- work
Queue stringId - (Work Queue) ID of the work queue to apply this action to
- automation_
id str - (Automation) ID of the automation to apply this action to
- block_
document_ strid - (Webhook / Notification) ID of the block to use
- body str
- (Notification) Body of the notification
- deployment_
id str - (Deployment) ID of the deployment to apply this action to
- job_
variables str - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode(). - message str
- (Flow Run State Change) Message to associate with the state change
- name str
- (Flow Run State Change) Name of the state to change the flow run to
- parameters str
- (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode(). - payload str
- (Webhook) Payload to send when calling the webhook
- source 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 str
- (Flow Run State Change) Type of state to change the flow run to
- subject str
- (Notification) Subject of the notification
- type str
- The type of action to perform
- work_
pool_ strid - (Work Pool) ID of the work pool to apply this action to
- work_
queue_ strid - (Work Queue) ID of the work queue to apply this action to
- automation
Id String - (Automation) ID of the automation to apply this action to
- block
Document StringId - (Webhook / Notification) ID of the block to use
- body String
- (Notification) Body of the notification
- deployment
Id String - (Deployment) ID of the deployment to apply this action to
- job
Variables String - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode(). - message String
- (Flow Run State Change) Message to associate with the state change
- name String
- (Flow Run State Change) Name of the state to change the flow run to
- parameters String
- (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode(). - payload String
- (Webhook) Payload to send when calling the webhook
- source 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 String
- (Flow Run State Change) Type of state to change the flow run to
- subject String
- (Notification) Subject of the notification
- type String
- The type of action to perform
- work
Pool StringId - (Work Pool) ID of the work pool to apply this action to
- work
Queue StringId - (Work Queue) ID of the work queue to apply this action to
GetAutomationActionsOnResolf
- Automation
Id string - (Automation) ID of the automation to apply this action to
- Block
Document stringId - (Webhook / Notification) ID of the block to use
- Body string
- (Notification) Body of the notification
- Deployment
Id string - (Deployment) ID of the deployment to apply this action to
- Job
Variables string - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode(). - Message string
- (Flow Run State Change) Message to associate with the state change
- Name string
- (Flow Run State Change) Name of the state to change the flow run to
- Parameters string
- (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode(). - Payload string
- (Webhook) Payload to send when calling the webhook
- Source 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 string
- (Flow Run State Change) Type of state to change the flow run to
- Subject string
- (Notification) Subject of the notification
- Type string
- The type of action to perform
- Work
Pool stringId - (Work Pool) ID of the work pool to apply this action to
- Work
Queue stringId - (Work Queue) ID of the work queue to apply this action to
- Automation
Id string - (Automation) ID of the automation to apply this action to
- Block
Document stringId - (Webhook / Notification) ID of the block to use
- Body string
- (Notification) Body of the notification
- Deployment
Id string - (Deployment) ID of the deployment to apply this action to
- Job
Variables string - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode(). - Message string
- (Flow Run State Change) Message to associate with the state change
- Name string
- (Flow Run State Change) Name of the state to change the flow run to
- Parameters string
- (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode(). - Payload string
- (Webhook) Payload to send when calling the webhook
- Source 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 string
- (Flow Run State Change) Type of state to change the flow run to
- Subject string
- (Notification) Subject of the notification
- Type string
- The type of action to perform
- Work
Pool stringId - (Work Pool) ID of the work pool to apply this action to
- Work
Queue stringId - (Work Queue) ID of the work queue to apply this action to
- automation
Id String - (Automation) ID of the automation to apply this action to
- block
Document StringId - (Webhook / Notification) ID of the block to use
- body String
- (Notification) Body of the notification
- deployment
Id String - (Deployment) ID of the deployment to apply this action to
- job
Variables String - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode(). - message String
- (Flow Run State Change) Message to associate with the state change
- name String
- (Flow Run State Change) Name of the state to change the flow run to
- parameters String
- (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode(). - payload String
- (Webhook) Payload to send when calling the webhook
- source 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 String
- (Flow Run State Change) Type of state to change the flow run to
- subject String
- (Notification) Subject of the notification
- type String
- The type of action to perform
- work
Pool StringId - (Work Pool) ID of the work pool to apply this action to
- work
Queue StringId - (Work Queue) ID of the work queue to apply this action to
- automation
Id string - (Automation) ID of the automation to apply this action to
- block
Document stringId - (Webhook / Notification) ID of the block to use
- body string
- (Notification) Body of the notification
- deployment
Id string - (Deployment) ID of the deployment to apply this action to
- job
Variables string - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode(). - message string
- (Flow Run State Change) Message to associate with the state change
- name string
- (Flow Run State Change) Name of the state to change the flow run to
- parameters string
- (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode(). - payload string
- (Webhook) Payload to send when calling the webhook
- source 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 string
- (Flow Run State Change) Type of state to change the flow run to
- subject string
- (Notification) Subject of the notification
- type string
- The type of action to perform
- work
Pool stringId - (Work Pool) ID of the work pool to apply this action to
- work
Queue stringId - (Work Queue) ID of the work queue to apply this action to
- automation_
id str - (Automation) ID of the automation to apply this action to
- block_
document_ strid - (Webhook / Notification) ID of the block to use
- body str
- (Notification) Body of the notification
- deployment_
id str - (Deployment) ID of the deployment to apply this action to
- job_
variables str - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode(). - message str
- (Flow Run State Change) Message to associate with the state change
- name str
- (Flow Run State Change) Name of the state to change the flow run to
- parameters str
- (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode(). - payload str
- (Webhook) Payload to send when calling the webhook
- source 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 str
- (Flow Run State Change) Type of state to change the flow run to
- subject str
- (Notification) Subject of the notification
- type str
- The type of action to perform
- work_
pool_ strid - (Work Pool) ID of the work pool to apply this action to
- work_
queue_ strid - (Work Queue) ID of the work queue to apply this action to
- automation
Id String - (Automation) ID of the automation to apply this action to
- block
Document StringId - (Webhook / Notification) ID of the block to use
- body String
- (Notification) Body of the notification
- deployment
Id String - (Deployment) ID of the deployment to apply this action to
- job
Variables String - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode(). - message String
- (Flow Run State Change) Message to associate with the state change
- name String
- (Flow Run State Change) Name of the state to change the flow run to
- parameters String
- (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode(). - payload String
- (Webhook) Payload to send when calling the webhook
- source 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 String
- (Flow Run State Change) Type of state to change the flow run to
- subject String
- (Notification) Subject of the notification
- type String
- The type of action to perform
- work
Pool StringId - (Work Pool) ID of the work pool to apply this action to
- work
Queue StringId - (Work Queue) ID of the work queue to apply this action to
GetAutomationActionsOnTrigger
- Automation
Id string - (Automation) ID of the automation to apply this action to
- Block
Document stringId - (Webhook / Notification) ID of the block to use
- Body string
- (Notification) Body of the notification
- Deployment
Id string - (Deployment) ID of the deployment to apply this action to
- Job
Variables string - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode(). - Message string
- (Flow Run State Change) Message to associate with the state change
- Name string
- (Flow Run State Change) Name of the state to change the flow run to
- Parameters string
- (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode(). - Payload string
- (Webhook) Payload to send when calling the webhook
- Source 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 string
- (Flow Run State Change) Type of state to change the flow run to
- Subject string
- (Notification) Subject of the notification
- Type string
- The type of action to perform
- Work
Pool stringId - (Work Pool) ID of the work pool to apply this action to
- Work
Queue stringId - (Work Queue) ID of the work queue to apply this action to
- Automation
Id string - (Automation) ID of the automation to apply this action to
- Block
Document stringId - (Webhook / Notification) ID of the block to use
- Body string
- (Notification) Body of the notification
- Deployment
Id string - (Deployment) ID of the deployment to apply this action to
- Job
Variables string - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode(). - Message string
- (Flow Run State Change) Message to associate with the state change
- Name string
- (Flow Run State Change) Name of the state to change the flow run to
- Parameters string
- (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode(). - Payload string
- (Webhook) Payload to send when calling the webhook
- Source 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 string
- (Flow Run State Change) Type of state to change the flow run to
- Subject string
- (Notification) Subject of the notification
- Type string
- The type of action to perform
- Work
Pool stringId - (Work Pool) ID of the work pool to apply this action to
- Work
Queue stringId - (Work Queue) ID of the work queue to apply this action to
- automation
Id String - (Automation) ID of the automation to apply this action to
- block
Document StringId - (Webhook / Notification) ID of the block to use
- body String
- (Notification) Body of the notification
- deployment
Id String - (Deployment) ID of the deployment to apply this action to
- job
Variables String - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode(). - message String
- (Flow Run State Change) Message to associate with the state change
- name String
- (Flow Run State Change) Name of the state to change the flow run to
- parameters String
- (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode(). - payload String
- (Webhook) Payload to send when calling the webhook
- source 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 String
- (Flow Run State Change) Type of state to change the flow run to
- subject String
- (Notification) Subject of the notification
- type String
- The type of action to perform
- work
Pool StringId - (Work Pool) ID of the work pool to apply this action to
- work
Queue StringId - (Work Queue) ID of the work queue to apply this action to
- automation
Id string - (Automation) ID of the automation to apply this action to
- block
Document stringId - (Webhook / Notification) ID of the block to use
- body string
- (Notification) Body of the notification
- deployment
Id string - (Deployment) ID of the deployment to apply this action to
- job
Variables string - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode(). - message string
- (Flow Run State Change) Message to associate with the state change
- name string
- (Flow Run State Change) Name of the state to change the flow run to
- parameters string
- (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode(). - payload string
- (Webhook) Payload to send when calling the webhook
- source 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 string
- (Flow Run State Change) Type of state to change the flow run to
- subject string
- (Notification) Subject of the notification
- type string
- The type of action to perform
- work
Pool stringId - (Work Pool) ID of the work pool to apply this action to
- work
Queue stringId - (Work Queue) ID of the work queue to apply this action to
- automation_
id str - (Automation) ID of the automation to apply this action to
- block_
document_ strid - (Webhook / Notification) ID of the block to use
- body str
- (Notification) Body of the notification
- deployment_
id str - (Deployment) ID of the deployment to apply this action to
- job_
variables str - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode(). - message str
- (Flow Run State Change) Message to associate with the state change
- name str
- (Flow Run State Change) Name of the state to change the flow run to
- parameters str
- (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode(). - payload str
- (Webhook) Payload to send when calling the webhook
- source 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 str
- (Flow Run State Change) Type of state to change the flow run to
- subject str
- (Notification) Subject of the notification
- type str
- The type of action to perform
- work_
pool_ strid - (Work Pool) ID of the work pool to apply this action to
- work_
queue_ strid - (Work Queue) ID of the work queue to apply this action to
- automation
Id String - (Automation) ID of the automation to apply this action to
- block
Document StringId - (Webhook / Notification) ID of the block to use
- body String
- (Notification) Body of the notification
- deployment
Id String - (Deployment) ID of the deployment to apply this action to
- job
Variables String - (Deployment) (JSON) Job variables to pass to the created flow run. Use
jsonencode(). - message String
- (Flow Run State Change) Message to associate with the state change
- name String
- (Flow Run State Change) Name of the state to change the flow run to
- parameters String
- (Deployment) (JSON) Parameters to pass to the deployment. Use
jsonencode(). - payload String
- (Webhook) Payload to send when calling the webhook
- source 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 String
- (Flow Run State Change) Type of state to change the flow run to
- subject String
- (Notification) Subject of the notification
- type String
- The type of action to perform
- work
Pool StringId - (Work Pool) ID of the work pool to apply this action to
- work
Queue StringId - (Work Queue) ID of the work queue to apply this action to
GetAutomationTrigger
- Compound
Get
Automation Trigger Compound - A composite trigger that requires some number of triggers to have fired within the given time period
- Event
Get
Automation Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- Metric
Get
Automation Trigger Metric - A trigger that fires based on the results of a metric query
- Sequence
Get
Automation Trigger Sequence - A composite trigger that requires triggers to fire in a specific order
- Compound
Get
Automation Trigger Compound - A composite trigger that requires some number of triggers to have fired within the given time period
- Event
Get
Automation Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- Metric
Get
Automation Trigger Metric - A trigger that fires based on the results of a metric query
- Sequence
Get
Automation Trigger Sequence - A composite trigger that requires triggers to fire in a specific order
- compound
Get
Automation Trigger Compound - A composite trigger that requires some number of triggers to have fired within the given time period
- event
Get
Automation Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
Get
Automation Trigger Metric - A trigger that fires based on the results of a metric query
- sequence
Get
Automation Trigger Sequence - A composite trigger that requires triggers to fire in a specific order
- compound
Get
Automation Trigger Compound - A composite trigger that requires some number of triggers to have fired within the given time period
- event
Get
Automation Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
Get
Automation Trigger Metric - A trigger that fires based on the results of a metric query
- sequence
Get
Automation Trigger Sequence - A composite trigger that requires triggers to fire in a specific order
- compound
Get
Automation Trigger Compound - A composite trigger that requires some number of triggers to have fired within the given time period
- event
Get
Automation Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
Get
Automation Trigger Metric - A trigger that fires based on the results of a metric query
- sequence
Get
Automation Trigger Sequence - A composite trigger that requires triggers to fire in a specific order
- compound Property Map
- A composite trigger that requires some number of triggers to have fired within the given time period
- event Property Map
- A trigger that fires based on the presence or absence of events within a given period of time
- metric Property Map
- A trigger that fires based on the results of a metric query
- sequence Property Map
- A composite trigger that requires triggers to fire in a specific order
GetAutomationTriggerCompound
- Require object
- How many triggers must fire ('any', 'all', or a number)
- Triggers
List<Get
Automation Trigger Compound Trigger> - The ordered list of triggers that must fire in sequence
- Within double
- The time period in seconds over which the events must occur
- Require interface{}
- How many triggers must fire ('any', 'all', or a number)
- Triggers
[]Get
Automation Trigger Compound Trigger - The ordered list of triggers that must fire in sequence
- Within float64
- The time period in seconds over which the events must occur
- require Object
- How many triggers must fire ('any', 'all', or a number)
- triggers
List<Get
Automation Trigger Compound Trigger> - The ordered list of triggers that must fire in sequence
- within Double
- The time period in seconds over which the events must occur
- require any
- How many triggers must fire ('any', 'all', or a number)
- triggers
Get
Automation Trigger Compound Trigger[] - The ordered list of triggers that must fire in sequence
- within number
- The time period in seconds over which the events must occur
- require Any
- How many triggers must fire ('any', 'all', or a number)
- triggers
Sequence[Get
Automation Trigger Compound Trigger] - The ordered list of triggers that must fire in sequence
- within float
- The time period in seconds over which the events must occur
- require Any
- How many triggers must fire ('any', 'all', or a number)
- triggers List<Property Map>
- The ordered list of triggers that must fire in sequence
- within Number
- The time period in seconds over which the events must occur
GetAutomationTriggerCompoundTrigger
- Event
Get
Automation Trigger Compound Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- Metric
Get
Automation Trigger Compound Trigger Metric - A trigger that fires based on the results of a metric query
- Event
Get
Automation Trigger Compound Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- Metric
Get
Automation Trigger Compound Trigger Metric - A trigger that fires based on the results of a metric query
- event
Get
Automation Trigger Compound Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
Get
Automation Trigger Compound Trigger Metric - A trigger that fires based on the results of a metric query
- event
Get
Automation Trigger Compound Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
Get
Automation Trigger Compound Trigger Metric - A trigger that fires based on the results of a metric query
- event
Get
Automation Trigger Compound Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
Get
Automation Trigger Compound Trigger Metric - A trigger that fires based on the results of a metric query
- event Property Map
- A trigger that fires based on the presence or absence of events within a given period of time
- metric Property Map
- A trigger that fires based on the results of a metric query
GetAutomationTriggerCompoundTriggerEvent
- Afters List<string>
- The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- Expects List<string>
- The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- For
Eaches List<string> - Evaluate the trigger separately for each distinct value of these labels on the resource
- Match string
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - string
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - Posture string
- The posture of this trigger, either Reactive or Proactive
- Threshold double
- The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- Within double
- The time period in seconds over which the events must occur
- Afters []string
- The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- Expects []string
- The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- For
Eaches []string - Evaluate the trigger separately for each distinct value of these labels on the resource
- Match string
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - string
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - Posture string
- The posture of this trigger, either Reactive or Proactive
- Threshold float64
- The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- Within float64
- The time period in seconds over which the events must occur
- afters List<String>
- The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects List<String>
- The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for
Eaches List<String> - Evaluate the trigger separately for each distinct value of these labels on the resource
- match String
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - String
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - posture String
- The posture of this trigger, either Reactive or Proactive
- threshold Double
- The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within Double
- The time period in seconds over which the events must occur
- afters string[]
- The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects string[]
- The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for
Eaches string[] - Evaluate the trigger separately for each distinct value of these labels on the resource
- match string
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - string
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - posture string
- The posture of this trigger, either Reactive or Proactive
- threshold number
- The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within number
- The time period in seconds over which the events must occur
- afters Sequence[str]
- The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects Sequence[str]
- The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for_
eaches Sequence[str] - Evaluate the trigger separately for each distinct value of these labels on the resource
- match str
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - str
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - posture str
- The posture of this trigger, either Reactive or Proactive
- threshold float
- The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within float
- The time period in seconds over which the events must occur
- afters List<String>
- The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects List<String>
- The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for
Eaches List<String> - Evaluate the trigger separately for each distinct value of these labels on the resource
- match String
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - String
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - posture String
- The posture of this trigger, either Reactive or Proactive
- threshold Number
- The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within Number
- The time period in seconds over which the events must occur
GetAutomationTriggerCompoundTriggerMetric
- Match string
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - string
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - Metric
Get
Automation Trigger Compound Trigger Metric Metric
- Match string
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - string
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - Metric
Get
Automation Trigger Compound Trigger Metric Metric
- match String
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - String
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - metric
Get
Automation Trigger Compound Trigger Metric Metric
- match string
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - string
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - metric
Get
Automation Trigger Compound Trigger Metric Metric
- match str
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - str
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - metric
Get
Automation Trigger Compound Trigger Metric Metric
- match String
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - String
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - metric Property Map
GetAutomationTriggerCompoundTriggerMetricMetric
- Firing
For double - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- Name string
- The name of the metric to query
- Operator string
- The comparative operator used to evaluate the query result against the threshold value
- Range 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 double
- The threshold value against which we'll compare the query results
- Firing
For float64 - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- Name string
- The name of the metric to query
- Operator string
- The comparative operator used to evaluate the query result against the threshold value
- Range 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 float64
- The threshold value against which we'll compare the query results
- firing
For Double - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name String
- The name of the metric to query
- operator String
- The comparative operator used to evaluate the query result against the threshold value
- range 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 Double
- The threshold value against which we'll compare the query results
- firing
For number - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name string
- The name of the metric to query
- operator string
- The comparative operator used to evaluate the query result against the threshold value
- range 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 number
- The threshold value against which we'll compare the query results
- firing_
for float - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name str
- The name of the metric to query
- operator str
- The comparative operator used to evaluate the query result against the threshold value
- range 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 float
- The threshold value against which we'll compare the query results
- firing
For Number - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name String
- The name of the metric to query
- operator String
- The comparative operator used to evaluate the query result against the threshold value
- range 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 Number
- The threshold value against which we'll compare the query results
GetAutomationTriggerEvent
- Afters List<string>
- The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- Expects List<string>
- The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- For
Eaches List<string> - Evaluate the trigger separately for each distinct value of these labels on the resource
- Match string
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - string
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - Posture string
- The posture of this trigger, either Reactive or Proactive
- Threshold double
- The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- Within double
- The time period in seconds over which the events must occur
- Afters []string
- The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- Expects []string
- The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- For
Eaches []string - Evaluate the trigger separately for each distinct value of these labels on the resource
- Match string
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - string
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - Posture string
- The posture of this trigger, either Reactive or Proactive
- Threshold float64
- The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- Within float64
- The time period in seconds over which the events must occur
- afters List<String>
- The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects List<String>
- The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for
Eaches List<String> - Evaluate the trigger separately for each distinct value of these labels on the resource
- match String
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - String
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - posture String
- The posture of this trigger, either Reactive or Proactive
- threshold Double
- The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within Double
- The time period in seconds over which the events must occur
- afters string[]
- The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects string[]
- The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for
Eaches string[] - Evaluate the trigger separately for each distinct value of these labels on the resource
- match string
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - string
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - posture string
- The posture of this trigger, either Reactive or Proactive
- threshold number
- The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within number
- The time period in seconds over which the events must occur
- afters Sequence[str]
- The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects Sequence[str]
- The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for_
eaches Sequence[str] - Evaluate the trigger separately for each distinct value of these labels on the resource
- match str
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - str
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - posture str
- The posture of this trigger, either Reactive or Proactive
- threshold float
- The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within float
- The time period in seconds over which the events must occur
- afters List<String>
- The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects List<String>
- The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for
Eaches List<String> - Evaluate the trigger separately for each distinct value of these labels on the resource
- match String
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - String
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - posture String
- The posture of this trigger, either Reactive or Proactive
- threshold Number
- The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within Number
- The time period in seconds over which the events must occur
GetAutomationTriggerMetric
- Match string
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - string
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - Metric
Get
Automation Trigger Metric Metric
- Match string
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - string
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - Metric
Get
Automation Trigger Metric Metric
- match String
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - String
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - metric
Get
Automation Trigger Metric Metric
- match string
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - string
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - metric
Get
Automation Trigger Metric Metric
- match str
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - str
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - metric
Get
Automation Trigger Metric Metric
- match String
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - String
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - metric Property Map
GetAutomationTriggerMetricMetric
- Firing
For double - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- Name string
- The name of the metric to query
- Operator string
- The comparative operator used to evaluate the query result against the threshold value
- Range 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 double
- The threshold value against which we'll compare the query results
- Firing
For float64 - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- Name string
- The name of the metric to query
- Operator string
- The comparative operator used to evaluate the query result against the threshold value
- Range 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 float64
- The threshold value against which we'll compare the query results
- firing
For Double - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name String
- The name of the metric to query
- operator String
- The comparative operator used to evaluate the query result against the threshold value
- range 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 Double
- The threshold value against which we'll compare the query results
- firing
For number - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name string
- The name of the metric to query
- operator string
- The comparative operator used to evaluate the query result against the threshold value
- range 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 number
- The threshold value against which we'll compare the query results
- firing_
for float - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name str
- The name of the metric to query
- operator str
- The comparative operator used to evaluate the query result against the threshold value
- range 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 float
- The threshold value against which we'll compare the query results
- firing
For Number - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name String
- The name of the metric to query
- operator String
- The comparative operator used to evaluate the query result against the threshold value
- range 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 Number
- The threshold value against which we'll compare the query results
GetAutomationTriggerSequence
- Triggers
List<Get
Automation Trigger Sequence Trigger> - The ordered list of triggers that must fire in sequence
- Within double
- The time period in seconds over which the events must occur
- Triggers
[]Get
Automation Trigger Sequence Trigger - The ordered list of triggers that must fire in sequence
- Within float64
- The time period in seconds over which the events must occur
- triggers
List<Get
Automation Trigger Sequence Trigger> - The ordered list of triggers that must fire in sequence
- within Double
- The time period in seconds over which the events must occur
- triggers
Get
Automation Trigger Sequence Trigger[] - The ordered list of triggers that must fire in sequence
- within number
- The time period in seconds over which the events must occur
- triggers
Sequence[Get
Automation Trigger Sequence Trigger] - The ordered list of triggers that must fire in sequence
- within float
- The time period in seconds over which the events must occur
- triggers List<Property Map>
- The ordered list of triggers that must fire in sequence
- within Number
- The time period in seconds over which the events must occur
GetAutomationTriggerSequenceTrigger
- Event
Get
Automation Trigger Sequence Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- Metric
Get
Automation Trigger Sequence Trigger Metric - A trigger that fires based on the results of a metric query
- Event
Get
Automation Trigger Sequence Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- Metric
Get
Automation Trigger Sequence Trigger Metric - A trigger that fires based on the results of a metric query
- event
Get
Automation Trigger Sequence Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
Get
Automation Trigger Sequence Trigger Metric - A trigger that fires based on the results of a metric query
- event
Get
Automation Trigger Sequence Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
Get
Automation Trigger Sequence Trigger Metric - A trigger that fires based on the results of a metric query
- event
Get
Automation Trigger Sequence Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
Get
Automation Trigger Sequence Trigger Metric - A trigger that fires based on the results of a metric query
- event Property Map
- A trigger that fires based on the presence or absence of events within a given period of time
- metric Property Map
- A trigger that fires based on the results of a metric query
GetAutomationTriggerSequenceTriggerEvent
- Afters List<string>
- The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- Expects List<string>
- The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- For
Eaches List<string> - Evaluate the trigger separately for each distinct value of these labels on the resource
- Match string
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - string
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - Posture string
- The posture of this trigger, either Reactive or Proactive
- Threshold double
- The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- Within double
- The time period in seconds over which the events must occur
- Afters []string
- The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- Expects []string
- The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- For
Eaches []string - Evaluate the trigger separately for each distinct value of these labels on the resource
- Match string
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - string
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - Posture string
- The posture of this trigger, either Reactive or Proactive
- Threshold float64
- The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- Within float64
- The time period in seconds over which the events must occur
- afters List<String>
- The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects List<String>
- The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for
Eaches List<String> - Evaluate the trigger separately for each distinct value of these labels on the resource
- match String
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - String
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - posture String
- The posture of this trigger, either Reactive or Proactive
- threshold Double
- The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within Double
- The time period in seconds over which the events must occur
- afters string[]
- The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects string[]
- The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for
Eaches string[] - Evaluate the trigger separately for each distinct value of these labels on the resource
- match string
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - string
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - posture string
- The posture of this trigger, either Reactive or Proactive
- threshold number
- The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within number
- The time period in seconds over which the events must occur
- afters Sequence[str]
- The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects Sequence[str]
- The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for_
eaches Sequence[str] - Evaluate the trigger separately for each distinct value of these labels on the resource
- match str
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - str
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - posture str
- The posture of this trigger, either Reactive or Proactive
- threshold float
- The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within float
- The time period in seconds over which the events must occur
- afters List<String>
- The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately
- expects List<String>
- The event(s) this trigger is expecting to see. If empty, this trigger will match any event
- for
Eaches List<String> - Evaluate the trigger separately for each distinct value of these labels on the resource
- match String
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - String
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - posture String
- The posture of this trigger, either Reactive or Proactive
- threshold Number
- The number of events required for this trigger to fire (Reactive) or expected (Proactive)
- within Number
- The time period in seconds over which the events must occur
GetAutomationTriggerSequenceTriggerMetric
- Match string
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - string
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - Metric
Get
Automation Trigger Sequence Trigger Metric Metric
- Match string
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - string
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - Metric
Get
Automation Trigger Sequence Trigger Metric Metric
- match String
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - String
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - metric
Get
Automation Trigger Sequence Trigger Metric Metric
- match string
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - string
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - metric
Get
Automation Trigger Sequence Trigger Metric Metric
- match str
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - str
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - metric
Get
Automation Trigger Sequence Trigger Metric Metric
- match String
- (JSON) Resource specification labels which this trigger will match. Use
jsonencode(). - String
- (JSON) Resource specification labels for related resources which this trigger will match. Use
jsonencode(). - metric Property Map
GetAutomationTriggerSequenceTriggerMetricMetric
- Firing
For double - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- Name string
- The name of the metric to query
- Operator string
- The comparative operator used to evaluate the query result against the threshold value
- Range 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 double
- The threshold value against which we'll compare the query results
- Firing
For float64 - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- Name string
- The name of the metric to query
- Operator string
- The comparative operator used to evaluate the query result against the threshold value
- Range 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 float64
- The threshold value against which we'll compare the query results
- firing
For Double - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name String
- The name of the metric to query
- operator String
- The comparative operator used to evaluate the query result against the threshold value
- range 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 Double
- The threshold value against which we'll compare the query results
- firing
For number - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name string
- The name of the metric to query
- operator string
- The comparative operator used to evaluate the query result against the threshold value
- range 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 number
- The threshold value against which we'll compare the query results
- firing_
for float - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name str
- The name of the metric to query
- operator str
- The comparative operator used to evaluate the query result against the threshold value
- range 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 float
- The threshold value against which we'll compare the query results
- firing
For Number - The duration (seconds) for which the metric query must breach OR resolve continuously before the state is updated and actions are triggered.
- name String
- The name of the metric to query
- operator String
- The comparative operator used to evaluate the query result against the threshold value
- range 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 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
prefectTerraform Provider.
