We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.6.0 published on Monday, Nov 4, 2024 by Pulumi
aws-native.rds.getDbProxyEndpoint
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.6.0 published on Monday, Nov 4, 2024 by Pulumi
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:rds:getDbProxyEndpoint
arguments:
# arguments dictionary
The following arguments are supported:
- Db
Proxy stringEndpoint Name - 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 stringEndpoint Name - 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 StringEndpoint Name - 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 stringEndpoint Name - 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_ strendpoint_ name - 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 StringEndpoint Name - 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:
- Db
Proxy stringEndpoint Arn - 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.
- 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.
- List<Pulumi.
Aws Native. Outputs. Tag> - An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
- Target
Role Pulumi.Aws Native. Rds. Db Proxy Endpoint Target Role - A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
- Vpc
Id string - VPC ID to associate with the new DB proxy endpoint.
- Vpc
Security List<string>Group Ids - VPC security group IDs to associate with the new DB proxy endpoint.
- Db
Proxy stringEndpoint Arn - 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.
- 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.
- Tag
- An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
- Target
Role DbProxy Endpoint Target Role - A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
- Vpc
Id string - VPC ID to associate with the new DB proxy endpoint.
- Vpc
Security []stringGroup Ids - VPC security group IDs to associate with the new DB proxy endpoint.
- db
Proxy StringEndpoint Arn - 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.
- is
Default 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.
- List<Tag>
- An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
- target
Role DbProxy Endpoint Target Role - A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
- vpc
Id String - VPC ID to associate with the new DB proxy endpoint.
- vpc
Security List<String>Group Ids - VPC security group IDs to associate with the new DB proxy endpoint.
- db
Proxy stringEndpoint Arn - 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.
- is
Default 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.
- Tag[]
- An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
- target
Role DbProxy Endpoint Target Role - A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
- vpc
Id string - VPC ID to associate with the new DB proxy endpoint.
- vpc
Security string[]Group Ids - VPC security group IDs to associate with the new DB proxy endpoint.
- db_
proxy_ strendpoint_ arn - 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.
- Sequence[root_Tag]
- An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
- target_
role DbProxy Endpoint Target Role - 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_ Sequence[str]group_ ids - VPC security group IDs to associate with the new DB proxy endpoint.
- db
Proxy StringEndpoint Arn - 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.
- is
Default 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.
- List<Property Map>
- An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
- target
Role "READ_WRITE" | "READ_ONLY" - A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
- vpc
Id String - VPC ID to associate with the new DB proxy endpoint.
- vpc
Security List<String>Group Ids - VPC security group IDs to associate with the new DB proxy endpoint.
Supporting Types
DbProxyEndpointTargetRole
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.6.0 published on Monday, Nov 4, 2024 by Pulumi