ProvisioningPreferences (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.servicecatalog.model.ProvisioningPreferences

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ProvisioningPreferences.Builder,ProvisioningPreferences>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class ProvisioningPreferences
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ProvisioningPreferences.Builder,ProvisioningPreferences>
```
The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product types.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ProvisioningPreferences.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ProvisioningPreferences.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ProvisioningPreferences.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ProvisioningPreferences.Builder>`	`serializableBuilderClass()`
`List<String>`	`stackSetAccounts()` One or more AWS accounts that will have access to the provisioned product.
`Integer`	`stackSetFailureToleranceCount()` The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region.
`Integer`	`stackSetFailureTolerancePercentage()` The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region.
`Integer`	`stackSetMaxConcurrencyCount()` The maximum number of accounts in which to perform this operation at one time.
`Integer`	`stackSetMaxConcurrencyPercentage()` The maximum percentage of accounts in which to perform this operation at one time.
`List<String>`	`stackSetRegions()` One or more AWS Regions where the provisioned product will be available.
`ProvisioningPreferences.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - stackSetAccounts
```
public List<String> stackSetAccounts()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    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.
  - stackSetRegions
```
public List<String> stackSetRegions()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    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.
  - stackSetFailureToleranceCount
```
public Integer stackSetFailureToleranceCount()
```
    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:
    
    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.
  - stackSetFailureTolerancePercentage
```
public Integer stackSetFailureTolerancePercentage()
```
    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:
    
    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.
  - stackSetMaxConcurrencyCount
```
public 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.
    
    Returns:
    
    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.
  - stackSetMaxConcurrencyPercentage
```
public 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, 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:
    
    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.
  - toBuilder
```
public ProvisioningPreferences.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ProvisioningPreferences.Builder,ProvisioningPreferences>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ProvisioningPreferences.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ProvisioningPreferences.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class ProvisioningPreferences

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

stackSetAccounts

stackSetRegions

stackSetFailureToleranceCount

stackSetFailureTolerancePercentage

stackSetMaxConcurrencyCount

stackSetMaxConcurrencyPercentage

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields