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 CreateProduct API operation.

Syntax

New-SCProduct
-AcceptLanguage <String>
-CodeStar_ArtifactPath <String>
-CodeStar_Branch <String>
-CodeStar_ConnectionArn <String>
-Description <String>
-ProvisioningArtifactParameters_Description <String>
-ProvisioningArtifactParameters_DisableTemplateValidation <Boolean>
-Distributor <String>
-IdempotencyToken <String>
-ProvisioningArtifactParameters_Info <Hashtable>
-Name <String>
-ProvisioningArtifactParameters_Name <String>
-ProductType <ProductType>
-CodeStar_Repository <String>
-SupportDescription <String>
-SupportEmail <String>
-SupportUrl <String>
-Tag <Tag[]>
-ProvisioningArtifactParameters_Type <ProvisioningArtifactType>
-SourceConnection_Type <SourceType>
-Owner <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonServiceCatalogConfig>

Description

Creates a product. A delegated admin is authorized to invoke this command. The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.

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)
-CodeStar_ArtifactPath <String>
The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceConnection_ConnectionParameters_CodeStar_ArtifactPath
-CodeStar_Branch <String>
The specific branch where the artifact resides.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceConnection_ConnectionParameters_CodeStar_Branch
-CodeStar_ConnectionArn <String>
The CodeStar ARN, which is the connection between Service Catalog and the external repository.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceConnection_ConnectionParameters_CodeStar_ConnectionArn
-CodeStar_Repository <String>
The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceConnection_ConnectionParameters_CodeStar_Repository
-Description <String>
The description of the product.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Distributor <String>
The distributor of the product.
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)
-IdempotencyToken <String>
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The name of the product.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Owner <String>
The owner of the product.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProductType <ProductType>
The type of product.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProvisioningArtifactParameters_Description <String>
The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProvisioningArtifactParameters_DisableTemplateValidation <Boolean>
If set to true, Service Catalog stops validating the specified provisioning artifact even if it is invalid. Service Catalog does not support template validation for the TERRAFORM_OS product type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProvisioningArtifactParameters_Info <Hashtable>
Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ]The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format. Specify the URL in JSON format as follows:"LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."ImportFromPhysicalId: The physical id of the resource that contains the template. Currently only supports CloudFormation stack arn. Specify the physical id in JSON format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId] Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProvisioningArtifactParameters_Name <String>
The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProvisioningArtifactParameters_Type <ProvisioningArtifactType>
The type of provisioning artifact.
  • CLOUD_FORMATION_TEMPLATE - CloudFormation template
  • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file
  • TERRAFORM_CLOUD - Terraform Cloud configuration file
  • EXTERNAL - External configuration file
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceCatalog.Model.CreateProductResponse). Specifying the name of a property of type Amazon.ServiceCatalog.Model.CreateProductResponse 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)
-SourceConnection_Type <SourceType>
The only supported SourceConnection type is Codestar.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SupportDescription <String>
The support information about the product.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SupportEmail <String>
The contact email for product support.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SupportUrl <String>
The contact URL for product support.^https?:\/\// / is the pattern used to validate SupportUrl.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
One or more tags. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
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.CreateProductResponse
This cmdlet returns an Amazon.ServiceCatalog.Model.CreateProductResponse object containing multiple properties.
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