This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-iam/include/aws/iam/model/CreateVirtualMFADeviceRequest.h

244 lines
13 KiB
C
Raw Normal View History

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/iam/IAM_EXPORTS.h>
#include <aws/iam/IAMRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace IAM
{
namespace Model
{
/**
*/
class AWS_IAM_API CreateVirtualMFADeviceRequest : public IAMRequest
{
public:
CreateVirtualMFADeviceRequest();
// 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 "CreateVirtualMFADevice"; }
Aws::String SerializePayload() const override;
protected:
void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
public:
/**
* <p> The path for the virtual MFA device. For more information about paths, see
* <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional.
* If it is not included, it defaults to a slash (/).</p> <p>This parameter allows
* (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a
* string of characters consisting of either a forward slash (/) by itself or a
* string that must begin and end with forward slashes. In addition, it can contain
* any ASCII character from the ! (<code>\u0021</code>) through the DEL character
* (<code>\u007F</code>), including most punctuation characters, digits, and upper
* and lowercased letters.</p>
*/
inline const Aws::String& GetPath() const{ return m_path; }
/**
* <p> The path for the virtual MFA device. For more information about paths, see
* <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional.
* If it is not included, it defaults to a slash (/).</p> <p>This parameter allows
* (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a
* string of characters consisting of either a forward slash (/) by itself or a
* string that must begin and end with forward slashes. In addition, it can contain
* any ASCII character from the ! (<code>\u0021</code>) through the DEL character
* (<code>\u007F</code>), including most punctuation characters, digits, and upper
* and lowercased letters.</p>
*/
inline bool PathHasBeenSet() const { return m_pathHasBeenSet; }
/**
* <p> The path for the virtual MFA device. For more information about paths, see
* <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional.
* If it is not included, it defaults to a slash (/).</p> <p>This parameter allows
* (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a
* string of characters consisting of either a forward slash (/) by itself or a
* string that must begin and end with forward slashes. In addition, it can contain
* any ASCII character from the ! (<code>\u0021</code>) through the DEL character
* (<code>\u007F</code>), including most punctuation characters, digits, and upper
* and lowercased letters.</p>
*/
inline void SetPath(const Aws::String& value) { m_pathHasBeenSet = true; m_path = value; }
/**
* <p> The path for the virtual MFA device. For more information about paths, see
* <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional.
* If it is not included, it defaults to a slash (/).</p> <p>This parameter allows
* (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a
* string of characters consisting of either a forward slash (/) by itself or a
* string that must begin and end with forward slashes. In addition, it can contain
* any ASCII character from the ! (<code>\u0021</code>) through the DEL character
* (<code>\u007F</code>), including most punctuation characters, digits, and upper
* and lowercased letters.</p>
*/
inline void SetPath(Aws::String&& value) { m_pathHasBeenSet = true; m_path = std::move(value); }
/**
* <p> The path for the virtual MFA device. For more information about paths, see
* <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional.
* If it is not included, it defaults to a slash (/).</p> <p>This parameter allows
* (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a
* string of characters consisting of either a forward slash (/) by itself or a
* string that must begin and end with forward slashes. In addition, it can contain
* any ASCII character from the ! (<code>\u0021</code>) through the DEL character
* (<code>\u007F</code>), including most punctuation characters, digits, and upper
* and lowercased letters.</p>
*/
inline void SetPath(const char* value) { m_pathHasBeenSet = true; m_path.assign(value); }
/**
* <p> The path for the virtual MFA device. For more information about paths, see
* <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional.
* If it is not included, it defaults to a slash (/).</p> <p>This parameter allows
* (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a
* string of characters consisting of either a forward slash (/) by itself or a
* string that must begin and end with forward slashes. In addition, it can contain
* any ASCII character from the ! (<code>\u0021</code>) through the DEL character
* (<code>\u007F</code>), including most punctuation characters, digits, and upper
* and lowercased letters.</p>
*/
inline CreateVirtualMFADeviceRequest& WithPath(const Aws::String& value) { SetPath(value); return *this;}
/**
* <p> The path for the virtual MFA device. For more information about paths, see
* <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional.
* If it is not included, it defaults to a slash (/).</p> <p>This parameter allows
* (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a
* string of characters consisting of either a forward slash (/) by itself or a
* string that must begin and end with forward slashes. In addition, it can contain
* any ASCII character from the ! (<code>\u0021</code>) through the DEL character
* (<code>\u007F</code>), including most punctuation characters, digits, and upper
* and lowercased letters.</p>
*/
inline CreateVirtualMFADeviceRequest& WithPath(Aws::String&& value) { SetPath(std::move(value)); return *this;}
/**
* <p> The path for the virtual MFA device. For more information about paths, see
* <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional.
* If it is not included, it defaults to a slash (/).</p> <p>This parameter allows
* (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a
* string of characters consisting of either a forward slash (/) by itself or a
* string that must begin and end with forward slashes. In addition, it can contain
* any ASCII character from the ! (<code>\u0021</code>) through the DEL character
* (<code>\u007F</code>), including most punctuation characters, digits, and upper
* and lowercased letters.</p>
*/
inline CreateVirtualMFADeviceRequest& WithPath(const char* value) { SetPath(value); return *this;}
/**
* <p>The name of the virtual MFA device. Use with path to uniquely identify a
* virtual MFA device.</p> <p>This parameter allows (through its <a
* href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters
* consisting of upper and lowercase alphanumeric characters with no spaces. You
* can also include any of the following characters: _+=,.@-</p>
*/
inline const Aws::String& GetVirtualMFADeviceName() const{ return m_virtualMFADeviceName; }
/**
* <p>The name of the virtual MFA device. Use with path to uniquely identify a
* virtual MFA device.</p> <p>This parameter allows (through its <a
* href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters
* consisting of upper and lowercase alphanumeric characters with no spaces. You
* can also include any of the following characters: _+=,.@-</p>
*/
inline bool VirtualMFADeviceNameHasBeenSet() const { return m_virtualMFADeviceNameHasBeenSet; }
/**
* <p>The name of the virtual MFA device. Use with path to uniquely identify a
* virtual MFA device.</p> <p>This parameter allows (through its <a
* href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters
* consisting of upper and lowercase alphanumeric characters with no spaces. You
* can also include any of the following characters: _+=,.@-</p>
*/
inline void SetVirtualMFADeviceName(const Aws::String& value) { m_virtualMFADeviceNameHasBeenSet = true; m_virtualMFADeviceName = value; }
/**
* <p>The name of the virtual MFA device. Use with path to uniquely identify a
* virtual MFA device.</p> <p>This parameter allows (through its <a
* href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters
* consisting of upper and lowercase alphanumeric characters with no spaces. You
* can also include any of the following characters: _+=,.@-</p>
*/
inline void SetVirtualMFADeviceName(Aws::String&& value) { m_virtualMFADeviceNameHasBeenSet = true; m_virtualMFADeviceName = std::move(value); }
/**
* <p>The name of the virtual MFA device. Use with path to uniquely identify a
* virtual MFA device.</p> <p>This parameter allows (through its <a
* href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters
* consisting of upper and lowercase alphanumeric characters with no spaces. You
* can also include any of the following characters: _+=,.@-</p>
*/
inline void SetVirtualMFADeviceName(const char* value) { m_virtualMFADeviceNameHasBeenSet = true; m_virtualMFADeviceName.assign(value); }
/**
* <p>The name of the virtual MFA device. Use with path to uniquely identify a
* virtual MFA device.</p> <p>This parameter allows (through its <a
* href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters
* consisting of upper and lowercase alphanumeric characters with no spaces. You
* can also include any of the following characters: _+=,.@-</p>
*/
inline CreateVirtualMFADeviceRequest& WithVirtualMFADeviceName(const Aws::String& value) { SetVirtualMFADeviceName(value); return *this;}
/**
* <p>The name of the virtual MFA device. Use with path to uniquely identify a
* virtual MFA device.</p> <p>This parameter allows (through its <a
* href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters
* consisting of upper and lowercase alphanumeric characters with no spaces. You
* can also include any of the following characters: _+=,.@-</p>
*/
inline CreateVirtualMFADeviceRequest& WithVirtualMFADeviceName(Aws::String&& value) { SetVirtualMFADeviceName(std::move(value)); return *this;}
/**
* <p>The name of the virtual MFA device. Use with path to uniquely identify a
* virtual MFA device.</p> <p>This parameter allows (through its <a
* href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters
* consisting of upper and lowercase alphanumeric characters with no spaces. You
* can also include any of the following characters: _+=,.@-</p>
*/
inline CreateVirtualMFADeviceRequest& WithVirtualMFADeviceName(const char* value) { SetVirtualMFADeviceName(value); return *this;}
private:
Aws::String m_path;
bool m_pathHasBeenSet;
Aws::String m_virtualMFADeviceName;
bool m_virtualMFADeviceNameHasBeenSet;
};
} // namespace Model
} // namespace IAM
} // namespace Aws