prefect.Automation
Explore with Pulumi AI
The resource ‘automations’ represents a Prefect Automation.
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
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.prefect.Automation;
import com.pulumi.prefect.AutomationArgs;
import com.pulumi.prefect.inputs.AutomationTriggerArgs;
import com.pulumi.prefect.inputs.AutomationTriggerEventArgs;
import com.pulumi.prefect.inputs.AutomationActionArgs;
import com.pulumi.prefect.inputs.AutomationTriggerMetricArgs;
import com.pulumi.prefect.inputs.AutomationTriggerMetricMetricArgs;
import com.pulumi.prefect.inputs.AutomationTriggerCompoundArgs;
import com.pulumi.prefect.inputs.AutomationTriggerSequenceArgs;
import com.pulumi.prefect.inputs.AutomationActionsOnTriggerArgs;
import com.pulumi.prefect.inputs.AutomationActionsOnResolfArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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) {
// example:
// An automation with an event trigger
var eventTrigger = new Automation("eventTrigger", AutomationArgs.builder()
.description("ayu carumba")
.enabled(true)
.trigger(AutomationTriggerArgs.builder()
.event(AutomationTriggerEventArgs.builder()
.posture("Reactive")
.match(serializeJson(
jsonObject(
jsonProperty("prefect.resource.id", "prefect.flow-run.*")
)))
.matchRelated(serializeJson(
jsonObject(
jsonProperty("prefect.resource.id", jsonArray("prefect.flow.ce6ec0c9-4b51-483b-a776-43c085b6c4f8")),
jsonProperty("prefect.resource.role", "flow")
)))
.after("prefect.flow-run.completed")
.expect("prefect.flow-run.failed")
.forEach("prefect.resource.id")
.threshold(1)
.within(60)
.build())
.build())
.actions(
AutomationActionArgs.builder()
.type("run-deployment")
.source("inferred")
.parameters(serializeJson(
jsonObject(
jsonProperty("param1", "value1"),
jsonProperty("param2", "value2")
)))
.jobVariables(serializeJson(
jsonObject(
jsonProperty("var1", "value1"),
jsonProperty("var2", "value2"),
jsonProperty("var3", 3),
jsonProperty("var4", true),
jsonProperty("var5", jsonObject(
jsonProperty("key1", "value1")
))
)))
.build(),
AutomationActionArgs.builder()
.type("declare-incident")
.build())
.build());
// example:
// An automation with a metric trigger
var metricTrigger = new Automation("metricTrigger", AutomationArgs.builder()
.description("boom shakkala")
.enabled(true)
.trigger(AutomationTriggerArgs.builder()
.metric(AutomationTriggerMetricArgs.builder()
.posture("Metric")
.match(serializeJson(
jsonObject(
)))
.matchRelated(serializeJson(
jsonObject(
)))
.metric(AutomationTriggerMetricMetricArgs.builder()
.name("duration")
.operator(">=")
.threshold(10)
.range(300)
.firingFor(300)
.build())
.build())
.build())
.actions(AutomationActionArgs.builder()
.type("change-flow-run-state")
.state("FAILED")
.name("Failed by automation")
.message("Flow run failed due to {{ event.reason }}")
.build())
.actionsOnTriggers()
.actionsOnResolves()
.build());
// example:
// An automation with a compound trigger
var compoundTrigger = new Automation("compoundTrigger", AutomationArgs.builder()
.description("compound trigger dos!")
.enabled(true)
.trigger(AutomationTriggerArgs.builder()
.compound(AutomationTriggerCompoundArgs.builder()
.require("any")
.within(300)
.triggers(
AutomationTriggerCompoundTriggerArgs.builder()
.event(AutomationTriggerCompoundTriggerEventArgs.builder()
.expect("prefect.flow-run.Failed")
.match(serializeJson(
jsonObject(
jsonProperty("prefect.resource.id", "prefect.flow-run.*")
)))
.matchRelated(serializeJson(
jsonObject(
jsonProperty("prefect.resource.id", "prefect.flow-run.*"),
jsonProperty("prefect.resource.role", "flow")
)))
.forEach()
.after()
.posture("Reactive")
.threshold(1)
.within(0)
.build())
.build(),
AutomationTriggerCompoundTriggerArgs.builder()
.event(AutomationTriggerCompoundTriggerEventArgs.builder()
.expect("prefect.flow-run.NonExistent")
.match(serializeJson(
jsonObject(
jsonProperty("prefect.resource.id", "prefect.flow-run.*")
)))
.matchRelated(serializeJson(
jsonObject(
jsonProperty("prefect.resource.id", "prefect.flow-run.*"),
jsonProperty("prefect.resource.role", "flow")
)))
.posture("Reactive")
.threshold(1)
.within(0)
.build())
.build())
.build())
.build())
.actions(AutomationActionArgs.builder()
.type("run-deployment")
.source("inferred")
.jobVariables(serializeJson(
jsonObject(
jsonProperty("var1", "value1"),
jsonProperty("var2", "value2"),
jsonProperty("var3", 3),
jsonProperty("var4", true),
jsonProperty("var5", jsonObject(
jsonProperty("key1", "value1")
))
)))
.build())
.build());
// example:
// An automation with a sequence trigger
var sequenceTrigger = new Automation("sequenceTrigger", AutomationArgs.builder()
.description("sequence trigger tres!")
.enabled(true)
.trigger(AutomationTriggerArgs.builder()
.sequence(AutomationTriggerSequenceArgs.builder()
.within(300)
.triggers(
AutomationTriggerSequenceTriggerArgs.builder()
.event(AutomationTriggerSequenceTriggerEventArgs.builder()
.expect("prefect.flow-run.Pending")
.match(serializeJson(
jsonObject(
jsonProperty("prefect.resource.id", "prefect.flow-run.*")
)))
.matchRelated(serializeJson(
jsonObject(
)))
.forEach()
.posture("Reactive")
.threshold(1)
.within(0)
.build())
.build(),
AutomationTriggerSequenceTriggerArgs.builder()
.event(AutomationTriggerSequenceTriggerEventArgs.builder()
.expect("prefect.flow-run.Running")
.match(serializeJson(
jsonObject(
jsonProperty("prefect.resource.id", "prefect.flow-run.*")
)))
.matchRelated(serializeJson(
jsonObject(
)))
.forEach()
.posture("Reactive")
.threshold(1)
.within(0)
.build())
.build(),
AutomationTriggerSequenceTriggerArgs.builder()
.event(AutomationTriggerSequenceTriggerEventArgs.builder()
.expect("prefect.flow-run.Completed")
.match(serializeJson(
jsonObject(
jsonProperty("prefect.resource.id", "prefect.flow-run.*")
)))
.matchRelated(serializeJson(
jsonObject(
)))
.forEach()
.posture("Reactive")
.threshold(1)
.within(0)
.build())
.build())
.build())
.build())
.actions(AutomationActionArgs.builder()
.type("send-notification")
.blockDocumentId("123e4567-e89b-12d3-a456-426614174000")
.subject("Flow Run Failed: {{ event.resource['prefect.resource.name'] }}")
.body("Flow run {{ event.resource['prefect.resource.id'] }} failed at {{ event.occurred }}")
.build())
.actionsOnTriggers(AutomationActionsOnTriggerArgs.builder()
.type("change-flow-run-state")
.state("FAILED")
.name("Failed by automation")
.message("Flow run failed due to {{ event.resource['prefect.resource.name'] }}")
.build())
.actionsOnResolves(AutomationActionsOnResolfArgs.builder()
.type("call-webhook")
.blockDocumentId("123e4567-e89b-12d3-a456-426614174000")
.payload("{\"flow_run_id\": \"{{ event.resource['prefect.resource.id'] }}\", \"status\": \"{{ event.event }}\"}")
.build())
.build());
}
}
resources:
# example:
# An automation with an event trigger
eventTrigger:
type: prefect:Automation
properties:
description: ayu carumba
enabled: true
trigger:
event:
posture: Reactive
match:
fn::toJSON:
prefect.resource.id: prefect.flow-run.*
matchRelated:
fn::toJSON:
prefect.resource.id:
- prefect.flow.ce6ec0c9-4b51-483b-a776-43c085b6c4f8
prefect.resource.role: flow
after:
- prefect.flow-run.completed
expect:
- prefect.flow-run.failed
forEach:
- prefect.resource.id
threshold: 1
within: 60
actions:
- type: run-deployment
source: inferred
parameters:
fn::toJSON:
param1: value1
param2: value2
jobVariables:
fn::toJSON:
var1: value1
var2: value2
var3: 3
var4: true
var5:
key1: value1
- type: declare-incident
# example:
# An automation with a metric trigger
metricTrigger:
type: prefect:Automation
properties:
description: boom shakkala
enabled: true
trigger:
metric:
posture: Metric
match:
fn::toJSON: {}
matchRelated:
fn::toJSON: {}
metric:
name: duration
operator: '>='
threshold: 10
range: 300
firingFor: 300
actions:
- type: change-flow-run-state
state: FAILED
name: Failed by automation
message: Flow run failed due to {{ event.reason }}
actionsOnTriggers: []
actionsOnResolves: []
# example:
# An automation with a compound trigger
compoundTrigger:
type: prefect:Automation
properties:
description: compound trigger dos!
enabled: true
trigger:
compound:
require: any
within: 300
triggers:
- event:
expect:
- prefect.flow-run.Failed
match:
fn::toJSON:
prefect.resource.id: prefect.flow-run.*
matchRelated:
fn::toJSON:
prefect.resource.id: prefect.flow-run.*
prefect.resource.role: flow
forEach: []
after: []
posture: Reactive
threshold: 1
within: 0
- event:
expect:
- prefect.flow-run.NonExistent
match:
fn::toJSON:
prefect.resource.id: prefect.flow-run.*
matchRelated:
fn::toJSON:
prefect.resource.id: prefect.flow-run.*
prefect.resource.role: flow
posture: Reactive
threshold: 1
within: 0
actions:
- type: run-deployment
source: inferred
jobVariables:
fn::toJSON:
var1: value1
var2: value2
var3: 3
var4: true
var5:
key1: value1
# example:
# An automation with a sequence trigger
sequenceTrigger:
type: prefect:Automation
properties:
description: sequence trigger tres!
enabled: true
trigger:
sequence:
within: 300
triggers:
- event:
expect:
- prefect.flow-run.Pending
match:
fn::toJSON:
prefect.resource.id: prefect.flow-run.*
matchRelated:
fn::toJSON: {}
forEach: []
posture: Reactive
threshold: 1
within: 0
- event:
expect:
- prefect.flow-run.Running
match:
fn::toJSON:
prefect.resource.id: prefect.flow-run.*
matchRelated:
fn::toJSON: {}
forEach: []
posture: Reactive
threshold: 1
within: 0
- event:
expect:
- prefect.flow-run.Completed
match:
fn::toJSON:
prefect.resource.id: prefect.flow-run.*
matchRelated:
fn::toJSON: {}
forEach: []
posture: Reactive
threshold: 1
within: 0
actions:
- type: send-notification
blockDocumentId: 123e4567-e89b-12d3-a456-426614174000
subject: 'Flow Run Failed: {{ event.resource[''prefect.resource.name''] }}'
body: Flow run {{ event.resource['prefect.resource.id'] }} failed at {{ event.occurred }}
actionsOnTriggers:
- type: change-flow-run-state
state: FAILED
name: Failed by automation
message: Flow run failed due to {{ event.resource['prefect.resource.name'] }}
actionsOnResolves:
- type: call-webhook
blockDocumentId: 123e4567-e89b-12d3-a456-426614174000
payload: '{"flow_run_id": "{{ event.resource[''prefect.resource.id''] }}", "status": "{{ event.event }}"}'
Create Automation Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Automation(name: string, args: AutomationArgs, opts?: CustomResourceOptions);
@overload
def Automation(resource_name: str,
args: AutomationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Automation(resource_name: str,
opts: Optional[ResourceOptions] = None,
trigger: Optional[AutomationTriggerArgs] = None,
account_id: Optional[str] = None,
actions: Optional[Sequence[AutomationActionArgs]] = None,
actions_on_resolves: Optional[Sequence[AutomationActionsOnResolfArgs]] = None,
actions_on_triggers: Optional[Sequence[AutomationActionsOnTriggerArgs]] = None,
description: Optional[str] = None,
enabled: Optional[bool] = None,
name: Optional[str] = None,
workspace_id: Optional[str] = None)
func NewAutomation(ctx *Context, name string, args AutomationArgs, opts ...ResourceOption) (*Automation, error)
public Automation(string name, AutomationArgs args, CustomResourceOptions? opts = null)
public Automation(String name, AutomationArgs args)
public Automation(String name, AutomationArgs args, CustomResourceOptions options)
type: prefect:Automation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AutomationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AutomationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AutomationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AutomationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AutomationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var automationResource = new Prefect.Automation("automationResource", new()
{
Trigger = new Prefect.Inputs.AutomationTriggerArgs
{
Compound = new Prefect.Inputs.AutomationTriggerCompoundArgs
{
Require = "any",
Triggers = new[]
{
new Prefect.Inputs.AutomationTriggerCompoundTriggerArgs
{
Event = new Prefect.Inputs.AutomationTriggerCompoundTriggerEventArgs
{
Posture = "string",
Afters = new[]
{
"string",
},
Expects = new[]
{
"string",
},
ForEaches = new[]
{
"string",
},
Match = "string",
MatchRelated = "string",
Threshold = 0,
Within = 0,
},
Metric = new Prefect.Inputs.AutomationTriggerCompoundTriggerMetricArgs
{
Metric = new Prefect.Inputs.AutomationTriggerCompoundTriggerMetricMetricArgs
{
FiringFor = 0,
Name = "string",
Operator = "string",
Range = 0,
Threshold = 0,
},
Match = "string",
MatchRelated = "string",
},
},
},
Within = 0,
},
Event = new Prefect.Inputs.AutomationTriggerEventArgs
{
Posture = "string",
Afters = new[]
{
"string",
},
Expects = new[]
{
"string",
},
ForEaches = new[]
{
"string",
},
Match = "string",
MatchRelated = "string",
Threshold = 0,
Within = 0,
},
Metric = new Prefect.Inputs.AutomationTriggerMetricArgs
{
Metric = new Prefect.Inputs.AutomationTriggerMetricMetricArgs
{
FiringFor = 0,
Name = "string",
Operator = "string",
Range = 0,
Threshold = 0,
},
Match = "string",
MatchRelated = "string",
},
Sequence = new Prefect.Inputs.AutomationTriggerSequenceArgs
{
Triggers = new[]
{
new Prefect.Inputs.AutomationTriggerSequenceTriggerArgs
{
Event = new Prefect.Inputs.AutomationTriggerSequenceTriggerEventArgs
{
Posture = "string",
Afters = new[]
{
"string",
},
Expects = new[]
{
"string",
},
ForEaches = new[]
{
"string",
},
Match = "string",
MatchRelated = "string",
Threshold = 0,
Within = 0,
},
Metric = new Prefect.Inputs.AutomationTriggerSequenceTriggerMetricArgs
{
Metric = new Prefect.Inputs.AutomationTriggerSequenceTriggerMetricMetricArgs
{
FiringFor = 0,
Name = "string",
Operator = "string",
Range = 0,
Threshold = 0,
},
Match = "string",
MatchRelated = "string",
},
},
},
Within = 0,
},
},
AccountId = "string",
Actions = new[]
{
new Prefect.Inputs.AutomationActionArgs
{
Type = "string",
Name = "string",
Payload = "string",
DeploymentId = "string",
JobVariables = "string",
Message = "string",
AutomationId = "string",
Parameters = "string",
Body = "string",
Source = "string",
State = "string",
Subject = "string",
BlockDocumentId = "string",
WorkPoolId = "string",
WorkQueueId = "string",
},
},
ActionsOnResolves = new[]
{
new Prefect.Inputs.AutomationActionsOnResolfArgs
{
Type = "string",
Name = "string",
Payload = "string",
DeploymentId = "string",
JobVariables = "string",
Message = "string",
AutomationId = "string",
Parameters = "string",
Body = "string",
Source = "string",
State = "string",
Subject = "string",
BlockDocumentId = "string",
WorkPoolId = "string",
WorkQueueId = "string",
},
},
ActionsOnTriggers = new[]
{
new Prefect.Inputs.AutomationActionsOnTriggerArgs
{
Type = "string",
Name = "string",
Payload = "string",
DeploymentId = "string",
JobVariables = "string",
Message = "string",
AutomationId = "string",
Parameters = "string",
Body = "string",
Source = "string",
State = "string",
Subject = "string",
BlockDocumentId = "string",
WorkPoolId = "string",
WorkQueueId = "string",
},
},
Description = "string",
Enabled = false,
Name = "string",
WorkspaceId = "string",
});
example, err := prefect.NewAutomation(ctx, "automationResource", &prefect.AutomationArgs{
Trigger: &.AutomationTriggerArgs{
Compound: &.AutomationTriggerCompoundArgs{
Require: pulumi.Any("any"),
Triggers: .AutomationTriggerCompoundTriggerArray{
&.AutomationTriggerCompoundTriggerArgs{
Event: &.AutomationTriggerCompoundTriggerEventArgs{
Posture: pulumi.String("string"),
Afters: pulumi.StringArray{
pulumi.String("string"),
},
Expects: pulumi.StringArray{
pulumi.String("string"),
},
ForEaches: pulumi.StringArray{
pulumi.String("string"),
},
Match: pulumi.String("string"),
MatchRelated: pulumi.String("string"),
Threshold: pulumi.Float64(0),
Within: pulumi.Float64(0),
},
Metric: &.AutomationTriggerCompoundTriggerMetricArgs{
Metric: &.AutomationTriggerCompoundTriggerMetricMetricArgs{
FiringFor: pulumi.Float64(0),
Name: pulumi.String("string"),
Operator: pulumi.String("string"),
Range: pulumi.Float64(0),
Threshold: pulumi.Float64(0),
},
Match: pulumi.String("string"),
MatchRelated: pulumi.String("string"),
},
},
},
Within: pulumi.Float64(0),
},
Event: &.AutomationTriggerEventArgs{
Posture: pulumi.String("string"),
Afters: pulumi.StringArray{
pulumi.String("string"),
},
Expects: pulumi.StringArray{
pulumi.String("string"),
},
ForEaches: pulumi.StringArray{
pulumi.String("string"),
},
Match: pulumi.String("string"),
MatchRelated: pulumi.String("string"),
Threshold: pulumi.Float64(0),
Within: pulumi.Float64(0),
},
Metric: &.AutomationTriggerMetricArgs{
Metric: &.AutomationTriggerMetricMetricArgs{
FiringFor: pulumi.Float64(0),
Name: pulumi.String("string"),
Operator: pulumi.String("string"),
Range: pulumi.Float64(0),
Threshold: pulumi.Float64(0),
},
Match: pulumi.String("string"),
MatchRelated: pulumi.String("string"),
},
Sequence: &.AutomationTriggerSequenceArgs{
Triggers: .AutomationTriggerSequenceTriggerArray{
&.AutomationTriggerSequenceTriggerArgs{
Event: &.AutomationTriggerSequenceTriggerEventArgs{
Posture: pulumi.String("string"),
Afters: pulumi.StringArray{
pulumi.String("string"),
},
Expects: pulumi.StringArray{
pulumi.String("string"),
},
ForEaches: pulumi.StringArray{
pulumi.String("string"),
},
Match: pulumi.String("string"),
MatchRelated: pulumi.String("string"),
Threshold: pulumi.Float64(0),
Within: pulumi.Float64(0),
},
Metric: &.AutomationTriggerSequenceTriggerMetricArgs{
Metric: &.AutomationTriggerSequenceTriggerMetricMetricArgs{
FiringFor: pulumi.Float64(0),
Name: pulumi.String("string"),
Operator: pulumi.String("string"),
Range: pulumi.Float64(0),
Threshold: pulumi.Float64(0),
},
Match: pulumi.String("string"),
MatchRelated: pulumi.String("string"),
},
},
},
Within: pulumi.Float64(0),
},
},
AccountId: pulumi.String("string"),
Actions: .AutomationActionArray{
&.AutomationActionArgs{
Type: pulumi.String("string"),
Name: pulumi.String("string"),
Payload: pulumi.String("string"),
DeploymentId: pulumi.String("string"),
JobVariables: pulumi.String("string"),
Message: pulumi.String("string"),
AutomationId: pulumi.String("string"),
Parameters: pulumi.String("string"),
Body: pulumi.String("string"),
Source: pulumi.String("string"),
State: pulumi.String("string"),
Subject: pulumi.String("string"),
BlockDocumentId: pulumi.String("string"),
WorkPoolId: pulumi.String("string"),
WorkQueueId: pulumi.String("string"),
},
},
ActionsOnResolves: .AutomationActionsOnResolfArray{
&.AutomationActionsOnResolfArgs{
Type: pulumi.String("string"),
Name: pulumi.String("string"),
Payload: pulumi.String("string"),
DeploymentId: pulumi.String("string"),
JobVariables: pulumi.String("string"),
Message: pulumi.String("string"),
AutomationId: pulumi.String("string"),
Parameters: pulumi.String("string"),
Body: pulumi.String("string"),
Source: pulumi.String("string"),
State: pulumi.String("string"),
Subject: pulumi.String("string"),
BlockDocumentId: pulumi.String("string"),
WorkPoolId: pulumi.String("string"),
WorkQueueId: pulumi.String("string"),
},
},
ActionsOnTriggers: .AutomationActionsOnTriggerArray{
&.AutomationActionsOnTriggerArgs{
Type: pulumi.String("string"),
Name: pulumi.String("string"),
Payload: pulumi.String("string"),
DeploymentId: pulumi.String("string"),
JobVariables: pulumi.String("string"),
Message: pulumi.String("string"),
AutomationId: pulumi.String("string"),
Parameters: pulumi.String("string"),
Body: pulumi.String("string"),
Source: pulumi.String("string"),
State: pulumi.String("string"),
Subject: pulumi.String("string"),
BlockDocumentId: pulumi.String("string"),
WorkPoolId: pulumi.String("string"),
WorkQueueId: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
Enabled: pulumi.Bool(false),
Name: pulumi.String("string"),
WorkspaceId: pulumi.String("string"),
})
var automationResource = new Automation("automationResource", AutomationArgs.builder()
.trigger(AutomationTriggerArgs.builder()
.compound(AutomationTriggerCompoundArgs.builder()
.require("any")
.triggers(AutomationTriggerCompoundTriggerArgs.builder()
.event(AutomationTriggerCompoundTriggerEventArgs.builder()
.posture("string")
.afters("string")
.expects("string")
.forEaches("string")
.match("string")
.matchRelated("string")
.threshold(0)
.within(0)
.build())
.metric(AutomationTriggerCompoundTriggerMetricArgs.builder()
.metric(AutomationTriggerCompoundTriggerMetricMetricArgs.builder()
.firingFor(0)
.name("string")
.operator("string")
.range(0)
.threshold(0)
.build())
.match("string")
.matchRelated("string")
.build())
.build())
.within(0)
.build())
.event(AutomationTriggerEventArgs.builder()
.posture("string")
.afters("string")
.expects("string")
.forEaches("string")
.match("string")
.matchRelated("string")
.threshold(0)
.within(0)
.build())
.metric(AutomationTriggerMetricArgs.builder()
.metric(AutomationTriggerMetricMetricArgs.builder()
.firingFor(0)
.name("string")
.operator("string")
.range(0)
.threshold(0)
.build())
.match("string")
.matchRelated("string")
.build())
.sequence(AutomationTriggerSequenceArgs.builder()
.triggers(AutomationTriggerSequenceTriggerArgs.builder()
.event(AutomationTriggerSequenceTriggerEventArgs.builder()
.posture("string")
.afters("string")
.expects("string")
.forEaches("string")
.match("string")
.matchRelated("string")
.threshold(0)
.within(0)
.build())
.metric(AutomationTriggerSequenceTriggerMetricArgs.builder()
.metric(AutomationTriggerSequenceTriggerMetricMetricArgs.builder()
.firingFor(0)
.name("string")
.operator("string")
.range(0)
.threshold(0)
.build())
.match("string")
.matchRelated("string")
.build())
.build())
.within(0)
.build())
.build())
.accountId("string")
.actions(AutomationActionArgs.builder()
.type("string")
.name("string")
.payload("string")
.deploymentId("string")
.jobVariables("string")
.message("string")
.automationId("string")
.parameters("string")
.body("string")
.source("string")
.state("string")
.subject("string")
.blockDocumentId("string")
.workPoolId("string")
.workQueueId("string")
.build())
.actionsOnResolves(AutomationActionsOnResolfArgs.builder()
.type("string")
.name("string")
.payload("string")
.deploymentId("string")
.jobVariables("string")
.message("string")
.automationId("string")
.parameters("string")
.body("string")
.source("string")
.state("string")
.subject("string")
.blockDocumentId("string")
.workPoolId("string")
.workQueueId("string")
.build())
.actionsOnTriggers(AutomationActionsOnTriggerArgs.builder()
.type("string")
.name("string")
.payload("string")
.deploymentId("string")
.jobVariables("string")
.message("string")
.automationId("string")
.parameters("string")
.body("string")
.source("string")
.state("string")
.subject("string")
.blockDocumentId("string")
.workPoolId("string")
.workQueueId("string")
.build())
.description("string")
.enabled(false)
.name("string")
.workspaceId("string")
.build());
automation_resource = prefect.Automation("automationResource",
trigger={
"compound": {
"require": "any",
"triggers": [{
"event": {
"posture": "string",
"afters": ["string"],
"expects": ["string"],
"for_eaches": ["string"],
"match": "string",
"match_related": "string",
"threshold": 0,
"within": 0,
},
"metric": {
"metric": {
"firing_for": 0,
"name": "string",
"operator": "string",
"range": 0,
"threshold": 0,
},
"match": "string",
"match_related": "string",
},
}],
"within": 0,
},
"event": {
"posture": "string",
"afters": ["string"],
"expects": ["string"],
"for_eaches": ["string"],
"match": "string",
"match_related": "string",
"threshold": 0,
"within": 0,
},
"metric": {
"metric": {
"firing_for": 0,
"name": "string",
"operator": "string",
"range": 0,
"threshold": 0,
},
"match": "string",
"match_related": "string",
},
"sequence": {
"triggers": [{
"event": {
"posture": "string",
"afters": ["string"],
"expects": ["string"],
"for_eaches": ["string"],
"match": "string",
"match_related": "string",
"threshold": 0,
"within": 0,
},
"metric": {
"metric": {
"firing_for": 0,
"name": "string",
"operator": "string",
"range": 0,
"threshold": 0,
},
"match": "string",
"match_related": "string",
},
}],
"within": 0,
},
},
account_id="string",
actions=[{
"type": "string",
"name": "string",
"payload": "string",
"deployment_id": "string",
"job_variables": "string",
"message": "string",
"automation_id": "string",
"parameters": "string",
"body": "string",
"source": "string",
"state": "string",
"subject": "string",
"block_document_id": "string",
"work_pool_id": "string",
"work_queue_id": "string",
}],
actions_on_resolves=[{
"type": "string",
"name": "string",
"payload": "string",
"deployment_id": "string",
"job_variables": "string",
"message": "string",
"automation_id": "string",
"parameters": "string",
"body": "string",
"source": "string",
"state": "string",
"subject": "string",
"block_document_id": "string",
"work_pool_id": "string",
"work_queue_id": "string",
}],
actions_on_triggers=[{
"type": "string",
"name": "string",
"payload": "string",
"deployment_id": "string",
"job_variables": "string",
"message": "string",
"automation_id": "string",
"parameters": "string",
"body": "string",
"source": "string",
"state": "string",
"subject": "string",
"block_document_id": "string",
"work_pool_id": "string",
"work_queue_id": "string",
}],
description="string",
enabled=False,
name="string",
workspace_id="string")
const automationResource = new prefect.Automation("automationResource", {
trigger: {
compound: {
require: "any",
triggers: [{
event: {
posture: "string",
afters: ["string"],
expects: ["string"],
forEaches: ["string"],
match: "string",
matchRelated: "string",
threshold: 0,
within: 0,
},
metric: {
metric: {
firingFor: 0,
name: "string",
operator: "string",
range: 0,
threshold: 0,
},
match: "string",
matchRelated: "string",
},
}],
within: 0,
},
event: {
posture: "string",
afters: ["string"],
expects: ["string"],
forEaches: ["string"],
match: "string",
matchRelated: "string",
threshold: 0,
within: 0,
},
metric: {
metric: {
firingFor: 0,
name: "string",
operator: "string",
range: 0,
threshold: 0,
},
match: "string",
matchRelated: "string",
},
sequence: {
triggers: [{
event: {
posture: "string",
afters: ["string"],
expects: ["string"],
forEaches: ["string"],
match: "string",
matchRelated: "string",
threshold: 0,
within: 0,
},
metric: {
metric: {
firingFor: 0,
name: "string",
operator: "string",
range: 0,
threshold: 0,
},
match: "string",
matchRelated: "string",
},
}],
within: 0,
},
},
accountId: "string",
actions: [{
type: "string",
name: "string",
payload: "string",
deploymentId: "string",
jobVariables: "string",
message: "string",
automationId: "string",
parameters: "string",
body: "string",
source: "string",
state: "string",
subject: "string",
blockDocumentId: "string",
workPoolId: "string",
workQueueId: "string",
}],
actionsOnResolves: [{
type: "string",
name: "string",
payload: "string",
deploymentId: "string",
jobVariables: "string",
message: "string",
automationId: "string",
parameters: "string",
body: "string",
source: "string",
state: "string",
subject: "string",
blockDocumentId: "string",
workPoolId: "string",
workQueueId: "string",
}],
actionsOnTriggers: [{
type: "string",
name: "string",
payload: "string",
deploymentId: "string",
jobVariables: "string",
message: "string",
automationId: "string",
parameters: "string",
body: "string",
source: "string",
state: "string",
subject: "string",
blockDocumentId: "string",
workPoolId: "string",
workQueueId: "string",
}],
description: "string",
enabled: false,
name: "string",
workspaceId: "string",
});
type: prefect:Automation
properties:
accountId: string
actions:
- automationId: string
blockDocumentId: string
body: string
deploymentId: string
jobVariables: string
message: string
name: string
parameters: string
payload: string
source: string
state: string
subject: string
type: string
workPoolId: string
workQueueId: string
actionsOnResolves:
- automationId: string
blockDocumentId: string
body: string
deploymentId: string
jobVariables: string
message: string
name: string
parameters: string
payload: string
source: string
state: string
subject: string
type: string
workPoolId: string
workQueueId: string
actionsOnTriggers:
- automationId: string
blockDocumentId: string
body: string
deploymentId: string
jobVariables: string
message: string
name: string
parameters: string
payload: string
source: string
state: string
subject: string
type: string
workPoolId: string
workQueueId: string
description: string
enabled: false
name: string
trigger:
compound:
require: any
triggers:
- event:
afters:
- string
expects:
- string
forEaches:
- string
match: string
matchRelated: string
posture: string
threshold: 0
within: 0
metric:
match: string
matchRelated: string
metric:
firingFor: 0
name: string
operator: string
range: 0
threshold: 0
within: 0
event:
afters:
- string
expects:
- string
forEaches:
- string
match: string
matchRelated: string
posture: string
threshold: 0
within: 0
metric:
match: string
matchRelated: string
metric:
firingFor: 0
name: string
operator: string
range: 0
threshold: 0
sequence:
triggers:
- event:
afters:
- string
expects:
- string
forEaches:
- string
match: string
matchRelated: string
posture: string
threshold: 0
within: 0
metric:
match: string
matchRelated: string
metric:
firingFor: 0
name: string
operator: string
range: 0
threshold: 0
within: 0
workspaceId: string
Automation Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Automation resource accepts the following input properties:
- Trigger
Automation
Trigger - The criteria for which events this Automation covers and how it will respond
- Account
Id string - Account ID (UUID), defaults to the account set in the provider
- Actions
List<Automation
Action> - List of actions to perform when the automation is triggered
- Actions
On List<AutomationResolves Actions On Resolf> - List of actions to perform when the automation is triggered
- Actions
On List<AutomationTriggers Actions On Trigger> - List of actions to perform when the automation is triggered
- Description string
- Description of the automation
- Enabled bool
- Whether the automation is enabled
- Name string
- Name of the automation
- Workspace
Id string - Workspace ID (UUID), defaults to the workspace set in the provider
- Trigger
Automation
Trigger Args - The criteria for which events this Automation covers and how it will respond
- Account
Id string - Account ID (UUID), defaults to the account set in the provider
- Actions
[]Automation
Action Args - List of actions to perform when the automation is triggered
- Actions
On []AutomationResolves Actions On Resolf Args - List of actions to perform when the automation is triggered
- Actions
On []AutomationTriggers Actions On Trigger Args - List of actions to perform when the automation is triggered
- Description string
- Description of the automation
- Enabled bool
- Whether the automation is enabled
- Name string
- Name of the automation
- Workspace
Id string - Workspace ID (UUID), defaults to the workspace set in the provider
- trigger
Automation
Trigger - The criteria for which events this Automation covers and how it will respond
- account
Id String - Account ID (UUID), defaults to the account set in the provider
- actions
List<Automation
Action> - List of actions to perform when the automation is triggered
- actions
On List<AutomationResolves Actions On Resolf> - List of actions to perform when the automation is triggered
- actions
On List<AutomationTriggers Actions On Trigger> - List of actions to perform when the automation is triggered
- description String
- Description of the automation
- enabled Boolean
- Whether the automation is enabled
- name String
- Name of the automation
- workspace
Id String - Workspace ID (UUID), defaults to the workspace set in the provider
- trigger
Automation
Trigger - The criteria for which events this Automation covers and how it will respond
- account
Id string - Account ID (UUID), defaults to the account set in the provider
- actions
Automation
Action[] - List of actions to perform when the automation is triggered
- actions
On AutomationResolves Actions On Resolf[] - List of actions to perform when the automation is triggered
- actions
On AutomationTriggers Actions On Trigger[] - List of actions to perform when the automation is triggered
- description string
- Description of the automation
- enabled boolean
- Whether the automation is enabled
- name string
- Name of the automation
- workspace
Id string - Workspace ID (UUID), defaults to the workspace set in the provider
- trigger
Automation
Trigger Args - The criteria for which events this Automation covers and how it will respond
- account_
id str - Account ID (UUID), defaults to the account set in the provider
- actions
Sequence[Automation
Action Args] - List of actions to perform when the automation is triggered
- actions_
on_ Sequence[Automationresolves Actions On Resolf Args] - List of actions to perform when the automation is triggered
- actions_
on_ Sequence[Automationtriggers Actions On Trigger Args] - List of actions to perform when the automation is triggered
- description str
- Description of the automation
- enabled bool
- Whether the automation is enabled
- name str
- Name of the automation
- workspace_
id str - Workspace ID (UUID), defaults to the workspace set in the provider
- trigger Property Map
- The criteria for which events this Automation covers and how it will respond
- account
Id String - Account ID (UUID), defaults to the account 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
- description String
- Description of the automation
- enabled Boolean
- Whether the automation is enabled
- name String
- Name of the automation
- workspace
Id String - Workspace ID (UUID), defaults to the workspace set in the provider
Outputs
All input properties are implicitly available as output properties. Additionally, the Automation resource produces the following output properties:
Look up Existing Automation Resource
Get an existing Automation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AutomationState, opts?: CustomResourceOptions): Automation
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
actions: Optional[Sequence[AutomationActionArgs]] = None,
actions_on_resolves: Optional[Sequence[AutomationActionsOnResolfArgs]] = None,
actions_on_triggers: Optional[Sequence[AutomationActionsOnTriggerArgs]] = None,
created: Optional[str] = None,
description: Optional[str] = None,
enabled: Optional[bool] = None,
name: Optional[str] = None,
trigger: Optional[AutomationTriggerArgs] = None,
updated: Optional[str] = None,
workspace_id: Optional[str] = None) -> Automation
func GetAutomation(ctx *Context, name string, id IDInput, state *AutomationState, opts ...ResourceOption) (*Automation, error)
public static Automation Get(string name, Input<string> id, AutomationState? state, CustomResourceOptions? opts = null)
public static Automation get(String name, Output<String> id, AutomationState state, CustomResourceOptions options)
resources: _: type: prefect:Automation get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Account
Id string - Account ID (UUID), defaults to the account set in the provider
- Actions
List<Automation
Action> - List of actions to perform when the automation is triggered
- Actions
On List<AutomationResolves Actions On Resolf> - List of actions to perform when the automation is triggered
- Actions
On List<AutomationTriggers 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
- Name string
- Name of the automation
- Trigger
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)
- Workspace
Id string - Workspace ID (UUID), defaults to the workspace set in the provider
- Account
Id string - Account ID (UUID), defaults to the account set in the provider
- Actions
[]Automation
Action Args - List of actions to perform when the automation is triggered
- Actions
On []AutomationResolves Actions On Resolf Args - List of actions to perform when the automation is triggered
- Actions
On []AutomationTriggers Actions On Trigger Args - 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
- Name string
- Name of the automation
- Trigger
Automation
Trigger Args - The criteria for which events this Automation covers and how it will respond
- Updated string
- Timestamp of when the resource was updated (RFC3339)
- Workspace
Id string - Workspace ID (UUID), defaults to the workspace set in the provider
- account
Id String - Account ID (UUID), defaults to the account set in the provider
- actions
List<Automation
Action> - List of actions to perform when the automation is triggered
- actions
On List<AutomationResolves Actions On Resolf> - List of actions to perform when the automation is triggered
- actions
On List<AutomationTriggers 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
- name String
- Name of the automation
- trigger
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)
- workspace
Id String - Workspace ID (UUID), defaults to the workspace set in the provider
- account
Id string - Account ID (UUID), defaults to the account set in the provider
- actions
Automation
Action[] - List of actions to perform when the automation is triggered
- actions
On AutomationResolves Actions On Resolf[] - List of actions to perform when the automation is triggered
- actions
On AutomationTriggers 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
- name string
- Name of the automation
- trigger
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)
- workspace
Id string - Workspace ID (UUID), defaults to the workspace set in the provider
- account_
id str - Account ID (UUID), defaults to the account set in the provider
- actions
Sequence[Automation
Action Args] - List of actions to perform when the automation is triggered
- actions_
on_ Sequence[Automationresolves Actions On Resolf Args] - List of actions to perform when the automation is triggered
- actions_
on_ Sequence[Automationtriggers Actions On Trigger Args] - 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
- name str
- Name of the automation
- trigger
Automation
Trigger Args - The criteria for which events this Automation covers and how it will respond
- updated str
- Timestamp of when the resource was updated (RFC3339)
- workspace_
id str - Workspace ID (UUID), defaults to the workspace set in the provider
- account
Id String - Account ID (UUID), defaults to the account 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
- 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)
- workspace
Id String - Workspace ID (UUID), defaults to the workspace set in the provider
Supporting Types
AutomationAction, AutomationActionArgs
- Type string
- The type of action to perform
- 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
- 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
- Type string
- The type of action to perform
- 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
- 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
- type String
- The type of action to perform
- 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
- 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
- type string
- The type of action to perform
- 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
- 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
- type str
- The type of action to perform
- 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
- 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
- type String
- The type of action to perform
- 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
- 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
AutomationActionsOnResolf, AutomationActionsOnResolfArgs
- Type string
- The type of action to perform
- 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
- 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
- Type string
- The type of action to perform
- 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
- 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
- type String
- The type of action to perform
- 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
- 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
- type string
- The type of action to perform
- 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
- 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
- type str
- The type of action to perform
- 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
- 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
- type String
- The type of action to perform
- 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
- 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
AutomationActionsOnTrigger, AutomationActionsOnTriggerArgs
- Type string
- The type of action to perform
- 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
- 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
- Type string
- The type of action to perform
- 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
- 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
- type String
- The type of action to perform
- 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
- 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
- type string
- The type of action to perform
- 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
- 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
- type str
- The type of action to perform
- 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
- 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
- type String
- The type of action to perform
- 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
- 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
AutomationTrigger, AutomationTriggerArgs
- Compound
Automation
Trigger Compound - A composite trigger that requires some number of triggers to have fired within the given time period
- Event
Automation
Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- Metric
Automation
Trigger Metric - A trigger that fires based on the results of a metric query
- Sequence
Automation
Trigger Sequence - A composite trigger that requires triggers to fire in a specific order
- Compound
Automation
Trigger Compound - A composite trigger that requires some number of triggers to have fired within the given time period
- Event
Automation
Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- Metric
Automation
Trigger Metric - A trigger that fires based on the results of a metric query
- Sequence
Automation
Trigger Sequence - A composite trigger that requires triggers to fire in a specific order
- compound
Automation
Trigger Compound - A composite trigger that requires some number of triggers to have fired within the given time period
- event
Automation
Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
Automation
Trigger Metric - A trigger that fires based on the results of a metric query
- sequence
Automation
Trigger Sequence - A composite trigger that requires triggers to fire in a specific order
- compound
Automation
Trigger Compound - A composite trigger that requires some number of triggers to have fired within the given time period
- event
Automation
Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
Automation
Trigger Metric - A trigger that fires based on the results of a metric query
- sequence
Automation
Trigger Sequence - A composite trigger that requires triggers to fire in a specific order
- compound
Automation
Trigger Compound - A composite trigger that requires some number of triggers to have fired within the given time period
- event
Automation
Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
Automation
Trigger Metric - A trigger that fires based on the results of a metric query
- sequence
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
AutomationTriggerCompound, AutomationTriggerCompoundArgs
- Require object
- How many triggers must fire ('any', 'all', or a number)
- Triggers
List<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
[]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<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
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[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
AutomationTriggerCompoundTrigger, AutomationTriggerCompoundTriggerArgs
- Event
Automation
Trigger Compound Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- Metric
Automation
Trigger Compound Trigger Metric - A trigger that fires based on the results of a metric query
- Event
Automation
Trigger Compound Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- Metric
Automation
Trigger Compound Trigger Metric - A trigger that fires based on the results of a metric query
- event
Automation
Trigger Compound Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
Automation
Trigger Compound Trigger Metric - A trigger that fires based on the results of a metric query
- event
Automation
Trigger Compound Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
Automation
Trigger Compound Trigger Metric - A trigger that fires based on the results of a metric query
- event
Automation
Trigger Compound Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
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
AutomationTriggerCompoundTriggerEvent, AutomationTriggerCompoundTriggerEventArgs
- Posture string
- The posture of this trigger, either Reactive or Proactive
- 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()
. - 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
- Posture string
- The posture of this trigger, either Reactive or Proactive
- 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()
. - 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
- posture String
- The posture of this trigger, either Reactive or Proactive
- 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()
. - 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
- posture string
- The posture of this trigger, either Reactive or Proactive
- 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()
. - 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
- posture str
- The posture of this trigger, either Reactive or Proactive
- 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()
. - 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
- posture String
- The posture of this trigger, either Reactive or Proactive
- 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()
. - 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
AutomationTriggerCompoundTriggerMetric, AutomationTriggerCompoundTriggerMetricArgs
- Metric
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
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
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
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
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 Property Map
- 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()
.
AutomationTriggerCompoundTriggerMetricMetric, AutomationTriggerCompoundTriggerMetricMetricArgs
- 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
AutomationTriggerEvent, AutomationTriggerEventArgs
- Posture string
- The posture of this trigger, either Reactive or Proactive
- 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()
. - 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
- Posture string
- The posture of this trigger, either Reactive or Proactive
- 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()
. - 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
- posture String
- The posture of this trigger, either Reactive or Proactive
- 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()
. - 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
- posture string
- The posture of this trigger, either Reactive or Proactive
- 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()
. - 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
- posture str
- The posture of this trigger, either Reactive or Proactive
- 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()
. - 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
- posture String
- The posture of this trigger, either Reactive or Proactive
- 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()
. - 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
AutomationTriggerMetric, AutomationTriggerMetricArgs
- Metric
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
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
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
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
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 Property Map
- 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()
.
AutomationTriggerMetricMetric, AutomationTriggerMetricMetricArgs
- 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
AutomationTriggerSequence, AutomationTriggerSequenceArgs
- Triggers
List<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
[]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<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
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[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
AutomationTriggerSequenceTrigger, AutomationTriggerSequenceTriggerArgs
- Event
Automation
Trigger Sequence Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- Metric
Automation
Trigger Sequence Trigger Metric - A trigger that fires based on the results of a metric query
- Event
Automation
Trigger Sequence Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- Metric
Automation
Trigger Sequence Trigger Metric - A trigger that fires based on the results of a metric query
- event
Automation
Trigger Sequence Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
Automation
Trigger Sequence Trigger Metric - A trigger that fires based on the results of a metric query
- event
Automation
Trigger Sequence Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
Automation
Trigger Sequence Trigger Metric - A trigger that fires based on the results of a metric query
- event
Automation
Trigger Sequence Trigger Event - A trigger that fires based on the presence or absence of events within a given period of time
- metric
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
AutomationTriggerSequenceTriggerEvent, AutomationTriggerSequenceTriggerEventArgs
- Posture string
- The posture of this trigger, either Reactive or Proactive
- 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()
. - 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
- Posture string
- The posture of this trigger, either Reactive or Proactive
- 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()
. - 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
- posture String
- The posture of this trigger, either Reactive or Proactive
- 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()
. - 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
- posture string
- The posture of this trigger, either Reactive or Proactive
- 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()
. - 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
- posture str
- The posture of this trigger, either Reactive or Proactive
- 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()
. - 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
- posture String
- The posture of this trigger, either Reactive or Proactive
- 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()
. - 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
AutomationTriggerSequenceTriggerMetric, AutomationTriggerSequenceTriggerMetricArgs
- Metric
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
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
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
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
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 Property Map
- 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()
.
AutomationTriggerSequenceTriggerMetricMetric, AutomationTriggerSequenceTriggerMetricMetricArgs
- 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
Import
prefect_automation resources can be imported by the automation_id
$ pulumi import prefect:index/automation:Automation my_automation 00000000-0000-0000-0000-000000000000
or from a different workspace via automation_id,workspace_id
$ pulumi import prefect:index/automation:Automation my_automation 00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- prefect prefecthq/terraform-provider-prefect
- License
- Notes
- This Pulumi package is based on the
prefect
Terraform Provider.