Class: AWSCDK::ImageBuilder::CfnImagePipeline::WorkflowConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
image_builder/cfn_image_pipeline.rb

Overview

Contains control settings and configurable inputs for a workflow resource.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(on_failure: nil, parallel_group: nil, parameters: nil, workflow_arn: nil) ⇒ WorkflowConfigurationProperty

Returns a new instance of WorkflowConfigurationProperty.

Parameters:

  • on_failure (String, nil) (defaults to: nil) —

    The action to take if the workflow fails.

  • parallel_group (String, nil) (defaults to: nil) —

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

  • parameters (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::ImageBuilder::CfnImagePipeline::WorkflowParameterProperty>, nil) (defaults to: nil) —

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

  • workflow_arn (String, nil) (defaults to: nil) —

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



1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
 
# File 'image_builder/cfn_image_pipeline.rb', line 1001

def initialize(on_failure: nil, parallel_group: nil, parameters: nil, workflow_arn: nil)
  @on_failure = on_failure
  Jsii::Type.check_type(@on_failure, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "onFailure") unless @on_failure.nil?
  @parallel_group = parallel_group
  Jsii::Type.check_type(@parallel_group, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parallelGroup") unless @parallel_group.nil?
  @parameters = parameters
  Jsii::Type.check_type(@parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW1hZ2VidWlsZGVyLkNmbkltYWdlUGlwZWxpbmUuV29ya2Zsb3dQYXJhbWV0ZXJQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "parameters") unless @parameters.nil?
  @workflow_arn = workflow_arn
  Jsii::Type.check_type(@workflow_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workflowArn") unless @workflow_arn.nil?
end

Instance Attribute Details

#on_failure ⇒ String? (readonly)

The action to take if the workflow fails.

Returns:

  • (String, nil)

See Also:



1016
1017
1018
 
# File 'image_builder/cfn_image_pipeline.rb', line 1016

def on_failure
  @on_failure
end

#parallel_group ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



1023
1024
1025
 
# File 'image_builder/cfn_image_pipeline.rb', line 1023

def parallel_group
  @parallel_group
end

#parameters ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



1028
1029
1030
 
# File 'image_builder/cfn_image_pipeline.rb', line 1028

def parameters
  @parameters
end

#workflow_arn ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1033
1034
1035
 
# File 'image_builder/cfn_image_pipeline.rb', line 1033

def workflow_arn
  @workflow_arn
end

Class Method Details

.jsii_properties ⇒ Object 



1035
1036
1037
1038
1039
1040
1041
1042
 
# File 'image_builder/cfn_image_pipeline.rb', line 1035

def self.jsii_properties
  {
    :on_failure => "onFailure",
    :parallel_group => "parallelGroup",
    :parameters => "parameters",
    :workflow_arn => "workflowArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
 
# File 'image_builder/cfn_image_pipeline.rb', line 1044

def to_jsii
  result = {}
  result.merge!({
    "onFailure" => @on_failure,
    "parallelGroup" => @parallel_group,
    "parameters" => @parameters,
    "workflowArn" => @workflow_arn,
  })
  result.compact
end