@pulumi/aws/lb/getListenerRule.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Provides information about an AWS Elastic Load Balancing Listener Rule.
 *
 * ## Example Usage
 *
 * ### Match by Rule ARN
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const config = new pulumi.Config();
 * const lbRuleArn = config.require("lbRuleArn");
 * const example = aws.lb.getListenerRule({
 *     arn: lbRuleArn,
 * });
 * ```
 *
 * ### Match by Listener ARN and Priority
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const config = new pulumi.Config();
 * const lbListenerArn = config.require("lbListenerArn");
 * const lbRulePriority = config.requireNumber("lbRulePriority");
 * const example = aws.lb.getListenerRule({
 *     listenerArn: lbListenerArn,
 *     priority: lbRulePriority,
 * });
 * ```
 */
export declare function getListenerRule(args?: GetListenerRuleArgs, opts?: pulumi.InvokeOptions): Promise<GetListenerRuleResult>;
/**
 * A collection of arguments for invoking getListenerRule.
 */
export interface GetListenerRuleArgs {
    /**
     * List of actions associated with the rule, sorted by `order`.
     * Detailed below.
     */
    actions?: inputs.lb.GetListenerRuleAction[];
    /**
     * ARN of the Listener Rule.
     * Either `arn` or `listenerArn` must be set.
     */
    arn?: string;
    /**
     * Set of conditions associated with the rule.
     * Detailed below.
     */
    conditions?: inputs.lb.GetListenerRuleCondition[];
    /**
     * ARN of the associated Listener.
     * Either `arn` or `listenerArn` must be set.
     */
    listenerArn?: string;
    /**
     * Priority of the Listener Rule within the Listener.
     * Must be set if `listenerArn` is set, otherwise must not be set.
     */
    priority?: number;
    /**
     * 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;
    /**
     * Block for transform to apply to requests that match this rule. Detailed below.
     */
    transforms?: inputs.lb.GetListenerRuleTransform[];
}
/**
 * A collection of values returned by getListenerRule.
 */
export interface GetListenerRuleResult {
    /**
     * List of actions associated with the rule, sorted by `order`.
     * Detailed below.
     */
    readonly actions?: outputs.lb.GetListenerRuleAction[];
    /**
     * ARN of the target group.
     */
    readonly arn: string;
    /**
     * Set of conditions associated with the rule.
     * Detailed below.
     */
    readonly conditions?: outputs.lb.GetListenerRuleCondition[];
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly listenerArn: string;
    readonly priority: number;
    readonly region: string;
    /**
     * Tags assigned to the Listener Rule.
     */
    readonly tags: {
        [key: string]: string;
    };
    /**
     * Block for transform to apply to requests that match this rule. Detailed below.
     */
    readonly transforms?: outputs.lb.GetListenerRuleTransform[];
}
/**
 * Provides information about an AWS Elastic Load Balancing Listener Rule.
 *
 * ## Example Usage
 *
 * ### Match by Rule ARN
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const config = new pulumi.Config();
 * const lbRuleArn = config.require("lbRuleArn");
 * const example = aws.lb.getListenerRule({
 *     arn: lbRuleArn,
 * });
 * ```
 *
 * ### Match by Listener ARN and Priority
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const config = new pulumi.Config();
 * const lbListenerArn = config.require("lbListenerArn");
 * const lbRulePriority = config.requireNumber("lbRulePriority");
 * const example = aws.lb.getListenerRule({
 *     listenerArn: lbListenerArn,
 *     priority: lbRulePriority,
 * });
 * ```
 */
export declare function getListenerRuleOutput(args?: GetListenerRuleOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetListenerRuleResult>;
/**
 * A collection of arguments for invoking getListenerRule.
 */
export interface GetListenerRuleOutputArgs {
    /**
     * List of actions associated with the rule, sorted by `order`.
     * Detailed below.
     */
    actions?: pulumi.Input<pulumi.Input<inputs.lb.GetListenerRuleActionArgs>[]>;
    /**
     * ARN of the Listener Rule.
     * Either `arn` or `listenerArn` must be set.
     */
    arn?: pulumi.Input<string>;
    /**
     * Set of conditions associated with the rule.
     * Detailed below.
     */
    conditions?: pulumi.Input<pulumi.Input<inputs.lb.GetListenerRuleConditionArgs>[]>;
    /**
     * ARN of the associated Listener.
     * Either `arn` or `listenerArn` must be set.
     */
    listenerArn?: pulumi.Input<string>;
    /**
     * Priority of the Listener Rule within the Listener.
     * Must be set if `listenerArn` is set, otherwise must not be set.
     */
    priority?: pulumi.Input<number>;
    /**
     * 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>;
    /**
     * Block for transform to apply to requests that match this rule. Detailed below.
     */
    transforms?: pulumi.Input<pulumi.Input<inputs.lb.GetListenerRuleTransformArgs>[]>;
}