Interface StackSetOperationPreferences.Builder

All Superinterfaces:
Buildable, CopyableBuilder<StackSetOperationPreferences.Builder,StackSetOperationPreferences>, SdkBuilder<StackSetOperationPreferences.Builder,StackSetOperationPreferences>, SdkPojo
Enclosing class:
StackSetOperationPreferences
public static interface StackSetOperationPreferences.Builder extends SdkPojo, CopyableBuilder<StackSetOperationPreferences.Builder,StackSetOperationPreferences>

  • Method Details

    • regionConcurrencyType

      StackSetOperationPreferences.Builder regionConcurrencyType(String regionConcurrencyType)

      The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

      Parameters:
      regionConcurrencyType - The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • regionConcurrencyType

      StackSetOperationPreferences.Builder regionConcurrencyType(RegionConcurrencyType regionConcurrencyType)

      The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

      Parameters:
      regionConcurrencyType - The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • regionOrder

      StackSetOperationPreferences.Builder regionOrder(Collection<String> regionOrder)

      The order of the Regions where you want to perform the stack operation.

      RegionOrder isn't followed if AutoDeployment is enabled.

      Parameters:
      regionOrder - The order of the Regions where you want to perform the stack operation.

      RegionOrder isn't followed if AutoDeployment is enabled.

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

    • regionOrder

      StackSetOperationPreferences.Builder regionOrder(String... regionOrder)

      The order of the Regions where you want to perform the stack operation.

      RegionOrder isn't followed if AutoDeployment is enabled.

      Parameters:
      regionOrder - The order of the Regions where you want to perform the stack operation.

      RegionOrder isn't followed if AutoDeployment is enabled.

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

    • failureToleranceCount

      StackSetOperationPreferences.Builder failureToleranceCount(Integer failureToleranceCount)

      The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

      Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

      By default, 0 is specified.

      Parameters:
      failureToleranceCount - The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

      Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

      By default, 0 is specified.

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

    • failureTolerancePercentage

      StackSetOperationPreferences.Builder failureTolerancePercentage(Integer failureTolerancePercentage)

      The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

      When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.

      Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

      By default, 0 is specified.

      Parameters:
      failureTolerancePercentage - The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

      When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.

      Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

      By default, 0 is specified.

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

    • maxConcurrentCount

      StackSetOperationPreferences.Builder maxConcurrentCount(Integer maxConcurrentCount)

      The maximum number of accounts in which to perform this operation at one time. This can depend on the value of FailureToleranceCount depending on your ConcurrencyMode. MaxConcurrentCount is at most one more than the FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE.

      Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

      Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

      By default, 1 is specified.

      Parameters:
      maxConcurrentCount - The maximum number of accounts in which to perform this operation at one time. This can depend on the value of FailureToleranceCount depending on your ConcurrencyMode. MaxConcurrentCount is at most one more than the FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE.

      Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

      Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

      By default, 1 is specified.

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

    • maxConcurrentPercentage

      StackSetOperationPreferences.Builder maxConcurrentPercentage(Integer maxConcurrentPercentage)

      The maximum percentage of accounts in which to perform this operation at one time.

      When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

      Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

      Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

      By default, 1 is specified.

      Parameters:
      maxConcurrentPercentage - The maximum percentage of accounts in which to perform this operation at one time.

      When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

      Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

      Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

      By default, 1 is specified.

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

    • concurrencyMode

      StackSetOperationPreferences.Builder concurrencyMode(String concurrencyMode)

      Specifies how the concurrency level behaves during the operation execution.

      • STRICT_FAILURE_TOLERANCE: This option dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the value of FailureToleranceCount +1. The initial actual concurrency is set to the lower of either the value of the MaxConcurrentCount, or the value of FailureToleranceCount +1. The actual concurrency is then reduced proportionally by the number of failures. This is the default behavior.

        If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.

      • SOFT_FAILURE_TOLERANCE: This option decouples FailureToleranceCount from the actual concurrency. This allows stack set operations to run at the concurrency level set by the MaxConcurrentCount value, or MaxConcurrentPercentage, regardless of the number of failures.

      Parameters:
      concurrencyMode - Specifies how the concurrency level behaves during the operation execution.

      • STRICT_FAILURE_TOLERANCE: This option dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the value of FailureToleranceCount +1. The initial actual concurrency is set to the lower of either the value of the MaxConcurrentCount, or the value of FailureToleranceCount +1. The actual concurrency is then reduced proportionally by the number of failures. This is the default behavior.

        If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.

      • SOFT_FAILURE_TOLERANCE: This option decouples FailureToleranceCount from the actual concurrency. This allows stack set operations to run at the concurrency level set by the MaxConcurrentCount value, or MaxConcurrentPercentage, regardless of the number of failures.

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

    • concurrencyMode

      StackSetOperationPreferences.Builder concurrencyMode(ConcurrencyMode concurrencyMode)

      Specifies how the concurrency level behaves during the operation execution.

      • STRICT_FAILURE_TOLERANCE: This option dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the value of FailureToleranceCount +1. The initial actual concurrency is set to the lower of either the value of the MaxConcurrentCount, or the value of FailureToleranceCount +1. The actual concurrency is then reduced proportionally by the number of failures. This is the default behavior.

        If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.

      • SOFT_FAILURE_TOLERANCE: This option decouples FailureToleranceCount from the actual concurrency. This allows stack set operations to run at the concurrency level set by the MaxConcurrentCount value, or MaxConcurrentPercentage, regardless of the number of failures.

      Parameters:
      concurrencyMode - Specifies how the concurrency level behaves during the operation execution.

      • STRICT_FAILURE_TOLERANCE: This option dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the value of FailureToleranceCount +1. The initial actual concurrency is set to the lower of either the value of the MaxConcurrentCount, or the value of FailureToleranceCount +1. The actual concurrency is then reduced proportionally by the number of failures. This is the default behavior.

        If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.

      • SOFT_FAILURE_TOLERANCE: This option decouples FailureToleranceCount from the actual concurrency. This allows stack set operations to run at the concurrency level set by the MaxConcurrentCount value, or MaxConcurrentPercentage, regardless of the number of failures.

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