1. Packages
  2. AWS Native
  3. API Docs
  4. servicecatalog
  5. getCloudFormationProvisionedProduct

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.servicecatalog.getCloudFormationProvisionedProduct

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    Resource Schema for AWS::ServiceCatalog::CloudFormationProvisionedProduct

    Using getCloudFormationProvisionedProduct

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCloudFormationProvisionedProduct(args: GetCloudFormationProvisionedProductArgs, opts?: InvokeOptions): Promise<GetCloudFormationProvisionedProductResult>
    function getCloudFormationProvisionedProductOutput(args: GetCloudFormationProvisionedProductOutputArgs, opts?: InvokeOptions): Output<GetCloudFormationProvisionedProductResult>
    def get_cloud_formation_provisioned_product(provisioned_product_id: Optional[str] = None,
                                                opts: Optional[InvokeOptions] = None) -> GetCloudFormationProvisionedProductResult
    def get_cloud_formation_provisioned_product_output(provisioned_product_id: Optional[pulumi.Input[str]] = None,
                                                opts: Optional[InvokeOptions] = None) -> Output[GetCloudFormationProvisionedProductResult]
    func LookupCloudFormationProvisionedProduct(ctx *Context, args *LookupCloudFormationProvisionedProductArgs, opts ...InvokeOption) (*LookupCloudFormationProvisionedProductResult, error)
    func LookupCloudFormationProvisionedProductOutput(ctx *Context, args *LookupCloudFormationProvisionedProductOutputArgs, opts ...InvokeOption) LookupCloudFormationProvisionedProductResultOutput

    > Note: This function is named LookupCloudFormationProvisionedProduct in the Go SDK.

    public static class GetCloudFormationProvisionedProduct 
    {
        public static Task<GetCloudFormationProvisionedProductResult> InvokeAsync(GetCloudFormationProvisionedProductArgs args, InvokeOptions? opts = null)
        public static Output<GetCloudFormationProvisionedProductResult> Invoke(GetCloudFormationProvisionedProductInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCloudFormationProvisionedProductResult> getCloudFormationProvisionedProduct(GetCloudFormationProvisionedProductArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:servicecatalog:getCloudFormationProvisionedProduct
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ProvisionedProductId string
    The ID of the provisioned product.
    ProvisionedProductId string
    The ID of the provisioned product.
    provisionedProductId String
    The ID of the provisioned product.
    provisionedProductId string
    The ID of the provisioned product.
    provisioned_product_id str
    The ID of the provisioned product.
    provisionedProductId String
    The ID of the provisioned product.

    getCloudFormationProvisionedProduct Result

    The following output properties are available:

    AcceptLanguage Pulumi.AwsNative.ServiceCatalog.CloudFormationProvisionedProductAcceptLanguage
    The language code.

    • jp - Japanese
    • zh - Chinese
    CloudformationStackArn string
    Outputs Dictionary<string, string>
    List of key-value pair outputs.
    PathId string

    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths .

    You must provide the name or ID, but not both.

    PathName string

    The name of the path. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths .

    You must provide the name or ID, but not both.

    ProductId string

    The product identifier.

    You must specify either the ID or the name of the product, but not both.

    ProductName string

    The name of the Service Catalog product.

    Each time a stack is created or updated, if ProductName is provided it will successfully resolve to ProductId as long as only one product exists in the account or Region with that ProductName .

    You must specify either the name or the ID of the product, but not both.

    ProvisionedProductId string
    The ID of the provisioned product.
    ProvisioningArtifactId string

    The identifier of the provisioning artifact (also known as a version).

    You must specify either the ID or the name of the provisioning artifact, but not both.

    ProvisioningArtifactName string

    The name of the provisioning artifact (also known as a version) for the product. This name must be unique for the product.

    You must specify either the name or the ID of the provisioning artifact, but not both. You must also specify either the name or the ID of the product, but not both.

    ProvisioningParameters List<Pulumi.AwsNative.ServiceCatalog.Outputs.CloudFormationProvisionedProductProvisioningParameter>
    Parameters specified by the administrator that are required for provisioning the product.
    ProvisioningPreferences Pulumi.AwsNative.ServiceCatalog.Outputs.CloudFormationProvisionedProductProvisioningPreferences
    StackSet preferences that are required for provisioning the product or updating a provisioned product.
    RecordId string
    The ID of the record, such as rec-rjeatvy434trk .
    Tags List<Pulumi.AwsNative.Outputs.Tag>

    One or more tags.

    Requires the provisioned product to have an ResourceUpdateConstraint resource with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates. If RESOURCE_UPDATE constraint is not present, tags updates are ignored.

    AcceptLanguage CloudFormationProvisionedProductAcceptLanguage
    The language code.

    • jp - Japanese
    • zh - Chinese
    CloudformationStackArn string
    Outputs map[string]string
    List of key-value pair outputs.
    PathId string

    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths .

    You must provide the name or ID, but not both.

    PathName string

    The name of the path. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths .

    You must provide the name or ID, but not both.

    ProductId string

    The product identifier.

    You must specify either the ID or the name of the product, but not both.

    ProductName string

    The name of the Service Catalog product.

    Each time a stack is created or updated, if ProductName is provided it will successfully resolve to ProductId as long as only one product exists in the account or Region with that ProductName .

    You must specify either the name or the ID of the product, but not both.

    ProvisionedProductId string
    The ID of the provisioned product.
    ProvisioningArtifactId string

    The identifier of the provisioning artifact (also known as a version).

    You must specify either the ID or the name of the provisioning artifact, but not both.

    ProvisioningArtifactName string

    The name of the provisioning artifact (also known as a version) for the product. This name must be unique for the product.

    You must specify either the name or the ID of the provisioning artifact, but not both. You must also specify either the name or the ID of the product, but not both.

    ProvisioningParameters []CloudFormationProvisionedProductProvisioningParameter
    Parameters specified by the administrator that are required for provisioning the product.
    ProvisioningPreferences CloudFormationProvisionedProductProvisioningPreferences
    StackSet preferences that are required for provisioning the product or updating a provisioned product.
    RecordId string
    The ID of the record, such as rec-rjeatvy434trk .
    Tags Tag

    One or more tags.

    Requires the provisioned product to have an ResourceUpdateConstraint resource with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates. If RESOURCE_UPDATE constraint is not present, tags updates are ignored.

    acceptLanguage CloudFormationProvisionedProductAcceptLanguage
    The language code.

    • jp - Japanese
    • zh - Chinese
    cloudformationStackArn String
    outputs Map<String,String>
    List of key-value pair outputs.
    pathId String

    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths .

    You must provide the name or ID, but not both.

    pathName String

    The name of the path. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths .

    You must provide the name or ID, but not both.

    productId String

    The product identifier.

    You must specify either the ID or the name of the product, but not both.

    productName String

    The name of the Service Catalog product.

    Each time a stack is created or updated, if ProductName is provided it will successfully resolve to ProductId as long as only one product exists in the account or Region with that ProductName .

    You must specify either the name or the ID of the product, but not both.

    provisionedProductId String
    The ID of the provisioned product.
    provisioningArtifactId String

    The identifier of the provisioning artifact (also known as a version).

    You must specify either the ID or the name of the provisioning artifact, but not both.

    provisioningArtifactName String

    The name of the provisioning artifact (also known as a version) for the product. This name must be unique for the product.

    You must specify either the name or the ID of the provisioning artifact, but not both. You must also specify either the name or the ID of the product, but not both.

    provisioningParameters List<CloudFormationProvisionedProductProvisioningParameter>
    Parameters specified by the administrator that are required for provisioning the product.
    provisioningPreferences CloudFormationProvisionedProductProvisioningPreferences
    StackSet preferences that are required for provisioning the product or updating a provisioned product.
    recordId String
    The ID of the record, such as rec-rjeatvy434trk .
    tags List<Tag>

    One or more tags.

    Requires the provisioned product to have an ResourceUpdateConstraint resource with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates. If RESOURCE_UPDATE constraint is not present, tags updates are ignored.

    acceptLanguage CloudFormationProvisionedProductAcceptLanguage
    The language code.

    • jp - Japanese
    • zh - Chinese
    cloudformationStackArn string
    outputs {[key: string]: string}
    List of key-value pair outputs.
    pathId string

    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths .

    You must provide the name or ID, but not both.

    pathName string

    The name of the path. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths .

    You must provide the name or ID, but not both.

    productId string

    The product identifier.

    You must specify either the ID or the name of the product, but not both.

    productName string

    The name of the Service Catalog product.

    Each time a stack is created or updated, if ProductName is provided it will successfully resolve to ProductId as long as only one product exists in the account or Region with that ProductName .

    You must specify either the name or the ID of the product, but not both.

    provisionedProductId string
    The ID of the provisioned product.
    provisioningArtifactId string

    The identifier of the provisioning artifact (also known as a version).

    You must specify either the ID or the name of the provisioning artifact, but not both.

    provisioningArtifactName string

    The name of the provisioning artifact (also known as a version) for the product. This name must be unique for the product.

    You must specify either the name or the ID of the provisioning artifact, but not both. You must also specify either the name or the ID of the product, but not both.

    provisioningParameters CloudFormationProvisionedProductProvisioningParameter[]
    Parameters specified by the administrator that are required for provisioning the product.
    provisioningPreferences CloudFormationProvisionedProductProvisioningPreferences
    StackSet preferences that are required for provisioning the product or updating a provisioned product.
    recordId string
    The ID of the record, such as rec-rjeatvy434trk .
    tags Tag[]

    One or more tags.

    Requires the provisioned product to have an ResourceUpdateConstraint resource with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates. If RESOURCE_UPDATE constraint is not present, tags updates are ignored.

    accept_language CloudFormationProvisionedProductAcceptLanguage
    The language code.

    • jp - Japanese
    • zh - Chinese
    cloudformation_stack_arn str
    outputs Mapping[str, str]
    List of key-value pair outputs.
    path_id str

    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths .

    You must provide the name or ID, but not both.

    path_name str

    The name of the path. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths .

    You must provide the name or ID, but not both.

    product_id str

    The product identifier.

    You must specify either the ID or the name of the product, but not both.

    product_name str

    The name of the Service Catalog product.

    Each time a stack is created or updated, if ProductName is provided it will successfully resolve to ProductId as long as only one product exists in the account or Region with that ProductName .

    You must specify either the name or the ID of the product, but not both.

    provisioned_product_id str
    The ID of the provisioned product.
    provisioning_artifact_id str

    The identifier of the provisioning artifact (also known as a version).

    You must specify either the ID or the name of the provisioning artifact, but not both.

    provisioning_artifact_name str

    The name of the provisioning artifact (also known as a version) for the product. This name must be unique for the product.

    You must specify either the name or the ID of the provisioning artifact, but not both. You must also specify either the name or the ID of the product, but not both.

    provisioning_parameters Sequence[CloudFormationProvisionedProductProvisioningParameter]
    Parameters specified by the administrator that are required for provisioning the product.
    provisioning_preferences CloudFormationProvisionedProductProvisioningPreferences
    StackSet preferences that are required for provisioning the product or updating a provisioned product.
    record_id str
    The ID of the record, such as rec-rjeatvy434trk .
    tags Sequence[root_Tag]

    One or more tags.

    Requires the provisioned product to have an ResourceUpdateConstraint resource with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates. If RESOURCE_UPDATE constraint is not present, tags updates are ignored.

    acceptLanguage "en" | "jp" | "zh"
    The language code.

    • jp - Japanese
    • zh - Chinese
    cloudformationStackArn String
    outputs Map<String>
    List of key-value pair outputs.
    pathId String

    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths .

    You must provide the name or ID, but not both.

    pathName String

    The name of the path. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths .

    You must provide the name or ID, but not both.

    productId String

    The product identifier.

    You must specify either the ID or the name of the product, but not both.

    productName String

    The name of the Service Catalog product.

    Each time a stack is created or updated, if ProductName is provided it will successfully resolve to ProductId as long as only one product exists in the account or Region with that ProductName .

    You must specify either the name or the ID of the product, but not both.

    provisionedProductId String
    The ID of the provisioned product.
    provisioningArtifactId String

    The identifier of the provisioning artifact (also known as a version).

    You must specify either the ID or the name of the provisioning artifact, but not both.

    provisioningArtifactName String

    The name of the provisioning artifact (also known as a version) for the product. This name must be unique for the product.

    You must specify either the name or the ID of the provisioning artifact, but not both. You must also specify either the name or the ID of the product, but not both.

    provisioningParameters List<Property Map>
    Parameters specified by the administrator that are required for provisioning the product.
    provisioningPreferences Property Map
    StackSet preferences that are required for provisioning the product or updating a provisioned product.
    recordId String
    The ID of the record, such as rec-rjeatvy434trk .
    tags List<Property Map>

    One or more tags.

    Requires the provisioned product to have an ResourceUpdateConstraint resource with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates. If RESOURCE_UPDATE constraint is not present, tags updates are ignored.

    Supporting Types

    CloudFormationProvisionedProductAcceptLanguage

    CloudFormationProvisionedProductProvisioningParameter

    Key string
    The parameter key.
    Value string
    The parameter value.
    Key string
    The parameter key.
    Value string
    The parameter value.
    key String
    The parameter key.
    value String
    The parameter value.
    key string
    The parameter key.
    value string
    The parameter value.
    key str
    The parameter key.
    value str
    The parameter value.
    key String
    The parameter key.
    value String
    The parameter value.

    CloudFormationProvisionedProductProvisioningPreferences

    StackSetAccounts List<string>

    One or more AWS 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.

    StackSetFailureToleranceCount int

    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 int

    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 int

    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 int

    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 Pulumi.AwsNative.ServiceCatalog.CloudFormationProvisionedProductProvisioningPreferencesStackSetOperationType

    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.
    StackSetRegions List<string>

    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.

    StackSetAccounts []string

    One or more AWS 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.

    StackSetFailureToleranceCount int

    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 int

    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 int

    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 int

    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 CloudFormationProvisionedProductProvisioningPreferencesStackSetOperationType

    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.
    StackSetRegions []string

    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.

    stackSetAccounts List<String>

    One or more AWS 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.

    stackSetFailureToleranceCount Integer

    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 Integer

    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 Integer

    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 Integer

    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 CloudFormationProvisionedProductProvisioningPreferencesStackSetOperationType

    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.
    stackSetRegions List<String>

    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.

    stackSetAccounts string[]

    One or more AWS 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.

    stackSetFailureToleranceCount number

    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 number

    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 number

    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 number

    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 CloudFormationProvisionedProductProvisioningPreferencesStackSetOperationType

    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.
    stackSetRegions string[]

    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.

    stack_set_accounts Sequence[str]

    One or more AWS 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.

    stack_set_failure_tolerance_count int

    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.

    stack_set_failure_tolerance_percentage int

    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.

    stack_set_max_concurrency_count int

    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.

    stack_set_max_concurrency_percentage int

    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.

    stack_set_operation_type CloudFormationProvisionedProductProvisioningPreferencesStackSetOperationType

    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.
    stack_set_regions Sequence[str]

    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.

    stackSetAccounts List<String>

    One or more AWS 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.

    stackSetFailureToleranceCount Number

    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 Number

    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 Number

    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 Number

    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 "CREATE" | "UPDATE" | "DELETE"

    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.
    stackSetRegions List<String>

    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.

    CloudFormationProvisionedProductProvisioningPreferencesStackSetOperationType

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi