/*******************************************************************************
* 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.Lightsail;
using Amazon.Lightsail.Model;
namespace Amazon.PowerShell.Cmdlets.LS
{
///
/// Registers a container image to your Amazon Lightsail container service.
///
///
/// This action is not required if you install and use the Lightsail Control (lightsailctl)
/// plugin to push container images to your Lightsail container service. For more information,
/// see Pushing
/// and managing container images on your Amazon Lightsail container services in the
/// Amazon Lightsail Developer Guide.
///
///
[Cmdlet("Register", "LSContainerImage", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.Lightsail.Model.ContainerImage")]
[AWSCmdlet("Calls the Amazon Lightsail RegisterContainerImage API operation.", Operation = new[] {"RegisterContainerImage"}, SelectReturnType = typeof(Amazon.Lightsail.Model.RegisterContainerImageResponse))]
[AWSCmdletOutput("Amazon.Lightsail.Model.ContainerImage or Amazon.Lightsail.Model.RegisterContainerImageResponse",
"This cmdlet returns an Amazon.Lightsail.Model.ContainerImage object.",
"The service call response (type Amazon.Lightsail.Model.RegisterContainerImageResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class RegisterLSContainerImageCmdlet : AmazonLightsailClientCmdlet, IExecutor
{
#region Parameter Digest
///
///
/// The digest of the container image to be registered.
///
///
#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 Digest { get; set; }
#endregion
#region Parameter Label
///
///
/// The label for the container image when it's registered to the container service.Use a descriptive label that you can use to track the different versions of your registered
/// container images.Use the GetContainerImages action to return the container images registered
/// to a Lightsail container service. The label is the <imagelabel>
/// portion of the following image name example::container-service-1.<imagelabel>.1
If the name of your container service is mycontainerservice, and the
/// label that you specify is mystaticwebsite, then the name of the registered
/// container image will be :mycontainerservice.mystaticwebsite.1.The number at the end of these image name examples represents the version of the registered
/// container image. If you push and register another container image to the same Lightsail
/// container service, with the same label, then the version number for the new registered
/// container image will be 2. If you push and register another container
/// image, the version number will be 3, and so on.
///
///
#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 Label { get; set; }
#endregion
#region Parameter ServiceName
///
///
/// The name of the container service for which to register a container image.
///
///
#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 ServiceName { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'ContainerImage'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Lightsail.Model.RegisterContainerImageResponse).
/// Specifying the name of a property of type Amazon.Lightsail.Model.RegisterContainerImageResponse 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; } = "ContainerImage";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the ServiceName parameter.
/// The -PassThru parameter is deprecated, use -Select '^ServiceName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ServiceName' 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.ServiceName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Register-LSContainerImage (RegisterContainerImage)"))
{
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.ServiceName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.Digest = this.Digest;
#if MODULAR
if (this.Digest == null && ParameterWasBound(nameof(this.Digest)))
{
WriteWarning("You are passing $null as a value for parameter Digest 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.Label = this.Label;
#if MODULAR
if (this.Label == null && ParameterWasBound(nameof(this.Label)))
{
WriteWarning("You are passing $null as a value for parameter Label 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.ServiceName = this.ServiceName;
#if MODULAR
if (this.ServiceName == null && ParameterWasBound(nameof(this.ServiceName)))
{
WriteWarning("You are passing $null as a value for parameter ServiceName 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.Lightsail.Model.RegisterContainerImageRequest();
if (cmdletContext.Digest != null)
{
request.Digest = cmdletContext.Digest;
}
if (cmdletContext.Label != null)
{
request.Label = cmdletContext.Label;
}
if (cmdletContext.ServiceName != null)
{
request.ServiceName = cmdletContext.ServiceName;
}
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.Lightsail.Model.RegisterContainerImageResponse CallAWSServiceOperation(IAmazonLightsail client, Amazon.Lightsail.Model.RegisterContainerImageRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Lightsail", "RegisterContainerImage");
try
{
#if DESKTOP
return client.RegisterContainerImage(request);
#elif CORECLR
return client.RegisterContainerImageAsync(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 Digest { get; set; }
public System.String Label { get; set; }
public System.String ServiceName { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.ContainerImage;
}
}
}