software.amazon.awscdk.services.elasticloadbalancingv2.targets

Class IpTarget

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.elasticloadbalancingv2.targets.IpTarget

All Implemented Interfaces:

IApplicationLoadBalancerTarget, INetworkLoadBalancerTarget

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:51.680Z")
public class IpTarget
extends software.amazon.jsii.JsiiObject
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 software.amazon.awscdk.services.elasticloadbalancingv2.targets.*;
 IpTarget ipTarget = new IpTarget("ipAddress", 123, "availabilityZone");
 

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.IApplicationLoadBalancerTarget

IApplicationLoadBalancerTarget.Jsii$Default, IApplicationLoadBalancerTarget.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.INetworkLoadBalancerTarget

INetworkLoadBalancerTarget.Jsii$Default, INetworkLoadBalancerTarget.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IpTarget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	IpTarget(software.amazon.jsii.JsiiObjectRef objRef)
	IpTarget(java.lang.String ipAddress, java.lang.Number port) Create a new IPAddress target.
	IpTarget(java.lang.String ipAddress, java.lang.Number port, java.lang.String availabilityZone) Create a new IPAddress target.

Method Summary

Modifier and Type	Method and Description
LoadBalancerTargetProps	attachToApplicationTargetGroup(IApplicationTargetGroup targetGroup) Register this instance target with a load balancer.
LoadBalancerTargetProps	attachToNetworkTargetGroup(INetworkTargetGroup targetGroup) Register this instance target with a load balancer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IpTarget

protected IpTarget(software.amazon.jsii.JsiiObjectRef objRef)

IpTarget

protected IpTarget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

IpTarget

public IpTarget(java.lang.String ipAddress,
                java.lang.Number port,
                java.lang.String availabilityZone)

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.

Parameters:

ipAddress - The IP Address to load balance to. This parameter is required.

port - Override the group's default port.

availabilityZone - Availability zone to send traffic from.

IpTarget

public IpTarget(java.lang.String ipAddress,
                java.lang.Number port)

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.

Parameters:

ipAddress - The IP Address to load balance to. This parameter is required.

port - Override the group's default port.

Method Detail

attachToApplicationTargetGroup

public LoadBalancerTargetProps attachToApplicationTargetGroup(IApplicationTargetGroup targetGroup)

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.

Specified by:

attachToApplicationTargetGroup in interface IApplicationLoadBalancerTarget

Parameters:

targetGroup - This parameter is required.

attachToNetworkTargetGroup

public LoadBalancerTargetProps attachToNetworkTargetGroup(INetworkTargetGroup targetGroup)

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.

Specified by:

attachToNetworkTargetGroup in interface INetworkLoadBalancerTarget

Parameters:

targetGroup - This parameter is required.