AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Service Catalog ProvisionProduct API operation.

Syntax

New-SCProvisionedProduct
-ProvisionedProductName <String>
-AcceptLanguage <String>
-NotificationArn <String[]>
-PathId <String>
-PathName <String>
-ProductId <String>
-ProductName <String>
-ProvisioningArtifactId <String>
-ProvisioningArtifactName <String>
-ProvisioningParameter <ProvisioningParameter[]>
-ProvisionToken <String>
-ProvisioningPreferences_StackSetAccount <String[]>
-ProvisioningPreferences_StackSetFailureToleranceCount <Int32>
-ProvisioningPreferences_StackSetFailureTolerancePercentage <Int32>
-ProvisioningPreferences_StackSetMaxConcurrencyCount <Int32>
-ProvisioningPreferences_StackSetMaxConcurrencyPercentage <Int32>
-ProvisioningPreferences_StackSetRegion <String[]>
-Tag <Tag[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonServiceCatalogConfig>

Description

Provisions the specified product. A provisioned product is a resourced instance of a product. For example, provisioning a product that's based on an CloudFormation template launches an CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord. If the request contains a tag key with an empty list of values, there's a tag conflict for that key. Don't include conflicted keys as tags, or this will cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide.

Parameters

-AcceptLanguage <String>
The language code.
  • jp - Japanese
  • zh - Chinese
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonServiceCatalogConfig>
Amazon.PowerShell.Cmdlets.SC.AmazonServiceCatalogClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NotificationArn <String[]>
Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNotificationArns
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ProvisionedProductName parameter. The -PassThru parameter is deprecated, use -Select '^ProvisionedProductName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PathName <String>
The name of the path. You must provide the name or ID, but not both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProductId <String>
The product identifier. You must provide the name or ID, but not both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProductName <String>
The name of the product. You must provide the name or ID, but not both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProvisionedProductName <String>
A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ProvisioningArtifactId <String>
The identifier of the provisioning artifact. You must provide the name or ID, but not both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProvisioningArtifactName <String>
The name of the provisioning artifact. You must provide the name or ID, but not both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProvisioningParameter <ProvisioningParameter[]>
Parameters specified by the administrator that are required for provisioning the product.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProvisioningParameters
-ProvisioningPreferences_StackSetAccount <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProvisioningPreferences_StackSetAccounts
-ProvisioningPreferences_StackSetFailureToleranceCount <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProvisioningPreferences_StackSetFailureTolerancePercentage <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProvisioningPreferences_StackSetMaxConcurrencyCount <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProvisioningPreferences_StackSetMaxConcurrencyPercentage <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProvisioningPreferences_StackSetRegion <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProvisioningPreferences_StackSetRegions
-ProvisionToken <String>
An idempotency token that uniquely identifies the provisioning request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'RecordDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceCatalog.Model.ProvisionProductResponse). Specifying the name of a property of type Amazon.ServiceCatalog.Model.ProvisionProductResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
One or more tags.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.ServiceCatalog.Model.RecordDetail or Amazon.ServiceCatalog.Model.ProvisionProductResponse
This cmdlet returns an Amazon.ServiceCatalog.Model.RecordDetail object. The service call response (type Amazon.ServiceCatalog.Model.ProvisionProductResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
User Guide
Developer Guide
Administrator Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z