amazonka-codedeploy-2.0: Amazon CodeDeploy SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CodeDeploy.UpdateDeploymentGroup

Description

Changes information about a deployment group.

Synopsis

Creating a Request

data UpdateDeploymentGroup Source #

Represents the input of an UpdateDeploymentGroup operation.

See: newUpdateDeploymentGroup smart constructor.

Constructors

UpdateDeploymentGroup' 

Fields

Instances

Instances details
ToJSON UpdateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.UpdateDeploymentGroup

ToHeaders UpdateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.UpdateDeploymentGroup

ToPath UpdateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.UpdateDeploymentGroup

ToQuery UpdateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.UpdateDeploymentGroup

AWSRequest UpdateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.UpdateDeploymentGroup

Associated Types

type AWSResponse UpdateDeploymentGroup #

Generic UpdateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.UpdateDeploymentGroup

Associated Types

type Rep UpdateDeploymentGroup :: Type -> Type #

Read UpdateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.UpdateDeploymentGroup

Show UpdateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.UpdateDeploymentGroup

NFData UpdateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.UpdateDeploymentGroup

Methods

rnf :: UpdateDeploymentGroup -> () #

Eq UpdateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.UpdateDeploymentGroup

Hashable UpdateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.UpdateDeploymentGroup

type AWSResponse UpdateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.UpdateDeploymentGroup

type Rep UpdateDeploymentGroup Source # 
Instance details

Defined in Amazonka.CodeDeploy.UpdateDeploymentGroup

type Rep UpdateDeploymentGroup = D1 ('MetaData "UpdateDeploymentGroup" "Amazonka.CodeDeploy.UpdateDeploymentGroup" "amazonka-codedeploy-2.0-4OehMEUeOr9G9ZXD2VmvAo" 'False) (C1 ('MetaCons "UpdateDeploymentGroup'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "alarmConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlarmConfiguration)) :*: S1 ('MetaSel ('Just "autoRollbackConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoRollbackConfiguration))) :*: (S1 ('MetaSel ('Just "autoScalingGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "blueGreenDeploymentConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BlueGreenDeploymentConfiguration)))) :*: ((S1 ('MetaSel ('Just "deploymentConfigName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deploymentStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentStyle))) :*: (S1 ('MetaSel ('Just "ec2TagFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EC2TagFilter])) :*: (S1 ('MetaSel ('Just "ec2TagSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EC2TagSet)) :*: S1 ('MetaSel ('Just "ecsServices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ECSService])))))) :*: (((S1 ('MetaSel ('Just "loadBalancerInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoadBalancerInfo)) :*: S1 ('MetaSel ('Just "newDeploymentGroupName'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "onPremisesInstanceTagFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagFilter])) :*: S1 ('MetaSel ('Just "onPremisesTagSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OnPremisesTagSet)))) :*: ((S1 ('MetaSel ('Just "outdatedInstancesStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutdatedInstancesStrategy)) :*: S1 ('MetaSel ('Just "serviceRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "triggerConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TriggerConfig])) :*: (S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "currentDeploymentGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newUpdateDeploymentGroup Source #

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.

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.

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.

Destructuring the Response

data UpdateDeploymentGroupResponse Source #

Represents the output of an UpdateDeploymentGroup operation.

See: newUpdateDeploymentGroupResponse smart constructor.

Constructors

UpdateDeploymentGroupResponse' 

Fields

  • hooksNotCleanedUp :: Maybe [AutoScalingGroup]

    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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic UpdateDeploymentGroupResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.UpdateDeploymentGroup

Associated Types

type Rep UpdateDeploymentGroupResponse :: Type -> Type #

Read UpdateDeploymentGroupResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.UpdateDeploymentGroup

Show UpdateDeploymentGroupResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.UpdateDeploymentGroup

NFData UpdateDeploymentGroupResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.UpdateDeploymentGroup

Eq UpdateDeploymentGroupResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.UpdateDeploymentGroup

type Rep UpdateDeploymentGroupResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.UpdateDeploymentGroup

type Rep UpdateDeploymentGroupResponse = D1 ('MetaData "UpdateDeploymentGroupResponse" "Amazonka.CodeDeploy.UpdateDeploymentGroup" "amazonka-codedeploy-2.0-4OehMEUeOr9G9ZXD2VmvAo" 'False) (C1 ('MetaCons "UpdateDeploymentGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hooksNotCleanedUp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AutoScalingGroup])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

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.