Skip to main content

ISESV2MultiRegionEndpoint

Interface in AWS.SESV2

Interface for SESV2 MultiRegionEndpoint.

Properties

CreatedTimestamp

property CreatedTimestamp: TOptional<TDateTime>

The timestamp when the multi-region endpoint was initially created.

This timestamp is automatically set when the multi-region endpoint is first created through the CreateMultiRegionEndpoint operation. It represents the start of the endpoint's lifecycle and is used for tracking endpoint age and audit purposes. This timestamp remains constant throughout the endpoint's lifecycle and can be used to calculate the endpoint's operational duration when combined with LastUpdatedTimestamp.

EndpointId

property EndpointId: string

The unique identifier assigned to the multi-region endpoint.

This identifier is automatically generated by Amazon SES when the multi-region endpoint is created and serves as the primary key for all subsequent operations involving this endpoint. Use this identifier with operations such as GetMultiRegionEndpoint, PutMultiRegionEndpoint, or DeleteMultiRegionEndpoint to manage the endpoint configuration. Endpoint identifiers are unique within your AWS account and region, ensuring reliable endpoint tracking and management across your email infrastructure.

EndpointName

property EndpointName: string

The human-readable name assigned to the multi-region endpoint.

The endpoint name provides a descriptive identifier that makes it easier to identify and manage endpoints in your Amazon SES account. This name is typically used in administrative interfaces and logging for operational clarity. Endpoint names have length constraints of 1 to 64 characters and should be chosen to clearly identify the endpoint's purpose or scope within your email infrastructure.

LastUpdatedTimestamp

property LastUpdatedTimestamp: TOptional<TDateTime>

The timestamp when the multi-region endpoint configuration was last modified.

This timestamp is updated whenever the endpoint configuration is modified through operations such as PutMultiRegionEndpoint. It helps track configuration changes and determine when the endpoint was last updated. Initially, this value matches CreatedTimestamp when the endpoint is first created. Subsequent configuration changes will update this timestamp while preserving the original creation timestamp.

Regions

property Regions: TList<string>

The collection of AWS regions configured for this multi-region endpoint.

This array contains the primary and secondary regions between which the multi-region endpoint distributes email sending traffic. The regional distribution provides improved reliability, performance, and compliance with regional data requirements. The first region in the array typically serves as the primary region, with additional regions serving as failover or load distribution targets. The specific region roles and traffic distribution patterns depend on the endpoint's route configuration. Region identifiers follow standard AWS region naming conventions such as us-east-1, eu-west-1, or ap-southeast-2.

Status

property Status: string

The current operational status of the multi-region endpoint.

This status indicates the current state of the endpoint's provisioning and operational readiness. The status determines what operations can be performed and whether the endpoint is actively processing email traffic. Valid status values:

  • CREATING – The endpoint is being provisioned and is not yet ready for use.
  • READY – The endpoint is fully operational and actively processing email traffic.
  • FAILED – The endpoint provisioning failed and requires attention or recreation.
  • DELETING – The endpoint is being deleted as requested and will soon be unavailable. Monitor this status to determine when the endpoint is ready for production use or when intervention is needed for failed provisioning attempts.