Skip to content

Latest commit

 

History

History
1502 lines (933 loc) · 66.1 KB

File metadata and controls

1502 lines (933 loc) · 66.1 KB

magicTransitSiteWan Submodule

Constructs

MagicTransitSiteWan

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/magic_transit_site_wan cloudflare_magic_transit_site_wan}.

Initializers

using Io.Cdktn.Providers.Cloudflare;

new MagicTransitSiteWan(Construct Scope, string Id, MagicTransitSiteWanConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config MagicTransitSiteWanConfig 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".
PutStaticAddressing No description.
ResetName No description.
ResetPriority No description.
ResetStaticAddressing No description.
ResetVlanTag 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".


PutStaticAddressing
private void PutStaticAddressing(MagicTransitSiteWanStaticAddressing Value)
ValueRequired

ResetName
private void ResetName()
ResetPriority
private void ResetPriority()
ResetStaticAddressing
private void ResetStaticAddressing()
ResetVlanTag
private void ResetVlanTag()

Static Functions

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

IsConstruct
using Io.Cdktn.Providers.Cloudflare;

MagicTransitSiteWan.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.Cloudflare;

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

IsTerraformResource
using Io.Cdktn.Providers.Cloudflare;

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

GenerateConfigForImport
using Io.Cdktn.Providers.Cloudflare;

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

Generates CDKTN code for importing a MagicTransitSiteWan 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 MagicTransitSiteWan to import.


ImportFromIdRequired
  • Type: string

The id of the existing MagicTransitSiteWan that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/magic_transit_site_wan#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 MagicTransitSiteWan 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.
HealthCheckRate string No description.
Id string No description.
StaticAddressing MagicTransitSiteWanStaticAddressingOutputReference No description.
AccountIdInput string No description.
NameInput string No description.
PhysportInput double No description.
PriorityInput double No description.
SiteIdInput string No description.
StaticAddressingInput Io.Cdktn.IResolvable|MagicTransitSiteWanStaticAddressing No description.
VlanTagInput double No description.
AccountId string No description.
Name string No description.
Physport double No description.
Priority double No description.
SiteId string No description.
VlanTag double 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[]

HealthCheckRateRequired
public string HealthCheckRate { get; }
  • Type: string

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

StaticAddressingRequired
public MagicTransitSiteWanStaticAddressingOutputReference StaticAddressing { get; }

AccountIdInputOptional
public string AccountIdInput { get; }
  • Type: string

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

PhysportInputOptional
public double PhysportInput { get; }
  • Type: double

PriorityInputOptional
public double PriorityInput { get; }
  • Type: double

SiteIdInputOptional
public string SiteIdInput { get; }
  • Type: string

StaticAddressingInputOptional
public IResolvable|MagicTransitSiteWanStaticAddressing StaticAddressingInput { get; }

VlanTagInputOptional
public double VlanTagInput { get; }
  • Type: double

AccountIdRequired
public string AccountId { get; }
  • Type: string

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

PhysportRequired
public double Physport { get; }
  • Type: double

PriorityRequired
public double Priority { get; }
  • Type: double

SiteIdRequired
public string SiteId { get; }
  • Type: string

VlanTagRequired
public double VlanTag { get; }
  • Type: double

Constants

Name Type Description
TfResourceType string No description.

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

Structs

MagicTransitSiteWanConfig

Initializer

using Io.Cdktn.Providers.Cloudflare;

new MagicTransitSiteWanConfig {
    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 AccountId,
    double Physport,
    string SiteId,
    string Name = null,
    double Priority = null,
    MagicTransitSiteWanStaticAddressing StaticAddressing = null,
    double VlanTag = 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.
AccountId string Identifier.
Physport double Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/magic_transit_site_wan#physport MagicTransitSiteWan#physport}.
SiteId string Identifier.
Name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/magic_transit_site_wan#name MagicTransitSiteWan#name}.
Priority double Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/magic_transit_site_wan#priority MagicTransitSiteWan#priority}.
StaticAddressing MagicTransitSiteWanStaticAddressing (optional) if omitted, use DHCP. Submit secondary_address when site is in high availability mode.
VlanTag double VLAN ID. Use zero for untagged.

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[]

AccountIdRequired
public string AccountId { get; set; }
  • Type: string

Identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/magic_transit_site_wan#account_id MagicTransitSiteWan#account_id}


PhysportRequired
public double Physport { get; set; }
  • Type: double

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/magic_transit_site_wan#physport MagicTransitSiteWan#physport}.


SiteIdRequired
public string SiteId { get; set; }
  • Type: string

Identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/magic_transit_site_wan#site_id MagicTransitSiteWan#site_id}


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/magic_transit_site_wan#name MagicTransitSiteWan#name}.


PriorityOptional
public double Priority { get; set; }
  • Type: double

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/magic_transit_site_wan#priority MagicTransitSiteWan#priority}.


StaticAddressingOptional
public MagicTransitSiteWanStaticAddressing StaticAddressing { get; set; }

(optional) if omitted, use DHCP. Submit secondary_address when site is in high availability mode.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/magic_transit_site_wan#static_addressing MagicTransitSiteWan#static_addressing}


VlanTagOptional
public double VlanTag { get; set; }
  • Type: double

VLAN ID. Use zero for untagged.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/magic_transit_site_wan#vlan_tag MagicTransitSiteWan#vlan_tag}


MagicTransitSiteWanStaticAddressing

Initializer

using Io.Cdktn.Providers.Cloudflare;

new MagicTransitSiteWanStaticAddressing {
    string Address,
    string GatewayAddress,
    string SecondaryAddress = null
};

Properties

Name Type Description
Address string A valid CIDR notation representing an IP range.
GatewayAddress string A valid IPv4 address.
SecondaryAddress string A valid CIDR notation representing an IP range.

AddressRequired
public string Address { get; set; }
  • Type: string

A valid CIDR notation representing an IP range.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/magic_transit_site_wan#address MagicTransitSiteWan#address}


GatewayAddressRequired
public string GatewayAddress { get; set; }
  • Type: string

A valid IPv4 address.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/magic_transit_site_wan#gateway_address MagicTransitSiteWan#gateway_address}


SecondaryAddressOptional
public string SecondaryAddress { get; set; }
  • Type: string

A valid CIDR notation representing an IP range.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/magic_transit_site_wan#secondary_address MagicTransitSiteWan#secondary_address}


Classes

MagicTransitSiteWanStaticAddressingOutputReference

Initializers

using Io.Cdktn.Providers.Cloudflare;

new MagicTransitSiteWanStaticAddressingOutputReference(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.
ResetSecondaryAddress 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.

ResetSecondaryAddress
private void ResetSecondaryAddress()

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.
AddressInput string No description.
GatewayAddressInput string No description.
SecondaryAddressInput string No description.
Address string No description.
GatewayAddress string No description.
SecondaryAddress string No description.
InternalValue Io.Cdktn.IResolvable|MagicTransitSiteWanStaticAddressing 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

AddressInputOptional
public string AddressInput { get; }
  • Type: string

GatewayAddressInputOptional
public string GatewayAddressInput { get; }
  • Type: string

SecondaryAddressInputOptional
public string SecondaryAddressInput { get; }
  • Type: string

AddressRequired
public string Address { get; }
  • Type: string

GatewayAddressRequired
public string GatewayAddress { get; }
  • Type: string

SecondaryAddressRequired
public string SecondaryAddress { get; }
  • Type: string

InternalValueOptional
public IResolvable|MagicTransitSiteWanStaticAddressing InternalValue { get; }