AWS.Tools.StorageGateway.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.StorageGateway</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SG.AddSGCacheCmdlet"> <summary> Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape and file gateway type (see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/StorageGatewayConcepts.html">Storage Gateway Concepts</a>). <para> In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGCacheCmdlet.DiskId"> <summary> <para> <para>An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the <a>ListLocalDisks</a> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGCacheCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGCacheCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.AddSGResourceTagCmdlet"> <summary> Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources: <ul><li><para> Storage gateways of all types </para></li><li><para> Storage volumes </para></li><li><para> Virtual tapes </para></li><li><para> NFS and SMB file shares </para></li></ul><para> You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource you want to add tags to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGResourceTagCmdlet.Tag"> <summary> <para> <para>The key-value pair that represents the tag you want to add to the resource. The value can be an empty string.</para><note><para>Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.AddSGTapeToTapePoolCmdlet"> <summary> Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (Glacier or Deep Archive) that corresponds to the pool. <para> Valid values: "GLACIER", "DEEP_ARCHIVE" </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGTapeToTapePoolCmdlet.PoolId"> <summary> <para> <para>The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.</para><para>Valid values: "GLACIER", "DEEP_ARCHIVE"</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGTapeToTapePoolCmdlet.TapeARN"> <summary> <para> <para>The unique Amazon Resource Name (ARN) of the virtual tape that you want to add to the tape pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGTapeToTapePoolCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.AddSGUploadBufferCmdlet"> <summary> Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume and tape gateway types. <para> In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGUploadBufferCmdlet.DiskId"> <summary> <para> <para>An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the <a>ListLocalDisks</a> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGUploadBufferCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGUploadBufferCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.AddSGWorkingStorageCmdlet"> <summary> Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use <a>AddUploadBuffer</a> instead. <note><para> Working storage is also referred to as upload buffer. You can also use the <a>AddUploadBuffer</a> operation to add upload buffer to a stored volume gateway. </para></note><para> In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGWorkingStorageCmdlet.DiskId"> <summary> <para> <para>An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the <a>ListLocalDisks</a> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGWorkingStorageCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGWorkingStorageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.DisableSGGatewayCmdlet"> <summary> Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes. <para> Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type. </para><important><para> Once a gateway is disabled it cannot be enabled. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.DisableSGGatewayCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.DisableSGGatewayCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.DismountSGVolumeCmdlet"> <summary> Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.DismountSGVolumeCmdlet.ForceDetach"> <summary> <para> <para>Set to <code>true</code> to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is <code>false</code>. If this value is set to <code>false</code>, you must manually disconnect the iSCSI connection from the target volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.DismountSGVolumeCmdlet.VolumeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the volume to detach from the gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.DismountSGVolumeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.EnableSGGatewayCmdlet"> <summary> Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the AWS Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see <a>UpdateGatewayInformation</a>. <note><para> You must turn on the gateway VM before you can activate your gateway. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.EnableSGGatewayCmdlet.ActivationKey"> <summary> <para> <para>Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter <code>activationKey</code>. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the <code>ActivateGateway</code> API call determine the actual configuration of your gateway. </para><para>For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html in the Storage Gateway User Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.EnableSGGatewayCmdlet.GatewayName"> <summary> <para> <para>The name you configured for your gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.EnableSGGatewayCmdlet.GatewayRegion"> <summary> <para> <para>A value that indicates the AWS Region where you want to store your data. The gateway AWS Region specified must be the same AWS Region as the AWS Region in your <code>Host</code> header in the request. For more information about available AWS Regions and endpoints for AWS Storage Gateway, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region">Regions and Endpoints</a> in the <i>Amazon Web Services Glossary</i>.</para><para> Valid Values: See <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region">AWS Storage Gateway Regions and Endpoints</a> in the AWS General Reference. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.EnableSGGatewayCmdlet.GatewayTimezone"> <summary> <para> <para>A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.EnableSGGatewayCmdlet.GatewayType"> <summary> <para> <para>A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is <code>CACHED</code>. </para><para> Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.EnableSGGatewayCmdlet.MediumChangerType"> <summary> <para> <para>The value that indicates the type of medium changer to use for tape gateway. This field is optional.</para><para> Valid Values: "STK-L700", "AWS-Gateway-VTL"</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.EnableSGGatewayCmdlet.Tag"> <summary> <para> <para>A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.</para><note><para>Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.EnableSGGatewayCmdlet.TapeDriveType"> <summary> <para> <para>The value that indicates the type of tape drive to use for tape gateway. This field is optional.</para><para> Valid Values: "IBM-ULT3580-TD5" </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.EnableSGGatewayCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGBandwidthRateLimitCmdlet"> <summary> Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. <para> This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGBandwidthRateLimitCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGCacheCmdlet"> <summary> Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape and file gateway types. <para> The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGCacheCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGCachediSCSIVolumeCmdlet"> <summary> Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types. <para> The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGCachediSCSIVolumeCmdlet.VolumeARNs"> <summary> <para> <para>An array of strings where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the specified cached volumes must from the same gateway. Use <a>ListVolumes</a> to get volume ARNs for a gateway.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGChapCredentialCmdlet"> <summary> Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGChapCredentialCmdlet.TargetARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return to retrieve the TargetARN for specified VolumeARN.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGFileShareListCmdlet"> <summary> Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported for file gateways.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGFileShareListCmdlet.GatewayARN"> <summary> <para> <para>The Amazon resource Name (ARN) of the gateway whose file shares you want to list. If this field is not present, all file shares under your account are listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGFileShareListCmdlet.Limit"> <summary> <para> <para>The maximum number of file shares to return in the response. The value must be an integer with a value greater than zero. Optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGFileShareListCmdlet.Marker"> <summary> <para> <para>Opaque pagination token returned from a previous ListFileShares operation. If present, <code>Marker</code> specifies where to continue the list from after a previous call to ListFileShares. Optional.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGGatewayCmdlet"> <summary> Lists gateways owned by an AWS account in an AWS Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN). <para> By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response. </para><para> If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGGatewayCmdlet.Limit"> <summary> <para> <para>Specifies that the list of gateways returned be limited to the specified number of items.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGGatewayCmdlet.Marker"> <summary> <para> <para>An opaque string that indicates the position at which to begin the returned list of gateways.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGGatewayInformationCmdlet"> <summary> Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGGatewayInformationCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGLocalDiskCmdlet"> <summary> Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request. <para> The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a <code>DiskStatus</code> field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGLocalDiskCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGMaintenanceStartTimeCmdlet"> <summary> Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGMaintenanceStartTimeCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGNFSFileShareListCmdlet"> <summary> Gets a description for one or more Network File System (NFS) file shares from a file gateway. This operation is only supported for file gateways. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGNFSFileShareListCmdlet.FileShareARNList"> <summary> <para> <para>An array containing the Amazon Resource Name (ARN) of each file share to be described. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGResourceTagCmdlet"> <summary> Lists the tags that have been added to the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway type.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource for which you want to list tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGResourceTagCmdlet.Limit"> <summary> <para> <para>Specifies that the list of tags returned be limited to the specified number of items.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGResourceTagCmdlet.Marker"> <summary> <para> <para>An opaque string that indicates the position at which to begin returning the list of tags.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGSMBFileShareCmdlet"> <summary> Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is only supported for file gateways. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGSMBFileShareCmdlet.FileShareARNList"> <summary> <para> <para>An array containing the Amazon Resource Name (ARN) of each file share to be described. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGSMBSettingCmdlet"> <summary> Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGSMBSettingCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGSnapshotScheduleCmdlet"> <summary> Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGSnapshotScheduleCmdlet.VolumeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGStorediSCSIVolumeCmdlet"> <summary> Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGStorediSCSIVolumeCmdlet.VolumeARNs"> <summary> <para> <para>An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use <a>ListVolumes</a> to get volume ARNs for a gateway.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGTapeCmdlet"> <summary> Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS. <para> This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the <code>Limit</code> parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a <code>Marker</code> element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway type. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeCmdlet.TapeARNs"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeCmdlet.Limit"> <summary> <para> <para>An optional number limit for the tapes in the list returned by this call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeCmdlet.Marker"> <summary> <para> <para>A string that indicates the position at which to begin the returned list of tapes.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGTapeArchiveCmdlet"> <summary> Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type. <para> Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeArchiveCmdlet.GatewayARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the <a>ListGateways</a> operation to return a list of gateways for your account and AWS Region.</para><para>You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeArchiveCmdlet.TapeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGTapeArchiveListCmdlet"> <summary> Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type. <para> If a specific <code>TapeARN</code> is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeArchiveListCmdlet.TapeARNs"> <summary> <para> <para>Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeArchiveListCmdlet.Limit"> <summary> <para> <para>Specifies that the number of virtual tapes descried be limited to the specified number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeArchiveListCmdlet.Marker"> <summary> <para> <para>An opaque string that indicates the position at which to begin describing virtual tapes.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGTapeListCmdlet"> <summary> Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a <code>TapeARN</code> is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway type.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeListCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeListCmdlet.TapeARNs"> <summary> <para> <para>Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeListCmdlet.Limit"> <summary> <para> <para>Specifies that the number of virtual tapes described be limited to the specified number.</para><note><para>Amazon Web Services may impose its own limit, if this field is not set.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeListCmdlet.Marker"> <summary> <para> <para>A marker value, obtained in a previous call to <code>DescribeTapes</code>. This marker indicates which page of results to retrieve. </para><para>If not specified, the first page of results is retrieved.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGTapeRecoveryPointCmdlet"> <summary> Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type. <para> A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. </para><note><para> The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge for retrieving recovery points. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeRecoveryPointCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeRecoveryPointCmdlet.TapeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGTapeRecoveryPointListCmdlet"> <summary> Returns a list of virtual tape recovery points that are available for the specified tape gateway. <para> A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway type. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeRecoveryPointListCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeRecoveryPointListCmdlet.Limit"> <summary> <para> <para>Specifies that the number of virtual tape recovery points that are described be limited to the specified number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeRecoveryPointListCmdlet.Marker"> <summary> <para> <para>An opaque string that indicates the position at which to begin describing the virtual tape recovery points.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGUploadBufferCmdlet"> <summary> Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume and tape gateway types. <para> The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGUploadBufferCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGVolumeCmdlet"> <summary> Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the <a>DescribeStorediSCSIVolumes</a> or the <a>DescribeCachediSCSIVolumes</a> API. <para> The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the <code>Limit</code> field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGVolumeCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGVolumeCmdlet.Limit"> <summary> <para> <para>Specifies that the list of volumes returned be limited to the specified number of items.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGVolumeCmdlet.Marker"> <summary> <para> <para>A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGVolumeInitiatorListCmdlet"> <summary> Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGVolumeInitiatorListCmdlet.VolumeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes for the gateway.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGVolumeRecoveryPointCmdlet"> <summary> Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type. <para> Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the <a>CreateSnapshotFromVolumeRecoveryPoint</a> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGVolumeRecoveryPointCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGVTLDeviceCmdlet"> <summary> Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information. <para> This operation is only supported in the tape gateway type. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGVTLDeviceCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGVTLDeviceCmdlet.VTLDeviceARNs"> <summary> <para> <para>An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.</para><note><para>All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGVTLDeviceCmdlet.Limit"> <summary> <para> <para>Specifies that the number of VTL devices described be limited to the specified number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGVTLDeviceCmdlet.Marker"> <summary> <para> <para>An opaque string that indicates the position at which to begin describing the VTL devices.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGWorkingStorageCmdlet"> <summary> Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead. <note><para> Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway. </para></note><para> The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGWorkingStorageCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.InvokeSGCacheRefreshCmdlet"> <summary> Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed or replaced since the gateway last listed the bucket's contents and cached the results. This operation is only supported in the file gateway type. You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification">Getting Notified About File Operations</a>. <para> When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through an CloudWatch event when your <code>RefreshCache</code> operation completes. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.InvokeSGCacheRefreshCmdlet.FileShareARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the file share you want to refresh.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.InvokeSGCacheRefreshCmdlet.FolderList"> <summary> <para> <para>A comma-separated list of the paths of folders to refresh in the cache. The default is [<code>"/"</code>]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If <code>Recursive</code> is set to "true", the entire S3 bucket that the file share has access to is refreshed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.InvokeSGCacheRefreshCmdlet.Recursive"> <summary> <para> <para>A value that specifies whether to recursively refresh folders in the cache. The refresh includes folders that were in the cache the last time the gateway listed the folder's contents. If this value set to "true", each folder that is listed in <code>FolderList</code> is recursively updated. Otherwise, subfolders listed in <code>FolderList</code> are not refreshed. Only objects that are in folders listed directly under <code>FolderList</code> are found and used for the update. The default is "true".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.InvokeSGCacheRefreshCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.JoinSGDomainCmdlet"> <summary> Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.JoinSGDomainCmdlet.DomainController"> <summary> <para> <para>List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, <code>mydc.mydomain.com:389</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.JoinSGDomainCmdlet.DomainName"> <summary> <para> <para>The name of the domain that you want the gateway to join.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.JoinSGDomainCmdlet.GatewayARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the gateway. Use the <code>ListGateways</code> operation to return a list of gateways for your account and AWS Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.JoinSGDomainCmdlet.OrganizationalUnit"> <summary> <para> <para>The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.JoinSGDomainCmdlet.Password"> <summary> <para> <para>Sets the password of the user who has permission to add the gateway to the Active Directory domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.JoinSGDomainCmdlet.UserName"> <summary> <para> <para>Sets the user name of user who has permission to add the gateway to the Active Directory domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.JoinSGDomainCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.MountSGVolumeCmdlet"> <summary> Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.MountSGVolumeCmdlet.DiskId"> <summary> <para> <para>The unique device ID or other distinguishing data that identifies the local disk used to create the volume. This value is only required when you are attaching a stored volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.MountSGVolumeCmdlet.GatewayARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.MountSGVolumeCmdlet.NetworkInterfaceId"> <summary> <para> <para>The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use <a>DescribeGatewayInformation</a> to get a list of the network interfaces available on a gateway.</para><para> Valid Values: A valid IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.MountSGVolumeCmdlet.TargetName"> <summary> <para> <para>The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying <code>TargetName</code> as <i>myvolume</i> results in the target ARN of <code>arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume</code>. The target name must be unique across all volumes on a gateway.</para><para>If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.MountSGVolumeCmdlet.VolumeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.MountSGVolumeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet"> <summary> Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type. <note><para> Cache storage must be allocated to the gateway before you can create a cached volume. Use the <a>AddCache</a> operation to add cache storage to a gateway. </para></note><para> In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. </para><para> Optionally, you can provide the ARN for an existing volume as the <code>SourceVolumeARN</code> for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The <code>VolumeSizeInBytes</code> value must be equal to or larger than the size of the copied volume, in bytes. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet.ClientToken"> <summary> <para> <para>A unique identifier that you use to retry a request. If you retry a request, use the same <code>ClientToken</code> you specified in the initial request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet.KMSEncrypted"> <summary> <para> <para>True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet.KMSKey"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet.NetworkInterfaceId"> <summary> <para> <para>The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use <a>DescribeGatewayInformation</a> to get a list of the network interfaces available on a gateway.</para><para> Valid Values: A valid IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet.SnapshotId"> <summary> <para> <para>The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html">DescribeSnapshots</a> in the <i>Amazon Elastic Compute Cloud API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet.SourceVolumeARN"> <summary> <para> <para>The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The <code>VolumeSizeInBytes</code> value for this new volume must be equal to or larger than the size of the existing volume, in bytes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet.Tag"> <summary> <para> <para>A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.</para><note><para>Valid characters for key and value are letters, spaces, and numbers that you can represent in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet.TargetName"> <summary> <para> <para>The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying <code>TargetName</code> as <i>myvolume</i> results in the target ARN of <code>arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume</code>. The target name must be unique across all volumes on a gateway.</para><para>If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet.VolumeSizeInBytes"> <summary> <para> <para>The size of the volume in bytes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet"> <summary> Creates a Network File System (NFS) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using a NFS interface. This operation is only supported for file gateways. <important><para> File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share. Make sure AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in the AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide. </para><para> File gateway does not support creating hard or symbolic links on a file share. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet.ClientList"> <summary> <para> <para>The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet.ClientToken"> <summary> <para> <para>A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet.DefaultStorageClass"> <summary> <para> <para>The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are <code>S3_STANDARD</code>, <code>S3_STANDARD_IA</code>, or <code>S3_ONEZONE_IA</code>. If this field is not populated, the default value <code>S3_STANDARD</code> is used. Optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet.NFSFileShareDefaults_DirectoryMode"> <summary> <para> <para>The Unix directory mode in the form "nnnn". For example, "0666" represents the default access mode for all directories inside the file share. The default value is 0777.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet.NFSFileShareDefaults_FileMode"> <summary> <para> <para>The Unix file mode in the form "nnnn". For example, "0666" represents the default file mode inside the file share. The default value is 0666. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet.GatewayARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet.NFSFileShareDefaults_GroupId"> <summary> <para> <para>The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet.GuessMIMETypeEnabled"> <summary> <para> <para>A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet.KMSEncrypted"> <summary> <para> <para>True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet.KMSKey"> <summary> <para> <para>The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet.LocationARN"> <summary> <para> <para>The ARN of the backed storage used for storing file data. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet.ObjectACL"> <summary> <para> <para>A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet.NFSFileShareDefaults_OwnerId"> <summary> <para> <para>The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet.ReadOnly"> <summary> <para> <para>A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet.RequesterPay"> <summary> <para> <para>A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.</para><note><para><code>RequesterPays</code> is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet.Role"> <summary> <para> <para>The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet.Squash"> <summary> <para> <para>A value that maps a user to anonymous user. Valid options are the following: </para><ul><li><para><code>RootSquash</code> - Only root is mapped to anonymous user.</para></li><li><para><code>NoSquash</code> - No one is mapped to anonymous user</para></li><li><para><code>AllSquash</code> - Everyone is mapped to anonymous user.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet.Tag"> <summary> <para> <para>A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.</para><note><para>Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGNFSFileShareCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.NewSGSMBFileShareCmdlet"> <summary> Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using a SMB interface. This operation is only supported for file gateways. <important><para> File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>AWS Identity and Access Management User Guide.</i></para><para> File gateways don't support creating hard or symbolic links on a file share. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSMBFileShareCmdlet.AdminUserList"> <summary> <para> <para>A list of users in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user. </para><important><para>Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSMBFileShareCmdlet.Authentication"> <summary> <para> <para>The authentication method that users use to access the file share.</para><para>Valid values are <code>ActiveDirectory</code> or <code>GuestAccess</code>. The default is <code>ActiveDirectory</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSMBFileShareCmdlet.ClientToken"> <summary> <para> <para>A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSMBFileShareCmdlet.DefaultStorageClass"> <summary> <para> <para>The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are <code>S3_STANDARD</code>, <code>S3_STANDARD_IA</code>, or <code>S3_ONEZONE_IA</code>. If this field is not populated, the default value <code>S3_STANDARD</code> is used. Optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSMBFileShareCmdlet.GatewayARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSMBFileShareCmdlet.GuessMIMETypeEnabled"> <summary> <para> <para>A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSMBFileShareCmdlet.InvalidUserList"> <summary> <para> <para>A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example <code>@group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSMBFileShareCmdlet.KMSEncrypted"> <summary> <para> <para>True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSMBFileShareCmdlet.KMSKey"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSMBFileShareCmdlet.LocationARN"> <summary> <para> <para>The ARN of the backed storage used for storing file data. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSMBFileShareCmdlet.ObjectACL"> <summary> <para> <para>A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSMBFileShareCmdlet.ReadOnly"> <summary> <para> <para>A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSMBFileShareCmdlet.RequesterPay"> <summary> <para> <para>A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.</para><note><para><code>RequesterPays</code> is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSMBFileShareCmdlet.Role"> <summary> <para> <para>The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSMBFileShareCmdlet.SMBACLEnabled"> <summary> <para> <para>Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.</para><para>For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSMBFileShareCmdlet.Tag"> <summary> <para> <para>A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.</para><note><para>Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSMBFileShareCmdlet.ValidUserList"> <summary> <para> <para>A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example <code>@group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSMBFileShareCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.NewSGSnapshotCmdlet"> <summary> Initiates a snapshot of a volume. <para> AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take ad-hoc snapshot. For more information, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#SchedulingSnapshot">Editing a Snapshot Schedule</a>. </para><para> In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type. </para><note><para> To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Operations.html">EC2 API reference</a>. </para></note><important><para> Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the <a href="https://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html">Welcome</a> page. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSnapshotCmdlet.SnapshotDescription"> <summary> <para> <para>Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the <b>Description</b> field, and in the AWS Storage Gateway snapshot <b>Details</b> pane, <b>Description</b> field</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSnapshotCmdlet.Tag"> <summary> <para> <para>A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.</para><note><para>Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSnapshotCmdlet.VolumeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSnapshotCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.NewSGSnapshotFromVolumeRecoveryPointCmdlet"> <summary> Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type. <para> A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use <a>ListVolumeRecoveryPoints</a>. </para><para> In the <code>CreateSnapshotFromVolumeRecoveryPoint</code> request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. </para><note><para> To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in <i>Amazon Elastic Compute Cloud API Reference</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSnapshotFromVolumeRecoveryPointCmdlet.SnapshotDescription"> <summary> <para> <para>Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the <b>Description</b> field, and in the AWS Storage Gateway snapshot <b>Details</b> pane, <b>Description</b> field</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSnapshotFromVolumeRecoveryPointCmdlet.Tag"> <summary> <para> <para>A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.</para><note><para>Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSnapshotFromVolumeRecoveryPointCmdlet.VolumeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return to retrieve the TargetARN for specified VolumeARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSnapshotFromVolumeRecoveryPointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.NewSGStorediSCSIVolumeCmdlet"> <summary> Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type. <para> The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased. </para><para> In the request you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGStorediSCSIVolumeCmdlet.DiskId"> <summary> <para> <para>The unique identifier for the gateway local disk that is configured as a stored volume. Use <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/API_ListLocalDisks.html">ListLocalDisks</a> to list disk IDs for a gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGStorediSCSIVolumeCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGStorediSCSIVolumeCmdlet.KMSEncrypted"> <summary> <para> <para>True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGStorediSCSIVolumeCmdlet.KMSKey"> <summary> <para> <para>The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGStorediSCSIVolumeCmdlet.NetworkInterfaceId"> <summary> <para> <para>The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use <a>DescribeGatewayInformation</a> to get a list of the network interfaces available on a gateway.</para><para> Valid Values: A valid IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGStorediSCSIVolumeCmdlet.PreserveExistingData"> <summary> <para> <para>Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume.</para><para> Valid Values: true, false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGStorediSCSIVolumeCmdlet.SnapshotId"> <summary> <para> <para>The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html">DescribeSnapshots</a> in the <i>Amazon Elastic Compute Cloud API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGStorediSCSIVolumeCmdlet.Tag"> <summary> <para> <para>A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.</para><note><para>Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGStorediSCSIVolumeCmdlet.TargetName"> <summary> <para> <para>The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying <code>TargetName</code> as <i>myvolume</i> results in the target ARN of <code>arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume</code>. The target name must be unique across all volumes on a gateway.</para><para>If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGStorediSCSIVolumeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.NewSGTapeCmdlet"> <summary> Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type. <note><para> Cache storage must be allocated to the gateway before you can create virtual tapes. Use the <a>AddCache</a> operation to add cache storage to a gateway. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapeCmdlet.ClientToken"> <summary> <para> <para>A unique identifier that you use to retry a request. If you retry a request, use the same <code>ClientToken</code> you specified in the initial request.</para><note><para>Using the same <code>ClientToken</code> prevents creating the tape multiple times.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapeCmdlet.GatewayARN"> <summary> <para> <para>The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the <a>ListGateways</a> operation to return a list of gateways for your account and AWS Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapeCmdlet.KMSEncrypted"> <summary> <para> <para>True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapeCmdlet.KMSKey"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapeCmdlet.NumTapesToCreate"> <summary> <para> <para>The number of virtual tapes that you want to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapeCmdlet.PoolId"> <summary> <para> <para>The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.</para><para>Valid values: "GLACIER", "DEEP_ARCHIVE"</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapeCmdlet.Tag"> <summary> <para> <para>A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair.</para><note><para>Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapeCmdlet.TapeBarcodePrefix"> <summary> <para> <para>A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.</para><note><para>The prefix must be 1 to 4 characters in length and must be one of the uppercase letters from A to Z.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapeCmdlet.TapeSizeInBytes"> <summary> <para> <para>The size, in bytes, of the virtual tapes that you want to create.</para><note><para>The size must be aligned by gigabyte (1024*1024*1024 byte).</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.NewSGTapeWithBarcodeCmdlet"> <summary> Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and can not be reused if it has already been used on a tape . This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type. <note><para> Cache storage must be allocated to the gateway before you can create a virtual tape. Use the <a>AddCache</a> operation to add cache storage to a gateway. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapeWithBarcodeCmdlet.GatewayARN"> <summary> <para> <para>The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the <a>ListGateways</a> operation to return a list of gateways for your account and AWS Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapeWithBarcodeCmdlet.KMSEncrypted"> <summary> <para> <para>True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapeWithBarcodeCmdlet.KMSKey"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapeWithBarcodeCmdlet.PoolId"> <summary> <para> <para>The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.</para><para>Valid values: "GLACIER", "DEEP_ARCHIVE"</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapeWithBarcodeCmdlet.Tag"> <summary> <para> <para>A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a key-value pair.</para><note><para>Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapeWithBarcodeCmdlet.TapeBarcode"> <summary> <para> <para>The barcode that you want to assign to the tape.</para><note><para>Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapeWithBarcodeCmdlet.TapeSizeInByte"> <summary> <para> <para>The size, in bytes, of the virtual tape that you want to create.</para><note><para>The size must be aligned by gigabyte (1024*1024*1024 byte).</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapeWithBarcodeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.RemoveSGBandwidthRateLimitCmdlet"> <summary> Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGBandwidthRateLimitCmdlet.BandwidthType"> <summary> <para> <para>One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete.</para><para>Valid Values: <code>Upload</code>, <code>Download</code>, <code>All</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGBandwidthRateLimitCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGBandwidthRateLimitCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.RemoveSGChapCredentialCmdlet"> <summary> Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGChapCredentialCmdlet.InitiatorName"> <summary> <para> <para>The iSCSI initiator that connects to the target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGChapCredentialCmdlet.TargetARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return to retrieve the TargetARN for specified VolumeARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGChapCredentialCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.RemoveSGFileShareCmdlet"> <summary> Deletes a file share from a file gateway. This operation is only supported for file gateways. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGFileShareCmdlet.FileShareARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the file share to be deleted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGFileShareCmdlet.ForceDelete"> <summary> <para> <para>If this value is set to true, the operation deletes a file share immediately and aborts all data uploads to AWS. Otherwise, the file share is not deleted until all data is uploaded to AWS. This process aborts the data upload process, and the file share enters the FORCE_DELETING status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGFileShareCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.RemoveSGGatewayCmdlet"> <summary> Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer. <para> After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment. </para><important><para> You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the <a href="http://aws.amazon.com/storagegateway"> AWS Storage Gateway Detail Page</a>. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGGatewayCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGGatewayCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.RemoveSGResourceTagCmdlet"> <summary> Removes one or more tags from the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway types. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource you want to remove the tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the tags you want to remove from the specified resource. A tag is composed of a key/value pair.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.RemoveSGSnapshotScheduleCmdlet"> <summary> Deletes a snapshot of a volume. <para> You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/WorkingWithSnapshots.html">Working with Snapshots</a>. In the <code>DeleteSnapshotSchedule</code> request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types. </para><note><para> To list or delete a snapshot, you must use the Amazon EC2 API. in <i>Amazon Elastic Compute Cloud API Reference</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGSnapshotScheduleCmdlet.VolumeARN"> <summary> <para> <para>The volume which snapshot schedule to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGSnapshotScheduleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.RemoveSGTapeCmdlet"> <summary> Deletes the specified virtual tape. This operation is only supported in the tape gateway type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGTapeCmdlet.GatewayARN"> <summary> <para> <para>The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the <a>ListGateways</a> operation to return a list of gateways for your account and AWS Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGTapeCmdlet.TapeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the virtual tape to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGTapeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.RemoveSGTapeArchiveCmdlet"> <summary> Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGTapeArchiveCmdlet.TapeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGTapeArchiveCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.RemoveSGVolumeCmdlet"> <summary> Deletes the specified storage volume that you previously created using the <a>CreateCachediSCSIVolume</a> or <a>CreateStorediSCSIVolume</a> API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume. <para> Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html">DescribeSnapshots</a> in the <i>Amazon Elastic Compute Cloud API Reference</i>. </para><para> In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGVolumeCmdlet.VolumeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGVolumeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.ResetSGCacheCmdlet"> <summary> Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types. <important><para> If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.ResetSGCacheCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.ResetSGCacheCmdlet.PassThru"> <summary> Returns the value passed to the GatewayARN parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.ResetSGCacheCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.SendSGUploadedNotificationCmdlet"> <summary> Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3. <para> AWS Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or AWS Lambda function. This operation is only supported for file gateways. </para><para> For more information, see Getting File Upload Notification in the Storage Gateway User Guide (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.SendSGUploadedNotificationCmdlet.FileShareARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.SendSGUploadedNotificationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.SetSGLocalConsolePasswordCmdlet"> <summary> Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.SetSGLocalConsolePasswordCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.SetSGLocalConsolePasswordCmdlet.LocalConsolePassword"> <summary> <para> <para>The password you want to set for your VM local console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.SetSGLocalConsolePasswordCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.SetSGSMBGuestPasswordCmdlet"> <summary> Sets the password for the guest user <code>smbguest</code>. The <code>smbguest</code> user is the user when the authentication method for the file share is set to <code>GuestAccess</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.SetSGSMBGuestPasswordCmdlet.GatewayARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the file gateway the SMB file share is associated with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.SetSGSMBGuestPasswordCmdlet.Password"> <summary> <para> <para>The password that you want to set for your SMB Server.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.SetSGSMBGuestPasswordCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.StartSGGatewayCmdlet"> <summary> Starts a gateway that you previously shut down (see <a>ShutdownGateway</a>). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups. <note><para> When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call <a>DescribeGatewayInformation</a> and check the status before making any additional API calls. For more information, see <a>ActivateGateway</a>. </para></note><para> To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StartSGGatewayCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StartSGGatewayCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.StopSGArchivalCmdlet"> <summary> Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StopSGArchivalCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StopSGArchivalCmdlet.TapeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StopSGArchivalCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.StopSGGatewayCmdlet"> <summary> Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request. <para> The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM. </para><note><para> If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions. </para></note><para> After the gateway is shutdown, you cannot call any other API except <a>StartGateway</a>, <a>DescribeGatewayInformation</a>, and <a>ListGateways</a>. For more information, see <a>ActivateGateway</a>. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken. </para><note><para> When you make a shutdown request, you will get a <code>200 OK</code> success response immediately. However, it might take some time for the gateway to shut down. You can call the <a>DescribeGatewayInformation</a> API to check the status. For more information, see <a>ActivateGateway</a>. </para></note><para> If do not intend to use the gateway again, you must delete the gateway (using <a>DeleteGateway</a>) to no longer pay software charges associated with the gateway. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StopSGGatewayCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StopSGGatewayCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.StopSGRetrievalCmdlet"> <summary> Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StopSGRetrievalCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StopSGRetrievalCmdlet.TapeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StopSGRetrievalCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.UpdateSGBandwidthRateLimitCmdlet"> <summary> Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. <para> By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth. </para><para> To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGBandwidthRateLimitCmdlet.AverageDownloadRateLimitInBitsPerSec"> <summary> <para> <para>The average download bandwidth rate limit in bits per second.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGBandwidthRateLimitCmdlet.AverageUploadRateLimitInBitsPerSec"> <summary> <para> <para>The average upload bandwidth rate limit in bits per second.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGBandwidthRateLimitCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGBandwidthRateLimitCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.UpdateSGChapCredentialCmdlet"> <summary> Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. <important><para> When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGChapCredentialCmdlet.InitiatorName"> <summary> <para> <para>The iSCSI initiator that connects to the target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGChapCredentialCmdlet.SecretToAuthenticateInitiator"> <summary> <para> <para>The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.</para><note><para>The secret key must be between 12 and 16 bytes when encoded in UTF-8.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGChapCredentialCmdlet.SecretToAuthenticateTarget"> <summary> <para> <para>The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).</para><para>Byte constraints: Minimum bytes of 12. Maximum bytes of 16.</para><note><para>The secret key must be between 12 and 16 bytes when encoded in UTF-8.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGChapCredentialCmdlet.TargetARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return the TargetARN for specified VolumeARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGChapCredentialCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.UpdateSGGatewayInformationCmdlet"> <summary> Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. <note><para> For Gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGGatewayInformationCmdlet.CloudWatchLogGroupARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway. </para><para>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html">What Is Amazon CloudWatch Logs?</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGGatewayInformationCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGGatewayInformationCmdlet.GatewayName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGGatewayInformationCmdlet.GatewayTimezone"> <summary> <para> <para>A value that indicates the time zone of the gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGGatewayInformationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.UpdateSGGatewaySoftwareNowCmdlet"> <summary> Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. <note><para> When you make this request, you get a <code>200 OK</code> success response immediately. However, it might take some time for the update to complete. You can call <a>DescribeGatewayInformation</a> to verify the gateway is in the <code>STATE_RUNNING</code> state. </para></note><important><para> A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorWindowsClient.html#CustomizeWindowsiSCSISettings">Customizing Your Windows iSCSI Settings</a> and <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorRedHatClient.html#CustomizeLinuxiSCSISettings">Customizing Your Linux iSCSI Settings</a>, respectively. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGGatewaySoftwareNowCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGGatewaySoftwareNowCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.UpdateSGMaintenanceStartTimeCmdlet"> <summary> Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGMaintenanceStartTimeCmdlet.DayOfMonth"> <summary> <para> <para>The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.</para><note><para>This value is only available for tape and volume gateways.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGMaintenanceStartTimeCmdlet.DayOfWeek"> <summary> <para> <para>The day of the week component of the maintenance start time week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGMaintenanceStartTimeCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGMaintenanceStartTimeCmdlet.HourOfDay"> <summary> <para> <para>The hour component of the maintenance start time represented as <i>hh</i>, where <i>hh</i> is the hour (00 to 23). The hour of the day is in the time zone of the gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGMaintenanceStartTimeCmdlet.MinuteOfHour"> <summary> <para> <para>The minute component of the maintenance start time represented as <i>mm</i>, where <i>mm</i> is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGMaintenanceStartTimeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.UpdateSGNFSFileShareCmdlet"> <summary> Updates a Network File System (NFS) file share. This operation is only supported in the file gateway type. <note><para> To leave a file share field unchanged, set the corresponding input field to null. </para></note><para> Updates the following file share setting: </para><ul><li><para> Default storage class for your S3 bucket </para></li><li><para> Metadata defaults for your S3 bucket </para></li><li><para> Allowed NFS clients for your file share </para></li><li><para> Squash settings </para></li><li><para> Write status of your file share </para></li></ul><note><para> To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported in file gateways. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGNFSFileShareCmdlet.ClientList"> <summary> <para> <para>The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGNFSFileShareCmdlet.DefaultStorageClass"> <summary> <para> <para>The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are <code>S3_STANDARD</code>, <code>S3_STANDARD_IA</code>, or <code>S3_ONEZONE_IA</code>. If this field is not populated, the default value <code>S3_STANDARD</code> is used. Optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGNFSFileShareCmdlet.NFSFileShareDefaults_DirectoryMode"> <summary> <para> <para>The Unix directory mode in the form "nnnn". For example, "0666" represents the default access mode for all directories inside the file share. The default value is 0777.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGNFSFileShareCmdlet.NFSFileShareDefaults_FileMode"> <summary> <para> <para>The Unix file mode in the form "nnnn". For example, "0666" represents the default file mode inside the file share. The default value is 0666. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGNFSFileShareCmdlet.FileShareARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the file share to be updated. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGNFSFileShareCmdlet.NFSFileShareDefaults_GroupId"> <summary> <para> <para>The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGNFSFileShareCmdlet.GuessMIMETypeEnabled"> <summary> <para> <para>A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGNFSFileShareCmdlet.KMSEncrypted"> <summary> <para> <para>True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGNFSFileShareCmdlet.KMSKey"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGNFSFileShareCmdlet.ObjectACL"> <summary> <para> <para>A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGNFSFileShareCmdlet.NFSFileShareDefaults_OwnerId"> <summary> <para> <para>The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGNFSFileShareCmdlet.ReadOnly"> <summary> <para> <para>A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGNFSFileShareCmdlet.RequesterPay"> <summary> <para> <para>A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.</para><note><para><code>RequesterPays</code> is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGNFSFileShareCmdlet.Squash"> <summary> <para> <para>The user mapped to anonymous user. Valid options are the following:</para><ul><li><para><code>RootSquash</code> - Only root is mapped to anonymous user.</para></li><li><para><code>NoSquash</code> - No one is mapped to anonymous user</para></li><li><para><code>AllSquash</code> - Everyone is mapped to anonymous user.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGNFSFileShareCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.UpdateSGSMBFileShareCmdlet"> <summary> Updates a Server Message Block (SMB) file share. <note><para> To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported for file gateways. </para></note><important><para> File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>AWS Identity and Access Management User Guide.</i></para><para> File gateways don't support creating hard or symbolic links on a file share. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSMBFileShareCmdlet.AdminUserList"> <summary> <para> <para>A list of users in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. For example <code>@group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSMBFileShareCmdlet.DefaultStorageClass"> <summary> <para> <para>The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are <code>S3_STANDARD</code>, <code>S3_STANDARD_IA</code>, or <code>S3_ONEZONE_IA</code>. If this field is not populated, the default value <code>S3_STANDARD</code> is used. Optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSMBFileShareCmdlet.FileShareARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the SMB file share that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSMBFileShareCmdlet.GuessMIMETypeEnabled"> <summary> <para> <para>A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSMBFileShareCmdlet.InvalidUserList"> <summary> <para> <para>A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example <code>@group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSMBFileShareCmdlet.KMSEncrypted"> <summary> <para> <para>True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSMBFileShareCmdlet.KMSKey"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSMBFileShareCmdlet.ObjectACL"> <summary> <para> <para>A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSMBFileShareCmdlet.ReadOnly"> <summary> <para> <para>A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSMBFileShareCmdlet.RequesterPay"> <summary> <para> <para>A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.</para><note><para><code>RequesterPays</code> is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSMBFileShareCmdlet.SMBACLEnabled"> <summary> <para> <para>Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.</para><para>For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.htmlin the Storage Gateway User Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSMBFileShareCmdlet.ValidUserList"> <summary> <para> <para>A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example <code>@group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSMBFileShareCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.UpdateSGSMBSecurityStrategyCmdlet"> <summary> Updates the SMB security strategy on a file gateway. This action is only supported in file gateways. <note><para> This API is called Security level in the User Guide. </para><para> A higher security level can affect performance of the gateway. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSMBSecurityStrategyCmdlet.GatewayARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSMBSecurityStrategyCmdlet.SMBSecurityStrategy"> <summary> <para> <para>Specifies the type of security strategy.</para><para>ClientSpecified: if you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. </para><para>MandatorySigning: if you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer. </para><para>MandatoryEncryption: if you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSMBSecurityStrategyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.UpdateSGSnapshotScheduleCmdlet"> <summary> Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types. <para> The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume. </para><para> In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSnapshotScheduleCmdlet.Description"> <summary> <para> <para>Optional description of the snapshot that overwrites the existing description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSnapshotScheduleCmdlet.RecurrenceInHours"> <summary> <para> <para>Frequency of snapshots. Specify the number of hours between snapshots.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSnapshotScheduleCmdlet.StartAt"> <summary> <para> <para>The hour of the day at which the snapshot schedule begins represented as <i>hh</i>, where <i>hh</i> is the hour (0 to 23). The hour of the day is in the time zone of the gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSnapshotScheduleCmdlet.Tag"> <summary> <para> <para>A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.</para><note><para>Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSnapshotScheduleCmdlet.VolumeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSnapshotScheduleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.UpdateSGVTLDeviceTypeCmdlet"> <summary> Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGVTLDeviceTypeCmdlet.DeviceType"> <summary> <para> <para>The type of medium changer you want to select.</para><para> Valid Values: "STK-L700", "AWS-Gateway-VTL"</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGVTLDeviceTypeCmdlet.VTLDeviceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the medium changer you want to select.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGVTLDeviceTypeCmdlet.PassThru"> <summary> Returns the value passed to the VTLDeviceARN parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGVTLDeviceTypeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |