AWS Transfer Family Server pattern-based discovery

  • Release version: Yokohama
  • Updated May 13, 2026
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of AWS Transfer Family Server pattern-based discovery

    The AWS Transfer Family Server pattern-based discovery enables ServiceNow customers to discover AWS Transfer Family Servers within their cloud environment using the Discovery and Service Mapping Patterns application. This functionality helps maintain accurate and up-to-date configuration management database (CMDB) records by identifying AWS Transfer Family Server resources and their attributes.

    Show full answer Show less

    Prerequisites and Setup

    • AWS Discovery Requirements: Customers must ensure AWS discovery prerequisites are met as detailed in the Amazon AWS Cloud components discovery documentation.
    • Resource Inclusion List: Verify that relevant AWS Transfer Family Server resources are not listed in the Resource Inclusion List table ([sacloudinventoryresourcewhitelist]) to prevent duplicate discoveries.
    • Enable the Pattern: The AWS Transfer Family Server discovery pattern is disabled by default. Starting with Visibility Content version 6.28.0, enabling or disabling this pattern is treated as a standard update action rather than a customization. After upgrades, patterns reset to the latest predefined version while preserving their last active state.

    Data Collection and Storage

    The discovery process populates data in both CMDB and non-CMDB tables:

    • Non-CMDB Tables: Running the "Amazon AWS - Transfer Family Server - Extended Inventory (LP)" pattern populates non-CMDB AWS-specific tables. These can be accessed via the ServiceNow navigation under All > Configuration > AWS.
    • CMDB Tables: The same pattern also populates core CMDB tables, specifically the cmdbawstransferfamilyserver and cmdbcicmpresource tables, which store server details and cloud resource metadata.

    Key Data Fields Captured

    • AWS Transfer Family Server Table: Includes the server ID, Amazon Resource Name (ARN), endpoint type (PUBLIC, VPC, or VPCENDPOINT), identity provider type (such as SERVICEMANAGED or AWSDIRECTORYSERVICE), server state (e.g., ONLINE, OFFLINE), user count, logging role ARN, and configuration item references.
    • Cloud Resource Table: Captures resource type (AWS::TransferFamily::Server), install status (default Installed), operational status (default Operational), and links to the server ID and ARN.
    • Key-Value Table for Tags: AWS tags associated with the server are collected and stored in the cmdbkeyvalue table, linked to the corresponding cloud resource.

    CI Relationships and References

    The discovery pattern establishes relationships such as the cloud resource being hosted on an AWS Datacenter, supporting comprehensive service mapping and impact analysis. Some references link directly to other configuration items without appearing in the CI Relationship table, enabling detailed tracking and resource association.

    Practical Benefits for ServiceNow Customers

    • Automates discovery and inventory of AWS Transfer Family Servers, ensuring CMDB accuracy.
    • Supports operational insight through detailed server states and user counts.
    • Enables integration of AWS Transfer Family Server data with other AWS and ServiceNow components for holistic cloud management.
    • Facilitates tag-based organization and filtering through automatic AWS tag collection.
    • Ensures discovery patterns remain current and manageable through pattern activation policies.

    Discovery and Service Mapping Patterns finds AWS Transfer Family Servers on your cloud environment. Discovering some of these resources may require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.

    Pattern-based discovery and mapping requirements

    Verify the AWS discovery prerequisites
    For more information, see the prerequisites section in Amazon AWS Cloud components discovery using patterns.
    Remove resources from the Resource Inclusion List table
    Verify that the relevant resource isn't listed in the Resource Inclusion List [sa_cloud_inventory_resource_whitelist] table to avoid duplicate discovery. For more information on removing resources from the Resource Inclusion List, see Amazon Web Services (AWS) Resource Inventory.
    Enable the relevant pattern
    The pattern for this service is disabled by default. Starting with Visibility Content version 6.28.0, activating or deactivating a pattern won't be considered a customization, and it will continue to receive updates. Patterns that were previously activated or deactivated will reset to the latest predefined version after upgrading while retaining the last active field value. For more information on enabling patterns, see Activate a disabled pattern.

    Discovery and Service Mapping Patterns application populates data in both CMDB and non-CMDB tables.

    Data stored in non-CMDB tables

    Discovery and Service Mapping Patterns application populates data in the non-CMDB table when running the Amazon AWS - Transfer Family Server - Extended Inventory (LP) pattern.

    You can review the non-CMDB AWS tables by navigating to All > Configuration > AWS. You can also search the navigation filter for the specific pattern name.

    Table 1. AWS Transfer Family Server [cmdb_aws_transfer_family_server]
    Field Description
    Name [name] The server ID, used as the display name.
    Object ID [object_id] The Amazon Resource Name (ARN) of the server.
    Server ID [server_id] The unique identifier of the Transfer Family server.
    Endpoint Type [endpoint_type] The type of endpoint for the server. The value is PUBLIC, VPC, or VPC_ENDPOINT.
    Identity Provider Type [identity_provider_type] The mode of authentication for the server.

    For example: SERVICE_MANAGED, API_GATEWAY, AWS_DIRECTORY_SERVICE, or AWS_LAMBDA.
    State [state] The current state of the server.

    For example: ONLINE, OFFLINE, STARTING, STOPPING, START_FAILED, or STOP_FAILED.
    User Count [user_count] The number of users assigned to the server.
    Logging Role [logging_role] The ARN of the IAM role used to write transfer activity to Amazon CloudWatch Logs.
    Configuration Item [configuration_item] References the Cloud Resource [cmdb_ci_cmp_resource] table.

    Data stored in CMDB tables

    Discovery and Service Mapping Patterns application populates data in the CMDB when running the Amazon AWS - Transfer Family Server - Extended Inventory (LP) pattern.

    Table 2. Cloud Resource [cmdb_ci_cmp_resource]
    Field Description
    Name [name] The server ID, used as the display name.
    Object ID [object_id] The ARN of the server.
    Resource type [resource_type] Type of resource. The value is set to AWS::TransferFamily::Server.
    Install Status [install_status] Install status of the resource. Default value is Installed.
    Operational status [operational_status] Operational status of the resource. Default value is Operational.

    CI relationships

    The Amazon AWS - Transfer Family Server - Extended Inventory (LP) pattern creates the following relationships and references to support AWS Transfer Family Server discovery. References link to records in other tables and don't appear in the CI Relationship [cmdb_rel_ci] table.

    Table 3. CI relationships
    CI Relationship CI
    Cloud Resource [cmdb_ci_cmp_resource] Hosted on::Hosts AWS Datacenter [cmdb_ci_aws_datacenter]
    Table 4. CI references
    CI Field Referenced CI
    AWS Transfer Family Server [cmdb_aws_transfer_family_server] Configuration Item [configuration_item] Cloud Resource [cmdb_ci_cmp_resource]
    Key Value [cmdb_key_value] Configuration item [configuration_item] Cloud Resource [cmdb_ci_cmp_resource]

    AWS Tag discovery

    The Amazon AWS - Transfer Family Server - Extended Inventory (LP) pattern collects tags and populates them in the Key Value [cmdb_key_value] table.

    Table 5. Key Value [cmdb_key_value]
    Field Description
    Key [key] Tag name.
    Value [value] Tag value.
    Configuration item [configuration_item] References the Cloud Resource [cmdb_ci_cmp_resource] table.