Class: AWSCDK::ARCRegionSwitch::CfnPlan::WorkflowProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::ARCRegionSwitch::CfnPlan::WorkflowProperty

Defined in:

arc_region_switch/cfn_plan.rb

Overview

Represents a workflow in a Region switch plan.

A workflow defines a sequence of steps to execute during a Region switch.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-workflow.html

Instance Attribute Summary

• #steps ⇒ AWSCDK::IResolvable, ... readonly

  The steps that make up the workflow.

• #workflow_description ⇒ String^? readonly

  The description of the workflow.

• #workflow_target_action ⇒ String readonly

  The action that the workflow performs.

• #workflow_target_region ⇒ String^? readonly

  The AWS Region that the workflow targets.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(workflow_target_action:, steps: nil, workflow_description: nil, workflow_target_region: nil) ⇒ WorkflowProperty constructor

  A new instance of WorkflowProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(workflow_target_action:, steps: nil, workflow_description: nil, workflow_target_region: nil) ⇒ WorkflowProperty

Returns a new instance of WorkflowProperty.

Parameters:

• workflow_target_action (String) —

  The action that the workflow performs.

• steps (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::ARCRegionSwitch::CfnPlan::StepProperty>, nil) (defaults to: nil) —

  The steps that make up the workflow.

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

  The description of the workflow.

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

  The AWS Region that the workflow targets.

# File 'arc_region_switch/cfn_plan.rb', line 3209

def initialize(workflow_target_action:, steps: nil, workflow_description: nil, workflow_target_region: nil)
  @workflow_target_action = workflow_target_action
  Jsii::Type.check_type(@workflow_target_action, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workflowTargetAction")
  @steps = steps
  Jsii::Type.check_type(@steps, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXJjcmVnaW9uc3dpdGNoLkNmblBsYW4uU3RlcFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "steps") unless @steps.nil?
  @workflow_description = workflow_description
  Jsii::Type.check_type(@workflow_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workflowDescription") unless @workflow_description.nil?
  @workflow_target_region = workflow_target_region
  Jsii::Type.check_type(@workflow_target_region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workflowTargetRegion") unless @workflow_target_region.nil?
end

Instance Attribute Details

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

The steps that make up the workflow.

Returns:

• (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::ARCRegionSwitch::CfnPlan::StepProperty>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-workflow.html#cfn-arcregionswitch-plan-workflow-steps

# File 'arc_region_switch/cfn_plan.rb', line 3231

def steps
  @steps
end

#workflow_description ⇒ String^? (readonly)

The description of the workflow.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-workflow.html#cfn-arcregionswitch-plan-workflow-workflowdescription

# File 'arc_region_switch/cfn_plan.rb', line 3236

def workflow_description
  @workflow_description
end

#workflow_target_action ⇒ String (readonly)

The action that the workflow performs.

Valid values include ACTIVATE and DEACTIVATE.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-workflow.html#cfn-arcregionswitch-plan-workflow-workflowtargetaction

# File 'arc_region_switch/cfn_plan.rb', line 3226

def workflow_target_action
  @workflow_target_action
end

#workflow_target_region ⇒ String^? (readonly)

The AWS Region that the workflow targets.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-workflow.html#cfn-arcregionswitch-plan-workflow-workflowtargetregion

# File 'arc_region_switch/cfn_plan.rb', line 3241

def workflow_target_region
  @workflow_target_region
end

Class Method Details

.jsii_properties ⇒ Object

# File 'arc_region_switch/cfn_plan.rb', line 3243

def self.jsii_properties
  {
    :workflow_target_action => "workflowTargetAction",
    :steps => "steps",
    :workflow_description => "workflowDescription",
    :workflow_target_region => "workflowTargetRegion",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'arc_region_switch/cfn_plan.rb', line 3252

def to_jsii
  result = {}
  result.merge!({
    "workflowTargetAction" => @workflow_target_action,
    "steps" => @steps,
    "workflowDescription" => @workflow_description,
    "workflowTargetRegion" => @workflow_target_region,
  })
  result.compact
end