/AWS1/CL_EL2TARGETDESCRIPTION¶
Information about a target.
CONSTRUCTOR
¶
IMPORTING¶
Required arguments:¶
IV_ID
TYPE /AWS1/EL2TARGETID
/AWS1/EL2TARGETID
¶
The ID of the target. If the target type of the target group is
instance
, specify an instance ID. If the target type isip
, specify an IP address. If the target type islambda
, specify the ARN of the Lambda function. If the target type isalb
, specify the ARN of the Application Load Balancer target.
Optional arguments:¶
IV_PORT
TYPE /AWS1/EL2PORT
/AWS1/EL2PORT
¶
The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is
alb
, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. This parameter is not used if the target is a Lambda function.
IV_AVAILABILITYZONE
TYPE /AWS1/EL2ZONENAME
/AWS1/EL2ZONENAME
¶
An Availability Zone or
all
. This 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.For Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross-zone load balancing is off. Otherwise the parameter is ignored and treated as
all
.This parameter is not supported if the target type of the target group is
instance
oralb
.If the target type is
ip
and 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.For Application Load Balancer target groups with cross-zone load balancing off, if the target type is
ip
and the IP address is outside of the VPC for the target group, this should be an Availability Zone inside the VPC for the target group.If the target type is
lambda
, this parameter is optional and the only supported value isall
.
Queryable Attributes¶
Id¶
The ID of the target. If the target type of the target group is
instance
, specify an instance ID. If the target type isip
, specify an IP address. If the target type islambda
, specify the ARN of the Lambda function. If the target type isalb
, specify the ARN of the Application Load Balancer target.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ID() |
Getter for ID, with configurable default |
ASK_ID() |
Getter for ID w/ exceptions if field has no value |
HAS_ID() |
Determine if ID has a value |
Port¶
The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is
alb
, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. This parameter is not used if the target is a Lambda function.
Accessible with the following methods¶
Method | Description |
---|---|
GET_PORT() |
Getter for PORT, with configurable default |
ASK_PORT() |
Getter for PORT w/ exceptions if field has no value |
HAS_PORT() |
Determine if PORT has a value |
AvailabilityZone¶
An Availability Zone or
all
. This 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.For Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross-zone load balancing is off. Otherwise the parameter is ignored and treated as
all
.This parameter is not supported if the target type of the target group is
instance
oralb
.If the target type is
ip
and 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.For Application Load Balancer target groups with cross-zone load balancing off, if the target type is
ip
and the IP address is outside of the VPC for the target group, this should be an Availability Zone inside the VPC for the target group.If the target type is
lambda
, this parameter is optional and the only supported value isall
.
Accessible with the following methods¶
Method | Description |
---|---|
GET_AVAILABILITYZONE() |
Getter for AVAILABILITYZONE, with configurable default |
ASK_AVAILABILITYZONE() |
Getter for AVAILABILITYZONE w/ exceptions if field has no va |
HAS_AVAILABILITYZONE() |
Determine if AVAILABILITYZONE has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_TARGETDESCRIPTIONS
¶
TYPES TT_TARGETDESCRIPTIONS TYPE STANDARD TABLE OF REF TO /AWS1/CL_EL2TARGETDESCRIPTION WITH DEFAULT KEY
.