Package software.amazon.awscdk.services.arcregionswitch

Interface CfnPlan.TriggerProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPlan.TriggerProperty.Jsii$Proxy

Enclosing class:

CfnPlan

@Stability(Stable)
public static interface CfnPlan.TriggerProperty
extends software.amazon.jsii.JsiiSerializable

Defines a condition that can automatically trigger the execution of a Region switch plan.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.arcregionswitch.*;
 TriggerProperty triggerProperty = TriggerProperty.builder()
         .action("action")
         .conditions(List.of(TriggerConditionProperty.builder()
                 .associatedAlarmName("associatedAlarmName")
                 .condition("condition")
                 .build()))
         .minDelayMinutesBetweenExecutions(123)
         .targetRegion("targetRegion")
         // the properties below are optional
         .description("description")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-trigger.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPlan.TriggerProperty.Builder	A builder for CfnPlan.TriggerProperty
static final class	CfnPlan.TriggerProperty.Jsii$Proxy	An implementation for CfnPlan.TriggerProperty

Method Summary

Modifier and Type	Method	Description
static CfnPlan.TriggerProperty.Builder	builder()
String	getAction()	The action to perform when the trigger fires.
Object	getConditions()	The conditions that must be met for the trigger to fire.
default String	getDescription()	The description for a trigger.
Number	getMinDelayMinutesBetweenExecutions()	The minimum time, in minutes, that must elapse between automatic executions of the plan.
String	getTargetRegion()	The AWS Region for a trigger.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAction

@Stability(Stable)
@NotNull
String getAction()

The action to perform when the trigger fires.

Valid values include ACTIVATE and DEACTIVATE.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-trigger.html#cfn-arcregionswitch-plan-trigger-action

getConditions

@Stability(Stable)
@NotNull
Object getConditions()

The conditions that must be met for the trigger to fire.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-trigger.html#cfn-arcregionswitch-plan-trigger-conditions

getMinDelayMinutesBetweenExecutions

@Stability(Stable)
@NotNull
Number getMinDelayMinutesBetweenExecutions()

The minimum time, in minutes, that must elapse between automatic executions of the plan.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-trigger.html#cfn-arcregionswitch-plan-trigger-mindelayminutesbetweenexecutions

getTargetRegion

@Stability(Stable)
@NotNull
String getTargetRegion()

The AWS Region for a trigger.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-trigger.html#cfn-arcregionswitch-plan-trigger-targetregion

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description for a trigger.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-trigger.html#cfn-arcregionswitch-plan-trigger-description

builder

@Stability(Stable)
static CfnPlan.TriggerProperty.Builder builder()

Returns:

a CfnPlan.TriggerProperty.Builder of CfnPlan.TriggerProperty