DeploymentGroupInfo (AWS Java SDK :: Services :: AWS CodeDeploy 2.17.89 API)

java.lang.Object
- software.amazon.awssdk.services.codedeploy.model.DeploymentGroupInfo

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<DeploymentGroupInfo.Builder,DeploymentGroupInfo>

@Generated(value="software.amazon.awssdk:codegen")
public final class DeploymentGroupInfo
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DeploymentGroupInfo.Builder,DeploymentGroupInfo>

Information about a deployment group.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DeploymentGroupInfo.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AlarmConfiguration`	`alarmConfiguration()` A list of alarms associated with the deployment group.
`String`	`applicationName()` The application name.
`AutoRollbackConfiguration`	`autoRollbackConfiguration()` Information about the automatic rollback configuration associated with the deployment group.
`List<AutoScalingGroup>`	`autoScalingGroups()` A list of associated Auto Scaling groups.
`BlueGreenDeploymentConfiguration`	`blueGreenDeploymentConfiguration()` Information about blue/green deployment options for a deployment group.
`static DeploymentGroupInfo.Builder`	`builder()`
`ComputePlatform`	`computePlatform()` The destination platform type for the deployment (`Lambda`, `Server`, or `ECS`).
`String`	`computePlatformAsString()` The destination platform type for the deployment (`Lambda`, `Server`, or `ECS`).
`String`	`deploymentConfigName()` The deployment configuration name.
`String`	`deploymentGroupId()` The deployment group ID.
`String`	`deploymentGroupName()` The deployment group name.
`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 Amazon EC2 tags on which to filter.
`EC2TagSet`	`ec2TagSet()` Information about groups of tags applied to an EC2 instance.
`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`	`hasTriggerConfigurations()` For responses, this returns true if the service returned a value for the TriggerConfigurations property.
`LastDeploymentInfo`	`lastAttemptedDeployment()` Information about the most recent attempted deployment to the deployment group.
`LastDeploymentInfo`	`lastSuccessfulDeployment()` Information about the most recent successful deployment to the deployment group.
`LoadBalancerInfo`	`loadBalancerInfo()` Information about the load balancer to use in a deployment.
`List<TagFilter>`	`onPremisesInstanceTagFilters()` The on-premises instance tags on which to filter.
`OnPremisesTagSet`	`onPremisesTagSet()` Information about groups of tags applied to an on-premises instance.
`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 DeploymentGroupInfo.Builder>`	`serializableBuilderClass()`
`String`	`serviceRoleArn()` A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf.
`RevisionLocation`	`targetRevision()` Information about the deployment group's target revision, including type and location.
`DeploymentGroupInfo.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<TriggerConfig>`	`triggerConfigurations()` Information about triggers associated with the deployment group.

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 application name.
    
    Returns:
    
    The application name.
  - deploymentGroupId
```
public final String deploymentGroupId()
```
    The deployment group ID.
    
    Returns:
    
    The deployment group ID.
  - deploymentGroupName
```
public final String deploymentGroupName()
```
    The deployment group name.
    
    Returns:
    
    The deployment group name.
  - deploymentConfigName
```
public final String deploymentConfigName()
```
    The deployment configuration name.
    
    Returns:
    
    The deployment configuration name.
  - 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.
    
    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.
  - 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.
    
    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.
  - 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<AutoScalingGroup> autoScalingGroups()
```
    A list of associated 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 Auto Scaling groups.
  - serviceRoleArn
```
public final String serviceRoleArn()
```
    A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf. For more information, see Create a Service Role for AWS CodeDeploy in the AWS CodeDeploy User Guide.
    
    Returns:
    
    A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf. For more information, see Create a Service Role for AWS CodeDeploy in the AWS CodeDeploy User Guide.
  - targetRevision
```
public final RevisionLocation targetRevision()
```
    Information about the deployment group's target revision, including type and location.
    
    Returns:
    
    Information about the deployment group's target revision, including type and location.
  - 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 associated with the deployment group.
    
    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 associated with the deployment group.
  - alarmConfiguration
```
public final AlarmConfiguration alarmConfiguration()
```
    A list of alarms associated with the deployment group.
    
    Returns:
    
    A list of alarms associated with the deployment group.
  - autoRollbackConfiguration
```
public final AutoRollbackConfiguration autoRollbackConfiguration()
```
    Information about the automatic rollback configuration associated with the deployment group.
    
    Returns:
    
    Information about the automatic rollback configuration associated with the deployment group.
  - 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.
  - 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
  - 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 to use in a deployment.
    
    Returns:
    
    Information about the load balancer to use in a deployment.
  - lastSuccessfulDeployment
```
public final LastDeploymentInfo lastSuccessfulDeployment()
```
    Information about the most recent successful deployment to the deployment group.
    
    Returns:
    
    Information about the most recent successful deployment to the deployment group.
  - lastAttemptedDeployment
```
public final LastDeploymentInfo lastAttemptedDeployment()
```
    Information about the most recent attempted deployment to the deployment group.
    
    Returns:
    
    Information about the most recent attempted deployment to the deployment group.
  - ec2TagSet
```
public final EC2TagSet ec2TagSet()
```
    Information about groups of tags applied to an EC2 instance. The deployment group includes only EC2 instances identified by all of the tag groups. Cannot be used in the same call as ec2TagFilters.
    
    Returns:
    
    Information about groups of tags applied to an EC2 instance. The deployment group includes only EC2 instances identified by all of the tag groups. Cannot be used in the same call as ec2TagFilters.
  - onPremisesTagSet
```
public final OnPremisesTagSet onPremisesTagSet()
```
    Information about groups of tags applied to an on-premises instance. The deployment group includes only on-premises instances identified by all the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.
    
    Returns:
    
    Information about groups of tags applied to an on-premises instance. The deployment group includes only on-premises instances identified by all the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.
  - computePlatform
```
public final ComputePlatform computePlatform()
```
    The destination platform type for the deployment (Lambda, Server, or ECS).
    
    If the service returns an enum value that is not available in the current SDK version, computePlatform will return ComputePlatform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computePlatformAsString().
    
    Returns:
    
    The destination platform type for the deployment (Lambda, Server, or ECS).
    
    See Also:
    
    ComputePlatform
  - computePlatformAsString
```
public final String computePlatformAsString()
```
    The destination platform type for the deployment (Lambda, Server, or ECS).
    
    If the service returns an enum value that is not available in the current SDK version, computePlatform will return ComputePlatform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computePlatformAsString().
    
    Returns:
    
    The destination platform type for the deployment (Lambda, Server, or ECS).
    
    See Also:
    
    ComputePlatform
  - 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>.
  - toBuilder
```
public DeploymentGroupInfo.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DeploymentGroupInfo.Builder,DeploymentGroupInfo>
  - builder
```
public static DeploymentGroupInfo.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DeploymentGroupInfo.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DeploymentGroupInfo

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

applicationName

deploymentGroupId

deploymentGroupName

deploymentConfigName

hasEc2TagFilters

ec2TagFilters

hasOnPremisesInstanceTagFilters

onPremisesInstanceTagFilters

hasAutoScalingGroups

autoScalingGroups

serviceRoleArn

targetRevision

hasTriggerConfigurations

triggerConfigurations

alarmConfiguration

autoRollbackConfiguration

deploymentStyle

outdatedInstancesStrategy

outdatedInstancesStrategyAsString

blueGreenDeploymentConfiguration

loadBalancerInfo

lastSuccessfulDeployment

lastAttemptedDeployment

ec2TagSet

onPremisesTagSet

computePlatform

computePlatformAsString

hasEcsServices

ecsServices

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields