/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::StorageGateway::CreateSMBFileShare

NAME

Paws::StorageGateway::CreateSMBFileShare - Arguments for method CreateSMBFileShare on Paws::StorageGateway

DESCRIPTION

This class represents the parameters used for calling the method CreateSMBFileShare on the AWS Storage Gateway service. Use the attributes of this class as arguments to method CreateSMBFileShare.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateSMBFileShare.

SYNOPSIS

my $storagegateway = Paws->service('StorageGateway');
my $CreateSMBFileShareOutput = $storagegateway->CreateSMBFileShare(
  ClientToken            => 'MyClientToken',
  GatewayARN             => 'MyGatewayARN',
  LocationARN            => 'MyLocationARN',
  Role                   => 'MyRole',
  AccessBasedEnumeration => 1,                 # OPTIONAL
  AdminUserList          => [
    'MyUserListUser', ...                      # min: 1, max: 64
  ],    # OPTIONAL
  AuditDestinationARN => 'MyAuditDestinationARN',    # OPTIONAL
  Authentication      => 'MyAuthentication',         # OPTIONAL
  CacheAttributes     => {
    CacheStaleTimeoutInSeconds => 1,                 # OPTIONAL
  },    # OPTIONAL
  CaseSensitivity      => 'ClientSpecified',    # OPTIONAL
  DefaultStorageClass  => 'MyStorageClass',     # OPTIONAL
  FileShareName        => 'MyFileShareName',    # OPTIONAL
  GuessMIMETypeEnabled => 1,                    # OPTIONAL
  InvalidUserList      => [
    'MyUserListUser', ...                       # min: 1, max: 64
  ],    # OPTIONAL
  KMSEncrypted       => 1,                         # OPTIONAL
  KMSKey             => 'MyKMSKey',                # OPTIONAL
  NotificationPolicy => 'MyNotificationPolicy',    # OPTIONAL
  ObjectACL          => 'private',                 # OPTIONAL
  ReadOnly           => 1,                         # OPTIONAL
  RequesterPays      => 1,                         # OPTIONAL
  SMBACLEnabled      => 1,                         # OPTIONAL
  Tags               => [
    {
      Key   => 'MyTagKey',      # min: 1, max: 128
      Value => 'MyTagValue',    # max: 256

    },
    ...
  ],    # OPTIONAL
  ValidUserList => [
    'MyUserListUser', ...    # min: 1, max: 64
  ],    # OPTIONAL
);

# Results:
my $FileShareARN = $CreateSMBFileShareOutput->FileShareARN;

# Returns a L<Paws::StorageGateway::CreateSMBFileShareOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/storagegateway/CreateSMBFileShare

ATTRIBUTES

AccessBasedEnumeration => Bool

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

AdminUserList => ArrayRef[Str|Undef]

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.

AuditDestinationARN => Str

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

Authentication => Str

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

Valid Values: ActiveDirectory | GuestAccess

CacheAttributes => Paws::StorageGateway::CacheAttributes

Specifies refresh cache information for the file share.

CaseSensitivity => Str

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.

Valid values are: "ClientSpecified", "CaseSensitive"

REQUIRED ClientToken => Str

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

DefaultStorageClass => Str

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

FileShareName => Str

The name of the file share. Optional.

FileShareName must be set if an S3 prefix name is set in LocationARN.

REQUIRED GatewayARN => Str

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

GuessMIMETypeEnabled => Bool

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

InvalidUserList => ArrayRef[Str|Undef]

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.

KMSEncrypted => Bool

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

KMSKey => Str

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.

REQUIRED LocationARN => Str

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 "/".

NotificationPolicy => Str

The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

{\"Upload\": {\"SettlingTimeInSeconds\": 60}}

The following example sets NotificationPolicy off.

{}

ObjectACL => Str

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.

Valid values are: "private", "public-read", "public-read-write", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control", "aws-exec-read"

ReadOnly => Bool

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

RequesterPays => 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

REQUIRED Role => Str

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

SMBACLEnabled => Bool

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 (https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html) in the AWS Storage Gateway User Guide.

Valid Values: true | false

Tags => ArrayRef[Paws::StorageGateway::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.

ValidUserList => ArrayRef[Str|Undef]

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateSMBFileShare in Paws::StorageGateway

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues