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

Inherits:

Struct

Object
Struct
Aws::StorageGateway::Types::CreateNFSFileShareInput

show all

Includes:: Aws::Structure

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

CreateNFSFileShareInput

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#cache_attributes ⇒ Types::CacheAttributes

Refresh cache information.
#client_list ⇒ Array<String>

The list of clients that are allowed to access the file gateway.
#client_token ⇒ String

A unique string value that you supply that is used by 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 file gateway.
#file_share_name ⇒ String

The name of the file share.
#gateway_arn ⇒ String

The Amazon Resource Name (ARN) of the 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 AWS 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

The ARN of the backend storage used for storing file data.
#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 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 AWS Identity and Access Management (IAM) role that a 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.

Instance Attribute Details

#cache_attributes ⇒ `Types::CacheAttributes`

Refresh cache information.

Returns:

(Types::CacheAttributes)

# File 'lib/aws-sdk-storagegateway/types.rb', line 1255

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)
  SENSITIVE = []
  include Aws::Structure
end

#client_list ⇒ `Array<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>)

# File 'lib/aws-sdk-storagegateway/types.rb', line 1255

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)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 1255

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)
  SENSITIVE = []
  include Aws::Structure
end

#default_storage_class ⇒ `String`

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)

# File 'lib/aws-sdk-storagegateway/types.rb', line 1255

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

</note>

Returns:

(String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 1255

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)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 1255

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

Returns:

(Boolean)

# File 'lib/aws-sdk-storagegateway/types.rb', line 1255

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)
  SENSITIVE = []
  include Aws::Structure
end

#kms_encrypted ⇒ `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. Optional.

Valid Values: ‘true` | `false`

Returns:

(Boolean)

# File 'lib/aws-sdk-storagegateway/types.rb', line 1255

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

Returns:

(String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 1255

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)
  SENSITIVE = []
  include Aws::Structure
end

#location_arn ⇒ `String`

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)

# File 'lib/aws-sdk-storagegateway/types.rb', line 1255

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)
  SENSITIVE = []
  include Aws::Structure
end

#nfs_file_share_defaults ⇒ `Types::NFSFileShareDefaults`

File share default values. Optional.

Returns:

(Types::NFSFileShareDefaults)

# File 'lib/aws-sdk-storagegateway/types.rb', line 1255

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)
  SENSITIVE = []
  include Aws::Structure
end

#notification_policy ⇒ `String`

The notification policy of the file share.

Returns:

(String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 1255

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)
  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 file gateway puts objects into. The default value is ‘private`.

Returns:

(String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 1255

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

Returns:

(Boolean)

# File 'lib/aws-sdk-storagegateway/types.rb', line 1255

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

Returns:

(Boolean)

# File 'lib/aws-sdk-storagegateway/types.rb', line 1255

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)
  SENSITIVE = []
  include Aws::Structure
end

#role ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 1255

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

Returns:

(String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 1255

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

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-storagegateway/types.rb', line 1255

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)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#cache_attributes ⇒ Types::CacheAttributes

#client_list ⇒ Array<String>

#client_token ⇒ String

#default_storage_class ⇒ String

#file_share_name ⇒ String

#gateway_arn ⇒ String

#guess_mime_type_enabled ⇒ Boolean

#kms_encrypted ⇒ Boolean

#kms_key ⇒ String

#location_arn ⇒ String

#nfs_file_share_defaults ⇒ Types::NFSFileShareDefaults

#notification_policy ⇒ String

#object_acl ⇒ String

#read_only ⇒ Boolean

#requester_pays ⇒ Boolean

#role ⇒ String

#squash ⇒ String

#tags ⇒ Array<Types::Tag>

#cache_attributes ⇒ `Types::CacheAttributes`

#client_list ⇒ `Array<String>`

#client_token ⇒ `String`

#default_storage_class ⇒ `String`

#file_share_name ⇒ `String`

#gateway_arn ⇒ `String`

#guess_mime_type_enabled ⇒ `Boolean`

#kms_encrypted ⇒ `Boolean`

#kms_key ⇒ `String`

#location_arn ⇒ `String`

#nfs_file_share_defaults ⇒ `Types::NFSFileShareDefaults`

#notification_policy ⇒ `String`

#object_acl ⇒ `String`

#read_only ⇒ `Boolean`

#requester_pays ⇒ `Boolean`

#role ⇒ `String`

#squash ⇒ `String`

#tags ⇒ `Array<Types::Tag>`