Policy types for @turbot/aws-dms
- AWS > DMS > API Enabled
- AWS > DMS > Approved Regions [Default]
- AWS > DMS > Enabled
- AWS > DMS > Endpoint > Active
- AWS > DMS > Endpoint > Active > Age
- AWS > DMS > Endpoint > Active > Last Modified
- AWS > DMS > Endpoint > Approved
- AWS > DMS > Endpoint > Approved > Encryption at Rest
- AWS > DMS > Endpoint > Approved > Encryption at Rest > Customer Managed Key
- AWS > DMS > Endpoint > Approved > Regions
- AWS > DMS > Endpoint > Approved > Usage
- AWS > DMS > Endpoint > CMDB
- AWS > DMS > Endpoint > Configured
- AWS > DMS > Endpoint > Configured > Claim Precedence
- AWS > DMS > Endpoint > Configured > Source
- AWS > DMS > Endpoint > Regions
- AWS > DMS > Endpoint > Tags
- AWS > DMS > Endpoint > Tags > Template
- AWS > DMS > Endpoint > Usage
- AWS > DMS > Endpoint > Usage > Limit
- AWS > DMS > Permissions
- AWS > DMS > Permissions > Levels
- AWS > DMS > Permissions > Levels > Modifiers
- AWS > DMS > Permissions > Lockdown
- AWS > DMS > Permissions > Lockdown > API Boundary
- AWS > DMS > Regions
- AWS > DMS > Replication Instance > Active
- AWS > DMS > Replication Instance > Active > Age
- AWS > DMS > Replication Instance > Active > Budget
- AWS > DMS > Replication Instance > Active > Last Modified
- AWS > DMS > Replication Instance > Approved
- AWS > DMS > Replication Instance > Approved > Budget
- AWS > DMS > Replication Instance > Approved > Encryption at Rest
- AWS > DMS > Replication Instance > Approved > Encryption at Rest > Customer Managed Key
- AWS > DMS > Replication Instance > Approved > Regions
- AWS > DMS > Replication Instance > Approved > Usage
- AWS > DMS > Replication Instance > CMDB
- AWS > DMS > Replication Instance > Regions
- AWS > DMS > Replication Instance > Tags
- AWS > DMS > Replication Instance > Tags > Template
- AWS > DMS > Replication Instance > Usage
- AWS > DMS > Replication Instance > Usage > Limit
- AWS > DMS > Tags Template [Default]
- AWS > Turbot > Event Handlers > Events > Rules > Event Sources > @turbot/aws-dms
- AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-dms
- AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-dms
- AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-dms
AWS > DMS > API Enabled
Configure whether the AWS DMS 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 > DMS > Enabled"]
{ "type": "string", "enum": [ "Enabled", "Disabled", "Enabled if AWS > DMS > Enabled" ], "default": "Enabled"}
AWS > DMS > Approved Regions [Default]
A list of AWS regions in which AWS DMS 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 DMS 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 > DMS > Enabled
Configure whether the AWS DMS service is enabled. This will only affect Turbot managed User Roles and will allow the Turbot managed user to access AWS DMS 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 > DMS > Endpoint > Active
Determine the action to take when an AWS DMS endpoint, based on the AWS > DMS > Endpoint > 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 > DMS > Endpoint > 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 > DMS > Endpoint > Active > Age
The age after which the AWS DMS endpoint 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 > DMS > Endpoint > 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 > DMS > Endpoint > Active > Last Modified
The number of days since the AWS DMS endpoint 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 > DMS > Endpoint > 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 > DMS > Endpoint > Approved
Determine the action to take when an AWS DMS endpoint is not approved based on AWS > DMS > Endpoint > 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 > DMS > Endpoint > Approved > Encryption at Rest
Define the Encryption at Rest settings required for AWS > DMS > Endpoint
.
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 > DMS > Endpoint > Encryption at Rest > *
),
raises an alarm, and takes the defined enforcement action
[ "None", "None or higher", "AWS SSE", "AWS SSE or higher", "Customer managed key", "Encryption at Rest > Customer Managed Key"]
{ "type": "string", "enum": [ "None", "None or higher", "AWS SSE", "AWS SSE or higher", "Customer managed key", "Encryption at Rest > Customer Managed Key" ], "example": [ "None or higher" ], "default": "None or higher"}
AWS > DMS > Endpoint > Approved > 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 > DMS > Endpoint > 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 > DMS > Endpoint > Approved > Regions
A list of AWS regions in which AWS DMS endpoints 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 DMS endpoint is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > DMS > Endpoint > Approved
policy.
See Approved for more information.
"{\n regions: policy(uri: \"tmod:@turbot/aws-dms#/policy/types/dmsApprovedRegionsDefault\")\n}\n"
"{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- '{{ item }}'\n{% endfor %}"
AWS > DMS > Endpoint > Approved > Usage
Determine whether the AWS DMS endpoint is allowed to exist.
This policy will be evaluated by the Approved control. If an AWS DMS endpoint is not approved, it will be subject to the action specified in the AWS > DMS > Endpoint > Approved
policy.
See Approved for more information.
[ "Not approved", "Approved", "Approved if AWS > DMS > Enabled"]
{ "type": "string", "enum": [ "Not approved", "Approved", "Approved if AWS > DMS > Enabled" ], "example": [ "Not approved" ], "default": "Approved if AWS > DMS > Enabled"}
AWS > DMS > Endpoint > CMDB
Configure whether to record and synchronize details for the AWS DMS endpoint 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 > DMS > Endpoint > 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 > DMS > Endpoint > Configured
Determine how to configure this resource.
Note: If the resource is managed by another stack, then the Skip/Check/Enforce values here are ignored and inherit from the stack that owns it
[ "Skip (unless claimed by a stack)", "Check: Per Configured > Source (unless claimed by a stack)", "Enforce: Per Configured > Source (unless claimed by a stack)"]
{ "enum": [ "Skip (unless claimed by a stack)", "Check: Per Configured > Source (unless claimed by a stack)", "Enforce: Per Configured > Source (unless claimed by a stack)" ], "default": "Skip (unless claimed by a stack)"}
AWS > DMS > Endpoint > Configured > Claim Precedence
An ordered list of who is allowed to claim a resource. A stack cannot claim a resource if it is already claimed by another stack at a higher level of precedence.
"{\n defaultPrecedence: policy(uri:\"tmod:@turbot/turbot#/policy/types/claimPrecedenceDefault\")\n}\n"
"{%- if $.defaultPrecedence | length == 0 %}[]{%- else %}{% for item in $.defaultPrecedence %}- '{{ item }}'{% endfor %}{% endif %}"
{ "type": "array", "items": { "type": "string" }}
AWS > DMS > Endpoint > Configured > Source
A HCL or JSON format Terraform configuration source used to configure this resource
{ "type": "string", "default": "", "x-schema-form": { "type": "code", "language": "hcl" }}
AWS > DMS > Endpoint > Regions
A list of AWS regions in which AWS DMS endpoints are supported for use.
Any endpoints 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-dms#/policy/types/dmsRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
AWS > DMS > Endpoint > Tags
Determine the action to take when an AWS DMS endpoint tags are not updated based on the AWS > DMS > Endpoint > Tags > *
policies.
The control ensure AWS DMS endpoint tags include tags defined in AWS > DMS > Endpoint > Tags > Template
.
Tags not defined in Endpoint 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 > DMS > Endpoint > Tags > Template
The template is used to generate the keys and values for AWS DMS endpoint.
Tags not defined in Endpoint 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-dms#/policy/types/dmsTagsTemplate\" 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 > DMS > Endpoint > Usage
Configure the number of AWS DMS endpoints 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 > DMS > Endpoint > 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 > DMS > Endpoint > Usage > Limit
Maximum number of items that can be created for this region.
{ "type": "integer", "minimum": 0, "default": 100}
AWS > DMS > Permissions
Configure whether permissions policies are in effect for AWS DMS.
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 > DMS > Enabled & AWS > DMS > API Enabled"]
{ "type": "string", "enum": [ "Enabled", "Disabled", "Enabled if AWS > DMS > Enabled & AWS > DMS > API Enabled" ], "example": [ "Enabled" ], "default": "Enabled if AWS > DMS > Enabled & AWS > DMS > API Enabled"}
AWS > DMS > 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 > DMS > 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 > DMS > Permissions > Lockdown
AWS > DMS > Permissions > Lockdown > API Boundary
Configure whether the AWS dms 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 > DMS > API Enabled"]
{ "type": "string", "enum": [ "Enabled if AWS > DMS > API Enabled" ], "example": [ "Enabled if AWS > DMS > API Enabled" ], "default": "Enabled if AWS > DMS > API Enabled"}
AWS > DMS > Regions
A list of AWS regions in which AWS DMS 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 DMS 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 > DMS > Replication Instance > Active
Determine the action to take when an AWS DMS replication instance, based on the AWS > DMS > Replication Instance > 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 > DMS > Replication Instance > 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 > DMS > Replication Instance > Active > Age
The age after which the AWS DMS replication instance 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 > DMS > Replication Instance > 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 > DMS > Replication Instance > Active > Budget
The impact of the budget state on the active control. This policy allows you to force
replicationInstances 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 > DMS > Replication Instance > 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 > DMS > Replication Instance > Active > Last Modified
The number of days since the AWS DMS replication instance 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 > DMS > Replication Instance > 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 > DMS > Replication Instance > Approved
Determine the action to take when an AWS DMS replication instance is not approved based on AWS > DMS > Replication Instance > 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 > DMS > Replication Instance > Approved > Budget
The policy allows you to set replication instances 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 DMS replication instance is not matched by the approved list, it will be subject to the action specified in the AWS > DMS > Replication Instance > 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 > DMS > Replication Instance > Approved > Encryption at Rest
Define the Encryption at Rest settings required for AWS > DMS > Replication Instance
.
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 > DMS > Replication Instance > Encryption at Rest > *
),
raises an alarm, and takes the defined enforcement action
[ "None", "None or higher", "AWS SSE", "AWS SSE or higher", "Customer managed key", "Encryption at Rest > Customer Managed Key"]
{ "type": "string", "enum": [ "None", "None or higher", "AWS SSE", "AWS SSE or higher", "Customer managed key", "Encryption at Rest > Customer Managed Key" ], "example": [ "None or higher" ], "default": "None or higher"}
AWS > DMS > Replication Instance > Approved > 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 > DMS > Replication Instance > 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 > DMS > Replication Instance > Approved > Regions
A list of AWS regions in which AWS DMS replication instances 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 DMS replication instance is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > DMS > Replication Instance > Approved
policy.
See Approved for more information.
"{\n regions: policy(uri: \"tmod:@turbot/aws-dms#/policy/types/dmsApprovedRegionsDefault\")\n}\n"
"{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- '{{ item }}'\n{% endfor %}"
AWS > DMS > Replication Instance > Approved > Usage
Determine whether the AWS DMS replication instance is allowed to exist.
This policy will be evaluated by the Approved control. If an AWS DMS replication instance is not approved, it will be subject to the action specified in the AWS > DMS > Replication Instance > Approved
policy.
See Approved for more information.
[ "Not approved", "Approved", "Approved if AWS > DMS > Enabled"]
{ "type": "string", "enum": [ "Not approved", "Approved", "Approved if AWS > DMS > Enabled" ], "example": [ "Not approved" ], "default": "Approved if AWS > DMS > Enabled"}
AWS > DMS > Replication Instance > CMDB
Configure whether to record and synchronize details for the AWS DMS replication instance 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 > DMS > Replication Instance > 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 > DMS > Replication Instance > Regions
A list of AWS regions in which AWS DMS replication instances are supported for use.
Any replication instances 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.
{ "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-3" ] } ]}
AWS > DMS > Replication Instance > Tags
Determine the action to take when an AWS DMS replication instance tags are not updated based on the AWS > DMS > Replication Instance > Tags > *
policies.
The control ensure AWS DMS replication instance tags include tags defined in AWS > DMS > Replication Instance > Tags > Template
.
Tags not defined in Replication Instance 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 > DMS > Replication Instance > Tags > Template
The template is used to generate the keys and values for AWS DMS replication instance.
Tags not defined in Replication Instance 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-dms#/policy/types/dmsTagsTemplate\" 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 > DMS > Replication Instance > Usage
Configure the number of AWS DMS replication instances 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 > DMS > Replication Instance > 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 > DMS > Replication Instance > Usage > Limit
Maximum number of items that can be created for this region.
{ "type": "integer", "minimum": 0, "default": 20}
AWS > DMS > Tags Template [Default]
A template used to generate the keys and values for AWS DMS resources.
By default, all DMS 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-dms
AWS DMS CloudWatch Events event sources for the Turbot Event Handlers.
{ "type": "array", "items": { "type": "string" }, "default": [ "aws.dms" ]}
AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-dms
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 > DMS > Permissions > Lockdown > API Boundary
policy
{ "type": "array"}
AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-dms
A calculated policy that Turbot uses to create a compiled list of ALL permissions for AWS DMS that is used as input to the stack that manages the Turbot IAM permissions objects.
AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-dms
A calculated policy that Turbot uses to create a compiled list of ALL permissions for AWS DMS that is used as input to the control that manages the IAM stack.