AWS::ApiGateway::Resource¶

The AWS::ApiGateway::Resource resource creates a resource in an API.

Generated by cfn-typegen --out cfn_types AWS::ApiGateway::Resource into cfn_types/apigateway.py:

# Generated by cfn-typegen from the CloudFormation registry schemas. Do not edit.
# fmt: off
# ruff: noqa
"""AWS::ApiGateway resources."""

from typing import Any, Literal, Unpack
from typing_extensions import TypedDict
from cfn_typed.base import DeletionPolicy, DependsOn, ResourceAttrs, UpdateReplacePolicy, build
from cfn_typed.intrinsics import Expr


CONSTRAINTS:dict[str,Any]={
}


ATTRIBUTES:dict[str,Any]={"AWS::ApiGateway::Resource":["ResourceId","RestApiId"]}


RULES:dict[str,Any]={}

Nested types (3)

These are defined above the properties in the generated module.

class ResourceProps(TypedDict, closed=True):
    'The ``AWS::ApiGateway::Resource`` resource creates a resource in an API.'
    ParentId: Expr[str]
    PathPart: Expr[str]
    RestApiId: Expr[str]


class Resource(ResourceAttrs):
    'The ``AWS::ApiGateway::Resource`` resource creates a resource in an API.'
    Type: Literal['AWS::ApiGateway::Resource']
    Properties: ResourceProps


def resource(
    *,
    depends_on: DependsOn | None = None,
    deletion_policy: DeletionPolicy | None = None,
    update_replace_policy: UpdateReplacePolicy | None = None,
    condition: str | None = None,
    metadata: dict[str, Any] | None = None,
    **props: Unpack[ResourceProps],
) -> Resource:
    return build('AWS::ApiGateway::Resource', props, depends_on, deletion_policy, update_replace_policy, condition, metadata)

Attributes¶

Read-only values for get_att(logical_id, attribute). They are not accepted as inputs.

ResourceId