StorageGateway class

AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and the AWS storage infrastructure. The service enables you to securely upload data to the AWS Cloud for cost effective backup and rapid disaster recovery.

Constructors

StorageGateway({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

activateGateway({required String activationKey, required String gatewayName, required String gatewayRegion, required String gatewayTimezone, String? gatewayType, String? mediumChangerType, List<Tag>? tags, String? tapeDriveType}) → Future<ActivateGatewayOutput>

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 UpdateGatewayInformation.

addCache({required List<String> diskIds, required String gatewayARN}) → Future<AddCacheOutput>

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 How AWS Storage Gateway works (architecture).

addTagsToResource({required String resourceARN, required List<Tag> tags}) → Future<AddTagsToResourceOutput>

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:

addUploadBuffer({required List<String> diskIds, required String gatewayARN}) → Future<AddUploadBufferOutput>

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.

addWorkingStorage({required List<String> diskIds, required String gatewayARN}) → Future<AddWorkingStorageOutput>

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 AddUploadBuffer instead. 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.

assignTapePool({required String poolId, required String tapeARN, bool? bypassGovernanceRetention}) → Future<AssignTapePoolOutput>

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 (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

attachVolume({required String gatewayARN, required String networkInterfaceId, required String volumeARN, String? diskId, String? targetName}) → Future<AttachVolumeOutput>

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.

cancelArchival({required String gatewayARN, required String tapeARN}) → Future<CancelArchivalOutput>

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.

cancelRetrieval({required String gatewayARN, required String tapeARN}) → Future<CancelRetrievalOutput>

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.

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createCachediSCSIVolume({required String clientToken, required String gatewayARN, required String networkInterfaceId, required String targetName, required int volumeSizeInBytes, bool? kMSEncrypted, String? kMSKey, String? snapshotId, String? sourceVolumeARN, List<Tag>? tags}) → Future<CreateCachediSCSIVolumeOutput>

Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type. 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.

createNFSFileShare({required String clientToken, required String gatewayARN, required String locationARN, required String role, CacheAttributes? cacheAttributes, List<String>? clientList, String? defaultStorageClass, String? fileShareName, bool? guessMIMETypeEnabled, bool? kMSEncrypted, String? kMSKey, NFSFileShareDefaults? nFSFileShareDefaults, String? notificationPolicy, ObjectACL? objectACL, bool? readOnly, bool? requesterPays, String? squash, List<Tag>? tags}) → Future<CreateNFSFileShareOutput>

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 an NFS interface. This operation is only supported for file gateways.

createSMBFileShare({required String clientToken, required String gatewayARN, required String locationARN, required String role, bool? accessBasedEnumeration, List<String>? adminUserList, String? auditDestinationARN, String? authentication, CacheAttributes? cacheAttributes, CaseSensitivity? caseSensitivity, String? defaultStorageClass, String? fileShareName, bool? guessMIMETypeEnabled, List<String>? invalidUserList, bool? kMSEncrypted, String? kMSKey, String? notificationPolicy, ObjectACL? objectACL, bool? readOnly, bool? requesterPays, bool? sMBACLEnabled, List<Tag>? tags, List<String>? validUserList}) → Future<CreateSMBFileShareOutput>

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 exposes file shares using an SMB interface. This operation is only supported for file gateways.

createSnapshot({required String snapshotDescription, required String volumeARN, List<Tag>? tags}) → Future<CreateSnapshotOutput>

Initiates a snapshot of a volume.

createSnapshotFromVolumeRecoveryPoint({required String snapshotDescription, required String volumeARN, List<Tag>? tags}) → Future<CreateSnapshotFromVolumeRecoveryPointOutput>

Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type.

createStorediSCSIVolume({required String diskId, required String gatewayARN, required String networkInterfaceId, required bool preserveExistingData, required String targetName, bool? kMSEncrypted, String? kMSKey, String? snapshotId, List<Tag>? tags}) → Future<CreateStorediSCSIVolumeOutput>

Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type.

createTapePool({required String poolName, required TapeStorageClass storageClass, int? retentionLockTimeInDays, RetentionLockType? retentionLockType, List<Tag>? tags}) → Future<CreateTapePoolOutput>

Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool.

createTapes({required String clientToken, required String gatewayARN, required int numTapesToCreate, required String tapeBarcodePrefix, required int tapeSizeInBytes, bool? kMSEncrypted, String? kMSKey, String? poolId, List<Tag>? tags, bool? worm}) → Future<CreateTapesOutput>

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.

createTapeWithBarcode({required String gatewayARN, required String tapeBarcode, required int tapeSizeInBytes, bool? kMSEncrypted, String? kMSKey, String? poolId, List<Tag>? tags, bool? worm}) → Future<CreateTapeWithBarcodeOutput>

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 cannot 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.

deleteAutomaticTapeCreationPolicy({required String gatewayARN}) → Future<DeleteAutomaticTapeCreationPolicyOutput>

Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy.

deleteBandwidthRateLimit({required String bandwidthType, required String gatewayARN}) → Future<DeleteBandwidthRateLimitOutput>

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. This operation is supported for the stored volume, cached volume and tape gateway types.

deleteChapCredentials({required String initiatorName, required String targetARN}) → Future<DeleteChapCredentialsOutput>

Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. This operation is supported in volume and tape gateway types.

deleteFileShare({required String fileShareARN, bool? forceDelete}) → Future<DeleteFileShareOutput>

Deletes a file share from a file gateway. This operation is only supported for file gateways.

deleteGateway({required String gatewayARN}) → Future<DeleteGatewayOutput>

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.

deleteSnapshotSchedule({required String volumeARN}) → Future<DeleteSnapshotScheduleOutput>

Deletes a snapshot of a volume.

deleteTape({required String gatewayARN, required String tapeARN, bool? bypassGovernanceRetention}) → Future<DeleteTapeOutput>

Deletes the specified virtual tape. This operation is only supported in the tape gateway type.

deleteTapeArchive({required String tapeARN, bool? bypassGovernanceRetention}) → Future<DeleteTapeArchiveOutput>

Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

deleteTapePool({required String poolARN}) → Future<DeleteTapePoolOutput>

Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in the pool and if there are no automatic tape creation policies that reference the custom tape pool.

deleteVolume({required String volumeARN}) → Future<DeleteVolumeOutput>

Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume 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.

describeAvailabilityMonitorTest({required String gatewayARN}) → Future<DescribeAvailabilityMonitorTestOutput>

Returns information about the most recent High Availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null.

describeBandwidthRateLimit({required String gatewayARN}) → Future<DescribeBandwidthRateLimitOutput>

Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. This operation is supported for the stored volume, cached volume, and tape gateway types.

describeBandwidthRateLimitSchedule({required String gatewayARN}) → Future<DescribeBandwidthRateLimitScheduleOutput>

Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This operation is supported only in the volume and tape gateway types.

describeCache({required String gatewayARN}) → Future<DescribeCacheOutput>

Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types.

describeCachediSCSIVolumes({required List<String> volumeARNs}) → Future<DescribeCachediSCSIVolumesOutput>

Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.

describeChapCredentials({required String targetARN}) → Future<DescribeChapCredentialsOutput>

Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway types.

describeGatewayInformation({required String gatewayARN}) → Future<DescribeGatewayInformationOutput>

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.

describeMaintenanceStartTime({required String gatewayARN}) → Future<DescribeMaintenanceStartTimeOutput>

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.

describeNFSFileShares({required List<String> fileShareARNList}) → Future<DescribeNFSFileSharesOutput>

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.

describeSMBFileShares({required List<String> fileShareARNList}) → Future<DescribeSMBFileSharesOutput>

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.

describeSMBSettings({required String gatewayARN}) → Future<DescribeSMBSettingsOutput>

Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.

describeSnapshotSchedule({required String volumeARN}) → Future<DescribeSnapshotScheduleOutput>

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.

describeStorediSCSIVolumes({required List<String> volumeARNs}) → Future<DescribeStorediSCSIVolumesOutput>

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, AWS Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.

describeTapeArchives({int? limit, String? marker, List<String>? tapeARNs}) → Future<DescribeTapeArchivesOutput>

Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

describeTapeRecoveryPoints({required String gatewayARN, int? limit, String? marker}) → Future<DescribeTapeRecoveryPointsOutput>

Returns a list of virtual tape recovery points that are available for the specified tape gateway.

describeTapes({required String gatewayARN, int? limit, String? marker, List<String>? tapeARNs}) → Future<DescribeTapesOutput>

Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN 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.

describeUploadBuffer({required String gatewayARN}) → Future<DescribeUploadBufferOutput>

Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.

describeVTLDevices({required String gatewayARN, int? limit, String? marker, List<String>? vTLDeviceARNs}) → Future<DescribeVTLDevicesOutput>

Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information.

describeWorkingStorage({required String gatewayARN}) → Future<DescribeWorkingStorageOutput>

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. The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.

detachVolume({required String volumeARN, bool? forceDetach}) → Future<DetachVolumeOutput>

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. This operation is only supported in the volume gateway type.

disableGateway({required String gatewayARN}) → Future<DisableGatewayOutput>

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.

joinDomain({required String domainName, required String gatewayARN, required String password, required String userName, List<String>? domainControllers, String? organizationalUnit, int? timeoutInSeconds}) → Future<JoinDomainOutput>

Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.

listAutomaticTapeCreationPolicies({String? gatewayARN}) → Future<ListAutomaticTapeCreationPoliciesOutput>

Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list.

listFileShares({String? gatewayARN, int? limit, String? marker}) → Future<ListFileSharesOutput>

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.

listGateways({int? limit, String? marker}) → Future<ListGatewaysOutput>

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).

listLocalDisks({required String gatewayARN}) → Future<ListLocalDisksOutput>

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.

listTagsForResource({required String resourceARN, int? limit, String? marker}) → Future<ListTagsForResourceOutput>

Lists the tags that have been added to the specified resource. This operation is supported in storage gateways of all types.

listTapePools({int? limit, String? marker, List<String>? poolARNs}) → Future<ListTapePoolsOutput>

Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools.

listTapes({int? limit, String? marker, List<String>? tapeARNs}) → Future<ListTapesOutput>

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.

listVolumeInitiators({required String volumeARN}) → Future<ListVolumeInitiatorsOutput>

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.

listVolumeRecoveryPoints({required String gatewayARN}) → Future<ListVolumeRecoveryPointsOutput>

Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type.

listVolumes({String? gatewayARN, int? limit, String? marker}) → Future<ListVolumesOutput>

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 DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notifyWhenUploaded({required String fileShareARN}) → Future<NotifyWhenUploadedOutput>

Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3.

refreshCache({required String fileShareARN, List<String>? folderList, bool? recursive}) → Future<RefreshCacheOutput>

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 Getting notified about file operations in the AWS Storage Gateway User Guide.

removeTagsFromResource({required String resourceARN, required List<String> tagKeys}) → Future<RemoveTagsFromResourceOutput>

Removes one or more tags from the specified resource. This operation is supported in storage gateways of all types.

resetCache({required String gatewayARN}) → Future<ResetCacheOutput>

Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters an 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.

retrieveTapeArchive({required String gatewayARN, required String tapeARN}) → Future<RetrieveTapeArchiveOutput>

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.

retrieveTapeRecoveryPoint({required String gatewayARN, required String tapeARN}) → Future<RetrieveTapeRecoveryPointOutput>

Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type.

setLocalConsolePassword({required String gatewayARN, required String localConsolePassword}) → Future<SetLocalConsolePasswordOutput>

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.

setSMBGuestPassword({required String gatewayARN, required String password}) → Future<SetSMBGuestPasswordOutput>

Sets the password for the guest user smbguest. The smbguest user is the user when the authentication method for the file share is set to GuestAccess.

shutdownGateway({required String gatewayARN}) → Future<ShutdownGatewayOutput>

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.

startAvailabilityMonitorTest({required String gatewayARN}) → Future<StartAvailabilityMonitorTestOutput>

Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API.

startGateway({required String gatewayARN}) → Future<StartGatewayOutput>

Starts a gateway that you previously shut down (see ShutdownGateway). 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. To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.

toString() → String

A string representation of this object.

inherited

updateAutomaticTapeCreationPolicy({required List<AutomaticTapeCreationRule> automaticTapeCreationRules, required String gatewayARN}) → Future<UpdateAutomaticTapeCreationPolicyOutput>

Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways.

updateBandwidthRateLimit({required String gatewayARN, int? averageDownloadRateLimitInBitsPerSec, int? averageUploadRateLimitInBitsPerSec}) → Future<UpdateBandwidthRateLimitOutput>

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. This operation is supported for the stored volume, cached volume, and tape gateway types.

updateBandwidthRateLimitSchedule({required List<BandwidthRateLimitInterval> bandwidthRateLimitIntervals, required String gatewayARN}) → Future<UpdateBandwidthRateLimitScheduleOutput>

Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This operation is supported in the volume and tape gateway types.

updateChapCredentials({required String initiatorName, required String secretToAuthenticateInitiator, required String targetARN, String? secretToAuthenticateTarget}) → Future<UpdateChapCredentialsOutput>

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. This operation is supported in the volume and tape gateway types.

updateGatewayInformation({required String gatewayARN, String? cloudWatchLogGroupARN, String? gatewayName, String? gatewayTimezone}) → Future<UpdateGatewayInformationOutput>

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.

updateGatewaySoftwareNow({required String gatewayARN}) → Future<UpdateGatewaySoftwareNowOutput>

Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

updateMaintenanceStartTime({required String gatewayARN, required int hourOfDay, required int minuteOfHour, int? dayOfMonth, int? dayOfWeek}) → Future<UpdateMaintenanceStartTimeOutput>

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.

updateNFSFileShare({required String fileShareARN, CacheAttributes? cacheAttributes, List<String>? clientList, String? defaultStorageClass, String? fileShareName, bool? guessMIMETypeEnabled, bool? kMSEncrypted, String? kMSKey, NFSFileShareDefaults? nFSFileShareDefaults, String? notificationPolicy, ObjectACL? objectACL, bool? readOnly, bool? requesterPays, String? squash}) → Future<UpdateNFSFileShareOutput>

Updates a Network File System (NFS) file share. This operation is only supported in the file gateway type. Updates the following file share settings:

updateSMBFileShare({required String fileShareARN, bool? accessBasedEnumeration, List<String>? adminUserList, String? auditDestinationARN, CacheAttributes? cacheAttributes, CaseSensitivity? caseSensitivity, String? defaultStorageClass, String? fileShareName, bool? guessMIMETypeEnabled, List<String>? invalidUserList, bool? kMSEncrypted, String? kMSKey, String? notificationPolicy, ObjectACL? objectACL, bool? readOnly, bool? requesterPays, bool? sMBACLEnabled, List<String>? validUserList}) → Future<UpdateSMBFileShareOutput>

Updates a Server Message Block (SMB) file share. This operation is only supported for file gateways.

updateSMBFileShareVisibility({required bool fileSharesVisible, required String gatewayARN}) → Future<UpdateSMBFileShareVisibilityOutput>

Controls whether the shares on a gateway are visible in a net view or browse list.

updateSMBSecurityStrategy({required String gatewayARN, required SMBSecurityStrategy sMBSecurityStrategy}) → Future<UpdateSMBSecurityStrategyOutput>

Updates the SMB security strategy on a file gateway. This action is only supported in file gateways.

updateSnapshotSchedule({required int recurrenceInHours, required int startAt, required String volumeARN, String? description, List<Tag>? tags}) → Future<UpdateSnapshotScheduleOutput>

Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types.

updateVTLDeviceType({required String deviceType, required String vTLDeviceARN}) → Future<UpdateVTLDeviceTypeOutput>

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.

Operators

operator ==(Object other) → bool

The equality operator.

inherited