`apiGatewayDocumentationPart` Submodule

Constructs

ApiGatewayDocumentationPart

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

Initializers

from cdktn_provider_aws import api_gateway_documentation_part

apiGatewayDocumentationPart.ApiGatewayDocumentationPart(
  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,
  location: ApiGatewayDocumentationPartLocation,
  properties: str,
  rest_api_id: str,
  id: str = None,
  region: 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.
`location`	`ApiGatewayDocumentationPartLocation`	location block.
`properties`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#properties ApiGatewayDocumentationPart#properties}.
`rest_api_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#rest_api_id ApiGatewayDocumentationPart#rest_api_id}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#id ApiGatewayDocumentationPart#id}.
`region`	`str`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.

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

`location`^Required

Type: ApiGatewayDocumentationPartLocation

location block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#location ApiGatewayDocumentationPart#location}

`properties`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#properties ApiGatewayDocumentationPart#properties}.

`rest_api_id`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#rest_api_id ApiGatewayDocumentationPart#rest_api_id}.

`id`^Optional

Type: str

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

`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_documentation_part#region ApiGatewayDocumentationPart#region}

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_location`	No description.
`reset_id`	No description.
`reset_region`	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_location`

def put_location(
  type: str,
  method: str = None,
  name: str = None,
  path: str = None,
  status_code: str = None
) -> None

`type`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#type ApiGatewayDocumentationPart#type}.

`method`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#method ApiGatewayDocumentationPart#method}.

`name`^Optional

Type: str

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

`path`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#path ApiGatewayDocumentationPart#path}.

`status_code`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#status_code ApiGatewayDocumentationPart#status_code}.

`reset_id`

def reset_id() -> None

`reset_region`

def reset_region() -> 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 ApiGatewayDocumentationPart resource upon running "cdktn plan ".

`is_construct`

from cdktn_provider_aws import api_gateway_documentation_part

apiGatewayDocumentationPart.ApiGatewayDocumentationPart.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_documentation_part

apiGatewayDocumentationPart.ApiGatewayDocumentationPart.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_resource`

from cdktn_provider_aws import api_gateway_documentation_part

apiGatewayDocumentationPart.ApiGatewayDocumentationPart.is_terraform_resource(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktn_provider_aws import api_gateway_documentation_part

apiGatewayDocumentationPart.ApiGatewayDocumentationPart.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

`import_from_id`^Required

Type: str

The id of the existing ApiGatewayDocumentationPart that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#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 ApiGatewayDocumentationPart 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.
`documentation_part_id`	`str`	No description.
`location`	`ApiGatewayDocumentationPartLocationOutputReference`	No description.
`id_input`	`str`	No description.
`location_input`	`ApiGatewayDocumentationPartLocation`	No description.
`properties_input`	`str`	No description.
`region_input`	`str`	No description.
`rest_api_id_input`	`str`	No description.
`id`	`str`	No description.
`properties`	`str`	No description.
`region`	`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: 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]

`documentation_part_id`^Required

documentation_part_id: str

Type: str

`location`^Required

location: ApiGatewayDocumentationPartLocationOutputReference

Type: ApiGatewayDocumentationPartLocationOutputReference

`id_input`^Optional

id_input: str

Type: str

`location_input`^Optional

location_input: ApiGatewayDocumentationPartLocation

Type: ApiGatewayDocumentationPartLocation

`properties_input`^Optional

properties_input: str

Type: str

`region_input`^Optional

region_input: str

Type: str

`rest_api_id_input`^Optional

rest_api_id_input: str

Type: str

`id`^Required

id: str

Type: str

`properties`^Required

properties: str

Type: str

`region`^Required

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

ApiGatewayDocumentationPartConfig

Initializer

from cdktn_provider_aws import api_gateway_documentation_part

apiGatewayDocumentationPart.ApiGatewayDocumentationPartConfig(
  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,
  location: ApiGatewayDocumentationPartLocation,
  properties: str,
  rest_api_id: str,
  id: str = None,
  region: 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.
`location`	`ApiGatewayDocumentationPartLocation`	location block.
`properties`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#properties ApiGatewayDocumentationPart#properties}.
`rest_api_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#rest_api_id ApiGatewayDocumentationPart#rest_api_id}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#id ApiGatewayDocumentationPart#id}.
`region`	`str`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.

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

`location`^Required

location: ApiGatewayDocumentationPartLocation

Type: ApiGatewayDocumentationPartLocation

location block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#location ApiGatewayDocumentationPart#location}

`properties`^Required

properties: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#properties ApiGatewayDocumentationPart#properties}.

`rest_api_id`^Required

rest_api_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#rest_api_id ApiGatewayDocumentationPart#rest_api_id}.

`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_documentation_part#id ApiGatewayDocumentationPart#id}.

`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_documentation_part#region ApiGatewayDocumentationPart#region}

ApiGatewayDocumentationPartLocation

Initializer

from cdktn_provider_aws import api_gateway_documentation_part

apiGatewayDocumentationPart.ApiGatewayDocumentationPartLocation(
  type: str,
  method: str = None,
  name: str = None,
  path: str = None,
  status_code: str = None
)

Properties

Name	Type	Description
`type`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#type ApiGatewayDocumentationPart#type}.
`method`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#method ApiGatewayDocumentationPart#method}.
`name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#name ApiGatewayDocumentationPart#name}.
`path`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#path ApiGatewayDocumentationPart#path}.
`status_code`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#status_code ApiGatewayDocumentationPart#status_code}.

`type`^Required

type: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#type ApiGatewayDocumentationPart#type}.

`method`^Optional

method: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#method ApiGatewayDocumentationPart#method}.

`name`^Optional

name: str

Type: str

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

`path`^Optional

path: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#path ApiGatewayDocumentationPart#path}.

`status_code`^Optional

status_code: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/api_gateway_documentation_part#status_code ApiGatewayDocumentationPart#status_code}.

Classes

ApiGatewayDocumentationPartLocationOutputReference

Initializers

from cdktn_provider_aws import api_gateway_documentation_part

apiGatewayDocumentationPart.ApiGatewayDocumentationPartLocationOutputReference(
  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_method`	No description.
`reset_name`	No description.
`reset_path`	No description.
`reset_status_code`	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_method`

def reset_method() -> None

`reset_name`

def reset_name() -> None

`reset_path`

def reset_path() -> None

`reset_status_code`

def reset_status_code() -> 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.
`method_input`	`str`	No description.
`name_input`	`str`	No description.
`path_input`	`str`	No description.
`status_code_input`	`str`	No description.
`type_input`	`str`	No description.
`method`	`str`	No description.
`name`	`str`	No description.
`path`	`str`	No description.
`status_code`	`str`	No description.
`type`	`str`	No description.
`internal_value`	`ApiGatewayDocumentationPartLocation`	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

`method_input`^Optional

method_input: str

Type: str

`name_input`^Optional

name_input: str

Type: str

`path_input`^Optional

path_input: str

Type: str

`status_code_input`^Optional

status_code_input: str

Type: str

`type_input`^Optional

type_input: str

Type: str

`method`^Required

method: str

Type: str

`name`^Required

name: str

Type: str

`path`^Required

path: str

Type: str

`status_code`^Required

status_code: str

Type: str

`type`^Required

type: str

Type: str

`internal_value`^Optional

internal_value: ApiGatewayDocumentationPartLocation

Type: ApiGatewayDocumentationPartLocation

FilesExpand file tree

apiGatewayDocumentationPart.python.md

Latest commit

History

apiGatewayDocumentationPart.python.md

File metadata and controls

apiGatewayDocumentationPart Submodule

Constructs