Class CfnDBProxyEndpoint
The AWS::RDS::DBProxyEndpoint
resource creates or updates a DB proxy endpoint.
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDBProxyEndpoint : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnDBProxyEndpoint
Inherits CfnResource
Implements IInspectable, 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
Tags = new [] { new TagFormatProperty {
Key = "key",
Value = "value"
} },
TargetRole = "targetRole",
VpcSecurityGroupIds = new [] { "vpcSecurityGroupIds" }
});
Synopsis
Constructors
CfnDBProxyEndpoint(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDBProxyEndpoint(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDBProxyEndpoint(Construct, String, ICfnDBProxyEndpointProps) |
Properties
AttrDbProxyEndpointArn | The Amazon Resource Name (ARN) representing the DB proxy endpoint. |
AttrEndpoint | The custom endpoint for the RDS DB instance or Aurora DB cluster. |
AttrIsDefault | A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. |
AttrVpcId | The VPC ID of the DB proxy endpoint. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DbProxyEndpointName | The name of the DB proxy endpoint to create. |
DbProxyName | The name of the DB proxy associated with the DB proxy endpoint that you create. |
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
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDBProxyEndpoint(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDBProxyEndpoint(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDBProxyEndpoint(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDBProxyEndpoint(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDBProxyEndpoint(Construct, String, ICfnDBProxyEndpointProps)
public CfnDBProxyEndpoint(Construct scope, string id, ICfnDBProxyEndpointProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDBProxyEndpointProps
Resource properties.
Properties
AttrDbProxyEndpointArn
The Amazon Resource Name (ARN) representing the DB proxy endpoint.
public virtual string AttrDbProxyEndpointArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DBProxyEndpointArn
AttrEndpoint
The custom endpoint for the RDS DB instance or Aurora DB cluster.
public virtual string AttrEndpoint { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Endpoint
AttrIsDefault
A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.
public virtual IResolvable AttrIsDefault { get; }
Property Value
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
The VPC ID of the DB proxy endpoint.
public virtual string AttrVpcId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: VpcId
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DbProxyEndpointName
The name of the DB proxy endpoint to create.
public virtual string DbProxyEndpointName { get; set; }
Property Value
System.String
DbProxyName
The name of the DB proxy associated with the DB proxy endpoint that you create.
public virtual string DbProxyName { get; set; }
Property Value
System.String
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
CfnDBProxyEndpoint.ITagFormatProperty[]
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
System.String
VpcSecurityGroupIds
The VPC security group IDs for the DB proxy endpoint that you create.
public virtual string[] VpcSecurityGroupIds { get; set; }
Property Value
System.String[]
VpcSubnetIds
The VPC subnet IDs for the DB proxy endpoint that you create.
public virtual string[] VpcSubnetIds { get; set; }
Property Value
System.String[]
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>