Skip to content

Commit ab4efa9

Browse files
committed
revamp config docs
1 parent 3ade9ca commit ab4efa9

File tree

1 file changed

+18
-19
lines changed

1 file changed

+18
-19
lines changed

src/content/docs/aws/services/config.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: "Config"
3-
linkTitle: "Config"
43
description: Get started with Config on LocalStack
54
persistence: supported
65
tags: ["Free"]
@@ -13,7 +12,7 @@ Config provides a comprehensive view of the resource configuration across your A
1312
Config continuously records configuration changes and allows you to retain a historical record of these changes.
1413

1514
LocalStack allows you to use the Config APIs in your local environment to assesses resource configurations and notifies you of any non-compliant items to mitigate potential security risks.
16-
The supported APIs are available on our [API coverage page]({{< ref "coverage_config" >}}), which provides information on the extent of Config's integration with LocalStack.
15+
The supported APIs are available on our [API coverage page](), which provides information on the extent of Config's integration with LocalStack.
1716

1817
## Getting started
1918

@@ -28,20 +27,20 @@ The S3 bucket will be used to receive a configuration snapshot on request and co
2827
The SNS topic will be used to notify you when a configuration snapshot is available.
2928
You can create a new S3 bucket and SNS topic using the AWS CLI:
3029

31-
{{< command >}}
32-
$ awslocal s3 mb s3://config-test
33-
$ awslocal sns create-topic --name config-test-topic
34-
{{< /command >}}
30+
```bash
31+
awslocal s3 mb s3://config-test
32+
awslocal sns create-topic --name config-test-topic
33+
```
3534

3635
### Create a new configuration recorder
3736

3837
You can now create a new configuration recorder to record configuration changes for specified resource types, using the [`PutConfigurationRecorder`](https://docs.aws.amazon.com/config/latest/APIReference/API_PutConfigurationRecorder.html) API.
3938
Run the following command to create a new configuration recorder:
4039

41-
{{< command >}}
42-
$ awslocal configservice put-configuration-recorder \
40+
```bash
41+
awslocal configservice put-configuration-recorder \
4342
--configuration-recorder name=default,roleARN=arn:aws:iam::000000000000:role/config-role
44-
{{< /command >}}
43+
```
4544

4645
We have specified the `roleARN` parameter to grant the configuration recorder the needful permissions to access the S3 bucket and SNS topic.
4746
In LocalStack, IAM roles are not enforced, so you can specify any role ARN you like.
@@ -68,8 +67,8 @@ You can inline the JSON into the `awslocal` command.
6867

6968
Run the following command to create the delivery channel:
7069

71-
{{< command >}}
72-
$ awslocal configservice put-delivery-channel \
70+
```bash
71+
awslocal configservice put-delivery-channel \
7372
--delivery-channel '{
7473
"name": "default",
7574
"s3BucketName": "config-test",
@@ -78,25 +77,25 @@ $ awslocal configservice put-delivery-channel \
7877
"deliveryFrequency": "Twelve_Hours"
7978
}
8079
}'
81-
{{< /command >}}
80+
```
8281

8382
### Start the configuration recorder
8483

8584
You can now start recording configurations of the local AWS resources you have selected to record in your running LocalStack container.
8685
You can use the [`StartConfigurationRecorder`](https://docs.aws.amazon.com/config/latest/APIReference/API_StartConfigurationRecorder.html) API to start the configuration recorder.
8786
Run the following command to start the configuration recorder:
8887

89-
{{< command >}}
90-
$ awslocal configservice start-configuration-recorder \
88+
```bash
89+
awslocal configservice start-configuration-recorder \
9190
--configuration-recorder-name default
92-
{{< /command >}}
91+
```
9392

9493
You can list the delivery channels and configuration recorders using the [`DescribeDeliveryChannels`](https://docs.aws.amazon.com/config/latest/APIReference/API_DescribeDeliveryChannels.html) and [`DescribeConfigurationRecorderStatus`](https://docs.aws.amazon.com/config/latest/APIReference/API_DescribeConfigurationRecorderStatus.html) APIs respectively.
9594

96-
{{< command >}}
97-
$ awslocal configservice describe-delivery-channels
98-
$ awslocal configservice describe-configuration-recorder-status
99-
{{< /command >}}
95+
```bash
96+
awslocal configservice describe-delivery-channels
97+
awslocal configservice describe-configuration-recorder-status
98+
```
10099

101100
## Current Limitations
102101

0 commit comments

Comments
 (0)