Policy types for @turbot/aws-ram
- AWS > Resource Access Manager > API Enabled
- AWS > Resource Access Manager > Approved Regions [Default]
- AWS > Resource Access Manager > Enabled
- AWS > Resource Access Manager > Permissions
- AWS > Resource Access Manager > Permissions > Levels
- AWS > Resource Access Manager > Permissions > Levels > Modifiers
- AWS > Resource Access Manager > Permissions > Lockdown
- AWS > Resource Access Manager > Permissions > Lockdown > API Boundary
- AWS > Resource Access Manager > Regions
- AWS > Resource Access Manager > Resource Share > Active
- AWS > Resource Access Manager > Resource Share > Active > Age
- AWS > Resource Access Manager > Resource Share > Active > Last Modified
- AWS > Resource Access Manager > Resource Share > Approved
- AWS > Resource Access Manager > Resource Share > Approved > Custom
- AWS > Resource Access Manager > Resource Share > Approved > Regions
- AWS > Resource Access Manager > Resource Share > Approved > Usage
- AWS > Resource Access Manager > Resource Share > CMDB
- AWS > Resource Access Manager > Resource Share > Regions
- AWS > Resource Access Manager > Resource Share > Tags
- AWS > Resource Access Manager > Resource Share > Tags > Template
- AWS > Resource Access Manager > Resource Share > Usage
- AWS > Resource Access Manager > Resource Share > Usage > Limit
- AWS > Resource Access Manager > Tags Template [Default]
- AWS > Turbot > Event Handlers > Events > Rules > Event Sources > @turbot/aws-ram
- AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-ram
- AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-ram
- AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-ram
AWS > Resource Access Manager > API Enabled
Configure whether the AWS Resource Access 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 > Resource Access Manager > Enabled"]{ "type": "string", "enum": [ "Enabled", "Disabled", "Enabled if AWS > Resource Access Manager > Enabled" ], "default": "Enabled"}AWS > Resource Access Manager > Approved Regions [Default]
A list of AWS regions in which AWS Resource Access 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 Resource Access 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 > Resource Access Manager > Enabled
Configure whether the AWS Resource Access Manager service is enabled. This will only affect Turbot managed User Roles and will allow the Turbot managed user to access AWS Resource Access Manager service.
Enabledpolicy allows Turbot managed users to perform all the actions for the serviceEnabled: Metadata Onlypolicy allows Turbot managed users to perform only the metadata level actions for the service (likedescribe*,list*)
Note:
Disabledpolicy 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 > Resource Access Manager > Permissions
Configure whether permissions policies are in effect for AWS Resource Access 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 > Resource Access Manager > Enabled & AWS > Resource Access Manager > API Enabled"]{ "type": "string", "enum": [ "Enabled", "Disabled", "Enabled if AWS > Resource Access Manager > Enabled & AWS > Resource Access Manager > API Enabled" ], "example": [ "Enabled" ], "default": "Enabled if AWS > Resource Access Manager > Enabled & AWS > Resource Access Manager > API Enabled"}AWS > Resource Access 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 }} policyTypeId:'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 > Resource Access 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": noneAWS > Resource Access Manager > Permissions > Lockdown
AWS > Resource Access Manager > Permissions > Lockdown > API Boundary
Configure whether the AWS ram 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 > Resource Access Manager > API Enabled"]{ "type": "string", "enum": [ "Enabled if AWS > Resource Access Manager > API Enabled" ], "example": [ "Enabled if AWS > Resource Access Manager > API Enabled" ], "default": "Enabled if AWS > Resource Access Manager > API Enabled"}AWS > Resource Access Manager > Regions
A list of AWS regions in which AWS Resource Access 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 Resource Access Manager resources' Regions policies.
{ "allOf": [ { "$ref": "aws#/definitions/regionNameMatcherList" }, { "default": [ "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "eu-central-1", "eu-north-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", "cn-north-1", "cn-northwest-1" ] } ]}AWS > Resource Access Manager > Resource Share > Active
Determine the action to take when an AWS Resource Access Manager resource share, based on the AWS > Resource Access Manager > Resource Share > 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 > Resource Access Manager > Resource Share > 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 > Resource Access Manager > Resource Share > Active > Age
The age after which the AWS Resource Access Manager resource share 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 > Resource Access Manager > Resource Share > 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 > Resource Access Manager > Resource Share > Active > Last Modified
The number of days since the AWS Resource Access Manager resource share 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 > Resource Access Manager > Resource Share > 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 > Resource Access Manager > Resource Share > Approved
Determine the action to take when an AWS Resource Access Manager resource share is not approved based on AWS > Resource Access Manager > Resource Share > 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 > Resource Access Manager > Resource Share > Approved > Custom
Determine whether the AWS Resource Access Manager resource share is allowed to exist.
This policy will be evaluated by the Approved control. If an AWS Resource Access Manager resource share is not approved, it will be subject to the action specified in the AWS > Resource Access Manager > Resource Share > Approved policy.
See Approved for more information.
Note: The policy value must be a string with a value of Approved, Not approved or Skip, or in the form of YAML objects. The object(s) must contain the key result with its value as Approved or Not approved. A custom title and message can also be added using the keys title and message respectively.
{ "example": [ "Approved", "Not approved", "Skip", { "result": "Approved" }, { "title": "string", "result": "Not approved" }, { "title": "string", "result": "Approved", "message": "string" }, [ { "title": "string", "result": "Approved", "message": "string" }, { "title": "string", "result": "Not approved", "message": "string" } ] ], "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "pattern": "^[\\W\\w]{1,32}$" }, "message": { "type": "string", "pattern": "^[\\W\\w]{1,128}$" }, "result": { "type": "string", "pattern": "^(Approved|Not approved|Skip)$" } }, "required": [ "result" ], "additionalProperties": false } }, { "type": "object", "properties": { "title": { "type": "string", "pattern": "^[\\W\\w]{1,32}$" }, "message": { "type": "string", "pattern": "^[\\W\\w]{1,128}$" }, "result": { "type": "string", "pattern": "^(Approved|Not approved|Skip)$" } }, "required": [ "result" ], "additionalProperties": false }, { "type": "string", "pattern": "^(Approved|Not approved|Skip)$" } ], "default": "Skip"}AWS > Resource Access Manager > Resource Share > Approved > Regions
A list of AWS regions in which AWS Resource Access Manager resource shares 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 Resource Access Manager resource share is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > Resource Access Manager > Resource Share > Approved policy.
See Approved for more information.
"{\n regions: policy(uri: \"tmod:@turbot/aws-ram#/policy/types/ramApprovedRegionsDefault\")\n}\n""{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- '{{ item }}'\n{% endfor %}"AWS > Resource Access Manager > Resource Share > Approved > Usage
Determine whether the AWS Resource Access Manager resource share is allowed to exist.
This policy will be evaluated by the Approved control. If an AWS Resource Access Manager resource share is not approved, it will be subject to the action specified in the AWS > Resource Access Manager > Resource Share > Approved policy.
See Approved for more information.
[ "Not approved", "Approved", "Approved if AWS > Resource Access Manager > Enabled"]{ "type": "string", "enum": [ "Not approved", "Approved", "Approved if AWS > Resource Access Manager > Enabled" ], "example": [ "Not approved" ], "default": "Approved if AWS > Resource Access Manager > Enabled"}AWS > Resource Access Manager > Resource Share > CMDB
Configure whether to record and synchronize details for the AWS Resource Access Manager resource share 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 > Resource Access Manager > Resource Share > 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 > Resource Access Manager > Resource Share > Regions
A list of AWS regions in which AWS Resource Access Manager resource shares are supported for use.
Any resource shares 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-ram#/policy/types/ramRegionsDefault\") {\n value\n }\n}\n""{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"AWS > Resource Access Manager > Resource Share > Tags
Determine the action to take when an AWS Resource Access Manager resource share tags are not updated based on the AWS > Resource Access Manager > Resource Share > Tags > * policies.
The control ensure AWS Resource Access Manager resource share tags include tags defined in AWS > Resource Access Manager > Resource Share > Tags > Template.
Tags not defined in Resource Share 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 > Resource Access Manager > Resource Share > Tags > Template
The template is used to generate the keys and values for AWS Resource Access Manager resource share.
Tags not defined in Resource Share 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-ram#/policy/types/ramTagsTemplate\" 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 > Resource Access Manager > Resource Share > Usage
Configure the number of AWS Resource Access Manager resource shares that can be used for this region and the current consumption against the limit.
You can configure the behavior of the control with this AWS > Resource Access Manager > Resource Share > 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 > Resource Access Manager > Resource Share > Usage > Limit
Maximum number of items that can be created for this region.
{ "type": "integer", "minimum": 0, "default": 25000}AWS > Resource Access Manager > Tags Template [Default]
A template used to generate the keys and values for AWS Resource Access Manager resources.
By default, all Resource Access 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 > Turbot > Event Handlers > Events > Rules > Event Sources > @turbot/aws-ram
AWS Resource Access Manager CloudWatch Events event sources for the Turbot Event Handlers.
{ "type": "array", "items": { "type": "string" }, "default": [ "aws.ram" ]}AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-ram
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 > Resource Access Manager > Permissions > Lockdown > API Boundary policy
{ "type": "array"}AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-ram
A calculated policy that Turbot uses to create a compiled list of ALL permissions for AWS Resource Access Manager that is used as input to the stack that manages the Turbot IAM permissions objects.
AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-ram
A calculated policy that Turbot uses to create a compiled list of ALL permissions for AWS Resource Access Manager that is used as input to the control that manages the IAM stack.