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

Class: Aws::StorageGateway::Types::CreateSMBFileShareInput

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 CreateSMBFileShareInput data as a hash:

{
  client_token: "ClientToken", # required
  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
  read_only: false,
  guess_mime_type_enabled: false,
  requester_pays: false,
  smbacl_enabled: false,
  admin_user_list: ["FileShareUser"],
  valid_user_list: ["FileShareUser"],
  invalid_user_list: ["FileShareUser"],
  authentication: "Authentication",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

CreateSMBFileShareInput

Instance Attribute Summary collapse

Instance Attribute Details

#admin_user_listArray<String>

A list of users in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user.

Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.

Returns:

  • (Array<String>)


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1158

class CreateSMBFileShareInput < Struct.new(
  :client_token,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :role,
  :location_arn,
  :default_storage_class,
  :object_acl,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :smbacl_enabled,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :tags)
  include Aws::Structure
end

#authenticationString

The authentication method that users use to access the file share.

Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.

Returns:

  • (String)


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1158

class CreateSMBFileShareInput < Struct.new(
  :client_token,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :role,
  :location_arn,
  :default_storage_class,
  :object_acl,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :smbacl_enabled,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :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)


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1158

class CreateSMBFileShareInput < Struct.new(
  :client_token,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :role,
  :location_arn,
  :default_storage_class,
  :object_acl,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :smbacl_enabled,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :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)


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1158

class CreateSMBFileShareInput < Struct.new(
  :client_token,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :role,
  :location_arn,
  :default_storage_class,
  :object_acl,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :smbacl_enabled,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :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)


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1158

class CreateSMBFileShareInput < Struct.new(
  :client_token,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :role,
  :location_arn,
  :default_storage_class,
  :object_acl,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :smbacl_enabled,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :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)


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1158

class CreateSMBFileShareInput < Struct.new(
  :client_token,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :role,
  :location_arn,
  :default_storage_class,
  :object_acl,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :smbacl_enabled,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :tags)
  include Aws::Structure
end

#invalid_user_listArray<String>

A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Returns:

  • (Array<String>)


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1158

class CreateSMBFileShareInput < Struct.new(
  :client_token,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :role,
  :location_arn,
  :default_storage_class,
  :object_acl,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :smbacl_enabled,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :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)


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1158

class CreateSMBFileShareInput < Struct.new(
  :client_token,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :role,
  :location_arn,
  :default_storage_class,
  :object_acl,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :smbacl_enabled,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :tags)
  include Aws::Structure
end

#kms_keyString

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

Returns:

  • (String)


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1158

class CreateSMBFileShareInput < Struct.new(
  :client_token,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :role,
  :location_arn,
  :default_storage_class,
  :object_acl,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :smbacl_enabled,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :tags)
  include Aws::Structure
end

#location_arnString

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

Returns:

  • (String)


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1158

class CreateSMBFileShareInput < Struct.new(
  :client_token,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :role,
  :location_arn,
  :default_storage_class,
  :object_acl,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :smbacl_enabled,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :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)


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1158

class CreateSMBFileShareInput < Struct.new(
  :client_token,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :role,
  :location_arn,
  :default_storage_class,
  :object_acl,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :smbacl_enabled,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :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)


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1158

class CreateSMBFileShareInput < Struct.new(
  :client_token,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :role,
  :location_arn,
  :default_storage_class,
  :object_acl,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :smbacl_enabled,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :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)


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1158

class CreateSMBFileShareInput < Struct.new(
  :client_token,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :role,
  :location_arn,
  :default_storage_class,
  :object_acl,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :smbacl_enabled,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :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)


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1158

class CreateSMBFileShareInput < Struct.new(
  :client_token,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :role,
  :location_arn,
  :default_storage_class,
  :object_acl,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :smbacl_enabled,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :tags)
  include Aws::Structure
end

#smbacl_enabledBoolean

Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.

For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.

Returns:

  • (Boolean)


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1158

class CreateSMBFileShareInput < Struct.new(
  :client_token,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :role,
  :location_arn,
  :default_storage_class,
  :object_acl,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :smbacl_enabled,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :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:



1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1158

class CreateSMBFileShareInput < Struct.new(
  :client_token,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :role,
  :location_arn,
  :default_storage_class,
  :object_acl,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :smbacl_enabled,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :tags)
  include Aws::Structure
end

#valid_user_listArray<String>

A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Returns:

  • (Array<String>)


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1158

class CreateSMBFileShareInput < Struct.new(
  :client_token,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :role,
  :location_arn,
  :default_storage_class,
  :object_acl,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :smbacl_enabled,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :tags)
  include Aws::Structure
end