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

Class ProvisioningPreferences

    • Method Detail

      • 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 where the provisioned product will be available.

        Applicable only to a CFN_STACKSET provisioned product type.

        The specified accounts should be within the list of accounts from 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 acounts 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 where the provisioned product will be available.

        Applicable only to a CFN_STACKSET provisioned product type.

        The specified accounts should be within the list of accounts from 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 acounts 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.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)