/******************************************************************************* * 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.Imagebuilder; using Amazon.Imagebuilder.Model; namespace Amazon.PowerShell.Cmdlets.EC2IB { /// /// Creates a new component that can be used to build, validate, test, and assess your /// image. The component is based on a YAML document that you specify using exactly one /// of the following methods: /// /// /// [Cmdlet("New", "EC2IBComponent", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the EC2 Image Builder CreateComponent API operation.", Operation = new[] {"CreateComponent"}, SelectReturnType = typeof(Amazon.Imagebuilder.Model.CreateComponentResponse))] [AWSCmdletOutput("System.String or Amazon.Imagebuilder.Model.CreateComponentResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.Imagebuilder.Model.CreateComponentResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewEC2IBComponentCmdlet : AmazonImagebuilderClientCmdlet, IExecutor { #region Parameter ChangeDescription /// /// /// The change description of the component. Describes what change has been made in this /// version, or what makes this version different from other versions of this component. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ChangeDescription { get; set; } #endregion #region Parameter Data /// /// /// Component data contains inline YAML document content for the component. /// Alternatively, you can specify the uri of a YAML document file stored /// in Amazon S3. However, you cannot specify both properties. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Data { get; set; } #endregion #region Parameter Description /// /// /// Describes the contents of the component. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter KmsKeyId /// /// /// The ID of the KMS key that is used to encrypt this component. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String KmsKeyId { get; set; } #endregion #region Parameter Name /// /// /// The name of the component. /// /// #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 Name { get; set; } #endregion #region Parameter Platform /// /// /// The operating system platform of the component. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [AWSConstantClassSource("Amazon.Imagebuilder.Platform")] public Amazon.Imagebuilder.Platform Platform { get; set; } #endregion #region Parameter SemanticVersion /// /// /// The semantic version of the component. This version follows the semantic version syntax.The semantic version has four nodes: <major>.<minor>.<patch>/<build>. /// You can assign values for the first three, and can filter on all of them.Assignment: For the first three nodes you can assign any positive integer /// value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. /// Image Builder automatically assigns the build number to the fourth node.Patterns: You can use any numeric pattern that adheres to the assignment requirements /// for the nodes that you can assign. For example, you might choose a software version /// pattern, such as 1.0.0, or a date, such as 2021.01.01. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String SemanticVersion { get; set; } #endregion #region Parameter SupportedOsVersion /// /// /// The operating system (OS) version supported by the component. If the OS information /// is available, a prefix match is performed against the base image OS version during /// image recipe creation. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("SupportedOsVersions")] public System.String[] SupportedOsVersion { get; set; } #endregion #region Parameter Tag /// /// /// The tags that apply to the component. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public System.Collections.Hashtable Tag { get; set; } #endregion #region Parameter Uri /// /// /// The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key), /// and the requester must have permission to access the S3 bucket it points to. If you /// use Amazon S3, you can specify component content up to your service quota.Alternatively, you can specify the YAML document inline, using the component data /// property. You cannot specify both properties. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Uri { get; set; } #endregion #region Parameter ClientToken /// /// /// The idempotency token of the component. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ClientToken { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'ComponentBuildVersionArn'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.CreateComponentResponse). /// Specifying the name of a property of type Amazon.Imagebuilder.Model.CreateComponentResponse 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; } = "ComponentBuildVersionArn"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the Name parameter. /// The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Name' 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.Name), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-EC2IBComponent (CreateComponent)")) { 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.Name; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ChangeDescription = this.ChangeDescription; context.ClientToken = this.ClientToken; context.Data = this.Data; context.Description = this.Description; context.KmsKeyId = this.KmsKeyId; context.Name = this.Name; #if MODULAR if (this.Name == null && ParameterWasBound(nameof(this.Name))) { WriteWarning("You are passing $null as a value for parameter Name 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 context.Platform = this.Platform; #if MODULAR if (this.Platform == null && ParameterWasBound(nameof(this.Platform))) { WriteWarning("You are passing $null as a value for parameter Platform 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 context.SemanticVersion = this.SemanticVersion; #if MODULAR if (this.SemanticVersion == null && ParameterWasBound(nameof(this.SemanticVersion))) { WriteWarning("You are passing $null as a value for parameter SemanticVersion 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 if (this.SupportedOsVersion != null) { context.SupportedOsVersion = new List(this.SupportedOsVersion); } if (this.Tag != null) { context.Tag = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.Tag.Keys) { context.Tag.Add((String)hashKey, (String)(this.Tag[hashKey])); } } context.Uri = this.Uri; // 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.Imagebuilder.Model.CreateComponentRequest(); if (cmdletContext.ChangeDescription != null) { request.ChangeDescription = cmdletContext.ChangeDescription; } if (cmdletContext.ClientToken != null) { request.ClientToken = cmdletContext.ClientToken; } if (cmdletContext.Data != null) { request.Data = cmdletContext.Data; } if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } if (cmdletContext.KmsKeyId != null) { request.KmsKeyId = cmdletContext.KmsKeyId; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } if (cmdletContext.Platform != null) { request.Platform = cmdletContext.Platform; } if (cmdletContext.SemanticVersion != null) { request.SemanticVersion = cmdletContext.SemanticVersion; } if (cmdletContext.SupportedOsVersion != null) { request.SupportedOsVersions = cmdletContext.SupportedOsVersion; } if (cmdletContext.Tag != null) { request.Tags = cmdletContext.Tag; } if (cmdletContext.Uri != null) { request.Uri = cmdletContext.Uri; } 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.Imagebuilder.Model.CreateComponentResponse CallAWSServiceOperation(IAmazonImagebuilder client, Amazon.Imagebuilder.Model.CreateComponentRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "EC2 Image Builder", "CreateComponent"); try { #if DESKTOP return client.CreateComponent(request); #elif CORECLR return client.CreateComponentAsync(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 ChangeDescription { get; set; } public System.String ClientToken { get; set; } public System.String Data { get; set; } public System.String Description { get; set; } public System.String KmsKeyId { get; set; } public System.String Name { get; set; } public Amazon.Imagebuilder.Platform Platform { get; set; } public System.String SemanticVersion { get; set; } public List SupportedOsVersion { get; set; } public Dictionary Tag { get; set; } public System.String Uri { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.ComponentBuildVersionArn; } } }