Workflow class
Resource for managing an AWS EC2 Image Builder Workflow.
> Image Builder manages the workflows for the distribution stage. Therefore, using the DISTRIBUTION workflow type results in an error.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.imagebuilder.Workflow("example", {
name: "example",
version: "1.0.0",
type: "TEST",
data: `name: example
description: Workflow to test an image
schemaVersion: 1.0
parameters:
- name: waitForActionAtEnd
type: boolean
steps:
- name: LaunchTestInstance
action: LaunchInstance
onFailure: Abort
inputs:
waitFor: \\"ssmAgent\\"
- name: TerminateTestInstance
action: TerminateInstance
onFailure: Continue
inputs:
instanceId.: \\".stepOutputs.LaunchTestInstance.instanceId\\"
- name: WaitForActionAtEnd
action: WaitForAction
if:
booleanEquals: true
value: \\".parameters.waitForActionAtEnd\\"
`,
});
import pulumi
import pulumi_aws as aws
example = aws.imagebuilder.Workflow("example",
name="example",
version="1.0.0",
type="TEST",
data="""name: example
description: Workflow to test an image
schemaVersion: 1.0
parameters:
- name: waitForActionAtEnd
type: boolean
steps:
- name: LaunchTestInstance
action: LaunchInstance
onFailure: Abort
inputs:
waitFor: \"ssmAgent\"
- name: TerminateTestInstance
action: TerminateInstance
onFailure: Continue
inputs:
instanceId.$: \"$.stepOutputs.LaunchTestInstance.instanceId\"
- name: WaitForActionAtEnd
action: WaitForAction
if:
booleanEquals: true
value: \"$.parameters.waitForActionAtEnd\"
""")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.ImageBuilder.Workflow("example", new()
{
Name = "example",
Version = "1.0.0",
Type = "TEST",
Data = @"name: example
description: Workflow to test an image
schemaVersion: 1.0
parameters:
- name: waitForActionAtEnd
type: boolean
steps:
- name: LaunchTestInstance
action: LaunchInstance
onFailure: Abort
inputs:
waitFor: \""ssmAgent\""
- name: TerminateTestInstance
action: TerminateInstance
onFailure: Continue
inputs:
instanceId.$: \""$.stepOutputs.LaunchTestInstance.instanceId\""
- name: WaitForActionAtEnd
action: WaitForAction
if:
booleanEquals: true
value: \""$.parameters.waitForActionAtEnd\""
",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/imagebuilder"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := imagebuilder.NewWorkflow(ctx, "example", &imagebuilder.WorkflowArgs{
Name: pulumi.String("example"),
Version: pulumi.String("1.0.0"),
Type: pulumi.String("TEST"),
Data: pulumi.String(`name: example
description: Workflow to test an image
schemaVersion: 1.0
parameters:
- name: waitForActionAtEnd
type: boolean
steps:
- name: LaunchTestInstance
action: LaunchInstance
onFailure: Abort
inputs:
waitFor: \"ssmAgent\"
- name: TerminateTestInstance
action: TerminateInstance
onFailure: Continue
inputs:
instanceId.$: \"$.stepOutputs.LaunchTestInstance.instanceId\"
- name: WaitForActionAtEnd
action: WaitForAction
if:
booleanEquals: true
value: \"$.parameters.waitForActionAtEnd\"
`),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_imagebuilder_workflow" "example" {
name = "example"
version = "1.0.0"
type = "TEST"
data = "name: example\ndescription: Workflow to test an image\nschemaVersion: 1.0\n\nparameters:\n - name: waitForActionAtEnd\n type: boolean\n\nsteps:\n - name: LaunchTestInstance\n action: LaunchInstance\n onFailure: Abort\n inputs:\n waitFor: \\\"ssmAgent\\\"\n\n - name: TerminateTestInstance\n action: TerminateInstance\n onFailure: Continue\n inputs:\n instanceId.$: \\\"$.stepOutputs.LaunchTestInstance.instanceId\\\"\n\n - name: WaitForActionAtEnd\n action: WaitForAction\n if:\n booleanEquals: true\n value: \\\"$.parameters.waitForActionAtEnd\\\"\n"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.imagebuilder.Workflow;
import com.pulumi.aws.imagebuilder.WorkflowArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
var example = new Workflow("example", WorkflowArgs.builder()
.name("example")
.version("1.0.0")
.type("TEST")
.data("""
name: example
description: Workflow to test an image
schemaVersion: 1.0
parameters:
- name: waitForActionAtEnd
type: boolean
steps:
- name: LaunchTestInstance
action: LaunchInstance
onFailure: Abort
inputs:
waitFor: \"ssmAgent\"
- name: TerminateTestInstance
action: TerminateInstance
onFailure: Continue
inputs:
instanceId.$: \"$.stepOutputs.LaunchTestInstance.instanceId\"
- name: WaitForActionAtEnd
action: WaitForAction
if:
booleanEquals: true
value: \"$.parameters.waitForActionAtEnd\"
""")
.build());
}
}
resources:
example:
type: aws:imagebuilder:Workflow
properties:
name: example
version: 1.0.0
type: TEST
data: |
name: example
description: Workflow to test an image
schemaVersion: 1.0
parameters:
- name: waitForActionAtEnd
type: boolean
steps:
- name: LaunchTestInstance
action: LaunchInstance
onFailure: Abort
inputs:
waitFor: \"ssmAgent\"
- name: TerminateTestInstance
action: TerminateInstance
onFailure: Continue
inputs:
instanceId.$: \"$.stepOutputs.LaunchTestInstance.instanceId\"
- name: WaitForActionAtEnd
action: WaitForAction
if:
booleanEquals: true
value: \"$.parameters.waitForActionAtEnd\"
Import
Identity Schema
Required
arn(String) ARN of the Image Builder workflow.
Using pulumi import, import EC2 Image Builder Workflow using the arn. For example:
$ pulumi import aws:imagebuilder/workflow:Workflow example arn:aws:imagebuilder:us-east-1:aws:workflow/test/example/1.0.1/1
Certain resource arguments, such as uri, cannot be read via the API and imported into Terraform. Terraform will display a difference for these arguments the first run after import if declared in the Terraform configuration for an imported resource.
Constructors
- Workflow(String name, {WorkflowArgs? args, CustomResourceOptions? options})
-
Creates a new Workflow.
nameThe Pulumi resource name.argsArguments used to configure this Workflow. The set of arguments for Workflow.optionsResource options controlling this resource's behavior. - Workflow.reference(String urn)
- Creates a typed reference to an existing Workflow resource.
Properties
-
arn
↔ Output<
String> -
ARN of the workflow.
latefinal
-
changeDescription
↔ Output<
String?> -
Change description of the workflow.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
data
↔ Output<
String> -
Inline YAML string with data of the workflow. Exactly one of
dataandurican be specified.latefinal -
dateCreated
↔ Output<
String> -
Date the workflow was created.
latefinal
-
description
↔ Output<
String?> -
Description of the workflow.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
kmsKeyId
↔ Output<
String?> -
ARN of the KMS Key used to encrypt the workflow.
latefinal
-
name
↔ Output<
String> -
Name of the workflow.
latefinal
-
owner
↔ Output<
String> -
Owner of the workflow.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Key-value map of resource tags for the workflow. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
type
↔ Output<
String> -
Type of the workflow. Valid values:
BUILD,TEST.latefinal -
uri
↔ Output<
String?> -
S3 URI with data of the workflow. Exactly one of
dataandurican be specified.latefinal -
urn
↔ Output<
String> -
latefinalinherited
-
version
↔ Output<
String> -
Version of the workflow.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited