Package software.amazon.awscdk.cfnpropertymixins.services.arcregionswitch

Interface CfnPlanPropsMixin.TriggerProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPlanPropsMixin.TriggerProperty.Jsii$Proxy

Enclosing class:

CfnPlanPropsMixin

@Stability(Stable)
public static interface CfnPlanPropsMixin.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.cfnpropertymixins.services.arcregionswitch.*;
 TriggerProperty triggerProperty = TriggerProperty.builder()
         .action("action")
         .conditions(List.of(TriggerConditionProperty.builder()
                 .associatedAlarmName("associatedAlarmName")
                 .condition("condition")
                 .build()))
         .description("description")
         .minDelayMinutesBetweenExecutions(123)
         .targetRegion("targetRegion")
         .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	CfnPlanPropsMixin.TriggerProperty.Builder	A builder for CfnPlanPropsMixin.TriggerProperty
static final class	CfnPlanPropsMixin.TriggerProperty.Jsii$Proxy	An implementation for CfnPlanPropsMixin.TriggerProperty

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAction

@Stability(Stable)
@Nullable
default 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)
@Nullable
default Object getConditions()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPlanPropsMixin.TriggerConditionProperty>

See Also:

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

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

getMinDelayMinutesBetweenExecutions

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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

builder

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

Returns:

a CfnPlanPropsMixin.TriggerProperty.Builder of CfnPlanPropsMixin.TriggerProperty