You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+34-8
Original file line number
Diff line number
Diff line change
@@ -7,8 +7,10 @@ Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-
7
7
## Table of Contents<!-- omit in toc -->
8
8
9
9
-[Introduction](#introduction)
10
-
-[Getting Started with the SRA Code Examples](#getting-started-with-the-sra-code-examples)
11
-
-[Quick Setup](#quick-setup)
10
+
-[Getting Started Using the AWS SRA Easy Setup (Recommended)](#getting-started-using-the-aws-sra-easy-setup-recommended)
11
+
-[AWS SRA Easy Setup](#aws-sra-easy-setup)
12
+
-[Manual Install Method For the AWS SRA](#manual-install-method-for-the-aws-sra)
13
+
-[AWS SRA Quick Setup](#aws-sra-quick-setup)
12
14
-[Example Solutions](#example-solutions)
13
15
-[Utils](#utils)
14
16
-[Environment Setup](#environment-setup)
@@ -28,24 +30,48 @@ to modify and tailor these solutions to suit your environment and security needs
28
30
29
31
The examples within this repository have been deployed and tested within an `AWS Control Tower` environment using `AWS CloudFormation` as well as the `Customizations for AWS Control Tower (CFCT)` solution.
30
32
31
-
## Getting Started with the SRA Code Examples
33
+
## Getting Started Using the AWS SRA Easy Setup (Recommended)
32
34
33
-

35
+

36
+
37
+
1. Setup the environment to configure [AWS Control Tower](https://docs.aws.amazon.com/controltower/latest/userguide/getting-started-with-control-tower.html) within a new or existing AWS account. Existing AWS Control Tower environments can also be used but may require existing service configurations to be removed.
- See [AWS CloudFormation Documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html) for more information.
41
+
- Customizations for AWS Control Tower (CfCT) - [CfCT AWS SRA Easy Setup Implementation Details](./aws_sra_examples/easy_setup#customizations-for-control-tower-implementation-instructions)
42
+
- See [CfCT Documentation](https://aws.amazon.com/solutions/implementations/customizations-for-aws-control-tower/) for more information.
43
+
3. If using CfCT, deploy the AWSControlTowerExecution role into the management account.
44
+
4. Using parameters within the easy setup template file, choose which AWS SRA Solutions to deploy. This can be done during initial setup or as an update later.
45
+
46
+
For more information view the [AWS SRA Easy Setup](./aws_sra_examples/easy_setup) solution page.
47
+
48
+
### AWS SRA Easy Setup
49
+
50
+
Using the AWS SRA Easy Setup, the common prerequisites and all AWS SRA solutions are automatically packaged, staged, and deployed into your AWS environment with minimal effort. This is the recommended method to install the AWS SRA code library because it reduces the likelihood of missing a step in the Manual install method. If using this method to install the AWS SRA code library, there is no other process you need to follow.
51
+
52
+
Follow the instructions in the [AWS SRA Easy Setup](./aws_sra_examples/easy_setup) solution page to install everything you need to get the AWS SRA code library and it's solutions deployed.
53
+
54
+
## Manual Install Method For the AWS SRA
55
+
56
+

34
57
35
58
1. Setup the environment to configure [AWS Control Tower](https://docs.aws.amazon.com/controltower/latest/userguide/getting-started-with-control-tower.html) within a new or existing AWS account. Existing AWS Control Tower environments can also be used but may require existing service configurations to be removed.
36
59
2. Deploy the [Common Prerequisites](aws_sra_examples/solutions/common/common_prerequisites) solution. **Note:** This only needs to be done once for all the solutions.
- Customizations for AWS Control Tower (CFCT) - [Solution Documentation](https://aws.amazon.com/solutions/implementations/customizations-for-aws-control-tower/)
62
+
- Customizations for AWS Control Tower (CfCT) - [Solution Documentation](https://aws.amazon.com/solutions/implementations/customizations-for-aws-control-tower/)
40
63
4. (Optional) - Deploy the [Customizations for AWS Control Tower (CFCT) Setup](aws_sra_examples/solutions/common/common_cfct_setup) solution. **Note** Only implement if the CFCT deployment method was selected.
41
-
5. Per your requirements select one or all of the below [Example Solutions](#example-solutions) to implement via the selected deployment method.
64
+
5. Per your requirements select one or all of the below [AWS SRA Solutions](#example-solutions) to implement via the selected deployment method.
65
+
- You may use the `Quick Setup` to deploy the AWS SRA Solutions at this step.
42
66
43
-
## Quick Setup
67
+
### AWS SRA Quick Setup
44
68
45
-
With the `Quick Setup` you can now deploy all the [Example Solutions](#example-solutions) listed in the below table via a single centralized CloudFormation template either directly within the CloudFormation console or via the Customizations for AWS Control Tower (CFCT) solution. Our testing within an environment that has the default AWS Control Tower setup (3 accounts and 1 region) resulted in deploying all the solutions within the `Quick Setup` in under 20 minutes.
69
+
The `Quick Setup`can be used along with the manual install of the AWS SRA. Once you have manually installed the common prerequisites, instead of installing each solution individually, you can deploy all the [Example Solutions](#example-solutions) listed in the below table via a single centralized CloudFormation template either directly within the CloudFormation console or via the Customizations for AWS Control Tower (CFCT) solution. Our testing within an environment that has the default AWS Control Tower setup (3 accounts and 1 region) resulted in deploying all the solutions within the `Quick Setup` in under 20 minutes.
46
70
47
71
Follow the instructions within the [Quick Setup](aws_sra_examples/quick_setup) to deploy all or a subset of the solutions based on your environment requirements.
48
72
73
+
*Note: The `Quick Setup` is not designed to be used with the `Easy Setup` procedure. Using them together may produce mixed results as we have not tested this. It is recommended to use the `Easy Setup` process*
74
+
49
75
## Example Solutions
50
76
51
77
-**Note:** All solutions below depend on the [Common Prerequisites](aws_sra_examples/solutions/common/common_prerequisites) solution in addition to the specified solutions within the `Depends On` column.
0 commit comments