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
+9
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,8 @@ SSO Sync will run on any platform that Go can build for. It is available in the
18
18
* if deploying the lambda from the [AWS Serverless Application Repository](https://console.aws.amazon.com/lambda/home#/create/app?applicationId=arn:aws:serverlessrepo:us-east-2:004480582608:applications/SSOSync) then it needs to be deployed into the [IAM Identity Center delegated administration](https://docs.aws.amazon.com/singlesignon/latest/userguide/delegated-admin.html) account. Technically you could deploy in the management account but we would recommend against this.
19
19
* if you are running the project as a cli tool, then the environment will need to be using credentials of a user in the [IAM Identity Center delegated administration](https://docs.aws.amazon.com/singlesignon/latest/userguide/delegated-admin.html) account, with appropriate permissions.
20
20
21
+
> :warning:`>= 2.1.0` make use of named IAM resources, so if deploying via CICD or IaC template will require **CAPABILITY_NAMED_IAM** to be specified.
22
+
21
23
## Why?
22
24
23
25
As per the [AWS SSO](https://aws.amazon.com/single-sign-on/) Homepage:
@@ -178,6 +180,13 @@ AWS SSO. To sync regularly, you can run ssosync via AWS Lambda.
178
180
179
181
:warning: You find it in the [AWS Serverless Application Repository](https://eu-west-1.console.aws.amazon.com/lambda/home#/create/app?applicationId=arn:aws:serverlessrepo:us-east-2:004480582608:applications/SSOSync).
180
182
183
+
:warning: v2.1 onwards now supports multiple deployment patterns, defaults are consistent with previous versions.
184
+
**App + secrets** This is the default mode and fully backwards compatible with previous versions
185
+
**App only** This mode does not create the secrets but expects you to deployed a separate stack using the **Secrets only** mode within the same account
186
+
**App for cross-account** This mode is used where you have deployed the secrets in a separate account, the arns of the KMS key and secrets need to be passed into the CrossStackConfig field, It is easiest to have created the secrets in the other account using the ** Secrest for cross-account** mode, as the output can simply copied and pasted into the above field.
187
+
**Secrets only** This mode creates a set of secrets but does not deploy the app itself, it requires the app is deployed in that same account using the **App only** mode. This allows for decoupling of the secrets and the app.
188
+
**Secrets for cross-account** This mode creates a set of secrets and KMS key but does not deploy the app itself, this is for use with an app stack, deployed using the **App for cross-account** mode. This allows for a single set of secrets to be shared with multipl app instance for testing, and improve secrets security.
189
+
181
190
## SAM
182
191
183
192
You can use the AWS Serverless Application Model (SAM) to deploy this to your account.
0 commit comments