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-ssm/include/aws/ssm/model/CreateActivationRequest.h

505 lines
26 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/ssm/SSM_EXPORTS.h>
#include <aws/ssm/SSMRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/core/utils/DateTime.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <aws/ssm/model/Tag.h>
#include <utility>
namespace Aws
{
namespace SSM
{
namespace Model
{
/**
*/
class AWS_SSM_API CreateActivationRequest : public SSMRequest
{
public:
CreateActivationRequest();
// 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 "CreateActivation"; }
Aws::String SerializePayload() const override;
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
/**
* <p>A user-defined description of the resource that you want to register with
* Systems Manager. </p> <p>Do not enter personally identifiable
* information in this field.</p>
*/
inline const Aws::String& GetDescription() const{ return m_description; }
/**
* <p>A user-defined description of the resource that you want to register with
* Systems Manager. </p> <p>Do not enter personally identifiable
* information in this field.</p>
*/
inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
/**
* <p>A user-defined description of the resource that you want to register with
* Systems Manager. </p> <p>Do not enter personally identifiable
* information in this field.</p>
*/
inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; }
/**
* <p>A user-defined description of the resource that you want to register with
* Systems Manager. </p> <p>Do not enter personally identifiable
* information in this field.</p>
*/
inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); }
/**
* <p>A user-defined description of the resource that you want to register with
* Systems Manager. </p> <p>Do not enter personally identifiable
* information in this field.</p>
*/
inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); }
/**
* <p>A user-defined description of the resource that you want to register with
* Systems Manager. </p> <p>Do not enter personally identifiable
* information in this field.</p>
*/
inline CreateActivationRequest& WithDescription(const Aws::String& value) { SetDescription(value); return *this;}
/**
* <p>A user-defined description of the resource that you want to register with
* Systems Manager. </p> <p>Do not enter personally identifiable
* information in this field.</p>
*/
inline CreateActivationRequest& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;}
/**
* <p>A user-defined description of the resource that you want to register with
* Systems Manager. </p> <p>Do not enter personally identifiable
* information in this field.</p>
*/
inline CreateActivationRequest& WithDescription(const char* value) { SetDescription(value); return *this;}
/**
* <p>The name of the registered, managed instance as it will appear in the Systems
* Manager console or when you use the AWS command line tools to list Systems
* Manager resources.</p> <p>Do not enter personally identifiable
* information in this field.</p>
*/
inline const Aws::String& GetDefaultInstanceName() const{ return m_defaultInstanceName; }
/**
* <p>The name of the registered, managed instance as it will appear in the Systems
* Manager console or when you use the AWS command line tools to list Systems
* Manager resources.</p> <p>Do not enter personally identifiable
* information in this field.</p>
*/
inline bool DefaultInstanceNameHasBeenSet() const { return m_defaultInstanceNameHasBeenSet; }
/**
* <p>The name of the registered, managed instance as it will appear in the Systems
* Manager console or when you use the AWS command line tools to list Systems
* Manager resources.</p> <p>Do not enter personally identifiable
* information in this field.</p>
*/
inline void SetDefaultInstanceName(const Aws::String& value) { m_defaultInstanceNameHasBeenSet = true; m_defaultInstanceName = value; }
/**
* <p>The name of the registered, managed instance as it will appear in the Systems
* Manager console or when you use the AWS command line tools to list Systems
* Manager resources.</p> <p>Do not enter personally identifiable
* information in this field.</p>
*/
inline void SetDefaultInstanceName(Aws::String&& value) { m_defaultInstanceNameHasBeenSet = true; m_defaultInstanceName = std::move(value); }
/**
* <p>The name of the registered, managed instance as it will appear in the Systems
* Manager console or when you use the AWS command line tools to list Systems
* Manager resources.</p> <p>Do not enter personally identifiable
* information in this field.</p>
*/
inline void SetDefaultInstanceName(const char* value) { m_defaultInstanceNameHasBeenSet = true; m_defaultInstanceName.assign(value); }
/**
* <p>The name of the registered, managed instance as it will appear in the Systems
* Manager console or when you use the AWS command line tools to list Systems
* Manager resources.</p> <p>Do not enter personally identifiable
* information in this field.</p>
*/
inline CreateActivationRequest& WithDefaultInstanceName(const Aws::String& value) { SetDefaultInstanceName(value); return *this;}
/**
* <p>The name of the registered, managed instance as it will appear in the Systems
* Manager console or when you use the AWS command line tools to list Systems
* Manager resources.</p> <p>Do not enter personally identifiable
* information in this field.</p>
*/
inline CreateActivationRequest& WithDefaultInstanceName(Aws::String&& value) { SetDefaultInstanceName(std::move(value)); return *this;}
/**
* <p>The name of the registered, managed instance as it will appear in the Systems
* Manager console or when you use the AWS command line tools to list Systems
* Manager resources.</p> <p>Do not enter personally identifiable
* information in this field.</p>
*/
inline CreateActivationRequest& WithDefaultInstanceName(const char* value) { SetDefaultInstanceName(value); return *this;}
/**
* <p>The Amazon Identity and Access Management (IAM) role that you want to assign
* to the managed instance. This IAM role must provide AssumeRole permissions for
* the Systems Manager service principal <code>ssm.amazonaws.com</code>. For more
* information, see <a
* href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html">Create
* an IAM service role for a hybrid environment</a> in the <i>AWS Systems Manager
* User Guide</i>.</p>
*/
inline const Aws::String& GetIamRole() const{ return m_iamRole; }
/**
* <p>The Amazon Identity and Access Management (IAM) role that you want to assign
* to the managed instance. This IAM role must provide AssumeRole permissions for
* the Systems Manager service principal <code>ssm.amazonaws.com</code>. For more
* information, see <a
* href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html">Create
* an IAM service role for a hybrid environment</a> in the <i>AWS Systems Manager
* User Guide</i>.</p>
*/
inline bool IamRoleHasBeenSet() const { return m_iamRoleHasBeenSet; }
/**
* <p>The Amazon Identity and Access Management (IAM) role that you want to assign
* to the managed instance. This IAM role must provide AssumeRole permissions for
* the Systems Manager service principal <code>ssm.amazonaws.com</code>. For more
* information, see <a
* href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html">Create
* an IAM service role for a hybrid environment</a> in the <i>AWS Systems Manager
* User Guide</i>.</p>
*/
inline void SetIamRole(const Aws::String& value) { m_iamRoleHasBeenSet = true; m_iamRole = value; }
/**
* <p>The Amazon Identity and Access Management (IAM) role that you want to assign
* to the managed instance. This IAM role must provide AssumeRole permissions for
* the Systems Manager service principal <code>ssm.amazonaws.com</code>. For more
* information, see <a
* href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html">Create
* an IAM service role for a hybrid environment</a> in the <i>AWS Systems Manager
* User Guide</i>.</p>
*/
inline void SetIamRole(Aws::String&& value) { m_iamRoleHasBeenSet = true; m_iamRole = std::move(value); }
/**
* <p>The Amazon Identity and Access Management (IAM) role that you want to assign
* to the managed instance. This IAM role must provide AssumeRole permissions for
* the Systems Manager service principal <code>ssm.amazonaws.com</code>. For more
* information, see <a
* href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html">Create
* an IAM service role for a hybrid environment</a> in the <i>AWS Systems Manager
* User Guide</i>.</p>
*/
inline void SetIamRole(const char* value) { m_iamRoleHasBeenSet = true; m_iamRole.assign(value); }
/**
* <p>The Amazon Identity and Access Management (IAM) role that you want to assign
* to the managed instance. This IAM role must provide AssumeRole permissions for
* the Systems Manager service principal <code>ssm.amazonaws.com</code>. For more
* information, see <a
* href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html">Create
* an IAM service role for a hybrid environment</a> in the <i>AWS Systems Manager
* User Guide</i>.</p>
*/
inline CreateActivationRequest& WithIamRole(const Aws::String& value) { SetIamRole(value); return *this;}
/**
* <p>The Amazon Identity and Access Management (IAM) role that you want to assign
* to the managed instance. This IAM role must provide AssumeRole permissions for
* the Systems Manager service principal <code>ssm.amazonaws.com</code>. For more
* information, see <a
* href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html">Create
* an IAM service role for a hybrid environment</a> in the <i>AWS Systems Manager
* User Guide</i>.</p>
*/
inline CreateActivationRequest& WithIamRole(Aws::String&& value) { SetIamRole(std::move(value)); return *this;}
/**
* <p>The Amazon Identity and Access Management (IAM) role that you want to assign
* to the managed instance. This IAM role must provide AssumeRole permissions for
* the Systems Manager service principal <code>ssm.amazonaws.com</code>. For more
* information, see <a
* href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html">Create
* an IAM service role for a hybrid environment</a> in the <i>AWS Systems Manager
* User Guide</i>.</p>
*/
inline CreateActivationRequest& WithIamRole(const char* value) { SetIamRole(value); return *this;}
/**
* <p>Specify the maximum number of managed instances you want to register. The
* default value is 1 instance.</p>
*/
inline int GetRegistrationLimit() const{ return m_registrationLimit; }
/**
* <p>Specify the maximum number of managed instances you want to register. The
* default value is 1 instance.</p>
*/
inline bool RegistrationLimitHasBeenSet() const { return m_registrationLimitHasBeenSet; }
/**
* <p>Specify the maximum number of managed instances you want to register. The
* default value is 1 instance.</p>
*/
inline void SetRegistrationLimit(int value) { m_registrationLimitHasBeenSet = true; m_registrationLimit = value; }
/**
* <p>Specify the maximum number of managed instances you want to register. The
* default value is 1 instance.</p>
*/
inline CreateActivationRequest& WithRegistrationLimit(int value) { SetRegistrationLimit(value); return *this;}
/**
* <p>The date by which this activation request should expire. The default value is
* 24 hours.</p>
*/
inline const Aws::Utils::DateTime& GetExpirationDate() const{ return m_expirationDate; }
/**
* <p>The date by which this activation request should expire. The default value is
* 24 hours.</p>
*/
inline bool ExpirationDateHasBeenSet() const { return m_expirationDateHasBeenSet; }
/**
* <p>The date by which this activation request should expire. The default value is
* 24 hours.</p>
*/
inline void SetExpirationDate(const Aws::Utils::DateTime& value) { m_expirationDateHasBeenSet = true; m_expirationDate = value; }
/**
* <p>The date by which this activation request should expire. The default value is
* 24 hours.</p>
*/
inline void SetExpirationDate(Aws::Utils::DateTime&& value) { m_expirationDateHasBeenSet = true; m_expirationDate = std::move(value); }
/**
* <p>The date by which this activation request should expire. The default value is
* 24 hours.</p>
*/
inline CreateActivationRequest& WithExpirationDate(const Aws::Utils::DateTime& value) { SetExpirationDate(value); return *this;}
/**
* <p>The date by which this activation request should expire. The default value is
* 24 hours.</p>
*/
inline CreateActivationRequest& WithExpirationDate(Aws::Utils::DateTime&& value) { SetExpirationDate(std::move(value)); return *this;}
/**
* <p>Optional metadata that you assign to a resource. Tags enable you to
* categorize a resource in different ways, such as by purpose, owner, or
* environment. For example, you might want to tag an activation to identify which
* servers or virtual machines (VMs) in your on-premises environment you intend to
* activate. In this case, you could specify the following key name/value
* pairs:</p> <ul> <li> <p> <code>Key=OS,Value=Windows</code> </p> </li> <li> <p>
* <code>Key=Environment,Value=Production</code> </p> </li> </ul>
* <p>When you install SSM Agent on your on-premises servers and VMs, you specify
* an activation ID and code. When you specify the activation ID and code, tags
* assigned to the activation are automatically applied to the on-premises servers
* or VMs.</p> <p>You can't add tags to or delete tags from an
* existing activation. You can tag your on-premises servers and VMs after they
* connect to Systems Manager for the first time and are assigned a managed
* instance ID. This means they are listed in the AWS Systems Manager console with
* an ID that is prefixed with "mi-". For information about how to add tags to your
* managed instances, see <a>AddTagsToResource</a>. For information about how to
* remove tags from your managed instances, see <a>RemoveTagsFromResource</a>.</p>
*/
inline const Aws::Vector<Tag>& GetTags() const{ return m_tags; }
/**
* <p>Optional metadata that you assign to a resource. Tags enable you to
* categorize a resource in different ways, such as by purpose, owner, or
* environment. For example, you might want to tag an activation to identify which
* servers or virtual machines (VMs) in your on-premises environment you intend to
* activate. In this case, you could specify the following key name/value
* pairs:</p> <ul> <li> <p> <code>Key=OS,Value=Windows</code> </p> </li> <li> <p>
* <code>Key=Environment,Value=Production</code> </p> </li> </ul>
* <p>When you install SSM Agent on your on-premises servers and VMs, you specify
* an activation ID and code. When you specify the activation ID and code, tags
* assigned to the activation are automatically applied to the on-premises servers
* or VMs.</p> <p>You can't add tags to or delete tags from an
* existing activation. You can tag your on-premises servers and VMs after they
* connect to Systems Manager for the first time and are assigned a managed
* instance ID. This means they are listed in the AWS Systems Manager console with
* an ID that is prefixed with "mi-". For information about how to add tags to your
* managed instances, see <a>AddTagsToResource</a>. For information about how to
* remove tags from your managed instances, see <a>RemoveTagsFromResource</a>.</p>
*/
inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
/**
* <p>Optional metadata that you assign to a resource. Tags enable you to
* categorize a resource in different ways, such as by purpose, owner, or
* environment. For example, you might want to tag an activation to identify which
* servers or virtual machines (VMs) in your on-premises environment you intend to
* activate. In this case, you could specify the following key name/value
* pairs:</p> <ul> <li> <p> <code>Key=OS,Value=Windows</code> </p> </li> <li> <p>
* <code>Key=Environment,Value=Production</code> </p> </li> </ul>
* <p>When you install SSM Agent on your on-premises servers and VMs, you specify
* an activation ID and code. When you specify the activation ID and code, tags
* assigned to the activation are automatically applied to the on-premises servers
* or VMs.</p> <p>You can't add tags to or delete tags from an
* existing activation. You can tag your on-premises servers and VMs after they
* connect to Systems Manager for the first time and are assigned a managed
* instance ID. This means they are listed in the AWS Systems Manager console with
* an ID that is prefixed with "mi-". For information about how to add tags to your
* managed instances, see <a>AddTagsToResource</a>. For information about how to
* remove tags from your managed instances, see <a>RemoveTagsFromResource</a>.</p>
*/
inline void SetTags(const Aws::Vector<Tag>& value) { m_tagsHasBeenSet = true; m_tags = value; }
/**
* <p>Optional metadata that you assign to a resource. Tags enable you to
* categorize a resource in different ways, such as by purpose, owner, or
* environment. For example, you might want to tag an activation to identify which
* servers or virtual machines (VMs) in your on-premises environment you intend to
* activate. In this case, you could specify the following key name/value
* pairs:</p> <ul> <li> <p> <code>Key=OS,Value=Windows</code> </p> </li> <li> <p>
* <code>Key=Environment,Value=Production</code> </p> </li> </ul>
* <p>When you install SSM Agent on your on-premises servers and VMs, you specify
* an activation ID and code. When you specify the activation ID and code, tags
* assigned to the activation are automatically applied to the on-premises servers
* or VMs.</p> <p>You can't add tags to or delete tags from an
* existing activation. You can tag your on-premises servers and VMs after they
* connect to Systems Manager for the first time and are assigned a managed
* instance ID. This means they are listed in the AWS Systems Manager console with
* an ID that is prefixed with "mi-". For information about how to add tags to your
* managed instances, see <a>AddTagsToResource</a>. For information about how to
* remove tags from your managed instances, see <a>RemoveTagsFromResource</a>.</p>
*/
inline void SetTags(Aws::Vector<Tag>&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); }
/**
* <p>Optional metadata that you assign to a resource. Tags enable you to
* categorize a resource in different ways, such as by purpose, owner, or
* environment. For example, you might want to tag an activation to identify which
* servers or virtual machines (VMs) in your on-premises environment you intend to
* activate. In this case, you could specify the following key name/value
* pairs:</p> <ul> <li> <p> <code>Key=OS,Value=Windows</code> </p> </li> <li> <p>
* <code>Key=Environment,Value=Production</code> </p> </li> </ul>
* <p>When you install SSM Agent on your on-premises servers and VMs, you specify
* an activation ID and code. When you specify the activation ID and code, tags
* assigned to the activation are automatically applied to the on-premises servers
* or VMs.</p> <p>You can't add tags to or delete tags from an
* existing activation. You can tag your on-premises servers and VMs after they
* connect to Systems Manager for the first time and are assigned a managed
* instance ID. This means they are listed in the AWS Systems Manager console with
* an ID that is prefixed with "mi-". For information about how to add tags to your
* managed instances, see <a>AddTagsToResource</a>. For information about how to
* remove tags from your managed instances, see <a>RemoveTagsFromResource</a>.</p>
*/
inline CreateActivationRequest& WithTags(const Aws::Vector<Tag>& value) { SetTags(value); return *this;}
/**
* <p>Optional metadata that you assign to a resource. Tags enable you to
* categorize a resource in different ways, such as by purpose, owner, or
* environment. For example, you might want to tag an activation to identify which
* servers or virtual machines (VMs) in your on-premises environment you intend to
* activate. In this case, you could specify the following key name/value
* pairs:</p> <ul> <li> <p> <code>Key=OS,Value=Windows</code> </p> </li> <li> <p>
* <code>Key=Environment,Value=Production</code> </p> </li> </ul>
* <p>When you install SSM Agent on your on-premises servers and VMs, you specify
* an activation ID and code. When you specify the activation ID and code, tags
* assigned to the activation are automatically applied to the on-premises servers
* or VMs.</p> <p>You can't add tags to or delete tags from an
* existing activation. You can tag your on-premises servers and VMs after they
* connect to Systems Manager for the first time and are assigned a managed
* instance ID. This means they are listed in the AWS Systems Manager console with
* an ID that is prefixed with "mi-". For information about how to add tags to your
* managed instances, see <a>AddTagsToResource</a>. For information about how to
* remove tags from your managed instances, see <a>RemoveTagsFromResource</a>.</p>
*/
inline CreateActivationRequest& WithTags(Aws::Vector<Tag>&& value) { SetTags(std::move(value)); return *this;}
/**
* <p>Optional metadata that you assign to a resource. Tags enable you to
* categorize a resource in different ways, such as by purpose, owner, or
* environment. For example, you might want to tag an activation to identify which
* servers or virtual machines (VMs) in your on-premises environment you intend to
* activate. In this case, you could specify the following key name/value
* pairs:</p> <ul> <li> <p> <code>Key=OS,Value=Windows</code> </p> </li> <li> <p>
* <code>Key=Environment,Value=Production</code> </p> </li> </ul>
* <p>When you install SSM Agent on your on-premises servers and VMs, you specify
* an activation ID and code. When you specify the activation ID and code, tags
* assigned to the activation are automatically applied to the on-premises servers
* or VMs.</p> <p>You can't add tags to or delete tags from an
* existing activation. You can tag your on-premises servers and VMs after they
* connect to Systems Manager for the first time and are assigned a managed
* instance ID. This means they are listed in the AWS Systems Manager console with
* an ID that is prefixed with "mi-". For information about how to add tags to your
* managed instances, see <a>AddTagsToResource</a>. For information about how to
* remove tags from your managed instances, see <a>RemoveTagsFromResource</a>.</p>
*/
inline CreateActivationRequest& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; }
/**
* <p>Optional metadata that you assign to a resource. Tags enable you to
* categorize a resource in different ways, such as by purpose, owner, or
* environment. For example, you might want to tag an activation to identify which
* servers or virtual machines (VMs) in your on-premises environment you intend to
* activate. In this case, you could specify the following key name/value
* pairs:</p> <ul> <li> <p> <code>Key=OS,Value=Windows</code> </p> </li> <li> <p>
* <code>Key=Environment,Value=Production</code> </p> </li> </ul>
* <p>When you install SSM Agent on your on-premises servers and VMs, you specify
* an activation ID and code. When you specify the activation ID and code, tags
* assigned to the activation are automatically applied to the on-premises servers
* or VMs.</p> <p>You can't add tags to or delete tags from an
* existing activation. You can tag your on-premises servers and VMs after they
* connect to Systems Manager for the first time and are assigned a managed
* instance ID. This means they are listed in the AWS Systems Manager console with
* an ID that is prefixed with "mi-". For information about how to add tags to your
* managed instances, see <a>AddTagsToResource</a>. For information about how to
* remove tags from your managed instances, see <a>RemoveTagsFromResource</a>.</p>
*/
inline CreateActivationRequest& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; }
private:
Aws::String m_description;
bool m_descriptionHasBeenSet;
Aws::String m_defaultInstanceName;
bool m_defaultInstanceNameHasBeenSet;
Aws::String m_iamRole;
bool m_iamRoleHasBeenSet;
int m_registrationLimit;
bool m_registrationLimitHasBeenSet;
Aws::Utils::DateTime m_expirationDate;
bool m_expirationDateHasBeenSet;
Aws::Vector<Tag> m_tags;
bool m_tagsHasBeenSet;
};
} // namespace Model
} // namespace SSM
} // namespace Aws