/*******************************************************************************
* 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.MainframeModernization;
using Amazon.MainframeModernization.Model;
namespace Amazon.PowerShell.Cmdlets.AMM
{
///
/// Creates a runtime environment for a given runtime engine.
///
[Cmdlet("New", "AMMEnvironment", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the M2 CreateEnvironment API operation.", Operation = new[] {"CreateEnvironment"}, SelectReturnType = typeof(Amazon.MainframeModernization.Model.CreateEnvironmentResponse))]
[AWSCmdletOutput("System.String or Amazon.MainframeModernization.Model.CreateEnvironmentResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.MainframeModernization.Model.CreateEnvironmentResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewAMMEnvironmentCmdlet : AmazonMainframeModernizationClientCmdlet, IExecutor
{
#region Parameter Description
///
///
/// The description of the runtime environment.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Description { get; set; }
#endregion
#region Parameter HighAvailabilityConfig_DesiredCapacity
///
///
/// The number of instances in a high availability configuration. The minimum possible
/// value is 1 and the maximum is 100.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? HighAvailabilityConfig_DesiredCapacity { get; set; }
#endregion
#region Parameter EngineType
///
///
/// The engine type for the runtime environment.
///
///
#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.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[AWSConstantClassSource("Amazon.MainframeModernization.EngineType")]
public Amazon.MainframeModernization.EngineType EngineType { get; set; }
#endregion
#region Parameter EngineVersion
///
///
/// The version of the engine type for the runtime environment.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String EngineVersion { get; set; }
#endregion
#region Parameter InstanceType
///
///
/// The type of instance for the runtime environment.
///
///
#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 InstanceType { get; set; }
#endregion
#region Parameter KmsKeyId
///
///
/// The identifier of a customer managed key.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String KmsKeyId { get; set; }
#endregion
#region Parameter Name
///
///
/// The name of the runtime environment. Must be unique within the account.
///
///
#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 Name { get; set; }
#endregion
#region Parameter PreferredMaintenanceWindow
///
///
/// Configures the maintenance window you want for the runtime environment. If you do
/// not provide a value, a random system-generated value will be assigned.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String PreferredMaintenanceWindow { get; set; }
#endregion
#region Parameter PubliclyAccessible
///
///
/// Specifies whether the runtime environment is publicly accessible.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? PubliclyAccessible { get; set; }
#endregion
#region Parameter SecurityGroupId
///
///
/// The list of security groups for the VPC associated with this runtime environment.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("SecurityGroupIds")]
public System.String[] SecurityGroupId { get; set; }
#endregion
#region Parameter StorageConfiguration
///
///
/// Optional. The storage configurations for this runtime environment.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("StorageConfigurations")]
public Amazon.MainframeModernization.Model.StorageConfiguration[] StorageConfiguration { get; set; }
#endregion
#region Parameter SubnetId
///
///
/// The list of subnets associated with the VPC for this runtime environment.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("SubnetIds")]
public System.String[] SubnetId { get; set; }
#endregion
#region Parameter Tag
///
///
/// The tags for the runtime environment.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public System.Collections.Hashtable Tag { get; set; }
#endregion
#region Parameter ClientToken
///
///
/// Unique, case-sensitive identifier you provide to ensure the idempotency of the request
/// to create an environment. The service generates the clientToken when the API call
/// is triggered. The token expires after one hour, so if you retry the API within this
/// timeframe with the same clientToken, you will get the same response. The service also
/// handles deleting the clientToken after it expires.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ClientToken { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentId'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MainframeModernization.Model.CreateEnvironmentResponse).
/// Specifying the name of a property of type Amazon.MainframeModernization.Model.CreateEnvironmentResponse 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; } = "EnvironmentId";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the EngineType parameter.
/// The -PassThru parameter is deprecated, use -Select '^EngineType' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^EngineType' 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-AMMEnvironment (CreateEnvironment)"))
{
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.EngineType;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ClientToken = this.ClientToken;
context.Description = this.Description;
context.EngineType = this.EngineType;
#if MODULAR
if (this.EngineType == null && ParameterWasBound(nameof(this.EngineType)))
{
WriteWarning("You are passing $null as a value for parameter EngineType 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.EngineVersion = this.EngineVersion;
context.HighAvailabilityConfig_DesiredCapacity = this.HighAvailabilityConfig_DesiredCapacity;
context.InstanceType = this.InstanceType;
#if MODULAR
if (this.InstanceType == null && ParameterWasBound(nameof(this.InstanceType)))
{
WriteWarning("You are passing $null as a value for parameter InstanceType 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.KmsKeyId = this.KmsKeyId;
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
context.PreferredMaintenanceWindow = this.PreferredMaintenanceWindow;
context.PubliclyAccessible = this.PubliclyAccessible;
if (this.SecurityGroupId != null)
{
context.SecurityGroupId = new List(this.SecurityGroupId);
}
if (this.StorageConfiguration != null)
{
context.StorageConfiguration = new List(this.StorageConfiguration);
}
if (this.SubnetId != null)
{
context.SubnetId = new List(this.SubnetId);
}
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.MainframeModernization.Model.CreateEnvironmentRequest();
if (cmdletContext.ClientToken != null)
{
request.ClientToken = cmdletContext.ClientToken;
}
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.EngineType != null)
{
request.EngineType = cmdletContext.EngineType;
}
if (cmdletContext.EngineVersion != null)
{
request.EngineVersion = cmdletContext.EngineVersion;
}
// populate HighAvailabilityConfig
var requestHighAvailabilityConfigIsNull = true;
request.HighAvailabilityConfig = new Amazon.MainframeModernization.Model.HighAvailabilityConfig();
System.Int32? requestHighAvailabilityConfig_highAvailabilityConfig_DesiredCapacity = null;
if (cmdletContext.HighAvailabilityConfig_DesiredCapacity != null)
{
requestHighAvailabilityConfig_highAvailabilityConfig_DesiredCapacity = cmdletContext.HighAvailabilityConfig_DesiredCapacity.Value;
}
if (requestHighAvailabilityConfig_highAvailabilityConfig_DesiredCapacity != null)
{
request.HighAvailabilityConfig.DesiredCapacity = requestHighAvailabilityConfig_highAvailabilityConfig_DesiredCapacity.Value;
requestHighAvailabilityConfigIsNull = false;
}
// determine if request.HighAvailabilityConfig should be set to null
if (requestHighAvailabilityConfigIsNull)
{
request.HighAvailabilityConfig = null;
}
if (cmdletContext.InstanceType != null)
{
request.InstanceType = cmdletContext.InstanceType;
}
if (cmdletContext.KmsKeyId != null)
{
request.KmsKeyId = cmdletContext.KmsKeyId;
}
if (cmdletContext.Name != null)
{
request.Name = cmdletContext.Name;
}
if (cmdletContext.PreferredMaintenanceWindow != null)
{
request.PreferredMaintenanceWindow = cmdletContext.PreferredMaintenanceWindow;
}
if (cmdletContext.PubliclyAccessible != null)
{
request.PubliclyAccessible = cmdletContext.PubliclyAccessible.Value;
}
if (cmdletContext.SecurityGroupId != null)
{
request.SecurityGroupIds = cmdletContext.SecurityGroupId;
}
if (cmdletContext.StorageConfiguration != null)
{
request.StorageConfigurations = cmdletContext.StorageConfiguration;
}
if (cmdletContext.SubnetId != null)
{
request.SubnetIds = cmdletContext.SubnetId;
}
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.MainframeModernization.Model.CreateEnvironmentResponse CallAWSServiceOperation(IAmazonMainframeModernization client, Amazon.MainframeModernization.Model.CreateEnvironmentRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "M2", "CreateEnvironment");
try
{
#if DESKTOP
return client.CreateEnvironment(request);
#elif CORECLR
return client.CreateEnvironmentAsync(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 ClientToken { get; set; }
public System.String Description { get; set; }
public Amazon.MainframeModernization.EngineType EngineType { get; set; }
public System.String EngineVersion { get; set; }
public System.Int32? HighAvailabilityConfig_DesiredCapacity { get; set; }
public System.String InstanceType { get; set; }
public System.String KmsKeyId { get; set; }
public System.String Name { get; set; }
public System.String PreferredMaintenanceWindow { get; set; }
public System.Boolean? PubliclyAccessible { get; set; }
public List SecurityGroupId { get; set; }
public List StorageConfiguration { get; set; }
public List SubnetId { get; set; }
public Dictionary Tag { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.EnvironmentId;
}
}
}