/*******************************************************************************
* 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 map resource in your Amazon Web Services account, which provides map tiles
/// of different styles sourced from global location data providers.
///
///
/// If your application is tracking or routing assets you use in your business, such as
/// delivery vehicles or employees, you must not use Esri as your geolocation provider.
/// See section 82 of the Amazon Web Services
/// service terms for more details.
///
///
[Cmdlet("New", "LOCMap", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.LocationService.Model.CreateMapResponse")]
[AWSCmdlet("Calls the Amazon Location Service CreateMap API operation.", Operation = new[] {"CreateMap"}, SelectReturnType = typeof(Amazon.LocationService.Model.CreateMapResponse))]
[AWSCmdletOutput("Amazon.LocationService.Model.CreateMapResponse",
"This cmdlet returns an Amazon.LocationService.Model.CreateMapResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewLOCMapCmdlet : AmazonLocationServiceClientCmdlet, IExecutor
{
#region Parameter Description
///
///
/// An optional description for the map resource.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Description { get; set; }
#endregion
#region Parameter MapName
///
///
/// The name for the map resource.Requirements:- Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.),
/// and underscores (_).
- Must be a unique map resource name.
- No spaces allowed. For example,
ExampleMap
.
///
///
#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 MapName { get; set; }
#endregion
#region Parameter Configuration_PoliticalView
///
///
/// Specifies the political view for the style. Leave unset to not use a political view,
/// or, for styles that support specific political views, you can choose a view, such
/// as IND
for the Indian view.Default is unset.Not all map resources or styles support political view styles. See Political
/// views for more information.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Configuration_PoliticalView { get; set; }
#endregion
#region Parameter Configuration_Style
///
///
/// Specifies the map style selected from an available data provider.Valid Esri
/// map styles:VectorEsriDarkGrayCanvas
– The Esri Dark Gray Canvas map style. A vector
/// basemap with a dark gray, neutral background with minimal colors, labels, and features
/// that's designed to draw attention to your thematic content. RasterEsriImagery
– The Esri Imagery map style. A raster basemap that
/// provides one meter or better satellite and aerial imagery in many parts of the world
/// and lower resolution satellite imagery worldwide. VectorEsriLightGrayCanvas
– The Esri Light Gray Canvas map style, which
/// provides a detailed vector basemap with a light gray, neutral background style with
/// minimal colors, labels, and features that's designed to draw attention to your thematic
/// content. VectorEsriTopographic
– The Esri Light map style, which provides a detailed
/// vector basemap with a classic Esri map style.VectorEsriStreets
– The Esri Street Map style, which provides a detailed
/// vector basemap for the world symbolized with a classic Esri street map style. The
/// vector tile layer is similar in content and style to the World Street Map raster map.VectorEsriNavigation
– The Esri Navigation map style, which provides
/// a detailed basemap for the world symbolized with a custom navigation map style that's
/// designed for use during the day in mobile devices.
Valid HERE
/// Technologies map styles:VectorHereContrast
– The HERE Contrast (Berlin) map style is a high
/// contrast detailed base map of the world that blends 3D and 2D rendering.The VectorHereContrast
style has been renamed from VectorHereBerlin
.
/// VectorHereBerlin
has been deprecated, but will continue to work in applications
/// that use it.VectorHereExplore
– A default HERE map style containing a neutral, global
/// map and its features including roads, buildings, landmarks, and water features. It
/// also now includes a fully designed map of Japan.VectorHereExploreTruck
– A global map containing truck restrictions
/// and attributes (e.g. width / height / HAZMAT) symbolized with highlighted segments
/// and icons on top of HERE Explore to support use cases within transport and logistics.RasterHereExploreSatellite
– A global map containing high resolution
/// satellite imagery.HybridHereExploreSatellite
– A global map displaying the road network,
/// street names, and city labels over satellite imagery. This style will automatically
/// retrieve both raster and vector tiles, and your charges will be based on total tiles
/// retrieved.Hybrid styles use both vector and raster tiles when rendering the map that you see.
/// This means that more tiles are retrieved than when using either vector or raster tiles
/// alone. Your charges will include all tiles retrieved.
Valid GrabMaps
/// map styles:VectorGrabStandardLight
– The Grab Standard Light map style provides
/// a basemap with detailed land use coloring, area names, roads, landmarks, and points
/// of interest covering Southeast Asia.VectorGrabStandardDark
– The Grab Standard Dark map style provides a
/// dark variation of the standard basemap covering Southeast Asia.
Grab provides maps only for countries in Southeast Asia, and is only available in
/// the Asia Pacific (Singapore) Region (ap-southeast-1
). For more information,
/// see GrabMaps
/// countries and area covered.Valid Open
/// Data map styles:VectorOpenDataStandardLight
– The Open Data Standard Light map style
/// provides a detailed basemap for the world suitable for website and mobile application
/// use. The map includes highways major roads, minor roads, railways, water features,
/// cities, parks, landmarks, building footprints, and administrative boundaries.VectorOpenDataStandardDark
– Open Data Standard Dark is a dark-themed
/// map style that provides a detailed basemap for the world suitable for website and
/// mobile application use. The map includes highways major roads, minor roads, railways,
/// water features, cities, parks, landmarks, building footprints, and administrative
/// boundaries.VectorOpenDataVisualizationLight
– The Open Data Visualization Light
/// map style is a light-themed style with muted colors and fewer features that aids in
/// understanding overlaid data.VectorOpenDataVisualizationDark
– The Open Data Visualization Dark map
/// style is a dark-themed style with muted colors and fewer features that aids in understanding
/// overlaid data.
///
///
#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 Configuration_Style { get; set; }
#endregion
#region Parameter Tag
///
///
/// Applies one or more tags to the map resource. 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 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.CreateMapResponse).
/// Specifying the name of a property of type Amazon.LocationService.Model.CreateMapResponse 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 MapName parameter.
/// The -PassThru parameter is deprecated, use -Select '^MapName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^MapName' 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.MapName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-LOCMap (CreateMap)"))
{
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.MapName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.Configuration_PoliticalView = this.Configuration_PoliticalView;
context.Configuration_Style = this.Configuration_Style;
#if MODULAR
if (this.Configuration_Style == null && ParameterWasBound(nameof(this.Configuration_Style)))
{
WriteWarning("You are passing $null as a value for parameter Configuration_Style 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.MapName = this.MapName;
#if MODULAR
if (this.MapName == null && ParameterWasBound(nameof(this.MapName)))
{
WriteWarning("You are passing $null as a value for parameter MapName 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
#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
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.CreateMapRequest();
// populate Configuration
var requestConfigurationIsNull = true;
request.Configuration = new Amazon.LocationService.Model.MapConfiguration();
System.String requestConfiguration_configuration_PoliticalView = null;
if (cmdletContext.Configuration_PoliticalView != null)
{
requestConfiguration_configuration_PoliticalView = cmdletContext.Configuration_PoliticalView;
}
if (requestConfiguration_configuration_PoliticalView != null)
{
request.Configuration.PoliticalView = requestConfiguration_configuration_PoliticalView;
requestConfigurationIsNull = false;
}
System.String requestConfiguration_configuration_Style = null;
if (cmdletContext.Configuration_Style != null)
{
requestConfiguration_configuration_Style = cmdletContext.Configuration_Style;
}
if (requestConfiguration_configuration_Style != null)
{
request.Configuration.Style = requestConfiguration_configuration_Style;
requestConfigurationIsNull = false;
}
// determine if request.Configuration should be set to null
if (requestConfigurationIsNull)
{
request.Configuration = null;
}
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.MapName != null)
{
request.MapName = cmdletContext.MapName;
}
#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
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.CreateMapResponse CallAWSServiceOperation(IAmazonLocationService client, Amazon.LocationService.Model.CreateMapRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Location Service", "CreateMap");
try
{
#if DESKTOP
return client.CreateMap(request);
#elif CORECLR
return client.CreateMapAsync(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 Configuration_PoliticalView { get; set; }
public System.String Configuration_Style { get; set; }
public System.String Description { get; set; }
public System.String MapName { get; set; }
[System.ObsoleteAttribute]
public Amazon.LocationService.PricingPlan PricingPlan { get; set; }
public Dictionary Tag { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}