You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ServiceCatalog::Types::UpdateProvisioningPreferences

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb

Overview

Note:

When making an API call, you may pass UpdateProvisioningPreferences data as a hash:

{
  stack_set_accounts: ["AccountId"],
  stack_set_regions: ["Region"],
  stack_set_failure_tolerance_count: 1,
  stack_set_failure_tolerance_percentage: 1,
  stack_set_max_concurrency_count: 1,
  stack_set_max_concurrency_percentage: 1,
  stack_set_operation_type: "CREATE", # accepts CREATE, UPDATE, DELETE
}

The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product types.

Instance Attribute Summary collapse

Instance Attribute Details

#stack_set_accountsArray<String>

One or more AWS accounts that will have access to the provisioned product.

Applicable only to a CFN_STACKSET provisioned product type.

The AWS 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:

  • (Array<String>)


6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 6870

class UpdateProvisioningPreferences < Struct.new(
  :stack_set_accounts,
  :stack_set_regions,
  :stack_set_failure_tolerance_count,
  :stack_set_failure_tolerance_percentage,
  :stack_set_max_concurrency_count,
  :stack_set_max_concurrency_percentage,
  :stack_set_operation_type)
  include Aws::Structure
end

#stack_set_failure_tolerance_countInteger

The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS 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:

  • (Integer)


6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 6870

class UpdateProvisioningPreferences < Struct.new(
  :stack_set_accounts,
  :stack_set_regions,
  :stack_set_failure_tolerance_count,
  :stack_set_failure_tolerance_percentage,
  :stack_set_max_concurrency_count,
  :stack_set_max_concurrency_percentage,
  :stack_set_operation_type)
  include Aws::Structure
end

#stack_set_failure_tolerance_percentageInteger

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

When calculating the number of accounts based on the specified percentage, AWS 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:

  • (Integer)


6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 6870

class UpdateProvisioningPreferences < Struct.new(
  :stack_set_accounts,
  :stack_set_regions,
  :stack_set_failure_tolerance_count,
  :stack_set_failure_tolerance_percentage,
  :stack_set_max_concurrency_count,
  :stack_set_max_concurrency_percentage,
  :stack_set_operation_type)
  include Aws::Structure
end

#stack_set_max_concurrency_countInteger

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:

  • (Integer)


6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 6870

class UpdateProvisioningPreferences < Struct.new(
  :stack_set_accounts,
  :stack_set_regions,
  :stack_set_failure_tolerance_count,
  :stack_set_failure_tolerance_percentage,
  :stack_set_max_concurrency_count,
  :stack_set_max_concurrency_percentage,
  :stack_set_operation_type)
  include Aws::Structure
end

#stack_set_max_concurrency_percentageInteger

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, AWS 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, AWS 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:

  • (Integer)


6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 6870

class UpdateProvisioningPreferences < Struct.new(
  :stack_set_accounts,
  :stack_set_regions,
  :stack_set_failure_tolerance_count,
  :stack_set_failure_tolerance_percentage,
  :stack_set_max_concurrency_count,
  :stack_set_max_concurrency_percentage,
  :stack_set_operation_type)
  include Aws::Structure
end

#stack_set_operation_typeString

Determines what action AWS 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:

  • (String)


6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 6870

class UpdateProvisioningPreferences < Struct.new(
  :stack_set_accounts,
  :stack_set_regions,
  :stack_set_failure_tolerance_count,
  :stack_set_failure_tolerance_percentage,
  :stack_set_max_concurrency_count,
  :stack_set_max_concurrency_percentage,
  :stack_set_operation_type)
  include Aws::Structure
end

#stack_set_regionsArray<String>

One or more AWS 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:

  • (Array<String>)


6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 6870

class UpdateProvisioningPreferences < Struct.new(
  :stack_set_accounts,
  :stack_set_regions,
  :stack_set_failure_tolerance_count,
  :stack_set_failure_tolerance_percentage,
  :stack_set_max_concurrency_count,
  :stack_set_max_concurrency_percentage,
  :stack_set_operation_type)
  include Aws::Structure
end