Class DatabaseProxyEndpoint

RDS Database Proxy Endpoint.

Inheritance

object

Resource

DatabaseProxyEndpoint

Implements

IDatabaseProxyEndpoint

IResource

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class DatabaseProxyEndpoint : Resource, IDatabaseProxyEndpoint, IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class DatabaseProxyEndpoint Inherits Resource Implements IDatabaseProxyEndpoint, IResource, IConstruct, IDependable, IEnvironmentAware

Remarks

Resource: AWS::RDS::DBProxyEndpoint

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EC2;
             using Amazon.CDK.AWS.RDS;

             DatabaseProxy databaseProxy;
             SecurityGroup securityGroup;
             Subnet subnet;
             SubnetFilter subnetFilter;
             Vpc vpc;

             var databaseProxyEndpoint = new DatabaseProxyEndpoint(this, "MyDatabaseProxyEndpoint", new DatabaseProxyEndpointProps {
                 DbProxy = databaseProxy,
                 Vpc = vpc,

                 // the properties below are optional
                 DbProxyEndpointName = "dbProxyEndpointName",
                 SecurityGroups = new [] { securityGroup },
                 TargetRole = ProxyEndpointTargetRole.READ_WRITE,
                 VpcSubnets = new SubnetSelection {
                     AvailabilityZones = new [] { "availabilityZones" },
                     OnePerAz = false,
                     SubnetFilters = new [] { subnetFilter },
                     SubnetGroupName = "subnetGroupName",
                     Subnets = new [] { subnet },
                     SubnetType = SubnetType.PRIVATE_ISOLATED
                 }
             });

Synopsis

Constructors

DatabaseProxyEndpoint(Construct, string, IDatabaseProxyEndpointProps)

RDS Database Proxy Endpoint.

Properties

DbProxyEndpointArn	DB Proxy Endpoint ARN.
DbProxyEndpointName	DB Proxy Endpoint Name.
Endpoint	The endpoint that you can use to connect to the DB proxy.
PROPERTY_INJECTION_ID	Uniquely identifies this class.

Methods

FromDatabaseProxyEndpointAttributes(Construct, string, IDatabaseProxyEndpointAttributes)

Import an existing database proxy endpoint.

Constructors

DatabaseProxyEndpoint(Construct, string, IDatabaseProxyEndpointProps)

RDS Database Proxy Endpoint.

public DatabaseProxyEndpoint(Construct scope, string id, IDatabaseProxyEndpointProps props)

Parameters

scope Construct

id string

props IDatabaseProxyEndpointProps

Remarks

Resource: AWS::RDS::DBProxyEndpoint

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EC2;
             using Amazon.CDK.AWS.RDS;

             DatabaseProxy databaseProxy;
             SecurityGroup securityGroup;
             Subnet subnet;
             SubnetFilter subnetFilter;
             Vpc vpc;

             var databaseProxyEndpoint = new DatabaseProxyEndpoint(this, "MyDatabaseProxyEndpoint", new DatabaseProxyEndpointProps {
                 DbProxy = databaseProxy,
                 Vpc = vpc,

                 // the properties below are optional
                 DbProxyEndpointName = "dbProxyEndpointName",
                 SecurityGroups = new [] { securityGroup },
                 TargetRole = ProxyEndpointTargetRole.READ_WRITE,
                 VpcSubnets = new SubnetSelection {
                     AvailabilityZones = new [] { "availabilityZones" },
                     OnePerAz = false,
                     SubnetFilters = new [] { subnetFilter },
                     SubnetGroupName = "subnetGroupName",
                     Subnets = new [] { subnet },
                     SubnetType = SubnetType.PRIVATE_ISOLATED
                 }
             });

Properties

DbProxyEndpointArn

DB Proxy Endpoint ARN.

public virtual string DbProxyEndpointArn { get; }

Property Value

string

Remarks

Attribute: true

DbProxyEndpointName

DB Proxy Endpoint Name.

public virtual string DbProxyEndpointName { get; }

Property Value

string

Remarks

Attribute: true

Endpoint

The endpoint that you can use to connect to the DB proxy.

public virtual string Endpoint { get; }

Property Value

string

Remarks

Attribute: true

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

Resource: AWS::RDS::DBProxyEndpoint

ExampleMetadata: fixture=_generated

Methods

FromDatabaseProxyEndpointAttributes(Construct, string, IDatabaseProxyEndpointAttributes)

Import an existing database proxy endpoint.

public static IDatabaseProxyEndpoint FromDatabaseProxyEndpointAttributes(Construct scope, string id, IDatabaseProxyEndpointAttributes attrs)

Parameters

scope Construct

id string

attrs IDatabaseProxyEndpointAttributes

Returns

IDatabaseProxyEndpoint

Remarks

Resource: AWS::RDS::DBProxyEndpoint

ExampleMetadata: fixture=_generated

Implements

IDatabaseProxyEndpoint

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware