AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.9.2 published on Friday, Jun 24, 2022 by Pulumi

getProxy

Use this data source to get information about a DB Proxy.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var proxy = Output.Create(Aws.Rds.GetProxy.InvokeAsync(new Aws.Rds.GetProxyArgs
        {
            Name = "my-test-db-proxy",
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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

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

    }
}
import pulumi
import pulumi_aws as aws

proxy = aws.rds.get_proxy(name="my-test-db-proxy")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const proxy = pulumi.output(aws.rds.getProxy({
    name: "my-test-db-proxy",
}));
variables:
  proxy:
    Fn::Invoke:
      Function: aws:rds:getProxy
      Arguments:
        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?: InvokeOptions): Output<GetProxyResult>
def get_proxy(name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetProxyResult
def get_proxy_output(name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = 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 CompletableFuture<GetProxyResult> getProxy(GetProxyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws:rds/getProxy:getProxy
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Name string

The name of the DB proxy.

Name string

The name of the DB proxy.

name String

The name of the DB proxy.

name string

The name of the DB proxy.

name str

The name of the DB proxy.

name String

The name of the DB proxy.

getProxy Result

The following output properties are available:

Arn string

The ARN of the DB Proxy.

Auths List<GetProxyAuth>

The configuration(s) with authorization mechanisms to connect to the associated instance or cluster.

DebugLogging bool

Whether the proxy includes detailed information about SQL statements in its logs.

Endpoint string

The endpoint that you can use to connect to the DB proxy.

EngineFamily string

The kinds of databases that the proxy can connect to.

Id string

The provider-assigned unique ID for this managed resource.

IdleClientTimeout int

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.

Name string
RequireTls bool

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

RoleArn string

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

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>

The EC2 subnet IDs for the proxy.

Arn string

The ARN of the DB Proxy.

Auths []GetProxyAuth

The configuration(s) with authorization mechanisms to connect to the associated instance or cluster.

DebugLogging bool

Whether the proxy includes detailed information about SQL statements in its logs.

Endpoint string

The endpoint that you can use to connect to the DB proxy.

EngineFamily string

The kinds of databases that the proxy can connect to.

Id string

The provider-assigned unique ID for this managed resource.

IdleClientTimeout int

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.

Name string
RequireTls bool

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

RoleArn string

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

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

The EC2 subnet IDs for the proxy.

arn String

The ARN of the DB Proxy.

auths List<GetProxyAuth>

The configuration(s) with authorization mechanisms to connect to the associated instance or cluster.

debugLogging Boolean

Whether the proxy includes detailed information about SQL statements in its logs.

endpoint String

The endpoint that you can use to connect to the DB proxy.

engineFamily String

The kinds of databases that the proxy can connect to.

id String

The provider-assigned unique ID for this managed resource.

idleClientTimeout Integer

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.

name String
requireTls Boolean

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

roleArn String

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

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>

The EC2 subnet IDs for the proxy.

arn string

The ARN of the DB Proxy.

auths GetProxyAuth[]

The configuration(s) with authorization mechanisms to connect to the associated instance or cluster.

debugLogging boolean

Whether the proxy includes detailed information about SQL statements in its logs.

endpoint string

The endpoint that you can use to connect to the DB proxy.

engineFamily string

The kinds of databases that the proxy can connect to.

id string

The provider-assigned unique ID for this managed resource.

idleClientTimeout number

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.

name string
requireTls boolean

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

roleArn string

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

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[]

The EC2 subnet IDs for the proxy.

arn str

The ARN of the DB Proxy.

auths Sequence[GetProxyAuth]

The configuration(s) with authorization mechanisms to connect to the associated instance or cluster.

debug_logging bool

Whether the proxy includes detailed information about SQL statements in its logs.

endpoint str

The endpoint that you can use to connect to the DB proxy.

engine_family str

The kinds of databases that the proxy can connect to.

id str

The provider-assigned unique ID for this managed resource.

idle_client_timeout int

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.

name str
require_tls bool

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

role_arn str

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

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]

The EC2 subnet IDs for the proxy.

arn String

The ARN of the DB Proxy.

auths List<Property Map>

The configuration(s) with authorization mechanisms to connect to the associated instance or cluster.

debugLogging Boolean

Whether the proxy includes detailed information about SQL statements in its logs.

endpoint String

The endpoint that you can use to connect to the DB proxy.

engineFamily String

The kinds of databases that the proxy can connect to.

id String

The provider-assigned unique ID for this managed resource.

idleClientTimeout Number

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.

name String
requireTls Boolean

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

roleArn String

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

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>

The EC2 subnet IDs for the proxy.

Supporting Types

GetProxyAuth

AuthScheme string
Description string
IamAuth string
SecretArn string
Username string
AuthScheme string
Description string
IamAuth string
SecretArn string
Username string
authScheme String
description String
iamAuth String
secretArn String
username String
authScheme string
description string
iamAuth string
secretArn string
username string
authScheme String
description String
iamAuth String
secretArn String
username String

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.