interface TargetGroupConfigProperty

Language	Type name
.NET	Amazon.CDK.AWS.VpcLattice.CfnTargetGroup.TargetGroupConfigProperty
Java	software.amazon.awscdk.services.vpclattice.CfnTargetGroup.TargetGroupConfigProperty
Python	aws_cdk.aws_vpclattice.CfnTargetGroup.TargetGroupConfigProperty
TypeScript	@aws-cdk/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 * as vpclattice from '@aws-cdk/aws-vpclattice';
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

Name	Type	Description
port	number	The port on which the targets are listening.
protocol	string	The protocol to use for routing traffic to the targets.
vpcIdentifier	string	The ID of the VPC.
healthCheck?	IResolvable | HealthCheckConfigProperty	The health check configuration.
ipAddressType?	string	The type of IP address used for the target group.
protocolVersion?	string	The 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 .