Endpoint
eventbridge.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | eventbridge-controller/apis/v1alpha1#Endpoint |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Endpoint |
| ListKind | EndpointList |
| Plural | endpoints |
| Singular | endpoint |
A global endpoint used to improve your application’s availability by making it regional-fault tolerant. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html) in the Amazon EventBridge User Guide.
Spec
description: string
eventBuses:
- eventBusARN: string
name: string
replicationConfig:
state: string
roleARN: string
routingConfig:
failoverConfig:
primary:
healthCheck: string
secondary:
route: string
| Field | Description |
|---|---|
| description Optional | string A description of the global endpoint. |
| eventBuses Required | array Define the event buses used. The names of the event buses must be identical in each Region. |
| eventBuses.[] Required | object The event buses the endpoint is associated with. |
| name Required | string The name of the global endpoint. For example, “Name”:“us-east-2-custom_bus_A-endpoint”. |
| replicationConfig Optional | object Enable or disable event replication. The default state is ENABLED which means you must supply a RoleArn. If you don’t have a RoleArn or you don’t want event replication enabled, set the state to DISABLED. |
| replicationConfig.state Optional | string |
| roleARN Optional | string The ARN of the role used for replication. |
| routingConfig Required | object Configure the routing policy, including the health check and secondary Region.. |
| routingConfig.failoverConfig Optional | object The failover configuration for an endpoint. This includes what triggers failover and what happens when it’s triggered. |
| routingConfig.failoverConfig.primary Optional | object The primary Region of the endpoint. |
| routingConfig.failoverConfig.primary.healthCheck Optional | string |
| routingConfig.failoverConfig.secondary Optional | object The secondary Region that processes events when failover is triggered or replication is enabled. |
| routingConfig.failoverConfig.secondary.route Optional | string |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
state: string
stateReason: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| conditions Optional | array All CRS managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| state Optional | string The state of the endpoint that was created by this request. |
| stateReason Optional | string The reason the endpoint you asked for information about is in its current state. |