« blib/lib/Paws/CodeDeploy/CreateDeploymentConfigOutput.pm
↑ Summary
blib/lib/Paws/CodeDeploy/CreateDeploymentGroupOutput.pm »
| 1 | |||
| 2 | package Paws::CodeDeploy::CreateDeploymentGroup; | ||
| 3 | use Moose; | ||
| 4 | has AlarmConfiguration => (is => 'ro', isa => 'Paws::CodeDeploy::AlarmConfiguration', traits => ['NameInRequest'], request_name => 'alarmConfiguration' ); | ||
| 5 | has ApplicationName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'applicationName' , required => 1); | ||
| 6 | has AutoRollbackConfiguration => (is => 'ro', isa => 'Paws::CodeDeploy::AutoRollbackConfiguration', traits => ['NameInRequest'], request_name => 'autoRollbackConfiguration' ); | ||
| 7 | has AutoScalingGroups => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'autoScalingGroups' ); | ||
| 8 | has BlueGreenDeploymentConfiguration => (is => 'ro', isa => 'Paws::CodeDeploy::BlueGreenDeploymentConfiguration', traits => ['NameInRequest'], request_name => 'blueGreenDeploymentConfiguration' ); | ||
| 9 | has DeploymentConfigName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'deploymentConfigName' ); | ||
| 10 | has DeploymentGroupName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'deploymentGroupName' , required => 1); | ||
| 11 | has DeploymentStyle => (is => 'ro', isa => 'Paws::CodeDeploy::DeploymentStyle', traits => ['NameInRequest'], request_name => 'deploymentStyle' ); | ||
| 12 | has Ec2TagFilters => (is => 'ro', isa => 'ArrayRef[Paws::CodeDeploy::EC2TagFilter]', traits => ['NameInRequest'], request_name => 'ec2TagFilters' ); | ||
| 13 | has Ec2TagSet => (is => 'ro', isa => 'Paws::CodeDeploy::EC2TagSet', traits => ['NameInRequest'], request_name => 'ec2TagSet' ); | ||
| 14 | has EcsServices => (is => 'ro', isa => 'ArrayRef[Paws::CodeDeploy::ECSService]', traits => ['NameInRequest'], request_name => 'ecsServices' ); | ||
| 15 | has LoadBalancerInfo => (is => 'ro', isa => 'Paws::CodeDeploy::LoadBalancerInfo', traits => ['NameInRequest'], request_name => 'loadBalancerInfo' ); | ||
| 16 | has OnPremisesInstanceTagFilters => (is => 'ro', isa => 'ArrayRef[Paws::CodeDeploy::TagFilter]', traits => ['NameInRequest'], request_name => 'onPremisesInstanceTagFilters' ); | ||
| 17 | has OnPremisesTagSet => (is => 'ro', isa => 'Paws::CodeDeploy::OnPremisesTagSet', traits => ['NameInRequest'], request_name => 'onPremisesTagSet' ); | ||
| 18 | has OutdatedInstancesStrategy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'outdatedInstancesStrategy' ); | ||
| 19 | has ServiceRoleArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'serviceRoleArn' , required => 1); | ||
| 20 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::CodeDeploy::Tag]', traits => ['NameInRequest'], request_name => 'tags' ); | ||
| 21 | has TriggerConfigurations => (is => 'ro', isa => 'ArrayRef[Paws::CodeDeploy::TriggerConfig]', traits => ['NameInRequest'], request_name => 'triggerConfigurations' ); | ||
| 22 | |||
| 23 | use MooseX::ClassAttribute; | ||
| 24 | |||
| 25 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDeploymentGroup'); | ||
| 26 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeDeploy::CreateDeploymentGroupOutput'); | ||
| 27 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 28 | 1; | ||
| 29 | |||
| 30 | ### main pod documentation begin ### | ||
| 31 | |||
| 32 | =head1 NAME | ||
| 33 | |||
| 34 | Paws::CodeDeploy::CreateDeploymentGroup - Arguments for method CreateDeploymentGroup on L<Paws::CodeDeploy> | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | This class represents the parameters used for calling the method CreateDeploymentGroup on the | ||
| 39 | L<AWS CodeDeploy|Paws::CodeDeploy> service. Use the attributes of this class | ||
| 40 | as arguments to method CreateDeploymentGroup. | ||
| 41 | |||
| 42 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDeploymentGroup. | ||
| 43 | |||
| 44 | =head1 SYNOPSIS | ||
| 45 | |||
| 46 | my $codedeploy = Paws->service('CodeDeploy'); | ||
| 47 | my $CreateDeploymentGroupOutput = $codedeploy->CreateDeploymentGroup( | ||
| 48 | ApplicationName => 'MyApplicationName', | ||
| 49 | DeploymentGroupName => 'MyDeploymentGroupName', | ||
| 50 | ServiceRoleArn => 'MyRole', | ||
| 51 | AlarmConfiguration => { | ||
| 52 | Alarms => [ | ||
| 53 | { | ||
| 54 | Name => 'MyAlarmName', # OPTIONAL | ||
| 55 | }, | ||
| 56 | ... | ||
| 57 | ], # OPTIONAL | ||
| 58 | Enabled => 1, # OPTIONAL | ||
| 59 | IgnorePollAlarmFailure => 1, # OPTIONAL | ||
| 60 | }, # OPTIONAL | ||
| 61 | AutoRollbackConfiguration => { | ||
| 62 | Enabled => 1, # OPTIONAL | ||
| 63 | Events => [ | ||
| 64 | 'DEPLOYMENT_FAILURE', | ||
| 65 | ... # values: DEPLOYMENT_FAILURE, DEPLOYMENT_STOP_ON_ALARM, DEPLOYMENT_STOP_ON_REQUEST | ||
| 66 | ], # OPTIONAL | ||
| 67 | }, # OPTIONAL | ||
| 68 | AutoScalingGroups => [ 'MyAutoScalingGroupName', ... ], # OPTIONAL | ||
| 69 | BlueGreenDeploymentConfiguration => { | ||
| 70 | DeploymentReadyOption => { | ||
| 71 | ActionOnTimeout => 'CONTINUE_DEPLOYMENT' | ||
| 72 | , # values: CONTINUE_DEPLOYMENT, STOP_DEPLOYMENT; OPTIONAL | ||
| 73 | WaitTimeInMinutes => 1, # OPTIONAL | ||
| 74 | }, # OPTIONAL | ||
| 75 | GreenFleetProvisioningOption => { | ||
| 76 | Action => 'DISCOVER_EXISTING' | ||
| 77 | , # values: DISCOVER_EXISTING, COPY_AUTO_SCALING_GROUP; OPTIONAL | ||
| 78 | }, # OPTIONAL | ||
| 79 | TerminateBlueInstancesOnDeploymentSuccess => { | ||
| 80 | Action => 'TERMINATE', # values: TERMINATE, KEEP_ALIVE; OPTIONAL | ||
| 81 | TerminationWaitTimeInMinutes => 1, # OPTIONAL | ||
| 82 | }, # OPTIONAL | ||
| 83 | }, # OPTIONAL | ||
| 84 | DeploymentConfigName => 'MyDeploymentConfigName', # OPTIONAL | ||
| 85 | DeploymentStyle => { | ||
| 86 | DeploymentOption => 'WITH_TRAFFIC_CONTROL' | ||
| 87 | , # values: WITH_TRAFFIC_CONTROL, WITHOUT_TRAFFIC_CONTROL; OPTIONAL | ||
| 88 | DeploymentType => 'IN_PLACE', # values: IN_PLACE, BLUE_GREEN; OPTIONAL | ||
| 89 | }, # OPTIONAL | ||
| 90 | Ec2TagFilters => [ | ||
| 91 | { | ||
| 92 | Key => 'MyKey', # OPTIONAL | ||
| 93 | Type => | ||
| 94 | 'KEY_ONLY', # values: KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE; OPTIONAL | ||
| 95 | Value => 'MyValue', # OPTIONAL | ||
| 96 | }, | ||
| 97 | ... | ||
| 98 | ], # OPTIONAL | ||
| 99 | Ec2TagSet => { | ||
| 100 | Ec2TagSetList => [ | ||
| 101 | [ | ||
| 102 | { | ||
| 103 | Key => 'MyKey', # OPTIONAL | ||
| 104 | Type => 'KEY_ONLY' | ||
| 105 | , # values: KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE; OPTIONAL | ||
| 106 | Value => 'MyValue', # OPTIONAL | ||
| 107 | }, | ||
| 108 | ... | ||
| 109 | ], | ||
| 110 | ... | ||
| 111 | ], # OPTIONAL | ||
| 112 | }, # OPTIONAL | ||
| 113 | EcsServices => [ | ||
| 114 | { | ||
| 115 | ClusterName => 'MyECSClusterName', # OPTIONAL | ||
| 116 | ServiceName => 'MyECSServiceName', # OPTIONAL | ||
| 117 | }, | ||
| 118 | ... | ||
| 119 | ], # OPTIONAL | ||
| 120 | LoadBalancerInfo => { | ||
| 121 | ElbInfoList => [ | ||
| 122 | { | ||
| 123 | Name => 'MyELBName', # OPTIONAL | ||
| 124 | }, | ||
| 125 | ... | ||
| 126 | ], # OPTIONAL | ||
| 127 | TargetGroupInfoList => [ | ||
| 128 | { | ||
| 129 | Name => 'MyTargetGroupName', # OPTIONAL | ||
| 130 | }, | ||
| 131 | ... | ||
| 132 | ], # OPTIONAL | ||
| 133 | TargetGroupPairInfoList => [ | ||
| 134 | { | ||
| 135 | ProdTrafficRoute => { | ||
| 136 | ListenerArns => [ 'MyListenerArn', ... ], # OPTIONAL | ||
| 137 | }, # OPTIONAL | ||
| 138 | TargetGroups => [ | ||
| 139 | { | ||
| 140 | Name => 'MyTargetGroupName', # OPTIONAL | ||
| 141 | }, | ||
| 142 | ... | ||
| 143 | ], # OPTIONAL | ||
| 144 | TestTrafficRoute => { | ||
| 145 | ListenerArns => [ 'MyListenerArn', ... ], # OPTIONAL | ||
| 146 | }, # OPTIONAL | ||
| 147 | }, | ||
| 148 | ... | ||
| 149 | ], # OPTIONAL | ||
| 150 | }, # OPTIONAL | ||
| 151 | OnPremisesInstanceTagFilters => [ | ||
| 152 | { | ||
| 153 | Key => 'MyKey', # OPTIONAL | ||
| 154 | Type => | ||
| 155 | 'KEY_ONLY', # values: KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE; OPTIONAL | ||
| 156 | Value => 'MyValue', # OPTIONAL | ||
| 157 | }, | ||
| 158 | ... | ||
| 159 | ], # OPTIONAL | ||
| 160 | OnPremisesTagSet => { | ||
| 161 | OnPremisesTagSetList => [ | ||
| 162 | [ | ||
| 163 | { | ||
| 164 | Key => 'MyKey', # OPTIONAL | ||
| 165 | Type => 'KEY_ONLY' | ||
| 166 | , # values: KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE; OPTIONAL | ||
| 167 | Value => 'MyValue', # OPTIONAL | ||
| 168 | }, | ||
| 169 | ... | ||
| 170 | ], | ||
| 171 | ... | ||
| 172 | ], # OPTIONAL | ||
| 173 | }, # OPTIONAL | ||
| 174 | OutdatedInstancesStrategy => 'UPDATE', # OPTIONAL | ||
| 175 | Tags => [ | ||
| 176 | { | ||
| 177 | Key => 'MyKey', # OPTIONAL | ||
| 178 | Value => 'MyValue', # OPTIONAL | ||
| 179 | }, | ||
| 180 | ... | ||
| 181 | ], # OPTIONAL | ||
| 182 | TriggerConfigurations => [ | ||
| 183 | { | ||
| 184 | TriggerEvents => [ | ||
| 185 | 'DeploymentStart', | ||
| 186 | ... # values: DeploymentStart, DeploymentSuccess, DeploymentFailure, DeploymentStop, DeploymentRollback, DeploymentReady, InstanceStart, InstanceSuccess, InstanceFailure, InstanceReady | ||
| 187 | ], # OPTIONAL | ||
| 188 | TriggerName => 'MyTriggerName', # OPTIONAL | ||
| 189 | TriggerTargetArn => 'MyTriggerTargetArn', # OPTIONAL | ||
| 190 | }, | ||
| 191 | ... | ||
| 192 | ], # OPTIONAL | ||
| 193 | ); | ||
| 194 | |||
| 195 | # Results: | ||
| 196 | my $DeploymentGroupId = $CreateDeploymentGroupOutput->DeploymentGroupId; | ||
| 197 | |||
| 198 | # Returns a L<Paws::CodeDeploy::CreateDeploymentGroupOutput> object. | ||
| 199 | |||
| 200 | 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. | ||
| 201 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codedeploy/CreateDeploymentGroup> | ||
| 202 | |||
| 203 | =head1 ATTRIBUTES | ||
| 204 | |||
| 205 | |||
| 206 | =head2 AlarmConfiguration => L<Paws::CodeDeploy::AlarmConfiguration> | ||
| 207 | |||
| 208 | Information to add about Amazon CloudWatch alarms when the deployment | ||
| 209 | group is created. | ||
| 210 | |||
| 211 | |||
| 212 | |||
| 213 | =head2 B<REQUIRED> ApplicationName => Str | ||
| 214 | |||
| 215 | The name of an AWS CodeDeploy application associated with the IAM user | ||
| 216 | or AWS account. | ||
| 217 | |||
| 218 | |||
| 219 | |||
| 220 | =head2 AutoRollbackConfiguration => L<Paws::CodeDeploy::AutoRollbackConfiguration> | ||
| 221 | |||
| 222 | Configuration information for an automatic rollback that is added when | ||
| 223 | a deployment group is created. | ||
| 224 | |||
| 225 | |||
| 226 | |||
| 227 | =head2 AutoScalingGroups => ArrayRef[Str|Undef] | ||
| 228 | |||
| 229 | A list of associated Amazon EC2 Auto Scaling groups. | ||
| 230 | |||
| 231 | |||
| 232 | |||
| 233 | =head2 BlueGreenDeploymentConfiguration => L<Paws::CodeDeploy::BlueGreenDeploymentConfiguration> | ||
| 234 | |||
| 235 | Information about blue/green deployment options for a deployment group. | ||
| 236 | |||
| 237 | |||
| 238 | |||
| 239 | =head2 DeploymentConfigName => Str | ||
| 240 | |||
| 241 | If specified, the deployment configuration name can be either one of | ||
| 242 | the predefined configurations provided with AWS CodeDeploy or a custom | ||
| 243 | deployment configuration that you create by calling the create | ||
| 244 | deployment configuration operation. | ||
| 245 | |||
| 246 | C<CodeDeployDefault.OneAtATime> is the default deployment | ||
| 247 | configuration. It is used if a configuration isn't specified for the | ||
| 248 | deployment or deployment group. | ||
| 249 | |||
| 250 | For more information about the predefined deployment configurations in | ||
| 251 | AWS CodeDeploy, see Working with Deployment Configurations in | ||
| 252 | CodeDeploy | ||
| 253 | (https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html) | ||
| 254 | in the I<AWS CodeDeploy User Guide>. | ||
| 255 | |||
| 256 | |||
| 257 | |||
| 258 | =head2 B<REQUIRED> DeploymentGroupName => Str | ||
| 259 | |||
| 260 | The name of a new deployment group for the specified application. | ||
| 261 | |||
| 262 | |||
| 263 | |||
| 264 | =head2 DeploymentStyle => L<Paws::CodeDeploy::DeploymentStyle> | ||
| 265 | |||
| 266 | Information about the type of deployment, in-place or blue/green, that | ||
| 267 | you want to run and whether to route deployment traffic behind a load | ||
| 268 | balancer. | ||
| 269 | |||
| 270 | |||
| 271 | |||
| 272 | =head2 Ec2TagFilters => ArrayRef[L<Paws::CodeDeploy::EC2TagFilter>] | ||
| 273 | |||
| 274 | The Amazon EC2 tags on which to filter. The deployment group includes | ||
| 275 | EC2 instances with any of the specified tags. Cannot be used in the | ||
| 276 | same call as ec2TagSet. | ||
| 277 | |||
| 278 | |||
| 279 | |||
| 280 | =head2 Ec2TagSet => L<Paws::CodeDeploy::EC2TagSet> | ||
| 281 | |||
| 282 | Information about groups of tags applied to EC2 instances. The | ||
| 283 | deployment group includes only EC2 instances identified by all the tag | ||
| 284 | groups. Cannot be used in the same call as C<ec2TagFilters>. | ||
| 285 | |||
| 286 | |||
| 287 | |||
| 288 | =head2 EcsServices => ArrayRef[L<Paws::CodeDeploy::ECSService>] | ||
| 289 | |||
| 290 | The target Amazon ECS services in the deployment group. This applies | ||
| 291 | only to deployment groups that use the Amazon ECS compute platform. A | ||
| 292 | target Amazon ECS service is specified as an Amazon ECS cluster and | ||
| 293 | service name pair using the format | ||
| 294 | C<E<lt>clusternameE<gt>:E<lt>servicenameE<gt>>. | ||
| 295 | |||
| 296 | |||
| 297 | |||
| 298 | =head2 LoadBalancerInfo => L<Paws::CodeDeploy::LoadBalancerInfo> | ||
| 299 | |||
| 300 | Information about the load balancer used in a deployment. | ||
| 301 | |||
| 302 | |||
| 303 | |||
| 304 | =head2 OnPremisesInstanceTagFilters => ArrayRef[L<Paws::CodeDeploy::TagFilter>] | ||
| 305 | |||
| 306 | The on-premises instance tags on which to filter. The deployment group | ||
| 307 | includes on-premises instances with any of the specified tags. Cannot | ||
| 308 | be used in the same call as C<OnPremisesTagSet>. | ||
| 309 | |||
| 310 | |||
| 311 | |||
| 312 | =head2 OnPremisesTagSet => L<Paws::CodeDeploy::OnPremisesTagSet> | ||
| 313 | |||
| 314 | Information about groups of tags applied to on-premises instances. The | ||
| 315 | deployment group includes only on-premises instances identified by all | ||
| 316 | of the tag groups. Cannot be used in the same call as | ||
| 317 | C<onPremisesInstanceTagFilters>. | ||
| 318 | |||
| 319 | |||
| 320 | |||
| 321 | =head2 OutdatedInstancesStrategy => Str | ||
| 322 | |||
| 323 | Indicates what happens when new EC2 instances are launched | ||
| 324 | mid-deployment and do not receive the deployed application revision. | ||
| 325 | |||
| 326 | If this option is set to C<UPDATE> or is unspecified, CodeDeploy | ||
| 327 | initiates one or more 'auto-update outdated instances' deployments to | ||
| 328 | apply the deployed application revision to the new EC2 instances. | ||
| 329 | |||
| 330 | If this option is set to C<IGNORE>, CodeDeploy does not initiate a | ||
| 331 | deployment to update the new EC2 instances. This may result in | ||
| 332 | instances having different revisions. | ||
| 333 | |||
| 334 | Valid values are: C<"UPDATE">, C<"IGNORE"> | ||
| 335 | |||
| 336 | =head2 B<REQUIRED> ServiceRoleArn => Str | ||
| 337 | |||
| 338 | A service role Amazon Resource Name (ARN) that allows AWS CodeDeploy to | ||
| 339 | act on the user's behalf when interacting with AWS services. | ||
| 340 | |||
| 341 | |||
| 342 | |||
| 343 | =head2 Tags => ArrayRef[L<Paws::CodeDeploy::Tag>] | ||
| 344 | |||
| 345 | The metadata that you apply to CodeDeploy deployment groups to help you | ||
| 346 | organize and categorize them. Each tag consists of a key and an | ||
| 347 | optional value, both of which you define. | ||
| 348 | |||
| 349 | |||
| 350 | |||
| 351 | =head2 TriggerConfigurations => ArrayRef[L<Paws::CodeDeploy::TriggerConfig>] | ||
| 352 | |||
| 353 | Information about triggers to create when the deployment group is | ||
| 354 | created. For examples, see Create a Trigger for an AWS CodeDeploy Event | ||
| 355 | (https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-sns.html) | ||
| 356 | in the I<AWS CodeDeploy User Guide>. | ||
| 357 | |||
| 358 | |||
| 359 | |||
| 360 | |||
| 361 | =head1 SEE ALSO | ||
| 362 | |||
| 363 | This class forms part of L<Paws>, documenting arguments for method CreateDeploymentGroup in L<Paws::CodeDeploy> | ||
| 364 | |||
| 365 | =head1 BUGS and CONTRIBUTIONS | ||
| 366 | |||
| 367 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 368 | |||
| 369 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 370 | |||
| 371 | =cut | ||
| 372 |