Class CfnDBProxy
The AWS::RDS::DBProxy
resource creates or updates a DB proxy.
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDBProxy : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnDBProxy
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
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 .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html
CloudformationResource: AWS::RDS::DBProxy
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(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 |
CfnDBProxy(Construct, String, ICfnDBProxyProps) |
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. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DbProxyName | The identifier for the proxy. |
DebugLogging | Specifies 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 | 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(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
CfnDBProxy(Construct, String, ICfnDBProxyProps)
public CfnDBProxy(Construct scope, string id, ICfnDBProxyProps 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 ICfnDBProxyProps
Resource properties.
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
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
DbProxyName
The identifier for the proxy.
public virtual string DbProxyName { get; set; }
Property Value
System.String
DebugLogging
Specifies whether the proxy includes detailed information about SQL statements in its logs.
public virtual object DebugLogging { get; set; }
Property Value
System.Object
EngineFamily
The kinds of databases that the proxy can connect to.
public virtual string EngineFamily { get; set; }
Property Value
System.String
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>
RequireTls
Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
public virtual object RequireTls { get; set; }
Property Value
System.Object
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
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[]
VpcSecurityGroupIds
One or more VPC security group IDs to associate with the new proxy.
public virtual string[] VpcSecurityGroupIds { get; set; }
Property Value
System.String[]
VpcSubnetIds
One or more VPC subnet IDs to associate with the new proxy.
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>