aws-cdk-lib.aws_vpclattice.CfnTargetGroup.TargetGroupConfigProperty

interface TargetGroupConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.VpcLattice.CfnTargetGroup.TargetGroupConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsvpclattice#CfnTargetGroup_TargetGroupConfigProperty
Javasoftware.amazon.awscdk.services.vpclattice.CfnTargetGroup.TargetGroupConfigProperty
Pythonaws_cdk.aws_vpclattice.CfnTargetGroup.TargetGroupConfigProperty
TypeScript aws-cdk-lib » aws_vpclattice » CfnTargetGroup » TargetGroupConfigProperty

Describes the configuration of a target group.

Lambda functions don't support target group configuration.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_vpclattice as vpclattice } from 'aws-cdk-lib';
const targetGroupConfigProperty: vpclattice.CfnTargetGroup.TargetGroupConfigProperty = {
  port: 123,
  protocol: 'protocol',
  vpcIdentifier: 'vpcIdentifier',

  // the properties below are optional
  healthCheck: {
    enabled: false,
    healthCheckIntervalSeconds: 123,
    healthCheckTimeoutSeconds: 123,
    healthyThresholdCount: 123,
    matcher: {
      httpCode: 'httpCode',
    },
    path: 'path',
    port: 123,
    protocol: 'protocol',
    protocolVersion: 'protocolVersion',
    unhealthyThresholdCount: 123,
  },
  ipAddressType: 'ipAddressType',
  protocolVersion: 'protocolVersion',
};

Properties

NameTypeDescription
portnumberThe port on which the targets are listening.
protocolstringThe protocol to use for routing traffic to the targets.
vpcIdentifierstringThe ID of the VPC.
healthCheck?IResolvable | HealthCheckConfigPropertyThe health check configuration.
ipAddressType?stringThe type of IP address used for the target group.
protocolVersion?stringThe protocol version.

port

Type: number

The port on which the targets are listening.

For HTTP, the default is 80 . For HTTPS, the default is 443


protocol

Type: string

The protocol to use for routing traffic to the targets.

Default is the protocol of a target group.


vpcIdentifier

Type: string

The ID of the VPC.


healthCheck?

Type: IResolvable | HealthCheckConfigProperty (optional)

The health check configuration.


ipAddressType?

Type: string (optional)

The type of IP address used for the target group.

The possible values are ipv4 and ipv6 . This is an optional parameter. If not specified, the IP address type defaults to ipv4 .


protocolVersion?

Type: string (optional)

The protocol version.

Default value is HTTP1 .