AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
aws-native.vpclattice.getTargetGroup
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service.
Using getTargetGroup
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getTargetGroup(args: GetTargetGroupArgs, opts?: InvokeOptions): Promise<GetTargetGroupResult>
function getTargetGroupOutput(args: GetTargetGroupOutputArgs, opts?: InvokeOptions): Output<GetTargetGroupResult>
def get_target_group(arn: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetTargetGroupResult
def get_target_group_output(arn: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetTargetGroupResult]
func LookupTargetGroup(ctx *Context, args *LookupTargetGroupArgs, opts ...InvokeOption) (*LookupTargetGroupResult, error)
func LookupTargetGroupOutput(ctx *Context, args *LookupTargetGroupOutputArgs, opts ...InvokeOption) LookupTargetGroupResultOutput
> Note: This function is named LookupTargetGroup
in the Go SDK.
public static class GetTargetGroup
{
public static Task<GetTargetGroupResult> InvokeAsync(GetTargetGroupArgs args, InvokeOptions? opts = null)
public static Output<GetTargetGroupResult> Invoke(GetTargetGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetTargetGroupResult> getTargetGroup(GetTargetGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:vpclattice:getTargetGroup
arguments:
# arguments dictionary
The following arguments are supported:
- Arn string
- The Amazon Resource Name (ARN) of the target group.
- Arn string
- The Amazon Resource Name (ARN) of the target group.
- arn String
- The Amazon Resource Name (ARN) of the target group.
- arn string
- The Amazon Resource Name (ARN) of the target group.
- arn str
- The Amazon Resource Name (ARN) of the target group.
- arn String
- The Amazon Resource Name (ARN) of the target group.
getTargetGroup Result
The following output properties are available:
- Arn string
- The Amazon Resource Name (ARN) of the target group.
- Config
Pulumi.
Aws Native. Vpc Lattice. Outputs. Target Group Config - The target group configuration.
- Created
At string - The date and time that the target group was created, specified in ISO-8601 format.
- Id string
- The ID of the target group.
- Last
Updated stringAt - The date and time that the target group was last updated, specified in ISO-8601 format.
- Status
Pulumi.
Aws Native. Vpc Lattice. Target Group Status - The operation's status. You can retry the operation if the status is
CREATE_FAILED
. However, if you retry it while the status isCREATE_IN_PROGRESS
, there is no change in the status. - List<Pulumi.
Aws Native. Outputs. Tag> - The tags for the target group.
- Targets
List<Pulumi.
Aws Native. Vpc Lattice. Outputs. Target Group Target> - Describes a target.
- Arn string
- The Amazon Resource Name (ARN) of the target group.
- Config
Target
Group Config - The target group configuration.
- Created
At string - The date and time that the target group was created, specified in ISO-8601 format.
- Id string
- The ID of the target group.
- Last
Updated stringAt - The date and time that the target group was last updated, specified in ISO-8601 format.
- Status
Target
Group Status - The operation's status. You can retry the operation if the status is
CREATE_FAILED
. However, if you retry it while the status isCREATE_IN_PROGRESS
, there is no change in the status. - Tag
- The tags for the target group.
- Targets
[]Target
Group Target - Describes a target.
- arn String
- The Amazon Resource Name (ARN) of the target group.
- config
Target
Group Config - The target group configuration.
- created
At String - The date and time that the target group was created, specified in ISO-8601 format.
- id String
- The ID of the target group.
- last
Updated StringAt - The date and time that the target group was last updated, specified in ISO-8601 format.
- status
Target
Group Status - The operation's status. You can retry the operation if the status is
CREATE_FAILED
. However, if you retry it while the status isCREATE_IN_PROGRESS
, there is no change in the status. - List<Tag>
- The tags for the target group.
- targets
List<Target
Group Target> - Describes a target.
- arn string
- The Amazon Resource Name (ARN) of the target group.
- config
Target
Group Config - The target group configuration.
- created
At string - The date and time that the target group was created, specified in ISO-8601 format.
- id string
- The ID of the target group.
- last
Updated stringAt - The date and time that the target group was last updated, specified in ISO-8601 format.
- status
Target
Group Status - The operation's status. You can retry the operation if the status is
CREATE_FAILED
. However, if you retry it while the status isCREATE_IN_PROGRESS
, there is no change in the status. - Tag[]
- The tags for the target group.
- targets
Target
Group Target[] - Describes a target.
- arn str
- The Amazon Resource Name (ARN) of the target group.
- config
Target
Group Config - The target group configuration.
- created_
at str - The date and time that the target group was created, specified in ISO-8601 format.
- id str
- The ID of the target group.
- last_
updated_ strat - The date and time that the target group was last updated, specified in ISO-8601 format.
- status
Target
Group Status - The operation's status. You can retry the operation if the status is
CREATE_FAILED
. However, if you retry it while the status isCREATE_IN_PROGRESS
, there is no change in the status. - Sequence[root_Tag]
- The tags for the target group.
- targets
Sequence[Target
Group Target] - Describes a target.
- arn String
- The Amazon Resource Name (ARN) of the target group.
- config Property Map
- The target group configuration.
- created
At String - The date and time that the target group was created, specified in ISO-8601 format.
- id String
- The ID of the target group.
- last
Updated StringAt - The date and time that the target group was last updated, specified in ISO-8601 format.
- status "CREATE_IN_PROGRESS" | "ACTIVE" | "DELETE_IN_PROGRESS" | "CREATE_FAILED" | "DELETE_FAILED"
- The operation's status. You can retry the operation if the status is
CREATE_FAILED
. However, if you retry it while the status isCREATE_IN_PROGRESS
, there is no change in the status. - List<Property Map>
- The tags for the target group.
- targets List<Property Map>
- Describes a target.
Supporting Types
Tag
TargetGroupConfig
- Health
Check Pulumi.Aws Native. Vpc Lattice. Inputs. Target Group Health Check Config - The health check configuration. Not supported if the target group type is
LAMBDA
orALB
. - Ip
Address Pulumi.Type Aws Native. Vpc Lattice. Target Group Config Ip Address Type - The type of IP address used for the target group. Supported only if the target group type is
IP
. The default isIPV4
. - Lambda
Event Pulumi.Structure Version Aws Native. Vpc Lattice. Target Group Config Lambda Event Structure Version - The version of the event structure that your Lambda function receives. Supported only if the target group type is
LAMBDA
. The default isV1
. - Port int
- The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is
LAMBDA
. - Protocol
Pulumi.
Aws Native. Vpc Lattice. Target Group Config Protocol - The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is
LAMBDA
. - Protocol
Version Pulumi.Aws Native. Vpc Lattice. Target Group Config Protocol Version - The protocol version. The default is
HTTP1
. Not supported if the target group type isLAMBDA
. - Vpc
Identifier string - The ID of the VPC. Not supported if the target group type is
LAMBDA
.
- Health
Check TargetGroup Health Check Config - The health check configuration. Not supported if the target group type is
LAMBDA
orALB
. - Ip
Address TargetType Group Config Ip Address Type - The type of IP address used for the target group. Supported only if the target group type is
IP
. The default isIPV4
. - Lambda
Event TargetStructure Version Group Config Lambda Event Structure Version - The version of the event structure that your Lambda function receives. Supported only if the target group type is
LAMBDA
. The default isV1
. - Port int
- The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is
LAMBDA
. - Protocol
Target
Group Config Protocol - The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is
LAMBDA
. - Protocol
Version TargetGroup Config Protocol Version - The protocol version. The default is
HTTP1
. Not supported if the target group type isLAMBDA
. - Vpc
Identifier string - The ID of the VPC. Not supported if the target group type is
LAMBDA
.
- health
Check TargetGroup Health Check Config - The health check configuration. Not supported if the target group type is
LAMBDA
orALB
. - ip
Address TargetType Group Config Ip Address Type - The type of IP address used for the target group. Supported only if the target group type is
IP
. The default isIPV4
. - lambda
Event TargetStructure Version Group Config Lambda Event Structure Version - The version of the event structure that your Lambda function receives. Supported only if the target group type is
LAMBDA
. The default isV1
. - port Integer
- The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is
LAMBDA
. - protocol
Target
Group Config Protocol - The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is
LAMBDA
. - protocol
Version TargetGroup Config Protocol Version - The protocol version. The default is
HTTP1
. Not supported if the target group type isLAMBDA
. - vpc
Identifier String - The ID of the VPC. Not supported if the target group type is
LAMBDA
.
- health
Check TargetGroup Health Check Config - The health check configuration. Not supported if the target group type is
LAMBDA
orALB
. - ip
Address TargetType Group Config Ip Address Type - The type of IP address used for the target group. Supported only if the target group type is
IP
. The default isIPV4
. - lambda
Event TargetStructure Version Group Config Lambda Event Structure Version - The version of the event structure that your Lambda function receives. Supported only if the target group type is
LAMBDA
. The default isV1
. - port number
- The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is
LAMBDA
. - protocol
Target
Group Config Protocol - The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is
LAMBDA
. - protocol
Version TargetGroup Config Protocol Version - The protocol version. The default is
HTTP1
. Not supported if the target group type isLAMBDA
. - vpc
Identifier string - The ID of the VPC. Not supported if the target group type is
LAMBDA
.
- health_
check TargetGroup Health Check Config - The health check configuration. Not supported if the target group type is
LAMBDA
orALB
. - ip_
address_ Targettype Group Config Ip Address Type - The type of IP address used for the target group. Supported only if the target group type is
IP
. The default isIPV4
. - lambda_
event_ Targetstructure_ version Group Config Lambda Event Structure Version - The version of the event structure that your Lambda function receives. Supported only if the target group type is
LAMBDA
. The default isV1
. - port int
- The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is
LAMBDA
. - protocol
Target
Group Config Protocol - The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is
LAMBDA
. - protocol_
version TargetGroup Config Protocol Version - The protocol version. The default is
HTTP1
. Not supported if the target group type isLAMBDA
. - vpc_
identifier str - The ID of the VPC. Not supported if the target group type is
LAMBDA
.
- health
Check Property Map - The health check configuration. Not supported if the target group type is
LAMBDA
orALB
. - ip
Address "IPV4" | "IPV6"Type - The type of IP address used for the target group. Supported only if the target group type is
IP
. The default isIPV4
. - lambda
Event "V1" | "V2"Structure Version - The version of the event structure that your Lambda function receives. Supported only if the target group type is
LAMBDA
. The default isV1
. - port Number
- The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is
LAMBDA
. - protocol "HTTP" | "HTTPS" | "TCP"
- The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is
LAMBDA
. - protocol
Version "HTTP1" | "HTTP2" | "GRPC" - The protocol version. The default is
HTTP1
. Not supported if the target group type isLAMBDA
. - vpc
Identifier String - The ID of the VPC. Not supported if the target group type is
LAMBDA
.
TargetGroupConfigIpAddressType
TargetGroupConfigLambdaEventStructureVersion
TargetGroupConfigProtocol
TargetGroupConfigProtocolVersion
TargetGroupHealthCheckConfig
- Enabled bool
- Indicates whether health checking is enabled.
- Health
Check intInterval Seconds - The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.
- Health
Check intTimeout Seconds - The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.
- Healthy
Threshold intCount - The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.
- Matcher
Pulumi.
Aws Native. Vpc Lattice. Inputs. Target Group Matcher - The codes to use when checking for a successful response from a target.
- Path string
- The destination for health checks on the targets. If the protocol version is
HTTP/1.1
orHTTP/2
, specify a valid URI (for example,/path?query
). The default path is/
. Health checks are not supported if the protocol version isgRPC
, however, you can chooseHTTP/1.1
orHTTP/2
and specify a valid URI. - Port int
- The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.
- Protocol
Pulumi.
Aws Native. Vpc Lattice. Target Group Health Check Config Protocol - The protocol used when performing health checks on targets. The possible protocols are
HTTP
andHTTPS
. The default isHTTP
. - Protocol
Version Pulumi.Aws Native. Vpc Lattice. Target Group Health Check Config Protocol Version - The protocol version used when performing health checks on targets. The possible protocol versions are
HTTP1
andHTTP2
. - Unhealthy
Threshold intCount - The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.
- Enabled bool
- Indicates whether health checking is enabled.
- Health
Check intInterval Seconds - The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.
- Health
Check intTimeout Seconds - The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.
- Healthy
Threshold intCount - The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.
- Matcher
Target
Group Matcher - The codes to use when checking for a successful response from a target.
- Path string
- The destination for health checks on the targets. If the protocol version is
HTTP/1.1
orHTTP/2
, specify a valid URI (for example,/path?query
). The default path is/
. Health checks are not supported if the protocol version isgRPC
, however, you can chooseHTTP/1.1
orHTTP/2
and specify a valid URI. - Port int
- The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.
- Protocol
Target
Group Health Check Config Protocol - The protocol used when performing health checks on targets. The possible protocols are
HTTP
andHTTPS
. The default isHTTP
. - Protocol
Version TargetGroup Health Check Config Protocol Version - The protocol version used when performing health checks on targets. The possible protocol versions are
HTTP1
andHTTP2
. - Unhealthy
Threshold intCount - The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.
- enabled Boolean
- Indicates whether health checking is enabled.
- health
Check IntegerInterval Seconds - The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.
- health
Check IntegerTimeout Seconds - The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.
- healthy
Threshold IntegerCount - The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.
- matcher
Target
Group Matcher - The codes to use when checking for a successful response from a target.
- path String
- The destination for health checks on the targets. If the protocol version is
HTTP/1.1
orHTTP/2
, specify a valid URI (for example,/path?query
). The default path is/
. Health checks are not supported if the protocol version isgRPC
, however, you can chooseHTTP/1.1
orHTTP/2
and specify a valid URI. - port Integer
- The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.
- protocol
Target
Group Health Check Config Protocol - The protocol used when performing health checks on targets. The possible protocols are
HTTP
andHTTPS
. The default isHTTP
. - protocol
Version TargetGroup Health Check Config Protocol Version - The protocol version used when performing health checks on targets. The possible protocol versions are
HTTP1
andHTTP2
. - unhealthy
Threshold IntegerCount - The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.
- enabled boolean
- Indicates whether health checking is enabled.
- health
Check numberInterval Seconds - The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.
- health
Check numberTimeout Seconds - The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.
- healthy
Threshold numberCount - The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.
- matcher
Target
Group Matcher - The codes to use when checking for a successful response from a target.
- path string
- The destination for health checks on the targets. If the protocol version is
HTTP/1.1
orHTTP/2
, specify a valid URI (for example,/path?query
). The default path is/
. Health checks are not supported if the protocol version isgRPC
, however, you can chooseHTTP/1.1
orHTTP/2
and specify a valid URI. - port number
- The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.
- protocol
Target
Group Health Check Config Protocol - The protocol used when performing health checks on targets. The possible protocols are
HTTP
andHTTPS
. The default isHTTP
. - protocol
Version TargetGroup Health Check Config Protocol Version - The protocol version used when performing health checks on targets. The possible protocol versions are
HTTP1
andHTTP2
. - unhealthy
Threshold numberCount - The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.
- enabled bool
- Indicates whether health checking is enabled.
- health_
check_ intinterval_ seconds - The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.
- health_
check_ inttimeout_ seconds - The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.
- healthy_
threshold_ intcount - The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.
- matcher
Target
Group Matcher - The codes to use when checking for a successful response from a target.
- path str
- The destination for health checks on the targets. If the protocol version is
HTTP/1.1
orHTTP/2
, specify a valid URI (for example,/path?query
). The default path is/
. Health checks are not supported if the protocol version isgRPC
, however, you can chooseHTTP/1.1
orHTTP/2
and specify a valid URI. - port int
- The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.
- protocol
Target
Group Health Check Config Protocol - The protocol used when performing health checks on targets. The possible protocols are
HTTP
andHTTPS
. The default isHTTP
. - protocol_
version TargetGroup Health Check Config Protocol Version - The protocol version used when performing health checks on targets. The possible protocol versions are
HTTP1
andHTTP2
. - unhealthy_
threshold_ intcount - The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.
- enabled Boolean
- Indicates whether health checking is enabled.
- health
Check NumberInterval Seconds - The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.
- health
Check NumberTimeout Seconds - The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.
- healthy
Threshold NumberCount - The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.
- matcher Property Map
- The codes to use when checking for a successful response from a target.
- path String
- The destination for health checks on the targets. If the protocol version is
HTTP/1.1
orHTTP/2
, specify a valid URI (for example,/path?query
). The default path is/
. Health checks are not supported if the protocol version isgRPC
, however, you can chooseHTTP/1.1
orHTTP/2
and specify a valid URI. - port Number
- The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.
- protocol "HTTP" | "HTTPS"
- The protocol used when performing health checks on targets. The possible protocols are
HTTP
andHTTPS
. The default isHTTP
. - protocol
Version "HTTP1" | "HTTP2" - The protocol version used when performing health checks on targets. The possible protocol versions are
HTTP1
andHTTP2
. - unhealthy
Threshold NumberCount - The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.
TargetGroupHealthCheckConfigProtocol
TargetGroupHealthCheckConfigProtocolVersion
TargetGroupMatcher
- Http
Code string - The HTTP code to use when checking for a successful response from a target.
- Http
Code string - The HTTP code to use when checking for a successful response from a target.
- http
Code String - The HTTP code to use when checking for a successful response from a target.
- http
Code string - The HTTP code to use when checking for a successful response from a target.
- http_
code str - The HTTP code to use when checking for a successful response from a target.
- http
Code String - The HTTP code to use when checking for a successful response from a target.
TargetGroupStatus
TargetGroupTarget
- Id string
- The ID of the target. If the target group type is
INSTANCE
, this is an instance ID. If the target group type isIP
, this is an IP address. If the target group type isLAMBDA
, this is the ARN of a Lambda function. If the target group type isALB
, this is the ARN of an Application Load Balancer. - Port int
- The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443.
- Id string
- The ID of the target. If the target group type is
INSTANCE
, this is an instance ID. If the target group type isIP
, this is an IP address. If the target group type isLAMBDA
, this is the ARN of a Lambda function. If the target group type isALB
, this is the ARN of an Application Load Balancer. - Port int
- The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443.
- id String
- The ID of the target. If the target group type is
INSTANCE
, this is an instance ID. If the target group type isIP
, this is an IP address. If the target group type isLAMBDA
, this is the ARN of a Lambda function. If the target group type isALB
, this is the ARN of an Application Load Balancer. - port Integer
- The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443.
- id string
- The ID of the target. If the target group type is
INSTANCE
, this is an instance ID. If the target group type isIP
, this is an IP address. If the target group type isLAMBDA
, this is the ARN of a Lambda function. If the target group type isALB
, this is the ARN of an Application Load Balancer. - port number
- The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443.
- id str
- The ID of the target. If the target group type is
INSTANCE
, this is an instance ID. If the target group type isIP
, this is an IP address. If the target group type isLAMBDA
, this is the ARN of a Lambda function. If the target group type isALB
, this is the ARN of an Application Load Balancer. - port int
- The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443.
- id String
- The ID of the target. If the target group type is
INSTANCE
, this is an instance ID. If the target group type isIP
, this is an IP address. If the target group type isLAMBDA
, this is the ARN of a Lambda function. If the target group type isALB
, this is the ARN of an Application Load Balancer. - port Number
- The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi