Class CfnDBProxy
A CloudFormation AWS::RDS::DBProxy
.
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.AWS.RDS.dll
Syntax (csharp)
public class CfnDBProxy : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDBProxy
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::RDS::DBProxy
resource creates or updates a DB proxy.
For information about RDS Proxy for Amazon RDS, see Managing Connections with Amazon RDS Proxy in the Amazon RDS User Guide .
For information about RDS Proxy for Amazon Aurora, see Managing Connections with Amazon RDS Proxy in the Amazon Aurora User Guide .
Limitations apply to RDS Proxy, including DB engine version limitations and AWS Region limitations.
For information about limitations that apply to RDS Proxy for Amazon RDS, see Limitations for RDS Proxy in the Amazon RDS User Guide .
For information about that apply to RDS Proxy for Amazon Aurora, see Limitations for RDS Proxy in the Amazon Aurora User Guide .
CloudformationResource: AWS::RDS::DBProxy
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html
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 cfnDBProxy = new CfnDBProxy(this, "MyCfnDBProxy", new CfnDBProxyProps {
Auth = new [] { new AuthFormatProperty {
AuthScheme = "authScheme",
ClientPasswordAuthType = "clientPasswordAuthType",
Description = "description",
IamAuth = "iamAuth",
SecretArn = "secretArn"
} },
DbProxyName = "dbProxyName",
EngineFamily = "engineFamily",
RoleArn = "roleArn",
VpcSubnetIds = new [] { "vpcSubnetIds" },
// the properties below are optional
DebugLogging = false,
IdleClientTimeout = 123,
RequireTls = false,
Tags = new [] { new TagFormatProperty {
Key = "key",
Value = "value"
} },
VpcSecurityGroupIds = new [] { "vpcSecurityGroupIds" }
});
Synopsis
Constructors
CfnDBProxy(Construct, String, ICfnDBProxyProps) | Create a new |
CfnDBProxy(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDBProxy(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrDbProxyArn | The Amazon Resource Name (ARN) representing the target group. |
AttrEndpoint | The writer endpoint for the RDS DB instance or Aurora DB cluster. |
AttrVpcId | The VPC ID to associate with the DB proxy. |
Auth | The authorization mechanism that the proxy uses. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DbProxyName | The identifier for the proxy. |
DebugLogging | Whether the proxy includes detailed information about SQL statements in its logs. |
EngineFamily | The kinds of databases that the proxy can connect to. |
IdleClientTimeout | The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. |
RequireTls | A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. |
RoleArn | The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager. |
Tags | An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy. |
VpcSecurityGroupIds | One or more VPC security group IDs to associate with the new proxy. |
VpcSubnetIds | One or more VPC subnet IDs to associate with the new proxy. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDBProxy(Construct, String, ICfnDBProxyProps)
Create a new AWS::RDS::DBProxy
.
public CfnDBProxy(Construct scope, string id, ICfnDBProxyProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDBProxyProps
- resource properties.
CfnDBProxy(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDBProxy(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDBProxy(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDBProxy(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrDbProxyArn
The Amazon Resource Name (ARN) representing the target group.
public virtual string AttrDbProxyArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DBProxyArn
AttrEndpoint
The writer endpoint for the RDS DB instance or Aurora DB cluster.
public virtual string AttrEndpoint { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Endpoint
AttrVpcId
The VPC ID to associate with the DB proxy.
public virtual string AttrVpcId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: VpcId
Auth
The authorization mechanism that the proxy uses.
public virtual object Auth { get; set; }
Property Value
System.Object
Remarks
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
DbProxyName
The identifier for the proxy.
public virtual string DbProxyName { get; set; }
Property Value
System.String
Remarks
This name must be unique for all proxies owned by your AWS account in the specified AWS Region . 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.
DebugLogging
Whether the proxy includes detailed information about SQL statements in its logs.
public virtual object DebugLogging { get; set; }
Property Value
System.Object
Remarks
This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
EngineFamily
The kinds of databases that the proxy can connect to.
public virtual string EngineFamily { get; set; }
Property Value
System.String
Remarks
This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL
. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL
. For RDS for Microsoft SQL Server, specify SQLSERVER
.
Valid values : MYSQL
| POSTGRESQL
| SQLSERVER
IdleClientTimeout
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
public virtual Nullable<double> IdleClientTimeout { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
You can set this value higher or lower than the connection timeout limit for the associated database.
RequireTls
A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
public virtual object RequireTls { get; set; }
Property Value
System.Object
Remarks
By enabling this setting, you can enforce encrypted TLS connections to the proxy.
RoleArn
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
public virtual string RoleArn { get; set; }
Property Value
System.String
Remarks
Tags
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
public virtual CfnDBProxy.ITagFormatProperty[] Tags { get; set; }
Property Value
CfnDBProxy.ITagFormatProperty[]
Remarks
VpcSecurityGroupIds
One or more VPC security group IDs to associate with the new proxy.
public virtual string[] VpcSecurityGroupIds { get; set; }
Property Value
System.String[]
Remarks
If you plan to update the resource, don't specify VPC security groups in a shared VPC.
VpcSubnetIds
One or more VPC subnet IDs to associate with the new proxy.
public virtual string[] VpcSubnetIds { get; set; }
Property Value
System.String[]
Remarks
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>