« blib/lib/Paws/CodeDeploy/DeploymentGroupInfo.pm
↑ Summary
blib/lib/Paws/CodeDeploy/DeploymentOverview.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CodeDeploy::DeploymentInfo; | ||
| 3 | use Moose; | ||
| 4 | has AdditionalDeploymentStatusInfo => (is => 'ro', isa => 'Str', request_name => 'additionalDeploymentStatusInfo', traits => ['NameInRequest']); | ||
| 5 | has ApplicationName => (is => 'ro', isa => 'Str', request_name => 'applicationName', traits => ['NameInRequest']); | ||
| 6 | has AutoRollbackConfiguration => (is => 'ro', isa => 'Paws::CodeDeploy::AutoRollbackConfiguration', request_name => 'autoRollbackConfiguration', traits => ['NameInRequest']); | ||
| 7 | has BlueGreenDeploymentConfiguration => (is => 'ro', isa => 'Paws::CodeDeploy::BlueGreenDeploymentConfiguration', request_name => 'blueGreenDeploymentConfiguration', traits => ['NameInRequest']); | ||
| 8 | has CompleteTime => (is => 'ro', isa => 'Str', request_name => 'completeTime', traits => ['NameInRequest']); | ||
| 9 | has ComputePlatform => (is => 'ro', isa => 'Str', request_name => 'computePlatform', traits => ['NameInRequest']); | ||
| 10 | has CreateTime => (is => 'ro', isa => 'Str', request_name => 'createTime', traits => ['NameInRequest']); | ||
| 11 | has Creator => (is => 'ro', isa => 'Str', request_name => 'creator', traits => ['NameInRequest']); | ||
| 12 | has DeploymentConfigName => (is => 'ro', isa => 'Str', request_name => 'deploymentConfigName', traits => ['NameInRequest']); | ||
| 13 | has DeploymentGroupName => (is => 'ro', isa => 'Str', request_name => 'deploymentGroupName', traits => ['NameInRequest']); | ||
| 14 | has DeploymentId => (is => 'ro', isa => 'Str', request_name => 'deploymentId', traits => ['NameInRequest']); | ||
| 15 | has DeploymentOverview => (is => 'ro', isa => 'Paws::CodeDeploy::DeploymentOverview', request_name => 'deploymentOverview', traits => ['NameInRequest']); | ||
| 16 | has DeploymentStatusMessages => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'deploymentStatusMessages', traits => ['NameInRequest']); | ||
| 17 | has DeploymentStyle => (is => 'ro', isa => 'Paws::CodeDeploy::DeploymentStyle', request_name => 'deploymentStyle', traits => ['NameInRequest']); | ||
| 18 | has Description => (is => 'ro', isa => 'Str', request_name => 'description', traits => ['NameInRequest']); | ||
| 19 | has ErrorInformation => (is => 'ro', isa => 'Paws::CodeDeploy::ErrorInformation', request_name => 'errorInformation', traits => ['NameInRequest']); | ||
| 20 | has ExternalId => (is => 'ro', isa => 'Str', request_name => 'externalId', traits => ['NameInRequest']); | ||
| 21 | has FileExistsBehavior => (is => 'ro', isa => 'Str', request_name => 'fileExistsBehavior', traits => ['NameInRequest']); | ||
| 22 | has IgnoreApplicationStopFailures => (is => 'ro', isa => 'Bool', request_name => 'ignoreApplicationStopFailures', traits => ['NameInRequest']); | ||
| 23 | has InstanceTerminationWaitTimeStarted => (is => 'ro', isa => 'Bool', request_name => 'instanceTerminationWaitTimeStarted', traits => ['NameInRequest']); | ||
| 24 | has LoadBalancerInfo => (is => 'ro', isa => 'Paws::CodeDeploy::LoadBalancerInfo', request_name => 'loadBalancerInfo', traits => ['NameInRequest']); | ||
| 25 | has PreviousRevision => (is => 'ro', isa => 'Paws::CodeDeploy::RevisionLocation', request_name => 'previousRevision', traits => ['NameInRequest']); | ||
| 26 | has RelatedDeployments => (is => 'ro', isa => 'Paws::CodeDeploy::RelatedDeployments', request_name => 'relatedDeployments', traits => ['NameInRequest']); | ||
| 27 | has Revision => (is => 'ro', isa => 'Paws::CodeDeploy::RevisionLocation', request_name => 'revision', traits => ['NameInRequest']); | ||
| 28 | has RollbackInfo => (is => 'ro', isa => 'Paws::CodeDeploy::RollbackInfo', request_name => 'rollbackInfo', traits => ['NameInRequest']); | ||
| 29 | has StartTime => (is => 'ro', isa => 'Str', request_name => 'startTime', traits => ['NameInRequest']); | ||
| 30 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 31 | has TargetInstances => (is => 'ro', isa => 'Paws::CodeDeploy::TargetInstances', request_name => 'targetInstances', traits => ['NameInRequest']); | ||
| 32 | has UpdateOutdatedInstancesOnly => (is => 'ro', isa => 'Bool', request_name => 'updateOutdatedInstancesOnly', traits => ['NameInRequest']); | ||
| 33 | |||
| 34 | 1; | ||
| 35 | |||
| 36 | ### main pod documentation begin ### | ||
| 37 | |||
| 38 | =head1 NAME | ||
| 39 | |||
| 40 | Paws::CodeDeploy::DeploymentInfo | ||
| 41 | |||
| 42 | =head1 USAGE | ||
| 43 | |||
| 44 | This class represents one of two things: | ||
| 45 | |||
| 46 | =head3 Arguments in a call to a service | ||
| 47 | |||
| 48 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 49 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 50 | |||
| 51 | As an example, if Att1 is expected to be a Paws::CodeDeploy::DeploymentInfo object: | ||
| 52 | |||
| 53 | $service_obj->Method(Att1 => { AdditionalDeploymentStatusInfo => $value, ..., UpdateOutdatedInstancesOnly => $value }); | ||
| 54 | |||
| 55 | =head3 Results returned from an API call | ||
| 56 | |||
| 57 | Use accessors for each attribute. If Att1 is expected to be an Paws::CodeDeploy::DeploymentInfo object: | ||
| 58 | |||
| 59 | $result = $service_obj->Method(...); | ||
| 60 | $result->Att1->AdditionalDeploymentStatusInfo | ||
| 61 | |||
| 62 | =head1 DESCRIPTION | ||
| 63 | |||
| 64 | Information about a deployment. | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 AdditionalDeploymentStatusInfo => Str | ||
| 70 | |||
| 71 | Provides information about the results of a deployment, such as whether | ||
| 72 | instances in the original environment in a blue/green deployment were | ||
| 73 | not terminated. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 ApplicationName => Str | ||
| 77 | |||
| 78 | The application name. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 AutoRollbackConfiguration => L<Paws::CodeDeploy::AutoRollbackConfiguration> | ||
| 82 | |||
| 83 | Information about the automatic rollback configuration associated with | ||
| 84 | the deployment. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 BlueGreenDeploymentConfiguration => L<Paws::CodeDeploy::BlueGreenDeploymentConfiguration> | ||
| 88 | |||
| 89 | Information about blue/green deployment options for this deployment. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 CompleteTime => Str | ||
| 93 | |||
| 94 | A timestamp that indicates when the deployment was complete. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 ComputePlatform => Str | ||
| 98 | |||
| 99 | The destination platform type for the deployment (C<Lambda>, C<Server>, | ||
| 100 | or C<ECS>). | ||
| 101 | |||
| 102 | |||
| 103 | =head2 CreateTime => Str | ||
| 104 | |||
| 105 | A timestamp that indicates when the deployment was created. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 Creator => Str | ||
| 109 | |||
| 110 | The means by which the deployment was created: | ||
| 111 | |||
| 112 | =over | ||
| 113 | |||
| 114 | =item * | ||
| 115 | |||
| 116 | C<user>: A user created the deployment. | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | C<autoscaling>: Amazon EC2 Auto Scaling created the deployment. | ||
| 121 | |||
| 122 | =item * | ||
| 123 | |||
| 124 | C<codeDeployRollback>: A rollback process created the deployment. | ||
| 125 | |||
| 126 | =item * | ||
| 127 | |||
| 128 | C<CodeDeployAutoUpdate>: An auto-update process created the deployment | ||
| 129 | when it detected outdated EC2 instances. | ||
| 130 | |||
| 131 | =back | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 DeploymentConfigName => Str | ||
| 136 | |||
| 137 | The deployment configuration name. | ||
| 138 | |||
| 139 | |||
| 140 | =head2 DeploymentGroupName => Str | ||
| 141 | |||
| 142 | The deployment group name. | ||
| 143 | |||
| 144 | |||
| 145 | =head2 DeploymentId => Str | ||
| 146 | |||
| 147 | The unique ID of a deployment. | ||
| 148 | |||
| 149 | |||
| 150 | =head2 DeploymentOverview => L<Paws::CodeDeploy::DeploymentOverview> | ||
| 151 | |||
| 152 | A summary of the deployment status of the instances in the deployment. | ||
| 153 | |||
| 154 | |||
| 155 | =head2 DeploymentStatusMessages => ArrayRef[Str|Undef] | ||
| 156 | |||
| 157 | Messages that contain information about the status of a deployment. | ||
| 158 | |||
| 159 | |||
| 160 | =head2 DeploymentStyle => L<Paws::CodeDeploy::DeploymentStyle> | ||
| 161 | |||
| 162 | Information about the type of deployment, either in-place or | ||
| 163 | blue/green, you want to run and whether to route deployment traffic | ||
| 164 | behind a load balancer. | ||
| 165 | |||
| 166 | |||
| 167 | =head2 Description => Str | ||
| 168 | |||
| 169 | A comment about the deployment. | ||
| 170 | |||
| 171 | |||
| 172 | =head2 ErrorInformation => L<Paws::CodeDeploy::ErrorInformation> | ||
| 173 | |||
| 174 | Information about any error associated with this deployment. | ||
| 175 | |||
| 176 | |||
| 177 | =head2 ExternalId => Str | ||
| 178 | |||
| 179 | The unique ID for an external resource (for example, a CloudFormation | ||
| 180 | stack ID) that is linked to this deployment. | ||
| 181 | |||
| 182 | |||
| 183 | =head2 FileExistsBehavior => Str | ||
| 184 | |||
| 185 | Information about how AWS CodeDeploy handles files that already exist | ||
| 186 | in a deployment target location but weren't part of the previous | ||
| 187 | successful deployment. | ||
| 188 | |||
| 189 | =over | ||
| 190 | |||
| 191 | =item * | ||
| 192 | |||
| 193 | C<DISALLOW>: The deployment fails. This is also the default behavior if | ||
| 194 | no option is specified. | ||
| 195 | |||
| 196 | =item * | ||
| 197 | |||
| 198 | C<OVERWRITE>: The version of the file from the application revision | ||
| 199 | currently being deployed replaces the version already on the instance. | ||
| 200 | |||
| 201 | =item * | ||
| 202 | |||
| 203 | C<RETAIN>: The version of the file already on the instance is kept and | ||
| 204 | used as part of the new deployment. | ||
| 205 | |||
| 206 | =back | ||
| 207 | |||
| 208 | |||
| 209 | |||
| 210 | =head2 IgnoreApplicationStopFailures => Bool | ||
| 211 | |||
| 212 | If true, then if an C<ApplicationStop>, C<BeforeBlockTraffic>, or | ||
| 213 | C<AfterBlockTraffic> deployment lifecycle event to an instance fails, | ||
| 214 | then the deployment continues to the next deployment lifecycle event. | ||
| 215 | For example, if C<ApplicationStop> fails, the deployment continues with | ||
| 216 | DownloadBundle. If C<BeforeBlockTraffic> fails, the deployment | ||
| 217 | continues with C<BlockTraffic>. If C<AfterBlockTraffic> fails, the | ||
| 218 | deployment continues with C<ApplicationStop>. | ||
| 219 | |||
| 220 | If false or not specified, then if a lifecycle event fails during a | ||
| 221 | deployment to an instance, that deployment fails. If deployment to that | ||
| 222 | instance is part of an overall deployment and the number of healthy | ||
| 223 | hosts is not less than the minimum number of healthy hosts, then a | ||
| 224 | deployment to the next instance is attempted. | ||
| 225 | |||
| 226 | During a deployment, the AWS CodeDeploy agent runs the scripts | ||
| 227 | specified for C<ApplicationStop>, C<BeforeBlockTraffic>, and | ||
| 228 | C<AfterBlockTraffic> in the AppSpec file from the previous successful | ||
| 229 | deployment. (All other scripts are run from the AppSpec file in the | ||
| 230 | current deployment.) If one of these scripts contains an error and does | ||
| 231 | not run successfully, the deployment can fail. | ||
| 232 | |||
| 233 | If the cause of the failure is a script from the last successful | ||
| 234 | deployment that will never run successfully, create a new deployment | ||
| 235 | and use C<ignoreApplicationStopFailures> to specify that the | ||
| 236 | C<ApplicationStop>, C<BeforeBlockTraffic>, and C<AfterBlockTraffic> | ||
| 237 | failures should be ignored. | ||
| 238 | |||
| 239 | |||
| 240 | =head2 InstanceTerminationWaitTimeStarted => Bool | ||
| 241 | |||
| 242 | Indicates whether the wait period set for the termination of instances | ||
| 243 | in the original environment has started. Status is 'false' if the | ||
| 244 | KEEP_ALIVE option is specified. Otherwise, 'true' as soon as the | ||
| 245 | termination wait period starts. | ||
| 246 | |||
| 247 | |||
| 248 | =head2 LoadBalancerInfo => L<Paws::CodeDeploy::LoadBalancerInfo> | ||
| 249 | |||
| 250 | Information about the load balancer used in the deployment. | ||
| 251 | |||
| 252 | |||
| 253 | =head2 PreviousRevision => L<Paws::CodeDeploy::RevisionLocation> | ||
| 254 | |||
| 255 | Information about the application revision that was deployed to the | ||
| 256 | deployment group before the most recent successful deployment. | ||
| 257 | |||
| 258 | |||
| 259 | =head2 RelatedDeployments => L<Paws::CodeDeploy::RelatedDeployments> | ||
| 260 | |||
| 261 | |||
| 262 | |||
| 263 | |||
| 264 | =head2 Revision => L<Paws::CodeDeploy::RevisionLocation> | ||
| 265 | |||
| 266 | Information about the location of stored application artifacts and the | ||
| 267 | service from which to retrieve them. | ||
| 268 | |||
| 269 | |||
| 270 | =head2 RollbackInfo => L<Paws::CodeDeploy::RollbackInfo> | ||
| 271 | |||
| 272 | Information about a deployment rollback. | ||
| 273 | |||
| 274 | |||
| 275 | =head2 StartTime => Str | ||
| 276 | |||
| 277 | A timestamp that indicates when the deployment was deployed to the | ||
| 278 | deployment group. | ||
| 279 | |||
| 280 | In some cases, the reported value of the start time might be later than | ||
| 281 | the complete time. This is due to differences in the clock settings of | ||
| 282 | backend servers that participate in the deployment process. | ||
| 283 | |||
| 284 | |||
| 285 | =head2 Status => Str | ||
| 286 | |||
| 287 | The current state of the deployment as a whole. | ||
| 288 | |||
| 289 | |||
| 290 | =head2 TargetInstances => L<Paws::CodeDeploy::TargetInstances> | ||
| 291 | |||
| 292 | Information about the instances that belong to the replacement | ||
| 293 | environment in a blue/green deployment. | ||
| 294 | |||
| 295 | |||
| 296 | =head2 UpdateOutdatedInstancesOnly => Bool | ||
| 297 | |||
| 298 | Indicates whether only instances that are not running the latest | ||
| 299 | application revision are to be deployed to. | ||
| 300 | |||
| 301 | |||
| 302 | |||
| 303 | =head1 SEE ALSO | ||
| 304 | |||
| 305 | This class forms part of L<Paws>, describing an object used in L<Paws::CodeDeploy> | ||
| 306 | |||
| 307 | =head1 BUGS and CONTRIBUTIONS | ||
| 308 | |||
| 309 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 310 | |||
| 311 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 312 | |||
| 313 | =cut | ||
| 314 |