Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Amazonka.CodeDeploy.UpdateDeploymentGroup
Description
Changes information about a deployment group.
Synopsis
- data UpdateDeploymentGroup = UpdateDeploymentGroup' {
- alarmConfiguration :: Maybe AlarmConfiguration
- autoRollbackConfiguration :: Maybe AutoRollbackConfiguration
- autoScalingGroups :: Maybe [Text]
- blueGreenDeploymentConfiguration :: Maybe BlueGreenDeploymentConfiguration
- deploymentConfigName :: Maybe Text
- deploymentStyle :: Maybe DeploymentStyle
- ec2TagFilters :: Maybe [EC2TagFilter]
- ec2TagSet :: Maybe EC2TagSet
- ecsServices :: Maybe [ECSService]
- loadBalancerInfo :: Maybe LoadBalancerInfo
- newDeploymentGroupName' :: Maybe Text
- onPremisesInstanceTagFilters :: Maybe [TagFilter]
- onPremisesTagSet :: Maybe OnPremisesTagSet
- outdatedInstancesStrategy :: Maybe OutdatedInstancesStrategy
- serviceRoleArn :: Maybe Text
- triggerConfigurations :: Maybe [TriggerConfig]
- applicationName :: Text
- currentDeploymentGroupName :: Text
- newUpdateDeploymentGroup :: Text -> Text -> UpdateDeploymentGroup
- updateDeploymentGroup_alarmConfiguration :: Lens' UpdateDeploymentGroup (Maybe AlarmConfiguration)
- updateDeploymentGroup_autoRollbackConfiguration :: Lens' UpdateDeploymentGroup (Maybe AutoRollbackConfiguration)
- updateDeploymentGroup_autoScalingGroups :: Lens' UpdateDeploymentGroup (Maybe [Text])
- updateDeploymentGroup_blueGreenDeploymentConfiguration :: Lens' UpdateDeploymentGroup (Maybe BlueGreenDeploymentConfiguration)
- updateDeploymentGroup_deploymentConfigName :: Lens' UpdateDeploymentGroup (Maybe Text)
- updateDeploymentGroup_deploymentStyle :: Lens' UpdateDeploymentGroup (Maybe DeploymentStyle)
- updateDeploymentGroup_ec2TagFilters :: Lens' UpdateDeploymentGroup (Maybe [EC2TagFilter])
- updateDeploymentGroup_ec2TagSet :: Lens' UpdateDeploymentGroup (Maybe EC2TagSet)
- updateDeploymentGroup_ecsServices :: Lens' UpdateDeploymentGroup (Maybe [ECSService])
- updateDeploymentGroup_loadBalancerInfo :: Lens' UpdateDeploymentGroup (Maybe LoadBalancerInfo)
- updateDeploymentGroup_newDeploymentGroupName :: Lens' UpdateDeploymentGroup (Maybe Text)
- updateDeploymentGroup_onPremisesInstanceTagFilters :: Lens' UpdateDeploymentGroup (Maybe [TagFilter])
- updateDeploymentGroup_onPremisesTagSet :: Lens' UpdateDeploymentGroup (Maybe OnPremisesTagSet)
- updateDeploymentGroup_outdatedInstancesStrategy :: Lens' UpdateDeploymentGroup (Maybe OutdatedInstancesStrategy)
- updateDeploymentGroup_serviceRoleArn :: Lens' UpdateDeploymentGroup (Maybe Text)
- updateDeploymentGroup_triggerConfigurations :: Lens' UpdateDeploymentGroup (Maybe [TriggerConfig])
- updateDeploymentGroup_applicationName :: Lens' UpdateDeploymentGroup Text
- updateDeploymentGroup_currentDeploymentGroupName :: Lens' UpdateDeploymentGroup Text
- data UpdateDeploymentGroupResponse = UpdateDeploymentGroupResponse' {}
- newUpdateDeploymentGroupResponse :: Int -> UpdateDeploymentGroupResponse
- updateDeploymentGroupResponse_hooksNotCleanedUp :: Lens' UpdateDeploymentGroupResponse (Maybe [AutoScalingGroup])
- updateDeploymentGroupResponse_httpStatus :: Lens' UpdateDeploymentGroupResponse Int
Creating a Request
data UpdateDeploymentGroup Source #
Represents the input of an UpdateDeploymentGroup
operation.
See: newUpdateDeploymentGroup
smart constructor.
Constructors
UpdateDeploymentGroup' | |
Fields
|
Instances
newUpdateDeploymentGroup Source #
Arguments
:: Text | |
-> Text | |
-> UpdateDeploymentGroup |
Create a value of UpdateDeploymentGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateDeploymentGroup
, updateDeploymentGroup_alarmConfiguration
- Information to add or change about Amazon CloudWatch alarms when the
deployment group is updated.
UpdateDeploymentGroup
, updateDeploymentGroup_autoRollbackConfiguration
- Information for an automatic rollback configuration that is added or
changed when a deployment group is updated.
UpdateDeploymentGroup
, updateDeploymentGroup_autoScalingGroups
- The replacement list of Auto Scaling groups to be included in the
deployment group, if you want to change them.
- To keep the Auto Scaling groups, enter their names or do not specify this parameter.
- To remove Auto Scaling groups, specify a non-null empty list of Auto Scaling group names to detach all CodeDeploy-managed Auto Scaling lifecycle hooks. For examples, see Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to launch and receive the error "Heartbeat Timeout" in the CodeDeploy User Guide.
UpdateDeploymentGroup
, updateDeploymentGroup_blueGreenDeploymentConfiguration
- Information about blue/green deployment options for a deployment group.
UpdateDeploymentGroup
, updateDeploymentGroup_deploymentConfigName
- The replacement deployment configuration name to use, if you want to
change it.
UpdateDeploymentGroup
, updateDeploymentGroup_deploymentStyle
- Information about the type of deployment, either in-place or
blue/green, you want to run and whether to route deployment traffic
behind a load balancer.
UpdateDeploymentGroup
, updateDeploymentGroup_ec2TagFilters
- The replacement set of Amazon EC2 tags on which to filter, if you want
to change them. To keep the existing tags, enter their names. To remove
tags, do not enter any tag names.
UpdateDeploymentGroup
, updateDeploymentGroup_ec2TagSet
- Information about groups of tags applied to on-premises instances. The
deployment group includes only Amazon EC2 instances identified by all
the tag groups.
UpdateDeploymentGroup
, updateDeploymentGroup_ecsServices
- The target Amazon ECS services in the deployment group. This applies
only to deployment groups that use the Amazon ECS compute platform. A
target Amazon ECS service is specified as an Amazon ECS cluster and
service name pair using the format <clustername>:<servicename>
.
UpdateDeploymentGroup
, updateDeploymentGroup_loadBalancerInfo
- Information about the load balancer used in a deployment.
$sel:newDeploymentGroupName':UpdateDeploymentGroup'
, updateDeploymentGroup_newDeploymentGroupName
- The new name of the deployment group, if you want to change it.
UpdateDeploymentGroup
, updateDeploymentGroup_onPremisesInstanceTagFilters
- The replacement set of on-premises instance tags on which to filter, if
you want to change them. To keep the existing tags, enter their names.
To remove tags, do not enter any tag names.
UpdateDeploymentGroup
, updateDeploymentGroup_onPremisesTagSet
- Information about an on-premises instance tag set. The deployment group
includes only on-premises instances identified by all the tag groups.
UpdateDeploymentGroup
, updateDeploymentGroup_outdatedInstancesStrategy
- Indicates what happens when new Amazon EC2 instances are launched
mid-deployment and do not receive the deployed application revision.
If this option is set to UPDATE
or is unspecified, CodeDeploy
initiates one or more 'auto-update outdated instances' deployments to
apply the deployed application revision to the new Amazon EC2 instances.
If this option is set to IGNORE
, CodeDeploy does not initiate a
deployment to update the new Amazon EC2 instances. This may result in
instances having different revisions.
UpdateDeploymentGroup
, updateDeploymentGroup_serviceRoleArn
- A replacement ARN for the service role, if you want to change it.
UpdateDeploymentGroup
, updateDeploymentGroup_triggerConfigurations
- Information about triggers to change when the deployment group is
updated. For examples, see
Edit a Trigger in a CodeDeploy Deployment Group
in the CodeDeploy User Guide.
UpdateDeploymentGroup
, updateDeploymentGroup_applicationName
- The application name that corresponds to the deployment group to update.
$sel:currentDeploymentGroupName:UpdateDeploymentGroup'
, updateDeploymentGroup_currentDeploymentGroupName
- The current name of the deployment group.
Request Lenses
updateDeploymentGroup_alarmConfiguration :: Lens' UpdateDeploymentGroup (Maybe AlarmConfiguration) Source #
Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.
updateDeploymentGroup_autoRollbackConfiguration :: Lens' UpdateDeploymentGroup (Maybe AutoRollbackConfiguration) Source #
Information for an automatic rollback configuration that is added or changed when a deployment group is updated.
updateDeploymentGroup_autoScalingGroups :: Lens' UpdateDeploymentGroup (Maybe [Text]) Source #
The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.
- To keep the Auto Scaling groups, enter their names or do not specify this parameter.
- To remove Auto Scaling groups, specify a non-null empty list of Auto Scaling group names to detach all CodeDeploy-managed Auto Scaling lifecycle hooks. For examples, see Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to launch and receive the error "Heartbeat Timeout" in the CodeDeploy User Guide.
updateDeploymentGroup_blueGreenDeploymentConfiguration :: Lens' UpdateDeploymentGroup (Maybe BlueGreenDeploymentConfiguration) Source #
Information about blue/green deployment options for a deployment group.
updateDeploymentGroup_deploymentConfigName :: Lens' UpdateDeploymentGroup (Maybe Text) Source #
The replacement deployment configuration name to use, if you want to change it.
updateDeploymentGroup_deploymentStyle :: Lens' UpdateDeploymentGroup (Maybe DeploymentStyle) Source #
Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.
updateDeploymentGroup_ec2TagFilters :: Lens' UpdateDeploymentGroup (Maybe [EC2TagFilter]) Source #
The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.
updateDeploymentGroup_ec2TagSet :: Lens' UpdateDeploymentGroup (Maybe EC2TagSet) Source #
Information about groups of tags applied to on-premises instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups.
updateDeploymentGroup_ecsServices :: Lens' UpdateDeploymentGroup (Maybe [ECSService]) Source #
The target Amazon ECS services in the deployment group. This applies
only to deployment groups that use the Amazon ECS compute platform. A
target Amazon ECS service is specified as an Amazon ECS cluster and
service name pair using the format <clustername>:<servicename>
.
updateDeploymentGroup_loadBalancerInfo :: Lens' UpdateDeploymentGroup (Maybe LoadBalancerInfo) Source #
Information about the load balancer used in a deployment.
updateDeploymentGroup_newDeploymentGroupName :: Lens' UpdateDeploymentGroup (Maybe Text) Source #
The new name of the deployment group, if you want to change it.
updateDeploymentGroup_onPremisesInstanceTagFilters :: Lens' UpdateDeploymentGroup (Maybe [TagFilter]) Source #
The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.
updateDeploymentGroup_onPremisesTagSet :: Lens' UpdateDeploymentGroup (Maybe OnPremisesTagSet) Source #
Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.
updateDeploymentGroup_outdatedInstancesStrategy :: Lens' UpdateDeploymentGroup (Maybe OutdatedInstancesStrategy) Source #
Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.
If this option is set to UPDATE
or is unspecified, CodeDeploy
initiates one or more 'auto-update outdated instances' deployments to
apply the deployed application revision to the new Amazon EC2 instances.
If this option is set to IGNORE
, CodeDeploy does not initiate a
deployment to update the new Amazon EC2 instances. This may result in
instances having different revisions.
updateDeploymentGroup_serviceRoleArn :: Lens' UpdateDeploymentGroup (Maybe Text) Source #
A replacement ARN for the service role, if you want to change it.
updateDeploymentGroup_triggerConfigurations :: Lens' UpdateDeploymentGroup (Maybe [TriggerConfig]) Source #
Information about triggers to change when the deployment group is updated. For examples, see Edit a Trigger in a CodeDeploy Deployment Group in the CodeDeploy User Guide.
updateDeploymentGroup_applicationName :: Lens' UpdateDeploymentGroup Text Source #
The application name that corresponds to the deployment group to update.
updateDeploymentGroup_currentDeploymentGroupName :: Lens' UpdateDeploymentGroup Text Source #
The current name of the deployment group.
Destructuring the Response
data UpdateDeploymentGroupResponse Source #
Represents the output of an UpdateDeploymentGroup
operation.
See: newUpdateDeploymentGroupResponse
smart constructor.
Constructors
UpdateDeploymentGroupResponse' | |
Fields
|
Instances
newUpdateDeploymentGroupResponse Source #
Create a value of UpdateDeploymentGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hooksNotCleanedUp:UpdateDeploymentGroupResponse'
, updateDeploymentGroupResponse_hooksNotCleanedUp
- If the output contains no data, and the corresponding deployment group
contained at least one Auto Scaling group, CodeDeploy successfully
removed all corresponding Auto Scaling lifecycle event hooks from the
Amazon Web Services account. If the output contains data, CodeDeploy
could not remove some Auto Scaling lifecycle event hooks from the Amazon
Web Services account.
$sel:httpStatus:UpdateDeploymentGroupResponse'
, updateDeploymentGroupResponse_httpStatus
- The response's http status code.
Response Lenses
updateDeploymentGroupResponse_hooksNotCleanedUp :: Lens' UpdateDeploymentGroupResponse (Maybe [AutoScalingGroup]) Source #
If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon Web Services account. If the output contains data, CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon Web Services account.
updateDeploymentGroupResponse_httpStatus :: Lens' UpdateDeploymentGroupResponse Int Source #
The response's http status code.