Package software.amazon.awscdk.services.codedeploy

Class LambdaDeploymentGroupProps.Builder

java.lang.Object

software.amazon.awscdk.services.codedeploy.LambdaDeploymentGroupProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LambdaDeploymentGroupProps>

Enclosing interface:

LambdaDeploymentGroupProps

@Stability(Stable)
public static final class LambdaDeploymentGroupProps.Builder
extends Object
implements software.amazon.jsii.Builder<LambdaDeploymentGroupProps>

A builder for LambdaDeploymentGroupProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
LambdaDeploymentGroupProps.Builder	alarms(List<? extends IAlarm> alarms)	Sets the value of LambdaDeploymentGroupProps.getAlarms()
LambdaDeploymentGroupProps.Builder	alias(Alias alias)	Sets the value of LambdaDeploymentGroupProps.getAlias()
LambdaDeploymentGroupProps.Builder	application(ILambdaApplication application)	Sets the value of LambdaDeploymentGroupProps.getApplication()
LambdaDeploymentGroupProps.Builder	autoRollback(AutoRollbackConfig autoRollback)	Sets the value of LambdaDeploymentGroupProps.getAutoRollback()
LambdaDeploymentGroupProps	build()	Builds the configured instance.
LambdaDeploymentGroupProps.Builder	deploymentConfig(ILambdaDeploymentConfig deploymentConfig)	Sets the value of LambdaDeploymentGroupProps.getDeploymentConfig()
LambdaDeploymentGroupProps.Builder	deploymentGroupName(String deploymentGroupName)	Sets the value of LambdaDeploymentGroupProps.getDeploymentGroupName()
LambdaDeploymentGroupProps.Builder	ignoreAlarmConfiguration(Boolean ignoreAlarmConfiguration)	Sets the value of LambdaDeploymentGroupProps.getIgnoreAlarmConfiguration()
LambdaDeploymentGroupProps.Builder	ignorePollAlarmsFailure(Boolean ignorePollAlarmsFailure)	Sets the value of LambdaDeploymentGroupProps.getIgnorePollAlarmsFailure()
LambdaDeploymentGroupProps.Builder	postHook(IFunction postHook)	Sets the value of LambdaDeploymentGroupProps.getPostHook()
LambdaDeploymentGroupProps.Builder	preHook(IFunction preHook)	Sets the value of LambdaDeploymentGroupProps.getPreHook()
LambdaDeploymentGroupProps.Builder	role(IRole role)	Sets the value of LambdaDeploymentGroupProps.getRole()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

alias

@Stability(Stable)
public LambdaDeploymentGroupProps.Builder alias(Alias alias)

Sets the value of LambdaDeploymentGroupProps.getAlias()

Parameters:

alias - Lambda Alias to shift traffic. Updating the version of the alias will trigger a CodeDeploy deployment. This parameter is required. [disable-awslint:ref-via-interface] since we need to modify the alias CFN resource update policy

Returns:

this

alarms

@Stability(Stable)
public LambdaDeploymentGroupProps.Builder alarms(List<? extends IAlarm> alarms)

Sets the value of LambdaDeploymentGroupProps.getAlarms()

Parameters:

alarms - The CloudWatch alarms associated with this Deployment Group. CodeDeploy will stop (and optionally roll back) a deployment if during it any of the alarms trigger.

Alarms can also be added after the Deployment Group is created using the #addAlarm method.

Returns:

this

application

@Stability(Stable)
public LambdaDeploymentGroupProps.Builder application(ILambdaApplication application)

Sets the value of LambdaDeploymentGroupProps.getApplication()

Parameters:

application - The reference to the CodeDeploy Lambda Application that this Deployment Group belongs to.

Returns:

this

autoRollback

@Stability(Stable)
public LambdaDeploymentGroupProps.Builder autoRollback(AutoRollbackConfig autoRollback)

Sets the value of LambdaDeploymentGroupProps.getAutoRollback()

Parameters:

autoRollback - The auto-rollback configuration for this Deployment Group.

Returns:

this

deploymentConfig

@Stability(Stable)
public LambdaDeploymentGroupProps.Builder deploymentConfig(ILambdaDeploymentConfig deploymentConfig)

Sets the value of LambdaDeploymentGroupProps.getDeploymentConfig()

Parameters:

deploymentConfig - The Deployment Configuration this Deployment Group uses.

Returns:

this

deploymentGroupName

@Stability(Stable)
public LambdaDeploymentGroupProps.Builder deploymentGroupName(String deploymentGroupName)

Sets the value of LambdaDeploymentGroupProps.getDeploymentGroupName()

Parameters:

deploymentGroupName - The physical, human-readable name of the CodeDeploy Deployment Group.

Returns:

this

ignoreAlarmConfiguration

@Stability(Stable)
public LambdaDeploymentGroupProps.Builder ignoreAlarmConfiguration(Boolean ignoreAlarmConfiguration)

Sets the value of LambdaDeploymentGroupProps.getIgnoreAlarmConfiguration()

Parameters:

ignoreAlarmConfiguration - Whether to skip the step of checking CloudWatch alarms during the deployment process.

Returns:

this

ignorePollAlarmsFailure

@Stability(Stable)
public LambdaDeploymentGroupProps.Builder ignorePollAlarmsFailure(Boolean ignorePollAlarmsFailure)

Sets the value of LambdaDeploymentGroupProps.getIgnorePollAlarmsFailure()

Parameters:

ignorePollAlarmsFailure - Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.

Returns:

this

postHook

@Stability(Stable)
public LambdaDeploymentGroupProps.Builder postHook(IFunction postHook)

Sets the value of LambdaDeploymentGroupProps.getPostHook()

Parameters:

postHook - The Lambda function to run after traffic routing starts.

Returns:

this

preHook

@Stability(Stable)
public LambdaDeploymentGroupProps.Builder preHook(IFunction preHook)

Sets the value of LambdaDeploymentGroupProps.getPreHook()

Parameters:

preHook - The Lambda function to run before traffic routing starts.

Returns:

this

role

@Stability(Stable)
public LambdaDeploymentGroupProps.Builder role(IRole role)

Sets the value of LambdaDeploymentGroupProps.getRole()

Parameters:

role - The service Role of this Deployment Group.

Returns:

this

build

@Stability(Stable)
public LambdaDeploymentGroupProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<LambdaDeploymentGroupProps>

Returns:

a new instance of LambdaDeploymentGroupProps

Throws:

NullPointerException - if any required attribute was not provided