Policy types for @turbot/aws-outposts
- AWS > Outposts > API Enabled
- AWS > Outposts > Approved Regions [Default]
- AWS > Outposts > Enabled
- AWS > Outposts > Local Gateway > CMDB
- AWS > Outposts > Local Gateway > Regions
- AWS > Outposts > Local Gateway Route Table > CMDB
- AWS > Outposts > Local Gateway Route Table > Regions
- AWS > Outposts > Local Gateway Virtual Interface > CMDB
- AWS > Outposts > Local Gateway Virtual Interface > Regions
- AWS > Outposts > Local Gateway Virtual Interface Group > CMDB
- AWS > Outposts > Local Gateway Virtual Interface Group > Regions
- AWS > Outposts > Outpost > CMDB
- AWS > Outposts > Outpost > Regions
- AWS > Outposts > Permissions
- AWS > Outposts > Permissions > Levels
- AWS > Outposts > Permissions > Levels > Modifiers
- AWS > Outposts > Permissions > Lockdown
- AWS > Outposts > Permissions > Lockdown > API Boundary
- AWS > Outposts > Regions
- AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-outposts
- AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-outposts
- AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-outposts
AWS > Outposts > API Enabled
Configure whether the AWS Outposts API is enabled.
Note: Disabling the service disables the API for ALL users and roles, and Guardrails will have no access to the API.
tmod:@turbot/aws-outposts#/policy/types/outpostsApiEnabled
[ "Enabled", "Disabled", "Enabled if AWS > Outposts > Enabled"]
{ "type": "string", "enum": [ "Enabled", "Disabled", "Enabled if AWS > Outposts > Enabled" ], "default": "Enabled"}
AWS > Outposts > Approved Regions [Default]
A list of AWS regions in which AWS Outposts 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 Outposts resources' Approved > Regions policies.
tmod:@turbot/aws-outposts#/policy/types/outpostsApprovedRegionsDefault
"{\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 > Outposts > Enabled
Configure whether the AWS Outposts service is enabled.
This will only affect Guardrails managed User Roles and will allow the Guardrails managed user to access AWS Outposts service.
- Enabled
policy allows Guardrails managed users to perform all the actions for the service
- Enabled: Metadata Only
policy allows Guardrails managed users to perform only the metadata level actions for the service (like describe*
, list*
)
Note:
- Disabled
policy disables the service but does NOT disable the API for Guardrails or SuperUsers
- All the resource data stored in the Guardrails CMDB is considered to be metadata
- For more information related to permissions and grant levels, please check the documentation
tmod:@turbot/aws-outposts#/policy/types/outpostsEnabled
[ "Enabled", "Enabled: Metadata Only", "Disabled"]
{ "type": "string", "enum": [ "Enabled", "Enabled: Metadata Only", "Disabled" ], "example": [ "Enabled" ], "default": "Disabled"}
AWS > Outposts > Local Gateway > CMDB
Configure whether to record and synchronize details for the AWS Outposts local gateway into the CMDB.
The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.
All policies and controls in Guardrails 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 > Outposts > Local Gateway > Regions
policy, the CMDB control will delete the resource from the CMDB.
(Note: Setting CMDB to "Skip" will also pause these changes.)
tmod:@turbot/aws-outposts#/policy/types/localGatewayCmdb
[ "Skip", "Enforce: Enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled"}
AWS > Outposts > Local Gateway > Regions
A list of AWS regions in which AWS Outposts local gateways are supported for use.
Any local gateways 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.
tmod:@turbot/aws-outposts#/policy/types/localGatewayRegions
{ "allOf": [ { "$ref": "aws#/definitions/regionNameMatcherList" }, { "default": [ "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "me-south-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2" ] } ]}
AWS > Outposts > Local Gateway Route Table > CMDB
Configure whether to record and synchronize details for the AWS Outposts local gateway route table into the CMDB.
The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.
All policies and controls in Guardrails 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 > Outposts > Local Gateway Route Table > Regions
policy, the CMDB control will delete the resource from the CMDB.
(Note: Setting CMDB to "Skip" will also pause these changes.)
tmod:@turbot/aws-outposts#/policy/types/localGatewayRouteTableCmdb
[ "Skip", "Enforce: Enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled"}
AWS > Outposts > Local Gateway Route Table > Regions
A list of AWS regions in which AWS Outposts local gateway route tables are supported for use.
Any local gateway route tables 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.
tmod:@turbot/aws-outposts#/policy/types/localGatewayRouteTableRegions
{ "allOf": [ { "$ref": "aws#/definitions/regionNameMatcherList" }, { "default": [ "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "me-south-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2" ] } ]}
AWS > Outposts > Local Gateway Virtual Interface > CMDB
Configure whether to record and synchronize details for the AWS Outposts local gateway virtual interface into the CMDB.
The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.
All policies and controls in Guardrails 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 > Outposts > Local Gateway Virtual Interface > Regions
policy, the CMDB control will delete the resource from the CMDB.
(Note: Setting CMDB to "Skip" will also pause these changes.)
tmod:@turbot/aws-outposts#/policy/types/localGatewayVirtualInterfaceCmdb
[ "Skip", "Enforce: Enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled"}
AWS > Outposts > Local Gateway Virtual Interface > Regions
A list of AWS regions in which AWS Outposts local gateway virtual interfaces are supported for use.
Any local gateway virtual interfaces 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.
tmod:@turbot/aws-outposts#/policy/types/localGatewayVirtualInterfaceRegions
{ "allOf": [ { "$ref": "aws#/definitions/regionNameMatcherList" }, { "default": [ "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "me-south-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2" ] } ]}
AWS > Outposts > Local Gateway Virtual Interface Group > CMDB
Configure whether to record and synchronize details for the AWS Outposts local gateway virtual interface group into the CMDB.
The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.
All policies and controls in Guardrails 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 > Outposts > Local Gateway Virtual Interface Group > Regions
policy, the CMDB control will delete the resource from the CMDB.
(Note: Setting CMDB to "Skip" will also pause these changes.)
tmod:@turbot/aws-outposts#/policy/types/localGatewayVirtualInterfaceGroupCmdb
[ "Skip", "Enforce: Enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled"}
AWS > Outposts > Local Gateway Virtual Interface Group > Regions
A list of AWS regions in which AWS Outposts local gateway virtual interface groups are supported for use.
Any local gateway virtual interface groups 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.
tmod:@turbot/aws-outposts#/policy/types/localGatewayVirtualInterfaceGroupRegions
{ "allOf": [ { "$ref": "aws#/definitions/regionNameMatcherList" }, { "default": [ "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "me-south-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2" ] } ]}
AWS > Outposts > Outpost > CMDB
Configure whether to record and synchronize details for the AWS Outposts outpost into the CMDB.
The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.
All policies and controls in Guardrails 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 > Outposts > Outpost > Regions
policy, the CMDB control will delete the resource from the CMDB.
(Note: Setting CMDB to "Skip" will also pause these changes.)
tmod:@turbot/aws-outposts#/policy/types/outpostCmdb
[ "Skip", "Enforce: Enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled"}
AWS > Outposts > Outpost > Regions
A list of AWS regions in which AWS Outposts outposts are supported for use.
Any outposts 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.
tmod:@turbot/aws-outposts#/policy/types/outpostRegions
{ "allOf": [ { "$ref": "aws#/definitions/regionNameMatcherList" }, { "default": [ "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "me-south-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2" ] } ]}
AWS > Outposts > Permissions
Configure whether permissions policies are in effect for AWS Outposts.
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.
tmod:@turbot/aws-outposts#/policy/types/outpostsPermissions
[ "Enabled", "Disabled", "Enabled if AWS > Outposts > Enabled & AWS > Outposts > API Enabled"]
{ "type": "string", "enum": [ "Enabled", "Disabled", "Enabled if AWS > Outposts > Enabled & AWS > Outposts > API Enabled" ], "example": [ "Enabled" ], "default": "Enabled if AWS > Outposts > Enabled & AWS > Outposts > API Enabled"}
AWS > Outposts > 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 Guardrails users.
This policy provides a default for Permissions > Levels in each service,
however you can explicitly override the setting for each service if desired
tmod:@turbot/aws-outposts#/policy/types/outpostsPermissionsLevels
[ "{\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 > Outposts > Permissions > Levels > Modifiers
A map of AWS API to Guardrails Permission Level used to customize Guardrails' standard permissions.
You can add, remove or redefine the mapping of AWS API operations to Guardrails 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<br />example:<br /> - "glacier:createvault": admin<br /> - "glacier:ListVaults": metadata<br /> - "s3:DeleteBucket": none<br />
tmod:@turbot/aws-outposts#/policy/types/outpostsPermissionsLevelsModifiers
AWS > Outposts > Permissions > Lockdown
tmod:@turbot/aws-outposts#/policy/types/outpostsPermissionsLockdown
AWS > Outposts > Permissions > Lockdown > API Boundary
Configure whether the AWS outposts API is enabled for all users and roles in guardrails-managed boundary policies.
Note: Disabling the service disables the API for ALL users and roles, and Guardrails will have no access to the API.
tmod:@turbot/aws-outposts#/policy/types/outpostsPermissionsLockdownApiBoundary
[ "Enabled if AWS > Outposts > API Enabled"]
{ "type": "string", "enum": [ "Enabled if AWS > Outposts > API Enabled" ], "example": [ "Enabled if AWS > Outposts > API Enabled" ], "default": "Enabled if AWS > Outposts > API Enabled"}
AWS > Outposts > Regions
A list of AWS regions in which AWS Outposts 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 Outposts resources' Regions policies.
tmod:@turbot/aws-outposts#/policy/types/outpostsRegionsDefault
{ "allOf": [ { "$ref": "aws#/definitions/regionNameMatcherList" }, { "default": [ "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "me-south-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2" ] } ]}
AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-outposts
A read-only policy generated by Guardrails that lists the APIs that
should be added to the guardrails-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 theAWS > Outposts > Permissions > Lockdown > API Boundary
policy
tmod:@turbot/aws-outposts#/policy/types/awsCompiledApiBoundary
{ "type": "array"}
AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-outposts
A calculated policy that Guardrails uses to create a compiled list of ALL permissions for AWS Outposts
that is used as input to the stack that manages the Guardrails IAM permissions objects.
tmod:@turbot/aws-outposts#/policy/types/awsLevelsCompiled
AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-outposts
A calculated policy that Guardrails uses to create a compiled list of ALL permissions for AWS Outposts
that is used as input to the control that manages the IAM stack.
tmod:@turbot/aws-outposts#/policy/types/awsCompiledServicePermissions