You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::StorageGateway::Types::CreateNFSFileShareInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb

Overview

Note:

When making an API call, you may pass CreateNFSFileShareInput data as a hash:

{
  client_token: "ClientToken", # required
  nfs_file_share_defaults: {
    file_mode: "PermissionMode",
    directory_mode: "PermissionMode",
    group_id: 1,
    owner_id: 1,
  },
  gateway_arn: "GatewayARN", # required
  kms_encrypted: false,
  kms_key: "KMSKey",
  role: "Role", # required
  location_arn: "LocationARN", # required
  default_storage_class: "StorageClass",
  object_acl: "private", # accepts private, public-read, public-read-write, authenticated-read, bucket-owner-read, bucket-owner-full-control, aws-exec-read
  client_list: ["IPV4AddressCIDR"],
  squash: "Squash",
  read_only: false,
  guess_mime_type_enabled: false,
  requester_pays: false,
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

CreateNFSFileShareInput

Instance Attribute Summary collapse

Instance Attribute Details

#client_listArray<String>

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

Returns:

  • (Array<String>)


973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 973

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)
  include Aws::Structure
end

#client_tokenString

A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

Returns:

  • (String)


973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 973

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)
  include Aws::Structure
end

#default_storage_classString

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

Returns:

  • (String)


973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 973

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)
  include Aws::Structure
end

#gateway_arnString

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

Returns:

  • (String)


973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 973

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)
  include Aws::Structure
end

#guess_mime_type_enabledBoolean

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, and otherwise to false. The default value is true.

Returns:

  • (Boolean)


973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 973

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)
  include Aws::Structure
end

#kms_encryptedBoolean

True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Returns:

  • (Boolean)


973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 973

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)
  include Aws::Structure
end

#kms_keyString

The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

Returns:

  • (String)


973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 973

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)
  include Aws::Structure
end

#location_arnString

The ARN of the backed storage used for storing file data.

Returns:

  • (String)


973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 973

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)
  include Aws::Structure
end

#nfs_file_share_defaultsTypes::NFSFileShareDefaults

File share default values. Optional.



973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 973

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)
  include Aws::Structure
end

#object_aclString

A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

Returns:

  • (String)


973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 973

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)
  include Aws::Structure
end

#read_onlyBoolean

A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

Returns:

  • (Boolean)


973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 973

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)
  include Aws::Structure
end

#requester_paysBoolean

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.

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.

Returns:

  • (Boolean)


973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 973

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)
  include Aws::Structure
end

#roleString

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

Returns:

  • (String)


973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 973

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)
  include Aws::Structure
end

#squashString

A value that maps a user to anonymous user. Valid options 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.

Returns:

  • (String)


973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 973

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)
  include Aws::Structure
end

#tagsArray<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.

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.

Returns:



973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 973

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)
  include Aws::Structure
end