Interface DeploymentLifecycleHook.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DeploymentLifecycleHook.Builder,DeploymentLifecycleHook>, SdkBuilder<DeploymentLifecycleHook.Builder,DeploymentLifecycleHook>, SdkPojo
Enclosing class:
DeploymentLifecycleHook
@Mutable @NotThreadSafe public static interface DeploymentLifecycleHook.Builder extends SdkPojo, CopyableBuilder<DeploymentLifecycleHook.Builder,DeploymentLifecycleHook>

  • Method Details

    • targetType

      DeploymentLifecycleHook.Builder targetType(String targetType)

      The type of action the lifecycle hook performs. Valid values are:

      • AWS_LAMBDA - Invokes a Lambda function at the specified lifecycle stage. This is the default value.

      • PAUSE - Pauses the deployment at the specified lifecycle stage until you call ContinueServiceDeployment to continue or roll back.

      This field is optional. If not specified, the default value is AWS_LAMBDA.

      Parameters:
      targetType - The type of action the lifecycle hook performs. Valid values are:

      • AWS_LAMBDA - Invokes a Lambda function at the specified lifecycle stage. This is the default value.

      • PAUSE - Pauses the deployment at the specified lifecycle stage until you call ContinueServiceDeployment to continue or roll back.

      This field is optional. If not specified, the default value is AWS_LAMBDA.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • targetType

      DeploymentLifecycleHook.Builder targetType(DeploymentLifecycleHookTargetType targetType)

      The type of action the lifecycle hook performs. Valid values are:

      • AWS_LAMBDA - Invokes a Lambda function at the specified lifecycle stage. This is the default value.

      • PAUSE - Pauses the deployment at the specified lifecycle stage until you call ContinueServiceDeployment to continue or roll back.

      This field is optional. If not specified, the default value is AWS_LAMBDA.

      Parameters:
      targetType - The type of action the lifecycle hook performs. Valid values are:

      • AWS_LAMBDA - Invokes a Lambda function at the specified lifecycle stage. This is the default value.

      • PAUSE - Pauses the deployment at the specified lifecycle stage until you call ContinueServiceDeployment to continue or roll back.

      This field is optional. If not specified, the default value is AWS_LAMBDA.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • hookTargetArn

      DeploymentLifecycleHook.Builder hookTargetArn(String hookTargetArn)

      The Amazon Resource Name (ARN) of the hook target. Currently, only Lambda function ARNs are supported.

      You must provide this parameter when configuring a deployment lifecycle hook.

      Parameters:
      hookTargetArn - The Amazon Resource Name (ARN) of the hook target. Currently, only Lambda function ARNs are supported.

      You must provide this parameter when configuring a deployment lifecycle hook.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      DeploymentLifecycleHook.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call Lambda functions on your behalf.

      For more information, see Permissions required for Lambda functions in Amazon ECS blue/green deployments in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call Lambda functions on your behalf.

      For more information, see Permissions required for Lambda functions in Amazon ECS blue/green deployments in the Amazon Elastic Container Service Developer Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifecycleStagesWithStrings

      DeploymentLifecycleHook.Builder lifecycleStagesWithStrings(Collection<String> lifecycleStages)

      The lifecycle stages at which to run the hook. Choose from these valid values:

      • RECONCILE_SERVICE

        The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.

        You can use a lifecycle hook for this stage.

      • PRE_SCALE_UP

        The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

        You can use a lifecycle hook for this stage.

      • POST_SCALE_UP

        The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

        You can use a lifecycle hook for this stage.

      • TEST_TRAFFIC_SHIFT

        The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.

        You can use a lifecycle hook for this stage.

      • POST_TEST_TRAFFIC_SHIFT

        The test traffic shift is complete. The green service revision handles 100% of the test traffic.

        You can use a lifecycle hook for this stage.

      • PRODUCTION_TRAFFIC_SHIFT

        Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic.

        You can use a lifecycle hook for this stage.

      • POST_PRODUCTION_TRAFFIC_SHIFT

        The production traffic shift is complete.

        You can use a lifecycle hook for this stage.

      You must provide this parameter when configuring a deployment lifecycle hook.

      Parameters:
      lifecycleStages - The lifecycle stages at which to run the hook. Choose from these valid values:

      • RECONCILE_SERVICE

        The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.

        You can use a lifecycle hook for this stage.

      • PRE_SCALE_UP

        The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

        You can use a lifecycle hook for this stage.

      • POST_SCALE_UP

        The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

        You can use a lifecycle hook for this stage.

      • TEST_TRAFFIC_SHIFT

        The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.

        You can use a lifecycle hook for this stage.

      • POST_TEST_TRAFFIC_SHIFT

        The test traffic shift is complete. The green service revision handles 100% of the test traffic.

        You can use a lifecycle hook for this stage.

      • PRODUCTION_TRAFFIC_SHIFT

        Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic.

        You can use a lifecycle hook for this stage.

      • POST_PRODUCTION_TRAFFIC_SHIFT

        The production traffic shift is complete.

        You can use a lifecycle hook for this stage.

      You must provide this parameter when configuring a deployment lifecycle hook.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifecycleStagesWithStrings

      DeploymentLifecycleHook.Builder lifecycleStagesWithStrings(String... lifecycleStages)

      The lifecycle stages at which to run the hook. Choose from these valid values:

      • RECONCILE_SERVICE

        The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.

        You can use a lifecycle hook for this stage.

      • PRE_SCALE_UP

        The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

        You can use a lifecycle hook for this stage.

      • POST_SCALE_UP

        The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

        You can use a lifecycle hook for this stage.

      • TEST_TRAFFIC_SHIFT

        The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.

        You can use a lifecycle hook for this stage.

      • POST_TEST_TRAFFIC_SHIFT

        The test traffic shift is complete. The green service revision handles 100% of the test traffic.

        You can use a lifecycle hook for this stage.

      • PRODUCTION_TRAFFIC_SHIFT

        Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic.

        You can use a lifecycle hook for this stage.

      • POST_PRODUCTION_TRAFFIC_SHIFT

        The production traffic shift is complete.

        You can use a lifecycle hook for this stage.

      You must provide this parameter when configuring a deployment lifecycle hook.

      Parameters:
      lifecycleStages - The lifecycle stages at which to run the hook. Choose from these valid values:

      • RECONCILE_SERVICE

        The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.

        You can use a lifecycle hook for this stage.

      • PRE_SCALE_UP

        The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

        You can use a lifecycle hook for this stage.

      • POST_SCALE_UP

        The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

        You can use a lifecycle hook for this stage.

      • TEST_TRAFFIC_SHIFT

        The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.

        You can use a lifecycle hook for this stage.

      • POST_TEST_TRAFFIC_SHIFT

        The test traffic shift is complete. The green service revision handles 100% of the test traffic.

        You can use a lifecycle hook for this stage.

      • PRODUCTION_TRAFFIC_SHIFT

        Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic.

        You can use a lifecycle hook for this stage.

      • POST_PRODUCTION_TRAFFIC_SHIFT

        The production traffic shift is complete.

        You can use a lifecycle hook for this stage.

      You must provide this parameter when configuring a deployment lifecycle hook.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifecycleStages

      DeploymentLifecycleHook.Builder lifecycleStages(Collection<DeploymentLifecycleHookStage> lifecycleStages)

      The lifecycle stages at which to run the hook. Choose from these valid values:

      • RECONCILE_SERVICE

        The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.

        You can use a lifecycle hook for this stage.

      • PRE_SCALE_UP

        The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

        You can use a lifecycle hook for this stage.

      • POST_SCALE_UP

        The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

        You can use a lifecycle hook for this stage.

      • TEST_TRAFFIC_SHIFT

        The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.

        You can use a lifecycle hook for this stage.

      • POST_TEST_TRAFFIC_SHIFT

        The test traffic shift is complete. The green service revision handles 100% of the test traffic.

        You can use a lifecycle hook for this stage.

      • PRODUCTION_TRAFFIC_SHIFT

        Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic.

        You can use a lifecycle hook for this stage.

      • POST_PRODUCTION_TRAFFIC_SHIFT

        The production traffic shift is complete.

        You can use a lifecycle hook for this stage.

      You must provide this parameter when configuring a deployment lifecycle hook.

      Parameters:
      lifecycleStages - The lifecycle stages at which to run the hook. Choose from these valid values:

      • RECONCILE_SERVICE

        The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.

        You can use a lifecycle hook for this stage.

      • PRE_SCALE_UP

        The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

        You can use a lifecycle hook for this stage.

      • POST_SCALE_UP

        The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

        You can use a lifecycle hook for this stage.

      • TEST_TRAFFIC_SHIFT

        The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.

        You can use a lifecycle hook for this stage.

      • POST_TEST_TRAFFIC_SHIFT

        The test traffic shift is complete. The green service revision handles 100% of the test traffic.

        You can use a lifecycle hook for this stage.

      • PRODUCTION_TRAFFIC_SHIFT

        Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic.

        You can use a lifecycle hook for this stage.

      • POST_PRODUCTION_TRAFFIC_SHIFT

        The production traffic shift is complete.

        You can use a lifecycle hook for this stage.

      You must provide this parameter when configuring a deployment lifecycle hook.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifecycleStages

      DeploymentLifecycleHook.Builder lifecycleStages(DeploymentLifecycleHookStage... lifecycleStages)

      The lifecycle stages at which to run the hook. Choose from these valid values:

      • RECONCILE_SERVICE

        The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.

        You can use a lifecycle hook for this stage.

      • PRE_SCALE_UP

        The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

        You can use a lifecycle hook for this stage.

      • POST_SCALE_UP

        The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

        You can use a lifecycle hook for this stage.

      • TEST_TRAFFIC_SHIFT

        The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.

        You can use a lifecycle hook for this stage.

      • POST_TEST_TRAFFIC_SHIFT

        The test traffic shift is complete. The green service revision handles 100% of the test traffic.

        You can use a lifecycle hook for this stage.

      • PRODUCTION_TRAFFIC_SHIFT

        Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic.

        You can use a lifecycle hook for this stage.

      • POST_PRODUCTION_TRAFFIC_SHIFT

        The production traffic shift is complete.

        You can use a lifecycle hook for this stage.

      You must provide this parameter when configuring a deployment lifecycle hook.

      Parameters:
      lifecycleStages - The lifecycle stages at which to run the hook. Choose from these valid values:

      • RECONCILE_SERVICE

        The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.

        You can use a lifecycle hook for this stage.

      • PRE_SCALE_UP

        The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

        You can use a lifecycle hook for this stage.

      • POST_SCALE_UP

        The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

        You can use a lifecycle hook for this stage.

      • TEST_TRAFFIC_SHIFT

        The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.

        You can use a lifecycle hook for this stage.

      • POST_TEST_TRAFFIC_SHIFT

        The test traffic shift is complete. The green service revision handles 100% of the test traffic.

        You can use a lifecycle hook for this stage.

      • PRODUCTION_TRAFFIC_SHIFT

        Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic.

        You can use a lifecycle hook for this stage.

      • POST_PRODUCTION_TRAFFIC_SHIFT

        The production traffic shift is complete.

        You can use a lifecycle hook for this stage.

      You must provide this parameter when configuring a deployment lifecycle hook.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hookDetails

      DeploymentLifecycleHook.Builder hookDetails(Document hookDetails)

      Use this field to specify custom parameters that Amazon ECS will pass to your hook target invocations (such as a Lambda function).

      Parameters:
      hookDetails - Use this field to specify custom parameters that Amazon ECS will pass to your hook target invocations (such as a Lambda function).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeoutConfiguration

      DeploymentLifecycleHook.Builder timeoutConfiguration(DeploymentLifecycleHookTimeoutConfiguration timeoutConfiguration)

      The timeout configuration for the lifecycle hook. This specifies how long Amazon ECS waits before taking the timeout action if the hook is not resolved.

      Parameters:
      timeoutConfiguration - The timeout configuration for the lifecycle hook. This specifies how long Amazon ECS waits before taking the timeout action if the hook is not resolved.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeoutConfiguration

      default DeploymentLifecycleHook.Builder timeoutConfiguration(Consumer<DeploymentLifecycleHookTimeoutConfiguration.Builder> timeoutConfiguration)

      The timeout configuration for the lifecycle hook. This specifies how long Amazon ECS waits before taking the timeout action if the hook is not resolved.

      This is a convenience method that creates an instance of the DeploymentLifecycleHookTimeoutConfiguration.Builder avoiding the need to create one manually via DeploymentLifecycleHookTimeoutConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timeoutConfiguration(DeploymentLifecycleHookTimeoutConfiguration).

      Parameters:
      timeoutConfiguration - a consumer that will call methods on DeploymentLifecycleHookTimeoutConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: