ProxyEndpointArgs

data class ProxyEndpointArgs(val dbProxyEndpointName: Output<String>? = null, val dbProxyName: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val targetRole: Output<String>? = null, val vpcSecurityGroupIds: Output<List<String>>? = null, val vpcSubnetIds: Output<List<String>>? = null) : ConvertibleToJava<ProxyEndpointArgs>

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/v6/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.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
}
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.List;
import java.util.ArrayList;
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

Link copied to clipboard
constructor(dbProxyEndpointName: Output<String>? = null, dbProxyName: Output<String>? = null, tags: Output<Map<String, String>>? = null, targetRole: Output<String>? = null, vpcSecurityGroupIds: Output<List<String>>? = null, vpcSubnetIds: Output<List<String>>? = null)

Properties

Link copied to clipboard
val dbProxyEndpointName: Output<String>? = null

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.

Link copied to clipboard
val dbProxyName: Output<String>? = null

The name of the DB proxy associated with the DB proxy endpoint that you create.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

A mapping of tags to assign to the resource.

Link copied to clipboard
val targetRole: Output<String>? = null

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.

Link copied to clipboard
val vpcSecurityGroupIds: Output<List<String>>? = null

One or more VPC security group IDs to associate with the new proxy.

Link copied to clipboard
val vpcSubnetIds: Output<List<String>>? = null

One or more VPC subnet IDs to associate with the new proxy.

Functions

Link copied to clipboard
open override fun toJava(): ProxyEndpointArgs