What is configuration recorder in AWS?

Amazon Config uses the configuration recorder to detect changes in your resource configurations and capture these changes as configuration items. You must create a configuration recorder before Amazon Config can track your resource configurations.

If you set up Amazon Config by using the console or the Amazon CLI, Amazon Config automatically creates and then starts the configuration recorder for you. For more information, see Getting Started with Amazon Config.

By default, the configuration recorder records all supported resources in the region where Amazon Config is running. You can create a customized configuration recorder that records only the resource types that you specify. For more information, see Selecting Which Resources Amazon Config Records.

You are charged service usage fees when Amazon Config starts recording configurations. For pricing information, see Amazon Config Pricing. To control costs, you can stop recording by stopping the configuration recorder. After you stop recording, you can continue to access the configuration information that was already recorded. You will not be charged Amazon Config usage fees until you resume recording.

When you start the configuration recorder, Amazon Config takes an inventory of all Amazon resources in your account.

Managing the Configuration Recorder (Console)

You can use the Amazon Config console to stop or start the configuration recorder.

To stop or start the configuration recorder

1. Sign in to the Amazon Web Services Management Console and open the Amazon Config console at https://console.amazonaws.cn/config/.

2. Choose Settings in the navigation pane.

3. Stop or start the configuration recorder:

   • If you want to stop recording, under Recording is on, choose Turn off. When prompted, choose Continue.

   • If you want to start recording, under Recording is off, choose Turn on. When prompted, choose Continue.

Managing the Configuration Recorder (Amazon CLI)

You can use the Amazon CLI to stop or start the configuration recorder. You can also rename or delete the configuration recorder using the Amazon CLI, the Amazon Config API, or one of the Amazon SDKs. The following steps help you use the Amazon CLI.

To stop the configuration recorder

• Use the stop-configuration-recorder command:

  $ aws configservice stop-configuration-recorder --configuration-recorder-name configRecorderName

To start the configuration recorder

• Use the start-configuration-recorder command:

  $ aws configservice start-configuration-recorder --configuration-recorder-name configRecorderName

To rename the configuration recorder

To change the configuration recorder name, you must delete it and create a new configuration recorder with the desired name.

1. Use the describe-configuration-recorders command to look up the name of your current configuration recorder:

   $ aws configservice describe-configuration-recorders
   {
       "ConfigurationRecorders": [
           {
               "roleARN": "arn:aws:iam::012345678912:role/myConfigRole",
               "name": "default"
           }
       ]
   }

2. Use the delete-configuration-recorder command to delete your current configuration recorder:

   $ aws configservice delete-configuration-recorder --configuration-recorder-name default

3. Use the put-configuration-recorder command to create a configuration recorder with the desired name:

   $ aws configservice put-configuration-recorder --configuration-recorder name=configRecorderName,roleARN=arn:aws:iam::012345678912:role/myConfigRole

4. Use the start-configuration-recorder command to resume recording:

   $ aws configservice start-configuration-recorder --configuration-recorder-name configRecorderName

To delete the configuration recorder

• Use the delete-configuration-recorder command:

  $ aws configservice delete-configuration-recorder --configuration-recorder-name default

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . configservice ]

Description¶

Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.

You must have created at least one delivery channel to successfully start the configuration recorder.

See also: AWS API Documentation

Synopsis¶

  start-configuration-recorder
--configuration-recorder-name 
[--cli-input-json ]
[--generate-cli-skeleton ]
[--debug]
[--endpoint-url ]
[--no-verify-ssl]
[--no-paginate]
[--output ]
[--query ]
[--profile ]
[--region ]
[--version ]
[--color ]
[--no-sign-request]
[--ca-bundle ]
[--cli-read-timeout ]
[--cli-connect-timeout ]

Options¶

--configuration-recorder-name (string)

The name of the recorder object that records each configuration change made to the resources.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To start the configuration recorder

The following command starts the default configuration recorder:

aws configservice start-configuration-recorder --configuration-recorder-name default

If the command succeeds, AWS Config returns no output. To verify that AWS Config is recording your resources, run the get-status command.

What are AWS config snapshots?

What is AWS configuration management?

What is AWS config docs?

How does AWS configuration work?