Skip to content
v2.275.0

FailoverConfigProperty Struct ​

The failover configuration for an endpoint.

This includes what triggers failover and what happens when it's triggered.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_events as events } from 'aws-cdk-lib';
const failoverConfigProperty: events.CfnEndpoint.FailoverConfigProperty = {
  primary: {
    healthCheck: 'healthCheck',
  },
  secondary: {
    route: 'route',
  },
};

Properties ​

primaryIResolvable | CfnEndpoint.PrimaryPropertyprimarytyping.Union[IResolvable, PrimaryProperty]primaryIResolvablePrimaryIResolvablePrimaryinterface{}required#
The main Region of the endpoint.
secondaryIResolvable | CfnEndpoint.SecondaryPropertysecondarytyping.Union[IResolvable, SecondaryProperty]secondaryIResolvableSecondaryIResolvableSecondaryinterface{}required#
The Region that events are routed to when failover is triggered or event replication is enabled.