1. Packages
  2. AWS
  3. API Docs
  4. rds
  5. ProxyTarget
AWS v7.16.0 published on Friday, Jan 9, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.rds.ProxyTarget

aws logo
AWS v7.16.0 published on Friday, Jan 9, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Example Usage

    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,
                region: 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 string
    The unique name of the resource.
    args ProxyTargetArgs
    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 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 string
    The unique name of the resource.
    args ProxyTargetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProxyTargetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
    Region = "string",
});

    example, err := rds.NewProxyTarget(ctx, "proxyTargetResource", &rds.ProxyTargetArgs{
	DbProxyName:          pulumi.String("string"),
	TargetGroupName:      pulumi.String("string"),
	DbClusterIdentifier:  pulumi.String("string"),
	DbInstanceIdentifier: pulumi.String("string"),
	Region:               pulumi.String("string"),
})

    var proxyTargetResource = new ProxyTarget("proxyTargetResource", ProxyTargetArgs.builder()
    .dbProxyName("string")
    .targetGroupName("string")
    .dbClusterIdentifier("string")
    .dbInstanceIdentifier("string")
    .region("string")
    .build());

    proxy_target_resource = aws.rds.ProxyTarget("proxyTargetResource",
    db_proxy_name="string",
    target_group_name="string",
    db_cluster_identifier="string",
    db_instance_identifier="string",
    region="string")

    const proxyTargetResource = new aws.rds.ProxyTarget("proxyTargetResource", {
    dbProxyName: "string",
    targetGroupName: "string",
    dbClusterIdentifier: "string",
    dbInstanceIdentifier: "string",
    region: "string",
});

    type: aws:rds:ProxyTarget
properties:
    dbClusterIdentifier: string
    dbInstanceIdentifier: string
    dbProxyName: string
    region: string
    targetGroupName: string

    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 string
    The name of the DB proxy.
    TargetGroupName string
    The name of the target group.
    DbClusterIdentifier string

    DB cluster identifier.

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

    DbInstanceIdentifier string
    DB instance identifier.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    DbProxyName string
    The name of the DB proxy.
    TargetGroupName string
    The name of the target group.
    DbClusterIdentifier string

    DB cluster identifier.

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

    DbInstanceIdentifier string
    DB instance identifier.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    dbProxyName String
    The name of the DB proxy.
    targetGroupName String
    The name of the target group.
    dbClusterIdentifier String

    DB cluster identifier.

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

    dbInstanceIdentifier String
    DB instance identifier.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    dbProxyName string
    The name of the DB proxy.
    targetGroupName string
    The name of the target group.
    dbClusterIdentifier string

    DB cluster identifier.

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

    dbInstanceIdentifier string
    DB instance identifier.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    db_proxy_name str
    The name of the DB proxy.
    target_group_name str
    The name of the target group.
    db_cluster_identifier 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 str
    DB instance identifier.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    dbProxyName String
    The name of the DB proxy.
    targetGroupName String
    The name of the target group.
    dbClusterIdentifier String

    DB cluster identifier.

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

    dbInstanceIdentifier String
    DB instance identifier.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    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,
        region: 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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 string

    DB cluster identifier.

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

    DbInstanceIdentifier string
    DB instance identifier.
    DbProxyName 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.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    TargetArn string
    Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API.
    TargetGroupName 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 string

    DB cluster identifier.

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

    DbInstanceIdentifier string
    DB instance identifier.
    DbProxyName 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.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    TargetArn string
    Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API.
    TargetGroupName 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 String

    DB cluster identifier.

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

    dbInstanceIdentifier String
    DB instance identifier.
    dbProxyName 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.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    targetArn String
    Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API.
    targetGroupName 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 string

    DB cluster identifier.

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

    dbInstanceIdentifier string
    DB instance identifier.
    dbProxyName 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.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    targetArn string
    Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API.
    targetGroupName 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 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 str
    DB instance identifier.
    db_proxy_name 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.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    target_arn str
    Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API.
    target_group_name 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 String

    DB cluster identifier.

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

    dbInstanceIdentifier String
    DB instance identifier.
    dbProxyName 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.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    targetArn String
    Amazon Resource Name (ARN) for the DB instance or DB cluster. Currently not returned by the RDS API.
    targetGroupName 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

    Provisioned Clusters:

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

    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 logo
    AWS v7.16.0 published on Friday, Jan 9, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws
      Meet Neo: Your AI Platform Teammate