We recommend new projects start with resources from the AWS provider.
aws-native.rds.DbProxyTargetGroup
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource schema for AWS::RDS::DBProxyTargetGroup
Create DbProxyTargetGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DbProxyTargetGroup(name: string, args: DbProxyTargetGroupArgs, opts?: CustomResourceOptions);
@overload
def DbProxyTargetGroup(resource_name: str,
args: DbProxyTargetGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DbProxyTargetGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
db_proxy_name: Optional[str] = None,
target_group_name: Optional[DbProxyTargetGroupTargetGroupName] = None,
connection_pool_configuration_info: Optional[DbProxyTargetGroupConnectionPoolConfigurationInfoFormatArgs] = None,
db_cluster_identifiers: Optional[Sequence[str]] = None,
db_instance_identifiers: Optional[Sequence[str]] = None)
func NewDbProxyTargetGroup(ctx *Context, name string, args DbProxyTargetGroupArgs, opts ...ResourceOption) (*DbProxyTargetGroup, error)
public DbProxyTargetGroup(string name, DbProxyTargetGroupArgs args, CustomResourceOptions? opts = null)
public DbProxyTargetGroup(String name, DbProxyTargetGroupArgs args)
public DbProxyTargetGroup(String name, DbProxyTargetGroupArgs args, CustomResourceOptions options)
type: aws-native:rds:DbProxyTargetGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DbProxyTargetGroupArgs
- 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 DbProxyTargetGroupArgs
- 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 DbProxyTargetGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DbProxyTargetGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DbProxyTargetGroupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
DbProxyTargetGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DbProxyTargetGroup resource accepts the following input properties:
- Db
Proxy stringName - The identifier for the proxy.
- Target
Group Pulumi.Name Aws Native. Rds. Db Proxy Target Group Target Group Name - The identifier for the DBProxyTargetGroup
- Connection
Pool Pulumi.Configuration Info Aws Native. Rds. Inputs. Db Proxy Target Group Connection Pool Configuration Info Format - Displays the settings that control the size and behavior of the connection pool associated with a
DBProxyTarget
. - Db
Cluster List<string>Identifiers - One or more DB cluster identifiers.
- Db
Instance List<string>Identifiers - One or more DB instance identifiers.
- Db
Proxy stringName - The identifier for the proxy.
- Target
Group DbName Proxy Target Group Target Group Name - The identifier for the DBProxyTargetGroup
- Connection
Pool DbConfiguration Info Proxy Target Group Connection Pool Configuration Info Format Args - Displays the settings that control the size and behavior of the connection pool associated with a
DBProxyTarget
. - Db
Cluster []stringIdentifiers - One or more DB cluster identifiers.
- Db
Instance []stringIdentifiers - One or more DB instance identifiers.
- db
Proxy StringName - The identifier for the proxy.
- target
Group DbName Proxy Target Group Target Group Name - The identifier for the DBProxyTargetGroup
- connection
Pool DbConfiguration Info Proxy Target Group Connection Pool Configuration Info Format - Displays the settings that control the size and behavior of the connection pool associated with a
DBProxyTarget
. - db
Cluster List<String>Identifiers - One or more DB cluster identifiers.
- db
Instance List<String>Identifiers - One or more DB instance identifiers.
- db
Proxy stringName - The identifier for the proxy.
- target
Group DbName Proxy Target Group Target Group Name - The identifier for the DBProxyTargetGroup
- connection
Pool DbConfiguration Info Proxy Target Group Connection Pool Configuration Info Format - Displays the settings that control the size and behavior of the connection pool associated with a
DBProxyTarget
. - db
Cluster string[]Identifiers - One or more DB cluster identifiers.
- db
Instance string[]Identifiers - One or more DB instance identifiers.
- db_
proxy_ strname - The identifier for the proxy.
- target_
group_ Dbname Proxy Target Group Target Group Name - The identifier for the DBProxyTargetGroup
- connection_
pool_ Dbconfiguration_ info Proxy Target Group Connection Pool Configuration Info Format Args - Displays the settings that control the size and behavior of the connection pool associated with a
DBProxyTarget
. - db_
cluster_ Sequence[str]identifiers - One or more DB cluster identifiers.
- db_
instance_ Sequence[str]identifiers - One or more DB instance identifiers.
- db
Proxy StringName - The identifier for the proxy.
- target
Group "default"Name - The identifier for the DBProxyTargetGroup
- connection
Pool Property MapConfiguration Info - Displays the settings that control the size and behavior of the connection pool associated with a
DBProxyTarget
. - db
Cluster List<String>Identifiers - One or more DB cluster identifiers.
- db
Instance List<String>Identifiers - One or more DB instance identifiers.
Outputs
All input properties are implicitly available as output properties. Additionally, the DbProxyTargetGroup resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Target
Group stringArn - The Amazon Resource Name (ARN) representing the target group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Target
Group stringArn - The Amazon Resource Name (ARN) representing the target group.
- id String
- The provider-assigned unique ID for this managed resource.
- target
Group StringArn - The Amazon Resource Name (ARN) representing the target group.
- id string
- The provider-assigned unique ID for this managed resource.
- target
Group stringArn - The Amazon Resource Name (ARN) representing the target group.
- id str
- The provider-assigned unique ID for this managed resource.
- target_
group_ strarn - The Amazon Resource Name (ARN) representing the target group.
- id String
- The provider-assigned unique ID for this managed resource.
- target
Group StringArn - The Amazon Resource Name (ARN) representing the target group.
Supporting Types
DbProxyTargetGroupConnectionPoolConfigurationInfoFormat, DbProxyTargetGroupConnectionPoolConfigurationInfoFormatArgs
- Connection
Borrow intTimeout - The number of seconds for a proxy to wait for a connection to become available in the connection pool.
- Init
Query string - One or more SQL statements for the proxy to run when opening each new database connection.
- Max
Connections intPercent - The maximum size of the connection pool for each target in a target group.
- Max
Idle intConnections Percent - Controls how actively the proxy closes idle database connections in the connection pool.
- Session
Pinning List<string>Filters - Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection.
- Connection
Borrow intTimeout - The number of seconds for a proxy to wait for a connection to become available in the connection pool.
- Init
Query string - One or more SQL statements for the proxy to run when opening each new database connection.
- Max
Connections intPercent - The maximum size of the connection pool for each target in a target group.
- Max
Idle intConnections Percent - Controls how actively the proxy closes idle database connections in the connection pool.
- Session
Pinning []stringFilters - Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection.
- connection
Borrow IntegerTimeout - The number of seconds for a proxy to wait for a connection to become available in the connection pool.
- init
Query String - One or more SQL statements for the proxy to run when opening each new database connection.
- max
Connections IntegerPercent - The maximum size of the connection pool for each target in a target group.
- max
Idle IntegerConnections Percent - Controls how actively the proxy closes idle database connections in the connection pool.
- session
Pinning List<String>Filters - Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection.
- connection
Borrow numberTimeout - The number of seconds for a proxy to wait for a connection to become available in the connection pool.
- init
Query string - One or more SQL statements for the proxy to run when opening each new database connection.
- max
Connections numberPercent - The maximum size of the connection pool for each target in a target group.
- max
Idle numberConnections Percent - Controls how actively the proxy closes idle database connections in the connection pool.
- session
Pinning string[]Filters - Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection.
- connection_
borrow_ inttimeout - The number of seconds for a proxy to wait for a connection to become available in the connection pool.
- init_
query str - One or more SQL statements for the proxy to run when opening each new database connection.
- max_
connections_ intpercent - The maximum size of the connection pool for each target in a target group.
- max_
idle_ intconnections_ percent - Controls how actively the proxy closes idle database connections in the connection pool.
- session_
pinning_ Sequence[str]filters - Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection.
- connection
Borrow NumberTimeout - The number of seconds for a proxy to wait for a connection to become available in the connection pool.
- init
Query String - One or more SQL statements for the proxy to run when opening each new database connection.
- max
Connections NumberPercent - The maximum size of the connection pool for each target in a target group.
- max
Idle NumberConnections Percent - Controls how actively the proxy closes idle database connections in the connection pool.
- session
Pinning List<String>Filters - Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection.
DbProxyTargetGroupTargetGroupName, DbProxyTargetGroupTargetGroupNameArgs
- Default
- default
- Db
Proxy Target Group Target Group Name Default - default
- Default
- default
- Default
- default
- DEFAULT
- default
- "default"
- default
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.