`customerGateway` Submodule

Constructs

CustomerGateway

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/customer_gateway aws_customer_gateway}.

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new CustomerGateway(Construct Scope, string Id, CustomerGatewayConfig Config);

Name	Type	Description
`Scope`	`Constructs.Construct`	The scope in which to define this construct.
`Id`	`string`	The scoped construct ID.
`Config`	`CustomerGatewayConfig`	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: CustomerGatewayConfig

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".
`ResetBgpAsn`	No description.
`ResetBgpAsnExtended`	No description.
`ResetCertificateArn`	No description.
`ResetDeviceName`	No description.
`ResetId`	No description.
`ResetIpAddress`	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)

`Path`^Required

Type: string

`Value`^Required

Type: object

`OverrideLogicalId`

private void OverrideLogicalId(string NewLogicalId)

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

`NewLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`ResetOverrideLogicalId`

private void ResetOverrideLogicalId()

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

`ToHclTerraform`

private object ToHclTerraform()

`ToMetadata`

private object ToMetadata()

`ToTerraform`

private object ToTerraform()

Adds this resource to the terraform JSON output.

`AddMoveTarget`

private void AddMoveTarget(string MoveTarget)

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

`MoveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`GetAnyMapAttribute`

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

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

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

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

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

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

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

`TerraformAttribute`^Required

Type: string

`HasResourceMove`

private object HasResourceMove()

`ImportFrom`

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

`Id`^Required

Type: string

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`MoveFromId`

private void MoveFromId(string Id)

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

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

`Id`^Required

Type: string

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

`MoveTo`

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

Moves this resource to the target resource given by moveTarget.

`MoveTarget`^Required

Type: string

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

`Index`^Optional

Type: object

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

`MoveToId`

private void MoveToId(string Id)

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

`Id`^Required

Type: string

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

`ResetBgpAsn`

private void ResetBgpAsn()

`ResetBgpAsnExtended`

private void ResetBgpAsnExtended()

`ResetCertificateArn`

private void ResetCertificateArn()

`ResetDeviceName`

private void ResetDeviceName()

`ResetId`

private void ResetId()

`ResetIpAddress`

private void ResetIpAddress()

`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 CustomerGateway resource upon running "cdktf plan ".

`IsConstruct`

using HashiCorp.Cdktf.Providers.Aws;

CustomerGateway.IsConstruct(object X);

Checks if x is a construct.

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

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

`X`^Required

Type: object

Any object.

`IsTerraformElement`

using HashiCorp.Cdktf.Providers.Aws;

CustomerGateway.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using HashiCorp.Cdktf.Providers.Aws;

CustomerGateway.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Aws;

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

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

`ImportFromId`^Required

Type: string

The id of the existing CustomerGateway that should be imported.

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

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the CustomerGateway 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.
`BgpAsnExtendedInput`	`string`	No description.
`BgpAsnInput`	`string`	No description.
`CertificateArnInput`	`string`	No description.
`DeviceNameInput`	`string`	No description.
`IdInput`	`string`	No description.
`IpAddressInput`	`string`	No description.
`TagsAllInput`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`TagsInput`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`TypeInput`	`string`	No description.
`BgpAsn`	`string`	No description.
`BgpAsnExtended`	`string`	No description.
`CertificateArn`	`string`	No description.
`DeviceName`	`string`	No description.
`Id`	`string`	No description.
`IpAddress`	`string`	No description.
`Tags`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`TagsAll`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`Type`	`string`	No description.

`Node`^Required

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: HashiCorp.Cdktf.TerraformStack

`Fqn`^Required

public string Fqn { get; }

Type: string

`FriendlyUniqueId`^Required

public string FriendlyUniqueId { get; }

Type: string

`TerraformMetaArguments`^Required

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

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

`TerraformResourceType`^Required

public string TerraformResourceType { get; }

Type: string

`TerraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

public object Connection { get; }

Type: object

`Count`^Optional

public object Count { get; }

Type: object

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; }

Type: object[]

`Arn`^Required

public string Arn { get; }

Type: string

`BgpAsnExtendedInput`^Optional

public string BgpAsnExtendedInput { get; }

Type: string

`BgpAsnInput`^Optional

public string BgpAsnInput { get; }

Type: string

`CertificateArnInput`^Optional

public string CertificateArnInput { get; }

Type: string

`DeviceNameInput`^Optional

public string DeviceNameInput { get; }

Type: string

`IdInput`^Optional

public string IdInput { get; }

Type: string

`IpAddressInput`^Optional

public string IpAddressInput { get; }

Type: string

`TagsAllInput`^Optional

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

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

`TagsInput`^Optional

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

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

`TypeInput`^Optional

public string TypeInput { get; }

Type: string

`BgpAsn`^Required

public string BgpAsn { get; }

Type: string

`BgpAsnExtended`^Required

public string BgpAsnExtended { get; }

Type: string

`CertificateArn`^Required

public string CertificateArn { get; }

Type: string

`DeviceName`^Required

public string DeviceName { get; }

Type: string

`Id`^Required

public string Id { get; }

Type: string

`IpAddress`^Required

public string IpAddress { get; }

Type: string

`Tags`^Required

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

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

`TagsAll`^Required

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

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

`Type`^Required

public string Type { get; }

Type: string

Constants

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

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

CustomerGatewayConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new CustomerGatewayConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Type,
    string BgpAsn = null,
    string BgpAsnExtended = null,
    string CertificateArn = null,
    string DeviceName = null,
    string Id = null,
    string IpAddress = 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.
`Type`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/customer_gateway#type CustomerGateway#type}.
`BgpAsn`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/customer_gateway#bgp_asn CustomerGateway#bgp_asn}.
`BgpAsnExtended`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/customer_gateway#bgp_asn_extended CustomerGateway#bgp_asn_extended}.
`CertificateArn`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/customer_gateway#certificate_arn CustomerGateway#certificate_arn}.
`DeviceName`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/customer_gateway#device_name CustomerGateway#device_name}.
`Id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/customer_gateway#id CustomerGateway#id}.
`IpAddress`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/customer_gateway#ip_address CustomerGateway#ip_address}.
`Tags`	`System.Collections.Generic.IDictionary<string, string>`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/customer_gateway#tags CustomerGateway#tags}.
`TagsAll`	`System.Collections.Generic.IDictionary<string, string>`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/customer_gateway#tags_all CustomerGateway#tags_all}.

`Connection`^Optional

public object Connection { get; set; }

Type: object

`Count`^Optional

public object Count { get; set; }

Type: object

`DependsOn`^Optional

public ITerraformDependable[] DependsOn { get; set; }

Type: HashiCorp.Cdktf.ITerraformDependable[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; set; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; set; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; set; }

Type: object[]

`Type`^Required

public string Type { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/customer_gateway#type CustomerGateway#type}.

`BgpAsn`^Optional

public string BgpAsn { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/customer_gateway#bgp_asn CustomerGateway#bgp_asn}.

`BgpAsnExtended`^Optional

public string BgpAsnExtended { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/customer_gateway#bgp_asn_extended CustomerGateway#bgp_asn_extended}.

`CertificateArn`^Optional

public string CertificateArn { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/customer_gateway#certificate_arn CustomerGateway#certificate_arn}.

`DeviceName`^Optional

public string DeviceName { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/customer_gateway#device_name CustomerGateway#device_name}.

`Id`^Optional

public string Id { get; set; }

Type: string

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

`IpAddress`^Optional

public string IpAddress { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/customer_gateway#ip_address CustomerGateway#ip_address}.

`Tags`^Optional

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

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/customer_gateway#tags CustomerGateway#tags}.

`TagsAll`^Optional

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

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/customer_gateway#tags_all CustomerGateway#tags_all}.

Files

customerGateway.csharp.md

Latest commit

History

customerGateway.csharp.md

File metadata and controls

customerGateway Submodule

Constructs