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"],
  audit_destination_arn: "AuditDestinationARN",
  authentication: "Authentication",
  case_sensitivity: "ClientSpecified", # accepts ClientSpecified, CaseSensitive
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  file_share_name: "FileShareName",
  cache_attributes: {
    cache_stale_timeout_in_seconds: 1,
  },
}

CreateSMBFileShareInput

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#admin_user_listArray<String>

A list of users or groups 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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1.

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


1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#audit_destination_arnString

The Amazon Resource Name (ARN) of the storage used for the audit logs.

Returns:

  • (String)


1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#authenticationString

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

Valid Values: ActiveDirectory | GuestAccess

Returns:

  • (String)


1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#cache_attributesTypes::CacheAttributes

Refresh cache information.



1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#case_sensitivityString

The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.

Returns:

  • (String)


1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  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)


1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  include Aws::Structure
end

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


1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  include Aws::Structure
end

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


1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_arnString

The ARN of the file gateway on which you want to create a file share.

Returns:

  • (String)


1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  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, otherwise set to false. The default value is true.

Valid Values: true | false

Returns:

  • (Boolean)


1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.

Returns:

  • (Array<String>)


1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  include Aws::Structure
end

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


1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  include Aws::Structure
end

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


1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  include Aws::Structure
end

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


1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String)


1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  include Aws::Structure
end

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


1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  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.

Valid Values: true | false

Returns:

  • (Boolean)


1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  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)


1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#smbacl_enabledBoolean

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

For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the AWS Storage Gateway User Guide.

Valid Values: true | false

Returns:

  • (Boolean)


1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  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:



1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.

Returns:

  • (Array<String>)


1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1388

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,
  :audit_destination_arn,
  :authentication,
  :case_sensitivity,
  :tags,
  :file_share_name,
  :cache_attributes)
  SENSITIVE = []
  include Aws::Structure
end