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-config/include/aws/config/model/OrganizationManagedRuleMetadata.h

477 lines
20 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/config/ConfigService_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/config/model/MaximumExecutionFrequency.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace ConfigService
{
namespace Model
{
/**
* <p>An object that specifies organization managed rule metadata such as resource
* type and ID of AWS resource along with the rule identifier. It also provides the
* frequency with which you want AWS Config to run evaluations for the rule if the
* trigger type is periodic.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/OrganizationManagedRuleMetadata">AWS
* API Reference</a></p>
*/
class AWS_CONFIGSERVICE_API OrganizationManagedRuleMetadata
{
public:
OrganizationManagedRuleMetadata();
OrganizationManagedRuleMetadata(Aws::Utils::Json::JsonView jsonValue);
OrganizationManagedRuleMetadata& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* <p>The description that you provide for organization config rule.</p>
*/
inline const Aws::String& GetDescription() const{ return m_description; }
/**
* <p>The description that you provide for organization config rule.</p>
*/
inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
/**
* <p>The description that you provide for organization config rule.</p>
*/
inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; }
/**
* <p>The description that you provide for organization config rule.</p>
*/
inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); }
/**
* <p>The description that you provide for organization config rule.</p>
*/
inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); }
/**
* <p>The description that you provide for organization config rule.</p>
*/
inline OrganizationManagedRuleMetadata& WithDescription(const Aws::String& value) { SetDescription(value); return *this;}
/**
* <p>The description that you provide for organization config rule.</p>
*/
inline OrganizationManagedRuleMetadata& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;}
/**
* <p>The description that you provide for organization config rule.</p>
*/
inline OrganizationManagedRuleMetadata& WithDescription(const char* value) { SetDescription(value); return *this;}
/**
* <p>For organization config managed rules, a predefined identifier from a list.
* For example, <code>IAM_PASSWORD_POLICY</code> is a managed rule. To reference a
* managed rule, see <a
* href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using
* AWS Managed Config Rules</a>.</p>
*/
inline const Aws::String& GetRuleIdentifier() const{ return m_ruleIdentifier; }
/**
* <p>For organization config managed rules, a predefined identifier from a list.
* For example, <code>IAM_PASSWORD_POLICY</code> is a managed rule. To reference a
* managed rule, see <a
* href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using
* AWS Managed Config Rules</a>.</p>
*/
inline bool RuleIdentifierHasBeenSet() const { return m_ruleIdentifierHasBeenSet; }
/**
* <p>For organization config managed rules, a predefined identifier from a list.
* For example, <code>IAM_PASSWORD_POLICY</code> is a managed rule. To reference a
* managed rule, see <a
* href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using
* AWS Managed Config Rules</a>.</p>
*/
inline void SetRuleIdentifier(const Aws::String& value) { m_ruleIdentifierHasBeenSet = true; m_ruleIdentifier = value; }
/**
* <p>For organization config managed rules, a predefined identifier from a list.
* For example, <code>IAM_PASSWORD_POLICY</code> is a managed rule. To reference a
* managed rule, see <a
* href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using
* AWS Managed Config Rules</a>.</p>
*/
inline void SetRuleIdentifier(Aws::String&& value) { m_ruleIdentifierHasBeenSet = true; m_ruleIdentifier = std::move(value); }
/**
* <p>For organization config managed rules, a predefined identifier from a list.
* For example, <code>IAM_PASSWORD_POLICY</code> is a managed rule. To reference a
* managed rule, see <a
* href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using
* AWS Managed Config Rules</a>.</p>
*/
inline void SetRuleIdentifier(const char* value) { m_ruleIdentifierHasBeenSet = true; m_ruleIdentifier.assign(value); }
/**
* <p>For organization config managed rules, a predefined identifier from a list.
* For example, <code>IAM_PASSWORD_POLICY</code> is a managed rule. To reference a
* managed rule, see <a
* href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using
* AWS Managed Config Rules</a>.</p>
*/
inline OrganizationManagedRuleMetadata& WithRuleIdentifier(const Aws::String& value) { SetRuleIdentifier(value); return *this;}
/**
* <p>For organization config managed rules, a predefined identifier from a list.
* For example, <code>IAM_PASSWORD_POLICY</code> is a managed rule. To reference a
* managed rule, see <a
* href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using
* AWS Managed Config Rules</a>.</p>
*/
inline OrganizationManagedRuleMetadata& WithRuleIdentifier(Aws::String&& value) { SetRuleIdentifier(std::move(value)); return *this;}
/**
* <p>For organization config managed rules, a predefined identifier from a list.
* For example, <code>IAM_PASSWORD_POLICY</code> is a managed rule. To reference a
* managed rule, see <a
* href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using
* AWS Managed Config Rules</a>.</p>
*/
inline OrganizationManagedRuleMetadata& WithRuleIdentifier(const char* value) { SetRuleIdentifier(value); return *this;}
/**
* <p>A string, in JSON format, that is passed to organization config rule Lambda
* function.</p>
*/
inline const Aws::String& GetInputParameters() const{ return m_inputParameters; }
/**
* <p>A string, in JSON format, that is passed to organization config rule Lambda
* function.</p>
*/
inline bool InputParametersHasBeenSet() const { return m_inputParametersHasBeenSet; }
/**
* <p>A string, in JSON format, that is passed to organization config rule Lambda
* function.</p>
*/
inline void SetInputParameters(const Aws::String& value) { m_inputParametersHasBeenSet = true; m_inputParameters = value; }
/**
* <p>A string, in JSON format, that is passed to organization config rule Lambda
* function.</p>
*/
inline void SetInputParameters(Aws::String&& value) { m_inputParametersHasBeenSet = true; m_inputParameters = std::move(value); }
/**
* <p>A string, in JSON format, that is passed to organization config rule Lambda
* function.</p>
*/
inline void SetInputParameters(const char* value) { m_inputParametersHasBeenSet = true; m_inputParameters.assign(value); }
/**
* <p>A string, in JSON format, that is passed to organization config rule Lambda
* function.</p>
*/
inline OrganizationManagedRuleMetadata& WithInputParameters(const Aws::String& value) { SetInputParameters(value); return *this;}
/**
* <p>A string, in JSON format, that is passed to organization config rule Lambda
* function.</p>
*/
inline OrganizationManagedRuleMetadata& WithInputParameters(Aws::String&& value) { SetInputParameters(std::move(value)); return *this;}
/**
* <p>A string, in JSON format, that is passed to organization config rule Lambda
* function.</p>
*/
inline OrganizationManagedRuleMetadata& WithInputParameters(const char* value) { SetInputParameters(value); return *this;}
/**
* <p>The maximum frequency with which AWS Config runs evaluations for a rule. You
* are using an AWS managed rule that is triggered at a periodic frequency.</p>
* <p>By default, rules with a periodic trigger are evaluated every 24
* hours. To change the frequency, specify a valid value for the
* <code>MaximumExecutionFrequency</code> parameter.</p>
*/
inline const MaximumExecutionFrequency& GetMaximumExecutionFrequency() const{ return m_maximumExecutionFrequency; }
/**
* <p>The maximum frequency with which AWS Config runs evaluations for a rule. You
* are using an AWS managed rule that is triggered at a periodic frequency.</p>
* <p>By default, rules with a periodic trigger are evaluated every 24
* hours. To change the frequency, specify a valid value for the
* <code>MaximumExecutionFrequency</code> parameter.</p>
*/
inline bool MaximumExecutionFrequencyHasBeenSet() const { return m_maximumExecutionFrequencyHasBeenSet; }
/**
* <p>The maximum frequency with which AWS Config runs evaluations for a rule. You
* are using an AWS managed rule that is triggered at a periodic frequency.</p>
* <p>By default, rules with a periodic trigger are evaluated every 24
* hours. To change the frequency, specify a valid value for the
* <code>MaximumExecutionFrequency</code> parameter.</p>
*/
inline void SetMaximumExecutionFrequency(const MaximumExecutionFrequency& value) { m_maximumExecutionFrequencyHasBeenSet = true; m_maximumExecutionFrequency = value; }
/**
* <p>The maximum frequency with which AWS Config runs evaluations for a rule. You
* are using an AWS managed rule that is triggered at a periodic frequency.</p>
* <p>By default, rules with a periodic trigger are evaluated every 24
* hours. To change the frequency, specify a valid value for the
* <code>MaximumExecutionFrequency</code> parameter.</p>
*/
inline void SetMaximumExecutionFrequency(MaximumExecutionFrequency&& value) { m_maximumExecutionFrequencyHasBeenSet = true; m_maximumExecutionFrequency = std::move(value); }
/**
* <p>The maximum frequency with which AWS Config runs evaluations for a rule. You
* are using an AWS managed rule that is triggered at a periodic frequency.</p>
* <p>By default, rules with a periodic trigger are evaluated every 24
* hours. To change the frequency, specify a valid value for the
* <code>MaximumExecutionFrequency</code> parameter.</p>
*/
inline OrganizationManagedRuleMetadata& WithMaximumExecutionFrequency(const MaximumExecutionFrequency& value) { SetMaximumExecutionFrequency(value); return *this;}
/**
* <p>The maximum frequency with which AWS Config runs evaluations for a rule. You
* are using an AWS managed rule that is triggered at a periodic frequency.</p>
* <p>By default, rules with a periodic trigger are evaluated every 24
* hours. To change the frequency, specify a valid value for the
* <code>MaximumExecutionFrequency</code> parameter.</p>
*/
inline OrganizationManagedRuleMetadata& WithMaximumExecutionFrequency(MaximumExecutionFrequency&& value) { SetMaximumExecutionFrequency(std::move(value)); return *this;}
/**
* <p>The type of the AWS resource that was evaluated.</p>
*/
inline const Aws::Vector<Aws::String>& GetResourceTypesScope() const{ return m_resourceTypesScope; }
/**
* <p>The type of the AWS resource that was evaluated.</p>
*/
inline bool ResourceTypesScopeHasBeenSet() const { return m_resourceTypesScopeHasBeenSet; }
/**
* <p>The type of the AWS resource that was evaluated.</p>
*/
inline void SetResourceTypesScope(const Aws::Vector<Aws::String>& value) { m_resourceTypesScopeHasBeenSet = true; m_resourceTypesScope = value; }
/**
* <p>The type of the AWS resource that was evaluated.</p>
*/
inline void SetResourceTypesScope(Aws::Vector<Aws::String>&& value) { m_resourceTypesScopeHasBeenSet = true; m_resourceTypesScope = std::move(value); }
/**
* <p>The type of the AWS resource that was evaluated.</p>
*/
inline OrganizationManagedRuleMetadata& WithResourceTypesScope(const Aws::Vector<Aws::String>& value) { SetResourceTypesScope(value); return *this;}
/**
* <p>The type of the AWS resource that was evaluated.</p>
*/
inline OrganizationManagedRuleMetadata& WithResourceTypesScope(Aws::Vector<Aws::String>&& value) { SetResourceTypesScope(std::move(value)); return *this;}
/**
* <p>The type of the AWS resource that was evaluated.</p>
*/
inline OrganizationManagedRuleMetadata& AddResourceTypesScope(const Aws::String& value) { m_resourceTypesScopeHasBeenSet = true; m_resourceTypesScope.push_back(value); return *this; }
/**
* <p>The type of the AWS resource that was evaluated.</p>
*/
inline OrganizationManagedRuleMetadata& AddResourceTypesScope(Aws::String&& value) { m_resourceTypesScopeHasBeenSet = true; m_resourceTypesScope.push_back(std::move(value)); return *this; }
/**
* <p>The type of the AWS resource that was evaluated.</p>
*/
inline OrganizationManagedRuleMetadata& AddResourceTypesScope(const char* value) { m_resourceTypesScopeHasBeenSet = true; m_resourceTypesScope.push_back(value); return *this; }
/**
* <p>The ID of the AWS resource that was evaluated.</p>
*/
inline const Aws::String& GetResourceIdScope() const{ return m_resourceIdScope; }
/**
* <p>The ID of the AWS resource that was evaluated.</p>
*/
inline bool ResourceIdScopeHasBeenSet() const { return m_resourceIdScopeHasBeenSet; }
/**
* <p>The ID of the AWS resource that was evaluated.</p>
*/
inline void SetResourceIdScope(const Aws::String& value) { m_resourceIdScopeHasBeenSet = true; m_resourceIdScope = value; }
/**
* <p>The ID of the AWS resource that was evaluated.</p>
*/
inline void SetResourceIdScope(Aws::String&& value) { m_resourceIdScopeHasBeenSet = true; m_resourceIdScope = std::move(value); }
/**
* <p>The ID of the AWS resource that was evaluated.</p>
*/
inline void SetResourceIdScope(const char* value) { m_resourceIdScopeHasBeenSet = true; m_resourceIdScope.assign(value); }
/**
* <p>The ID of the AWS resource that was evaluated.</p>
*/
inline OrganizationManagedRuleMetadata& WithResourceIdScope(const Aws::String& value) { SetResourceIdScope(value); return *this;}
/**
* <p>The ID of the AWS resource that was evaluated.</p>
*/
inline OrganizationManagedRuleMetadata& WithResourceIdScope(Aws::String&& value) { SetResourceIdScope(std::move(value)); return *this;}
/**
* <p>The ID of the AWS resource that was evaluated.</p>
*/
inline OrganizationManagedRuleMetadata& WithResourceIdScope(const char* value) { SetResourceIdScope(value); return *this;}
/**
* <p>One part of a key-value pair that make up a tag. A key is a general label
* that acts like a category for more specific tag values. </p>
*/
inline const Aws::String& GetTagKeyScope() const{ return m_tagKeyScope; }
/**
* <p>One part of a key-value pair that make up a tag. A key is a general label
* that acts like a category for more specific tag values. </p>
*/
inline bool TagKeyScopeHasBeenSet() const { return m_tagKeyScopeHasBeenSet; }
/**
* <p>One part of a key-value pair that make up a tag. A key is a general label
* that acts like a category for more specific tag values. </p>
*/
inline void SetTagKeyScope(const Aws::String& value) { m_tagKeyScopeHasBeenSet = true; m_tagKeyScope = value; }
/**
* <p>One part of a key-value pair that make up a tag. A key is a general label
* that acts like a category for more specific tag values. </p>
*/
inline void SetTagKeyScope(Aws::String&& value) { m_tagKeyScopeHasBeenSet = true; m_tagKeyScope = std::move(value); }
/**
* <p>One part of a key-value pair that make up a tag. A key is a general label
* that acts like a category for more specific tag values. </p>
*/
inline void SetTagKeyScope(const char* value) { m_tagKeyScopeHasBeenSet = true; m_tagKeyScope.assign(value); }
/**
* <p>One part of a key-value pair that make up a tag. A key is a general label
* that acts like a category for more specific tag values. </p>
*/
inline OrganizationManagedRuleMetadata& WithTagKeyScope(const Aws::String& value) { SetTagKeyScope(value); return *this;}
/**
* <p>One part of a key-value pair that make up a tag. A key is a general label
* that acts like a category for more specific tag values. </p>
*/
inline OrganizationManagedRuleMetadata& WithTagKeyScope(Aws::String&& value) { SetTagKeyScope(std::move(value)); return *this;}
/**
* <p>One part of a key-value pair that make up a tag. A key is a general label
* that acts like a category for more specific tag values. </p>
*/
inline OrganizationManagedRuleMetadata& WithTagKeyScope(const char* value) { SetTagKeyScope(value); return *this;}
/**
* <p>The optional part of a key-value pair that make up a tag. A value acts as a
* descriptor within a tag category (key).</p>
*/
inline const Aws::String& GetTagValueScope() const{ return m_tagValueScope; }
/**
* <p>The optional part of a key-value pair that make up a tag. A value acts as a
* descriptor within a tag category (key).</p>
*/
inline bool TagValueScopeHasBeenSet() const { return m_tagValueScopeHasBeenSet; }
/**
* <p>The optional part of a key-value pair that make up a tag. A value acts as a
* descriptor within a tag category (key).</p>
*/
inline void SetTagValueScope(const Aws::String& value) { m_tagValueScopeHasBeenSet = true; m_tagValueScope = value; }
/**
* <p>The optional part of a key-value pair that make up a tag. A value acts as a
* descriptor within a tag category (key).</p>
*/
inline void SetTagValueScope(Aws::String&& value) { m_tagValueScopeHasBeenSet = true; m_tagValueScope = std::move(value); }
/**
* <p>The optional part of a key-value pair that make up a tag. A value acts as a
* descriptor within a tag category (key).</p>
*/
inline void SetTagValueScope(const char* value) { m_tagValueScopeHasBeenSet = true; m_tagValueScope.assign(value); }
/**
* <p>The optional part of a key-value pair that make up a tag. A value acts as a
* descriptor within a tag category (key).</p>
*/
inline OrganizationManagedRuleMetadata& WithTagValueScope(const Aws::String& value) { SetTagValueScope(value); return *this;}
/**
* <p>The optional part of a key-value pair that make up a tag. A value acts as a
* descriptor within a tag category (key).</p>
*/
inline OrganizationManagedRuleMetadata& WithTagValueScope(Aws::String&& value) { SetTagValueScope(std::move(value)); return *this;}
/**
* <p>The optional part of a key-value pair that make up a tag. A value acts as a
* descriptor within a tag category (key).</p>
*/
inline OrganizationManagedRuleMetadata& WithTagValueScope(const char* value) { SetTagValueScope(value); return *this;}
private:
Aws::String m_description;
bool m_descriptionHasBeenSet;
Aws::String m_ruleIdentifier;
bool m_ruleIdentifierHasBeenSet;
Aws::String m_inputParameters;
bool m_inputParametersHasBeenSet;
MaximumExecutionFrequency m_maximumExecutionFrequency;
bool m_maximumExecutionFrequencyHasBeenSet;
Aws::Vector<Aws::String> m_resourceTypesScope;
bool m_resourceTypesScopeHasBeenSet;
Aws::String m_resourceIdScope;
bool m_resourceIdScopeHasBeenSet;
Aws::String m_tagKeyScope;
bool m_tagKeyScopeHasBeenSet;
Aws::String m_tagValueScope;
bool m_tagValueScopeHasBeenSet;
};
} // namespace Model
} // namespace ConfigService
} // namespace Aws