apiGatewayBasePathMapping.csharp.md

apiGatewayBasePathMapping Submodule

Constructs

ApiGatewayBasePathMapping

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_base_path_mapping aws_api_gateway_base_path_mapping}.

Initializers

using Io.Cdktn.Providers.Aws;

new ApiGatewayBasePathMapping(Construct Scope, string Id, ApiGatewayBasePathMappingConfig Config);

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

---

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".
ResetBasePath	No description.
ResetDomainNameId	No description.
ResetId	No description.
ResetRegion	No description.
ResetStageName	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.

Mixins^Required

• Type: params Constructs.IMixin[]

The mixins to apply.

---

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 TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove()

ImportFrom

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

Id^Required

• Type: string

---

Provider^Optional

• Type: Io.Cdktn.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, string|double 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: 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".

Id^Required

• Type: string

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

---

ResetBasePath

private void ResetBasePath()

ResetDomainNameId

private void ResetDomainNameId()

ResetId

private void ResetId()

ResetRegion

private void ResetRegion()

ResetStageName

private void ResetStageName()

Static Functions

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

---

IsConstruct

using Io.Cdktn.Providers.Aws;

ApiGatewayBasePathMapping.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 Io.Cdktn.Providers.Aws;

ApiGatewayBasePathMapping.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using Io.Cdktn.Providers.Aws;

ApiGatewayBasePathMapping.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using Io.Cdktn.Providers.Aws;

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

Generates CDKTN code for importing a ApiGatewayBasePathMapping resource upon running "cdktn 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 ApiGatewayBasePathMapping to import.

---

ImportFromId^Required

• Type: string

The id of the existing ApiGatewayBasePathMapping that should be imported.

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

---

Provider^Optional

• Type: Io.Cdktn.TerraformProvider

? Optional instance of the provider where the ApiGatewayBasePathMapping 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.
ApiIdInput	string	No description.
BasePathInput	string	No description.
DomainNameIdInput	string	No description.
DomainNameInput	string	No description.
IdInput	string	No description.
RegionInput	string	No description.
StageNameInput	string	No description.
ApiId	string	No description.
BasePath	string	No description.
DomainName	string	No description.
DomainNameId	string	No description.
Id	string	No description.
Region	string	No description.
StageName	string	No description.

---

Node^Required

public Node Node { get; }

• Type: Constructs.Node

The tree node.

---

CdktfStack^Required

public TerraformStack CdktfStack { get; }

• Type: Io.Cdktn.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: Io.Cdktn.TerraformProviderGeneratorMetadata

---

Connection^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; }

• Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

---

Count^Optional

public double|TerraformCount Count { get; }

• Type: double|Io.Cdktn.TerraformCount

---

DependsOn^Optional

public string[] DependsOn { get; }

• Type: string[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; }

• Type: Io.Cdktn.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; }

• Type: Io.Cdktn.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; }

• Type: Io.Cdktn.TerraformProvider

---

Provisioners^Optional

public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; }

• Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

---

ApiIdInput^Optional

public string ApiIdInput { get; }

• Type: string

---

BasePathInput^Optional

public string BasePathInput { get; }

• Type: string

---

DomainNameIdInput^Optional

public string DomainNameIdInput { get; }

• Type: string

---

DomainNameInput^Optional

public string DomainNameInput { get; }

• Type: string

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

RegionInput^Optional

public string RegionInput { get; }

• Type: string

---

StageNameInput^Optional

public string StageNameInput { get; }

• Type: string

---

ApiId^Required

public string ApiId { get; }

• Type: string

---

BasePath^Required

public string BasePath { get; }

• Type: string

---

DomainName^Required

public string DomainName { get; }

• Type: string

---

DomainNameId^Required

public string DomainNameId { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

Region^Required

public string Region { get; }

• Type: string

---

StageName^Required

public string StageName { get; }

• Type: string

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

ApiGatewayBasePathMappingConfig

Initializer

using Io.Cdktn.Providers.Aws;

new ApiGatewayBasePathMappingConfig {
    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 ApiId,
    string DomainName,
    string BasePath = null,
    string DomainNameId = null,
    string Id = null,
    string Region = null,
    string StageName = 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.
ApiId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_base_path_mapping#api_id ApiGatewayBasePathMapping#api_id}.
DomainName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_base_path_mapping#domain_name ApiGatewayBasePathMapping#domain_name}.
BasePath	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_base_path_mapping#base_path ApiGatewayBasePathMapping#base_path}.
DomainNameId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_base_path_mapping#domain_name_id ApiGatewayBasePathMapping#domain_name_id}.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_base_path_mapping#id ApiGatewayBasePathMapping#id}.
Region	string	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
StageName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_base_path_mapping#stage_name ApiGatewayBasePathMapping#stage_name}.

---

Connection^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; }

• Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

---

Count^Optional

public double|TerraformCount Count { get; set; }

• Type: double|Io.Cdktn.TerraformCount

---

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: Io.Cdktn.ITerraformDependable[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: Io.Cdktn.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: Io.Cdktn.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: Io.Cdktn.TerraformProvider

---

Provisioners^Optional

public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; }

• Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

---

ApiId^Required

public string ApiId { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_base_path_mapping#api_id ApiGatewayBasePathMapping#api_id}.

---

DomainName^Required

public string DomainName { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_base_path_mapping#domain_name ApiGatewayBasePathMapping#domain_name}.

---

BasePath^Optional

public string BasePath { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_base_path_mapping#base_path ApiGatewayBasePathMapping#base_path}.

---

DomainNameId^Optional

public string DomainNameId { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_base_path_mapping#domain_name_id ApiGatewayBasePathMapping#domain_name_id}.

---

Id^Optional

public string Id { get; set; }

• Type: string

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

---

Region^Optional

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.50.0/docs/resources/api_gateway_base_path_mapping#region ApiGatewayBasePathMapping#region}

---

StageName^Optional

public string StageName { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_base_path_mapping#stage_name ApiGatewayBasePathMapping#stage_name}.

---