AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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",
  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
    },
  ],
  file_share_name: "FileShareName",
  cache_attributes: {
    cache_stale_timeout_in_seconds: 1,
  },
  notification_policy: "NotificationPolicy",
}

CreateNFSFileShareInput

Instance Attribute Summary collapse

Instance Attribute Details

#cache_attributesTypes::CacheAttributes

Refresh cache information.

Returns:

#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 the file gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Returns:

  • (String)

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

#file_share_nameString

The name of the file share. Optional.

FileShareName must be set if an S3 prefix name is set in LocationARN.

Returns:

  • (String)

    The name of the file share.

#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

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

Returns:

  • (Boolean)

    A value that enables guessing of the MIME type for uploaded objects based on file extensions.

#kms_encryptedBoolean

Set to 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.

Valid Values: true | false

Returns:

  • (Boolean)

    Set to 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 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.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.

#location_arnString

The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a \"/\".

Returns:

  • (String)

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

#nfs_file_share_defaultsTypes::NFSFileShareDefaults

File share default values. Optional.

Returns:

#notification_policyString

The notification policy of the file share.

Returns:

  • (String)

    The notification policy of the file share.

#object_aclString

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

Possible values:

  • private
  • public-read
  • public-read-write
  • authenticated-read
  • bucket-owner-read
  • bucket-owner-full-control
  • aws-exec-read

Returns:

  • (String)

    A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into.

#read_onlyBoolean

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

Returns:

  • (Boolean)

    A value that sets the write status of a file share.

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

Valid Values: true | false

Returns:

  • (Boolean)

    A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.

#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

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.

Returns:

  • (String)

    A value that maps a user to anonymous user.

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

  • (Array<Types::Tag>)

    A list of up to 50 tags that can be assigned to the NFS file share.