Package software.amazon.awscdk.services.codedeploy

Class TrafficRouting

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.codedeploy.TrafficRouting
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
Direct Known Subclasses:
AllAtOnceTrafficRouting, TimeBasedCanaryTrafficRouting, TimeBasedLinearTrafficRouting
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:23:58.809Z") @Stability(Stable) public abstract class TrafficRouting extends software.amazon.jsii.JsiiObject
Represents how traffic is shifted during a CodeDeploy deployment.

Example: 

 LambdaDeploymentConfig config = LambdaDeploymentConfig.Builder.create(this, "CustomConfig")
         .trafficRouting(TimeBasedCanaryTrafficRouting.Builder.create()
                 .interval(Duration.minutes(15))
                 .percentage(5)
                 .build())
         .deploymentConfigName("MyDeploymentConfig")
         .build();

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    TrafficRouting()
     
    protected
    TrafficRouting(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    TrafficRouting(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static TrafficRouting
    allAtOnce()
    Shifts 100% of traffic in a single shift.
    abstract TrafficRoutingConfig
    bind(software.constructs.Construct scope)
    Returns the traffic routing configuration.
    static TrafficRouting
    timeBasedCanary(TimeBasedCanaryTrafficRoutingProps props)
    Shifts a specified percentage of traffic, waits for a specified amount of time, then shifts the rest of traffic.
    static TrafficRouting
    timeBasedLinear(TimeBasedLinearTrafficRoutingProps props)
    Keeps shifting a specified percentage of traffic until reaching 100%, waiting for a specified amount of time in between each traffic shift.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • TrafficRouting

      protected TrafficRouting(software.amazon.jsii.JsiiObjectRef objRef)

    • TrafficRouting

      protected TrafficRouting(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • TrafficRouting

      @Stability(Stable) protected TrafficRouting()

  • Method Details

    • allAtOnce

      @Stability(Stable) @NotNull public static TrafficRouting allAtOnce()
      Shifts 100% of traffic in a single shift.

    • timeBasedCanary

      @Stability(Stable) @NotNull public static TrafficRouting timeBasedCanary(@NotNull TimeBasedCanaryTrafficRoutingProps props)
      Shifts a specified percentage of traffic, waits for a specified amount of time, then shifts the rest of traffic.

      Parameters:
      props - This parameter is required.

    • timeBasedLinear

      @Stability(Stable) @NotNull public static TrafficRouting timeBasedLinear(@NotNull TimeBasedLinearTrafficRoutingProps props)
      Keeps shifting a specified percentage of traffic until reaching 100%, waiting for a specified amount of time in between each traffic shift.

      Parameters:
      props - This parameter is required.

    • bind

      @Stability(Stable) @NotNull public abstract TrafficRoutingConfig bind(@NotNull software.constructs.Construct scope)
      Returns the traffic routing configuration.

      Parameters:
      scope - This parameter is required.