/*******************************************************************************
* 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.Route53Resolver;
using Amazon.Route53Resolver.Model;
namespace Amazon.PowerShell.Cmdlets.R53R
{
///
/// For DNS queries that originate in your VPCs, specifies which Resolver endpoint the
/// queries pass through, one domain name that you want to forward to your network, and
/// the IP addresses of the DNS resolvers in your network.
///
[Cmdlet("New", "R53RResolverRule", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.Route53Resolver.Model.ResolverRule")]
[AWSCmdlet("Calls the Amazon Route 53 Resolver CreateResolverRule API operation.", Operation = new[] {"CreateResolverRule"}, SelectReturnType = typeof(Amazon.Route53Resolver.Model.CreateResolverRuleResponse))]
[AWSCmdletOutput("Amazon.Route53Resolver.Model.ResolverRule or Amazon.Route53Resolver.Model.CreateResolverRuleResponse",
"This cmdlet returns an Amazon.Route53Resolver.Model.ResolverRule object.",
"The service call response (type Amazon.Route53Resolver.Model.CreateResolverRuleResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewR53RResolverRuleCmdlet : AmazonRoute53ResolverClientCmdlet, IExecutor
{
#region Parameter CreatorRequestId
///
///
/// A unique string that identifies the request and that allows failed requests to be
/// retried without the risk of running the operation twice. CreatorRequestId
/// can be any unique string, for example, a date/time stamp.
///
///
#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 CreatorRequestId { get; set; }
#endregion
#region Parameter DomainName
///
///
/// DNS queries for this domain name are forwarded to the IP addresses that you specify
/// in TargetIps
. If a query matches multiple Resolver rules (example.com
/// and www.example.com), outbound DNS queries are routed using the Resolver rule that
/// contains the most specific domain name (www.example.com).
///
///
#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 DomainName { get; set; }
#endregion
#region Parameter Name
///
///
/// A friendly name that lets you easily find a rule in the Resolver dashboard in the
/// Route 53 console.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Name { get; set; }
#endregion
#region Parameter ResolverEndpointId
///
///
/// The ID of the outbound Resolver endpoint that you want to use to route DNS queries
/// to the IP addresses that you specify in TargetIps
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ResolverEndpointId { get; set; }
#endregion
#region Parameter RuleType
///
///
/// When you want to forward DNS queries for specified domain name to resolvers on your
/// network, specify FORWARD
.When you have a forwarding rule to forward DNS queries for a domain to your network
/// and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM
.For example, to forward DNS queries for example.com to resolvers on your network,
/// you create a rule and specify FORWARD
for RuleType
. To then
/// have Resolver process queries for apex.example.com, you create a rule and specify
/// SYSTEM
for RuleType
.Currently, only Resolver can create rules that have a value of RECURSIVE
/// for RuleType
.
///
///
#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.Route53Resolver.RuleTypeOption")]
public Amazon.Route53Resolver.RuleTypeOption RuleType { get; set; }
#endregion
#region Parameter Tag
///
///
/// A list of the tag keys and values that you want to associate with the endpoint.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public Amazon.Route53Resolver.Model.Tag[] Tag { get; set; }
#endregion
#region Parameter TargetIp
///
///
/// The IPs that you want Resolver to forward DNS queries to. You can specify either Ipv4
/// or Ipv6 addresses but not both in the same rule. Separate IP addresses with a space.TargetIps
is available only when the value of Rule type
/// is FORWARD
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("TargetIps")]
public Amazon.Route53Resolver.Model.TargetAddress[] TargetIp { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'ResolverRule'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53Resolver.Model.CreateResolverRuleResponse).
/// Specifying the name of a property of type Amazon.Route53Resolver.Model.CreateResolverRuleResponse 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; } = "ResolverRule";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the DomainName parameter.
/// The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^DomainName' 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.DomainName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-R53RResolverRule (CreateResolverRule)"))
{
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.DomainName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.CreatorRequestId = this.CreatorRequestId;
#if MODULAR
if (this.CreatorRequestId == null && ParameterWasBound(nameof(this.CreatorRequestId)))
{
WriteWarning("You are passing $null as a value for parameter CreatorRequestId 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.DomainName = this.DomainName;
#if MODULAR
if (this.DomainName == null && ParameterWasBound(nameof(this.DomainName)))
{
WriteWarning("You are passing $null as a value for parameter DomainName 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.Name = this.Name;
context.ResolverEndpointId = this.ResolverEndpointId;
context.RuleType = this.RuleType;
#if MODULAR
if (this.RuleType == null && ParameterWasBound(nameof(this.RuleType)))
{
WriteWarning("You are passing $null as a value for parameter RuleType 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 List(this.Tag);
}
if (this.TargetIp != null)
{
context.TargetIp = new List(this.TargetIp);
}
// 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.Route53Resolver.Model.CreateResolverRuleRequest();
if (cmdletContext.CreatorRequestId != null)
{
request.CreatorRequestId = cmdletContext.CreatorRequestId;
}
if (cmdletContext.DomainName != null)
{
request.DomainName = cmdletContext.DomainName;
}
if (cmdletContext.Name != null)
{
request.Name = cmdletContext.Name;
}
if (cmdletContext.ResolverEndpointId != null)
{
request.ResolverEndpointId = cmdletContext.ResolverEndpointId;
}
if (cmdletContext.RuleType != null)
{
request.RuleType = cmdletContext.RuleType;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
if (cmdletContext.TargetIp != null)
{
request.TargetIps = cmdletContext.TargetIp;
}
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.Route53Resolver.Model.CreateResolverRuleResponse CallAWSServiceOperation(IAmazonRoute53Resolver client, Amazon.Route53Resolver.Model.CreateResolverRuleRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Route 53 Resolver", "CreateResolverRule");
try
{
#if DESKTOP
return client.CreateResolverRule(request);
#elif CORECLR
return client.CreateResolverRuleAsync(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 CreatorRequestId { get; set; }
public System.String DomainName { get; set; }
public System.String Name { get; set; }
public System.String ResolverEndpointId { get; set; }
public Amazon.Route53Resolver.RuleTypeOption RuleType { get; set; }
public List Tag { get; set; }
public List TargetIp { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.ResolverRule;
}
}
}