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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateNFSFileShareInput as input to an Aws::Client method, you can use a vanilla 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",
  client_list: ["IPV4AddressCIDR"],
  squash: "Squash",
  read_only: false,
  guess_mime_type_enabled: false,
}

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>)

    The list of clients that are allowed to access the file gateway.

#client_tokenString

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

Returns:

  • (String)

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

#default_storage_classString

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

Returns:

  • (String)

    The default storage class for objects put into an Amazon S3 bucket by file gateway.

#gateway_arnString

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

Returns:

  • (String)

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

#guess_mime_type_enabledBoolean

Enables guessing of the MIME type for uploaded objects based on file extensions: \"true\" to enable MIME type guessing, and otherwise \"false\".

Returns:

  • (Boolean)

    Enables guessing of the MIME type for uploaded objects based on file extensions: \"true\" to enable MIME type guessing, and otherwise \"false\".

#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)

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

#kms_keyString

The KMS key used for Amazon S3 server side encryption. This value can only be set when KmsEncrypted is true. Optional.

Returns:

  • (String)

    The KMS key used for Amazon S3 server side encryption.

#location_arnString

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

Returns:

  • (String)

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

#nfs_file_share_defaultsTypes::NFSFileShareDefaults

File share default values. Optional.

Returns:

#read_onlyBoolean

Sets the write status of a file share: \"true\" if the write status is read-only, and otherwise \"false\".

Returns:

  • (Boolean)

    Sets the write status of a file share: \"true\" if the write status is read-only, and otherwise \"false\".

#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)

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

#squashString

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)

    Maps a user to anonymous user.