Skip to content

Commit 2bdbf32

Browse files
author
aws-sdk-cpp-automation
committed
Documentation update for PutConfigRule and PutOrganizationConfigRule
This release introduces ModifySamlProperties, a new API that allows control of SAML properties associated with a WorkSpaces directory. The DescribeWorkspaceDirectories API will now additionally return SAML properties in its responses.
1 parent f13fa8f commit 2bdbf32

27 files changed

+1570
-274
lines changed

aws-cpp-sdk-config/include/aws/config/ConfigServiceClient.h

Lines changed: 78 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1881,8 +1881,10 @@ namespace Model
18811881
* conformance pack compared to the number of total possible rule-resource
18821882
* combinations in the conformance pack. This metric provides you with a high-level
18831883
* view of the compliance state of your conformance packs, and can be used to
1884-
* identify, investigate, and understand compliance deviations in your conformance
1885-
* packs.</p><p><h3>See Also:</h3> <a
1884+
* identify, investigate, and understand the level of compliance in your
1885+
* conformance packs.</p> <p>Conformance packs with no evaluation results
1886+
* will have a compliance score of <code>INSUFFICIENT_DATA</code>.</p>
1887+
* <p><h3>See Also:</h3> <a
18861888
* href="http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/ListConformancePackComplianceScores">AWS
18871889
* API Reference</a></p>
18881890
*/
@@ -1981,33 +1983,38 @@ namespace Model
19811983
virtual void PutAggregationAuthorizationAsync(const Model::PutAggregationAuthorizationRequest& request, const PutAggregationAuthorizationResponseReceivedHandler& handler, const std::shared_ptr<const Aws::Client::AsyncCallerContext>& context = nullptr) const;
19821984

19831985
/**
1984-
* <p>Adds or updates an Config rule for evaluating whether your Amazon Web
1985-
* Services resources comply with your desired configurations.</p> <p>You can use
1986-
* this action for Config custom rules and Config managed rules. A Config custom
1987-
* rule is a rule that you develop and maintain. An Config managed rule is a
1988-
* customizable, predefined rule that Config provides.</p> <p>If you are adding a
1989-
* new Config custom rule, you must first create the Lambda function that the rule
1990-
* invokes to evaluate your resources. When you use the <code>PutConfigRule</code>
1991-
* action to add the rule to Config, you must specify the Amazon Resource Name
1992-
* (ARN) that Lambda assigns to the function. Specify the ARN for the
1986+
* <p>Adds or updates an Config rule to evaluate if your Amazon Web Services
1987+
* resources comply with your desired configurations. For information on how many
1988+
* Config rules you can have per account, see <a
1989+
* href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
1990+
* <b>Service Limits</b> </a> in the <i>Config Developer Guide</i>.</p> <p>There
1991+
* are two types of rules: Config Custom Rules and Config Managed Rules. You can
1992+
* use <code>PutConfigRule</code> to create both Config custom rules and Config
1993+
* managed rules.</p> <p>Custom rules are rules that you can create using either
1994+
* Guard or Lambda functions. Guard (<a
1995+
* href="https://github.com/aws-cloudformation/cloudformation-guard">Guard GitHub
1996+
* Repository</a>) is a policy-as-code language that allows you to write policies
1997+
* that are enforced by Config Custom Policy rules. Lambda uses custom code that
1998+
* you upload to evaluate a custom rule. If you are adding a new Custom Lambda
1999+
* rule, you first need to create an Lambda function that the rule invokes to
2000+
* evaluate your resources. When you use <code>PutConfigRule</code> to add a Custom
2001+
* Lambda rule to Config, you must specify the Amazon Resource Name (ARN) that
2002+
* Lambda assigns to the function. You specify the ARN in the
19932003
* <code>SourceIdentifier</code> key. This key is part of the <code>Source</code>
1994-
* object, which is part of the <code>ConfigRule</code> object. </p> <p>If you are
1995-
* adding an Config managed rule, specify the rule's identifier for the
1996-
* <code>SourceIdentifier</code> key. To reference Config managed rule identifiers,
1997-
* see <a
1998-
* href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">About
1999-
* Config managed rules</a>.</p> <p>For any new rule that you add, specify the
2000-
* <code>ConfigRuleName</code> in the <code>ConfigRule</code> object. Do not
2001-
* specify the <code>ConfigRuleArn</code> or the <code>ConfigRuleId</code>. These
2002-
* values are generated by Config for new rules.</p> <p>If you are updating a rule
2003-
* that you added previously, you can specify the rule by
2004-
* <code>ConfigRuleName</code>, <code>ConfigRuleId</code>, or
2004+
* object, which is part of the <code>ConfigRule</code> object. </p> <p>Managed
2005+
* rules are predefined, customizable rules created by Config. For a list of
2006+
* managed rules, see <a
2007+
* href="https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html">List
2008+
* of Config Managed Rules</a>. If you are adding an Config managed rule, you must
2009+
* specify the rule's identifier for the <code>SourceIdentifier</code> key.</p>
2010+
* <p>For any new rule that you add, specify the <code>ConfigRuleName</code> in the
2011+
* <code>ConfigRule</code> object. Do not specify the <code>ConfigRuleArn</code> or
2012+
* the <code>ConfigRuleId</code>. These values are generated by Config for new
2013+
* rules.</p> <p>If you are updating a rule that you added previously, you can
2014+
* specify the rule by <code>ConfigRuleName</code>, <code>ConfigRuleId</code>, or
20052015
* <code>ConfigRuleArn</code> in the <code>ConfigRule</code> data type that you use
2006-
* in this request.</p> <p>For information on how many Config rules you can have
2007-
* per account, see <a
2008-
* href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
2009-
* <b>Service Limits</b> </a> in the Config Developer Guide.</p> <p>For more
2010-
* information about developing and using Config rules, see <a
2016+
* in this request.</p> <p>For more information about developing and using Config
2017+
* rules, see <a
20112018
* href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html">Evaluating
20122019
* Amazon Web Services resource Configurations with Config</a> in the <i>Config
20132020
* Developer Guide</i>.</p><p><h3>See Also:</h3> <a
@@ -2043,7 +2050,7 @@ namespace Model
20432050
* is a valid delegated administrator.</p> <p>To register a delegated
20442051
* administrator, see <a
20452052
* href="https://docs.aws.amazon.com/config/latest/developerguide/set-up-aggregator-cli.html#register-a-delegated-administrator-cli">Register
2046-
* a Delegated Administrator</a> in the Config developer guide. </p>
2053+
* a Delegated Administrator</a> in the <i>Config developer guide</i>. </p>
20472054
* <p><h3>See Also:</h3> <a
20482055
* href="http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/PutConfigurationAggregator">AWS
20492056
* API Reference</a></p>
@@ -2092,8 +2099,8 @@ namespace Model
20922099
* you can have per account, see <a
20932100
* href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
20942101
* <b>Service Limits</b> </a> in the Config Developer Guide.</p> <p>This API
2095-
* creates a service linked role <code>AWSServiceRoleForConfigConforms</code> in
2096-
* your account. The service linked role is created only when the role does not
2102+
* creates a service-linked role <code>AWSServiceRoleForConfigConforms</code> in
2103+
* your account. The service-linked role is created only when the role does not
20972104
* exist in your account. </p> <p>You must specify either the
20982105
* <code>TemplateS3Uri</code> or the <code>TemplateBody</code> parameter, but not
20992106
* both. If you provide both Config uses the <code>TemplateS3Uri</code> parameter
@@ -2179,38 +2186,49 @@ namespace Model
21792186
virtual void PutExternalEvaluationAsync(const Model::PutExternalEvaluationRequest& request, const PutExternalEvaluationResponseReceivedHandler& handler, const std::shared_ptr<const Aws::Client::AsyncCallerContext>& context = nullptr) const;
21802187

21812188
/**
2182-
* <p>Adds or updates organization Config rule for your entire organization
2183-
* evaluating whether your Amazon Web Services resources comply with your desired
2184-
* configurations. For information on how many organization Config rules you can
2185-
* have per account, see <a
2189+
* <p>Adds or updates an Config rule for your entire organization to evaluate if
2190+
* your Amazon Web Services resources comply with your desired configurations. For
2191+
* information on how many organization Config rules you can have per account, see
2192+
* <a
21862193
* href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
2187-
* <b>Service Limits</b> </a> in the Config Developer Guide.</p> <p> Only a master
2188-
* account and a delegated administrator can create or update an organization
2189-
* Config rule. When calling this API with a delegated administrator, you must
2190-
* ensure Organizations <code>ListDelegatedAdministrator</code> permissions are
2191-
* added. An organization can have up to 3 delegated administrators.</p> <p>This
2192-
* API enables organization service access through the
2193-
* <code>EnableAWSServiceAccess</code> action and creates a service linked role
2194+
* <b>Service Limits</b> </a> in the <i>Config Developer Guide</i>.</p> <p> Only a
2195+
* master account and a delegated administrator can create or update an
2196+
* organization Config rule. When calling this API with a delegated administrator,
2197+
* you must ensure Organizations <code>ListDelegatedAdministrator</code>
2198+
* permissions are added. An organization can have up to 3 delegated
2199+
* administrators.</p> <p>This API enables organization service access through the
2200+
* <code>EnableAWSServiceAccess</code> action and creates a service-linked role
21942201
* <code>AWSServiceRoleForConfigMultiAccountSetup</code> in the master or delegated
2195-
* administrator account of your organization. The service linked role is created
2202+
* administrator account of your organization. The service-linked role is created
21962203
* only when the role does not exist in the caller account. Config verifies the
21972204
* existence of role with <code>GetRole</code> action.</p> <p>To use this API with
21982205
* delegated administrator, register a delegated administrator by calling Amazon
21992206
* Web Services Organization <code>register-delegated-administrator</code> for
2200-
* <code>config-multiaccountsetup.amazonaws.com</code>. </p> <p>You can use this
2201-
* action to create both Config custom rules and Config managed rules. If you are
2202-
* adding a new Config custom rule, you must first create Lambda function in the
2203-
* master account or a delegated administrator that the rule invokes to evaluate
2204-
* your resources. You also need to create an IAM role in the managed-account that
2205-
* can be assumed by the Lambda function. When you use the
2206-
* <code>PutOrganizationConfigRule</code> action to add the rule to Config, you
2207-
* must specify the Amazon Resource Name (ARN) that Lambda assigns to the function.
2208-
* If you are adding an Config managed rule, specify the rule's identifier for the
2209-
* <code>RuleIdentifier</code> key.</p> <p>Prerequisite: Ensure you call
2210-
* <code>EnableAllFeatures</code> API to enable all features in an
2211-
* organization.</p> <p>Specify either <code>OrganizationCustomRuleMetadata</code>
2212-
* or <code>OrganizationManagedRuleMetadata</code>.</p> <p><h3>See
2213-
* Also:</h3> <a
2207+
* <code>config-multiaccountsetup.amazonaws.com</code>. </p> <p>There are two types
2208+
* of rules: Config Custom Rules and Config Managed Rules. You can use
2209+
* <code>PutOrganizationConfigRule</code> to create both Config custom rules and
2210+
* Config managed rules.</p> <p>Custom rules are rules that you can create using
2211+
* either Guard or Lambda functions. Guard (<a
2212+
* href="https://github.com/aws-cloudformation/cloudformation-guard">Guard GitHub
2213+
* Repository</a>) is a policy-as-code language that allows you to write policies
2214+
* that are enforced by Config Custom Policy rules. Lambda uses custom code that
2215+
* you upload to evaluate a custom rule. If you are adding a new Custom Lambda
2216+
* rule, you first need to create an Lambda function in the master account or a
2217+
* delegated administrator that the rule invokes to evaluate your resources. You
2218+
* also need to create an IAM role in the managed account that can be assumed by
2219+
* the Lambda function. When you use <code>PutOrganizationConfigRule</code> to add
2220+
* a Custom Lambda rule to Config, you must specify the Amazon Resource Name (ARN)
2221+
* that Lambda assigns to the function.</p> <p>Managed rules are predefined,
2222+
* customizable rules created by Config. For a list of managed rules, see <a
2223+
* href="https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html">List
2224+
* of Config Managed Rules</a>. If you are adding an Config managed rule, you must
2225+
* specify the rule's identifier for the <code>RuleIdentifier</code> key.</p>
2226+
* <p>Prerequisite: Ensure you call <code>EnableAllFeatures</code> API to
2227+
* enable all features in an organization.</p> <p>Make sure to specify one of
2228+
* either <code>OrganizationCustomPolicyRuleMetadata</code> for Custom Policy
2229+
* rules, <code>OrganizationCustomRuleMetadata</code> for Custom Lambda rules, or
2230+
* <code>OrganizationManagedRuleMetadata</code> for managed rules.</p>
2231+
* <p><h3>See Also:</h3> <a
22142232
* href="http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/PutOrganizationConfigRule">AWS
22152233
* API Reference</a></p>
22162234
*/
@@ -2237,9 +2255,9 @@ namespace Model
22372255
* <code>ListDelegatedAdministrator</code> permissions are added. An organization
22382256
* can have up to 3 delegated administrators.</p> <p>This API enables organization
22392257
* service access for <code>config-multiaccountsetup.amazonaws.com</code> through
2240-
* the <code>EnableAWSServiceAccess</code> action and creates a service linked role
2258+
* the <code>EnableAWSServiceAccess</code> action and creates a service-linked role
22412259
* <code>AWSServiceRoleForConfigMultiAccountSetup</code> in the master or delegated
2242-
* administrator account of your organization. The service linked role is created
2260+
* administrator account of your organization. The service-linked role is created
22432261
* only when the role does not exist in the caller account. To use this API with
22442262
* delegated administrator, register a delegated administrator by calling Amazon
22452263
* Web Services Organization <code>register-delegate-admin</code> for
@@ -2433,8 +2451,8 @@ namespace Model
24332451
* performs the corresponding search, and returns resource configurations matching
24342452
* the properties.</p> <p>For more information about query components, see the <a
24352453
* href="https://docs.aws.amazon.com/config/latest/developerguide/query-components.html">
2436-
* <b>Query Components</b> </a> section in the Config Developer
2437-
* Guide.</p><p><h3>See Also:</h3> <a
2454+
* <b>Query Components</b> </a> section in the <i>Config Developer
2455+
* Guide</i>.</p><p><h3>See Also:</h3> <a
24382456
* href="http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/SelectResourceConfig">AWS
24392457
* API Reference</a></p>
24402458
*/

0 commit comments

Comments
 (0)