/*******************************************************************************
* 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.Lightsail;
using Amazon.Lightsail.Model;
namespace Amazon.PowerShell.Cmdlets.LS
{
///
/// Creates an email or SMS text message contact method.
///
///
///
/// A contact method is used to send you notifications about your Amazon Lightsail resources.
/// You can add one email address and one mobile phone number contact method in each Amazon
/// Web Services Region. However, SMS text messaging is not supported in some Amazon Web
/// Services Regions, and SMS text messages cannot be sent to some countries/regions.
/// For more information, see Notifications
/// in Amazon Lightsail.
///
///
[Cmdlet("New", "LSContactMethod", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.Lightsail.Model.Operation")]
[AWSCmdlet("Calls the Amazon Lightsail CreateContactMethod API operation.", Operation = new[] {"CreateContactMethod"}, SelectReturnType = typeof(Amazon.Lightsail.Model.CreateContactMethodResponse))]
[AWSCmdletOutput("Amazon.Lightsail.Model.Operation or Amazon.Lightsail.Model.CreateContactMethodResponse",
"This cmdlet returns a collection of Amazon.Lightsail.Model.Operation objects.",
"The service call response (type Amazon.Lightsail.Model.CreateContactMethodResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewLSContactMethodCmdlet : AmazonLightsailClientCmdlet, IExecutor
{
#region Parameter ContactEndpoint
///
///
/// The destination of the contact method, such as an email address or a mobile phone
/// number.Use the E.164 format when specifying a mobile phone number. E.164 is a standard for
/// the phone number structure used for international telecommunication. Phone numbers
/// that follow this format can have a maximum of 15 digits, and they are prefixed with
/// the plus character (+) and the country code. For example, a U.S. phone number in E.164
/// format would be specified as +1XXX5550100. For more information, see E.164
/// on Wikipedia.
///
///
#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 ContactEndpoint { get; set; }
#endregion
#region Parameter Protocol
///
///
/// The protocol of the contact method, such as Email
or SMS
/// (text messaging).The SMS
protocol is supported only in the following Amazon Web Services
/// Regions.- US East (N. Virginia) (
us-east-1
) - US West (Oregon) (
us-west-2
) - Europe (Ireland) (
eu-west-1
) - Asia Pacific (Tokyo) (
ap-northeast-1
) - Asia Pacific (Singapore) (
ap-southeast-1
) - Asia Pacific (Sydney) (
ap-southeast-2
)
For a list of countries/regions where SMS text messages can be sent, and the latest
/// Amazon Web Services Regions where SMS text messaging is supported, see Supported
/// Regions and Countries in the Amazon SNS Developer Guide.For more information about notifications in Amazon Lightsail, see Notifications
/// in Amazon Lightsail.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[AWSConstantClassSource("Amazon.Lightsail.ContactProtocol")]
public Amazon.Lightsail.ContactProtocol Protocol { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'Operations'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Lightsail.Model.CreateContactMethodResponse).
/// Specifying the name of a property of type Amazon.Lightsail.Model.CreateContactMethodResponse 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; } = "Operations";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the ContactEndpoint parameter.
/// The -PassThru parameter is deprecated, use -Select '^ContactEndpoint' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ContactEndpoint' 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.ContactEndpoint), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-LSContactMethod (CreateContactMethod)"))
{
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.ContactEndpoint;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ContactEndpoint = this.ContactEndpoint;
#if MODULAR
if (this.ContactEndpoint == null && ParameterWasBound(nameof(this.ContactEndpoint)))
{
WriteWarning("You are passing $null as a value for parameter ContactEndpoint 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.Protocol = this.Protocol;
#if MODULAR
if (this.Protocol == null && ParameterWasBound(nameof(this.Protocol)))
{
WriteWarning("You are passing $null as a value for parameter Protocol 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.Lightsail.Model.CreateContactMethodRequest();
if (cmdletContext.ContactEndpoint != null)
{
request.ContactEndpoint = cmdletContext.ContactEndpoint;
}
if (cmdletContext.Protocol != null)
{
request.Protocol = cmdletContext.Protocol;
}
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.Lightsail.Model.CreateContactMethodResponse CallAWSServiceOperation(IAmazonLightsail client, Amazon.Lightsail.Model.CreateContactMethodRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Lightsail", "CreateContactMethod");
try
{
#if DESKTOP
return client.CreateContactMethod(request);
#elif CORECLR
return client.CreateContactMethodAsync(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 ContactEndpoint { get; set; }
public Amazon.Lightsail.ContactProtocol Protocol { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Operations;
}
}
}