You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::StorageGateway::Types::CreateSMBFileShareInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::StorageGateway::Types::CreateSMBFileShareInput
- Defined in:
- (unknown)
Overview
When passing CreateSMBFileShareInput as input to an Aws::Client method, you can use a vanilla 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,
access_based_enumeration: 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,
},
notification_policy: "NotificationPolicy",
}
CreateSMBFileShareInput
Instance Attribute Summary collapse
-
#access_based_enumeration ⇒ Boolean
The files and folders on this share will only be visible to users with read access.
-
#admin_user_list ⇒ Array<String>
A list of users or groups in the Active Directory that will be granted administrator privileges on the file share.
-
#audit_destination_arn ⇒ String
The Amazon Resource Name (ARN) of the storage used for the audit logs.
-
#authentication ⇒ String
The authentication method that users use to access the file share.
-
#cache_attributes ⇒ Types::CacheAttributes
Refresh cache information.
-
#case_sensitivity ⇒ String
The case of an object name in an Amazon S3 bucket.
-
#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 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.
-
#invalid_user_list ⇒ Array<String>
A list of users or groups in the Active Directory that are not allowed to access the file share.
-
#kms_encrypted ⇒ Boolean
Set to
true
to use Amazon S3 server-side encryption with your own AWS KMS key, orfalse
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.
-
#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.
-
#smbacl_enabled ⇒ Boolean
Set this value to
true
to enable access control list (ACL) on the SMB file share. -
#tags ⇒ Array<Types::Tag>
A list of up to 50 tags that can be assigned to the NFS file share.
- #valid_user_list ⇒ Array<String>
Instance Attribute Details
#access_based_enumeration ⇒ Boolean
The files and folders on this share will only be visible to users with read access.
#admin_user_list ⇒ Array<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
.
#audit_destination_arn ⇒ String
The Amazon Resource Name (ARN) of the storage used for the audit logs.
#authentication ⇒ String
The authentication method that users use to access the file share. The
default is ActiveDirectory
.
Valid Values: ActiveDirectory
| GuestAccess
#cache_attributes ⇒ Types::CacheAttributes
Refresh cache information.
#case_sensitivity ⇒ String
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
.
Possible values:
- ClientSpecified
- CaseSensitive
#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. The default value is S3_INTELLIGENT_TIERING
.
Optional.
Valid Values: S3_STANDARD
| S3_INTELLIGENT_TIERING
|
S3_STANDARD_IA
| S3_ONEZONE_IA
#file_share_name ⇒ String
The name of the file share. Optional.
FileShareName
must be set if an S3 prefix name is set in
LocationARN
.
#gateway_arn ⇒ String
The 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. Set this value to true
to enable MIME type
guessing, otherwise set to false
. The default value is true
.
Valid Values: true
| false
#invalid_user_list ⇒ Array<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
.
#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
#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.
#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 \"/\".
#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. 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
#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
#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.
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
#role ⇒ String
The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
#smbacl_enabled ⇒ Boolean
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
#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.