1. Packages
  2. AWS Native
  3. API Docs
  4. elasticloadbalancingv2
  5. getTargetGroup

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.98.0 published on Thursday, Feb 29, 2024 by Pulumi

aws-native.elasticloadbalancingv2.getTargetGroup

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.98.0 published on Thursday, Feb 29, 2024 by Pulumi

    Resource Type definition for AWS::ElasticLoadBalancingV2::TargetGroup

    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(target_group_arn: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetTargetGroupResult
    def get_target_group_output(target_group_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:elasticloadbalancingv2:getTargetGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    TargetGroupArn string
    The ARN of the Target Group
    TargetGroupArn string
    The ARN of the Target Group
    targetGroupArn String
    The ARN of the Target Group
    targetGroupArn string
    The ARN of the Target Group
    target_group_arn str
    The ARN of the Target Group
    targetGroupArn String
    The ARN of the Target Group

    getTargetGroup Result

    The following output properties are available:

    HealthCheckEnabled bool
    Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled.
    HealthCheckIntervalSeconds int
    The approximate amount of time, in seconds, between health checks of an individual target.
    HealthCheckPath string
    [HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck.
    HealthCheckPort string
    The port the load balancer uses when performing health checks on targets.
    HealthCheckProtocol string
    The protocol the load balancer uses when performing health checks on targets.
    HealthCheckTimeoutSeconds int
    The amount of time, in seconds, during which no response from a target means a failed health check.
    HealthyThresholdCount int
    The number of consecutive health checks successes required before considering an unhealthy target healthy.
    LoadBalancerArns List<string>
    The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group.
    Matcher Pulumi.AwsNative.ElasticLoadBalancingV2.Outputs.TargetGroupMatcher
    [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags.
    TargetGroupArn string
    The ARN of the Target Group
    TargetGroupAttributes List<Pulumi.AwsNative.ElasticLoadBalancingV2.Outputs.TargetGroupAttribute>
    The attributes.
    TargetGroupFullName string
    The full name of the target group.
    TargetGroupName string
    The name of the target group.
    Targets List<Pulumi.AwsNative.ElasticLoadBalancingV2.Outputs.TargetGroupTargetDescription>
    The targets.
    UnhealthyThresholdCount int
    The number of consecutive health check failures required before considering a target unhealthy.
    HealthCheckEnabled bool
    Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled.
    HealthCheckIntervalSeconds int
    The approximate amount of time, in seconds, between health checks of an individual target.
    HealthCheckPath string
    [HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck.
    HealthCheckPort string
    The port the load balancer uses when performing health checks on targets.
    HealthCheckProtocol string
    The protocol the load balancer uses when performing health checks on targets.
    HealthCheckTimeoutSeconds int
    The amount of time, in seconds, during which no response from a target means a failed health check.
    HealthyThresholdCount int
    The number of consecutive health checks successes required before considering an unhealthy target healthy.
    LoadBalancerArns []string
    The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group.
    Matcher TargetGroupMatcher
    [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
    Tags Tag
    The tags.
    TargetGroupArn string
    The ARN of the Target Group
    TargetGroupAttributes []TargetGroupAttribute
    The attributes.
    TargetGroupFullName string
    The full name of the target group.
    TargetGroupName string
    The name of the target group.
    Targets []TargetGroupTargetDescription
    The targets.
    UnhealthyThresholdCount int
    The number of consecutive health check failures required before considering a target unhealthy.
    healthCheckEnabled Boolean
    Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled.
    healthCheckIntervalSeconds Integer
    The approximate amount of time, in seconds, between health checks of an individual target.
    healthCheckPath String
    [HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck.
    healthCheckPort String
    The port the load balancer uses when performing health checks on targets.
    healthCheckProtocol String
    The protocol the load balancer uses when performing health checks on targets.
    healthCheckTimeoutSeconds Integer
    The amount of time, in seconds, during which no response from a target means a failed health check.
    healthyThresholdCount Integer
    The number of consecutive health checks successes required before considering an unhealthy target healthy.
    loadBalancerArns List<String>
    The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group.
    matcher TargetGroupMatcher
    [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
    tags List<Tag>
    The tags.
    targetGroupArn String
    The ARN of the Target Group
    targetGroupAttributes List<TargetGroupAttribute>
    The attributes.
    targetGroupFullName String
    The full name of the target group.
    targetGroupName String
    The name of the target group.
    targets List<TargetGroupTargetDescription>
    The targets.
    unhealthyThresholdCount Integer
    The number of consecutive health check failures required before considering a target unhealthy.
    healthCheckEnabled boolean
    Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled.
    healthCheckIntervalSeconds number
    The approximate amount of time, in seconds, between health checks of an individual target.
    healthCheckPath string
    [HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck.
    healthCheckPort string
    The port the load balancer uses when performing health checks on targets.
    healthCheckProtocol string
    The protocol the load balancer uses when performing health checks on targets.
    healthCheckTimeoutSeconds number
    The amount of time, in seconds, during which no response from a target means a failed health check.
    healthyThresholdCount number
    The number of consecutive health checks successes required before considering an unhealthy target healthy.
    loadBalancerArns string[]
    The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group.
    matcher TargetGroupMatcher
    [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
    tags Tag[]
    The tags.
    targetGroupArn string
    The ARN of the Target Group
    targetGroupAttributes TargetGroupAttribute[]
    The attributes.
    targetGroupFullName string
    The full name of the target group.
    targetGroupName string
    The name of the target group.
    targets TargetGroupTargetDescription[]
    The targets.
    unhealthyThresholdCount number
    The number of consecutive health check failures required before considering a target unhealthy.
    health_check_enabled bool
    Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled.
    health_check_interval_seconds int
    The approximate amount of time, in seconds, between health checks of an individual target.
    health_check_path str
    [HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck.
    health_check_port str
    The port the load balancer uses when performing health checks on targets.
    health_check_protocol str
    The protocol the load balancer uses when performing health checks on targets.
    health_check_timeout_seconds int
    The amount of time, in seconds, during which no response from a target means a failed health check.
    healthy_threshold_count int
    The number of consecutive health checks successes required before considering an unhealthy target healthy.
    load_balancer_arns Sequence[str]
    The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group.
    matcher TargetGroupMatcher
    [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
    tags Sequence[_root_Tag]
    The tags.
    target_group_arn str
    The ARN of the Target Group
    target_group_attributes Sequence[TargetGroupAttribute]
    The attributes.
    target_group_full_name str
    The full name of the target group.
    target_group_name str
    The name of the target group.
    targets Sequence[TargetGroupTargetDescription]
    The targets.
    unhealthy_threshold_count int
    The number of consecutive health check failures required before considering a target unhealthy.
    healthCheckEnabled Boolean
    Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled.
    healthCheckIntervalSeconds Number
    The approximate amount of time, in seconds, between health checks of an individual target.
    healthCheckPath String
    [HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck.
    healthCheckPort String
    The port the load balancer uses when performing health checks on targets.
    healthCheckProtocol String
    The protocol the load balancer uses when performing health checks on targets.
    healthCheckTimeoutSeconds Number
    The amount of time, in seconds, during which no response from a target means a failed health check.
    healthyThresholdCount Number
    The number of consecutive health checks successes required before considering an unhealthy target healthy.
    loadBalancerArns List<String>
    The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group.
    matcher Property Map
    [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
    tags List<Property Map>
    The tags.
    targetGroupArn String
    The ARN of the Target Group
    targetGroupAttributes List<Property Map>
    The attributes.
    targetGroupFullName String
    The full name of the target group.
    targetGroupName String
    The name of the target group.
    targets List<Property Map>
    The targets.
    unhealthyThresholdCount Number
    The number of consecutive health check failures required before considering a target unhealthy.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    TargetGroupAttribute

    Key string
    The value of the attribute.
    Value string
    The name of the attribute.
    Key string
    The value of the attribute.
    Value string
    The name of the attribute.
    key String
    The value of the attribute.
    value String
    The name of the attribute.
    key string
    The value of the attribute.
    value string
    The name of the attribute.
    key str
    The value of the attribute.
    value str
    The name of the attribute.
    key String
    The value of the attribute.
    value String
    The name of the attribute.

    TargetGroupMatcher

    GrpcCode string
    You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12.
    HttpCode string
    For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values.
    GrpcCode string
    You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12.
    HttpCode string
    For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values.
    grpcCode String
    You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12.
    httpCode String
    For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values.
    grpcCode string
    You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12.
    httpCode string
    For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values.
    grpc_code str
    You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12.
    http_code str
    For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values.
    grpcCode String
    You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12.
    httpCode String
    For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values.

    TargetGroupTargetDescription

    Id string
    The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target.
    AvailabilityZone string
    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.
    Port int
    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. Not used if the target is a Lambda function.
    Id string
    The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target.
    AvailabilityZone string
    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.
    Port int
    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. Not used if the target is a Lambda function.
    id String
    The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target.
    availabilityZone String
    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.
    port Integer
    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. Not used if the target is a Lambda function.
    id string
    The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target.
    availabilityZone string
    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.
    port number
    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. Not used if the target is a Lambda function.
    id str
    The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target.
    availability_zone str
    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.
    port int
    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. Not used if the target is a Lambda function.
    id String
    The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target.
    availabilityZone String
    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.
    port Number
    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. Not used if the target is a Lambda function.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.98.0 published on Thursday, Feb 29, 2024 by Pulumi