UpdateProvisioningPreferences (AWS Java SDK :: Services

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<UpdateProvisioningPreferences.Builder,UpdateProvisioningPreferences>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateProvisioningPreferences
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UpdateProvisioningPreferences.Builder,UpdateProvisioningPreferences>
```
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 UpdateProvisioningPreferences.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static UpdateProvisioningPreferences.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasStackSetAccounts()` Returns true if the StackSetAccounts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasStackSetRegions()` Returns true if the StackSetRegions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateProvisioningPreferences.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.
`StackSetOperationType`	`stackSetOperationType()` Determines what action AWS Service Catalog performs to a stack set or a stack instance represented by the provisioned product.
`String`	`stackSetOperationTypeAsString()` Determines what action AWS Service Catalog performs to a stack set or a stack instance represented by the provisioned product.
`List<String>`	`stackSetRegions()` One or more AWS Regions where the provisioned product will be available.
`UpdateProvisioningPreferences.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

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

- Method Detail
  - hasStackSetAccounts
```
public final boolean hasStackSetAccounts()
```
    Returns true if the StackSetAccounts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - stackSetAccounts
```
public final 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.
    
    You can use hasStackSetAccounts() to see if a value was sent in this field.
    
    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.
  - hasStackSetRegions
```
public final boolean hasStackSetRegions()
```
    Returns true if the StackSetRegions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - stackSetRegions
```
public final 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.
    
    You can use hasStackSetRegions() to see if a value was sent in this field.
    
    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 final 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 final 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 final 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 final 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.
  - stackSetOperationType
```
public final StackSetOperationType stackSetOperationType()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, stackSetOperationType will return StackSetOperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stackSetOperationTypeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    StackSetOperationType
  - stackSetOperationTypeAsString
```
public final String stackSetOperationTypeAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, stackSetOperationType will return StackSetOperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stackSetOperationTypeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    StackSetOperationType
  - toBuilder
```
public UpdateProvisioningPreferences.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateProvisioningPreferences.Builder,UpdateProvisioningPreferences>
  - builder
```
public static UpdateProvisioningPreferences.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateProvisioningPreferences.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateProvisioningPreferences

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasStackSetAccounts

stackSetAccounts

hasStackSetRegions

stackSetRegions

stackSetFailureToleranceCount

stackSetFailureTolerancePercentage

stackSetMaxConcurrencyCount

stackSetMaxConcurrencyPercentage

stackSetOperationType

stackSetOperationTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields