Class CfnDBProxyEndpoint

The AWS::RDS::DBProxyEndpoint resource creates or updates a DB proxy endpoint.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDBProxyEndpoint

Implements

IInspectable

IDBProxyEndpointRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDBProxyEndpoint : CfnResource, IInspectable, IDBProxyEndpointRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnDBProxyEndpoint Inherits CfnResource Implements IInspectable, IDBProxyEndpointRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html

CloudformationResource: 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.RDS;

             var cfnDBProxyEndpoint = new CfnDBProxyEndpoint(this, "MyCfnDBProxyEndpoint", new CfnDBProxyEndpointProps {
                 DbProxyEndpointName = "dbProxyEndpointName",
                 DbProxyName = "dbProxyName",
                 VpcSubnetIds = new [] { "vpcSubnetIds" },

                 // the properties below are optional
                 EndpointNetworkType = "endpointNetworkType",
                 Tags = new [] { new TagFormatProperty {
                     Key = "key",
                     Value = "value"
                 } },
                 TargetRole = "targetRole",
                 VpcSecurityGroupIds = new [] { "vpcSecurityGroupIds" }
             });

Synopsis

Constructors

CfnDBProxyEndpoint(Construct, string, ICfnDBProxyEndpointProps)

Create a new AWS::RDS::DBProxyEndpoint.

Properties

AttrDbProxyEndpointArn	The Amazon Resource Name (ARN) for the DB proxy endpoint.
AttrEndpoint	The endpoint that you can use to connect to the DB proxy.
AttrIsDefault	Indicates whether this endpoint is the default endpoint for the associated DB proxy.
AttrVpcId	Provides the VPC ID of the DB proxy endpoint.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	The AWS::RDS::DBProxyEndpoint resource creates or updates a DB proxy endpoint.
DbProxyEndpointName	The name of the DB proxy endpoint to create.
DbProxyEndpointRef	A reference to a DBProxyEndpoint resource.
DbProxyName	The name of the DB proxy associated with the DB proxy endpoint that you create.
EndpointNetworkType	The network type of the DB proxy endpoint.
Tags	An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
TargetRole	A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
VpcSecurityGroupIds	The VPC security group IDs for the DB proxy endpoint that you create.
VpcSubnetIds	The VPC subnet IDs for the DB proxy endpoint that you create.

Methods

ArnForDBProxyEndpoint(IDBProxyEndpointRef)	The AWS::RDS::DBProxyEndpoint resource creates or updates a DB proxy endpoint.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnDBProxyEndpoint(object)	Checks whether the given object is a CfnDBProxyEndpoint.
RenderProperties(IDictionary<string, object>)	The AWS::RDS::DBProxyEndpoint resource creates or updates a DB proxy endpoint.

Constructors

CfnDBProxyEndpoint(Construct, string, ICfnDBProxyEndpointProps)

Create a new AWS::RDS::DBProxyEndpoint.

public CfnDBProxyEndpoint(Construct scope, string id, ICfnDBProxyEndpointProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnDBProxyEndpointProps

Resource properties.

Remarks

You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html

CloudformationResource: AWS::RDS::DBProxyEndpoint

ExampleMetadata: fixture=_generated

Properties

AttrDbProxyEndpointArn

The Amazon Resource Name (ARN) for the DB proxy endpoint.

public virtual string AttrDbProxyEndpointArn { get; }

Property Value

string

Remarks

CloudformationAttribute: DBProxyEndpointArn

AttrEndpoint

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

public virtual string AttrEndpoint { get; }

Property Value

string

Remarks

You include the endpoint value in the connection string for a database client application.

CloudformationAttribute: Endpoint

AttrIsDefault

Indicates whether this endpoint is the default endpoint for the associated DB proxy.

public virtual IResolvable AttrIsDefault { get; }

Property Value

IResolvable

Remarks

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.

CloudformationAttribute: IsDefault

AttrVpcId

Provides the VPC ID of the DB proxy endpoint.

public virtual string AttrVpcId { get; }

Property Value

string

Remarks

CloudformationAttribute: VpcId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html

CloudformationResource: AWS::RDS::DBProxyEndpoint

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html

CloudformationResource: AWS::RDS::DBProxyEndpoint

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::RDS::DBProxyEndpoint resource creates or updates a DB proxy endpoint.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html

CloudformationResource: AWS::RDS::DBProxyEndpoint

ExampleMetadata: fixture=_generated

DbProxyEndpointName

The name of the DB proxy endpoint to create.

public virtual string DbProxyEndpointName { get; set; }

Property Value

string

Remarks

You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html

CloudformationResource: AWS::RDS::DBProxyEndpoint

ExampleMetadata: fixture=_generated

DbProxyEndpointRef

A reference to a DBProxyEndpoint resource.

public virtual IDBProxyEndpointReference DbProxyEndpointRef { get; }

Property Value

IDBProxyEndpointReference

Remarks

You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html

CloudformationResource: AWS::RDS::DBProxyEndpoint

ExampleMetadata: fixture=_generated

DbProxyName

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

public virtual string DbProxyName { get; set; }

Property Value

string

Remarks

You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html

CloudformationResource: AWS::RDS::DBProxyEndpoint

ExampleMetadata: fixture=_generated

EndpointNetworkType

The network type of the DB proxy endpoint.

public virtual string? EndpointNetworkType { get; set; }

Property Value

string

Remarks

You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html

CloudformationResource: AWS::RDS::DBProxyEndpoint

ExampleMetadata: fixture=_generated

Tags

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

public virtual CfnDBProxyEndpoint.ITagFormatProperty[]? Tags { get; set; }

Property Value

ITagFormatProperty[]

Remarks

You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html

CloudformationResource: AWS::RDS::DBProxyEndpoint

ExampleMetadata: fixture=_generated

TargetRole

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

public virtual string? TargetRole { get; set; }

Property Value

string

Remarks

You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html

CloudformationResource: AWS::RDS::DBProxyEndpoint

ExampleMetadata: fixture=_generated

VpcSecurityGroupIds

The VPC security group IDs for the DB proxy endpoint that you create.

public virtual string[]? VpcSecurityGroupIds { get; set; }

Property Value

string[]

Remarks

You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html

CloudformationResource: AWS::RDS::DBProxyEndpoint

ExampleMetadata: fixture=_generated

VpcSubnetIds

The VPC subnet IDs for the DB proxy endpoint that you create.

public virtual string[] VpcSubnetIds { get; set; }

Property Value

string[]

Remarks

You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html

CloudformationResource: AWS::RDS::DBProxyEndpoint

ExampleMetadata: fixture=_generated

Methods

ArnForDBProxyEndpoint(IDBProxyEndpointRef)

The AWS::RDS::DBProxyEndpoint resource creates or updates a DB proxy endpoint.

public static string ArnForDBProxyEndpoint(IDBProxyEndpointRef resource)

Parameters

resource IDBProxyEndpointRef

Returns

string

Remarks

You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html

CloudformationResource: 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.RDS;

             var cfnDBProxyEndpoint = new CfnDBProxyEndpoint(this, "MyCfnDBProxyEndpoint", new CfnDBProxyEndpointProps {
                 DbProxyEndpointName = "dbProxyEndpointName",
                 DbProxyName = "dbProxyName",
                 VpcSubnetIds = new [] { "vpcSubnetIds" },

                 // the properties below are optional
                 EndpointNetworkType = "endpointNetworkType",
                 Tags = new [] { new TagFormatProperty {
                     Key = "key",
                     Value = "value"
                 } },
                 TargetRole = "targetRole",
                 VpcSecurityGroupIds = new [] { "vpcSecurityGroupIds" }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html

CloudformationResource: AWS::RDS::DBProxyEndpoint

ExampleMetadata: fixture=_generated

IsCfnDBProxyEndpoint(object)

Checks whether the given object is a CfnDBProxyEndpoint.

public static bool IsCfnDBProxyEndpoint(object x)

Parameters

x object

Returns

bool

Remarks

You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html

CloudformationResource: AWS::RDS::DBProxyEndpoint

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::RDS::DBProxyEndpoint resource creates or updates a DB proxy endpoint.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html

CloudformationResource: AWS::RDS::DBProxyEndpoint

ExampleMetadata: fixture=_generated

Implements

IInspectable

IDBProxyEndpointRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2