Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. rds
  5. getDbProxyEndpoint

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.getDbProxyEndpoint

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::RDS::DBProxyEndpoint.

    Using getDbProxyEndpoint

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDbProxyEndpoint(args: GetDbProxyEndpointArgs, opts?: InvokeOptions): Promise<GetDbProxyEndpointResult>
function getDbProxyEndpointOutput(args: GetDbProxyEndpointOutputArgs, opts?: InvokeOptions): Output<GetDbProxyEndpointResult>
    def get_db_proxy_endpoint(db_proxy_endpoint_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetDbProxyEndpointResult
def get_db_proxy_endpoint_output(db_proxy_endpoint_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetDbProxyEndpointResult]
    func LookupDbProxyEndpoint(ctx *Context, args *LookupDbProxyEndpointArgs, opts ...InvokeOption) (*LookupDbProxyEndpointResult, error)
func LookupDbProxyEndpointOutput(ctx *Context, args *LookupDbProxyEndpointOutputArgs, opts ...InvokeOption) LookupDbProxyEndpointResultOutput

    > Note: This function is named LookupDbProxyEndpoint in the Go SDK.

    public static class GetDbProxyEndpoint 
{
    public static Task<GetDbProxyEndpointResult> InvokeAsync(GetDbProxyEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetDbProxyEndpointResult> Invoke(GetDbProxyEndpointInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDbProxyEndpointResult> getDbProxyEndpoint(GetDbProxyEndpointArgs args, InvokeOptions options)
public static Output<GetDbProxyEndpointResult> getDbProxyEndpoint(GetDbProxyEndpointArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:rds:getDbProxyEndpoint
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DbProxyEndpointName string
    The identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
    DbProxyEndpointName string
    The identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
    dbProxyEndpointName String
    The identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
    dbProxyEndpointName string
    The identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
    db_proxy_endpoint_name str
    The identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
    dbProxyEndpointName String
    The identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.

    getDbProxyEndpoint Result

    The following output properties are available:

    DbProxyEndpointArn string
    The Amazon Resource Name (ARN) for the DB proxy endpoint.
    Endpoint string
    The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
    IsDefault bool
    A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
    TargetRole Pulumi.AwsNative.Rds.DbProxyEndpointTargetRole
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    VpcId string
    VPC ID to associate with the new DB proxy endpoint.
    VpcSecurityGroupIds List<string>
    VPC security group IDs to associate with the new DB proxy endpoint.
    DbProxyEndpointArn string
    The Amazon Resource Name (ARN) for the DB proxy endpoint.
    Endpoint string
    The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
    IsDefault bool
    A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
    Tags Tag
    An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
    TargetRole DbProxyEndpointTargetRole
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    VpcId string
    VPC ID to associate with the new DB proxy endpoint.
    VpcSecurityGroupIds []string
    VPC security group IDs to associate with the new DB proxy endpoint.
    dbProxyEndpointArn String
    The Amazon Resource Name (ARN) for the DB proxy endpoint.
    endpoint String
    The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
    isDefault Boolean
    A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
    tags List<Tag>
    An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
    targetRole DbProxyEndpointTargetRole
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    vpcId String
    VPC ID to associate with the new DB proxy endpoint.
    vpcSecurityGroupIds List<String>
    VPC security group IDs to associate with the new DB proxy endpoint.
    dbProxyEndpointArn string
    The Amazon Resource Name (ARN) for the DB proxy endpoint.
    endpoint string
    The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
    isDefault boolean
    A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
    tags Tag[]
    An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
    targetRole DbProxyEndpointTargetRole
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    vpcId string
    VPC ID to associate with the new DB proxy endpoint.
    vpcSecurityGroupIds string[]
    VPC security group IDs to associate with the new DB proxy endpoint.
    db_proxy_endpoint_arn str
    The Amazon Resource Name (ARN) for the DB proxy endpoint.
    endpoint str
    The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
    is_default bool
    A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
    tags Sequence[root_Tag]
    An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
    target_role DbProxyEndpointTargetRole
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    vpc_id str
    VPC ID to associate with the new DB proxy endpoint.
    vpc_security_group_ids Sequence[str]
    VPC security group IDs to associate with the new DB proxy endpoint.
    dbProxyEndpointArn String
    The Amazon Resource Name (ARN) for the DB proxy endpoint.
    endpoint String
    The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
    isDefault Boolean
    A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
    tags List<Property Map>
    An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
    targetRole "READ_WRITE" | "READ_ONLY"
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    vpcId String
    VPC ID to associate with the new DB proxy endpoint.
    vpcSecurityGroupIds List<String>
    VPC security group IDs to associate with the new DB proxy endpoint.

    Supporting Types

    DbProxyEndpointTargetRole

    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
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
    pulumi/pulumi-aws-native