Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. arczonalshift
  5. getZonalAutoshiftConfiguration

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.arczonalshift.getZonalAutoshiftConfiguration

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Definition of AWS::ARCZonalShift::ZonalAutoshiftConfiguration Resource Type

Using getZonalAutoshiftConfiguration

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getZonalAutoshiftConfiguration(args: GetZonalAutoshiftConfigurationArgs, opts?: InvokeOptions): Promise<GetZonalAutoshiftConfigurationResult>
function getZonalAutoshiftConfigurationOutput(args: GetZonalAutoshiftConfigurationOutputArgs, opts?: InvokeOptions): Output<GetZonalAutoshiftConfigurationResult>
Copy
def get_zonal_autoshift_configuration(resource_identifier: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetZonalAutoshiftConfigurationResult
def get_zonal_autoshift_configuration_output(resource_identifier: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetZonalAutoshiftConfigurationResult]
Copy
func LookupZonalAutoshiftConfiguration(ctx *Context, args *LookupZonalAutoshiftConfigurationArgs, opts ...InvokeOption) (*LookupZonalAutoshiftConfigurationResult, error)
func LookupZonalAutoshiftConfigurationOutput(ctx *Context, args *LookupZonalAutoshiftConfigurationOutputArgs, opts ...InvokeOption) LookupZonalAutoshiftConfigurationResultOutput
Copy

> Note: This function is named LookupZonalAutoshiftConfiguration in the Go SDK.

public static class GetZonalAutoshiftConfiguration 
{
    public static Task<GetZonalAutoshiftConfigurationResult> InvokeAsync(GetZonalAutoshiftConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<GetZonalAutoshiftConfigurationResult> Invoke(GetZonalAutoshiftConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetZonalAutoshiftConfigurationResult> getZonalAutoshiftConfiguration(GetZonalAutoshiftConfigurationArgs args, InvokeOptions options)
public static Output<GetZonalAutoshiftConfigurationResult> getZonalAutoshiftConfiguration(GetZonalAutoshiftConfigurationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:arczonalshift:getZonalAutoshiftConfiguration
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceIdentifier This property is required. string

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 with cross-zone load balancing turned off.

ResourceIdentifier This property is required. string

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 with cross-zone load balancing turned off.

resourceIdentifier This property is required. String

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 with cross-zone load balancing turned off.

resourceIdentifier This property is required. string

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 with cross-zone load balancing turned off.

resource_identifier This property is required. str

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 with cross-zone load balancing turned off.

resourceIdentifier This property is required. String

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 with cross-zone load balancing turned off.

getZonalAutoshiftConfiguration Result

The following output properties are available:

PracticeRunConfiguration Pulumi.AwsNative.ArcZonalShift.Outputs.ZonalAutoshiftConfigurationPracticeRunConfiguration

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. When a resource has a practice run configuration, Route 53 ARC shifts traffic for the resource weekly for practice runs.

Practice runs are required for zonal autoshift. The zonal shifts that Route 53 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.

ZonalAutoshiftStatus Pulumi.AwsNative.ArcZonalShift.ZonalAutoshiftConfigurationZonalAutoshiftStatus
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.
PracticeRunConfiguration ZonalAutoshiftConfigurationPracticeRunConfiguration

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. When a resource has a practice run configuration, Route 53 ARC shifts traffic for the resource weekly for practice runs.

Practice runs are required for zonal autoshift. The zonal shifts that Route 53 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.

ZonalAutoshiftStatus ZonalAutoshiftConfigurationZonalAutoshiftStatus
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.
practiceRunConfiguration ZonalAutoshiftConfigurationPracticeRunConfiguration

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. When a resource has a practice run configuration, Route 53 ARC shifts traffic for the resource weekly for practice runs.

Practice runs are required for zonal autoshift. The zonal shifts that Route 53 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.

zonalAutoshiftStatus ZonalAutoshiftConfigurationZonalAutoshiftStatus
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.
practiceRunConfiguration ZonalAutoshiftConfigurationPracticeRunConfiguration

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. When a resource has a practice run configuration, Route 53 ARC shifts traffic for the resource weekly for practice runs.

Practice runs are required for zonal autoshift. The zonal shifts that Route 53 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.

zonalAutoshiftStatus ZonalAutoshiftConfigurationZonalAutoshiftStatus
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.
practice_run_configuration ZonalAutoshiftConfigurationPracticeRunConfiguration

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. When a resource has a practice run configuration, Route 53 ARC shifts traffic for the resource weekly for practice runs.

Practice runs are required for zonal autoshift. The zonal shifts that Route 53 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.

zonal_autoshift_status ZonalAutoshiftConfigurationZonalAutoshiftStatus
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.
practiceRunConfiguration Property Map

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. When a resource has a practice run configuration, Route 53 ARC shifts traffic for the resource weekly for practice runs.

Practice runs are required for zonal autoshift. The zonal shifts that Route 53 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.

zonalAutoshiftStatus "ENABLED"
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.

Supporting Types

ZonalAutoshiftConfigurationControlCondition

AlarmIdentifier This property is required. string
The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.
Type This property is required. string
The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is CLOUDWATCH .
AlarmIdentifier This property is required. string
The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.
Type This property is required. string
The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is CLOUDWATCH .
alarmIdentifier This property is required. String
The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.
type This property is required. String
The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is CLOUDWATCH .
alarmIdentifier This property is required. string
The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.
type This property is required. string
The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is CLOUDWATCH .
alarm_identifier This property is required. str
The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.
type This property is required. str
The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is CLOUDWATCH .
alarmIdentifier This property is required. String
The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.
type This property is required. String
The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is CLOUDWATCH .

ZonalAutoshiftConfigurationPracticeRunConfiguration

OutcomeAlarms This property is required. List<Pulumi.AwsNative.ArcZonalShift.Inputs.ZonalAutoshiftConfigurationControlCondition>
The alarm that you specify to monitor the health of your application during practice runs. When the outcome alarm goes into an ALARM state, the practice run is ended and the outcome is set to FAILED .
BlockedDates List<string>

An array of one or more dates that you can specify when AWS does not start practice runs for a resource. Dates are in UTC.

Specify blocked dates in the format YYYY-MM-DD , separated by spaces.

BlockedWindows List<string>

An array of one or more days and times that you can specify when Route 53 ARC does not start practice runs for a resource. Days and times are in UTC.

Specify blocked windows in the format DAY:HH:MM-DAY:HH:MM , separated by spaces. For example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30 .

BlockingAlarms List<Pulumi.AwsNative.ArcZonalShift.Inputs.ZonalAutoshiftConfigurationControlCondition>
An optional alarm that you can specify that blocks practice runs when the alarm is in an ALARM state. When a blocking alarm goes into an ALARM state, it prevents practice runs from being started, and ends practice runs that are in progress.
OutcomeAlarms This property is required. []ZonalAutoshiftConfigurationControlCondition
The alarm that you specify to monitor the health of your application during practice runs. When the outcome alarm goes into an ALARM state, the practice run is ended and the outcome is set to FAILED .
BlockedDates []string

An array of one or more dates that you can specify when AWS does not start practice runs for a resource. Dates are in UTC.

Specify blocked dates in the format YYYY-MM-DD , separated by spaces.

BlockedWindows []string

An array of one or more days and times that you can specify when Route 53 ARC does not start practice runs for a resource. Days and times are in UTC.

Specify blocked windows in the format DAY:HH:MM-DAY:HH:MM , separated by spaces. For example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30 .

BlockingAlarms []ZonalAutoshiftConfigurationControlCondition
An optional alarm that you can specify that blocks practice runs when the alarm is in an ALARM state. When a blocking alarm goes into an ALARM state, it prevents practice runs from being started, and ends practice runs that are in progress.
outcomeAlarms This property is required. List<ZonalAutoshiftConfigurationControlCondition>
The alarm that you specify to monitor the health of your application during practice runs. When the outcome alarm goes into an ALARM state, the practice run is ended and the outcome is set to FAILED .
blockedDates List<String>

An array of one or more dates that you can specify when AWS does not start practice runs for a resource. Dates are in UTC.

Specify blocked dates in the format YYYY-MM-DD , separated by spaces.

blockedWindows List<String>

An array of one or more days and times that you can specify when Route 53 ARC does not start practice runs for a resource. Days and times are in UTC.

Specify blocked windows in the format DAY:HH:MM-DAY:HH:MM , separated by spaces. For example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30 .

blockingAlarms List<ZonalAutoshiftConfigurationControlCondition>
An optional alarm that you can specify that blocks practice runs when the alarm is in an ALARM state. When a blocking alarm goes into an ALARM state, it prevents practice runs from being started, and ends practice runs that are in progress.
outcomeAlarms This property is required. ZonalAutoshiftConfigurationControlCondition[]
The alarm that you specify to monitor the health of your application during practice runs. When the outcome alarm goes into an ALARM state, the practice run is ended and the outcome is set to FAILED .
blockedDates string[]

An array of one or more dates that you can specify when AWS does not start practice runs for a resource. Dates are in UTC.

Specify blocked dates in the format YYYY-MM-DD , separated by spaces.

blockedWindows string[]

An array of one or more days and times that you can specify when Route 53 ARC does not start practice runs for a resource. Days and times are in UTC.

Specify blocked windows in the format DAY:HH:MM-DAY:HH:MM , separated by spaces. For example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30 .

blockingAlarms ZonalAutoshiftConfigurationControlCondition[]
An optional alarm that you can specify that blocks practice runs when the alarm is in an ALARM state. When a blocking alarm goes into an ALARM state, it prevents practice runs from being started, and ends practice runs that are in progress.
outcome_alarms This property is required. Sequence[ZonalAutoshiftConfigurationControlCondition]
The alarm that you specify to monitor the health of your application during practice runs. When the outcome alarm goes into an ALARM state, the practice run is ended and the outcome is set to FAILED .
blocked_dates Sequence[str]

An array of one or more dates that you can specify when AWS does not start practice runs for a resource. Dates are in UTC.

Specify blocked dates in the format YYYY-MM-DD , separated by spaces.

blocked_windows Sequence[str]

An array of one or more days and times that you can specify when Route 53 ARC does not start practice runs for a resource. Days and times are in UTC.

Specify blocked windows in the format DAY:HH:MM-DAY:HH:MM , separated by spaces. For example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30 .

blocking_alarms Sequence[ZonalAutoshiftConfigurationControlCondition]
An optional alarm that you can specify that blocks practice runs when the alarm is in an ALARM state. When a blocking alarm goes into an ALARM state, it prevents practice runs from being started, and ends practice runs that are in progress.
outcomeAlarms This property is required. List<Property Map>
The alarm that you specify to monitor the health of your application during practice runs. When the outcome alarm goes into an ALARM state, the practice run is ended and the outcome is set to FAILED .
blockedDates List<String>

An array of one or more dates that you can specify when AWS does not start practice runs for a resource. Dates are in UTC.

Specify blocked dates in the format YYYY-MM-DD , separated by spaces.

blockedWindows List<String>

An array of one or more days and times that you can specify when Route 53 ARC does not start practice runs for a resource. Days and times are in UTC.

Specify blocked windows in the format DAY:HH:MM-DAY:HH:MM , separated by spaces. For example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30 .

blockingAlarms List<Property Map>
An optional alarm that you can specify that blocks practice runs when the alarm is in an ALARM state. When a blocking alarm goes into an ALARM state, it prevents practice runs from being started, and ends practice runs that are in progress.

ZonalAutoshiftConfigurationZonalAutoshiftStatus

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native