@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
138 lines (137 loc) • 4.78 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* > **Note:** `aws.alb.TargetGroup` is known as `aws.lb.TargetGroup`. The functionality is identical.
*
* Provides information about a Load Balancer Target Group.
*
* This data source can prove useful when a module accepts an LB Target Group as an
* input variable and needs to know its attributes. It can also be used to get the ARN of
* an LB Target Group for use in other resources, given LB Target Group name.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const config = new pulumi.Config();
* const lbTgArn = config.get("lbTgArn") || "";
* const lbTgName = config.get("lbTgName") || "";
* const test = aws.lb.getTargetGroup({
* arn: lbTgArn,
* name: lbTgName,
* });
* ```
*/
export declare function getTargetGroup(args?: GetTargetGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetTargetGroupResult>;
/**
* A collection of arguments for invoking getTargetGroup.
*/
export interface GetTargetGroupArgs {
/**
* Full ARN of the target group.
*/
arn?: string;
loadBalancingAnomalyMitigation?: string;
/**
* Unique name of the target group.
*/
name?: string;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: string;
/**
* Mapping of tags, each pair of which must exactly match a pair on the desired target group.
*
* > **NOTE:** When both `arn` and `name` are specified, `arn` takes precedence. `tags` has the lowest precedence.
*/
tags?: {
[key: string]: string;
};
}
/**
* A collection of values returned by getTargetGroup.
*/
export interface GetTargetGroupResult {
readonly arn: string;
readonly arnSuffix: string;
readonly connectionTermination: boolean;
readonly deregistrationDelay: string;
readonly healthCheck: outputs.alb.GetTargetGroupHealthCheck;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly lambdaMultiValueHeadersEnabled: boolean;
readonly loadBalancerArns: string[];
readonly loadBalancingAlgorithmType: string;
readonly loadBalancingAnomalyMitigation: string;
readonly loadBalancingCrossZoneEnabled: string;
readonly name: string;
readonly port: number;
readonly preserveClientIp: string;
readonly protocol: string;
readonly protocolVersion: string;
readonly proxyProtocolV2: boolean;
readonly region: string;
readonly slowStart: number;
readonly stickiness: outputs.alb.GetTargetGroupStickiness;
readonly tags: {
[key: string]: string;
};
readonly targetType: string;
readonly vpcId: string;
}
/**
* > **Note:** `aws.alb.TargetGroup` is known as `aws.lb.TargetGroup`. The functionality is identical.
*
* Provides information about a Load Balancer Target Group.
*
* This data source can prove useful when a module accepts an LB Target Group as an
* input variable and needs to know its attributes. It can also be used to get the ARN of
* an LB Target Group for use in other resources, given LB Target Group name.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const config = new pulumi.Config();
* const lbTgArn = config.get("lbTgArn") || "";
* const lbTgName = config.get("lbTgName") || "";
* const test = aws.lb.getTargetGroup({
* arn: lbTgArn,
* name: lbTgName,
* });
* ```
*/
export declare function getTargetGroupOutput(args?: GetTargetGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetTargetGroupResult>;
/**
* A collection of arguments for invoking getTargetGroup.
*/
export interface GetTargetGroupOutputArgs {
/**
* Full ARN of the target group.
*/
arn?: pulumi.Input<string>;
loadBalancingAnomalyMitigation?: pulumi.Input<string>;
/**
* Unique name of the target group.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Mapping of tags, each pair of which must exactly match a pair on the desired target group.
*
* > **NOTE:** When both `arn` and `name` are specified, `arn` takes precedence. `tags` has the lowest precedence.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}