aws-cdk-lib.aws_arczonalshift.CfnZonalAutoshiftConfigurationProps

CfnZonalAutoshiftConfigurationProps Struct

Properties for defining a CfnZonalAutoshiftConfiguration.

Source

Generated code

Type last changed

v2.140.0 · 2 May 2024

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_arczonalshift as arczonalshift } from 'aws-cdk-lib';
const cfnZonalAutoshiftConfigurationProps: arczonalshift.CfnZonalAutoshiftConfigurationProps = {
  resourceIdentifier: 'resourceIdentifier',

  // the properties below are optional
  practiceRunConfiguration: {
    outcomeAlarms: [{
      alarmIdentifier: 'alarmIdentifier',
      type: 'type',
    }],

    // the properties below are optional
    blockedDates: ['blockedDates'],
    blockedWindows: ['blockedWindows'],
    blockingAlarms: [{
      alarmIdentifier: 'alarmIdentifier',
      type: 'type',
    }],
  },
  zonalAutoshiftStatus: 'zonalAutoshiftStatus',
};

Properties

practiceRunConfigurationIResolvable | CfnZonalAutoshiftConfiguration.PracticeRunConfigurationPropertypractice_run_configurationtyping.Union[IResolvable, PracticeRunConfigurationProperty]practiceRunConfigurationIResolvablePracticeRunConfigurationIResolvablePracticeRunConfigurationinterface{}#

A practice run configuration for a resource includes the Amazon CloudWatch alarms that you've specified for a practice run, as well as any blocked dates or blocked windows for the practice run.

notes

When a resource has a practice run configuration, ARC shifts traffic for the resource weekly for practice runs.

Practice runs are required for zonal autoshift. The zonal shifts that ARC starts for practice runs help you to ensure that shifting away traffic from an Availability Zone during an autoshift is safe for your application.

You can update or delete a practice run configuration. Before you delete a practice run configuration, you must disable zonal autoshift for the resource. A practice run configuration is required when zonal autoshift is enabled.

resourceIdentifierstringresource_identifierstrresourceIdentifierStringResourceIdentifierstringResourceIdentifier*stringrequired#

The identifier for the resource that AWS shifts traffic for.

The identifier is the Amazon Resource Name (ARN) for the resource.

At this time, supported resources are Network Load Balancers and Application Load Balancers.

zonalAutoshiftStatusstringzonal_autoshift_statusstrzonalAutoshiftStatusStringZonalAutoshiftStatusstringZonalAutoshiftStatus*string#

When zonal autoshift is `ENABLED` , you authorize AWS to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery.

Traffic is also shifted away for the required weekly practice runs.

Used as props by

• CfnZonalAutoshiftConfiguration