AWS CDK Reference

Appearance

v2.275.0

Experimental

@aws-cdk/aws-imagebuilder-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

AmazonManagedWorkflow Class ​

Helper class for working with Amazon-managed workflows.

Stability
Experimental
Source
lib/amazon-managed-workflow.ts

Example ​

ts
const containerWorkflowPipeline = new imagebuilder.ImagePipeline(this, 'ContainerWorkflowPipeline', {
  recipe: exampleContainerRecipe,
  workflows: [
    { workflow: imagebuilder.AmazonManagedWorkflow.buildContainer(this, 'BuildContainer') },
    { workflow: imagebuilder.AmazonManagedWorkflow.testContainer(this, 'TestContainer') },
    { workflow: imagebuilder.AmazonManagedWorkflow.distributeContainer(this, 'DistributeContainer') }
  ]
});
python
container_workflow_pipeline = imagebuilder.ImagePipeline(self, "ContainerWorkflowPipeline",
    recipe=example_container_recipe,
    workflows=[imagebuilder.WorkflowConfiguration(workflow=imagebuilder.AmazonManagedWorkflow.build_container(self, "BuildContainer")), imagebuilder.WorkflowConfiguration(workflow=imagebuilder.AmazonManagedWorkflow.test_container(self, "TestContainer")), imagebuilder.WorkflowConfiguration(workflow=imagebuilder.AmazonManagedWorkflow.distribute_container(self, "DistributeContainer"))
    ]
)
java
ImagePipeline containerWorkflowPipeline = ImagePipeline.Builder.create(this, "ContainerWorkflowPipeline")
        .recipe(exampleContainerRecipe)
        .workflows(List.of(WorkflowConfiguration.builder().workflow(AmazonManagedWorkflow.buildContainer(this, "BuildContainer")).build(), WorkflowConfiguration.builder().workflow(AmazonManagedWorkflow.testContainer(this, "TestContainer")).build(), WorkflowConfiguration.builder().workflow(AmazonManagedWorkflow.distributeContainer(this, "DistributeContainer")).build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.ImageBuilder.Alpha
var containerWorkflowPipeline = new ImagePipeline(this, "ContainerWorkflowPipeline", new ImagePipelineProps {
    Recipe = exampleContainerRecipe,
    Workflows = new [] { new WorkflowConfiguration { Workflow = AmazonManagedWorkflow.BuildContainer(this, "BuildContainer") }, new WorkflowConfiguration { Workflow = AmazonManagedWorkflow.TestContainer(this, "TestContainer") }, new WorkflowConfiguration { Workflow = AmazonManagedWorkflow.DistributeContainer(this, "DistributeContainer") } }
});
go
// Install: go get github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2
containerWorkflowPipeline := imagebuilder.NewImagePipeline(this, jsii.String("ContainerWorkflowPipeline"), &ImagePipelineProps{
	Recipe: exampleContainerRecipe,
	Workflows: []WorkflowConfiguration{
		&WorkflowConfiguration{
			Workflow: imagebuilder.AmazonManagedWorkflow_BuildContainer(this, jsii.String("BuildContainer")),
		},
		&WorkflowConfiguration{
			Workflow: imagebuilder.AmazonManagedWorkflow_TestContainer(this, jsii.String("TestContainer")),
		},
		&WorkflowConfiguration{
			Workflow: imagebuilder.AmazonManagedWorkflow_DistributeContainer(this, jsii.String("DistributeContainer")),
		},
	},
})

Initializer ​

ts
new AmazonManagedWorkflow()
python
AmazonManagedWorkflow()
java
new AmazonManagedWorkflow()
csharp
new AmazonManagedWorkflow()
go
NewAmazonManagedWorkflow()

Methods ​

buildContainer(scope: Construct, id: string): IWorkflow@staticmethod def build_container(scope: Construct, id: str) -> IWorkflowpublic static IWorkflow buildContainer(Construct scope, String id)public static IWorkflow BuildContainer(Construct scope, string id)func BuildContainer(Scope Construct, Id *string) IWorkflowstatic#
Imports the build-container Amazon-managed workflow.
2 parameters

Parameters

  • scopescopescopescopeScope — The construct scope.
  • ididididId — Identifier of the construct.
buildImage(scope: Construct, id: string): IWorkflow@staticmethod def build_image(scope: Construct, id: str) -> IWorkflowpublic static IWorkflow buildImage(Construct scope, String id)public static IWorkflow BuildImage(Construct scope, string id)func BuildImage(Scope Construct, Id *string) IWorkflowstatic#
Imports the build-image AWS-managed workflow.
2 parameters

Parameters

  • scopescopescopescopeScope — The construct scope.
  • ididididId — Identifier of the construct.
distributeContainer(scope: Construct, id: string): IWorkflow@staticmethod def distribute_container(scope: Construct, id: str) -> IWorkflowpublic static IWorkflow distributeContainer(Construct scope, String id)public static IWorkflow DistributeContainer(Construct scope, string id)func DistributeContainer(Scope Construct, Id *string) IWorkflowstatic#
Imports the distribute-container AWS-managed workflow.
2 parameters

Parameters

  • scopescopescopescopeScope — The construct scope.
  • ididididId — Identifier of the construct.
distributeImage(scope: Construct, id: string): IWorkflow@staticmethod def distribute_image(scope: Construct, id: str) -> IWorkflowpublic static IWorkflow distributeImage(Construct scope, String id)public static IWorkflow DistributeImage(Construct scope, string id)func DistributeImage(Scope Construct, Id *string) IWorkflowstatic#
Imports the distribute-image AWS-managed workflow.
2 parameters

Parameters

  • scopescopescopescopeScope — The construct scope.
  • ididididId — Identifier of the construct.
fromAmazonManagedWorkflowAttributes(scope: Construct, id: string, attrs: AmazonManagedWorkflowAttributes): IWorkflow@staticmethod def from_amazon_managed_workflow_attributes(scope: Construct, id: str, attrs: AmazonManagedWorkflowAttributes) -> IWorkflowpublic static IWorkflow fromAmazonManagedWorkflowAttributes(Construct scope, String id, AmazonManagedWorkflowAttributes attrs)public static IWorkflow FromAmazonManagedWorkflowAttributes(Construct scope, string id, AmazonManagedWorkflowAttributes attrs)func FromAmazonManagedWorkflowAttributes(Scope Construct, Id *string, Attrs AmazonManagedWorkflowAttributes) IWorkflowstatic#
Imports an AWS-managed workflow from its attributes.
3 parameters

Parameters

  • scopescopescopescopeScope — The construct scope.
  • ididididId — Identifier of the construct.
  • attrsattrsattrsattrsAttrs — The attributes of the AWS-managed workflow.
testContainer(scope: Construct, id: string): IWorkflow@staticmethod def test_container(scope: Construct, id: str) -> IWorkflowpublic static IWorkflow testContainer(Construct scope, String id)public static IWorkflow TestContainer(Construct scope, string id)func TestContainer(Scope Construct, Id *string) IWorkflowstatic#
Imports the test-container AWS-managed workflow.
2 parameters

Parameters

  • scopescopescopescopeScope — The construct scope.
  • ididididId — Identifier of the construct.
testImage(scope: Construct, id: string): IWorkflow@staticmethod def test_image(scope: Construct, id: str) -> IWorkflowpublic static IWorkflow testImage(Construct scope, String id)public static IWorkflow TestImage(Construct scope, string id)func TestImage(Scope Construct, Id *string) IWorkflowstatic#
Imports the test-image AWS-managed workflow.
2 parameters

Parameters

  • scopescopescopescopeScope — The construct scope.
  • ididididId — Identifier of the construct.