aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.TargetGroupInfoProperty

TargetGroupInfoProperty Struct

The TargetGroupInfo property type specifies information about a target group in Elastic Load Balancing to use in a deployment.

Instances are registered as targets in a target group, and traffic is routed to the target group. For more information, see TargetGroupInfo in the AWS CodeDeploy API Reference

If you specify the TargetGroupInfo property, the DeploymentStyle.DeploymentOption property must be set to WITH_TRAFFIC_CONTROL for CodeDeploy to route your traffic using the specified target groups.

TargetGroupInfo is a property of the LoadBalancerInfo property type.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codedeploy as codedeploy } from 'aws-cdk-lib';
const targetGroupInfoProperty: codedeploy.CfnDeploymentGroup.TargetGroupInfoProperty = {
  name: 'name',
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_codedeploy as codedeploy

target_group_info_property = codedeploy.CfnDeploymentGroup.TargetGroupInfoProperty(
    name="name"
)

// 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.*;

TargetGroupInfoProperty targetGroupInfoProperty = TargetGroupInfoProperty.builder()
        .name("name")
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// 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 targetGroupInfoProperty = new TargetGroupInfoProperty {
    Name = "name"
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

targetGroupInfoProperty := &TargetGroupInfoProperty{
	Name: jsii.String("name"),
}

Properties

name?optionalstringname?optionalstrname?optionalStringName?optionalstringName?optional*string#

For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment registered with.

notes

For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment completes. No duplicates allowed.

CloudFormation supports blue/green deployments on AWS Lambda compute platforms only.

This value cannot exceed 32 characters, so you should use the Name property of the target group, or the TargetGroupName attribute with the Fn::GetAtt intrinsic function, as shown in the following example. Don't use the group's Amazon Resource Name (ARN) or TargetGroupFullName attribute.