Skip to content

Latest commit

 

History

History
2650 lines (1659 loc) · 104 KB

File metadata and controls

2650 lines (1659 loc) · 104 KB

dbProxy Submodule

Constructs

DbProxy

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

Initializers

using Io.Cdktn.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.

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


ConfigRequired

Methods

Name Description
ToString Returns a string representation of this construct.
With Applies one or more mixins to 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.
ResetAuth No description.
ResetDebugLogging No description.
ResetDefaultAuthScheme No description.
ResetEndpointNetworkType No description.
ResetId No description.
ResetIdleClientTimeout No description.
ResetRegion No description.
ResetRequireTls No description.
ResetTags No description.
ResetTagsAll No description.
ResetTargetConnectionNetworkType No description.
ResetTimeouts No description.
ResetVpcSecurityGroupIds No description.

ToString
private string ToString()

Returns a string representation of this construct.

With
private IConstruct With(params IMixin[] Mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

MixinsRequired
  • Type: params Constructs.IMixin[]

The mixins to apply.


AddOverride
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string

ValueRequired
  • Type: object

OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalIdRequired
  • 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.

MoveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

HasResourceMove
private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove()
ImportFrom
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string

ProviderOptional
  • Type: Io.Cdktn.TerraformProvider

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • 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.

IdRequired
  • Type: string

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


MoveTo
private void MoveTo(string MoveTarget, string|double Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTargetRequired
  • Type: string

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


IndexOptional
  • Type: string|double

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".

IdRequired
  • Type: string

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


PutAuth
private void PutAuth(IResolvable|DbProxyAuth[] Value)
ValueRequired

PutTimeouts
private void PutTimeouts(DbProxyTimeouts Value)
ValueRequired

ResetAuth
private void ResetAuth()
ResetDebugLogging
private void ResetDebugLogging()
ResetDefaultAuthScheme
private void ResetDefaultAuthScheme()
ResetEndpointNetworkType
private void ResetEndpointNetworkType()
ResetId
private void ResetId()
ResetIdleClientTimeout
private void ResetIdleClientTimeout()
ResetRegion
private void ResetRegion()
ResetRequireTls
private void ResetRequireTls()
ResetTags
private void ResetTags()
ResetTagsAll
private void ResetTagsAll()
ResetTargetConnectionNetworkType
private void ResetTargetConnectionNetworkType()
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 CDKTN code for importing a DbProxy resource upon running "cdktn plan ".

IsConstruct
using Io.Cdktn.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.

XRequired
  • Type: object

Any object.


IsTerraformElement
using Io.Cdktn.Providers.Aws;

DbProxy.IsTerraformElement(object X);
XRequired
  • Type: object

IsTerraformResource
using Io.Cdktn.Providers.Aws;

DbProxy.IsTerraformResource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using Io.Cdktn.Providers.Aws;

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

Generates CDKTN code for importing a DbProxy resource upon running "cdktn plan ".

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


ImportToIdRequired
  • Type: string

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


ImportFromIdRequired
  • Type: string

The id of the existing DbProxy that should be imported.

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


ProviderOptional
  • Type: Io.Cdktn.TerraformProvider

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


Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack Io.Cdktn.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 Io.Cdktn.TerraformProviderGeneratorMetadata No description.
Connection Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection No description.
Count double|Io.Cdktn.TerraformCount No description.
DependsOn string[] No description.
ForEach Io.Cdktn.ITerraformIterator No description.
Lifecycle Io.Cdktn.TerraformResourceLifecycle No description.
Provider Io.Cdktn.TerraformProvider No description.
Provisioners Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] No description.
Arn string No description.
Auth DbProxyAuthList No description.
Endpoint string No description.
Timeouts DbProxyTimeoutsOutputReference No description.
AuthInput Io.Cdktn.IResolvable|DbProxyAuth[] No description.
DebugLoggingInput bool|Io.Cdktn.IResolvable No description.
DefaultAuthSchemeInput string No description.
EndpointNetworkTypeInput string No description.
EngineFamilyInput string No description.
IdInput string No description.
IdleClientTimeoutInput double No description.
NameInput string No description.
RegionInput string No description.
RequireTlsInput bool|Io.Cdktn.IResolvable No description.
RoleArnInput string No description.
TagsAllInput System.Collections.Generic.IDictionary<string, string> No description.
TagsInput System.Collections.Generic.IDictionary<string, string> No description.
TargetConnectionNetworkTypeInput string No description.
TimeoutsInput Io.Cdktn.IResolvable|DbProxyTimeouts No description.
VpcSecurityGroupIdsInput string[] No description.
VpcSubnetIdsInput string[] No description.
DebugLogging bool|Io.Cdktn.IResolvable No description.
DefaultAuthScheme string No description.
EndpointNetworkType string No description.
EngineFamily string No description.
Id string No description.
IdleClientTimeout double No description.
Name string No description.
Region string No description.
RequireTls bool|Io.Cdktn.IResolvable No description.
RoleArn string No description.
Tags System.Collections.Generic.IDictionary<string, string> No description.
TagsAll System.Collections.Generic.IDictionary<string, string> No description.
TargetConnectionNetworkType string No description.
VpcSecurityGroupIds string[] No description.
VpcSubnetIds string[] No description.

NodeRequired
public Node Node { get; }
  • Type: Constructs.Node

The tree node.


CdktfStackRequired
public TerraformStack CdktfStack { get; }
  • Type: Io.Cdktn.TerraformStack

FqnRequired
public string Fqn { get; }
  • Type: string

FriendlyUniqueIdRequired
public string FriendlyUniqueId { get; }
  • Type: string

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

TerraformResourceTypeRequired
public string TerraformResourceType { get; }
  • Type: string

TerraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: Io.Cdktn.TerraformProviderGeneratorMetadata

ConnectionOptional
public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; }
  • Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

CountOptional
public double|TerraformCount Count { get; }
  • Type: double|Io.Cdktn.TerraformCount

DependsOnOptional
public string[] DependsOn { get; }
  • Type: string[]

ForEachOptional
public ITerraformIterator ForEach { get; }
  • Type: Io.Cdktn.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: Io.Cdktn.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; }
  • Type: Io.Cdktn.TerraformProvider

ProvisionersOptional
public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; }
  • Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

ArnRequired
public string Arn { get; }
  • Type: string

AuthRequired
public DbProxyAuthList Auth { get; }

EndpointRequired
public string Endpoint { get; }
  • Type: string

TimeoutsRequired
public DbProxyTimeoutsOutputReference Timeouts { get; }

AuthInputOptional
public IResolvable|DbProxyAuth[] AuthInput { get; }

DebugLoggingInputOptional
public bool|IResolvable DebugLoggingInput { get; }
  • Type: bool|Io.Cdktn.IResolvable

DefaultAuthSchemeInputOptional
public string DefaultAuthSchemeInput { get; }
  • Type: string

EndpointNetworkTypeInputOptional
public string EndpointNetworkTypeInput { get; }
  • Type: string

EngineFamilyInputOptional
public string EngineFamilyInput { get; }
  • Type: string

IdInputOptional
public string IdInput { get; }
  • Type: string

IdleClientTimeoutInputOptional
public double IdleClientTimeoutInput { get; }
  • Type: double

NameInputOptional
public string NameInput { get; }
  • Type: string

RegionInputOptional
public string RegionInput { get; }
  • Type: string

RequireTlsInputOptional
public bool|IResolvable RequireTlsInput { get; }
  • Type: bool|Io.Cdktn.IResolvable

RoleArnInputOptional
public string RoleArnInput { get; }
  • Type: string

TagsAllInputOptional
public System.Collections.Generic.IDictionary<string, string> TagsAllInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

TagsInputOptional
public System.Collections.Generic.IDictionary<string, string> TagsInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

TargetConnectionNetworkTypeInputOptional
public string TargetConnectionNetworkTypeInput { get; }
  • Type: string

TimeoutsInputOptional
public IResolvable|DbProxyTimeouts TimeoutsInput { get; }

VpcSecurityGroupIdsInputOptional
public string[] VpcSecurityGroupIdsInput { get; }
  • Type: string[]

VpcSubnetIdsInputOptional
public string[] VpcSubnetIdsInput { get; }
  • Type: string[]

DebugLoggingRequired
public bool|IResolvable DebugLogging { get; }
  • Type: bool|Io.Cdktn.IResolvable

DefaultAuthSchemeRequired
public string DefaultAuthScheme { get; }
  • Type: string

EndpointNetworkTypeRequired
public string EndpointNetworkType { get; }
  • Type: string

EngineFamilyRequired
public string EngineFamily { get; }
  • Type: string

IdRequired
public string Id { get; }
  • Type: string

IdleClientTimeoutRequired
public double IdleClientTimeout { get; }
  • Type: double

NameRequired
public string Name { get; }
  • Type: string

RegionRequired
public string Region { get; }
  • Type: string

RequireTlsRequired
public bool|IResolvable RequireTls { get; }
  • Type: bool|Io.Cdktn.IResolvable

RoleArnRequired
public string RoleArn { get; }
  • Type: string

TagsRequired
public System.Collections.Generic.IDictionary<string, string> Tags { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

TagsAllRequired
public System.Collections.Generic.IDictionary<string, string> TagsAll { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

TargetConnectionNetworkTypeRequired
public string TargetConnectionNetworkType { get; }
  • Type: string

VpcSecurityGroupIdsRequired
public string[] VpcSecurityGroupIds { get; }
  • Type: string[]

VpcSubnetIdsRequired
public string[] VpcSubnetIds { get; }
  • Type: string[]

Constants

Name Type Description
TfResourceType string No description.

TfResourceTypeRequired
public string TfResourceType { get; }
  • Type: string

Structs

DbProxyAuth

Initializer

using Io.Cdktn.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/6.55.0/docs/resources/db_proxy#auth_scheme DbProxy#auth_scheme}.
ClientPasswordAuthType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.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/6.55.0/docs/resources/db_proxy#description DbProxy#description}.
IamAuth string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/db_proxy#iam_auth DbProxy#iam_auth}.
SecretArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/db_proxy#secret_arn DbProxy#secret_arn}.
Username string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/db_proxy#username DbProxy#username}.

AuthSchemeOptional
public string AuthScheme { get; set; }
  • Type: string

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


ClientPasswordAuthTypeOptional
public string ClientPasswordAuthType { get; set; }
  • Type: string

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


DescriptionOptional
public string Description { get; set; }
  • Type: string

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


IamAuthOptional
public string IamAuth { get; set; }
  • Type: string

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


SecretArnOptional
public string SecretArn { get; set; }
  • Type: string

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


UsernameOptional
public string Username { get; set; }
  • Type: string

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


DbProxyConfig

Initializer

using Io.Cdktn.Providers.Aws;

new DbProxyConfig {
    SSHProvisionerConnection|WinrmProvisionerConnection Connection = null,
    double|TerraformCount Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners = null,
    string EngineFamily,
    string Name,
    string RoleArn,
    string[] VpcSubnetIds,
    IResolvable|DbProxyAuth[] Auth = null,
    bool|IResolvable DebugLogging = null,
    string DefaultAuthScheme = null,
    string EndpointNetworkType = null,
    string Id = null,
    double IdleClientTimeout = null,
    string Region = null,
    bool|IResolvable RequireTls = null,
    System.Collections.Generic.IDictionary<string, string> Tags = null,
    System.Collections.Generic.IDictionary<string, string> TagsAll = null,
    string TargetConnectionNetworkType = null,
    DbProxyTimeouts Timeouts = null,
    string[] VpcSecurityGroupIds = null
};

Properties

Name Type Description
Connection Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection No description.
Count double|Io.Cdktn.TerraformCount No description.
DependsOn Io.Cdktn.ITerraformDependable[] No description.
ForEach Io.Cdktn.ITerraformIterator No description.
Lifecycle Io.Cdktn.TerraformResourceLifecycle No description.
Provider Io.Cdktn.TerraformProvider No description.
Provisioners Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] No description.
EngineFamily string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/db_proxy#engine_family DbProxy#engine_family}.
Name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/db_proxy#name DbProxy#name}.
RoleArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/db_proxy#role_arn DbProxy#role_arn}.
VpcSubnetIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/db_proxy#vpc_subnet_ids DbProxy#vpc_subnet_ids}.
Auth Io.Cdktn.IResolvable|DbProxyAuth[] auth block.
DebugLogging bool|Io.Cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/db_proxy#debug_logging DbProxy#debug_logging}.
DefaultAuthScheme string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/db_proxy#default_auth_scheme DbProxy#default_auth_scheme}.
EndpointNetworkType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/db_proxy#endpoint_network_type DbProxy#endpoint_network_type}.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/db_proxy#id DbProxy#id}.
IdleClientTimeout double Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/db_proxy#idle_client_timeout DbProxy#idle_client_timeout}.
Region string Region where this resource will be managed. Defaults to the Region set in the provider configuration.
RequireTls bool|Io.Cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.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/6.55.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/6.55.0/docs/resources/db_proxy#tags_all DbProxy#tags_all}.
TargetConnectionNetworkType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/db_proxy#target_connection_network_type DbProxy#target_connection_network_type}.
Timeouts DbProxyTimeouts timeouts block.
VpcSecurityGroupIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/db_proxy#vpc_security_group_ids DbProxy#vpc_security_group_ids}.

ConnectionOptional
public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; }
  • Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

CountOptional
public double|TerraformCount Count { get; set; }
  • Type: double|Io.Cdktn.TerraformCount

DependsOnOptional
public ITerraformDependable[] DependsOn { get; set; }
  • Type: Io.Cdktn.ITerraformDependable[]

ForEachOptional
public ITerraformIterator ForEach { get; set; }
  • Type: Io.Cdktn.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: Io.Cdktn.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; set; }
  • Type: Io.Cdktn.TerraformProvider

ProvisionersOptional
public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; }
  • Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

EngineFamilyRequired
public string EngineFamily { get; set; }
  • Type: string

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


NameRequired
public string Name { get; set; }
  • Type: string

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


RoleArnRequired
public string RoleArn { get; set; }
  • Type: string

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


VpcSubnetIdsRequired
public string[] VpcSubnetIds { get; set; }
  • Type: string[]

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


AuthOptional
public IResolvable|DbProxyAuth[] Auth { get; set; }

auth block.

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


DebugLoggingOptional
public bool|IResolvable DebugLogging { get; set; }
  • Type: bool|Io.Cdktn.IResolvable

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


DefaultAuthSchemeOptional
public string DefaultAuthScheme { get; set; }
  • Type: string

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


EndpointNetworkTypeOptional
public string EndpointNetworkType { get; set; }
  • Type: string

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


IdOptional
public string Id { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.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.


IdleClientTimeoutOptional
public double IdleClientTimeout { get; set; }
  • Type: double

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


RegionOptional
public string Region { get; set; }
  • Type: string

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

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


RequireTlsOptional
public bool|IResolvable RequireTls { get; set; }
  • Type: bool|Io.Cdktn.IResolvable

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


TagsOptional
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/6.55.0/docs/resources/db_proxy#tags DbProxy#tags}.


TagsAllOptional
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/6.55.0/docs/resources/db_proxy#tags_all DbProxy#tags_all}.


TargetConnectionNetworkTypeOptional
public string TargetConnectionNetworkType { get; set; }
  • Type: string

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


TimeoutsOptional
public DbProxyTimeouts Timeouts { get; set; }

timeouts block.

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


VpcSecurityGroupIdsOptional
public string[] VpcSecurityGroupIds { get; set; }
  • Type: string[]

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


DbProxyTimeouts

Initializer

using Io.Cdktn.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/6.55.0/docs/resources/db_proxy#create DbProxy#create}.
Delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/db_proxy#delete DbProxy#delete}.
Update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/db_proxy#update DbProxy#update}.

CreateOptional
public string Create { get; set; }
  • Type: string

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


DeleteOptional
public string Delete { get; set; }
  • Type: string

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


UpdateOptional
public string Update { get; set; }
  • Type: string

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


Classes

DbProxyAuthList

Initializers

using Io.Cdktn.Providers.Aws;

new DbProxyAuthList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);
Name Type Description
TerraformResource Io.Cdktn.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).

TerraformResourceRequired
  • Type: Io.Cdktn.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


WrapsSetRequired
  • 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.

MapKeyAttributeNameRequired
  • Type: string

ComputeFqn
private string ComputeFqn()
Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: Io.Cdktn.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get
private DbProxyAuthOutputReference Get(double Index)
IndexRequired
  • 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 Io.Cdktn.IResolvable|DbProxyAuth[] No description.

CreationStackRequired
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.


FqnRequired
public string Fqn { get; }
  • Type: string

InternalValueOptional
public IResolvable|DbProxyAuth[] InternalValue { get; }

DbProxyAuthOutputReference

Initializers

using Io.Cdktn.Providers.Aws;

new DbProxyAuthOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);
Name Type Description
TerraformResource Io.Cdktn.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).

TerraformResourceRequired
  • Type: Io.Cdktn.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


ComplexObjectIndexRequired
  • Type: double

the index of this item in the list.


ComplexObjectIsFromSetRequired
  • 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)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string

Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: Io.Cdktn.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 Io.Cdktn.IResolvable|DbProxyAuth No description.

CreationStackRequired
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.


FqnRequired
public string Fqn { get; }
  • Type: string

AuthSchemeInputOptional
public string AuthSchemeInput { get; }
  • Type: string

ClientPasswordAuthTypeInputOptional
public string ClientPasswordAuthTypeInput { get; }
  • Type: string

DescriptionInputOptional
public string DescriptionInput { get; }
  • Type: string

IamAuthInputOptional
public string IamAuthInput { get; }
  • Type: string

SecretArnInputOptional
public string SecretArnInput { get; }
  • Type: string

UsernameInputOptional
public string UsernameInput { get; }
  • Type: string

AuthSchemeRequired
public string AuthScheme { get; }
  • Type: string

ClientPasswordAuthTypeRequired
public string ClientPasswordAuthType { get; }
  • Type: string

DescriptionRequired
public string Description { get; }
  • Type: string

IamAuthRequired
public string IamAuth { get; }
  • Type: string

SecretArnRequired
public string SecretArn { get; }
  • Type: string

UsernameRequired
public string Username { get; }
  • Type: string

InternalValueOptional
public IResolvable|DbProxyAuth InternalValue { get; }

DbProxyTimeoutsOutputReference

Initializers

using Io.Cdktn.Providers.Aws;

new DbProxyTimeoutsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);
Name Type Description
TerraformResource Io.Cdktn.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.

TerraformResourceRequired
  • Type: Io.Cdktn.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • 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)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string

Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: Io.Cdktn.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 Io.Cdktn.IResolvable|DbProxyTimeouts No description.

CreationStackRequired
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.


FqnRequired
public string Fqn { get; }
  • Type: string

CreateInputOptional
public string CreateInput { get; }
  • Type: string

DeleteInputOptional
public string DeleteInput { get; }
  • Type: string

UpdateInputOptional
public string UpdateInput { get; }
  • Type: string

CreateRequired
public string Create { get; }
  • Type: string

DeleteRequired
public string Delete { get; }
  • Type: string

UpdateRequired
public string Update { get; }
  • Type: string

InternalValueOptional
public IResolvable|DbProxyTimeouts InternalValue { get; }