/*******************************************************************************
* 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.LocationService;
using Amazon.LocationService.Model;
namespace Amazon.PowerShell.Cmdlets.LOC
{
///
/// Creates a geofence collection, which manages and stores geofences.
///
[Cmdlet("New", "LOCGeofenceCollection", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.LocationService.Model.CreateGeofenceCollectionResponse")]
[AWSCmdlet("Calls the Amazon Location Service CreateGeofenceCollection API operation.", Operation = new[] {"CreateGeofenceCollection"}, SelectReturnType = typeof(Amazon.LocationService.Model.CreateGeofenceCollectionResponse))]
[AWSCmdletOutput("Amazon.LocationService.Model.CreateGeofenceCollectionResponse",
"This cmdlet returns an Amazon.LocationService.Model.CreateGeofenceCollectionResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewLOCGeofenceCollectionCmdlet : AmazonLocationServiceClientCmdlet, IExecutor
{
#region Parameter CollectionName
///
///
/// A custom name for the geofence collection.Requirements:- Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and
/// underscores (_).
- Must be a unique geofence collection name.
- No spaces allowed. For example,
ExampleGeofenceCollection
.
///
///
#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 CollectionName { get; set; }
#endregion
#region Parameter Description
///
///
/// An optional description for the geofence collection.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Description { get; set; }
#endregion
#region Parameter KmsKeyId
///
///
/// A key identifier for an Amazon
/// Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or
/// alias ARN.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String KmsKeyId { get; set; }
#endregion
#region Parameter Tag
///
///
/// Applies one or more tags to the geofence collection. A tag is a key-value pair helps
/// manage, identify, search, and filter your resources by labelling them.Format: "key" : "value"
Restrictions:- Maximum 50 tags per resource
- Each resource tag must be unique with a maximum of one value.
- Maximum key length: 128 Unicode characters in UTF-8
- Maximum value length: 256 Unicode characters in UTF-8
- Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + -
/// = . _ : / @.
- Cannot use "aws:" as a prefix for a key.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public System.Collections.Hashtable Tag { get; set; }
#endregion
#region Parameter PricingPlan
///
///
/// No longer used. If included, the only allowed value is RequestBasedUsage
.
///
/// This parameter is deprecated.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[System.ObsoleteAttribute("Deprecated. If included, the only allowed value is RequestBasedUsage.")]
[AWSConstantClassSource("Amazon.LocationService.PricingPlan")]
public Amazon.LocationService.PricingPlan PricingPlan { get; set; }
#endregion
#region Parameter PricingPlanDataSource
///
///
/// This parameter is no longer used.
///
/// This parameter is deprecated.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[System.ObsoleteAttribute("Deprecated. No longer allowed.")]
public System.String PricingPlanDataSource { 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.LocationService.Model.CreateGeofenceCollectionResponse).
/// Specifying the name of a property of type Amazon.LocationService.Model.CreateGeofenceCollectionResponse 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 CollectionName parameter.
/// The -PassThru parameter is deprecated, use -Select '^CollectionName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^CollectionName' 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.CollectionName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-LOCGeofenceCollection (CreateGeofenceCollection)"))
{
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.CollectionName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.CollectionName = this.CollectionName;
#if MODULAR
if (this.CollectionName == null && ParameterWasBound(nameof(this.CollectionName)))
{
WriteWarning("You are passing $null as a value for parameter CollectionName 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.Description = this.Description;
context.KmsKeyId = this.KmsKeyId;
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.PricingPlan = this.PricingPlan;
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.PricingPlanDataSource = this.PricingPlanDataSource;
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
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]));
}
}
// 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.LocationService.Model.CreateGeofenceCollectionRequest();
if (cmdletContext.CollectionName != null)
{
request.CollectionName = cmdletContext.CollectionName;
}
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.KmsKeyId != null)
{
request.KmsKeyId = cmdletContext.KmsKeyId;
}
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (cmdletContext.PricingPlan != null)
{
request.PricingPlan = cmdletContext.PricingPlan;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (cmdletContext.PricingPlanDataSource != null)
{
request.PricingPlanDataSource = cmdletContext.PricingPlanDataSource;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
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.LocationService.Model.CreateGeofenceCollectionResponse CallAWSServiceOperation(IAmazonLocationService client, Amazon.LocationService.Model.CreateGeofenceCollectionRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Location Service", "CreateGeofenceCollection");
try
{
#if DESKTOP
return client.CreateGeofenceCollection(request);
#elif CORECLR
return client.CreateGeofenceCollectionAsync(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 CollectionName { get; set; }
public System.String Description { get; set; }
public System.String KmsKeyId { get; set; }
[System.ObsoleteAttribute]
public Amazon.LocationService.PricingPlan PricingPlan { get; set; }
[System.ObsoleteAttribute]
public System.String PricingPlanDataSource { get; set; }
public Dictionary Tag { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}