apiGatewayRestApi.python.md

apiGatewayRestApi Submodule

Constructs

ApiGatewayRestApi

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

Initializers

from cdktn_provider_aws import api_gateway_rest_api

apiGatewayRestApi.ApiGatewayRestApi(
  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,
  name: str,
  api_key_source: str = None,
  binary_media_types: typing.List[str] = None,
  body: str = None,
  description: str = None,
  disable_execute_api_endpoint: bool | IResolvable = None,
  endpoint_configuration: ApiGatewayRestApiEndpointConfiguration = None,
  fail_on_warnings: bool | IResolvable = None,
  id: str = None,
  minimum_compression_size: str = None,
  parameters: typing.Mapping[str] = None,
  policy: str = None,
  put_rest_api_mode: str = None,
  region: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None
)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	str	The scoped construct ID.
connection	cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection	No description.
count	typing.Union[int, float] | cdktn.TerraformCount	No description.
depends_on	typing.List[cdktn.ITerraformDependable]	No description.
for_each	cdktn.ITerraformIterator	No description.
lifecycle	cdktn.TerraformResourceLifecycle	No description.
provider	cdktn.TerraformProvider	No description.
provisioners	typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]	No description.
name	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#name ApiGatewayRestApi#name}.
api_key_source	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#api_key_source ApiGatewayRestApi#api_key_source}.
binary_media_types	typing.List[str]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#binary_media_types ApiGatewayRestApi#binary_media_types}.
body	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#body ApiGatewayRestApi#body}.
description	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#description ApiGatewayRestApi#description}.
disable_execute_api_endpoint	bool | cdktn.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#disable_execute_api_endpoint ApiGatewayRestApi#disable_execute_api_endpoint}.
endpoint_configuration	ApiGatewayRestApiEndpointConfiguration	endpoint_configuration block.
fail_on_warnings	bool | cdktn.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#fail_on_warnings ApiGatewayRestApi#fail_on_warnings}.
id	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#id ApiGatewayRestApi#id}.
minimum_compression_size	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#minimum_compression_size ApiGatewayRestApi#minimum_compression_size}.
parameters	typing.Mapping[str]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#parameters ApiGatewayRestApi#parameters}.
policy	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#policy ApiGatewayRestApi#policy}.
put_rest_api_mode	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#put_rest_api_mode ApiGatewayRestApi#put_rest_api_mode}.
region	str	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags	typing.Mapping[str]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#tags ApiGatewayRestApi#tags}.
tags_all	typing.Mapping[str]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#tags_all ApiGatewayRestApi#tags_all}.

---

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: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

---

count^Optional

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

---

depends_on^Optional

• Type: typing.List[cdktn.ITerraformDependable]

---

for_each^Optional

• Type: cdktn.ITerraformIterator

---

lifecycle^Optional

• Type: cdktn.TerraformResourceLifecycle

---

provider^Optional

• Type: cdktn.TerraformProvider

---

provisioners^Optional

• Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

---

name^Required

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#name ApiGatewayRestApi#name}.

---

api_key_source^Optional

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#api_key_source ApiGatewayRestApi#api_key_source}.

---

binary_media_types^Optional

• Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#binary_media_types ApiGatewayRestApi#binary_media_types}.

---

body^Optional

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#body ApiGatewayRestApi#body}.

---

description^Optional

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#description ApiGatewayRestApi#description}.

---

disable_execute_api_endpoint^Optional

• Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#disable_execute_api_endpoint ApiGatewayRestApi#disable_execute_api_endpoint}.

---

endpoint_configuration^Optional

• Type: ApiGatewayRestApiEndpointConfiguration

endpoint_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#endpoint_configuration ApiGatewayRestApi#endpoint_configuration}

---

fail_on_warnings^Optional

• Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#fail_on_warnings ApiGatewayRestApi#fail_on_warnings}.

---

id^Optional

• Type: str

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

---

minimum_compression_size^Optional

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#minimum_compression_size ApiGatewayRestApi#minimum_compression_size}.

---

parameters^Optional

• Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#parameters ApiGatewayRestApi#parameters}.

---

policy^Optional

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#policy ApiGatewayRestApi#policy}.

---

put_rest_api_mode^Optional

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#put_rest_api_mode ApiGatewayRestApi#put_rest_api_mode}.

---

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

---

tags^Optional

• Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#tags ApiGatewayRestApi#tags}.

---

tags_all^Optional

• Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#tags_all ApiGatewayRestApi#tags_all}.

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
with	Applies one or more mixins to 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".
put_endpoint_configuration	No description.
reset_api_key_source	No description.
reset_binary_media_types	No description.
reset_body	No description.
reset_description	No description.
reset_disable_execute_api_endpoint	No description.
reset_endpoint_configuration	No description.
reset_fail_on_warnings	No description.
reset_id	No description.
reset_minimum_compression_size	No description.
reset_parameters	No description.
reset_policy	No description.
reset_put_rest_api_mode	No description.
reset_region	No description.
reset_tags	No description.
reset_tags_all	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

with

def with(
  mixins: *IMixin
) -> IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: *constructs.IMixin

The mixins to apply.

---

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

---

put_endpoint_configuration

def put_endpoint_configuration(
  types: typing.List[str],
  ip_address_type: str = None,
  vpc_endpoint_ids: typing.List[str] = None
) -> None

types^Required

• Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#types ApiGatewayRestApi#types}.

---

ip_address_type^Optional

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#ip_address_type ApiGatewayRestApi#ip_address_type}.

---

vpc_endpoint_ids^Optional

• Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#vpc_endpoint_ids ApiGatewayRestApi#vpc_endpoint_ids}.

---

reset_api_key_source

def reset_api_key_source() -> None

reset_binary_media_types

def reset_binary_media_types() -> None

reset_body

def reset_body() -> None

reset_description

def reset_description() -> None

reset_disable_execute_api_endpoint

def reset_disable_execute_api_endpoint() -> None

reset_endpoint_configuration

def reset_endpoint_configuration() -> None

reset_fail_on_warnings

def reset_fail_on_warnings() -> None

reset_id

def reset_id() -> None

reset_minimum_compression_size

def reset_minimum_compression_size() -> None

reset_parameters

def reset_parameters() -> None

reset_policy

def reset_policy() -> None

reset_put_rest_api_mode

def reset_put_rest_api_mode() -> None

reset_region

def reset_region() -> None

reset_tags

def reset_tags() -> None

reset_tags_all

def reset_tags_all() -> 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 CDKTN code for importing a ApiGatewayRestApi resource upon running "cdktn plan ".

---

is_construct

from cdktn_provider_aws import api_gateway_rest_api

apiGatewayRestApi.ApiGatewayRestApi.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 cdktn_provider_aws import api_gateway_rest_api

apiGatewayRestApi.ApiGatewayRestApi.is_terraform_element(
  x: typing.Any
)

x^Required

• Type: typing.Any

---

is_terraform_resource

from cdktn_provider_aws import api_gateway_rest_api

apiGatewayRestApi.ApiGatewayRestApi.is_terraform_resource(
  x: typing.Any
)

x^Required

• Type: typing.Any

---

generate_config_for_import

from cdktn_provider_aws import api_gateway_rest_api

apiGatewayRestApi.ApiGatewayRestApi.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

---

import_from_id^Required

• Type: str

The id of the existing ApiGatewayRestApi that should be imported.

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

---

provider^Optional

• Type: cdktn.TerraformProvider

? Optional instance of the provider where the ApiGatewayRestApi to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktf_stack	cdktn.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	cdktn.TerraformProviderGeneratorMetadata	No description.
connection	cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection	No description.
count	typing.Union[int, float] | cdktn.TerraformCount	No description.
depends_on	typing.List[str]	No description.
for_each	cdktn.ITerraformIterator	No description.
lifecycle	cdktn.TerraformResourceLifecycle	No description.
provider	cdktn.TerraformProvider	No description.
provisioners	typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]	No description.
arn	str	No description.
created_date	str	No description.
endpoint_configuration	ApiGatewayRestApiEndpointConfigurationOutputReference	No description.
execution_arn	str	No description.
root_resource_id	str	No description.
api_key_source_input	str	No description.
binary_media_types_input	typing.List[str]	No description.
body_input	str	No description.
description_input	str	No description.
disable_execute_api_endpoint_input	bool | cdktn.IResolvable	No description.
endpoint_configuration_input	ApiGatewayRestApiEndpointConfiguration	No description.
fail_on_warnings_input	bool | cdktn.IResolvable	No description.
id_input	str	No description.
minimum_compression_size_input	str	No description.
name_input	str	No description.
parameters_input	typing.Mapping[str]	No description.
policy_input	str	No description.
put_rest_api_mode_input	str	No description.
region_input	str	No description.
tags_all_input	typing.Mapping[str]	No description.
tags_input	typing.Mapping[str]	No description.
api_key_source	str	No description.
binary_media_types	typing.List[str]	No description.
body	str	No description.
description	str	No description.
disable_execute_api_endpoint	bool | cdktn.IResolvable	No description.
fail_on_warnings	bool | cdktn.IResolvable	No description.
id	str	No description.
minimum_compression_size	str	No description.
name	str	No description.
parameters	typing.Mapping[str]	No description.
policy	str	No description.
put_rest_api_mode	str	No description.
region	str	No description.
tags	typing.Mapping[str]	No description.
tags_all	typing.Mapping[str]	No description.

---

node^Required

node: Node

• Type: constructs.Node

The tree node.

---

cdktf_stack^Required

cdktf_stack: TerraformStack

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

---

connection^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

• Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

---

count^Optional

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

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

---

depends_on^Optional

depends_on: typing.List[str]

• Type: typing.List[str]

---

for_each^Optional

for_each: ITerraformIterator

• Type: cdktn.ITerraformIterator

---

lifecycle^Optional

lifecycle: TerraformResourceLifecycle

• Type: cdktn.TerraformResourceLifecycle

---

provider^Optional

provider: TerraformProvider

• Type: cdktn.TerraformProvider

---

provisioners^Optional

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

• Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

---

arn^Required

arn: str

• Type: str

---

created_date^Required

created_date: str

• Type: str

---

endpoint_configuration^Required

endpoint_configuration: ApiGatewayRestApiEndpointConfigurationOutputReference

• Type: ApiGatewayRestApiEndpointConfigurationOutputReference

---

execution_arn^Required

execution_arn: str

• Type: str

---

root_resource_id^Required

root_resource_id: str

• Type: str

---

api_key_source_input^Optional

api_key_source_input: str

• Type: str

---

binary_media_types_input^Optional

binary_media_types_input: typing.List[str]

• Type: typing.List[str]

---

body_input^Optional

body_input: str

• Type: str

---

description_input^Optional

description_input: str

• Type: str

---

disable_execute_api_endpoint_input^Optional

disable_execute_api_endpoint_input: bool | IResolvable

• Type: bool | cdktn.IResolvable

---

endpoint_configuration_input^Optional

endpoint_configuration_input: ApiGatewayRestApiEndpointConfiguration

• Type: ApiGatewayRestApiEndpointConfiguration

---

fail_on_warnings_input^Optional

fail_on_warnings_input: bool | IResolvable

• Type: bool | cdktn.IResolvable

---

id_input^Optional

id_input: str

• Type: str

---

minimum_compression_size_input^Optional

minimum_compression_size_input: str

• Type: str

---

name_input^Optional

name_input: str

• Type: str

---

parameters_input^Optional

parameters_input: typing.Mapping[str]

• Type: typing.Mapping[str]

---

policy_input^Optional

policy_input: str

• Type: str

---

put_rest_api_mode_input^Optional

put_rest_api_mode_input: str

• Type: str

---

region_input^Optional

region_input: str

• Type: str

---

tags_all_input^Optional

tags_all_input: typing.Mapping[str]

• Type: typing.Mapping[str]

---

tags_input^Optional

tags_input: typing.Mapping[str]

• Type: typing.Mapping[str]

---

api_key_source^Required

api_key_source: str

• Type: str

---

binary_media_types^Required

binary_media_types: typing.List[str]

• Type: typing.List[str]

---

body^Required

body: str

• Type: str

---

description^Required

description: str

• Type: str

---

disable_execute_api_endpoint^Required

disable_execute_api_endpoint: bool | IResolvable

• Type: bool | cdktn.IResolvable

---

fail_on_warnings^Required

fail_on_warnings: bool | IResolvable

• Type: bool | cdktn.IResolvable

---

id^Required

id: str

• Type: str

---

minimum_compression_size^Required

minimum_compression_size: str

• Type: str

---

name^Required

name: str

• Type: str

---

parameters^Required

parameters: typing.Mapping[str]

• Type: typing.Mapping[str]

---

policy^Required

policy: str

• Type: str

---

put_rest_api_mode^Required

put_rest_api_mode: str

• Type: str

---

region^Required

region: str

• Type: str

---

tags^Required

tags: typing.Mapping[str]

• Type: typing.Mapping[str]

---

tags_all^Required

tags_all: typing.Mapping[str]

• Type: typing.Mapping[str]

---

Constants

Name	Type	Description
tfResourceType	str	No description.

---

tfResourceType^Required

tfResourceType: str

• Type: str

---

Structs

ApiGatewayRestApiConfig

Initializer

from cdktn_provider_aws import api_gateway_rest_api

apiGatewayRestApi.ApiGatewayRestApiConfig(
  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,
  name: str,
  api_key_source: str = None,
  binary_media_types: typing.List[str] = None,
  body: str = None,
  description: str = None,
  disable_execute_api_endpoint: bool | IResolvable = None,
  endpoint_configuration: ApiGatewayRestApiEndpointConfiguration = None,
  fail_on_warnings: bool | IResolvable = None,
  id: str = None,
  minimum_compression_size: str = None,
  parameters: typing.Mapping[str] = None,
  policy: str = None,
  put_rest_api_mode: str = None,
  region: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None
)

Properties

Name	Type	Description
connection	cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection	No description.
count	typing.Union[int, float] | cdktn.TerraformCount	No description.
depends_on	typing.List[cdktn.ITerraformDependable]	No description.
for_each	cdktn.ITerraformIterator	No description.
lifecycle	cdktn.TerraformResourceLifecycle	No description.
provider	cdktn.TerraformProvider	No description.
provisioners	typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]	No description.
name	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#name ApiGatewayRestApi#name}.
api_key_source	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#api_key_source ApiGatewayRestApi#api_key_source}.
binary_media_types	typing.List[str]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#binary_media_types ApiGatewayRestApi#binary_media_types}.
body	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#body ApiGatewayRestApi#body}.
description	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#description ApiGatewayRestApi#description}.
disable_execute_api_endpoint	bool | cdktn.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#disable_execute_api_endpoint ApiGatewayRestApi#disable_execute_api_endpoint}.
endpoint_configuration	ApiGatewayRestApiEndpointConfiguration	endpoint_configuration block.
fail_on_warnings	bool | cdktn.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#fail_on_warnings ApiGatewayRestApi#fail_on_warnings}.
id	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#id ApiGatewayRestApi#id}.
minimum_compression_size	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#minimum_compression_size ApiGatewayRestApi#minimum_compression_size}.
parameters	typing.Mapping[str]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#parameters ApiGatewayRestApi#parameters}.
policy	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#policy ApiGatewayRestApi#policy}.
put_rest_api_mode	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#put_rest_api_mode ApiGatewayRestApi#put_rest_api_mode}.
region	str	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags	typing.Mapping[str]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#tags ApiGatewayRestApi#tags}.
tags_all	typing.Mapping[str]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#tags_all ApiGatewayRestApi#tags_all}.

---

connection^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

• Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

---

count^Optional

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

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

---

depends_on^Optional

depends_on: typing.List[ITerraformDependable]

• Type: typing.List[cdktn.ITerraformDependable]

---

for_each^Optional

for_each: ITerraformIterator

• Type: cdktn.ITerraformIterator

---

lifecycle^Optional

lifecycle: TerraformResourceLifecycle

• Type: cdktn.TerraformResourceLifecycle

---

provider^Optional

provider: TerraformProvider

• Type: cdktn.TerraformProvider

---

provisioners^Optional

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

• Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

---

name^Required

name: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#name ApiGatewayRestApi#name}.

---

api_key_source^Optional

api_key_source: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#api_key_source ApiGatewayRestApi#api_key_source}.

---

binary_media_types^Optional

binary_media_types: typing.List[str]

• Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#binary_media_types ApiGatewayRestApi#binary_media_types}.

---

body^Optional

body: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#body ApiGatewayRestApi#body}.

---

description^Optional

description: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#description ApiGatewayRestApi#description}.

---

disable_execute_api_endpoint^Optional

disable_execute_api_endpoint: bool | IResolvable

• Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#disable_execute_api_endpoint ApiGatewayRestApi#disable_execute_api_endpoint}.

---

endpoint_configuration^Optional

endpoint_configuration: ApiGatewayRestApiEndpointConfiguration

• Type: ApiGatewayRestApiEndpointConfiguration

endpoint_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#endpoint_configuration ApiGatewayRestApi#endpoint_configuration}

---

fail_on_warnings^Optional

fail_on_warnings: bool | IResolvable

• Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#fail_on_warnings ApiGatewayRestApi#fail_on_warnings}.

---

id^Optional

id: str

• Type: str

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

---

minimum_compression_size^Optional

minimum_compression_size: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#minimum_compression_size ApiGatewayRestApi#minimum_compression_size}.

---

parameters^Optional

parameters: typing.Mapping[str]

• Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#parameters ApiGatewayRestApi#parameters}.

---

policy^Optional

policy: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#policy ApiGatewayRestApi#policy}.

---

put_rest_api_mode^Optional

put_rest_api_mode: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#put_rest_api_mode ApiGatewayRestApi#put_rest_api_mode}.

---

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

---

tags^Optional

tags: typing.Mapping[str]

• Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#tags ApiGatewayRestApi#tags}.

---

tags_all^Optional

tags_all: typing.Mapping[str]

• Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#tags_all ApiGatewayRestApi#tags_all}.

---

ApiGatewayRestApiEndpointConfiguration

Initializer

from cdktn_provider_aws import api_gateway_rest_api

apiGatewayRestApi.ApiGatewayRestApiEndpointConfiguration(
  types: typing.List[str],
  ip_address_type: str = None,
  vpc_endpoint_ids: typing.List[str] = None
)

Properties

Name	Type	Description
types	typing.List[str]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#types ApiGatewayRestApi#types}.
ip_address_type	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#ip_address_type ApiGatewayRestApi#ip_address_type}.
vpc_endpoint_ids	typing.List[str]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#vpc_endpoint_ids ApiGatewayRestApi#vpc_endpoint_ids}.

---

types^Required

types: typing.List[str]

• Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#types ApiGatewayRestApi#types}.

---

ip_address_type^Optional

ip_address_type: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#ip_address_type ApiGatewayRestApi#ip_address_type}.

---

vpc_endpoint_ids^Optional

vpc_endpoint_ids: typing.List[str]

• Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_rest_api#vpc_endpoint_ids ApiGatewayRestApi#vpc_endpoint_ids}.

---

Classes

ApiGatewayRestApiEndpointConfigurationOutputReference

Initializers

from cdktn_provider_aws import api_gateway_rest_api

apiGatewayRestApi.ApiGatewayRestApiEndpointConfigurationOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
terraform_resource	cdktn.IInterpolatingParent	The parent resource.
terraform_attribute	str	The attribute on the parent resource this class is referencing.

---

terraform_resource^Required

• Type: cdktn.IInterpolatingParent

The parent resource.

---

terraform_attribute^Required

• Type: str

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
compute_fqn	No description.
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.
interpolation_for_attribute	No description.
resolve	Produce the Token's value at resolution time.
to_string	Return a string representation of this resolvable object.
reset_ip_address_type	No description.
reset_vpc_endpoint_ids	No description.

---

compute_fqn

def compute_fqn() -> str

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

---

interpolation_for_attribute

def interpolation_for_attribute(
  property: str
) -> IResolvable

property^Required

• Type: str

---

resolve

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktn.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_ip_address_type

def reset_ip_address_type() -> None

reset_vpc_endpoint_ids

def reset_vpc_endpoint_ids() -> None

Properties

Name	Type	Description
creation_stack	typing.List[str]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	str	No description.
ip_address_type_input	str	No description.
types_input	typing.List[str]	No description.
vpc_endpoint_ids_input	typing.List[str]	No description.
ip_address_type	str	No description.
types	typing.List[str]	No description.
vpc_endpoint_ids	typing.List[str]	No description.
internal_value	ApiGatewayRestApiEndpointConfiguration	No description.

---

creation_stack^Required

creation_stack: typing.List[str]

• Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

fqn: str

• Type: str

---

ip_address_type_input^Optional

ip_address_type_input: str

• Type: str

---

types_input^Optional

types_input: typing.List[str]

• Type: typing.List[str]

---

vpc_endpoint_ids_input^Optional

vpc_endpoint_ids_input: typing.List[str]

• Type: typing.List[str]

---

ip_address_type^Required

ip_address_type: str

• Type: str

---

types^Required

types: typing.List[str]

• Type: typing.List[str]

---

vpc_endpoint_ids^Required

vpc_endpoint_ids: typing.List[str]

• Type: typing.List[str]

---

internal_value^Optional

internal_value: ApiGatewayRestApiEndpointConfiguration

• Type: ApiGatewayRestApiEndpointConfiguration

---