getProxy

AWS v7.47.0, Sep 17 26

Viewing docs for AWS v7.47.0
published on Thursday, Sep 17, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

Viewing docs for AWS v7.47.0
published on Thursday, Sep 17, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const proxy = aws.rds.getProxy({
    name: "my-test-db-proxy",
});

import pulumi
import pulumi_aws as aws

proxy = aws.rds.get_proxy(name="my-test-db-proxy")

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds.LookupProxy(ctx, &rds.LookupProxyArgs{
			Name: "my-test-db-proxy",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var proxy = Aws.Rds.GetProxy.Invoke(new()
    {
        Name = "my-test-db-proxy",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.RdsFunctions;
import com.pulumi.aws.rds.inputs.GetProxyArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var proxy = RdsFunctions.getProxy(GetProxyArgs.builder()
            .name("my-test-db-proxy")
            .build());

    }
}

variables:
  proxy:
    fn::invoke:
      function: aws:rds:getProxy
      arguments:
        name: my-test-db-proxy

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_rds_getproxy" "proxy" {
  name = "my-test-db-proxy"
}

Using getProxy

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 getProxy(args: GetProxyArgs, opts?: InvokeOptions): Promise<GetProxyResult>
function getProxyOutput(args: GetProxyOutputArgs, opts?: InvokeOutputOptions): Output<GetProxyResult>

def get_proxy(name: Optional[str] = None,
              region: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetProxyResult
def get_proxy_output(name: pulumi.Input[Optional[str]] = None,
              region: pulumi.Input[Optional[str]] = None,
              opts: Optional[InvokeOutputOptions] = None) -> Output[GetProxyResult]

func LookupProxy(ctx *Context, args *LookupProxyArgs, opts ...InvokeOption) (*LookupProxyResult, error)
func LookupProxyOutput(ctx *Context, args *LookupProxyOutputArgs, opts ...InvokeOption) LookupProxyResultOutput

> Note: This function is named LookupProxy in the Go SDK.

public static class GetProxy 
{
    public static Task<GetProxyResult> InvokeAsync(GetProxyArgs args, InvokeOptions? opts = null)
    public static Output<GetProxyResult> Invoke(GetProxyInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetProxyResult> Invoke(GetProxyInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetProxyResult> getProxy(GetProxyArgs args, InvokeOptions options)
public static Output<GetProxyResult> getProxy(GetProxyArgs args, InvokeOptions options)
public static Output<GetProxyResult> getProxy(GetProxyArgs args, InvokeOutputOptions options)

fn::invoke:
  function: aws:rds/getProxy:getProxy
  arguments:
    # arguments dictionary

data "aws_rds_get_proxy" "name" {
    # arguments
}

The following arguments are supported:

Name string: Name of the DB proxy.
Region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Name string: Name of the DB proxy.
Region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.

name string: Name of the DB proxy.
region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.

name String: Name of the DB proxy.
region String: Region where this resource will be managed. Defaults to the Region set in the provider configuration.

name string: Name of the DB proxy.
region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.

name str: Name of the DB proxy.
region str: Region where this resource will be managed. Defaults to the Region set in the provider configuration.

name String: Name of the DB proxy.
region String: Region where this resource will be managed. Defaults to the Region set in the provider configuration.

getProxy Result

The following output properties are available:

Arn string: ARN of the DB Proxy.
Auths List<GetProxyAuth>: Configuration(s) with authorization mechanisms to connect to the associated instance or cluster. See the auth block below.
DebugLogging bool: Whether the proxy includes detailed information about SQL statements in its logs.
DefaultAuthScheme string: Default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.
Endpoint string: Endpoint that you can use to connect to the DB proxy.
EndpointNetworkType string: Network type of the DB proxy endpoint.
EngineFamily string: Kinds of databases that the proxy can connect to.
Id string: The provider-assigned unique ID for this managed resource.
IdleClientTimeout int: Number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.
Name string
Region string
RequireTls bool: Whether TLS encryption is required for connections to the proxy.
RoleArn string: ARN for the IAM role that the proxy uses to access Amazon Secrets Manager.
TargetConnectionNetworkType string: Network type that the proxy uses to connect to the target database.
VpcId string: Provides the VPC ID of the DB proxy.
VpcSecurityGroupIds List<string>: Provides a list of VPC security groups that the proxy belongs to.
VpcSubnetIds List<string>: EC2 subnet IDs for the proxy.

Arn string: ARN of the DB Proxy.
Auths []GetProxyAuth: Configuration(s) with authorization mechanisms to connect to the associated instance or cluster. See the auth block below.
DebugLogging bool: Whether the proxy includes detailed information about SQL statements in its logs.
DefaultAuthScheme string: Default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.
Endpoint string: Endpoint that you can use to connect to the DB proxy.
EndpointNetworkType string: Network type of the DB proxy endpoint.
EngineFamily string: Kinds of databases that the proxy can connect to.
Id string: The provider-assigned unique ID for this managed resource.
IdleClientTimeout int: Number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.
Name string
Region string
RequireTls bool: Whether TLS encryption is required for connections to the proxy.
RoleArn string: ARN for the IAM role that the proxy uses to access Amazon Secrets Manager.
TargetConnectionNetworkType string: Network type that the proxy uses to connect to the target database.
VpcId string: Provides the VPC ID of the DB proxy.
VpcSecurityGroupIds []string: Provides a list of VPC security groups that the proxy belongs to.
VpcSubnetIds []string: EC2 subnet IDs for the proxy.

arn string: ARN of the DB Proxy.
auths list(object): Configuration(s) with authorization mechanisms to connect to the associated instance or cluster. See the auth block below.
debug_logging bool: Whether the proxy includes detailed information about SQL statements in its logs.
default_auth_scheme string: Default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.
endpoint string: Endpoint that you can use to connect to the DB proxy.
endpoint_network_type string: Network type of the DB proxy endpoint.
engine_family string: Kinds of databases that the proxy can connect to.
id string: The provider-assigned unique ID for this managed resource.
idle_client_timeout number: Number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.
name string
region string
require_tls bool: Whether TLS encryption is required for connections to the proxy.
role_arn string: ARN for the IAM role that the proxy uses to access Amazon Secrets Manager.
target_connection_network_type string: Network type that the proxy uses to connect to the target database.
vpc_id string: Provides the VPC ID of the DB proxy.
vpc_security_group_ids list(string): Provides a list of VPC security groups that the proxy belongs to.
vpc_subnet_ids list(string): EC2 subnet IDs for the proxy.

arn String: ARN of the DB Proxy.
auths List<GetProxyAuth>: Configuration(s) with authorization mechanisms to connect to the associated instance or cluster. See the auth block below.
debugLogging Boolean: Whether the proxy includes detailed information about SQL statements in its logs.
defaultAuthScheme String: Default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.
endpoint String: Endpoint that you can use to connect to the DB proxy.
endpointNetworkType String: Network type of the DB proxy endpoint.
engineFamily String: Kinds of databases that the proxy can connect to.
id String: The provider-assigned unique ID for this managed resource.
idleClientTimeout Integer: Number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.
name String
region String
requireTls Boolean: Whether TLS encryption is required for connections to the proxy.
roleArn String: ARN for the IAM role that the proxy uses to access Amazon Secrets Manager.
targetConnectionNetworkType String: Network type that the proxy uses to connect to the target database.
vpcId String: Provides the VPC ID of the DB proxy.
vpcSecurityGroupIds List<String>: Provides a list of VPC security groups that the proxy belongs to.
vpcSubnetIds List<String>: EC2 subnet IDs for the proxy.

arn string: ARN of the DB Proxy.
auths GetProxyAuth[]: Configuration(s) with authorization mechanisms to connect to the associated instance or cluster. See the auth block below.
debugLogging boolean: Whether the proxy includes detailed information about SQL statements in its logs.
defaultAuthScheme string: Default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.
endpoint string: Endpoint that you can use to connect to the DB proxy.
endpointNetworkType string: Network type of the DB proxy endpoint.
engineFamily string: Kinds of databases that the proxy can connect to.
id string: The provider-assigned unique ID for this managed resource.
idleClientTimeout number: Number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.
name string
region string
requireTls boolean: Whether TLS encryption is required for connections to the proxy.
roleArn string: ARN for the IAM role that the proxy uses to access Amazon Secrets Manager.
targetConnectionNetworkType string: Network type that the proxy uses to connect to the target database.
vpcId string: Provides the VPC ID of the DB proxy.
vpcSecurityGroupIds string[]: Provides a list of VPC security groups that the proxy belongs to.
vpcSubnetIds string[]: EC2 subnet IDs for the proxy.

arn str: ARN of the DB Proxy.
auths Sequence[GetProxyAuth]: Configuration(s) with authorization mechanisms to connect to the associated instance or cluster. See the auth block below.
debug_logging bool: Whether the proxy includes detailed information about SQL statements in its logs.
default_auth_scheme str: Default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.
endpoint str: Endpoint that you can use to connect to the DB proxy.
endpoint_network_type str: Network type of the DB proxy endpoint.
engine_family str: Kinds of databases that the proxy can connect to.
id str: The provider-assigned unique ID for this managed resource.
idle_client_timeout int: Number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.
name str
region str
require_tls bool: Whether TLS encryption is required for connections to the proxy.
role_arn str: ARN for the IAM role that the proxy uses to access Amazon Secrets Manager.
target_connection_network_type str: Network type that the proxy uses to connect to the target database.
vpc_id str: Provides the VPC ID of the DB proxy.
vpc_security_group_ids Sequence[str]: Provides a list of VPC security groups that the proxy belongs to.
vpc_subnet_ids Sequence[str]: EC2 subnet IDs for the proxy.

arn String: ARN of the DB Proxy.
auths List<Property Map>: Configuration(s) with authorization mechanisms to connect to the associated instance or cluster. See the auth block below.
debugLogging Boolean: Whether the proxy includes detailed information about SQL statements in its logs.
defaultAuthScheme String: Default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.
endpoint String: Endpoint that you can use to connect to the DB proxy.
endpointNetworkType String: Network type of the DB proxy endpoint.
engineFamily String: Kinds of databases that the proxy can connect to.
id String: The provider-assigned unique ID for this managed resource.
idleClientTimeout Number: Number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.
name String
region String
requireTls Boolean: Whether TLS encryption is required for connections to the proxy.
roleArn String: ARN for the IAM role that the proxy uses to access Amazon Secrets Manager.
targetConnectionNetworkType String: Network type that the proxy uses to connect to the target database.
vpcId String: Provides the VPC ID of the DB proxy.
vpcSecurityGroupIds List<String>: Provides a list of VPC security groups that the proxy belongs to.
vpcSubnetIds List<String>: EC2 subnet IDs for the proxy.

Supporting Types

GetProxyAuth

AuthScheme string: Type of authentication that the proxy uses for connections from the proxy to the underlying database.
ClientPasswordAuthType string: Type of authentication the proxy uses for connections from clients.
Description string: User-specified description about the authentication used by a proxy to log in as a specific database user.
IamAuth string: Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
SecretArn string: ARN representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.
Username string: Name of the database user to which the proxy connects.

AuthScheme string: Type of authentication that the proxy uses for connections from the proxy to the underlying database.
ClientPasswordAuthType string: Type of authentication the proxy uses for connections from clients.
Description string: User-specified description about the authentication used by a proxy to log in as a specific database user.
IamAuth string: Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
SecretArn string: ARN representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.
Username string: Name of the database user to which the proxy connects.

auth_scheme string: Type of authentication that the proxy uses for connections from the proxy to the underlying database.
client_password_auth_type string: Type of authentication the proxy uses for connections from clients.
description string: User-specified description about the authentication used by a proxy to log in as a specific database user.
iam_auth string: Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
secret_arn string: ARN representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.
username string: Name of the database user to which the proxy connects.

authScheme String: Type of authentication that the proxy uses for connections from the proxy to the underlying database.
clientPasswordAuthType String: Type of authentication the proxy uses for connections from clients.
description String: User-specified description about the authentication used by a proxy to log in as a specific database user.
iamAuth String: Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
secretArn String: ARN representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.
username String: Name of the database user to which the proxy connects.

authScheme string: Type of authentication that the proxy uses for connections from the proxy to the underlying database.
clientPasswordAuthType string: Type of authentication the proxy uses for connections from clients.
description string: User-specified description about the authentication used by a proxy to log in as a specific database user.
iamAuth string: Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
secretArn string: ARN representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.
username string: Name of the database user to which the proxy connects.

auth_scheme str: Type of authentication that the proxy uses for connections from the proxy to the underlying database.
client_password_auth_type str: Type of authentication the proxy uses for connections from clients.
description str: User-specified description about the authentication used by a proxy to log in as a specific database user.
iam_auth str: Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
secret_arn str: ARN representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.
username str: Name of the database user to which the proxy connects.

authScheme String: Type of authentication that the proxy uses for connections from the proxy to the underlying database.
clientPasswordAuthType String: Type of authentication the proxy uses for connections from clients.
description String: User-specified description about the authentication used by a proxy to log in as a specific database user.
iamAuth String: Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
secretArn String: ARN representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.
username String: Name of the database user to which the proxy connects.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

Viewing docs for AWS v7.47.0
published on Thursday, Sep 17, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

aws.rds.getProxy

On this page

On this page

Example Usage

Using getProxy

getProxy Result

Supporting Types

GetProxyAuth

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

aws.rds.getProxy

On this page

On this page

Example Usage

Using getProxy

getProxy Result

Supporting Types

GetProxyAuth

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.