AWS Native v0.65.0, Jun 7 23

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.65.0 published on Wednesday, Jun 7, 2023 by Pulumi

pulumi/pulumi-aws-native

aws-native.rds.getDBProxy

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.65.0 published on Wednesday, Jun 7, 2023 by Pulumi

pulumi/pulumi-aws-native

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(d_b_proxy_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDBProxyResult
def get_db_proxy_output(d_b_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)
// Output-based functions aren't available in Java yet

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.

d_b_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.RDS.Outputs.DBProxyTagFormat>: 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 []DBProxyTagFormat: 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<DBProxyTagFormat>: 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 DBProxyTagFormat[]: 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.
d_b_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[DBProxyTagFormat]: 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.
i_am_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

DBProxyTagFormat

Key string
Value string

Key string
Value string

key String
value String

key string
value string

key str
value str

key String
value String

Package Details

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

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.65.0 published on Wednesday, Jun 7, 2023 by Pulumi

pulumi/pulumi-aws-native

aws-native.rds.getDBProxy

On this page

On this page

Using getDBProxy

getDBProxy Result

Supporting Types

DBProxyAuthFormat

DBProxyAuthFormatAuthScheme

DBProxyAuthFormatClientPasswordAuthType

DBProxyAuthFormatIAMAuth

DBProxyTagFormat

Package Details

On this page

On this page