/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include namespace Aws { namespace StorageGateway { namespace Model { /** *

CreateSMBFileShareInput

*/ class CreateSMBFileShareRequest : public StorageGatewayRequest { public: AWS_STORAGEGATEWAY_API CreateSMBFileShareRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "CreateSMBFileShare"; } AWS_STORAGEGATEWAY_API Aws::String SerializePayload() const override; AWS_STORAGEGATEWAY_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

A unique string value that you supply that is used by S3 File Gateway to * ensure idempotent file share creation.

*/ inline const Aws::String& GetClientToken() const{ return m_clientToken; } /** *

A unique string value that you supply that is used by S3 File Gateway to * ensure idempotent file share creation.

*/ inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; } /** *

A unique string value that you supply that is used by S3 File Gateway to * ensure idempotent file share creation.

*/ inline void SetClientToken(const Aws::String& value) { m_clientTokenHasBeenSet = true; m_clientToken = value; } /** *

A unique string value that you supply that is used by S3 File Gateway to * ensure idempotent file share creation.

*/ inline void SetClientToken(Aws::String&& value) { m_clientTokenHasBeenSet = true; m_clientToken = std::move(value); } /** *

A unique string value that you supply that is used by S3 File Gateway to * ensure idempotent file share creation.

*/ inline void SetClientToken(const char* value) { m_clientTokenHasBeenSet = true; m_clientToken.assign(value); } /** *

A unique string value that you supply that is used by S3 File Gateway to * ensure idempotent file share creation.

*/ inline CreateSMBFileShareRequest& WithClientToken(const Aws::String& value) { SetClientToken(value); return *this;} /** *

A unique string value that you supply that is used by S3 File Gateway to * ensure idempotent file share creation.

*/ inline CreateSMBFileShareRequest& WithClientToken(Aws::String&& value) { SetClientToken(std::move(value)); return *this;} /** *

A unique string value that you supply that is used by S3 File Gateway to * ensure idempotent file share creation.

*/ inline CreateSMBFileShareRequest& WithClientToken(const char* value) { SetClientToken(value); return *this;} /** *

The ARN of the S3 File Gateway on which you want to create a file share.

*/ inline const Aws::String& GetGatewayARN() const{ return m_gatewayARN; } /** *

The ARN of the S3 File Gateway on which you want to create a file share.

*/ inline bool GatewayARNHasBeenSet() const { return m_gatewayARNHasBeenSet; } /** *

The ARN of the S3 File Gateway on which you want to create a file share.

*/ inline void SetGatewayARN(const Aws::String& value) { m_gatewayARNHasBeenSet = true; m_gatewayARN = value; } /** *

The ARN of the S3 File Gateway on which you want to create a file share.

*/ inline void SetGatewayARN(Aws::String&& value) { m_gatewayARNHasBeenSet = true; m_gatewayARN = std::move(value); } /** *

The ARN of the S3 File Gateway on which you want to create a file share.

*/ inline void SetGatewayARN(const char* value) { m_gatewayARNHasBeenSet = true; m_gatewayARN.assign(value); } /** *

The ARN of the S3 File Gateway on which you want to create a file share.

*/ inline CreateSMBFileShareRequest& WithGatewayARN(const Aws::String& value) { SetGatewayARN(value); return *this;} /** *

The ARN of the S3 File Gateway on which you want to create a file share.

*/ inline CreateSMBFileShareRequest& WithGatewayARN(Aws::String&& value) { SetGatewayARN(std::move(value)); return *this;} /** *

The ARN of the S3 File Gateway on which you want to create a file share.

*/ inline CreateSMBFileShareRequest& WithGatewayARN(const char* value) { SetGatewayARN(value); return *this;} /** *

Set to true to use Amazon S3 server-side encryption with your * own KMS key, or false to use a key managed by Amazon S3. * Optional.

Valid Values: true | false

*/ inline bool GetKMSEncrypted() const{ return m_kMSEncrypted; } /** *

Set to true to use Amazon S3 server-side encryption with your * own KMS key, or false to use a key managed by Amazon S3. * Optional.

Valid Values: true | false

*/ inline bool KMSEncryptedHasBeenSet() const { return m_kMSEncryptedHasBeenSet; } /** *

Set to true to use Amazon S3 server-side encryption with your * own KMS key, or false to use a key managed by Amazon S3. * Optional.

Valid Values: true | false

*/ inline void SetKMSEncrypted(bool value) { m_kMSEncryptedHasBeenSet = true; m_kMSEncrypted = value; } /** *

Set to true to use Amazon S3 server-side encryption with your * own KMS key, or false to use a key managed by Amazon S3. * Optional.

Valid Values: true | false

*/ inline CreateSMBFileShareRequest& WithKMSEncrypted(bool value) { SetKMSEncrypted(value); return *this;} /** *

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.

*/ inline const Aws::String& GetKMSKey() const{ return m_kMSKey; } /** *

*/ inline bool KMSKeyHasBeenSet() const { return m_kMSKeyHasBeenSet; } /** *

*/ inline void SetKMSKey(const Aws::String& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = value; } /** *

*/ inline void SetKMSKey(Aws::String&& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = std::move(value); } /** *

*/ inline void SetKMSKey(const char* value) { m_kMSKeyHasBeenSet = true; m_kMSKey.assign(value); } /** *

*/ inline CreateSMBFileShareRequest& WithKMSKey(const Aws::String& value) { SetKMSKey(value); return *this;} /** *

*/ inline CreateSMBFileShareRequest& WithKMSKey(Aws::String&& value) { SetKMSKey(std::move(value)); return *this;} /** *

*/ inline CreateSMBFileShareRequest& WithKMSKey(const char* value) { SetKMSKey(value); return *this;} /** *

The ARN of the Identity and Access Management (IAM) role that an S3 File * Gateway assumes when it accesses the underlying storage.

*/ inline const Aws::String& GetRole() const{ return m_role; } /** *

The ARN of the Identity and Access Management (IAM) role that an S3 File * Gateway assumes when it accesses the underlying storage.

*/ inline bool RoleHasBeenSet() const { return m_roleHasBeenSet; } /** *

The ARN of the Identity and Access Management (IAM) role that an S3 File * Gateway assumes when it accesses the underlying storage.

*/ inline void SetRole(const Aws::String& value) { m_roleHasBeenSet = true; m_role = value; } /** *

The ARN of the Identity and Access Management (IAM) role that an S3 File * Gateway assumes when it accesses the underlying storage.

*/ inline void SetRole(Aws::String&& value) { m_roleHasBeenSet = true; m_role = std::move(value); } /** *

The ARN of the Identity and Access Management (IAM) role that an S3 File * Gateway assumes when it accesses the underlying storage.

*/ inline void SetRole(const char* value) { m_roleHasBeenSet = true; m_role.assign(value); } /** *

The ARN of the Identity and Access Management (IAM) role that an S3 File * Gateway assumes when it accesses the underlying storage.

*/ inline CreateSMBFileShareRequest& WithRole(const Aws::String& value) { SetRole(value); return *this;} /** *

The ARN of the Identity and Access Management (IAM) role that an S3 File * Gateway assumes when it accesses the underlying storage.

*/ inline CreateSMBFileShareRequest& WithRole(Aws::String&& value) { SetRole(std::move(value)); return *this;} /** *

The ARN of the Identity and Access Management (IAM) role that an S3 File * Gateway assumes when it accesses the underlying storage.

*/ inline CreateSMBFileShareRequest& WithRole(const char* value) { SetRole(value); return *this;} /** *

A custom ARN for the backend storage used for storing data for file shares. * It includes a resource ARN with an optional prefix concatenation. The prefix * must end with a forward slash (/).

You can specify LocationARN as * a bucket ARN, access point ARN or access point alias, as shown in the following * examples.

Bucket ARN:

arn:aws:s3:::my-bucket/prefix/ *

Access point ARN:

* arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ *

If you specify an access point, the bucket policy must be configured to * delegate access control to the access point. For information, see Delegating * access control to access points in the Amazon S3 User Guide.

Access point alias:

* test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias

*/ inline const Aws::String& GetLocationARN() const{ return m_locationARN; } /** *

A custom ARN for the backend storage used for storing data for file shares. * It includes a resource ARN with an optional prefix concatenation. The prefix * must end with a forward slash (/).

You can specify LocationARN as * a bucket ARN, access point ARN or access point alias, as shown in the following * examples.

Bucket ARN:

arn:aws:s3:::my-bucket/prefix/ *

Access point ARN:

* arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ *

Access point alias:

* test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias

*/ inline bool LocationARNHasBeenSet() const { return m_locationARNHasBeenSet; } /** *

A custom ARN for the backend storage used for storing data for file shares. * It includes a resource ARN with an optional prefix concatenation. The prefix * must end with a forward slash (/).

You can specify LocationARN as * a bucket ARN, access point ARN or access point alias, as shown in the following * examples.

Bucket ARN:

arn:aws:s3:::my-bucket/prefix/ *

Access point ARN:

* arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ *

Access point alias:

* test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias

*/ inline void SetLocationARN(const Aws::String& value) { m_locationARNHasBeenSet = true; m_locationARN = value; } /** *

A custom ARN for the backend storage used for storing data for file shares. * It includes a resource ARN with an optional prefix concatenation. The prefix * must end with a forward slash (/).

You can specify LocationARN as * a bucket ARN, access point ARN or access point alias, as shown in the following * examples.

Bucket ARN:

arn:aws:s3:::my-bucket/prefix/ *

Access point ARN:

* arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ *

Access point alias:

* test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias

*/ inline void SetLocationARN(Aws::String&& value) { m_locationARNHasBeenSet = true; m_locationARN = std::move(value); } /** *

A custom ARN for the backend storage used for storing data for file shares. * It includes a resource ARN with an optional prefix concatenation. The prefix * must end with a forward slash (/).

You can specify LocationARN as * a bucket ARN, access point ARN or access point alias, as shown in the following * examples.

Bucket ARN:

arn:aws:s3:::my-bucket/prefix/ *

Access point ARN:

* arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ *

Access point alias:

* test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias

*/ inline void SetLocationARN(const char* value) { m_locationARNHasBeenSet = true; m_locationARN.assign(value); } /** *

A custom ARN for the backend storage used for storing data for file shares. * It includes a resource ARN with an optional prefix concatenation. The prefix * must end with a forward slash (/).

You can specify LocationARN as * a bucket ARN, access point ARN or access point alias, as shown in the following * examples.

Bucket ARN:

arn:aws:s3:::my-bucket/prefix/ *

Access point ARN:

* arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ *

Access point alias:

* test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias

*/ inline CreateSMBFileShareRequest& WithLocationARN(const Aws::String& value) { SetLocationARN(value); return *this;} /** *

A custom ARN for the backend storage used for storing data for file shares. * It includes a resource ARN with an optional prefix concatenation. The prefix * must end with a forward slash (/).

You can specify LocationARN as * a bucket ARN, access point ARN or access point alias, as shown in the following * examples.

Bucket ARN:

arn:aws:s3:::my-bucket/prefix/ *

Access point ARN:

* arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ *

Access point alias:

* test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias

*/ inline CreateSMBFileShareRequest& WithLocationARN(Aws::String&& value) { SetLocationARN(std::move(value)); return *this;} /** *

A custom ARN for the backend storage used for storing data for file shares. * It includes a resource ARN with an optional prefix concatenation. The prefix * must end with a forward slash (/).

You can specify LocationARN as * a bucket ARN, access point ARN or access point alias, as shown in the following * examples.

Bucket ARN:

arn:aws:s3:::my-bucket/prefix/ *

Access point ARN:

* arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ *

Access point alias:

* test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias

*/ inline CreateSMBFileShareRequest& WithLocationARN(const char* value) { SetLocationARN(value); return *this;} /** *

The default storage class for objects put into an Amazon S3 bucket by the S3 * File Gateway. The default value is S3_STANDARD. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING * | S3_STANDARD_IA | S3_ONEZONE_IA

*/ inline const Aws::String& GetDefaultStorageClass() const{ return m_defaultStorageClass; } /** *

The default storage class for objects put into an Amazon S3 bucket by the S3 * File Gateway. The default value is S3_STANDARD. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING * | S3_STANDARD_IA | S3_ONEZONE_IA

*/ inline bool DefaultStorageClassHasBeenSet() const { return m_defaultStorageClassHasBeenSet; } /** *

The default storage class for objects put into an Amazon S3 bucket by the S3 * File Gateway. The default value is S3_STANDARD. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING * | S3_STANDARD_IA | S3_ONEZONE_IA

*/ inline void SetDefaultStorageClass(const Aws::String& value) { m_defaultStorageClassHasBeenSet = true; m_defaultStorageClass = value; } /** *

The default storage class for objects put into an Amazon S3 bucket by the S3 * File Gateway. The default value is S3_STANDARD. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING * | S3_STANDARD_IA | S3_ONEZONE_IA

*/ inline void SetDefaultStorageClass(Aws::String&& value) { m_defaultStorageClassHasBeenSet = true; m_defaultStorageClass = std::move(value); } /** *

The default storage class for objects put into an Amazon S3 bucket by the S3 * File Gateway. The default value is S3_STANDARD. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING * | S3_STANDARD_IA | S3_ONEZONE_IA

*/ inline void SetDefaultStorageClass(const char* value) { m_defaultStorageClassHasBeenSet = true; m_defaultStorageClass.assign(value); } /** *

The default storage class for objects put into an Amazon S3 bucket by the S3 * File Gateway. The default value is S3_STANDARD. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING * | S3_STANDARD_IA | S3_ONEZONE_IA

*/ inline CreateSMBFileShareRequest& WithDefaultStorageClass(const Aws::String& value) { SetDefaultStorageClass(value); return *this;} /** *

The default storage class for objects put into an Amazon S3 bucket by the S3 * File Gateway. The default value is S3_STANDARD. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING * | S3_STANDARD_IA | S3_ONEZONE_IA

*/ inline CreateSMBFileShareRequest& WithDefaultStorageClass(Aws::String&& value) { SetDefaultStorageClass(std::move(value)); return *this;} /** *

The default storage class for objects put into an Amazon S3 bucket by the S3 * File Gateway. The default value is S3_STANDARD. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING * | S3_STANDARD_IA | S3_ONEZONE_IA

*/ inline CreateSMBFileShareRequest& WithDefaultStorageClass(const char* value) { SetDefaultStorageClass(value); return *this;} /** *

A value that sets the access control list (ACL) permission for objects in the * S3 bucket that a S3 File Gateway puts objects into. The default value is * private.

*/ inline const ObjectACL& GetObjectACL() const{ return m_objectACL; } /** *

A value that sets the access control list (ACL) permission for objects in the * S3 bucket that a S3 File Gateway puts objects into. The default value is * private.

*/ inline bool ObjectACLHasBeenSet() const { return m_objectACLHasBeenSet; } /** *

A value that sets the access control list (ACL) permission for objects in the * S3 bucket that a S3 File Gateway puts objects into. The default value is * private.

*/ inline void SetObjectACL(const ObjectACL& value) { m_objectACLHasBeenSet = true; m_objectACL = value; } /** *

A value that sets the access control list (ACL) permission for objects in the * S3 bucket that a S3 File Gateway puts objects into. The default value is * private.

*/ inline void SetObjectACL(ObjectACL&& value) { m_objectACLHasBeenSet = true; m_objectACL = std::move(value); } /** *

A value that sets the access control list (ACL) permission for objects in the * S3 bucket that a S3 File Gateway puts objects into. The default value is * private.

*/ inline CreateSMBFileShareRequest& WithObjectACL(const ObjectACL& value) { SetObjectACL(value); return *this;} /** *

A value that sets the access control list (ACL) permission for objects in the * S3 bucket that a S3 File Gateway puts objects into. The default value is * private.

*/ inline CreateSMBFileShareRequest& WithObjectACL(ObjectACL&& value) { SetObjectACL(std::move(value)); return *this;} /** *

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 *

*/ inline bool GetReadOnly() const{ return m_readOnly; } /** *

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 *

*/ inline bool ReadOnlyHasBeenSet() const { return m_readOnlyHasBeenSet; } /** *

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 *

*/ inline void SetReadOnly(bool value) { m_readOnlyHasBeenSet = true; m_readOnly = value; } /** *

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 *

*/ inline CreateSMBFileShareRequest& WithReadOnly(bool value) { SetReadOnly(value); return *this;} /** *

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 *

*/ inline bool GetGuessMIMETypeEnabled() const{ return m_guessMIMETypeEnabled; } /** *

Valid Values: true | false *

*/ inline bool GuessMIMETypeEnabledHasBeenSet() const { return m_guessMIMETypeEnabledHasBeenSet; } /** *

Valid Values: true | false *

*/ inline void SetGuessMIMETypeEnabled(bool value) { m_guessMIMETypeEnabledHasBeenSet = true; m_guessMIMETypeEnabled = value; } /** *

Valid Values: true | false *

*/ inline CreateSMBFileShareRequest& WithGuessMIMETypeEnabled(bool value) { SetGuessMIMETypeEnabled(value); return *this;} /** *

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

*/ inline bool GetRequesterPays() const{ return m_requesterPays; } /** *

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

*/ inline bool RequesterPaysHasBeenSet() const { return m_requesterPaysHasBeenSet; } /** *

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

*/ inline void SetRequesterPays(bool value) { m_requesterPaysHasBeenSet = true; m_requesterPays = value; } /** *

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

*/ inline CreateSMBFileShareRequest& WithRequesterPays(bool value) { SetRequesterPays(value); return *this;} /** *

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 * Storage Gateway User Guide.

Valid Values: true | * false

*/ inline bool GetSMBACLEnabled() const{ return m_sMBACLEnabled; } /** *

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 * Storage Gateway User Guide.

Valid Values: true | * false

*/ inline bool SMBACLEnabledHasBeenSet() const { return m_sMBACLEnabledHasBeenSet; } /** *

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 * Storage Gateway User Guide.

Valid Values: true | * false

*/ inline void SetSMBACLEnabled(bool value) { m_sMBACLEnabledHasBeenSet = true; m_sMBACLEnabled = value; } /** *

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 * Storage Gateway User Guide.

Valid Values: true | * false

*/ inline CreateSMBFileShareRequest& WithSMBACLEnabled(bool value) { SetSMBACLEnabled(value); return *this;} /** *

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

*/ inline bool GetAccessBasedEnumeration() const{ return m_accessBasedEnumeration; } /** *

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

*/ inline bool AccessBasedEnumerationHasBeenSet() const { return m_accessBasedEnumerationHasBeenSet; } /** *

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

*/ inline void SetAccessBasedEnumeration(bool value) { m_accessBasedEnumerationHasBeenSet = true; m_accessBasedEnumeration = value; } /** *

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

*/ inline CreateSMBFileShareRequest& WithAccessBasedEnumeration(bool value) { SetAccessBasedEnumeration(value); return *this;} /** *

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.