apiGatewayMethod.md

apiGatewayMethod Submodule

Constructs

ApiGatewayMethod

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

Initializers

import { apiGatewayMethod } from '@cdktf/aws-cdk'

new apiGatewayMethod.ApiGatewayMethod(scope: Construct, id: string, config: ApiGatewayMethodConfig)

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

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

---

resetApiKeyRequired

public resetApiKeyRequired(): void

resetAuthorizationScopes

public resetAuthorizationScopes(): void

resetAuthorizerId

public resetAuthorizerId(): void

resetId

public resetId(): void

resetOperationName

public resetOperationName(): void

resetRequestModels

public resetRequestModels(): void

resetRequestParameters

public resetRequestParameters(): void

resetRequestValidatorId

public resetRequestValidatorId(): 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 ApiGatewayMethod resource upon running "cdktf plan ".

---

isConstruct

import { apiGatewayMethod } from '@cdktf/aws-cdk'

apiGatewayMethod.ApiGatewayMethod.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { apiGatewayMethod } from '@cdktf/aws-cdk'

apiGatewayMethod.ApiGatewayMethod.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { apiGatewayMethod } from '@cdktf/aws-cdk'

apiGatewayMethod.ApiGatewayMethod.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { apiGatewayMethod } from '@cdktf/aws-cdk'

apiGatewayMethod.ApiGatewayMethod.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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/3.76.1/docs/resources/api_gateway_method#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 ApiGatewayMethod 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.
apiKeyRequiredInput	boolean | cdktf.IResolvable	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	{[ key: string ]: string}	No description.
requestParametersInput	{[ key: string ]: boolean | cdktf.IResolvable}	No description.
requestValidatorIdInput	string	No description.
resourceIdInput	string	No description.
restApiIdInput	string	No description.
apiKeyRequired	boolean | cdktf.IResolvable	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	{[ key: string ]: string}	No description.
requestParameters	{[ key: string ]: boolean | cdktf.IResolvable}	No description.
requestValidatorId	string	No description.
resourceId	string	No description.
restApiId	string	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[]

---

apiKeyRequiredInput^Optional

public readonly apiKeyRequiredInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

authorizationInput^Optional

public readonly authorizationInput: string;

• Type: string

---

authorizationScopesInput^Optional

public readonly authorizationScopesInput: string[];

• Type: string[]

---

authorizerIdInput^Optional

public readonly authorizerIdInput: string;

• Type: string

---

httpMethodInput^Optional

public readonly httpMethodInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

operationNameInput^Optional

public readonly operationNameInput: string;

• Type: string

---

requestModelsInput^Optional

public readonly requestModelsInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

requestParametersInput^Optional

public readonly requestParametersInput: {[ key: string ]: boolean | IResolvable};

• Type: {[ key: string ]: boolean | cdktf.IResolvable}

---

requestValidatorIdInput^Optional

public readonly requestValidatorIdInput: string;

• Type: string

---

resourceIdInput^Optional

public readonly resourceIdInput: string;

• Type: string

---

restApiIdInput^Optional

public readonly restApiIdInput: string;

• Type: string

---

apiKeyRequired^Required

public readonly apiKeyRequired: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

authorization^Required

public readonly authorization: string;

• Type: string

---

authorizationScopes^Required

public readonly authorizationScopes: string[];

• Type: string[]

---

authorizerId^Required

public readonly authorizerId: string;

• Type: string

---

httpMethod^Required

public readonly httpMethod: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

operationName^Required

public readonly operationName: string;

• Type: string

---

requestModels^Required

public readonly requestModels: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

requestParameters^Required

public readonly requestParameters: {[ key: string ]: boolean | IResolvable};

• Type: {[ key: string ]: boolean | cdktf.IResolvable}

---

requestValidatorId^Required

public readonly requestValidatorId: string;

• Type: string

---

resourceId^Required

public readonly resourceId: string;

• Type: string

---

restApiId^Required

public readonly restApiId: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

ApiGatewayMethodConfig

Initializer

import { apiGatewayMethod } from '@cdktf/aws-cdk'

const apiGatewayMethodConfig: apiGatewayMethod.ApiGatewayMethodConfig = { ... }

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.
authorization	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method#authorization ApiGatewayMethod#authorization}.
httpMethod	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method#http_method ApiGatewayMethod#http_method}.
resourceId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method#resource_id ApiGatewayMethod#resource_id}.
restApiId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method#rest_api_id ApiGatewayMethod#rest_api_id}.
apiKeyRequired	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/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/3.76.1/docs/resources/api_gateway_method#authorization_scopes ApiGatewayMethod#authorization_scopes}.
authorizerId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method#authorizer_id ApiGatewayMethod#authorizer_id}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method#id ApiGatewayMethod#id}.
operationName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method#operation_name ApiGatewayMethod#operation_name}.
requestModels	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method#request_models ApiGatewayMethod#request_models}.
requestParameters	{[ key: string ]: boolean | cdktf.IResolvable}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method#request_parameters ApiGatewayMethod#request_parameters}.
requestValidatorId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method#request_validator_id ApiGatewayMethod#request_validator_id}.

---

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

---

authorization^Required

public readonly authorization: string;

• Type: string

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

---

httpMethod^Required

public readonly httpMethod: string;

• Type: string

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

---

resourceId^Required

public readonly resourceId: string;

• Type: string

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

---

restApiId^Required

public readonly restApiId: string;

• Type: string

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

---

apiKeyRequired^Optional

public readonly apiKeyRequired: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

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

---

authorizationScopes^Optional

public readonly authorizationScopes: string[];

• Type: string[]

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

---

authorizerId^Optional

public readonly authorizerId: string;

• Type: string

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

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/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 readonly operationName: string;

• Type: string

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

---

requestModels^Optional

public readonly requestModels: {[ key: string ]: string};

• Type: {[ key: string ]: string}

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

---

requestParameters^Optional

public readonly requestParameters: {[ key: string ]: boolean | IResolvable};

• Type: {[ key: string ]: boolean | cdktf.IResolvable}

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

---

requestValidatorId^Optional

public readonly requestValidatorId: string;

• Type: string

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

---