CfnDeploymentGroup (software.amazon.awscdk:codedeploy 1.169.0 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.core.Construct
    - - software.amazon.awscdk.core.CfnElement
      - software.amazon.awscdk.core.CfnRefElement
        
        software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup

All Implemented Interfaces:: IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-17T17:31:20.150Z")
 @Stability(value=Stable)
public class CfnDeploymentGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CodeDeploy::DeploymentGroup`.

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. 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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codedeploy.*;
 CfnDeploymentGroup cfnDeploymentGroup = CfnDeploymentGroup.Builder.create(this, "MyCfnDeploymentGroup")
         .applicationName("applicationName")
         .serviceRoleArn("serviceRoleArn")
         // the properties below are optional
         .alarmConfiguration(AlarmConfigurationProperty.builder()
                 .alarms(List.of(AlarmProperty.builder()
                         .name("name")
                         .build()))
                 .enabled(false)
                 .ignorePollAlarmFailure(false)
                 .build())
         .autoRollbackConfiguration(AutoRollbackConfigurationProperty.builder()
                 .enabled(false)
                 .events(List.of("events"))
                 .build())
         .autoScalingGroups(List.of("autoScalingGroups"))
         .blueGreenDeploymentConfiguration(BlueGreenDeploymentConfigurationProperty.builder()
                 .deploymentReadyOption(DeploymentReadyOptionProperty.builder()
                         .actionOnTimeout("actionOnTimeout")
                         .waitTimeInMinutes(123)
                         .build())
                 .greenFleetProvisioningOption(GreenFleetProvisioningOptionProperty.builder()
                         .action("action")
                         .build())
                 .terminateBlueInstancesOnDeploymentSuccess(BlueInstanceTerminationOptionProperty.builder()
                         .action("action")
                         .terminationWaitTimeInMinutes(123)
                         .build())
                 .build())
         .deployment(DeploymentProperty.builder()
                 .revision(RevisionLocationProperty.builder()
                         .gitHubLocation(GitHubLocationProperty.builder()
                                 .commitId("commitId")
                                 .repository("repository")
                                 .build())
                         .revisionType("revisionType")
                         .s3Location(S3LocationProperty.builder()
                                 .bucket("bucket")
                                 .key("key")
                                 // the properties below are optional
                                 .bundleType("bundleType")
                                 .eTag("eTag")
                                 .version("version")
                                 .build())
                         .build())
                 // the properties below are optional
                 .description("description")
                 .ignoreApplicationStopFailures(false)
                 .build())
         .deploymentConfigName("deploymentConfigName")
         .deploymentGroupName("deploymentGroupName")
         .deploymentStyle(DeploymentStyleProperty.builder()
                 .deploymentOption("deploymentOption")
                 .deploymentType("deploymentType")
                 .build())
         .ec2TagFilters(List.of(EC2TagFilterProperty.builder()
                 .key("key")
                 .type("type")
                 .value("value")
                 .build()))
         .ec2TagSet(EC2TagSetProperty.builder()
                 .ec2TagSetList(List.of(EC2TagSetListObjectProperty.builder()
                         .ec2TagGroup(List.of(EC2TagFilterProperty.builder()
                                 .key("key")
                                 .type("type")
                                 .value("value")
                                 .build()))
                         .build()))
                 .build())
         .ecsServices(List.of(ECSServiceProperty.builder()
                 .clusterName("clusterName")
                 .serviceName("serviceName")
                 .build()))
         .loadBalancerInfo(LoadBalancerInfoProperty.builder()
                 .elbInfoList(List.of(ELBInfoProperty.builder()
                         .name("name")
                         .build()))
                 .targetGroupInfoList(List.of(TargetGroupInfoProperty.builder()
                         .name("name")
                         .build()))
                 .targetGroupPairInfoList(List.of(TargetGroupPairInfoProperty.builder()
                         .prodTrafficRoute(TrafficRouteProperty.builder()
                                 .listenerArns(List.of("listenerArns"))
                                 .build())
                         .targetGroups(List.of(TargetGroupInfoProperty.builder()
                                 .name("name")
                                 .build()))
                         .testTrafficRoute(TrafficRouteProperty.builder()
                                 .listenerArns(List.of("listenerArns"))
                                 .build())
                         .build()))
                 .build())
         .onPremisesInstanceTagFilters(List.of(TagFilterProperty.builder()
                 .key("key")
                 .type("type")
                 .value("value")
                 .build()))
         .onPremisesTagSet(OnPremisesTagSetProperty.builder()
                 .onPremisesTagSetList(List.of(OnPremisesTagSetListObjectProperty.builder()
                         .onPremisesTagGroup(List.of(TagFilterProperty.builder()
                                 .key("key")
                                 .type("type")
                                 .value("value")
                                 .build()))
                         .build()))
                 .build())
         .outdatedInstancesStrategy("outdatedInstancesStrategy")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .triggerConfigurations(List.of(TriggerConfigProperty.builder()
                 .triggerEvents(List.of("triggerEvents"))
                 .triggerName("triggerName")
                 .triggerTargetArn("triggerTargetArn")
                 .build()))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CfnDeploymentGroup.AlarmConfigurationProperty` The `AlarmConfiguration` property type configures CloudWatch alarms for an AWS CodeDeploy deployment group.
`static interface`	`CfnDeploymentGroup.AlarmProperty` The `Alarm` property type specifies a CloudWatch alarm to use for an AWS CodeDeploy deployment group.
`static interface`	`CfnDeploymentGroup.AutoRollbackConfigurationProperty` The `AutoRollbackConfiguration` property type configures automatic rollback for an AWS CodeDeploy deployment group when a deployment is not completed successfully.
`static interface`	`CfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty` Information about blue/green deployment options for a deployment group.
`static interface`	`CfnDeploymentGroup.BlueInstanceTerminationOptionProperty` Information about whether instances in the original environment are terminated when a blue/green deployment is successful.
`static class`	`CfnDeploymentGroup.Builder` A fluent builder for `CfnDeploymentGroup`.
`static interface`	`CfnDeploymentGroup.DeploymentProperty` `Deployment` is a property of the [DeploymentGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html) resource that specifies an AWS CodeDeploy application revision to be deployed to instances in the deployment group.
`static interface`	`CfnDeploymentGroup.DeploymentReadyOptionProperty` Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.
`static interface`	`CfnDeploymentGroup.DeploymentStyleProperty` 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.
`static interface`	`CfnDeploymentGroup.EC2TagFilterProperty` Information about an Amazon EC2 tag filter.
`static interface`	`CfnDeploymentGroup.EC2TagSetListObjectProperty` The `EC2TagSet` property type specifies information about groups of tags applied to Amazon EC2 instances.
`static interface`	`CfnDeploymentGroup.EC2TagSetProperty` The `EC2TagSet` property type specifies information about groups of tags applied to Amazon EC2 instances.
`static interface`	`CfnDeploymentGroup.ECSServiceProperty` Contains the service and cluster names used to identify an Amazon ECS deployment's target.
`static interface`	`CfnDeploymentGroup.ELBInfoProperty` The `ELBInfo` property type specifies information about the Elastic Load Balancing load balancer used for an CodeDeploy deployment group.
`static interface`	`CfnDeploymentGroup.GitHubLocationProperty` `GitHubLocation` is a property of the [CodeDeploy DeploymentGroup Revision](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html) property that specifies the location of an application revision that is stored in GitHub.
`static interface`	`CfnDeploymentGroup.GreenFleetProvisioningOptionProperty` Information about the instances that belong to the replacement environment in a blue/green deployment.
`static interface`	`CfnDeploymentGroup.LoadBalancerInfoProperty` The `LoadBalancerInfo` property type specifies information about the load balancer or target group used for an AWS CodeDeploy deployment group.
`static interface`	`CfnDeploymentGroup.OnPremisesTagSetListObjectProperty` The `OnPremisesTagSetListObject` property type specifies lists of on-premises instance tag groups.
`static interface`	`CfnDeploymentGroup.OnPremisesTagSetProperty` The `OnPremisesTagSet` property type specifies a list containing other lists of on-premises instance tag groups.
`static interface`	`CfnDeploymentGroup.RevisionLocationProperty` `RevisionLocation` is a property that defines the location of the CodeDeploy application revision to deploy.
`static interface`	`CfnDeploymentGroup.S3LocationProperty` `S3Location` is a property of the [CodeDeploy DeploymentGroup Revision](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html) property that specifies the location of an application revision that is stored in Amazon Simple Storage Service ( Amazon S3 ).
`static interface`	`CfnDeploymentGroup.TagFilterProperty` `TagFilter` is a property type of the [AWS::CodeDeploy::DeploymentGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html) resource that specifies which on-premises instances to associate with the deployment group.
`static interface`	`CfnDeploymentGroup.TargetGroupInfoProperty` The `TargetGroupInfo` property type specifies information about a target group in Elastic Load Balancing to use in a deployment.
`static interface`	`CfnDeploymentGroup.TargetGroupPairInfoProperty` Information about two target groups and how traffic is routed during an Amazon ECS deployment.
`static interface`	`CfnDeploymentGroup.TrafficRouteProperty` Information about a listener.
`static interface`	`CfnDeploymentGroup.TriggerConfigProperty` Information about notification triggers for the deployment group.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnDeploymentGroup(Construct scope, String id, CfnDeploymentGroupProps props)` Create a new `AWS::CodeDeploy::DeploymentGroup`.
`protected`	`CfnDeploymentGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnDeploymentGroup(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`getAlarmConfiguration()` Information about the Amazon CloudWatch alarms that are associated with the deployment group.
`String`	`getApplicationName()` The name of an existing CodeDeploy application to associate this deployment group with.
`Object`	`getAutoRollbackConfiguration()` Information about the automatic rollback configuration that is associated with the deployment group.
`List<String>`	`getAutoScalingGroups()` A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created.
`Object`	`getBlueGreenDeploymentConfiguration()` Information about blue/green deployment options for a deployment group.
`protected Map<String,Object>`	`getCfnProperties()`
`Object`	`getDeployment()` The application revision to deploy to this deployment group.
`String`	`getDeploymentConfigName()` A deployment configuration name or a predefined configuration name.
`String`	`getDeploymentGroupName()` A name for the deployment group.
`Object`	`getDeploymentStyle()` Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer.
`Object`	`getEc2TagFilters()` The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group.
`Object`	`getEc2TagSet()` Information about groups of tags applied to Amazon EC2 instances.
`Object`	`getEcsServices()` The target Amazon ECS services in the deployment group.
`Object`	`getLoadBalancerInfo()` Information about the load balancer to use in a deployment.
`Object`	`getOnPremisesInstanceTagFilters()` The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group.
`Object`	`getOnPremisesTagSet()` Information about groups of tags applied to on-premises instances.
`String`	`getOutdatedInstancesStrategy()` Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.
`String`	`getServiceRoleArn()` A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf.
`TagManager`	`getTags()` The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them.
`Object`	`getTriggerConfigurations()` Information about triggers associated with the deployment group.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setAlarmConfiguration(CfnDeploymentGroup.AlarmConfigurationProperty value)` Information about the Amazon CloudWatch alarms that are associated with the deployment group.
`void`	`setAlarmConfiguration(IResolvable value)` Information about the Amazon CloudWatch alarms that are associated with the deployment group.
`void`	`setApplicationName(String value)` The name of an existing CodeDeploy application to associate this deployment group with.
`void`	`setAutoRollbackConfiguration(CfnDeploymentGroup.AutoRollbackConfigurationProperty value)` Information about the automatic rollback configuration that is associated with the deployment group.
`void`	`setAutoRollbackConfiguration(IResolvable value)` Information about the automatic rollback configuration that is associated with the deployment group.
`void`	`setAutoScalingGroups(List<String> value)` A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created.
`void`	`setBlueGreenDeploymentConfiguration(CfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty value)` Information about blue/green deployment options for a deployment group.
`void`	`setBlueGreenDeploymentConfiguration(IResolvable value)` Information about blue/green deployment options for a deployment group.
`void`	`setDeployment(CfnDeploymentGroup.DeploymentProperty value)` The application revision to deploy to this deployment group.
`void`	`setDeployment(IResolvable value)` The application revision to deploy to this deployment group.
`void`	`setDeploymentConfigName(String value)` A deployment configuration name or a predefined configuration name.
`void`	`setDeploymentGroupName(String value)` A name for the deployment group.
`void`	`setDeploymentStyle(CfnDeploymentGroup.DeploymentStyleProperty value)` Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer.
`void`	`setDeploymentStyle(IResolvable value)` Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer.
`void`	`setEc2TagFilters(IResolvable value)` The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group.
`void`	`setEc2TagFilters(List<Object> value)` The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group.
`void`	`setEc2TagSet(CfnDeploymentGroup.EC2TagSetProperty value)` Information about groups of tags applied to Amazon EC2 instances.
`void`	`setEc2TagSet(IResolvable value)` Information about groups of tags applied to Amazon EC2 instances.
`void`	`setEcsServices(IResolvable value)` The target Amazon ECS services in the deployment group.
`void`	`setEcsServices(List<Object> value)` The target Amazon ECS services in the deployment group.
`void`	`setLoadBalancerInfo(CfnDeploymentGroup.LoadBalancerInfoProperty value)` Information about the load balancer to use in a deployment.
`void`	`setLoadBalancerInfo(IResolvable value)` Information about the load balancer to use in a deployment.
`void`	`setOnPremisesInstanceTagFilters(IResolvable value)` The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group.
`void`	`setOnPremisesInstanceTagFilters(List<Object> value)` The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group.
`void`	`setOnPremisesTagSet(CfnDeploymentGroup.OnPremisesTagSetProperty value)` Information about groups of tags applied to on-premises instances.
`void`	`setOnPremisesTagSet(IResolvable value)` Information about groups of tags applied to on-premises instances.
`void`	`setOutdatedInstancesStrategy(String value)` Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.
`void`	`setServiceRoleArn(String value)` A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf.
`void`	`setTriggerConfigurations(IResolvable value)` Information about triggers associated with the deployment group.
`void`	`setTriggerConfigurations(List<Object> value)` Information about triggers associated with the deployment group.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnDeploymentGroup
```
protected CfnDeploymentGroup(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnDeploymentGroup
```
protected CfnDeploymentGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnDeploymentGroup
```
@Stability(value=Stable)
public CfnDeploymentGroup(@NotNull
                                                   Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @NotNull
                                                   CfnDeploymentGroupProps props)
```
    Create a new `AWS::CodeDeploy::DeploymentGroup`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
public TagManager getTags()
```
    The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them.
    Each tag consists of a key and an optional value, both of which you define.
  - getApplicationName
```
@Stability(value=Stable)
 @NotNull
public String getApplicationName()
```
    The name of an existing CodeDeploy application to associate this deployment group with.
  - setApplicationName
```
@Stability(value=Stable)
public void setApplicationName(@NotNull
                                                        String value)
```
    The name of an existing CodeDeploy application to associate this deployment group with.
  - getServiceRoleArn
```
@Stability(value=Stable)
 @NotNull
public String getServiceRoleArn()
```
    A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf.
    For more information, see Create a Service Role for AWS CodeDeploy in the AWS CodeDeploy User Guide .
    
    In some cases, you might need to add a dependency on the service role's policy. For more information, see IAM role policy in DependsOn Attribute .
  - setServiceRoleArn
```
@Stability(value=Stable)
public void setServiceRoleArn(@NotNull
                                                       String value)
```
    A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf.
    For more information, see Create a Service Role for AWS CodeDeploy in the AWS CodeDeploy User Guide .
    
    In some cases, you might need to add a dependency on the service role's policy. For more information, see IAM role policy in DependsOn Attribute .
  - getAlarmConfiguration
```
@Stability(value=Stable)
 @Nullable
public Object getAlarmConfiguration()
```
    Information about the Amazon CloudWatch alarms that are associated with the deployment group.
  - setAlarmConfiguration
```
@Stability(value=Stable)
public void setAlarmConfiguration(@Nullable
                                                           IResolvable value)
```
    Information about the Amazon CloudWatch alarms that are associated with the deployment group.
  - setAlarmConfiguration
```
@Stability(value=Stable)
public void setAlarmConfiguration(@Nullable
                                                           CfnDeploymentGroup.AlarmConfigurationProperty value)
```
    Information about the Amazon CloudWatch alarms that are associated with the deployment group.
  - getAutoRollbackConfiguration
```
@Stability(value=Stable)
 @Nullable
public Object getAutoRollbackConfiguration()
```
    Information about the automatic rollback configuration that is associated with the deployment group.
    If you specify this property, don't specify the Deployment property.
  - setAutoRollbackConfiguration
```
@Stability(value=Stable)
public void setAutoRollbackConfiguration(@Nullable
                                                                  IResolvable value)
```
    Information about the automatic rollback configuration that is associated with the deployment group.
    If you specify this property, don't specify the Deployment property.
  - setAutoRollbackConfiguration
```
@Stability(value=Stable)
public void setAutoRollbackConfiguration(@Nullable
                                                                  CfnDeploymentGroup.AutoRollbackConfigurationProperty value)
```
    Information about the automatic rollback configuration that is associated with the deployment group.
    If you specify this property, don't specify the Deployment property.
  - getAutoScalingGroups
```
@Stability(value=Stable)
 @Nullable
public List<String> getAutoScalingGroups()
```
    A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created.
    Duplicates are not allowed.
  - setAutoScalingGroups
```
@Stability(value=Stable)
public void setAutoScalingGroups(@Nullable
                                                          List<String> value)
```
    A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created.
    Duplicates are not allowed.
  - getBlueGreenDeploymentConfiguration
```
@Stability(value=Stable)
 @Nullable
public Object getBlueGreenDeploymentConfiguration()
```
    Information about blue/green deployment options for a deployment group.
  - setBlueGreenDeploymentConfiguration
```
@Stability(value=Stable)
public void setBlueGreenDeploymentConfiguration(@Nullable
                                                                         IResolvable value)
```
    Information about blue/green deployment options for a deployment group.
  - setBlueGreenDeploymentConfiguration
```
@Stability(value=Stable)
public void setBlueGreenDeploymentConfiguration(@Nullable
                                                                         CfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty value)
```
    Information about blue/green deployment options for a deployment group.
  - getDeployment
```
@Stability(value=Stable)
 @Nullable
public Object getDeployment()
```
    The application revision to deploy to this deployment group.
    If you specify this property, your target application revision is deployed as soon as the provisioning process is complete. If you specify this property, don't specify the AutoRollbackConfiguration property.
  - setDeployment
```
@Stability(value=Stable)
public void setDeployment(@Nullable
                                                   IResolvable value)
```
    The application revision to deploy to this deployment group.
    If you specify this property, your target application revision is deployed as soon as the provisioning process is complete. If you specify this property, don't specify the AutoRollbackConfiguration property.
  - setDeployment
```
@Stability(value=Stable)
public void setDeployment(@Nullable
                                                   CfnDeploymentGroup.DeploymentProperty value)
```
    The application revision to deploy to this deployment group.
    If you specify this property, your target application revision is deployed as soon as the provisioning process is complete. If you specify this property, don't specify the AutoRollbackConfiguration property.
  - getDeploymentConfigName
```
@Stability(value=Stable)
 @Nullable
public String getDeploymentConfigName()
```
    A deployment configuration name or a predefined configuration name.
    With predefined configurations, you can deploy application revisions to one instance at a time ( CodeDeployDefault.OneAtATime ), half of the instances at a time ( CodeDeployDefault.HalfAtATime ), or all the instances at once ( CodeDeployDefault.AllAtOnce ). For more information and valid values, see Working with Deployment Configurations in the AWS CodeDeploy User Guide .
  - setDeploymentConfigName
```
@Stability(value=Stable)
public void setDeploymentConfigName(@Nullable
                                                             String value)
```
    A deployment configuration name or a predefined configuration name.
    With predefined configurations, you can deploy application revisions to one instance at a time ( CodeDeployDefault.OneAtATime ), half of the instances at a time ( CodeDeployDefault.HalfAtATime ), or all the instances at once ( CodeDeployDefault.AllAtOnce ). For more information and valid values, see Working with Deployment Configurations in the AWS CodeDeploy User Guide .
  - getDeploymentGroupName
```
@Stability(value=Stable)
 @Nullable
public String getDeploymentGroupName()
```
    A name for the deployment group.
    If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment group name. For more information, see Name Type .
    
    If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
  - setDeploymentGroupName
```
@Stability(value=Stable)
public void setDeploymentGroupName(@Nullable
                                                            String value)
```
    A name for the deployment group.
    If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment group name. For more information, see Name Type .
    
    If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
  - getDeploymentStyle
```
@Stability(value=Stable)
 @Nullable
public Object getDeploymentStyle()
```
    Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer.
    If you specify this property with a blue/green deployment type, don't specify the AutoScalingGroups , LoadBalancerInfo , or Deployment properties.
    
    For blue/green deployments, AWS CloudFormation supports deployments on Lambda compute platforms only. You can perform Amazon ECS blue/green deployments using AWS::CodeDeploy::BlueGreen hook. See Perform Amazon ECS blue/green deployments through CodeDeploy using AWS CloudFormation for more information.
  - setDeploymentStyle
```
@Stability(value=Stable)
public void setDeploymentStyle(@Nullable
                                                        IResolvable value)
```
    Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer.
    If you specify this property with a blue/green deployment type, don't specify the AutoScalingGroups , LoadBalancerInfo , or Deployment properties.
    
    For blue/green deployments, AWS CloudFormation supports deployments on Lambda compute platforms only. You can perform Amazon ECS blue/green deployments using AWS::CodeDeploy::BlueGreen hook. See Perform Amazon ECS blue/green deployments through CodeDeploy using AWS CloudFormation for more information.
  - setDeploymentStyle
```
@Stability(value=Stable)
public void setDeploymentStyle(@Nullable
                                                        CfnDeploymentGroup.DeploymentStyleProperty value)
```
    Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer.
    If you specify this property with a blue/green deployment type, don't specify the AutoScalingGroups , LoadBalancerInfo , or Deployment properties.
    
    For blue/green deployments, AWS CloudFormation supports deployments on Lambda compute platforms only. You can perform Amazon ECS blue/green deployments using AWS::CodeDeploy::BlueGreen hook. See Perform Amazon ECS blue/green deployments through CodeDeploy using AWS CloudFormation for more information.
  - getEc2TagFilters
```
@Stability(value=Stable)
 @Nullable
public Object getEc2TagFilters()
```
    The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group.
    CodeDeploy includes all Amazon EC2 instances identified by any of the tags you specify in this deployment group. Duplicates are not allowed.
    You can specify EC2TagFilters or Ec2TagSet , but not both.
  - setEc2TagFilters
```
@Stability(value=Stable)
public void setEc2TagFilters(@Nullable
                                                      IResolvable value)
```
    The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group.
    CodeDeploy includes all Amazon EC2 instances identified by any of the tags you specify in this deployment group. Duplicates are not allowed.
    You can specify EC2TagFilters or Ec2TagSet , but not both.
  - setEc2TagFilters
```
@Stability(value=Stable)
public void setEc2TagFilters(@Nullable
                                                      List<Object> value)
```
    The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group.
    CodeDeploy includes all Amazon EC2 instances identified by any of the tags you specify in this deployment group. Duplicates are not allowed.
    You can specify EC2TagFilters or Ec2TagSet , but not both.
  - getEc2TagSet
```
@Stability(value=Stable)
 @Nullable
public Object getEc2TagSet()
```
    Information about groups of tags applied to Amazon EC2 instances.
    The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilter .
  - setEc2TagSet
```
@Stability(value=Stable)
public void setEc2TagSet(@Nullable
                                                  IResolvable value)
```
    Information about groups of tags applied to Amazon EC2 instances.
    The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilter .
  - setEc2TagSet
```
@Stability(value=Stable)
public void setEc2TagSet(@Nullable
                                                  CfnDeploymentGroup.EC2TagSetProperty value)
```
    Information about groups of tags applied to Amazon EC2 instances.
    The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilter .
  - getEcsServices
```
@Stability(value=Stable)
 @Nullable
public Object getEcsServices()
```
    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> .
  - setEcsServices
```
@Stability(value=Stable)
public void setEcsServices(@Nullable
                                                    IResolvable value)
```
    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> .
  - setEcsServices
```
@Stability(value=Stable)
public void setEcsServices(@Nullable
                                                    List<Object> value)
```
    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> .
  - getLoadBalancerInfo
```
@Stability(value=Stable)
 @Nullable
public Object getLoadBalancerInfo()
```
    Information about the load balancer to use in a deployment.
    For more information, see Integrating CodeDeploy with Elastic Load Balancing in the AWS CodeDeploy User Guide .
  - setLoadBalancerInfo
```
@Stability(value=Stable)
public void setLoadBalancerInfo(@Nullable
                                                         IResolvable value)
```
    Information about the load balancer to use in a deployment.
    For more information, see Integrating CodeDeploy with Elastic Load Balancing in the AWS CodeDeploy User Guide .
  - setLoadBalancerInfo
```
@Stability(value=Stable)
public void setLoadBalancerInfo(@Nullable
                                                         CfnDeploymentGroup.LoadBalancerInfoProperty value)
```
    Information about the load balancer to use in a deployment.
    For more information, see Integrating CodeDeploy with Elastic Load Balancing in the AWS CodeDeploy User Guide .
  - getOnPremisesInstanceTagFilters
```
@Stability(value=Stable)
 @Nullable
public Object getOnPremisesInstanceTagFilters()
```
    The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group.
    CodeDeploy includes all on-premises instances identified by any of the tags you specify in this deployment group. To register on-premises instances with CodeDeploy , see Working with On-Premises Instances for CodeDeploy in the AWS CodeDeploy User Guide . Duplicates are not allowed.
    You can specify OnPremisesInstanceTagFilters or OnPremisesInstanceTagSet , but not both.
  - setOnPremisesInstanceTagFilters
```
@Stability(value=Stable)
public void setOnPremisesInstanceTagFilters(@Nullable
                                                                     IResolvable value)
```
    The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group.
    CodeDeploy includes all on-premises instances identified by any of the tags you specify in this deployment group. To register on-premises instances with CodeDeploy , see Working with On-Premises Instances for CodeDeploy in the AWS CodeDeploy User Guide . Duplicates are not allowed.
    You can specify OnPremisesInstanceTagFilters or OnPremisesInstanceTagSet , but not both.
  - setOnPremisesInstanceTagFilters
```
@Stability(value=Stable)
public void setOnPremisesInstanceTagFilters(@Nullable
                                                                     List<Object> value)
```
    The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group.
    CodeDeploy includes all on-premises instances identified by any of the tags you specify in this deployment group. To register on-premises instances with CodeDeploy , see Working with On-Premises Instances for CodeDeploy in the AWS CodeDeploy User Guide . Duplicates are not allowed.
    You can specify OnPremisesInstanceTagFilters or OnPremisesInstanceTagSet , but not both.
  - getOnPremisesTagSet
```
@Stability(value=Stable)
 @Nullable
public Object getOnPremisesTagSet()
```
    Information about groups of tags applied to on-premises instances.
    The deployment group includes only on-premises instances identified by all the tag groups.
    You can specify OnPremisesInstanceTagFilters or OnPremisesInstanceTagSet , but not both.
  - setOnPremisesTagSet
```
@Stability(value=Stable)
public void setOnPremisesTagSet(@Nullable
                                                         IResolvable value)
```
    Information about groups of tags applied to on-premises instances.
    The deployment group includes only on-premises instances identified by all the tag groups.
    You can specify OnPremisesInstanceTagFilters or OnPremisesInstanceTagSet , but not both.
  - setOnPremisesTagSet
```
@Stability(value=Stable)
public void setOnPremisesTagSet(@Nullable
                                                         CfnDeploymentGroup.OnPremisesTagSetProperty value)
```
    Information about groups of tags applied to on-premises instances.
    The deployment group includes only on-premises instances identified by all the tag groups.
    You can specify OnPremisesInstanceTagFilters or OnPremisesInstanceTagSet , but not both.
  - getOutdatedInstancesStrategy
```
@Stability(value=Stable)
 @Nullable
public String getOutdatedInstancesStrategy()
```
    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.
  - setOutdatedInstancesStrategy
```
@Stability(value=Stable)
public void setOutdatedInstancesStrategy(@Nullable
                                                                  String value)
```
    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.
  - getTriggerConfigurations
```
@Stability(value=Stable)
 @Nullable
public Object getTriggerConfigurations()
```
    Information about triggers associated with the deployment group.
    Duplicates are not allowed
  - setTriggerConfigurations
```
@Stability(value=Stable)
public void setTriggerConfigurations(@Nullable
                                                              IResolvable value)
```
    Information about triggers associated with the deployment group.
    Duplicates are not allowed
  - setTriggerConfigurations
```
@Stability(value=Stable)
public void setTriggerConfigurations(@Nullable
                                                              List<Object> value)
```
    Information about triggers associated with the deployment group.
    Duplicates are not allowed

Class CfnDeploymentGroup

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnDeploymentGroup

CfnDeploymentGroup

CfnDeploymentGroup

Method Detail

inspect

renderProperties

getCfnProperties

getTags

getApplicationName

setApplicationName

getServiceRoleArn

setServiceRoleArn

getAlarmConfiguration

setAlarmConfiguration

setAlarmConfiguration

getAutoRollbackConfiguration

setAutoRollbackConfiguration

setAutoRollbackConfiguration

getAutoScalingGroups

setAutoScalingGroups

getBlueGreenDeploymentConfiguration

setBlueGreenDeploymentConfiguration

setBlueGreenDeploymentConfiguration

getDeployment

setDeployment

setDeployment

getDeploymentConfigName

setDeploymentConfigName

getDeploymentGroupName

setDeploymentGroupName

getDeploymentStyle

setDeploymentStyle

setDeploymentStyle

getEc2TagFilters

setEc2TagFilters

setEc2TagFilters

getEc2TagSet

setEc2TagSet

setEc2TagSet

getEcsServices

setEcsServices

setEcsServices

getLoadBalancerInfo

setLoadBalancerInfo

setLoadBalancerInfo

getOnPremisesInstanceTagFilters

setOnPremisesInstanceTagFilters

setOnPremisesInstanceTagFilters

getOnPremisesTagSet

setOnPremisesTagSet

setOnPremisesTagSet

getOutdatedInstancesStrategy

setOutdatedInstancesStrategy

getTriggerConfigurations

setTriggerConfigurations

setTriggerConfigurations