From 766963ee3a5f6ea23b9c76bc9b4b38ec065d6f1d Mon Sep 17 00:00:00 2001 From: Aaron Khoo Date: Tue, 17 May 2016 09:13:01 -0700 Subject: [PATCH] Readme.md and Rules.md update --- README.md | 18 +++++++++++------- RULES.md | 10 +++++++++- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1e127c4e5..c24540fd8 100644 --- a/README.md +++ b/README.md @@ -10,14 +10,18 @@ You can use the sample functions in this repository to create Config rules that Add a rule to AWS Config by completing the following steps. For more detailed steps, see [Developing a Custom Rule for AWS Config](http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules_nodejs.html) in the *AWS Config Developer Guide*. 1. Sign in to the AWS Management Console and open the AWS Lambda console at https://console.aws.amazon.com/lambda/. Verify that your region is set to one that supports AWS Config rules. For the list of supported regions, see [AWS Config Regions and Endpoints](http://docs.aws.amazon.com/general/latest/gr/rande.html#awsconfig_region) in the *Amazon Web Services General Reference*. -2. Use the AWS Lambda console to create a Lambda function. - For the Lambda function code, copy and paste the code from the sample that you want to use. +2. Use the AWS Lambda console to create a Lambda function. + Provide your code using the method required by the code entry type that you choose. + If you are adding a Python or Node.js function, you can copy and paste the code from the sample that you want to use. If you are adding a Java function, you must provide a JAR file that contains the Java classes. For instructions to build the JAR file, see [Creating an AWS Config Rule with Java](./java/HOWTO.md). For the role that you assign to your function, choose the **AWS Config role** option to create a role that grants AWS Config permission to invoke the function. -3. After you create the function, take note of its ARN. -4. Open the AWS Config console at https://console.aws.amazon.com/config/. Verify that your region is set to the same region in which you created the AWS Lambda function for your custom rule. + For **Handler**, if you are adding a Python or Node.js function, keep the default value. If you are adding a Java function, specify the handler value for to the Java function that you want to use. For the handler values, see [AWS Config Rules (Java)](./java/RULES_JAVA.md). +3. After you create the function, take note of its ARN. +4. Open the AWS Config console at https://console.aws.amazon.com/config/. + Verify that your region is set to the same region in which you created the AWS Lambda function for your custom rule. 5. Use the AWS Config console to add a custom rule. For **AWS Lambda function ARN**, specify the ARN of the function that you created. - For **Trigger type**, if you are using any of the *triggered samples* from this repository (file name ends with ```triggered```), choose **Configuration changes**. If you are using any of the *periodic* samples from this repository (file name ends with ```periodic```), choose **Periodic**. - For the rule parameters, specify any required parameters that are documented in the [list of AWS Config rules (RULES.md)](./RULES.md). + For **Trigger type**, if you are using any of the *triggered samples* from this repository, choose **Configuration changes**. If you are using any of the *periodic* samples from this repository, choose **Periodic**. + For the rule parameters, specify any required parameters. + For the trigger types and required parameters for each function, see [AWS Config Rules](./RULES.md) (for Python and Node.js functions) or [AWS Config Rules (Java)](./java/RULES_JAVA.md). -After you create the rule, it displays on the **Rules** page, and AWS Config invokes its Lambda function. A summary of the evaluation results appears after several minutes. +After you create the rule, it displays on the **Rules** page, and AWS Config invokes its Lambda function. A summary of the evaluation results appears after several minutes. \ No newline at end of file diff --git a/RULES.md b/RULES.md index 7df7e1abb..e9a993589 100644 --- a/RULES.md +++ b/RULES.md @@ -242,4 +242,12 @@ Description: Checks that all EC2 instances that have match a tag format (via reg Trigger Type: ```Change Triggered``` Scope of Changes: ```EC2:Instance``` Required Parameters: ```namePattern```, ```securityGroupName``` -Example Value: ```^prod(us|eu|br)[lw]box[0-9]{3}$```, ```MyTestGroup``` \ No newline at end of file +Example Value: ```^prod(us|eu|br)[lw]box[0-9]{3}$```, ```MyTestGroup``` + +### 28. Ensure MFA Enabled on Root Account +Description: Checks that the Root Account has MFA Enabled + + java/src/main/java/com/amazonaws/services/config/samplerules/RootAccountMFAEnabled.java + +Trigger Type: ```Periodic``` +Required Parameter: ```None``` \ No newline at end of file