/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace CloudWatchLogs { namespace Model { /** */ class PutAccountPolicyRequest : public CloudWatchLogsRequest { public: AWS_CLOUDWATCHLOGS_API PutAccountPolicyRequest(); // 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 "PutAccountPolicy"; } AWS_CLOUDWATCHLOGS_API Aws::String SerializePayload() const override; AWS_CLOUDWATCHLOGS_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

A name for the policy. This must be unique within the account.

*/ inline const Aws::String& GetPolicyName() const{ return m_policyName; } /** *

A name for the policy. This must be unique within the account.

*/ inline bool PolicyNameHasBeenSet() const { return m_policyNameHasBeenSet; } /** *

A name for the policy. This must be unique within the account.

*/ inline void SetPolicyName(const Aws::String& value) { m_policyNameHasBeenSet = true; m_policyName = value; } /** *

A name for the policy. This must be unique within the account.

*/ inline void SetPolicyName(Aws::String&& value) { m_policyNameHasBeenSet = true; m_policyName = std::move(value); } /** *

A name for the policy. This must be unique within the account.

*/ inline void SetPolicyName(const char* value) { m_policyNameHasBeenSet = true; m_policyName.assign(value); } /** *

A name for the policy. This must be unique within the account.

*/ inline PutAccountPolicyRequest& WithPolicyName(const Aws::String& value) { SetPolicyName(value); return *this;} /** *

A name for the policy. This must be unique within the account.

*/ inline PutAccountPolicyRequest& WithPolicyName(Aws::String&& value) { SetPolicyName(std::move(value)); return *this;} /** *

A name for the policy. This must be unique within the account.

*/ inline PutAccountPolicyRequest& WithPolicyName(const char* value) { SetPolicyName(value); return *this;} /** *

Specify the data protection policy, in JSON.

This policy must include * two JSON blocks:

  • The first block must include both a * DataIdentifer array and an Operation property with an * Audit action. The DataIdentifer array lists the types * of sensitive data that you want to mask. For more information about the * available options, see Types * of data that you can mask.

    The Operation property with * an Audit action is required to find the sensitive data terms. This * Audit action must contain a FindingsDestination * object. You can optionally use that FindingsDestination object to * list one or more destinations to send audit findings to. If you specify * destinations such as log groups, Kinesis Data Firehose streams, and S3 buckets, * they must already exist.

  • The second block must include both a * DataIdentifer array and an Operation property with an * Deidentify action. The DataIdentifer array must * exactly match the DataIdentifer array in the first block of the * policy.

    The Operation property with the * Deidentify action is what actually masks the data, and it must * contain the "MaskConfig": {} object. The "MaskConfig": * {} object must be empty.

For an example data * protection policy, see the Examples section on this page.

*

The contents of the two DataIdentifer arrays must match * exactly.

In addition to the two JSON blocks, the * policyDocument can also include Name, * Description, and Version fields. The Name * is different than the operation's policyName parameter, and is used * as a dimension when CloudWatch Logs reports audit findings metrics to * CloudWatch.

The JSON specified in policyDocument can be up * to 30,720 characters.

*/ inline const Aws::String& GetPolicyDocument() const{ return m_policyDocument; } /** *

Specify the data protection policy, in JSON.

This policy must include * two JSON blocks:

  • The first block must include both a * DataIdentifer array and an Operation property with an * Audit action. The DataIdentifer array lists the types * of sensitive data that you want to mask. For more information about the * available options, see Types * of data that you can mask.

    The Operation property with * an Audit action is required to find the sensitive data terms. This * Audit action must contain a FindingsDestination * object. You can optionally use that FindingsDestination object to * list one or more destinations to send audit findings to. If you specify * destinations such as log groups, Kinesis Data Firehose streams, and S3 buckets, * they must already exist.

  • The second block must include both a * DataIdentifer array and an Operation property with an * Deidentify action. The DataIdentifer array must * exactly match the DataIdentifer array in the first block of the * policy.

    The Operation property with the * Deidentify action is what actually masks the data, and it must * contain the "MaskConfig": {} object. The "MaskConfig": * {} object must be empty.

For an example data * protection policy, see the Examples section on this page.

*

The contents of the two DataIdentifer arrays must match * exactly.

In addition to the two JSON blocks, the * policyDocument can also include Name, * Description, and Version fields. The Name * is different than the operation's policyName parameter, and is used * as a dimension when CloudWatch Logs reports audit findings metrics to * CloudWatch.

The JSON specified in policyDocument can be up * to 30,720 characters.

*/ inline bool PolicyDocumentHasBeenSet() const { return m_policyDocumentHasBeenSet; } /** *

Specify the data protection policy, in JSON.

This policy must include * two JSON blocks:

  • The first block must include both a * DataIdentifer array and an Operation property with an * Audit action. The DataIdentifer array lists the types * of sensitive data that you want to mask. For more information about the * available options, see Types * of data that you can mask.

    The Operation property with * an Audit action is required to find the sensitive data terms. This * Audit action must contain a FindingsDestination * object. You can optionally use that FindingsDestination object to * list one or more destinations to send audit findings to. If you specify * destinations such as log groups, Kinesis Data Firehose streams, and S3 buckets, * they must already exist.

  • The second block must include both a * DataIdentifer array and an Operation property with an * Deidentify action. The DataIdentifer array must * exactly match the DataIdentifer array in the first block of the * policy.

    The Operation property with the * Deidentify action is what actually masks the data, and it must * contain the "MaskConfig": {} object. The "MaskConfig": * {} object must be empty.

For an example data * protection policy, see the Examples section on this page.

*

The contents of the two DataIdentifer arrays must match * exactly.

In addition to the two JSON blocks, the * policyDocument can also include Name, * Description, and Version fields. The Name * is different than the operation's policyName parameter, and is used * as a dimension when CloudWatch Logs reports audit findings metrics to * CloudWatch.

The JSON specified in policyDocument can be up * to 30,720 characters.

*/ inline void SetPolicyDocument(const Aws::String& value) { m_policyDocumentHasBeenSet = true; m_policyDocument = value; } /** *

Specify the data protection policy, in JSON.

This policy must include * two JSON blocks:

  • The first block must include both a * DataIdentifer array and an Operation property with an * Audit action. The DataIdentifer array lists the types * of sensitive data that you want to mask. For more information about the * available options, see Types * of data that you can mask.

    The Operation property with * an Audit action is required to find the sensitive data terms. This * Audit action must contain a FindingsDestination * object. You can optionally use that FindingsDestination object to * list one or more destinations to send audit findings to. If you specify * destinations such as log groups, Kinesis Data Firehose streams, and S3 buckets, * they must already exist.

  • The second block must include both a * DataIdentifer array and an Operation property with an * Deidentify action. The DataIdentifer array must * exactly match the DataIdentifer array in the first block of the * policy.

    The Operation property with the * Deidentify action is what actually masks the data, and it must * contain the "MaskConfig": {} object. The "MaskConfig": * {} object must be empty.

For an example data * protection policy, see the Examples section on this page.

*

The contents of the two DataIdentifer arrays must match * exactly.

In addition to the two JSON blocks, the * policyDocument can also include Name, * Description, and Version fields. The Name * is different than the operation's policyName parameter, and is used * as a dimension when CloudWatch Logs reports audit findings metrics to * CloudWatch.

The JSON specified in policyDocument can be up * to 30,720 characters.

*/ inline void SetPolicyDocument(Aws::String&& value) { m_policyDocumentHasBeenSet = true; m_policyDocument = std::move(value); } /** *

Specify the data protection policy, in JSON.

This policy must include * two JSON blocks:

  • The first block must include both a * DataIdentifer array and an Operation property with an * Audit action. The DataIdentifer array lists the types * of sensitive data that you want to mask. For more information about the * available options, see Types * of data that you can mask.

    The Operation property with * an Audit action is required to find the sensitive data terms. This * Audit action must contain a FindingsDestination * object. You can optionally use that FindingsDestination object to * list one or more destinations to send audit findings to. If you specify * destinations such as log groups, Kinesis Data Firehose streams, and S3 buckets, * they must already exist.

  • The second block must include both a * DataIdentifer array and an Operation property with an * Deidentify action. The DataIdentifer array must * exactly match the DataIdentifer array in the first block of the * policy.

    The Operation property with the * Deidentify action is what actually masks the data, and it must * contain the "MaskConfig": {} object. The "MaskConfig": * {} object must be empty.

For an example data * protection policy, see the Examples section on this page.

*

The contents of the two DataIdentifer arrays must match * exactly.

In addition to the two JSON blocks, the * policyDocument can also include Name, * Description, and Version fields. The Name * is different than the operation's policyName parameter, and is used * as a dimension when CloudWatch Logs reports audit findings metrics to * CloudWatch.

The JSON specified in policyDocument can be up * to 30,720 characters.

*/ inline void SetPolicyDocument(const char* value) { m_policyDocumentHasBeenSet = true; m_policyDocument.assign(value); } /** *

Specify the data protection policy, in JSON.

This policy must include * two JSON blocks:

  • The first block must include both a * DataIdentifer array and an Operation property with an * Audit action. The DataIdentifer array lists the types * of sensitive data that you want to mask. For more information about the * available options, see Types * of data that you can mask.

    The Operation property with * an Audit action is required to find the sensitive data terms. This * Audit action must contain a FindingsDestination * object. You can optionally use that FindingsDestination object to * list one or more destinations to send audit findings to. If you specify * destinations such as log groups, Kinesis Data Firehose streams, and S3 buckets, * they must already exist.

  • The second block must include both a * DataIdentifer array and an Operation property with an * Deidentify action. The DataIdentifer array must * exactly match the DataIdentifer array in the first block of the * policy.

    The Operation property with the * Deidentify action is what actually masks the data, and it must * contain the "MaskConfig": {} object. The "MaskConfig": * {} object must be empty.

For an example data * protection policy, see the Examples section on this page.

*

The contents of the two DataIdentifer arrays must match * exactly.

In addition to the two JSON blocks, the * policyDocument can also include Name, * Description, and Version fields. The Name * is different than the operation's policyName parameter, and is used * as a dimension when CloudWatch Logs reports audit findings metrics to * CloudWatch.

The JSON specified in policyDocument can be up * to 30,720 characters.

*/ inline PutAccountPolicyRequest& WithPolicyDocument(const Aws::String& value) { SetPolicyDocument(value); return *this;} /** *

Specify the data protection policy, in JSON.

This policy must include * two JSON blocks:

  • The first block must include both a * DataIdentifer array and an Operation property with an * Audit action. The DataIdentifer array lists the types * of sensitive data that you want to mask. For more information about the * available options, see Types * of data that you can mask.

    The Operation property with * an Audit action is required to find the sensitive data terms. This * Audit action must contain a FindingsDestination * object. You can optionally use that FindingsDestination object to * list one or more destinations to send audit findings to. If you specify * destinations such as log groups, Kinesis Data Firehose streams, and S3 buckets, * they must already exist.

  • The second block must include both a * DataIdentifer array and an Operation property with an * Deidentify action. The DataIdentifer array must * exactly match the DataIdentifer array in the first block of the * policy.

    The Operation property with the * Deidentify action is what actually masks the data, and it must * contain the "MaskConfig": {} object. The "MaskConfig": * {} object must be empty.

For an example data * protection policy, see the Examples section on this page.

*

The contents of the two DataIdentifer arrays must match * exactly.

In addition to the two JSON blocks, the * policyDocument can also include Name, * Description, and Version fields. The Name * is different than the operation's policyName parameter, and is used * as a dimension when CloudWatch Logs reports audit findings metrics to * CloudWatch.

The JSON specified in policyDocument can be up * to 30,720 characters.

*/ inline PutAccountPolicyRequest& WithPolicyDocument(Aws::String&& value) { SetPolicyDocument(std::move(value)); return *this;} /** *

Specify the data protection policy, in JSON.

This policy must include * two JSON blocks:

  • The first block must include both a * DataIdentifer array and an Operation property with an * Audit action. The DataIdentifer array lists the types * of sensitive data that you want to mask. For more information about the * available options, see Types * of data that you can mask.

    The Operation property with * an Audit action is required to find the sensitive data terms. This * Audit action must contain a FindingsDestination * object. You can optionally use that FindingsDestination object to * list one or more destinations to send audit findings to. If you specify * destinations such as log groups, Kinesis Data Firehose streams, and S3 buckets, * they must already exist.

  • The second block must include both a * DataIdentifer array and an Operation property with an * Deidentify action. The DataIdentifer array must * exactly match the DataIdentifer array in the first block of the * policy.

    The Operation property with the * Deidentify action is what actually masks the data, and it must * contain the "MaskConfig": {} object. The "MaskConfig": * {} object must be empty.

For an example data * protection policy, see the Examples section on this page.

*

The contents of the two DataIdentifer arrays must match * exactly.

In addition to the two JSON blocks, the * policyDocument can also include Name, * Description, and Version fields. The Name * is different than the operation's policyName parameter, and is used * as a dimension when CloudWatch Logs reports audit findings metrics to * CloudWatch.

The JSON specified in policyDocument can be up * to 30,720 characters.

*/ inline PutAccountPolicyRequest& WithPolicyDocument(const char* value) { SetPolicyDocument(value); return *this;} /** *

Currently the only valid value for this parameter is * DATA_PROTECTION_POLICY.

*/ inline const PolicyType& GetPolicyType() const{ return m_policyType; } /** *

Currently the only valid value for this parameter is * DATA_PROTECTION_POLICY.

*/ inline bool PolicyTypeHasBeenSet() const { return m_policyTypeHasBeenSet; } /** *

Currently the only valid value for this parameter is * DATA_PROTECTION_POLICY.

*/ inline void SetPolicyType(const PolicyType& value) { m_policyTypeHasBeenSet = true; m_policyType = value; } /** *

Currently the only valid value for this parameter is * DATA_PROTECTION_POLICY.

*/ inline void SetPolicyType(PolicyType&& value) { m_policyTypeHasBeenSet = true; m_policyType = std::move(value); } /** *

Currently the only valid value for this parameter is * DATA_PROTECTION_POLICY.

*/ inline PutAccountPolicyRequest& WithPolicyType(const PolicyType& value) { SetPolicyType(value); return *this;} /** *

Currently the only valid value for this parameter is * DATA_PROTECTION_POLICY.

*/ inline PutAccountPolicyRequest& WithPolicyType(PolicyType&& value) { SetPolicyType(std::move(value)); return *this;} /** *

Currently the only valid value for this parameter is ALL, which * specifies that the data protection policy applies to all log groups in the * account. If you omit this parameter, the default of ALL is * used.

*/ inline const Scope& GetScope() const{ return m_scope; } /** *

Currently the only valid value for this parameter is ALL, which * specifies that the data protection policy applies to all log groups in the * account. If you omit this parameter, the default of ALL is * used.

*/ inline bool ScopeHasBeenSet() const { return m_scopeHasBeenSet; } /** *

Currently the only valid value for this parameter is ALL, which * specifies that the data protection policy applies to all log groups in the * account. If you omit this parameter, the default of ALL is * used.

*/ inline void SetScope(const Scope& value) { m_scopeHasBeenSet = true; m_scope = value; } /** *

Currently the only valid value for this parameter is ALL, which * specifies that the data protection policy applies to all log groups in the * account. If you omit this parameter, the default of ALL is * used.

*/ inline void SetScope(Scope&& value) { m_scopeHasBeenSet = true; m_scope = std::move(value); } /** *

Currently the only valid value for this parameter is ALL, which * specifies that the data protection policy applies to all log groups in the * account. If you omit this parameter, the default of ALL is * used.

*/ inline PutAccountPolicyRequest& WithScope(const Scope& value) { SetScope(value); return *this;} /** *

Currently the only valid value for this parameter is ALL, which * specifies that the data protection policy applies to all log groups in the * account. If you omit this parameter, the default of ALL is * used.

*/ inline PutAccountPolicyRequest& WithScope(Scope&& value) { SetScope(std::move(value)); return *this;} private: Aws::String m_policyName; bool m_policyNameHasBeenSet = false; Aws::String m_policyDocument; bool m_policyDocumentHasBeenSet = false; PolicyType m_policyType; bool m_policyTypeHasBeenSet = false; Scope m_scope; bool m_scopeHasBeenSet = false; }; } // namespace Model } // namespace CloudWatchLogs } // namespace Aws