Skip to content
AWS for Query.Farm

aws.ssm_sap.get_component

Example SQL Queries

SELECT * FROM
aws.ssm_sap.get_component
WHERE
"application_id" = 'VALUE'
AND "component_id" = 'VALUE';

Description

Gets the component of an application registered with AWS Systems Manager for SAP.

Table Definition

Column NameColumn Data Type
application_id Required Input Column

The ID of the application.

VARCHAR
component_id Required Input Column

The ID of the component.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
component

The component of an application registered with AWS Systems Manager for SAP.

STRUCT(
    "component_id" VARCHAR,
    "sid" VARCHAR,
    "system_number" VARCHAR,
    "parent_component" VARCHAR,
    "child_components" VARCHAR[],
    "application_id" VARCHAR,
    "component_type" VARCHAR,
    "status" VARCHAR,
    "sap_hostname" VARCHAR,
    "sap_feature" VARCHAR,
    "sap_kernel_version" VARCHAR,
    "hdb_version" VARCHAR,
    "resilience" STRUCT(
        "hsr_tier" VARCHAR,
        "hsr_replication_mode" VARCHAR,
        "hsr_operation_mode" VARCHAR,
        "cluster_status" VARCHAR,
        "enqueue_replication" BOOLEAN
    ),
    "associated_host" STRUCT(
        "hostname" VARCHAR,
        "ec2_instance_id" VARCHAR,
        "ip_addresses" STRUCT(
            "ip_address" VARCHAR,
            "primary" BOOLEAN,
            "allocation_type" VARCHAR
        )[],
        "os_version" VARCHAR
    ),
    "databases" VARCHAR[],
    "hosts" STRUCT(
        "host_name" VARCHAR,
        "host_ip" VARCHAR,
        "ec2_instance_id" VARCHAR,
        "instance_id" VARCHAR,
        "host_role" VARCHAR,
        "os_version" VARCHAR
    )[],
    "primary_host" VARCHAR,
    "database_connection" STRUCT(
        "database_connection_method" VARCHAR,
        "database_arn" VARCHAR,
        "connection_ip" VARCHAR
    ),
    "last_updated" TIMESTAMP_S,
    "arn" VARCHAR
)
Show child fields
component.application_id

The ID of the application.

component.arn

The Amazon Resource Name (ARN) of the component.

component.associated_host

The associated host of the component.

Show child fields
component.associated_host.ec2_instance_id

The ID of the Amazon EC2 instance.

component.associated_host.hostname

The name of the host.

component.associated_host.ip_addresses[]
Show child fields
component.associated_host.ip_addresses[].allocation_type

The type of allocation for the IP address.

component.associated_host.ip_addresses[].ip_address

The IP address.

component.associated_host.ip_addresses[].primary

The primary IP address.

component.associated_host.os_version

The version of the operating system.

component.child_components[]
component.component_id

The ID of the component.

component.component_type

The type of the component.

component.database_connection

The connection specifications for the database of the component.

Show child fields
component.database_connection.connection_ip

The IP address for connection.

component.database_connection.database_arn

The Amazon Resource Name of the connected SAP HANA database.

component.database_connection.database_connection_method

The method of connection.

component.databases[]
component.hdb_version

The SAP HANA version of the component.

component.hosts[]
Show child fields
component.hosts[].ec2_instance_id

The ID of Amazon EC2 instance.

component.hosts[].host_ip

The IP address of the Dedicated Host.

component.hosts[].host_name

The name of the Dedicated Host.

component.hosts[].host_role

The role of the Dedicated Host.

component.hosts[].instance_id

The instance ID of the instance on the Dedicated Host.

component.hosts[].os_version

The version of the operating system.

component.last_updated

The time at which the component was last updated.

component.parent_component

The parent component of a highly available environment. For example, in a highly available SAP on AWS workload, the parent component consists of the entire setup, including the child components.

component.primary_host

The primary host of the component.

component.resilience

Details of the SAP HANA system replication for the component.

Show child fields
component.resilience.cluster_status

The cluster status of the component.

component.resilience.enqueue_replication

Indicates if or not enqueue replication is enabled for the ASCS component.

component.resilience.hsr_operation_mode

The operation mode of the component.

component.resilience.hsr_replication_mode

The replication mode of the component.

component.resilience.hsr_tier

The tier of the component.

component.sap_feature

The SAP feature of the component.

component.sap_hostname

The hostname of the component.

component.sap_kernel_version

The kernel version of the component.

component.sid

The SAP System Identifier of the application component.

component.status

The status of the component.

  • ACTIVATED - this status has been deprecated.

  • STARTING - the component is in the process of being started.

  • STOPPED - the component is not running.

  • STOPPING - the component is in the process of being stopped.

  • RUNNING - the component is running.

  • RUNNING_WITH_ERROR - one or more child component(s) of the parent component is not running. Call GetComponent to review the status of each child component.

  • UNDEFINED - AWS Systems Manager for SAP cannot provide the component status based on the discovered information. Verify your SAP application.

component.system_number

The SAP system number of the application component.

tags

The tags of a component.

MAP(VARCHAR, VARCHAR)