@pulumi/aws/rds/getProxy.d.ts

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

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Use this data source to get information about a DB Proxy.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const proxy = aws.rds.getProxy({
 *     name: "my-test-db-proxy",
 * });
 * ```
 */
export declare function getProxy(args: GetProxyArgs, opts?: pulumi.InvokeOptions): Promise<GetProxyResult>;
/**
 * A collection of arguments for invoking getProxy.
 */
export interface GetProxyArgs {
    /**
     * Name of the DB proxy.
     */
    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;
}
/**
 * A collection of values returned by getProxy.
 */
export interface GetProxyResult {
    /**
     * ARN of the DB Proxy.
     */
    readonly arn: string;
    /**
     * Configuration(s) with authorization mechanisms to connect to the associated instance or cluster.
     */
    readonly auths: outputs.rds.GetProxyAuth[];
    /**
     * Whether the proxy includes detailed information about SQL statements in its logs.
     */
    readonly debugLogging: boolean;
    /**
     * Default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.
     */
    readonly defaultAuthScheme: string;
    /**
     * Endpoint that you can use to connect to the DB proxy.
     */
    readonly endpoint: string;
    /**
     * Kinds of databases that the proxy can connect to.
     */
    readonly engineFamily: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * Number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.
     */
    readonly idleClientTimeout: number;
    readonly name: string;
    readonly region: string;
    /**
     * Whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
     */
    readonly requireTls: boolean;
    /**
     * ARN for the IAM role that the proxy uses to access Amazon Secrets Manager.
     */
    readonly roleArn: string;
    /**
     * Provides the VPC ID of the DB proxy.
     */
    readonly vpcId: string;
    /**
     * Provides a list of VPC security groups that the proxy belongs to.
     */
    readonly vpcSecurityGroupIds: string[];
    /**
     * EC2 subnet IDs for the proxy.
     */
    readonly vpcSubnetIds: string[];
}
/**
 * Use this data source to get information about a DB Proxy.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const proxy = aws.rds.getProxy({
 *     name: "my-test-db-proxy",
 * });
 * ```
 */
export declare function getProxyOutput(args: GetProxyOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetProxyResult>;
/**
 * A collection of arguments for invoking getProxy.
 */
export interface GetProxyOutputArgs {
    /**
     * Name of the DB proxy.
     */
    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>;
}