Package software.amazon.awssdk.services.servicecatalog.model

Interface UpdateProvisioningPreferences.Builder

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

  • Method Details

    • stackSetAccounts

      UpdateProvisioningPreferences.Builder stackSetAccounts(Collection<String> stackSetAccounts)

      One or more Amazon Web Services accounts that will have access to the provisioned product.

      Applicable only to a CFN_STACKSET provisioned product type.

      The Amazon Web Services accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

      If no values are specified, the default value is all accounts from the STACKSET constraint.

      Parameters:
      stackSetAccounts - One or more Amazon Web Services accounts that will have access to the provisioned product.

      Applicable only to a CFN_STACKSET provisioned product type.

      The Amazon Web Services accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

      If no values are specified, the default value is all accounts from the STACKSET constraint.

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

    • stackSetAccounts

      UpdateProvisioningPreferences.Builder stackSetAccounts(String... stackSetAccounts)

      One or more Amazon Web Services accounts that will have access to the provisioned product.

      Applicable only to a CFN_STACKSET provisioned product type.

      The Amazon Web Services accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

      If no values are specified, the default value is all accounts from the STACKSET constraint.

      Parameters:
      stackSetAccounts - One or more Amazon Web Services accounts that will have access to the provisioned product.

      Applicable only to a CFN_STACKSET provisioned product type.

      The Amazon Web Services accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

      If no values are specified, the default value is all accounts from the STACKSET constraint.

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

    • stackSetRegions

      UpdateProvisioningPreferences.Builder stackSetRegions(Collection<String> stackSetRegions)

      One or more Amazon Web Services Regions where the provisioned product will be available.

      Applicable only to a CFN_STACKSET provisioned product type.

      The specified Regions should be within the list of Regions from the STACKSET constraint. To get the list of Regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

      If no values are specified, the default value is all Regions from the STACKSET constraint.

      Parameters:
      stackSetRegions - One or more Amazon Web Services Regions where the provisioned product will be available.

      Applicable only to a CFN_STACKSET provisioned product type.

      The specified Regions should be within the list of Regions from the STACKSET constraint. To get the list of Regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

      If no values are specified, the default value is all Regions from the STACKSET constraint.

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

    • stackSetRegions

      UpdateProvisioningPreferences.Builder stackSetRegions(String... stackSetRegions)

      One or more Amazon Web Services Regions where the provisioned product will be available.

      Applicable only to a CFN_STACKSET provisioned product type.

      The specified Regions should be within the list of Regions from the STACKSET constraint. To get the list of Regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

      If no values are specified, the default value is all Regions from the STACKSET constraint.

      Parameters:
      stackSetRegions - One or more Amazon Web Services Regions where the provisioned product will be available.

      Applicable only to a CFN_STACKSET provisioned product type.

      The specified Regions should be within the list of Regions from the STACKSET constraint. To get the list of Regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

      If no values are specified, the default value is all Regions from the STACKSET constraint.

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

    • stackSetFailureToleranceCount

      UpdateProvisioningPreferences.Builder stackSetFailureToleranceCount(Integer stackSetFailureToleranceCount)

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

      Applicable only to a CFN_STACKSET provisioned product type.

      Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

      The default value is 0 if no value is specified.

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

      Applicable only to a CFN_STACKSET provisioned product type.

      Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

      The default value is 0 if no value is specified.

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

    • stackSetFailureTolerancePercentage

      UpdateProvisioningPreferences.Builder stackSetFailureTolerancePercentage(Integer stackSetFailureTolerancePercentage)

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

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

      Applicable only to a CFN_STACKSET provisioned product type.

      Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

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

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

      Applicable only to a CFN_STACKSET provisioned product type.

      Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

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

    • stackSetMaxConcurrencyCount

      UpdateProvisioningPreferences.Builder stackSetMaxConcurrencyCount(Integer stackSetMaxConcurrencyCount)

      The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount.

      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.

      Applicable only to a CFN_STACKSET provisioned product type.

      Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

      Parameters:
      stackSetMaxConcurrencyCount - The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount.

      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.

      Applicable only to a CFN_STACKSET provisioned product type.

      Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

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

    • stackSetMaxConcurrencyPercentage

      UpdateProvisioningPreferences.Builder stackSetMaxConcurrencyPercentage(Integer stackSetMaxConcurrencyPercentage)

      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, Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, Service Catalog sets the number as 1 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.

      Applicable only to a CFN_STACKSET provisioned product type.

      Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

      Parameters:
      stackSetMaxConcurrencyPercentage - 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, Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, Service Catalog sets the number as 1 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.

      Applicable only to a CFN_STACKSET provisioned product type.

      Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

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

    • stackSetOperationType

      UpdateProvisioningPreferences.Builder stackSetOperationType(String stackSetOperationType)

      Determines what action Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is UPDATE if nothing is specified.

      Applicable only to a CFN_STACKSET provisioned product type.

      CREATE

      Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and Regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.

      UPDATE

      Updates the stack set represented by the provisioned product and also its stack instances.

      DELETE

      Deletes a stack instance in the stack set represented by the provisioned product.

      Parameters:
      stackSetOperationType - Determines what action Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is UPDATE if nothing is specified.

      Applicable only to a CFN_STACKSET provisioned product type.

      CREATE

      Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and Regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.

      UPDATE

      Updates the stack set represented by the provisioned product and also its stack instances.

      DELETE

      Deletes a stack instance in the stack set represented by the provisioned product.

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

    • stackSetOperationType

      UpdateProvisioningPreferences.Builder stackSetOperationType(StackSetOperationType stackSetOperationType)

      Determines what action Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is UPDATE if nothing is specified.

      Applicable only to a CFN_STACKSET provisioned product type.

      CREATE

      Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and Regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.

      UPDATE

      Updates the stack set represented by the provisioned product and also its stack instances.

      DELETE

      Deletes a stack instance in the stack set represented by the provisioned product.

      Parameters:
      stackSetOperationType - Determines what action Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is UPDATE if nothing is specified.

      Applicable only to a CFN_STACKSET provisioned product type.

      CREATE

      Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and Regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.

      UPDATE

      Updates the stack set represented by the provisioned product and also its stack instances.

      DELETE

      Deletes a stack instance in the stack set represented by the provisioned product.

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