AWS Native

v0.29.0 published on Thursday, Sep 8, 2022 by Pulumi

DBProxy

Resource schema for AWS::RDS::DBProxy

Create a 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.AwsNative.RDS.Inputs.DBProxyAuthFormatArgs>

The authorization mechanism that the proxy uses.

EngineFamily Pulumi.AwsNative.RDS.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.

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.

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 List<Pulumi.AwsNative.RDS.Inputs.DBProxyTagFormatArgs>

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

VpcSecurityGroupIds List<string>

VPC security group IDs to associate with the new proxy.

Auth []DBProxyAuthFormatArgs

The authorization mechanism that the proxy uses.

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.

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.

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 []DBProxyTagFormatArgs

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

VpcSecurityGroupIds []string

VPC security group IDs to associate with the new proxy.

auth List<DBProxyAuthFormatArgs>

The authorization mechanism that the proxy uses.

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.

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.

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<DBProxyTagFormatArgs>

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

vpcSecurityGroupIds List<String>

VPC security group IDs to associate with the new proxy.

auth DBProxyAuthFormatArgs[]

The authorization mechanism that the proxy uses.

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.

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.

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 DBProxyTagFormatArgs[]

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

vpcSecurityGroupIds string[]

VPC security group IDs to associate with the new proxy.

auth Sequence[DBProxyAuthFormatArgs]

The authorization mechanism that the proxy uses.

engine_family DBProxyEngineFamily

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_ids Sequence[str]

VPC subnet IDs to associate with the new proxy.

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.

debug_logging bool

Whether the proxy includes detailed information about SQL statements in its logs.

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.

tags Sequence[DBProxyTagFormatArgs]

An optional set of key-value pairs to associate arbitrary data of your choosing with the 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.

engineFamily "MYSQL" | "POSTGRESQL"

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.

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.

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.

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.

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.

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.

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.

d_b_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.

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.

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.

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 AWS Identity and Access Management (IAM) authentication for connections to the proxy.

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.

UserName string

The name of the database user to which the proxy connects.

AuthScheme DBProxyAuthFormatAuthScheme

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

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 AWS Identity and Access Management (IAM) authentication for connections to the proxy.

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.

UserName string

The name of the database user to which the proxy connects.

authScheme DBProxyAuthFormatAuthScheme

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

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 AWS Identity and Access Management (IAM) authentication for connections to the proxy.

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.

userName String

The name of the database user to which the proxy connects.

authScheme DBProxyAuthFormatAuthScheme

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

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 AWS Identity and Access Management (IAM) authentication for connections to the proxy.

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.

userName string

The name of the database user to which the proxy connects.

auth_scheme DBProxyAuthFormatAuthScheme

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

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 AWS Identity and Access Management (IAM) authentication for connections to the proxy.

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.

user_name str

The name of the database user to which the proxy connects.

authScheme "SECRETS"

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

description String

A user-specified description about the authentication used by a proxy to log in as a specific database user.

iAMAuth "DISABLED" | "REQUIRED"

Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.

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.

userName String

The name of the database user to which the proxy connects.

DBProxyAuthFormatAuthScheme

Secrets
SECRETS
DBProxyAuthFormatAuthSchemeSecrets
SECRETS
Secrets
SECRETS
Secrets
SECRETS
SECRETS
SECRETS
"SECRETS"
SECRETS

DBProxyAuthFormatIAMAuth

Disabled
DISABLED
Required
REQUIRED
DBProxyAuthFormatIAMAuthDisabled
DISABLED
DBProxyAuthFormatIAMAuthRequired
REQUIRED
Disabled
DISABLED
Required
REQUIRED
Disabled
DISABLED
Required
REQUIRED
DISABLED
DISABLED
REQUIRED
REQUIRED
"DISABLED"
DISABLED
"REQUIRED"
REQUIRED

DBProxyEngineFamily

Mysql
MYSQL
Postgresql
POSTGRESQL
DBProxyEngineFamilyMysql
MYSQL
DBProxyEngineFamilyPostgresql
POSTGRESQL
Mysql
MYSQL
Postgresql
POSTGRESQL
Mysql
MYSQL
Postgresql
POSTGRESQL
MYSQL
MYSQL
POSTGRESQL
POSTGRESQL
"MYSQL"
MYSQL
"POSTGRESQL"
POSTGRESQL

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
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0