Class TrafficRoutingConfig

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

The configuration that specifies how traffic is shifted from one version of a Lambda function to another version during an Lambda deployment, or from one Amazon ECS task set to another during an Amazon ECS deployment.

See Also:

  • Method Details

    • type

      public final TrafficRoutingType type()

      The type of traffic shifting (TimeBasedCanary or TimeBasedLinear) used by a deployment configuration.

      If the service returns an enum value that is not available in the current SDK version, type will return TrafficRoutingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of traffic shifting (TimeBasedCanary or TimeBasedLinear) used by a deployment configuration.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of traffic shifting (TimeBasedCanary or TimeBasedLinear) used by a deployment configuration.

      If the service returns an enum value that is not available in the current SDK version, type will return TrafficRoutingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of traffic shifting (TimeBasedCanary or TimeBasedLinear) used by a deployment configuration.
      See Also:

    • timeBasedCanary

      public final TimeBasedCanary timeBasedCanary()

      A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in two increments. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file.

      Returns:
      A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in two increments. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file.

    • timeBasedLinear

      public final TimeBasedLinear timeBasedLinear()

      A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions or Amazon ECS task sets are specified in the deployment's AppSpec file.

      Returns:
      A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions or Amazon ECS task sets are specified in the deployment's AppSpec file.

    • toBuilder

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

    • builder

      public static TrafficRoutingConfig.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.