/*******************************************************************************
* 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.GlobalAccelerator;
using Amazon.GlobalAccelerator.Model;
namespace Amazon.PowerShell.Cmdlets.GACL
{
///
/// Create an accelerator. An accelerator includes one or more listeners that process
/// inbound connections and direct traffic to one or more endpoint groups, each of which
/// includes endpoints, such as Network Load Balancers.
///
///
/// Global Accelerator is a global service that supports endpoints in multiple Amazon
/// Web Services Regions but you must specify the US West (Oregon) Region to create, update,
/// or otherwise work with accelerators. That is, for example, specify --region
/// us-west-2
on AWS CLI commands.
///
///
[Cmdlet("New", "GACLAccelerator", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.GlobalAccelerator.Model.Accelerator")]
[AWSCmdlet("Calls the AWS Global Accelerator CreateAccelerator API operation.", Operation = new[] {"CreateAccelerator"}, SelectReturnType = typeof(Amazon.GlobalAccelerator.Model.CreateAcceleratorResponse))]
[AWSCmdletOutput("Amazon.GlobalAccelerator.Model.Accelerator or Amazon.GlobalAccelerator.Model.CreateAcceleratorResponse",
"This cmdlet returns an Amazon.GlobalAccelerator.Model.Accelerator object.",
"The service call response (type Amazon.GlobalAccelerator.Model.CreateAcceleratorResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewGACLAcceleratorCmdlet : AmazonGlobalAcceleratorClientCmdlet, IExecutor
{
#region Parameter Enabled
///
///
/// Indicates whether an accelerator is enabled. The value is true or false. The default
/// value is true. If the value is set to true, an accelerator cannot be deleted. If set to false, the
/// accelerator can be deleted.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? Enabled { get; set; }
#endregion
#region Parameter IdempotencyToken
///
///
/// A unique, case-sensitive identifier that you provide to ensure the idempotency—that
/// is, the uniqueness—of an accelerator.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String IdempotencyToken { get; set; }
#endregion
#region Parameter IpAddress
///
///
/// Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP),
/// you can choose an IPv4 address from your own pool to use for the accelerator's static
/// IPv4 address when you create an accelerator. After you bring an address range to Amazon Web Services, it appears in your account
/// as an address pool. When you create an accelerator, you can assign one IPv4 address
/// from your range to it. Global Accelerator assigns you a second static IPv4 address
/// from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web
/// Services, you can assign one IPv4 address from each range to your accelerator. This
/// restriction is because Global Accelerator assigns each address range to a different
/// network zone, for high availability.You can specify one or two addresses, separated by a space. Do not include the /32
/// suffix.Note that you can't update IP addresses for an existing accelerator. To change them,
/// you must create a new accelerator with the new addresses.For more information, see Bring
/// your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("IpAddresses")]
public System.String[] IpAddress { get; set; }
#endregion
#region Parameter IpAddressType
///
///
/// The IP address type that an accelerator supports. For a standard accelerator, the
/// value can be IPV4 or DUAL_STACK.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.GlobalAccelerator.IpAddressType")]
public Amazon.GlobalAccelerator.IpAddressType IpAddressType { get; set; }
#endregion
#region Parameter Name
///
///
/// The name of the accelerator. The name can have a maximum of 64 characters, must contain
/// only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end
/// with a hyphen or period.
///
///
#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 Tag
///
///
/// Create tags for an accelerator.For more information, see Tagging
/// in Global Accelerator in the Global Accelerator Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public Amazon.GlobalAccelerator.Model.Tag[] Tag { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'Accelerator'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GlobalAccelerator.Model.CreateAcceleratorResponse).
/// Specifying the name of a property of type Amazon.GlobalAccelerator.Model.CreateAcceleratorResponse 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; } = "Accelerator";
#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-GACLAccelerator (CreateAccelerator)"))
{
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.Enabled = this.Enabled;
context.IdempotencyToken = this.IdempotencyToken;
if (this.IpAddress != null)
{
context.IpAddress = new List(this.IpAddress);
}
context.IpAddressType = this.IpAddressType;
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
if (this.Tag != null)
{
context.Tag = new List(this.Tag);
}
// 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.GlobalAccelerator.Model.CreateAcceleratorRequest();
if (cmdletContext.Enabled != null)
{
request.Enabled = cmdletContext.Enabled.Value;
}
if (cmdletContext.IdempotencyToken != null)
{
request.IdempotencyToken = cmdletContext.IdempotencyToken;
}
if (cmdletContext.IpAddress != null)
{
request.IpAddresses = cmdletContext.IpAddress;
}
if (cmdletContext.IpAddressType != null)
{
request.IpAddressType = cmdletContext.IpAddressType;
}
if (cmdletContext.Name != null)
{
request.Name = cmdletContext.Name;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
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.GlobalAccelerator.Model.CreateAcceleratorResponse CallAWSServiceOperation(IAmazonGlobalAccelerator client, Amazon.GlobalAccelerator.Model.CreateAcceleratorRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Global Accelerator", "CreateAccelerator");
try
{
#if DESKTOP
return client.CreateAccelerator(request);
#elif CORECLR
return client.CreateAcceleratorAsync(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.Boolean? Enabled { get; set; }
public System.String IdempotencyToken { get; set; }
public List IpAddress { get; set; }
public Amazon.GlobalAccelerator.IpAddressType IpAddressType { get; set; }
public System.String Name { get; set; }
public List Tag { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Accelerator;
}
}
}