We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.8.0 published on Thursday, Nov 14, 2024 by Pulumi
aws-native.rds.getDbProxy
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.8.0 published on Thursday, Nov 14, 2024 by Pulumi
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:rds:getDbProxy
arguments:
# arguments dictionary
The following arguments are supported:
- Db
Proxy stringName - 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 stringName - 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 StringName - 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 stringName - 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_ strname - 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 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. Db Proxy Auth Format> - The authorization mechanism that the proxy uses.
- Db
Proxy stringArn - 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. Outputs. Tag> - 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
[]Db
Proxy Auth Format - The authorization mechanism that the proxy uses.
- Db
Proxy stringArn - 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.
- Tag
- 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<Db
Proxy Auth Format> - The authorization mechanism that the proxy uses.
- db
Proxy 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<Tag>
- 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
Db
Proxy Auth Format[] - The authorization mechanism that the proxy uses.
- db
Proxy 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.
- Tag[]
- 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[Db
Proxy Auth Format] - The authorization mechanism that the proxy uses.
- db_
proxy_ strarn - 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[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_ 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.
- db
Proxy 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. Db Proxy 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. Db Proxy 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.
- Iam
Auth Pulumi.Aws Native. Rds. Db Proxy Auth Format Iam Auth - 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 DbProxy Auth Format Auth Scheme - The type of authentication that the proxy uses for connections from the proxy to the underlying database.
- Client
Password DbAuth Type Proxy 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.
- Iam
Auth DbProxy Auth Format Iam Auth - 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 DbProxy Auth Format Auth Scheme - The type of authentication that the proxy uses for connections from the proxy to the underlying database.
- client
Password DbAuth Type Proxy 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.
- iam
Auth DbProxy Auth Format Iam Auth - 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 DbProxy Auth Format Auth Scheme - The type of authentication that the proxy uses for connections from the proxy to the underlying database.
- client
Password DbAuth Type Proxy 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.
- iam
Auth DbProxy Auth Format Iam Auth - 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 DbProxy Auth Format Auth Scheme - The type of authentication that the proxy uses for connections from the proxy to the underlying database.
- client_
password_ Dbauth_ type Proxy 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.
- iam_
auth DbProxy Auth Format Iam Auth - 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.
- iam
Auth "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
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.8.0 published on Thursday, Nov 14, 2024 by Pulumi