Resource schema for AWS::RDS::DBProxy
Create DbProxy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
@overload
def DbProxy(resource_name: str,
args: DbProxyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DbProxy(resource_name: str,
opts: Optional[ResourceOptions] = None,
engine_family: Optional[DbProxyEngineFamily] = None,
vpc_subnet_ids: Optional[Sequence[str]] = None,
role_arn: Optional[str] = None,
idle_client_timeout: Optional[int] = None,
endpoint_network_type: Optional[DbProxyEndpointNetworkType] = None,
default_auth_scheme: Optional[DbProxyDefaultAuthScheme] = None,
auth: Optional[Sequence[DbProxyAuthFormatArgs]] = None,
require_tls: Optional[bool] = None,
debug_logging: Optional[bool] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
target_connection_network_type: Optional[DbProxyTargetConnectionNetworkType] = None,
vpc_security_group_ids: Optional[Sequence[str]] = None,
db_proxy_name: Optional[str] = None)
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.
resource "aws-native_rds_db_proxy" "name" {
# resource properties
}
Parameters
- 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.
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DbProxy resource accepts the following input properties:
- EngineFamily
DbProxyEngineFamily
- The kinds of databases that the proxy can connect to.
- RoleArn
string
- The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
- VpcSubnetIds
[]string
- VPC subnet IDs to associate with the new proxy.
- Auth
[]DbProxyAuthFormatArgs
- The authorization mechanism that the proxy uses.
- 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.
- DebugLogging
bool
- Whether the proxy includes detailed information about SQL statements in its logs.
- DefaultAuthScheme
DbProxyDefaultAuthScheme
- The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.
- EndpointNetworkType
DbProxyEndpointNetworkType
- The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.
- 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.
- Tags
TagArgs
- An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
- TargetConnectionNetworkType
DbProxyTargetConnectionNetworkType
- The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.
- VpcSecurityGroupIds
[]string
- VPC security group IDs to associate with the new proxy.
- 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_ids
list(string)
- VPC subnet IDs to associate with the new proxy.
- auth
list(object)
- The authorization mechanism that the proxy uses.
- db_proxy_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.
- default_auth_scheme
"IAM_AUTH" | "NONE"
- The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.
- endpoint_network_type
"IPV4" | "IPV6" | "DUAL"
- The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.
- idle_client_timeout
number
- 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.
- tags
list(object)
- An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
- target_connection_network_type
"IPV4" | "IPV6"
- The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.
- vpc_security_group_ids
list(string)
- VPC security group IDs to associate with the new proxy.
- engineFamily
DbProxyEngineFamily
- The kinds of databases that the proxy can connect to.
- roleArn
String
- The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
- vpcSubnetIds
List<String>
- VPC subnet IDs to associate with the new proxy.
- auth
List<DbProxyAuthFormat>
- The authorization mechanism that the proxy uses.
- 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.
- debugLogging
Boolean
- Whether the proxy includes detailed information about SQL statements in its logs.
- defaultAuthScheme
DbProxyDefaultAuthScheme
- The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.
- endpointNetworkType
DbProxyEndpointNetworkType
- The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.
- 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.
- tags
List<Tag>
- An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
- targetConnectionNetworkType
DbProxyTargetConnectionNetworkType
- The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.
- vpcSecurityGroupIds
List<String>
- VPC security group IDs to associate with the new proxy.
- engineFamily
DbProxyEngineFamily
- The kinds of databases that the proxy can connect to.
- roleArn
string
- The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
- vpcSubnetIds
string[]
- VPC subnet IDs to associate with the new proxy.
- auth
DbProxyAuthFormat[]
- The authorization mechanism that the proxy uses.
- 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.
- debugLogging
boolean
- Whether the proxy includes detailed information about SQL statements in its logs.
- defaultAuthScheme
DbProxyDefaultAuthScheme
- The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.
- endpointNetworkType
DbProxyEndpointNetworkType
- The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.
- 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.
- tags
Tag[]
- An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
- targetConnectionNetworkType
DbProxyTargetConnectionNetworkType
- The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.
- vpcSecurityGroupIds
string[]
- VPC security group IDs to associate with the new proxy.
- engineFamily
"MYSQL" | "POSTGRESQL" | "SQLSERVER"
- The kinds of databases that the proxy can connect to.
- roleArn
String
- The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
- vpcSubnetIds
List<String>
- VPC subnet IDs to associate with the new proxy.
- auth
List<Property Map>
- The authorization mechanism that the proxy uses.
- 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.
- debugLogging
Boolean
- Whether the proxy includes detailed information about SQL statements in its logs.
- defaultAuthScheme
"IAM_AUTH" | "NONE"
- The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.
- endpointNetworkType
"IPV4" | "IPV6" | "DUAL"
- The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.
- 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.
- tags
List<Property Map>
- An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
- targetConnectionNetworkType
"IPV4" | "IPV6"
- The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.
- vpcSecurityGroupIds
List<String>
- 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:
- DbProxyArn
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.
- VpcId
string
- VPC ID to associate with the new DB proxy.
- DbProxyArn
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.
- VpcId
string
- VPC ID to associate with the new DB proxy.
- db_proxy_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.
- dbProxyArn
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.
- vpcId
String
- VPC ID to associate with the new DB proxy.
- dbProxyArn
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.
- vpcId
string
- VPC ID to associate with the new DB proxy.
- db_proxy_arn
str
- 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.
- dbProxyArn
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.
- vpcId
String
- VPC ID to associate with the new DB proxy.
Supporting Types
- 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.
| Name | Value |
|---|
| DbProxyAuthFormatAuthSchemeSecrets | SECRETS |
| Name | Value |
|---|
| MysqlNativePassword | MYSQL_NATIVE_PASSWORD |
| MysqlCachingSha2Password | MYSQL_CACHING_SHA2_PASSWORD |
| PostgresScramSha256 | POSTGRES_SCRAM_SHA_256 |
| PostgresMd5 | POSTGRES_MD5 |
| SqlServerAuthentication | SQL_SERVER_AUTHENTICATION |
| Name | Value |
|---|
| DbProxyAuthFormatClientPasswordAuthTypeMysqlNativePassword | MYSQL_NATIVE_PASSWORD |
| DbProxyAuthFormatClientPasswordAuthTypeMysqlCachingSha2Password | MYSQL_CACHING_SHA2_PASSWORD |
| DbProxyAuthFormatClientPasswordAuthTypePostgresScramSha256 | POSTGRES_SCRAM_SHA_256 |
| DbProxyAuthFormatClientPasswordAuthTypePostgresMd5 | POSTGRES_MD5 |
| DbProxyAuthFormatClientPasswordAuthTypeSqlServerAuthentication | SQL_SERVER_AUTHENTICATION |
| Value |
|---|
MYSQL_NATIVE_PASSWORD |
MYSQL_CACHING_SHA2_PASSWORD |
POSTGRES_SCRAM_SHA_256 |
POSTGRES_MD5 |
SQL_SERVER_AUTHENTICATION |
| Name | Value |
|---|
| MysqlNativePassword | MYSQL_NATIVE_PASSWORD |
| MysqlCachingSha2Password | MYSQL_CACHING_SHA2_PASSWORD |
| PostgresScramSha256 | POSTGRES_SCRAM_SHA_256 |
| PostgresMd5 | POSTGRES_MD5 |
| SqlServerAuthentication | SQL_SERVER_AUTHENTICATION |
| Name | Value |
|---|
| MysqlNativePassword | MYSQL_NATIVE_PASSWORD |
| MysqlCachingSha2Password | MYSQL_CACHING_SHA2_PASSWORD |
| PostgresScramSha256 | POSTGRES_SCRAM_SHA_256 |
| PostgresMd5 | POSTGRES_MD5 |
| SqlServerAuthentication | SQL_SERVER_AUTHENTICATION |
| Name | Value |
|---|
| MYSQL_NATIVE_PASSWORD | MYSQL_NATIVE_PASSWORD |
| MYSQL_CACHING_SHA2_PASSWORD | MYSQL_CACHING_SHA2_PASSWORD |
| POSTGRES_SCRAM_SHA256 | POSTGRES_SCRAM_SHA_256 |
| POSTGRES_MD5 | POSTGRES_MD5 |
| SQL_SERVER_AUTHENTICATION | SQL_SERVER_AUTHENTICATION |
| Value |
|---|
MYSQL_NATIVE_PASSWORD |
MYSQL_CACHING_SHA2_PASSWORD |
POSTGRES_SCRAM_SHA_256 |
POSTGRES_MD5 |
SQL_SERVER_AUTHENTICATION |
| Name | Value |
|---|
| Disabled | DISABLED |
| Required | REQUIRED |
| Enabled | ENABLED |
| Name | Value |
|---|
| DbProxyAuthFormatIamAuthDisabled | DISABLED |
| DbProxyAuthFormatIamAuthRequired | REQUIRED |
| DbProxyAuthFormatIamAuthEnabled | ENABLED |
| Value |
|---|
DISABLED |
REQUIRED |
ENABLED |
| Name | Value |
|---|
| Disabled | DISABLED |
| Required | REQUIRED |
| Enabled | ENABLED |
| Name | Value |
|---|
| Disabled | DISABLED |
| Required | REQUIRED |
| Enabled | ENABLED |
| Name | Value |
|---|
| DISABLED | DISABLED |
| REQUIRED | REQUIRED |
| ENABLED | ENABLED |
| Value |
|---|
DISABLED |
REQUIRED |
ENABLED |
DbProxyDefaultAuthScheme, DbProxyDefaultAuthSchemeArgs
| Name | Value |
|---|
| IamAuth | IAM_AUTH |
| None | NONE |
| Name | Value |
|---|
| DbProxyDefaultAuthSchemeIamAuth | IAM_AUTH |
| DbProxyDefaultAuthSchemeNone | NONE |
| Name | Value |
|---|
| IamAuth | IAM_AUTH |
| None | NONE |
| Name | Value |
|---|
| IamAuth | IAM_AUTH |
| None | NONE |
| Name | Value |
|---|
| IAM_AUTH | IAM_AUTH |
| NONE | NONE |
DbProxyEndpointNetworkType, DbProxyEndpointNetworkTypeArgs
| Name | Value |
|---|
| Ipv4 | IPV4 |
| Ipv6 | IPV6 |
| Dual | DUAL |
| Name | Value |
|---|
| DbProxyEndpointNetworkTypeIpv4 | IPV4 |
| DbProxyEndpointNetworkTypeIpv6 | IPV6 |
| DbProxyEndpointNetworkTypeDual | DUAL |
| Name | Value |
|---|
| Ipv4 | IPV4 |
| Ipv6 | IPV6 |
| Dual | DUAL |
| Name | Value |
|---|
| Ipv4 | IPV4 |
| Ipv6 | IPV6 |
| Dual | DUAL |
| Name | Value |
|---|
| IPV4 | IPV4 |
| IPV6 | IPV6 |
| DUAL | DUAL |
DbProxyEngineFamily, DbProxyEngineFamilyArgs
| Name | Value |
|---|
| Mysql | MYSQL |
| Postgresql | POSTGRESQL |
| Sqlserver | SQLSERVER |
| Name | Value |
|---|
| DbProxyEngineFamilyMysql | MYSQL |
| DbProxyEngineFamilyPostgresql | POSTGRESQL |
| DbProxyEngineFamilySqlserver | SQLSERVER |
| Value |
|---|
MYSQL |
POSTGRESQL |
SQLSERVER |
| Name | Value |
|---|
| Mysql | MYSQL |
| Postgresql | POSTGRESQL |
| Sqlserver | SQLSERVER |
| Name | Value |
|---|
| Mysql | MYSQL |
| Postgresql | POSTGRESQL |
| Sqlserver | SQLSERVER |
| Name | Value |
|---|
| MYSQL | MYSQL |
| POSTGRESQL | POSTGRESQL |
| SQLSERVER | SQLSERVER |
| Value |
|---|
MYSQL |
POSTGRESQL |
SQLSERVER |
DbProxyTargetConnectionNetworkType, DbProxyTargetConnectionNetworkTypeArgs
| Name | Value |
|---|
| Ipv4 | IPV4 |
| Ipv6 | IPV6 |
| Name | Value |
|---|
| DbProxyTargetConnectionNetworkTypeIpv4 | IPV4 |
| DbProxyTargetConnectionNetworkTypeIpv6 | IPV6 |
| Name | Value |
|---|
| Ipv4 | IPV4 |
| Ipv6 | IPV6 |
| Name | Value |
|---|
| Ipv4 | IPV4 |
| Ipv6 | IPV6 |
| Name | Value |
|---|
| IPV4 | IPV4 |
| IPV6 | IPV6 |
Tag, TagArgs
A set of tags to apply to the resource.- 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
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