Package software.amazon.awssdk.services.codedeploy.model

Class CreateDeploymentGroupRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.codedeploy.model.CreateDeploymentGroupRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateDeploymentGroupRequest.Builder,CreateDeploymentGroupRequest>

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

Represents the input of a CreateDeploymentGroup operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateDeploymentGroupRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	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 applicable 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 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.
boolean	equals(Object obj)
int	hashCode()
LoadBalancerInfo	loadBalancerInfo()	Information about the load balancer used in a deployment.
List<TagFilter>	onPremisesInstanceTagFilters()	The on-premises instance tags on which to filter.
static Class<? extends CreateDeploymentGroupRequest.Builder>	serializableBuilderClass()
String	serviceRoleArn()	A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.
CreateDeploymentGroupRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<TriggerConfig>	triggerConfigurations()	Information about triggers to create when the deployment group is created.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

applicationName

public String applicationName()

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

Returns:

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

deploymentGroupName

public 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 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 the deployment group.

For more information about the predefined deployment configurations in AWS CodeDeploy, see Working with Deployment Groups in AWS 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 the deployment group.

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

ec2TagFilters

public List<EC2TagFilter> ec2TagFilters()

The Amazon EC2 tags on which to filter. The deployment group will include EC2 instances with any of the specified tags.

Returns:

The Amazon EC2 tags on which to filter. The deployment group will include EC2 instances with any of the specified tags.

onPremisesInstanceTagFilters

public List<TagFilter> onPremisesInstanceTagFilters()

The on-premises instance tags on which to filter. The deployment group will include on-premises instances with any of the specified tags.

Returns:

The on-premises instance tags on which to filter. The deployment group will include on-premises instances with any of the specified tags.

autoScalingGroups

public List<String> autoScalingGroups()

A list of associated Auto Scaling groups.

Returns:

A list of associated Auto Scaling groups.

serviceRoleArn

public String serviceRoleArn()

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

Returns:

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

triggerConfigurations

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

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

deploymentStyle

public 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 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 LoadBalancerInfo loadBalancerInfo()

Information about the load balancer used in a deployment.

Returns:

Information about the load balancer used in a deployment.

toBuilder

public CreateDeploymentGroupRequest.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<CreateDeploymentGroupRequest.Builder,CreateDeploymentGroupRequest>

Returns:

a builder for type T

builder

public static CreateDeploymentGroupRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object