You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodeDeploy::Types::CreateDeploymentConfigInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb

Overview

Note:

When making an API call, you may pass CreateDeploymentConfigInput data as a hash:

{
  deployment_config_name: "DeploymentConfigName", # required
  minimum_healthy_hosts: { # required
    value: 1,
    type: "HOST_COUNT", # accepts HOST_COUNT, FLEET_PERCENT
  },
  traffic_routing_config: {
    type: "TimeBasedCanary", # accepts TimeBasedCanary, TimeBasedLinear, AllAtOnce
    time_based_canary: {
      canary_percentage: 1,
      canary_interval: 1,
    },
    time_based_linear: {
      linear_percentage: 1,
      linear_interval: 1,
    },
  },
  compute_platform: "Server", # accepts Server, Lambda
}

Represents the input of a CreateDeploymentConfig operation.

Instance Attribute Summary collapse

Instance Attribute Details

#compute_platformString

The destination platform type for the deployment (Lambda or Server>).

Returns:

  • (String)


663
664
665
666
667
668
669
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 663

class CreateDeploymentConfigInput < Struct.new(
  :deployment_config_name,
  :minimum_healthy_hosts,
  :traffic_routing_config,
  :compute_platform)
  include Aws::Structure
end

#deployment_config_nameString

The name of the deployment configuration to create.

Returns:

  • (String)


663
664
665
666
667
668
669
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 663

class CreateDeploymentConfigInput < Struct.new(
  :deployment_config_name,
  :minimum_healthy_hosts,
  :traffic_routing_config,
  :compute_platform)
  include Aws::Structure
end

#minimum_healthy_hostsTypes::MinimumHealthyHosts

The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.

The type parameter takes either of the following values:

  • HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.

  • FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, AWS CodeDeploy converts the percentage to the equivalent number of instance and rounds up fractional instances.

The value parameter takes an integer.

For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.



663
664
665
666
667
668
669
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 663

class CreateDeploymentConfigInput < Struct.new(
  :deployment_config_name,
  :minimum_healthy_hosts,
  :traffic_routing_config,
  :compute_platform)
  include Aws::Structure
end

#traffic_routing_configTypes::TrafficRoutingConfig

The configuration that specifies how the deployment traffic will be routed.



663
664
665
666
667
668
669
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 663

class CreateDeploymentConfigInput < Struct.new(
  :deployment_config_name,
  :minimum_healthy_hosts,
  :traffic_routing_config,
  :compute_platform)
  include Aws::Structure
end