« blib/lib/Paws/AppConfig/CreateConfigurationProfile.pm
↑ Summary
blib/lib/Paws/AppConfig/CreateEnvironment.pm »
| 1 | |||
| 2 | package Paws::AppConfig::CreateDeploymentStrategy; | ||
| 3 | use Moose; | ||
| 4 | has DeploymentDurationInMinutes => (is => 'ro', isa => 'Int', required => 1); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has FinalBakeTimeInMinutes => (is => 'ro', isa => 'Int'); | ||
| 7 | has GrowthFactor => (is => 'ro', isa => 'Num', required => 1); | ||
| 8 | has GrowthType => (is => 'ro', isa => 'Str'); | ||
| 9 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has ReplicateTo => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has Tags => (is => 'ro', isa => 'Paws::AppConfig::TagMap'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDeploymentStrategy'); | ||
| 16 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/deploymentstrategies'); | ||
| 17 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AppConfig::DeploymentStrategy'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::AppConfig::CreateDeploymentStrategy - Arguments for method CreateDeploymentStrategy on L<Paws::AppConfig> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method CreateDeploymentStrategy on the | ||
| 30 | L<Amazon AppConfig|Paws::AppConfig> service. Use the attributes of this class | ||
| 31 | as arguments to method CreateDeploymentStrategy. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDeploymentStrategy. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $appconfig = Paws->service('AppConfig'); | ||
| 38 | my $DeploymentStrategy = $appconfig->CreateDeploymentStrategy( | ||
| 39 | DeploymentDurationInMinutes => 1, | ||
| 40 | GrowthFactor => 1.0, | ||
| 41 | Name => 'MyName', | ||
| 42 | ReplicateTo => 'NONE', | ||
| 43 | Description => 'MyDescription', # OPTIONAL | ||
| 44 | FinalBakeTimeInMinutes => 1, # OPTIONAL | ||
| 45 | GrowthType => 'LINEAR', # OPTIONAL | ||
| 46 | Tags => { | ||
| 47 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 48 | }, # OPTIONAL | ||
| 49 | ); | ||
| 50 | |||
| 51 | # Results: | ||
| 52 | my $DeploymentDurationInMinutes = | ||
| 53 | $DeploymentStrategy->DeploymentDurationInMinutes; | ||
| 54 | my $Description = $DeploymentStrategy->Description; | ||
| 55 | my $FinalBakeTimeInMinutes = $DeploymentStrategy->FinalBakeTimeInMinutes; | ||
| 56 | my $GrowthFactor = $DeploymentStrategy->GrowthFactor; | ||
| 57 | my $GrowthType = $DeploymentStrategy->GrowthType; | ||
| 58 | my $Id = $DeploymentStrategy->Id; | ||
| 59 | my $Name = $DeploymentStrategy->Name; | ||
| 60 | my $ReplicateTo = $DeploymentStrategy->ReplicateTo; | ||
| 61 | |||
| 62 | # Returns a L<Paws::AppConfig::DeploymentStrategy> object. | ||
| 63 | |||
| 64 | 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. | ||
| 65 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appconfig/CreateDeploymentStrategy> | ||
| 66 | |||
| 67 | =head1 ATTRIBUTES | ||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> DeploymentDurationInMinutes => Int | ||
| 71 | |||
| 72 | Total amount of time for a deployment to last. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 Description => Str | ||
| 77 | |||
| 78 | A description of the deployment strategy. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 FinalBakeTimeInMinutes => Int | ||
| 83 | |||
| 84 | The amount of time AppConfig monitors for alarms before considering the | ||
| 85 | deployment to be complete and no longer eligible for automatic roll | ||
| 86 | back. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 B<REQUIRED> GrowthFactor => Num | ||
| 91 | |||
| 92 | The percentage of targets to receive a deployed configuration during | ||
| 93 | each interval. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 GrowthType => Str | ||
| 98 | |||
| 99 | The algorithm used to define how percentage grows over time. AWS | ||
| 100 | AppConfig supports the following growth types: | ||
| 101 | |||
| 102 | B<Linear>: For this type, AppConfig processes the deployment by | ||
| 103 | dividing the total number of targets by the value specified for C<Step | ||
| 104 | percentage>. For example, a linear deployment that uses a C<Step | ||
| 105 | percentage> of 10 deploys the configuration to 10 percent of the hosts. | ||
| 106 | After those deployments are complete, the system deploys the | ||
| 107 | configuration to the next 10 percent. This continues until 100% of the | ||
| 108 | targets have successfully received the configuration. | ||
| 109 | |||
| 110 | B<Exponential>: For this type, AppConfig processes the deployment | ||
| 111 | exponentially using the following formula: C<G*(2^N)>. In this formula, | ||
| 112 | C<G> is the growth factor specified by the user and C<N> is the number | ||
| 113 | of steps until the configuration is deployed to all targets. For | ||
| 114 | example, if you specify a growth factor of 2, then the system rolls out | ||
| 115 | the configuration as follows: | ||
| 116 | |||
| 117 | C<2*(2^0)> | ||
| 118 | |||
| 119 | C<2*(2^1)> | ||
| 120 | |||
| 121 | C<2*(2^2)> | ||
| 122 | |||
| 123 | Expressed numerically, the deployment rolls out as follows: 2% of the | ||
| 124 | targets, 4% of the targets, 8% of the targets, and continues until the | ||
| 125 | configuration has been deployed to all targets. | ||
| 126 | |||
| 127 | Valid values are: C<"LINEAR">, C<"EXPONENTIAL"> | ||
| 128 | |||
| 129 | =head2 B<REQUIRED> Name => Str | ||
| 130 | |||
| 131 | A name for the deployment strategy. | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 B<REQUIRED> ReplicateTo => Str | ||
| 136 | |||
| 137 | Save the deployment strategy to a Systems Manager (SSM) document. | ||
| 138 | |||
| 139 | Valid values are: C<"NONE">, C<"SSM_DOCUMENT"> | ||
| 140 | |||
| 141 | =head2 Tags => L<Paws::AppConfig::TagMap> | ||
| 142 | |||
| 143 | Metadata to assign to the deployment strategy. Tags help organize and | ||
| 144 | categorize your AppConfig resources. Each tag consists of a key and an | ||
| 145 | optional value, both of which you define. | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head1 SEE ALSO | ||
| 151 | |||
| 152 | This class forms part of L<Paws>, documenting arguments for method CreateDeploymentStrategy in L<Paws::AppConfig> | ||
| 153 | |||
| 154 | =head1 BUGS and CONTRIBUTIONS | ||
| 155 | |||
| 156 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 157 | |||
| 158 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 159 | |||
| 160 | =cut | ||
| 161 |