Package software.amazon.awscdk.services.imagebuilder

Interface CfnImage.WorkflowConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnImage.WorkflowConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnImage

@Stability(Stable)
public static interface CfnImage.WorkflowConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Contains control settings and configurable inputs for a workflow resource.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.imagebuilder.*;
 WorkflowConfigurationProperty workflowConfigurationProperty = WorkflowConfigurationProperty.builder()
         .onFailure("onFailure")
         .parallelGroup("parallelGroup")
         .parameters(List.of(WorkflowParameterProperty.builder()
                 .name("name")
                 .value(List.of("value"))
                 .build()))
         .workflowArn("workflowArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-workflowconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnImage.WorkflowConfigurationProperty.Builder	A builder for CfnImage.WorkflowConfigurationProperty
static final class	CfnImage.WorkflowConfigurationProperty.Jsii$Proxy	An implementation for CfnImage.WorkflowConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnImage.WorkflowConfigurationProperty.Builder	builder()
default String	getOnFailure()	The action to take if the workflow fails.
default String	getParallelGroup()	Test workflows are defined within named runtime groups called parallel groups.
default Object	getParameters()	Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.
default String	getWorkflowArn()	The Amazon Resource Name (ARN) of the workflow resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getOnFailure

@Stability(Stable)
@Nullable
default String getOnFailure()

The action to take if the workflow fails.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-workflowconfiguration.html#cfn-imagebuilder-image-workflowconfiguration-onfailure

getParallelGroup

@Stability(Stable)
@Nullable
default String getParallelGroup()

Test workflows are defined within named runtime groups called parallel groups.

The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-workflowconfiguration.html#cfn-imagebuilder-image-workflowconfiguration-parallelgroup

getParameters

@Stability(Stable)
@Nullable
default Object getParameters()

Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-workflowconfiguration.html#cfn-imagebuilder-image-workflowconfiguration-parameters

getWorkflowArn

@Stability(Stable)
@Nullable
default String getWorkflowArn()

The Amazon Resource Name (ARN) of the workflow resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-workflowconfiguration.html#cfn-imagebuilder-image-workflowconfiguration-workflowarn

builder

@Stability(Stable)
static CfnImage.WorkflowConfigurationProperty.Builder builder()

Returns:

a CfnImage.WorkflowConfigurationProperty.Builder of CfnImage.WorkflowConfigurationProperty