`apiGatewayMethod` Submodule

Constructs

ApiGatewayMethod

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

Initializers

from cdktf_cdktf_provider_aws import api_gateway_method

apiGatewayMethod.ApiGatewayMethod(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  authorization: str,
  http_method: str,
  resource_id: str,
  rest_api_id: str,
  api_key_required: bool | IResolvable = None,
  authorization_scopes: typing.List[str] = None,
  authorizer_id: str = None,
  id: str = None,
  operation_name: str = None,
  region: str = None,
  request_models: typing.Mapping[str] = None,
  request_parameters: typing.Mapping[bool | IResolvable] = None,
  request_validator_id: str = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktf.TerraformCount`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner]`	No description.
`authorization`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#authorization ApiGatewayMethod#authorization}.
`http_method`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#http_method ApiGatewayMethod#http_method}.
`resource_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#resource_id ApiGatewayMethod#resource_id}.
`rest_api_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#rest_api_id ApiGatewayMethod#rest_api_id}.
`api_key_required`	`bool \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#api_key_required ApiGatewayMethod#api_key_required}.
`authorization_scopes`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#authorization_scopes ApiGatewayMethod#authorization_scopes}.
`authorizer_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#authorizer_id ApiGatewayMethod#authorizer_id}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#id ApiGatewayMethod#id}.
`operation_name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#operation_name ApiGatewayMethod#operation_name}.
`region`	`str`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
`request_models`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#request_models ApiGatewayMethod#request_models}.
`request_parameters`	`typing.Mapping[bool \| cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#request_parameters ApiGatewayMethod#request_parameters}.
`request_validator_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#request_validator_id ApiGatewayMethod#request_validator_id}.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

Type: typing.Union[int, float] | cdktf.TerraformCount

`depends_on`^Optional

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

Type: cdktf.TerraformProvider

`provisioners`^Optional

Type: typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner]

`authorization`^Required

Type: str

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

`http_method`^Required

Type: str

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

`resource_id`^Required

Type: str

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

`rest_api_id`^Required

Type: str

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

`api_key_required`^Optional

Type: bool | cdktf.IResolvable

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

`authorization_scopes`^Optional

Type: typing.List[str]

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

`authorizer_id`^Optional

Type: str

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

`id`^Optional

Type: str

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

`operation_name`^Optional

Type: str

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

`region`^Optional

Type: str

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.25.0/docs/resources/api_gateway_method#region ApiGatewayMethod#region}

`request_models`^Optional

Type: typing.Mapping[str]

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

`request_parameters`^Optional

Type: typing.Mapping[bool | cdktf.IResolvable]

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

`request_validator_id`^Optional

Type: str

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

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	No description.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`add_move_target`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`has_resource_move`	No description.
`import_from`	No description.
`interpolation_for_attribute`	No description.
`move_from_id`	Move the resource corresponding to "id" to this resource.
`move_to`	Moves this resource to the target resource given by moveTarget.
`move_to_id`	Moves this resource to the resource corresponding to "id".
`reset_api_key_required`	No description.
`reset_authorization_scopes`	No description.
`reset_authorizer_id`	No description.
`reset_id`	No description.
`reset_operation_name`	No description.
`reset_region`	No description.
`reset_request_models`	No description.
`reset_request_parameters`	No description.
`reset_request_validator_id`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

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

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

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

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`add_move_target`

def add_move_target(
  move_target: str
) -> None

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

`move_target`^Required

Type: str

The string move target that will correspond to this resource.

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`has_resource_move`

def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById

`import_from`

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

`id`^Required

Type: str

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`move_from_id`

def move_from_id(
  id: str
) -> None

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: str

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

`move_to`

def move_to(
  move_target: str,
  index: str | typing.Union[int, float] = None
) -> None

Moves this resource to the target resource given by moveTarget.

`move_target`^Required

Type: str

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

`index`^Optional

Type: str | typing.Union[int, float]

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

`move_to_id`

def move_to_id(
  id: str
) -> None

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

`id`^Required

Type: str

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

`reset_api_key_required`

def reset_api_key_required() -> None

`reset_authorization_scopes`

def reset_authorization_scopes() -> None

`reset_authorizer_id`

def reset_authorizer_id() -> None

`reset_id`

def reset_id() -> None

`reset_operation_name`

def reset_operation_name() -> None

`reset_region`

def reset_region() -> None

`reset_request_models`

def reset_request_models() -> None

`reset_request_parameters`

def reset_request_parameters() -> None

`reset_request_validator_id`

def reset_request_validator_id() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_resource`	No description.
`generate_config_for_import`	Generates CDKTF code for importing a ApiGatewayMethod resource upon running "cdktf plan ".

`is_construct`

from cdktf_cdktf_provider_aws import api_gateway_method

apiGatewayMethod.ApiGatewayMethod.is_construct(
  x: typing.Any
)

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: typing.Any

Any object.

`is_terraform_element`

from cdktf_cdktf_provider_aws import api_gateway_method

apiGatewayMethod.ApiGatewayMethod.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_resource`

from cdktf_cdktf_provider_aws import api_gateway_method

apiGatewayMethod.ApiGatewayMethod.is_terraform_resource(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktf_cdktf_provider_aws import api_gateway_method

apiGatewayMethod.ApiGatewayMethod.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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.

`import_to_id`^Required

Type: str

The construct id used in the generated config for the ApiGatewayMethod to import.

`import_from_id`^Required

Type: str

The id of the existing ApiGatewayMethod that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/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.
`cdktf_stack`	`cdktf.TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.
`terraform_meta_arguments`	`typing.Mapping[typing.Any]`	No description.
`terraform_resource_type`	`str`	No description.
`terraform_generator_metadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktf.TerraformCount`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner]`	No description.
`api_key_required_input`	`bool \| cdktf.IResolvable`	No description.
`authorization_input`	`str`	No description.
`authorization_scopes_input`	`typing.List[str]`	No description.
`authorizer_id_input`	`str`	No description.
`http_method_input`	`str`	No description.
`id_input`	`str`	No description.
`operation_name_input`	`str`	No description.
`region_input`	`str`	No description.
`request_models_input`	`typing.Mapping[str]`	No description.
`request_parameters_input`	`typing.Mapping[bool \| cdktf.IResolvable]`	No description.
`request_validator_id_input`	`str`	No description.
`resource_id_input`	`str`	No description.
`rest_api_id_input`	`str`	No description.
`api_key_required`	`bool \| cdktf.IResolvable`	No description.
`authorization`	`str`	No description.
`authorization_scopes`	`typing.List[str]`	No description.
`authorizer_id`	`str`	No description.
`http_method`	`str`	No description.
`id`	`str`	No description.
`operation_name`	`str`	No description.
`region`	`str`	No description.
`request_models`	`typing.Mapping[str]`	No description.
`request_parameters`	`typing.Mapping[bool \| cdktf.IResolvable]`	No description.
`request_validator_id`	`str`	No description.
`resource_id`	`str`	No description.
`rest_api_id`	`str`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktf.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktf.TerraformCount

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner]

`api_key_required_input`^Optional

api_key_required_input: bool | IResolvable

Type: bool | cdktf.IResolvable

`authorization_input`^Optional

authorization_input: str

Type: str

`authorization_scopes_input`^Optional

authorization_scopes_input: typing.List[str]

Type: typing.List[str]

`authorizer_id_input`^Optional

authorizer_id_input: str

Type: str

`http_method_input`^Optional

http_method_input: str

Type: str

`id_input`^Optional

id_input: str

Type: str

`operation_name_input`^Optional

operation_name_input: str

Type: str

`region_input`^Optional

region_input: str

Type: str

`request_models_input`^Optional

request_models_input: typing.Mapping[str]

Type: typing.Mapping[str]

`request_parameters_input`^Optional

request_parameters_input: typing.Mapping[bool | IResolvable]

Type: typing.Mapping[bool | cdktf.IResolvable]

`request_validator_id_input`^Optional

request_validator_id_input: str

Type: str

`resource_id_input`^Optional

resource_id_input: str

Type: str

`rest_api_id_input`^Optional

rest_api_id_input: str

Type: str

`api_key_required`^Required

api_key_required: bool | IResolvable

Type: bool | cdktf.IResolvable

`authorization`^Required

authorization: str

Type: str

`authorization_scopes`^Required

authorization_scopes: typing.List[str]

Type: typing.List[str]

`authorizer_id`^Required

authorizer_id: str

Type: str

`http_method`^Required

http_method: str

Type: str

`id`^Required

id: str

Type: str

`operation_name`^Required

operation_name: str

Type: str

`region`^Required

region: str

Type: str

`request_models`^Required

request_models: typing.Mapping[str]

Type: typing.Mapping[str]

`request_parameters`^Required

request_parameters: typing.Mapping[bool | IResolvable]

Type: typing.Mapping[bool | cdktf.IResolvable]

`request_validator_id`^Required

request_validator_id: str

Type: str

`resource_id`^Required

resource_id: str

Type: str

`rest_api_id`^Required

rest_api_id: str

Type: str

Constants

Name	Type	Description
`tfResourceType`	`str`	No description.

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

ApiGatewayMethodConfig

Initializer

from cdktf_cdktf_provider_aws import api_gateway_method

apiGatewayMethod.ApiGatewayMethodConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  authorization: str,
  http_method: str,
  resource_id: str,
  rest_api_id: str,
  api_key_required: bool | IResolvable = None,
  authorization_scopes: typing.List[str] = None,
  authorizer_id: str = None,
  id: str = None,
  operation_name: str = None,
  region: str = None,
  request_models: typing.Mapping[str] = None,
  request_parameters: typing.Mapping[bool | IResolvable] = None,
  request_validator_id: str = None
)

Properties

Name	Type	Description
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktf.TerraformCount`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner]`	No description.
`authorization`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#authorization ApiGatewayMethod#authorization}.
`http_method`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#http_method ApiGatewayMethod#http_method}.
`resource_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#resource_id ApiGatewayMethod#resource_id}.
`rest_api_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#rest_api_id ApiGatewayMethod#rest_api_id}.
`api_key_required`	`bool \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#api_key_required ApiGatewayMethod#api_key_required}.
`authorization_scopes`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#authorization_scopes ApiGatewayMethod#authorization_scopes}.
`authorizer_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#authorizer_id ApiGatewayMethod#authorizer_id}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#id ApiGatewayMethod#id}.
`operation_name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#operation_name ApiGatewayMethod#operation_name}.
`region`	`str`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
`request_models`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#request_models ApiGatewayMethod#request_models}.
`request_parameters`	`typing.Mapping[bool \| cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#request_parameters ApiGatewayMethod#request_parameters}.
`request_validator_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_method#request_validator_id ApiGatewayMethod#request_validator_id}.

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktf.TerraformCount

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner]

`authorization`^Required

authorization: str

Type: str

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

`http_method`^Required

http_method: str

Type: str

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

`resource_id`^Required

resource_id: str

Type: str

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

`rest_api_id`^Required

rest_api_id: str

Type: str

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

`api_key_required`^Optional

api_key_required: bool | IResolvable

Type: bool | cdktf.IResolvable

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

`authorization_scopes`^Optional

authorization_scopes: typing.List[str]

Type: typing.List[str]

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

`authorizer_id`^Optional

authorizer_id: str

Type: str

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

`id`^Optional

id: str

Type: str

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

`operation_name`^Optional

operation_name: str

Type: str

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

`region`^Optional

region: str

Type: str

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.25.0/docs/resources/api_gateway_method#region ApiGatewayMethod#region}

`request_models`^Optional

request_models: typing.Mapping[str]

Type: typing.Mapping[str]

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

`request_parameters`^Optional

request_parameters: typing.Mapping[bool | IResolvable]

Type: typing.Mapping[bool | cdktf.IResolvable]

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

`request_validator_id`^Optional

request_validator_id: str

Type: str

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

FilesExpand file tree

apiGatewayMethod.python.md

Latest commit

History

apiGatewayMethod.python.md

File metadata and controls

apiGatewayMethod Submodule

Constructs