Skip to content

External endpoints and adapters

External concepts identify systems outside the modeled application and the adapters needed to call or receive from them.

Source: mde/metamodels/pim/pim-external.emf.

ExternalEndpoint

Represents external endpoint in the PIM vocabulary. It specializes TraceableElement, ExternalCallTarget, PolicyTarget, ProtectedResource with the details needed for this modeling concern.

Direct supertypes: TraceableElement, ExternalCallTarget, PolicyTarget, ProtectedResource. 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
externalSystemName String [1] Records stable name/key/code used for external system name for external endpoint. 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: ExternalEndpointExample.
protocolFamily String [1] For a external endpoint, the model records the protocol family 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: External Endpoint Protocol Family.
endpointDescription String [1] Records human explanation of endpoint description for external endpoint. 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: Processes confirmed orders for the owning capability..
privateNetworkRequired Boolean [1] Records whether private network required applies to external endpoint. 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.
credentialsRequired Boolean [1] Records whether credentials required applies to external endpoint. 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.
rateLimitedByProvider Boolean [1] Records whether rate limited by provider applies to external endpoint. 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.
expectedSla String [1] Stores the expected sla value on the external endpoint. 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: External Endpoint Expected Sla.
endpointUri String [1] Records URI/URL from which endpoint is obtained for external endpoint. 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: https://example.com/orders.
authorizationEndpoint String [1] Stores the authorization endpoint value on the external endpoint. 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/values.eol. A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: External Endpoint Authorization Endpoint.

Relationships

This class declares no direct relationships.

ExternalAdapter

Represents external adapter in the PIM vocabulary. It specializes TraceableElement, DeployableElement, FlowEndpoint, InvocationTarget, FunctionTarget, SubscriptionTarget, RoutingTarget, ExternalCallTarget, ProtectedResource, PolicyTarget, ConfigurableElement with the details needed for this modeling concern.

Direct supertypes: TraceableElement, DeployableElement, FlowEndpoint, InvocationTarget, FunctionTarget, SubscriptionTarget, RoutingTarget, ExternalCallTarget, ProtectedResource, PolicyTarget, ConfigurableElement. 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
responsibility String [1] For a external adapter, the model records the accountable person, team, or identity for responsibility. Keeping the fact with its owning element lets validation and refinement inspect it before artifact generation. Transformation role: ETL rule ExternalSystem2Adapter in mde/transformations/cim-to-pim/boundaries-security.etl assigns or materializes this feature while refining ExternalAdapter. A free-form String, subject to this class's semantic meaning and any EVL constraints. Example: Reserve inventory for a confirmed order..

Relationships

Relationship Kind and multiplicity Meaning in the model
credentialsCredentialRequirement containment, [*] Contains the credential requirement element(s) that make up this external adapter; the contained objects belong to this model element.
serviceServerlessService reference; read-only, [1]; opposite adapters References the serverless service element(s) used as service by this external adapter; the target may be shared elsewhere in the model.
endpointExternalEndpoint reference, [1] References the external endpoint element(s) used as endpoint by this external adapter; the target may be shared elsewhere in the model.
adapterFunctionsFunctionTarget reference, [*] References the function target element(s) used as adapter functions by this external adapter; the target may be shared elsewhere in the model.
resilienceResiliencePolicy reference, [?] References the resilience policy element(s) used as resilience by this external adapter; the target may be shared elsewhere in the model.
observabilityObservabilityConfig reference, [?] References the observability config element(s) used as observability by this external adapter; the target may be shared elsewhere in the model.
idempotencyIdempotencyPolicy reference, [?] References the idempotency policy element(s) used as idempotency by this external adapter; the target may be shared elsewhere in the model.