aws-native.rds.DBProxy
Explore with Pulumi AI
Resource schema for AWS::RDS::DBProxy
Create DBProxy Resource
new DBProxy(name: string, args: DBProxyArgs, opts?: CustomResourceOptions);
@overload
def DBProxy(resource_name: str,
opts: Optional[ResourceOptions] = None,
auth: Optional[Sequence[DBProxyAuthFormatArgs]] = None,
d_b_proxy_name: Optional[str] = None,
debug_logging: Optional[bool] = None,
engine_family: Optional[DBProxyEngineFamily] = None,
idle_client_timeout: Optional[int] = None,
require_tls: Optional[bool] = None,
role_arn: Optional[str] = None,
tags: Optional[Sequence[DBProxyTagFormatArgs]] = None,
vpc_security_group_ids: Optional[Sequence[str]] = None,
vpc_subnet_ids: Optional[Sequence[str]] = None)
@overload
def DBProxy(resource_name: str,
args: DBProxyArgs,
opts: Optional[ResourceOptions] = None)
func NewDBProxy(ctx *Context, name string, args DBProxyArgs, opts ...ResourceOption) (*DBProxy, error)
public DBProxy(string name, DBProxyArgs args, CustomResourceOptions? opts = null)
public DBProxy(String name, DBProxyArgs args)
public DBProxy(String name, DBProxyArgs args, CustomResourceOptions options)
type: aws-native:rds:DBProxy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DBProxyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DBProxyArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DBProxyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DBProxyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DBProxyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
DBProxy Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The DBProxy resource accepts the following input properties:
- Auth
List<Pulumi.
Aws Native. RDS. Inputs. DBProxy Auth Format Args> The authorization mechanism that the proxy uses.
- Engine
Family Pulumi.Aws Native. RDS. DBProxy Engine Family The kinds of databases that the proxy can connect to.
- Role
Arn string The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
- Vpc
Subnet List<string>Ids VPC subnet IDs to associate with the new proxy.
- 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.
- Debug
Logging bool Whether the proxy includes detailed information about SQL statements in its logs.
- 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.
- List<Pulumi.
Aws Native. RDS. Inputs. DBProxy Tag Format Args> An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
- Vpc
Security List<string>Group Ids VPC security group IDs to associate with the new proxy.
- Auth
[]DBProxy
Auth Format Args The authorization mechanism that the proxy uses.
- Engine
Family DBProxyEngine Family The kinds of databases that the proxy can connect to.
- Role
Arn string The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
- Vpc
Subnet []stringIds VPC subnet IDs to associate with the new proxy.
- 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.
- Debug
Logging bool Whether the proxy includes detailed information about SQL statements in its logs.
- 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.
- []DBProxy
Tag Format Args An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
- Vpc
Security []stringGroup Ids VPC security group IDs to associate with the new proxy.
- auth
List<DBProxy
Auth Format Args> The authorization mechanism that the proxy uses.
- engine
Family DBProxyEngine Family The kinds of databases that the proxy can connect to.
- role
Arn String The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
- vpc
Subnet List<String>Ids VPC subnet IDs to associate with the new proxy.
- 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.
- debug
Logging Boolean Whether the proxy includes detailed information about SQL statements in its logs.
- 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.
- List<DBProxy
Tag Format Args> An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
- vpc
Security List<String>Group Ids VPC security group IDs to associate with the new proxy.
- auth
DBProxy
Auth Format Args[] The authorization mechanism that the proxy uses.
- engine
Family DBProxyEngine Family The kinds of databases that the proxy can connect to.
- role
Arn string The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
- vpc
Subnet string[]Ids VPC subnet IDs to associate with the new proxy.
- 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.
- debug
Logging boolean Whether the proxy includes detailed information about SQL statements in its logs.
- 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.
- DBProxy
Tag Format Args[] An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
- vpc
Security string[]Group Ids VPC security group IDs to associate with the new proxy.
- auth
Sequence[DBProxy
Auth Format Args] The authorization mechanism that the proxy uses.
- engine_
family DBProxyEngine Family The kinds of databases that the proxy can connect to.
- role_
arn str The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
- vpc_
subnet_ Sequence[str]ids VPC subnet IDs to associate with the new proxy.
- 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.
- debug_
logging bool Whether the proxy includes detailed information about SQL statements in its logs.
- 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.
- Sequence[DBProxy
Tag Format Args] An optional set of key-value pairs to associate arbitrary data of your choosing with the 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.
- engine
Family "MYSQL" | "POSTGRESQL" | "SQLSERVER" The kinds of databases that the proxy can connect to.
- role
Arn String The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
- vpc
Subnet List<String>Ids VPC subnet IDs to associate with the new proxy.
- 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.
- debug
Logging Boolean Whether the proxy includes detailed information about SQL statements in its logs.
- 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.
- List<Property Map>
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
- vpc
Security List<String>Group Ids VPC security group IDs to associate with the new proxy.
Outputs
All input properties are implicitly available as output properties. Additionally, the DBProxy resource produces the following output properties:
- DBProxy
Arn string The Amazon Resource Name (ARN) for the proxy.
- 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.
- Id string
The provider-assigned unique ID for this managed resource.
- Vpc
Id string VPC ID to associate with the new DB proxy.
- DBProxy
Arn string The Amazon Resource Name (ARN) for the proxy.
- 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.
- Id string
The provider-assigned unique ID for this managed resource.
- Vpc
Id string VPC ID to associate with the new DB proxy.
- d
BProxy StringArn The Amazon Resource Name (ARN) for the proxy.
- 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.
- id String
The provider-assigned unique ID for this managed resource.
- vpc
Id String VPC ID to associate with the new DB proxy.
- d
BProxy stringArn The Amazon Resource Name (ARN) for the proxy.
- 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.
- id string
The provider-assigned unique ID for this managed resource.
- vpc
Id string VPC ID to associate with the new DB proxy.
- d_
b_ strproxy_ arn The Amazon Resource Name (ARN) for the proxy.
- 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.
- id str
The provider-assigned unique ID for this managed resource.
- vpc_
id str VPC ID to associate with the new DB proxy.
- d
BProxy StringArn The Amazon Resource Name (ARN) for the proxy.
- 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.
- id String
The provider-assigned unique ID for this managed resource.
- vpc
Id String VPC ID to associate with the new DB 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
- Secrets
- SECRETS
- DBProxy
Auth Format Auth Scheme Secrets - SECRETS
- Secrets
- SECRETS
- Secrets
- SECRETS
- SECRETS
- SECRETS
- "SECRETS"
- SECRETS
DBProxyAuthFormatClientPasswordAuthType
- Mysql
Native Password - MYSQL_NATIVE_PASSWORD
- Postgres
Scram Sha256 - POSTGRES_SCRAM_SHA_256
- Postgres
Md5 - POSTGRES_MD5
- Sql
Server Authentication - SQL_SERVER_AUTHENTICATION
- DBProxy
Auth Format Client Password Auth Type Mysql Native Password - MYSQL_NATIVE_PASSWORD
- DBProxy
Auth Format Client Password Auth Type Postgres Scram Sha256 - POSTGRES_SCRAM_SHA_256
- DBProxy
Auth Format Client Password Auth Type Postgres Md5 - POSTGRES_MD5
- DBProxy
Auth Format Client Password Auth Type Sql Server Authentication - SQL_SERVER_AUTHENTICATION
- Mysql
Native Password - MYSQL_NATIVE_PASSWORD
- Postgres
Scram Sha256 - POSTGRES_SCRAM_SHA_256
- Postgres
Md5 - POSTGRES_MD5
- Sql
Server Authentication - SQL_SERVER_AUTHENTICATION
- Mysql
Native Password - MYSQL_NATIVE_PASSWORD
- Postgres
Scram Sha256 - POSTGRES_SCRAM_SHA_256
- Postgres
Md5 - POSTGRES_MD5
- Sql
Server Authentication - SQL_SERVER_AUTHENTICATION
- MYSQL_NATIVE_PASSWORD
- MYSQL_NATIVE_PASSWORD
- POSTGRES_SCRAM_SHA256
- POSTGRES_SCRAM_SHA_256
- POSTGRES_MD5
- POSTGRES_MD5
- SQL_SERVER_AUTHENTICATION
- SQL_SERVER_AUTHENTICATION
- "MYSQL_NATIVE_PASSWORD"
- MYSQL_NATIVE_PASSWORD
- "POSTGRES_SCRAM_SHA_256"
- POSTGRES_SCRAM_SHA_256
- "POSTGRES_MD5"
- POSTGRES_MD5
- "SQL_SERVER_AUTHENTICATION"
- SQL_SERVER_AUTHENTICATION
DBProxyAuthFormatIAMAuth
- Disabled
- DISABLED
- Required
- REQUIRED
- Enabled
- ENABLED
- DBProxy
Auth Format IAMAuth Disabled - DISABLED
- DBProxy
Auth Format IAMAuth Required - REQUIRED
- DBProxy
Auth Format IAMAuth Enabled - ENABLED
- Disabled
- DISABLED
- Required
- REQUIRED
- Enabled
- ENABLED
- Disabled
- DISABLED
- Required
- REQUIRED
- Enabled
- ENABLED
- DISABLED
- DISABLED
- REQUIRED
- REQUIRED
- ENABLED
- ENABLED
- "DISABLED"
- DISABLED
- "REQUIRED"
- REQUIRED
- "ENABLED"
- ENABLED
DBProxyEngineFamily
- Mysql
- MYSQL
- Postgresql
- POSTGRESQL
- Sqlserver
- SQLSERVER
- DBProxy
Engine Family Mysql - MYSQL
- DBProxy
Engine Family Postgresql - POSTGRESQL
- DBProxy
Engine Family Sqlserver - SQLSERVER
- Mysql
- MYSQL
- Postgresql
- POSTGRESQL
- Sqlserver
- SQLSERVER
- Mysql
- MYSQL
- Postgresql
- POSTGRESQL
- Sqlserver
- SQLSERVER
- MYSQL
- MYSQL
- POSTGRESQL
- POSTGRESQL
- SQLSERVER
- SQLSERVER
- "MYSQL"
- MYSQL
- "POSTGRESQL"
- POSTGRESQL
- "SQLSERVER"
- SQLSERVER
DBProxyTagFormat
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0