Class CreateDeploymentConfigRequest

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.CreateDeploymentConfigRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateDeploymentConfigRequest.Builder,CreateDeploymentConfigRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDeploymentConfigRequest extends CodeDeployRequest implements ToCopyableBuilder<CreateDeploymentConfigRequest.Builder,CreateDeploymentConfigRequest>

Represents the input of a CreateDeploymentConfig operation.

  • Method Details

    • deploymentConfigName

      public final String deploymentConfigName()

      The name of the deployment configuration to create.

      Returns:
      The name of the deployment configuration to create.

    • minimumHealthyHosts

      public final MinimumHealthyHosts minimumHealthyHosts()

      The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.

      The type parameter takes either of the following values:

      • HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.

      • FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, CodeDeploy converts the percentage to the equivalent number of instances and rounds up fractional instances.

      The value parameter takes an integer.

      For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.

      Returns:
      The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.

      The type parameter takes either of the following values:

      • HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.

      • FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, CodeDeploy converts the percentage to the equivalent number of instances and rounds up fractional instances.

      The value parameter takes an integer.

      For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.

    • trafficRoutingConfig

      public final TrafficRoutingConfig trafficRoutingConfig()

      The configuration that specifies how the deployment traffic is routed.

      Returns:
      The configuration that specifies how the deployment traffic is routed.

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

    • zonalConfig

      public final ZonalConfig zonalConfig()

      Configure the ZonalConfig object if you want CodeDeploy to deploy your application to one Availability Zone at a time, within an Amazon Web Services Region.

      For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide.

      Returns:
      Configure the ZonalConfig object if you want CodeDeploy to deploy your application to one Availability Zone at a time, within an Amazon Web Services Region.

      For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide.

    • toBuilder

      public CreateDeploymentConfigRequest.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<CreateDeploymentConfigRequest.Builder,CreateDeploymentConfigRequest>
      Specified by:
      toBuilder in class CodeDeployRequest
      Returns:
      a builder for type T

    • builder

      public static CreateDeploymentConfigRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateDeploymentConfigRequest.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.