software.amazon.awscdk.services.codedeploy

Interface CfnDeploymentGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeploymentGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.72.0 (build 4b8828b)",
           date="2022-12-21T20:28:58.713Z")
 @Stability(value=Stable)
public interface CfnDeploymentGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnDeploymentGroup`.

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.*;
 CfnDeploymentGroupProps cfnDeploymentGroupProps = CfnDeploymentGroupProps.builder()
         .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	Interface and Description
static class	CfnDeploymentGroupProps.Builder A builder for CfnDeploymentGroupProps
static class	CfnDeploymentGroupProps.Jsii$Proxy An implementation for CfnDeploymentGroupProps

Method Summary

Modifier and Type	Method and Description
static CfnDeploymentGroupProps.Builder	builder()
default 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.
default Object	getAutoRollbackConfiguration() Information about the automatic rollback configuration that is associated with the deployment group.
default List<String>	getAutoScalingGroups() A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created.
default Object	getBlueGreenDeploymentConfiguration() Information about blue/green deployment options for a deployment group.
default Object	getDeployment() The application revision to deploy to this deployment group.
default String	getDeploymentConfigName() A deployment configuration name or a predefined configuration name.
default String	getDeploymentGroupName() A name for the deployment group.
default Object	getDeploymentStyle() Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer.
default Object	getEc2TagFilters() The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group.
default Object	getEc2TagSet() Information about groups of tags applied to Amazon EC2 instances.
default Object	getEcsServices() The target Amazon ECS services in the deployment group.
default Object	getLoadBalancerInfo() Information about the load balancer to use in a deployment.
default Object	getOnPremisesInstanceTagFilters() The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group.
default Object	getOnPremisesTagSet() Information about groups of tags applied to on-premises instances.
default 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.
default List<CfnTag>	getTags() The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them.
default Object	getTriggerConfigurations() Information about triggers associated with the deployment group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApplicationName

@Stability(value=Stable)
 @NotNull
String getApplicationName()

The name of an existing CodeDeploy application to associate this deployment group with.

getServiceRoleArn

@Stability(value=Stable)
 @NotNull
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 .

getAlarmConfiguration

@Stability(value=Stable)
 @Nullable
default Object getAlarmConfiguration()

Information about the Amazon CloudWatch alarms that are associated with the deployment group.

getAutoRollbackConfiguration

@Stability(value=Stable)
 @Nullable
default 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.

getAutoScalingGroups

@Stability(value=Stable)
 @Nullable
default 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.

getBlueGreenDeploymentConfiguration

@Stability(value=Stable)
 @Nullable
default Object getBlueGreenDeploymentConfiguration()

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

getDeployment

@Stability(value=Stable)
 @Nullable
default 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.

getDeploymentConfigName

@Stability(value=Stable)
 @Nullable
default 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 .

getDeploymentGroupName

@Stability(value=Stable)
 @Nullable
default 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.

getDeploymentStyle

@Stability(value=Stable)
 @Nullable
default 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.

getEc2TagFilters

@Stability(value=Stable)
 @Nullable
default 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.

getEc2TagSet

@Stability(value=Stable)
 @Nullable
default 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 .

getEcsServices

@Stability(value=Stable)
 @Nullable
default 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> .

getLoadBalancerInfo

@Stability(value=Stable)
 @Nullable
default 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 .

getOnPremisesInstanceTagFilters

@Stability(value=Stable)
 @Nullable
default 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.

getOnPremisesTagSet

@Stability(value=Stable)
 @Nullable
default 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.

getOutdatedInstancesStrategy

@Stability(value=Stable)
 @Nullable
default 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.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> 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.

getTriggerConfigurations

@Stability(value=Stable)
 @Nullable
default Object getTriggerConfigurations()

Information about triggers associated with the deployment group.

Duplicates are not allowed

builder

@Stability(value=Stable)
static CfnDeploymentGroupProps.Builder builder()

Returns:

a CfnDeploymentGroupProps.Builder of CfnDeploymentGroupProps