« blib/lib/Paws/CodeDeploy/CreateDeployment.pm
↑ Summary
blib/lib/Paws/CodeDeploy/CreateDeploymentConfigOutput.pm »
| 1 | |||
| 2 | package Paws::CodeDeploy::CreateDeploymentConfig; | ||
| 3 | use Moose; | ||
| 4 | has ComputePlatform => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'computePlatform' ); | ||
| 5 | has DeploymentConfigName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'deploymentConfigName' , required => 1); | ||
| 6 | has MinimumHealthyHosts => (is => 'ro', isa => 'Paws::CodeDeploy::MinimumHealthyHosts', traits => ['NameInRequest'], request_name => 'minimumHealthyHosts' ); | ||
| 7 | has TrafficRoutingConfig => (is => 'ro', isa => 'Paws::CodeDeploy::TrafficRoutingConfig', traits => ['NameInRequest'], request_name => 'trafficRoutingConfig' ); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDeploymentConfig'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeDeploy::CreateDeploymentConfigOutput'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CodeDeploy::CreateDeploymentConfig - Arguments for method CreateDeploymentConfig on L<Paws::CodeDeploy> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method CreateDeploymentConfig on the | ||
| 25 | L<AWS CodeDeploy|Paws::CodeDeploy> service. Use the attributes of this class | ||
| 26 | as arguments to method CreateDeploymentConfig. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDeploymentConfig. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $codedeploy = Paws->service('CodeDeploy'); | ||
| 33 | my $CreateDeploymentConfigOutput = $codedeploy->CreateDeploymentConfig( | ||
| 34 | DeploymentConfigName => 'MyDeploymentConfigName', | ||
| 35 | ComputePlatform => 'Server', # OPTIONAL | ||
| 36 | MinimumHealthyHosts => { | ||
| 37 | Type => 'HOST_COUNT', # values: HOST_COUNT, FLEET_PERCENT; OPTIONAL | ||
| 38 | Value => 1, # OPTIONAL | ||
| 39 | }, # OPTIONAL | ||
| 40 | TrafficRoutingConfig => { | ||
| 41 | TimeBasedCanary => { | ||
| 42 | CanaryInterval => 1, # OPTIONAL | ||
| 43 | CanaryPercentage => 1, # OPTIONAL | ||
| 44 | }, # OPTIONAL | ||
| 45 | TimeBasedLinear => { | ||
| 46 | LinearInterval => 1, # OPTIONAL | ||
| 47 | LinearPercentage => 1, # OPTIONAL | ||
| 48 | }, # OPTIONAL | ||
| 49 | Type => 'TimeBasedCanary' | ||
| 50 | , # values: TimeBasedCanary, TimeBasedLinear, AllAtOnce; OPTIONAL | ||
| 51 | }, # OPTIONAL | ||
| 52 | ); | ||
| 53 | |||
| 54 | # Results: | ||
| 55 | my $DeploymentConfigId = $CreateDeploymentConfigOutput->DeploymentConfigId; | ||
| 56 | |||
| 57 | # Returns a L<Paws::CodeDeploy::CreateDeploymentConfigOutput> object. | ||
| 58 | |||
| 59 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codedeploy/CreateDeploymentConfig> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 ComputePlatform => Str | ||
| 66 | |||
| 67 | The destination platform type for the deployment (C<Lambda>, C<Server>, | ||
| 68 | or C<ECS>). | ||
| 69 | |||
| 70 | Valid values are: C<"Server">, C<"Lambda">, C<"ECS"> | ||
| 71 | |||
| 72 | =head2 B<REQUIRED> DeploymentConfigName => Str | ||
| 73 | |||
| 74 | The name of the deployment configuration to create. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 MinimumHealthyHosts => L<Paws::CodeDeploy::MinimumHealthyHosts> | ||
| 79 | |||
| 80 | The minimum number of healthy instances that should be available at any | ||
| 81 | time during the deployment. There are two parameters expected in the | ||
| 82 | input: type and value. | ||
| 83 | |||
| 84 | The type parameter takes either of the following values: | ||
| 85 | |||
| 86 | =over | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | HOST_COUNT: The value parameter represents the minimum number of | ||
| 91 | healthy instances as an absolute value. | ||
| 92 | |||
| 93 | =item * | ||
| 94 | |||
| 95 | FLEET_PERCENT: The value parameter represents the minimum number of | ||
| 96 | healthy instances as a percentage of the total number of instances in | ||
| 97 | the deployment. If you specify FLEET_PERCENT, at the start of the | ||
| 98 | deployment, AWS CodeDeploy converts the percentage to the equivalent | ||
| 99 | number of instances and rounds up fractional instances. | ||
| 100 | |||
| 101 | =back | ||
| 102 | |||
| 103 | The value parameter takes an integer. | ||
| 104 | |||
| 105 | For example, to set a minimum of 95% healthy instance, specify a type | ||
| 106 | of FLEET_PERCENT and a value of 95. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 TrafficRoutingConfig => L<Paws::CodeDeploy::TrafficRoutingConfig> | ||
| 111 | |||
| 112 | The configuration that specifies how the deployment traffic is routed. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head1 SEE ALSO | ||
| 118 | |||
| 119 | This class forms part of L<Paws>, documenting arguments for method CreateDeploymentConfig in L<Paws::CodeDeploy> | ||
| 120 | |||
| 121 | =head1 BUGS and CONTRIBUTIONS | ||
| 122 | |||
| 123 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 124 | |||
| 125 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 126 | |||
| 127 | =cut | ||
| 128 |