/*******************************************************************************
* Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use
* this file except in compliance with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file.
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.ServiceCatalog;
using Amazon.ServiceCatalog.Model;
namespace Amazon.PowerShell.Cmdlets.SC
{
///
/// Creates a provisioning artifact (also known as a version) for the specified product.
///
///
///
/// You cannot create a provisioning artifact for a product that was shared with you.
///
/// 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.
///
///
[Cmdlet("New", "SCProvisioningArtifact", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.ServiceCatalog.Model.CreateProvisioningArtifactResponse")]
[AWSCmdlet("Calls the AWS Service Catalog CreateProvisioningArtifact API operation.", Operation = new[] {"CreateProvisioningArtifact"}, SelectReturnType = typeof(Amazon.ServiceCatalog.Model.CreateProvisioningArtifactResponse))]
[AWSCmdletOutput("Amazon.ServiceCatalog.Model.CreateProvisioningArtifactResponse",
"This cmdlet returns an Amazon.ServiceCatalog.Model.CreateProvisioningArtifactResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewSCProvisioningArtifactCmdlet : AmazonServiceCatalogClientCmdlet, IExecutor
{
#region Parameter AcceptLanguage
///
///
/// The language code.jp
- Japanesezh
- Chinese
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String AcceptLanguage { get; set; }
#endregion
#region Parameter Parameters_Description
///
///
/// The description of the provisioning artifact, including how it differs from the previous
/// provisioning artifact.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Parameters_Description { get; set; }
#endregion
#region Parameter Parameters_DisableTemplateValidation
///
///
/// If set to true, Service Catalog stops validating the specified provisioning artifact
/// even if it is invalid.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? Parameters_DisableTemplateValidation { get; set; }
#endregion
#region Parameter IdempotencyToken
///
///
/// 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String IdempotencyToken { get; set; }
#endregion
#region Parameter Parameters_Info
///
///
/// 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]
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Collections.Hashtable Parameters_Info { get; set; }
#endregion
#region Parameter Parameters_Name
///
///
/// The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Parameters_Name { get; set; }
#endregion
#region Parameter ProductId
///
///
/// The product identifier.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
#else
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String ProductId { get; set; }
#endregion
#region Parameter Parameters_Type
///
///
/// The type of provisioning artifact.CLOUD_FORMATION_TEMPLATE
- CloudFormation templateMARKETPLACE_AMI
- Amazon Web Services Marketplace AMIMARKETPLACE_CAR
- Amazon Web Services Marketplace Clusters and Amazon
/// Web Services ResourcesTERRAFORM_OPEN_SOURCE
- Terraform open source configuration file
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.ServiceCatalog.ProvisioningArtifactType")]
public Amazon.ServiceCatalog.ProvisioningArtifactType Parameters_Type { get; set; }
#endregion
#region Parameter Select
///
/// 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.CreateProvisioningArtifactResponse).
/// Specifying the name of a property of type Amazon.ServiceCatalog.Model.CreateProvisioningArtifactResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "*";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the ProductId parameter.
/// The -PassThru parameter is deprecated, use -Select '^ProductId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ProductId' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
#region Parameter Force
///
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter Force { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.ProductId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-SCProvisioningArtifact (CreateProvisioningArtifact)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
if (this.PassThru.IsPresent)
{
throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select));
}
}
else if (this.PassThru.IsPresent)
{
context.Select = (response, cmdlet) => this.ProductId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.AcceptLanguage = this.AcceptLanguage;
context.IdempotencyToken = this.IdempotencyToken;
context.Parameters_Description = this.Parameters_Description;
context.Parameters_DisableTemplateValidation = this.Parameters_DisableTemplateValidation;
if (this.Parameters_Info != null)
{
context.Parameters_Info = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.Parameters_Info.Keys)
{
context.Parameters_Info.Add((String)hashKey, (String)(this.Parameters_Info[hashKey]));
}
}
context.Parameters_Name = this.Parameters_Name;
context.Parameters_Type = this.Parameters_Type;
context.ProductId = this.ProductId;
#if MODULAR
if (this.ProductId == null && ParameterWasBound(nameof(this.ProductId)))
{
WriteWarning("You are passing $null as a value for parameter ProductId which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.ServiceCatalog.Model.CreateProvisioningArtifactRequest();
if (cmdletContext.AcceptLanguage != null)
{
request.AcceptLanguage = cmdletContext.AcceptLanguage;
}
if (cmdletContext.IdempotencyToken != null)
{
request.IdempotencyToken = cmdletContext.IdempotencyToken;
}
// populate Parameters
var requestParametersIsNull = true;
request.Parameters = new Amazon.ServiceCatalog.Model.ProvisioningArtifactProperties();
System.String requestParameters_parameters_Description = null;
if (cmdletContext.Parameters_Description != null)
{
requestParameters_parameters_Description = cmdletContext.Parameters_Description;
}
if (requestParameters_parameters_Description != null)
{
request.Parameters.Description = requestParameters_parameters_Description;
requestParametersIsNull = false;
}
System.Boolean? requestParameters_parameters_DisableTemplateValidation = null;
if (cmdletContext.Parameters_DisableTemplateValidation != null)
{
requestParameters_parameters_DisableTemplateValidation = cmdletContext.Parameters_DisableTemplateValidation.Value;
}
if (requestParameters_parameters_DisableTemplateValidation != null)
{
request.Parameters.DisableTemplateValidation = requestParameters_parameters_DisableTemplateValidation.Value;
requestParametersIsNull = false;
}
Dictionary requestParameters_parameters_Info = null;
if (cmdletContext.Parameters_Info != null)
{
requestParameters_parameters_Info = cmdletContext.Parameters_Info;
}
if (requestParameters_parameters_Info != null)
{
request.Parameters.Info = requestParameters_parameters_Info;
requestParametersIsNull = false;
}
System.String requestParameters_parameters_Name = null;
if (cmdletContext.Parameters_Name != null)
{
requestParameters_parameters_Name = cmdletContext.Parameters_Name;
}
if (requestParameters_parameters_Name != null)
{
request.Parameters.Name = requestParameters_parameters_Name;
requestParametersIsNull = false;
}
Amazon.ServiceCatalog.ProvisioningArtifactType requestParameters_parameters_Type = null;
if (cmdletContext.Parameters_Type != null)
{
requestParameters_parameters_Type = cmdletContext.Parameters_Type;
}
if (requestParameters_parameters_Type != null)
{
request.Parameters.Type = requestParameters_parameters_Type;
requestParametersIsNull = false;
}
// determine if request.Parameters should be set to null
if (requestParametersIsNull)
{
request.Parameters = null;
}
if (cmdletContext.ProductId != null)
{
request.ProductId = cmdletContext.ProductId;
}
CmdletOutput output;
// issue call
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
pipelineOutput = cmdletContext.Select(response, this);
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
return output;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.ServiceCatalog.Model.CreateProvisioningArtifactResponse CallAWSServiceOperation(IAmazonServiceCatalog client, Amazon.ServiceCatalog.Model.CreateProvisioningArtifactRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Service Catalog", "CreateProvisioningArtifact");
try
{
#if DESKTOP
return client.CreateProvisioningArtifact(request);
#elif CORECLR
return client.CreateProvisioningArtifactAsync(request).GetAwaiter().GetResult();
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public System.String AcceptLanguage { get; set; }
public System.String IdempotencyToken { get; set; }
public System.String Parameters_Description { get; set; }
public System.Boolean? Parameters_DisableTemplateValidation { get; set; }
public Dictionary Parameters_Info { get; set; }
public System.String Parameters_Name { get; set; }
public Amazon.ServiceCatalog.ProvisioningArtifactType Parameters_Type { get; set; }
public System.String ProductId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}