Class CfnDeploymentGroup
The AWS::CodeDeploy::DeploymentGroup
resource creates an AWS CodeDeploy deployment group that specifies which instances your application revisions are deployed to, along with other deployment options.
Inherited Members
Namespace: Amazon.CDK.AWS.CodeDeploy
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDeploymentGroup : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDeploymentGroup
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
For more information, see CreateDeploymentGroup in the CodeDeploy API Reference .
Amazon ECS blue/green deployments through CodeDeploy do not use the AWS::CodeDeploy::DeploymentGroup
resource. To perform Amazon ECS blue/green deployments, use the AWS::CodeDeploy::BlueGreen
hook. See Perform Amazon ECS blue/green deployments through CodeDeploy using AWS CloudFormation for more information.
CloudformationResource: AWS::CodeDeploy::DeploymentGroup
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodeDeploy;
var cfnDeploymentGroup = new CfnDeploymentGroup(this, "MyCfnDeploymentGroup", new CfnDeploymentGroupProps {
ApplicationName = "applicationName",
ServiceRoleArn = "serviceRoleArn",
// the properties below are optional
AlarmConfiguration = new AlarmConfigurationProperty {
Alarms = new [] { new AlarmProperty {
Name = "name"
} },
Enabled = false,
IgnorePollAlarmFailure = false
},
AutoRollbackConfiguration = new AutoRollbackConfigurationProperty {
Enabled = false,
Events = new [] { "events" }
},
AutoScalingGroups = new [] { "autoScalingGroups" },
BlueGreenDeploymentConfiguration = new BlueGreenDeploymentConfigurationProperty {
DeploymentReadyOption = new DeploymentReadyOptionProperty {
ActionOnTimeout = "actionOnTimeout",
WaitTimeInMinutes = 123
},
GreenFleetProvisioningOption = new GreenFleetProvisioningOptionProperty {
Action = "action"
},
TerminateBlueInstancesOnDeploymentSuccess = new BlueInstanceTerminationOptionProperty {
Action = "action",
TerminationWaitTimeInMinutes = 123
}
},
Deployment = new DeploymentProperty {
Revision = new RevisionLocationProperty {
GitHubLocation = new GitHubLocationProperty {
CommitId = "commitId",
Repository = "repository"
},
RevisionType = "revisionType",
S3Location = new S3LocationProperty {
Bucket = "bucket",
Key = "key",
// the properties below are optional
BundleType = "bundleType",
ETag = "eTag",
Version = "version"
}
},
// the properties below are optional
Description = "description",
IgnoreApplicationStopFailures = false
},
DeploymentConfigName = "deploymentConfigName",
DeploymentGroupName = "deploymentGroupName",
DeploymentStyle = new DeploymentStyleProperty {
DeploymentOption = "deploymentOption",
DeploymentType = "deploymentType"
},
Ec2TagFilters = new [] { new EC2TagFilterProperty {
Key = "key",
Type = "type",
Value = "value"
} },
Ec2TagSet = new EC2TagSetProperty {
Ec2TagSetList = new [] { new EC2TagSetListObjectProperty {
Ec2TagGroup = new [] { new EC2TagFilterProperty {
Key = "key",
Type = "type",
Value = "value"
} }
} }
},
EcsServices = new [] { new ECSServiceProperty {
ClusterName = "clusterName",
ServiceName = "serviceName"
} },
LoadBalancerInfo = new LoadBalancerInfoProperty {
ElbInfoList = new [] { new ELBInfoProperty {
Name = "name"
} },
TargetGroupInfoList = new [] { new TargetGroupInfoProperty {
Name = "name"
} },
TargetGroupPairInfoList = new [] { new TargetGroupPairInfoProperty {
ProdTrafficRoute = new TrafficRouteProperty {
ListenerArns = new [] { "listenerArns" }
},
TargetGroups = new [] { new TargetGroupInfoProperty {
Name = "name"
} },
TestTrafficRoute = new TrafficRouteProperty {
ListenerArns = new [] { "listenerArns" }
}
} }
},
OnPremisesInstanceTagFilters = new [] { new TagFilterProperty {
Key = "key",
Type = "type",
Value = "value"
} },
OnPremisesTagSet = new OnPremisesTagSetProperty {
OnPremisesTagSetList = new [] { new OnPremisesTagSetListObjectProperty {
OnPremisesTagGroup = new [] { new TagFilterProperty {
Key = "key",
Type = "type",
Value = "value"
} }
} }
},
OutdatedInstancesStrategy = "outdatedInstancesStrategy",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TerminationHookEnabled = false,
TriggerConfigurations = new [] { new TriggerConfigProperty {
TriggerEvents = new [] { "triggerEvents" },
TriggerName = "triggerName",
TriggerTargetArn = "triggerTargetArn"
} }
});
Synopsis
Constructors
CfnDeploymentGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDeploymentGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDeploymentGroup(Construct, String, ICfnDeploymentGroupProps) |
Properties
AlarmConfiguration | Information about the Amazon CloudWatch alarms that are associated with the deployment group. |
ApplicationName | The name of an existing CodeDeploy application to associate this deployment group with. |
AttrId | |
AutoRollbackConfiguration | Information about the automatic rollback configuration that is associated with the deployment group. |
AutoScalingGroups | A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created. |
BlueGreenDeploymentConfiguration | Information about blue/green deployment options for a deployment group. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Deployment | The application revision to deploy to this deployment group. |
DeploymentConfigName | A deployment configuration name or a predefined configuration name. |
DeploymentGroupName | A name for the deployment group. |
DeploymentStyle | Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer. |
Ec2TagFilters | The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group. |
Ec2TagSet | Information about groups of tags applied to Amazon EC2 instances. |
EcsServices | The target Amazon ECS services in the deployment group. |
LoadBalancerInfo | Information about the load balancer to use in a deployment. |
OnPremisesInstanceTagFilters | The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group. |
OnPremisesTagSet | Information about groups of tags applied to on-premises instances. |
OutdatedInstancesStrategy | Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision. |
ServiceRoleArn | A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. |
TerminationHookEnabled | Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group. |
TriggerConfigurations | Information about triggers associated with the deployment group. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDeploymentGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDeploymentGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDeploymentGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDeploymentGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDeploymentGroup(Construct, String, ICfnDeploymentGroupProps)
public CfnDeploymentGroup(Construct scope, string id, ICfnDeploymentGroupProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDeploymentGroupProps
Resource properties.
Properties
AlarmConfiguration
Information about the Amazon CloudWatch alarms that are associated with the deployment group.
public virtual object AlarmConfiguration { get; set; }
Property Value
System.Object
ApplicationName
The name of an existing CodeDeploy application to associate this deployment group with.
public virtual string ApplicationName { get; set; }
Property Value
System.String
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AutoRollbackConfiguration
Information about the automatic rollback configuration that is associated with the deployment group.
public virtual object AutoRollbackConfiguration { get; set; }
Property Value
System.Object
AutoScalingGroups
A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created.
public virtual string[] AutoScalingGroups { get; set; }
Property Value
System.String[]
BlueGreenDeploymentConfiguration
Information about blue/green deployment options for a deployment group.
public virtual object BlueGreenDeploymentConfiguration { get; set; }
Property Value
System.Object
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Deployment
The application revision to deploy to this deployment group.
public virtual object Deployment { get; set; }
Property Value
System.Object
DeploymentConfigName
A deployment configuration name or a predefined configuration name.
public virtual string DeploymentConfigName { get; set; }
Property Value
System.String
DeploymentGroupName
A name for the deployment group.
public virtual string DeploymentGroupName { get; set; }
Property Value
System.String
DeploymentStyle
Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer.
public virtual object DeploymentStyle { get; set; }
Property Value
System.Object
Ec2TagFilters
The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group.
public virtual object Ec2TagFilters { get; set; }
Property Value
System.Object
Ec2TagSet
Information about groups of tags applied to Amazon EC2 instances.
public virtual object Ec2TagSet { get; set; }
Property Value
System.Object
EcsServices
The target Amazon ECS services in the deployment group.
public virtual object EcsServices { get; set; }
Property Value
System.Object
LoadBalancerInfo
Information about the load balancer to use in a deployment.
public virtual object LoadBalancerInfo { get; set; }
Property Value
System.Object
OnPremisesInstanceTagFilters
The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group.
public virtual object OnPremisesInstanceTagFilters { get; set; }
Property Value
System.Object
OnPremisesTagSet
Information about groups of tags applied to on-premises instances.
public virtual object OnPremisesTagSet { get; set; }
Property Value
System.Object
OutdatedInstancesStrategy
Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.
public virtual string OutdatedInstancesStrategy { get; set; }
Property Value
System.String
ServiceRoleArn
A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf.
public virtual string ServiceRoleArn { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
TerminationHookEnabled
Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.
public virtual object TerminationHookEnabled { get; set; }
Property Value
System.Object
TriggerConfigurations
Information about triggers associated with the deployment group.
public virtual object TriggerConfigurations { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>