Package software.amazon.awscdk.services.vpclattice

Interface CfnTargetGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTargetGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:47.149Z")
@Stability(Stable)
public interface CfnTargetGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTargetGroup.

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.vpclattice.*;
 CfnTargetGroupProps cfnTargetGroupProps = CfnTargetGroupProps.builder()
         .type("type")
         // the properties below are optional
         .config(TargetGroupConfigProperty.builder()
                 .healthCheck(HealthCheckConfigProperty.builder()
                         .enabled(false)
                         .healthCheckIntervalSeconds(123)
                         .healthCheckTimeoutSeconds(123)
                         .healthyThresholdCount(123)
                         .matcher(MatcherProperty.builder()
                                 .httpCode("httpCode")
                                 .build())
                         .path("path")
                         .port(123)
                         .protocol("protocol")
                         .protocolVersion("protocolVersion")
                         .unhealthyThresholdCount(123)
                         .build())
                 .ipAddressType("ipAddressType")
                 .lambdaEventStructureVersion("lambdaEventStructureVersion")
                 .port(123)
                 .protocol("protocol")
                 .protocolVersion("protocolVersion")
                 .vpcIdentifier("vpcIdentifier")
                 .build())
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targets(List.of(TargetProperty.builder()
                 .id("id")
                 // the properties below are optional
                 .port(123)
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-targetgroup.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTargetGroupProps.Builder	builder()
default Object	getConfig()	The target group configuration.
default String	getName()	The name of the target group.
default List<CfnTag>	getTags()	The tags for the target group.
default Object	getTargets()	Describes a target.
String	getType()	The type of target group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
String getType()

The type of target group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-targetgroup.html#cfn-vpclattice-targetgroup-type

getConfig

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

The target group configuration.

Returns union: either IResolvable or CfnTargetGroup.TargetGroupConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-targetgroup.html#cfn-vpclattice-targetgroup-config

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the target group.

The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

If you don't specify a name, CloudFormation generates one. However, if you specify a name, and later want to replace the resource, you must specify a new name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-targetgroup.html#cfn-vpclattice-targetgroup-name

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags for the target group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-targetgroup.html#cfn-vpclattice-targetgroup-tags

getTargets

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

Describes a target.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTargetGroup.TargetProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-targetgroup.html#cfn-vpclattice-targetgroup-targets

builder

@Stability(Stable)
static CfnTargetGroupProps.Builder builder()

Returns:

a CfnTargetGroupProps.Builder of CfnTargetGroupProps