Amazon API Gateway resources

API Gateway classes refine provider-independent APIs into HTTP, REST, and WebSocket resources, routes, integrations, stages, authorizers, and usage controls.

Source: mde/metamodels/psm/awspsm-api.emf.

ApiGatewayApi

An abstract api gateway api concept. Use one of its concrete subtypes when creating a model instance; the shared attributes and relationships defined here still apply.

Direct supertypes: AwsResource. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
apiName	String [1]	Records stable name/key/code used for api name for api gateway api. It keeps this decision explicit during review and transformation, so later steps do not have to infer it. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol. The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/contracts.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: ApiGatewayApiExample.
descriptionText	String [1]	Records the human explanation of description text for the api gateway api. This keeps the decision explicit even when the element's class or relationships remain unchanged. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: Orders processing.
accessLogsEnabled	Boolean [1]	For a api gateway api, the model records whether access logs enabled applies. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Semantic validation: AccessLogsRequireLogGroupAndFormat (access logs require log group and format) in mde/validation/psm/rules/api.evl the flag must be enabled for this rule to pass. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	Either true or false. Example: true.
tracingEnabled	Boolean [1]	Records whether tracing enabled applies to api gateway api. It preserves an explicit architectural or governance decision through review and transformation, so later steps do not have to infer it. Semantic validation: ProductionApiShouldHaveMetricsAndTracing (production api should have metrics and tracing) in mde/validation/psm/rules/api.evl the related value or object must be explicitly provided.	Either true or false. Example: true.
metricsEnabled	Boolean [1]	For a api gateway api, the model records whether metrics enabled applies. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Semantic validation: ProductionApiShouldHaveMetricsAndTracing (production api should have metrics and tracing) in mde/validation/psm/rules/api.evl the related value or object must be explicitly provided.	Either true or false. Example: true.
corsEnabled	Boolean [1]	For a api gateway api, the model records whether cors enabled applies. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	Either true or false. Example: true.
definitionUri	String [1]	Records the human explanation of definition uri for the api gateway api. This keeps the decision explicit even when the element's class or relationships remain unchanged. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: https://example.com/orders.
definitionBody	String [1]	Records human explanation of definition body for api gateway api. It keeps human review and generated guidance explicit during review and transformation, so later steps do not have to infer it. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol. The artifact generator references this feature in mde/generation/awspsm-to-artifacts/templates/contracts/openapi.egl.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: A confirmed order is one accepted for fulfillment by the business..
openApiVersion	String [1]	For a api gateway api, the model records the compatibility/version marker for open api version. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: 1.0.
apiPolicyJson	String [1]	Stores the serialized JSON representation of api policy on the api gateway api. The field preserves structured provider or contract detail as an explicit, reviewable input. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: {"enabled":true}.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
cors → CorsConfiguration	containment, [?]	Contains the cors configuration element(s) that make up this api gateway api; the contained objects belong to this model element.
tracingConfig → ApiGatewayTracingConfig	containment, [?]	Contains the api gateway tracing config element(s) that make up this api gateway api; the contained objects belong to this model element.
accessLogSetting → ApiGatewayAccessLogSetting	containment, [?]	Contains the api gateway access log setting element(s) that make up this api gateway api; the contained objects belong to this model element.
apiPolicy → IamPolicyDocument	containment, [?]	Contains the iam policy document element(s) that make up this api gateway api; the contained objects belong to this model element.
accessLogGroup → CloudWatchLogGroup	reference, [?]	References the cloud watch log group element(s) used as access log group by this api gateway api; the target may be shared elsewhere in the model.
routes → ApiGatewayRoute	containment, [*]; opposite api	Contains the api gateway route element(s) that make up this api gateway api; the contained objects belong to this model element.
stages → ApiGatewayStage	containment, [*]; opposite api	Contains the api gateway stage element(s) that make up this api gateway api; the contained objects belong to this model element.
authorizers → ApiGatewayAuthorizer	containment, [*]; opposite api	Contains the api gateway authorizer element(s) that make up this api gateway api; the contained objects belong to this model element.
apiDomainName → ApiGatewayDomainName	reference, [?]; opposite api	References the api gateway domain name element(s) used as api domain name by this api gateway api; the target may be shared elsewhere in the model.
wafAssociation → WafWebAclAssociation	reference, [?]	References the waf web acl association element(s) used as waf association by this api gateway api; the target may be shared elsewhere in the model.

HttpApi

Represents http api in the PSM vocabulary. It specializes ApiGatewayApi with the details needed for this modeling concern.

Direct supertypes: ApiGatewayApi. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
protocolType	String [1]	Stores the controlled classification or strategy represented by protocol type on the http api. The field keeps the model explicit and reviewable during review and transformation instead of leaving the decision to an inferred default. Transformation role: ETL rule Api2HttpApi in mde/transformations/pim-to-awspsm/compute-api.etl assigns or materializes this feature while refining HttpApi.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: BUSINESS.
disableExecuteApiEndpoint	Boolean [1]	For a http api, the model records whether disable execute api endpoint applies. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Transformation role: ETL rule Api2HttpApi in mde/transformations/pim-to-awspsm/compute-api.etl assigns or materializes this feature while refining HttpApi. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	Either true or false. Example: false.
minimumCompressionSize	Integer [1]	Records the minimum compression size value for the http api. This keeps the decision explicit even when the element's class or relationships remain unchanged. Transformation role: ETL rule Api2HttpApi in mde/transformations/pim-to-awspsm/compute-api.etl assigns or materializes this feature while refining HttpApi.	A numeric Integer value; use the unit or boundary documented for this attribute. Example: 1.
failOnWarnings	Boolean [1]	For a http api, the model records whether fail on warnings applies. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Transformation role: ETL rule Api2HttpApi in mde/transformations/pim-to-awspsm/compute-api.etl assigns or materializes this feature while refining HttpApi.	Either true or false. Example: false.

Relationships

This class declares no direct relationships.

RestApi

Represents rest api in the PSM vocabulary. It specializes ApiGatewayApi with the details needed for this modeling concern.

Direct supertypes: ApiGatewayApi. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
minimumCompressionSize	Integer [1]	Records the minimum compression size value for rest api. It keeps an operational boundary that should not be left to provider defaults explicit during review and transformation, so later steps do not have to infer it. Transformation role: ETL rule Api2RestApi in mde/transformations/pim-to-awspsm/compute-api.etl assigns or materializes this feature while refining RestApi.	A numeric Integer value; use the unit or boundary documented for this attribute. Example: 1.
failOnWarnings	Boolean [1]	Records whether fail on warnings applies to rest api. The field records an explicit architectural or governance decision as an explicit, reviewable input. Transformation role: ETL rule Api2RestApi in mde/transformations/pim-to-awspsm/compute-api.etl assigns or materializes this feature while refining RestApi.	Either true or false. Example: false.
apiKeyRequiredByDefault	Boolean [1]	For a rest api, the model records whether api key required by default applies. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Transformation role: ETL rule Api2RestApi in mde/transformations/pim-to-awspsm/compute-api.etl assigns or materializes this feature while refining RestApi.	Either true or false. Example: true.
endpointType	ApiGatewayEndpointType [1]	Records the controlled classification or strategy for endpoint type in the rest api. This keeps the decision explicit even when the element's class or relationships remain unchanged. Transformation role: ETL rule Api2RestApi in mde/transformations/pim-to-awspsm/compute-api.etl assigns or materializes this feature while refining RestApi.	Exactly one of: REGIONAL, EDGE, PRIVATE. Example: REGIONAL.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
resources → RestApiResource	containment, [*]; opposite api	Contains the rest api resource element(s) that make up this rest api; the contained objects belong to this model element.

WebSocketApi

Represents web socket api in the PSM vocabulary. It specializes ApiGatewayApi with the details needed for this modeling concern.

Direct supertypes: ApiGatewayApi. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
routeSelectionExpression	String [1]	Stores the expression or rule that governs route selection expression on the web socket api. The field keeps the model explicit and reviewable during review and transformation instead of leaving the decision to an inferred default. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: $.status == 'READY'.

Relationships

This class declares no direct relationships.

ApiGatewayRoute

An abstract api gateway route concept. Use one of its concrete subtypes when creating a model instance; the shared attributes and relationships defined here still apply.

Direct supertypes: AwsResource. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
operationName	String [1]	Records stable name/key/code used for operation name for api gateway route. It keeps this decision explicit during review and transformation, so later steps do not have to infer it. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/contracts.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: ApiGatewayRouteExample.
apiKeyRequired	Boolean [1]	Records whether api key required applies to api gateway route. This keeps the decision explicit even when the element's class or relationships remain unchanged. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	Either true or false. Example: true.
authorizationScopes	String [*]	Records boundary within which authorization scopes is interpreted for api gateway route. It keeps isolation and ownership decisions explicit during review and transformation, so later steps do not have to infer it. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A collection of values. Example: [orders, orders-2].
requestParametersJson	String [1]	Stores the serialized JSON representation of request parameters on the api gateway route. The field preserves structured provider or contract detail as an explicit, reviewable input. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: {"enabled":true}.
requestModelsJson	String [1]	Stores the serialized JSON representation of request models on the api gateway route. The field preserves structured provider or contract detail as an explicit, reviewable input. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: {"enabled":true}.
responseModelsJson	String [1]	For a api gateway route, the model records the serialized JSON representation of response models. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: {"enabled":true}.
routeSettingsJson	String [1]	Records serialized JSON representation of route settings for api gateway route. It keeps preserving structured provider or contract detail explicit during review and transformation, so later steps do not have to infer it. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: {"enabled":true}.
timeoutInMillis	Integer [1]	Records the timeout in millis value for the api gateway route. This keeps the decision explicit even when the element's class or relationships remain unchanged. Semantic validation: IntegrationTimeoutShouldNotExceedLambdaTimeout (integration timeout should not exceed lambda timeout) in mde/validation/psm/rules/api.evl the related value or object must be explicitly provided.	A numeric Integer value; use the unit or boundary documented for this attribute. Example: 30.
authorizationType	ApiGatewayAuthorizationType [1]	Stores the controlled classification or strategy represented by authorization type on the api gateway route. The field keeps the model explicit and reviewable during review and transformation instead of leaving the decision to an inferred default. Semantic validation: ProtectedRouteHasRequiredAuthConfiguration (protected route has required auth configuration) in mde/validation/psm/rules/api.evl the feature participates in a semantic validation condition.	Exactly one of: NONE, AWS_IAM, JWT, COGNITO_USER_POOLS, CUSTOM_LAMBDA, API_KEY. Example: NONE.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
requestModels → ApiGatewayRequestModel	containment, [*]	Contains the api gateway request model element(s) that make up this api gateway route; the contained objects belong to this model element.
responseModels → ApiGatewayResponseModel	containment, [*]	Contains the api gateway response model element(s) that make up this api gateway route; the contained objects belong to this model element.
routeSettings → ApiGatewayRouteSetting	containment, [?]	Contains the api gateway route setting element(s) that make up this api gateway route; the contained objects belong to this model element.
api → ApiGatewayApi	reference; read-only, [1]; opposite routes	References the api gateway api element(s) used as api by this api gateway route; the target may be shared elsewhere in the model.
integration → ApiGatewayIntegration	reference, [1]	References the api gateway integration element(s) used as integration by this api gateway route; the target may be shared elsewhere in the model.
authorizer → ApiGatewayAuthorizer	reference, [?]	References the api gateway authorizer element(s) used as authorizer by this api gateway route; the target may be shared elsewhere in the model.

HttpApiRoute

Represents http api route in the PSM vocabulary. It specializes ApiGatewayRoute with the details needed for this modeling concern.

Direct supertypes: ApiGatewayRoute. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
path	String [1]	Stores the data location or endpoint represented by path on the http api route. The field keeps the model explicit and reviewable during review and transformation instead of leaving the decision to an inferred default. Semantic validation: UniqueHttpRouteWithinApi (unique http route within api) in mde/validation/psm/rules/api.evl the rule's diagnostic or remediation guidance refers to this feature.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: /orders/{orderId}.
routeKey	String [1]	Records stable name/key/code used for route key for http api route. It keeps this decision explicit during review and transformation, so later steps do not have to infer it. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: orderId.
method	ApiGatewayHttpMethod [1]	Stores the controlled classification or strategy represented by method on the http api route. The field keeps the model explicit and reviewable during review and transformation instead of leaving the decision to an inferred default. Semantic validation: UniqueHttpRouteWithinApi (unique http route within api) in mde/validation/psm/rules/api.evl the rule's diagnostic or remediation guidance refers to this feature.	Exactly one of: GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD, ANY. Example: GET.

Relationships

This class declares no direct relationships.

RestApiRoute

Represents rest api route in the PSM vocabulary. It specializes ApiGatewayRoute with the details needed for this modeling concern.

Direct supertypes: ApiGatewayRoute. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
path	String [1]	For a rest api route, the model records the data location or endpoint represented by path. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Semantic validation: UniqueRestRouteWithinApi (unique rest route within api) in mde/validation/psm/rules/api.evl the rule's diagnostic or remediation guidance refers to this feature. Transformation role: ETL rule ApiRoute2RestApiRoute in mde/transformations/pim-to-awspsm/compute-api.etl assigns or materializes this feature while refining RestApiRoute.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: /orders/{orderId}.
restApiResourcePath	String [1]	For a rest api route, the model records the origin/source selected for rest api resource path. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Transformation role: ETL rule ApiRoute2RestApiRoute in mde/transformations/pim-to-awspsm/compute-api.etl assigns or materializes this feature while refining RestApiRoute. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: /orders/{orderId}.
method	ApiGatewayHttpMethod [1]	For a rest api route, the model records the controlled classification or strategy represented by method. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Semantic validation: UniqueRestRouteWithinApi (unique rest route within api) in mde/validation/psm/rules/api.evl the rule's diagnostic or remediation guidance refers to this feature. Transformation role: ETL rule ApiRoute2RestApiRoute in mde/transformations/pim-to-awspsm/compute-api.etl assigns or materializes this feature while refining RestApiRoute.	Exactly one of: GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD, ANY. Example: GET.

Relationships

This class declares no direct relationships.

RestApiResource

Represents rest api resource in the PSM vocabulary. It specializes AwsResource with the details needed for this modeling concern.

Direct supertypes: AwsResource. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
pathPart	String [1]	For a rest api resource, the model records the path part value. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: /orders/{orderId}.
fullPath	String [1]	For a rest api resource, the model records the data location or endpoint represented by full path. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: /orders/{orderId}.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
api → RestApi	reference; read-only, [1]; opposite resources	References the rest api element(s) used as api by this rest api resource; the target may be shared elsewhere in the model.
parentResource → RestApiResource	reference, [?]	References the rest api resource element(s) used as parent resource by this rest api resource; the target may be shared elsewhere in the model.

RestApiMethod

Represents rest api method in the PSM vocabulary. It specializes ApiGatewayRoute with the details needed for this modeling concern.

Direct supertypes: ApiGatewayRoute. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
method	ApiGatewayHttpMethod [1]	Stores the controlled classification or strategy represented by method on the rest api method. The field keeps the model explicit and reviewable during review and transformation instead of leaving the decision to an inferred default. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	Exactly one of: GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD, ANY. Example: GET.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
resource → RestApiResource	reference, [1]	References the rest api resource element(s) used as resource by this rest api method; the target may be shared elsewhere in the model.
requestValidator → ApiGatewayRequestValidator	reference, [?]	References the api gateway request validator element(s) used as request validator by this rest api method; the target may be shared elsewhere in the model.

WebSocketRoute

Represents web socket route in the PSM vocabulary. It specializes ApiGatewayRoute with the details needed for this modeling concern.

Direct supertypes: ApiGatewayRoute. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
routeKey	String [1]	Stores the stable name/key/code used for route key on the web socket route. The field keeps the model explicit and reviewable during review and transformation instead of leaving the decision to an inferred default. Semantic validation: UniqueWebSocketRouteKeyWithinApi (unique web socket route key within api) in mde/validation/psm/rules/api.evl the rule's diagnostic or remediation guidance refers to this feature.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: orderId.

Relationships

This class declares no direct relationships.

ApiGatewayRequestModel

Represents api gateway request model in the PSM vocabulary. It specializes TraceableElement with the details needed for this modeling concern.

Direct supertypes: TraceableElement. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
modelName	String [1]	For a api gateway request model, the model records the stable name/key/code used for model name. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/contracts.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: ApiGatewayRequestModelExample.
contentType	String [1]	Records the serialization/content format for content type for the api gateway request model. This keeps the decision explicit even when the element's class or relationships remain unchanged. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: BUSINESS.
schemaJson	String [1]	Records serialized JSON representation of schema for api gateway request model. It keeps preserving structured provider or contract detail explicit during review and transformation, so later steps do not have to infer it. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: {"enabled":true}.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
schemaResource → AwsResource	reference, [?]	References the aws resource element(s) used as schema resource by this api gateway request model; the target may be shared elsewhere in the model.

ApiGatewayResponseModel

Represents api gateway response model in the PSM vocabulary. It specializes TraceableElement with the details needed for this modeling concern.

Direct supertypes: TraceableElement. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
statusCode	String [1]	Records the stable name/key/code used for status code for the api gateway response model. This keeps the decision explicit even when the element's class or relationships remain unchanged. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/contracts.eol. The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/validation.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: ORDER_NOT_FOUND.
contentType	String [1]	Records serialization/content format for content type for api gateway response model. It keeps this decision explicit during review and transformation, so later steps do not have to infer it. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: BUSINESS.
schemaJson	String [1]	Records the serialized JSON representation of schema for the api gateway response model. This keeps the decision explicit even when the element's class or relationships remain unchanged. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: {"enabled":true}.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
schemaResource → AwsResource	reference, [?]	References the aws resource element(s) used as schema resource by this api gateway response model; the target may be shared elsewhere in the model.

ApiGatewayRequestValidator

Represents api gateway request validator in the PSM vocabulary. It specializes AwsResource with the details needed for this modeling concern.

Direct supertypes: AwsResource. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
validatorName	String [1]	Stores the stable name/key/code used for validator name on the api gateway request validator. The field keeps the model explicit and reviewable during review and transformation instead of leaving the decision to an inferred default. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: ApiGatewayRequestValidatorExample.
validateRequestBody	Boolean [1]	For a api gateway request validator, the model records whether validate request body applies. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	Either true or false. Example: false.
validateRequestParameters	Boolean [1]	Records whether validate request parameters applies to api gateway request validator. The field records an explicit architectural or governance decision as an explicit, reviewable input. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	Either true or false. Example: false.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
api → RestApi	reference, [1]	References the rest api element(s) used as api by this api gateway request validator; the target may be shared elsewhere in the model.

ApiGatewayRouteSetting

Represents api gateway route setting in the PSM vocabulary. It specializes TraceableElement with the details needed for this modeling concern.

Direct supertypes: TraceableElement. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
detailedMetricsEnabled	Boolean [1]	Records whether detailed metrics enabled applies to api gateway route setting. This keeps the decision explicit even when the element's class or relationships remain unchanged. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	Either true or false. Example: true.
dataTraceEnabled	Boolean [1]	Records whether data trace enabled applies to api gateway route setting. It preserves an explicit architectural or governance decision through review and transformation, so later steps do not have to infer it. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	Either true or false. Example: true.
loggingLevel	String [1]	For a api gateway route setting, the model records the logging level value. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: INFO.
throttlingBurstLimit	Integer [1]	Records the throttling burst limit value for the api gateway route setting. This keeps the decision explicit even when the element's class or relationships remain unchanged. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A numeric Integer value; use the unit or boundary documented for this attribute. Example: 1.
throttlingRateLimit	Double [1]	Records the throttling rate limit value for the api gateway route setting. This keeps the decision explicit even when the element's class or relationships remain unchanged. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A numeric Double value; use the unit or boundary documented for this attribute. Example: 1.

Relationships

This class declares no direct relationships.

ApiGatewayAccessLogSetting

Represents api gateway access log setting in the PSM vocabulary. It specializes TraceableElement with the details needed for this modeling concern.

Direct supertypes: TraceableElement. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
format	String [1]	Records the serialization/content format for format for the api gateway access log setting. This keeps the decision explicit even when the element's class or relationships remain unchanged. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: Api Gateway Access Log Setting Format.
destinationArn	String [1]	Records destination selected for destination arn for api gateway access log setting. It keeps this decision explicit during review and transformation, so later steps do not have to infer it. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: arn:aws:lambda:us-east-1:123456789012:function:orders.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
destinationLogGroup → CloudWatchLogGroup	reference, [?]	References the cloud watch log group element(s) used as destination log group by this api gateway access log setting; the target may be shared elsewhere in the model.

ApiGatewayIntegration

Represents api gateway integration in the PSM vocabulary. It specializes AwsResource with the details needed for this modeling concern.

Direct supertypes: AwsResource. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
integrationUri	String [1]	For a api gateway integration, the model records the URI/URL from which integration is obtained. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Semantic validation: IntegrationHasSingleTarget (integration has single target) in mde/validation/psm/rules/api.evl the rule's diagnostic or remediation guidance refers to this feature. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol. The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/contracts.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: https://example.com/orders.
integrationMethod	String [1]	Records the integration method value for api gateway integration. It keeps this decision explicit during review and transformation, so later steps do not have to infer it. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol. The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/contracts.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: Api Gateway Integration Integration Method.
payloadFormatVersion	String [1]	Records serialization/content format for payload format version for api gateway integration. It keeps compatibility and contract evolution explicit during review and transformation, so later steps do not have to infer it. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol. The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/contracts.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: 1.0.
credentialsArn	String [1]	Records the AWS ARN used for credentials for the api gateway integration. This keeps the decision explicit even when the element's class or relationships remain unchanged. Semantic validation: CredentialsArnMatchesCredentialsRole (credentials arn matches credentials role) in mde/validation/psm/rules/api.evl the value must be present and non-blank. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: arn:aws:lambda:us-east-1:123456789012:function:orders.
timeoutInMillis	Integer [1]	For a api gateway integration, the model records the timeout in millis value. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Semantic validation: LongApiGatewayTimeoutRequiresQuotaReview (long api gateway timeout requires quota review) in mde/validation/psm/rules/api.evl the related value or object must be explicitly provided.	A numeric Integer value; use the unit or boundary documented for this attribute. Example: 30.
passthroughBehavior	String [1]	For a api gateway integration, the model records the passthrough behavior value. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: Api Gateway Integration Passthrough Behavior.
requestTemplatesJson	String [1]	Stores the serialized JSON representation of request templates on the api gateway integration. The field preserves structured provider or contract detail as an explicit, reviewable input. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: {"enabled":true}.
responseParametersJson	String [1]	Records serialized JSON representation of response parameters for api gateway integration. It keeps preserving structured provider or contract detail explicit during review and transformation, so later steps do not have to infer it. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: {"enabled":true}.
integrationType	ApiGatewayIntegrationType [1]	Stores the controlled classification or strategy represented by integration type on the api gateway integration. The field keeps the model explicit and reviewable during review and transformation instead of leaving the decision to an inferred default. Semantic validation: IntegrationHasSingleTarget (integration has single target) in mde/validation/psm/rules/api.evl the feature participates in a semantic validation condition. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol. The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/contracts.eol.	Exactly one of: AWS_PROXY, AWS, HTTP_PROXY, HTTP, MOCK. Example: AWS_PROXY.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
responseParameters → ApiGatewayIntegrationResponseParameter	containment, [*]	Contains the api gateway integration response parameter element(s) that make up this api gateway integration; the contained objects belong to this model element.
requestTemplates → ApiGatewayIntegrationRequestTemplate	containment, [*]	Contains the api gateway integration request template element(s) that make up this api gateway integration; the contained objects belong to this model element.
lambdaTarget → AwsLambdaFunction	reference, [?]	References the aws lambda function element(s) used as lambda target by this api gateway integration; the target may be shared elsewhere in the model.
stateMachineTarget → StepFunctionStateMachine	reference, [?]	References the step function state machine element(s) used as state machine target by this api gateway integration; the target may be shared elsewhere in the model.
credentialsRole → IamRole	reference, [?]	References the iam role element(s) used as credentials role by this api gateway integration; the target may be shared elsewhere in the model.

ApiGatewayIntegrationRequestTemplate

Represents api gateway integration request template in the PSM vocabulary. It specializes TraceableElement with the details needed for this modeling concern.

Direct supertypes: TraceableElement. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
contentType	String [1]	Stores the serialization/content format for content type on the api gateway integration request template. The field keeps the model explicit and reviewable during review and transformation instead of leaving the decision to an inferred default. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: BUSINESS.
template	String [1]	Records the template value for api gateway integration request template. It keeps this decision explicit during review and transformation, so later steps do not have to infer it. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/awspsm2artifacts.egx. The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: Api Gateway Integration Request Template Template.

Relationships

This class declares no direct relationships.

ApiGatewayIntegrationResponseParameter

Represents api gateway integration response parameter in the PSM vocabulary. It specializes TraceableElement with the details needed for this modeling concern.

Direct supertypes: TraceableElement. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
parameterName	String [1]	Stores the stable name/key/code used for parameter name on the api gateway integration response parameter. The field keeps the model explicit and reviewable during review and transformation instead of leaving the decision to an inferred default. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: ApiGatewayIntegrationResponseParameterExample.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
value → ValueExpression	containment, [1]	Contains the value expression element(s) that make up this api gateway integration response parameter; the contained objects belong to this model element.

ApiGatewayStage

An abstract api gateway stage concept. Use one of its concrete subtypes when creating a model instance; the shared attributes and relationships defined here still apply.

Direct supertypes: AwsResource, WafAssociableResource. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
stageName	String [1]	Records stable name/key/code used for stage name for api gateway stage. It keeps this decision explicit during review and transformation, so later steps do not have to infer it. Semantic validation: AccessLogStageRequiresGroupAndFormat (access log stage requires group and format) in mde/validation/psm/rules/api.evl the rule's diagnostic or remediation guidance refers to this feature. ProductionStageShouldThrottle (production stage should throttle) in mde/validation/psm/rules/api.evl the rule's diagnostic or remediation guidance refers to this feature.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: ApiGatewayStageExample.
autoDeploy	Boolean [1]	Records whether auto deploy applies to api gateway stage. The field records an explicit architectural or governance decision as an explicit, reviewable input. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	Either true or false. Example: false.
accessLogEnabled	Boolean [1]	Records whether access log enabled applies to api gateway stage. This keeps the decision explicit even when the element's class or relationships remain unchanged. Semantic validation: AccessLogStageRequiresGroupAndFormat (access log stage requires group and format) in mde/validation/psm/rules/api.evl the flag must be enabled for this rule to pass. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	Either true or false. Example: true.
accessLogFormat	String [1]	Records serialization/content format for access log format for api gateway stage. It keeps this decision explicit during review and transformation, so later steps do not have to infer it. Semantic validation: AccessLogStageRequiresGroupAndFormat (access log stage requires group and format) in mde/validation/psm/rules/api.evl the value must be present and non-blank. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: Api Gateway Stage Access Log Format.
metricsEnabled	Boolean [1]	Records whether metrics enabled applies to api gateway stage. The field records an explicit architectural or governance decision as an explicit, reviewable input. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	Either true or false. Example: true.
dataTraceEnabled	Boolean [1]	For a api gateway stage, the model records whether data trace enabled applies. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	Either true or false. Example: true.
loggingLevel	String [1]	Records the logging level value for the api gateway stage. This keeps the decision explicit even when the element's class or relationships remain unchanged. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: INFO.
throttlingBurstLimit	Integer [1]	Stores the throttling burst limit value on the api gateway stage. The field records an operational boundary explicitly instead of leaving it to provider defaults. Semantic validation: ProductionStageShouldThrottle (production stage should throttle) in mde/validation/psm/rules/api.evl the related value or object must be explicitly provided.	A numeric Integer value; use the unit or boundary documented for this attribute. Example: 1.
throttlingRateLimit	Double [1]	Stores the throttling rate limit value on the api gateway stage. The field records an operational boundary explicitly instead of leaving it to provider defaults. Semantic validation: ProductionStageShouldThrottle (production stage should throttle) in mde/validation/psm/rules/api.evl the related value or object must be explicitly provided.	A numeric Double value; use the unit or boundary documented for this attribute. Example: 1.
variablesJson	String [1]	Records the serialized JSON representation of variables for the api gateway stage. This keeps the decision explicit even when the element's class or relationships remain unchanged. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: {"enabled":true}.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
accessLogSetting → ApiGatewayAccessLogSetting	containment, [?]	Contains the api gateway access log setting element(s) that make up this api gateway stage; the contained objects belong to this model element.
defaultRouteSettings → ApiGatewayRouteSetting	containment, [?]	Contains the api gateway route setting element(s) that make up this api gateway stage; the contained objects belong to this model element.
api → ApiGatewayApi	reference; read-only, [1]; opposite stages	References the api gateway api element(s) used as api by this api gateway stage; the target may be shared elsewhere in the model.
accessLogGroup → CloudWatchLogGroup	reference, [?]	References the cloud watch log group element(s) used as access log group by this api gateway stage; the target may be shared elsewhere in the model.

HttpApiStage

Represents http api stage in the PSM vocabulary. It specializes ApiGatewayStage with the details needed for this modeling concern.

Direct supertypes: ApiGatewayStage. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

This class declares no attributes of its own. It inherits the attributes of its supertype, if any.

Relationships

This class declares no direct relationships.

RestApiStage

Represents rest api stage in the PSM vocabulary. It specializes ApiGatewayStage with the details needed for this modeling concern.

Direct supertypes: ApiGatewayStage. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

This class declares no attributes of its own. It inherits the attributes of its supertype, if any.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
deployment → ApiGatewayDeployment	reference, [?]	References the api gateway deployment element(s) used as deployment by this rest api stage; the target may be shared elsewhere in the model.

WebSocketStage

Represents web socket stage in the PSM vocabulary. It specializes ApiGatewayStage with the details needed for this modeling concern.

Direct supertypes: ApiGatewayStage. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

This class declares no attributes of its own. It inherits the attributes of its supertype, if any.

Relationships

This class declares no direct relationships.

ApiGatewayAuthorizer

An abstract api gateway authorizer concept. Use one of its concrete subtypes when creating a model instance; the shared attributes and relationships defined here still apply.

Direct supertypes: AwsResource. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
authorizerName	String [1]	Records the stable name/key/code used for authorizer name for the api gateway authorizer. This keeps the decision explicit even when the element's class or relationships remain unchanged. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: ApiGatewayAuthorizerExample.
identitySource	String [1]	For a api gateway authorizer, the model records the origin/source selected for identity source. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: Api Gateway Authorizer Identity Source.
authorizerResultTtlInSeconds	Integer [1]	Records the authorizer result ttl in seconds duration or limit, expressed in seconds for the api gateway authorizer. This keeps the decision explicit even when the element's class or relationships remain unchanged. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A numeric Integer value; use the unit or boundary documented for this attribute. Example: 1.
authorizationType	ApiGatewayAuthorizationType [1]	For a api gateway authorizer, the model records the controlled classification or strategy represented by authorization type. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	Exactly one of: NONE, AWS_IAM, JWT, COGNITO_USER_POOLS, CUSTOM_LAMBDA, API_KEY. Example: NONE.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
api → ApiGatewayApi	reference; read-only, [1]; opposite authorizers	References the api gateway api element(s) used as api by this api gateway authorizer; the target may be shared elsewhere in the model.

JwtAuthorizer

Represents jwt authorizer in the PSM vocabulary. It specializes ApiGatewayAuthorizer with the details needed for this modeling concern.

Direct supertypes: ApiGatewayAuthorizer. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
issuer	String [1]	Records whether issuer applies to jwt authorizer. It preserves an explicit architectural or governance decision through review and transformation, so later steps do not have to infer it. Semantic validation: JwtAuthorizerHasIssuerAndAudience (jwt authorizer has issuer and audience) in mde/validation/psm/rules/api.evl the value must be present and non-blank. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: Jwt Authorizer Issuer.
audience	String [*]	For a jwt authorizer, the model records the audience value. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Semantic validation: JwtAuthorizerHasIssuerAndAudience (jwt authorizer has issuer and audience) in mde/validation/psm/rules/api.evl the value must be present and non-blank. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A collection of values. Example: [Jwt Authorizer Audience, Jwt Authorizer Audience-2].

Relationships

This class declares no direct relationships.

CognitoAuthorizer

Represents cognito authorizer in the PSM vocabulary. It specializes ApiGatewayAuthorizer with the details needed for this modeling concern.

Direct supertypes: ApiGatewayAuthorizer. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

This class declares no attributes of its own. It inherits the attributes of its supertype, if any.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
userPool → CognitoUserPool	reference, [1]	References the cognito user pool element(s) used as user pool by this cognito authorizer; the target may be shared elsewhere in the model.
clients → CognitoUserPoolClient	reference, [*]	References the cognito user pool client element(s) used as clients by this cognito authorizer; the target may be shared elsewhere in the model.

LambdaAuthorizer

Represents lambda authorizer in the PSM vocabulary. It specializes ApiGatewayAuthorizer with the details needed for this modeling concern.

Direct supertypes: ApiGatewayAuthorizer. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
authorizerPayloadFormatVersion	String [1]	For a lambda authorizer, the model records the serialization/content format for authorizer payload format version. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: 1.0.
enableSimpleResponses	Boolean [1]	Records whether enable simple responses applies to lambda authorizer. It preserves an explicit architectural or governance decision through review and transformation, so later steps do not have to infer it. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	Either true or false. Example: false.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
function → AwsLambdaFunction	reference, [1]	References the aws lambda function element(s) used as function by this lambda authorizer; the target may be shared elsewhere in the model.

ApiGatewayDomainName

Represents api gateway domain name in the PSM vocabulary. It specializes AwsResource with the details needed for this modeling concern.

Direct supertypes: AwsResource. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
domainName	String [1]	Stores the stable name/key/code used for domain name on the api gateway domain name. The field keeps the model explicit and reviewable during review and transformation instead of leaving the decision to an inferred default. Semantic validation: DomainHasCertificate (domain has certificate) in mde/validation/psm/rules/api.evl the rule's diagnostic or remediation guidance refers to this feature. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: orders.example.com.
certificateArn	String [1]	Records AWS ARN used for certificate for api gateway domain name. It keeps this decision explicit during review and transformation, so later steps do not have to infer it. Semantic validation: DomainHasCertificate (domain has certificate) in mde/validation/psm/rules/api.evl the value must be present and non-blank.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: arn:aws:lambda:us-east-1:123456789012:function:orders.
securityPolicy	String [1]	Records the security policy value for api gateway domain name. It keeps this decision explicit during review and transformation, so later steps do not have to infer it. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: STANDARD.
endpointType	ApiGatewayEndpointType [1]	For a api gateway domain name, the model records the controlled classification or strategy represented by endpoint type. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	Exactly one of: REGIONAL, EDGE, PRIVATE. Example: REGIONAL.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
api → ApiGatewayApi	reference, [?]; opposite apiDomainName	References the api gateway api element(s) used as api by this api gateway domain name; the target may be shared elsewhere in the model.
mappings → ApiGatewayBasePathMapping	reference, [*]; opposite domainName	References the api gateway base path mapping element(s) used as mappings by this api gateway domain name; the target may be shared elsewhere in the model.

ApiGatewayBasePathMapping

Represents api gateway base path mapping in the PSM vocabulary. It specializes AwsResource with the details needed for this modeling concern.

Direct supertypes: AwsResource. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
basePath	String [1]	For a api gateway base path mapping, the model records the data location or endpoint represented by base path. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: /orders/{orderId}.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
domainName → ApiGatewayDomainName	reference, [1]; opposite mappings	References the api gateway domain name element(s) used as domain name by this api gateway base path mapping; the target may be shared elsewhere in the model.
api → ApiGatewayApi	reference, [1]	References the api gateway api element(s) used as api by this api gateway base path mapping; the target may be shared elsewhere in the model.
stage → ApiGatewayStage	reference, [?]	References the api gateway stage element(s) used as stage by this api gateway base path mapping; the target may be shared elsewhere in the model.

ApiGatewayApiKey

Represents api gateway api key in the PSM vocabulary. It specializes AwsResource with the details needed for this modeling concern.

Direct supertypes: AwsResource. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
apiKeyName	String [1]	Records the stable name/key/code used for api key name for the api gateway api key. This keeps the decision explicit even when the element's class or relationships remain unchanged. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: orderId.
enabled	Boolean [1]	Records whether enabled applies to api gateway api key. The field records an explicit architectural or governance decision as an explicit, reviewable input. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	Either true or false. Example: true.
value	String [1]	For a api gateway api key, the model records the value value. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: READY.
descriptionText	String [1]	For a api gateway api key, the model records the human explanation of description text. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: Orders processing.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
stages → RestApiStage	reference, [*]	References the rest api stage element(s) used as stages by this api gateway api key; the target may be shared elsewhere in the model.

ApiGatewayUsagePlan

Represents api gateway usage plan in the PSM vocabulary. It specializes AwsResource with the details needed for this modeling concern.

Direct supertypes: AwsResource. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
usagePlanName	String [1]	Records stable name/key/code used for usage plan name for api gateway usage plan. It keeps this decision explicit during review and transformation, so later steps do not have to infer it. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: ApiGatewayUsagePlanExample.
descriptionText	String [1]	Records human explanation of description text for api gateway usage plan. It keeps human review and generated guidance explicit during review and transformation, so later steps do not have to infer it. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: Orders processing.
throttleBurstLimit	Integer [1]	Records the throttle burst limit value for api gateway usage plan. It keeps an operational boundary that should not be left to provider defaults explicit during review and transformation, so later steps do not have to infer it. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A numeric Integer value; use the unit or boundary documented for this attribute. Example: 1.
throttleRateLimit	Double [1]	Records the throttle rate limit value for api gateway usage plan. It keeps an operational boundary that should not be left to provider defaults explicit during review and transformation, so later steps do not have to infer it. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A numeric Double value; use the unit or boundary documented for this attribute. Example: 1.
quotaLimit	Integer [1]	Records the quota limit value for api gateway usage plan. It keeps an operational boundary that should not be left to provider defaults explicit during review and transformation, so later steps do not have to infer it. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A numeric Integer value; use the unit or boundary documented for this attribute. Example: 1.
quotaPeriod	String [1]	Records the quota period value for api gateway usage plan. It keeps this decision explicit during review and transformation, so later steps do not have to infer it. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: Api Gateway Usage Plan Quota Period.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
apiStages → RestApiStage	reference, [*]	References the rest api stage element(s) used as api stages by this api gateway usage plan; the target may be shared elsewhere in the model.

ApiGatewayUsagePlanKey

Represents api gateway usage plan key in the PSM vocabulary. It specializes AwsResource with the details needed for this modeling concern.

Direct supertypes: AwsResource. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
keyType	String [1]	For a api gateway usage plan key, the model records the controlled classification or strategy represented by key type. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Semantic validation: UsagePlanKeyUsesKnownType (usage plan key uses known type) in mde/validation/psm/rules/api.evl the value must be present and non-blank.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: orderId.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
apiKey → ApiGatewayApiKey	reference, [1]	References the api gateway api key element(s) used as api key by this api gateway usage plan key; the target may be shared elsewhere in the model.
usagePlan → ApiGatewayUsagePlan	reference, [1]	References the api gateway usage plan element(s) used as usage plan by this api gateway usage plan key; the target may be shared elsewhere in the model.

ApiGatewayDeployment

Represents api gateway deployment in the PSM vocabulary. It specializes AwsResource with the details needed for this modeling concern.

Direct supertypes: AwsResource. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
descriptionText	String [1]	Stores the human explanation of description text on the api gateway deployment. The field records human review and generated guidance as an explicit, reviewable input. The repository contains no direct EVL rule, ETL assignment, or artifact-generator read for this declared field. For now, it remains a model-level fact for review and future refinement.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: Orders processing.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
api → RestApi	reference, [1]	References the rest api element(s) used as api by this api gateway deployment; the target may be shared elsewhere in the model.

ApiGatewayTracingConfig

Represents api gateway tracing config in the PSM vocabulary. It specializes TracingConfig with the details needed for this modeling concern.

Direct supertypes: TracingConfig. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

This class declares no attributes of its own. It inherits the attributes of its supertype, if any.

Relationships

This class declares no direct relationships.

WafWebAclAssociation

Represents waf web acl association in the PSM vocabulary. It specializes AwsResource with the details needed for this modeling concern.

Direct supertypes: AwsResource. Inherited attributes and marker capabilities are documented in the shared kernel; this section lists every attribute declared by this class.

Declared attributes

Attribute	Type and multiplicity	What it captures and why it exists	Accepted values and example
webAclArn	String [1]	For a waf web acl association, the model records the AWS ARN used for web acl. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Generation role: The artifact generator references this feature in mde/generation/awspsm-to-artifacts/lib/cfn.eol.	A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: arn:aws:lambda:us-east-1:123456789012:function:orders.

Relationships

Relationship	Kind and multiplicity	Meaning in the model
protectedResource → WafAssociableResource	reference, [1]	References the waf associable resource element(s) used as protected resource by this waf web acl association; the target may be shared elsewhere in the model.