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

Class DeploymentGroupInfo

java.lang.Object
software.amazon.awssdk.services.codedeploy.model.DeploymentGroupInfo
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DeploymentGroupInfo.Builder,DeploymentGroupInfo>
@Generated("software.amazon.awssdk:codegen") public final class DeploymentGroupInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DeploymentGroupInfo.Builder,DeploymentGroupInfo>

Information about a deployment group.

See Also:

  • Method Details

    • 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 Amazon Web Services services on your behalf. For more information, see Create a Service Role for CodeDeploy in the CodeDeploy User Guide.

      Returns:
      A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to Amazon Web Services services on your behalf. For more information, see Create a Service Role for CodeDeploy in the 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 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 return OutdatedInstancesStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outdatedInstancesStrategyAsString().

      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

      public final String 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 return OutdatedInstancesStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outdatedInstancesStrategyAsString().

      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:

    • 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 Amazon EC2 instance. The deployment group includes only Amazon 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 Amazon EC2 instance. The deployment group includes only Amazon 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:

    • 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:

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

    • terminationHookEnabled

      public final Boolean terminationHookEnabled()

      Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.

      For more information about the termination hook, see How Amazon EC2 Auto Scaling works with CodeDeploy in the CodeDeploy User Guide.

      Returns:
      Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.

      For more information about the termination hook, see How Amazon EC2 Auto Scaling works with CodeDeploy in the CodeDeploy User Guide.

    • toBuilder

      public DeploymentGroupInfo.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<DeploymentGroupInfo.Builder,DeploymentGroupInfo>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.