@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
70 lines (69 loc) • 2.65 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Resource schema for AWS::RDS::DBProxy
*/
export declare function getDbProxy(args: GetDbProxyArgs, opts?: pulumi.InvokeOptions): Promise<GetDbProxyResult>;
export interface GetDbProxyArgs {
/**
* The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
*/
dbProxyName: string;
}
export interface GetDbProxyResult {
/**
* The authorization mechanism that the proxy uses.
*/
readonly auth?: outputs.rds.DbProxyAuthFormat[];
/**
* The Amazon Resource Name (ARN) for the proxy.
*/
readonly dbProxyArn?: string;
/**
* Whether the proxy includes detailed information about SQL statements in its logs.
*/
readonly debugLogging?: boolean;
/**
* The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.
*/
readonly defaultAuthScheme?: enums.rds.DbProxyDefaultAuthScheme;
/**
* The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
*/
readonly endpoint?: string;
/**
* The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
*/
readonly idleClientTimeout?: number;
/**
* A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
*/
readonly requireTls?: boolean;
/**
* The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
*/
readonly roleArn?: string;
/**
* An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
*/
readonly tags?: outputs.Tag[];
/**
* VPC ID to associate with the new DB proxy.
*/
readonly vpcId?: string;
/**
* VPC security group IDs to associate with the new proxy.
*/
readonly vpcSecurityGroupIds?: string[];
}
/**
* Resource schema for AWS::RDS::DBProxy
*/
export declare function getDbProxyOutput(args: GetDbProxyOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDbProxyResult>;
export interface GetDbProxyOutputArgs {
/**
* The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
*/
dbProxyName: pulumi.Input<string>;
}