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/EnableMFADeviceRequest.h

420 lines
22 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 EnableMFADeviceRequest : public IAMRequest
{
public:
EnableMFADeviceRequest();
// 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 "EnableMFADevice"; }
Aws::String SerializePayload() const override;
protected:
void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
public:
/**
* <p>The name of the IAM user for whom you want to enable the 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& GetUserName() const{ return m_userName; }
/**
* <p>The name of the IAM user for whom you want to enable the 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 UserNameHasBeenSet() const { return m_userNameHasBeenSet; }
/**
* <p>The name of the IAM user for whom you want to enable the 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 SetUserName(const Aws::String& value) { m_userNameHasBeenSet = true; m_userName = value; }
/**
* <p>The name of the IAM user for whom you want to enable the 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 SetUserName(Aws::String&& value) { m_userNameHasBeenSet = true; m_userName = std::move(value); }
/**
* <p>The name of the IAM user for whom you want to enable the 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 SetUserName(const char* value) { m_userNameHasBeenSet = true; m_userName.assign(value); }
/**
* <p>The name of the IAM user for whom you want to enable the 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 EnableMFADeviceRequest& WithUserName(const Aws::String& value) { SetUserName(value); return *this;}
/**
* <p>The name of the IAM user for whom you want to enable the 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 EnableMFADeviceRequest& WithUserName(Aws::String&& value) { SetUserName(std::move(value)); return *this;}
/**
* <p>The name of the IAM user for whom you want to enable the 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 EnableMFADeviceRequest& WithUserName(const char* value) { SetUserName(value); return *this;}
/**
* <p>The serial number that uniquely identifies the MFA device. For virtual MFA
* devices, the serial number is the device ARN.</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& GetSerialNumber() const{ return m_serialNumber; }
/**
* <p>The serial number that uniquely identifies the MFA device. For virtual MFA
* devices, the serial number is the device ARN.</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 SerialNumberHasBeenSet() const { return m_serialNumberHasBeenSet; }
/**
* <p>The serial number that uniquely identifies the MFA device. For virtual MFA
* devices, the serial number is the device ARN.</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 SetSerialNumber(const Aws::String& value) { m_serialNumberHasBeenSet = true; m_serialNumber = value; }
/**
* <p>The serial number that uniquely identifies the MFA device. For virtual MFA
* devices, the serial number is the device ARN.</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 SetSerialNumber(Aws::String&& value) { m_serialNumberHasBeenSet = true; m_serialNumber = std::move(value); }
/**
* <p>The serial number that uniquely identifies the MFA device. For virtual MFA
* devices, the serial number is the device ARN.</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 SetSerialNumber(const char* value) { m_serialNumberHasBeenSet = true; m_serialNumber.assign(value); }
/**
* <p>The serial number that uniquely identifies the MFA device. For virtual MFA
* devices, the serial number is the device ARN.</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 EnableMFADeviceRequest& WithSerialNumber(const Aws::String& value) { SetSerialNumber(value); return *this;}
/**
* <p>The serial number that uniquely identifies the MFA device. For virtual MFA
* devices, the serial number is the device ARN.</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 EnableMFADeviceRequest& WithSerialNumber(Aws::String&& value) { SetSerialNumber(std::move(value)); return *this;}
/**
* <p>The serial number that uniquely identifies the MFA device. For virtual MFA
* devices, the serial number is the device ARN.</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 EnableMFADeviceRequest& WithSerialNumber(const char* value) { SetSerialNumber(value); return *this;}
/**
* <p>An authentication code emitted by the device. </p> <p>The format for this
* parameter is a string of six digits.</p> <p>Submit your request
* immediately after generating the authentication codes. If you generate the codes
* and then wait too long to submit the request, the MFA device successfully
* associates with the user but the MFA device becomes out of sync. This happens
* because time-based one-time passwords (TOTP) expire after a short period of
* time. If this happens, you can <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html">resync
* the device</a>.</p>
*/
inline const Aws::String& GetAuthenticationCode1() const{ return m_authenticationCode1; }
/**
* <p>An authentication code emitted by the device. </p> <p>The format for this
* parameter is a string of six digits.</p> <p>Submit your request
* immediately after generating the authentication codes. If you generate the codes
* and then wait too long to submit the request, the MFA device successfully
* associates with the user but the MFA device becomes out of sync. This happens
* because time-based one-time passwords (TOTP) expire after a short period of
* time. If this happens, you can <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html">resync
* the device</a>.</p>
*/
inline bool AuthenticationCode1HasBeenSet() const { return m_authenticationCode1HasBeenSet; }
/**
* <p>An authentication code emitted by the device. </p> <p>The format for this
* parameter is a string of six digits.</p> <p>Submit your request
* immediately after generating the authentication codes. If you generate the codes
* and then wait too long to submit the request, the MFA device successfully
* associates with the user but the MFA device becomes out of sync. This happens
* because time-based one-time passwords (TOTP) expire after a short period of
* time. If this happens, you can <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html">resync
* the device</a>.</p>
*/
inline void SetAuthenticationCode1(const Aws::String& value) { m_authenticationCode1HasBeenSet = true; m_authenticationCode1 = value; }
/**
* <p>An authentication code emitted by the device. </p> <p>The format for this
* parameter is a string of six digits.</p> <p>Submit your request
* immediately after generating the authentication codes. If you generate the codes
* and then wait too long to submit the request, the MFA device successfully
* associates with the user but the MFA device becomes out of sync. This happens
* because time-based one-time passwords (TOTP) expire after a short period of
* time. If this happens, you can <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html">resync
* the device</a>.</p>
*/
inline void SetAuthenticationCode1(Aws::String&& value) { m_authenticationCode1HasBeenSet = true; m_authenticationCode1 = std::move(value); }
/**
* <p>An authentication code emitted by the device. </p> <p>The format for this
* parameter is a string of six digits.</p> <p>Submit your request
* immediately after generating the authentication codes. If you generate the codes
* and then wait too long to submit the request, the MFA device successfully
* associates with the user but the MFA device becomes out of sync. This happens
* because time-based one-time passwords (TOTP) expire after a short period of
* time. If this happens, you can <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html">resync
* the device</a>.</p>
*/
inline void SetAuthenticationCode1(const char* value) { m_authenticationCode1HasBeenSet = true; m_authenticationCode1.assign(value); }
/**
* <p>An authentication code emitted by the device. </p> <p>The format for this
* parameter is a string of six digits.</p> <p>Submit your request
* immediately after generating the authentication codes. If you generate the codes
* and then wait too long to submit the request, the MFA device successfully
* associates with the user but the MFA device becomes out of sync. This happens
* because time-based one-time passwords (TOTP) expire after a short period of
* time. If this happens, you can <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html">resync
* the device</a>.</p>
*/
inline EnableMFADeviceRequest& WithAuthenticationCode1(const Aws::String& value) { SetAuthenticationCode1(value); return *this;}
/**
* <p>An authentication code emitted by the device. </p> <p>The format for this
* parameter is a string of six digits.</p> <p>Submit your request
* immediately after generating the authentication codes. If you generate the codes
* and then wait too long to submit the request, the MFA device successfully
* associates with the user but the MFA device becomes out of sync. This happens
* because time-based one-time passwords (TOTP) expire after a short period of
* time. If this happens, you can <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html">resync
* the device</a>.</p>
*/
inline EnableMFADeviceRequest& WithAuthenticationCode1(Aws::String&& value) { SetAuthenticationCode1(std::move(value)); return *this;}
/**
* <p>An authentication code emitted by the device. </p> <p>The format for this
* parameter is a string of six digits.</p> <p>Submit your request
* immediately after generating the authentication codes. If you generate the codes
* and then wait too long to submit the request, the MFA device successfully
* associates with the user but the MFA device becomes out of sync. This happens
* because time-based one-time passwords (TOTP) expire after a short period of
* time. If this happens, you can <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html">resync
* the device</a>.</p>
*/
inline EnableMFADeviceRequest& WithAuthenticationCode1(const char* value) { SetAuthenticationCode1(value); return *this;}
/**
* <p>A subsequent authentication code emitted by the device.</p> <p>The format for
* this parameter is a string of six digits.</p> <p>Submit your request
* immediately after generating the authentication codes. If you generate the codes
* and then wait too long to submit the request, the MFA device successfully
* associates with the user but the MFA device becomes out of sync. This happens
* because time-based one-time passwords (TOTP) expire after a short period of
* time. If this happens, you can <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html">resync
* the device</a>.</p>
*/
inline const Aws::String& GetAuthenticationCode2() const{ return m_authenticationCode2; }
/**
* <p>A subsequent authentication code emitted by the device.</p> <p>The format for
* this parameter is a string of six digits.</p> <p>Submit your request
* immediately after generating the authentication codes. If you generate the codes
* and then wait too long to submit the request, the MFA device successfully
* associates with the user but the MFA device becomes out of sync. This happens
* because time-based one-time passwords (TOTP) expire after a short period of
* time. If this happens, you can <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html">resync
* the device</a>.</p>
*/
inline bool AuthenticationCode2HasBeenSet() const { return m_authenticationCode2HasBeenSet; }
/**
* <p>A subsequent authentication code emitted by the device.</p> <p>The format for
* this parameter is a string of six digits.</p> <p>Submit your request
* immediately after generating the authentication codes. If you generate the codes
* and then wait too long to submit the request, the MFA device successfully
* associates with the user but the MFA device becomes out of sync. This happens
* because time-based one-time passwords (TOTP) expire after a short period of
* time. If this happens, you can <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html">resync
* the device</a>.</p>
*/
inline void SetAuthenticationCode2(const Aws::String& value) { m_authenticationCode2HasBeenSet = true; m_authenticationCode2 = value; }
/**
* <p>A subsequent authentication code emitted by the device.</p> <p>The format for
* this parameter is a string of six digits.</p> <p>Submit your request
* immediately after generating the authentication codes. If you generate the codes
* and then wait too long to submit the request, the MFA device successfully
* associates with the user but the MFA device becomes out of sync. This happens
* because time-based one-time passwords (TOTP) expire after a short period of
* time. If this happens, you can <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html">resync
* the device</a>.</p>
*/
inline void SetAuthenticationCode2(Aws::String&& value) { m_authenticationCode2HasBeenSet = true; m_authenticationCode2 = std::move(value); }
/**
* <p>A subsequent authentication code emitted by the device.</p> <p>The format for
* this parameter is a string of six digits.</p> <p>Submit your request
* immediately after generating the authentication codes. If you generate the codes
* and then wait too long to submit the request, the MFA device successfully
* associates with the user but the MFA device becomes out of sync. This happens
* because time-based one-time passwords (TOTP) expire after a short period of
* time. If this happens, you can <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html">resync
* the device</a>.</p>
*/
inline void SetAuthenticationCode2(const char* value) { m_authenticationCode2HasBeenSet = true; m_authenticationCode2.assign(value); }
/**
* <p>A subsequent authentication code emitted by the device.</p> <p>The format for
* this parameter is a string of six digits.</p> <p>Submit your request
* immediately after generating the authentication codes. If you generate the codes
* and then wait too long to submit the request, the MFA device successfully
* associates with the user but the MFA device becomes out of sync. This happens
* because time-based one-time passwords (TOTP) expire after a short period of
* time. If this happens, you can <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html">resync
* the device</a>.</p>
*/
inline EnableMFADeviceRequest& WithAuthenticationCode2(const Aws::String& value) { SetAuthenticationCode2(value); return *this;}
/**
* <p>A subsequent authentication code emitted by the device.</p> <p>The format for
* this parameter is a string of six digits.</p> <p>Submit your request
* immediately after generating the authentication codes. If you generate the codes
* and then wait too long to submit the request, the MFA device successfully
* associates with the user but the MFA device becomes out of sync. This happens
* because time-based one-time passwords (TOTP) expire after a short period of
* time. If this happens, you can <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html">resync
* the device</a>.</p>
*/
inline EnableMFADeviceRequest& WithAuthenticationCode2(Aws::String&& value) { SetAuthenticationCode2(std::move(value)); return *this;}
/**
* <p>A subsequent authentication code emitted by the device.</p> <p>The format for
* this parameter is a string of six digits.</p> <p>Submit your request
* immediately after generating the authentication codes. If you generate the codes
* and then wait too long to submit the request, the MFA device successfully
* associates with the user but the MFA device becomes out of sync. This happens
* because time-based one-time passwords (TOTP) expire after a short period of
* time. If this happens, you can <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html">resync
* the device</a>.</p>
*/
inline EnableMFADeviceRequest& WithAuthenticationCode2(const char* value) { SetAuthenticationCode2(value); return *this;}
private:
Aws::String m_userName;
bool m_userNameHasBeenSet;
Aws::String m_serialNumber;
bool m_serialNumberHasBeenSet;
Aws::String m_authenticationCode1;
bool m_authenticationCode1HasBeenSet;
Aws::String m_authenticationCode2;
bool m_authenticationCode2HasBeenSet;
};
} // namespace Model
} // namespace IAM
} // namespace Aws