← All packages

AWS Native

Pulumi Official

Package maintained by Pulumi

v0.17.0 published on Monday, May 23, 2022 by Pulumi

Source code

getDBProxyEndpoint

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(d_b_proxy_endpoint_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetDBProxyEndpointResult
def get_db_proxy_endpoint_output(d_b_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)
// Output-based functions aren't available in Java yet

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.

d_b_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.RDS.Outputs.DBProxyEndpointTagFormat>: An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
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 []DBProxyEndpointTagFormat: An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
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 ListEndpointTagFormat>: An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
vpcId String: VPC ID to associate with the new DB proxy endpoint.
vpcSecurityGroupIds List: 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 DBProxyEndpointTagFormat[]: An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
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.

d_b_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[DBProxyEndpointTagFormat]: An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
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: An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
vpcId String: VPC ID to associate with the new DB proxy endpoint.
vpcSecurityGroupIds List: VPC security group IDs to associate with the new DB proxy endpoint.

Supporting Types

DBProxyEndpointTagFormat

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