software.amazon.awssdk.services.codedeploy.model

Class CreateDeploymentGroupRequest

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.CreateDeploymentGroupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDeploymentGroupRequest.Builder,CreateDeploymentGroupRequest>

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

Represents the input of a CreateDeploymentGroup operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDeploymentGroupRequest.Builder

Method Summary

Modifier and Type	Method and Description
AlarmConfiguration	alarmConfiguration() Information to add about Amazon CloudWatch alarms when the deployment group is created.
String	applicationName() The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
AutoRollbackConfiguration	autoRollbackConfiguration() Configuration information for an automatic rollback that is added when a deployment group is created.
List<String>	autoScalingGroups() A list of associated Amazon EC2 Auto Scaling groups.
BlueGreenDeploymentConfiguration	blueGreenDeploymentConfiguration() Information about blue/green deployment options for a deployment group.
static CreateDeploymentGroupRequest.Builder	builder()
String	deploymentConfigName() If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.
String	deploymentGroupName() The name of a new deployment group for the specified application.
DeploymentStyle	deploymentStyle() Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.
List<EC2TagFilter>	ec2TagFilters() The Amazon EC2 tags on which to filter.
EC2TagSet	ec2TagSet() Information about groups of tags applied to EC2 instances.
List<ECSService>	ecsServices() The target Amazon ECS services in the deployment group.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAutoScalingGroups() For responses, this returns true if the service returned a value for the AutoScalingGroups property.
boolean	hasEc2TagFilters() For responses, this returns true if the service returned a value for the Ec2TagFilters property.
boolean	hasEcsServices() For responses, this returns true if the service returned a value for the EcsServices property.
int	hashCode()
boolean	hasOnPremisesInstanceTagFilters() For responses, this returns true if the service returned a value for the OnPremisesInstanceTagFilters property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
boolean	hasTriggerConfigurations() For responses, this returns true if the service returned a value for the TriggerConfigurations property.
LoadBalancerInfo	loadBalancerInfo() Information about the load balancer used in a deployment.
List<TagFilter>	onPremisesInstanceTagFilters() The on-premises instance tags on which to filter.
OnPremisesTagSet	onPremisesTagSet() Information about groups of tags applied to on-premises instances.
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 CreateDeploymentGroupRequest.Builder>	serializableBuilderClass()
String	serviceRoleArn() A service role Amazon Resource Name (ARN) that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.
List<Tag>	tags() The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them.
CreateDeploymentGroupRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<TriggerConfig>	triggerConfigurations() Information about triggers to create when the deployment group is created.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, 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 name of an AWS CodeDeploy application associated with the IAM user or AWS account.

Returns:

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

deploymentGroupName

public final String deploymentGroupName()

The name of a new deployment group for the specified application.

Returns:

The name of a new deployment group for the specified application.

deploymentConfigName

public final String deploymentConfigName()

If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.

CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or deployment group.

For more information about the predefined deployment configurations in AWS CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the AWS CodeDeploy User Guide.

Returns:

If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.

CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or deployment group.

For more information about the predefined deployment configurations in AWS CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the AWS CodeDeploy User Guide.

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 the isEmpty() 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

public final List<EC2TagFilter> ec2TagFilters()

The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.

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 Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.

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 the isEmpty() 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

public final List<TagFilter> onPremisesInstanceTagFilters()

The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet.

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 on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet.

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 the isEmpty() 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

public final List<String> autoScalingGroups()

A list of associated Amazon EC2 Auto Scaling groups.

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:

A list of associated Amazon EC2 Auto Scaling groups.

serviceRoleArn

public final String serviceRoleArn()

A service role Amazon Resource Name (ARN) that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.

Returns:

A service role Amazon Resource Name (ARN) that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.

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 the isEmpty() 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

public final List<TriggerConfig> triggerConfigurations()

Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an AWS CodeDeploy Event in the AWS 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 create when the deployment group is created. For examples, see Create a Trigger for an AWS CodeDeploy Event in the AWS CodeDeploy User Guide.

alarmConfiguration

public final AlarmConfiguration alarmConfiguration()

Information to add about Amazon CloudWatch alarms when the deployment group is created.

Returns:

Information to add about Amazon CloudWatch alarms when the deployment group is created.

autoRollbackConfiguration

public final AutoRollbackConfiguration autoRollbackConfiguration()

Configuration information for an automatic rollback that is added when a deployment group is created.

Returns:

Configuration information for an automatic rollback that is added when a deployment group is created.

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, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.

Returns:

Information about the type of deployment, in-place or blue/green, that 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 EC2 instances. The deployment group includes only EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.

Returns:

Information about groups of tags applied to EC2 instances. The deployment group includes only EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters .

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 the isEmpty() 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

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.

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

public final OnPremisesTagSet onPremisesTagSet()

Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all of the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.

Returns:

Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all of the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

tags

public final List<Tag> tags()

The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.

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 hasTags() method.

Returns:

The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.

toBuilder

public CreateDeploymentGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDeploymentGroupRequest.Builder,CreateDeploymentGroupRequest>

Specified by:

toBuilder in class CodeDeployRequest

builder

public static CreateDeploymentGroupRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateDeploymentGroupRequest.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo