aws-sdk-storagegateway 1.6.0 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 66dbb2bbfc322b79addf246c098f96926e4b2fdd
4
- data.tar.gz: 7b34670d0560b5c37c80576f35a0cb4658ba916c
3
+ metadata.gz: fbccba0e0f3bdf200554ee47f5cfb186c4846213
4
+ data.tar.gz: a88cbaa7103f73968dddf57da409f6e16a12b3b8
5
5
  SHA512:
6
- metadata.gz: 3595e20b3dd4f9627c83bc010e729ebd90acc7d637a09c72fc4c2e1bf22d8d52bd27fd70e241384562080826ee36257f9bb03a7ce1cf84b2a44f03dd9c95d2ec
7
- data.tar.gz: 3b7ceacc7a346fbf4a19a39da66f06c4cecba5cdfe1d7cd349611335e0cca0486609c70bf71216bd24107ee2109904a5bc606e835204bfeea4bf889fd9ee6787
6
+ metadata.gz: a36f91b3702405dc6ebda00304aea6705f9327cfee765ce6f330f984c2df87cf47cc9b46a3c5ddc1528f6adc9a4726e92ad09931bb38bc067a23912acbfabffe
7
+ data.tar.gz: 4cedfcf1cd3c975a0674df8f989f878f8875c4acb054499415571b0548b591a4535118ecf872ba6dab22a8aaf4fb61c2722c10230a5f810e716cc4052cc03975
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-storagegateway/customizations'
42
42
  # @service
43
43
  module Aws::StorageGateway
44
44
 
45
- GEM_VERSION = '1.6.0'
45
+ GEM_VERSION = '1.7.0'
46
46
 
47
47
  end
@@ -733,7 +733,7 @@ module Aws::StorageGateway
733
733
  # key, or false to use a key managed by Amazon S3. Optional.
734
734
  #
735
735
  # @option params [String] :kms_key
736
- # The Amazon Resource Name (ARN) of the KMS key used for Amazon S3
736
+ # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
737
737
  # server side encryption. This value can only be set when KMSEncrypted
738
738
  # is true. Optional.
739
739
  #
@@ -793,8 +793,8 @@ module Aws::StorageGateway
793
793
  # Creates a Network File System (NFS) file share on an existing file
794
794
  # gateway. In Storage Gateway, a file share is a file system mount point
795
795
  # backed by Amazon S3 cloud storage. Storage Gateway exposes file shares
796
- # using a NFS interface. This operation is only supported in the file
797
- # gateway type.
796
+ # using a NFS interface. This operation is only supported for file
797
+ # gateways.
798
798
  #
799
799
  # File gateway requires AWS Security Token Service (AWS STS) to be
800
800
  # activated to enable you create a file share. Make sure AWS STS is
@@ -822,8 +822,8 @@ module Aws::StorageGateway
822
822
  # key, or false to use a key managed by Amazon S3. Optional.
823
823
  #
824
824
  # @option params [String] :kms_key
825
- # The Amazon Resource Name (ARN) KMS key used for Amazon S3 server side
826
- # encryption. This value can only be set when KMSEncrypted is true.
825
+ # The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server
826
+ # side encryption. This value can only be set when KMSEncrypted is true.
827
827
  # Optional.
828
828
  #
829
829
  # @option params [required, String] :role
@@ -835,14 +835,14 @@ module Aws::StorageGateway
835
835
  #
836
836
  # @option params [String] :default_storage_class
837
837
  # The default storage class for objects put into an Amazon S3 bucket by
838
- # file gateway. Possible values are S3\_STANDARD, S3\_STANDARD\_IA or
839
- # S3\_ONEZONE\_IA. If this field is not populated, the default value
840
- # S3\_STANDARD is used. Optional.
838
+ # the file gateway. Possible values are `S3_STANDARD`, `S3_STANDARD_IA`,
839
+ # or `S3_ONEZONE_IA`. If this field is not populated, the default value
840
+ # `S3_STANDARD` is used. Optional.
841
841
  #
842
842
  # @option params [String] :object_acl
843
- # Sets the access control list permission for objects in the Amazon S3
844
- # bucket that a file gateway puts objects into. The default value is
845
- # "private".
843
+ # A value that sets the access control list permission for objects in
844
+ # the S3 bucket that a file gateway puts objects into. The default value
845
+ # is "private".
846
846
  #
847
847
  # @option params [Array<String>] :client_list
848
848
  # The list of clients that are allowed to access the file gateway. The
@@ -851,25 +851,25 @@ module Aws::StorageGateway
851
851
  # @option params [String] :squash
852
852
  # Maps a user to anonymous user. Valid options are the following:
853
853
  #
854
- # * "RootSquash" - Only root is mapped to anonymous user.
854
+ # * `RootSquash` - Only root is mapped to anonymous user.
855
855
  #
856
- # * "NoSquash" - No one is mapped to anonymous user.
856
+ # * `NoSquash` - No one is mapped to anonymous user
857
857
  #
858
- # * "AllSquash" - Everyone is mapped to anonymous user.
858
+ # * `AllSquash` - Everyone is mapped to anonymous user.
859
859
  #
860
860
  # @option params [Boolean] :read_only
861
- # Sets the write status of a file share. This value is true if the write
862
- # status is read-only, and otherwise false.
861
+ # A value that sets the write status of a file share. This value is true
862
+ # if the write status is read-only, and otherwise false.
863
863
  #
864
864
  # @option params [Boolean] :guess_mime_type_enabled
865
- # Enables guessing of the MIME type for uploaded objects based on file
866
- # extensions. Set this value to true to enable MIME type guessing, and
867
- # otherwise to false. The default value is true.
865
+ # A value that enables guessing of the MIME type for uploaded objects
866
+ # based on file extensions. Set this value to true to enable MIME type
867
+ # guessing, and otherwise to false. The default value is true.
868
868
  #
869
869
  # @option params [Boolean] :requester_pays
870
- # Sets who pays the cost of the request and the data download from the
871
- # Amazon S3 bucket. Set this value to true if you want the requester to
872
- # pay instead of the bucket owner, and otherwise to false.
870
+ # A value that sets the access control list permission for objects in
871
+ # the Amazon S3 bucket that a file gateway puts objects into. The
872
+ # default value is `private`.
873
873
  #
874
874
  # @return [Types::CreateNFSFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
875
875
  #
@@ -915,18 +915,24 @@ module Aws::StorageGateway
915
915
  # Creates a Server Message Block (SMB) file share on an existing file
916
916
  # gateway. In Storage Gateway, a file share is a file system mount point
917
917
  # backed by Amazon S3 cloud storage. Storage Gateway expose file shares
918
- # using a SMB interface. This operation is only supported in the file
919
- # gateway type.
918
+ # using a SMB interface. This operation is only supported for file
919
+ # gateways.
920
920
  #
921
- # File gateway requires AWS Security Token Service (AWS STS) to be
922
- # activated to enable you create a file share. Make sure AWS STS is
923
- # activated in the region you are creating your file gateway in. If AWS
924
- # STS is not activated in the region, activate it. For information about
925
- # how to activate AWS STS, see Activating and Deactivating AWS STS in an
926
- # AWS Region in the AWS Identity and Access Management User Guide.
921
+ # File gateways require AWS Security Token Service (AWS STS) to be
922
+ # activated to enable you to create a file share. Make sure that AWS STS
923
+ # is activated in the AWS Region you are creating your file gateway in.
924
+ # If AWS STS is not activated in this AWS Region, activate it. For
925
+ # information about how to activate AWS STS, see [Activating and
926
+ # Deactivating AWS STS in an AWS Region][1] in the *AWS Identity and
927
+ # Access Management User Guide.*
928
+ #
929
+ # File gateways don't support creating hard or symbolic links on a
930
+ # file
931
+ # share.
927
932
  #
928
- # File gateway does not support creating hard or symbolic links on a
929
- # file share.
933
+ #
934
+ #
935
+ # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html
930
936
  #
931
937
  # @option params [required, String] :client_token
932
938
  # A unique string value that you supply that is used by file gateway to
@@ -941,9 +947,9 @@ module Aws::StorageGateway
941
947
  # key, or false to use a key managed by Amazon S3. Optional.
942
948
  #
943
949
  # @option params [String] :kms_key
944
- # The Amazon Resource Name (ARN) KMS key used for Amazon S3 server side
945
- # encryption. This value can only be set when KMSEncrypted is true.
946
- # Optional.
950
+ # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
951
+ # server side encryption. This value can only be set when KMSEncrypted
952
+ # is true. Optional.
947
953
  #
948
954
  # @option params [required, String] :role
949
955
  # The ARN of the AWS Identity and Access Management (IAM) role that a
@@ -954,44 +960,46 @@ module Aws::StorageGateway
954
960
  #
955
961
  # @option params [String] :default_storage_class
956
962
  # The default storage class for objects put into an Amazon S3 bucket by
957
- # file gateway. Possible values are S3\_STANDARD, S3\_STANDARD\_IA or
958
- # S3\_ONEZONE\_IA. If this field is not populated, the default value
959
- # S3\_STANDARD is used. Optional.
963
+ # the file gateway. Possible values are `S3_STANDARD`, `S3_STANDARD_IA`,
964
+ # or `S3_ONEZONE_IA`. If this field is not populated, the default value
965
+ # `S3_STANDARD` is used. Optional.
960
966
  #
961
967
  # @option params [String] :object_acl
962
- # Sets the access control list permission for objects in the Amazon S3
963
- # bucket that a file gateway puts objects into. The default value is
964
- # "private".
968
+ # A value that sets the access control list permission for objects in
969
+ # the S3 bucket that a file gateway puts objects into. The default value
970
+ # is "private".
965
971
  #
966
972
  # @option params [Boolean] :read_only
967
- # Sets the write status of a file share. This value is true if the write
968
- # status is read-only, and otherwise false.
973
+ # A value that sets the write status of a file share. This value is true
974
+ # if the write status is read-only, and otherwise false.
969
975
  #
970
976
  # @option params [Boolean] :guess_mime_type_enabled
971
- # Enables guessing of the MIME type for uploaded objects based on file
972
- # extensions. Set this value to true to enable MIME type guessing, and
973
- # otherwise to false. The default value is true.
977
+ # A value that enables guessing of the MIME type for uploaded objects
978
+ # based on file extensions. Set this value to true to enable MIME type
979
+ # guessing, and otherwise to false. The default value is true.
974
980
  #
975
981
  # @option params [Boolean] :requester_pays
976
- # Sets who pays the cost of the request and the data download from the
977
- # Amazon S3 bucket. Set this value to true if you want the requester to
978
- # pay instead of the bucket owner, and otherwise to false.
982
+ # A value that sets the access control list permission for objects in
983
+ # the Amazon S3 bucket that a file gateway puts objects into. The
984
+ # default value is `private`.
979
985
  #
980
986
  # @option params [Array<String>] :valid_user_list
981
- # A list of users in the Active Directory that are allowed to access the
982
- # file share. Can only be set if Authentication is set to
983
- # "ActiveDirectory".
987
+ # A list of users or groups in the Active Directory that are allowed to
988
+ # access the file share. A group must be prefixed with the @ character.
989
+ # For example `@group1`. Can only be set if Authentication is set to
990
+ # `ActiveDirectory`.
984
991
  #
985
992
  # @option params [Array<String>] :invalid_user_list
986
- # A list of users in the Active Directory that are not allowed to access
987
- # the file share. Can only be set if Authentication is set to
988
- # "ActiveDirectory".
993
+ # A list of users or groups in the Active Directory that are not allowed
994
+ # to access the file share. A group must be prefixed with the @
995
+ # character. For example `@group1`. Can only be set if Authentication is
996
+ # set to `ActiveDirectory`.
989
997
  #
990
998
  # @option params [String] :authentication
991
999
  # The authentication method that users use to access the file share.
992
1000
  #
993
- # Valid values: "ActiveDirectory" or "GuestAccess". The default is
994
- # "ActiveDirectory".
1001
+ # Valid values are `ActiveDirectory` or `GuestAccess`. The default is
1002
+ # `ActiveDirectory`.
995
1003
  #
996
1004
  # @return [Types::CreateSMBFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
997
1005
  #
@@ -1248,6 +1256,15 @@ module Aws::StorageGateway
1248
1256
  #
1249
1257
  # Valid Values: A valid IP address.
1250
1258
  #
1259
+ # @option params [Boolean] :kms_encrypted
1260
+ # True to use Amazon S3 server side encryption with your own AWS KMS
1261
+ # key, or false to use a key managed by Amazon S3. Optional.
1262
+ #
1263
+ # @option params [String] :kms_key
1264
+ # The Amazon Resource Name (ARN) of the KMS key used for Amazon S3
1265
+ # server side encryption. This value can only be set when KMSEncrypted
1266
+ # is true. Optional.
1267
+ #
1251
1268
  # @return [Types::CreateStorediSCSIVolumeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1252
1269
  #
1253
1270
  # * {Types::CreateStorediSCSIVolumeOutput#volume_arn #volume_arn} => String
@@ -1284,6 +1301,8 @@ module Aws::StorageGateway
1284
1301
  # preserve_existing_data: false, # required
1285
1302
  # target_name: "TargetName", # required
1286
1303
  # network_interface_id: "NetworkInterfaceId", # required
1304
+ # kms_encrypted: false,
1305
+ # kms_key: "KMSKey",
1287
1306
  # })
1288
1307
  #
1289
1308
  # @example Response structure
@@ -1338,7 +1357,7 @@ module Aws::StorageGateway
1338
1357
  # key, or false to use a key managed by Amazon S3. Optional.
1339
1358
  #
1340
1359
  # @option params [String] :kms_key
1341
- # The Amazon Resource Name (ARN) of the KMS Key used for Amazon S3
1360
+ # The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3
1342
1361
  # server side encryption. This value can only be set when KMSEncrypted
1343
1362
  # is true. Optional.
1344
1363
  #
@@ -1434,7 +1453,7 @@ module Aws::StorageGateway
1434
1453
  # key, or false to use a key managed by Amazon S3. Optional.
1435
1454
  #
1436
1455
  # @option params [String] :kms_key
1437
- # The Amazon Resource Name (ARN) of the KMS key used for Amazon S3
1456
+ # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
1438
1457
  # server side encryption. This value can only be set when KMSEncrypted
1439
1458
  # is true. Optional.
1440
1459
  #
@@ -1599,7 +1618,7 @@ module Aws::StorageGateway
1599
1618
  end
1600
1619
 
1601
1620
  # Deletes a file share from a file gateway. This operation is only
1602
- # supported in the file gateway type.
1621
+ # supported for file gateways.
1603
1622
  #
1604
1623
  # @option params [required, String] :file_share_arn
1605
1624
  # The Amazon Resource Name (ARN) of the file share to be deleted.
@@ -2313,8 +2332,8 @@ module Aws::StorageGateway
2313
2332
  end
2314
2333
 
2315
2334
  # Gets a description for one or more Network File System (NFS) file
2316
- # shares from a file gateway. This operation is only supported in the
2317
- # file gateway type.
2335
+ # shares from a file gateway. This operation is only supported for file
2336
+ # gateways.
2318
2337
  #
2319
2338
  # @option params [required, Array<String>] :file_share_arn_list
2320
2339
  # An array containing the Amazon Resource Name (ARN) of each file share
@@ -2365,8 +2384,8 @@ module Aws::StorageGateway
2365
2384
  end
2366
2385
 
2367
2386
  # Gets a description for one or more Server Message Block (SMB) file
2368
- # shares from a file gateway. This operation is only supported in the
2369
- # file gateway type.
2387
+ # shares from a file gateway. This operation is only supported for file
2388
+ # gateways.
2370
2389
  #
2371
2390
  # @option params [required, Array<String>] :file_share_arn_list
2372
2391
  # An array containing the Amazon Resource Name (ARN) of each file share
@@ -2415,8 +2434,8 @@ module Aws::StorageGateway
2415
2434
  end
2416
2435
 
2417
2436
  # Gets a description of a Server Message Block (SMB) file share settings
2418
- # from a file gateway. This operation is only supported in the file
2419
- # gateway type.
2437
+ # from a file gateway. This operation is only supported for file
2438
+ # gateways.
2420
2439
  #
2421
2440
  # @option params [required, String] :gateway_arn
2422
2441
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
@@ -2581,6 +2600,7 @@ module Aws::StorageGateway
2581
2600
  # resp.stored_iscsi_volumes[0].volume_iscsi_attributes.chap_enabled #=> Boolean
2582
2601
  # resp.stored_iscsi_volumes[0].created_date #=> Time
2583
2602
  # resp.stored_iscsi_volumes[0].volume_used_in_bytes #=> Integer
2603
+ # resp.stored_iscsi_volumes[0].kms_key #=> String
2584
2604
  #
2585
2605
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeStorediSCSIVolumes AWS API Documentation
2586
2606
  #
@@ -3191,12 +3211,11 @@ module Aws::StorageGateway
3191
3211
  end
3192
3212
 
3193
3213
  # Adds a file gateway to an Active Directory domain. This operation is
3194
- # only supported in the file gateway type that supports the SMB file
3195
- # protocol.
3214
+ # only supported for file gateways that support the SMB file protocol.
3196
3215
  #
3197
3216
  # @option params [required, String] :gateway_arn
3198
- # The unique Amazon Resource Name of the file gateway you want to add to
3199
- # the Active Directory domain.
3217
+ # The unique Amazon Resource Name (ARN) of the file gateway you want to
3218
+ # add to the Active Directory domain.
3200
3219
  #
3201
3220
  # @option params [required, String] :domain_name
3202
3221
  # The name of the domain that you want the gateway to join.
@@ -3237,7 +3256,7 @@ module Aws::StorageGateway
3237
3256
 
3238
3257
  # Gets a list of the file shares for a specific file gateway, or the
3239
3258
  # list of file shares that belong to the calling user account. This
3240
- # operation is only supported in the file gateway type.
3259
+ # operation is only supported for file gateways.
3241
3260
  #
3242
3261
  # @option params [String] :gateway_arn
3243
3262
  # The Amazon resource Name (ARN) of the gateway whose file shares you
@@ -3779,7 +3798,7 @@ module Aws::StorageGateway
3779
3798
  # notification through an Amazon CloudWatch Event. You can configure
3780
3799
  # CloudWatch Events to send the notification through event targets such
3781
3800
  # as Amazon SNS or AWS Lambda function. This operation is only supported
3782
- # in the file gateway type.
3801
+ # for file gateways.
3783
3802
  #
3784
3803
  # For more information, see Getting File Upload Notification in the
3785
3804
  # Storage Gateway User Guide
@@ -4130,16 +4149,16 @@ module Aws::StorageGateway
4130
4149
  req.send_request(options)
4131
4150
  end
4132
4151
 
4133
- # Sets the password for the guest user smbguest”. "smbguest" is the
4134
- # user when the Authentication method for the file share is
4135
- # GuestAccess”.
4152
+ # Sets the password for the guest user `smbguest`. The `smbguest` user
4153
+ # is the user when the authentication method for the file share is set
4154
+ # to `GuestAccess`.
4136
4155
  #
4137
4156
  # @option params [required, String] :gateway_arn
4138
4157
  # The Amazon Resource Name (ARN) of the file gateway the SMB file share
4139
4158
  # is associated with.
4140
4159
  #
4141
4160
  # @option params [required, String] :password
4142
- # The password you want to set for your SMB Server.
4161
+ # The password that you want to set for your SMB Server.
4143
4162
  #
4144
4163
  # @return [Types::SetSMBGuestPasswordOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4145
4164
  #
@@ -4663,7 +4682,7 @@ module Aws::StorageGateway
4663
4682
  # key, or false to use a key managed by Amazon S3. Optional.
4664
4683
  #
4665
4684
  # @option params [String] :kms_key
4666
- # The Amazon Resource Name (ARN) of the KMS key used for Amazon S3
4685
+ # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
4667
4686
  # server side encryption. This value can only be set when KMSEncrypted
4668
4687
  # is true. Optional.
4669
4688
  #
@@ -4672,14 +4691,14 @@ module Aws::StorageGateway
4672
4691
  #
4673
4692
  # @option params [String] :default_storage_class
4674
4693
  # The default storage class for objects put into an Amazon S3 bucket by
4675
- # a file gateway. Possible values are S3\_STANDARD, S3\_STANDARD\_IA or
4676
- # S3\_ONEZONE\_IA. If this field is not populated, the default value
4677
- # S3\_STANDARD is used. Optional.
4694
+ # the file gateway. Possible values are `S3_STANDARD`, `S3_STANDARD_IA`,
4695
+ # or `S3_ONEZONE_IA`. If this field is not populated, the default value
4696
+ # `S3_STANDARD` is used. Optional.
4678
4697
  #
4679
4698
  # @option params [String] :object_acl
4680
- # Sets the access control list permission for objects in the S3 bucket
4681
- # that a file gateway puts objects into. The default value is
4682
- # "private".
4699
+ # A value that sets the access control list permission for objects in
4700
+ # the S3 bucket that a file gateway puts objects into. The default value
4701
+ # is "private".
4683
4702
  #
4684
4703
  # @option params [Array<String>] :client_list
4685
4704
  # The list of clients that are allowed to access the file gateway. The
@@ -4688,25 +4707,25 @@ module Aws::StorageGateway
4688
4707
  # @option params [String] :squash
4689
4708
  # The user mapped to anonymous user. Valid options are the following:
4690
4709
  #
4691
- # * "RootSquash" - Only root is mapped to anonymous user.
4710
+ # * `RootSquash` - Only root is mapped to anonymous user.
4692
4711
  #
4693
- # * "NoSquash" - No one is mapped to anonymous user
4712
+ # * `NoSquash` - No one is mapped to anonymous user
4694
4713
  #
4695
- # * "AllSquash" - Everyone is mapped to anonymous user.
4714
+ # * `AllSquash` - Everyone is mapped to anonymous user.
4696
4715
  #
4697
4716
  # @option params [Boolean] :read_only
4698
- # Sets the write status of a file share. This value is true if the write
4699
- # status is read-only, and otherwise false.
4717
+ # A value that sets the write status of a file share. This value is true
4718
+ # if the write status is read-only, and otherwise false.
4700
4719
  #
4701
4720
  # @option params [Boolean] :guess_mime_type_enabled
4702
- # Enables guessing of the MIME type for uploaded objects based on file
4703
- # extensions. Set this value to true to enable MIME type guessing, and
4704
- # otherwise to false. The default value is true.
4721
+ # A value that enables guessing of the MIME type for uploaded objects
4722
+ # based on file extensions. Set this value to true to enable MIME type
4723
+ # guessing, and otherwise to false. The default value is true.
4705
4724
  #
4706
4725
  # @option params [Boolean] :requester_pays
4707
- # Sets who pays the cost of the request and the data download from the
4708
- # Amazon S3 bucket. Set this value to true if you want the requester to
4709
- # pay instead of the bucket owner, and otherwise to false.
4726
+ # A value that sets the access control list permission for objects in
4727
+ # the Amazon S3 bucket that a file gateway puts objects into. The
4728
+ # default value is `private`.
4710
4729
  #
4711
4730
  # @return [Types::UpdateNFSFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4712
4731
  #
@@ -4746,27 +4765,31 @@ module Aws::StorageGateway
4746
4765
  req.send_request(options)
4747
4766
  end
4748
4767
 
4749
- # Updates a Server Message Block (SMB) file share. This operation is
4750
- # only supported in the file gateway type.
4768
+ # Updates a Server Message Block (SMB) file share.
4751
4769
  #
4752
4770
  # <note markdown="1"> To leave a file share field unchanged, set the corresponding input
4753
- # field to null. This operation is only supported in the file gateway
4754
- # type.
4771
+ # field to null. This operation is only supported for file gateways.
4755
4772
  #
4756
4773
  # </note>
4757
4774
  #
4758
- # File gateway requires AWS Security Token Service (AWS STS) to be
4759
- # activated to enable you create a file share. Make sure AWS STS is
4760
- # activated in the region you are creating your file gateway in. If AWS
4761
- # STS is not activated in the region, activate it. For information about
4762
- # how to activate AWS STS, see Activating and Deactivating AWS STS in an
4763
- # AWS Region in the AWS Identity and Access Management User Guide.
4775
+ # File gateways require AWS Security Token Service (AWS STS) to be
4776
+ # activated to enable you to create a file share. Make sure that AWS STS
4777
+ # is activated in the AWS Region you are creating your file gateway in.
4778
+ # If AWS STS is not activated in this AWS Region, activate it. For
4779
+ # information about how to activate AWS STS, see [Activating and
4780
+ # Deactivating AWS STS in an AWS Region][1] in the *AWS Identity and
4781
+ # Access Management User Guide.*
4764
4782
  #
4765
- # File gateway does not support creating hard or symbolic links on a
4766
- # file share.
4783
+ # File gateways don't support creating hard or symbolic links on a
4784
+ # file
4785
+ # share.
4786
+ #
4787
+ #
4788
+ #
4789
+ # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html
4767
4790
  #
4768
4791
  # @option params [required, String] :file_share_arn
4769
- # The Amazon Resource Name (ARN) of the SMB file share you want to
4792
+ # The Amazon Resource Name (ARN) of the SMB file share that you want to
4770
4793
  # update.
4771
4794
  #
4772
4795
  # @option params [Boolean] :kms_encrypted
@@ -4774,44 +4797,46 @@ module Aws::StorageGateway
4774
4797
  # key, or false to use a key managed by Amazon S3. Optional.
4775
4798
  #
4776
4799
  # @option params [String] :kms_key
4777
- # The Amazon Resource Name (ARN) KMS key used for Amazon S3 server side
4778
- # encryption. This value can only be set when KMSEncrypted is true.
4779
- # Optional.
4800
+ # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
4801
+ # server side encryption. This value can only be set when KMSEncrypted
4802
+ # is true. Optional.
4780
4803
  #
4781
4804
  # @option params [String] :default_storage_class
4782
4805
  # The default storage class for objects put into an Amazon S3 bucket by
4783
- # file gateway. Possible values are S3\_STANDARD, S3\_STANDARD\_IA or
4784
- # S3\_ONEZONE\_IA. If this field is not populated, the default value
4785
- # S3\_STANDARD is used. Optional.
4806
+ # the file gateway. Possible values are `S3_STANDARD`, `S3_STANDARD_IA`,
4807
+ # or `S3_ONEZONE_IA`. If this field is not populated, the default value
4808
+ # `S3_STANDARD` is used. Optional.
4786
4809
  #
4787
4810
  # @option params [String] :object_acl
4788
- # Sets the access control list permission for objects in the Amazon S3
4789
- # bucket that a file gateway puts objects into. The default value is
4790
- # "private".
4811
+ # A value that sets the access control list permission for objects in
4812
+ # the S3 bucket that a file gateway puts objects into. The default value
4813
+ # is "private".
4791
4814
  #
4792
4815
  # @option params [Boolean] :read_only
4793
- # Sets the write status of a file share. This value is true if the write
4794
- # status is read-only, and otherwise false.
4816
+ # A value that sets the write status of a file share. This value is true
4817
+ # if the write status is read-only, and otherwise false.
4795
4818
  #
4796
4819
  # @option params [Boolean] :guess_mime_type_enabled
4797
- # Enables guessing of the MIME type for uploaded objects based on file
4798
- # extensions. Set this value to true to enable MIME type guessing, and
4799
- # otherwise to false. The default value is true.
4820
+ # A value that enables guessing of the MIME type for uploaded objects
4821
+ # based on file extensions. Set this value to true to enable MIME type
4822
+ # guessing, and otherwise to false. The default value is true.
4800
4823
  #
4801
4824
  # @option params [Boolean] :requester_pays
4802
- # Sets who pays the cost of the request and the data download from the
4803
- # Amazon S3 bucket. Set this value to true if you want the requester to
4804
- # pay instead of the bucket owner, and otherwise to false.
4825
+ # A value that sets the access control list permission for objects in
4826
+ # the Amazon S3 bucket that a file gateway puts objects into. The
4827
+ # default value is `private`.
4805
4828
  #
4806
4829
  # @option params [Array<String>] :valid_user_list
4807
- # A list of users in the Active Directory that are allowed to access the
4808
- # file share. Can only be set if Authentication is set to
4809
- # "ActiveDirectory".
4830
+ # A list of users or groups in the Active Directory that are allowed to
4831
+ # access the file share. A group must be prefixed with the @ character.
4832
+ # For example `@group1`. Can only be set if Authentication is set to
4833
+ # `ActiveDirectory`.
4810
4834
  #
4811
4835
  # @option params [Array<String>] :invalid_user_list
4812
- # A list of users in the Active Directory that are not allowed to access
4813
- # the file share. Can only be set if Authentication is set to
4814
- # "ActiveDirectory".
4836
+ # A list of users or groups in the Active Directory that are not allowed
4837
+ # to access the file share. A group must be prefixed with the @
4838
+ # character. For example `@group1`. Can only be set if Authentication is
4839
+ # set to `ActiveDirectory`.
4815
4840
  #
4816
4841
  # @return [Types::UpdateSMBFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4817
4842
  #
@@ -4984,7 +5009,7 @@ module Aws::StorageGateway
4984
5009
  params: params,
4985
5010
  config: config)
4986
5011
  context[:gem_name] = 'aws-sdk-storagegateway'
4987
- context[:gem_version] = '1.6.0'
5012
+ context[:gem_version] = '1.7.0'
4988
5013
  Seahorse::Client::Request.new(handlers, context)
4989
5014
  end
4990
5015