ProxyEndpoint class

Provides an RDS DB proxy endpoint resource. For additional information, see the RDS User Guide.

Example Usage

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

const example = new aws.rds.ProxyEndpoint("example", {
    dbProxyName: test.name,
    dbProxyEndpointName: "example",
    vpcSubnetIds: testAwsSubnet.map(__item => __item.id),
    targetRole: "READ_ONLY",
});
import pulumi
import pulumi_aws as aws

example = aws.rds.ProxyEndpoint("example",
    db_proxy_name=test["name"],
    db_proxy_endpoint_name="example",
    vpc_subnet_ids=[__item["id"] for __item in test_aws_subnet],
    target_role="READ_ONLY")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Rds.ProxyEndpoint("example", new()
    {
        DbProxyName = test.Name,
        DbProxyEndpointName = "example",
        VpcSubnetIds = testAwsSubnet.Select(__item => __item.Id).ToList(),
        TargetRole = "READ_ONLY",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
var splat0 []interface{}
for _, val0 := range testAwsSubnet {
splat0 = append(splat0, val0.(map[string]interface{})["id"])
}
_, err := rds.NewProxyEndpoint(ctx, "example", &rds.ProxyEndpointArgs{
DbProxyName: pulumi.Any(test.Name),
DbProxyEndpointName: pulumi.String("example"),
VpcSubnetIds: toPulumiArray(splat0),
TargetRole: pulumi.String("READ_ONLY"),
})
if err != nil {
return err
}
return nil
})
}
func toPulumiArray(arr []) pulumi.Array {
var pulumiArr pulumi.Array
for _, v := range arr {
pulumiArr = append(pulumiArr, pulumi.(v))
}
return pulumiArr
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_rds_proxyendpoint" "example" {
  db_proxy_name          = test.name
  db_proxy_endpoint_name = "example"
  vpc_subnet_ids         = testAwsSubnet[*].id
  target_role            = "READ_ONLY"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.ProxyEndpoint;
import com.pulumi.aws.rds.ProxyEndpointArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 ProxyEndpoint("example", ProxyEndpointArgs.builder()
            .dbProxyName(test.name())
            .dbProxyEndpointName("example")
            .vpcSubnetIds(testAwsSubnet.stream().map(element -> element.id()).collect(toList()))
            .targetRole("READ_ONLY")
            .build());

    }
}

Import

Using pulumi import, import DB proxy endpoints using the DB-PROXY-NAME/DB-PROXY-ENDPOINT-NAME. For example:

$ pulumi import aws:rds/proxyEndpoint:ProxyEndpoint example example/example

Constructors

ProxyEndpoint(String name, {ProxyEndpointArgs? args, CustomResourceOptions? options})
Creates a new ProxyEndpoint. name The Pulumi resource name. args Arguments used to configure this ProxyEndpoint. The set of arguments for ProxyEndpoint. options Resource options controlling this resource's behavior.
ProxyEndpoint.reference(String urn)
Creates a typed reference to an existing ProxyEndpoint resource.

Properties

arn ↔ Output<String>
ARN for the proxy endpoint.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
dbProxyEndpointName ↔ Output<String>
The identifier for the proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
latefinal
dbProxyName ↔ Output<String>
The name of the DB proxy associated with the DB proxy endpoint that you create.
latefinal
endpoint ↔ Output<String>
The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isDefault ↔ Output<bool>
Indicates whether this endpoint is the default endpoint for the associated DB proxy.
latefinal
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
A mapping of tags to assign to the resource.
latefinal
tagsAll ↔ Output<Map<String, String>>
latefinal
targetRole ↔ Output<String?>
Indicates whether the DB proxy endpoint can be used for read/write or read-only operations. The default is READ_WRITE. Valid values are READ_WRITE and READ_ONLY.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
vpcId ↔ Output<String>
The VPC ID of the DB proxy endpoint.
latefinal
vpcSecurityGroupIds ↔ Output<List<String>>
One or more VPC security group IDs to associate with the new proxy.
latefinal
vpcSubnetIds ↔ Output<List<String>>
One or more VPC subnet IDs to associate with the new proxy.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ProxyEndpointState? state, CustomResourceOptions? options}) → ProxyEndpoint
Gets an existing ProxyEndpoint resource's state with the given name and id.