dataAwsApiGatewayExport.csharp.md

dataAwsApiGatewayExport Submodule

Constructs

DataAwsApiGatewayExport

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/api_gateway_export aws_api_gateway_export}.

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DataAwsApiGatewayExport(Construct Scope, string Id, DataAwsApiGatewayExportConfig Config);

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

---

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	Adds this resource to the terraform JSON output.
ToMetadata	No description.
ToTerraform	Adds this resource to the terraform JSON output.
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.
ResetAccepts	No description.
ResetId	No description.
ResetParameters	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()

Adds this resource to the terraform JSON output.

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

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

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

ResetAccepts

private void ResetAccepts()

ResetId

private void ResetId()

ResetParameters

private void ResetParameters()

Static Functions

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

---

IsConstruct

using HashiCorp.Cdktf.Providers.Aws;

DataAwsApiGatewayExport.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;

DataAwsApiGatewayExport.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformDataSource

using HashiCorp.Cdktf.Providers.Aws;

DataAwsApiGatewayExport.IsTerraformDataSource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Aws;

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

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

---

ImportFromId^Required

• Type: string

The id of the existing DataAwsApiGatewayExport that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/api_gateway_export#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 DataAwsApiGatewayExport 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.
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.
Body	string	No description.
ContentDisposition	string	No description.
ContentType	string	No description.
AcceptsInput	string	No description.
ExportTypeInput	string	No description.
IdInput	string	No description.
ParametersInput	System.Collections.Generic.IDictionary<string, string>	No description.
RestApiIdInput	string	No description.
StageNameInput	string	No description.
Accepts	string	No description.
ExportType	string	No description.
Id	string	No description.
Parameters	System.Collections.Generic.IDictionary<string, string>	No description.
RestApiId	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: 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

---

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

---

Body^Required

public string Body { get; }

• Type: string

---

ContentDisposition^Required

public string ContentDisposition { get; }

• Type: string

---

ContentType^Required

public string ContentType { get; }

• Type: string

---

AcceptsInput^Optional

public string AcceptsInput { get; }

• Type: string

---

ExportTypeInput^Optional

public string ExportTypeInput { get; }

• Type: string

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

ParametersInput^Optional

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

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

---

RestApiIdInput^Optional

public string RestApiIdInput { get; }

• Type: string

---

StageNameInput^Optional

public string StageNameInput { get; }

• Type: string

---

Accepts^Required

public string Accepts { get; }

• Type: string

---

ExportType^Required

public string ExportType { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

Parameters^Required

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

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

---

RestApiId^Required

public string RestApiId { 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

DataAwsApiGatewayExportConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DataAwsApiGatewayExportConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string ExportType,
    string RestApiId,
    string StageName,
    string Accepts = null,
    string Id = null,
    System.Collections.Generic.IDictionary<string, string> Parameters = 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.
ExportType	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/api_gateway_export#export_type DataAwsApiGatewayExport#export_type}.
RestApiId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/api_gateway_export#rest_api_id DataAwsApiGatewayExport#rest_api_id}.
StageName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/api_gateway_export#stage_name DataAwsApiGatewayExport#stage_name}.
Accepts	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/api_gateway_export#accepts DataAwsApiGatewayExport#accepts}.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/api_gateway_export#id DataAwsApiGatewayExport#id}.
Parameters	System.Collections.Generic.IDictionary<string, string>	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/api_gateway_export#parameters DataAwsApiGatewayExport#parameters}.

---

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

---

ExportType^Required

public string ExportType { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/api_gateway_export#export_type DataAwsApiGatewayExport#export_type}.

---

RestApiId^Required

public string RestApiId { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/api_gateway_export#rest_api_id DataAwsApiGatewayExport#rest_api_id}.

---

StageName^Required

public string StageName { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/api_gateway_export#stage_name DataAwsApiGatewayExport#stage_name}.

---

Accepts^Optional

public string Accepts { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/api_gateway_export#accepts DataAwsApiGatewayExport#accepts}.

---

Id^Optional

public string Id { get; set; }

• Type: string

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

---

Parameters^Optional

public System.Collections.Generic.IDictionary<string, string> Parameters { 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/data-sources/api_gateway_export#parameters DataAwsApiGatewayExport#parameters}.

---