@aws-mdaa/roles
v1.4.0
Published
MDAA roles module
Readme
IAM Roles and Policies
The Roles CDK application is used to deploy IAM roles which can be used within a broader data environment.
Deployed Resources and Compliance Details

IAM Managed Policies -
An IAM 'Customer' Managed Policy will be created for each policy specified in the config.
Policies which violate CDK Nag rule sets will require explicit suppressions
MDAA Managed Policies will be created, which can be attached to the IAM Roles specified in the config.
IAM Roles - An IAM role will be created for each role specified in the config.
- Roles can have one or more assume role trust policy statements
- Roles can specify usage persona ( data-admin, data-engineer, data-scientist, data-steward ) to attach relevant policies
IAM Identity (Federation) Providers - IAM identity providers which can be used to establish SAML federation (via assume role trust) into generated roles
- New federation providers can be created by providing the SAML metadata XML document
Configuration
MDAA Config
Add the following snippet to your mdaa.yaml under the modules: section of a domain/env in order to use this module:
roles: # Module Name can be customized
module_path: "@aws-caef/roles" # Must match module NPM package name
module_configs:
- ./roles.yaml # Filename/path can be customizedModule Config (./roles.yaml)
# Optional - If true (default), a set of MDAA managed policies will be created for use in predefined personas.
createPersonaManagedPolicies: true
# Used to configure SAML federations
federations:
existing-federation: # Should be descriptive and unique
# This is the arn of an existing IAM Identity Provider
providerArn: arn:{{partition}}:iam::{{account}}:saml-provider/ExampleIdentityProvider
new-federation: # Should be descriptive and unique
# Path to a Saml Metadata Doc, which will be used to create
# a SAML Identity Provider in IAM. Relative paths should be prefixed with a "./"
samlDoc: ./path/to/samlMetaDoc.xml
# Generate Managed Policies. These Managed Policies can be
generatePolicies:
TestPolicy:
policyDocument:
Statement:
- SID: testing
Effect: Allow
Resource:
- "arn:{{partition}}:s3:::*"
Action:
- s3:List*
- s3:GetBucket*
suppressions:
- id: "AwsSolutions-IAM5"
reason: "Wildcard testing ok!"
VerbatimPolicy:
# If specified, the policy name will be created verbatim (Ie "VerbatimPolicy" )
# Otherwise the policy name will be generated using the naming module and above policy object name ("VerbatimPolicy")
verbatimPolicyName: true
policyDocument:
Statement:
- SID: testing
Effect: Allow
Resource:
- "arn:{{partition}}:s3:::*"
Action:
- s3:List*
- s3:GetBucket*
suppressions:
- id: "AwsSolutions-IAM5"
reason: "Wildcard testing ok!"
# The list of roles which will be generated
generateRoles:
my-data-admin:
trustedPrincipal: this_account
# basePersona(optional) - Specify a persona which can be applied to the role.
# Allowed values: "data-admin"| "data-engineer" | "data-scientist"
basePersona: data-admin
generatedPolicies:
- TestPolicy
test-role:
# By trusting 'this_account', AssumeRoleTrust will be established with IAM root of this account
trustedPrincipal: this_account
# List of AWS managed policies (by policy name)
awsManagedPolicies:
- service-role/AWSLambdaBasicExecutionRole
# List of existing customer managed policies (by policy name)
customerManagedPolicies:
- SomeExistingPolicyName
# List of policies generated in the generatePolicies section of the config (by config name)
generatedPolicies:
- TestPolicy
suppressions:
- id: "AwsSolutions-IAM4"
reason: "AWSLambdaBasicExecutionRole approved for use"
glue-role:
trustedPrincipal: service:glue.amazonaws.com
awsManagedPolicies:
- service-role/AWSGlueServiceRole
suppressions:
- id: "AwsSolutions-IAM4"
reason: "AWSGlueServiceRole approved for use"
# An example role which uses SAML federation
data-scientist:
trustedPrincipal: federation:example-federation
generatedPolicies:
- TestPolicy
# An example role which will be assumable by another role, such as
# the role being used by an application.
application_data_role1:
trustedPrincipal: arn:{{partition}}:iam::{{account}}:role/test-application-role
generatedPolicies:
- TestPolicy
# An example role which will be assumable by another role, such as
# the role being used by an application.
application_data_role2:
trustedPrincipal: this_account
assumeRoleTrustConditions:
StringEquals:
aws:PrincipalArn: arn:{{partition}}:iam::{{account}}:role/test-application-role
generatedPolicies:
- TestPolicy
# An example role which will be assumable by multple services
multiple_service_role:
trustedPrincipal: service:sagemaker.amazonaws.com
additionalTrustedPrincipals:
- trustedPrincipal: service:sagemaker.amazonaws.com
additionalTrustedActions: ["sts:SetSourceIdentity"]
- trustedPrincipal: service:elasticmapreduce.amazonaws.com
additionalTrustedActions: ["sts:SetSourceIdentity"]
generatedPolicies:
- TestPolicy