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

314 lines
14 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/ssm/model/DocumentPermissionType.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <utility>
namespace Aws
{
namespace SSM
{
namespace Model
{
/**
*/
class AWS_SSM_API ModifyDocumentPermissionRequest : public SSMRequest
{
public:
ModifyDocumentPermissionRequest();
// 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 "ModifyDocumentPermission"; }
Aws::String SerializePayload() const override;
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
/**
* <p>The name of the document that you want to share.</p>
*/
inline const Aws::String& GetName() const{ return m_name; }
/**
* <p>The name of the document that you want to share.</p>
*/
inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
/**
* <p>The name of the document that you want to share.</p>
*/
inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }
/**
* <p>The name of the document that you want to share.</p>
*/
inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }
/**
* <p>The name of the document that you want to share.</p>
*/
inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }
/**
* <p>The name of the document that you want to share.</p>
*/
inline ModifyDocumentPermissionRequest& WithName(const Aws::String& value) { SetName(value); return *this;}
/**
* <p>The name of the document that you want to share.</p>
*/
inline ModifyDocumentPermissionRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
/**
* <p>The name of the document that you want to share.</p>
*/
inline ModifyDocumentPermissionRequest& WithName(const char* value) { SetName(value); return *this;}
/**
* <p>The permission type for the document. The permission type can be
* <i>Share</i>.</p>
*/
inline const DocumentPermissionType& GetPermissionType() const{ return m_permissionType; }
/**
* <p>The permission type for the document. The permission type can be
* <i>Share</i>.</p>
*/
inline bool PermissionTypeHasBeenSet() const { return m_permissionTypeHasBeenSet; }
/**
* <p>The permission type for the document. The permission type can be
* <i>Share</i>.</p>
*/
inline void SetPermissionType(const DocumentPermissionType& value) { m_permissionTypeHasBeenSet = true; m_permissionType = value; }
/**
* <p>The permission type for the document. The permission type can be
* <i>Share</i>.</p>
*/
inline void SetPermissionType(DocumentPermissionType&& value) { m_permissionTypeHasBeenSet = true; m_permissionType = std::move(value); }
/**
* <p>The permission type for the document. The permission type can be
* <i>Share</i>.</p>
*/
inline ModifyDocumentPermissionRequest& WithPermissionType(const DocumentPermissionType& value) { SetPermissionType(value); return *this;}
/**
* <p>The permission type for the document. The permission type can be
* <i>Share</i>.</p>
*/
inline ModifyDocumentPermissionRequest& WithPermissionType(DocumentPermissionType&& value) { SetPermissionType(std::move(value)); return *this;}
/**
* <p>The AWS user accounts that should have access to the document. The account
* IDs can either be a group of account IDs or <i>All</i>.</p>
*/
inline const Aws::Vector<Aws::String>& GetAccountIdsToAdd() const{ return m_accountIdsToAdd; }
/**
* <p>The AWS user accounts that should have access to the document. The account
* IDs can either be a group of account IDs or <i>All</i>.</p>
*/
inline bool AccountIdsToAddHasBeenSet() const { return m_accountIdsToAddHasBeenSet; }
/**
* <p>The AWS user accounts that should have access to the document. The account
* IDs can either be a group of account IDs or <i>All</i>.</p>
*/
inline void SetAccountIdsToAdd(const Aws::Vector<Aws::String>& value) { m_accountIdsToAddHasBeenSet = true; m_accountIdsToAdd = value; }
/**
* <p>The AWS user accounts that should have access to the document. The account
* IDs can either be a group of account IDs or <i>All</i>.</p>
*/
inline void SetAccountIdsToAdd(Aws::Vector<Aws::String>&& value) { m_accountIdsToAddHasBeenSet = true; m_accountIdsToAdd = std::move(value); }
/**
* <p>The AWS user accounts that should have access to the document. The account
* IDs can either be a group of account IDs or <i>All</i>.</p>
*/
inline ModifyDocumentPermissionRequest& WithAccountIdsToAdd(const Aws::Vector<Aws::String>& value) { SetAccountIdsToAdd(value); return *this;}
/**
* <p>The AWS user accounts that should have access to the document. The account
* IDs can either be a group of account IDs or <i>All</i>.</p>
*/
inline ModifyDocumentPermissionRequest& WithAccountIdsToAdd(Aws::Vector<Aws::String>&& value) { SetAccountIdsToAdd(std::move(value)); return *this;}
/**
* <p>The AWS user accounts that should have access to the document. The account
* IDs can either be a group of account IDs or <i>All</i>.</p>
*/
inline ModifyDocumentPermissionRequest& AddAccountIdsToAdd(const Aws::String& value) { m_accountIdsToAddHasBeenSet = true; m_accountIdsToAdd.push_back(value); return *this; }
/**
* <p>The AWS user accounts that should have access to the document. The account
* IDs can either be a group of account IDs or <i>All</i>.</p>
*/
inline ModifyDocumentPermissionRequest& AddAccountIdsToAdd(Aws::String&& value) { m_accountIdsToAddHasBeenSet = true; m_accountIdsToAdd.push_back(std::move(value)); return *this; }
/**
* <p>The AWS user accounts that should have access to the document. The account
* IDs can either be a group of account IDs or <i>All</i>.</p>
*/
inline ModifyDocumentPermissionRequest& AddAccountIdsToAdd(const char* value) { m_accountIdsToAddHasBeenSet = true; m_accountIdsToAdd.push_back(value); return *this; }
/**
* <p>The AWS user accounts that should no longer have access to the document. The
* AWS user account can either be a group of account IDs or <i>All</i>. This action
* has a higher priority than <i>AccountIdsToAdd</i>. If you specify an account ID
* to add and the same ID to remove, the system removes access to the document.</p>
*/
inline const Aws::Vector<Aws::String>& GetAccountIdsToRemove() const{ return m_accountIdsToRemove; }
/**
* <p>The AWS user accounts that should no longer have access to the document. The
* AWS user account can either be a group of account IDs or <i>All</i>. This action
* has a higher priority than <i>AccountIdsToAdd</i>. If you specify an account ID
* to add and the same ID to remove, the system removes access to the document.</p>
*/
inline bool AccountIdsToRemoveHasBeenSet() const { return m_accountIdsToRemoveHasBeenSet; }
/**
* <p>The AWS user accounts that should no longer have access to the document. The
* AWS user account can either be a group of account IDs or <i>All</i>. This action
* has a higher priority than <i>AccountIdsToAdd</i>. If you specify an account ID
* to add and the same ID to remove, the system removes access to the document.</p>
*/
inline void SetAccountIdsToRemove(const Aws::Vector<Aws::String>& value) { m_accountIdsToRemoveHasBeenSet = true; m_accountIdsToRemove = value; }
/**
* <p>The AWS user accounts that should no longer have access to the document. The
* AWS user account can either be a group of account IDs or <i>All</i>. This action
* has a higher priority than <i>AccountIdsToAdd</i>. If you specify an account ID
* to add and the same ID to remove, the system removes access to the document.</p>
*/
inline void SetAccountIdsToRemove(Aws::Vector<Aws::String>&& value) { m_accountIdsToRemoveHasBeenSet = true; m_accountIdsToRemove = std::move(value); }
/**
* <p>The AWS user accounts that should no longer have access to the document. The
* AWS user account can either be a group of account IDs or <i>All</i>. This action
* has a higher priority than <i>AccountIdsToAdd</i>. If you specify an account ID
* to add and the same ID to remove, the system removes access to the document.</p>
*/
inline ModifyDocumentPermissionRequest& WithAccountIdsToRemove(const Aws::Vector<Aws::String>& value) { SetAccountIdsToRemove(value); return *this;}
/**
* <p>The AWS user accounts that should no longer have access to the document. The
* AWS user account can either be a group of account IDs or <i>All</i>. This action
* has a higher priority than <i>AccountIdsToAdd</i>. If you specify an account ID
* to add and the same ID to remove, the system removes access to the document.</p>
*/
inline ModifyDocumentPermissionRequest& WithAccountIdsToRemove(Aws::Vector<Aws::String>&& value) { SetAccountIdsToRemove(std::move(value)); return *this;}
/**
* <p>The AWS user accounts that should no longer have access to the document. The
* AWS user account can either be a group of account IDs or <i>All</i>. This action
* has a higher priority than <i>AccountIdsToAdd</i>. If you specify an account ID
* to add and the same ID to remove, the system removes access to the document.</p>
*/
inline ModifyDocumentPermissionRequest& AddAccountIdsToRemove(const Aws::String& value) { m_accountIdsToRemoveHasBeenSet = true; m_accountIdsToRemove.push_back(value); return *this; }
/**
* <p>The AWS user accounts that should no longer have access to the document. The
* AWS user account can either be a group of account IDs or <i>All</i>. This action
* has a higher priority than <i>AccountIdsToAdd</i>. If you specify an account ID
* to add and the same ID to remove, the system removes access to the document.</p>
*/
inline ModifyDocumentPermissionRequest& AddAccountIdsToRemove(Aws::String&& value) { m_accountIdsToRemoveHasBeenSet = true; m_accountIdsToRemove.push_back(std::move(value)); return *this; }
/**
* <p>The AWS user accounts that should no longer have access to the document. The
* AWS user account can either be a group of account IDs or <i>All</i>. This action
* has a higher priority than <i>AccountIdsToAdd</i>. If you specify an account ID
* to add and the same ID to remove, the system removes access to the document.</p>
*/
inline ModifyDocumentPermissionRequest& AddAccountIdsToRemove(const char* value) { m_accountIdsToRemoveHasBeenSet = true; m_accountIdsToRemove.push_back(value); return *this; }
/**
* <p>(Optional) The version of the document to share. If it's not specified, the
* system choose the <code>Default</code> version to share.</p>
*/
inline const Aws::String& GetSharedDocumentVersion() const{ return m_sharedDocumentVersion; }
/**
* <p>(Optional) The version of the document to share. If it's not specified, the
* system choose the <code>Default</code> version to share.</p>
*/
inline bool SharedDocumentVersionHasBeenSet() const { return m_sharedDocumentVersionHasBeenSet; }
/**
* <p>(Optional) The version of the document to share. If it's not specified, the
* system choose the <code>Default</code> version to share.</p>
*/
inline void SetSharedDocumentVersion(const Aws::String& value) { m_sharedDocumentVersionHasBeenSet = true; m_sharedDocumentVersion = value; }
/**
* <p>(Optional) The version of the document to share. If it's not specified, the
* system choose the <code>Default</code> version to share.</p>
*/
inline void SetSharedDocumentVersion(Aws::String&& value) { m_sharedDocumentVersionHasBeenSet = true; m_sharedDocumentVersion = std::move(value); }
/**
* <p>(Optional) The version of the document to share. If it's not specified, the
* system choose the <code>Default</code> version to share.</p>
*/
inline void SetSharedDocumentVersion(const char* value) { m_sharedDocumentVersionHasBeenSet = true; m_sharedDocumentVersion.assign(value); }
/**
* <p>(Optional) The version of the document to share. If it's not specified, the
* system choose the <code>Default</code> version to share.</p>
*/
inline ModifyDocumentPermissionRequest& WithSharedDocumentVersion(const Aws::String& value) { SetSharedDocumentVersion(value); return *this;}
/**
* <p>(Optional) The version of the document to share. If it's not specified, the
* system choose the <code>Default</code> version to share.</p>
*/
inline ModifyDocumentPermissionRequest& WithSharedDocumentVersion(Aws::String&& value) { SetSharedDocumentVersion(std::move(value)); return *this;}
/**
* <p>(Optional) The version of the document to share. If it's not specified, the
* system choose the <code>Default</code> version to share.</p>
*/
inline ModifyDocumentPermissionRequest& WithSharedDocumentVersion(const char* value) { SetSharedDocumentVersion(value); return *this;}
private:
Aws::String m_name;
bool m_nameHasBeenSet;
DocumentPermissionType m_permissionType;
bool m_permissionTypeHasBeenSet;
Aws::Vector<Aws::String> m_accountIdsToAdd;
bool m_accountIdsToAddHasBeenSet;
Aws::Vector<Aws::String> m_accountIdsToRemove;
bool m_accountIdsToRemoveHasBeenSet;
Aws::String m_sharedDocumentVersion;
bool m_sharedDocumentVersionHasBeenSet;
};
} // namespace Model
} // namespace SSM
} // namespace Aws