AWS SDK Version 2 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.

.NET Framework 4.5
 
Container for the parameters to the CreateDeploymentGroup operation. Creates a new deployment group for application revisions to be deployed to.

Inheritance Hierarchy

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

Namespace: Amazon.CodeDeploy.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class CreateDeploymentGroupRequest : AmazonCodeDeployRequest
         IRequestEvents

The CreateDeploymentGroupRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ApplicationName System.String Gets and sets the property ApplicationName.

The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.

Public Property AutoScalingGroups System.Collections.Generic.List<System.String> Gets and sets the property AutoScalingGroups.

A list of associated Auto Scaling groups.

Public Property DeploymentConfigName System.String Gets and sets the property DeploymentConfigName.

If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy, or a custom deployment configuration that you created by calling the create deployment configuration operation.

CodeDeployDefault.OneAtATime is the default deployment configuration that is used if a configuration isn't specified for either the deployment or the deployment group.

The predefined deployment configurations including the following:

  • CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instances as possible at once. The status of the overall deployment will be displayed as Succeeded if the application revision is deployed to one or more of the instances. The status of the overall deployment will be displayed as Failed if the application revision is not deployed to any of the instances. Using an example of nine instances, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instances at once. The overall deployment will succeed if deployment to even a single instance is successful; it will fail only if deployments to all nine instances fail.

  • CodeDeployDefault.HalfAtATime deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision deploys to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. For example, for nine instances, deploy to up to four instances at a time. The overall deployment succeeds if deployment to five or more instances succeed; otherwise, the deployment fails. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails.

  • CodeDeployDefault.OneAtATime deploys the application revision to only one instance at a time.

    For deployment groups that contain more than one instance:

    • The overall deployment succeeds if the application revision deploys to all of the instances. The exception to this rule is that if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance to be taken offline at a time with the CodeDeployDefault.OneAtATime configuration.

    • The overall deployment fails as soon as the application revision fails to deploy to any but the last instance. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails.

    • Example: For nine instances, deploy to one instance at a time. The overall deployment succeeds if the first eight instances are successfully deployed to, but it fails if deployment to any of the first eight instances fails.

    For deployment groups that contain only one instance, the overall deployment is of course successful only if deployment to the single instance succeeds.

Public Property DeploymentGroupName System.String Gets and sets the property DeploymentGroupName.

The name of a new deployment group for the specified application.

Public Property Ec2TagFilters System.Collections.Generic.List<Amazon.CodeDeploy.Model.EC2TagFilter> Gets and sets the property Ec2TagFilters.

The Amazon EC2 tags to filter on.

Public Property OnPremisesInstanceTagFilters System.Collections.Generic.List<Amazon.CodeDeploy.Model.TagFilter> Gets and sets the property OnPremisesInstanceTagFilters.

The on-premises instance tags to filter on.

Public Property ServiceRoleArn System.String Gets and sets the property ServiceRoleArn.

A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.

Public Property TriggerConfigurations System.Collections.Generic.List<Amazon.CodeDeploy.Model.TriggerConfig> Gets and sets the property TriggerConfigurations.

Information about triggers to create when the deployment group is created.

Version Information

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