software.amazon.awssdk.services.codedeploy.model

Class UpdateDeploymentGroupRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codedeploy.model.CodeDeployRequest

software.amazon.awssdk.services.codedeploy.model.UpdateDeploymentGroupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateDeploymentGroupRequest.Builder,UpdateDeploymentGroupRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateDeploymentGroupRequest
extends CodeDeployRequest
implements ToCopyableBuilder<UpdateDeploymentGroupRequest.Builder,UpdateDeploymentGroupRequest>

Represents the input of an UpdateDeploymentGroup operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateDeploymentGroupRequest.Builder

Method Summary

Modifier and Type	Method and Description
AlarmConfiguration	alarmConfiguration() Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.
String	applicationName() The application name that corresponds to the deployment group to update.
AutoRollbackConfiguration	autoRollbackConfiguration() Information for an automatic rollback configuration that is added or changed when a deployment group is updated.
List<String>	autoScalingGroups() The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.
BlueGreenDeploymentConfiguration	blueGreenDeploymentConfiguration() Information about blue/green deployment options for a deployment group.
static UpdateDeploymentGroupRequest.Builder	builder()
String	currentDeploymentGroupName() The current name of the deployment group.
String	deploymentConfigName() The replacement deployment configuration name to use, if you want to change it.
DeploymentStyle	deploymentStyle() Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.
List<EC2TagFilter>	ec2TagFilters() The replacement set of Amazon EC2 tags on which to filter, if you want to change them.
EC2TagSet	ec2TagSet() Information about groups of tags applied to on-premises instances.
List<ECSService>	ecsServices() The target Amazon ECS services in the deployment group.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
boolean	hasAutoScalingGroups() Returns true if the AutoScalingGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasEc2TagFilters() Returns true if the Ec2TagFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasEcsServices() Returns true if the EcsServices property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasOnPremisesInstanceTagFilters() Returns true if the OnPremisesInstanceTagFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTriggerConfigurations() Returns true if the TriggerConfigurations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
LoadBalancerInfo	loadBalancerInfo() Information about the load balancer used in a deployment.
String	newDeploymentGroupName() The new name of the deployment group, if you want to change it.
List<TagFilter>	onPremisesInstanceTagFilters() The replacement set of on-premises instance tags on which to filter, if you want to change them.
OnPremisesTagSet	onPremisesTagSet() Information about an on-premises instance tag set.
OutdatedInstancesStrategy	outdatedInstancesStrategy() Indicates what happens when new EC2 instances are launched mid-deployment and do not receive the deployed application revision.
String	outdatedInstancesStrategyAsString() Indicates what happens when new EC2 instances are launched mid-deployment and do not receive the deployed application revision.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateDeploymentGroupRequest.Builder>	serializableBuilderClass()
String	serviceRoleArn() A replacement ARN for the service role, if you want to change it.
UpdateDeploymentGroupRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
List<TriggerConfig>	triggerConfigurations() Information about triggers to change when the deployment group is updated.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

applicationName

public final String applicationName()

The application name that corresponds to the deployment group to update.

Returns:

The application name that corresponds to the deployment group to update.

currentDeploymentGroupName

public final String currentDeploymentGroupName()

The current name of the deployment group.

Returns:

The current name of the deployment group.

newDeploymentGroupName

public final String newDeploymentGroupName()

The new name of the deployment group, if you want to change it.

Returns:

The new name of the deployment group, if you want to change it.

deploymentConfigName

public final String deploymentConfigName()

The replacement deployment configuration name to use, if you want to change it.

Returns:

The replacement deployment configuration name to use, if you want to change it.

hasEc2TagFilters

public final boolean hasEc2TagFilters()

Returns true if the Ec2TagFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

ec2TagFilters

public final List<EC2TagFilter> ec2TagFilters()

The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasEc2TagFilters() to see if a value was sent in this field.

Returns:

The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

hasOnPremisesInstanceTagFilters

public final boolean hasOnPremisesInstanceTagFilters()

Returns true if the OnPremisesInstanceTagFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

onPremisesInstanceTagFilters

public final List<TagFilter> onPremisesInstanceTagFilters()

The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasOnPremisesInstanceTagFilters() to see if a value was sent in this field.

Returns:

The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

hasAutoScalingGroups

public final boolean hasAutoScalingGroups()

Returns true if the AutoScalingGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

autoScalingGroups

public final List<String> autoScalingGroups()

The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them. To keep the Auto Scaling groups, enter their names. To remove Auto Scaling groups, do not enter any Auto Scaling group names.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAutoScalingGroups() to see if a value was sent in this field.

Returns:

The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them. To keep the Auto Scaling groups, enter their names. To remove Auto Scaling groups, do not enter any Auto Scaling group names.

serviceRoleArn

public final String serviceRoleArn()

A replacement ARN for the service role, if you want to change it.

Returns:

A replacement ARN for the service role, if you want to change it.

hasTriggerConfigurations

public final boolean hasTriggerConfigurations()

Returns true if the TriggerConfigurations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

triggerConfigurations

public final List<TriggerConfig> triggerConfigurations()

Information about triggers to change when the deployment group is updated. For examples, see Edit a Trigger in a CodeDeploy Deployment Group in the AWS CodeDeploy User Guide.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTriggerConfigurations() to see if a value was sent in this field.

Returns:

Information about triggers to change when the deployment group is updated. For examples, see Edit a Trigger in a CodeDeploy Deployment Group in the AWS CodeDeploy User Guide.

alarmConfiguration

public final AlarmConfiguration alarmConfiguration()

Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.

Returns:

Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.

autoRollbackConfiguration

public final AutoRollbackConfiguration autoRollbackConfiguration()

Information for an automatic rollback configuration that is added or changed when a deployment group is updated.

Returns:

Information for an automatic rollback configuration that is added or changed when a deployment group is updated.

outdatedInstancesStrategy

public final OutdatedInstancesStrategy outdatedInstancesStrategy()

Indicates what happens when new EC2 instances are launched mid-deployment and do not receive the deployed application revision.

If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new EC2 instances. This may result in instances having different revisions.

If the service returns an enum value that is not available in the current SDK version, outdatedInstancesStrategy will return OutdatedInstancesStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outdatedInstancesStrategyAsString().

Returns:

Indicates what happens when new EC2 instances are launched mid-deployment and do not receive the deployed application revision.

If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new EC2 instances. This may result in instances having different revisions.

See Also:

OutdatedInstancesStrategy

outdatedInstancesStrategyAsString

public final String outdatedInstancesStrategyAsString()

Indicates what happens when new EC2 instances are launched mid-deployment and do not receive the deployed application revision.

If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new EC2 instances. This may result in instances having different revisions.

If the service returns an enum value that is not available in the current SDK version, outdatedInstancesStrategy will return OutdatedInstancesStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outdatedInstancesStrategyAsString().

Returns:

Indicates what happens when new EC2 instances are launched mid-deployment and do not receive the deployed application revision.

If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new EC2 instances. This may result in instances having different revisions.

See Also:

OutdatedInstancesStrategy

deploymentStyle

public final DeploymentStyle deploymentStyle()

Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

Returns:

Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

blueGreenDeploymentConfiguration

public final BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration()

Information about blue/green deployment options for a deployment group.

Returns:

Information about blue/green deployment options for a deployment group.

loadBalancerInfo

public final LoadBalancerInfo loadBalancerInfo()

Information about the load balancer used in a deployment.

Returns:

Information about the load balancer used in a deployment.

ec2TagSet

public final EC2TagSet ec2TagSet()

Information about groups of tags applied to on-premises instances. The deployment group includes only EC2 instances identified by all the tag groups.

Returns:

Information about groups of tags applied to on-premises instances. The deployment group includes only EC2 instances identified by all the tag groups.

hasEcsServices

public final boolean hasEcsServices()

Returns true if the EcsServices property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

ecsServices

public final List<ECSService> ecsServices()

The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasEcsServices() to see if a value was sent in this field.

Returns:

The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>.

onPremisesTagSet

public final OnPremisesTagSet onPremisesTagSet()

Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.

Returns:

Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.

toBuilder

public UpdateDeploymentGroupRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateDeploymentGroupRequest.Builder,UpdateDeploymentGroupRequest>

Specified by:

toBuilder in class CodeDeployRequest

Returns:

a builder for type T

builder

public static UpdateDeploymentGroupRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateDeploymentGroupRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.