The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
- * value can only be set when KMSEncrypted is true. Optional.
Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
+ * CMKs. This value must be set if KMSEncrypted is true, or if
+ * EncryptionType is SseKms or DsseKms.
Describes Network File System (NFS) file share default values. Files and folders stored * as Amazon S3 objects in S3 buckets don't, by default, have Unix file @@ -1344,9 +1361,39 @@ export interface CreateNFSFileShareInput { GatewayARN: string | undefined; /** - *
Set to true to use Amazon S3 server-side encryption with your own
- * KMS key, or false to use a key managed by Amazon S3.
- * Optional.
A value that specifies the type of server-side encryption that the file share will use + * for the data that it stores in Amazon S3.
+ *We recommend using EncryptionType instead of KMSEncrypted
+ * to set the file share encryption method. You do not need to provide values for both
+ * parameters.
If values for both parameters exist in the same request, then the specified
+ * encryption methods must not conflict. For example, if EncryptionType is
+ * SseS3, then KMSEncrypted must be false. If
+ * EncryptionType is SseKms or DsseKms, then
+ * KMSEncrypted must be true.
Optional. Set to true to use Amazon S3 server-side encryption with
+ * your own KMS key (SSE-KMS), or false to use a key managed by
+ * Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the
+ * EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted
+ * to set the file share encryption method. You do not need to provide values for both
+ * parameters.
If values for both parameters exist in the same request, then the specified
+ * encryption methods must not conflict. For example, if EncryptionType is
+ * SseS3, then KMSEncrypted must be false. If
+ * EncryptionType is SseKms or DsseKms, then
+ * KMSEncrypted must be true.
Valid Values: true | false
*
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
- * value can only be set when KMSEncrypted is true. Optional.
Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
+ * CMKs. This value must be set if KMSEncrypted is true, or if
+ * EncryptionType is SseKms or DsseKms.
* SettlingTimeInSeconds has no effect on the timing of the object
* uploading to Amazon S3, only the timing of the notification.
This setting is not meant to specify an exact time at which the notification will be + * sent. In some cases, the gateway might require more than the specified delay time to + * generate and send notifications.
* *The following example sets NotificationPolicy on with
* SettlingTimeInSeconds set to 60.
Set to true to use Amazon S3 server-side encryption with your own
- * KMS key, or false to use a key managed by Amazon S3.
- * Optional.
A value that specifies the type of server-side encryption that the file share will use + * for the data that it stores in Amazon S3.
+ *We recommend using EncryptionType instead of KMSEncrypted
+ * to set the file share encryption method. You do not need to provide values for both
+ * parameters.
If values for both parameters exist in the same request, then the specified
+ * encryption methods must not conflict. For example, if EncryptionType is
+ * SseS3, then KMSEncrypted must be false. If
+ * EncryptionType is SseKms or DsseKms, then
+ * KMSEncrypted must be true.
Optional. Set to true to use Amazon S3 server-side encryption with
+ * your own KMS key (SSE-KMS), or false to use a key managed by
+ * Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the
+ * EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted
+ * to set the file share encryption method. You do not need to provide values for both
+ * parameters.
If values for both parameters exist in the same request, then the specified
+ * encryption methods must not conflict. For example, if EncryptionType is
+ * SseS3, then KMSEncrypted must be false. If
+ * EncryptionType is SseKms or DsseKms, then
+ * KMSEncrypted must be true.
Valid Values: true | false
*
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
- * value can only be set when KMSEncrypted is true. Optional.
Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
+ * CMKs. This value must be set if KMSEncrypted is true, or if
+ * EncryptionType is SseKms or DsseKms.
Set this value to true to enable access control list (ACL) on the SMB file
* share. Set it to false to map file and directory permissions to the POSIX
* permissions.
For more information, see Using Microsoft Windows ACLs to - * control access to an SMB file share in the Storage Gateway User - * Guide.
+ *For more information, see Using Windows ACLs to limit SMB file share + * access in the Amazon S3 File Gateway User + * Guide.
*Valid Values: true | false
*
* SettlingTimeInSeconds has no effect on the timing of the object
* uploading to Amazon S3, only the timing of the notification.
This setting is not meant to specify an exact time at which the notification will be + * sent. In some cases, the gateway might require more than the specified delay time to + * generate and send notifications.
* *The following example sets NotificationPolicy on with
* SettlingTimeInSeconds set to 60.
* ALL_VERSIONS - Enables regular gateway maintenance updates.
- * EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance
- * updates.
EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates. The
+ * gateway will still receive emergency version updates on rare occasions if necessary to
+ * remedy highly critical security or durability issues. You will be notified before an
+ * emergency version update is applied. These updates are applied during your gateway's
+ * scheduled maintenance window.
* @public
*/
AutomaticUpdatePolicy?: AutomaticUpdatePolicy;
@@ -3495,12 +3585,15 @@ export interface DescribeMaintenanceStartTimeOutput {
/**
* A set of variables indicating the software update preferences for the gateway.
- *Includes AutomaticUpdatePolicy field with the following inputs:
Includes AutomaticUpdatePolicy parameter with the following inputs:
* ALL_VERSIONS - Enables regular gateway maintenance updates.
- * EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance
- * updates.
EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates. The
+ * gateway will still receive emergency version updates on rare occasions if necessary to
+ * remedy highly critical security or durability issues. You will be notified before an
+ * emergency version update is applied. These updates are applied during your gateway's
+ * scheduled maintenance window.
* @public
*/
SoftwareUpdatePreferences?: SoftwareUpdatePreferences;
@@ -3565,9 +3658,39 @@ export interface NFSFileShareInfo {
GatewayARN?: string;
/**
- * Set to true to use Amazon S3 server-side encryption with your own
- * KMS key, or false to use a key managed by Amazon S3.
- * Optional.
A value that specifies the type of server-side encryption that the file share will use + * for the data that it stores in Amazon S3.
+ *We recommend using EncryptionType instead of KMSEncrypted
+ * to set the file share encryption method. You do not need to provide values for both
+ * parameters.
If values for both parameters exist in the same request, then the specified
+ * encryption methods must not conflict. For example, if EncryptionType is
+ * SseS3, then KMSEncrypted must be false. If
+ * EncryptionType is SseKms or DsseKms, then
+ * KMSEncrypted must be true.
Optional. Set to true to use Amazon S3 server-side encryption with
+ * your own KMS key (SSE-KMS), or false to use a key managed by
+ * Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the
+ * EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted
+ * to set the file share encryption method. You do not need to provide values for both
+ * parameters.
If values for both parameters exist in the same request, then the specified
+ * encryption methods must not conflict. For example, if EncryptionType is
+ * SseS3, then KMSEncrypted must be false. If
+ * EncryptionType is SseKms or DsseKms, then
+ * KMSEncrypted must be true.
Valid Values: true | false
*
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
- * value can only be set when KMSEncrypted is true. Optional.
Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
+ * CMKs. This value must be set if KMSEncrypted is true, or if
+ * EncryptionType is SseKms or DsseKms.
* SettlingTimeInSeconds has no effect on the timing of the object
* uploading to Amazon S3, only the timing of the notification.
This setting is not meant to specify an exact time at which the notification will be + * sent. In some cases, the gateway might require more than the specified delay time to + * generate and send notifications.
* *The following example sets NotificationPolicy on with
* SettlingTimeInSeconds set to 60.
Set to true to use Amazon S3 server-side encryption with your own
- * KMS key, or false to use a key managed by Amazon S3.
- * Optional.
A value that specifies the type of server-side encryption that the file share will use + * for the data that it stores in Amazon S3.
+ *We recommend using EncryptionType instead of KMSEncrypted
+ * to set the file share encryption method. You do not need to provide values for both
+ * parameters.
If values for both parameters exist in the same request, then the specified
+ * encryption methods must not conflict. For example, if EncryptionType is
+ * SseS3, then KMSEncrypted must be false. If
+ * EncryptionType is SseKms or DsseKms, then
+ * KMSEncrypted must be true.
Optional. Set to true to use Amazon S3 server-side encryption with
+ * your own KMS key (SSE-KMS), or false to use a key managed by
+ * Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the
+ * EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted
+ * to set the file share encryption method. You do not need to provide values for both
+ * parameters.
If values for both parameters exist in the same request, then the specified
+ * encryption methods must not conflict. For example, if EncryptionType is
+ * SseS3, then KMSEncrypted must be false. If
+ * EncryptionType is SseKms or DsseKms, then
+ * KMSEncrypted must be true.
Valid Values: true | false
*
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
- * value can only be set when KMSEncrypted is true. Optional.
Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
+ * CMKs. This value must be set if KMSEncrypted is true, or if
+ * EncryptionType is SseKms or DsseKms.
If this value is set to true, it indicates that access control list (ACL)
* is enabled on the SMB file share. If it is set to false, it indicates that
* file and directory permissions are mapped to the POSIX permission.
For more information, see Using Microsoft Windows ACLs to - * control access to an SMB file share in the Storage Gateway User - * Guide.
+ *For more information, see Using Windows ACLs to limit SMB file share + * access in the Amazon S3 File Gateway User + * Guide.
* @public */ SMBACLEnabled?: boolean; @@ -4056,6 +4216,9 @@ export interface SMBFileShareInfo { *
* SettlingTimeInSeconds has no effect on the timing of the object
* uploading to Amazon S3, only the timing of the notification.
This setting is not meant to specify an exact time at which the notification will be + * sent. In some cases, the gateway might require more than the specified delay time to + * generate and send notifications.
* *The following example sets NotificationPolicy on with
* SettlingTimeInSeconds set to 60.
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
- * value can only be set when KMSEncrypted is true. Optional.
Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
+ * CMKs. This value must be set if KMSEncrypted is true, or if
+ * EncryptionType is SseKms or DsseKms.
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
- * value can only be set when KMSEncrypted is true. Optional.
Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
+ * CMKs. This value must be set if KMSEncrypted is true, or if
+ * EncryptionType is SseKms or DsseKms.
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
- * value can only be set when KMSEncrypted is true. Optional.
Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
+ * CMKs. This value must be set if KMSEncrypted is true, or if
+ * EncryptionType is SseKms or DsseKms.
* ALL_VERSIONS - Enables regular gateway maintenance updates.
- * EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance
- * updates.
EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates. The
+ * gateway will still receive emergency version updates on rare occasions if necessary to
+ * remedy highly critical security or durability issues. You will be notified before an
+ * emergency version update is applied. These updates are applied during your gateway's
+ * scheduled maintenance window.
* @public
*/
SoftwareUpdatePreferences?: SoftwareUpdatePreferences;
@@ -7165,9 +7337,39 @@ export interface UpdateNFSFileShareInput {
FileShareARN: string | undefined;
/**
- * Set to true to use Amazon S3 server-side encryption with your own
- * KMS key, or false to use a key managed by Amazon S3.
- * Optional.
A value that specifies the type of server-side encryption that the file share will use + * for the data that it stores in Amazon S3.
+ *We recommend using EncryptionType instead of KMSEncrypted
+ * to set the file share encryption method. You do not need to provide values for both
+ * parameters.
If values for both parameters exist in the same request, then the specified
+ * encryption methods must not conflict. For example, if EncryptionType is
+ * SseS3, then KMSEncrypted must be false. If
+ * EncryptionType is SseKms or DsseKms, then
+ * KMSEncrypted must be true.
Optional. Set to true to use Amazon S3 server-side encryption with
+ * your own KMS key (SSE-KMS), or false to use a key managed by
+ * Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the
+ * EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted
+ * to set the file share encryption method. You do not need to provide values for both
+ * parameters.
If values for both parameters exist in the same request, then the specified
+ * encryption methods must not conflict. For example, if EncryptionType is
+ * SseS3, then KMSEncrypted must be false. If
+ * EncryptionType is SseKms or DsseKms, then
+ * KMSEncrypted must be true.
Valid Values: true | false
*
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
- * value can only be set when KMSEncrypted is true. Optional.
Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
+ * CMKs. This value must be set if KMSEncrypted is true, or if
+ * EncryptionType is SseKms or DsseKms.
* SettlingTimeInSeconds has no effect on the timing of the object
* uploading to Amazon S3, only the timing of the notification.
This setting is not meant to specify an exact time at which the notification will be + * sent. In some cases, the gateway might require more than the specified delay time to + * generate and send notifications.
* *The following example sets NotificationPolicy on with
* SettlingTimeInSeconds set to 60.
Set to true to use Amazon S3 server-side encryption with your own
- * KMS key, or false to use a key managed by Amazon S3.
- * Optional.
A value that specifies the type of server-side encryption that the file share will use + * for the data that it stores in Amazon S3.
+ *We recommend using EncryptionType instead of KMSEncrypted
+ * to set the file share encryption method. You do not need to provide values for both
+ * parameters.
If values for both parameters exist in the same request, then the specified
+ * encryption methods must not conflict. For example, if EncryptionType is
+ * SseS3, then KMSEncrypted must be false. If
+ * EncryptionType is SseKms or DsseKms, then
+ * KMSEncrypted must be true.
Optional. Set to true to use Amazon S3 server-side encryption with
+ * your own KMS key (SSE-KMS), or false to use a key managed by
+ * Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the
+ * EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted
+ * to set the file share encryption method. You do not need to provide values for both
+ * parameters.
If values for both parameters exist in the same request, then the specified
+ * encryption methods must not conflict. For example, if EncryptionType is
+ * SseS3, then KMSEncrypted must be false. If
+ * EncryptionType is SseKms or DsseKms, then
+ * KMSEncrypted must be true.
Valid Values: true | false
*
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
- * value can only be set when KMSEncrypted is true. Optional.
Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
+ * CMKs. This value must be set if KMSEncrypted is true, or if
+ * EncryptionType is SseKms or DsseKms.
Set this value to true to enable access control list (ACL) on the SMB file
* share. Set it to false to map file and directory permissions to the POSIX
* permissions.
For more information, see Using Microsoft Windows ACLs to - * control access to an SMB file share in the Storage Gateway User - * Guide.
+ *For more information, see Using Windows ACLs to limit SMB file share + * access in the Amazon S3 File Gateway User + * Guide.
*Valid Values: true | false
*
* SettlingTimeInSeconds has no effect on the timing of the object
* uploading to Amazon S3, only the timing of the notification.
This setting is not meant to specify an exact time at which the notification will be + * sent. In some cases, the gateway might require more than the specified delay time to + * generate and send notifications.
* *The following example sets NotificationPolicy on with
* SettlingTimeInSeconds set to 60.
A value that specifies the type of server-side encryption that the file share will use\n for the data that it stores in Amazon S3.
\nWe recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Set to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
Optional. Set to true to use Amazon S3 server-side encryption with\n your own KMS key (SSE-KMS), or false to use a key managed by\n Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the\n EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Valid Values: true | false\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This\n value can only be set when KMSEncrypted is true. Optional.
Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used\n for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric\n CMKs. This value must be set if KMSEncrypted is true, or if\n EncryptionType is SseKms or DsseKms.
The notification policy of the file share. SettlingTimeInSeconds controls\n the number of seconds to wait after the last point in time a client wrote to a file before\n generating an ObjectUploaded notification. Because clients can make many small\n writes to files, it's best to set this parameter for as long as possible to avoid\n generating multiple notifications for the same file in a small time period.
\n SettlingTimeInSeconds has no effect on the timing of the object\n uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with\n SettlingTimeInSeconds set to 60.
\n {\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}\n
The following example sets NotificationPolicy off.
\n {}\n
The notification policy of the file share. SettlingTimeInSeconds controls\n the number of seconds to wait after the last point in time a client wrote to a file before\n generating an ObjectUploaded notification. Because clients can make many small\n writes to files, it's best to set this parameter for as long as possible to avoid\n generating multiple notifications for the same file in a small time period.
\n SettlingTimeInSeconds has no effect on the timing of the object\n uploading to Amazon S3, only the timing of the notification.
This setting is not meant to specify an exact time at which the notification will be\n sent. In some cases, the gateway might require more than the specified delay time to\n generate and send notifications.
\nThe following example sets NotificationPolicy on with\n SettlingTimeInSeconds set to 60.
\n {\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}\n
The following example sets NotificationPolicy off.
\n {}\n
A value that specifies the type of server-side encryption that the file share will use\n for the data that it stores in Amazon S3.
\nWe recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Set to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
Optional. Set to true to use Amazon S3 server-side encryption with\n your own KMS key (SSE-KMS), or false to use a key managed by\n Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the\n EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Valid Values: true | false\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This\n value can only be set when KMSEncrypted is true. Optional.
Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used\n for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric\n CMKs. This value must be set if KMSEncrypted is true, or if\n EncryptionType is SseKms or DsseKms.
Set this value to true to enable access control list (ACL) on the SMB file\n share. Set it to false to map file and directory permissions to the POSIX\n permissions.
For more information, see Using Microsoft Windows ACLs to\n control access to an SMB file share in the Storage Gateway User\n Guide.
\nValid Values: true | false\n
Set this value to true to enable access control list (ACL) on the SMB file\n share. Set it to false to map file and directory permissions to the POSIX\n permissions.
For more information, see Using Windows ACLs to limit SMB file share\n access in the Amazon S3 File Gateway User\n Guide.
\nValid Values: true | false\n
The notification policy of the file share. SettlingTimeInSeconds controls\n the number of seconds to wait after the last point in time a client wrote to a file before\n generating an ObjectUploaded notification. Because clients can make many small\n writes to files, it's best to set this parameter for as long as possible to avoid\n generating multiple notifications for the same file in a small time period.
\n SettlingTimeInSeconds has no effect on the timing of the object\n uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with\n SettlingTimeInSeconds set to 60.
\n {\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}\n
The following example sets NotificationPolicy off.
\n {}\n
The notification policy of the file share. SettlingTimeInSeconds controls\n the number of seconds to wait after the last point in time a client wrote to a file before\n generating an ObjectUploaded notification. Because clients can make many small\n writes to files, it's best to set this parameter for as long as possible to avoid\n generating multiple notifications for the same file in a small time period.
\n SettlingTimeInSeconds has no effect on the timing of the object\n uploading to Amazon S3, only the timing of the notification.
This setting is not meant to specify an exact time at which the notification will be\n sent. In some cases, the gateway might require more than the specified delay time to\n generate and send notifications.
\nThe following example sets NotificationPolicy on with\n SettlingTimeInSeconds set to 60.
\n {\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}\n
The following example sets NotificationPolicy off.
\n {}\n
A set of variables indicating the software update preferences for the gateway.
\nIncludes AutomaticUpdatePolicy field with the following inputs:
\n ALL_VERSIONS - Enables regular gateway maintenance updates.
\n EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance\n updates.
A set of variables indicating the software update preferences for the gateway.
\nIncludes AutomaticUpdatePolicy parameter with the following inputs:
\n ALL_VERSIONS - Enables regular gateway maintenance updates.
\n EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates. The\n gateway will still receive emergency version updates on rare occasions if necessary to\n remedy highly critical security or durability issues. You will be notified before an\n emergency version update is applied. These updates are applied during your gateway's\n scheduled maintenance window.
Returns information about the upload buffer of a gateway. This operation is supported\n for the stored volume, cached volume, and tape gateway types.
\nThe response includes disk IDs that are configured as upload buffer space, and it\n includes the amount of upload buffer space allocated and used.
", "smithy.api#examples": [ { - "title": "To describe upload buffer of gateway", - "documentation": "Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated/used.", + "title": "To describe upload buffer of a gateway", + "documentation": "Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated and used.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" }, "output": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", "DiskIds": ["pci-0000:03:00.0-scsi-0:0:0:0", "pci-0000:04:00.0-scsi-0:1:0:0"], - "UploadBufferUsedInBytes": 161061273600, - "UploadBufferAllocatedInBytes": 0 + "UploadBufferUsedInBytes": 0, + "UploadBufferAllocatedInBytes": 161061273600 } }, { - "title": "To describe upload buffer of a gateway", - "documentation": "Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated and used.", + "title": "To describe upload buffer of gateway", + "documentation": "Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated/used.", "input": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" }, "output": { "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", "DiskIds": ["pci-0000:03:00.0-scsi-0:0:0:0", "pci-0000:04:00.0-scsi-0:1:0:0"], - "UploadBufferUsedInBytes": 0, - "UploadBufferAllocatedInBytes": 161061273600 + "UploadBufferUsedInBytes": 161061273600, + "UploadBufferAllocatedInBytes": 0 } } ] @@ -5177,6 +5195,29 @@ "com.amazonaws.storagegateway#Ec2InstanceRegion": { "type": "string" }, + "com.amazonaws.storagegateway#EncryptionType": { + "type": "enum", + "members": { + "SseS3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SseS3" + } + }, + "SseKms": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SseKms" + } + }, + "DsseKms": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DsseKms" + } + } + } + }, "com.amazonaws.storagegateway#EndpointNetworkConfiguration": { "type": "structure", "members": { @@ -6325,7 +6366,7 @@ "com.amazonaws.storagegateway#KMSKey": { "type": "string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This\n value can only be set when KMSEncrypted is true. Optional.
Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used\n for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric\n CMKs. This value must be set if KMSEncrypted is true, or if\n EncryptionType is SseKms or DsseKms.
A value that specifies the type of server-side encryption that the file share will use\n for the data that it stores in Amazon S3.
\nWe recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Set to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
Optional. Set to true to use Amazon S3 server-side encryption with\n your own KMS key (SSE-KMS), or false to use a key managed by\n Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the\n EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Valid Values: true | false\n
The notification policy of the file share. SettlingTimeInSeconds controls\n the number of seconds to wait after the last point in time a client wrote to a file before\n generating an ObjectUploaded notification. Because clients can make many small\n writes to files, it's best to set this parameter for as long as possible to avoid\n generating multiple notifications for the same file in a small time period.
\n SettlingTimeInSeconds has no effect on the timing of the object\n uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with\n SettlingTimeInSeconds set to 60.
\n {\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}\n
The following example sets NotificationPolicy off.
\n {}\n
The notification policy of the file share. SettlingTimeInSeconds controls\n the number of seconds to wait after the last point in time a client wrote to a file before\n generating an ObjectUploaded notification. Because clients can make many small\n writes to files, it's best to set this parameter for as long as possible to avoid\n generating multiple notifications for the same file in a small time period.
\n SettlingTimeInSeconds has no effect on the timing of the object\n uploading to Amazon S3, only the timing of the notification.
This setting is not meant to specify an exact time at which the notification will be\n sent. In some cases, the gateway might require more than the specified delay time to\n generate and send notifications.
\nThe following example sets NotificationPolicy on with\n SettlingTimeInSeconds set to 60.
\n {\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}\n
The following example sets NotificationPolicy off.
\n {}\n
A value that specifies the type of server-side encryption that the file share will use\n for the data that it stores in Amazon S3.
\nWe recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Set to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
Optional. Set to true to use Amazon S3 server-side encryption with\n your own KMS key (SSE-KMS), or false to use a key managed by\n Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the\n EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Valid Values: true | false\n
If this value is set to true, it indicates that access control list (ACL)\n is enabled on the SMB file share. If it is set to false, it indicates that\n file and directory permissions are mapped to the POSIX permission.
For more information, see Using Microsoft Windows ACLs to\n control access to an SMB file share in the Storage Gateway User\n Guide.
" + "smithy.api#documentation": "If this value is set to true, it indicates that access control list (ACL)\n is enabled on the SMB file share. If it is set to false, it indicates that\n file and directory permissions are mapped to the POSIX permission.
For more information, see Using Windows ACLs to limit SMB file share\n access in the Amazon S3 File Gateway User\n Guide.
" } }, "AccessBasedEnumeration": { @@ -8239,7 +8298,7 @@ "NotificationPolicy": { "target": "com.amazonaws.storagegateway#NotificationPolicy", "traits": { - "smithy.api#documentation": "The notification policy of the file share. SettlingTimeInSeconds controls\n the number of seconds to wait after the last point in time a client wrote to a file before\n generating an ObjectUploaded notification. Because clients can make many small\n writes to files, it's best to set this parameter for as long as possible to avoid\n generating multiple notifications for the same file in a small time period.
\n SettlingTimeInSeconds has no effect on the timing of the object\n uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with\n SettlingTimeInSeconds set to 60.
\n {\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}\n
The following example sets NotificationPolicy off.
\n {}\n
The notification policy of the file share. SettlingTimeInSeconds controls\n the number of seconds to wait after the last point in time a client wrote to a file before\n generating an ObjectUploaded notification. Because clients can make many small\n writes to files, it's best to set this parameter for as long as possible to avoid\n generating multiple notifications for the same file in a small time period.
\n SettlingTimeInSeconds has no effect on the timing of the object\n uploading to Amazon S3, only the timing of the notification.
This setting is not meant to specify an exact time at which the notification will be\n sent. In some cases, the gateway might require more than the specified delay time to\n generate and send notifications.
\nThe following example sets NotificationPolicy on with\n SettlingTimeInSeconds set to 60.
\n {\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}\n
The following example sets NotificationPolicy off.
\n {}\n
Indicates the automatic update policy for a gateway.
\n\n ALL_VERSIONS - Enables regular gateway maintenance updates.
\n EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance\n updates.
Indicates the automatic update policy for a gateway.
\n\n ALL_VERSIONS - Enables regular gateway maintenance updates.
\n EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates. The\n gateway will still receive emergency version updates on rare occasions if necessary to\n remedy highly critical security or durability issues. You will be notified before an\n emergency version update is applied. These updates are applied during your gateway's\n scheduled maintenance window.
A set of variables indicating the software update preferences for the gateway.
\nIncludes AutomaticUpdatePolicy field with the following inputs:
\n ALL_VERSIONS - Enables regular gateway maintenance updates.
\n EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance\n updates.
A set of variables indicating the software update preferences for the gateway.
\nIncludes AutomaticUpdatePolicy field with the following inputs:
\n ALL_VERSIONS - Enables regular gateway maintenance updates.
\n EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates. The\n gateway will still receive emergency version updates on rare occasions if necessary to\n remedy highly critical security or durability issues. You will be notified before an\n emergency version update is applied. These updates are applied during your gateway's\n scheduled maintenance window.
A value that specifies the type of server-side encryption that the file share will use\n for the data that it stores in Amazon S3.
\nWe recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Set to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
Optional. Set to true to use Amazon S3 server-side encryption with\n your own KMS key (SSE-KMS), or false to use a key managed by\n Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the\n EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Valid Values: true | false\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This\n value can only be set when KMSEncrypted is true. Optional.
Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used\n for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric\n CMKs. This value must be set if KMSEncrypted is true, or if\n EncryptionType is SseKms or DsseKms.
The notification policy of the file share. SettlingTimeInSeconds controls\n the number of seconds to wait after the last point in time a client wrote to a file before\n generating an ObjectUploaded notification. Because clients can make many small\n writes to files, it's best to set this parameter for as long as possible to avoid\n generating multiple notifications for the same file in a small time period.
\n SettlingTimeInSeconds has no effect on the timing of the object\n uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with\n SettlingTimeInSeconds set to 60.
\n {\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}\n
The following example sets NotificationPolicy off.
\n {}\n
The notification policy of the file share. SettlingTimeInSeconds controls\n the number of seconds to wait after the last point in time a client wrote to a file before\n generating an ObjectUploaded notification. Because clients can make many small\n writes to files, it's best to set this parameter for as long as possible to avoid\n generating multiple notifications for the same file in a small time period.
\n SettlingTimeInSeconds has no effect on the timing of the object\n uploading to Amazon S3, only the timing of the notification.
This setting is not meant to specify an exact time at which the notification will be\n sent. In some cases, the gateway might require more than the specified delay time to\n generate and send notifications.
\nThe following example sets NotificationPolicy on with\n SettlingTimeInSeconds set to 60.
\n {\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}\n
The following example sets NotificationPolicy off.
\n {}\n
A value that specifies the type of server-side encryption that the file share will use\n for the data that it stores in Amazon S3.
\nWe recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Set to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
Optional. Set to true to use Amazon S3 server-side encryption with\n your own KMS key (SSE-KMS), or false to use a key managed by\n Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the\n EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted\n to set the file share encryption method. You do not need to provide values for both\n parameters.
If values for both parameters exist in the same request, then the specified\n encryption methods must not conflict. For example, if EncryptionType is\n SseS3, then KMSEncrypted must be false. If\n EncryptionType is SseKms or DsseKms, then\n KMSEncrypted must be true.
Valid Values: true | false\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This\n value can only be set when KMSEncrypted is true. Optional.
Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used\n for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric\n CMKs. This value must be set if KMSEncrypted is true, or if\n EncryptionType is SseKms or DsseKms.
Set this value to true to enable access control list (ACL) on the SMB file\n share. Set it to false to map file and directory permissions to the POSIX\n permissions.
For more information, see Using Microsoft Windows ACLs to\n control access to an SMB file share in the Storage Gateway User\n Guide.
\nValid Values: true | false\n
Set this value to true to enable access control list (ACL) on the SMB file\n share. Set it to false to map file and directory permissions to the POSIX\n permissions.
For more information, see Using Windows ACLs to limit SMB file share\n access in the Amazon S3 File Gateway User\n Guide.
\nValid Values: true | false\n
The notification policy of the file share. SettlingTimeInSeconds controls\n the number of seconds to wait after the last point in time a client wrote to a file before\n generating an ObjectUploaded notification. Because clients can make many small\n writes to files, it's best to set this parameter for as long as possible to avoid\n generating multiple notifications for the same file in a small time period.
\n SettlingTimeInSeconds has no effect on the timing of the object\n uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with\n SettlingTimeInSeconds set to 60.
\n {\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}\n
The following example sets NotificationPolicy off.
\n {}\n
The notification policy of the file share. SettlingTimeInSeconds controls\n the number of seconds to wait after the last point in time a client wrote to a file before\n generating an ObjectUploaded notification. Because clients can make many small\n writes to files, it's best to set this parameter for as long as possible to avoid\n generating multiple notifications for the same file in a small time period.
\n SettlingTimeInSeconds has no effect on the timing of the object\n uploading to Amazon S3, only the timing of the notification.
This setting is not meant to specify an exact time at which the notification will be\n sent. In some cases, the gateway might require more than the specified delay time to\n generate and send notifications.
\nThe following example sets NotificationPolicy on with\n SettlingTimeInSeconds set to 60.
\n {\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}\n
The following example sets NotificationPolicy off.
\n {}\n