`dbProxy` Submodule

Constructs

DbProxy

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy aws_db_proxy}.

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DbProxy(Construct Scope, string Id, DbProxyConfig Config);

Name	Type	Description
`Scope`	`Constructs.Construct`	The scope in which to define this construct.
`Id`	`string`	The scoped construct ID.
`Config`	`DbProxyConfig`	No description.

`Scope`^Required

Type: Constructs.Construct

The scope in which to define this construct.

`Id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`Config`^Required

Type: DbProxyConfig

Methods

Name	Description
`ToString`	Returns a string representation of this construct.
`AddOverride`	No description.
`OverrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`ResetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`ToHclTerraform`	No description.
`ToMetadata`	No description.
`ToTerraform`	Adds this resource to the terraform JSON output.
`AddMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`GetAnyMapAttribute`	No description.
`GetBooleanAttribute`	No description.
`GetBooleanMapAttribute`	No description.
`GetListAttribute`	No description.
`GetNumberAttribute`	No description.
`GetNumberListAttribute`	No description.
`GetNumberMapAttribute`	No description.
`GetStringAttribute`	No description.
`GetStringMapAttribute`	No description.
`HasResourceMove`	No description.
`ImportFrom`	No description.
`InterpolationForAttribute`	No description.
`MoveFromId`	Move the resource corresponding to "id" to this resource.
`MoveTo`	Moves this resource to the target resource given by moveTarget.
`MoveToId`	Moves this resource to the resource corresponding to "id".
`PutAuth`	No description.
`PutTimeouts`	No description.
`ResetDebugLogging`	No description.
`ResetId`	No description.
`ResetIdleClientTimeout`	No description.
`ResetRequireTls`	No description.
`ResetTags`	No description.
`ResetTagsAll`	No description.
`ResetTimeouts`	No description.
`ResetVpcSecurityGroupIds`	No description.

`ToString`

private string ToString()

Returns a string representation of this construct.

`AddOverride`

private void AddOverride(string Path, object Value)

`Path`^Required

Type: string

`Value`^Required

Type: object

`OverrideLogicalId`

private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

`NewLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`ResetOverrideLogicalId`

private void ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

`ToHclTerraform`

private object ToHclTerraform()

`ToMetadata`

private object ToMetadata()

`ToTerraform`

private object ToTerraform()

Adds this resource to the terraform JSON output.

`AddMoveTarget`

private void AddMoveTarget(string MoveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`MoveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`HasResourceMove`

private object HasResourceMove()

`ImportFrom`

private void ImportFrom(string Id, TerraformProvider Provider = null)

`Id`^Required

Type: string

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`MoveFromId`

private void MoveFromId(string Id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

`Id`^Required

Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`MoveTo`

private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

`MoveTarget`^Required

Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`Index`^Optional

Type: object

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`MoveToId`

private void MoveToId(string Id)

Moves this resource to the resource corresponding to "id".

`Id`^Required

Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

`PutAuth`

private void PutAuth(object Value)

`Value`^Required

Type: object

`PutTimeouts`

private void PutTimeouts(DbProxyTimeouts Value)

`Value`^Required

Type: DbProxyTimeouts

`ResetDebugLogging`

private void ResetDebugLogging()

`ResetId`

private void ResetId()

`ResetIdleClientTimeout`

private void ResetIdleClientTimeout()

`ResetRequireTls`

private void ResetRequireTls()

`ResetTags`

private void ResetTags()

`ResetTagsAll`

private void ResetTagsAll()

`ResetTimeouts`

private void ResetTimeouts()

`ResetVpcSecurityGroupIds`

private void ResetVpcSecurityGroupIds()

Static Functions

Name	Description
`IsConstruct`	Checks if `x` is a construct.
`IsTerraformElement`	No description.
`IsTerraformResource`	No description.
`GenerateConfigForImport`	Generates CDKTF code for importing a DbProxy resource upon running "cdktf plan ".

`IsConstruct`

using HashiCorp.Cdktf.Providers.Aws;

DbProxy.IsConstruct(object X);

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`X`^Required

Type: object

Any object.

`IsTerraformElement`

using HashiCorp.Cdktf.Providers.Aws;

DbProxy.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using HashiCorp.Cdktf.Providers.Aws;

DbProxy.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Aws;

DbProxy.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTF code for importing a DbProxy resource upon running "cdktf plan ".

`Scope`^Required

Type: Constructs.Construct

The scope in which to define this construct.

`ImportToId`^Required

Type: string

The construct id used in the generated config for the DbProxy to import.

`ImportFromId`^Required

Type: string

The id of the existing DbProxy that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#import import section} in the documentation of this resource for the id to use

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the DbProxy to import is found.

Properties

Name	Type	Description
`Node`	`Constructs.Node`	The tree node.
`CdktfStack`	`HashiCorp.Cdktf.TerraformStack`	No description.
`Fqn`	`string`	No description.
`FriendlyUniqueId`	`string`	No description.
`TerraformMetaArguments`	`System.Collections.Generic.IDictionary<string, object>`	No description.
`TerraformResourceType`	`string`	No description.
`TerraformGeneratorMetadata`	`HashiCorp.Cdktf.TerraformProviderGeneratorMetadata`	No description.
`Connection`	`object`	No description.
`Count`	`object`	No description.
`DependsOn`	`string[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`Provisioners`	`object[]`	No description.
`Arn`	`string`	No description.
`Auth`	`DbProxyAuthList`	No description.
`Endpoint`	`string`	No description.
`Timeouts`	`DbProxyTimeoutsOutputReference`	No description.
`AuthInput`	`object`	No description.
`DebugLoggingInput`	`object`	No description.
`EngineFamilyInput`	`string`	No description.
`IdInput`	`string`	No description.
`IdleClientTimeoutInput`	`double`	No description.
`NameInput`	`string`	No description.
`RequireTlsInput`	`object`	No description.
`RoleArnInput`	`string`	No description.
`TagsAllInput`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`TagsInput`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`TimeoutsInput`	`object`	No description.
`VpcSecurityGroupIdsInput`	`string[]`	No description.
`VpcSubnetIdsInput`	`string[]`	No description.
`DebugLogging`	`object`	No description.
`EngineFamily`	`string`	No description.
`Id`	`string`	No description.
`IdleClientTimeout`	`double`	No description.
`Name`	`string`	No description.
`RequireTls`	`object`	No description.
`RoleArn`	`string`	No description.
`Tags`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`TagsAll`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`VpcSecurityGroupIds`	`string[]`	No description.
`VpcSubnetIds`	`string[]`	No description.

`Node`^Required

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: HashiCorp.Cdktf.TerraformStack

`Fqn`^Required

public string Fqn { get; }

Type: string

`FriendlyUniqueId`^Required

public string FriendlyUniqueId { get; }

Type: string

`TerraformMetaArguments`^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

Type: System.Collections.Generic.IDictionary<string, object>

`TerraformResourceType`^Required

public string TerraformResourceType { get; }

Type: string

`TerraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

public object Connection { get; }

Type: object

`Count`^Optional

public object Count { get; }

Type: object

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; }

Type: object[]

`Arn`^Required

public string Arn { get; }

Type: string

`Auth`^Required

public DbProxyAuthList Auth { get; }

Type: DbProxyAuthList

`Endpoint`^Required

public string Endpoint { get; }

Type: string

`Timeouts`^Required

public DbProxyTimeoutsOutputReference Timeouts { get; }

Type: DbProxyTimeoutsOutputReference

`AuthInput`^Optional

public object AuthInput { get; }

Type: object

`DebugLoggingInput`^Optional

public object DebugLoggingInput { get; }

Type: object

`EngineFamilyInput`^Optional

public string EngineFamilyInput { get; }

Type: string

`IdInput`^Optional

public string IdInput { get; }

Type: string

`IdleClientTimeoutInput`^Optional

public double IdleClientTimeoutInput { get; }

Type: double

`NameInput`^Optional

public string NameInput { get; }

Type: string

`RequireTlsInput`^Optional

public object RequireTlsInput { get; }

Type: object

`RoleArnInput`^Optional

public string RoleArnInput { get; }

Type: string

`TagsAllInput`^Optional

public System.Collections.Generic.IDictionary<string, string> TagsAllInput { get; }

Type: System.Collections.Generic.IDictionary<string, string>

`TagsInput`^Optional

public System.Collections.Generic.IDictionary<string, string> TagsInput { get; }

Type: System.Collections.Generic.IDictionary<string, string>

`TimeoutsInput`^Optional

public object TimeoutsInput { get; }

Type: object

`VpcSecurityGroupIdsInput`^Optional

public string[] VpcSecurityGroupIdsInput { get; }

Type: string[]

`VpcSubnetIdsInput`^Optional

public string[] VpcSubnetIdsInput { get; }

Type: string[]

`DebugLogging`^Required

public object DebugLogging { get; }

Type: object

`EngineFamily`^Required

public string EngineFamily { get; }

Type: string

`Id`^Required

public string Id { get; }

Type: string

`IdleClientTimeout`^Required

public double IdleClientTimeout { get; }

Type: double

`Name`^Required

public string Name { get; }

Type: string

`RequireTls`^Required

public object RequireTls { get; }

Type: object

`RoleArn`^Required

public string RoleArn { get; }

Type: string

`Tags`^Required

public System.Collections.Generic.IDictionary<string, string> Tags { get; }

Type: System.Collections.Generic.IDictionary<string, string>

`TagsAll`^Required

public System.Collections.Generic.IDictionary<string, string> TagsAll { get; }

Type: System.Collections.Generic.IDictionary<string, string>

`VpcSecurityGroupIds`^Required

public string[] VpcSecurityGroupIds { get; }

Type: string[]

`VpcSubnetIds`^Required

public string[] VpcSubnetIds { get; }

Type: string[]

Constants

Name	Type	Description
`TfResourceType`	`string`	No description.

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

DbProxyAuth

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DbProxyAuth {
    string AuthScheme = null,
    string ClientPasswordAuthType = null,
    string Description = null,
    string IamAuth = null,
    string SecretArn = null,
    string Username = null
};

Properties

Name	Type	Description
`AuthScheme`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#auth_scheme DbProxy#auth_scheme}.
`ClientPasswordAuthType`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#client_password_auth_type DbProxy#client_password_auth_type}.
`Description`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#description DbProxy#description}.
`IamAuth`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#iam_auth DbProxy#iam_auth}.
`SecretArn`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#secret_arn DbProxy#secret_arn}.
`Username`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#username DbProxy#username}.

`AuthScheme`^Optional

public string AuthScheme { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#auth_scheme DbProxy#auth_scheme}.

`ClientPasswordAuthType`^Optional

public string ClientPasswordAuthType { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#client_password_auth_type DbProxy#client_password_auth_type}.

`Description`^Optional

public string Description { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#description DbProxy#description}.

`IamAuth`^Optional

public string IamAuth { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#iam_auth DbProxy#iam_auth}.

`SecretArn`^Optional

public string SecretArn { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#secret_arn DbProxy#secret_arn}.

`Username`^Optional

public string Username { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#username DbProxy#username}.

DbProxyConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DbProxyConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    object Auth,
    string EngineFamily,
    string Name,
    string RoleArn,
    string[] VpcSubnetIds,
    object DebugLogging = null,
    string Id = null,
    double IdleClientTimeout = null,
    object RequireTls = null,
    System.Collections.Generic.IDictionary<string, string> Tags = null,
    System.Collections.Generic.IDictionary<string, string> TagsAll = null,
    DbProxyTimeouts Timeouts = null,
    string[] VpcSecurityGroupIds = null
};

Properties

Name	Type	Description
`Connection`	`object`	No description.
`Count`	`object`	No description.
`DependsOn`	`HashiCorp.Cdktf.ITerraformDependable[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`Provisioners`	`object[]`	No description.
`Auth`	`object`	auth block.
`EngineFamily`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#engine_family DbProxy#engine_family}.
`Name`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#name DbProxy#name}.
`RoleArn`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#role_arn DbProxy#role_arn}.
`VpcSubnetIds`	`string[]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#vpc_subnet_ids DbProxy#vpc_subnet_ids}.
`DebugLogging`	`object`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#debug_logging DbProxy#debug_logging}.
`Id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#id DbProxy#id}.
`IdleClientTimeout`	`double`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#idle_client_timeout DbProxy#idle_client_timeout}.
`RequireTls`	`object`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#require_tls DbProxy#require_tls}.
`Tags`	`System.Collections.Generic.IDictionary<string, string>`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#tags DbProxy#tags}.
`TagsAll`	`System.Collections.Generic.IDictionary<string, string>`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#tags_all DbProxy#tags_all}.
`Timeouts`	`DbProxyTimeouts`	timeouts block.
`VpcSecurityGroupIds`	`string[]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#vpc_security_group_ids DbProxy#vpc_security_group_ids}.

`Connection`^Optional

public object Connection { get; set; }

Type: object

`Count`^Optional

public object Count { get; set; }

Type: object

`DependsOn`^Optional

public ITerraformDependable[] DependsOn { get; set; }

Type: HashiCorp.Cdktf.ITerraformDependable[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; set; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; set; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; set; }

Type: object[]

`Auth`^Required

public object Auth { get; set; }

Type: object

auth block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#auth DbProxy#auth}

`EngineFamily`^Required

public string EngineFamily { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#engine_family DbProxy#engine_family}.

`Name`^Required

public string Name { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#name DbProxy#name}.

`RoleArn`^Required

public string RoleArn { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#role_arn DbProxy#role_arn}.

`VpcSubnetIds`^Required

public string[] VpcSubnetIds { get; set; }

Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#vpc_subnet_ids DbProxy#vpc_subnet_ids}.

`DebugLogging`^Optional

public object DebugLogging { get; set; }

Type: object

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#debug_logging DbProxy#debug_logging}.

`Id`^Optional

public string Id { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#id DbProxy#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

`IdleClientTimeout`^Optional

public double IdleClientTimeout { get; set; }

Type: double

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#idle_client_timeout DbProxy#idle_client_timeout}.

`RequireTls`^Optional

public object RequireTls { get; set; }

Type: object

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#require_tls DbProxy#require_tls}.

`Tags`^Optional

public System.Collections.Generic.IDictionary<string, string> Tags { get; set; }

Type: System.Collections.Generic.IDictionary<string, string>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#tags DbProxy#tags}.

`TagsAll`^Optional

public System.Collections.Generic.IDictionary<string, string> TagsAll { get; set; }

Type: System.Collections.Generic.IDictionary<string, string>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#tags_all DbProxy#tags_all}.

`Timeouts`^Optional

public DbProxyTimeouts Timeouts { get; set; }

Type: DbProxyTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#timeouts DbProxy#timeouts}

`VpcSecurityGroupIds`^Optional

public string[] VpcSecurityGroupIds { get; set; }

Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#vpc_security_group_ids DbProxy#vpc_security_group_ids}.

DbProxyTimeouts

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DbProxyTimeouts {
    string Create = null,
    string Delete = null,
    string Update = null
};

Properties

Name	Type	Description
`Create`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#create DbProxy#create}.
`Delete`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#delete DbProxy#delete}.
`Update`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#update DbProxy#update}.

`Create`^Optional

public string Create { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#create DbProxy#create}.

`Delete`^Optional

public string Delete { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#delete DbProxy#delete}.

`Update`^Optional

public string Update { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/db_proxy#update DbProxy#update}.

Classes

DbProxyAuthList

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DbProxyAuthList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`WrapsSet`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`WrapsSet`^Required

Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`AllWithMapKey`	Creating an iterator for this complex list.
`ComputeFqn`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`Get`	No description.

`AllWithMapKey`

private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`MapKeyAttributeName`^Required

Type: string

`ComputeFqn`

private string ComputeFqn()

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`Get`

private DbProxyAuthOutputReference Get(double Index)

`Index`^Required

Type: double

the index of the item to return.

Properties

Name	Type	Description
`CreationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`string`	No description.
`InternalValue`	`object`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

public string Fqn { get; }

Type: string

`InternalValue`^Optional

public object InternalValue { get; }

Type: object

DbProxyAuthOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DbProxyAuthOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`ComplexObjectIndex`	`double`	the index of this item in the list.
`ComplexObjectIsFromSet`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`ComplexObjectIndex`^Required

Type: double

the index of this item in the list.

`ComplexObjectIsFromSet`^Required

Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`ComputeFqn`	No description.
`GetAnyMapAttribute`	No description.
`GetBooleanAttribute`	No description.
`GetBooleanMapAttribute`	No description.
`GetListAttribute`	No description.
`GetNumberAttribute`	No description.
`GetNumberListAttribute`	No description.
`GetNumberMapAttribute`	No description.
`GetStringAttribute`	No description.
`GetStringMapAttribute`	No description.
`InterpolationForAttribute`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`ResetAuthScheme`	No description.
`ResetClientPasswordAuthType`	No description.
`ResetDescription`	No description.
`ResetIamAuth`	No description.
`ResetSecretArn`	No description.
`ResetUsername`	No description.

`ComputeFqn`

private string ComputeFqn()

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string Property)

`Property`^Required

Type: string

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetAuthScheme`

private void ResetAuthScheme()

`ResetClientPasswordAuthType`

private void ResetClientPasswordAuthType()

`ResetDescription`

private void ResetDescription()

`ResetIamAuth`

private void ResetIamAuth()

`ResetSecretArn`

private void ResetSecretArn()

`ResetUsername`

private void ResetUsername()

Properties

Name	Type	Description
`CreationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`string`	No description.
`AuthSchemeInput`	`string`	No description.
`ClientPasswordAuthTypeInput`	`string`	No description.
`DescriptionInput`	`string`	No description.
`IamAuthInput`	`string`	No description.
`SecretArnInput`	`string`	No description.
`UsernameInput`	`string`	No description.
`AuthScheme`	`string`	No description.
`ClientPasswordAuthType`	`string`	No description.
`Description`	`string`	No description.
`IamAuth`	`string`	No description.
`SecretArn`	`string`	No description.
`Username`	`string`	No description.
`InternalValue`	`object`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

public string Fqn { get; }

Type: string

`AuthSchemeInput`^Optional

public string AuthSchemeInput { get; }

Type: string

`ClientPasswordAuthTypeInput`^Optional

public string ClientPasswordAuthTypeInput { get; }

Type: string

`DescriptionInput`^Optional

public string DescriptionInput { get; }

Type: string

`IamAuthInput`^Optional

public string IamAuthInput { get; }

Type: string

`SecretArnInput`^Optional

public string SecretArnInput { get; }

Type: string

`UsernameInput`^Optional

public string UsernameInput { get; }

Type: string

`AuthScheme`^Required

public string AuthScheme { get; }

Type: string

`ClientPasswordAuthType`^Required

public string ClientPasswordAuthType { get; }

Type: string

`Description`^Required

public string Description { get; }

Type: string

`IamAuth`^Required

public string IamAuth { get; }

Type: string

`SecretArn`^Required

public string SecretArn { get; }

Type: string

`Username`^Required

public string Username { get; }

Type: string

`InternalValue`^Optional

public object InternalValue { get; }

Type: object

DbProxyTimeoutsOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DbProxyTimeoutsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`ComputeFqn`	No description.
`GetAnyMapAttribute`	No description.
`GetBooleanAttribute`	No description.
`GetBooleanMapAttribute`	No description.
`GetListAttribute`	No description.
`GetNumberAttribute`	No description.
`GetNumberListAttribute`	No description.
`GetNumberMapAttribute`	No description.
`GetStringAttribute`	No description.
`GetStringMapAttribute`	No description.
`InterpolationForAttribute`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`ResetCreate`	No description.
`ResetDelete`	No description.
`ResetUpdate`	No description.

`ComputeFqn`

private string ComputeFqn()

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string Property)

`Property`^Required

Type: string

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetCreate`

private void ResetCreate()

`ResetDelete`

private void ResetDelete()

`ResetUpdate`

private void ResetUpdate()

Properties

Name	Type	Description
`CreationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`string`	No description.
`CreateInput`	`string`	No description.
`DeleteInput`	`string`	No description.
`UpdateInput`	`string`	No description.
`Create`	`string`	No description.
`Delete`	`string`	No description.
`Update`	`string`	No description.
`InternalValue`	`object`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

public string Fqn { get; }

Type: string

`CreateInput`^Optional

public string CreateInput { get; }

Type: string

`DeleteInput`^Optional

public string DeleteInput { get; }

Type: string

`UpdateInput`^Optional

public string UpdateInput { get; }

Type: string

`Create`^Required

public string Create { get; }

Type: string

`Delete`^Required

public string Delete { get; }

Type: string

`Update`^Required

public string Update { get; }

Type: string

`InternalValue`^Optional

public object InternalValue { get; }

Type: object

Files

dbProxy.csharp.md

Latest commit

History

dbProxy.csharp.md

File metadata and controls

dbProxy Submodule

Constructs

DbProxy

Initializers

ScopeRequired

IdRequired

ConfigRequired

Methods

ToString

AddOverride

PathRequired

ValueRequired

OverrideLogicalId

NewLogicalIdRequired

ResetOverrideLogicalId

ToHclTerraform

ToMetadata

ToTerraform

AddMoveTarget

MoveTargetRequired

GetAnyMapAttribute

TerraformAttributeRequired

GetBooleanAttribute

TerraformAttributeRequired

GetBooleanMapAttribute

TerraformAttributeRequired

GetListAttribute

TerraformAttributeRequired

GetNumberAttribute

TerraformAttributeRequired

GetNumberListAttribute

TerraformAttributeRequired

GetNumberMapAttribute

TerraformAttributeRequired

GetStringAttribute

TerraformAttributeRequired

GetStringMapAttribute

TerraformAttributeRequired

HasResourceMove

ImportFrom

IdRequired

ProviderOptional

InterpolationForAttribute

TerraformAttributeRequired

MoveFromId

IdRequired

MoveTo

MoveTargetRequired

IndexOptional

MoveToId

IdRequired

PutAuth

ValueRequired

PutTimeouts

ValueRequired

ResetDebugLogging

ResetId

ResetIdleClientTimeout

ResetRequireTls

ResetTags

ResetTagsAll

ResetTimeouts

ResetVpcSecurityGroupIds

Static Functions

IsConstruct

XRequired

IsTerraformElement

XRequired

IsTerraformResource

XRequired

GenerateConfigForImport

ScopeRequired

ImportToIdRequired

ImportFromIdRequired

`dbProxy` Submodule

`Scope`^Required

`Id`^Required

`Config`^Required

`ToString`

`AddOverride`

`Path`^Required

`Value`^Required

`OverrideLogicalId`

`NewLogicalId`^Required

`ResetOverrideLogicalId`

`ToHclTerraform`

`ToMetadata`

`ToTerraform`

`AddMoveTarget`

`MoveTarget`^Required

`GetAnyMapAttribute`

`TerraformAttribute`^Required

`GetBooleanAttribute`

`TerraformAttribute`^Required

`GetBooleanMapAttribute`

`TerraformAttribute`^Required

`GetListAttribute`

`TerraformAttribute`^Required

`GetNumberAttribute`

`TerraformAttribute`^Required

`GetNumberListAttribute`

`TerraformAttribute`^Required

`GetNumberMapAttribute`

`TerraformAttribute`^Required

`GetStringAttribute`

`TerraformAttribute`^Required

`GetStringMapAttribute`

`TerraformAttribute`^Required

`HasResourceMove`

`ImportFrom`

`Id`^Required

`Provider`^Optional

`InterpolationForAttribute`

`TerraformAttribute`^Required

`MoveFromId`

`Id`^Required

`MoveTo`

`MoveTarget`^Required

`Index`^Optional

`MoveToId`

`Id`^Required

`PutAuth`

`Value`^Required

`PutTimeouts`

`Value`^Required

`ResetDebugLogging`

`ResetId`

`ResetIdleClientTimeout`

`ResetRequireTls`

`ResetTags`

`ResetTagsAll`

`ResetTimeouts`

`ResetVpcSecurityGroupIds`

`IsConstruct`

`X`^Required

`IsTerraformElement`

`X`^Required

`IsTerraformResource`

`X`^Required

`GenerateConfigForImport`

`Scope`^Required

`ImportToId`^Required

`ImportFromId`^Required

`Provider`^Optional

`Node`^Required

`CdktfStack`^Required

`Fqn`^Required

`FriendlyUniqueId`^Required

`TerraformMetaArguments`^Required

`TerraformResourceType`^Required

`TerraformGeneratorMetadata`^Optional

`Connection`^Optional

`Count`^Optional

`DependsOn`^Optional