2.168.0

class IpTarget

LanguageType name
.NETAmazon.CDK.AWS.ElasticLoadBalancingV2.Targets.IpTarget
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awselasticloadbalancingv2targets#IpTarget
Javasoftware.amazon.awscdk.services.elasticloadbalancingv2.targets.IpTarget
Pythonaws_cdk.aws_elasticloadbalancingv2_targets.IpTarget
TypeScript (source)aws-cdk-lib » aws_elasticloadbalancingv2_targets » IpTarget

Implements IApplicationLoadBalancerTarget, INetworkLoadBalancerTarget

An IP address that is a target for load balancing.

Specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.

If you register a target of this type, you are responsible for making sure the load balancer's security group can send packets to the IP address.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_elasticloadbalancingv2_targets as elasticloadbalancingv2_targets } from 'aws-cdk-lib';
const ipTarget = new elasticloadbalancingv2_targets.IpTarget('ipAddress', /* all optional props */ 123, /* all optional props */ 'availabilityZone');

Initializer

new IpTarget(ipAddress: string, port?: number, availabilityZone?: string)

Parameters

  • ipAddress string — The IP Address to load balance to.
  • port number — Override the group's default port.
  • availabilityZone string — Availability zone to send traffic from.

Create a new IPAddress target.

The availabilityZone parameter determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.

This parameter is not supported if the target type of the target group is instance. If the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.

With an Application Load Balancer, if the IP address is outside the VPC for the target group, the only supported value is all.

Default is automatic.

Methods

NameDescription
attachToApplicationTargetGroup(targetGroup)Register this instance target with a load balancer.
attachToNetworkTargetGroup(targetGroup)Register this instance target with a load balancer.

attachToApplicationTargetGroup(targetGroup)

public attachToApplicationTargetGroup(targetGroup: IApplicationTargetGroup): LoadBalancerTargetProps

Parameters

Returns

Register this instance target with a load balancer.

Don't call this, it is called automatically when you add the target to a load balancer.

attachToNetworkTargetGroup(targetGroup)

public attachToNetworkTargetGroup(targetGroup: INetworkTargetGroup): LoadBalancerTargetProps

Parameters

Returns

Register this instance target with a load balancer.

Don't call this, it is called automatically when you add the target to a load balancer.

← PreviousNext →