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

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.arczonalshift.ZonalAutoshiftConfiguration

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::ARCZonalShift::ZonalAutoshiftConfiguration Resource Type

    Create ZonalAutoshiftConfiguration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ZonalAutoshiftConfiguration(name: string, args?: ZonalAutoshiftConfigurationArgs, opts?: CustomResourceOptions);
    @overload
def ZonalAutoshiftConfiguration(resource_name: str,
                                args: Optional[ZonalAutoshiftConfigurationArgs] = None,
                                opts: Optional[ResourceOptions] = None)

@overload
def ZonalAutoshiftConfiguration(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                practice_run_configuration: Optional[ZonalAutoshiftConfigurationPracticeRunConfigurationArgs] = None,
                                resource_identifier: Optional[str] = None,
                                zonal_autoshift_status: Optional[ZonalAutoshiftConfigurationZonalAutoshiftStatus] = None)
    func NewZonalAutoshiftConfiguration(ctx *Context, name string, args *ZonalAutoshiftConfigurationArgs, opts ...ResourceOption) (*ZonalAutoshiftConfiguration, error)
    public ZonalAutoshiftConfiguration(string name, ZonalAutoshiftConfigurationArgs? args = null, CustomResourceOptions? opts = null)
    public ZonalAutoshiftConfiguration(String name, ZonalAutoshiftConfigurationArgs args)
public ZonalAutoshiftConfiguration(String name, ZonalAutoshiftConfigurationArgs args, CustomResourceOptions options)

    type: aws-native:arczonalshift:ZonalAutoshiftConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ZonalAutoshiftConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ZonalAutoshiftConfigurationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ZonalAutoshiftConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ZonalAutoshiftConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ZonalAutoshiftConfigurationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ZonalAutoshiftConfiguration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ZonalAutoshiftConfiguration resource accepts the following input properties:

    PracticeRunConfiguration Pulumi.AwsNative.ArcZonalShift.Inputs.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.

    ResourceIdentifier 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.

    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 ZonalAutoshiftConfigurationPracticeRunConfigurationArgs

    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.

    ResourceIdentifier 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.

    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.

    resourceIdentifier 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.

    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.

    resourceIdentifier 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.

    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 ZonalAutoshiftConfigurationPracticeRunConfigurationArgs

    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.

    resource_identifier 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.

    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.

    resourceIdentifier 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.

    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ZonalAutoshiftConfiguration resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ZonalAutoshiftConfigurationControlCondition, ZonalAutoshiftConfigurationControlConditionArgs

    AlarmIdentifier string
    The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.
    Type 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 string
    The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.
    Type 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 String
    The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.
    type 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 string
    The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.
    type 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 str
    The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.
    type 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 String
    The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.
    type 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, ZonalAutoshiftConfigurationPracticeRunConfigurationArgs

    OutcomeAlarms 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 []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 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 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 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 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, ZonalAutoshiftConfigurationZonalAutoshiftStatusArgs

    Enabled
    ENABLED
    ZonalAutoshiftConfigurationZonalAutoshiftStatusEnabled
    ENABLED
    Enabled
    ENABLED
    Enabled
    ENABLED
    ENABLED
    ENABLED
    "ENABLED"
    ENABLED

    Package Details

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

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

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native