Package software.amazon.awscdk.services.codedeploy

Interface CfnDeploymentGroup.TargetGroupPairInfoProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeploymentGroup.TargetGroupPairInfoProperty.Jsii$Proxy

Enclosing class:

CfnDeploymentGroup

@Stability(Stable)
public static interface CfnDeploymentGroup.TargetGroupPairInfoProperty
extends software.amazon.jsii.JsiiSerializable

Information about two target groups and how traffic is routed during an Amazon ECS deployment.

An optional test traffic route can be specified.

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.*;
 TargetGroupPairInfoProperty targetGroupPairInfoProperty = 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgrouppairinfo.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeploymentGroup.TargetGroupPairInfoProperty.Builder	A builder for CfnDeploymentGroup.TargetGroupPairInfoProperty
static final class	CfnDeploymentGroup.TargetGroupPairInfoProperty.Jsii$Proxy	An implementation for CfnDeploymentGroup.TargetGroupPairInfoProperty

Method Summary

Modifier and Type	Method	Description
static CfnDeploymentGroup.TargetGroupPairInfoProperty.Builder	builder()
default Object	getProdTrafficRoute()	The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.
default Object	getTargetGroups()	One pair of target groups.
default Object	getTestTrafficRoute()	An optional path used by a load balancer to route test traffic after an Amazon ECS deployment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getProdTrafficRoute

@Stability(Stable)
@Nullable
default Object getProdTrafficRoute()

The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.

Returns union: either IResolvable or CfnDeploymentGroup.TrafficRouteProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgrouppairinfo.html#cfn-codedeploy-deploymentgroup-targetgrouppairinfo-prodtrafficroute

getTargetGroups

@Stability(Stable)
@Nullable
default Object getTargetGroups()

One pair of target groups.

One is associated with the original task set. The second is associated with the task set that serves traffic after the deployment is complete.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDeploymentGroup.TargetGroupInfoProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgrouppairinfo.html#cfn-codedeploy-deploymentgroup-targetgrouppairinfo-targetgroups

getTestTrafficRoute

@Stability(Stable)
@Nullable
default Object getTestTrafficRoute()

An optional path used by a load balancer to route test traffic after an Amazon ECS deployment.

Validation can occur while test traffic is served during a deployment.

Returns union: either IResolvable or CfnDeploymentGroup.TrafficRouteProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgrouppairinfo.html#cfn-codedeploy-deploymentgroup-targetgrouppairinfo-testtrafficroute

builder

@Stability(Stable)
static CfnDeploymentGroup.TargetGroupPairInfoProperty.Builder builder()

Returns:

a CfnDeploymentGroup.TargetGroupPairInfoProperty.Builder of CfnDeploymentGroup.TargetGroupPairInfoProperty