Skip to main content

Component: aws-ssosync

Deploys AWS ssosync to sync Google Groups with AWS SSO.

AWS ssosync is a Lambda application that regularly manages Identity Store users.

This component requires manual deployment by a privileged user because it deploys a role in the root or identity management account.

Usage

You should be able to deploy the aws-ssosync component to the same account as aws-sso. Typically that is the core-gbl-root or gbl-root stack.

Stack Level: Global Deployment: Must be deployed by managers or SuperAdmin using atmos CLI

The following is an example snippet for how to use this component:

(stacks/catalog/aws-ssosync.yaml)

components:
terraform:
aws-ssosync:
vars:
enabled: true
name: aws-ssosync
google_admin_email: an-actual-[email protected]
ssosync_url_prefix: "https://github.com/Benbentwo/ssosync/releases/download"
ssosync_version: "2.0.2"
google_credentials_ssm_path: "/ssosync"
log_format: text
log_level: debug
schedule_expression: "rate(15 minutes)"

We recommend following a similar process to what the AWS ssosync documentation recommends.

Deployment

Overview of steps:

  1. Configure AWS IAM Identity Center
  2. Configure Google Cloud console
  3. Configure Google Admin console
  4. Deploy the aws-ssosync component
  5. Deploy the aws-sso component

1. Configure AWS IAM Identity Center (AWS SSO)

Follow AWS documentation to configure SAML and SCIM with Google Workspace and IAM Identity Center.

As part of this process, save the SCIM endpoint token and URL. Then in AWS SSM Parameter Store, create two SecureString parameters in the same account used for AWS SSO. This is usually the root account in the primary region.

/ssosync/scim_endpoint_access_token
/ssosync/scim_endpoint_url

One more parameter you'll need is your Identity Store ID. To obtain your Identity Store ID, go to the AWS Identity Center console and select Settings. Under the Identity Source section, copy the Identity Store ID. In the same account used for AWS SSO, create the following parameter:

/ssosync/identity_store_id

2. Configure Google Cloud console

Within the Google Cloud console, we need to create a new Google Project and Service Account and enable the Admin SDK API. Follow these steps:

  1. Open the Google Cloud console: https://console.cloud.google.com
  2. Create a new project. Give the project a descriptive name such as AWS SSO Sync
  3. Enable Admin SDK in APIs: APIs & Services > Enabled APIs & Services > + ENABLE APIS AND SERVICES

Enable Admin SDK # use raw URL so that this works in both GitHub and docusaurus

  1. Create Service Account: IAM & Admin > Service Accounts > Create Service Account (ref).

Create Service Account # use raw URL so that this works in both GitHub and docusaurus

  1. Download credentials for the new Service Account: IAM & Admin > Service Accounts > select Service Account > Keys > ADD KEY > Create new key > JSON

Download Credentials # use raw URL so that this works in both GitHub and docusaurus

  1. Save the JSON credentials as a new SecureString AWS SSM parameter in the same account used for AWS SSO. Use the full JSON string as the value for the parameter.
/ssosync/google_credentials

3. Configure Google Admin console

  • Open the Google Admin console
  • From your domain’s Admin console, go to Main menu menu > Security > Access and data control > API controls (ref)
  • In the Domain wide delegation pane, select Manage Domain Wide Delegation.
  • Click Add new.
  • In the Client ID field, enter the client ID obtained from the service account creation steps above.
  • In the OAuth Scopes field, enter a comma-delimited list of the scopes required for your application. Use the scope https://www.googleapis.com/auth/cloud_search.query for search applications using the Query API.
  • Add the following permission: (ref)
https://www.googleapis.com/auth/admin.directory.group.readonly
https://www.googleapis.com/auth/admin.directory.group.member.readonly
https://www.googleapis.com/auth/admin.directory.user.readonly

4. Deploy the aws-ssosync component

Make sure that all four of the following SSM parameters exist in the target account and region:

  • /ssosync/scim_endpoint_url
  • /ssosync/scim_endpoint_access_token
  • /ssosync/identity_store_id
  • /ssosync/google_credentials

If deployed successfully, Groups and Users should be programmatically copied from the Google Workspace into AWS IAM Identity Center on the given schedule.

If these Groups are not showing up, check the CloudWatch logs for the new Lambda function and refer the FAQs included below.

5. Deploy the aws-sso component

Use the names of the Groups now provisioned programmatically in the aws-sso component catalog. Follow the aws-sso component documentation to deploy the aws-sso component.

FAQ

Why is the tool forked by Benbentwo?

The awslabs tool requires AWS Secrets Managers for the Google Credentials. However, we would prefer to use AWS SSM to store all credentials consistency and not require AWS Secrets Manager. Therefore we've created a Pull Request and will point to a fork until the PR is merged.

Ref:

What should I use for the Google Admin Email Address?

The Service Account created will assume the User given by --google-admin / SSOSYNC_GOOGLE_ADMIN / var.google_admin_email. Therefore, this user email must be a valid Google admin user in your organization.

This is not the same email as the Service Account.

If Google fails to query Groups, you may see the following error:

Notifying Lambda and mark this execution as Failure: googleapi: Error 404: Domain not found., notFound

Common Group Name Query Error

If filtering group names using query strings, make sure the provided string is valid. For example, google_group_match: "name:aws*" is incorrect. Instead use google_group_match: "Name:aws*"

If not, you may again see the same error message:

Notifying Lambda and mark this execution as Failure: googleapi: Error 404: Domain not found., notFound

Ref:

The specific error you are seeing is because the google api doesn't like the query string you provided for the -g parameter. try -g "Name:Fuel*"

https://github.com/awslabs/ssosync/issues/91

Requirements

NameVersion
terraform>= 1.0.0
archive>= 2.3.0
aws>= 4.0
null>= 3.0

Providers

NameVersion
archive>= 2.3.0
aws>= 4.0
null>= 3.0

Modules

NameSourceVersion
ssosync_artifactcloudposse/module-artifact/external0.8.0
thiscloudposse/label/null0.25.0

Resources

NameType
aws_cloudwatch_event_rule.ssosyncresource
aws_cloudwatch_event_target.ssosyncresource
aws_iam_role.defaultresource
aws_lambda_function.ssosyncresource
aws_lambda_permission.allow_cloudwatch_executionresource
null_resource.extract_my_tgzresource
archive_file.lambdadata source
aws_iam_policy_document.ssosync_lambda_assume_roledata source
aws_iam_policy_document.ssosync_lambda_identity_centerdata source
aws_ssm_parameter.google_credentialsdata source
aws_ssm_parameter.identity_store_iddata source
aws_ssm_parameter.scim_endpoint_access_tokendata source
aws_ssm_parameter.scim_endpoint_urldata source

Inputs

NameDescriptionTypeDefaultRequired
additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
map(string){}no
architectureArchitecture of the Lambda functionstring"x86_64"no
attributesID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.
list(string)[]no
contextSingle object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
any
{
"additional_tag_map": {},
"attributes": [],
"delimiter": null,
"descriptor_formats": {},
"enabled": true,
"environment": null,
"id_length_limit": null,
"label_key_case": null,
"label_order": [],
"label_value_case": null,
"labels_as_tags": [
"unset"
],
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
}
no
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
stringnullno
descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br/> format = string<br/> labels = list(string)<br/>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
any{}no
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
google_admin_emailGoogle Admin emailstringn/ayes
google_credentials_ssm_pathSSM Path for ssosync secretsstring"/ssosync"no
google_group_matchGoogle Workspace group filter query parameter, example: 'name:Admin email:aws-', see: https://developers.google.com/admin-sdk/directory/v1/guides/search-groupsstring""no
google_user_matchGoogle Workspace user filter query parameter, example: 'name:John email:admin', see: https://developers.google.com/admin-sdk/directory/v1/guides/search-usersstring""no
id_length_limitLimit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.
numbernullno
ignore_groupsIgnore these Google Workspace groupsstring""no
ignore_usersIgnore these Google Workspace usersstring""no
include_groupsInclude only these Google Workspace groups. (Only applicable for sync_method user_groups)string""no
label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.
stringnullno
label_orderThe order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
list(string)nullno
label_value_caseControls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.
stringnullno
labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
set(string)
[
"default"
]
no
log_formatLog format for Lambda function loggingstring"json"no
log_levelLog level for Lambda function loggingstring"warn"no
nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.
stringnullno
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
regex_replace_charsTerraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.
stringnullno
regionAWS Region where AWS SSO is enabledstringn/ayes
schedule_expressionSchedule for trigger the execution of ssosync (see CloudWatch schedule expressions)string"rate(15 minutes)"no
ssosync_url_prefixURL prefix for ssosync binarystring"https://github.com/Benbentwo/ssosync/releases/download"no
ssosync_versionVersion of ssosync to usestring"v2.0.2"no
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
sync_methodSync method to usestring"groups"no
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
map(string){}no
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno

Outputs

NameDescription
arnARN of the lambda function
invoke_arnInvoke ARN of the lambda function
qualified_arnARN identifying your Lambda Function Version (if versioning is enabled via publish = true)

References