Skip to content

Component

Source code in docs_src/capo_ssm_sap/types/component.py
class Component(TypedDict, closed=True):
    component_id: NotRequired["capo_ssm_sap.types.component_id.ComponentId"]
    """<p>The ID of the component.</p>"""
    sid: NotRequired["capo_ssm_sap.types.sid.SID"]
    """<p>The SAP System Identifier of the application component.</p>"""
    system_number: NotRequired[
        "capo_ssm_sap.types.sap_instance_number.SAPInstanceNumber"
    ]
    """<p>The SAP system number of the application component.</p>"""
    parent_component: NotRequired["capo_ssm_sap.types.component_id.ComponentId"]
    """<p>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.</p>"""
    child_components: NotRequired[
        "capo_ssm_sap.types.component_id_list.ComponentIdList"
    ]
    """<p>The child components of a highly available environment. For example, in a highly available SAP on AWS workload, the child component consists of the primary and secondar instances.</p>"""
    application_id: NotRequired["capo_ssm_sap.types.application_id.ApplicationId"]
    """<p>The ID of the application.</p>"""
    component_type: NotRequired["capo_ssm_sap.types.component_type.ComponentType"]
    """<p>The type of the component.</p>"""
    status: NotRequired["capo_ssm_sap.types.component_status.ComponentStatus"]
    """<p>The status of the component.</p> <ul> <li> <p>ACTIVATED - this status has been deprecated.</p> </li> <li> <p>STARTING - the component is in the process of being started.</p> </li> <li> <p>STOPPED - the component is not running.</p> </li> <li> <p>STOPPING - the component is in the process of being stopped.</p> </li> <li> <p>RUNNING - the component is running.</p> </li> <li> <p>RUNNING_WITH_ERROR - one or more child component(s) of the parent component is not running. Call <a href="https://docs.aws.amazon.com/ssmsap/latest/APIReference/API_GetComponent.html"> <code>GetComponent</code> </a> to review the status of each child component.</p> </li> <li> <p>UNDEFINED - AWS Systems Manager for SAP cannot provide the component status based on the discovered information. Verify your SAP application.</p> </li> </ul>"""
    sap_hostname: NotRequired["str"]
    """<p>The hostname of the component.</p>"""
    sap_feature: NotRequired["str"]
    """<p>The SAP feature of the component.</p>"""
    sap_kernel_version: NotRequired["str"]
    """<p>The kernel version of the component.</p>"""
    hdb_version: NotRequired["str"]
    """<p>The SAP HANA version of the component.</p>"""
    resilience: NotRequired["capo_ssm_sap.types.resilience.Resilience"]
    """<p>Details of the SAP HANA system replication for the component.</p>"""
    associated_host: NotRequired["capo_ssm_sap.types.associated_host.AssociatedHost"]
    """<p>The associated host of the component.</p>"""
    databases: NotRequired["capo_ssm_sap.types.database_id_list.DatabaseIdList"]
    """<p>The SAP HANA databases of the component.</p>"""
    hosts: NotRequired["capo_ssm_sap.types.host_list.HostList"]
    """<p>The hosts of the component.</p>"""
    primary_host: NotRequired["str"]
    """<p>The primary host of the component.</p>"""
    database_connection: NotRequired[
        "capo_ssm_sap.types.database_connection.DatabaseConnection"
    ]
    """<p>The connection specifications for the database of the component.</p>"""
    last_updated: NotRequired["datetime.datetime"]
    """<p>The time at which the component was last updated.</p>"""
    arn: NotRequired["capo_ssm_sap.types.ssm_sap_arn.SsmSapArn"]
    """<p>The Amazon Resource Name (ARN) of the component.</p>"""

application_id instance-attribute

application_id: NotRequired[ApplicationId]

The ID of the application.

arn instance-attribute

arn: NotRequired[SsmSapArn]

The Amazon Resource Name (ARN) of the component.

associated_host instance-attribute

associated_host: NotRequired[AssociatedHost]

The associated host of the component.

child_components instance-attribute

child_components: NotRequired[ComponentIdList]

The child components of a highly available environment. For example, in a highly available SAP on AWS workload, the child component consists of the primary and secondar instances.

component_id instance-attribute

component_id: NotRequired[ComponentId]

The ID of the component.

component_type instance-attribute

component_type: NotRequired[ComponentType]

The type of the component.

database_connection instance-attribute

database_connection: NotRequired[DatabaseConnection]

The connection specifications for the database of the component.

databases instance-attribute

databases: NotRequired[DatabaseIdList]

The SAP HANA databases of the component.

hdb_version instance-attribute

hdb_version: NotRequired[str]

The SAP HANA version of the component.

hosts instance-attribute

hosts: NotRequired[HostList]

The hosts of the component.

last_updated instance-attribute

last_updated: NotRequired[datetime]

The time at which the component was last updated.

parent_component instance-attribute

parent_component: NotRequired[ComponentId]

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.

primary_host instance-attribute

primary_host: NotRequired[str]

The primary host of the component.

resilience instance-attribute

resilience: NotRequired[Resilience]

Details of the SAP HANA system replication for the component.

sap_feature instance-attribute

sap_feature: NotRequired[str]

The SAP feature of the component.

sap_hostname instance-attribute

sap_hostname: NotRequired[str]

The hostname of the component.

sap_kernel_version instance-attribute

sap_kernel_version: NotRequired[str]

The kernel version of the component.

sid instance-attribute

sid: NotRequired[SID]

The SAP System Identifier of the application component.

status instance-attribute

status: NotRequired[ComponentStatus]

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.

system_number instance-attribute

system_number: NotRequired[SAPInstanceNumber]

The SAP system number of the application component.