Class: Aws::StorageGateway::Types::CreateNFSFileShareInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::StorageGateway::Types::CreateNFSFileShareInput
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-storagegateway/types.rb
Overview
CreateNFSFileShareInput
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#audit_destination_arn ⇒ String
The Amazon Resource Name (ARN) of the storage used for audit logs.
-
#bucket_region ⇒ String
Specifies the Region of the S3 bucket where the NFS file share stores files.
-
#cache_attributes ⇒ Types::CacheAttributes
Specifies refresh cache information for the file share.
-
#client_list ⇒ Array<String>
The list of clients that are allowed to access the S3 File Gateway.
-
#client_token ⇒ String
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
-
#default_storage_class ⇒ String
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.
-
#file_share_name ⇒ String
The name of the file share.
-
#gateway_arn ⇒ String
The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file share.
-
#guess_mime_type_enabled ⇒ Boolean
A value that enables guessing of the MIME type for uploaded objects based on file extensions.
-
#kms_encrypted ⇒ Boolean
Set to ‘true` to use Amazon S3 server-side encryption with your own KMS key, or `false` to use a key managed by Amazon S3.
-
#kms_key ⇒ String
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
-
#location_arn ⇒ String
A custom ARN for the backend storage used for storing data for file shares.
-
#nfs_file_share_defaults ⇒ Types::NFSFileShareDefaults
File share default values.
-
#notification_policy ⇒ String
The notification policy of the file share.
-
#object_acl ⇒ String
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into.
-
#read_only ⇒ Boolean
A value that sets the write status of a file share.
-
#requester_pays ⇒ Boolean
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
-
#role ⇒ String
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
-
#squash ⇒ String
A value that maps a user to anonymous user.
-
#tags ⇒ Array<Types::Tag>
A list of up to 50 tags that can be assigned to the NFS file share.
-
#vpc_endpoint_dns_name ⇒ String
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.
Instance Attribute Details
#audit_destination_arn ⇒ String
The Amazon Resource Name (ARN) of the storage used for audit logs.
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#bucket_region ⇒ String
Specifies the Region of the S3 bucket where the NFS file share stores files.
<note markdown=“1”> This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
</note>
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#cache_attributes ⇒ Types::CacheAttributes
Specifies refresh cache information for the file share.
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#client_list ⇒ Array<String>
The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IP addresses or valid CIDR blocks.
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#client_token ⇒ String
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#default_storage_class ⇒ String
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is ‘S3_STANDARD`. Optional.
Valid Values: ‘S3_STANDARD` | `S3_INTELLIGENT_TIERING` | `S3_STANDARD_IA` | `S3_ONEZONE_IA`
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#file_share_name ⇒ String
The name of the file share. Optional.
<note markdown=“1”> ‘FileShareName` must be set if an S3 prefix name is set in `LocationARN`, or if an access point or access point alias is used.
</note>
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#gateway_arn ⇒ String
The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file share.
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#guess_mime_type_enabled ⇒ Boolean
A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to ‘true` to enable MIME type guessing, otherwise set to `false`. The default value is `true`.
Valid Values: ‘true` | `false`
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#kms_encrypted ⇒ Boolean
Set to ‘true` to use Amazon S3 server-side encryption with your own KMS key, or `false` to use a key managed by Amazon S3. Optional.
Valid Values: ‘true` | `false`
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#kms_key ⇒ String
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when ‘KMSEncrypted` is `true`. Optional.
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#location_arn ⇒ String
A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).
<note markdown=“1”> You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.
Bucket ARN:
`arn:aws:s3:::my-bucket/prefix/`
Access point ARN:
`arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/`
If you specify an access point, the bucket policy must be configured
to delegate access control to the access point. For information, see
- Delegating access control to access points][1
-
in the *Amazon S3
User Guide*.
Access point alias:
`test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias`
</note>
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#nfs_file_share_defaults ⇒ Types::NFSFileShareDefaults
File share default values. Optional.
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#notification_policy ⇒ String
The notification policy of the file share. ‘SettlingTimeInSeconds` controls the number of seconds to wait after the last point in time a client wrote to a file before generating an `ObjectUploaded` notification. Because clients can make many small writes to files, it’s best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.
<note markdown=“1”> ‘SettlingTimeInSeconds` has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.
</note>
The following example sets ‘NotificationPolicy` on with `SettlingTimeInSeconds` set to 60.
‘{“SettlingTimeInSeconds”: 60}`
The following example sets ‘NotificationPolicy` off.
‘{}`
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#object_acl ⇒ String
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is ‘private`.
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#read_only ⇒ Boolean
A value that sets the write status of a file share. Set this value to ‘true` to set the write status to read-only, otherwise set to `false`.
Valid Values: ‘true` | `false`
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#requester_pays ⇒ Boolean
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to ‘true`, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
<note markdown=“1”> ‘RequesterPays` is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
</note>
Valid Values: ‘true` | `false`
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#role ⇒ String
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#squash ⇒ String
A value that maps a user to anonymous user.
Valid values are the following:
-
‘RootSquash`: Only root is mapped to anonymous user.
-
‘NoSquash`: No one is mapped to anonymous user.
-
‘AllSquash`: Everyone is mapped to anonymous user.
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
<note markdown=“1”> Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag’s key is 128 characters, and the maximum length for a tag’s value is 256.
</note>
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |
#vpc_endpoint_dns_name ⇒ String
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.
<note markdown=“1”> This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
</note>
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 1233 class CreateNFSFileShareInput < Struct.new( :client_token, :nfs_file_share_defaults, :gateway_arn, :kms_encrypted, :kms_key, :role, :location_arn, :default_storage_class, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :audit_destination_arn) SENSITIVE = [] include Aws::Structure end |