/******************************************************************************* * 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.FSx; using Amazon.FSx.Model; namespace Amazon.PowerShell.Cmdlets.FSX { /// /// Creates a new Amazon File Cache resource. /// /// /// /// You can use this operation with a client request token in the request that Amazon /// File Cache uses to ensure idempotent creation. If a cache with the specified client /// request token exists and the parameters match, CreateFileCache returns /// the description of the existing cache. If a cache with the specified client request /// token exists and the parameters don't match, this call returns IncompatibleParameterError. /// If a file cache with the specified client request token doesn't exist, CreateFileCache /// does the following: /// /// The CreateFileCache call returns while the cache's lifecycle state is /// still CREATING. You can check the cache creation status by calling the /// DescribeFileCaches /// operation, which returns the cache state along with other information. /// /// [Cmdlet("New", "FSXFileCache", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.FSx.Model.FileCacheCreating")] [AWSCmdlet("Calls the Amazon FSx CreateFileCache API operation.", Operation = new[] {"CreateFileCache"}, SelectReturnType = typeof(Amazon.FSx.Model.CreateFileCacheResponse))] [AWSCmdletOutput("Amazon.FSx.Model.FileCacheCreating or Amazon.FSx.Model.CreateFileCacheResponse", "This cmdlet returns an Amazon.FSx.Model.FileCacheCreating object.", "The service call response (type Amazon.FSx.Model.CreateFileCacheResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewFSXFileCacheCmdlet : AmazonFSxClientCmdlet, IExecutor { #region Parameter ClientRequestToken /// /// /// An idempotency token for resource creation, in a string of up to 63 ASCII characters. /// This token is automatically filled on your behalf when you use the Command Line Interface /// (CLI) or an Amazon Web Services SDK.By using the idempotent operation, you can retry a CreateFileCache operation /// without the risk of creating an extra cache. This approach can be useful when an initial /// call fails in a way that makes it unclear whether a cache was created. Examples are /// if a transport level timeout occurred, or your connection was reset. If you use the /// same client request token and the initial call created a cache, the client receives /// success as long as the parameters are the same. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ClientRequestToken { get; set; } #endregion #region Parameter CopyTagsToDataRepositoryAssociation /// /// /// A boolean flag indicating whether tags for the cache should be copied to data repository /// associations. This value defaults to false. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("CopyTagsToDataRepositoryAssociations")] public System.Boolean? CopyTagsToDataRepositoryAssociation { get; set; } #endregion #region Parameter DataRepositoryAssociation /// /// /// A list of up to 8 configurations for data repository associations (DRAs) to be created /// during the cache creation. The DRAs link the cache to either an Amazon S3 data repository /// or a Network File System (NFS) data repository that supports the NFSv3 protocol.The DRA configurations must meet the following requirements:DRA automatic import and automatic export is not supported. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("DataRepositoryAssociations")] public Amazon.FSx.Model.FileCacheDataRepositoryAssociation[] DataRepositoryAssociation { get; set; } #endregion #region Parameter LustreConfiguration_DeploymentType /// /// /// Specifies the cache deployment type, which must be CACHE_1. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.FSx.FileCacheLustreDeploymentType")] public Amazon.FSx.FileCacheLustreDeploymentType LustreConfiguration_DeploymentType { get; set; } #endregion #region Parameter FileCacheType /// /// /// The type of cache that you're creating, which must be LUSTRE. /// /// #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.FSx.FileCacheType")] public Amazon.FSx.FileCacheType FileCacheType { get; set; } #endregion #region Parameter FileCacheTypeVersion /// /// /// Sets the Lustre version for the cache that you're creating, which must be 2.12. /// /// #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 FileCacheTypeVersion { get; set; } #endregion #region Parameter KmsKeyId /// /// /// Specifies the ID of the Key Management Service (KMS) key to use for encrypting data /// on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed /// KMS key for your account is used. For more information, see Encrypt /// in the Key Management Service API Reference. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String KmsKeyId { get; set; } #endregion #region Parameter LustreConfiguration_PerUnitStorageThroughput /// /// /// Provisions the amount of read and write throughput for each 1 tebibyte (TiB) of cache /// storage capacity, in MB/s/TiB. The only supported value is 1000. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? LustreConfiguration_PerUnitStorageThroughput { get; set; } #endregion #region Parameter SecurityGroupId /// /// /// A list of IDs specifying the security groups to apply to all network interfaces created /// for Amazon File Cache access. This list isn't returned in later requests to describe /// the cache. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("SecurityGroupIds")] public System.String[] SecurityGroupId { get; set; } #endregion #region Parameter MetadataConfiguration_StorageCapacity /// /// /// The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes /// (GiB). The only supported value is 2400 GiB. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("LustreConfiguration_MetadataConfiguration_StorageCapacity")] public System.Int32? MetadataConfiguration_StorageCapacity { get; set; } #endregion #region Parameter StorageCapacity /// /// /// The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 /// GiB, and increments of 2400 GiB. /// /// #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] public System.Int32? StorageCapacity { get; set; } #endregion #region Parameter SubnetId /// /// /// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. /// /// #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("SubnetIds")] public System.String[] SubnetId { get; set; } #endregion #region Parameter Tag /// /// /// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public Amazon.FSx.Model.Tag[] Tag { get; set; } #endregion #region Parameter LustreConfiguration_WeeklyMaintenanceStartTime /// /// /// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String LustreConfiguration_WeeklyMaintenanceStartTime { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'FileCache'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CreateFileCacheResponse). /// Specifying the name of a property of type Amazon.FSx.Model.CreateFileCacheResponse 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; } = "FileCache"; #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.KmsKeyId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-FSXFileCache (CreateFileCache)")) { return; } 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.ClientRequestToken = this.ClientRequestToken; context.CopyTagsToDataRepositoryAssociation = this.CopyTagsToDataRepositoryAssociation; if (this.DataRepositoryAssociation != null) { context.DataRepositoryAssociation = new List(this.DataRepositoryAssociation); } context.FileCacheType = this.FileCacheType; #if MODULAR if (this.FileCacheType == null && ParameterWasBound(nameof(this.FileCacheType))) { WriteWarning("You are passing $null as a value for parameter FileCacheType 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.FileCacheTypeVersion = this.FileCacheTypeVersion; #if MODULAR if (this.FileCacheTypeVersion == null && ParameterWasBound(nameof(this.FileCacheTypeVersion))) { WriteWarning("You are passing $null as a value for parameter FileCacheTypeVersion 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.KmsKeyId = this.KmsKeyId; context.LustreConfiguration_DeploymentType = this.LustreConfiguration_DeploymentType; context.MetadataConfiguration_StorageCapacity = this.MetadataConfiguration_StorageCapacity; context.LustreConfiguration_PerUnitStorageThroughput = this.LustreConfiguration_PerUnitStorageThroughput; context.LustreConfiguration_WeeklyMaintenanceStartTime = this.LustreConfiguration_WeeklyMaintenanceStartTime; if (this.SecurityGroupId != null) { context.SecurityGroupId = new List(this.SecurityGroupId); } context.StorageCapacity = this.StorageCapacity; #if MODULAR if (this.StorageCapacity == null && ParameterWasBound(nameof(this.StorageCapacity))) { WriteWarning("You are passing $null as a value for parameter StorageCapacity 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.SubnetId != null) { context.SubnetId = new List(this.SubnetId); } #if MODULAR if (this.SubnetId == null && ParameterWasBound(nameof(this.SubnetId))) { WriteWarning("You are passing $null as a value for parameter SubnetId 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); } // 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.FSx.Model.CreateFileCacheRequest(); if (cmdletContext.ClientRequestToken != null) { request.ClientRequestToken = cmdletContext.ClientRequestToken; } if (cmdletContext.CopyTagsToDataRepositoryAssociation != null) { request.CopyTagsToDataRepositoryAssociations = cmdletContext.CopyTagsToDataRepositoryAssociation.Value; } if (cmdletContext.DataRepositoryAssociation != null) { request.DataRepositoryAssociations = cmdletContext.DataRepositoryAssociation; } if (cmdletContext.FileCacheType != null) { request.FileCacheType = cmdletContext.FileCacheType; } if (cmdletContext.FileCacheTypeVersion != null) { request.FileCacheTypeVersion = cmdletContext.FileCacheTypeVersion; } if (cmdletContext.KmsKeyId != null) { request.KmsKeyId = cmdletContext.KmsKeyId; } // populate LustreConfiguration var requestLustreConfigurationIsNull = true; request.LustreConfiguration = new Amazon.FSx.Model.CreateFileCacheLustreConfiguration(); Amazon.FSx.FileCacheLustreDeploymentType requestLustreConfiguration_lustreConfiguration_DeploymentType = null; if (cmdletContext.LustreConfiguration_DeploymentType != null) { requestLustreConfiguration_lustreConfiguration_DeploymentType = cmdletContext.LustreConfiguration_DeploymentType; } if (requestLustreConfiguration_lustreConfiguration_DeploymentType != null) { request.LustreConfiguration.DeploymentType = requestLustreConfiguration_lustreConfiguration_DeploymentType; requestLustreConfigurationIsNull = false; } System.Int32? requestLustreConfiguration_lustreConfiguration_PerUnitStorageThroughput = null; if (cmdletContext.LustreConfiguration_PerUnitStorageThroughput != null) { requestLustreConfiguration_lustreConfiguration_PerUnitStorageThroughput = cmdletContext.LustreConfiguration_PerUnitStorageThroughput.Value; } if (requestLustreConfiguration_lustreConfiguration_PerUnitStorageThroughput != null) { request.LustreConfiguration.PerUnitStorageThroughput = requestLustreConfiguration_lustreConfiguration_PerUnitStorageThroughput.Value; requestLustreConfigurationIsNull = false; } System.String requestLustreConfiguration_lustreConfiguration_WeeklyMaintenanceStartTime = null; if (cmdletContext.LustreConfiguration_WeeklyMaintenanceStartTime != null) { requestLustreConfiguration_lustreConfiguration_WeeklyMaintenanceStartTime = cmdletContext.LustreConfiguration_WeeklyMaintenanceStartTime; } if (requestLustreConfiguration_lustreConfiguration_WeeklyMaintenanceStartTime != null) { request.LustreConfiguration.WeeklyMaintenanceStartTime = requestLustreConfiguration_lustreConfiguration_WeeklyMaintenanceStartTime; requestLustreConfigurationIsNull = false; } Amazon.FSx.Model.FileCacheLustreMetadataConfiguration requestLustreConfiguration_lustreConfiguration_MetadataConfiguration = null; // populate MetadataConfiguration var requestLustreConfiguration_lustreConfiguration_MetadataConfigurationIsNull = true; requestLustreConfiguration_lustreConfiguration_MetadataConfiguration = new Amazon.FSx.Model.FileCacheLustreMetadataConfiguration(); System.Int32? requestLustreConfiguration_lustreConfiguration_MetadataConfiguration_metadataConfiguration_StorageCapacity = null; if (cmdletContext.MetadataConfiguration_StorageCapacity != null) { requestLustreConfiguration_lustreConfiguration_MetadataConfiguration_metadataConfiguration_StorageCapacity = cmdletContext.MetadataConfiguration_StorageCapacity.Value; } if (requestLustreConfiguration_lustreConfiguration_MetadataConfiguration_metadataConfiguration_StorageCapacity != null) { requestLustreConfiguration_lustreConfiguration_MetadataConfiguration.StorageCapacity = requestLustreConfiguration_lustreConfiguration_MetadataConfiguration_metadataConfiguration_StorageCapacity.Value; requestLustreConfiguration_lustreConfiguration_MetadataConfigurationIsNull = false; } // determine if requestLustreConfiguration_lustreConfiguration_MetadataConfiguration should be set to null if (requestLustreConfiguration_lustreConfiguration_MetadataConfigurationIsNull) { requestLustreConfiguration_lustreConfiguration_MetadataConfiguration = null; } if (requestLustreConfiguration_lustreConfiguration_MetadataConfiguration != null) { request.LustreConfiguration.MetadataConfiguration = requestLustreConfiguration_lustreConfiguration_MetadataConfiguration; requestLustreConfigurationIsNull = false; } // determine if request.LustreConfiguration should be set to null if (requestLustreConfigurationIsNull) { request.LustreConfiguration = null; } if (cmdletContext.SecurityGroupId != null) { request.SecurityGroupIds = cmdletContext.SecurityGroupId; } if (cmdletContext.StorageCapacity != null) { request.StorageCapacity = cmdletContext.StorageCapacity.Value; } if (cmdletContext.SubnetId != null) { request.SubnetIds = cmdletContext.SubnetId; } if (cmdletContext.Tag != null) { request.Tags = cmdletContext.Tag; } 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.FSx.Model.CreateFileCacheResponse CallAWSServiceOperation(IAmazonFSx client, Amazon.FSx.Model.CreateFileCacheRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon FSx", "CreateFileCache"); try { #if DESKTOP return client.CreateFileCache(request); #elif CORECLR return client.CreateFileCacheAsync(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 ClientRequestToken { get; set; } public System.Boolean? CopyTagsToDataRepositoryAssociation { get; set; } public List DataRepositoryAssociation { get; set; } public Amazon.FSx.FileCacheType FileCacheType { get; set; } public System.String FileCacheTypeVersion { get; set; } public System.String KmsKeyId { get; set; } public Amazon.FSx.FileCacheLustreDeploymentType LustreConfiguration_DeploymentType { get; set; } public System.Int32? MetadataConfiguration_StorageCapacity { get; set; } public System.Int32? LustreConfiguration_PerUnitStorageThroughput { get; set; } public System.String LustreConfiguration_WeeklyMaintenanceStartTime { get; set; } public List SecurityGroupId { get; set; } public System.Int32? StorageCapacity { get; set; } public List SubnetId { get; set; } public List Tag { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.FileCache; } } }