Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. rds
  5. getDbProxy

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.getDbProxy

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::RDS::DBProxy

    Using getDbProxy

    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 getDbProxy(args: GetDbProxyArgs, opts?: InvokeOptions): Promise<GetDbProxyResult>
function getDbProxyOutput(args: GetDbProxyOutputArgs, opts?: InvokeOptions): Output<GetDbProxyResult>
    def get_db_proxy(db_proxy_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDbProxyResult
def get_db_proxy_output(db_proxy_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDbProxyResult]
    func LookupDbProxy(ctx *Context, args *LookupDbProxyArgs, opts ...InvokeOption) (*LookupDbProxyResult, error)
func LookupDbProxyOutput(ctx *Context, args *LookupDbProxyOutputArgs, opts ...InvokeOption) LookupDbProxyResultOutput

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

    public static class GetDbProxy 
{
    public static Task<GetDbProxyResult> InvokeAsync(GetDbProxyArgs args, InvokeOptions? opts = null)
    public static Output<GetDbProxyResult> Invoke(GetDbProxyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDbProxyResult> getDbProxy(GetDbProxyArgs args, InvokeOptions options)
public static Output<GetDbProxyResult> getDbProxy(GetDbProxyArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:rds:getDbProxy
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DbProxyName string
    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
    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
    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
    The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
    db_proxy_name str
    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
    The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

    getDbProxy Result

    The following output properties are available:

    Auth List<Pulumi.AwsNative.Rds.Outputs.DbProxyAuthFormat>
    The authorization mechanism that the proxy uses.
    DbProxyArn string
    The Amazon Resource Name (ARN) for the proxy.
    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 proxy. You include the endpoint value in the connection string for a database client application.
    IdleClientTimeout int
    The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
    RequireTls bool
    A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
    VpcId string
    VPC ID to associate with the new DB proxy.
    VpcSecurityGroupIds List<string>
    VPC security group IDs to associate with the new proxy.
    Auth []DbProxyAuthFormat
    The authorization mechanism that the proxy uses.
    DbProxyArn string
    The Amazon Resource Name (ARN) for the proxy.
    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 proxy. You include the endpoint value in the connection string for a database client application.
    IdleClientTimeout int
    The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
    RequireTls bool
    A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
    Tags Tag
    An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
    VpcId string
    VPC ID to associate with the new DB proxy.
    VpcSecurityGroupIds []string
    VPC security group IDs to associate with the new proxy.
    auth List<DbProxyAuthFormat>
    The authorization mechanism that the proxy uses.
    dbProxyArn String
    The Amazon Resource Name (ARN) for the proxy.
    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 proxy. You include the endpoint value in the connection string for a database client application.
    idleClientTimeout Integer
    The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
    requireTls Boolean
    A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
    roleArn String
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
    tags List<Tag>
    An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
    vpcId String
    VPC ID to associate with the new DB proxy.
    vpcSecurityGroupIds List<String>
    VPC security group IDs to associate with the new proxy.
    auth DbProxyAuthFormat[]
    The authorization mechanism that the proxy uses.
    dbProxyArn string
    The Amazon Resource Name (ARN) for the proxy.
    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 proxy. You include the endpoint value in the connection string for a database client application.
    idleClientTimeout number
    The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
    requireTls boolean
    A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
    roleArn string
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
    tags Tag[]
    An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
    vpcId string
    VPC ID to associate with the new DB proxy.
    vpcSecurityGroupIds string[]
    VPC security group IDs to associate with the new proxy.
    auth Sequence[DbProxyAuthFormat]
    The authorization mechanism that the proxy uses.
    db_proxy_arn str
    The Amazon Resource Name (ARN) for the proxy.
    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 proxy. You include the endpoint value in the connection string for a database client application.
    idle_client_timeout int
    The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
    require_tls bool
    A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
    role_arn str
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
    tags Sequence[root_Tag]
    An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
    vpc_id str
    VPC ID to associate with the new DB proxy.
    vpc_security_group_ids Sequence[str]
    VPC security group IDs to associate with the new proxy.
    auth List<Property Map>
    The authorization mechanism that the proxy uses.
    dbProxyArn String
    The Amazon Resource Name (ARN) for the proxy.
    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 proxy. You include the endpoint value in the connection string for a database client application.
    idleClientTimeout Number
    The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
    requireTls Boolean
    A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
    roleArn String
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
    tags List<Property Map>
    An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
    vpcId String
    VPC ID to associate with the new DB proxy.
    vpcSecurityGroupIds List<String>
    VPC security group IDs to associate with the new proxy.

    Supporting Types

    DbProxyAuthFormat

    AuthScheme Pulumi.AwsNative.Rds.DbProxyAuthFormatAuthScheme
    The type of authentication that the proxy uses for connections from the proxy to the underlying database.
    ClientPasswordAuthType Pulumi.AwsNative.Rds.DbProxyAuthFormatClientPasswordAuthType
    The type of authentication the proxy uses for connections from clients.
    Description string
    A user-specified description about the authentication used by a proxy to log in as a specific database user.
    IamAuth Pulumi.AwsNative.Rds.DbProxyAuthFormatIamAuth
    Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
    SecretArn string
    The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
    AuthScheme DbProxyAuthFormatAuthScheme
    The type of authentication that the proxy uses for connections from the proxy to the underlying database.
    ClientPasswordAuthType DbProxyAuthFormatClientPasswordAuthType
    The type of authentication the proxy uses for connections from clients.
    Description string
    A user-specified description about the authentication used by a proxy to log in as a specific database user.
    IamAuth DbProxyAuthFormatIamAuth
    Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
    SecretArn string
    The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
    authScheme DbProxyAuthFormatAuthScheme
    The type of authentication that the proxy uses for connections from the proxy to the underlying database.
    clientPasswordAuthType DbProxyAuthFormatClientPasswordAuthType
    The type of authentication the proxy uses for connections from clients.
    description String
    A user-specified description about the authentication used by a proxy to log in as a specific database user.
    iamAuth DbProxyAuthFormatIamAuth
    Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
    secretArn String
    The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
    authScheme DbProxyAuthFormatAuthScheme
    The type of authentication that the proxy uses for connections from the proxy to the underlying database.
    clientPasswordAuthType DbProxyAuthFormatClientPasswordAuthType
    The type of authentication the proxy uses for connections from clients.
    description string
    A user-specified description about the authentication used by a proxy to log in as a specific database user.
    iamAuth DbProxyAuthFormatIamAuth
    Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
    secretArn string
    The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
    auth_scheme DbProxyAuthFormatAuthScheme
    The type of authentication that the proxy uses for connections from the proxy to the underlying database.
    client_password_auth_type DbProxyAuthFormatClientPasswordAuthType
    The type of authentication the proxy uses for connections from clients.
    description str
    A user-specified description about the authentication used by a proxy to log in as a specific database user.
    iam_auth DbProxyAuthFormatIamAuth
    Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
    secret_arn str
    The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
    authScheme "SECRETS"
    The type of authentication that the proxy uses for connections from the proxy to the underlying database.
    clientPasswordAuthType "MYSQL_NATIVE_PASSWORD" | "POSTGRES_SCRAM_SHA_256" | "POSTGRES_MD5" | "SQL_SERVER_AUTHENTICATION"
    The type of authentication the proxy uses for connections from clients.
    description String
    A user-specified description about the authentication used by a proxy to log in as a specific database user.
    iamAuth "DISABLED" | "REQUIRED" | "ENABLED"
    Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
    secretArn String
    The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

    DbProxyAuthFormatAuthScheme

    DbProxyAuthFormatClientPasswordAuthType

    DbProxyAuthFormatIamAuth

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-aws-native