aws-sdk-storagegateway 1.38.0 → 1.43.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 +4 -4
- data/lib/aws-sdk-storagegateway.rb +1 -1
- data/lib/aws-sdk-storagegateway/client.rb +292 -199
- data/lib/aws-sdk-storagegateway/client_api.rb +2 -0
- data/lib/aws-sdk-storagegateway/types.rb +436 -311
- metadata +4 -4
@@ -142,6 +142,7 @@ module Aws::StorageGateway
|
|
142
142
|
DoubleObject = Shapes::FloatShape.new(name: 'DoubleObject')
|
143
143
|
Ec2InstanceId = Shapes::StringShape.new(name: 'Ec2InstanceId')
|
144
144
|
Ec2InstanceRegion = Shapes::StringShape.new(name: 'Ec2InstanceRegion')
|
145
|
+
EndpointType = Shapes::StringShape.new(name: 'EndpointType')
|
145
146
|
ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
|
146
147
|
FileShareARN = Shapes::StringShape.new(name: 'FileShareARN')
|
147
148
|
FileShareARNList = Shapes::ListShape.new(name: 'FileShareARNList')
|
@@ -680,6 +681,7 @@ module Aws::StorageGateway
|
|
680
681
|
DescribeGatewayInformationOutput.add_member(:vpc_endpoint, Shapes::ShapeRef.new(shape: string, location_name: "VPCEndpoint"))
|
681
682
|
DescribeGatewayInformationOutput.add_member(:cloud_watch_log_group_arn, Shapes::ShapeRef.new(shape: CloudWatchLogGroupARN, location_name: "CloudWatchLogGroupARN"))
|
682
683
|
DescribeGatewayInformationOutput.add_member(:host_environment, Shapes::ShapeRef.new(shape: HostEnvironment, location_name: "HostEnvironment"))
|
684
|
+
DescribeGatewayInformationOutput.add_member(:endpoint_type, Shapes::ShapeRef.new(shape: EndpointType, location_name: "EndpointType"))
|
683
685
|
DescribeGatewayInformationOutput.struct_class = Types::DescribeGatewayInformationOutput
|
684
686
|
|
685
687
|
DescribeMaintenanceStartTimeInput.add_member(:gateway_arn, Shapes::ShapeRef.new(shape: GatewayARN, required: true, location_name: "GatewayARN"))
|
@@ -20,10 +20,10 @@ module Aws::StorageGateway
|
|
20
20
|
#
|
21
21
|
# * ActivateGatewayInput$GatewayType
|
22
22
|
#
|
23
|
-
# * ActivateGatewayInput$TapeDriveType
|
24
|
-
#
|
25
23
|
# * ActivateGatewayInput$MediumChangerType
|
26
24
|
#
|
25
|
+
# * ActivateGatewayInput$TapeDriveType
|
26
|
+
#
|
27
27
|
# @note When making an API call, you may pass ActivateGatewayInput
|
28
28
|
# data as a hash:
|
29
29
|
#
|
@@ -53,9 +53,12 @@ module Aws::StorageGateway
|
|
53
53
|
# the arguments you pass to the `ActivateGateway` API call determine
|
54
54
|
# the actual configuration of your gateway.
|
55
55
|
#
|
56
|
-
# For more information, see
|
57
|
-
#
|
58
|
-
#
|
56
|
+
# For more information, see [Getting activation key][1] in the *AWS
|
57
|
+
# Storage Gateway User Guide*.
|
58
|
+
#
|
59
|
+
#
|
60
|
+
#
|
61
|
+
# [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html
|
59
62
|
# @return [String]
|
60
63
|
#
|
61
64
|
# @!attribute [rw] gateway_name
|
@@ -76,15 +79,15 @@ module Aws::StorageGateway
|
|
76
79
|
# data. The gateway AWS Region specified must be the same AWS Region
|
77
80
|
# as the AWS Region in your `Host` header in the request. For more
|
78
81
|
# information about available AWS Regions and endpoints for AWS
|
79
|
-
# Storage Gateway, see [
|
80
|
-
#
|
82
|
+
# Storage Gateway, see [AWS Storage Gateway endpoints and quotas][1]
|
83
|
+
# in the *AWS General Reference*.
|
81
84
|
#
|
82
|
-
# Valid Values: See [AWS Storage Gateway
|
83
|
-
# the AWS General Reference
|
85
|
+
# Valid Values: See [AWS Storage Gateway endpoints and quotas][1] in
|
86
|
+
# the *AWS General Reference*.
|
84
87
|
#
|
85
88
|
#
|
86
89
|
#
|
87
|
-
# [1]: https://docs.aws.amazon.com/general/latest/gr/
|
90
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/sg.html
|
88
91
|
# @return [String]
|
89
92
|
#
|
90
93
|
# @!attribute [rw] gateway_type
|
@@ -92,21 +95,21 @@ module Aws::StorageGateway
|
|
92
95
|
# specified is critical to all later functions of the gateway and
|
93
96
|
# cannot be changed after activation. The default value is `CACHED`.
|
94
97
|
#
|
95
|
-
# Valid Values:
|
98
|
+
# Valid Values: `STORED` \| `CACHED` \| `VTL` \| `FILE_S3`
|
96
99
|
# @return [String]
|
97
100
|
#
|
98
101
|
# @!attribute [rw] tape_drive_type
|
99
102
|
# The value that indicates the type of tape drive to use for tape
|
100
103
|
# gateway. This field is optional.
|
101
104
|
#
|
102
|
-
# Valid Values:
|
105
|
+
# Valid Values: `IBM-ULT3580-TD5`
|
103
106
|
# @return [String]
|
104
107
|
#
|
105
108
|
# @!attribute [rw] medium_changer_type
|
106
109
|
# The value that indicates the type of medium changer to use for tape
|
107
110
|
# gateway. This field is optional.
|
108
111
|
#
|
109
|
-
# Valid Values:
|
112
|
+
# Valid Values: `STK-L700` \| `AWS-Gateway-VTL`
|
110
113
|
# @return [String]
|
111
114
|
#
|
112
115
|
# @!attribute [rw] tags
|
@@ -368,7 +371,7 @@ module Aws::StorageGateway
|
|
368
371
|
# (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the
|
369
372
|
# pool.
|
370
373
|
#
|
371
|
-
# Valid
|
374
|
+
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
372
375
|
# @return [String]
|
373
376
|
#
|
374
377
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AssignTapePoolInput AWS API Documentation
|
@@ -527,7 +530,7 @@ module Aws::StorageGateway
|
|
527
530
|
# the storage class (S3 Glacier or S3 Glacier Deep Archive) that
|
528
531
|
# corresponds to the pool.
|
529
532
|
#
|
530
|
-
# Valid
|
533
|
+
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
531
534
|
# @return [String]
|
532
535
|
#
|
533
536
|
# @!attribute [rw] tape_size_in_bytes
|
@@ -573,8 +576,8 @@ module Aws::StorageGateway
|
|
573
576
|
#
|
574
577
|
# @!attribute [rw] volume_attachment_status
|
575
578
|
# A value that indicates whether a storage volume is attached to or
|
576
|
-
# detached from a gateway. For more information, see [Moving
|
577
|
-
#
|
579
|
+
# detached from a gateway. For more information, see [Moving your
|
580
|
+
# volumes to a different gateway][1].
|
578
581
|
#
|
579
582
|
#
|
580
583
|
#
|
@@ -624,9 +627,10 @@ module Aws::StorageGateway
|
|
624
627
|
# @return [Integer]
|
625
628
|
#
|
626
629
|
# @!attribute [rw] kms_key
|
627
|
-
# The Amazon Resource Name (ARN) of
|
628
|
-
# server-side encryption.
|
629
|
-
#
|
630
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
631
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway
|
632
|
+
# does not support asymmetric CMKs. This value can only be set when
|
633
|
+
# `KMSEncrypted` is `true`. Optional.
|
630
634
|
# @return [String]
|
631
635
|
#
|
632
636
|
# @!attribute [rw] target_name
|
@@ -814,7 +818,7 @@ module Aws::StorageGateway
|
|
814
818
|
# @!attribute [rw] snapshot_id
|
815
819
|
# The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore
|
816
820
|
# as the new cached volume. Specify this field if you want to create
|
817
|
-
# the iSCSI storage volume from a snapshot otherwise do not include
|
821
|
+
# the iSCSI storage volume from a snapshot; otherwise, do not include
|
818
822
|
# this field. To list snapshots for your account use
|
819
823
|
# [DescribeSnapshots][1] in the *Amazon Elastic Compute Cloud API
|
820
824
|
# Reference*.
|
@@ -859,14 +863,17 @@ module Aws::StorageGateway
|
|
859
863
|
# @return [String]
|
860
864
|
#
|
861
865
|
# @!attribute [rw] kms_encrypted
|
862
|
-
#
|
863
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
866
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
867
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
868
|
+
#
|
869
|
+
# Valid Values: `true` \| `false`
|
864
870
|
# @return [Boolean]
|
865
871
|
#
|
866
872
|
# @!attribute [rw] kms_key
|
867
|
-
# The Amazon Resource Name (ARN) of
|
868
|
-
# server-side encryption.
|
869
|
-
#
|
873
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
874
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway
|
875
|
+
# does not support asymmetric CMKs. This value can only be set when
|
876
|
+
# `KMSEncrypted` is `true`. Optional.
|
870
877
|
# @return [String]
|
871
878
|
#
|
872
879
|
# @!attribute [rw] tags
|
@@ -963,14 +970,17 @@ module Aws::StorageGateway
|
|
963
970
|
# @return [String]
|
964
971
|
#
|
965
972
|
# @!attribute [rw] kms_encrypted
|
966
|
-
#
|
967
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
973
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
974
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
975
|
+
#
|
976
|
+
# Valid Values: `true` \| `false`
|
968
977
|
# @return [Boolean]
|
969
978
|
#
|
970
979
|
# @!attribute [rw] kms_key
|
971
|
-
# The Amazon Resource Name (ARN)
|
972
|
-
# server-side encryption.
|
973
|
-
#
|
980
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
981
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway
|
982
|
+
# does not support asymmetric CMKs. This value can only be set when
|
983
|
+
# `KMSEncrypted` is `true`. Optional.
|
974
984
|
# @return [String]
|
975
985
|
#
|
976
986
|
# @!attribute [rw] role
|
@@ -984,15 +994,17 @@ module Aws::StorageGateway
|
|
984
994
|
#
|
985
995
|
# @!attribute [rw] default_storage_class
|
986
996
|
# The default storage class for objects put into an Amazon S3 bucket
|
987
|
-
# by the file gateway.
|
988
|
-
#
|
989
|
-
#
|
997
|
+
# by the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
|
998
|
+
# Optional.
|
999
|
+
#
|
1000
|
+
# Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
|
1001
|
+
# `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
|
990
1002
|
# @return [String]
|
991
1003
|
#
|
992
1004
|
# @!attribute [rw] object_acl
|
993
|
-
# A value that sets the access control list permission for
|
994
|
-
# the S3 bucket that a file gateway puts objects into. The
|
995
|
-
# value is
|
1005
|
+
# A value that sets the access control list (ACL) permission for
|
1006
|
+
# objects in the S3 bucket that a file gateway puts objects into. The
|
1007
|
+
# default value is `private`.
|
996
1008
|
# @return [String]
|
997
1009
|
#
|
998
1010
|
# @!attribute [rw] client_list
|
@@ -1001,39 +1013,48 @@ module Aws::StorageGateway
|
|
1001
1013
|
# @return [Array<String>]
|
1002
1014
|
#
|
1003
1015
|
# @!attribute [rw] squash
|
1004
|
-
# A value that maps a user to anonymous user.
|
1005
|
-
# following:
|
1016
|
+
# A value that maps a user to anonymous user.
|
1006
1017
|
#
|
1007
|
-
#
|
1018
|
+
# Valid values are the following:
|
1008
1019
|
#
|
1009
|
-
# * `
|
1020
|
+
# * `RootSquash`\: Only root is mapped to anonymous user.
|
1010
1021
|
#
|
1011
|
-
# * `
|
1022
|
+
# * `NoSquash`\: No one is mapped to anonymous user.
|
1023
|
+
#
|
1024
|
+
# * `AllSquash`\: Everyone is mapped to anonymous user.
|
1012
1025
|
# @return [String]
|
1013
1026
|
#
|
1014
1027
|
# @!attribute [rw] read_only
|
1015
|
-
# A value that sets the write status of a file share.
|
1016
|
-
# true
|
1028
|
+
# A value that sets the write status of a file share. Set this value
|
1029
|
+
# to `true` to set the write status to read-only, otherwise set to
|
1030
|
+
# `false`.
|
1031
|
+
#
|
1032
|
+
# Valid Values: `true` \| `false`
|
1017
1033
|
# @return [Boolean]
|
1018
1034
|
#
|
1019
1035
|
# @!attribute [rw] guess_mime_type_enabled
|
1020
1036
|
# A value that enables guessing of the MIME type for uploaded objects
|
1021
|
-
# based on file extensions. Set this value to true to enable MIME
|
1022
|
-
# guessing,
|
1037
|
+
# based on file extensions. Set this value to `true` to enable MIME
|
1038
|
+
# type guessing, otherwise set to `false`. The default value is
|
1039
|
+
# `true`.
|
1040
|
+
#
|
1041
|
+
# Valid Values: `true` \| `false`
|
1023
1042
|
# @return [Boolean]
|
1024
1043
|
#
|
1025
1044
|
# @!attribute [rw] requester_pays
|
1026
1045
|
# A value that sets who pays the cost of the request and the cost
|
1027
1046
|
# associated with data download from the S3 bucket. If this value is
|
1028
|
-
# set to true
|
1029
|
-
# owner pays. However, the S3 bucket owner always pays the cost
|
1030
|
-
# storing data.
|
1047
|
+
# set to `true`, the requester pays the costs; otherwise, the S3
|
1048
|
+
# bucket owner pays. However, the S3 bucket owner always pays the cost
|
1049
|
+
# of storing data.
|
1031
1050
|
#
|
1032
1051
|
# <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
|
1033
1052
|
# file share, so make sure that the configuration on the file share is
|
1034
1053
|
# the same as the S3 bucket configuration.
|
1035
1054
|
#
|
1036
1055
|
# </note>
|
1056
|
+
#
|
1057
|
+
# Valid Values: `true` \| `false`
|
1037
1058
|
# @return [Boolean]
|
1038
1059
|
#
|
1039
1060
|
# @!attribute [rw] tags
|
@@ -1124,14 +1145,17 @@ module Aws::StorageGateway
|
|
1124
1145
|
# @return [String]
|
1125
1146
|
#
|
1126
1147
|
# @!attribute [rw] kms_encrypted
|
1127
|
-
#
|
1128
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
1148
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
1149
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
1150
|
+
#
|
1151
|
+
# Valid Values: `true` \| `false`
|
1129
1152
|
# @return [Boolean]
|
1130
1153
|
#
|
1131
1154
|
# @!attribute [rw] kms_key
|
1132
|
-
# The Amazon Resource Name (ARN) of
|
1133
|
-
# server-side encryption.
|
1134
|
-
#
|
1155
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
1156
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway
|
1157
|
+
# does not support asymmetric CMKs. This value can only be set when
|
1158
|
+
# `KMSEncrypted` is `true`. Optional.
|
1135
1159
|
# @return [String]
|
1136
1160
|
#
|
1137
1161
|
# @!attribute [rw] role
|
@@ -1145,50 +1169,66 @@ module Aws::StorageGateway
|
|
1145
1169
|
#
|
1146
1170
|
# @!attribute [rw] default_storage_class
|
1147
1171
|
# The default storage class for objects put into an Amazon S3 bucket
|
1148
|
-
# by the file gateway.
|
1149
|
-
#
|
1150
|
-
#
|
1172
|
+
# by the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
|
1173
|
+
# Optional.
|
1174
|
+
#
|
1175
|
+
# Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
|
1176
|
+
# `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
|
1151
1177
|
# @return [String]
|
1152
1178
|
#
|
1153
1179
|
# @!attribute [rw] object_acl
|
1154
|
-
# A value that sets the access control list permission for
|
1155
|
-
# the S3 bucket that a file gateway puts objects into. The
|
1156
|
-
# value is
|
1180
|
+
# A value that sets the access control list (ACL) permission for
|
1181
|
+
# objects in the S3 bucket that a file gateway puts objects into. The
|
1182
|
+
# default value is `private`.
|
1157
1183
|
# @return [String]
|
1158
1184
|
#
|
1159
1185
|
# @!attribute [rw] read_only
|
1160
|
-
# A value that sets the write status of a file share.
|
1161
|
-
# true
|
1186
|
+
# A value that sets the write status of a file share. Set this value
|
1187
|
+
# to `true` to set the write status to read-only, otherwise set to
|
1188
|
+
# `false`.
|
1189
|
+
#
|
1190
|
+
# Valid Values: `true` \| `false`
|
1162
1191
|
# @return [Boolean]
|
1163
1192
|
#
|
1164
1193
|
# @!attribute [rw] guess_mime_type_enabled
|
1165
1194
|
# A value that enables guessing of the MIME type for uploaded objects
|
1166
|
-
# based on file extensions. Set this value to true to enable MIME
|
1167
|
-
# guessing,
|
1195
|
+
# based on file extensions. Set this value to `true` to enable MIME
|
1196
|
+
# type guessing, otherwise set to `false`. The default value is
|
1197
|
+
# `true`.
|
1198
|
+
#
|
1199
|
+
# Valid Values: `true` \| `false`
|
1168
1200
|
# @return [Boolean]
|
1169
1201
|
#
|
1170
1202
|
# @!attribute [rw] requester_pays
|
1171
1203
|
# A value that sets who pays the cost of the request and the cost
|
1172
1204
|
# associated with data download from the S3 bucket. If this value is
|
1173
|
-
# set to true
|
1174
|
-
# owner pays. However, the S3 bucket owner always pays the cost
|
1175
|
-
# storing data.
|
1205
|
+
# set to `true`, the requester pays the costs; otherwise, the S3
|
1206
|
+
# bucket owner pays. However, the S3 bucket owner always pays the cost
|
1207
|
+
# of storing data.
|
1176
1208
|
#
|
1177
1209
|
# <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
|
1178
1210
|
# file share, so make sure that the configuration on the file share is
|
1179
1211
|
# the same as the S3 bucket configuration.
|
1180
1212
|
#
|
1181
1213
|
# </note>
|
1214
|
+
#
|
1215
|
+
# Valid Values: `true` \| `false`
|
1182
1216
|
# @return [Boolean]
|
1183
1217
|
#
|
1184
1218
|
# @!attribute [rw] smbacl_enabled
|
1185
|
-
# Set this value to
|
1186
|
-
# SMB file share. Set it to
|
1219
|
+
# Set this value to `true` to enable access control list (ACL) on the
|
1220
|
+
# SMB file share. Set it to `false` to map file and directory
|
1187
1221
|
# permissions to the POSIX permissions.
|
1188
1222
|
#
|
1189
|
-
# For more information, see
|
1190
|
-
#
|
1191
|
-
#
|
1223
|
+
# For more information, see [Using Microsoft Windows ACLs to control
|
1224
|
+
# access to an SMB file share][1] in the *AWS Storage Gateway User
|
1225
|
+
# Guide*.
|
1226
|
+
#
|
1227
|
+
# Valid Values: `true` \| `false`
|
1228
|
+
#
|
1229
|
+
#
|
1230
|
+
#
|
1231
|
+
# [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
|
1192
1232
|
# @return [Boolean]
|
1193
1233
|
#
|
1194
1234
|
# @!attribute [rw] admin_user_list
|
@@ -1204,7 +1244,7 @@ module Aws::StorageGateway
|
|
1204
1244
|
# @!attribute [rw] valid_user_list
|
1205
1245
|
# A list of users or groups in the Active Directory that are allowed
|
1206
1246
|
# to access the file share. A group must be prefixed with the @
|
1207
|
-
# character. For example `@group1`. Can only be set if Authentication
|
1247
|
+
# character. For example, `@group1`. Can only be set if Authentication
|
1208
1248
|
# is set to `ActiveDirectory`.
|
1209
1249
|
# @return [Array<String>]
|
1210
1250
|
#
|
@@ -1222,9 +1262,9 @@ module Aws::StorageGateway
|
|
1222
1262
|
#
|
1223
1263
|
# @!attribute [rw] authentication
|
1224
1264
|
# The authentication method that users use to access the file share.
|
1265
|
+
# The default is `ActiveDirectory`.
|
1225
1266
|
#
|
1226
|
-
# Valid
|
1227
|
-
# `ActiveDirectory`.
|
1267
|
+
# Valid Values: `ActiveDirectory` \| `GuestAccess`
|
1228
1268
|
# @return [String]
|
1229
1269
|
#
|
1230
1270
|
# @!attribute [rw] tags
|
@@ -1300,7 +1340,7 @@ module Aws::StorageGateway
|
|
1300
1340
|
# Textual description of the snapshot that appears in the Amazon EC2
|
1301
1341
|
# console, Elastic Block Store snapshots panel in the **Description**
|
1302
1342
|
# field, and in the AWS Storage Gateway snapshot **Details** pane,
|
1303
|
-
# **Description** field
|
1343
|
+
# **Description** field.
|
1304
1344
|
# @return [String]
|
1305
1345
|
#
|
1306
1346
|
# @!attribute [rw] tags
|
@@ -1376,7 +1416,7 @@ module Aws::StorageGateway
|
|
1376
1416
|
# Textual description of the snapshot that appears in the Amazon EC2
|
1377
1417
|
# console, Elastic Block Store snapshots panel in the **Description**
|
1378
1418
|
# field, and in the AWS Storage Gateway snapshot **Details** pane,
|
1379
|
-
# **Description** field
|
1419
|
+
# **Description** field.
|
1380
1420
|
# @return [String]
|
1381
1421
|
#
|
1382
1422
|
# @!attribute [rw] tags
|
@@ -1473,7 +1513,7 @@ module Aws::StorageGateway
|
|
1473
1513
|
# @!attribute [rw] snapshot_id
|
1474
1514
|
# The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore
|
1475
1515
|
# as the new stored volume. Specify this field if you want to create
|
1476
|
-
# the iSCSI storage volume from a snapshot otherwise do not include
|
1516
|
+
# the iSCSI storage volume from a snapshot; otherwise, do not include
|
1477
1517
|
# this field. To list snapshots for your account use
|
1478
1518
|
# [DescribeSnapshots][1] in the *Amazon Elastic Compute Cloud API
|
1479
1519
|
# Reference*.
|
@@ -1484,11 +1524,10 @@ module Aws::StorageGateway
|
|
1484
1524
|
# @return [String]
|
1485
1525
|
#
|
1486
1526
|
# @!attribute [rw] preserve_existing_data
|
1487
|
-
#
|
1488
|
-
#
|
1489
|
-
# empty volume.
|
1527
|
+
# Set to true `true` if you want to preserve the data on the local
|
1528
|
+
# disk. Otherwise, set to `false` to create an empty volume.
|
1490
1529
|
#
|
1491
|
-
# Valid Values: true
|
1530
|
+
# Valid Values: `true` \| `false`
|
1492
1531
|
# @return [Boolean]
|
1493
1532
|
#
|
1494
1533
|
# @!attribute [rw] target_name
|
@@ -1512,14 +1551,17 @@ module Aws::StorageGateway
|
|
1512
1551
|
# @return [String]
|
1513
1552
|
#
|
1514
1553
|
# @!attribute [rw] kms_encrypted
|
1515
|
-
#
|
1516
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
1554
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
1555
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
1556
|
+
#
|
1557
|
+
# Valid Values: `true` \| `false`
|
1517
1558
|
# @return [Boolean]
|
1518
1559
|
#
|
1519
1560
|
# @!attribute [rw] kms_key
|
1520
|
-
# The Amazon Resource Name (ARN) of
|
1521
|
-
# server-side encryption.
|
1522
|
-
#
|
1561
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
1562
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway
|
1563
|
+
# does not support asymmetric CMKs. This value can only be set when
|
1564
|
+
# `KMSEncrypted` is `true`. Optional.
|
1523
1565
|
# @return [String]
|
1524
1566
|
#
|
1525
1567
|
# @!attribute [rw] tags
|
@@ -1617,14 +1659,17 @@ module Aws::StorageGateway
|
|
1617
1659
|
# @return [String]
|
1618
1660
|
#
|
1619
1661
|
# @!attribute [rw] kms_encrypted
|
1620
|
-
#
|
1621
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
1662
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
1663
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
1664
|
+
#
|
1665
|
+
# Valid Values: `true` \| `false`
|
1622
1666
|
# @return [Boolean]
|
1623
1667
|
#
|
1624
1668
|
# @!attribute [rw] kms_key
|
1625
|
-
# The Amazon Resource Name (ARN) of
|
1626
|
-
# server-side encryption.
|
1627
|
-
#
|
1669
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
1670
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway
|
1671
|
+
# does not support asymmetric CMKs. This value can only be set when
|
1672
|
+
# `KMSEncrypted` is `true`. Optional.
|
1628
1673
|
# @return [String]
|
1629
1674
|
#
|
1630
1675
|
# @!attribute [rw] pool_id
|
@@ -1632,10 +1677,9 @@ module Aws::StorageGateway
|
|
1632
1677
|
# The tape in this pool is archived in the S3 storage class that is
|
1633
1678
|
# associated with the pool. When you use your backup application to
|
1634
1679
|
# eject the tape, the tape is archived directly into the storage class
|
1635
|
-
# (S3 Glacier or S3
|
1636
|
-
# pool.
|
1680
|
+
# (S3 Glacier or S3 Deep Archive) that corresponds to the pool.
|
1637
1681
|
#
|
1638
|
-
# Valid
|
1682
|
+
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
1639
1683
|
# @return [String]
|
1640
1684
|
#
|
1641
1685
|
# @!attribute [rw] tags
|
@@ -1739,14 +1783,17 @@ module Aws::StorageGateway
|
|
1739
1783
|
# @return [String]
|
1740
1784
|
#
|
1741
1785
|
# @!attribute [rw] kms_encrypted
|
1742
|
-
#
|
1743
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
1786
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
1787
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
1788
|
+
#
|
1789
|
+
# Valid Values: `true` \| `false`
|
1744
1790
|
# @return [Boolean]
|
1745
1791
|
#
|
1746
1792
|
# @!attribute [rw] kms_key
|
1747
|
-
# The Amazon Resource Name (ARN) of
|
1748
|
-
# server-side encryption.
|
1749
|
-
#
|
1793
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
1794
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway
|
1795
|
+
# does not support asymmetric CMKs. This value can only be set when
|
1796
|
+
# `KMSEncrypted` is `true`. Optional.
|
1750
1797
|
# @return [String]
|
1751
1798
|
#
|
1752
1799
|
# @!attribute [rw] pool_id
|
@@ -1757,7 +1804,7 @@ module Aws::StorageGateway
|
|
1757
1804
|
# (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the
|
1758
1805
|
# pool.
|
1759
1806
|
#
|
1760
|
-
# Valid
|
1807
|
+
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
1761
1808
|
# @return [String]
|
1762
1809
|
#
|
1763
1810
|
# @!attribute [rw] tags
|
@@ -1858,7 +1905,7 @@ module Aws::StorageGateway
|
|
1858
1905
|
# One of the BandwidthType values that indicates the gateway bandwidth
|
1859
1906
|
# rate limit to delete.
|
1860
1907
|
#
|
1861
|
-
# Valid Values: `Upload
|
1908
|
+
# Valid Values: `Upload` \| `Download` \| `All`
|
1862
1909
|
# @return [String]
|
1863
1910
|
#
|
1864
1911
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteBandwidthRateLimitInput AWS API Documentation
|
@@ -1950,11 +1997,13 @@ module Aws::StorageGateway
|
|
1950
1997
|
# @return [String]
|
1951
1998
|
#
|
1952
1999
|
# @!attribute [rw] force_delete
|
1953
|
-
# If this value is set to true
|
2000
|
+
# If this value is set to `true`, the operation deletes a file share
|
1954
2001
|
# immediately and aborts all data uploads to AWS. Otherwise, the file
|
1955
2002
|
# share is not deleted until all data is uploaded to AWS. This process
|
1956
2003
|
# aborts the data upload process, and the file share enters the
|
1957
|
-
#
|
2004
|
+
# `FORCE_DELETING` status.
|
2005
|
+
#
|
2006
|
+
# Valid Values: `true` \| `false`
|
1958
2007
|
# @return [Boolean]
|
1959
2008
|
#
|
1960
2009
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteFileShareInput AWS API Documentation
|
@@ -2143,7 +2192,7 @@ module Aws::StorageGateway
|
|
2143
2192
|
end
|
2144
2193
|
|
2145
2194
|
# A JSON object containing the Amazon Resource Name (ARN) of the storage
|
2146
|
-
# volume that was deleted
|
2195
|
+
# volume that was deleted.
|
2147
2196
|
#
|
2148
2197
|
# @!attribute [rw] volume_arn
|
2149
2198
|
# The Amazon Resource Name (ARN) of the storage volume that was
|
@@ -2385,7 +2434,7 @@ module Aws::StorageGateway
|
|
2385
2434
|
include Aws::Structure
|
2386
2435
|
end
|
2387
2436
|
|
2388
|
-
# A JSON object containing
|
2437
|
+
# A JSON object containing the following fields:
|
2389
2438
|
#
|
2390
2439
|
# @!attribute [rw] chap_credentials
|
2391
2440
|
# An array of ChapInfo objects that represent CHAP credentials. Each
|
@@ -2515,6 +2564,12 @@ module Aws::StorageGateway
|
|
2515
2564
|
# The type of hypervisor environment used by the host.
|
2516
2565
|
# @return [String]
|
2517
2566
|
#
|
2567
|
+
# @!attribute [rw] endpoint_type
|
2568
|
+
# The type of endpoint for your gateway.
|
2569
|
+
#
|
2570
|
+
# Valid Values: `STANDARD` \| `FIPS`
|
2571
|
+
# @return [String]
|
2572
|
+
#
|
2518
2573
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeGatewayInformationOutput AWS API Documentation
|
2519
2574
|
#
|
2520
2575
|
class DescribeGatewayInformationOutput < Struct.new(
|
@@ -2532,7 +2587,8 @@ module Aws::StorageGateway
|
|
2532
2587
|
:tags,
|
2533
2588
|
:vpc_endpoint,
|
2534
2589
|
:cloud_watch_log_group_arn,
|
2535
|
-
:host_environment
|
2590
|
+
:host_environment,
|
2591
|
+
:endpoint_type)
|
2536
2592
|
include Aws::Structure
|
2537
2593
|
end
|
2538
2594
|
|
@@ -2600,10 +2656,6 @@ module Aws::StorageGateway
|
|
2600
2656
|
# represented as an ordinal number from 1 to 28, where 1 represents
|
2601
2657
|
# the first day of the month and 28 represents the last day of the
|
2602
2658
|
# month.
|
2603
|
-
#
|
2604
|
-
# <note markdown="1"> This value is only available for tape and volume gateways.
|
2605
|
-
#
|
2606
|
-
# </note>
|
2607
2659
|
# @return [Integer]
|
2608
2660
|
#
|
2609
2661
|
# @!attribute [rw] timezone
|
@@ -2726,49 +2778,52 @@ module Aws::StorageGateway
|
|
2726
2778
|
# Indicates the status of a gateway that is a member of the Active
|
2727
2779
|
# Directory domain.
|
2728
2780
|
#
|
2729
|
-
# *
|
2781
|
+
# * `ACCESS_DENIED`\: Indicates that the `JoinDomain` operation failed
|
2730
2782
|
# due to an authentication error.
|
2731
2783
|
#
|
2732
|
-
# * DETACHED
|
2784
|
+
# * `DETACHED`\: Indicates that gateway is not joined to a domain.
|
2733
2785
|
#
|
2734
|
-
# * JOINED
|
2786
|
+
# * `JOINED`\: Indicates that the gateway has successfully joined a
|
2735
2787
|
# domain.
|
2736
2788
|
#
|
2737
|
-
# * JOINING
|
2789
|
+
# * `JOINING`\: Indicates that a `JoinDomain` operation is in
|
2790
|
+
# progress.
|
2738
2791
|
#
|
2739
|
-
# *
|
2792
|
+
# * `NETWORK_ERROR`\: Indicates that `JoinDomain` operation failed due
|
2740
2793
|
# to a network or connectivity error.
|
2741
2794
|
#
|
2742
|
-
# * TIMEOUT
|
2743
|
-
# the operation didn't complete within the allotted time.
|
2795
|
+
# * `TIMEOUT`\: Indicates that the `JoinDomain` operation failed
|
2796
|
+
# because the operation didn't complete within the allotted time.
|
2744
2797
|
#
|
2745
|
-
# *
|
2798
|
+
# * `UNKNOWN_ERROR`\: Indicates that the `JoinDomain` operation failed
|
2746
2799
|
# due to another type of error.
|
2747
2800
|
# @return [String]
|
2748
2801
|
#
|
2749
2802
|
# @!attribute [rw] smb_guest_password_set
|
2750
|
-
# This value is true if a password for the guest user
|
2751
|
-
# set,
|
2803
|
+
# This value is `true` if a password for the guest user `smbguest` is
|
2804
|
+
# set, otherwise `false`.
|
2805
|
+
#
|
2806
|
+
# Valid Values: `true` \| `false`
|
2752
2807
|
# @return [Boolean]
|
2753
2808
|
#
|
2754
2809
|
# @!attribute [rw] smb_security_strategy
|
2755
2810
|
# The type of security strategy that was specified for file gateway.
|
2756
2811
|
#
|
2757
|
-
# ClientSpecified
|
2758
|
-
#
|
2759
|
-
#
|
2760
|
-
#
|
2812
|
+
# * `ClientSpecified`\: If you use this option, requests are
|
2813
|
+
# established based on what is negotiated by the client. This option
|
2814
|
+
# is recommended when you want to maximize compatibility across
|
2815
|
+
# different clients in your environment.
|
2761
2816
|
#
|
2762
|
-
# MandatorySigning
|
2763
|
-
#
|
2764
|
-
#
|
2765
|
-
#
|
2817
|
+
# * `MandatorySigning`\: If you use this option, file gateway only
|
2818
|
+
# allows connections from SMBv2 or SMBv3 clients that have signing
|
2819
|
+
# enabled. This option works with SMB clients on Microsoft Windows
|
2820
|
+
# Vista, Windows Server 2008 or newer.
|
2766
2821
|
#
|
2767
|
-
# MandatoryEncryption
|
2768
|
-
#
|
2769
|
-
#
|
2770
|
-
#
|
2771
|
-
#
|
2822
|
+
# * `MandatoryEncryption`\: If you use this option, file gateway only
|
2823
|
+
# allows connections from SMBv3 clients that have encryption
|
2824
|
+
# enabled. This option is highly recommended for environments that
|
2825
|
+
# handle sensitive data. This option works with SMB clients on
|
2826
|
+
# Microsoft Windows 8, Windows Server 2012 or newer.
|
2772
2827
|
# @return [String]
|
2773
2828
|
#
|
2774
2829
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSMBSettingsOutput AWS API Documentation
|
@@ -2874,56 +2929,53 @@ module Aws::StorageGateway
|
|
2874
2929
|
# Describes a single unit of output from DescribeStorediSCSIVolumes.
|
2875
2930
|
# The following fields are returned:
|
2876
2931
|
#
|
2877
|
-
# *
|
2932
|
+
# * `ChapEnabled`\: Indicates whether mutual CHAP is enabled for the
|
2878
2933
|
# iSCSI target.
|
2879
2934
|
#
|
2880
|
-
# *
|
2935
|
+
# * `LunNumber`\: The logical disk number.
|
2881
2936
|
#
|
2882
|
-
# *
|
2937
|
+
# * `NetworkInterfaceId`\: The network interface ID of the stored
|
2883
2938
|
# volume that initiator use to map the stored volume as an iSCSI
|
2884
2939
|
# target.
|
2885
2940
|
#
|
2886
|
-
# *
|
2941
|
+
# * `NetworkInterfacePort`\: The port used to communicate with iSCSI
|
2887
2942
|
# targets.
|
2888
2943
|
#
|
2889
|
-
# *
|
2890
|
-
#
|
2891
|
-
# preserved.
|
2944
|
+
# * `PreservedExistingData`\: Indicates when the stored volume was
|
2945
|
+
# created, existing data on the underlying local disk was preserved.
|
2892
2946
|
#
|
2893
|
-
# *
|
2947
|
+
# * `SourceSnapshotId`\: If the stored volume was created from a
|
2894
2948
|
# snapshot, this field contains the snapshot ID used, e.g.
|
2895
|
-
# snap-1122aabb
|
2949
|
+
# `snap-1122aabb`. Otherwise, this field is not included.
|
2896
2950
|
#
|
2897
|
-
# *
|
2898
|
-
#
|
2951
|
+
# * `StorediSCSIVolumes`\: An array of StorediSCSIVolume objects where
|
2952
|
+
# each object contains metadata about one stored volume.
|
2899
2953
|
#
|
2900
|
-
# *
|
2901
|
-
# target.
|
2954
|
+
# * `TargetARN`\: The Amazon Resource Name (ARN) of the volume target.
|
2902
2955
|
#
|
2903
|
-
# *
|
2904
|
-
# volume.
|
2956
|
+
# * `VolumeARN`\: The Amazon Resource Name (ARN) of the stored volume.
|
2905
2957
|
#
|
2906
|
-
# *
|
2907
|
-
#
|
2958
|
+
# * `VolumeDiskId`\: The disk ID of the local disk that was specified
|
2959
|
+
# in the CreateStorediSCSIVolume operation.
|
2908
2960
|
#
|
2909
|
-
# *
|
2910
|
-
# vol-1122AABB
|
2961
|
+
# * `VolumeId`\: The unique identifier of the storage volume, e.g.
|
2962
|
+
# `vol-1122AABB`.
|
2911
2963
|
#
|
2912
|
-
# *
|
2964
|
+
# * `VolumeiSCSIAttributes`\: An VolumeiSCSIAttributes object that
|
2913
2965
|
# represents a collection of iSCSI attributes for one stored volume.
|
2914
2966
|
#
|
2915
|
-
# *
|
2967
|
+
# * `VolumeProgress`\: Represents the percentage complete if the
|
2916
2968
|
# volume is restoring or bootstrapping that represents the percent
|
2917
2969
|
# of data transferred. This field does not appear in the response if
|
2918
2970
|
# the stored volume is not restoring or bootstrapping.
|
2919
2971
|
#
|
2920
|
-
# *
|
2972
|
+
# * `VolumeSizeInBytes`\: The size of the volume in bytes.
|
2921
2973
|
#
|
2922
|
-
# *
|
2974
|
+
# * `VolumeStatus`\: One of the `VolumeStatus` values that indicates
|
2923
2975
|
# the state of the volume.
|
2924
2976
|
#
|
2925
|
-
# *
|
2926
|
-
# of the volume. Currently,
|
2977
|
+
# * `VolumeType`\: One of the enumeration values describing the type
|
2978
|
+
# of the volume. Currently, only `STORED` volumes are supported.
|
2927
2979
|
# @return [Array<Types::StorediSCSIVolume>]
|
2928
2980
|
#
|
2929
2981
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeStorediSCSIVolumesOutput AWS API Documentation
|
@@ -2975,7 +3027,7 @@ module Aws::StorageGateway
|
|
2975
3027
|
# The description includes of the Amazon Resource Name (ARN) of the
|
2976
3028
|
# virtual tapes. The information returned includes the Amazon Resource
|
2977
3029
|
# Names (ARNs) of the tapes, size of the tapes, status of the tapes,
|
2978
|
-
# progress of the description and tape barcode.
|
3030
|
+
# progress of the description, and tape barcode.
|
2979
3031
|
# @return [Array<Types::TapeArchive>]
|
2980
3032
|
#
|
2981
3033
|
# @!attribute [rw] marker
|
@@ -3345,6 +3397,8 @@ module Aws::StorageGateway
|
|
3345
3397
|
# volume and detach the volume. The default is `false`. If this value
|
3346
3398
|
# is set to `false`, you must manually disconnect the iSCSI connection
|
3347
3399
|
# from the target volume.
|
3400
|
+
#
|
3401
|
+
# Valid Values: `true` \| `false`
|
3348
3402
|
# @return [Boolean]
|
3349
3403
|
#
|
3350
3404
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DetachVolumeInput AWS API Documentation
|
@@ -3458,8 +3512,9 @@ module Aws::StorageGateway
|
|
3458
3512
|
#
|
3459
3513
|
# @!attribute [rw] disk_allocation_type
|
3460
3514
|
# One of the `DiskAllocationType` enumeration values that identifies
|
3461
|
-
# how a local disk is used.
|
3462
|
-
#
|
3515
|
+
# how a local disk is used.
|
3516
|
+
#
|
3517
|
+
# Valid Values: `UPLOAD_BUFFER` \| `CACHE_STORAGE`
|
3463
3518
|
# @return [String]
|
3464
3519
|
#
|
3465
3520
|
# @!attribute [rw] disk_allocation_resource
|
@@ -3502,8 +3557,9 @@ module Aws::StorageGateway
|
|
3502
3557
|
# @return [String]
|
3503
3558
|
#
|
3504
3559
|
# @!attribute [rw] file_share_status
|
3505
|
-
# The status of the file share.
|
3506
|
-
#
|
3560
|
+
# The status of the file share.
|
3561
|
+
#
|
3562
|
+
# Valid Values: `CREATING` \| `UPDATING` \| `AVAILABLE` \| `DELETING`
|
3507
3563
|
# @return [String]
|
3508
3564
|
#
|
3509
3565
|
# @!attribute [rw] gateway_arn
|
@@ -3544,7 +3600,7 @@ module Aws::StorageGateway
|
|
3544
3600
|
# @!attribute [rw] gateway_operational_state
|
3545
3601
|
# The state of the gateway.
|
3546
3602
|
#
|
3547
|
-
# Valid Values: DISABLED
|
3603
|
+
# Valid Values: `DISABLED` \| `ACTIVE`
|
3548
3604
|
# @return [String]
|
3549
3605
|
#
|
3550
3606
|
# @!attribute [rw] gateway_name
|
@@ -3693,23 +3749,24 @@ module Aws::StorageGateway
|
|
3693
3749
|
# Indicates the status of the gateway as a member of the Active
|
3694
3750
|
# Directory domain.
|
3695
3751
|
#
|
3696
|
-
# *
|
3752
|
+
# * `ACCESS_DENIED`\: Indicates that the `JoinDomain` operation failed
|
3697
3753
|
# due to an authentication error.
|
3698
3754
|
#
|
3699
|
-
# * DETACHED
|
3755
|
+
# * `DETACHED`\: Indicates that gateway is not joined to a domain.
|
3700
3756
|
#
|
3701
|
-
# * JOINED
|
3757
|
+
# * `JOINED`\: Indicates that the gateway has successfully joined a
|
3702
3758
|
# domain.
|
3703
3759
|
#
|
3704
|
-
# * JOINING
|
3760
|
+
# * `JOINING`\: Indicates that a `JoinDomain` operation is in
|
3761
|
+
# progress.
|
3705
3762
|
#
|
3706
|
-
# *
|
3763
|
+
# * `NETWORK_ERROR`\: Indicates that `JoinDomain` operation failed due
|
3707
3764
|
# to a network or connectivity error.
|
3708
3765
|
#
|
3709
|
-
# * TIMEOUT
|
3710
|
-
# the operation didn't complete within the allotted time.
|
3766
|
+
# * `TIMEOUT`\: Indicates that the `JoinDomain` operation failed
|
3767
|
+
# because the operation didn't complete within the allotted time.
|
3711
3768
|
#
|
3712
|
-
# *
|
3769
|
+
# * `UNKNOWN_ERROR`\: Indicates that the `JoinDomain` operation failed
|
3713
3770
|
# due to another type of error.
|
3714
3771
|
# @return [String]
|
3715
3772
|
#
|
@@ -4206,25 +4263,25 @@ module Aws::StorageGateway
|
|
4206
4263
|
# }
|
4207
4264
|
#
|
4208
4265
|
# @!attribute [rw] file_mode
|
4209
|
-
# The Unix file mode in the form "nnnn". For example,
|
4266
|
+
# The Unix file mode in the form "nnnn". For example, `0666`
|
4210
4267
|
# represents the default file mode inside the file share. The default
|
4211
|
-
# value is 0666
|
4268
|
+
# value is `0666`.
|
4212
4269
|
# @return [String]
|
4213
4270
|
#
|
4214
4271
|
# @!attribute [rw] directory_mode
|
4215
|
-
# The Unix directory mode in the form "nnnn". For example,
|
4272
|
+
# The Unix directory mode in the form "nnnn". For example, `0666`
|
4216
4273
|
# represents the default access mode for all directories inside the
|
4217
|
-
# file share. The default value is 0777
|
4274
|
+
# file share. The default value is `0777`.
|
4218
4275
|
# @return [String]
|
4219
4276
|
#
|
4220
4277
|
# @!attribute [rw] group_id
|
4221
4278
|
# The default group ID for the file share (unless the files have
|
4222
|
-
# another group ID specified). The default value is nfsnobody
|
4279
|
+
# another group ID specified). The default value is `nfsnobody`.
|
4223
4280
|
# @return [Integer]
|
4224
4281
|
#
|
4225
4282
|
# @!attribute [rw] owner_id
|
4226
4283
|
# The default owner ID for files in the file share (unless the files
|
4227
|
-
# have another owner ID specified). The default value is nfsnobody
|
4284
|
+
# have another owner ID specified). The default value is `nfsnobody`.
|
4228
4285
|
# @return [Integer]
|
4229
4286
|
#
|
4230
4287
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/NFSFileShareDefaults AWS API Documentation
|
@@ -4259,8 +4316,9 @@ module Aws::StorageGateway
|
|
4259
4316
|
# @return [String]
|
4260
4317
|
#
|
4261
4318
|
# @!attribute [rw] file_share_status
|
4262
|
-
# The status of the file share.
|
4263
|
-
#
|
4319
|
+
# The status of the file share.
|
4320
|
+
#
|
4321
|
+
# Valid Values: `CREATING` \| `UPDATING` \| `AVAILABLE` \| `DELETING`
|
4264
4322
|
# @return [String]
|
4265
4323
|
#
|
4266
4324
|
# @!attribute [rw] gateway_arn
|
@@ -4270,14 +4328,17 @@ module Aws::StorageGateway
|
|
4270
4328
|
# @return [String]
|
4271
4329
|
#
|
4272
4330
|
# @!attribute [rw] kms_encrypted
|
4273
|
-
#
|
4274
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
4331
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
4332
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
4333
|
+
#
|
4334
|
+
# Valid Values: `true` \| `false`
|
4275
4335
|
# @return [Boolean]
|
4276
4336
|
#
|
4277
4337
|
# @!attribute [rw] kms_key
|
4278
|
-
# The Amazon Resource Name (ARN) of
|
4279
|
-
# server-side encryption.
|
4280
|
-
#
|
4338
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
4339
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway
|
4340
|
+
# does not support asymmetric CMKs. This value can only be set when
|
4341
|
+
# `KMSEncrypted` is `true`. Optional.
|
4281
4342
|
# @return [String]
|
4282
4343
|
#
|
4283
4344
|
# @!attribute [rw] path
|
@@ -4296,15 +4357,17 @@ module Aws::StorageGateway
|
|
4296
4357
|
#
|
4297
4358
|
# @!attribute [rw] default_storage_class
|
4298
4359
|
# The default storage class for objects put into an Amazon S3 bucket
|
4299
|
-
# by the file gateway.
|
4300
|
-
#
|
4301
|
-
#
|
4360
|
+
# by the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
|
4361
|
+
# Optional.
|
4362
|
+
#
|
4363
|
+
# Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
|
4364
|
+
# `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
|
4302
4365
|
# @return [String]
|
4303
4366
|
#
|
4304
4367
|
# @!attribute [rw] object_acl
|
4305
|
-
# A value that sets the access control list permission for
|
4306
|
-
# the S3 bucket that a file gateway puts objects into. The
|
4307
|
-
# value is
|
4368
|
+
# A value that sets the access control list (ACL) permission for
|
4369
|
+
# objects in the S3 bucket that a file gateway puts objects into. The
|
4370
|
+
# default value is `private`.
|
4308
4371
|
# @return [String]
|
4309
4372
|
#
|
4310
4373
|
# @!attribute [rw] client_list
|
@@ -4315,36 +4378,44 @@ module Aws::StorageGateway
|
|
4315
4378
|
# @!attribute [rw] squash
|
4316
4379
|
# The user mapped to anonymous user. Valid options are the following:
|
4317
4380
|
#
|
4318
|
-
# * `RootSquash
|
4381
|
+
# * `RootSquash`\: Only root is mapped to anonymous user.
|
4319
4382
|
#
|
4320
|
-
# * `NoSquash
|
4383
|
+
# * `NoSquash`\: No one is mapped to anonymous user.
|
4321
4384
|
#
|
4322
|
-
# * `AllSquash
|
4385
|
+
# * `AllSquash`\: Everyone is mapped to anonymous user.
|
4323
4386
|
# @return [String]
|
4324
4387
|
#
|
4325
4388
|
# @!attribute [rw] read_only
|
4326
|
-
# A value that sets the write status of a file share.
|
4327
|
-
# true
|
4389
|
+
# A value that sets the write status of a file share. Set this value
|
4390
|
+
# to `true` to set the write status to read-only, otherwise set to
|
4391
|
+
# `false`.
|
4392
|
+
#
|
4393
|
+
# Valid Values: `true` \| `false`
|
4328
4394
|
# @return [Boolean]
|
4329
4395
|
#
|
4330
4396
|
# @!attribute [rw] guess_mime_type_enabled
|
4331
4397
|
# A value that enables guessing of the MIME type for uploaded objects
|
4332
|
-
# based on file extensions. Set this value to true to enable MIME
|
4333
|
-
# guessing,
|
4398
|
+
# based on file extensions. Set this value to `true` to enable MIME
|
4399
|
+
# type guessing, otherwise set to `false`. The default value is
|
4400
|
+
# `true`.
|
4401
|
+
#
|
4402
|
+
# Valid Values: `true` \| `false`
|
4334
4403
|
# @return [Boolean]
|
4335
4404
|
#
|
4336
4405
|
# @!attribute [rw] requester_pays
|
4337
4406
|
# A value that sets who pays the cost of the request and the cost
|
4338
4407
|
# associated with data download from the S3 bucket. If this value is
|
4339
|
-
# set to true
|
4340
|
-
# owner pays. However, the S3 bucket owner always pays the cost
|
4341
|
-
# storing data.
|
4408
|
+
# set to `true`, the requester pays the costs; otherwise, the S3
|
4409
|
+
# bucket owner pays. However, the S3 bucket owner always pays the cost
|
4410
|
+
# of storing data.
|
4342
4411
|
#
|
4343
4412
|
# <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
|
4344
4413
|
# file share, so make sure that the configuration on the file share is
|
4345
4414
|
# the same as the S3 bucket configuration.
|
4346
4415
|
#
|
4347
4416
|
# </note>
|
4417
|
+
#
|
4418
|
+
# Valid Values: `true` \| `false`
|
4348
4419
|
# @return [Boolean]
|
4349
4420
|
#
|
4350
4421
|
# @!attribute [rw] tags
|
@@ -4461,19 +4532,21 @@ module Aws::StorageGateway
|
|
4461
4532
|
# A comma-separated list of the paths of folders to refresh in the
|
4462
4533
|
# cache. The default is \[`"/"`\]. The default refreshes objects and
|
4463
4534
|
# folders at the root of the Amazon S3 bucket. If `Recursive` is set
|
4464
|
-
# to
|
4465
|
-
#
|
4535
|
+
# to `true`, the entire S3 bucket that the file share has access to is
|
4536
|
+
# refreshed.
|
4466
4537
|
# @return [Array<String>]
|
4467
4538
|
#
|
4468
4539
|
# @!attribute [rw] recursive
|
4469
4540
|
# A value that specifies whether to recursively refresh folders in the
|
4470
4541
|
# cache. The refresh includes folders that were in the cache the last
|
4471
4542
|
# time the gateway listed the folder's contents. If this value set to
|
4472
|
-
#
|
4543
|
+
# `true`, each folder that is listed in `FolderList` is recursively
|
4473
4544
|
# updated. Otherwise, subfolders listed in `FolderList` are not
|
4474
4545
|
# refreshed. Only objects that are in folders listed directly under
|
4475
4546
|
# `FolderList` are found and used for the update. The default is
|
4476
|
-
#
|
4547
|
+
# `true`.
|
4548
|
+
#
|
4549
|
+
# Valid Values: `true` \| `false`
|
4477
4550
|
# @return [Boolean]
|
4478
4551
|
#
|
4479
4552
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/RefreshCacheInput AWS API Documentation
|
@@ -4680,8 +4753,9 @@ module Aws::StorageGateway
|
|
4680
4753
|
# @return [String]
|
4681
4754
|
#
|
4682
4755
|
# @!attribute [rw] file_share_status
|
4683
|
-
# The status of the file share.
|
4684
|
-
#
|
4756
|
+
# The status of the file share.
|
4757
|
+
#
|
4758
|
+
# Valid Values: `CREATING` \| `UPDATING` \| `AVAILABLE` \| `DELETING`
|
4685
4759
|
# @return [String]
|
4686
4760
|
#
|
4687
4761
|
# @!attribute [rw] gateway_arn
|
@@ -4691,14 +4765,17 @@ module Aws::StorageGateway
|
|
4691
4765
|
# @return [String]
|
4692
4766
|
#
|
4693
4767
|
# @!attribute [rw] kms_encrypted
|
4694
|
-
#
|
4695
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
4768
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
4769
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
4770
|
+
#
|
4771
|
+
# Valid Values: `true` \| `false`
|
4696
4772
|
# @return [Boolean]
|
4697
4773
|
#
|
4698
4774
|
# @!attribute [rw] kms_key
|
4699
|
-
# The Amazon Resource Name (ARN) of
|
4700
|
-
# server-side encryption.
|
4701
|
-
#
|
4775
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
4776
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway
|
4777
|
+
# does not support asymmetric CMKs. This value can only be set when
|
4778
|
+
# `KMSEncrypted` is `true`. Optional.
|
4702
4779
|
# @return [String]
|
4703
4780
|
#
|
4704
4781
|
# @!attribute [rw] path
|
@@ -4717,51 +4794,65 @@ module Aws::StorageGateway
|
|
4717
4794
|
#
|
4718
4795
|
# @!attribute [rw] default_storage_class
|
4719
4796
|
# The default storage class for objects put into an Amazon S3 bucket
|
4720
|
-
# by the file gateway.
|
4721
|
-
#
|
4722
|
-
#
|
4797
|
+
# by the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
|
4798
|
+
# Optional.
|
4799
|
+
#
|
4800
|
+
# Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
|
4801
|
+
# `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
|
4723
4802
|
# @return [String]
|
4724
4803
|
#
|
4725
4804
|
# @!attribute [rw] object_acl
|
4726
|
-
# A value that sets the access control list permission for
|
4727
|
-
# the S3 bucket that a file gateway puts objects into. The
|
4728
|
-
# value is
|
4805
|
+
# A value that sets the access control list (ACL) permission for
|
4806
|
+
# objects in the S3 bucket that a file gateway puts objects into. The
|
4807
|
+
# default value is `private`.
|
4729
4808
|
# @return [String]
|
4730
4809
|
#
|
4731
4810
|
# @!attribute [rw] read_only
|
4732
|
-
# A value that sets the write status of a file share.
|
4733
|
-
# true
|
4811
|
+
# A value that sets the write status of a file share. Set this value
|
4812
|
+
# to `true` to set the write status to read-only, otherwise set to
|
4813
|
+
# `false`.
|
4814
|
+
#
|
4815
|
+
# Valid Values: `true` \| `false`
|
4734
4816
|
# @return [Boolean]
|
4735
4817
|
#
|
4736
4818
|
# @!attribute [rw] guess_mime_type_enabled
|
4737
4819
|
# A value that enables guessing of the MIME type for uploaded objects
|
4738
|
-
# based on file extensions. Set this value to true to enable MIME
|
4739
|
-
# guessing,
|
4820
|
+
# based on file extensions. Set this value to `true` to enable MIME
|
4821
|
+
# type guessing, otherwise set to `false`. The default value is
|
4822
|
+
# `true`.
|
4823
|
+
#
|
4824
|
+
# Valid Values: `true` \| `false`
|
4740
4825
|
# @return [Boolean]
|
4741
4826
|
#
|
4742
4827
|
# @!attribute [rw] requester_pays
|
4743
4828
|
# A value that sets who pays the cost of the request and the cost
|
4744
4829
|
# associated with data download from the S3 bucket. If this value is
|
4745
|
-
# set to true
|
4746
|
-
# owner pays. However, the S3 bucket owner always pays the cost
|
4747
|
-
# storing data.
|
4830
|
+
# set to `true`, the requester pays the costs; otherwise, the S3
|
4831
|
+
# bucket owner pays. However, the S3 bucket owner always pays the cost
|
4832
|
+
# of storing data.
|
4748
4833
|
#
|
4749
4834
|
# <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
|
4750
4835
|
# file share, so make sure that the configuration on the file share is
|
4751
4836
|
# the same as the S3 bucket configuration.
|
4752
4837
|
#
|
4753
4838
|
# </note>
|
4839
|
+
#
|
4840
|
+
# Valid Values: `true` \| `false`
|
4754
4841
|
# @return [Boolean]
|
4755
4842
|
#
|
4756
4843
|
# @!attribute [rw] smbacl_enabled
|
4757
|
-
# If this value is set to
|
4758
|
-
# list) is enabled on the SMB file share. If it is set to
|
4759
|
-
# it indicates that file and directory permissions are mapped
|
4760
|
-
# POSIX permission.
|
4761
|
-
#
|
4762
|
-
# For more information, see
|
4763
|
-
#
|
4764
|
-
#
|
4844
|
+
# If this value is set to `true`, it indicates that access control
|
4845
|
+
# list (ACL) is enabled on the SMB file share. If it is set to
|
4846
|
+
# `false`, it indicates that file and directory permissions are mapped
|
4847
|
+
# to the POSIX permission.
|
4848
|
+
#
|
4849
|
+
# For more information, see [Using Microsoft Windows ACLs to control
|
4850
|
+
# access to an SMB file share][1] in the *AWS Storage Gateway User
|
4851
|
+
# Guide*.
|
4852
|
+
#
|
4853
|
+
#
|
4854
|
+
#
|
4855
|
+
# [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
|
4765
4856
|
# @return [Boolean]
|
4766
4857
|
#
|
4767
4858
|
# @!attribute [rw] admin_user_list
|
@@ -4774,7 +4865,7 @@ module Aws::StorageGateway
|
|
4774
4865
|
# @!attribute [rw] valid_user_list
|
4775
4866
|
# A list of users or groups in the Active Directory that are allowed
|
4776
4867
|
# to access the file share. A group must be prefixed with the @
|
4777
|
-
# character. For example `@group1`. Can only be set if Authentication
|
4868
|
+
# character. For example, `@group1`. Can only be set if Authentication
|
4778
4869
|
# is set to `ActiveDirectory`.
|
4779
4870
|
# @return [Array<String>]
|
4780
4871
|
#
|
@@ -4791,10 +4882,10 @@ module Aws::StorageGateway
|
|
4791
4882
|
# @return [String]
|
4792
4883
|
#
|
4793
4884
|
# @!attribute [rw] authentication
|
4794
|
-
# The authentication method of the file share.
|
4795
|
-
#
|
4796
|
-
# Valid values are `ActiveDirectory` or `GuestAccess`. The default is
|
4885
|
+
# The authentication method of the file share. The default is
|
4797
4886
|
# `ActiveDirectory`.
|
4887
|
+
#
|
4888
|
+
# Valid Values: `ActiveDirectory` \| `GuestAccess`
|
4798
4889
|
# @return [String]
|
4799
4890
|
#
|
4800
4891
|
# @!attribute [rw] tags
|
@@ -4908,7 +4999,7 @@ module Aws::StorageGateway
|
|
4908
4999
|
# @return [String]
|
4909
5000
|
#
|
4910
5001
|
# @!attribute [rw] password
|
4911
|
-
# The password that you want to set for your SMB
|
5002
|
+
# The password that you want to set for your SMB server.
|
4912
5003
|
# @return [String]
|
4913
5004
|
#
|
4914
5005
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/SetSMBGuestPasswordInput AWS API Documentation
|
@@ -5087,8 +5178,8 @@ module Aws::StorageGateway
|
|
5087
5178
|
# @!attribute [rw] volume_attachment_status
|
5088
5179
|
# A value that indicates whether a storage volume is attached to,
|
5089
5180
|
# detached from, or is in the process of detaching from a gateway. For
|
5090
|
-
# more information, see [Moving
|
5091
|
-
#
|
5181
|
+
# more information, see [Moving your volumes to a different
|
5182
|
+
# gateway][1].
|
5092
5183
|
#
|
5093
5184
|
#
|
5094
5185
|
#
|
@@ -5121,7 +5212,7 @@ module Aws::StorageGateway
|
|
5121
5212
|
# Indicates if when the stored volume was created, existing data on
|
5122
5213
|
# the underlying local disk was preserved.
|
5123
5214
|
#
|
5124
|
-
# Valid Values: true
|
5215
|
+
# Valid Values: `true` \| `false`
|
5125
5216
|
# @return [Boolean]
|
5126
5217
|
#
|
5127
5218
|
# @!attribute [rw] volume_iscsi_attributes
|
@@ -5150,9 +5241,10 @@ module Aws::StorageGateway
|
|
5150
5241
|
# @return [Integer]
|
5151
5242
|
#
|
5152
5243
|
# @!attribute [rw] kms_key
|
5153
|
-
# The Amazon Resource Name (ARN) of
|
5154
|
-
# server-side encryption.
|
5155
|
-
#
|
5244
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
5245
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway
|
5246
|
+
# does not support asymmetric CMKs. This value can only be set when
|
5247
|
+
# `KMSEncrypted` is `true`. Optional.
|
5156
5248
|
# @return [String]
|
5157
5249
|
#
|
5158
5250
|
# @!attribute [rw] target_name
|
@@ -5189,7 +5281,7 @@ module Aws::StorageGateway
|
|
5189
5281
|
|
5190
5282
|
# A key-value pair that helps you manage, filter, and search for your
|
5191
5283
|
# resource. Allowed characters: letters, white space, and numbers,
|
5192
|
-
# representable in UTF-8, and the following characters: + - = . \_ :
|
5284
|
+
# representable in UTF-8, and the following characters: + - = . \_ : /.
|
5193
5285
|
#
|
5194
5286
|
# @note When making an API call, you may pass Tag
|
5195
5287
|
# data as a hash:
|
@@ -5200,7 +5292,7 @@ module Aws::StorageGateway
|
|
5200
5292
|
# }
|
5201
5293
|
#
|
5202
5294
|
# @!attribute [rw] key
|
5203
|
-
# Tag key
|
5295
|
+
# Tag key. The key can't start with aws:.
|
5204
5296
|
# @return [String]
|
5205
5297
|
#
|
5206
5298
|
# @!attribute [rw] value
|
@@ -5258,9 +5350,10 @@ module Aws::StorageGateway
|
|
5258
5350
|
# @return [Integer]
|
5259
5351
|
#
|
5260
5352
|
# @!attribute [rw] kms_key
|
5261
|
-
# The Amazon Resource Name (ARN) of
|
5262
|
-
# server-side encryption.
|
5263
|
-
#
|
5353
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
5354
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway
|
5355
|
+
# does not support asymmetric CMKs. This value can only be set when
|
5356
|
+
# `KMSEncrypted` is `true`. Optional.
|
5264
5357
|
# @return [String]
|
5265
5358
|
#
|
5266
5359
|
# @!attribute [rw] pool_id
|
@@ -5268,10 +5361,10 @@ module Aws::StorageGateway
|
|
5268
5361
|
# tapes in this pool are archived in the S3 storage class that is
|
5269
5362
|
# associated with the pool. When you use your backup application to
|
5270
5363
|
# eject the tape, the tape is archived directly into the storage class
|
5271
|
-
# (S3 Glacier or
|
5364
|
+
# (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the
|
5272
5365
|
# pool.
|
5273
5366
|
#
|
5274
|
-
# Valid
|
5367
|
+
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
5275
5368
|
# @return [String]
|
5276
5369
|
#
|
5277
5370
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/Tape AWS API Documentation
|
@@ -5336,9 +5429,10 @@ module Aws::StorageGateway
|
|
5336
5429
|
# @return [Integer]
|
5337
5430
|
#
|
5338
5431
|
# @!attribute [rw] kms_key
|
5339
|
-
# The Amazon Resource Name (ARN) of
|
5340
|
-
# server-side encryption.
|
5341
|
-
#
|
5432
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
5433
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway
|
5434
|
+
# does not support asymmetric CMKs. This value can only be set when
|
5435
|
+
# `KMSEncrypted` is `true`. Optional.
|
5342
5436
|
# @return [String]
|
5343
5437
|
#
|
5344
5438
|
# @!attribute [rw] pool_id
|
@@ -5346,7 +5440,7 @@ module Aws::StorageGateway
|
|
5346
5440
|
# this pool are archived in the S3 storage class that is associated
|
5347
5441
|
# with the pool.
|
5348
5442
|
#
|
5349
|
-
# Valid
|
5443
|
+
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
5350
5444
|
# @return [String]
|
5351
5445
|
#
|
5352
5446
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/TapeArchive AWS API Documentation
|
@@ -5397,7 +5491,7 @@ module Aws::StorageGateway
|
|
5397
5491
|
# (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the
|
5398
5492
|
# pool.
|
5399
5493
|
#
|
5400
|
-
# Valid
|
5494
|
+
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
5401
5495
|
# @return [String]
|
5402
5496
|
#
|
5403
5497
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/TapeInfo AWS API Documentation
|
@@ -5656,7 +5750,7 @@ module Aws::StorageGateway
|
|
5656
5750
|
# The Amazon Resource Name (ARN) of the Amazon CloudWatch log group
|
5657
5751
|
# that you want to use to monitor and log events in the gateway.
|
5658
5752
|
#
|
5659
|
-
# For more information, see [What
|
5753
|
+
# For more information, see [What is Amazon CloudWatch logs?][1].
|
5660
5754
|
#
|
5661
5755
|
#
|
5662
5756
|
#
|
@@ -5673,7 +5767,8 @@ module Aws::StorageGateway
|
|
5673
5767
|
include Aws::Structure
|
5674
5768
|
end
|
5675
5769
|
|
5676
|
-
# A JSON object containing the ARN of the gateway
|
5770
|
+
# A JSON object containing the Amazon Resource Name (ARN) of the gateway
|
5771
|
+
# that was updated.
|
5677
5772
|
#
|
5678
5773
|
# @!attribute [rw] gateway_arn
|
5679
5774
|
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
@@ -5782,10 +5877,6 @@ module Aws::StorageGateway
|
|
5782
5877
|
# represented as an ordinal number from 1 to 28, where 1 represents
|
5783
5878
|
# the first day of the month and 28 represents the last day of the
|
5784
5879
|
# month.
|
5785
|
-
#
|
5786
|
-
# <note markdown="1"> This value is only available for tape and volume gateways.
|
5787
|
-
#
|
5788
|
-
# </note>
|
5789
5880
|
# @return [Integer]
|
5790
5881
|
#
|
5791
5882
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateMaintenanceStartTimeInput AWS API Documentation
|
@@ -5844,14 +5935,17 @@ module Aws::StorageGateway
|
|
5844
5935
|
# @return [String]
|
5845
5936
|
#
|
5846
5937
|
# @!attribute [rw] kms_encrypted
|
5847
|
-
#
|
5848
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
5938
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
5939
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
5940
|
+
#
|
5941
|
+
# Valid Values: `true` \| `false`
|
5849
5942
|
# @return [Boolean]
|
5850
5943
|
#
|
5851
5944
|
# @!attribute [rw] kms_key
|
5852
|
-
# The Amazon Resource Name (ARN) of
|
5853
|
-
# server-side encryption.
|
5854
|
-
#
|
5945
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
5946
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway
|
5947
|
+
# does not support asymmetric CMKs. This value can only be set when
|
5948
|
+
# `KMSEncrypted` is `true`. Optional.
|
5855
5949
|
# @return [String]
|
5856
5950
|
#
|
5857
5951
|
# @!attribute [rw] nfs_file_share_defaults
|
@@ -5860,15 +5954,17 @@ module Aws::StorageGateway
|
|
5860
5954
|
#
|
5861
5955
|
# @!attribute [rw] default_storage_class
|
5862
5956
|
# The default storage class for objects put into an Amazon S3 bucket
|
5863
|
-
# by the file gateway.
|
5864
|
-
#
|
5865
|
-
#
|
5957
|
+
# by the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
|
5958
|
+
# Optional.
|
5959
|
+
#
|
5960
|
+
# Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
|
5961
|
+
# `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
|
5866
5962
|
# @return [String]
|
5867
5963
|
#
|
5868
5964
|
# @!attribute [rw] object_acl
|
5869
|
-
# A value that sets the access control list permission for
|
5870
|
-
# the S3 bucket that a file gateway puts objects into. The
|
5871
|
-
# value is
|
5965
|
+
# A value that sets the access control list (ACL) permission for
|
5966
|
+
# objects in the S3 bucket that a file gateway puts objects into. The
|
5967
|
+
# default value is `private`.
|
5872
5968
|
# @return [String]
|
5873
5969
|
#
|
5874
5970
|
# @!attribute [rw] client_list
|
@@ -5877,38 +5973,48 @@ module Aws::StorageGateway
|
|
5877
5973
|
# @return [Array<String>]
|
5878
5974
|
#
|
5879
5975
|
# @!attribute [rw] squash
|
5880
|
-
# The user mapped to anonymous user.
|
5976
|
+
# The user mapped to anonymous user.
|
5977
|
+
#
|
5978
|
+
# Valid values are the following:
|
5881
5979
|
#
|
5882
|
-
# * `RootSquash
|
5980
|
+
# * `RootSquash`\: Only root is mapped to anonymous user.
|
5883
5981
|
#
|
5884
|
-
# * `NoSquash
|
5982
|
+
# * `NoSquash`\: No one is mapped to anonymous user.
|
5885
5983
|
#
|
5886
|
-
# * `AllSquash
|
5984
|
+
# * `AllSquash`\: Everyone is mapped to anonymous user.
|
5887
5985
|
# @return [String]
|
5888
5986
|
#
|
5889
5987
|
# @!attribute [rw] read_only
|
5890
|
-
# A value that sets the write status of a file share.
|
5891
|
-
# true
|
5988
|
+
# A value that sets the write status of a file share. Set this value
|
5989
|
+
# to `true` to set the write status to read-only, otherwise set to
|
5990
|
+
# `false`.
|
5991
|
+
#
|
5992
|
+
# Valid Values: `true` \| `false`
|
5892
5993
|
# @return [Boolean]
|
5893
5994
|
#
|
5894
5995
|
# @!attribute [rw] guess_mime_type_enabled
|
5895
5996
|
# A value that enables guessing of the MIME type for uploaded objects
|
5896
|
-
# based on file extensions. Set this value to true to enable MIME
|
5897
|
-
# guessing,
|
5997
|
+
# based on file extensions. Set this value to `true` to enable MIME
|
5998
|
+
# type guessing, otherwise set to `false`. The default value is
|
5999
|
+
# `true`.
|
6000
|
+
#
|
6001
|
+
# Valid Values: `true` \| `false`
|
5898
6002
|
# @return [Boolean]
|
5899
6003
|
#
|
5900
6004
|
# @!attribute [rw] requester_pays
|
5901
6005
|
# A value that sets who pays the cost of the request and the cost
|
5902
6006
|
# associated with data download from the S3 bucket. If this value is
|
5903
|
-
# set to true
|
5904
|
-
# owner pays. However, the S3 bucket owner always pays the cost
|
5905
|
-
# storing data.
|
6007
|
+
# set to `true`, the requester pays the costs; otherwise, the S3
|
6008
|
+
# bucket owner pays. However, the S3 bucket owner always pays the cost
|
6009
|
+
# of storing data.
|
5906
6010
|
#
|
5907
6011
|
# <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
|
5908
6012
|
# file share, so make sure that the configuration on the file share is
|
5909
6013
|
# the same as the S3 bucket configuration.
|
5910
6014
|
#
|
5911
6015
|
# </note>
|
6016
|
+
#
|
6017
|
+
# Valid Values: `true` \| `false`
|
5912
6018
|
# @return [Boolean]
|
5913
6019
|
#
|
5914
6020
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateNFSFileShareInput AWS API Documentation
|
@@ -5968,75 +6074,94 @@ module Aws::StorageGateway
|
|
5968
6074
|
# @return [String]
|
5969
6075
|
#
|
5970
6076
|
# @!attribute [rw] kms_encrypted
|
5971
|
-
#
|
5972
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
6077
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
6078
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
6079
|
+
#
|
6080
|
+
# Valid Values: `true` \| `false`
|
5973
6081
|
# @return [Boolean]
|
5974
6082
|
#
|
5975
6083
|
# @!attribute [rw] kms_key
|
5976
|
-
# The Amazon Resource Name (ARN) of
|
5977
|
-
# server-side encryption.
|
5978
|
-
#
|
6084
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
6085
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway
|
6086
|
+
# does not support asymmetric CMKs. This value can only be set when
|
6087
|
+
# `KMSEncrypted` is `true`. Optional.
|
5979
6088
|
# @return [String]
|
5980
6089
|
#
|
5981
6090
|
# @!attribute [rw] default_storage_class
|
5982
6091
|
# The default storage class for objects put into an Amazon S3 bucket
|
5983
|
-
# by the file gateway.
|
5984
|
-
#
|
5985
|
-
#
|
6092
|
+
# by the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
|
6093
|
+
# Optional.
|
6094
|
+
#
|
6095
|
+
# Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
|
6096
|
+
# `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
|
5986
6097
|
# @return [String]
|
5987
6098
|
#
|
5988
6099
|
# @!attribute [rw] object_acl
|
5989
|
-
# A value that sets the access control list permission for
|
5990
|
-
# the S3 bucket that a file gateway puts objects into. The
|
5991
|
-
# value is
|
6100
|
+
# A value that sets the access control list (ACL) permission for
|
6101
|
+
# objects in the S3 bucket that a file gateway puts objects into. The
|
6102
|
+
# default value is `private`.
|
5992
6103
|
# @return [String]
|
5993
6104
|
#
|
5994
6105
|
# @!attribute [rw] read_only
|
5995
|
-
# A value that sets the write status of a file share.
|
5996
|
-
# true
|
6106
|
+
# A value that sets the write status of a file share. Set this value
|
6107
|
+
# to `true` to set write status to read-only, otherwise set to
|
6108
|
+
# `false`.
|
6109
|
+
#
|
6110
|
+
# Valid Values: `true` \| `false`
|
5997
6111
|
# @return [Boolean]
|
5998
6112
|
#
|
5999
6113
|
# @!attribute [rw] guess_mime_type_enabled
|
6000
6114
|
# A value that enables guessing of the MIME type for uploaded objects
|
6001
|
-
# based on file extensions. Set this value to true to enable MIME
|
6002
|
-
# guessing,
|
6115
|
+
# based on file extensions. Set this value to `true` to enable MIME
|
6116
|
+
# type guessing, otherwise set to `false`. The default value is
|
6117
|
+
# `true`.
|
6118
|
+
#
|
6119
|
+
# Valid Values: `true` \| `false`
|
6003
6120
|
# @return [Boolean]
|
6004
6121
|
#
|
6005
6122
|
# @!attribute [rw] requester_pays
|
6006
6123
|
# A value that sets who pays the cost of the request and the cost
|
6007
6124
|
# associated with data download from the S3 bucket. If this value is
|
6008
|
-
# set to true
|
6009
|
-
# owner pays. However, the S3 bucket owner always pays the cost
|
6010
|
-
# storing data.
|
6125
|
+
# set to `true`, the requester pays the costs; otherwise, the S3
|
6126
|
+
# bucket owner pays. However, the S3 bucket owner always pays the cost
|
6127
|
+
# of storing data.
|
6011
6128
|
#
|
6012
6129
|
# <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
|
6013
6130
|
# file share, so make sure that the configuration on the file share is
|
6014
6131
|
# the same as the S3 bucket configuration.
|
6015
6132
|
#
|
6016
6133
|
# </note>
|
6134
|
+
#
|
6135
|
+
# Valid Values: `true` \| `false`
|
6017
6136
|
# @return [Boolean]
|
6018
6137
|
#
|
6019
6138
|
# @!attribute [rw] smbacl_enabled
|
6020
|
-
# Set this value to
|
6021
|
-
# SMB file share. Set it to
|
6139
|
+
# Set this value to `true` to enable access control list (ACL) on the
|
6140
|
+
# SMB file share. Set it to `false` to map file and directory
|
6022
6141
|
# permissions to the POSIX permissions.
|
6023
6142
|
#
|
6024
|
-
# For more information, see
|
6025
|
-
#
|
6026
|
-
#
|
6143
|
+
# For more information, see [Using Microsoft Windows ACLs to control
|
6144
|
+
# access to an SMB file share][1] in the *AWS Storage Gateway User
|
6145
|
+
# Guide*.
|
6146
|
+
#
|
6147
|
+
# Valid Values: `true` \| `false`
|
6148
|
+
#
|
6149
|
+
#
|
6150
|
+
#
|
6151
|
+
# [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
|
6027
6152
|
# @return [Boolean]
|
6028
6153
|
#
|
6029
6154
|
# @!attribute [rw] admin_user_list
|
6030
6155
|
# A list of users in the Active Directory that have administrator
|
6031
6156
|
# rights to the file share. A group must be prefixed with the @
|
6032
|
-
# character. For example `@group1`. Can only be set if Authentication
|
6157
|
+
# character. For example, `@group1`. Can only be set if Authentication
|
6033
6158
|
# is set to `ActiveDirectory`.
|
6034
6159
|
# @return [Array<String>]
|
6035
6160
|
#
|
6036
6161
|
# @!attribute [rw] valid_user_list
|
6037
6162
|
# A list of users or groups in the Active Directory that are allowed
|
6038
6163
|
# to access the file share. A group must be prefixed with the @
|
6039
|
-
# character. For example `@group1`. Can only be set if Authentication
|
6164
|
+
# character. For example, `@group1`. Can only be set if Authentication
|
6040
6165
|
# is set to `ActiveDirectory`.
|
6041
6166
|
# @return [Array<String>]
|
6042
6167
|
#
|
@@ -6240,7 +6365,7 @@ module Aws::StorageGateway
|
|
6240
6365
|
# @!attribute [rw] device_type
|
6241
6366
|
# The type of medium changer you want to select.
|
6242
6367
|
#
|
6243
|
-
# Valid Values:
|
6368
|
+
# Valid Values: `STK-L700` \| `AWS-Gateway-VTL`
|
6244
6369
|
# @return [String]
|
6245
6370
|
#
|
6246
6371
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateVTLDeviceTypeInput AWS API Documentation
|