Package software.amazon.awscdk.services.vpclattice

Interface CfnTargetGroup.TargetGroupConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTargetGroup.TargetGroupConfigProperty.Jsii$Proxy

Enclosing class:

CfnTargetGroup

@Stability(Stable)
public static interface CfnTargetGroup.TargetGroupConfigProperty
extends software.amazon.jsii.JsiiSerializable

Describes the configuration of a target group.

For more information, see Target groups in the Amazon VPC Lattice User Guide .

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.*;
 TargetGroupConfigProperty targetGroupConfigProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTargetGroup.TargetGroupConfigProperty.Builder	builder()
default Object	getHealthCheck()	The health check configuration.
default String	getIpAddressType()	The type of IP address used for the target group.
default String	getLambdaEventStructureVersion()	The version of the event structure that your Lambda function receives.
default Number	getPort()	The port on which the targets are listening.
default String	getProtocol()	The protocol to use for routing traffic to the targets.
default String	getProtocolVersion()	The protocol version.
default String	getVpcIdentifier()	The ID of the VPC.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHealthCheck

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

The health check configuration.

Not supported if the target group type is LAMBDA or ALB .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-targetgroupconfig.html#cfn-vpclattice-targetgroup-targetgroupconfig-healthcheck

getIpAddressType

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

The type of IP address used for the target group.

Supported only if the target group type is IP . The default is IPV4 .

Default: - "IPV4"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-targetgroupconfig.html#cfn-vpclattice-targetgroup-targetgroupconfig-ipaddresstype

getLambdaEventStructureVersion

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

The version of the event structure that your Lambda function receives.

Supported only if the target group type is LAMBDA . The default is V1 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-targetgroupconfig.html#cfn-vpclattice-targetgroup-targetgroupconfig-lambdaeventstructureversion

getPort

@Stability(Stable)
@Nullable
default Number getPort()

The port on which the targets are listening.

For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is LAMBDA .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-targetgroupconfig.html#cfn-vpclattice-targetgroup-targetgroupconfig-port

getProtocol

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

The protocol to use for routing traffic to the targets.

The default is the protocol of the target group. Not supported if the target group type is LAMBDA .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-targetgroupconfig.html#cfn-vpclattice-targetgroup-targetgroupconfig-protocol

getProtocolVersion

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

The protocol version.

The default is HTTP1 . Not supported if the target group type is LAMBDA .

Default: - "HTTP1"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-targetgroupconfig.html#cfn-vpclattice-targetgroup-targetgroupconfig-protocolversion

getVpcIdentifier

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

The ID of the VPC.

Not supported if the target group type is LAMBDA .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-targetgroup-targetgroupconfig.html#cfn-vpclattice-targetgroup-targetgroupconfig-vpcidentifier

builder

@Stability(Stable)
static CfnTargetGroup.TargetGroupConfigProperty.Builder builder()

Returns:

a CfnTargetGroup.TargetGroupConfigProperty.Builder of CfnTargetGroup.TargetGroupConfigProperty