CreateSMBFileShareInput

public struct CreateSMBFileShareInput : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let adminUserList: [String]?

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

    Declaration

    Swift

    public let auditDestinationARN: String?

  • The authentication method that users use to access the file share. The default is ActiveDirectory. Valid Values: ActiveDirectory | GuestAccess

    Declaration

    Swift

    public let authentication: String?

  • Refresh cache information.

    Declaration

    Swift

    public let cacheAttributes: CacheAttributes?

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

    Declaration

    Swift

    public let caseSensitivity: CaseSensitivity?

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

    Declaration

    Swift

    public let clientToken: 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

    Declaration

    Swift

    public let defaultStorageClass: String?

  • The name of the file share. Optional. FileShareName must be set if an S3 prefix name is set in LocationARN.

    Declaration

    Swift

    public let fileShareName: String?

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

    Declaration

    Swift

    public let gatewayARN: String

  • 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

    Declaration

    Swift

    public let guessMIMETypeEnabled: Bool?

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

    Declaration

    Swift

    public let invalidUserList: [String]?

  • 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

    Declaration

    Swift

    public let kMSEncrypted: Bool?

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

    Declaration

    Swift

    public let kMSKey: 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 “/”.

    Declaration

    Swift

    public let locationARN: 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.

    Declaration

    Swift

    public let objectACL: ObjectACL?

  • 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

    Declaration

    Swift

    public let readOnly: Bool?

  • 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

    Declaration

    Swift

    public let requesterPays: Bool?

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

    Declaration

    Swift

    public let role: String

  • 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

    Declaration

    Swift

    public let sMBACLEnabled: Bool?

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

    Declaration

    Swift

    public let tags: [Tag]?

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

    Declaration

    Swift

    public let validUserList: [String]?

  • Undocumented

    Declaration

    Swift

    public init(adminUserList: [String]? = nil, auditDestinationARN: String? = nil, authentication: String? = nil, cacheAttributes: CacheAttributes? = nil, caseSensitivity: CaseSensitivity? = nil, clientToken: String, defaultStorageClass: String? = nil, fileShareName: String? = nil, gatewayARN: String, guessMIMETypeEnabled: Bool? = nil, invalidUserList: [String]? = nil, kMSEncrypted: Bool? = nil, kMSKey: String? = nil, locationARN: String, objectACL: ObjectACL? = nil, readOnly: Bool? = nil, requesterPays: Bool? = nil, role: String, sMBACLEnabled: Bool? = nil, tags: [Tag]? = nil, validUserList: [String]? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws