/******************************************************************************* * 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.AppConfigData; using Amazon.AppConfigData.Model; namespace Amazon.PowerShell.Cmdlets.ACD { /// /// Starts a configuration session used to retrieve a deployed configuration. For more /// information about this API action and to view example CLI commands that show how to /// use it with the GetLatestConfiguration API action, see Retrieving /// the configuration in the AppConfig User Guide. /// [Cmdlet("Start", "ACDConfigurationSession", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the AWS AppConfig Data StartConfigurationSession API operation.", Operation = new[] {"StartConfigurationSession"}, SelectReturnType = typeof(Amazon.AppConfigData.Model.StartConfigurationSessionResponse))] [AWSCmdletOutput("System.String or Amazon.AppConfigData.Model.StartConfigurationSessionResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.AppConfigData.Model.StartConfigurationSessionResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class StartACDConfigurationSessionCmdlet : AmazonAppConfigDataClientCmdlet, IExecutor { #region Parameter ApplicationIdentifier /// /// /// The application ID or the application name. /// /// #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 ApplicationIdentifier { get; set; } #endregion #region Parameter ConfigurationProfileIdentifier /// /// /// The configuration profile ID or the configuration profile name. /// /// #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 ConfigurationProfileIdentifier { get; set; } #endregion #region Parameter EnvironmentIdentifier /// /// /// The environment ID or the environment name. /// /// #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 EnvironmentIdentifier { get; set; } #endregion #region Parameter RequiredMinimumPollIntervalInSecond /// /// /// Sets a constraint on a session. If you specify a value of, for example, 60 seconds, /// then the client that established the session can't call GetLatestConfiguration /// more frequently than every 60 seconds. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("RequiredMinimumPollIntervalInSeconds")] public System.Int32? RequiredMinimumPollIntervalInSecond { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'InitialConfigurationToken'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppConfigData.Model.StartConfigurationSessionResponse). /// Specifying the name of a property of type Amazon.AppConfigData.Model.StartConfigurationSessionResponse 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; } = "InitialConfigurationToken"; #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 = string.Empty; if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Start-ACDConfigurationSession (StartConfigurationSession)")) { return; } var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); } context.ApplicationIdentifier = this.ApplicationIdentifier; #if MODULAR if (this.ApplicationIdentifier == null && ParameterWasBound(nameof(this.ApplicationIdentifier))) { WriteWarning("You are passing $null as a value for parameter ApplicationIdentifier 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.ConfigurationProfileIdentifier = this.ConfigurationProfileIdentifier; #if MODULAR if (this.ConfigurationProfileIdentifier == null && ParameterWasBound(nameof(this.ConfigurationProfileIdentifier))) { WriteWarning("You are passing $null as a value for parameter ConfigurationProfileIdentifier 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.EnvironmentIdentifier = this.EnvironmentIdentifier; #if MODULAR if (this.EnvironmentIdentifier == null && ParameterWasBound(nameof(this.EnvironmentIdentifier))) { WriteWarning("You are passing $null as a value for parameter EnvironmentIdentifier 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.RequiredMinimumPollIntervalInSecond = this.RequiredMinimumPollIntervalInSecond; // 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.AppConfigData.Model.StartConfigurationSessionRequest(); if (cmdletContext.ApplicationIdentifier != null) { request.ApplicationIdentifier = cmdletContext.ApplicationIdentifier; } if (cmdletContext.ConfigurationProfileIdentifier != null) { request.ConfigurationProfileIdentifier = cmdletContext.ConfigurationProfileIdentifier; } if (cmdletContext.EnvironmentIdentifier != null) { request.EnvironmentIdentifier = cmdletContext.EnvironmentIdentifier; } if (cmdletContext.RequiredMinimumPollIntervalInSecond != null) { request.RequiredMinimumPollIntervalInSeconds = cmdletContext.RequiredMinimumPollIntervalInSecond.Value; } 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.AppConfigData.Model.StartConfigurationSessionResponse CallAWSServiceOperation(IAmazonAppConfigData client, Amazon.AppConfigData.Model.StartConfigurationSessionRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS AppConfig Data", "StartConfigurationSession"); try { #if DESKTOP return client.StartConfigurationSession(request); #elif CORECLR return client.StartConfigurationSessionAsync(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 ApplicationIdentifier { get; set; } public System.String ConfigurationProfileIdentifier { get; set; } public System.String EnvironmentIdentifier { get; set; } public System.Int32? RequiredMinimumPollIntervalInSecond { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.InitialConfigurationToken; } } }