AWS Native

v0.42.0 published on Wednesday, Nov 23, 2022 by Pulumi

DBProxyEndpoint

Resource schema for AWS::RDS::DBProxyEndpoint.

Example Usage

Example

using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var proxyEndpointName = config.Get("proxyEndpointName") ?? "exampleProxyEndpoint";
    var proxyName = config.Get("proxyName") ?? "exampleProxy";
    var securityGroupIds = config.Get("securityGroupIds") ?? "sg-12345678";
    var subnetIds = config.Get("subnetIds") ?? "subnet-12345677,subnet-12345678,subnet-12345679";
    var testDBProxy = new AwsNative.RDS.DBProxyEndpoint("testDBProxy", new()
    {
        DbProxyEndpointName = proxyEndpointName,
        DbProxyName = proxyName,
        VpcSecurityGroupIds = securityGroupIds.Split(","),
        VpcSubnetIds = subnetIds.Split(","),
        TargetRole = AwsNative.RDS.DBProxyEndpointTargetRole.ReadOnly,
    });

});

Coming soon!

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

config = pulumi.Config()
proxy_endpoint_name = config.get("proxyEndpointName")
if proxy_endpoint_name is None:
    proxy_endpoint_name = "exampleProxyEndpoint"
proxy_name = config.get("proxyName")
if proxy_name is None:
    proxy_name = "exampleProxy"
security_group_ids = config.get("securityGroupIds")
if security_group_ids is None:
    security_group_ids = "sg-12345678"
subnet_ids = config.get("subnetIds")
if subnet_ids is None:
    subnet_ids = "subnet-12345677,subnet-12345678,subnet-12345679"
test_db_proxy = aws_native.rds.DBProxyEndpoint("testDBProxy",
    db_proxy_endpoint_name=proxy_endpoint_name,
    db_proxy_name=proxy_name,
    vpc_security_group_ids=security_group_ids.split(","),
    vpc_subnet_ids=subnet_ids.split(","),
    target_role=aws_native.rds.DBProxyEndpointTargetRole.READ_ONLY)
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const config = new pulumi.Config();
const proxyEndpointName = config.get("proxyEndpointName") || "exampleProxyEndpoint";
const proxyName = config.get("proxyName") || "exampleProxy";
const securityGroupIds = config.get("securityGroupIds") || "sg-12345678";
const subnetIds = config.get("subnetIds") || "subnet-12345677,subnet-12345678,subnet-12345679";
const testDBProxy = new aws_native.rds.DBProxyEndpoint("testDBProxy", {
    dbProxyEndpointName: proxyEndpointName,
    dbProxyName: proxyName,
    vpcSecurityGroupIds: securityGroupIds.split(","),
    vpcSubnetIds: subnetIds.split(","),
    targetRole: aws_native.rds.DBProxyEndpointTargetRole.ReadOnly,
});

Coming soon!

Example

using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var proxyEndpointName = config.Get("proxyEndpointName") ?? "exampleProxyEndpoint";
    var proxyName = config.Get("proxyName") ?? "exampleProxy";
    var subnetIds = config.Get("subnetIds") ?? "subnet-12345677,subnet-12345678,subnet-12345679";
    var securityGroupIds = config.Get("securityGroupIds") ?? "sg-12345678";
    var testDBProxyEndpoint = new AwsNative.RDS.DBProxyEndpoint("testDBProxyEndpoint", new()
    {
        DbProxyEndpointName = proxyEndpointName,
        DbProxyName = proxyName,
        VpcSubnetIds = subnetIds.Split(","),
        VpcSecurityGroupIds = securityGroupIds.Split(","),
        TargetRole = AwsNative.RDS.DBProxyEndpointTargetRole.ReadOnly,
    });

});

Coming soon!

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

config = pulumi.Config()
proxy_endpoint_name = config.get("proxyEndpointName")
if proxy_endpoint_name is None:
    proxy_endpoint_name = "exampleProxyEndpoint"
proxy_name = config.get("proxyName")
if proxy_name is None:
    proxy_name = "exampleProxy"
subnet_ids = config.get("subnetIds")
if subnet_ids is None:
    subnet_ids = "subnet-12345677,subnet-12345678,subnet-12345679"
security_group_ids = config.get("securityGroupIds")
if security_group_ids is None:
    security_group_ids = "sg-12345678"
test_db_proxy_endpoint = aws_native.rds.DBProxyEndpoint("testDBProxyEndpoint",
    db_proxy_endpoint_name=proxy_endpoint_name,
    db_proxy_name=proxy_name,
    vpc_subnet_ids=subnet_ids.split(","),
    vpc_security_group_ids=security_group_ids.split(","),
    target_role=aws_native.rds.DBProxyEndpointTargetRole.READ_ONLY)
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const config = new pulumi.Config();
const proxyEndpointName = config.get("proxyEndpointName") || "exampleProxyEndpoint";
const proxyName = config.get("proxyName") || "exampleProxy";
const subnetIds = config.get("subnetIds") || "subnet-12345677,subnet-12345678,subnet-12345679";
const securityGroupIds = config.get("securityGroupIds") || "sg-12345678";
const testDBProxyEndpoint = new aws_native.rds.DBProxyEndpoint("testDBProxyEndpoint", {
    dbProxyEndpointName: proxyEndpointName,
    dbProxyName: proxyName,
    vpcSubnetIds: subnetIds.split(","),
    vpcSecurityGroupIds: securityGroupIds.split(","),
    targetRole: aws_native.rds.DBProxyEndpointTargetRole.ReadOnly,
});

Coming soon!

Create DBProxyEndpoint Resource

new DBProxyEndpoint(name: string, args: DBProxyEndpointArgs, opts?: CustomResourceOptions);
@overload
def DBProxyEndpoint(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    d_b_proxy_endpoint_name: Optional[str] = None,
                    d_b_proxy_name: Optional[str] = None,
                    tags: Optional[Sequence[DBProxyEndpointTagFormatArgs]] = None,
                    target_role: Optional[DBProxyEndpointTargetRole] = None,
                    vpc_security_group_ids: Optional[Sequence[str]] = None,
                    vpc_subnet_ids: Optional[Sequence[str]] = None)
@overload
def DBProxyEndpoint(resource_name: str,
                    args: DBProxyEndpointArgs,
                    opts: Optional[ResourceOptions] = None)
func NewDBProxyEndpoint(ctx *Context, name string, args DBProxyEndpointArgs, opts ...ResourceOption) (*DBProxyEndpoint, error)
public DBProxyEndpoint(string name, DBProxyEndpointArgs args, CustomResourceOptions? opts = null)
public DBProxyEndpoint(String name, DBProxyEndpointArgs args)
public DBProxyEndpoint(String name, DBProxyEndpointArgs args, CustomResourceOptions options)
type: aws-native:rds:DBProxyEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DBProxyEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DBProxyEndpointArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DBProxyEndpointArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DBProxyEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DBProxyEndpointArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DBProxyEndpoint Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DBProxyEndpoint resource accepts the following input properties:

DBProxyName string

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

VpcSubnetIds List<string>

VPC subnet IDs to associate with the new DB proxy endpoint.

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.

Tags List<Pulumi.AwsNative.RDS.Inputs.DBProxyEndpointTagFormatArgs>

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.

VpcSecurityGroupIds List<string>

VPC security group IDs to associate with the new DB proxy endpoint.

DBProxyName string

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

VpcSubnetIds []string

VPC subnet IDs to associate with the new DB proxy endpoint.

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.

Tags []DBProxyEndpointTagFormatArgs

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.

VpcSecurityGroupIds []string

VPC security group IDs to associate with the new DB proxy endpoint.

dBProxyName String

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

vpcSubnetIds List<String>

VPC subnet IDs to associate with the new DB proxy endpoint.

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.

tags List<DBProxyEndpointTagFormatArgs>

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.

vpcSecurityGroupIds List<String>

VPC security group IDs to associate with the new DB proxy endpoint.

dBProxyName string

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

vpcSubnetIds string[]

VPC subnet IDs to associate with the new DB proxy endpoint.

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.

tags DBProxyEndpointTagFormatArgs[]

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.

vpcSecurityGroupIds string[]

VPC security group IDs to associate with the new DB proxy endpoint.

d_b_proxy_name str

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

vpc_subnet_ids Sequence[str]

VPC subnet IDs to associate with the new DB proxy endpoint.

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.

tags Sequence[DBProxyEndpointTagFormatArgs]

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_security_group_ids Sequence[str]

VPC security group IDs to associate with the new DB proxy endpoint.

dBProxyName String

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

vpcSubnetIds List<String>

VPC subnet IDs to associate with the new DB proxy endpoint.

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.

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.

vpcSecurityGroupIds List<String>

VPC security group IDs to associate with the new DB proxy endpoint.

Outputs

All input properties are implicitly available as output properties. Additionally, the DBProxyEndpoint resource produces the following output properties:

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.

Id string

The provider-assigned unique ID for this managed resource.

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.

VpcId string

VPC ID 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.

Id string

The provider-assigned unique ID for this managed resource.

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.

VpcId string

VPC ID 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.

id String

The provider-assigned unique ID for this managed resource.

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.

vpcId String

VPC ID 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.

id string

The provider-assigned unique ID for this managed resource.

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.

vpcId string

VPC ID 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.

id str

The provider-assigned unique ID for this managed resource.

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.

vpc_id str

VPC ID 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.

id String

The provider-assigned unique ID for this managed resource.

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.

vpcId String

VPC ID 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

DBProxyEndpointTargetRole

ReadWrite
READ_WRITE
ReadOnly
READ_ONLY
DBProxyEndpointTargetRoleReadWrite
READ_WRITE
DBProxyEndpointTargetRoleReadOnly
READ_ONLY
ReadWrite
READ_WRITE
ReadOnly
READ_ONLY
ReadWrite
READ_WRITE
ReadOnly
READ_ONLY
READ_WRITE
READ_WRITE
READ_ONLY
READ_ONLY
"READ_WRITE"
READ_WRITE
"READ_ONLY"
READ_ONLY

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0