/******************************************************************************* * 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.ServiceDiscovery; using Amazon.ServiceDiscovery.Model; namespace Amazon.PowerShell.Cmdlets.SD { /// /// Creates or updates one or more records and, optionally, creates a health check based /// on the settings in a specified service. When you submit a RegisterInstance /// request, the following occurs: /// /// /// One RegisterInstance request must complete before you can submit another /// request and specify the same service ID and instance ID. /// /// For more information, see CreateService. /// /// When Cloud Map receives a DNS query for the specified DNS name, it returns the applicable /// value: /// /// For the current quota on the number of instances that you can register using the same /// namespace and using the same service, see Cloud /// Map quotas in the Cloud Map Developer Guide. /// /// [Cmdlet("New", "SDInstanceRegistration", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the AWS Cloud Map RegisterInstance API operation.", Operation = new[] {"RegisterInstance"}, SelectReturnType = typeof(Amazon.ServiceDiscovery.Model.RegisterInstanceResponse))] [AWSCmdletOutput("System.String or Amazon.ServiceDiscovery.Model.RegisterInstanceResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.ServiceDiscovery.Model.RegisterInstanceResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewSDInstanceRegistrationCmdlet : AmazonServiceDiscoveryClientCmdlet, IExecutor { #region Parameter Attribute /// /// /// A string map that contains the following information for the service that you specify /// in ServiceId:Do not include sensitive information in the attributes if the namespace is discoverable /// by public DNS queries.Supported attribute keys include the following:
AWS_ALIAS_DNS_NAME
If you want Cloud Map to create an Amazon Route 53 alias record that routes traffic /// to an Elastic Load Balancing load balancer, specify the DNS name that's associated /// with the load balancer. For information about how to get the DNS name, see "DNSName" /// in the topic AliasTarget /// in the Route 53 API Reference.Note the following:
  • The configuration for the service that's specified by ServiceId must /// include settings for an A record, an AAAA record, or both.
  • In the service that's specified by ServiceId, the value of RoutingPolicy /// must be WEIGHTED.
  • If the service that's specified by ServiceId includes HealthCheckConfig /// settings, Cloud Map will create the Route 53 health check, but it doesn't associate /// the health check with the alias record.
  • Auto naming currently doesn't support creating alias records that route traffic to /// Amazon Web Services resources other than Elastic Load Balancing load balancers.
  • If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for /// any of the AWS_INSTANCE attributes.
AWS_EC2_INSTANCE_ID
HTTP namespaces only. The Amazon EC2 instance ID for the instance. If the /// AWS_EC2_INSTANCE_ID attribute is specified, then the only other attribute /// that can be specified is AWS_INIT_HEALTH_STATUS. When the AWS_EC2_INSTANCE_ID /// attribute is specified, then the AWS_INSTANCE_IPV4 attribute will be /// filled out with the primary private IPv4 address.
AWS_INIT_HEALTH_STATUS
If the service configuration includes HealthCheckCustomConfig, you can /// optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of /// the custom health check, HEALTHY or UNHEALTHY. If you don't /// specify a value for AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
AWS_INSTANCE_CNAME
If the service configuration includes a CNAME record, the domain name /// that you want Route 53 to return in response to DNS queries (for example, example.com).This value is required if the service specified by ServiceId includes /// settings for an CNAME record.
AWS_INSTANCE_IPV4
If the service configuration includes an A record, the IPv4 address that /// you want Route 53 to return in response to DNS queries (for example, 192.0.2.44).This value is required if the service specified by ServiceId includes /// settings for an A record. If the service includes settings for an SRV /// record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, /// or both.
AWS_INSTANCE_IPV6
If the service configuration includes an AAAA record, the IPv6 address /// that you want Route 53 to return in response to DNS queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345).This value is required if the service specified by ServiceId includes /// settings for an AAAA record. If the service includes settings for an /// SRV record, you must specify a value for AWS_INSTANCE_IPV4, /// AWS_INSTANCE_IPV6, or both.
AWS_INSTANCE_PORT
If the service includes an SRV record, the value that you want Route 53 /// to return for the port.If the service includes HealthCheckConfig, the port on the endpoint that /// you want Route 53 to send requests to. This value is required if you specified settings for an SRV record or /// a Route 53 health check when you created the service.
Custom attributes
You can add up to 30 custom attributes. For each key-value pair, the maximum length /// of the attribute name is 255 characters, and the maximum length of the attribute value /// is 1,024 characters. The total size of all provided attributes (sum of all keys and /// values) must not exceed 5,000 characters.
///
///
#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("Attributes")] public System.Collections.Hashtable Attribute { get; set; } #endregion #region Parameter CreatorRequestId /// /// /// A unique string that identifies the request and that allows failed RegisterInstance /// requests to be retried without the risk of executing the operation twice. You must /// use a unique CreatorRequestId string every time you submit a RegisterInstance /// request if you're registering additional instances for the same namespace and service. /// CreatorRequestId can be any unique string (for example, a date/time stamp). /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String CreatorRequestId { get; set; } #endregion #region Parameter InstanceId /// /// /// An identifier that you want to associate with the instance. Note the following:Do not include sensitive information in InstanceId if the namespace is /// discoverable by public DNS queries and any Type member of DnsRecord /// for the service contains SRV because the InstanceId is discoverable /// by public DNS queries. /// /// #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 InstanceId { get; set; } #endregion #region Parameter ServiceId /// /// /// The ID of the service that you want to use for settings for the instance. /// /// #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 ServiceId { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'OperationId'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceDiscovery.Model.RegisterInstanceResponse). /// Specifying the name of a property of type Amazon.ServiceDiscovery.Model.RegisterInstanceResponse 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; } = "OperationId"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the InstanceId parameter. /// The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^InstanceId' 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.InstanceId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-SDInstanceRegistration (RegisterInstance)")) { 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.InstanceId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.Attribute != null) { context.Attribute = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.Attribute.Keys) { context.Attribute.Add((String)hashKey, (String)(this.Attribute[hashKey])); } } #if MODULAR if (this.Attribute == null && ParameterWasBound(nameof(this.Attribute))) { WriteWarning("You are passing $null as a value for parameter Attribute 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.CreatorRequestId = this.CreatorRequestId; context.InstanceId = this.InstanceId; #if MODULAR if (this.InstanceId == null && ParameterWasBound(nameof(this.InstanceId))) { WriteWarning("You are passing $null as a value for parameter InstanceId 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.ServiceId = this.ServiceId; #if MODULAR if (this.ServiceId == null && ParameterWasBound(nameof(this.ServiceId))) { WriteWarning("You are passing $null as a value for parameter ServiceId 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.ServiceDiscovery.Model.RegisterInstanceRequest(); if (cmdletContext.Attribute != null) { request.Attributes = cmdletContext.Attribute; } if (cmdletContext.CreatorRequestId != null) { request.CreatorRequestId = cmdletContext.CreatorRequestId; } if (cmdletContext.InstanceId != null) { request.InstanceId = cmdletContext.InstanceId; } if (cmdletContext.ServiceId != null) { request.ServiceId = cmdletContext.ServiceId; } 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.ServiceDiscovery.Model.RegisterInstanceResponse CallAWSServiceOperation(IAmazonServiceDiscovery client, Amazon.ServiceDiscovery.Model.RegisterInstanceRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Cloud Map", "RegisterInstance"); try { #if DESKTOP return client.RegisterInstance(request); #elif CORECLR return client.RegisterInstanceAsync(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 Dictionary Attribute { get; set; } public System.String CreatorRequestId { get; set; } public System.String InstanceId { get; set; } public System.String ServiceId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.OperationId; } } }