Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. rds
  5. ProxyTarget
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.rds.ProxyTarget

Explore with Pulumi AI

AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

Provides an RDS DB proxy target resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.rds.Proxy("example", {
    name: "example",
    debugLogging: false,
    engineFamily: "MYSQL",
    idleClientTimeout: 1800,
    requireTls: true,
    roleArn: exampleAwsIamRole.arn,
    vpcSecurityGroupIds: [exampleAwsSecurityGroup.id],
    vpcSubnetIds: [exampleAwsSubnet.id],
    auths: [{
        authScheme: "SECRETS",
        description: "example",
        iamAuth: "DISABLED",
        secretArn: exampleAwsSecretsmanagerSecret.arn,
    }],
    tags: {
        Name: "example",
        Key: "value",
    },
});
const exampleProxyDefaultTargetGroup = new aws.rds.ProxyDefaultTargetGroup("example", {
    dbProxyName: example.name,
    connectionPoolConfig: {
        connectionBorrowTimeout: 120,
        initQuery: "SET x=1, y=2",
        maxConnectionsPercent: 100,
        maxIdleConnectionsPercent: 50,
        sessionPinningFilters: ["EXCLUDE_VARIABLE_SETS"],
    },
});
const exampleProxyTarget = new aws.rds.ProxyTarget("example", {
    dbInstanceIdentifier: exampleAwsDbInstance.identifier,
    dbProxyName: example.name,
    targetGroupName: exampleProxyDefaultTargetGroup.name,
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.rds.Proxy("example",
    name="example",
    debug_logging=False,
    engine_family="MYSQL",
    idle_client_timeout=1800,
    require_tls=True,
    role_arn=example_aws_iam_role["arn"],
    vpc_security_group_ids=[example_aws_security_group["id"]],
    vpc_subnet_ids=[example_aws_subnet["id"]],
    auths=[{
        "auth_scheme": "SECRETS",
        "description": "example",
        "iam_auth": "DISABLED",
        "secret_arn": example_aws_secretsmanager_secret["arn"],
    }],
    tags={
        "Name": "example",
        "Key": "value",
    })
example_proxy_default_target_group = aws.rds.ProxyDefaultTargetGroup("example",
    db_proxy_name=example.name,
    connection_pool_config={
        "connection_borrow_timeout": 120,
        "init_query": "SET x=1, y=2",
        "max_connections_percent": 100,
        "max_idle_connections_percent": 50,
        "session_pinning_filters": ["EXCLUDE_VARIABLE_SETS"],
    })
example_proxy_target = aws.rds.ProxyTarget("example",
    db_instance_identifier=example_aws_db_instance["identifier"],
    db_proxy_name=example.name,
    target_group_name=example_proxy_default_target_group.name)
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := rds.NewProxy(ctx, "example", &rds.ProxyArgs{
			Name:              pulumi.String("example"),
			DebugLogging:      pulumi.Bool(false),
			EngineFamily:      pulumi.String("MYSQL"),
			IdleClientTimeout: pulumi.Int(1800),
			RequireTls:        pulumi.Bool(true),
			RoleArn:           pulumi.Any(exampleAwsIamRole.Arn),
			VpcSecurityGroupIds: pulumi.StringArray{
				exampleAwsSecurityGroup.Id,
			},
			VpcSubnetIds: pulumi.StringArray{
				exampleAwsSubnet.Id,
			},
			Auths: rds.ProxyAuthArray{
				&rds.ProxyAuthArgs{
					AuthScheme:  pulumi.String("SECRETS"),
					Description: pulumi.String("example"),
					IamAuth:     pulumi.String("DISABLED"),
					SecretArn:   pulumi.Any(exampleAwsSecretsmanagerSecret.Arn),
				},
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example"),
				"Key":  pulumi.String("value"),
			},
		})
		if err != nil {
			return err
		}
		exampleProxyDefaultTargetGroup, err := rds.NewProxyDefaultTargetGroup(ctx, "example", &rds.ProxyDefaultTargetGroupArgs{
			DbProxyName: example.Name,
			ConnectionPoolConfig: &rds.ProxyDefaultTargetGroupConnectionPoolConfigArgs{
				ConnectionBorrowTimeout:   pulumi.Int(120),
				InitQuery:                 pulumi.String("SET x=1, y=2"),
				MaxConnectionsPercent:     pulumi.Int(100),
				MaxIdleConnectionsPercent: pulumi.Int(50),
				SessionPinningFilters: pulumi.StringArray{
					pulumi.String("EXCLUDE_VARIABLE_SETS"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = rds.NewProxyTarget(ctx, "example", &rds.ProxyTargetArgs{
			DbInstanceIdentifier: pulumi.Any(exampleAwsDbInstance.Identifier),
			DbProxyName:          example.Name,
			TargetGroupName:      exampleProxyDefaultTargetGroup.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Rds.Proxy("example", new()
    {
        Name = "example",
        DebugLogging = false,
        EngineFamily = "MYSQL",
        IdleClientTimeout = 1800,
        RequireTls = true,
        RoleArn = exampleAwsIamRole.Arn,
        VpcSecurityGroupIds = new[]
        {
            exampleAwsSecurityGroup.Id,
        },
        VpcSubnetIds = new[]
        {
            exampleAwsSubnet.Id,
        },
        Auths = new[]
        {
            new Aws.Rds.Inputs.ProxyAuthArgs
            {
                AuthScheme = "SECRETS",
                Description = "example",
                IamAuth = "DISABLED",
                SecretArn = exampleAwsSecretsmanagerSecret.Arn,
            },
        },
        Tags = 
        {
            { "Name", "example" },
            { "Key", "value" },
        },
    });

    var exampleProxyDefaultTargetGroup = new Aws.Rds.ProxyDefaultTargetGroup("example", new()
    {
        DbProxyName = example.Name,
        ConnectionPoolConfig = new Aws.Rds.Inputs.ProxyDefaultTargetGroupConnectionPoolConfigArgs
        {
            ConnectionBorrowTimeout = 120,
            InitQuery = "SET x=1, y=2",
            MaxConnectionsPercent = 100,
            MaxIdleConnectionsPercent = 50,
            SessionPinningFilters = new[]
            {
                "EXCLUDE_VARIABLE_SETS",
            },
        },
    });

    var exampleProxyTarget = new Aws.Rds.ProxyTarget("example", new()
    {
        DbInstanceIdentifier = exampleAwsDbInstance.Identifier,
        DbProxyName = example.Name,
        TargetGroupName = exampleProxyDefaultTargetGroup.Name,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.Proxy;
import com.pulumi.aws.rds.ProxyArgs;
import com.pulumi.aws.rds.inputs.ProxyAuthArgs;
import com.pulumi.aws.rds.ProxyDefaultTargetGroup;
import com.pulumi.aws.rds.ProxyDefaultTargetGroupArgs;
import com.pulumi.aws.rds.inputs.ProxyDefaultTargetGroupConnectionPoolConfigArgs;
import com.pulumi.aws.rds.ProxyTarget;
import com.pulumi.aws.rds.ProxyTargetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Proxy("example", ProxyArgs.builder()
            .name("example")
            .debugLogging(false)
            .engineFamily("MYSQL")
            .idleClientTimeout(1800)
            .requireTls(true)
            .roleArn(exampleAwsIamRole.arn())
            .vpcSecurityGroupIds(exampleAwsSecurityGroup.id())
            .vpcSubnetIds(exampleAwsSubnet.id())
            .auths(ProxyAuthArgs.builder()
                .authScheme("SECRETS")
                .description("example")
                .iamAuth("DISABLED")
                .secretArn(exampleAwsSecretsmanagerSecret.arn())
                .build())
            .tags(Map.ofEntries(
                Map.entry("Name", "example"),
                Map.entry("Key", "value")
            ))
            .build());

        var exampleProxyDefaultTargetGroup = new ProxyDefaultTargetGroup("exampleProxyDefaultTargetGroup", ProxyDefaultTargetGroupArgs.builder()
            .dbProxyName(example.name())
            .connectionPoolConfig(ProxyDefaultTargetGroupConnectionPoolConfigArgs.builder()
                .connectionBorrowTimeout(120)
                .initQuery("SET x=1, y=2")
                .maxConnectionsPercent(100)
                .maxIdleConnectionsPercent(50)
                .sessionPinningFilters("EXCLUDE_VARIABLE_SETS")
                .build())
            .build());

        var exampleProxyTarget = new ProxyTarget("exampleProxyTarget", ProxyTargetArgs.builder()
            .dbInstanceIdentifier(exampleAwsDbInstance.identifier())
            .dbProxyName(example.name())
            .targetGroupName(exampleProxyDefaultTargetGroup.name())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:rds:Proxy
    properties:
      name: example
      debugLogging: false
      engineFamily: MYSQL
      idleClientTimeout: 1800
      requireTls: true
      roleArn: ${exampleAwsIamRole.arn}
      vpcSecurityGroupIds:
        - ${exampleAwsSecurityGroup.id}
      vpcSubnetIds:
        - ${exampleAwsSubnet.id}
      auths:
        - authScheme: SECRETS
          description: example
          iamAuth: DISABLED
          secretArn: ${exampleAwsSecretsmanagerSecret.arn}
      tags:
        Name: example
        Key: value
  exampleProxyDefaultTargetGroup:
    type: aws:rds:ProxyDefaultTargetGroup
    name: example
    properties:
      dbProxyName: ${example.name}
      connectionPoolConfig:
        connectionBorrowTimeout: 120
        initQuery: SET x=1, y=2
        maxConnectionsPercent: 100
        maxIdleConnectionsPercent: 50
        sessionPinningFilters:
          - EXCLUDE_VARIABLE_SETS
  exampleProxyTarget:
    type: aws:rds:ProxyTarget
    name: example
    properties:
      dbInstanceIdentifier: ${exampleAwsDbInstance.identifier}
      dbProxyName: ${example.name}
      targetGroupName: ${exampleProxyDefaultTargetGroup.name}
Copy

Create ProxyTarget Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ProxyTarget(name: string, args: ProxyTargetArgs, opts?: CustomResourceOptions);
@overload
def ProxyTarget(resource_name: str,
                args: ProxyTargetArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def ProxyTarget(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                db_proxy_name: Optional[str] = None,
                target_group_name: Optional[str] = None,
                db_cluster_identifier: Optional[str] = None,
                db_instance_identifier: Optional[str] = None)
func NewProxyTarget(ctx *Context, name string, args ProxyTargetArgs, opts ...ResourceOption) (*ProxyTarget, error)
public ProxyTarget(string name, ProxyTargetArgs args, CustomResourceOptions? opts = null)
public ProxyTarget(String name, ProxyTargetArgs args)
public ProxyTarget(String name, ProxyTargetArgs args, CustomResourceOptions options)

type: aws:rds:ProxyTarget
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ProxyTargetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ProxyTargetArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ProxyTargetArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ProxyTargetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ProxyTargetArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var proxyTargetResource = new Aws.Rds.ProxyTarget("proxyTargetResource", new()
{
    DbProxyName = "string",
    TargetGroupName = "string",
    DbClusterIdentifier = "string",
    DbInstanceIdentifier = "string",
});
Copy
example, err := rds.NewProxyTarget(ctx, "proxyTargetResource", &rds.ProxyTargetArgs{
	DbProxyName:          pulumi.String("string"),
	TargetGroupName:      pulumi.String("string"),
	DbClusterIdentifier:  pulumi.String("string"),
	DbInstanceIdentifier: pulumi.String("string"),
})
Copy
var proxyTargetResource = new ProxyTarget("proxyTargetResource", ProxyTargetArgs.builder()
    .dbProxyName("string")
    .targetGroupName("string")
    .dbClusterIdentifier("string")
    .dbInstanceIdentifier("string")
    .build());
Copy
proxy_target_resource = aws.rds.ProxyTarget("proxyTargetResource",
    db_proxy_name="string",
    target_group_name="string",
    db_cluster_identifier="string",
    db_instance_identifier="string")
Copy
const proxyTargetResource = new aws.rds.ProxyTarget("proxyTargetResource", {
    dbProxyName: "string",
    targetGroupName: "string",
    dbClusterIdentifier: "string",
    dbInstanceIdentifier: "string",
});
Copy
type: aws:rds:ProxyTarget
properties:
    dbClusterIdentifier: string
    dbInstanceIdentifier: string
    dbProxyName: string
    targetGroupName: string
Copy

ProxyTarget 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 ProxyTarget resource accepts the following input properties:

DbProxyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the DB proxy.
TargetGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the target group.
DbClusterIdentifier Changes to this property will trigger replacement. string

DB cluster identifier.

NOTE: Either db_instance_identifier or db_cluster_identifier should be specified and both should not be specified together

DbInstanceIdentifier Changes to this property will trigger replacement. string
DB instance identifier.
DbProxyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the DB proxy.
TargetGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the target group.
DbClusterIdentifier Changes to this property will trigger replacement. string

DB cluster identifier.

NOTE: Either db_instance_identifier or db_cluster_identifier should be specified and both should not be specified together

DbInstanceIdentifier Changes to this property will trigger replacement. string
DB instance identifier.
dbProxyName
This property is required.
Changes to this property will trigger replacement.
String
The name of the DB proxy.
targetGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the target group.
dbClusterIdentifier Changes to this property will trigger replacement. String

DB cluster identifier.

NOTE: Either db_instance_identifier or db_cluster_identifier should be specified and both should not be specified together

dbInstanceIdentifier Changes to this property will trigger replacement. String
DB instance identifier.
dbProxyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the DB proxy.
targetGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the target group.
dbClusterIdentifier Changes to this property will trigger replacement. string

DB cluster identifier.

NOTE: Either db_instance_identifier or db_cluster_identifier should be specified and both should not be specified together

dbInstanceIdentifier Changes to this property will trigger replacement. string
DB instance identifier.
db_proxy_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the DB proxy.
target_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the target group.
db_cluster_identifier Changes to this property will trigger replacement. str

DB cluster identifier.

NOTE: Either db_instance_identifier or db_cluster_identifier should be specified and both should not be specified together

db_instance_identifier Changes to this property will trigger replacement. str
DB instance identifier.
dbProxyName
This property is required.
Changes to this property will trigger replacement.
String
The name of the DB proxy.
targetGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the target group.
dbClusterIdentifier Changes to this property will trigger replacement. String

DB cluster identifier.

NOTE: Either db_instance_identifier or db_cluster_identifier should be specified and both should not be specified together

dbInstanceIdentifier Changes to this property will trigger replacement. String
DB instance identifier.

Outputs

All input properties are implicitly available as output properties. Additionally, the ProxyTarget resource produces the following output properties:

Endpoint string
Hostname for the target RDS DB Instance. Only returned for RDS_INSTANCE type.
Id string
The provider-assigned unique ID for this managed resource.
Port int
Port for the target RDS DB Instance or Aurora DB Cluster.
RdsResourceId string
Identifier representing the DB Instance or DB Cluster target.
TargetArn string
Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API.
TrackedClusterId string
DB Cluster identifier for the DB Instance target. Not returned unless manually importing an RDS_INSTANCE target that is part of a DB Cluster.
Type string
Type of targetE.g., RDS_INSTANCE or TRACKED_CLUSTER
Endpoint string
Hostname for the target RDS DB Instance. Only returned for RDS_INSTANCE type.
Id string
The provider-assigned unique ID for this managed resource.
Port int
Port for the target RDS DB Instance or Aurora DB Cluster.
RdsResourceId string
Identifier representing the DB Instance or DB Cluster target.
TargetArn string
Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API.
TrackedClusterId string
DB Cluster identifier for the DB Instance target. Not returned unless manually importing an RDS_INSTANCE target that is part of a DB Cluster.
Type string
Type of targetE.g., RDS_INSTANCE or TRACKED_CLUSTER
endpoint String
Hostname for the target RDS DB Instance. Only returned for RDS_INSTANCE type.
id String
The provider-assigned unique ID for this managed resource.
port Integer
Port for the target RDS DB Instance or Aurora DB Cluster.
rdsResourceId String
Identifier representing the DB Instance or DB Cluster target.
targetArn String
Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API.
trackedClusterId String
DB Cluster identifier for the DB Instance target. Not returned unless manually importing an RDS_INSTANCE target that is part of a DB Cluster.
type String
Type of targetE.g., RDS_INSTANCE or TRACKED_CLUSTER
endpoint string
Hostname for the target RDS DB Instance. Only returned for RDS_INSTANCE type.
id string
The provider-assigned unique ID for this managed resource.
port number
Port for the target RDS DB Instance or Aurora DB Cluster.
rdsResourceId string
Identifier representing the DB Instance or DB Cluster target.
targetArn string
Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API.
trackedClusterId string
DB Cluster identifier for the DB Instance target. Not returned unless manually importing an RDS_INSTANCE target that is part of a DB Cluster.
type string
Type of targetE.g., RDS_INSTANCE or TRACKED_CLUSTER
endpoint str
Hostname for the target RDS DB Instance. Only returned for RDS_INSTANCE type.
id str
The provider-assigned unique ID for this managed resource.
port int
Port for the target RDS DB Instance or Aurora DB Cluster.
rds_resource_id str
Identifier representing the DB Instance or DB Cluster target.
target_arn str
Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API.
tracked_cluster_id str
DB Cluster identifier for the DB Instance target. Not returned unless manually importing an RDS_INSTANCE target that is part of a DB Cluster.
type str
Type of targetE.g., RDS_INSTANCE or TRACKED_CLUSTER
endpoint String
Hostname for the target RDS DB Instance. Only returned for RDS_INSTANCE type.
id String
The provider-assigned unique ID for this managed resource.
port Number
Port for the target RDS DB Instance or Aurora DB Cluster.
rdsResourceId String
Identifier representing the DB Instance or DB Cluster target.
targetArn String
Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API.
trackedClusterId String
DB Cluster identifier for the DB Instance target. Not returned unless manually importing an RDS_INSTANCE target that is part of a DB Cluster.
type String
Type of targetE.g., RDS_INSTANCE or TRACKED_CLUSTER

Look up Existing ProxyTarget Resource

Get an existing ProxyTarget resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ProxyTargetState, opts?: CustomResourceOptions): ProxyTarget
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        db_cluster_identifier: Optional[str] = None,
        db_instance_identifier: Optional[str] = None,
        db_proxy_name: Optional[str] = None,
        endpoint: Optional[str] = None,
        port: Optional[int] = None,
        rds_resource_id: Optional[str] = None,
        target_arn: Optional[str] = None,
        target_group_name: Optional[str] = None,
        tracked_cluster_id: Optional[str] = None,
        type: Optional[str] = None) -> ProxyTarget
func GetProxyTarget(ctx *Context, name string, id IDInput, state *ProxyTargetState, opts ...ResourceOption) (*ProxyTarget, error)
public static ProxyTarget Get(string name, Input<string> id, ProxyTargetState? state, CustomResourceOptions? opts = null)
public static ProxyTarget get(String name, Output<String> id, ProxyTargetState state, CustomResourceOptions options)
resources:  _:    type: aws:rds:ProxyTarget    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
DbClusterIdentifier Changes to this property will trigger replacement. string

DB cluster identifier.

NOTE: Either db_instance_identifier or db_cluster_identifier should be specified and both should not be specified together

DbInstanceIdentifier Changes to this property will trigger replacement. string
DB instance identifier.
DbProxyName Changes to this property will trigger replacement. string
The name of the DB proxy.
Endpoint string
Hostname for the target RDS DB Instance. Only returned for RDS_INSTANCE type.
Port int
Port for the target RDS DB Instance or Aurora DB Cluster.
RdsResourceId string
Identifier representing the DB Instance or DB Cluster target.
TargetArn string
Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API.
TargetGroupName Changes to this property will trigger replacement. string
The name of the target group.
TrackedClusterId string
DB Cluster identifier for the DB Instance target. Not returned unless manually importing an RDS_INSTANCE target that is part of a DB Cluster.
Type string
Type of targetE.g., RDS_INSTANCE or TRACKED_CLUSTER
DbClusterIdentifier Changes to this property will trigger replacement. string

DB cluster identifier.

NOTE: Either db_instance_identifier or db_cluster_identifier should be specified and both should not be specified together

DbInstanceIdentifier Changes to this property will trigger replacement. string
DB instance identifier.
DbProxyName Changes to this property will trigger replacement. string
The name of the DB proxy.
Endpoint string
Hostname for the target RDS DB Instance. Only returned for RDS_INSTANCE type.
Port int
Port for the target RDS DB Instance or Aurora DB Cluster.
RdsResourceId string
Identifier representing the DB Instance or DB Cluster target.
TargetArn string
Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API.
TargetGroupName Changes to this property will trigger replacement. string
The name of the target group.
TrackedClusterId string
DB Cluster identifier for the DB Instance target. Not returned unless manually importing an RDS_INSTANCE target that is part of a DB Cluster.
Type string
Type of targetE.g., RDS_INSTANCE or TRACKED_CLUSTER
dbClusterIdentifier Changes to this property will trigger replacement. String

DB cluster identifier.

NOTE: Either db_instance_identifier or db_cluster_identifier should be specified and both should not be specified together

dbInstanceIdentifier Changes to this property will trigger replacement. String
DB instance identifier.
dbProxyName Changes to this property will trigger replacement. String
The name of the DB proxy.
endpoint String
Hostname for the target RDS DB Instance. Only returned for RDS_INSTANCE type.
port Integer
Port for the target RDS DB Instance or Aurora DB Cluster.
rdsResourceId String
Identifier representing the DB Instance or DB Cluster target.
targetArn String
Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API.
targetGroupName Changes to this property will trigger replacement. String
The name of the target group.
trackedClusterId String
DB Cluster identifier for the DB Instance target. Not returned unless manually importing an RDS_INSTANCE target that is part of a DB Cluster.
type String
Type of targetE.g., RDS_INSTANCE or TRACKED_CLUSTER
dbClusterIdentifier Changes to this property will trigger replacement. string

DB cluster identifier.

NOTE: Either db_instance_identifier or db_cluster_identifier should be specified and both should not be specified together

dbInstanceIdentifier Changes to this property will trigger replacement. string
DB instance identifier.
dbProxyName Changes to this property will trigger replacement. string
The name of the DB proxy.
endpoint string
Hostname for the target RDS DB Instance. Only returned for RDS_INSTANCE type.
port number
Port for the target RDS DB Instance or Aurora DB Cluster.
rdsResourceId string
Identifier representing the DB Instance or DB Cluster target.
targetArn string
Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API.
targetGroupName Changes to this property will trigger replacement. string
The name of the target group.
trackedClusterId string
DB Cluster identifier for the DB Instance target. Not returned unless manually importing an RDS_INSTANCE target that is part of a DB Cluster.
type string
Type of targetE.g., RDS_INSTANCE or TRACKED_CLUSTER
db_cluster_identifier Changes to this property will trigger replacement. str

DB cluster identifier.

NOTE: Either db_instance_identifier or db_cluster_identifier should be specified and both should not be specified together

db_instance_identifier Changes to this property will trigger replacement. str
DB instance identifier.
db_proxy_name Changes to this property will trigger replacement. str
The name of the DB proxy.
endpoint str
Hostname for the target RDS DB Instance. Only returned for RDS_INSTANCE type.
port int
Port for the target RDS DB Instance or Aurora DB Cluster.
rds_resource_id str
Identifier representing the DB Instance or DB Cluster target.
target_arn str
Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API.
target_group_name Changes to this property will trigger replacement. str
The name of the target group.
tracked_cluster_id str
DB Cluster identifier for the DB Instance target. Not returned unless manually importing an RDS_INSTANCE target that is part of a DB Cluster.
type str
Type of targetE.g., RDS_INSTANCE or TRACKED_CLUSTER
dbClusterIdentifier Changes to this property will trigger replacement. String

DB cluster identifier.

NOTE: Either db_instance_identifier or db_cluster_identifier should be specified and both should not be specified together

dbInstanceIdentifier Changes to this property will trigger replacement. String
DB instance identifier.
dbProxyName Changes to this property will trigger replacement. String
The name of the DB proxy.
endpoint String
Hostname for the target RDS DB Instance. Only returned for RDS_INSTANCE type.
port Number
Port for the target RDS DB Instance or Aurora DB Cluster.
rdsResourceId String
Identifier representing the DB Instance or DB Cluster target.
targetArn String
Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API.
targetGroupName Changes to this property will trigger replacement. String
The name of the target group.
trackedClusterId String
DB Cluster identifier for the DB Instance target. Not returned unless manually importing an RDS_INSTANCE target that is part of a DB Cluster.
type String
Type of targetE.g., RDS_INSTANCE or TRACKED_CLUSTER

Import

Provisioned Clusters:

Using pulumi import to import RDS DB Proxy Targets using the db_proxy_name, target_group_name, target type (such as RDS_INSTANCE or TRACKED_CLUSTER), and resource identifier separated by forward slashes (/). For example:

Instances:

$ pulumi import aws:rds/proxyTarget:ProxyTarget example example-proxy/default/RDS_INSTANCE/example-instance
Copy

Provisioned Clusters:

$ pulumi import aws:rds/proxyTarget:ProxyTarget example example-proxy/default/TRACKED_CLUSTER/example-cluster
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws