Class UpdateDeploymentGroupRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateDeploymentGroupRequest.Builder,
UpdateDeploymentGroupRequest>
Represents the input of an UpdateDeploymentGroup
operation.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AlarmConfiguration
Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.final String
The application name that corresponds to the deployment group to update.Information for an automatic rollback configuration that is added or changed when a deployment group is updated.The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.Information about blue/green deployment options for a deployment group.builder()
final String
The current name of the deployment group.final String
The replacement deployment configuration name to use, if you want to change it.final 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.final List
<EC2TagFilter> The replacement set of Amazon EC2 tags on which to filter, if you want to change them.final EC2TagSet
Information about groups of tags applied to on-premises instances.final List
<ECSService> The target Amazon ECS services in the deployment group.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AutoScalingGroups property.final boolean
For responses, this returns true if the service returned a value for the Ec2TagFilters property.final boolean
For responses, this returns true if the service returned a value for the EcsServices property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the OnPremisesInstanceTagFilters property.final boolean
For responses, this returns true if the service returned a value for the TriggerConfigurations property.final LoadBalancerInfo
Information about the load balancer used in a deployment.final String
The new name of the deployment group, if you want to change it.The replacement set of on-premises instance tags on which to filter, if you want to change them.final OnPremisesTagSet
Information about an on-premises instance tag set.Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.final String
Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.static Class
<? extends UpdateDeploymentGroupRequest.Builder> final String
A replacement ARN for the service role, if you want to change it.final Boolean
This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final List
<TriggerConfig> Information about triggers to change when the deployment group is updated.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The current name of the deployment group.
- Returns:
- The current name of the deployment group.
-
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
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()For responses, this returns true if the service returned a value for the Ec2TagFilters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasEc2TagFilters()
method.- 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()For responses, this returns true if the service returned a value for the OnPremisesInstanceTagFilters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasOnPremisesInstanceTagFilters()
method.- 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()For responses, this returns true if the service returned a value for the AutoScalingGroups property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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 or do not specify this parameter.
-
To remove Auto Scaling groups, specify a non-null empty list of Auto Scaling group names to detach all CodeDeploy-managed Auto Scaling lifecycle hooks. For examples, see Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to launch and receive the error "Heartbeat Timeout" in the CodeDeploy User Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAutoScalingGroups()
method.- 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 or do not specify this parameter.
-
To remove Auto Scaling groups, specify a non-null empty list of Auto Scaling group names to detach all CodeDeploy-managed Auto Scaling lifecycle hooks. For examples, see Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to launch and receive the error "Heartbeat Timeout" in the CodeDeploy User Guide.
-
-
-
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()For responses, this returns true if the service returned a value for the TriggerConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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 CodeDeploy User Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTriggerConfigurations()
method.- 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 CodeDeploy User Guide.
-
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
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
Indicates what happens when new Amazon 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 Amazon EC2 instances.If this option is set to
IGNORE
, CodeDeploy does not initiate a deployment to update the new Amazon 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 returnOutdatedInstancesStrategy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutdatedInstancesStrategyAsString()
.- Returns:
- Indicates what happens when new Amazon 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 Amazon EC2 instances.If this option is set to
IGNORE
, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions. - See Also:
-
outdatedInstancesStrategyAsString
Indicates what happens when new Amazon 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 Amazon EC2 instances.If this option is set to
IGNORE
, CodeDeploy does not initiate a deployment to update the new Amazon 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 returnOutdatedInstancesStrategy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutdatedInstancesStrategyAsString()
.- Returns:
- Indicates what happens when new Amazon 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 Amazon EC2 instances.If this option is set to
IGNORE
, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions. - See Also:
-
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
Information about blue/green deployment options for a deployment group.
- Returns:
- Information about blue/green deployment options for a deployment group.
-
loadBalancerInfo
Information about the load balancer used in a deployment.
- Returns:
- Information about the load balancer used in a deployment.
-
ec2TagSet
Information about groups of tags applied to on-premises instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups.
- Returns:
- Information about groups of tags applied to on-premises instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups.
-
hasEcsServices
public final boolean hasEcsServices()For responses, this returns true if the service returned a value for the EcsServices property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasEcsServices()
method.- 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
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.
-
terminationHookEnabled
This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.
Set
terminationHookEnabled
totrue
to have CodeDeploy install a termination hook into your Auto Scaling group when you update a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.
For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.
- Returns:
- This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more
information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.
Set
terminationHookEnabled
totrue
to have CodeDeploy install a termination hook into your Auto Scaling group when you update a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.
For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.
-
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 interfaceToCopyableBuilder<UpdateDeploymentGroupRequest.Builder,
UpdateDeploymentGroupRequest> - Specified by:
toBuilder
in classCodeDeployRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-