/*******************************************************************************
* 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.WAFV2;
using Amazon.WAFV2.Model;
namespace Amazon.PowerShell.Cmdlets.WAF2
{
///
/// Creates an API key that contains a set of token domains.
///
///
///
/// API keys are required for the integration of the CAPTCHA API in your JavaScript client
/// applications. The API lets you customize the placement and characteristics of the
/// CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript
/// integration, see WAF
/// client application integration in the WAF Developer Guide.
///
/// You can use a single key for up to 5 domains. After you generate a key, you can copy
/// it for use in your JavaScript integration.
///
///
[Cmdlet("New", "WAF2APIKey", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the AWS WAF V2 CreateAPIKey API operation.", Operation = new[] {"CreateAPIKey"}, SelectReturnType = typeof(Amazon.WAFV2.Model.CreateAPIKeyResponse))]
[AWSCmdletOutput("System.String or Amazon.WAFV2.Model.CreateAPIKeyResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.WAFV2.Model.CreateAPIKeyResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewWAF2APIKeyCmdlet : AmazonWAFV2ClientCmdlet, IExecutor
{
#region Parameter Scope
///
///
/// Specifies whether this is for an Amazon CloudFront distribution or for a regional
/// application. A regional application can be an Application Load Balancer (ALB), an
/// Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool,
/// an App Runner service, or an Amazon Web Services Verified Access instance. To work with CloudFront, you must also specify the Region US East (N. Virginia) as
/// follows: - CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT
/// --region=us-east-1
. - API and SDKs - For all calls, use the Region endpoint us-east-1.
///
///
#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.WAFV2.Scope")]
public Amazon.WAFV2.Scope Scope { get; set; }
#endregion
#region Parameter TokenDomain
///
///
/// The client application domains that you want to use this API key for. Example JSON: "TokenDomains": ["abc.com", "store.abc.com"]
Public suffixes aren't allowed. For example, you can't use usa.gov
or
/// co.uk
as token domains.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyCollection]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[Alias("TokenDomains")]
public System.String[] TokenDomain { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'APIKey'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.CreateAPIKeyResponse).
/// Specifying the name of a property of type Amazon.WAFV2.Model.CreateAPIKeyResponse 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; } = "APIKey";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the Scope parameter.
/// The -PassThru parameter is deprecated, use -Select '^Scope' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Scope' 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.Scope), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-WAF2APIKey (CreateAPIKey)"))
{
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.Scope;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.Scope = this.Scope;
#if MODULAR
if (this.Scope == null && ParameterWasBound(nameof(this.Scope)))
{
WriteWarning("You are passing $null as a value for parameter Scope 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.TokenDomain != null)
{
context.TokenDomain = new List(this.TokenDomain);
}
#if MODULAR
if (this.TokenDomain == null && ParameterWasBound(nameof(this.TokenDomain)))
{
WriteWarning("You are passing $null as a value for parameter TokenDomain 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
// 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.WAFV2.Model.CreateAPIKeyRequest();
if (cmdletContext.Scope != null)
{
request.Scope = cmdletContext.Scope;
}
if (cmdletContext.TokenDomain != null)
{
request.TokenDomains = cmdletContext.TokenDomain;
}
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.WAFV2.Model.CreateAPIKeyResponse CallAWSServiceOperation(IAmazonWAFV2 client, Amazon.WAFV2.Model.CreateAPIKeyRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS WAF V2", "CreateAPIKey");
try
{
#if DESKTOP
return client.CreateAPIKey(request);
#elif CORECLR
return client.CreateAPIKeyAsync(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 Amazon.WAFV2.Scope Scope { get; set; }
public List TokenDomain { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.APIKey;
}
}
}