AWS SDK for C++  1.9.70
AWS SDK for C++
Public Member Functions | List of all members
Aws::ServiceCatalog::Model::UpdateProvisioningPreferences Class Reference

#include <UpdateProvisioningPreferences.h>

Public Member Functions

 UpdateProvisioningPreferences ()
 
 UpdateProvisioningPreferences (Aws::Utils::Json::JsonView jsonValue)
 
UpdateProvisioningPreferencesoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Vector< Aws::String > & GetStackSetAccounts () const
 
bool StackSetAccountsHasBeenSet () const
 
void SetStackSetAccounts (const Aws::Vector< Aws::String > &value)
 
void SetStackSetAccounts (Aws::Vector< Aws::String > &&value)
 
UpdateProvisioningPreferencesWithStackSetAccounts (const Aws::Vector< Aws::String > &value)
 
UpdateProvisioningPreferencesWithStackSetAccounts (Aws::Vector< Aws::String > &&value)
 
UpdateProvisioningPreferencesAddStackSetAccounts (const Aws::String &value)
 
UpdateProvisioningPreferencesAddStackSetAccounts (Aws::String &&value)
 
UpdateProvisioningPreferencesAddStackSetAccounts (const char *value)
 
const Aws::Vector< Aws::String > & GetStackSetRegions () const
 
bool StackSetRegionsHasBeenSet () const
 
void SetStackSetRegions (const Aws::Vector< Aws::String > &value)
 
void SetStackSetRegions (Aws::Vector< Aws::String > &&value)
 
UpdateProvisioningPreferencesWithStackSetRegions (const Aws::Vector< Aws::String > &value)
 
UpdateProvisioningPreferencesWithStackSetRegions (Aws::Vector< Aws::String > &&value)
 
UpdateProvisioningPreferencesAddStackSetRegions (const Aws::String &value)
 
UpdateProvisioningPreferencesAddStackSetRegions (Aws::String &&value)
 
UpdateProvisioningPreferencesAddStackSetRegions (const char *value)
 
int GetStackSetFailureToleranceCount () const
 
bool StackSetFailureToleranceCountHasBeenSet () const
 
void SetStackSetFailureToleranceCount (int value)
 
UpdateProvisioningPreferencesWithStackSetFailureToleranceCount (int value)
 
int GetStackSetFailureTolerancePercentage () const
 
bool StackSetFailureTolerancePercentageHasBeenSet () const
 
void SetStackSetFailureTolerancePercentage (int value)
 
UpdateProvisioningPreferencesWithStackSetFailureTolerancePercentage (int value)
 
int GetStackSetMaxConcurrencyCount () const
 
bool StackSetMaxConcurrencyCountHasBeenSet () const
 
void SetStackSetMaxConcurrencyCount (int value)
 
UpdateProvisioningPreferencesWithStackSetMaxConcurrencyCount (int value)
 
int GetStackSetMaxConcurrencyPercentage () const
 
bool StackSetMaxConcurrencyPercentageHasBeenSet () const
 
void SetStackSetMaxConcurrencyPercentage (int value)
 
UpdateProvisioningPreferencesWithStackSetMaxConcurrencyPercentage (int value)
 
const StackSetOperationTypeGetStackSetOperationType () const
 
bool StackSetOperationTypeHasBeenSet () const
 
void SetStackSetOperationType (const StackSetOperationType &value)
 
void SetStackSetOperationType (StackSetOperationType &&value)
 
UpdateProvisioningPreferencesWithStackSetOperationType (const StackSetOperationType &value)
 
UpdateProvisioningPreferencesWithStackSetOperationType (StackSetOperationType &&value)
 

Detailed Description

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:

AWS API Reference

Definition at line 35 of file UpdateProvisioningPreferences.h.

Constructor & Destructor Documentation

◆ UpdateProvisioningPreferences() [1/2]

Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::UpdateProvisioningPreferences ( )

◆ UpdateProvisioningPreferences() [2/2]

Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::UpdateProvisioningPreferences ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddStackSetAccounts() [1/3]

UpdateProvisioningPreferences& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::AddStackSetAccounts ( Aws::String &&  value)
inline

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.

Definition at line 138 of file UpdateProvisioningPreferences.h.

◆ AddStackSetAccounts() [2/3]

UpdateProvisioningPreferences& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::AddStackSetAccounts ( const Aws::String value)
inline

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.

Definition at line 126 of file UpdateProvisioningPreferences.h.

◆ AddStackSetAccounts() [3/3]

UpdateProvisioningPreferences& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::AddStackSetAccounts ( const char *  value)
inline

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.

Definition at line 150 of file UpdateProvisioningPreferences.h.

◆ AddStackSetRegions() [1/3]

UpdateProvisioningPreferences& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::AddStackSetRegions ( Aws::String &&  value)
inline

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.

Definition at line 247 of file UpdateProvisioningPreferences.h.

◆ AddStackSetRegions() [2/3]

UpdateProvisioningPreferences& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::AddStackSetRegions ( const Aws::String value)
inline

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.

Definition at line 235 of file UpdateProvisioningPreferences.h.

◆ AddStackSetRegions() [3/3]

UpdateProvisioningPreferences& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::AddStackSetRegions ( const char *  value)
inline

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.

Definition at line 259 of file UpdateProvisioningPreferences.h.

◆ GetStackSetAccounts()

const Aws::Vector<Aws::String>& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::GetStackSetAccounts ( ) const
inline

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.

Definition at line 54 of file UpdateProvisioningPreferences.h.

◆ GetStackSetFailureToleranceCount()

int Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::GetStackSetFailureToleranceCount ( ) const
inline

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.

Definition at line 272 of file UpdateProvisioningPreferences.h.

◆ GetStackSetFailureTolerancePercentage()

int Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::GetStackSetFailureTolerancePercentage ( ) const
inline

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.

Definition at line 322 of file UpdateProvisioningPreferences.h.

◆ GetStackSetMaxConcurrencyCount()

int Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::GetStackSetMaxConcurrencyCount ( ) const
inline

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.

Definition at line 377 of file UpdateProvisioningPreferences.h.

◆ GetStackSetMaxConcurrencyPercentage()

int Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::GetStackSetMaxConcurrencyPercentage ( ) const
inline

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.

Definition at line 438 of file UpdateProvisioningPreferences.h.

◆ GetStackSetOperationType()

const StackSetOperationType& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::GetStackSetOperationType ( ) const
inline

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.

Definition at line 499 of file UpdateProvisioningPreferences.h.

◆ GetStackSetRegions()

const Aws::Vector<Aws::String>& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::GetStackSetRegions ( ) const
inline

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.

Definition at line 163 of file UpdateProvisioningPreferences.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::Jsonize ( ) const

◆ operator=()

UpdateProvisioningPreferences& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetStackSetAccounts() [1/2]

void Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::SetStackSetAccounts ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 90 of file UpdateProvisioningPreferences.h.

◆ SetStackSetAccounts() [2/2]

void Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::SetStackSetAccounts ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 78 of file UpdateProvisioningPreferences.h.

◆ SetStackSetFailureToleranceCount()

void Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::SetStackSetFailureToleranceCount ( int  value)
inline

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.

Definition at line 296 of file UpdateProvisioningPreferences.h.

◆ SetStackSetFailureTolerancePercentage()

void Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::SetStackSetFailureTolerancePercentage ( int  value)
inline

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.

Definition at line 348 of file UpdateProvisioningPreferences.h.

◆ SetStackSetMaxConcurrencyCount()

void Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::SetStackSetMaxConcurrencyCount ( int  value)
inline

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.

Definition at line 407 of file UpdateProvisioningPreferences.h.

◆ SetStackSetMaxConcurrencyPercentage()

void Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::SetStackSetMaxConcurrencyPercentage ( int  value)
inline

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.

Definition at line 468 of file UpdateProvisioningPreferences.h.

◆ SetStackSetOperationType() [1/2]

void Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::SetStackSetOperationType ( const StackSetOperationType value)
inline

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.

Definition at line 529 of file UpdateProvisioningPreferences.h.

◆ SetStackSetOperationType() [2/2]

void Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::SetStackSetOperationType ( StackSetOperationType &&  value)
inline

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.

Definition at line 544 of file UpdateProvisioningPreferences.h.

◆ SetStackSetRegions() [1/2]

void Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::SetStackSetRegions ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 199 of file UpdateProvisioningPreferences.h.

◆ SetStackSetRegions() [2/2]

void Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::SetStackSetRegions ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 187 of file UpdateProvisioningPreferences.h.

◆ StackSetAccountsHasBeenSet()

bool Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::StackSetAccountsHasBeenSet ( ) const
inline

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.

Definition at line 66 of file UpdateProvisioningPreferences.h.

◆ StackSetFailureToleranceCountHasBeenSet()

bool Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::StackSetFailureToleranceCountHasBeenSet ( ) const
inline

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.

Definition at line 284 of file UpdateProvisioningPreferences.h.

◆ StackSetFailureTolerancePercentageHasBeenSet()

bool Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::StackSetFailureTolerancePercentageHasBeenSet ( ) const
inline

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.

Definition at line 335 of file UpdateProvisioningPreferences.h.

◆ StackSetMaxConcurrencyCountHasBeenSet()

bool Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::StackSetMaxConcurrencyCountHasBeenSet ( ) const
inline

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.

Definition at line 392 of file UpdateProvisioningPreferences.h.

◆ StackSetMaxConcurrencyPercentageHasBeenSet()

bool Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::StackSetMaxConcurrencyPercentageHasBeenSet ( ) const
inline

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.

Definition at line 453 of file UpdateProvisioningPreferences.h.

◆ StackSetOperationTypeHasBeenSet()

bool Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::StackSetOperationTypeHasBeenSet ( ) const
inline

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.

Definition at line 514 of file UpdateProvisioningPreferences.h.

◆ StackSetRegionsHasBeenSet()

bool Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::StackSetRegionsHasBeenSet ( ) const
inline

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.

Definition at line 175 of file UpdateProvisioningPreferences.h.

◆ WithStackSetAccounts() [1/2]

UpdateProvisioningPreferences& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::WithStackSetAccounts ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 114 of file UpdateProvisioningPreferences.h.

◆ WithStackSetAccounts() [2/2]

UpdateProvisioningPreferences& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::WithStackSetAccounts ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 102 of file UpdateProvisioningPreferences.h.

◆ WithStackSetFailureToleranceCount()

UpdateProvisioningPreferences& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::WithStackSetFailureToleranceCount ( int  value)
inline

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.

Definition at line 308 of file UpdateProvisioningPreferences.h.

◆ WithStackSetFailureTolerancePercentage()

UpdateProvisioningPreferences& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::WithStackSetFailureTolerancePercentage ( int  value)
inline

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.

Definition at line 361 of file UpdateProvisioningPreferences.h.

◆ WithStackSetMaxConcurrencyCount()

UpdateProvisioningPreferences& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::WithStackSetMaxConcurrencyCount ( int  value)
inline

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.

Definition at line 422 of file UpdateProvisioningPreferences.h.

◆ WithStackSetMaxConcurrencyPercentage()

UpdateProvisioningPreferences& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::WithStackSetMaxConcurrencyPercentage ( int  value)
inline

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.

Definition at line 483 of file UpdateProvisioningPreferences.h.

◆ WithStackSetOperationType() [1/2]

UpdateProvisioningPreferences& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::WithStackSetOperationType ( const StackSetOperationType value)
inline

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.

Definition at line 559 of file UpdateProvisioningPreferences.h.

◆ WithStackSetOperationType() [2/2]

UpdateProvisioningPreferences& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::WithStackSetOperationType ( StackSetOperationType &&  value)
inline

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.

Definition at line 574 of file UpdateProvisioningPreferences.h.

◆ WithStackSetRegions() [1/2]

UpdateProvisioningPreferences& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::WithStackSetRegions ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 223 of file UpdateProvisioningPreferences.h.

◆ WithStackSetRegions() [2/2]

UpdateProvisioningPreferences& Aws::ServiceCatalog::Model::UpdateProvisioningPreferences::WithStackSetRegions ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 211 of file UpdateProvisioningPreferences.h.


The documentation for this class was generated from the following file: