Package software.amazon.awscdk.services.codedeploy

Interface CfnDeploymentGroup.AlarmConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeploymentGroup.AlarmConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDeploymentGroup

@Stability(Stable)
public static interface CfnDeploymentGroup.AlarmConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The AlarmConfiguration property type configures CloudWatch alarms for an AWS CodeDeploy deployment group.

AlarmConfiguration is a property of the DeploymentGroup resource.

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.codedeploy.*;
 AlarmConfigurationProperty alarmConfigurationProperty = AlarmConfigurationProperty.builder()
         .alarms(List.of(AlarmProperty.builder()
                 .name("name")
                 .build()))
         .enabled(false)
         .ignorePollAlarmFailure(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDeploymentGroup.AlarmConfigurationProperty.Builder	builder()
default Object	getAlarms()	A list of alarms configured for the deployment or deployment group.
default Object	getEnabled()	Indicates whether the alarm configuration is enabled.
default Object	getIgnorePollAlarmFailure()	Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlarms

@Stability(Stable)
@Nullable
default Object getAlarms()

A list of alarms configured for the deployment or deployment group.

A maximum of 10 alarms can be added.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html#cfn-codedeploy-deploymentgroup-alarmconfiguration-alarms

getEnabled

@Stability(Stable)
@Nullable
default Object getEnabled()

Indicates whether the alarm configuration is enabled.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html#cfn-codedeploy-deploymentgroup-alarmconfiguration-enabled

getIgnorePollAlarmFailure

@Stability(Stable)
@Nullable
default Object getIgnorePollAlarmFailure()

Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch .

The default value is false .

• true : The deployment proceeds even if alarm status information can't be retrieved from CloudWatch .
• false : The deployment stops if alarm status information can't be retrieved from CloudWatch .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html#cfn-codedeploy-deploymentgroup-alarmconfiguration-ignorepollalarmfailure

builder

@Stability(Stable)
static CfnDeploymentGroup.AlarmConfigurationProperty.Builder builder()

Returns:

a CfnDeploymentGroup.AlarmConfigurationProperty.Builder of CfnDeploymentGroup.AlarmConfigurationProperty