AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the UpdateDeploymentGroup operation. Changes information about a deployment group.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CodeDeploy.AmazonCodeDeployRequest
      Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest

Namespace: Amazon.CodeDeploy.Model
Assembly: AWSSDK.CodeDeploy.dll
Version: 3.x.y.z

Syntax

C#
public class UpdateDeploymentGroupRequest : AmazonCodeDeployRequest
         IAmazonWebServiceRequest

The UpdateDeploymentGroupRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AlarmConfiguration Amazon.CodeDeploy.Model.AlarmConfiguration

Gets and sets the property AlarmConfiguration.

Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.

Public Property ApplicationName System.String

Gets and sets the property ApplicationName.

The application name that corresponds to the deployment group to update.

Public Property AutoRollbackConfiguration Amazon.CodeDeploy.Model.AutoRollbackConfiguration

Gets and sets the property AutoRollbackConfiguration.

Information for an automatic rollback configuration that is added or changed when a deployment group is updated.

Public Property AutoScalingGroups System.Collections.Generic.List<System.String>

Gets and sets the property AutoScalingGroups.

The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.

Public Property BlueGreenDeploymentConfiguration Amazon.CodeDeploy.Model.BlueGreenDeploymentConfiguration

Gets and sets the property BlueGreenDeploymentConfiguration.

Information about blue/green deployment options for a deployment group.

Public Property CurrentDeploymentGroupName System.String

Gets and sets the property CurrentDeploymentGroupName.

The current name of the deployment group.

Public Property DeploymentConfigName System.String

Gets and sets the property DeploymentConfigName.

The replacement deployment configuration name to use, if you want to change it.

Public Property DeploymentStyle Amazon.CodeDeploy.Model.DeploymentStyle

Gets and sets the property 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.

Public Property Ec2TagFilters System.Collections.Generic.List<Amazon.CodeDeploy.Model.EC2TagFilter>

Gets and sets the property 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.

Public Property Ec2TagSet Amazon.CodeDeploy.Model.EC2TagSet

Gets and sets the property 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.

Public Property EcsServices System.Collections.Generic.List<Amazon.CodeDeploy.Model.ECSService>

Gets and sets the property 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 :.

Public Property IsAutoScalingGroupsSet System.Boolean

This property is set to true if the property Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest.AutoScalingGroups is set; false otherwise. This property can be used to determine if the related property was returned by a service response or if the related property should be sent to the service during a service call.

Public Property LoadBalancerInfo Amazon.CodeDeploy.Model.LoadBalancerInfo

Gets and sets the property LoadBalancerInfo.

Information about the load balancer used in a deployment.

Public Property NewDeploymentGroupName System.String

Gets and sets the property NewDeploymentGroupName.

The new name of the deployment group, if you want to change it.

Public Property OnPremisesInstanceTagFilters System.Collections.Generic.List<Amazon.CodeDeploy.Model.TagFilter>

Gets and sets the property 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.

Public Property OnPremisesTagSet Amazon.CodeDeploy.Model.OnPremisesTagSet

Gets and sets the property OnPremisesTagSet.

Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.

Public Property OutdatedInstancesStrategy Amazon.CodeDeploy.OutdatedInstancesStrategy

Gets and sets the property 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.

Public Property ServiceRoleArn System.String

Gets and sets the property ServiceRoleArn.

A replacement ARN for the service role, if you want to change it.

Public Property TerminationHookEnabled System.Boolean

Gets and sets the property TerminationHookEnabled.

This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.

Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you update a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.

For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.

For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.

Public Property TriggerConfigurations System.Collections.Generic.List<Amazon.CodeDeploy.Model.TriggerConfig>

Gets and sets the property 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5