Product logo
DocsBlogPricing

Policy types for @turbot/aws-transfer

AWS > Transfer for SFTP > API Enabled

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

URI
tmod:@turbot/aws-transfer#/policy/types/transferApiEnabled
Category
Parent
Targets
Valid Value
[
  "Enabled",
  "Disabled",
  "Enabled if AWS > Transfer for SFTP > Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled",
    "Disabled",
    "Enabled if AWS > Transfer for SFTP > Enabled"
  ],
  "default": "Enabled"
}

AWS > Transfer for SFTP > Approved Regions [Default]

A list of AWS regions in which AWS Transfer for SFTP 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 Transfer for SFTP resources' Approved > Regions policies.

URI
tmod:@turbot/aws-transfer#/policy/types/transferApprovedRegionsDefault
Category
Parent
Targets
Schema

AWS > Transfer for SFTP > Enabled

Enabled Transfer for SFTP.

URI
tmod:@turbot/aws-transfer#/policy/types/transferEnabled
Category
Parent
Targets
Valid Value
[
  "Enabled",
  "Enabled: Metadata Only",
  "Disabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled",
    "Enabled: Metadata Only",
    "Disabled"
  ],
  "example": [
    "Enabled"
  ],
  "default": "Disabled"
}

AWS > Transfer for SFTP > Permissions

Configure whether permissions policies are in effect for AWS Transfer for SFTP.

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.

URI
tmod:@turbot/aws-transfer#/policy/types/transferPermissions
Category
Parent
Targets
Valid Value
[
  "Enabled",
  "Disabled",
  "Enabled if AWS > Transfer for SFTP > Enabled & AWS > Transfer for SFTP > API Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled",
    "Disabled",
    "Enabled if AWS > Transfer for SFTP > Enabled & AWS > Transfer for SFTP > API Enabled"
  ],
  "example": [
    "Enabled"
  ],
  "default": "Enabled if AWS > Transfer for SFTP > Enabled & AWS > Transfer for SFTP > API Enabled"
}

AWS > Transfer for SFTP > 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

URI
tmod:@turbot/aws-transfer#/policy/types/transferPermissionsLevels
Category
Parent
Targets
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "Metadata",
      "ReadOnly",
      "Operator",
      "Admin",
      "Owner"
    ]
  }
}

AWS > Transfer for SFTP > 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
URI
tmod:@turbot/aws-transfer#/policy/types/transferPermissionsLevelsModifiers
Category
Parent
Targets
Schema

AWS > Transfer for SFTP > Permissions > Lockdown

URI
tmod:@turbot/aws-transfer#/policy/types/transferPermissionsLockdown
Category
Parent
Targets

AWS > Transfer for SFTP > Permissions > Lockdown > API Boundary

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

URI
tmod:@turbot/aws-transfer#/policy/types/transferPermissionsLockdownApiBoundary
Category
Parent
Targets
Valid Value
[
  "Enabled if AWS > Transfer for SFTP > API Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled if AWS > Transfer for SFTP > API Enabled"
  ],
  "example": [
    "Enabled if AWS > Transfer for SFTP > API Enabled"
  ],
  "default": "Enabled if AWS > Transfer for SFTP > API Enabled"
}

AWS > Transfer for SFTP > Regions

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

URI
tmod:@turbot/aws-transfer#/policy/types/transferRegionsDefault
Category
Parent
Targets
Schema
{
  "allOf": [
    {
      "$ref": "aws#/definitions/regionNameMatcherList"
    },
    {
      "default": [
        "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",
        "sa-east-1",
        "us-east-1",
        "us-east-2",
        "us-west-1",
        "us-west-2"
      ]
    }
  ]
}

AWS > Transfer for SFTP > Tags Template [Default]

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

By default, all Transfer for SFTP resource Tags > Template policies will use this value.

URI
tmod:@turbot/aws-transfer#/policy/types/transferTagsTemplate
Category
Parent
Targets
Schema

AWS > Turbot > Event Handlers > Events > Rules > Event Sources > @turbot/aws-transfer

AWS Transfer for SFTP CloudWatch Events event sources for the Turbot Event Handlers.

URI
tmod:@turbot/aws-transfer#/policy/types/transferEventSources
Category
Parent
Targets
Schema
{
  "type": "array",
  "items": {
    "type": "string"
  },
  "default": [
    "aws.transfer"
  ]
}

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

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 > Transfer for SFTP > Permissions > Lockdown > API Boundary policy

URI
tmod:@turbot/aws-transfer#/policy/types/awsCompiledApiBoundary
Category
Parent
Targets
Schema
{
  "type": "array"
}

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

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

URI
tmod:@turbot/aws-transfer#/policy/types/awsLevelsCompiled
Category
Parent
Targets
Schema

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

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

URI
tmod:@turbot/aws-transfer#/policy/types/awsCompiledServicePermissions
Category
Parent
Targets
Schema