apiGatewayMethod.csharp.md

apiGatewayMethod Submodule

Constructs

ApiGatewayMethod

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method aws_api_gateway_method}.

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new ApiGatewayMethod(Construct Scope, string Id, ApiGatewayMethodConfig Config);

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

---

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".
ResetApiKeyRequired	No description.
ResetAuthorizationScopes	No description.
ResetAuthorizerId	No description.
ResetId	No description.
ResetOperationName	No description.
ResetRequestModels	No description.
ResetRequestParameters	No description.
ResetRequestValidatorId	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".

---

ResetApiKeyRequired

private void ResetApiKeyRequired()

ResetAuthorizationScopes

private void ResetAuthorizationScopes()

ResetAuthorizerId

private void ResetAuthorizerId()

ResetId

private void ResetId()

ResetOperationName

private void ResetOperationName()

ResetRequestModels

private void ResetRequestModels()

ResetRequestParameters

private void ResetRequestParameters()

ResetRequestValidatorId

private void ResetRequestValidatorId()

Static Functions

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

---

IsConstruct

using HashiCorp.Cdktf.Providers.Aws;

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

ApiGatewayMethod.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using HashiCorp.Cdktf.Providers.Aws;

ApiGatewayMethod.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Aws;

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

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

---

ImportFromId^Required

• Type: string

The id of the existing ApiGatewayMethod that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#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 ApiGatewayMethod 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.
ApiKeyRequiredInput	object	No description.
AuthorizationInput	string	No description.
AuthorizationScopesInput	string[]	No description.
AuthorizerIdInput	string	No description.
HttpMethodInput	string	No description.
IdInput	string	No description.
OperationNameInput	string	No description.
RequestModelsInput	System.Collections.Generic.IDictionary<string, string>	No description.
RequestParametersInput	System.Collections.Generic.IDictionary<string, object>	No description.
RequestValidatorIdInput	string	No description.
ResourceIdInput	string	No description.
RestApiIdInput	string	No description.
ApiKeyRequired	object	No description.
Authorization	string	No description.
AuthorizationScopes	string[]	No description.
AuthorizerId	string	No description.
HttpMethod	string	No description.
Id	string	No description.
OperationName	string	No description.
RequestModels	System.Collections.Generic.IDictionary<string, string>	No description.
RequestParameters	System.Collections.Generic.IDictionary<string, object>	No description.
RequestValidatorId	string	No description.
ResourceId	string	No description.
RestApiId	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[]

---

ApiKeyRequiredInput^Optional

public object ApiKeyRequiredInput { get; }

• Type: object

---

AuthorizationInput^Optional

public string AuthorizationInput { get; }

• Type: string

---

AuthorizationScopesInput^Optional

public string[] AuthorizationScopesInput { get; }

• Type: string[]

---

AuthorizerIdInput^Optional

public string AuthorizerIdInput { get; }

• Type: string

---

HttpMethodInput^Optional

public string HttpMethodInput { get; }

• Type: string

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

OperationNameInput^Optional

public string OperationNameInput { get; }

• Type: string

---

RequestModelsInput^Optional

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

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

---

RequestParametersInput^Optional

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

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

---

RequestValidatorIdInput^Optional

public string RequestValidatorIdInput { get; }

• Type: string

---

ResourceIdInput^Optional

public string ResourceIdInput { get; }

• Type: string

---

RestApiIdInput^Optional

public string RestApiIdInput { get; }

• Type: string

---

ApiKeyRequired^Required

public object ApiKeyRequired { get; }

• Type: object

---

Authorization^Required

public string Authorization { get; }

• Type: string

---

AuthorizationScopes^Required

public string[] AuthorizationScopes { get; }

• Type: string[]

---

AuthorizerId^Required

public string AuthorizerId { get; }

• Type: string

---

HttpMethod^Required

public string HttpMethod { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

OperationName^Required

public string OperationName { get; }

• Type: string

---

RequestModels^Required

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

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

---

RequestParameters^Required

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

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

---

RequestValidatorId^Required

public string RequestValidatorId { get; }

• Type: string

---

ResourceId^Required

public string ResourceId { get; }

• Type: string

---

RestApiId^Required

public string RestApiId { get; }

• Type: string

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

ApiGatewayMethodConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new ApiGatewayMethodConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Authorization,
    string HttpMethod,
    string ResourceId,
    string RestApiId,
    object ApiKeyRequired = null,
    string[] AuthorizationScopes = null,
    string AuthorizerId = null,
    string Id = null,
    string OperationName = null,
    System.Collections.Generic.IDictionary<string, string> RequestModels = null,
    System.Collections.Generic.IDictionary<string, object> RequestParameters = null,
    string RequestValidatorId = 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.
Authorization	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#authorization ApiGatewayMethod#authorization}.
HttpMethod	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#http_method ApiGatewayMethod#http_method}.
ResourceId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#resource_id ApiGatewayMethod#resource_id}.
RestApiId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#rest_api_id ApiGatewayMethod#rest_api_id}.
ApiKeyRequired	object	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#api_key_required ApiGatewayMethod#api_key_required}.
AuthorizationScopes	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#authorization_scopes ApiGatewayMethod#authorization_scopes}.
AuthorizerId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#authorizer_id ApiGatewayMethod#authorizer_id}.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#id ApiGatewayMethod#id}.
OperationName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#operation_name ApiGatewayMethod#operation_name}.
RequestModels	System.Collections.Generic.IDictionary<string, string>	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#request_models ApiGatewayMethod#request_models}.
RequestParameters	System.Collections.Generic.IDictionary<string, object>	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#request_parameters ApiGatewayMethod#request_parameters}.
RequestValidatorId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#request_validator_id ApiGatewayMethod#request_validator_id}.

---

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

---

Authorization^Required

public string Authorization { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#authorization ApiGatewayMethod#authorization}.

---

HttpMethod^Required

public string HttpMethod { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#http_method ApiGatewayMethod#http_method}.

---

ResourceId^Required

public string ResourceId { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#resource_id ApiGatewayMethod#resource_id}.

---

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/resources/api_gateway_method#rest_api_id ApiGatewayMethod#rest_api_id}.

---

ApiKeyRequired^Optional

public object ApiKeyRequired { get; set; }

• Type: object

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#api_key_required ApiGatewayMethod#api_key_required}.

---

AuthorizationScopes^Optional

public string[] AuthorizationScopes { get; set; }

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#authorization_scopes ApiGatewayMethod#authorization_scopes}.

---

AuthorizerId^Optional

public string AuthorizerId { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#authorizer_id ApiGatewayMethod#authorizer_id}.

---

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/resources/api_gateway_method#id ApiGatewayMethod#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.

---

OperationName^Optional

public string OperationName { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#operation_name ApiGatewayMethod#operation_name}.

---

RequestModels^Optional

public System.Collections.Generic.IDictionary<string, string> RequestModels { 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/resources/api_gateway_method#request_models ApiGatewayMethod#request_models}.

---

RequestParameters^Optional

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

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#request_parameters ApiGatewayMethod#request_parameters}.

---

RequestValidatorId^Optional

public string RequestValidatorId { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/api_gateway_method#request_validator_id ApiGatewayMethod#request_validator_id}.

---