aws-sdk-storagegateway 1.39.0 → 1.44.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -142,6 +144,7 @@ module Aws::StorageGateway
142
144
  DoubleObject = Shapes::FloatShape.new(name: 'DoubleObject')
143
145
  Ec2InstanceId = Shapes::StringShape.new(name: 'Ec2InstanceId')
144
146
  Ec2InstanceRegion = Shapes::StringShape.new(name: 'Ec2InstanceRegion')
147
+ EndpointType = Shapes::StringShape.new(name: 'EndpointType')
145
148
  ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
146
149
  FileShareARN = Shapes::StringShape.new(name: 'FileShareARN')
147
150
  FileShareARNList = Shapes::ListShape.new(name: 'FileShareARNList')
@@ -680,6 +683,7 @@ module Aws::StorageGateway
680
683
  DescribeGatewayInformationOutput.add_member(:vpc_endpoint, Shapes::ShapeRef.new(shape: string, location_name: "VPCEndpoint"))
681
684
  DescribeGatewayInformationOutput.add_member(:cloud_watch_log_group_arn, Shapes::ShapeRef.new(shape: CloudWatchLogGroupARN, location_name: "CloudWatchLogGroupARN"))
682
685
  DescribeGatewayInformationOutput.add_member(:host_environment, Shapes::ShapeRef.new(shape: HostEnvironment, location_name: "HostEnvironment"))
686
+ DescribeGatewayInformationOutput.add_member(:endpoint_type, Shapes::ShapeRef.new(shape: EndpointType, location_name: "EndpointType"))
683
687
  DescribeGatewayInformationOutput.struct_class = Types::DescribeGatewayInformationOutput
684
688
 
685
689
  DescribeMaintenanceStartTimeInput.add_member(:gateway_arn, Shapes::ShapeRef.new(shape: GatewayARN, required: true, location_name: "GatewayARN"))
@@ -1,3 +1,4 @@
1
+ # frozen_string_literal: true
1
2
  # WARNING ABOUT GENERATED CODE
2
3
  #
3
4
  # This file is generated. See the contributing for info on making contributions:
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -20,10 +22,10 @@ module Aws::StorageGateway
20
22
  #
21
23
  # * ActivateGatewayInput$GatewayType
22
24
  #
23
- # * ActivateGatewayInput$TapeDriveType
24
- #
25
25
  # * ActivateGatewayInput$MediumChangerType
26
26
  #
27
+ # * ActivateGatewayInput$TapeDriveType
28
+ #
27
29
  # @note When making an API call, you may pass ActivateGatewayInput
28
30
  # data as a hash:
29
31
  #
@@ -53,9 +55,12 @@ module Aws::StorageGateway
53
55
  # the arguments you pass to the `ActivateGateway` API call determine
54
56
  # the actual configuration of your gateway.
55
57
  #
56
- # For more information, see
57
- # https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html
58
- # in the Storage Gateway User Guide.
58
+ # For more information, see [Getting activation key][1] in the *AWS
59
+ # Storage Gateway User Guide*.
60
+ #
61
+ #
62
+ #
63
+ # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html
59
64
  # @return [String]
60
65
  #
61
66
  # @!attribute [rw] gateway_name
@@ -76,15 +81,15 @@ module Aws::StorageGateway
76
81
  # data. The gateway AWS Region specified must be the same AWS Region
77
82
  # as the AWS Region in your `Host` header in the request. For more
78
83
  # information about available AWS Regions and endpoints for AWS
79
- # Storage Gateway, see [Regions and Endpoints][1] in the *Amazon Web
80
- # Services Glossary*.
84
+ # Storage Gateway, see [AWS Storage Gateway endpoints and quotas][1]
85
+ # in the *AWS General Reference*.
81
86
  #
82
- # Valid Values: See [AWS Storage Gateway Regions and Endpoints][1] in
83
- # the AWS General Reference.
87
+ # Valid Values: See [AWS Storage Gateway endpoints and quotas][1] in
88
+ # the *AWS General Reference*.
84
89
  #
85
90
  #
86
91
  #
87
- # [1]: https://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region
92
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/sg.html
88
93
  # @return [String]
89
94
  #
90
95
  # @!attribute [rw] gateway_type
@@ -92,21 +97,21 @@ module Aws::StorageGateway
92
97
  # specified is critical to all later functions of the gateway and
93
98
  # cannot be changed after activation. The default value is `CACHED`.
94
99
  #
95
- # Valid Values: "STORED", "CACHED", "VTL", "FILE\_S3"
100
+ # Valid Values: `STORED` \| `CACHED` \| `VTL` \| `FILE_S3`
96
101
  # @return [String]
97
102
  #
98
103
  # @!attribute [rw] tape_drive_type
99
104
  # The value that indicates the type of tape drive to use for tape
100
105
  # gateway. This field is optional.
101
106
  #
102
- # Valid Values: "IBM-ULT3580-TD5"
107
+ # Valid Values: `IBM-ULT3580-TD5`
103
108
  # @return [String]
104
109
  #
105
110
  # @!attribute [rw] medium_changer_type
106
111
  # The value that indicates the type of medium changer to use for tape
107
112
  # gateway. This field is optional.
108
113
  #
109
- # Valid Values: "STK-L700", "AWS-Gateway-VTL"
114
+ # Valid Values: `STK-L700` \| `AWS-Gateway-VTL`
110
115
  # @return [String]
111
116
  #
112
117
  # @!attribute [rw] tags
@@ -133,6 +138,7 @@ module Aws::StorageGateway
133
138
  :tape_drive_type,
134
139
  :medium_changer_type,
135
140
  :tags)
141
+ SENSITIVE = []
136
142
  include Aws::Structure
137
143
  end
138
144
 
@@ -158,6 +164,7 @@ module Aws::StorageGateway
158
164
  #
159
165
  class ActivateGatewayOutput < Struct.new(
160
166
  :gateway_arn)
167
+ SENSITIVE = []
161
168
  include Aws::Structure
162
169
  end
163
170
 
@@ -186,6 +193,7 @@ module Aws::StorageGateway
186
193
  class AddCacheInput < Struct.new(
187
194
  :gateway_arn,
188
195
  :disk_ids)
196
+ SENSITIVE = []
189
197
  include Aws::Structure
190
198
  end
191
199
 
@@ -199,6 +207,7 @@ module Aws::StorageGateway
199
207
  #
200
208
  class AddCacheOutput < Struct.new(
201
209
  :gateway_arn)
210
+ SENSITIVE = []
202
211
  include Aws::Structure
203
212
  end
204
213
 
@@ -239,6 +248,7 @@ module Aws::StorageGateway
239
248
  class AddTagsToResourceInput < Struct.new(
240
249
  :resource_arn,
241
250
  :tags)
251
+ SENSITIVE = []
242
252
  include Aws::Structure
243
253
  end
244
254
 
@@ -253,6 +263,7 @@ module Aws::StorageGateway
253
263
  #
254
264
  class AddTagsToResourceOutput < Struct.new(
255
265
  :resource_arn)
266
+ SENSITIVE = []
256
267
  include Aws::Structure
257
268
  end
258
269
 
@@ -281,6 +292,7 @@ module Aws::StorageGateway
281
292
  class AddUploadBufferInput < Struct.new(
282
293
  :gateway_arn,
283
294
  :disk_ids)
295
+ SENSITIVE = []
284
296
  include Aws::Structure
285
297
  end
286
298
 
@@ -294,6 +306,7 @@ module Aws::StorageGateway
294
306
  #
295
307
  class AddUploadBufferOutput < Struct.new(
296
308
  :gateway_arn)
309
+ SENSITIVE = []
297
310
  include Aws::Structure
298
311
  end
299
312
 
@@ -328,6 +341,7 @@ module Aws::StorageGateway
328
341
  class AddWorkingStorageInput < Struct.new(
329
342
  :gateway_arn,
330
343
  :disk_ids)
344
+ SENSITIVE = []
331
345
  include Aws::Structure
332
346
  end
333
347
 
@@ -344,6 +358,7 @@ module Aws::StorageGateway
344
358
  #
345
359
  class AddWorkingStorageOutput < Struct.new(
346
360
  :gateway_arn)
361
+ SENSITIVE = []
347
362
  include Aws::Structure
348
363
  end
349
364
 
@@ -368,7 +383,7 @@ module Aws::StorageGateway
368
383
  # (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the
369
384
  # pool.
370
385
  #
371
- # Valid values: "GLACIER", "DEEP\_ARCHIVE"
386
+ # Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
372
387
  # @return [String]
373
388
  #
374
389
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AssignTapePoolInput AWS API Documentation
@@ -376,6 +391,7 @@ module Aws::StorageGateway
376
391
  class AssignTapePoolInput < Struct.new(
377
392
  :tape_arn,
378
393
  :pool_id)
394
+ SENSITIVE = []
379
395
  include Aws::Structure
380
396
  end
381
397
 
@@ -388,6 +404,7 @@ module Aws::StorageGateway
388
404
  #
389
405
  class AssignTapePoolOutput < Struct.new(
390
406
  :tape_arn)
407
+ SENSITIVE = []
391
408
  include Aws::Structure
392
409
  end
393
410
 
@@ -448,6 +465,7 @@ module Aws::StorageGateway
448
465
  :volume_arn,
449
466
  :network_interface_id,
450
467
  :disk_id)
468
+ SENSITIVE = []
451
469
  include Aws::Structure
452
470
  end
453
471
 
@@ -469,6 +487,7 @@ module Aws::StorageGateway
469
487
  class AttachVolumeOutput < Struct.new(
470
488
  :volume_arn,
471
489
  :target_arn)
490
+ SENSITIVE = []
472
491
  include Aws::Structure
473
492
  end
474
493
 
@@ -493,6 +512,7 @@ module Aws::StorageGateway
493
512
  class AutomaticTapeCreationPolicyInfo < Struct.new(
494
513
  :automatic_tape_creation_rules,
495
514
  :gateway_arn)
515
+ SENSITIVE = []
496
516
  include Aws::Structure
497
517
  end
498
518
 
@@ -527,7 +547,7 @@ module Aws::StorageGateway
527
547
  # the storage class (S3 Glacier or S3 Glacier Deep Archive) that
528
548
  # corresponds to the pool.
529
549
  #
530
- # Valid values: "GLACIER", "DEEP\_ARCHIVE"
550
+ # Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
531
551
  # @return [String]
532
552
  #
533
553
  # @!attribute [rw] tape_size_in_bytes
@@ -548,6 +568,7 @@ module Aws::StorageGateway
548
568
  :pool_id,
549
569
  :tape_size_in_bytes,
550
570
  :minimum_num_tapes)
571
+ SENSITIVE = []
551
572
  include Aws::Structure
552
573
  end
553
574
 
@@ -573,8 +594,8 @@ module Aws::StorageGateway
573
594
  #
574
595
  # @!attribute [rw] volume_attachment_status
575
596
  # A value that indicates whether a storage volume is attached to or
576
- # detached from a gateway. For more information, see [Moving Your
577
- # Volumes to a Different Gateway][1].
597
+ # detached from a gateway. For more information, see [Moving your
598
+ # volumes to a different gateway][1].
578
599
  #
579
600
  #
580
601
  #
@@ -624,9 +645,10 @@ module Aws::StorageGateway
624
645
  # @return [Integer]
625
646
  #
626
647
  # @!attribute [rw] kms_key
627
- # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
628
- # server-side encryption. This value can only be set when KMSEncrypted
629
- # is true. Optional.
648
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
649
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway
650
+ # does not support asymmetric CMKs. This value can only be set when
651
+ # `KMSEncrypted` is `true`. Optional.
630
652
  # @return [String]
631
653
  #
632
654
  # @!attribute [rw] target_name
@@ -656,6 +678,7 @@ module Aws::StorageGateway
656
678
  :volume_used_in_bytes,
657
679
  :kms_key,
658
680
  :target_name)
681
+ SENSITIVE = []
659
682
  include Aws::Structure
660
683
  end
661
684
 
@@ -685,6 +708,7 @@ module Aws::StorageGateway
685
708
  class CancelArchivalInput < Struct.new(
686
709
  :gateway_arn,
687
710
  :tape_arn)
711
+ SENSITIVE = []
688
712
  include Aws::Structure
689
713
  end
690
714
 
@@ -699,6 +723,7 @@ module Aws::StorageGateway
699
723
  #
700
724
  class CancelArchivalOutput < Struct.new(
701
725
  :tape_arn)
726
+ SENSITIVE = []
702
727
  include Aws::Structure
703
728
  end
704
729
 
@@ -728,6 +753,7 @@ module Aws::StorageGateway
728
753
  class CancelRetrievalInput < Struct.new(
729
754
  :gateway_arn,
730
755
  :tape_arn)
756
+ SENSITIVE = []
731
757
  include Aws::Structure
732
758
  end
733
759
 
@@ -742,6 +768,7 @@ module Aws::StorageGateway
742
768
  #
743
769
  class CancelRetrievalOutput < Struct.new(
744
770
  :tape_arn)
771
+ SENSITIVE = []
745
772
  include Aws::Structure
746
773
  end
747
774
 
@@ -777,6 +804,7 @@ module Aws::StorageGateway
777
804
  :secret_to_authenticate_initiator,
778
805
  :initiator_name,
779
806
  :secret_to_authenticate_target)
807
+ SENSITIVE = [:secret_to_authenticate_initiator, :secret_to_authenticate_target]
780
808
  include Aws::Structure
781
809
  end
782
810
 
@@ -814,7 +842,7 @@ module Aws::StorageGateway
814
842
  # @!attribute [rw] snapshot_id
815
843
  # The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore
816
844
  # 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
845
+ # the iSCSI storage volume from a snapshot; otherwise, do not include
818
846
  # this field. To list snapshots for your account use
819
847
  # [DescribeSnapshots][1] in the *Amazon Elastic Compute Cloud API
820
848
  # Reference*.
@@ -859,14 +887,17 @@ module Aws::StorageGateway
859
887
  # @return [String]
860
888
  #
861
889
  # @!attribute [rw] kms_encrypted
862
- # True to use Amazon S3 server-side encryption with your own AWS KMS
863
- # key, or false to use a key managed by Amazon S3. Optional.
890
+ # Set to `true` to use Amazon S3 server-side encryption with your own
891
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
892
+ #
893
+ # Valid Values: `true` \| `false`
864
894
  # @return [Boolean]
865
895
  #
866
896
  # @!attribute [rw] kms_key
867
- # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
868
- # server-side encryption. This value can only be set when KMSEncrypted
869
- # is true. Optional.
897
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
898
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway
899
+ # does not support asymmetric CMKs. This value can only be set when
900
+ # `KMSEncrypted` is `true`. Optional.
870
901
  # @return [String]
871
902
  #
872
903
  # @!attribute [rw] tags
@@ -895,6 +926,7 @@ module Aws::StorageGateway
895
926
  :kms_encrypted,
896
927
  :kms_key,
897
928
  :tags)
929
+ SENSITIVE = []
898
930
  include Aws::Structure
899
931
  end
900
932
 
@@ -912,6 +944,7 @@ module Aws::StorageGateway
912
944
  class CreateCachediSCSIVolumeOutput < Struct.new(
913
945
  :volume_arn,
914
946
  :target_arn)
947
+ SENSITIVE = []
915
948
  include Aws::Structure
916
949
  end
917
950
 
@@ -963,14 +996,17 @@ module Aws::StorageGateway
963
996
  # @return [String]
964
997
  #
965
998
  # @!attribute [rw] kms_encrypted
966
- # True to use Amazon S3 server-side encryption with your own AWS KMS
967
- # key, or false to use a key managed by Amazon S3. Optional.
999
+ # Set to `true` to use Amazon S3 server-side encryption with your own
1000
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1001
+ #
1002
+ # Valid Values: `true` \| `false`
968
1003
  # @return [Boolean]
969
1004
  #
970
1005
  # @!attribute [rw] kms_key
971
- # The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3
972
- # server-side encryption. This value can only be set when KMSEncrypted
973
- # is true. Optional.
1006
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
1007
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway
1008
+ # does not support asymmetric CMKs. This value can only be set when
1009
+ # `KMSEncrypted` is `true`. Optional.
974
1010
  # @return [String]
975
1011
  #
976
1012
  # @!attribute [rw] role
@@ -984,15 +1020,17 @@ module Aws::StorageGateway
984
1020
  #
985
1021
  # @!attribute [rw] default_storage_class
986
1022
  # The default storage class for objects put into an Amazon S3 bucket
987
- # by the file gateway. Possible values are `S3_STANDARD`,
988
- # `S3_STANDARD_IA`, or `S3_ONEZONE_IA`. If this field is not
989
- # populated, the default value `S3_STANDARD` is used. Optional.
1023
+ # by the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
1024
+ # Optional.
1025
+ #
1026
+ # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
1027
+ # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
990
1028
  # @return [String]
991
1029
  #
992
1030
  # @!attribute [rw] object_acl
993
- # A value that sets the access control list permission for objects in
994
- # the S3 bucket that a file gateway puts objects into. The default
995
- # value is "private".
1031
+ # A value that sets the access control list (ACL) permission for
1032
+ # objects in the S3 bucket that a file gateway puts objects into. The
1033
+ # default value is `private`.
996
1034
  # @return [String]
997
1035
  #
998
1036
  # @!attribute [rw] client_list
@@ -1001,39 +1039,48 @@ module Aws::StorageGateway
1001
1039
  # @return [Array<String>]
1002
1040
  #
1003
1041
  # @!attribute [rw] squash
1004
- # A value that maps a user to anonymous user. Valid options are the
1005
- # following:
1042
+ # A value that maps a user to anonymous user.
1043
+ #
1044
+ # Valid values are the following:
1006
1045
  #
1007
- # * `RootSquash` - Only root is mapped to anonymous user.
1046
+ # * `RootSquash`\: Only root is mapped to anonymous user.
1008
1047
  #
1009
- # * `NoSquash` - No one is mapped to anonymous user
1048
+ # * `NoSquash`\: No one is mapped to anonymous user.
1010
1049
  #
1011
- # * `AllSquash` - Everyone is mapped to anonymous user.
1050
+ # * `AllSquash`\: Everyone is mapped to anonymous user.
1012
1051
  # @return [String]
1013
1052
  #
1014
1053
  # @!attribute [rw] read_only
1015
- # A value that sets the write status of a file share. This value is
1016
- # true if the write status is read-only, and otherwise false.
1054
+ # A value that sets the write status of a file share. Set this value
1055
+ # to `true` to set the write status to read-only, otherwise set to
1056
+ # `false`.
1057
+ #
1058
+ # Valid Values: `true` \| `false`
1017
1059
  # @return [Boolean]
1018
1060
  #
1019
1061
  # @!attribute [rw] guess_mime_type_enabled
1020
1062
  # 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 type
1022
- # guessing, and otherwise to false. The default value is true.
1063
+ # based on file extensions. Set this value to `true` to enable MIME
1064
+ # type guessing, otherwise set to `false`. The default value is
1065
+ # `true`.
1066
+ #
1067
+ # Valid Values: `true` \| `false`
1023
1068
  # @return [Boolean]
1024
1069
  #
1025
1070
  # @!attribute [rw] requester_pays
1026
1071
  # A value that sets who pays the cost of the request and the cost
1027
1072
  # associated with data download from the S3 bucket. If this value is
1028
- # set to true, the requester pays the costs. Otherwise the S3 bucket
1029
- # owner pays. However, the S3 bucket owner always pays the cost of
1030
- # storing data.
1073
+ # set to `true`, the requester pays the costs; otherwise, the S3
1074
+ # bucket owner pays. However, the S3 bucket owner always pays the cost
1075
+ # of storing data.
1031
1076
  #
1032
1077
  # <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
1033
1078
  # file share, so make sure that the configuration on the file share is
1034
1079
  # the same as the S3 bucket configuration.
1035
1080
  #
1036
1081
  # </note>
1082
+ #
1083
+ # Valid Values: `true` \| `false`
1037
1084
  # @return [Boolean]
1038
1085
  #
1039
1086
  # @!attribute [rw] tags
@@ -1066,6 +1113,7 @@ module Aws::StorageGateway
1066
1113
  :guess_mime_type_enabled,
1067
1114
  :requester_pays,
1068
1115
  :tags)
1116
+ SENSITIVE = []
1069
1117
  include Aws::Structure
1070
1118
  end
1071
1119
 
@@ -1079,6 +1127,7 @@ module Aws::StorageGateway
1079
1127
  #
1080
1128
  class CreateNFSFileShareOutput < Struct.new(
1081
1129
  :file_share_arn)
1130
+ SENSITIVE = []
1082
1131
  include Aws::Structure
1083
1132
  end
1084
1133
 
@@ -1124,14 +1173,17 @@ module Aws::StorageGateway
1124
1173
  # @return [String]
1125
1174
  #
1126
1175
  # @!attribute [rw] kms_encrypted
1127
- # True to use Amazon S3 server-side encryption with your own AWS KMS
1128
- # key, or false to use a key managed by Amazon S3. Optional.
1176
+ # Set to `true` to use Amazon S3 server-side encryption with your own
1177
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1178
+ #
1179
+ # Valid Values: `true` \| `false`
1129
1180
  # @return [Boolean]
1130
1181
  #
1131
1182
  # @!attribute [rw] kms_key
1132
- # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
1133
- # server-side encryption. This value can only be set when KMSEncrypted
1134
- # is true. Optional.
1183
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
1184
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway
1185
+ # does not support asymmetric CMKs. This value can only be set when
1186
+ # `KMSEncrypted` is `true`. Optional.
1135
1187
  # @return [String]
1136
1188
  #
1137
1189
  # @!attribute [rw] role
@@ -1145,50 +1197,66 @@ module Aws::StorageGateway
1145
1197
  #
1146
1198
  # @!attribute [rw] default_storage_class
1147
1199
  # The default storage class for objects put into an Amazon S3 bucket
1148
- # by the file gateway. Possible values are `S3_STANDARD`,
1149
- # `S3_STANDARD_IA`, or `S3_ONEZONE_IA`. If this field is not
1150
- # populated, the default value `S3_STANDARD` is used. Optional.
1200
+ # by the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
1201
+ # Optional.
1202
+ #
1203
+ # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
1204
+ # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
1151
1205
  # @return [String]
1152
1206
  #
1153
1207
  # @!attribute [rw] object_acl
1154
- # A value that sets the access control list permission for objects in
1155
- # the S3 bucket that a file gateway puts objects into. The default
1156
- # value is "private".
1208
+ # A value that sets the access control list (ACL) permission for
1209
+ # objects in the S3 bucket that a file gateway puts objects into. The
1210
+ # default value is `private`.
1157
1211
  # @return [String]
1158
1212
  #
1159
1213
  # @!attribute [rw] read_only
1160
- # A value that sets the write status of a file share. This value is
1161
- # true if the write status is read-only, and otherwise false.
1214
+ # A value that sets the write status of a file share. Set this value
1215
+ # to `true` to set the write status to read-only, otherwise set to
1216
+ # `false`.
1217
+ #
1218
+ # Valid Values: `true` \| `false`
1162
1219
  # @return [Boolean]
1163
1220
  #
1164
1221
  # @!attribute [rw] guess_mime_type_enabled
1165
1222
  # 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 type
1167
- # guessing, and otherwise to false. The default value is true.
1223
+ # based on file extensions. Set this value to `true` to enable MIME
1224
+ # type guessing, otherwise set to `false`. The default value is
1225
+ # `true`.
1226
+ #
1227
+ # Valid Values: `true` \| `false`
1168
1228
  # @return [Boolean]
1169
1229
  #
1170
1230
  # @!attribute [rw] requester_pays
1171
1231
  # A value that sets who pays the cost of the request and the cost
1172
1232
  # associated with data download from the S3 bucket. If this value is
1173
- # set to true, the requester pays the costs. Otherwise the S3 bucket
1174
- # owner pays. However, the S3 bucket owner always pays the cost of
1175
- # storing data.
1233
+ # set to `true`, the requester pays the costs; otherwise, the S3
1234
+ # bucket owner pays. However, the S3 bucket owner always pays the cost
1235
+ # of storing data.
1176
1236
  #
1177
1237
  # <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
1178
1238
  # file share, so make sure that the configuration on the file share is
1179
1239
  # the same as the S3 bucket configuration.
1180
1240
  #
1181
1241
  # </note>
1242
+ #
1243
+ # Valid Values: `true` \| `false`
1182
1244
  # @return [Boolean]
1183
1245
  #
1184
1246
  # @!attribute [rw] smbacl_enabled
1185
- # Set this value to "true to enable ACL (access control list) on the
1186
- # SMB file share. Set it to "false" to map file and directory
1247
+ # Set this value to `true` to enable access control list (ACL) on the
1248
+ # SMB file share. Set it to `false` to map file and directory
1187
1249
  # permissions to the POSIX permissions.
1188
1250
  #
1189
- # For more information, see
1190
- # https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
1191
- # in the Storage Gateway User Guide.
1251
+ # For more information, see [Using Microsoft Windows ACLs to control
1252
+ # access to an SMB file share][1] in the *AWS Storage Gateway User
1253
+ # Guide*.
1254
+ #
1255
+ # Valid Values: `true` \| `false`
1256
+ #
1257
+ #
1258
+ #
1259
+ # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
1192
1260
  # @return [Boolean]
1193
1261
  #
1194
1262
  # @!attribute [rw] admin_user_list
@@ -1204,7 +1272,7 @@ module Aws::StorageGateway
1204
1272
  # @!attribute [rw] valid_user_list
1205
1273
  # A list of users or groups in the Active Directory that are allowed
1206
1274
  # to access the file share. A group must be prefixed with the @
1207
- # character. For example `@group1`. Can only be set if Authentication
1275
+ # character. For example, `@group1`. Can only be set if Authentication
1208
1276
  # is set to `ActiveDirectory`.
1209
1277
  # @return [Array<String>]
1210
1278
  #
@@ -1222,9 +1290,9 @@ module Aws::StorageGateway
1222
1290
  #
1223
1291
  # @!attribute [rw] authentication
1224
1292
  # The authentication method that users use to access the file share.
1293
+ # The default is `ActiveDirectory`.
1225
1294
  #
1226
- # Valid values are `ActiveDirectory` or `GuestAccess`. The default is
1227
- # `ActiveDirectory`.
1295
+ # Valid Values: `ActiveDirectory` \| `GuestAccess`
1228
1296
  # @return [String]
1229
1297
  #
1230
1298
  # @!attribute [rw] tags
@@ -1260,6 +1328,7 @@ module Aws::StorageGateway
1260
1328
  :audit_destination_arn,
1261
1329
  :authentication,
1262
1330
  :tags)
1331
+ SENSITIVE = []
1263
1332
  include Aws::Structure
1264
1333
  end
1265
1334
 
@@ -1273,6 +1342,7 @@ module Aws::StorageGateway
1273
1342
  #
1274
1343
  class CreateSMBFileShareOutput < Struct.new(
1275
1344
  :file_share_arn)
1345
+ SENSITIVE = []
1276
1346
  include Aws::Structure
1277
1347
  end
1278
1348
 
@@ -1300,7 +1370,7 @@ module Aws::StorageGateway
1300
1370
  # Textual description of the snapshot that appears in the Amazon EC2
1301
1371
  # console, Elastic Block Store snapshots panel in the **Description**
1302
1372
  # field, and in the AWS Storage Gateway snapshot **Details** pane,
1303
- # **Description** field
1373
+ # **Description** field.
1304
1374
  # @return [String]
1305
1375
  #
1306
1376
  # @!attribute [rw] tags
@@ -1321,6 +1391,7 @@ module Aws::StorageGateway
1321
1391
  :volume_arn,
1322
1392
  :snapshot_description,
1323
1393
  :tags)
1394
+ SENSITIVE = []
1324
1395
  include Aws::Structure
1325
1396
  end
1326
1397
 
@@ -1344,6 +1415,7 @@ module Aws::StorageGateway
1344
1415
  :snapshot_id,
1345
1416
  :volume_arn,
1346
1417
  :volume_recovery_point_time)
1418
+ SENSITIVE = []
1347
1419
  include Aws::Structure
1348
1420
  end
1349
1421
 
@@ -1376,7 +1448,7 @@ module Aws::StorageGateway
1376
1448
  # Textual description of the snapshot that appears in the Amazon EC2
1377
1449
  # console, Elastic Block Store snapshots panel in the **Description**
1378
1450
  # field, and in the AWS Storage Gateway snapshot **Details** pane,
1379
- # **Description** field
1451
+ # **Description** field.
1380
1452
  # @return [String]
1381
1453
  #
1382
1454
  # @!attribute [rw] tags
@@ -1397,6 +1469,7 @@ module Aws::StorageGateway
1397
1469
  :volume_arn,
1398
1470
  :snapshot_description,
1399
1471
  :tags)
1472
+ SENSITIVE = []
1400
1473
  include Aws::Structure
1401
1474
  end
1402
1475
 
@@ -1419,6 +1492,7 @@ module Aws::StorageGateway
1419
1492
  class CreateSnapshotOutput < Struct.new(
1420
1493
  :volume_arn,
1421
1494
  :snapshot_id)
1495
+ SENSITIVE = []
1422
1496
  include Aws::Structure
1423
1497
  end
1424
1498
 
@@ -1473,7 +1547,7 @@ module Aws::StorageGateway
1473
1547
  # @!attribute [rw] snapshot_id
1474
1548
  # The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore
1475
1549
  # 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
1550
+ # the iSCSI storage volume from a snapshot; otherwise, do not include
1477
1551
  # this field. To list snapshots for your account use
1478
1552
  # [DescribeSnapshots][1] in the *Amazon Elastic Compute Cloud API
1479
1553
  # Reference*.
@@ -1484,11 +1558,10 @@ module Aws::StorageGateway
1484
1558
  # @return [String]
1485
1559
  #
1486
1560
  # @!attribute [rw] preserve_existing_data
1487
- # Specify this field as true if you want to preserve the data on the
1488
- # local disk. Otherwise, specifying this field as false creates an
1489
- # empty volume.
1561
+ # Set to true `true` if you want to preserve the data on the local
1562
+ # disk. Otherwise, set to `false` to create an empty volume.
1490
1563
  #
1491
- # Valid Values: true, false
1564
+ # Valid Values: `true` \| `false`
1492
1565
  # @return [Boolean]
1493
1566
  #
1494
1567
  # @!attribute [rw] target_name
@@ -1512,14 +1585,17 @@ module Aws::StorageGateway
1512
1585
  # @return [String]
1513
1586
  #
1514
1587
  # @!attribute [rw] kms_encrypted
1515
- # True to use Amazon S3 server-side encryption with your own AWS KMS
1516
- # key, or false to use a key managed by Amazon S3. Optional.
1588
+ # Set to `true` to use Amazon S3 server-side encryption with your own
1589
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1590
+ #
1591
+ # Valid Values: `true` \| `false`
1517
1592
  # @return [Boolean]
1518
1593
  #
1519
1594
  # @!attribute [rw] kms_key
1520
- # The Amazon Resource Name (ARN) of the KMS key used for Amazon S3
1521
- # server-side encryption. This value can only be set when KMSEncrypted
1522
- # is true. Optional.
1595
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
1596
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway
1597
+ # does not support asymmetric CMKs. This value can only be set when
1598
+ # `KMSEncrypted` is `true`. Optional.
1523
1599
  # @return [String]
1524
1600
  #
1525
1601
  # @!attribute [rw] tags
@@ -1546,6 +1622,7 @@ module Aws::StorageGateway
1546
1622
  :kms_encrypted,
1547
1623
  :kms_key,
1548
1624
  :tags)
1625
+ SENSITIVE = []
1549
1626
  include Aws::Structure
1550
1627
  end
1551
1628
 
@@ -1570,6 +1647,7 @@ module Aws::StorageGateway
1570
1647
  :volume_arn,
1571
1648
  :volume_size_in_bytes,
1572
1649
  :target_arn)
1650
+ SENSITIVE = []
1573
1651
  include Aws::Structure
1574
1652
  end
1575
1653
 
@@ -1617,14 +1695,17 @@ module Aws::StorageGateway
1617
1695
  # @return [String]
1618
1696
  #
1619
1697
  # @!attribute [rw] kms_encrypted
1620
- # True to use Amazon S3 server-side encryption with your own AWS KMS
1621
- # key, or false to use a key managed by Amazon S3. Optional.
1698
+ # Set to `true` to use Amazon S3 server-side encryption with your own
1699
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1700
+ #
1701
+ # Valid Values: `true` \| `false`
1622
1702
  # @return [Boolean]
1623
1703
  #
1624
1704
  # @!attribute [rw] kms_key
1625
- # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
1626
- # server-side encryption. This value can only be set when KMSEncrypted
1627
- # is true. Optional.
1705
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
1706
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway
1707
+ # does not support asymmetric CMKs. This value can only be set when
1708
+ # `KMSEncrypted` is `true`. Optional.
1628
1709
  # @return [String]
1629
1710
  #
1630
1711
  # @!attribute [rw] pool_id
@@ -1632,10 +1713,9 @@ module Aws::StorageGateway
1632
1713
  # The tape in this pool is archived in the S3 storage class that is
1633
1714
  # associated with the pool. When you use your backup application to
1634
1715
  # eject the tape, the tape is archived directly into the storage class
1635
- # (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the
1636
- # pool.
1716
+ # (S3 Glacier or S3 Deep Archive) that corresponds to the pool.
1637
1717
  #
1638
- # Valid values: "GLACIER", "DEEP\_ARCHIVE"
1718
+ # Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
1639
1719
  # @return [String]
1640
1720
  #
1641
1721
  # @!attribute [rw] tags
@@ -1660,6 +1740,7 @@ module Aws::StorageGateway
1660
1740
  :kms_key,
1661
1741
  :pool_id,
1662
1742
  :tags)
1743
+ SENSITIVE = []
1663
1744
  include Aws::Structure
1664
1745
  end
1665
1746
 
@@ -1674,6 +1755,7 @@ module Aws::StorageGateway
1674
1755
  #
1675
1756
  class CreateTapeWithBarcodeOutput < Struct.new(
1676
1757
  :tape_arn)
1758
+ SENSITIVE = []
1677
1759
  include Aws::Structure
1678
1760
  end
1679
1761
 
@@ -1739,14 +1821,17 @@ module Aws::StorageGateway
1739
1821
  # @return [String]
1740
1822
  #
1741
1823
  # @!attribute [rw] kms_encrypted
1742
- # True to use Amazon S3 server-side encryption with your own AWS KMS
1743
- # key, or false to use a key managed by Amazon S3. Optional.
1824
+ # Set to `true` to use Amazon S3 server-side encryption with your own
1825
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1826
+ #
1827
+ # Valid Values: `true` \| `false`
1744
1828
  # @return [Boolean]
1745
1829
  #
1746
1830
  # @!attribute [rw] kms_key
1747
- # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
1748
- # server-side encryption. This value can only be set when KMSEncrypted
1749
- # is true. Optional.
1831
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
1832
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway
1833
+ # does not support asymmetric CMKs. This value can only be set when
1834
+ # `KMSEncrypted` is `true`. Optional.
1750
1835
  # @return [String]
1751
1836
  #
1752
1837
  # @!attribute [rw] pool_id
@@ -1757,7 +1842,7 @@ module Aws::StorageGateway
1757
1842
  # (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the
1758
1843
  # pool.
1759
1844
  #
1760
- # Valid values: "GLACIER", "DEEP\_ARCHIVE"
1845
+ # Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
1761
1846
  # @return [String]
1762
1847
  #
1763
1848
  # @!attribute [rw] tags
@@ -1784,6 +1869,7 @@ module Aws::StorageGateway
1784
1869
  :kms_key,
1785
1870
  :pool_id,
1786
1871
  :tags)
1872
+ SENSITIVE = []
1787
1873
  include Aws::Structure
1788
1874
  end
1789
1875
 
@@ -1798,6 +1884,7 @@ module Aws::StorageGateway
1798
1884
  #
1799
1885
  class CreateTapesOutput < Struct.new(
1800
1886
  :tape_arns)
1887
+ SENSITIVE = []
1801
1888
  include Aws::Structure
1802
1889
  end
1803
1890
 
@@ -1818,6 +1905,7 @@ module Aws::StorageGateway
1818
1905
  #
1819
1906
  class DeleteAutomaticTapeCreationPolicyInput < Struct.new(
1820
1907
  :gateway_arn)
1908
+ SENSITIVE = []
1821
1909
  include Aws::Structure
1822
1910
  end
1823
1911
 
@@ -1831,6 +1919,7 @@ module Aws::StorageGateway
1831
1919
  #
1832
1920
  class DeleteAutomaticTapeCreationPolicyOutput < Struct.new(
1833
1921
  :gateway_arn)
1922
+ SENSITIVE = []
1834
1923
  include Aws::Structure
1835
1924
  end
1836
1925
 
@@ -1858,7 +1947,7 @@ module Aws::StorageGateway
1858
1947
  # One of the BandwidthType values that indicates the gateway bandwidth
1859
1948
  # rate limit to delete.
1860
1949
  #
1861
- # Valid Values: `Upload`, `Download`, `All`.
1950
+ # Valid Values: `Upload` \| `Download` \| `All`
1862
1951
  # @return [String]
1863
1952
  #
1864
1953
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteBandwidthRateLimitInput AWS API Documentation
@@ -1866,6 +1955,7 @@ module Aws::StorageGateway
1866
1955
  class DeleteBandwidthRateLimitInput < Struct.new(
1867
1956
  :gateway_arn,
1868
1957
  :bandwidth_type)
1958
+ SENSITIVE = []
1869
1959
  include Aws::Structure
1870
1960
  end
1871
1961
 
@@ -1882,6 +1972,7 @@ module Aws::StorageGateway
1882
1972
  #
1883
1973
  class DeleteBandwidthRateLimitOutput < Struct.new(
1884
1974
  :gateway_arn)
1975
+ SENSITIVE = []
1885
1976
  include Aws::Structure
1886
1977
  end
1887
1978
 
@@ -1914,6 +2005,7 @@ module Aws::StorageGateway
1914
2005
  class DeleteChapCredentialsInput < Struct.new(
1915
2006
  :target_arn,
1916
2007
  :initiator_name)
2008
+ SENSITIVE = []
1917
2009
  include Aws::Structure
1918
2010
  end
1919
2011
 
@@ -1932,6 +2024,7 @@ module Aws::StorageGateway
1932
2024
  class DeleteChapCredentialsOutput < Struct.new(
1933
2025
  :target_arn,
1934
2026
  :initiator_name)
2027
+ SENSITIVE = []
1935
2028
  include Aws::Structure
1936
2029
  end
1937
2030
 
@@ -1950,11 +2043,13 @@ module Aws::StorageGateway
1950
2043
  # @return [String]
1951
2044
  #
1952
2045
  # @!attribute [rw] force_delete
1953
- # If this value is set to true, the operation deletes a file share
2046
+ # If this value is set to `true`, the operation deletes a file share
1954
2047
  # immediately and aborts all data uploads to AWS. Otherwise, the file
1955
2048
  # share is not deleted until all data is uploaded to AWS. This process
1956
2049
  # aborts the data upload process, and the file share enters the
1957
- # FORCE\_DELETING status.
2050
+ # `FORCE_DELETING` status.
2051
+ #
2052
+ # Valid Values: `true` \| `false`
1958
2053
  # @return [Boolean]
1959
2054
  #
1960
2055
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteFileShareInput AWS API Documentation
@@ -1962,6 +2057,7 @@ module Aws::StorageGateway
1962
2057
  class DeleteFileShareInput < Struct.new(
1963
2058
  :file_share_arn,
1964
2059
  :force_delete)
2060
+ SENSITIVE = []
1965
2061
  include Aws::Structure
1966
2062
  end
1967
2063
 
@@ -1975,6 +2071,7 @@ module Aws::StorageGateway
1975
2071
  #
1976
2072
  class DeleteFileShareOutput < Struct.new(
1977
2073
  :file_share_arn)
2074
+ SENSITIVE = []
1978
2075
  include Aws::Structure
1979
2076
  end
1980
2077
 
@@ -1997,6 +2094,7 @@ module Aws::StorageGateway
1997
2094
  #
1998
2095
  class DeleteGatewayInput < Struct.new(
1999
2096
  :gateway_arn)
2097
+ SENSITIVE = []
2000
2098
  include Aws::Structure
2001
2099
  end
2002
2100
 
@@ -2012,6 +2110,7 @@ module Aws::StorageGateway
2012
2110
  #
2013
2111
  class DeleteGatewayOutput < Struct.new(
2014
2112
  :gateway_arn)
2113
+ SENSITIVE = []
2015
2114
  include Aws::Structure
2016
2115
  end
2017
2116
 
@@ -2030,6 +2129,7 @@ module Aws::StorageGateway
2030
2129
  #
2031
2130
  class DeleteSnapshotScheduleInput < Struct.new(
2032
2131
  :volume_arn)
2132
+ SENSITIVE = []
2033
2133
  include Aws::Structure
2034
2134
  end
2035
2135
 
@@ -2041,6 +2141,7 @@ module Aws::StorageGateway
2041
2141
  #
2042
2142
  class DeleteSnapshotScheduleOutput < Struct.new(
2043
2143
  :volume_arn)
2144
+ SENSITIVE = []
2044
2145
  include Aws::Structure
2045
2146
  end
2046
2147
 
@@ -2062,6 +2163,7 @@ module Aws::StorageGateway
2062
2163
  #
2063
2164
  class DeleteTapeArchiveInput < Struct.new(
2064
2165
  :tape_arn)
2166
+ SENSITIVE = []
2065
2167
  include Aws::Structure
2066
2168
  end
2067
2169
 
@@ -2076,6 +2178,7 @@ module Aws::StorageGateway
2076
2178
  #
2077
2179
  class DeleteTapeArchiveOutput < Struct.new(
2078
2180
  :tape_arn)
2181
+ SENSITIVE = []
2079
2182
  include Aws::Structure
2080
2183
  end
2081
2184
 
@@ -2105,6 +2208,7 @@ module Aws::StorageGateway
2105
2208
  class DeleteTapeInput < Struct.new(
2106
2209
  :gateway_arn,
2107
2210
  :tape_arn)
2211
+ SENSITIVE = []
2108
2212
  include Aws::Structure
2109
2213
  end
2110
2214
 
@@ -2118,6 +2222,7 @@ module Aws::StorageGateway
2118
2222
  #
2119
2223
  class DeleteTapeOutput < Struct.new(
2120
2224
  :tape_arn)
2225
+ SENSITIVE = []
2121
2226
  include Aws::Structure
2122
2227
  end
2123
2228
 
@@ -2139,11 +2244,12 @@ module Aws::StorageGateway
2139
2244
  #
2140
2245
  class DeleteVolumeInput < Struct.new(
2141
2246
  :volume_arn)
2247
+ SENSITIVE = []
2142
2248
  include Aws::Structure
2143
2249
  end
2144
2250
 
2145
2251
  # A JSON object containing the Amazon Resource Name (ARN) of the storage
2146
- # volume that was deleted
2252
+ # volume that was deleted.
2147
2253
  #
2148
2254
  # @!attribute [rw] volume_arn
2149
2255
  # The Amazon Resource Name (ARN) of the storage volume that was
@@ -2154,6 +2260,7 @@ module Aws::StorageGateway
2154
2260
  #
2155
2261
  class DeleteVolumeOutput < Struct.new(
2156
2262
  :volume_arn)
2263
+ SENSITIVE = []
2157
2264
  include Aws::Structure
2158
2265
  end
2159
2266
 
@@ -2174,6 +2281,7 @@ module Aws::StorageGateway
2174
2281
  #
2175
2282
  class DescribeAvailabilityMonitorTestInput < Struct.new(
2176
2283
  :gateway_arn)
2284
+ SENSITIVE = []
2177
2285
  include Aws::Structure
2178
2286
  end
2179
2287
 
@@ -2199,6 +2307,7 @@ module Aws::StorageGateway
2199
2307
  :gateway_arn,
2200
2308
  :status,
2201
2309
  :start_time)
2310
+ SENSITIVE = []
2202
2311
  include Aws::Structure
2203
2312
  end
2204
2313
 
@@ -2222,6 +2331,7 @@ module Aws::StorageGateway
2222
2331
  #
2223
2332
  class DescribeBandwidthRateLimitInput < Struct.new(
2224
2333
  :gateway_arn)
2334
+ SENSITIVE = []
2225
2335
  include Aws::Structure
2226
2336
  end
2227
2337
 
@@ -2251,6 +2361,7 @@ module Aws::StorageGateway
2251
2361
  :gateway_arn,
2252
2362
  :average_upload_rate_limit_in_bits_per_sec,
2253
2363
  :average_download_rate_limit_in_bits_per_sec)
2364
+ SENSITIVE = []
2254
2365
  include Aws::Structure
2255
2366
  end
2256
2367
 
@@ -2271,6 +2382,7 @@ module Aws::StorageGateway
2271
2382
  #
2272
2383
  class DescribeCacheInput < Struct.new(
2273
2384
  :gateway_arn)
2385
+ SENSITIVE = []
2274
2386
  include Aws::Structure
2275
2387
  end
2276
2388
 
@@ -2324,6 +2436,7 @@ module Aws::StorageGateway
2324
2436
  :cache_dirty_percentage,
2325
2437
  :cache_hit_percentage,
2326
2438
  :cache_miss_percentage)
2439
+ SENSITIVE = []
2327
2440
  include Aws::Structure
2328
2441
  end
2329
2442
 
@@ -2345,6 +2458,7 @@ module Aws::StorageGateway
2345
2458
  #
2346
2459
  class DescribeCachediSCSIVolumesInput < Struct.new(
2347
2460
  :volume_arns)
2461
+ SENSITIVE = []
2348
2462
  include Aws::Structure
2349
2463
  end
2350
2464
 
@@ -2359,6 +2473,7 @@ module Aws::StorageGateway
2359
2473
  #
2360
2474
  class DescribeCachediSCSIVolumesOutput < Struct.new(
2361
2475
  :cached_iscsi_volumes)
2476
+ SENSITIVE = []
2362
2477
  include Aws::Structure
2363
2478
  end
2364
2479
 
@@ -2382,10 +2497,11 @@ module Aws::StorageGateway
2382
2497
  #
2383
2498
  class DescribeChapCredentialsInput < Struct.new(
2384
2499
  :target_arn)
2500
+ SENSITIVE = []
2385
2501
  include Aws::Structure
2386
2502
  end
2387
2503
 
2388
- # A JSON object containing a .
2504
+ # A JSON object containing the following fields:
2389
2505
  #
2390
2506
  # @!attribute [rw] chap_credentials
2391
2507
  # An array of ChapInfo objects that represent CHAP credentials. Each
@@ -2413,6 +2529,7 @@ module Aws::StorageGateway
2413
2529
  #
2414
2530
  class DescribeChapCredentialsOutput < Struct.new(
2415
2531
  :chap_credentials)
2532
+ SENSITIVE = []
2416
2533
  include Aws::Structure
2417
2534
  end
2418
2535
 
@@ -2435,6 +2552,7 @@ module Aws::StorageGateway
2435
2552
  #
2436
2553
  class DescribeGatewayInformationInput < Struct.new(
2437
2554
  :gateway_arn)
2555
+ SENSITIVE = []
2438
2556
  include Aws::Structure
2439
2557
  end
2440
2558
 
@@ -2515,6 +2633,12 @@ module Aws::StorageGateway
2515
2633
  # The type of hypervisor environment used by the host.
2516
2634
  # @return [String]
2517
2635
  #
2636
+ # @!attribute [rw] endpoint_type
2637
+ # The type of endpoint for your gateway.
2638
+ #
2639
+ # Valid Values: `STANDARD` \| `FIPS`
2640
+ # @return [String]
2641
+ #
2518
2642
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeGatewayInformationOutput AWS API Documentation
2519
2643
  #
2520
2644
  class DescribeGatewayInformationOutput < Struct.new(
@@ -2532,7 +2656,9 @@ module Aws::StorageGateway
2532
2656
  :tags,
2533
2657
  :vpc_endpoint,
2534
2658
  :cloud_watch_log_group_arn,
2535
- :host_environment)
2659
+ :host_environment,
2660
+ :endpoint_type)
2661
+ SENSITIVE = []
2536
2662
  include Aws::Structure
2537
2663
  end
2538
2664
 
@@ -2556,6 +2682,7 @@ module Aws::StorageGateway
2556
2682
  #
2557
2683
  class DescribeMaintenanceStartTimeInput < Struct.new(
2558
2684
  :gateway_arn)
2685
+ SENSITIVE = []
2559
2686
  include Aws::Structure
2560
2687
  end
2561
2688
 
@@ -2600,10 +2727,6 @@ module Aws::StorageGateway
2600
2727
  # represented as an ordinal number from 1 to 28, where 1 represents
2601
2728
  # the first day of the month and 28 represents the last day of the
2602
2729
  # month.
2603
- #
2604
- # <note markdown="1"> This value is only available for tape and volume gateways.
2605
- #
2606
- # </note>
2607
2730
  # @return [Integer]
2608
2731
  #
2609
2732
  # @!attribute [rw] timezone
@@ -2621,6 +2744,7 @@ module Aws::StorageGateway
2621
2744
  :day_of_week,
2622
2745
  :day_of_month,
2623
2746
  :timezone)
2747
+ SENSITIVE = []
2624
2748
  include Aws::Structure
2625
2749
  end
2626
2750
 
@@ -2642,6 +2766,7 @@ module Aws::StorageGateway
2642
2766
  #
2643
2767
  class DescribeNFSFileSharesInput < Struct.new(
2644
2768
  :file_share_arn_list)
2769
+ SENSITIVE = []
2645
2770
  include Aws::Structure
2646
2771
  end
2647
2772
 
@@ -2655,6 +2780,7 @@ module Aws::StorageGateway
2655
2780
  #
2656
2781
  class DescribeNFSFileSharesOutput < Struct.new(
2657
2782
  :nfs_file_share_info_list)
2783
+ SENSITIVE = []
2658
2784
  include Aws::Structure
2659
2785
  end
2660
2786
 
@@ -2676,6 +2802,7 @@ module Aws::StorageGateway
2676
2802
  #
2677
2803
  class DescribeSMBFileSharesInput < Struct.new(
2678
2804
  :file_share_arn_list)
2805
+ SENSITIVE = []
2679
2806
  include Aws::Structure
2680
2807
  end
2681
2808
 
@@ -2689,6 +2816,7 @@ module Aws::StorageGateway
2689
2816
  #
2690
2817
  class DescribeSMBFileSharesOutput < Struct.new(
2691
2818
  :smb_file_share_info_list)
2819
+ SENSITIVE = []
2692
2820
  include Aws::Structure
2693
2821
  end
2694
2822
 
@@ -2709,6 +2837,7 @@ module Aws::StorageGateway
2709
2837
  #
2710
2838
  class DescribeSMBSettingsInput < Struct.new(
2711
2839
  :gateway_arn)
2840
+ SENSITIVE = []
2712
2841
  include Aws::Structure
2713
2842
  end
2714
2843
 
@@ -2726,49 +2855,52 @@ module Aws::StorageGateway
2726
2855
  # Indicates the status of a gateway that is a member of the Active
2727
2856
  # Directory domain.
2728
2857
  #
2729
- # * ACCESS\_DENIED: Indicates that the `JoinDomain` operation failed
2858
+ # * `ACCESS_DENIED`\: Indicates that the `JoinDomain` operation failed
2730
2859
  # due to an authentication error.
2731
2860
  #
2732
- # * DETACHED: Indicates that gateway is not joined to a domain.
2861
+ # * `DETACHED`\: Indicates that gateway is not joined to a domain.
2733
2862
  #
2734
- # * JOINED: Indicates that the gateway has successfully joined a
2863
+ # * `JOINED`\: Indicates that the gateway has successfully joined a
2735
2864
  # domain.
2736
2865
  #
2737
- # * JOINING: Indicates that a `JoinDomain` operation is in progress.
2866
+ # * `JOINING`\: Indicates that a `JoinDomain` operation is in
2867
+ # progress.
2738
2868
  #
2739
- # * NETWORK\_ERROR: Indicates that `JoinDomain` operation failed due
2869
+ # * `NETWORK_ERROR`\: Indicates that `JoinDomain` operation failed due
2740
2870
  # to a network or connectivity error.
2741
2871
  #
2742
- # * TIMEOUT: Indicates that the `JoinDomain` operation failed because
2743
- # the operation didn't complete within the allotted time.
2872
+ # * `TIMEOUT`\: Indicates that the `JoinDomain` operation failed
2873
+ # because the operation didn't complete within the allotted time.
2744
2874
  #
2745
- # * UNKNOWN\_ERROR: Indicates that the `JoinDomain` operation failed
2875
+ # * `UNKNOWN_ERROR`\: Indicates that the `JoinDomain` operation failed
2746
2876
  # due to another type of error.
2747
2877
  # @return [String]
2748
2878
  #
2749
2879
  # @!attribute [rw] smb_guest_password_set
2750
- # This value is true if a password for the guest user smbguest is
2751
- # set, and otherwise false.
2880
+ # This value is `true` if a password for the guest user `smbguest` is
2881
+ # set, otherwise `false`.
2882
+ #
2883
+ # Valid Values: `true` \| `false`
2752
2884
  # @return [Boolean]
2753
2885
  #
2754
2886
  # @!attribute [rw] smb_security_strategy
2755
2887
  # The type of security strategy that was specified for file gateway.
2756
2888
  #
2757
- # ClientSpecified: if you use this option, requests are established
2758
- # based on what is negotiated by the client. This option is
2759
- # recommended when you want to maximize compatibility across different
2760
- # clients in your environment.
2889
+ # * `ClientSpecified`\: If you use this option, requests are
2890
+ # established based on what is negotiated by the client. This option
2891
+ # is recommended when you want to maximize compatibility across
2892
+ # different clients in your environment.
2761
2893
  #
2762
- # MandatorySigning: if you use this option, file gateway only allows
2763
- # connections from SMBv2 or SMBv3 clients that have signing enabled.
2764
- # This option works with SMB clients on Microsoft Windows Vista,
2765
- # Windows Server 2008 or newer.
2894
+ # * `MandatorySigning`\: If you use this option, file gateway only
2895
+ # allows connections from SMBv2 or SMBv3 clients that have signing
2896
+ # enabled. This option works with SMB clients on Microsoft Windows
2897
+ # Vista, Windows Server 2008 or newer.
2766
2898
  #
2767
- # MandatoryEncryption: if you use this option, file gateway only
2768
- # allows connections from SMBv3 clients that have encryption enabled.
2769
- # This option is highly recommended for environments that handle
2770
- # sensitive data. This option works with SMB clients on Microsoft
2771
- # Windows 8, Windows Server 2012 or newer.
2899
+ # * `MandatoryEncryption`\: If you use this option, file gateway only
2900
+ # allows connections from SMBv3 clients that have encryption
2901
+ # enabled. This option is highly recommended for environments that
2902
+ # handle sensitive data. This option works with SMB clients on
2903
+ # Microsoft Windows 8, Windows Server 2012 or newer.
2772
2904
  # @return [String]
2773
2905
  #
2774
2906
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSMBSettingsOutput AWS API Documentation
@@ -2779,6 +2911,7 @@ module Aws::StorageGateway
2779
2911
  :active_directory_status,
2780
2912
  :smb_guest_password_set,
2781
2913
  :smb_security_strategy)
2914
+ SENSITIVE = []
2782
2915
  include Aws::Structure
2783
2916
  end
2784
2917
 
@@ -2801,6 +2934,7 @@ module Aws::StorageGateway
2801
2934
  #
2802
2935
  class DescribeSnapshotScheduleInput < Struct.new(
2803
2936
  :volume_arn)
2937
+ SENSITIVE = []
2804
2938
  include Aws::Structure
2805
2939
  end
2806
2940
 
@@ -2843,6 +2977,7 @@ module Aws::StorageGateway
2843
2977
  :description,
2844
2978
  :timezone,
2845
2979
  :tags)
2980
+ SENSITIVE = []
2846
2981
  include Aws::Structure
2847
2982
  end
2848
2983
 
@@ -2867,6 +3002,7 @@ module Aws::StorageGateway
2867
3002
  #
2868
3003
  class DescribeStorediSCSIVolumesInput < Struct.new(
2869
3004
  :volume_arns)
3005
+ SENSITIVE = []
2870
3006
  include Aws::Structure
2871
3007
  end
2872
3008
 
@@ -2874,62 +3010,60 @@ module Aws::StorageGateway
2874
3010
  # Describes a single unit of output from DescribeStorediSCSIVolumes.
2875
3011
  # The following fields are returned:
2876
3012
  #
2877
- # * **ChapEnabled**\: Indicates whether mutual CHAP is enabled for the
3013
+ # * `ChapEnabled`\: Indicates whether mutual CHAP is enabled for the
2878
3014
  # iSCSI target.
2879
3015
  #
2880
- # * **LunNumber**\: The logical disk number.
3016
+ # * `LunNumber`\: The logical disk number.
2881
3017
  #
2882
- # * **NetworkInterfaceId**\: The network interface ID of the stored
3018
+ # * `NetworkInterfaceId`\: The network interface ID of the stored
2883
3019
  # volume that initiator use to map the stored volume as an iSCSI
2884
3020
  # target.
2885
3021
  #
2886
- # * **NetworkInterfacePort**\: The port used to communicate with iSCSI
3022
+ # * `NetworkInterfacePort`\: The port used to communicate with iSCSI
2887
3023
  # targets.
2888
3024
  #
2889
- # * **PreservedExistingData**\: Indicates if when the stored volume
2890
- # was created, existing data on the underlying local disk was
2891
- # preserved.
3025
+ # * `PreservedExistingData`\: Indicates when the stored volume was
3026
+ # created, existing data on the underlying local disk was preserved.
2892
3027
  #
2893
- # * **SourceSnapshotId**\: If the stored volume was created from a
3028
+ # * `SourceSnapshotId`\: If the stored volume was created from a
2894
3029
  # snapshot, this field contains the snapshot ID used, e.g.
2895
- # snap-1122aabb. Otherwise, this field is not included.
3030
+ # `snap-1122aabb`. Otherwise, this field is not included.
2896
3031
  #
2897
- # * **StorediSCSIVolumes**\: An array of StorediSCSIVolume objects
2898
- # where each object contains metadata about one stored volume.
3032
+ # * `StorediSCSIVolumes`\: An array of StorediSCSIVolume objects where
3033
+ # each object contains metadata about one stored volume.
2899
3034
  #
2900
- # * **TargetARN**\: The Amazon Resource Name (ARN) of the volume
2901
- # target.
3035
+ # * `TargetARN`\: The Amazon Resource Name (ARN) of the volume target.
2902
3036
  #
2903
- # * **VolumeARN**\: The Amazon Resource Name (ARN) of the stored
2904
- # volume.
3037
+ # * `VolumeARN`\: The Amazon Resource Name (ARN) of the stored volume.
2905
3038
  #
2906
- # * **VolumeDiskId**\: The disk ID of the local disk that was
2907
- # specified in the CreateStorediSCSIVolume operation.
3039
+ # * `VolumeDiskId`\: The disk ID of the local disk that was specified
3040
+ # in the CreateStorediSCSIVolume operation.
2908
3041
  #
2909
- # * **VolumeId**\: The unique identifier of the storage volume, e.g.
2910
- # vol-1122AABB.
3042
+ # * `VolumeId`\: The unique identifier of the storage volume, e.g.
3043
+ # `vol-1122AABB`.
2911
3044
  #
2912
- # * **VolumeiSCSIAttributes**\: An VolumeiSCSIAttributes object that
3045
+ # * `VolumeiSCSIAttributes`\: An VolumeiSCSIAttributes object that
2913
3046
  # represents a collection of iSCSI attributes for one stored volume.
2914
3047
  #
2915
- # * **VolumeProgress**\: Represents the percentage complete if the
3048
+ # * `VolumeProgress`\: Represents the percentage complete if the
2916
3049
  # volume is restoring or bootstrapping that represents the percent
2917
3050
  # of data transferred. This field does not appear in the response if
2918
3051
  # the stored volume is not restoring or bootstrapping.
2919
3052
  #
2920
- # * **VolumeSizeInBytes**\: The size of the volume in bytes.
3053
+ # * `VolumeSizeInBytes`\: The size of the volume in bytes.
2921
3054
  #
2922
- # * **VolumeStatus**\: One of the `VolumeStatus` values that indicates
3055
+ # * `VolumeStatus`\: One of the `VolumeStatus` values that indicates
2923
3056
  # the state of the volume.
2924
3057
  #
2925
- # * **VolumeType**\: One of the enumeration values describing the type
2926
- # of the volume. Currently, on STORED volumes are supported.
3058
+ # * `VolumeType`\: One of the enumeration values describing the type
3059
+ # of the volume. Currently, only `STORED` volumes are supported.
2927
3060
  # @return [Array<Types::StorediSCSIVolume>]
2928
3061
  #
2929
3062
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeStorediSCSIVolumesOutput AWS API Documentation
2930
3063
  #
2931
3064
  class DescribeStorediSCSIVolumesOutput < Struct.new(
2932
3065
  :stored_iscsi_volumes)
3066
+ SENSITIVE = []
2933
3067
  include Aws::Structure
2934
3068
  end
2935
3069
 
@@ -2965,6 +3099,7 @@ module Aws::StorageGateway
2965
3099
  :tape_arns,
2966
3100
  :marker,
2967
3101
  :limit)
3102
+ SENSITIVE = []
2968
3103
  include Aws::Structure
2969
3104
  end
2970
3105
 
@@ -2975,7 +3110,7 @@ module Aws::StorageGateway
2975
3110
  # The description includes of the Amazon Resource Name (ARN) of the
2976
3111
  # virtual tapes. The information returned includes the Amazon Resource
2977
3112
  # Names (ARNs) of the tapes, size of the tapes, status of the tapes,
2978
- # progress of the description and tape barcode.
3113
+ # progress of the description, and tape barcode.
2979
3114
  # @return [Array<Types::TapeArchive>]
2980
3115
  #
2981
3116
  # @!attribute [rw] marker
@@ -2991,6 +3126,7 @@ module Aws::StorageGateway
2991
3126
  class DescribeTapeArchivesOutput < Struct.new(
2992
3127
  :tape_archives,
2993
3128
  :marker)
3129
+ SENSITIVE = []
2994
3130
  include Aws::Structure
2995
3131
  end
2996
3132
 
@@ -3027,6 +3163,7 @@ module Aws::StorageGateway
3027
3163
  :gateway_arn,
3028
3164
  :marker,
3029
3165
  :limit)
3166
+ SENSITIVE = []
3030
3167
  include Aws::Structure
3031
3168
  end
3032
3169
 
@@ -3058,6 +3195,7 @@ module Aws::StorageGateway
3058
3195
  :gateway_arn,
3059
3196
  :tape_recovery_point_infos,
3060
3197
  :marker)
3198
+ SENSITIVE = []
3061
3199
  include Aws::Structure
3062
3200
  end
3063
3201
 
@@ -3110,6 +3248,7 @@ module Aws::StorageGateway
3110
3248
  :tape_arns,
3111
3249
  :marker,
3112
3250
  :limit)
3251
+ SENSITIVE = []
3113
3252
  include Aws::Structure
3114
3253
  end
3115
3254
 
@@ -3132,6 +3271,7 @@ module Aws::StorageGateway
3132
3271
  class DescribeTapesOutput < Struct.new(
3133
3272
  :tapes,
3134
3273
  :marker)
3274
+ SENSITIVE = []
3135
3275
  include Aws::Structure
3136
3276
  end
3137
3277
 
@@ -3152,6 +3292,7 @@ module Aws::StorageGateway
3152
3292
  #
3153
3293
  class DescribeUploadBufferInput < Struct.new(
3154
3294
  :gateway_arn)
3295
+ SENSITIVE = []
3155
3296
  include Aws::Structure
3156
3297
  end
3157
3298
 
@@ -3185,6 +3326,7 @@ module Aws::StorageGateway
3185
3326
  :disk_ids,
3186
3327
  :upload_buffer_used_in_bytes,
3187
3328
  :upload_buffer_allocated_in_bytes)
3329
+ SENSITIVE = []
3188
3330
  include Aws::Structure
3189
3331
  end
3190
3332
 
@@ -3234,6 +3376,7 @@ module Aws::StorageGateway
3234
3376
  :vtl_device_arns,
3235
3377
  :marker,
3236
3378
  :limit)
3379
+ SENSITIVE = []
3237
3380
  include Aws::Structure
3238
3381
  end
3239
3382
 
@@ -3264,6 +3407,7 @@ module Aws::StorageGateway
3264
3407
  :gateway_arn,
3265
3408
  :vtl_devices,
3266
3409
  :marker)
3410
+ SENSITIVE = []
3267
3411
  include Aws::Structure
3268
3412
  end
3269
3413
 
@@ -3287,6 +3431,7 @@ module Aws::StorageGateway
3287
3431
  #
3288
3432
  class DescribeWorkingStorageInput < Struct.new(
3289
3433
  :gateway_arn)
3434
+ SENSITIVE = []
3290
3435
  include Aws::Structure
3291
3436
  end
3292
3437
 
@@ -3322,6 +3467,7 @@ module Aws::StorageGateway
3322
3467
  :disk_ids,
3323
3468
  :working_storage_used_in_bytes,
3324
3469
  :working_storage_allocated_in_bytes)
3470
+ SENSITIVE = []
3325
3471
  include Aws::Structure
3326
3472
  end
3327
3473
 
@@ -3345,6 +3491,8 @@ module Aws::StorageGateway
3345
3491
  # volume and detach the volume. The default is `false`. If this value
3346
3492
  # is set to `false`, you must manually disconnect the iSCSI connection
3347
3493
  # from the target volume.
3494
+ #
3495
+ # Valid Values: `true` \| `false`
3348
3496
  # @return [Boolean]
3349
3497
  #
3350
3498
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DetachVolumeInput AWS API Documentation
@@ -3352,6 +3500,7 @@ module Aws::StorageGateway
3352
3500
  class DetachVolumeInput < Struct.new(
3353
3501
  :volume_arn,
3354
3502
  :force_detach)
3503
+ SENSITIVE = []
3355
3504
  include Aws::Structure
3356
3505
  end
3357
3506
 
@@ -3365,6 +3514,7 @@ module Aws::StorageGateway
3365
3514
  #
3366
3515
  class DetachVolumeOutput < Struct.new(
3367
3516
  :volume_arn)
3517
+ SENSITIVE = []
3368
3518
  include Aws::Structure
3369
3519
  end
3370
3520
 
@@ -3394,6 +3544,7 @@ module Aws::StorageGateway
3394
3544
  :network_interface_id,
3395
3545
  :network_interface_port,
3396
3546
  :chap_enabled)
3547
+ SENSITIVE = []
3397
3548
  include Aws::Structure
3398
3549
  end
3399
3550
 
@@ -3416,6 +3567,7 @@ module Aws::StorageGateway
3416
3567
  #
3417
3568
  class DisableGatewayInput < Struct.new(
3418
3569
  :gateway_arn)
3570
+ SENSITIVE = []
3419
3571
  include Aws::Structure
3420
3572
  end
3421
3573
 
@@ -3429,6 +3581,7 @@ module Aws::StorageGateway
3429
3581
  #
3430
3582
  class DisableGatewayOutput < Struct.new(
3431
3583
  :gateway_arn)
3584
+ SENSITIVE = []
3432
3585
  include Aws::Structure
3433
3586
  end
3434
3587
 
@@ -3458,8 +3611,9 @@ module Aws::StorageGateway
3458
3611
  #
3459
3612
  # @!attribute [rw] disk_allocation_type
3460
3613
  # One of the `DiskAllocationType` enumeration values that identifies
3461
- # how a local disk is used. Valid values: `UPLOAD_BUFFER`,
3462
- # `CACHE_STORAGE`
3614
+ # how a local disk is used.
3615
+ #
3616
+ # Valid Values: `UPLOAD_BUFFER` \| `CACHE_STORAGE`
3463
3617
  # @return [String]
3464
3618
  #
3465
3619
  # @!attribute [rw] disk_allocation_resource
@@ -3484,6 +3638,7 @@ module Aws::StorageGateway
3484
3638
  :disk_allocation_type,
3485
3639
  :disk_allocation_resource,
3486
3640
  :disk_attribute_list)
3641
+ SENSITIVE = []
3487
3642
  include Aws::Structure
3488
3643
  end
3489
3644
 
@@ -3502,8 +3657,9 @@ module Aws::StorageGateway
3502
3657
  # @return [String]
3503
3658
  #
3504
3659
  # @!attribute [rw] file_share_status
3505
- # The status of the file share. Possible values are `CREATING`,
3506
- # `UPDATING`, `AVAILABLE` and `DELETING`.
3660
+ # The status of the file share.
3661
+ #
3662
+ # Valid Values: `CREATING` \| `UPDATING` \| `AVAILABLE` \| `DELETING`
3507
3663
  # @return [String]
3508
3664
  #
3509
3665
  # @!attribute [rw] gateway_arn
@@ -3520,6 +3676,7 @@ module Aws::StorageGateway
3520
3676
  :file_share_id,
3521
3677
  :file_share_status,
3522
3678
  :gateway_arn)
3679
+ SENSITIVE = []
3523
3680
  include Aws::Structure
3524
3681
  end
3525
3682
 
@@ -3544,7 +3701,7 @@ module Aws::StorageGateway
3544
3701
  # @!attribute [rw] gateway_operational_state
3545
3702
  # The state of the gateway.
3546
3703
  #
3547
- # Valid Values: DISABLED or ACTIVE
3704
+ # Valid Values: `DISABLED` \| `ACTIVE`
3548
3705
  # @return [String]
3549
3706
  #
3550
3707
  # @!attribute [rw] gateway_name
@@ -3570,6 +3727,7 @@ module Aws::StorageGateway
3570
3727
  :gateway_name,
3571
3728
  :ec2_instance_id,
3572
3729
  :ec2_instance_region)
3730
+ SENSITIVE = []
3573
3731
  include Aws::Structure
3574
3732
  end
3575
3733
 
@@ -3590,6 +3748,7 @@ module Aws::StorageGateway
3590
3748
  class InternalServerError < Struct.new(
3591
3749
  :message,
3592
3750
  :error)
3751
+ SENSITIVE = []
3593
3752
  include Aws::Structure
3594
3753
  end
3595
3754
 
@@ -3610,6 +3769,7 @@ module Aws::StorageGateway
3610
3769
  class InvalidGatewayRequestException < Struct.new(
3611
3770
  :message,
3612
3771
  :error)
3772
+ SENSITIVE = []
3613
3773
  include Aws::Structure
3614
3774
  end
3615
3775
 
@@ -3679,6 +3839,7 @@ module Aws::StorageGateway
3679
3839
  :timeout_in_seconds,
3680
3840
  :user_name,
3681
3841
  :password)
3842
+ SENSITIVE = [:password]
3682
3843
  include Aws::Structure
3683
3844
  end
3684
3845
 
@@ -3693,23 +3854,24 @@ module Aws::StorageGateway
3693
3854
  # Indicates the status of the gateway as a member of the Active
3694
3855
  # Directory domain.
3695
3856
  #
3696
- # * ACCESS\_DENIED: Indicates that the `JoinDomain` operation failed
3857
+ # * `ACCESS_DENIED`\: Indicates that the `JoinDomain` operation failed
3697
3858
  # due to an authentication error.
3698
3859
  #
3699
- # * DETACHED: Indicates that gateway is not joined to a domain.
3860
+ # * `DETACHED`\: Indicates that gateway is not joined to a domain.
3700
3861
  #
3701
- # * JOINED: Indicates that the gateway has successfully joined a
3862
+ # * `JOINED`\: Indicates that the gateway has successfully joined a
3702
3863
  # domain.
3703
3864
  #
3704
- # * JOINING: Indicates that a `JoinDomain` operation is in progress.
3865
+ # * `JOINING`\: Indicates that a `JoinDomain` operation is in
3866
+ # progress.
3705
3867
  #
3706
- # * NETWORK\_ERROR: Indicates that `JoinDomain` operation failed due
3868
+ # * `NETWORK_ERROR`\: Indicates that `JoinDomain` operation failed due
3707
3869
  # to a network or connectivity error.
3708
3870
  #
3709
- # * TIMEOUT: Indicates that the `JoinDomain` operation failed because
3710
- # the operation didn't complete within the allotted time.
3871
+ # * `TIMEOUT`\: Indicates that the `JoinDomain` operation failed
3872
+ # because the operation didn't complete within the allotted time.
3711
3873
  #
3712
- # * UNKNOWN\_ERROR: Indicates that the `JoinDomain` operation failed
3874
+ # * `UNKNOWN_ERROR`\: Indicates that the `JoinDomain` operation failed
3713
3875
  # due to another type of error.
3714
3876
  # @return [String]
3715
3877
  #
@@ -3718,6 +3880,7 @@ module Aws::StorageGateway
3718
3880
  class JoinDomainOutput < Struct.new(
3719
3881
  :gateway_arn,
3720
3882
  :active_directory_status)
3883
+ SENSITIVE = []
3721
3884
  include Aws::Structure
3722
3885
  end
3723
3886
 
@@ -3738,6 +3901,7 @@ module Aws::StorageGateway
3738
3901
  #
3739
3902
  class ListAutomaticTapeCreationPoliciesInput < Struct.new(
3740
3903
  :gateway_arn)
3904
+ SENSITIVE = []
3741
3905
  include Aws::Structure
3742
3906
  end
3743
3907
 
@@ -3751,6 +3915,7 @@ module Aws::StorageGateway
3751
3915
  #
3752
3916
  class ListAutomaticTapeCreationPoliciesOutput < Struct.new(
3753
3917
  :automatic_tape_creation_policy_infos)
3918
+ SENSITIVE = []
3754
3919
  include Aws::Structure
3755
3920
  end
3756
3921
 
@@ -3788,6 +3953,7 @@ module Aws::StorageGateway
3788
3953
  :gateway_arn,
3789
3954
  :limit,
3790
3955
  :marker)
3956
+ SENSITIVE = []
3791
3957
  include Aws::Structure
3792
3958
  end
3793
3959
 
@@ -3814,6 +3980,7 @@ module Aws::StorageGateway
3814
3980
  :marker,
3815
3981
  :next_marker,
3816
3982
  :file_share_info_list)
3983
+ SENSITIVE = []
3817
3984
  include Aws::Structure
3818
3985
  end
3819
3986
 
@@ -3846,6 +4013,7 @@ module Aws::StorageGateway
3846
4013
  class ListGatewaysInput < Struct.new(
3847
4014
  :marker,
3848
4015
  :limit)
4016
+ SENSITIVE = []
3849
4017
  include Aws::Structure
3850
4018
  end
3851
4019
 
@@ -3864,6 +4032,7 @@ module Aws::StorageGateway
3864
4032
  class ListGatewaysOutput < Struct.new(
3865
4033
  :gateways,
3866
4034
  :marker)
4035
+ SENSITIVE = []
3867
4036
  include Aws::Structure
3868
4037
  end
3869
4038
 
@@ -3887,6 +4056,7 @@ module Aws::StorageGateway
3887
4056
  #
3888
4057
  class ListLocalDisksInput < Struct.new(
3889
4058
  :gateway_arn)
4059
+ SENSITIVE = []
3890
4060
  include Aws::Structure
3891
4061
  end
3892
4062
 
@@ -3909,6 +4079,7 @@ module Aws::StorageGateway
3909
4079
  class ListLocalDisksOutput < Struct.new(
3910
4080
  :gateway_arn,
3911
4081
  :disks)
4082
+ SENSITIVE = []
3912
4083
  include Aws::Structure
3913
4084
  end
3914
4085
 
@@ -3944,6 +4115,7 @@ module Aws::StorageGateway
3944
4115
  :resource_arn,
3945
4116
  :marker,
3946
4117
  :limit)
4118
+ SENSITIVE = []
3947
4119
  include Aws::Structure
3948
4120
  end
3949
4121
 
@@ -3969,6 +4141,7 @@ module Aws::StorageGateway
3969
4141
  :resource_arn,
3970
4142
  :marker,
3971
4143
  :tags)
4144
+ SENSITIVE = []
3972
4145
  include Aws::Structure
3973
4146
  end
3974
4147
 
@@ -4011,6 +4184,7 @@ module Aws::StorageGateway
4011
4184
  :tape_arns,
4012
4185
  :marker,
4013
4186
  :limit)
4187
+ SENSITIVE = []
4014
4188
  include Aws::Structure
4015
4189
  end
4016
4190
 
@@ -4038,6 +4212,7 @@ module Aws::StorageGateway
4038
4212
  class ListTapesOutput < Struct.new(
4039
4213
  :tape_infos,
4040
4214
  :marker)
4215
+ SENSITIVE = []
4041
4216
  include Aws::Structure
4042
4217
  end
4043
4218
 
@@ -4059,6 +4234,7 @@ module Aws::StorageGateway
4059
4234
  #
4060
4235
  class ListVolumeInitiatorsInput < Struct.new(
4061
4236
  :volume_arn)
4237
+ SENSITIVE = []
4062
4238
  include Aws::Structure
4063
4239
  end
4064
4240
 
@@ -4073,6 +4249,7 @@ module Aws::StorageGateway
4073
4249
  #
4074
4250
  class ListVolumeInitiatorsOutput < Struct.new(
4075
4251
  :initiators)
4252
+ SENSITIVE = []
4076
4253
  include Aws::Structure
4077
4254
  end
4078
4255
 
@@ -4093,6 +4270,7 @@ module Aws::StorageGateway
4093
4270
  #
4094
4271
  class ListVolumeRecoveryPointsInput < Struct.new(
4095
4272
  :gateway_arn)
4273
+ SENSITIVE = []
4096
4274
  include Aws::Structure
4097
4275
  end
4098
4276
 
@@ -4111,6 +4289,7 @@ module Aws::StorageGateway
4111
4289
  class ListVolumeRecoveryPointsOutput < Struct.new(
4112
4290
  :gateway_arn,
4113
4291
  :volume_recovery_point_infos)
4292
+ SENSITIVE = []
4114
4293
  include Aws::Structure
4115
4294
  end
4116
4295
 
@@ -4152,6 +4331,7 @@ module Aws::StorageGateway
4152
4331
  :gateway_arn,
4153
4332
  :marker,
4154
4333
  :limit)
4334
+ SENSITIVE = []
4155
4335
  include Aws::Structure
4156
4336
  end
4157
4337
 
@@ -4185,6 +4365,7 @@ module Aws::StorageGateway
4185
4365
  :gateway_arn,
4186
4366
  :marker,
4187
4367
  :volume_infos)
4368
+ SENSITIVE = []
4188
4369
  include Aws::Structure
4189
4370
  end
4190
4371
 
@@ -4206,25 +4387,25 @@ module Aws::StorageGateway
4206
4387
  # }
4207
4388
  #
4208
4389
  # @!attribute [rw] file_mode
4209
- # The Unix file mode in the form "nnnn". For example, "0666"
4390
+ # The Unix file mode in the form "nnnn". For example, `0666`
4210
4391
  # represents the default file mode inside the file share. The default
4211
- # value is 0666.
4392
+ # value is `0666`.
4212
4393
  # @return [String]
4213
4394
  #
4214
4395
  # @!attribute [rw] directory_mode
4215
- # The Unix directory mode in the form "nnnn". For example, "0666"
4396
+ # The Unix directory mode in the form "nnnn". For example, `0666`
4216
4397
  # represents the default access mode for all directories inside the
4217
- # file share. The default value is 0777.
4398
+ # file share. The default value is `0777`.
4218
4399
  # @return [String]
4219
4400
  #
4220
4401
  # @!attribute [rw] group_id
4221
4402
  # The default group ID for the file share (unless the files have
4222
- # another group ID specified). The default value is nfsnobody.
4403
+ # another group ID specified). The default value is `nfsnobody`.
4223
4404
  # @return [Integer]
4224
4405
  #
4225
4406
  # @!attribute [rw] owner_id
4226
4407
  # The default owner ID for files in the file share (unless the files
4227
- # have another owner ID specified). The default value is nfsnobody.
4408
+ # have another owner ID specified). The default value is `nfsnobody`.
4228
4409
  # @return [Integer]
4229
4410
  #
4230
4411
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/NFSFileShareDefaults AWS API Documentation
@@ -4234,6 +4415,7 @@ module Aws::StorageGateway
4234
4415
  :directory_mode,
4235
4416
  :group_id,
4236
4417
  :owner_id)
4418
+ SENSITIVE = []
4237
4419
  include Aws::Structure
4238
4420
  end
4239
4421
 
@@ -4259,8 +4441,9 @@ module Aws::StorageGateway
4259
4441
  # @return [String]
4260
4442
  #
4261
4443
  # @!attribute [rw] file_share_status
4262
- # The status of the file share. Possible values are `CREATING`,
4263
- # `UPDATING`, `AVAILABLE` and `DELETING`.
4444
+ # The status of the file share.
4445
+ #
4446
+ # Valid Values: `CREATING` \| `UPDATING` \| `AVAILABLE` \| `DELETING`
4264
4447
  # @return [String]
4265
4448
  #
4266
4449
  # @!attribute [rw] gateway_arn
@@ -4270,14 +4453,17 @@ module Aws::StorageGateway
4270
4453
  # @return [String]
4271
4454
  #
4272
4455
  # @!attribute [rw] kms_encrypted
4273
- # True to use Amazon S3 server-side encryption with your own AWS KMS
4274
- # key, or false to use a key managed by Amazon S3. Optional.
4456
+ # Set to `true` to use Amazon S3 server-side encryption with your own
4457
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
4458
+ #
4459
+ # Valid Values: `true` \| `false`
4275
4460
  # @return [Boolean]
4276
4461
  #
4277
4462
  # @!attribute [rw] kms_key
4278
- # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
4279
- # server-side encryption. This value can only be set when KMSEncrypted
4280
- # is true. Optional.
4463
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
4464
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway
4465
+ # does not support asymmetric CMKs. This value can only be set when
4466
+ # `KMSEncrypted` is `true`. Optional.
4281
4467
  # @return [String]
4282
4468
  #
4283
4469
  # @!attribute [rw] path
@@ -4296,15 +4482,17 @@ module Aws::StorageGateway
4296
4482
  #
4297
4483
  # @!attribute [rw] default_storage_class
4298
4484
  # The default storage class for objects put into an Amazon S3 bucket
4299
- # by the file gateway. Possible values are `S3_STANDARD`,
4300
- # `S3_STANDARD_IA`, or `S3_ONEZONE_IA`. If this field is not
4301
- # populated, the default value `S3_STANDARD` is used. Optional.
4485
+ # by the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
4486
+ # Optional.
4487
+ #
4488
+ # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
4489
+ # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
4302
4490
  # @return [String]
4303
4491
  #
4304
4492
  # @!attribute [rw] object_acl
4305
- # A value that sets the access control list permission for objects in
4306
- # the S3 bucket that a file gateway puts objects into. The default
4307
- # value is "private".
4493
+ # A value that sets the access control list (ACL) permission for
4494
+ # objects in the S3 bucket that a file gateway puts objects into. The
4495
+ # default value is `private`.
4308
4496
  # @return [String]
4309
4497
  #
4310
4498
  # @!attribute [rw] client_list
@@ -4315,36 +4503,44 @@ module Aws::StorageGateway
4315
4503
  # @!attribute [rw] squash
4316
4504
  # The user mapped to anonymous user. Valid options are the following:
4317
4505
  #
4318
- # * `RootSquash` - Only root is mapped to anonymous user.
4506
+ # * `RootSquash`\: Only root is mapped to anonymous user.
4319
4507
  #
4320
- # * `NoSquash` - No one is mapped to anonymous user
4508
+ # * `NoSquash`\: No one is mapped to anonymous user.
4321
4509
  #
4322
- # * `AllSquash` - Everyone is mapped to anonymous user.
4510
+ # * `AllSquash`\: Everyone is mapped to anonymous user.
4323
4511
  # @return [String]
4324
4512
  #
4325
4513
  # @!attribute [rw] read_only
4326
- # A value that sets the write status of a file share. This value is
4327
- # true if the write status is read-only, and otherwise false.
4514
+ # A value that sets the write status of a file share. Set this value
4515
+ # to `true` to set the write status to read-only, otherwise set to
4516
+ # `false`.
4517
+ #
4518
+ # Valid Values: `true` \| `false`
4328
4519
  # @return [Boolean]
4329
4520
  #
4330
4521
  # @!attribute [rw] guess_mime_type_enabled
4331
4522
  # 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 type
4333
- # guessing, and otherwise to false. The default value is true.
4523
+ # based on file extensions. Set this value to `true` to enable MIME
4524
+ # type guessing, otherwise set to `false`. The default value is
4525
+ # `true`.
4526
+ #
4527
+ # Valid Values: `true` \| `false`
4334
4528
  # @return [Boolean]
4335
4529
  #
4336
4530
  # @!attribute [rw] requester_pays
4337
4531
  # A value that sets who pays the cost of the request and the cost
4338
4532
  # associated with data download from the S3 bucket. If this value is
4339
- # set to true, the requester pays the costs. Otherwise the S3 bucket
4340
- # owner pays. However, the S3 bucket owner always pays the cost of
4341
- # storing data.
4533
+ # set to `true`, the requester pays the costs; otherwise, the S3
4534
+ # bucket owner pays. However, the S3 bucket owner always pays the cost
4535
+ # of storing data.
4342
4536
  #
4343
4537
  # <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
4344
4538
  # file share, so make sure that the configuration on the file share is
4345
4539
  # the same as the S3 bucket configuration.
4346
4540
  #
4347
4541
  # </note>
4542
+ #
4543
+ # Valid Values: `true` \| `false`
4348
4544
  # @return [Boolean]
4349
4545
  #
4350
4546
  # @!attribute [rw] tags
@@ -4375,6 +4571,7 @@ module Aws::StorageGateway
4375
4571
  :guess_mime_type_enabled,
4376
4572
  :requester_pays,
4377
4573
  :tags)
4574
+ SENSITIVE = []
4378
4575
  include Aws::Structure
4379
4576
  end
4380
4577
 
@@ -4403,6 +4600,7 @@ module Aws::StorageGateway
4403
4600
  :ipv_4_address,
4404
4601
  :mac_address,
4405
4602
  :ipv_6_address)
4603
+ SENSITIVE = []
4406
4604
  include Aws::Structure
4407
4605
  end
4408
4606
 
@@ -4421,6 +4619,7 @@ module Aws::StorageGateway
4421
4619
  #
4422
4620
  class NotifyWhenUploadedInput < Struct.new(
4423
4621
  :file_share_arn)
4622
+ SENSITIVE = []
4424
4623
  include Aws::Structure
4425
4624
  end
4426
4625
 
@@ -4438,6 +4637,7 @@ module Aws::StorageGateway
4438
4637
  class NotifyWhenUploadedOutput < Struct.new(
4439
4638
  :file_share_arn,
4440
4639
  :notification_id)
4640
+ SENSITIVE = []
4441
4641
  include Aws::Structure
4442
4642
  end
4443
4643
 
@@ -4461,19 +4661,21 @@ module Aws::StorageGateway
4461
4661
  # A comma-separated list of the paths of folders to refresh in the
4462
4662
  # cache. The default is \[`"/"`\]. The default refreshes objects and
4463
4663
  # folders at the root of the Amazon S3 bucket. If `Recursive` is set
4464
- # to "true", the entire S3 bucket that the file share has access to
4465
- # is refreshed.
4664
+ # to `true`, the entire S3 bucket that the file share has access to is
4665
+ # refreshed.
4466
4666
  # @return [Array<String>]
4467
4667
  #
4468
4668
  # @!attribute [rw] recursive
4469
4669
  # A value that specifies whether to recursively refresh folders in the
4470
4670
  # cache. The refresh includes folders that were in the cache the last
4471
4671
  # time the gateway listed the folder's contents. If this value set to
4472
- # "true", each folder that is listed in `FolderList` is recursively
4672
+ # `true`, each folder that is listed in `FolderList` is recursively
4473
4673
  # updated. Otherwise, subfolders listed in `FolderList` are not
4474
4674
  # refreshed. Only objects that are in folders listed directly under
4475
4675
  # `FolderList` are found and used for the update. The default is
4476
- # "true".
4676
+ # `true`.
4677
+ #
4678
+ # Valid Values: `true` \| `false`
4477
4679
  # @return [Boolean]
4478
4680
  #
4479
4681
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/RefreshCacheInput AWS API Documentation
@@ -4482,6 +4684,7 @@ module Aws::StorageGateway
4482
4684
  :file_share_arn,
4483
4685
  :folder_list,
4484
4686
  :recursive)
4687
+ SENSITIVE = []
4485
4688
  include Aws::Structure
4486
4689
  end
4487
4690
 
@@ -4501,6 +4704,7 @@ module Aws::StorageGateway
4501
4704
  class RefreshCacheOutput < Struct.new(
4502
4705
  :file_share_arn,
4503
4706
  :notification_id)
4707
+ SENSITIVE = []
4504
4708
  include Aws::Structure
4505
4709
  end
4506
4710
 
@@ -4529,6 +4733,7 @@ module Aws::StorageGateway
4529
4733
  class RemoveTagsFromResourceInput < Struct.new(
4530
4734
  :resource_arn,
4531
4735
  :tag_keys)
4736
+ SENSITIVE = []
4532
4737
  include Aws::Structure
4533
4738
  end
4534
4739
 
@@ -4543,6 +4748,7 @@ module Aws::StorageGateway
4543
4748
  #
4544
4749
  class RemoveTagsFromResourceOutput < Struct.new(
4545
4750
  :resource_arn)
4751
+ SENSITIVE = []
4546
4752
  include Aws::Structure
4547
4753
  end
4548
4754
 
@@ -4563,6 +4769,7 @@ module Aws::StorageGateway
4563
4769
  #
4564
4770
  class ResetCacheInput < Struct.new(
4565
4771
  :gateway_arn)
4772
+ SENSITIVE = []
4566
4773
  include Aws::Structure
4567
4774
  end
4568
4775
 
@@ -4576,6 +4783,7 @@ module Aws::StorageGateway
4576
4783
  #
4577
4784
  class ResetCacheOutput < Struct.new(
4578
4785
  :gateway_arn)
4786
+ SENSITIVE = []
4579
4787
  include Aws::Structure
4580
4788
  end
4581
4789
 
@@ -4608,6 +4816,7 @@ module Aws::StorageGateway
4608
4816
  class RetrieveTapeArchiveInput < Struct.new(
4609
4817
  :tape_arn,
4610
4818
  :gateway_arn)
4819
+ SENSITIVE = []
4611
4820
  include Aws::Structure
4612
4821
  end
4613
4822
 
@@ -4621,6 +4830,7 @@ module Aws::StorageGateway
4621
4830
  #
4622
4831
  class RetrieveTapeArchiveOutput < Struct.new(
4623
4832
  :tape_arn)
4833
+ SENSITIVE = []
4624
4834
  include Aws::Structure
4625
4835
  end
4626
4836
 
@@ -4650,6 +4860,7 @@ module Aws::StorageGateway
4650
4860
  class RetrieveTapeRecoveryPointInput < Struct.new(
4651
4861
  :tape_arn,
4652
4862
  :gateway_arn)
4863
+ SENSITIVE = []
4653
4864
  include Aws::Structure
4654
4865
  end
4655
4866
 
@@ -4664,6 +4875,7 @@ module Aws::StorageGateway
4664
4875
  #
4665
4876
  class RetrieveTapeRecoveryPointOutput < Struct.new(
4666
4877
  :tape_arn)
4878
+ SENSITIVE = []
4667
4879
  include Aws::Structure
4668
4880
  end
4669
4881
 
@@ -4680,8 +4892,9 @@ module Aws::StorageGateway
4680
4892
  # @return [String]
4681
4893
  #
4682
4894
  # @!attribute [rw] file_share_status
4683
- # The status of the file share. Possible values are `CREATING`,
4684
- # `UPDATING`, `AVAILABLE` and `DELETING`.
4895
+ # The status of the file share.
4896
+ #
4897
+ # Valid Values: `CREATING` \| `UPDATING` \| `AVAILABLE` \| `DELETING`
4685
4898
  # @return [String]
4686
4899
  #
4687
4900
  # @!attribute [rw] gateway_arn
@@ -4691,14 +4904,17 @@ module Aws::StorageGateway
4691
4904
  # @return [String]
4692
4905
  #
4693
4906
  # @!attribute [rw] kms_encrypted
4694
- # True to use Amazon S3 server-side encryption with your own AWS KMS
4695
- # key, or false to use a key managed by Amazon S3. Optional.
4907
+ # Set to `true` to use Amazon S3 server-side encryption with your own
4908
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
4909
+ #
4910
+ # Valid Values: `true` \| `false`
4696
4911
  # @return [Boolean]
4697
4912
  #
4698
4913
  # @!attribute [rw] kms_key
4699
- # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
4700
- # server-side encryption. This value can only be set when KMSEncrypted
4701
- # is true. Optional.
4914
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
4915
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway
4916
+ # does not support asymmetric CMKs. This value can only be set when
4917
+ # `KMSEncrypted` is `true`. Optional.
4702
4918
  # @return [String]
4703
4919
  #
4704
4920
  # @!attribute [rw] path
@@ -4717,51 +4933,65 @@ module Aws::StorageGateway
4717
4933
  #
4718
4934
  # @!attribute [rw] default_storage_class
4719
4935
  # The default storage class for objects put into an Amazon S3 bucket
4720
- # by the file gateway. Possible values are `S3_STANDARD`,
4721
- # `S3_STANDARD_IA`, or `S3_ONEZONE_IA`. If this field is not
4722
- # populated, the default value `S3_STANDARD` is used. Optional.
4936
+ # by the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
4937
+ # Optional.
4938
+ #
4939
+ # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
4940
+ # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
4723
4941
  # @return [String]
4724
4942
  #
4725
4943
  # @!attribute [rw] object_acl
4726
- # A value that sets the access control list permission for objects in
4727
- # the S3 bucket that a file gateway puts objects into. The default
4728
- # value is "private".
4944
+ # A value that sets the access control list (ACL) permission for
4945
+ # objects in the S3 bucket that a file gateway puts objects into. The
4946
+ # default value is `private`.
4729
4947
  # @return [String]
4730
4948
  #
4731
4949
  # @!attribute [rw] read_only
4732
- # A value that sets the write status of a file share. This value is
4733
- # true if the write status is read-only, and otherwise false.
4950
+ # A value that sets the write status of a file share. Set this value
4951
+ # to `true` to set the write status to read-only, otherwise set to
4952
+ # `false`.
4953
+ #
4954
+ # Valid Values: `true` \| `false`
4734
4955
  # @return [Boolean]
4735
4956
  #
4736
4957
  # @!attribute [rw] guess_mime_type_enabled
4737
4958
  # 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 type
4739
- # guessing, and otherwise to false. The default value is true.
4959
+ # based on file extensions. Set this value to `true` to enable MIME
4960
+ # type guessing, otherwise set to `false`. The default value is
4961
+ # `true`.
4962
+ #
4963
+ # Valid Values: `true` \| `false`
4740
4964
  # @return [Boolean]
4741
4965
  #
4742
4966
  # @!attribute [rw] requester_pays
4743
4967
  # A value that sets who pays the cost of the request and the cost
4744
4968
  # associated with data download from the S3 bucket. If this value is
4745
- # set to true, the requester pays the costs. Otherwise the S3 bucket
4746
- # owner pays. However, the S3 bucket owner always pays the cost of
4747
- # storing data.
4969
+ # set to `true`, the requester pays the costs; otherwise, the S3
4970
+ # bucket owner pays. However, the S3 bucket owner always pays the cost
4971
+ # of storing data.
4748
4972
  #
4749
4973
  # <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
4750
4974
  # file share, so make sure that the configuration on the file share is
4751
4975
  # the same as the S3 bucket configuration.
4752
4976
  #
4753
4977
  # </note>
4978
+ #
4979
+ # Valid Values: `true` \| `false`
4754
4980
  # @return [Boolean]
4755
4981
  #
4756
4982
  # @!attribute [rw] smbacl_enabled
4757
- # If this value is set to "true", indicates that ACL (access control
4758
- # list) is enabled on the SMB file share. If it is set to "false",
4759
- # it indicates that file and directory permissions are mapped to the
4760
- # POSIX permission.
4761
- #
4762
- # For more information, see
4763
- # https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
4764
- # in the Storage Gateway User Guide.
4983
+ # If this value is set to `true`, it indicates that access control
4984
+ # list (ACL) is enabled on the SMB file share. If it is set to
4985
+ # `false`, it indicates that file and directory permissions are mapped
4986
+ # to the POSIX permission.
4987
+ #
4988
+ # For more information, see [Using Microsoft Windows ACLs to control
4989
+ # access to an SMB file share][1] in the *AWS Storage Gateway User
4990
+ # Guide*.
4991
+ #
4992
+ #
4993
+ #
4994
+ # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
4765
4995
  # @return [Boolean]
4766
4996
  #
4767
4997
  # @!attribute [rw] admin_user_list
@@ -4774,7 +5004,7 @@ module Aws::StorageGateway
4774
5004
  # @!attribute [rw] valid_user_list
4775
5005
  # A list of users or groups in the Active Directory that are allowed
4776
5006
  # to access the file share. A group must be prefixed with the @
4777
- # character. For example `@group1`. Can only be set if Authentication
5007
+ # character. For example, `@group1`. Can only be set if Authentication
4778
5008
  # is set to `ActiveDirectory`.
4779
5009
  # @return [Array<String>]
4780
5010
  #
@@ -4791,10 +5021,10 @@ module Aws::StorageGateway
4791
5021
  # @return [String]
4792
5022
  #
4793
5023
  # @!attribute [rw] authentication
4794
- # The authentication method of the file share.
4795
- #
4796
- # Valid values are `ActiveDirectory` or `GuestAccess`. The default is
5024
+ # The authentication method of the file share. The default is
4797
5025
  # `ActiveDirectory`.
5026
+ #
5027
+ # Valid Values: `ActiveDirectory` \| `GuestAccess`
4798
5028
  # @return [String]
4799
5029
  #
4800
5030
  # @!attribute [rw] tags
@@ -4828,6 +5058,7 @@ module Aws::StorageGateway
4828
5058
  :audit_destination_arn,
4829
5059
  :authentication,
4830
5060
  :tags)
5061
+ SENSITIVE = []
4831
5062
  include Aws::Structure
4832
5063
  end
4833
5064
 
@@ -4848,6 +5079,7 @@ module Aws::StorageGateway
4848
5079
  class ServiceUnavailableError < Struct.new(
4849
5080
  :message,
4850
5081
  :error)
5082
+ SENSITIVE = []
4851
5083
  include Aws::Structure
4852
5084
  end
4853
5085
 
@@ -4876,6 +5108,7 @@ module Aws::StorageGateway
4876
5108
  class SetLocalConsolePasswordInput < Struct.new(
4877
5109
  :gateway_arn,
4878
5110
  :local_console_password)
5111
+ SENSITIVE = [:local_console_password]
4879
5112
  include Aws::Structure
4880
5113
  end
4881
5114
 
@@ -4889,6 +5122,7 @@ module Aws::StorageGateway
4889
5122
  #
4890
5123
  class SetLocalConsolePasswordOutput < Struct.new(
4891
5124
  :gateway_arn)
5125
+ SENSITIVE = []
4892
5126
  include Aws::Structure
4893
5127
  end
4894
5128
 
@@ -4908,7 +5142,7 @@ module Aws::StorageGateway
4908
5142
  # @return [String]
4909
5143
  #
4910
5144
  # @!attribute [rw] password
4911
- # The password that you want to set for your SMB Server.
5145
+ # The password that you want to set for your SMB server.
4912
5146
  # @return [String]
4913
5147
  #
4914
5148
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/SetSMBGuestPasswordInput AWS API Documentation
@@ -4916,6 +5150,7 @@ module Aws::StorageGateway
4916
5150
  class SetSMBGuestPasswordInput < Struct.new(
4917
5151
  :gateway_arn,
4918
5152
  :password)
5153
+ SENSITIVE = [:password]
4919
5154
  include Aws::Structure
4920
5155
  end
4921
5156
 
@@ -4929,6 +5164,7 @@ module Aws::StorageGateway
4929
5164
  #
4930
5165
  class SetSMBGuestPasswordOutput < Struct.new(
4931
5166
  :gateway_arn)
5167
+ SENSITIVE = []
4932
5168
  include Aws::Structure
4933
5169
  end
4934
5170
 
@@ -4952,6 +5188,7 @@ module Aws::StorageGateway
4952
5188
  #
4953
5189
  class ShutdownGatewayInput < Struct.new(
4954
5190
  :gateway_arn)
5191
+ SENSITIVE = []
4955
5192
  include Aws::Structure
4956
5193
  end
4957
5194
 
@@ -4968,6 +5205,7 @@ module Aws::StorageGateway
4968
5205
  #
4969
5206
  class ShutdownGatewayOutput < Struct.new(
4970
5207
  :gateway_arn)
5208
+ SENSITIVE = []
4971
5209
  include Aws::Structure
4972
5210
  end
4973
5211
 
@@ -4988,6 +5226,7 @@ module Aws::StorageGateway
4988
5226
  #
4989
5227
  class StartAvailabilityMonitorTestInput < Struct.new(
4990
5228
  :gateway_arn)
5229
+ SENSITIVE = []
4991
5230
  include Aws::Structure
4992
5231
  end
4993
5232
 
@@ -5001,6 +5240,7 @@ module Aws::StorageGateway
5001
5240
  #
5002
5241
  class StartAvailabilityMonitorTestOutput < Struct.new(
5003
5242
  :gateway_arn)
5243
+ SENSITIVE = []
5004
5244
  include Aws::Structure
5005
5245
  end
5006
5246
 
@@ -5024,6 +5264,7 @@ module Aws::StorageGateway
5024
5264
  #
5025
5265
  class StartGatewayInput < Struct.new(
5026
5266
  :gateway_arn)
5267
+ SENSITIVE = []
5027
5268
  include Aws::Structure
5028
5269
  end
5029
5270
 
@@ -5040,6 +5281,7 @@ module Aws::StorageGateway
5040
5281
  #
5041
5282
  class StartGatewayOutput < Struct.new(
5042
5283
  :gateway_arn)
5284
+ SENSITIVE = []
5043
5285
  include Aws::Structure
5044
5286
  end
5045
5287
 
@@ -5061,6 +5303,7 @@ module Aws::StorageGateway
5061
5303
  class StorageGatewayError < Struct.new(
5062
5304
  :error_code,
5063
5305
  :error_details)
5306
+ SENSITIVE = []
5064
5307
  include Aws::Structure
5065
5308
  end
5066
5309
 
@@ -5087,8 +5330,8 @@ module Aws::StorageGateway
5087
5330
  # @!attribute [rw] volume_attachment_status
5088
5331
  # A value that indicates whether a storage volume is attached to,
5089
5332
  # detached from, or is in the process of detaching from a gateway. For
5090
- # more information, see [Moving Your Volumes to a Different
5091
- # Gateway][1].
5333
+ # more information, see [Moving your volumes to a different
5334
+ # gateway][1].
5092
5335
  #
5093
5336
  #
5094
5337
  #
@@ -5121,7 +5364,7 @@ module Aws::StorageGateway
5121
5364
  # Indicates if when the stored volume was created, existing data on
5122
5365
  # the underlying local disk was preserved.
5123
5366
  #
5124
- # Valid Values: true, false
5367
+ # Valid Values: `true` \| `false`
5125
5368
  # @return [Boolean]
5126
5369
  #
5127
5370
  # @!attribute [rw] volume_iscsi_attributes
@@ -5150,9 +5393,10 @@ module Aws::StorageGateway
5150
5393
  # @return [Integer]
5151
5394
  #
5152
5395
  # @!attribute [rw] kms_key
5153
- # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
5154
- # server-side encryption. This value can only be set when KMSEncrypted
5155
- # is true. Optional.
5396
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
5397
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway
5398
+ # does not support asymmetric CMKs. This value can only be set when
5399
+ # `KMSEncrypted` is `true`. Optional.
5156
5400
  # @return [String]
5157
5401
  #
5158
5402
  # @!attribute [rw] target_name
@@ -5184,12 +5428,13 @@ module Aws::StorageGateway
5184
5428
  :volume_used_in_bytes,
5185
5429
  :kms_key,
5186
5430
  :target_name)
5431
+ SENSITIVE = []
5187
5432
  include Aws::Structure
5188
5433
  end
5189
5434
 
5190
5435
  # A key-value pair that helps you manage, filter, and search for your
5191
5436
  # resource. Allowed characters: letters, white space, and numbers,
5192
- # representable in UTF-8, and the following characters: + - = . \_ : /
5437
+ # representable in UTF-8, and the following characters: + - = . \_ : /.
5193
5438
  #
5194
5439
  # @note When making an API call, you may pass Tag
5195
5440
  # data as a hash:
@@ -5200,7 +5445,7 @@ module Aws::StorageGateway
5200
5445
  # }
5201
5446
  #
5202
5447
  # @!attribute [rw] key
5203
- # Tag key (String). The key can't start with aws:.
5448
+ # Tag key. The key can't start with aws:.
5204
5449
  # @return [String]
5205
5450
  #
5206
5451
  # @!attribute [rw] value
@@ -5212,6 +5457,7 @@ module Aws::StorageGateway
5212
5457
  class Tag < Struct.new(
5213
5458
  :key,
5214
5459
  :value)
5460
+ SENSITIVE = []
5215
5461
  include Aws::Structure
5216
5462
  end
5217
5463
 
@@ -5258,9 +5504,10 @@ module Aws::StorageGateway
5258
5504
  # @return [Integer]
5259
5505
  #
5260
5506
  # @!attribute [rw] kms_key
5261
- # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
5262
- # server-side encryption. This value can only be set when KMSEncrypted
5263
- # is true. Optional.
5507
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
5508
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway
5509
+ # does not support asymmetric CMKs. This value can only be set when
5510
+ # `KMSEncrypted` is `true`. Optional.
5264
5511
  # @return [String]
5265
5512
  #
5266
5513
  # @!attribute [rw] pool_id
@@ -5268,10 +5515,10 @@ module Aws::StorageGateway
5268
5515
  # tapes in this pool are archived in the S3 storage class that is
5269
5516
  # associated with the pool. When you use your backup application to
5270
5517
  # eject the tape, the tape is archived directly into the storage class
5271
- # (S3 Glacier or S# Glacier Deep Archive) that corresponds to the
5518
+ # (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the
5272
5519
  # pool.
5273
5520
  #
5274
- # Valid values: "GLACIER", "DEEP\_ARCHIVE"
5521
+ # Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
5275
5522
  # @return [String]
5276
5523
  #
5277
5524
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/Tape AWS API Documentation
@@ -5287,6 +5534,7 @@ module Aws::StorageGateway
5287
5534
  :tape_used_in_bytes,
5288
5535
  :kms_key,
5289
5536
  :pool_id)
5537
+ SENSITIVE = []
5290
5538
  include Aws::Structure
5291
5539
  end
5292
5540
 
@@ -5336,9 +5584,10 @@ module Aws::StorageGateway
5336
5584
  # @return [Integer]
5337
5585
  #
5338
5586
  # @!attribute [rw] kms_key
5339
- # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
5340
- # server-side encryption. This value can only be set when KMSEncrypted
5341
- # is true. Optional.
5587
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
5588
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway
5589
+ # does not support asymmetric CMKs. This value can only be set when
5590
+ # `KMSEncrypted` is `true`. Optional.
5342
5591
  # @return [String]
5343
5592
  #
5344
5593
  # @!attribute [rw] pool_id
@@ -5346,7 +5595,7 @@ module Aws::StorageGateway
5346
5595
  # this pool are archived in the S3 storage class that is associated
5347
5596
  # with the pool.
5348
5597
  #
5349
- # Valid values: "GLACIER", "DEEP\_ARCHIVE"
5598
+ # Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
5350
5599
  # @return [String]
5351
5600
  #
5352
5601
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/TapeArchive AWS API Documentation
@@ -5362,6 +5611,7 @@ module Aws::StorageGateway
5362
5611
  :tape_used_in_bytes,
5363
5612
  :kms_key,
5364
5613
  :pool_id)
5614
+ SENSITIVE = []
5365
5615
  include Aws::Structure
5366
5616
  end
5367
5617
 
@@ -5397,7 +5647,7 @@ module Aws::StorageGateway
5397
5647
  # (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the
5398
5648
  # pool.
5399
5649
  #
5400
- # Valid values: "GLACIER", "DEEP\_ARCHIVE"
5650
+ # Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
5401
5651
  # @return [String]
5402
5652
  #
5403
5653
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/TapeInfo AWS API Documentation
@@ -5409,6 +5659,7 @@ module Aws::StorageGateway
5409
5659
  :tape_status,
5410
5660
  :gateway_arn,
5411
5661
  :pool_id)
5662
+ SENSITIVE = []
5412
5663
  include Aws::Structure
5413
5664
  end
5414
5665
 
@@ -5441,6 +5692,7 @@ module Aws::StorageGateway
5441
5692
  :tape_recovery_point_time,
5442
5693
  :tape_size_in_bytes,
5443
5694
  :tape_status)
5695
+ SENSITIVE = []
5444
5696
  include Aws::Structure
5445
5697
  end
5446
5698
 
@@ -5476,6 +5728,7 @@ module Aws::StorageGateway
5476
5728
  class UpdateAutomaticTapeCreationPolicyInput < Struct.new(
5477
5729
  :automatic_tape_creation_rules,
5478
5730
  :gateway_arn)
5731
+ SENSITIVE = []
5479
5732
  include Aws::Structure
5480
5733
  end
5481
5734
 
@@ -5489,6 +5742,7 @@ module Aws::StorageGateway
5489
5742
  #
5490
5743
  class UpdateAutomaticTapeCreationPolicyOutput < Struct.new(
5491
5744
  :gateway_arn)
5745
+ SENSITIVE = []
5492
5746
  include Aws::Structure
5493
5747
  end
5494
5748
 
@@ -5527,6 +5781,7 @@ module Aws::StorageGateway
5527
5781
  :gateway_arn,
5528
5782
  :average_upload_rate_limit_in_bits_per_sec,
5529
5783
  :average_download_rate_limit_in_bits_per_sec)
5784
+ SENSITIVE = []
5530
5785
  include Aws::Structure
5531
5786
  end
5532
5787
 
@@ -5543,6 +5798,7 @@ module Aws::StorageGateway
5543
5798
  #
5544
5799
  class UpdateBandwidthRateLimitOutput < Struct.new(
5545
5800
  :gateway_arn)
5801
+ SENSITIVE = []
5546
5802
  include Aws::Structure
5547
5803
  end
5548
5804
 
@@ -5605,6 +5861,7 @@ module Aws::StorageGateway
5605
5861
  :secret_to_authenticate_initiator,
5606
5862
  :initiator_name,
5607
5863
  :secret_to_authenticate_target)
5864
+ SENSITIVE = [:secret_to_authenticate_initiator, :secret_to_authenticate_target]
5608
5865
  include Aws::Structure
5609
5866
  end
5610
5867
 
@@ -5625,6 +5882,7 @@ module Aws::StorageGateway
5625
5882
  class UpdateChapCredentialsOutput < Struct.new(
5626
5883
  :target_arn,
5627
5884
  :initiator_name)
5885
+ SENSITIVE = []
5628
5886
  include Aws::Structure
5629
5887
  end
5630
5888
 
@@ -5656,7 +5914,7 @@ module Aws::StorageGateway
5656
5914
  # The Amazon Resource Name (ARN) of the Amazon CloudWatch log group
5657
5915
  # that you want to use to monitor and log events in the gateway.
5658
5916
  #
5659
- # For more information, see [What Is Amazon CloudWatch Logs?][1].
5917
+ # For more information, see [What is Amazon CloudWatch logs?][1].
5660
5918
  #
5661
5919
  #
5662
5920
  #
@@ -5670,10 +5928,12 @@ module Aws::StorageGateway
5670
5928
  :gateway_name,
5671
5929
  :gateway_timezone,
5672
5930
  :cloud_watch_log_group_arn)
5931
+ SENSITIVE = []
5673
5932
  include Aws::Structure
5674
5933
  end
5675
5934
 
5676
- # A JSON object containing the ARN of the gateway that was updated.
5935
+ # A JSON object containing the Amazon Resource Name (ARN) of the gateway
5936
+ # that was updated.
5677
5937
  #
5678
5938
  # @!attribute [rw] gateway_arn
5679
5939
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
@@ -5690,6 +5950,7 @@ module Aws::StorageGateway
5690
5950
  class UpdateGatewayInformationOutput < Struct.new(
5691
5951
  :gateway_arn,
5692
5952
  :gateway_name)
5953
+ SENSITIVE = []
5693
5954
  include Aws::Structure
5694
5955
  end
5695
5956
 
@@ -5713,6 +5974,7 @@ module Aws::StorageGateway
5713
5974
  #
5714
5975
  class UpdateGatewaySoftwareNowInput < Struct.new(
5715
5976
  :gateway_arn)
5977
+ SENSITIVE = []
5716
5978
  include Aws::Structure
5717
5979
  end
5718
5980
 
@@ -5729,6 +5991,7 @@ module Aws::StorageGateway
5729
5991
  #
5730
5992
  class UpdateGatewaySoftwareNowOutput < Struct.new(
5731
5993
  :gateway_arn)
5994
+ SENSITIVE = []
5732
5995
  include Aws::Structure
5733
5996
  end
5734
5997
 
@@ -5782,10 +6045,6 @@ module Aws::StorageGateway
5782
6045
  # represented as an ordinal number from 1 to 28, where 1 represents
5783
6046
  # the first day of the month and 28 represents the last day of the
5784
6047
  # month.
5785
- #
5786
- # <note markdown="1"> This value is only available for tape and volume gateways.
5787
- #
5788
- # </note>
5789
6048
  # @return [Integer]
5790
6049
  #
5791
6050
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateMaintenanceStartTimeInput AWS API Documentation
@@ -5796,6 +6055,7 @@ module Aws::StorageGateway
5796
6055
  :minute_of_hour,
5797
6056
  :day_of_week,
5798
6057
  :day_of_month)
6058
+ SENSITIVE = []
5799
6059
  include Aws::Structure
5800
6060
  end
5801
6061
 
@@ -5812,6 +6072,7 @@ module Aws::StorageGateway
5812
6072
  #
5813
6073
  class UpdateMaintenanceStartTimeOutput < Struct.new(
5814
6074
  :gateway_arn)
6075
+ SENSITIVE = []
5815
6076
  include Aws::Structure
5816
6077
  end
5817
6078
 
@@ -5844,14 +6105,17 @@ module Aws::StorageGateway
5844
6105
  # @return [String]
5845
6106
  #
5846
6107
  # @!attribute [rw] kms_encrypted
5847
- # True to use Amazon S3 server-side encryption with your own AWS KMS
5848
- # key, or false to use a key managed by Amazon S3. Optional.
6108
+ # Set to `true` to use Amazon S3 server-side encryption with your own
6109
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
6110
+ #
6111
+ # Valid Values: `true` \| `false`
5849
6112
  # @return [Boolean]
5850
6113
  #
5851
6114
  # @!attribute [rw] kms_key
5852
- # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
5853
- # server-side encryption. This value can only be set when KMSEncrypted
5854
- # is true. Optional.
6115
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
6116
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway
6117
+ # does not support asymmetric CMKs. This value can only be set when
6118
+ # `KMSEncrypted` is `true`. Optional.
5855
6119
  # @return [String]
5856
6120
  #
5857
6121
  # @!attribute [rw] nfs_file_share_defaults
@@ -5860,15 +6124,17 @@ module Aws::StorageGateway
5860
6124
  #
5861
6125
  # @!attribute [rw] default_storage_class
5862
6126
  # The default storage class for objects put into an Amazon S3 bucket
5863
- # by the file gateway. Possible values are `S3_STANDARD`,
5864
- # `S3_STANDARD_IA`, or `S3_ONEZONE_IA`. If this field is not
5865
- # populated, the default value `S3_STANDARD` is used. Optional.
6127
+ # by the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
6128
+ # Optional.
6129
+ #
6130
+ # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
6131
+ # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
5866
6132
  # @return [String]
5867
6133
  #
5868
6134
  # @!attribute [rw] object_acl
5869
- # A value that sets the access control list permission for objects in
5870
- # the S3 bucket that a file gateway puts objects into. The default
5871
- # value is "private".
6135
+ # A value that sets the access control list (ACL) permission for
6136
+ # objects in the S3 bucket that a file gateway puts objects into. The
6137
+ # default value is `private`.
5872
6138
  # @return [String]
5873
6139
  #
5874
6140
  # @!attribute [rw] client_list
@@ -5877,38 +6143,48 @@ module Aws::StorageGateway
5877
6143
  # @return [Array<String>]
5878
6144
  #
5879
6145
  # @!attribute [rw] squash
5880
- # The user mapped to anonymous user. Valid options are the following:
6146
+ # The user mapped to anonymous user.
6147
+ #
6148
+ # Valid values are the following:
5881
6149
  #
5882
- # * `RootSquash` - Only root is mapped to anonymous user.
6150
+ # * `RootSquash`\: Only root is mapped to anonymous user.
5883
6151
  #
5884
- # * `NoSquash` - No one is mapped to anonymous user
6152
+ # * `NoSquash`\: No one is mapped to anonymous user.
5885
6153
  #
5886
- # * `AllSquash` - Everyone is mapped to anonymous user.
6154
+ # * `AllSquash`\: Everyone is mapped to anonymous user.
5887
6155
  # @return [String]
5888
6156
  #
5889
6157
  # @!attribute [rw] read_only
5890
- # A value that sets the write status of a file share. This value is
5891
- # true if the write status is read-only, and otherwise false.
6158
+ # A value that sets the write status of a file share. Set this value
6159
+ # to `true` to set the write status to read-only, otherwise set to
6160
+ # `false`.
6161
+ #
6162
+ # Valid Values: `true` \| `false`
5892
6163
  # @return [Boolean]
5893
6164
  #
5894
6165
  # @!attribute [rw] guess_mime_type_enabled
5895
6166
  # 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 type
5897
- # guessing, and otherwise to false. The default value is true.
6167
+ # based on file extensions. Set this value to `true` to enable MIME
6168
+ # type guessing, otherwise set to `false`. The default value is
6169
+ # `true`.
6170
+ #
6171
+ # Valid Values: `true` \| `false`
5898
6172
  # @return [Boolean]
5899
6173
  #
5900
6174
  # @!attribute [rw] requester_pays
5901
6175
  # A value that sets who pays the cost of the request and the cost
5902
6176
  # associated with data download from the S3 bucket. If this value is
5903
- # set to true, the requester pays the costs. Otherwise the S3 bucket
5904
- # owner pays. However, the S3 bucket owner always pays the cost of
5905
- # storing data.
6177
+ # set to `true`, the requester pays the costs; otherwise, the S3
6178
+ # bucket owner pays. However, the S3 bucket owner always pays the cost
6179
+ # of storing data.
5906
6180
  #
5907
6181
  # <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
5908
6182
  # file share, so make sure that the configuration on the file share is
5909
6183
  # the same as the S3 bucket configuration.
5910
6184
  #
5911
6185
  # </note>
6186
+ #
6187
+ # Valid Values: `true` \| `false`
5912
6188
  # @return [Boolean]
5913
6189
  #
5914
6190
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateNFSFileShareInput AWS API Documentation
@@ -5925,6 +6201,7 @@ module Aws::StorageGateway
5925
6201
  :read_only,
5926
6202
  :guess_mime_type_enabled,
5927
6203
  :requester_pays)
6204
+ SENSITIVE = []
5928
6205
  include Aws::Structure
5929
6206
  end
5930
6207
 
@@ -5938,6 +6215,7 @@ module Aws::StorageGateway
5938
6215
  #
5939
6216
  class UpdateNFSFileShareOutput < Struct.new(
5940
6217
  :file_share_arn)
6218
+ SENSITIVE = []
5941
6219
  include Aws::Structure
5942
6220
  end
5943
6221
 
@@ -5968,75 +6246,94 @@ module Aws::StorageGateway
5968
6246
  # @return [String]
5969
6247
  #
5970
6248
  # @!attribute [rw] kms_encrypted
5971
- # True to use Amazon S3 server-side encryption with your own AWS KMS
5972
- # key, or false to use a key managed by Amazon S3. Optional.
6249
+ # Set to `true` to use Amazon S3 server-side encryption with your own
6250
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
6251
+ #
6252
+ # Valid Values: `true` \| `false`
5973
6253
  # @return [Boolean]
5974
6254
  #
5975
6255
  # @!attribute [rw] kms_key
5976
- # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
5977
- # server-side encryption. This value can only be set when KMSEncrypted
5978
- # is true. Optional.
6256
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
6257
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway
6258
+ # does not support asymmetric CMKs. This value can only be set when
6259
+ # `KMSEncrypted` is `true`. Optional.
5979
6260
  # @return [String]
5980
6261
  #
5981
6262
  # @!attribute [rw] default_storage_class
5982
6263
  # The default storage class for objects put into an Amazon S3 bucket
5983
- # by the file gateway. Possible values are `S3_STANDARD`,
5984
- # `S3_STANDARD_IA`, or `S3_ONEZONE_IA`. If this field is not
5985
- # populated, the default value `S3_STANDARD` is used. Optional.
6264
+ # by the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
6265
+ # Optional.
6266
+ #
6267
+ # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
6268
+ # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
5986
6269
  # @return [String]
5987
6270
  #
5988
6271
  # @!attribute [rw] object_acl
5989
- # A value that sets the access control list permission for objects in
5990
- # the S3 bucket that a file gateway puts objects into. The default
5991
- # value is "private".
6272
+ # A value that sets the access control list (ACL) permission for
6273
+ # objects in the S3 bucket that a file gateway puts objects into. The
6274
+ # default value is `private`.
5992
6275
  # @return [String]
5993
6276
  #
5994
6277
  # @!attribute [rw] read_only
5995
- # A value that sets the write status of a file share. This value is
5996
- # true if the write status is read-only, and otherwise false.
6278
+ # A value that sets the write status of a file share. Set this value
6279
+ # to `true` to set write status to read-only, otherwise set to
6280
+ # `false`.
6281
+ #
6282
+ # Valid Values: `true` \| `false`
5997
6283
  # @return [Boolean]
5998
6284
  #
5999
6285
  # @!attribute [rw] guess_mime_type_enabled
6000
6286
  # 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 type
6002
- # guessing, and otherwise to false. The default value is true.
6287
+ # based on file extensions. Set this value to `true` to enable MIME
6288
+ # type guessing, otherwise set to `false`. The default value is
6289
+ # `true`.
6290
+ #
6291
+ # Valid Values: `true` \| `false`
6003
6292
  # @return [Boolean]
6004
6293
  #
6005
6294
  # @!attribute [rw] requester_pays
6006
6295
  # A value that sets who pays the cost of the request and the cost
6007
6296
  # associated with data download from the S3 bucket. If this value is
6008
- # set to true, the requester pays the costs. Otherwise the S3 bucket
6009
- # owner pays. However, the S3 bucket owner always pays the cost of
6010
- # storing data.
6297
+ # set to `true`, the requester pays the costs; otherwise, the S3
6298
+ # bucket owner pays. However, the S3 bucket owner always pays the cost
6299
+ # of storing data.
6011
6300
  #
6012
6301
  # <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
6013
6302
  # file share, so make sure that the configuration on the file share is
6014
6303
  # the same as the S3 bucket configuration.
6015
6304
  #
6016
6305
  # </note>
6306
+ #
6307
+ # Valid Values: `true` \| `false`
6017
6308
  # @return [Boolean]
6018
6309
  #
6019
6310
  # @!attribute [rw] smbacl_enabled
6020
- # Set this value to "true to enable ACL (access control list) on the
6021
- # SMB file share. Set it to "false" to map file and directory
6311
+ # Set this value to `true` to enable access control list (ACL) on the
6312
+ # SMB file share. Set it to `false` to map file and directory
6022
6313
  # permissions to the POSIX permissions.
6023
6314
  #
6024
- # For more information, see
6025
- # https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.htmlin
6026
- # the Storage Gateway User Guide.
6315
+ # For more information, see [Using Microsoft Windows ACLs to control
6316
+ # access to an SMB file share][1] in the *AWS Storage Gateway User
6317
+ # Guide*.
6318
+ #
6319
+ # Valid Values: `true` \| `false`
6320
+ #
6321
+ #
6322
+ #
6323
+ # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
6027
6324
  # @return [Boolean]
6028
6325
  #
6029
6326
  # @!attribute [rw] admin_user_list
6030
6327
  # A list of users in the Active Directory that have administrator
6031
6328
  # rights to the file share. A group must be prefixed with the @
6032
- # character. For example `@group1`. Can only be set if Authentication
6329
+ # character. For example, `@group1`. Can only be set if Authentication
6033
6330
  # is set to `ActiveDirectory`.
6034
6331
  # @return [Array<String>]
6035
6332
  #
6036
6333
  # @!attribute [rw] valid_user_list
6037
6334
  # A list of users or groups in the Active Directory that are allowed
6038
6335
  # to access the file share. A group must be prefixed with the @
6039
- # character. For example `@group1`. Can only be set if Authentication
6336
+ # character. For example, `@group1`. Can only be set if Authentication
6040
6337
  # is set to `ActiveDirectory`.
6041
6338
  # @return [Array<String>]
6042
6339
  #
@@ -6068,6 +6365,7 @@ module Aws::StorageGateway
6068
6365
  :valid_user_list,
6069
6366
  :invalid_user_list,
6070
6367
  :audit_destination_arn)
6368
+ SENSITIVE = []
6071
6369
  include Aws::Structure
6072
6370
  end
6073
6371
 
@@ -6081,6 +6379,7 @@ module Aws::StorageGateway
6081
6379
  #
6082
6380
  class UpdateSMBFileShareOutput < Struct.new(
6083
6381
  :file_share_arn)
6382
+ SENSITIVE = []
6084
6383
  include Aws::Structure
6085
6384
  end
6086
6385
 
@@ -6123,6 +6422,7 @@ module Aws::StorageGateway
6123
6422
  class UpdateSMBSecurityStrategyInput < Struct.new(
6124
6423
  :gateway_arn,
6125
6424
  :smb_security_strategy)
6425
+ SENSITIVE = []
6126
6426
  include Aws::Structure
6127
6427
  end
6128
6428
 
@@ -6136,6 +6436,7 @@ module Aws::StorageGateway
6136
6436
  #
6137
6437
  class UpdateSMBSecurityStrategyOutput < Struct.new(
6138
6438
  :gateway_arn)
6439
+ SENSITIVE = []
6139
6440
  include Aws::Structure
6140
6441
  end
6141
6442
 
@@ -6206,6 +6507,7 @@ module Aws::StorageGateway
6206
6507
  :recurrence_in_hours,
6207
6508
  :description,
6208
6509
  :tags)
6510
+ SENSITIVE = []
6209
6511
  include Aws::Structure
6210
6512
  end
6211
6513
 
@@ -6221,6 +6523,7 @@ module Aws::StorageGateway
6221
6523
  #
6222
6524
  class UpdateSnapshotScheduleOutput < Struct.new(
6223
6525
  :volume_arn)
6526
+ SENSITIVE = []
6224
6527
  include Aws::Structure
6225
6528
  end
6226
6529
 
@@ -6240,7 +6543,7 @@ module Aws::StorageGateway
6240
6543
  # @!attribute [rw] device_type
6241
6544
  # The type of medium changer you want to select.
6242
6545
  #
6243
- # Valid Values: "STK-L700", "AWS-Gateway-VTL"
6546
+ # Valid Values: `STK-L700` \| `AWS-Gateway-VTL`
6244
6547
  # @return [String]
6245
6548
  #
6246
6549
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateVTLDeviceTypeInput AWS API Documentation
@@ -6248,6 +6551,7 @@ module Aws::StorageGateway
6248
6551
  class UpdateVTLDeviceTypeInput < Struct.new(
6249
6552
  :vtl_device_arn,
6250
6553
  :device_type)
6554
+ SENSITIVE = []
6251
6555
  include Aws::Structure
6252
6556
  end
6253
6557
 
@@ -6262,6 +6566,7 @@ module Aws::StorageGateway
6262
6566
  #
6263
6567
  class UpdateVTLDeviceTypeOutput < Struct.new(
6264
6568
  :vtl_device_arn)
6569
+ SENSITIVE = []
6265
6570
  include Aws::Structure
6266
6571
  end
6267
6572
 
@@ -6297,6 +6602,7 @@ module Aws::StorageGateway
6297
6602
  :vtl_device_vendor,
6298
6603
  :vtl_device_product_identifier,
6299
6604
  :device_iscsi_attributes)
6605
+ SENSITIVE = []
6300
6606
  include Aws::Structure
6301
6607
  end
6302
6608
 
@@ -6363,6 +6669,7 @@ module Aws::StorageGateway
6363
6669
  :volume_type,
6364
6670
  :volume_size_in_bytes,
6365
6671
  :volume_attachment_status)
6672
+ SENSITIVE = []
6366
6673
  include Aws::Structure
6367
6674
  end
6368
6675
 
@@ -6396,6 +6703,7 @@ module Aws::StorageGateway
6396
6703
  :volume_size_in_bytes,
6397
6704
  :volume_usage_in_bytes,
6398
6705
  :volume_recovery_point_time)
6706
+ SENSITIVE = []
6399
6707
  include Aws::Structure
6400
6708
  end
6401
6709
 
@@ -6429,6 +6737,7 @@ module Aws::StorageGateway
6429
6737
  :network_interface_port,
6430
6738
  :lun_number,
6431
6739
  :chap_enabled)
6740
+ SENSITIVE = []
6432
6741
  include Aws::Structure
6433
6742
  end
6434
6743