Package software.amazon.awscdk.services.arcregionswitch

Interface CfnPlan.AssociatedAlarmProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPlan.AssociatedAlarmProperty.Jsii$Proxy

Enclosing class:

CfnPlan

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

An Amazon CloudWatch alarm associated with a Region switch plan.

These alarms can be used to trigger automatic execution of the 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.*;
 AssociatedAlarmProperty associatedAlarmProperty = AssociatedAlarmProperty.builder()
         .alarmType("alarmType")
         .resourceIdentifier("resourceIdentifier")
         // the properties below are optional
         .crossAccountRole("crossAccountRole")
         .externalId("externalId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPlan.AssociatedAlarmProperty.Builder	builder()
String	getAlarmType()	The alarm type for an associated alarm.
default String	getCrossAccountRole()	The cross account role for the configuration.
default String	getExternalId()	The external ID (secret key) for the configuration.
String	getResourceIdentifier()	The resource identifier for alarms that you associate with a plan.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlarmType

@Stability(Stable)
@NotNull
String getAlarmType()

The alarm type for an associated alarm.

An associated CloudWatch alarm can be an application health alarm or a trigger alarm.

See Also:

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

getResourceIdentifier

@Stability(Stable)
@NotNull
String getResourceIdentifier()

The resource identifier for alarms that you associate with a plan.

See Also:

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

getCrossAccountRole

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

The cross account role for the configuration.

See Also:

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

getExternalId

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

The external ID (secret key) for the configuration.

See Also:

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

builder

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

Returns:

a CfnPlan.AssociatedAlarmProperty.Builder of CfnPlan.AssociatedAlarmProperty