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-codecommit/include/aws/codecommit/model/CreateApprovalRuleTemplateRequest.h

390 lines
24 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/codecommit/CodeCommit_EXPORTS.h>
#include <aws/codecommit/CodeCommitRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace CodeCommit
{
namespace Model
{
/**
*/
class AWS_CODECOMMIT_API CreateApprovalRuleTemplateRequest : public CodeCommitRequest
{
public:
CreateApprovalRuleTemplateRequest();
// 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 "CreateApprovalRuleTemplate"; }
Aws::String SerializePayload() const override;
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
/**
* <p>The name of the approval rule template. Provide descriptive names, because
* this name is applied to the approval rules created automatically in associated
* repositories.</p>
*/
inline const Aws::String& GetApprovalRuleTemplateName() const{ return m_approvalRuleTemplateName; }
/**
* <p>The name of the approval rule template. Provide descriptive names, because
* this name is applied to the approval rules created automatically in associated
* repositories.</p>
*/
inline bool ApprovalRuleTemplateNameHasBeenSet() const { return m_approvalRuleTemplateNameHasBeenSet; }
/**
* <p>The name of the approval rule template. Provide descriptive names, because
* this name is applied to the approval rules created automatically in associated
* repositories.</p>
*/
inline void SetApprovalRuleTemplateName(const Aws::String& value) { m_approvalRuleTemplateNameHasBeenSet = true; m_approvalRuleTemplateName = value; }
/**
* <p>The name of the approval rule template. Provide descriptive names, because
* this name is applied to the approval rules created automatically in associated
* repositories.</p>
*/
inline void SetApprovalRuleTemplateName(Aws::String&& value) { m_approvalRuleTemplateNameHasBeenSet = true; m_approvalRuleTemplateName = std::move(value); }
/**
* <p>The name of the approval rule template. Provide descriptive names, because
* this name is applied to the approval rules created automatically in associated
* repositories.</p>
*/
inline void SetApprovalRuleTemplateName(const char* value) { m_approvalRuleTemplateNameHasBeenSet = true; m_approvalRuleTemplateName.assign(value); }
/**
* <p>The name of the approval rule template. Provide descriptive names, because
* this name is applied to the approval rules created automatically in associated
* repositories.</p>
*/
inline CreateApprovalRuleTemplateRequest& WithApprovalRuleTemplateName(const Aws::String& value) { SetApprovalRuleTemplateName(value); return *this;}
/**
* <p>The name of the approval rule template. Provide descriptive names, because
* this name is applied to the approval rules created automatically in associated
* repositories.</p>
*/
inline CreateApprovalRuleTemplateRequest& WithApprovalRuleTemplateName(Aws::String&& value) { SetApprovalRuleTemplateName(std::move(value)); return *this;}
/**
* <p>The name of the approval rule template. Provide descriptive names, because
* this name is applied to the approval rules created automatically in associated
* repositories.</p>
*/
inline CreateApprovalRuleTemplateRequest& WithApprovalRuleTemplateName(const char* value) { SetApprovalRuleTemplateName(value); return *this;}
/**
* <p>The content of the approval rule that is created on pull requests in
* associated repositories. If you specify one or more destination references
* (branches), approval rules are created in an associated repository only if their
* destination references (branches) match those specified in the template.</p>
* <p>When you create the content of the approval rule template, you can
* specify approvers in an approval pool in one of two ways:</p> <ul> <li> <p>
* <b>CodeCommitApprovers</b>: This option only requires an AWS account and a
* resource. It can be used for both IAM users and federated access users whose
* name matches the provided resource name. This is a very powerful option that
* offers a great deal of flexibility. For example, if you specify the AWS account
* <i>123456789012</i> and <i>Mary_Major</i>, all of the following are counted as
* approvals coming from that user:</p> <ul> <li> <p>An IAM user in the account
* (arn:aws:iam::<i>123456789012</i>:user/<i>Mary_Major</i>)</p> </li> <li> <p>A
* federated user identified in IAM as Mary_Major
* (arn:aws:sts::<i>123456789012</i>:federated-user/<i>Mary_Major</i>)</p> </li>
* </ul> <p>This option does not recognize an active session of someone assuming
* the role of CodeCommitReview with a role session name of <i>Mary_Major</i>
* (arn:aws:sts::<i>123456789012</i>:assumed-role/CodeCommitReview/<i>Mary_Major</i>)
* unless you include a wildcard (*Mary_Major).</p> </li> <li> <p> <b>Fully
* qualified ARN</b>: This option allows you to specify the fully qualified Amazon
* Resource Name (ARN) of the IAM user or role. </p> </li> </ul> <p>For more
* information about IAM ARNs, wildcards, and formats, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p>
*/
inline const Aws::String& GetApprovalRuleTemplateContent() const{ return m_approvalRuleTemplateContent; }
/**
* <p>The content of the approval rule that is created on pull requests in
* associated repositories. If you specify one or more destination references
* (branches), approval rules are created in an associated repository only if their
* destination references (branches) match those specified in the template.</p>
* <p>When you create the content of the approval rule template, you can
* specify approvers in an approval pool in one of two ways:</p> <ul> <li> <p>
* <b>CodeCommitApprovers</b>: This option only requires an AWS account and a
* resource. It can be used for both IAM users and federated access users whose
* name matches the provided resource name. This is a very powerful option that
* offers a great deal of flexibility. For example, if you specify the AWS account
* <i>123456789012</i> and <i>Mary_Major</i>, all of the following are counted as
* approvals coming from that user:</p> <ul> <li> <p>An IAM user in the account
* (arn:aws:iam::<i>123456789012</i>:user/<i>Mary_Major</i>)</p> </li> <li> <p>A
* federated user identified in IAM as Mary_Major
* (arn:aws:sts::<i>123456789012</i>:federated-user/<i>Mary_Major</i>)</p> </li>
* </ul> <p>This option does not recognize an active session of someone assuming
* the role of CodeCommitReview with a role session name of <i>Mary_Major</i>
* (arn:aws:sts::<i>123456789012</i>:assumed-role/CodeCommitReview/<i>Mary_Major</i>)
* unless you include a wildcard (*Mary_Major).</p> </li> <li> <p> <b>Fully
* qualified ARN</b>: This option allows you to specify the fully qualified Amazon
* Resource Name (ARN) of the IAM user or role. </p> </li> </ul> <p>For more
* information about IAM ARNs, wildcards, and formats, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p>
*/
inline bool ApprovalRuleTemplateContentHasBeenSet() const { return m_approvalRuleTemplateContentHasBeenSet; }
/**
* <p>The content of the approval rule that is created on pull requests in
* associated repositories. If you specify one or more destination references
* (branches), approval rules are created in an associated repository only if their
* destination references (branches) match those specified in the template.</p>
* <p>When you create the content of the approval rule template, you can
* specify approvers in an approval pool in one of two ways:</p> <ul> <li> <p>
* <b>CodeCommitApprovers</b>: This option only requires an AWS account and a
* resource. It can be used for both IAM users and federated access users whose
* name matches the provided resource name. This is a very powerful option that
* offers a great deal of flexibility. For example, if you specify the AWS account
* <i>123456789012</i> and <i>Mary_Major</i>, all of the following are counted as
* approvals coming from that user:</p> <ul> <li> <p>An IAM user in the account
* (arn:aws:iam::<i>123456789012</i>:user/<i>Mary_Major</i>)</p> </li> <li> <p>A
* federated user identified in IAM as Mary_Major
* (arn:aws:sts::<i>123456789012</i>:federated-user/<i>Mary_Major</i>)</p> </li>
* </ul> <p>This option does not recognize an active session of someone assuming
* the role of CodeCommitReview with a role session name of <i>Mary_Major</i>
* (arn:aws:sts::<i>123456789012</i>:assumed-role/CodeCommitReview/<i>Mary_Major</i>)
* unless you include a wildcard (*Mary_Major).</p> </li> <li> <p> <b>Fully
* qualified ARN</b>: This option allows you to specify the fully qualified Amazon
* Resource Name (ARN) of the IAM user or role. </p> </li> </ul> <p>For more
* information about IAM ARNs, wildcards, and formats, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p>
*/
inline void SetApprovalRuleTemplateContent(const Aws::String& value) { m_approvalRuleTemplateContentHasBeenSet = true; m_approvalRuleTemplateContent = value; }
/**
* <p>The content of the approval rule that is created on pull requests in
* associated repositories. If you specify one or more destination references
* (branches), approval rules are created in an associated repository only if their
* destination references (branches) match those specified in the template.</p>
* <p>When you create the content of the approval rule template, you can
* specify approvers in an approval pool in one of two ways:</p> <ul> <li> <p>
* <b>CodeCommitApprovers</b>: This option only requires an AWS account and a
* resource. It can be used for both IAM users and federated access users whose
* name matches the provided resource name. This is a very powerful option that
* offers a great deal of flexibility. For example, if you specify the AWS account
* <i>123456789012</i> and <i>Mary_Major</i>, all of the following are counted as
* approvals coming from that user:</p> <ul> <li> <p>An IAM user in the account
* (arn:aws:iam::<i>123456789012</i>:user/<i>Mary_Major</i>)</p> </li> <li> <p>A
* federated user identified in IAM as Mary_Major
* (arn:aws:sts::<i>123456789012</i>:federated-user/<i>Mary_Major</i>)</p> </li>
* </ul> <p>This option does not recognize an active session of someone assuming
* the role of CodeCommitReview with a role session name of <i>Mary_Major</i>
* (arn:aws:sts::<i>123456789012</i>:assumed-role/CodeCommitReview/<i>Mary_Major</i>)
* unless you include a wildcard (*Mary_Major).</p> </li> <li> <p> <b>Fully
* qualified ARN</b>: This option allows you to specify the fully qualified Amazon
* Resource Name (ARN) of the IAM user or role. </p> </li> </ul> <p>For more
* information about IAM ARNs, wildcards, and formats, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p>
*/
inline void SetApprovalRuleTemplateContent(Aws::String&& value) { m_approvalRuleTemplateContentHasBeenSet = true; m_approvalRuleTemplateContent = std::move(value); }
/**
* <p>The content of the approval rule that is created on pull requests in
* associated repositories. If you specify one or more destination references
* (branches), approval rules are created in an associated repository only if their
* destination references (branches) match those specified in the template.</p>
* <p>When you create the content of the approval rule template, you can
* specify approvers in an approval pool in one of two ways:</p> <ul> <li> <p>
* <b>CodeCommitApprovers</b>: This option only requires an AWS account and a
* resource. It can be used for both IAM users and federated access users whose
* name matches the provided resource name. This is a very powerful option that
* offers a great deal of flexibility. For example, if you specify the AWS account
* <i>123456789012</i> and <i>Mary_Major</i>, all of the following are counted as
* approvals coming from that user:</p> <ul> <li> <p>An IAM user in the account
* (arn:aws:iam::<i>123456789012</i>:user/<i>Mary_Major</i>)</p> </li> <li> <p>A
* federated user identified in IAM as Mary_Major
* (arn:aws:sts::<i>123456789012</i>:federated-user/<i>Mary_Major</i>)</p> </li>
* </ul> <p>This option does not recognize an active session of someone assuming
* the role of CodeCommitReview with a role session name of <i>Mary_Major</i>
* (arn:aws:sts::<i>123456789012</i>:assumed-role/CodeCommitReview/<i>Mary_Major</i>)
* unless you include a wildcard (*Mary_Major).</p> </li> <li> <p> <b>Fully
* qualified ARN</b>: This option allows you to specify the fully qualified Amazon
* Resource Name (ARN) of the IAM user or role. </p> </li> </ul> <p>For more
* information about IAM ARNs, wildcards, and formats, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p>
*/
inline void SetApprovalRuleTemplateContent(const char* value) { m_approvalRuleTemplateContentHasBeenSet = true; m_approvalRuleTemplateContent.assign(value); }
/**
* <p>The content of the approval rule that is created on pull requests in
* associated repositories. If you specify one or more destination references
* (branches), approval rules are created in an associated repository only if their
* destination references (branches) match those specified in the template.</p>
* <p>When you create the content of the approval rule template, you can
* specify approvers in an approval pool in one of two ways:</p> <ul> <li> <p>
* <b>CodeCommitApprovers</b>: This option only requires an AWS account and a
* resource. It can be used for both IAM users and federated access users whose
* name matches the provided resource name. This is a very powerful option that
* offers a great deal of flexibility. For example, if you specify the AWS account
* <i>123456789012</i> and <i>Mary_Major</i>, all of the following are counted as
* approvals coming from that user:</p> <ul> <li> <p>An IAM user in the account
* (arn:aws:iam::<i>123456789012</i>:user/<i>Mary_Major</i>)</p> </li> <li> <p>A
* federated user identified in IAM as Mary_Major
* (arn:aws:sts::<i>123456789012</i>:federated-user/<i>Mary_Major</i>)</p> </li>
* </ul> <p>This option does not recognize an active session of someone assuming
* the role of CodeCommitReview with a role session name of <i>Mary_Major</i>
* (arn:aws:sts::<i>123456789012</i>:assumed-role/CodeCommitReview/<i>Mary_Major</i>)
* unless you include a wildcard (*Mary_Major).</p> </li> <li> <p> <b>Fully
* qualified ARN</b>: This option allows you to specify the fully qualified Amazon
* Resource Name (ARN) of the IAM user or role. </p> </li> </ul> <p>For more
* information about IAM ARNs, wildcards, and formats, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p>
*/
inline CreateApprovalRuleTemplateRequest& WithApprovalRuleTemplateContent(const Aws::String& value) { SetApprovalRuleTemplateContent(value); return *this;}
/**
* <p>The content of the approval rule that is created on pull requests in
* associated repositories. If you specify one or more destination references
* (branches), approval rules are created in an associated repository only if their
* destination references (branches) match those specified in the template.</p>
* <p>When you create the content of the approval rule template, you can
* specify approvers in an approval pool in one of two ways:</p> <ul> <li> <p>
* <b>CodeCommitApprovers</b>: This option only requires an AWS account and a
* resource. It can be used for both IAM users and federated access users whose
* name matches the provided resource name. This is a very powerful option that
* offers a great deal of flexibility. For example, if you specify the AWS account
* <i>123456789012</i> and <i>Mary_Major</i>, all of the following are counted as
* approvals coming from that user:</p> <ul> <li> <p>An IAM user in the account
* (arn:aws:iam::<i>123456789012</i>:user/<i>Mary_Major</i>)</p> </li> <li> <p>A
* federated user identified in IAM as Mary_Major
* (arn:aws:sts::<i>123456789012</i>:federated-user/<i>Mary_Major</i>)</p> </li>
* </ul> <p>This option does not recognize an active session of someone assuming
* the role of CodeCommitReview with a role session name of <i>Mary_Major</i>
* (arn:aws:sts::<i>123456789012</i>:assumed-role/CodeCommitReview/<i>Mary_Major</i>)
* unless you include a wildcard (*Mary_Major).</p> </li> <li> <p> <b>Fully
* qualified ARN</b>: This option allows you to specify the fully qualified Amazon
* Resource Name (ARN) of the IAM user or role. </p> </li> </ul> <p>For more
* information about IAM ARNs, wildcards, and formats, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p>
*/
inline CreateApprovalRuleTemplateRequest& WithApprovalRuleTemplateContent(Aws::String&& value) { SetApprovalRuleTemplateContent(std::move(value)); return *this;}
/**
* <p>The content of the approval rule that is created on pull requests in
* associated repositories. If you specify one or more destination references
* (branches), approval rules are created in an associated repository only if their
* destination references (branches) match those specified in the template.</p>
* <p>When you create the content of the approval rule template, you can
* specify approvers in an approval pool in one of two ways:</p> <ul> <li> <p>
* <b>CodeCommitApprovers</b>: This option only requires an AWS account and a
* resource. It can be used for both IAM users and federated access users whose
* name matches the provided resource name. This is a very powerful option that
* offers a great deal of flexibility. For example, if you specify the AWS account
* <i>123456789012</i> and <i>Mary_Major</i>, all of the following are counted as
* approvals coming from that user:</p> <ul> <li> <p>An IAM user in the account
* (arn:aws:iam::<i>123456789012</i>:user/<i>Mary_Major</i>)</p> </li> <li> <p>A
* federated user identified in IAM as Mary_Major
* (arn:aws:sts::<i>123456789012</i>:federated-user/<i>Mary_Major</i>)</p> </li>
* </ul> <p>This option does not recognize an active session of someone assuming
* the role of CodeCommitReview with a role session name of <i>Mary_Major</i>
* (arn:aws:sts::<i>123456789012</i>:assumed-role/CodeCommitReview/<i>Mary_Major</i>)
* unless you include a wildcard (*Mary_Major).</p> </li> <li> <p> <b>Fully
* qualified ARN</b>: This option allows you to specify the fully qualified Amazon
* Resource Name (ARN) of the IAM user or role. </p> </li> </ul> <p>For more
* information about IAM ARNs, wildcards, and formats, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p>
*/
inline CreateApprovalRuleTemplateRequest& WithApprovalRuleTemplateContent(const char* value) { SetApprovalRuleTemplateContent(value); return *this;}
/**
* <p>The description of the approval rule template. Consider providing a
* description that explains what this template does and when it might be
* appropriate to associate it with repositories.</p>
*/
inline const Aws::String& GetApprovalRuleTemplateDescription() const{ return m_approvalRuleTemplateDescription; }
/**
* <p>The description of the approval rule template. Consider providing a
* description that explains what this template does and when it might be
* appropriate to associate it with repositories.</p>
*/
inline bool ApprovalRuleTemplateDescriptionHasBeenSet() const { return m_approvalRuleTemplateDescriptionHasBeenSet; }
/**
* <p>The description of the approval rule template. Consider providing a
* description that explains what this template does and when it might be
* appropriate to associate it with repositories.</p>
*/
inline void SetApprovalRuleTemplateDescription(const Aws::String& value) { m_approvalRuleTemplateDescriptionHasBeenSet = true; m_approvalRuleTemplateDescription = value; }
/**
* <p>The description of the approval rule template. Consider providing a
* description that explains what this template does and when it might be
* appropriate to associate it with repositories.</p>
*/
inline void SetApprovalRuleTemplateDescription(Aws::String&& value) { m_approvalRuleTemplateDescriptionHasBeenSet = true; m_approvalRuleTemplateDescription = std::move(value); }
/**
* <p>The description of the approval rule template. Consider providing a
* description that explains what this template does and when it might be
* appropriate to associate it with repositories.</p>
*/
inline void SetApprovalRuleTemplateDescription(const char* value) { m_approvalRuleTemplateDescriptionHasBeenSet = true; m_approvalRuleTemplateDescription.assign(value); }
/**
* <p>The description of the approval rule template. Consider providing a
* description that explains what this template does and when it might be
* appropriate to associate it with repositories.</p>
*/
inline CreateApprovalRuleTemplateRequest& WithApprovalRuleTemplateDescription(const Aws::String& value) { SetApprovalRuleTemplateDescription(value); return *this;}
/**
* <p>The description of the approval rule template. Consider providing a
* description that explains what this template does and when it might be
* appropriate to associate it with repositories.</p>
*/
inline CreateApprovalRuleTemplateRequest& WithApprovalRuleTemplateDescription(Aws::String&& value) { SetApprovalRuleTemplateDescription(std::move(value)); return *this;}
/**
* <p>The description of the approval rule template. Consider providing a
* description that explains what this template does and when it might be
* appropriate to associate it with repositories.</p>
*/
inline CreateApprovalRuleTemplateRequest& WithApprovalRuleTemplateDescription(const char* value) { SetApprovalRuleTemplateDescription(value); return *this;}
private:
Aws::String m_approvalRuleTemplateName;
bool m_approvalRuleTemplateNameHasBeenSet;
Aws::String m_approvalRuleTemplateContent;
bool m_approvalRuleTemplateContentHasBeenSet;
Aws::String m_approvalRuleTemplateDescription;
bool m_approvalRuleTemplateDescriptionHasBeenSet;
};
} // namespace Model
} // namespace CodeCommit
} // namespace Aws