Policy types for @turbot/aws-datapipeline

• AWS > Data Pipeline > API Enabled
• AWS > Data Pipeline > Approved Regions [Default]
• AWS > Data Pipeline > Enabled
• AWS > Data Pipeline > Permissions
• AWS > Data Pipeline > Permissions > Levels
• AWS > Data Pipeline > Permissions > Levels > Modifiers
• AWS > Data Pipeline > Permissions > Lockdown
• AWS > Data Pipeline > Permissions > Lockdown > API Boundary
• AWS > Data Pipeline > Pipeline > Active
• AWS > Data Pipeline > Pipeline > Active > Age
• AWS > Data Pipeline > Pipeline > Active > Last Modified
• AWS > Data Pipeline > Pipeline > Approved
• AWS > Data Pipeline > Pipeline > Approved > Custom
• AWS > Data Pipeline > Pipeline > Approved > Regions
• AWS > Data Pipeline > Pipeline > Approved > Usage
• AWS > Data Pipeline > Pipeline > CMDB
• AWS > Data Pipeline > Pipeline > Regions
• AWS > Data Pipeline > Pipeline > Tags
• AWS > Data Pipeline > Pipeline > Tags > Template
• AWS > Data Pipeline > Regions
• AWS > Data Pipeline > Tags Template [Default]
• AWS > Turbot > Event Handlers > Events > Rules > Event Sources > @turbot/aws-datapipeline
• AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-datapipeline
• AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-datapipeline
• AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-datapipeline

AWS > Data Pipeline > API Enabled

Configure whether the AWS DataPipeline API is enabled.
Note: Disabling the service disables the API for ALL users and roles, and Guardrails will have no access to the API.

[
  "Enabled",
  "Disabled",
  "Enabled if AWS > DataPipeline > Enabled"
]

{
  "type": "string",
  "enum": [
    "Enabled",
    "Disabled",
    "Enabled if AWS > DataPipeline > Enabled"
  ],
  "default": "Enabled"
}

AWS > Data Pipeline > Approved Regions [Default]

A list of AWS regions in which AWS Data Pipeline 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 Data Pipeline 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 > Data Pipeline > Enabled

Enabled DataPipeline.

[
  "Enabled",
  "Enabled: Metadata Only",
  "Disabled"
]

{
  "type": "string",
  "enum": [
    "Enabled",
    "Enabled: Metadata Only",
    "Disabled"
  ],
  "example": [
    "Enabled"
  ],
  "default": "Disabled"
}

AWS > Data Pipeline > Permissions

Configure whether permissions policies are in effect for AWS DataPipeline.

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 > DataPipeline > Enabled & AWS > DataPipeline > API Enabled"
]

{
  "type": "string",
  "enum": [
    "Enabled",
    "Disabled",
    "Enabled if AWS > DataPipeline > Enabled & AWS > DataPipeline > API Enabled"
  ],
  "example": [
    "Enabled"
  ],
  "default": "Enabled if AWS > DataPipeline > Enabled & AWS > DataPipeline > API Enabled"
}

AWS > Data Pipeline > 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

[
  "{\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 > Data Pipeline > 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 /> - &quot;glacier:createvault&quot;: admin<br /> - &quot;glacier:ListVaults&quot;: metadata<br /> - &quot;s3:DeleteBucket&quot;: none<br />

AWS > Data Pipeline > Permissions > Lockdown

AWS > Data Pipeline > Permissions > Lockdown > API Boundary

Configure whether the AWS dataPipeline 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.

[
  "Enabled if AWS > DataPipeline > API Enabled"
]

{
  "type": "string",
  "enum": [
    "Enabled if AWS > DataPipeline > API Enabled"
  ],
  "example": [
    "Enabled if AWS > DataPipeline > API Enabled"
  ],
  "default": "Enabled if AWS > DataPipeline > API Enabled"
}

AWS > Data Pipeline > Pipeline > Active

Determine the action to take when an AWS Data Pipeline pipeline, based on the AWS > Data Pipeline > Pipeline > 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 > Data Pipeline > Pipeline > 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 > Data Pipeline > Pipeline > Active > Age

The age after which the AWS Data Pipeline pipeline
is no longer considered active. If a create time is unavailable, the time Guardrails 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 > Data Pipeline > Pipeline > 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 > Data Pipeline > Pipeline > Active > Last Modified

The number of days since the AWS Data Pipeline pipeline
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 > Data Pipeline > Pipeline > 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 > Data Pipeline > Pipeline > Approved

Determine the action to take when an AWS Data Pipeline pipeline is not approved based on AWS > Data Pipeline > Pipeline > 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 > Data Pipeline > Pipeline > Approved > Custom

Determine whether the AWS Data Pipeline pipeline is allowed to exist.
This policy will be evaluated by the Approved control. If an AWS Data Pipeline pipeline is not approved, it will be subject to the action specified in the AWS > Data Pipeline > Pipeline > 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 > Data Pipeline > Pipeline > Approved > Regions

A list of AWS regions in which AWS Data Pipeline pipelines 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 Data Pipeline pipeline is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > Data Pipeline > Pipeline > Approved policy.

See Approved for more information.

"{\n  regions: policy(uri: \"tmod:@turbot/aws-datapipeline#/policy/types/dataPipelineApprovedRegionsDefault\")\n}\n"

"{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- '{{ item }}'\n{% endfor %}"

AWS > Data Pipeline > Pipeline > Approved > Usage

Determine whether the AWS Data Pipeline pipeline is allowed to exist.

This policy will be evaluated by the Approved control. If an AWS Data Pipeline pipeline is not approved, it will be subject to the action specified in the AWS > Data Pipeline > Pipeline > Approved policy.

See Approved for more information.

[
  "Not approved",
  "Approved",
  "Approved if AWS > Data Pipeline > Enabled"
]

{
  "type": "string",
  "enum": [
    "Not approved",
    "Approved",
    "Approved if AWS > Data Pipeline > Enabled"
  ],
  "example": [
    "Not approved"
  ],
  "default": "Approved if AWS > Data Pipeline > Enabled"
}

AWS > Data Pipeline > Pipeline > CMDB

Configure whether to record and synchronize details for the AWS Data Pipeline pipeline 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 > Data Pipeline > Pipeline > 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 > Data Pipeline > Pipeline > Regions

A list of AWS regions in which AWS Data Pipeline pipelines are supported for use.

Any pipelines 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-datapipeline#/policy/types/dataPipelineRegionsDefault\") {\n    value\n  }\n}\n"

"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"

AWS > Data Pipeline > Pipeline > Tags

Determine the action to take when an AWS Data Pipeline pipeline tags are not updated based on the AWS > Data Pipeline > Pipeline > Tags > * policies.

The control ensure AWS Data Pipeline pipeline tags include tags defined in AWS > Data Pipeline > Pipeline > Tags > Template.

Tags not defined in Pipeline 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 > Data Pipeline > Pipeline > Tags > Template

The template is used to generate the keys and values for AWS Data Pipeline pipeline.

Tags not defined in Pipeline 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-datapipeline#/policy/types/dataPipelineTagsTemplate\" 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 > Data Pipeline > Regions

A list of AWS regions in which AWS Data Pipeline 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 Data Pipeline resources' Regions policies.

{
  "allOf": [
    {
      "$ref": "aws#/definitions/regionNameMatcherList"
    },
    {
      "default": [
        "ap-northeast-1",
        "ap-southeast-2",
        "eu-west-1",
        "us-east-1",
        "us-west-2"
      ]
    }
  ]
}

AWS > Data Pipeline > Tags Template [Default]

A template used to generate the keys and values for AWS DataPipeline resources.

By default, all DataPipeline 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-datapipeline

AWS Data Pipeline CloudWatch Events event sources for the Guardrails Event Handlers.

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "default": [
    "aws.datapipeline"
  ]
}

AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-datapipeline

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 the
AWS > DataPipeline > Permissions > Lockdown > API Boundary policy

{
  "type": "array"
}

AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-datapipeline

A calculated policy that Guardrails uses to create a compiled list of ALL permissions for AWS DataPipeline
that is used as input to the stack that manages the Guardrails IAM permissions objects.

AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-datapipeline

A calculated policy that Guardrails uses to create a compiled list of ALL permissions for AWS DataPipeline
that is used as input to the control that manages the IAM stack.