`magicWanStaticRoute` Submodule

Constructs

MagicWanStaticRoute

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/magic_wan_static_route cloudflare_magic_wan_static_route}.

Initializers

import { magicWanStaticRoute } from '@cdktf/provider-cloudflare'

new magicWanStaticRoute.MagicWanStaticRoute(scope: Construct, id: string, config: MagicWanStaticRouteConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`MagicWanStaticRouteConfig`	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: MagicWanStaticRouteConfig

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".
`putScope`	No description.
`resetDescription`	No description.
`resetScope`	No description.
`resetWeight`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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`

public resetOverrideLogicalId(): void

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

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

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`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

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`

public moveTo(moveTarget: string, index?: string | number): void

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: string | number

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

`moveToId`

public moveToId(id: string): void

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

`putScope`

public putScope(value: MagicWanStaticRouteScope): void

`value`^Required

Type: MagicWanStaticRouteScope

`resetDescription`

public resetDescription(): void

`resetScope`

public resetScope(): void

`resetWeight`

public resetWeight(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.
`generateConfigForImport`	Generates CDKTF code for importing a MagicWanStaticRoute resource upon running "cdktf plan ".

`isConstruct`

import { magicWanStaticRoute } from '@cdktf/provider-cloudflare'

magicWanStaticRoute.MagicWanStaticRoute.isConstruct(x: any)

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: any

Any object.

`isTerraformElement`

import { magicWanStaticRoute } from '@cdktf/provider-cloudflare'

magicWanStaticRoute.MagicWanStaticRoute.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { magicWanStaticRoute } from '@cdktf/provider-cloudflare'

magicWanStaticRoute.MagicWanStaticRoute.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { magicWanStaticRoute } from '@cdktf/provider-cloudflare'

magicWanStaticRoute.MagicWanStaticRoute.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`importFromId`^Required

Type: string

The id of the existing MagicWanStaticRoute that should be imported.

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

`provider`^Optional

Type: cdktf.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktfStack`	`cdktf.TerraformStack`	No description.
`fqn`	`string`	No description.
`friendlyUniqueId`	`string`	No description.
`terraformMetaArguments`	`{[ key: string ]: any}`	No description.
`terraformResourceType`	`string`	No description.
`terraformGeneratorMetadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`createdOn`	`string`	No description.
`id`	`string`	No description.
`modifiedOn`	`string`	No description.
`scope`	`MagicWanStaticRouteScopeOutputReference`	No description.
`accountIdInput`	`string`	No description.
`descriptionInput`	`string`	No description.
`nexthopInput`	`string`	No description.
`prefixInput`	`string`	No description.
`priorityInput`	`number`	No description.
`scopeInput`	`cdktf.IResolvable \| MagicWanStaticRouteScope`	No description.
`weightInput`	`number`	No description.
`accountId`	`string`	No description.
`description`	`string`	No description.
`nexthop`	`string`	No description.
`prefix`	`string`	No description.
`priority`	`number`	No description.
`weight`	`number`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`createdOn`^Required

public readonly createdOn: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`modifiedOn`^Required

public readonly modifiedOn: string;

Type: string

`scope`^Required

public readonly scope: MagicWanStaticRouteScopeOutputReference;

Type: MagicWanStaticRouteScopeOutputReference

`accountIdInput`^Optional

public readonly accountIdInput: string;

Type: string

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`nexthopInput`^Optional

public readonly nexthopInput: string;

Type: string

`prefixInput`^Optional

public readonly prefixInput: string;

Type: string

`priorityInput`^Optional

public readonly priorityInput: number;

Type: number

`scopeInput`^Optional

public readonly scopeInput: IResolvable | MagicWanStaticRouteScope;

Type: cdktf.IResolvable | MagicWanStaticRouteScope

`weightInput`^Optional

public readonly weightInput: number;

Type: number

`accountId`^Required

public readonly accountId: string;

Type: string

`description`^Required

public readonly description: string;

Type: string

`nexthop`^Required

public readonly nexthop: string;

Type: string

`prefix`^Required

public readonly prefix: string;

Type: string

`priority`^Required

public readonly priority: number;

Type: number

`weight`^Required

public readonly weight: number;

Type: number

Constants

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

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

MagicWanStaticRouteConfig

Initializer

import { magicWanStaticRoute } from '@cdktf/provider-cloudflare'

const magicWanStaticRouteConfig: magicWanStaticRoute.MagicWanStaticRouteConfig = { ... }

Properties

Name	Type	Description
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`cdktf.ITerraformDependable[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`accountId`	`string`	Identifier.
`nexthop`	`string`	The next-hop IP Address for the static route.
`prefix`	`string`	IP Prefix in Classless Inter-Domain Routing format.
`priority`	`number`	Priority of the static route.
`description`	`string`	An optional human provided description of the static route.
`scope`	`MagicWanStaticRouteScope`	Used only for ECMP routes.
`weight`	`number`	Optional weight of the ECMP scope - if provided.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`accountId`^Required

public readonly accountId: string;

Type: string

Identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/magic_wan_static_route#account_id MagicWanStaticRoute#account_id}

`nexthop`^Required

public readonly nexthop: string;

Type: string

The next-hop IP Address for the static route.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/magic_wan_static_route#nexthop MagicWanStaticRoute#nexthop}

`prefix`^Required

public readonly prefix: string;

Type: string

IP Prefix in Classless Inter-Domain Routing format.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/magic_wan_static_route#prefix MagicWanStaticRoute#prefix}

`priority`^Required

public readonly priority: number;

Type: number

Priority of the static route.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/magic_wan_static_route#priority MagicWanStaticRoute#priority}

`description`^Optional

public readonly description: string;

Type: string

An optional human provided description of the static route.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/magic_wan_static_route#description MagicWanStaticRoute#description}

`scope`^Optional

public readonly scope: MagicWanStaticRouteScope;

Type: MagicWanStaticRouteScope

Used only for ECMP routes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/magic_wan_static_route#scope MagicWanStaticRoute#scope}

`weight`^Optional

public readonly weight: number;

Type: number

Optional weight of the ECMP scope - if provided.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/magic_wan_static_route#weight MagicWanStaticRoute#weight}

MagicWanStaticRouteScope

Initializer

import { magicWanStaticRoute } from '@cdktf/provider-cloudflare'

const magicWanStaticRouteScope: magicWanStaticRoute.MagicWanStaticRouteScope = { ... }

Properties

Name	Type	Description
`coloNames`	`string[]`	List of colo names for the ECMP scope.
`coloRegions`	`string[]`	List of colo regions for the ECMP scope.

`coloNames`^Optional

public readonly coloNames: string[];

Type: string[]

List of colo names for the ECMP scope.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/magic_wan_static_route#colo_names MagicWanStaticRoute#colo_names}

`coloRegions`^Optional

public readonly coloRegions: string[];

Type: string[]

List of colo regions for the ECMP scope.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/magic_wan_static_route#colo_regions MagicWanStaticRoute#colo_regions}

Classes

MagicWanStaticRouteScopeOutputReference

Initializers

import { magicWanStaticRoute } from '@cdktf/provider-cloudflare'

new magicWanStaticRoute.MagicWanStaticRouteScopeOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: 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.
`resetColoNames`	No description.
`resetColoRegions`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetColoNames`

public resetColoNames(): void

`resetColoRegions`

public resetColoRegions(): void

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.
`coloNamesInput`	`string[]`	No description.
`coloRegionsInput`	`string[]`	No description.
`coloNames`	`string[]`	No description.
`coloRegions`	`string[]`	No description.
`internalValue`	`cdktf.IResolvable \| MagicWanStaticRouteScope`	No description.

`creationStack`^Required

public readonly creationStack: string[];

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 readonly fqn: string;

Type: string

`coloNamesInput`^Optional

public readonly coloNamesInput: string[];

Type: string[]

`coloRegionsInput`^Optional

public readonly coloRegionsInput: string[];

Type: string[]

`coloNames`^Required

public readonly coloNames: string[];

Type: string[]

`coloRegions`^Required

public readonly coloRegions: string[];

Type: string[]

`internalValue`^Optional

public readonly internalValue: IResolvable | MagicWanStaticRouteScope;

Type: cdktf.IResolvable | MagicWanStaticRouteScope

FilesExpand file tree

magicWanStaticRoute.typescript.md

Latest commit

History

magicWanStaticRoute.typescript.md

File metadata and controls

magicWanStaticRoute Submodule

Constructs