CreateDeploymentGroupRequest (AWS Java SDK :: Services

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateDeploymentGroupRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` 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`	`hasTags()` Returns true if the Tags 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.
`List<TagFilter>`	`onPremisesInstanceTagFilters()` The on-premises instance tags on which to filter.
`OnPremisesTagSet`	`onPremisesTagSet()` Information about groups of tags applied to on-premises instances.
`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 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 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 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 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 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.
    
    You can use hasEc2TagFilters() to see if a value was sent in this field.
    
    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 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 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.
    
    You can use hasOnPremisesInstanceTagFilters() to see if a value was sent in this field.
    
    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 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 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.
    
    You can use hasAutoScalingGroups() to see if a value was sent in this field.
    
    Returns:
    
    A list of associated Amazon EC2 Auto Scaling groups.
  - serviceRoleArn
```
public 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 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 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.
    
    You can use hasTriggerConfigurations() to see if a value was sent in this field.
    
    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.
  - ec2TagSet
```
public 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 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 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 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 boolean hasTags()
```
    Returns true if the Tags 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.
  - tags
```
public 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    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 int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateDeploymentGroupRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

applicationName

deploymentGroupName

deploymentConfigName

hasEc2TagFilters

ec2TagFilters

hasOnPremisesInstanceTagFilters

onPremisesInstanceTagFilters

hasAutoScalingGroups

autoScalingGroups

serviceRoleArn

hasTriggerConfigurations

triggerConfigurations

alarmConfiguration

autoRollbackConfiguration

deploymentStyle

blueGreenDeploymentConfiguration

loadBalancerInfo

ec2TagSet

hasEcsServices

ecsServices

onPremisesTagSet

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields