1. Packages
  2. AWS Classic
  3. API Docs
  4. rds
  5. getProxy

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi

aws.rds.getProxy

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi

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

    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/v6/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.List;
    import java.util.ArrayList;
    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
    

    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
    Name of the DB proxy.
    Name string
    Name of the DB proxy.
    name String
    Name of the DB proxy.
    name string
    Name of the DB proxy.
    name str
    Name of the DB proxy.
    name String
    Name of the DB proxy.

    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.
    DebugLogging bool
    Whether the proxy includes detailed information about SQL statements in its logs.
    Endpoint string
    Endpoint that you can use to connect to the DB proxy.
    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
    RequireTls bool
    Whether Transport Layer Security (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.
    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.
    DebugLogging bool
    Whether the proxy includes detailed information about SQL statements in its logs.
    Endpoint string
    Endpoint that you can use to connect to the DB proxy.
    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
    RequireTls bool
    Whether Transport Layer Security (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.
    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<GetProxyAuth>
    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
    Endpoint that you can use to connect to the DB proxy.
    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
    requireTls Boolean
    Whether Transport Layer Security (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.
    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.
    debugLogging boolean
    Whether the proxy includes detailed information about SQL statements in its logs.
    endpoint string
    Endpoint that you can use to connect to the DB proxy.
    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
    requireTls boolean
    Whether Transport Layer Security (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.
    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.
    debug_logging bool
    Whether the proxy includes detailed information about SQL statements in its logs.
    endpoint str
    Endpoint that you can use to connect to the DB proxy.
    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
    require_tls bool
    Whether Transport Layer Security (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.
    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.
    debugLogging Boolean
    Whether the proxy includes detailed information about SQL statements in its logs.
    endpoint String
    Endpoint that you can use to connect to the DB proxy.
    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
    requireTls Boolean
    Whether Transport Layer Security (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.
    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

    Package Details

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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi