Policy types for @turbot/aws-secretsmanager
- AWS > Secrets Manager > API Enabled
- AWS > Secrets Manager > Approved Regions [Default]
- AWS > Secrets Manager > Enabled
- AWS > Secrets Manager > Permissions
- AWS > Secrets Manager > Permissions > Levels
- AWS > Secrets Manager > Permissions > Levels > Modifiers
- AWS > Secrets Manager > Permissions > Lockdown
- AWS > Secrets Manager > Permissions > Lockdown > API Boundary
- AWS > Secrets Manager > Regions
- AWS > Secrets Manager > Secret > Active
- AWS > Secrets Manager > Secret > Active > Age
- AWS > Secrets Manager > Secret > Active > Budget
- AWS > Secrets Manager > Secret > Active > Last Modified
- AWS > Secrets Manager > Secret > Approved
- AWS > Secrets Manager > Secret > Approved > Budget
- AWS > Secrets Manager > Secret > Approved > Regions
- AWS > Secrets Manager > Secret > Approved > Usage
- AWS > Secrets Manager > Secret > CMDB
- AWS > Secrets Manager > Secret > Encryption at Rest
- AWS > Secrets Manager > Secret > Encryption at Rest > Customer Managed Key
- AWS > Secrets Manager > Secret > Policy
- AWS > Secrets Manager > Secret > Policy > Trusted Access
- AWS > Secrets Manager > Secret > Policy > Trusted Access > Accounts
- AWS > Secrets Manager > Secret > Policy > Trusted Access > Identity Providers
- AWS > Secrets Manager > Secret > Policy > Trusted Access > Organization Restrictions
- AWS > Secrets Manager > Secret > Policy > Trusted Access > Services
- AWS > Secrets Manager > Secret > Regions
- AWS > Secrets Manager > Secret > Tags
- AWS > Secrets Manager > Secret > Tags > Template
- AWS > Secrets Manager > Secret > Usage
- AWS > Secrets Manager > Secret > Usage > Limit
- AWS > Secrets Manager > Tags Template [Default]
- AWS > Secrets Manager > Trusted Accounts [Default]
- AWS > Secrets Manager > Trusted Identity Providers [Default]
- AWS > Secrets Manager > Trusted Organizations [Default]
- AWS > Secrets Manager > Trusted Services [Default]
- AWS > Turbot > Event Handlers > Events > Rules > Event Sources > @turbot/aws-secretsmanager
- AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-secretsmanager
- AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-secretsmanager
- AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-secretsmanager
AWS > Secrets Manager > API Enabled
Configure whether the AWS Secrets Manager API is enabled.
Note: Disabling the service disables the API for ALL users and roles, and Turbot will have no access to the API.
[ "Enabled", "Disabled", "Enabled if AWS > Secrets Manager > Enabled"]
{ "type": "string", "enum": [ "Enabled", "Disabled", "Enabled if AWS > Secrets Manager > Enabled" ], "default": "Enabled"}
AWS > Secrets Manager > Approved Regions [Default]
A list of AWS regions in which AWS Secrets Manager resources are approved for use.
The expected format is an array of regions names. You may use the '*' and '?' wildcard characters.
This policy is the default value for all AWS Secrets Manager resources' Approved > Regions policies.
"{\n regions: policyValue(uri:\"tmod:@turbot/aws#/policy/types/approvedRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
AWS > Secrets Manager > Enabled
Configure whether the AWS Secrets Manager service is enabled. This will only affect Turbot managed User Roles and will allow the Turbot managed user to access AWS Secrets Manager service.
Enabled
policy allows Turbot managed users to perform all the actions for the serviceEnabled: Metadata Only
policy allows Turbot managed users to perform only the metadata level actions for the service (likedescribe*
,list*
)
Note:
Disabled
policy disables the service but does NOT disable the API for Turbot or SuperUsers- All the resource data stored in the Turbot CMDB is considered to be metadata
- For more information related to permissions and grant levels, please check the documentation
[ "Enabled", "Enabled: Metadata Only", "Disabled"]
{ "type": "string", "enum": [ "Enabled", "Enabled: Metadata Only", "Disabled" ], "example": [ "Enabled" ], "default": "Disabled"}
AWS > Secrets Manager > Permissions
Configure whether permissions policies are in effect for AWS Secrets Manager.
This setting does not affect account level permissions (AWS/Admin, AWS/Owner, etc)
Note: The behavior of this policy depends on the value of AWS > Permissions.
[ "Enabled", "Disabled", "Enabled if AWS > Secrets Manager > Enabled & AWS > Secrets Manager > API Enabled"]
{ "type": "string", "enum": [ "Enabled", "Disabled", "Enabled if AWS > Secrets Manager > Enabled & AWS > Secrets Manager > API Enabled" ], "example": [ "Enabled" ], "default": "Enabled if AWS > Secrets Manager > Enabled & AWS > Secrets Manager > API Enabled"}
AWS > Secrets Manager > Permissions > Levels
Define the permissions levels that can be used to grant access to an AWS account. Permissions levels defined will appear in the UI to assign access to Turbot users. This policy provides a default for Permissions > Levels in each service, however you can explicitly override the setting for each service if desired
[ "{\n item: account {\n turbot{\n id\n }\n }\n}\n", "{\n availableLevels: policyValues(filter:\"policyTypeLevel:self resourceId:{{ $.item.turbot.id }} policyType:'tmod:@turbot/aws-iam#/policy/types/permissionsLevelsDefault'\") {\n items {\n value\n }\n }\n}\n"]
"{% if $.availableLevels.items[0].value | length == 0 %} [] {% endif %}{% for item in $.availableLevels.items[0].value %}- {{ item }}\n{% endfor %}"
{ "type": "array", "items": { "type": "string", "enum": [ "Metadata", "ReadOnly", "Operator", "Admin", "Owner" ] }}
AWS > Secrets Manager > Permissions > Levels > Modifiers
A map of AWS API to Turbot Permission Level used to customize Turbot's standard permissions. You can add, remove or redefine the mapping of AWS API operations to Turbot permissions levels here.
Note: Modifiers are cumulative - if you add a permission to the Metadata level, it is also added to ReadOnly, Operator and Admin. Modifier policies set here apply ONLY to the AWS level
example: - "glacier:createvault": admin - "glacier:ListVaults": metadata - "s3:DeleteBucket": none
AWS > Secrets Manager > Permissions > Lockdown
AWS > Secrets Manager > Permissions > Lockdown > API Boundary
Configure whether the AWS secretsManager API is enabled for all users and roles in turbot-managed boundary policies.
Note: Disabling the service disables the API for ALL users and roles, and Turbot will have no access to the API.
[ "Enabled if AWS > Secrets Manager > API Enabled"]
{ "type": "string", "enum": [ "Enabled if AWS > Secrets Manager > API Enabled" ], "example": [ "Enabled if AWS > Secrets Manager > API Enabled" ], "default": "Enabled if AWS > Secrets Manager > API Enabled"}
AWS > Secrets Manager > Regions
A list of AWS regions in which AWS Secrets Manager resources are supported for use.
The expected format is an array of regions names. You may use the '*' and '?' wildcard characters.
This policy is the default value for all AWS Secrets Manager resources' Regions policies.
{ "allOf": [ { "$ref": "aws#/definitions/regionNameMatcherList" }, { "default": [ "af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "cn-north-1", "cn-northwest-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2" ] } ]}
AWS > Secrets Manager > Secret > Active
Determine the action to take when an AWS Secrets Manager secret, based on the AWS > Secrets Manager > Secret > Active > *
policies.
The control determines whether the resource is in active use, and if not, has the ability to delete / cleanup the resource. When running an automated compliance environment, it's common to end up with a wide range of alarms that are difficult and time consuming to clear. The Active control brings automated, well-defined control to this process.
The Active control checks the status of all defined Active policies for the
resource (AWS > Secrets Manager > Secret > Active > *
), raises an alarm, and takes the defined enforcement
action. Each Active sub-policy can calculate a status of active, inactive
or skipped. Generally, if the resource appears to be Active for any reason
it will be considered Active.
Note the contrast with Approved, where if the resource appears to be Unapproved for any reason it will be considered
Unapproved.
See Active for more information.
[ "Skip", "Check: Active", "Enforce: Delete inactive with 1 day warning", "Enforce: Delete inactive with 3 days warning", "Enforce: Delete inactive with 7 days warning", "Enforce: Delete inactive with 14 days warning", "Enforce: Delete inactive with 30 days warning", "Enforce: Delete inactive with 60 days warning", "Enforce: Delete inactive with 90 days warning", "Enforce: Delete inactive with 180 days warning", "Enforce: Delete inactive with 365 days warning"]
{ "type": "string", "enum": [ "Skip", "Check: Active", "Enforce: Delete inactive with 1 day warning", "Enforce: Delete inactive with 3 days warning", "Enforce: Delete inactive with 7 days warning", "Enforce: Delete inactive with 14 days warning", "Enforce: Delete inactive with 30 days warning", "Enforce: Delete inactive with 60 days warning", "Enforce: Delete inactive with 90 days warning", "Enforce: Delete inactive with 180 days warning", "Enforce: Delete inactive with 365 days warning" ], "example": [ "Check: Active" ], "default": "Skip"}
AWS > Secrets Manager > Secret > Active > Age
The age after which the AWS Secrets Manager secret is no longer considered active. If a create time is unavailable, the time Turbot discovered the resource is used.
The Active control determines whether the resource is in active use, and if not, has the ability to delete / cleanup the resource. When running an automated compliance environment, it's common to end up with a wide range of alarms that are difficult and time consuming to clear. The Active control brings automated, well-defined control to this process.
The Active control checks the status of all defined Active policies for the
resource (AWS > Secrets Manager > Secret > Active > *
),
raises an alarm, and takes the defined enforcement action. Each Active
sub-policy can calculate a status of active, inactive or skipped. Generally,
if the resource appears to be Active for any reason it will be considered Active.
Note the contrast with Approved, where if the resource appears to be Unapproved
for any reason it will be considered Unapproved.
See Active for more information.
[ "Skip", "Force inactive if age > 1 day", "Force inactive if age > 3 days", "Force inactive if age > 7 days", "Force inactive if age > 14 days", "Force inactive if age > 30 days", "Force inactive if age > 60 days", "Force inactive if age > 90 days", "Force inactive if age > 180 days", "Force inactive if age > 365 days"]
{ "type": "string", "enum": [ "Skip", "Force inactive if age > 1 day", "Force inactive if age > 3 days", "Force inactive if age > 7 days", "Force inactive if age > 14 days", "Force inactive if age > 30 days", "Force inactive if age > 60 days", "Force inactive if age > 90 days", "Force inactive if age > 180 days", "Force inactive if age > 365 days" ], "example": [ "Force inactive if age > 90 days" ], "default": "Skip"}
AWS > Secrets Manager > Secret > Active > Budget
The impact of the budget state on the active control. This policy allows you to force
secrets to inactive based on the current budget state, as reflected in
AWS > Account > Budget > State
The Active control determines whether the resource is in active use, and if not, has the ability to delete / cleanup the resource. When running an automated compliance environment, it's common to end up with a wide range of alarms that are difficult and time consuming to clear. The Active control brings automated, well-defined control to this process.
The Active control checks the status of all defined Active policies for the
resource (AWS > Secrets Manager > Secret > Active > *
),
raises an alarm, and takes the defined enforcement action. Each Active
sub-policy can calculate a status of active, inactive or skipped. Generally,
if the resource appears to be Active for any reason it will be considered Active.
Note the contrast with Approved, where if the resource appears to be Unapproved
for any reason it will be considered Unapproved.
See Active for more information.
[ "Skip", "Force inactive if Budget > State is Over or higher", "Force inactive if Budget > State is Critical or higher", "Force inactive if Budget > State is Shutdown"]
{ "type": "string", "enum": [ "Skip", "Force inactive if Budget > State is Over or higher", "Force inactive if Budget > State is Critical or higher", "Force inactive if Budget > State is Shutdown" ], "example": [ "Skip" ], "default": "Skip"}
AWS > Secrets Manager > Secret > Active > Last Modified
The number of days since the AWS Secrets Manager secret was last modified before it is considered inactive.
The Active control determines whether the resource is in active use, and if not, has the ability to delete / cleanup the resource. When running an automated compliance environment, it's common to end up with a wide range of alarms that are difficult and time consuming to clear. The Active control brings automated, well-defined control to this process.
The Active control checks the status of all defined Active policies for the
resource (AWS > Secrets Manager > Secret > Active > *
),
raises an alarm, and takes the defined enforcement action. Each Active
sub-policy can calculate a status of active, inactive or skipped. Generally,
if the resource appears to be Active for any reason it will be considered Active.
Note the contrast with Approved, where if the resource appears to be Unapproved
for any reason it will be considered Unapproved.
See Active for more information.
[ "Skip", "Active if last modified <= 1 day", "Active if last modified <= 3 days", "Active if last modified <= 7 days", "Active if last modified <= 14 days", "Active if last modified <= 30 days", "Active if last modified <= 60 days", "Active if last modified <= 90 days", "Active if last modified <= 180 days", "Active if last modified <= 365 days", "Force active if last modified <= 1 day", "Force active if last modified <= 3 days", "Force active if last modified <= 7 days", "Force active if last modified <= 14 days", "Force active if last modified <= 30 days", "Force active if last modified <= 60 days", "Force active if last modified <= 90 days", "Force active if last modified <= 180 days", "Force active if last modified <= 365 days"]
{ "type": "string", "enum": [ "Skip", "Active if last modified <= 1 day", "Active if last modified <= 3 days", "Active if last modified <= 7 days", "Active if last modified <= 14 days", "Active if last modified <= 30 days", "Active if last modified <= 60 days", "Active if last modified <= 90 days", "Active if last modified <= 180 days", "Active if last modified <= 365 days", "Force active if last modified <= 1 day", "Force active if last modified <= 3 days", "Force active if last modified <= 7 days", "Force active if last modified <= 14 days", "Force active if last modified <= 30 days", "Force active if last modified <= 60 days", "Force active if last modified <= 90 days", "Force active if last modified <= 180 days", "Force active if last modified <= 365 days" ], "example": [ "Active if last modified <= 90 days" ], "default": "Skip"}
AWS > Secrets Manager > Secret > Approved
Determine the action to take when an AWS Secrets Manager secret is not approved based on AWS > Secrets Manager > Secret > Approved > *
policies.
The Approved control checks the status of the defined Approved sub-policies for the resource. If the resource is not approved according to any of these policies, this control raises an alarm and takes the defined enforcement action.
For any enforcement actions that specify if new
, e.g., Enforce: Delete unapproved if new
, this control will only take the enforcement actions for resources created within the last 60 minutes.
See Approved for more information.
[ "Skip", "Check: Approved", "Enforce: Delete unapproved if new"]
{ "type": "string", "enum": [ "Skip", "Check: Approved", "Enforce: Delete unapproved if new" ], "example": [ "Check: Approved" ], "default": "Skip"}
AWS > Secrets Manager > Secret > Approved > Budget
The policy allows you to set secrets to unapproved based on the current budget state, as reflected in AWS > Account > Budget > State
This policy will be evaluated by the Approved control. If an AWS Secrets Manager secret is not matched by the approved list, it will be subject to the action specified in the AWS > Secrets Manager > Secret > Approved
policy.
See Approved for more information.
[ "Skip", "Unapproved if Budget > State is Over or higher", "Unapproved if Budget > State is Critical or higher", "Unapproved if Budget > State is Shutdown"]
{ "type": "string", "enum": [ "Skip", "Unapproved if Budget > State is Over or higher", "Unapproved if Budget > State is Critical or higher", "Unapproved if Budget > State is Shutdown" ], "example": [ "Unapproved if Budget > State is Shutdown" ], "default": "Skip"}
AWS > Secrets Manager > Secret > Approved > Regions
A list of AWS regions in which AWS Secrets Manager secrets are approved for use.
The expected format is an array of regions names. You may use the '*' and '?' wildcard characters.
This policy will be evaluated by the Approved control. If an AWS Secrets Manager secret is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > Secrets Manager > Secret > Approved
policy.
See Approved for more information.
"{\n regions: policy(uri: \"tmod:@turbot/aws-secretsmanager#/policy/types/secretsManagerApprovedRegionsDefault\")\n}\n"
"{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- '{{ item }}'\n{% endfor %}"
AWS > Secrets Manager > Secret > Approved > Usage
Determine whether the AWS Secrets Manager secret is allowed to exist.
This policy will be evaluated by the Approved control. If an AWS Secrets Manager secret is not approved, it will be subject to the action specified in the AWS > Secrets Manager > Secret > Approved
policy.
See Approved for more information.
[ "Not approved", "Approved", "Approved if AWS > Secrets Manager > Enabled"]
{ "type": "string", "enum": [ "Not approved", "Approved", "Approved if AWS > Secrets Manager > Enabled" ], "example": [ "Not approved" ], "default": "Approved if AWS > Secrets Manager > Enabled"}
AWS > Secrets Manager > Secret > CMDB
Configure whether to record and synchronize details for the AWS Secrets Manager secret into the CMDB.
The CMDB control is responsible for populating and updating all the attributes for that resource type in the Turbot CMDB. All policies and controls in Turbot are based around the resource, so usually the CMDB policy is set to "Enforce: Enabled".
If set to Skip then all changes to the CMDB are paused - no new resources will be discovered, no updates will be made and deleted resources will not be removed.
To cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".
CMDB controls also use the Regions policy associated with the resource. If region is not in AWS > Secrets Manager > Secret > Regions
policy, the CMDB control will delete the resource from the CMDB.
(Note: Setting CMDB to "Skip" will also pause these changes.)
[ "Skip", "Enforce: Enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled"}
AWS > Secrets Manager > Secret > Encryption at Rest
Define the Encryption at Rest settings required for AWS > Secrets Manager > Secret
.
Encryption at Rest refers specifically to the encryption of data when written to an underlying storage system. This control determines whether the resource is encrypted at rest, and sets encryption to your desired level.
The Encryption at Rest
control compares the encryption settings against the encryption policies for the resource
(AWS > Secrets Manager > Secret > Encryption at Rest > *
),
raises an alarm, and takes the defined enforcement action
[ "Skip", "Check: AWS managed key", "Check: AWS managed key or higher", "Check: Customer managed key", "Check: Encryption at Rest > Customer Managed Key", "Enforce: AWS managed key", "Enforce: AWS managed key or higher", "Enforce: Customer managed key", "Enforce: Encryption at Rest > Customer Managed Key"]
{ "type": "string", "enum": [ "Skip", "Check: AWS managed key", "Check: AWS managed key or higher", "Check: Customer managed key", "Check: Encryption at Rest > Customer Managed Key", "Enforce: AWS managed key", "Enforce: AWS managed key or higher", "Enforce: Customer managed key", "Enforce: Encryption at Rest > Customer Managed Key" ], "example": [ "Check: None or higher" ], "default": "Skip"}
AWS > Secrets Manager > Secret > Encryption at Rest > Customer Managed Key
Define the KMS key ID for encryption at rest.
Encryption at Rest refers specifically to the encryption of data when written to an underlying storage system. This control determines whether the resource is encrypted at rest, and sets encryption to your desired level.
The Encryption at Rest
control compares the encryption settings against the encryption policies for the resource
(AWS > Secrets Manager > Secret > Encryption at Rest > *
),
raises an alarm, and takes the defined enforcement action
Please make sure the key defined in the template has required permissions.
example: alias/aws/ebs ddc06e04-ce5f-4995-c758-c2b6c510e8fd arn:aws:kms:us-east-1:123456789012:key/ddc06e04-ce5f-4995-c758-c2b6c510e8fd arn:aws:kms:us-east-1:123456789012:alias/aws/ebs
"{\n defaultKey: policy(uri: \"aws-kms#/policy/types/keyDefaultCustomerManagedKey\")\n}\n"
"{{ $.defaultKey }}"
{ "anyOf": [ { "type": "string", "pattern": "^alias/[a-zA-Z0-9:/_-]{1,249}$" }, { "type": "string", "pattern": "^[-a-z0-9-]{1,255}$" }, { "type": "string", "pattern": "^arn:aws(-us-gov|-cn)?:kms:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:key/[-a-z0-9-]{1,255}$" }, { "type": "string", "pattern": "^arn:aws(-us-gov|-cn)?:kms:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:alias/[a-zA-Z0-9:/_-]{1,249}$" } ], "tests": [ { "description": "valid - if keyArn", "input": "arn:aws:kms:us-east-1:039305405804:key/ddc06e04-ce5f-4995-b758-c2b6c510e8fd" }, { "description": "valid - if aliasName", "input": "alias/aws/ebs" }, { "description": "valid - if keyId", "input": "ddc06e04-ce5f-4995-b758-c2b6c510e8fd" }, { "description": "valid - if aliasArn", "input": "arn:aws:kms:us-east-1:039305405804:alias/aws/ebs" } ]}
AWS > Secrets Manager > Secret > Policy
AWS > Secrets Manager > Secret > Policy > Trusted Access
Take an action when AWS Secrets Manager secret policy is not trusted based on the
AWS > Secrets Manager > Secret > Policy > Trusted Access > *
policies.
The Trusted Access control evaluates the secret policy against the list of allowed members in each of the Trusted Access sub-policies (Trusted Access > Accounts, Trusted Access > Services etc.), this control raises an alarm and takes the defined enforcement action.
The account that owns the secret will always be trusted, even if its account ID is not included in the Trusted Accounts policy.
If set to Enforce: Revoke untrusted access
, access to non-trusted
members will be removed.
[ "Skip", "Check: Trusted Access", "Enforce: Revoke untrusted access"]
{ "type": "string", "enum": [ "Skip", "Check: Trusted Access", "Enforce: Revoke untrusted access" ], "default": "Skip"}
AWS > Secrets Manager > Secret > Policy > Trusted Access > Accounts
List of AWS Account IDs that are trusted for cross-account access in the AWS Secrets Manager secret policy.
Note that Trusted Access > Accounts
and Trusted Access >
Organizations
are evaluated independently. To have access, an AWS
principal must be allowed in Trusted Access > Accounts
AND be a
member of an Organization that is allowed in Trusted Access >
Organizations
.
example: - "123456789012"
Note: Setting the policy to an Empty
array will remove all accounts.
"{\n accounts: policy(uri: \"tmod:@turbot/aws-secretsmanager#/policy/types/secretsManagerPolicyTrustedAccounts\")\n}\n"
"{% if $.accounts | length == 0 %}[]{% endif %}{% for item in $.accounts %}- '{{ item }}'\n{% endfor %}"
{ "type": "array", "items": { "type": "string", "pattern": "(?:^\\d{12}$|^\\*$)" }}
AWS > Secrets Manager > Secret > Policy > Trusted Access > Identity Providers
List of Identity Providers that are trusted for cross-account access in the AWS Secrets Manager secret policy.
example: - www.google.com - www.facebook.com
Note: Setting the policy to an Empty
array will remove all identity providers.
"{\n identityProviders: policy(uri: \"tmod:@turbot/aws-secretsmanager#/policy/types/secretsManagerPolicyTrustedIdentityProviders\")\n}\n"
"{% if $.identityProviders | length == 0 %}[]{% endif %}{% for item in $.identityProviders %}- '{{ item }}'\n{% endfor %}"
{ "type": "array", "items": { "type": "string" }}
AWS > Secrets Manager > Secret > Policy > Trusted Access > Organization Restrictions
List of AWS Organization IDs that are trusted for cross-account access in the AWS Secrets Manager secret policy, or '*' to skip the Organization Restriction.
Note that Trusted Access > Accounts
and Trusted Access >
Organizations
are evaluated independently. To have access, an AWS
principal must be allowed in Trusted Access > Accounts
AND be a
member of an Organization that is allowed in Trusted Access >
Organizations
.
Note: Trusted Access > Organization Restrictions
are ONLY
applied to AWS principals. Services and Federated principals do
NOT contain the aws:PrincipalOrgId
condition key, and thus
cannot be validated against the Organization.
example: - "o-333333333" - "o-c3a5y4wd52"
"{\n organizations: policy(uri: \"tmod:@turbot/aws-secretsmanager#/policy/types/secretsManagerPolicyTrustedOrganizations\")\n}\n"
"{% if $.organizations | length == 0 %}[]{% endif %}{% for item in $.organizations %}- '{{ item }}'\n{% endfor %}"
{ "type": "array", "items": { "type": "string", "pattern": "(?:^o-[a-z0-9]{10,32}$|^\\*$)" }}
AWS > Secrets Manager > Secret > Policy > Trusted Access > Services
List of AWS Services that are trusted for access in the AWS Secrets Manager secret policy.
example: - sns.amazonaws.com - ec2.amazonaws.com
Note: Setting the policy to an Empty
array will remove all services.
"{\n services: policy(uri: \"tmod:@turbot/aws-secretsmanager#/policy/types/secretsManagerPolicyTrustedServices\")\n}\n"
"{% if $.services | length == 0 %}[]{% endif %}{% for item in $.services %}- '{{ item }}'\n{% endfor %}"
{ "type": "array", "items": { "type": "string", "pattern": "(?:^\\S*\\.amazonaws\\.com$|^\\*$)" }}
AWS > Secrets Manager > Secret > Regions
A list of AWS regions in which AWS Secrets Manager secrets are supported for use.
Any secrets in a region not listed here will not be recorded in CMDB.
The expected format is an array of regions names. You may use the '*' and '?' wildcard characters.
"{\n regions: policyValue(uri:\"tmod:@turbot/aws-secretsmanager#/policy/types/secretsManagerRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
AWS > Secrets Manager > Secret > Tags
Determine the action to take when an AWS Secrets Manager secret tags are not updated based on the AWS > Secrets Manager > Secret > Tags > *
policies.
The control ensure AWS Secrets Manager secret tags include tags defined in AWS > Secrets Manager > Secret > Tags > Template
.
Tags not defined in Secret Tags Template will not be modified or deleted. Setting a tag value to undefined
will result in the tag being deleted.
See Tags for more information.
[ "Skip", "Check: Tags are correct", "Enforce: Set tags"]
{ "type": "string", "enum": [ "Skip", "Check: Tags are correct", "Enforce: Set tags" ], "example": [ "Check: Tags are correct" ], "default": "Skip"}
AWS > Secrets Manager > Secret > Tags > Template
The template is used to generate the keys and values for AWS Secrets Manager secret.
Tags not defined in Secret Tags Template will not be modified or deleted. Setting a tag value to undefined
will result in the tag being deleted.
See Tags for more information.
[ "{\n account {\n turbot {\n id\n }\n }\n}\n", "{\n defaultTags: policyValue(uri:\"tmod:@turbot/aws-secretsmanager#/policy/types/secretsManagerTagsTemplate\" resourceId: \"{{ $.account.turbot.id }}\") {\n value\n }\n}\n"]
"{%- if $.defaultTags.value | length == 0 %} [] {%- elif $.defaultTags.value != undefined %}{{ $.defaultTags.value | dump | safe }}{%- else %}{% for item in $.defaultTags.value %}- {{ item }}{% endfor %}{% endif %}"
AWS > Secrets Manager > Secret > Usage
Configure the number of AWS Secrets Manager secrets that can be used for this account and the current consumption against the limit.
You can configure the behavior of the control with this AWS > Secrets Manager > Secret > Usage
policy.
[ "Skip", "Check: Usage <= 85% of Limit", "Check: Usage <= 100% of Limit"]
{ "type": "string", "enum": [ "Skip", "Check: Usage <= 85% of Limit", "Check: Usage <= 100% of Limit" ], "example": [ "Check: Usage <= 85% of Limit" ], "default": "Skip"}
AWS > Secrets Manager > Secret > Usage > Limit
Maximum number of items that can be created for this account.
{ "type": "integer", "minimum": 0, "default": 40000}
AWS > Secrets Manager > Tags Template [Default]
A template used to generate the keys and values for AWS Secrets Manager resources.
By default, all Secrets Manager resource Tags > Template policies will use this value.
"{\n defaultTags: policyValue(uri:\"tmod:@turbot/aws#/policy/types/defaultTagsTemplate\") {\n value\n }\n}\n"
"{%- if $.defaultTags.value | length == 0 %} [] {%- elif $.defaultTags.value != undefined %}{{ $.defaultTags.value | dump | safe }}{%- else %}{% for item in $.defaultTags.value %}- {{ item }}{% endfor %}{% endif %}"
AWS > Secrets Manager > Trusted Accounts [Default]
List of AWS Accounts that are trusted for access in the AWS Secrets Manager policy.
This policy is used by the Trusted Access control to determine which members of type "account" are allowed to be granted access. You may use the '*' and '?' wildcard characters.
example: - "013122550996" - "560741234067"
Note: Setting the policy to Empty
array will remove all accounts.
"{\n trustedAccounts: policyValue(uri:\"tmod:@turbot/aws#/policy/types/trustedAccounts\") {\n value\n }\n}\n"
"{% if $.trustedAccounts.value | length == 0 %}[]{% else %}{% for item in $.trustedAccounts.value %}- '{{ item }}'\n{% endfor %}{% endif %}"
{ "type": "array", "items": { "type": "string", "pattern": "^[0-9]{12}|^\\*$" }}
AWS > Secrets Manager > Trusted Identity Providers [Default]
List of AWS Identity Providers that are trusted for access in the AWS Secrets Manager policy.
This policy is used by the Trusted Access control to determine which members of type "identity provider" are allowed to be granted access. You may use the '*' and '?' wildcard characters.
example: - "www.amazon.com" - "graph.facebook.com"
Note: Setting the policy to Empty
array will remove all identity providers.
"{\n trustedIdentityProviders: policyValue(uri:\"tmod:@turbot/aws#/policy/types/trustedIdentityProviders\") {\n value\n }\n}\n"
"{% if $.trustedIdentityProviders.value | length == 0 %}[]{% else %}{% for item in $.trustedIdentityProviders.value %}- '{{ item }}'\n{% endfor %}{% endif %}"
{ "type": "array", "items": { "type": "string" }}
AWS > Secrets Manager > Trusted Organizations [Default]
List of AWS Organizations that are trusted for access in the AWS Secrets Manager policy.
This policy is used by the Trusted Access control to determine which members of type "organization" are allowed to be granted access. You may use the '*' and '?' wildcard characters.
example: - "o-333333333" - "o-c3a5y4wd52"
Note: Trusted Access > Organization Restrictions
are ONLY
applied to AWS principals. Services and Federated principals do
NOT contain the aws:PrincipalOrgId
condition key, and thus
cannot be validated against the Organization.
Setting the policy to Empty
array will remove all organizations.
"{\n trustedOrganizations: policyValue(uri:\"tmod:@turbot/aws#/policy/types/trustedOrganizations\") {\n value\n }\n}\n"
"{% if $.trustedOrganizations.value | length == 0 %}[]{% else %}{% for item in $.trustedOrganizations.value %}- '{{ item }}'\n{% endfor %}{% endif %}"
{ "type": "array", "items": { "type": "string", "pattern": "(?:^o-[a-z0-9]{10,32}$|^\\*$)" }}
AWS > Secrets Manager > Trusted Services [Default]
List of AWS Services that are trusted for access in the AWS Secrets Manager policy.
This policy is used by the Trusted Access control to determine which members of type "service" are allowed to be granted access. You may use the '*' and '?' wildcard characters.
example: - "sns.amazonaws.com" - "ec2.amazonaws.com"
Note: Setting the policy to Empty
array will remove all services.
"{\n trustedServices: policyValue(uri:\"tmod:@turbot/aws#/policy/types/trustedServices\") {\n value\n }\n}\n"
"{% if $.trustedServices.value | length == 0 %}[]{% else %}{% for item in $.trustedServices.value %}- '{{ item }}'\n{% endfor %}{% endif %}"
{ "type": "array", "items": { "type": "string", "pattern": "(?:^\\S*\\.amazonaws\\.com$|^\\*$)" }}
AWS > Turbot > Event Handlers > Events > Rules > Event Sources > @turbot/aws-secretsmanager
AWS Secrets Manager CloudWatch Events event sources for the Turbot Event Handlers.
{ "type": "array", "items": { "type": "string" }, "default": [ "aws.secretsmanager" ]}
AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-secretsmanager
A read-only policy generated by Turbot that lists the APIs that
should be added to the turbot-managed (hard) boundary policy,
thereby enabling them to be assigned to users and roles.
This value will change depending on the value of the value of the
AWS > Secrets Manager > Permissions > Lockdown > API Boundary
policy
{ "type": "array"}
AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-secretsmanager
A calculated policy that Turbot uses to create a compiled list of ALL permissions for AWS Secrets Manager that is used as input to the stack that manages the Turbot IAM permissions objects.
AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-secretsmanager
A calculated policy that Turbot uses to create a compiled list of ALL permissions for AWS Secrets Manager that is used as input to the control that manages the IAM stack.