Package 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("software.amazon.awssdk:codegen") public final class CreateDeploymentGroupRequest extends CodeDeployRequest implements ToCopyableBuilder<CreateDeploymentGroupRequest.Builder,CreateDeploymentGroupRequest>

Represents the input of a CreateDeploymentGroup operation.

  • Method Details

    • applicationName

      public final String applicationName()

      The name of an CodeDeploy application associated with the user or Amazon Web Services account.

      Returns:
      The name of an CodeDeploy application associated with the user or Amazon Web Services 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 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 CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the CodeDeploy User Guide.

      Returns:
      If specified, the deployment configuration name can be either one of the predefined configurations provided with 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 CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the 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 Amazon 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 Amazon 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 CodeDeploy to act on the user's behalf when interacting with Amazon Web Services services.

      Returns:
      A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the user's behalf when interacting with Amazon Web Services 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 CodeDeploy Event in the 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 CodeDeploy Event in the 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 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:

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

    • terminationHookEnabled

      public final Boolean terminationHookEnabled()

      This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.

      Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you create a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.

      For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.

      For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.

      Returns:
      This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.

      Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you create a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.

      For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.

      For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.

    • 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>
      Specified by:
      toBuilder in class CodeDeployRequest
      Returns:
      a builder for type T

    • 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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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