Class UpdateProvisioningPreferences

java.lang.Object
software.amazon.awssdk.services.servicecatalog.model.UpdateProvisioningPreferences
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UpdateProvisioningPreferences.Builder,UpdateProvisioningPreferences>
@Generated("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:

  • Method Details

    • hasStackSetAccounts

      public final boolean hasStackSetAccounts()
      For responses, this returns true if the service returned a value for the StackSetAccounts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • stackSetAccounts

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStackSetAccounts() method.

      Returns:
      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.

    • hasStackSetRegions

      public final boolean hasStackSetRegions()
      For responses, this returns true if the service returned a value for the StackSetRegions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • stackSetRegions

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStackSetRegions() method.

      Returns:
      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.

    • stackSetFailureToleranceCount

      public final 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.

      Returns:
      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.

    • stackSetFailureTolerancePercentage

      public final 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.

      Returns:
      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.

    • 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, 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:
      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.

    • stackSetOperationType

      public final 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.

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

    • stackSetOperationTypeAsString

      public final String stackSetOperationTypeAsString()

      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.

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

    • toBuilder

      public UpdateProvisioningPreferences.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<UpdateProvisioningPreferences.Builder,UpdateProvisioningPreferences>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.