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-sagemaker/include/aws/sagemaker/model/CreateUserProfileRequest.h

355 lines
14 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/sagemaker/SageMaker_EXPORTS.h>
#include <aws/sagemaker/SageMakerRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <aws/sagemaker/model/UserSettings.h>
#include <aws/sagemaker/model/Tag.h>
#include <utility>
namespace Aws
{
namespace SageMaker
{
namespace Model
{
/**
*/
class AWS_SAGEMAKER_API CreateUserProfileRequest : public SageMakerRequest
{
public:
CreateUserProfileRequest();
// 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 "CreateUserProfile"; }
Aws::String SerializePayload() const override;
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
/**
* <p>The ID of the associated Domain.</p>
*/
inline const Aws::String& GetDomainId() const{ return m_domainId; }
/**
* <p>The ID of the associated Domain.</p>
*/
inline bool DomainIdHasBeenSet() const { return m_domainIdHasBeenSet; }
/**
* <p>The ID of the associated Domain.</p>
*/
inline void SetDomainId(const Aws::String& value) { m_domainIdHasBeenSet = true; m_domainId = value; }
/**
* <p>The ID of the associated Domain.</p>
*/
inline void SetDomainId(Aws::String&& value) { m_domainIdHasBeenSet = true; m_domainId = std::move(value); }
/**
* <p>The ID of the associated Domain.</p>
*/
inline void SetDomainId(const char* value) { m_domainIdHasBeenSet = true; m_domainId.assign(value); }
/**
* <p>The ID of the associated Domain.</p>
*/
inline CreateUserProfileRequest& WithDomainId(const Aws::String& value) { SetDomainId(value); return *this;}
/**
* <p>The ID of the associated Domain.</p>
*/
inline CreateUserProfileRequest& WithDomainId(Aws::String&& value) { SetDomainId(std::move(value)); return *this;}
/**
* <p>The ID of the associated Domain.</p>
*/
inline CreateUserProfileRequest& WithDomainId(const char* value) { SetDomainId(value); return *this;}
/**
* <p>A name for the UserProfile.</p>
*/
inline const Aws::String& GetUserProfileName() const{ return m_userProfileName; }
/**
* <p>A name for the UserProfile.</p>
*/
inline bool UserProfileNameHasBeenSet() const { return m_userProfileNameHasBeenSet; }
/**
* <p>A name for the UserProfile.</p>
*/
inline void SetUserProfileName(const Aws::String& value) { m_userProfileNameHasBeenSet = true; m_userProfileName = value; }
/**
* <p>A name for the UserProfile.</p>
*/
inline void SetUserProfileName(Aws::String&& value) { m_userProfileNameHasBeenSet = true; m_userProfileName = std::move(value); }
/**
* <p>A name for the UserProfile.</p>
*/
inline void SetUserProfileName(const char* value) { m_userProfileNameHasBeenSet = true; m_userProfileName.assign(value); }
/**
* <p>A name for the UserProfile.</p>
*/
inline CreateUserProfileRequest& WithUserProfileName(const Aws::String& value) { SetUserProfileName(value); return *this;}
/**
* <p>A name for the UserProfile.</p>
*/
inline CreateUserProfileRequest& WithUserProfileName(Aws::String&& value) { SetUserProfileName(std::move(value)); return *this;}
/**
* <p>A name for the UserProfile.</p>
*/
inline CreateUserProfileRequest& WithUserProfileName(const char* value) { SetUserProfileName(value); return *this;}
/**
* <p>A specifier for the type of value specified in SingleSignOnUserValue.
* Currently, the only supported value is "UserName". If the Domain's AuthMode is
* SSO, this field is required. If the Domain's AuthMode is not SSO, this field
* cannot be specified. </p>
*/
inline const Aws::String& GetSingleSignOnUserIdentifier() const{ return m_singleSignOnUserIdentifier; }
/**
* <p>A specifier for the type of value specified in SingleSignOnUserValue.
* Currently, the only supported value is "UserName". If the Domain's AuthMode is
* SSO, this field is required. If the Domain's AuthMode is not SSO, this field
* cannot be specified. </p>
*/
inline bool SingleSignOnUserIdentifierHasBeenSet() const { return m_singleSignOnUserIdentifierHasBeenSet; }
/**
* <p>A specifier for the type of value specified in SingleSignOnUserValue.
* Currently, the only supported value is "UserName". If the Domain's AuthMode is
* SSO, this field is required. If the Domain's AuthMode is not SSO, this field
* cannot be specified. </p>
*/
inline void SetSingleSignOnUserIdentifier(const Aws::String& value) { m_singleSignOnUserIdentifierHasBeenSet = true; m_singleSignOnUserIdentifier = value; }
/**
* <p>A specifier for the type of value specified in SingleSignOnUserValue.
* Currently, the only supported value is "UserName". If the Domain's AuthMode is
* SSO, this field is required. If the Domain's AuthMode is not SSO, this field
* cannot be specified. </p>
*/
inline void SetSingleSignOnUserIdentifier(Aws::String&& value) { m_singleSignOnUserIdentifierHasBeenSet = true; m_singleSignOnUserIdentifier = std::move(value); }
/**
* <p>A specifier for the type of value specified in SingleSignOnUserValue.
* Currently, the only supported value is "UserName". If the Domain's AuthMode is
* SSO, this field is required. If the Domain's AuthMode is not SSO, this field
* cannot be specified. </p>
*/
inline void SetSingleSignOnUserIdentifier(const char* value) { m_singleSignOnUserIdentifierHasBeenSet = true; m_singleSignOnUserIdentifier.assign(value); }
/**
* <p>A specifier for the type of value specified in SingleSignOnUserValue.
* Currently, the only supported value is "UserName". If the Domain's AuthMode is
* SSO, this field is required. If the Domain's AuthMode is not SSO, this field
* cannot be specified. </p>
*/
inline CreateUserProfileRequest& WithSingleSignOnUserIdentifier(const Aws::String& value) { SetSingleSignOnUserIdentifier(value); return *this;}
/**
* <p>A specifier for the type of value specified in SingleSignOnUserValue.
* Currently, the only supported value is "UserName". If the Domain's AuthMode is
* SSO, this field is required. If the Domain's AuthMode is not SSO, this field
* cannot be specified. </p>
*/
inline CreateUserProfileRequest& WithSingleSignOnUserIdentifier(Aws::String&& value) { SetSingleSignOnUserIdentifier(std::move(value)); return *this;}
/**
* <p>A specifier for the type of value specified in SingleSignOnUserValue.
* Currently, the only supported value is "UserName". If the Domain's AuthMode is
* SSO, this field is required. If the Domain's AuthMode is not SSO, this field
* cannot be specified. </p>
*/
inline CreateUserProfileRequest& WithSingleSignOnUserIdentifier(const char* value) { SetSingleSignOnUserIdentifier(value); return *this;}
/**
* <p>The username of the associated AWS Single Sign-On User for this UserProfile.
* If the Domain's AuthMode is SSO, this field is required, and must match a valid
* username of a user in your directory. If the Domain's AuthMode is not SSO, this
* field cannot be specified. </p>
*/
inline const Aws::String& GetSingleSignOnUserValue() const{ return m_singleSignOnUserValue; }
/**
* <p>The username of the associated AWS Single Sign-On User for this UserProfile.
* If the Domain's AuthMode is SSO, this field is required, and must match a valid
* username of a user in your directory. If the Domain's AuthMode is not SSO, this
* field cannot be specified. </p>
*/
inline bool SingleSignOnUserValueHasBeenSet() const { return m_singleSignOnUserValueHasBeenSet; }
/**
* <p>The username of the associated AWS Single Sign-On User for this UserProfile.
* If the Domain's AuthMode is SSO, this field is required, and must match a valid
* username of a user in your directory. If the Domain's AuthMode is not SSO, this
* field cannot be specified. </p>
*/
inline void SetSingleSignOnUserValue(const Aws::String& value) { m_singleSignOnUserValueHasBeenSet = true; m_singleSignOnUserValue = value; }
/**
* <p>The username of the associated AWS Single Sign-On User for this UserProfile.
* If the Domain's AuthMode is SSO, this field is required, and must match a valid
* username of a user in your directory. If the Domain's AuthMode is not SSO, this
* field cannot be specified. </p>
*/
inline void SetSingleSignOnUserValue(Aws::String&& value) { m_singleSignOnUserValueHasBeenSet = true; m_singleSignOnUserValue = std::move(value); }
/**
* <p>The username of the associated AWS Single Sign-On User for this UserProfile.
* If the Domain's AuthMode is SSO, this field is required, and must match a valid
* username of a user in your directory. If the Domain's AuthMode is not SSO, this
* field cannot be specified. </p>
*/
inline void SetSingleSignOnUserValue(const char* value) { m_singleSignOnUserValueHasBeenSet = true; m_singleSignOnUserValue.assign(value); }
/**
* <p>The username of the associated AWS Single Sign-On User for this UserProfile.
* If the Domain's AuthMode is SSO, this field is required, and must match a valid
* username of a user in your directory. If the Domain's AuthMode is not SSO, this
* field cannot be specified. </p>
*/
inline CreateUserProfileRequest& WithSingleSignOnUserValue(const Aws::String& value) { SetSingleSignOnUserValue(value); return *this;}
/**
* <p>The username of the associated AWS Single Sign-On User for this UserProfile.
* If the Domain's AuthMode is SSO, this field is required, and must match a valid
* username of a user in your directory. If the Domain's AuthMode is not SSO, this
* field cannot be specified. </p>
*/
inline CreateUserProfileRequest& WithSingleSignOnUserValue(Aws::String&& value) { SetSingleSignOnUserValue(std::move(value)); return *this;}
/**
* <p>The username of the associated AWS Single Sign-On User for this UserProfile.
* If the Domain's AuthMode is SSO, this field is required, and must match a valid
* username of a user in your directory. If the Domain's AuthMode is not SSO, this
* field cannot be specified. </p>
*/
inline CreateUserProfileRequest& WithSingleSignOnUserValue(const char* value) { SetSingleSignOnUserValue(value); return *this;}
/**
* <p>Each tag consists of a key and an optional value. Tag keys must be unique per
* resource.</p>
*/
inline const Aws::Vector<Tag>& GetTags() const{ return m_tags; }
/**
* <p>Each tag consists of a key and an optional value. Tag keys must be unique per
* resource.</p>
*/
inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
/**
* <p>Each tag consists of a key and an optional value. Tag keys must be unique per
* resource.</p>
*/
inline void SetTags(const Aws::Vector<Tag>& value) { m_tagsHasBeenSet = true; m_tags = value; }
/**
* <p>Each tag consists of a key and an optional value. Tag keys must be unique per
* resource.</p>
*/
inline void SetTags(Aws::Vector<Tag>&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); }
/**
* <p>Each tag consists of a key and an optional value. Tag keys must be unique per
* resource.</p>
*/
inline CreateUserProfileRequest& WithTags(const Aws::Vector<Tag>& value) { SetTags(value); return *this;}
/**
* <p>Each tag consists of a key and an optional value. Tag keys must be unique per
* resource.</p>
*/
inline CreateUserProfileRequest& WithTags(Aws::Vector<Tag>&& value) { SetTags(std::move(value)); return *this;}
/**
* <p>Each tag consists of a key and an optional value. Tag keys must be unique per
* resource.</p>
*/
inline CreateUserProfileRequest& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; }
/**
* <p>Each tag consists of a key and an optional value. Tag keys must be unique per
* resource.</p>
*/
inline CreateUserProfileRequest& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; }
/**
* <p>A collection of settings.</p>
*/
inline const UserSettings& GetUserSettings() const{ return m_userSettings; }
/**
* <p>A collection of settings.</p>
*/
inline bool UserSettingsHasBeenSet() const { return m_userSettingsHasBeenSet; }
/**
* <p>A collection of settings.</p>
*/
inline void SetUserSettings(const UserSettings& value) { m_userSettingsHasBeenSet = true; m_userSettings = value; }
/**
* <p>A collection of settings.</p>
*/
inline void SetUserSettings(UserSettings&& value) { m_userSettingsHasBeenSet = true; m_userSettings = std::move(value); }
/**
* <p>A collection of settings.</p>
*/
inline CreateUserProfileRequest& WithUserSettings(const UserSettings& value) { SetUserSettings(value); return *this;}
/**
* <p>A collection of settings.</p>
*/
inline CreateUserProfileRequest& WithUserSettings(UserSettings&& value) { SetUserSettings(std::move(value)); return *this;}
private:
Aws::String m_domainId;
bool m_domainIdHasBeenSet;
Aws::String m_userProfileName;
bool m_userProfileNameHasBeenSet;
Aws::String m_singleSignOnUserIdentifier;
bool m_singleSignOnUserIdentifierHasBeenSet;
Aws::String m_singleSignOnUserValue;
bool m_singleSignOnUserValueHasBeenSet;
Aws::Vector<Tag> m_tags;
bool m_tagsHasBeenSet;
UserSettings m_userSettings;
bool m_userSettingsHasBeenSet;
};
} // namespace Model
} // namespace SageMaker
} // namespace Aws