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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

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

Instance Attribute Details

#access_based_enumerationBoolean

The files and folders on this share will only be visible to users with read access.

Returns:

  • (Boolean)

    The files and folders on this share will only be visible to users with read access.

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

    A list of users or groups in the Active Directory that will be granted administrator privileges on the file share.

#audit_destination_arnString

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

Returns:

  • (String)

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

#authenticationString

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

Valid Values: ActiveDirectory | GuestAccess

Returns:

  • (String)

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

#cache_attributesTypes::CacheAttributes

Refresh cache information.

Returns:

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

Possible values:

  • ClientSpecified
  • CaseSensitive

Returns:

  • (String)

    The case of an object name in an Amazon S3 bucket.

#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 ARN of the file gateway on which you want to create a file share.

Returns:

  • (String)

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

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

    A list of users or groups in the Active Directory that are not allowed to access the file share.

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

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

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

    Set this value to true to enable access control list (ACL) on the SMB file share.

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

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

    A list of users or groups in the Active Directory that are allowed to access the file share.