Class: AWSCDK::CodeDeploy::CfnDeploymentGroup::DeploymentReadyOptionProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
code_deploy/cfn_deployment_group.rb

Overview

Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(action_on_timeout: nil, wait_time_in_minutes: nil) ⇒ DeploymentReadyOptionProperty

Returns a new instance of DeploymentReadyOptionProperty.

Parameters:

  • action_on_timeout (String, nil) (defaults to: nil)

    Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.

  • wait_time_in_minutes (Numeric, nil) (defaults to: nil)

    The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually.



1076
1077
1078
1079
1080
1081
# File 'code_deploy/cfn_deployment_group.rb', line 1076

def initialize(action_on_timeout: nil, wait_time_in_minutes: nil)
  @action_on_timeout = action_on_timeout
  Jsii::Type.check_type(@action_on_timeout, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actionOnTimeout") unless @action_on_timeout.nil?
  @wait_time_in_minutes = wait_time_in_minutes
  Jsii::Type.check_type(@wait_time_in_minutes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "waitTimeInMinutes") unless @wait_time_in_minutes.nil?
end

Instance Attribute Details

#action_on_timeoutString? (readonly)

Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.

  • CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.
  • STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment . If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.


1090
1091
1092
# File 'code_deploy/cfn_deployment_group.rb', line 1090

def action_on_timeout
  @action_on_timeout
end

#wait_time_in_minutesNumeric? (readonly)

The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually.

Applies only to the STOP_DEPLOYMENT option for action_on_timeout .



1097
1098
1099
# File 'code_deploy/cfn_deployment_group.rb', line 1097

def wait_time_in_minutes
  @wait_time_in_minutes
end

Class Method Details

.jsii_propertiesObject



1099
1100
1101
1102
1103
1104
# File 'code_deploy/cfn_deployment_group.rb', line 1099

def self.jsii_properties
  {
    :action_on_timeout => "actionOnTimeout",
    :wait_time_in_minutes => "waitTimeInMinutes",
  }
end

Instance Method Details

#to_jsiiObject



1106
1107
1108
1109
1110
1111
1112
1113
# File 'code_deploy/cfn_deployment_group.rb', line 1106

def to_jsii
  result = {}
  result.merge!({
    "actionOnTimeout" => @action_on_timeout,
    "waitTimeInMinutes" => @wait_time_in_minutes,
  })
  result.compact
end