Skip to content

Latest commit

 

History

History
1279 lines (802 loc) · 49.1 KB

dxConnection.csharp.md

File metadata and controls

1279 lines (802 loc) · 49.1 KB

dxConnection Submodule

Constructs

DxConnection

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

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DxConnection(Construct Scope, string Id, DxConnectionConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config DxConnectionConfig 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.
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".
ResetEncryptionMode No description.
ResetId No description.
ResetProviderName No description.
ResetRequestMacsec No description.
ResetSkipDestroy No description.
ResetTags No description.
ResetTagsAll No description.

ToString
private string ToString()

Returns a string representation of this construct.

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 object HasResourceMove()
ImportFrom
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string

ProviderOptional
  • Type: HashiCorp.Cdktf.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, object 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: 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".

IdRequired
  • Type: string

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


ResetEncryptionMode
private void ResetEncryptionMode()
ResetId
private void ResetId()
ResetProviderName
private void ResetProviderName()
ResetRequestMacsec
private void ResetRequestMacsec()
ResetSkipDestroy
private void ResetSkipDestroy()
ResetTags
private void ResetTags()
ResetTagsAll
private void ResetTagsAll()

Static Functions

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

IsConstruct
using HashiCorp.Cdktf.Providers.Aws;

DxConnection.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 HashiCorp.Cdktf.Providers.Aws;

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

IsTerraformResource
using HashiCorp.Cdktf.Providers.Aws;

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

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Aws;

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

Generates CDKTF code for importing a DxConnection resource upon running "cdktf 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 DxConnection to import.


ImportFromIdRequired
  • Type: string

The id of the existing DxConnection that should be imported.

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


ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the DxConnection 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.
AwsDevice string No description.
HasLogicalRedundancy string No description.
JumboFrameCapable HashiCorp.Cdktf.IResolvable No description.
MacsecCapable HashiCorp.Cdktf.IResolvable No description.
OwnerAccountId string No description.
PartnerName string No description.
PortEncryptionStatus string No description.
VlanId double No description.
BandwidthInput string No description.
EncryptionModeInput string No description.
IdInput string No description.
LocationInput string No description.
NameInput string No description.
ProviderNameInput string No description.
RequestMacsecInput object No description.
SkipDestroyInput object No description.
TagsAllInput System.Collections.Generic.IDictionary<string, string> No description.
TagsInput System.Collections.Generic.IDictionary<string, string> No description.
Bandwidth string No description.
EncryptionMode string No description.
Id string No description.
Location string No description.
Name string No description.
ProviderName string No description.
RequestMacsec object No description.
SkipDestroy object No description.
Tags System.Collections.Generic.IDictionary<string, string> No description.
TagsAll System.Collections.Generic.IDictionary<string, string> No description.

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

The tree node.


CdktfStackRequired
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.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: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

ConnectionOptional
public object Connection { get; }
  • Type: object

CountOptional
public object Count { get; }
  • Type: object

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

ForEachOptional
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; }
  • Type: object[]

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

AwsDeviceRequired
public string AwsDevice { get; }
  • Type: string

HasLogicalRedundancyRequired
public string HasLogicalRedundancy { get; }
  • Type: string

JumboFrameCapableRequired
public IResolvable JumboFrameCapable { get; }
  • Type: HashiCorp.Cdktf.IResolvable

MacsecCapableRequired
public IResolvable MacsecCapable { get; }
  • Type: HashiCorp.Cdktf.IResolvable

OwnerAccountIdRequired
public string OwnerAccountId { get; }
  • Type: string

PartnerNameRequired
public string PartnerName { get; }
  • Type: string

PortEncryptionStatusRequired
public string PortEncryptionStatus { get; }
  • Type: string

VlanIdRequired
public double VlanId { get; }
  • Type: double

BandwidthInputOptional
public string BandwidthInput { get; }
  • Type: string

EncryptionModeInputOptional
public string EncryptionModeInput { get; }
  • Type: string

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

LocationInputOptional
public string LocationInput { get; }
  • Type: string

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

ProviderNameInputOptional
public string ProviderNameInput { get; }
  • Type: string

RequestMacsecInputOptional
public object RequestMacsecInput { get; }
  • Type: object

SkipDestroyInputOptional
public object SkipDestroyInput { get; }
  • Type: object

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>

BandwidthRequired
public string Bandwidth { get; }
  • Type: string

EncryptionModeRequired
public string EncryptionMode { get; }
  • Type: string

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

LocationRequired
public string Location { get; }
  • Type: string

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

ProviderNameRequired
public string ProviderName { get; }
  • Type: string

RequestMacsecRequired
public object RequestMacsec { get; }
  • Type: object

SkipDestroyRequired
public object SkipDestroy { get; }
  • Type: object

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>

Constants

Name Type Description
TfResourceType string No description.

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

Structs

DxConnectionConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DxConnectionConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Bandwidth,
    string Location,
    string Name,
    string EncryptionMode = null,
    string Id = null,
    string ProviderName = null,
    object RequestMacsec = null,
    object SkipDestroy = null,
    System.Collections.Generic.IDictionary<string, string> Tags = null,
    System.Collections.Generic.IDictionary<string, string> TagsAll = 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.
Bandwidth string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/dx_connection#bandwidth DxConnection#bandwidth}.
Location string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/dx_connection#location DxConnection#location}.
Name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/dx_connection#name DxConnection#name}.
EncryptionMode string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/dx_connection#encryption_mode DxConnection#encryption_mode}.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/dx_connection#id DxConnection#id}.
ProviderName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/dx_connection#provider_name DxConnection#provider_name}.
RequestMacsec object Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/dx_connection#request_macsec DxConnection#request_macsec}.
SkipDestroy object Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/dx_connection#skip_destroy DxConnection#skip_destroy}.
Tags System.Collections.Generic.IDictionary<string, string> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/dx_connection#tags DxConnection#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/dx_connection#tags_all DxConnection#tags_all}.

ConnectionOptional
public object Connection { get; set; }
  • Type: object

CountOptional
public object Count { get; set; }
  • Type: object

DependsOnOptional
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]

ForEachOptional
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; set; }
  • Type: object[]

BandwidthRequired
public string Bandwidth { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/dx_connection#bandwidth DxConnection#bandwidth}.


LocationRequired
public string Location { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/dx_connection#location DxConnection#location}.


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

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


EncryptionModeOptional
public string EncryptionMode { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/dx_connection#encryption_mode DxConnection#encryption_mode}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/dx_connection#id DxConnection#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.


ProviderNameOptional
public string ProviderName { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/dx_connection#provider_name DxConnection#provider_name}.


RequestMacsecOptional
public object RequestMacsec { get; set; }
  • Type: object

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/dx_connection#request_macsec DxConnection#request_macsec}.


SkipDestroyOptional
public object SkipDestroy { get; set; }
  • Type: object

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/dx_connection#skip_destroy DxConnection#skip_destroy}.


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/5.52.0/docs/resources/dx_connection#tags DxConnection#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/5.52.0/docs/resources/dx_connection#tags_all DxConnection#tags_all}.