/*******************************************************************************
* 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
{
/// <summary>
/// Updates the specified attribute for a load balancer. You can only update one attribute
/// at a time.
///
///
/// <para>
/// The <code>update load balancer attribute</code> operation supports tag-based access
/// control via resource tags applied to the resource identified by <code>load balancer
/// name</code>. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags">Amazon
/// Lightsail Developer Guide</a>.
/// </para>
/// </summary>
[Cmdlet("Update", "LSLoadBalancerAttribute", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.Lightsail.Model.Operation")]
[AWSCmdlet("Calls the Amazon Lightsail UpdateLoadBalancerAttribute API operation.", Operation = new[] {"UpdateLoadBalancerAttribute"}, SelectReturnType = typeof(Amazon.Lightsail.Model.UpdateLoadBalancerAttributeResponse))]
[AWSCmdletOutput("Amazon.Lightsail.Model.Operation or Amazon.Lightsail.Model.UpdateLoadBalancerAttributeResponse",
"This cmdlet returns a collection of Amazon.Lightsail.Model.Operation objects.",
"The service call response (type Amazon.Lightsail.Model.UpdateLoadBalancerAttributeResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class UpdateLSLoadBalancerAttributeCmdlet : AmazonLightsailClientCmdlet, IExecutor
{
#region Parameter AttributeName
/// <summary>
/// <para>
/// <para>The name of the attribute you want to update.</para>
/// </para>
/// </summary>
#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.Lightsail.LoadBalancerAttributeName")]
public Amazon.Lightsail.LoadBalancerAttributeName AttributeName { get; set; }
#endregion
#region Parameter AttributeValue
/// <summary>
/// <para>
/// <para>The value that you want to specify for the attribute name.</para><para>The following values are supported depending on what you specify for the <code>attributeName</code>
/// request parameter:</para><ul><li><para>If you specify <code>HealthCheckPath</code> for the <code>attributeName</code> request
/// parameter, then the <code>attributeValue</code> request parameter must be the path
/// to ping on the target (for example, <code>/weather/us/wa/seattle</code>).</para></li><li><para>If you specify <code>SessionStickinessEnabled</code> for the <code>attributeName</code>
/// request parameter, then the <code>attributeValue</code> request parameter must be
/// <code>true</code> to activate session stickiness or <code>false</code> to deactivate
/// session stickiness.</para></li><li><para>If you specify <code>SessionStickiness_LB_CookieDurationSeconds</code> for the <code>attributeName</code>
/// request parameter, then the <code>attributeValue</code> request parameter must be
/// an interger that represents the cookie duration in seconds.</para></li><li><para>If you specify <code>HttpsRedirectionEnabled</code> for the <code>attributeName</code>
/// request parameter, then the <code>attributeValue</code> request parameter must be
/// <code>true</code> to activate HTTP to HTTPS redirection or <code>false</code> to deactivate
/// HTTP to HTTPS redirection.</para></li><li><para>If you specify <code>TlsPolicyName</code> for the <code>attributeName</code> request
/// parameter, then the <code>attributeValue</code> request parameter must be the name
/// of the TLS policy.</para><para>Use the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html">GetLoadBalancerTlsPolicies</a>
/// action to get a list of TLS policy names that you can specify.</para></li></ul>
/// </para>
/// </summary>
#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 AttributeValue { get; set; }
#endregion
#region Parameter LoadBalancerName
/// <summary>
/// <para>
/// <para>The name of the load balancer that you want to modify (e.g., <code>my-load-balancer</code>.</para>
/// </para>
/// </summary>
#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 LoadBalancerName { get; set; }
#endregion
#region Parameter Select
/// <summary>
/// Use the -Select parameter to control the cmdlet output. The default value is 'Operations'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Lightsail.Model.UpdateLoadBalancerAttributeResponse).
/// Specifying the name of a property of type Amazon.Lightsail.Model.UpdateLoadBalancerAttributeResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "Operations";
#endregion
#region Parameter PassThru
/// <summary>
/// Changes the cmdlet behavior to return the value passed to the LoadBalancerName parameter.
/// The -PassThru parameter is deprecated, use -Select '^LoadBalancerName' instead. This parameter will be removed in a future version.
/// </summary>
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^LoadBalancerName' 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
/// <summary>
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
/// </summary>
[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.LoadBalancerName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-LSLoadBalancerAttribute (UpdateLoadBalancerAttribute)"))
{
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<Amazon.Lightsail.Model.UpdateLoadBalancerAttributeResponse, UpdateLSLoadBalancerAttributeCmdlet>(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.LoadBalancerName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.AttributeName = this.AttributeName;
#if MODULAR
if (this.AttributeName == null && ParameterWasBound(nameof(this.AttributeName)))
{
WriteWarning("You are passing $null as a value for parameter AttributeName 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.AttributeValue = this.AttributeValue;
#if MODULAR
if (this.AttributeValue == null && ParameterWasBound(nameof(this.AttributeValue)))
{
WriteWarning("You are passing $null as a value for parameter AttributeValue 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.LoadBalancerName = this.LoadBalancerName;
#if MODULAR
if (this.LoadBalancerName == null && ParameterWasBound(nameof(this.LoadBalancerName)))
{
WriteWarning("You are passing $null as a value for parameter LoadBalancerName 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.UpdateLoadBalancerAttributeRequest();
if (cmdletContext.AttributeName != null)
{
request.AttributeName = cmdletContext.AttributeName;
}
if (cmdletContext.AttributeValue != null)
{
request.AttributeValue = cmdletContext.AttributeValue;
}
if (cmdletContext.LoadBalancerName != null)
{
request.LoadBalancerName = cmdletContext.LoadBalancerName;
}
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.UpdateLoadBalancerAttributeResponse CallAWSServiceOperation(IAmazonLightsail client, Amazon.Lightsail.Model.UpdateLoadBalancerAttributeRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Lightsail", "UpdateLoadBalancerAttribute");
try
{
#if DESKTOP
return client.UpdateLoadBalancerAttribute(request);
#elif CORECLR
return client.UpdateLoadBalancerAttributeAsync(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 Amazon.Lightsail.LoadBalancerAttributeName AttributeName { get; set; }
public System.String AttributeValue { get; set; }
public System.String LoadBalancerName { get; set; }
public System.Func<Amazon.Lightsail.Model.UpdateLoadBalancerAttributeResponse, UpdateLSLoadBalancerAttributeCmdlet, object> Select { get; set; } =
(response, cmdlet) => response.Operations;
}
}
}