`apigatewayv2Api` Submodule

Constructs

Apigatewayv2Api

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api aws_apigatewayv2_api}.

Initializers

from cdktf_cdktf_provider_aws import apigatewayv2_api

apigatewayv2Api.Apigatewayv2Api(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[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[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  protocol_type: str,
  api_key_selection_expression: str = None,
  body: str = None,
  cors_configuration: Apigatewayv2ApiCorsConfiguration = None,
  credentials_arn: str = None,
  description: str = None,
  disable_execute_api_endpoint: typing.Union[bool, IResolvable] = None,
  fail_on_warnings: typing.Union[bool, IResolvable] = None,
  id: str = None,
  route_key: str = None,
  route_selection_expression: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None,
  target: str = None,
  version: str = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[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[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#name Apigatewayv2Api#name}.
`protocol_type`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#protocol_type Apigatewayv2Api#protocol_type}.
`api_key_selection_expression`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#api_key_selection_expression Apigatewayv2Api#api_key_selection_expression}.
`body`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#body Apigatewayv2Api#body}.
`cors_configuration`	`Apigatewayv2ApiCorsConfiguration`	cors_configuration block.
`credentials_arn`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#credentials_arn Apigatewayv2Api#credentials_arn}.
`description`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#description Apigatewayv2Api#description}.
`disable_execute_api_endpoint`	`typing.Union[bool, cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#disable_execute_api_endpoint Apigatewayv2Api#disable_execute_api_endpoint}.
`fail_on_warnings`	`typing.Union[bool, cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#fail_on_warnings Apigatewayv2Api#fail_on_warnings}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#id Apigatewayv2Api#id}.
`route_key`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#route_key Apigatewayv2Api#route_key}.
`route_selection_expression`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#route_selection_expression Apigatewayv2Api#route_selection_expression}.
`tags`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#tags Apigatewayv2Api#tags}.
`tags_all`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#tags_all Apigatewayv2Api#tags_all}.
`target`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#target Apigatewayv2Api#target}.
`version`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#version Apigatewayv2Api#version}.

`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: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

Type: typing.Union[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[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`name`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#name Apigatewayv2Api#name}.

`protocol_type`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#protocol_type Apigatewayv2Api#protocol_type}.

`api_key_selection_expression`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#api_key_selection_expression Apigatewayv2Api#api_key_selection_expression}.

`body`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#body Apigatewayv2Api#body}.

`cors_configuration`^Optional

Type: Apigatewayv2ApiCorsConfiguration

cors_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#cors_configuration Apigatewayv2Api#cors_configuration}

`credentials_arn`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#credentials_arn Apigatewayv2Api#credentials_arn}.

`description`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#description Apigatewayv2Api#description}.

`disable_execute_api_endpoint`^Optional

Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#disable_execute_api_endpoint Apigatewayv2Api#disable_execute_api_endpoint}.

`fail_on_warnings`^Optional

Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#fail_on_warnings Apigatewayv2Api#fail_on_warnings}.

`id`^Optional

Type: str

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

`route_key`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#route_key Apigatewayv2Api#route_key}.

`route_selection_expression`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#route_selection_expression Apigatewayv2Api#route_selection_expression}.

`tags`^Optional

Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#tags Apigatewayv2Api#tags}.

`tags_all`^Optional

Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#tags_all Apigatewayv2Api#tags_all}.

`target`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#target Apigatewayv2Api#target}.

`version`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#version Apigatewayv2Api#version}.

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".
`put_cors_configuration`	No description.
`reset_api_key_selection_expression`	No description.
`reset_body`	No description.
`reset_cors_configuration`	No description.
`reset_credentials_arn`	No description.
`reset_description`	No description.
`reset_disable_execute_api_endpoint`	No description.
`reset_fail_on_warnings`	No description.
`reset_id`	No description.
`reset_route_key`	No description.
`reset_route_selection_expression`	No description.
`reset_tags`	No description.
`reset_tags_all`	No description.
`reset_target`	No description.
`reset_version`	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() -> typing.Union[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: typing.Union[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: typing.Union[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_cors_configuration`

def put_cors_configuration(
  allow_credentials: typing.Union[bool, IResolvable] = None,
  allow_headers: typing.List[str] = None,
  allow_methods: typing.List[str] = None,
  allow_origins: typing.List[str] = None,
  expose_headers: typing.List[str] = None,
  max_age: typing.Union[int, float] = None
) -> None

`allow_credentials`^Optional

Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#allow_credentials Apigatewayv2Api#allow_credentials}.

`allow_headers`^Optional

Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#allow_headers Apigatewayv2Api#allow_headers}.

`allow_methods`^Optional

Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#allow_methods Apigatewayv2Api#allow_methods}.

`allow_origins`^Optional

Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#allow_origins Apigatewayv2Api#allow_origins}.

`expose_headers`^Optional

Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#expose_headers Apigatewayv2Api#expose_headers}.

`max_age`^Optional

Type: typing.Union[int, float]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#max_age Apigatewayv2Api#max_age}.

`reset_api_key_selection_expression`

def reset_api_key_selection_expression() -> None

`reset_body`

def reset_body() -> None

`reset_cors_configuration`

def reset_cors_configuration() -> None

`reset_credentials_arn`

def reset_credentials_arn() -> None

`reset_description`

def reset_description() -> None

`reset_disable_execute_api_endpoint`

def reset_disable_execute_api_endpoint() -> None

`reset_fail_on_warnings`

def reset_fail_on_warnings() -> None

`reset_id`

def reset_id() -> None

`reset_route_key`

def reset_route_key() -> None

`reset_route_selection_expression`

def reset_route_selection_expression() -> None

`reset_tags`

def reset_tags() -> None

`reset_tags_all`

def reset_tags_all() -> None

`reset_target`

def reset_target() -> None

`reset_version`

def reset_version() -> 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 Apigatewayv2Api resource upon running "cdktf plan ".

`is_construct`

from cdktf_cdktf_provider_aws import apigatewayv2_api

apigatewayv2Api.Apigatewayv2Api.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 apigatewayv2_api

apigatewayv2Api.Apigatewayv2Api.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_resource`

from cdktf_cdktf_provider_aws import apigatewayv2_api

apigatewayv2Api.Apigatewayv2Api.is_terraform_resource(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktf_cdktf_provider_aws import apigatewayv2_api

apigatewayv2Api.Apigatewayv2Api.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

`import_from_id`^Required

Type: str

The id of the existing Apigatewayv2Api that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#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 Apigatewayv2Api 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`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[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[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`api_endpoint`	`str`	No description.
`arn`	`str`	No description.
`cors_configuration`	`Apigatewayv2ApiCorsConfigurationOutputReference`	No description.
`execution_arn`	`str`	No description.
`api_key_selection_expression_input`	`str`	No description.
`body_input`	`str`	No description.
`cors_configuration_input`	`Apigatewayv2ApiCorsConfiguration`	No description.
`credentials_arn_input`	`str`	No description.
`description_input`	`str`	No description.
`disable_execute_api_endpoint_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`fail_on_warnings_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`id_input`	`str`	No description.
`name_input`	`str`	No description.
`protocol_type_input`	`str`	No description.
`route_key_input`	`str`	No description.
`route_selection_expression_input`	`str`	No description.
`tags_all_input`	`typing.Mapping[str]`	No description.
`tags_input`	`typing.Mapping[str]`	No description.
`target_input`	`str`	No description.
`version_input`	`str`	No description.
`api_key_selection_expression`	`str`	No description.
`body`	`str`	No description.
`credentials_arn`	`str`	No description.
`description`	`str`	No description.
`disable_execute_api_endpoint`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`fail_on_warnings`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`id`	`str`	No description.
`name`	`str`	No description.
`protocol_type`	`str`	No description.
`route_key`	`str`	No description.
`route_selection_expression`	`str`	No description.
`tags`	`typing.Mapping[str]`	No description.
`tags_all`	`typing.Mapping[str]`	No description.
`target`	`str`	No description.
`version`	`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: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

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

Type: typing.Union[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[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`api_endpoint`^Required

api_endpoint: str

Type: str

`arn`^Required

arn: str

Type: str

`cors_configuration`^Required

cors_configuration: Apigatewayv2ApiCorsConfigurationOutputReference

Type: Apigatewayv2ApiCorsConfigurationOutputReference

`execution_arn`^Required

execution_arn: str

Type: str

`api_key_selection_expression_input`^Optional

api_key_selection_expression_input: str

Type: str

`body_input`^Optional

body_input: str

Type: str

`cors_configuration_input`^Optional

cors_configuration_input: Apigatewayv2ApiCorsConfiguration

Type: Apigatewayv2ApiCorsConfiguration

`credentials_arn_input`^Optional

credentials_arn_input: str

Type: str

`description_input`^Optional

description_input: str

Type: str

`disable_execute_api_endpoint_input`^Optional

disable_execute_api_endpoint_input: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`fail_on_warnings_input`^Optional

fail_on_warnings_input: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`id_input`^Optional

id_input: str

Type: str

`name_input`^Optional

name_input: str

Type: str

`protocol_type_input`^Optional

protocol_type_input: str

Type: str

`route_key_input`^Optional

route_key_input: str

Type: str

`route_selection_expression_input`^Optional

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

`target_input`^Optional

target_input: str

Type: str

`version_input`^Optional

version_input: str

Type: str

`api_key_selection_expression`^Required

api_key_selection_expression: str

Type: str

`body`^Required

body: str

Type: str

`credentials_arn`^Required

credentials_arn: str

Type: str

`description`^Required

description: str

Type: str

`disable_execute_api_endpoint`^Required

disable_execute_api_endpoint: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`fail_on_warnings`^Required

fail_on_warnings: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`id`^Required

id: str

Type: str

`name`^Required

name: str

Type: str

`protocol_type`^Required

protocol_type: str

Type: str

`route_key`^Required

route_key: str

Type: str

`route_selection_expression`^Required

route_selection_expression: 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]

`target`^Required

target: str

Type: str

`version`^Required

version: str

Type: str

Constants

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

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

Apigatewayv2ApiConfig

Initializer

from cdktf_cdktf_provider_aws import apigatewayv2_api

apigatewayv2Api.Apigatewayv2ApiConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[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[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  protocol_type: str,
  api_key_selection_expression: str = None,
  body: str = None,
  cors_configuration: Apigatewayv2ApiCorsConfiguration = None,
  credentials_arn: str = None,
  description: str = None,
  disable_execute_api_endpoint: typing.Union[bool, IResolvable] = None,
  fail_on_warnings: typing.Union[bool, IResolvable] = None,
  id: str = None,
  route_key: str = None,
  route_selection_expression: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None,
  target: str = None,
  version: str = None
)

Properties

Name	Type	Description
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[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[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#name Apigatewayv2Api#name}.
`protocol_type`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#protocol_type Apigatewayv2Api#protocol_type}.
`api_key_selection_expression`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#api_key_selection_expression Apigatewayv2Api#api_key_selection_expression}.
`body`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#body Apigatewayv2Api#body}.
`cors_configuration`	`Apigatewayv2ApiCorsConfiguration`	cors_configuration block.
`credentials_arn`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#credentials_arn Apigatewayv2Api#credentials_arn}.
`description`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#description Apigatewayv2Api#description}.
`disable_execute_api_endpoint`	`typing.Union[bool, cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#disable_execute_api_endpoint Apigatewayv2Api#disable_execute_api_endpoint}.
`fail_on_warnings`	`typing.Union[bool, cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#fail_on_warnings Apigatewayv2Api#fail_on_warnings}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#id Apigatewayv2Api#id}.
`route_key`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#route_key Apigatewayv2Api#route_key}.
`route_selection_expression`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#route_selection_expression Apigatewayv2Api#route_selection_expression}.
`tags`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#tags Apigatewayv2Api#tags}.
`tags_all`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#tags_all Apigatewayv2Api#tags_all}.
`target`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#target Apigatewayv2Api#target}.
`version`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#version Apigatewayv2Api#version}.

`connection`^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

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

Type: typing.Union[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[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`name`^Required

name: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#name Apigatewayv2Api#name}.

`protocol_type`^Required

protocol_type: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#protocol_type Apigatewayv2Api#protocol_type}.

`api_key_selection_expression`^Optional

api_key_selection_expression: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#api_key_selection_expression Apigatewayv2Api#api_key_selection_expression}.

`body`^Optional

body: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#body Apigatewayv2Api#body}.

`cors_configuration`^Optional

cors_configuration: Apigatewayv2ApiCorsConfiguration

Type: Apigatewayv2ApiCorsConfiguration

cors_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#cors_configuration Apigatewayv2Api#cors_configuration}

`credentials_arn`^Optional

credentials_arn: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#credentials_arn Apigatewayv2Api#credentials_arn}.

`description`^Optional

description: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#description Apigatewayv2Api#description}.

`disable_execute_api_endpoint`^Optional

disable_execute_api_endpoint: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#disable_execute_api_endpoint Apigatewayv2Api#disable_execute_api_endpoint}.

`fail_on_warnings`^Optional

fail_on_warnings: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#fail_on_warnings Apigatewayv2Api#fail_on_warnings}.

`id`^Optional

id: str

Type: str

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

`route_key`^Optional

route_key: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#route_key Apigatewayv2Api#route_key}.

`route_selection_expression`^Optional

route_selection_expression: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#route_selection_expression Apigatewayv2Api#route_selection_expression}.

`tags`^Optional

tags: typing.Mapping[str]

Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#tags Apigatewayv2Api#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/5.76.0/docs/resources/apigatewayv2_api#tags_all Apigatewayv2Api#tags_all}.

`target`^Optional

target: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#target Apigatewayv2Api#target}.

`version`^Optional

version: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#version Apigatewayv2Api#version}.

Apigatewayv2ApiCorsConfiguration

Initializer

from cdktf_cdktf_provider_aws import apigatewayv2_api

apigatewayv2Api.Apigatewayv2ApiCorsConfiguration(
  allow_credentials: typing.Union[bool, IResolvable] = None,
  allow_headers: typing.List[str] = None,
  allow_methods: typing.List[str] = None,
  allow_origins: typing.List[str] = None,
  expose_headers: typing.List[str] = None,
  max_age: typing.Union[int, float] = None
)

Properties

Name	Type	Description
`allow_credentials`	`typing.Union[bool, cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#allow_credentials Apigatewayv2Api#allow_credentials}.
`allow_headers`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#allow_headers Apigatewayv2Api#allow_headers}.
`allow_methods`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#allow_methods Apigatewayv2Api#allow_methods}.
`allow_origins`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#allow_origins Apigatewayv2Api#allow_origins}.
`expose_headers`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#expose_headers Apigatewayv2Api#expose_headers}.
`max_age`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#max_age Apigatewayv2Api#max_age}.

`allow_credentials`^Optional

allow_credentials: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#allow_credentials Apigatewayv2Api#allow_credentials}.

`allow_headers`^Optional

allow_headers: typing.List[str]

Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#allow_headers Apigatewayv2Api#allow_headers}.

`allow_methods`^Optional

allow_methods: typing.List[str]

Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#allow_methods Apigatewayv2Api#allow_methods}.

`allow_origins`^Optional

allow_origins: typing.List[str]

Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#allow_origins Apigatewayv2Api#allow_origins}.

`expose_headers`^Optional

expose_headers: typing.List[str]

Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#expose_headers Apigatewayv2Api#expose_headers}.

`max_age`^Optional

max_age: typing.Union[int, float]

Type: typing.Union[int, float]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.76.0/docs/resources/apigatewayv2_api#max_age Apigatewayv2Api#max_age}.

Classes

Apigatewayv2ApiCorsConfigurationOutputReference

Initializers

from cdktf_cdktf_provider_aws import apigatewayv2_api

apigatewayv2Api.Apigatewayv2ApiCorsConfigurationOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

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

`terraform_resource`^Required

Type: cdktf.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_allow_credentials`	No description.
`reset_allow_headers`	No description.
`reset_allow_methods`	No description.
`reset_allow_origins`	No description.
`reset_expose_headers`	No description.
`reset_max_age`	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: cdktf.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

`reset_allow_credentials`

def reset_allow_credentials() -> None

`reset_allow_headers`

def reset_allow_headers() -> None

`reset_allow_methods`

def reset_allow_methods() -> None

`reset_allow_origins`

def reset_allow_origins() -> None

`reset_expose_headers`

def reset_expose_headers() -> None

`reset_max_age`

def reset_max_age() -> 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.
`allow_credentials_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`allow_headers_input`	`typing.List[str]`	No description.
`allow_methods_input`	`typing.List[str]`	No description.
`allow_origins_input`	`typing.List[str]`	No description.
`expose_headers_input`	`typing.List[str]`	No description.
`max_age_input`	`typing.Union[int, float]`	No description.
`allow_credentials`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`allow_headers`	`typing.List[str]`	No description.
`allow_methods`	`typing.List[str]`	No description.
`allow_origins`	`typing.List[str]`	No description.
`expose_headers`	`typing.List[str]`	No description.
`max_age`	`typing.Union[int, float]`	No description.
`internal_value`	`Apigatewayv2ApiCorsConfiguration`	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

`allow_credentials_input`^Optional

allow_credentials_input: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`allow_headers_input`^Optional

allow_headers_input: typing.List[str]

Type: typing.List[str]

`allow_methods_input`^Optional

allow_methods_input: typing.List[str]

Type: typing.List[str]

`allow_origins_input`^Optional

allow_origins_input: typing.List[str]

Type: typing.List[str]

`expose_headers_input`^Optional

expose_headers_input: typing.List[str]

Type: typing.List[str]

`max_age_input`^Optional

max_age_input: typing.Union[int, float]

Type: typing.Union[int, float]

`allow_credentials`^Required

allow_credentials: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`allow_headers`^Required

allow_headers: typing.List[str]

Type: typing.List[str]

`allow_methods`^Required

allow_methods: typing.List[str]

Type: typing.List[str]

`allow_origins`^Required

allow_origins: typing.List[str]

Type: typing.List[str]

`expose_headers`^Required

expose_headers: typing.List[str]

Type: typing.List[str]

`max_age`^Required

max_age: typing.Union[int, float]

Type: typing.Union[int, float]

`internal_value`^Optional

internal_value: Apigatewayv2ApiCorsConfiguration

Type: Apigatewayv2ApiCorsConfiguration

Files

apigatewayv2Api.python.md

Latest commit

History

apigatewayv2Api.python.md

File metadata and controls

apigatewayv2Api Submodule

Constructs