/******************************************************************************* * 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.IoT; using Amazon.IoT.Model; namespace Amazon.PowerShell.Cmdlets.IOT { /// /// Registers a CA certificate with Amazon Web Services IoT Core. There is no limit to /// the number of CA certificates you can register in your Amazon Web Services account. /// You can register up to 10 CA certificates with the same CA subject field /// per Amazon Web Services account. /// /// /// /// Requires permission to access the RegisterCACertificate /// action. /// /// [Cmdlet("Register", "IOTCACertificate")] [OutputType("Amazon.IoT.Model.RegisterCACertificateResponse")] [AWSCmdlet("Calls the AWS IoT RegisterCACertificate API operation.", Operation = new[] {"RegisterCACertificate"}, SelectReturnType = typeof(Amazon.IoT.Model.RegisterCACertificateResponse))] [AWSCmdletOutput("Amazon.IoT.Model.RegisterCACertificateResponse", "This cmdlet returns an Amazon.IoT.Model.RegisterCACertificateResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class RegisterIOTCACertificateCmdlet : AmazonIoTClientCmdlet, IExecutor { #region Parameter AllowAutoRegistration /// /// /// Allows this CA certificate to be used for auto registration of device certificates. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? AllowAutoRegistration { get; set; } #endregion #region Parameter CaCertificate /// /// /// The CA certificate. /// /// #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 CaCertificate { get; set; } #endregion #region Parameter CertificateMode /// /// /// Describes the certificate mode in which the Certificate Authority (CA) will be registered. /// If the verificationCertificate field is not provided, set certificateMode /// to be SNI_ONLY. If the verificationCertificate field is /// provided, set certificateMode to be DEFAULT. When certificateMode /// is not provided, it defaults to DEFAULT. All the device certificates /// that are registered using this CA will be registered in the same certificate mode /// as the CA. For more information about certificate mode for device certificates, see /// /// certificate mode. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.IoT.CertificateMode")] public Amazon.IoT.CertificateMode CertificateMode { get; set; } #endregion #region Parameter RegistrationConfig_RoleArn /// /// /// The ARN of the role. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String RegistrationConfig_RoleArn { get; set; } #endregion #region Parameter SetAsActive /// /// /// A boolean value that specifies if the CA certificate is set to active.Valid values: ACTIVE | INACTIVE /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? SetAsActive { get; set; } #endregion #region Parameter Tag /// /// /// Metadata which can be used to manage the CA certificate.For URI Request parameters use format: ...key1=value1&key2=value2...For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."For the cli-input-json file use format: "tags": "key1=value1&key2=value2..." /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public Amazon.IoT.Model.Tag[] Tag { get; set; } #endregion #region Parameter RegistrationConfig_TemplateBody /// /// /// The template body. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String RegistrationConfig_TemplateBody { get; set; } #endregion #region Parameter RegistrationConfig_TemplateName /// /// /// The name of the provisioning template. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String RegistrationConfig_TemplateName { get; set; } #endregion #region Parameter VerificationCertificate /// /// /// The private key verification certificate. If certificateMode is SNI_ONLY, /// the verificationCertificate field must be empty. If certificateMode /// is DEFAULT or not provided, the verificationCertificate /// field must not be empty. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String VerificationCertificate { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is '*'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoT.Model.RegisterCACertificateResponse). /// Specifying the name of a property of type Amazon.IoT.Model.RegisterCACertificateResponse 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; } = "*"; #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); } context.AllowAutoRegistration = this.AllowAutoRegistration; context.CaCertificate = this.CaCertificate; #if MODULAR if (this.CaCertificate == null && ParameterWasBound(nameof(this.CaCertificate))) { WriteWarning("You are passing $null as a value for parameter CaCertificate 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.CertificateMode = this.CertificateMode; context.RegistrationConfig_RoleArn = this.RegistrationConfig_RoleArn; context.RegistrationConfig_TemplateBody = this.RegistrationConfig_TemplateBody; context.RegistrationConfig_TemplateName = this.RegistrationConfig_TemplateName; context.SetAsActive = this.SetAsActive; if (this.Tag != null) { context.Tag = new List(this.Tag); } context.VerificationCertificate = this.VerificationCertificate; // 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.IoT.Model.RegisterCACertificateRequest(); if (cmdletContext.AllowAutoRegistration != null) { request.AllowAutoRegistration = cmdletContext.AllowAutoRegistration.Value; } if (cmdletContext.CaCertificate != null) { request.CaCertificate = cmdletContext.CaCertificate; } if (cmdletContext.CertificateMode != null) { request.CertificateMode = cmdletContext.CertificateMode; } // populate RegistrationConfig var requestRegistrationConfigIsNull = true; request.RegistrationConfig = new Amazon.IoT.Model.RegistrationConfig(); System.String requestRegistrationConfig_registrationConfig_RoleArn = null; if (cmdletContext.RegistrationConfig_RoleArn != null) { requestRegistrationConfig_registrationConfig_RoleArn = cmdletContext.RegistrationConfig_RoleArn; } if (requestRegistrationConfig_registrationConfig_RoleArn != null) { request.RegistrationConfig.RoleArn = requestRegistrationConfig_registrationConfig_RoleArn; requestRegistrationConfigIsNull = false; } System.String requestRegistrationConfig_registrationConfig_TemplateBody = null; if (cmdletContext.RegistrationConfig_TemplateBody != null) { requestRegistrationConfig_registrationConfig_TemplateBody = cmdletContext.RegistrationConfig_TemplateBody; } if (requestRegistrationConfig_registrationConfig_TemplateBody != null) { request.RegistrationConfig.TemplateBody = requestRegistrationConfig_registrationConfig_TemplateBody; requestRegistrationConfigIsNull = false; } System.String requestRegistrationConfig_registrationConfig_TemplateName = null; if (cmdletContext.RegistrationConfig_TemplateName != null) { requestRegistrationConfig_registrationConfig_TemplateName = cmdletContext.RegistrationConfig_TemplateName; } if (requestRegistrationConfig_registrationConfig_TemplateName != null) { request.RegistrationConfig.TemplateName = requestRegistrationConfig_registrationConfig_TemplateName; requestRegistrationConfigIsNull = false; } // determine if request.RegistrationConfig should be set to null if (requestRegistrationConfigIsNull) { request.RegistrationConfig = null; } if (cmdletContext.SetAsActive != null) { request.SetAsActive = cmdletContext.SetAsActive.Value; } if (cmdletContext.Tag != null) { request.Tags = cmdletContext.Tag; } if (cmdletContext.VerificationCertificate != null) { request.VerificationCertificate = cmdletContext.VerificationCertificate; } 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.IoT.Model.RegisterCACertificateResponse CallAWSServiceOperation(IAmazonIoT client, Amazon.IoT.Model.RegisterCACertificateRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS IoT", "RegisterCACertificate"); try { #if DESKTOP return client.RegisterCACertificate(request); #elif CORECLR return client.RegisterCACertificateAsync(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.Boolean? AllowAutoRegistration { get; set; } public System.String CaCertificate { get; set; } public Amazon.IoT.CertificateMode CertificateMode { get; set; } public System.String RegistrationConfig_RoleArn { get; set; } public System.String RegistrationConfig_TemplateBody { get; set; } public System.String RegistrationConfig_TemplateName { get; set; } public System.Boolean? SetAsActive { get; set; } public List Tag { get; set; } public System.String VerificationCertificate { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }