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 identity account.

You need to have set up AWS SSO in root account and delegated to the identity account as your SSO administrator.


You should be able to deploy the aws-ssosync component to the [core-]gbl-identity stack with atmos terraform deploy aws-ssosync -s gbl-identity.

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:


role_arn: null
workspace_enabled: false
enabled: true
name: aws-ssosync
google_admin_email: an-actual-[email protected]
ssosync_url_prefix: ""
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.


Overview of steps:

  1. Deploy the aws-sso component
  2. Configure GSuite
  3. Deploy the aws-ssosync component to the gbl-identity stack

Deploy the aws-sso component

Follow the aws-sso component documentation to deploy the aws-sso component. Once this is done, you'll want to grab a few pieces of information.

Go to the AWS Single Sign-On console in the region you have set up AWS SSO and select Settings. Click Enable automatic provisioning.

A pop up will appear with URL and the Access Token. The Access Token will only appear at this stage. You want to copy both of these as a parameter to the ssosync command.

To pass parameters to the ssosync command, you'll need to decide on a path in SSM Parameter Store, google_credentials_ssm_path.

In SSM Parameter Store on your identity account, create a parameter with the name <google_credentials_ssm_path>/scim_endpoint_url and the value of the URL from the previous step. Also create a parameter with the name <google_credentials_ssm_path>/scim_endpoint_access_token and the value of the Access Token from the previous step.

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. Back in the identity account, create a parameter with the name <google_credentials_ssm_path>/identity_store_id.

Lastly, go ahead and delegate administration from the root account to the identity account

Configure GSuite

steps taken directly from ssosync

First, you have to setup your API. In the project you want to use go to the Console and select API & Service > Enable APIs and Services. Search for Admin SDK and Enable the API.

You have to perform this tutorial to create a service account that you use to sync your users. Save the JSON file you create during the process and rename it to google_credentials.json.

Head back in to your identity account in AWS and create a parameter in SSM Parameter Store with the name <google_credentials_ssm_path>/google_credentials and give it the contents of the google_credentials.json file.

In the domain-wide delegation for the Admin API, you have to specify the following scopes for the user.

Back in the Console go to the Dashboard for the API & Services and select Enable API and Services. In the Search box type Admin and select the Admin SDK option. Click the Enable button.

Deploy the aws-ssosync component

Make sure that all four of the following SSM parameters exist in the identity account:

  • <google_credentials_ssm_path>/scim_endpoint_url
  • <google_credentials_ssm_path>/scim_endpoint_access_token
  • <google_credentials_ssm_path>/identity_store_id
  • <google_credentials_ssm_path>/google_credentials


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


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




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


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.
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.
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.
"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": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
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).
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:""no
google_user_matchGoogle Workspace user filter query parameter, example: 'name:John email:admin', see:""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.
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.
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.
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.
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.
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.
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.
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.
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""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.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno


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)