/*******************************************************************************
* 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.CloudWatchEvidently;
using Amazon.CloudWatchEvidently.Model;
namespace Amazon.PowerShell.Cmdlets.CWEVD
{
///
/// Creates an Evidently feature that you want to launch or test. You can define
/// up to five variations of a feature, and use these variations in your launches and
/// experiments. A feature must be created in a project. For information about creating
/// a project, see CreateProject.
///
///
///
/// Don't use this operation to update an existing feature. Instead, use UpdateFeature.
///
///
///
[Cmdlet("New", "CWEVDFeature", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.CloudWatchEvidently.Model.Feature")]
[AWSCmdlet("Calls the Amazon CloudWatch Evidently CreateFeature API operation.", Operation = new[] {"CreateFeature"}, SelectReturnType = typeof(Amazon.CloudWatchEvidently.Model.CreateFeatureResponse))]
[AWSCmdletOutput("Amazon.CloudWatchEvidently.Model.Feature or Amazon.CloudWatchEvidently.Model.CreateFeatureResponse",
"This cmdlet returns an Amazon.CloudWatchEvidently.Model.Feature object.",
"The service call response (type Amazon.CloudWatchEvidently.Model.CreateFeatureResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewCWEVDFeatureCmdlet : AmazonCloudWatchEvidentlyClientCmdlet, IExecutor
{
#region Parameter DefaultVariation
///
///
/// The name of the variation to use as the default variation. The default variation is
/// served to users who are not allocated to any ongoing launches or experiments of this
/// feature.This variation must also be listed in the variations
structure.If you omit defaultVariation
, the first variation listed in the variations
/// structure is used as the default variation.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DefaultVariation { get; set; }
#endregion
#region Parameter Description
///
///
/// An optional description of the feature.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Description { get; set; }
#endregion
#region Parameter EntityOverride
///
///
/// Specify users that should always be served a specific variation of a feature. Each
/// user is specified by a key-value pair . For each key, specify a user by entering their
/// user ID, account ID, or some other identifier. For the value, specify the name of
/// the variation that they are to be served.This parameter is limited to 2500 overrides or a total of 40KB. The 40KB limit includes
/// an overhead of 6 bytes per override.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("EntityOverrides")]
public System.Collections.Hashtable EntityOverride { get; set; }
#endregion
#region Parameter EvaluationStrategy
///
///
/// Specify ALL_RULES
to activate the traffic allocation specified by any
/// ongoing launches or experiments. Specify DEFAULT_VARIATION
to serve the
/// default variation to all users instead.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.CloudWatchEvidently.FeatureEvaluationStrategy")]
public Amazon.CloudWatchEvidently.FeatureEvaluationStrategy EvaluationStrategy { get; set; }
#endregion
#region Parameter Name
///
///
/// The name for the new feature.
///
///
#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 Project
///
///
/// The name or ARN of the project that is to contain the new feature.
///
///
#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 Project { get; set; }
#endregion
#region Parameter Tag
///
///
/// Assigns one or more tags (key-value pairs) to the feature.Tags can help you organize and categorize your resources. You can also use them to
/// scope user permissions by granting a user permission to access or change only resources
/// with certain tag values.Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly
/// as strings of characters.You can associate as many as 50 tags with a feature.For more information, see Tagging
/// Amazon Web Services resources.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public System.Collections.Hashtable Tag { get; set; }
#endregion
#region Parameter Variation
///
///
/// An array of structures that contain the configuration of the feature's different variations.
///
///
#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("Variations")]
public Amazon.CloudWatchEvidently.Model.VariationConfig[] Variation { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'Feature'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchEvidently.Model.CreateFeatureResponse).
/// Specifying the name of a property of type Amazon.CloudWatchEvidently.Model.CreateFeatureResponse 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; } = "Feature";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the Project parameter.
/// The -PassThru parameter is deprecated, use -Select '^Project' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Project' 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-CWEVDFeature (CreateFeature)"))
{
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.Project;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.DefaultVariation = this.DefaultVariation;
context.Description = this.Description;
if (this.EntityOverride != null)
{
context.EntityOverride = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.EntityOverride.Keys)
{
context.EntityOverride.Add((String)hashKey, (String)(this.EntityOverride[hashKey]));
}
}
context.EvaluationStrategy = this.EvaluationStrategy;
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.Project = this.Project;
#if MODULAR
if (this.Project == null && ParameterWasBound(nameof(this.Project)))
{
WriteWarning("You are passing $null as a value for parameter Project 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.Tag != null)
{
context.Tag = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.Tag.Keys)
{
context.Tag.Add((String)hashKey, (String)(this.Tag[hashKey]));
}
}
if (this.Variation != null)
{
context.Variation = new List(this.Variation);
}
#if MODULAR
if (this.Variation == null && ParameterWasBound(nameof(this.Variation)))
{
WriteWarning("You are passing $null as a value for parameter Variation 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.CloudWatchEvidently.Model.CreateFeatureRequest();
if (cmdletContext.DefaultVariation != null)
{
request.DefaultVariation = cmdletContext.DefaultVariation;
}
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.EntityOverride != null)
{
request.EntityOverrides = cmdletContext.EntityOverride;
}
if (cmdletContext.EvaluationStrategy != null)
{
request.EvaluationStrategy = cmdletContext.EvaluationStrategy;
}
if (cmdletContext.Name != null)
{
request.Name = cmdletContext.Name;
}
if (cmdletContext.Project != null)
{
request.Project = cmdletContext.Project;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
if (cmdletContext.Variation != null)
{
request.Variations = cmdletContext.Variation;
}
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.CloudWatchEvidently.Model.CreateFeatureResponse CallAWSServiceOperation(IAmazonCloudWatchEvidently client, Amazon.CloudWatchEvidently.Model.CreateFeatureRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon CloudWatch Evidently", "CreateFeature");
try
{
#if DESKTOP
return client.CreateFeature(request);
#elif CORECLR
return client.CreateFeatureAsync(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 DefaultVariation { get; set; }
public System.String Description { get; set; }
public Dictionary EntityOverride { get; set; }
public Amazon.CloudWatchEvidently.FeatureEvaluationStrategy EvaluationStrategy { get; set; }
public System.String Name { get; set; }
public System.String Project { get; set; }
public Dictionary Tag { get; set; }
public List Variation { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Feature;
}
}
}