AWS Native is in preview. AWS Classic is fully supported.
aws-native.rds.getDBProxy
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
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(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:
- DBProxy
Name string The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
- DBProxy
Name 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
BProxy StringName The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
- d
BProxy stringName 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_ strproxy_ name The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
- d
BProxy StringName 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.
Aws Native. RDS. Outputs. DBProxy Auth Format> The authorization mechanism that the proxy uses.
- DBProxy
Arn string The Amazon Resource Name (ARN) for the proxy.
- Debug
Logging 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.
- Idle
Client intTimeout 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 string The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
- List<Pulumi.
Aws Native. RDS. Outputs. DBProxy Tag Format> An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
- Vpc
Id string VPC ID to associate with the new DB proxy.
- Vpc
Security List<string>Group Ids VPC security group IDs to associate with the new proxy.
- Auth
[]DBProxy
Auth Format The authorization mechanism that the proxy uses.
- DBProxy
Arn string The Amazon Resource Name (ARN) for the proxy.
- Debug
Logging 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.
- Idle
Client intTimeout 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 string The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
- []DBProxy
Tag Format An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
- Vpc
Id string VPC ID to associate with the new DB proxy.
- Vpc
Security []stringGroup Ids VPC security group IDs to associate with the new proxy.
- auth
List<DBProxy
Auth Format> The authorization mechanism that the proxy uses.
- d
BProxy StringArn The Amazon Resource Name (ARN) for the proxy.
- debug
Logging 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.
- idle
Client IntegerTimeout The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
- require
TLS Boolean A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
- role
Arn String The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
- List<DBProxy
Tag Format> An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
- vpc
Id String VPC ID to associate with the new DB proxy.
- vpc
Security List<String>Group Ids VPC security group IDs to associate with the new proxy.
- auth
DBProxy
Auth Format[] The authorization mechanism that the proxy uses.
- d
BProxy stringArn The Amazon Resource Name (ARN) for the proxy.
- debug
Logging 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.
- idle
Client numberTimeout The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
- require
TLS boolean A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
- role
Arn string The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
- DBProxy
Tag Format[] An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
- vpc
Id string VPC ID to associate with the new DB proxy.
- vpc
Security string[]Group Ids VPC security group IDs to associate with the new proxy.
- auth
Sequence[DBProxy
Auth Format] The authorization mechanism that the proxy uses.
- d_
b_ strproxy_ arn 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_ inttimeout 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.
- Sequence[DBProxy
Tag Format] 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_ Sequence[str]group_ ids VPC security group IDs to associate with the new proxy.
- auth List<Property Map>
The authorization mechanism that the proxy uses.
- d
BProxy StringArn The Amazon Resource Name (ARN) for the proxy.
- debug
Logging 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.
- idle
Client NumberTimeout The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
- require
TLS Boolean A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
- role
Arn String The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
- List<Property Map>
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
- vpc
Id String VPC ID to associate with the new DB proxy.
- vpc
Security List<String>Group Ids VPC security group IDs to associate with the new proxy.
Supporting Types
DBProxyAuthFormat
- Auth
Scheme Pulumi.Aws Native. RDS. DBProxy Auth Format Auth Scheme The type of authentication that the proxy uses for connections from the proxy to the underlying database.
- Client
Password Pulumi.Auth Type Aws Native. RDS. DBProxy Auth Format Client Password Auth Type 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.
Aws Native. RDS. DBProxy Auth Format IAMAuth 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 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 DBProxyAuth Format Auth Scheme The type of authentication that the proxy uses for connections from the proxy to the underlying database.
- Client
Password DBProxyAuth Type Auth Format Client Password Auth Type 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
DBProxy
Auth Format IAMAuth 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 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 DBProxyAuth Format Auth Scheme The type of authentication that the proxy uses for connections from the proxy to the underlying database.
- client
Password DBProxyAuth Type Auth Format Client Password Auth Type 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.
- i
AMAuth DBProxyAuth Format IAMAuth 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 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 DBProxyAuth Format Auth Scheme The type of authentication that the proxy uses for connections from the proxy to the underlying database.
- client
Password DBProxyAuth Type Auth Format Client Password Auth Type 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.
- i
AMAuth DBProxyAuth Format IAMAuth 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 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 DBProxyAuth Format Auth Scheme The type of authentication that the proxy uses for connections from the proxy to the underlying database.
- client_
password_ DBProxyauth_ type Auth Format Client Password Auth Type 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_ DBProxyauth Auth Format IAMAuth 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.
- auth
Scheme "SECRETS" The type of authentication that the proxy uses for connections from the proxy to the underlying database.
- client
Password "MYSQL_NATIVE_PASSWORD" | "POSTGRES_SCRAM_SHA_256" | "POSTGRES_MD5" | "SQL_SERVER_AUTHENTICATION"Auth Type 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.
- i
AMAuth "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.
- secret
Arn 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
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.