Skip to content

InstanceProperty

Source code in docs_src/capo_ssm/types/instance_property.py
class InstanceProperty(TypedDict, closed=True):
    name: NotRequired["capo_ssm.types.instance_name.InstanceName"]
    """<p>The value of the EC2 <code>Name</code> tag associated with the node. If a <code>Name</code> tag hasn't been applied to the node, this value is blank.</p>"""
    instance_id: NotRequired["capo_ssm.types.instance_id.InstanceId"]
    """<p>The ID of the managed node.</p>"""
    instance_type: NotRequired["capo_ssm.types.instance_type.InstanceType"]
    """<p>The instance type of the managed node. For example, t3.large.</p>"""
    instance_role: NotRequired["capo_ssm.types.instance_role.InstanceRole"]
    """<p>The instance profile attached to the node. If an instance profile isn't attached to the node, this value is blank.</p>"""
    key_name: NotRequired["capo_ssm.types.key_name.KeyName"]
    """<p>The name of the key pair associated with the node. If a key pair isnt't associated with the node, this value is blank.</p>"""
    instance_state: NotRequired["capo_ssm.types.instance_state.InstanceState"]
    """<p>The current state of the node.</p>"""
    architecture: NotRequired["capo_ssm.types.architecture.Architecture"]
    """<p>The CPU architecture of the node. For example, <code>x86_64</code>.</p>"""
    ip_address: NotRequired["capo_ssm.types.ip_address.IPAddress"]
    """<p>The public IPv4 address assigned to the node. If a public IPv4 address isn't assigned to the node, this value is blank.</p>"""
    launch_time: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The timestamp for when the node was launched.</p>"""
    ping_status: NotRequired["capo_ssm.types.ping_status.PingStatus"]
    """<p>Connection status of the SSM Agent on the managed node.</p>"""
    last_ping_date_time: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The date and time when the SSM Agent last pinged the Systems Manager service.</p>"""
    agent_version: NotRequired["capo_ssm.types.version.Version"]
    """<p>The version of SSM Agent running on your managed node.</p>"""
    platform_type: NotRequired["capo_ssm.types.platform_type.PlatformType"]
    """<p>The operating system platform type of the managed node. For example, Windows Server or Amazon Linux 2.</p>"""
    platform_name: NotRequired["capo_ssm.types.platform_name.PlatformName"]
    """<p>The name of the operating system platform running on your managed node.</p>"""
    platform_version: NotRequired["capo_ssm.types.platform_version.PlatformVersion"]
    """<p>The version of the OS platform running on your managed node.</p>"""
    activation_id: NotRequired["capo_ssm.types.activation_id.ActivationId"]
    """<p>The activation ID created by Systems Manager when the server or virtual machine (VM) was registered</p>"""
    iam_role: NotRequired["capo_ssm.types.iam_role.IamRole"]
    """<p>The IAM role used in the hybrid activation to register the node with Systems Manager.</p>"""
    registration_date: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The date the node was registered with Systems Manager.</p>"""
    resource_type: NotRequired["capo_ssm.types.string.String"]
    """<p>The type of managed node.</p>"""
    computer_name: NotRequired["capo_ssm.types.computer_name.ComputerName"]
    """<p>The fully qualified host name of the managed node.</p>"""
    association_status: NotRequired["capo_ssm.types.status_name.StatusName"]
    """<p>The status of the State Manager association applied to the managed node.</p>"""
    last_association_execution_date: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The date the association was last run.</p>"""
    last_successful_association_execution_date: NotRequired[
        "capo_ssm.types.date_time.DateTime"
    ]
    """<p>The last date the association was successfully run.</p>"""
    association_overview: NotRequired[
        "capo_ssm.types.instance_aggregated_association_overview.InstanceAggregatedAssociationOverview"
    ]
    source_id: NotRequired["capo_ssm.types.source_id.SourceId"]
    """<p>The ID of the source resource.</p>"""
    source_type: NotRequired["capo_ssm.types.source_type.SourceType"]
    """<p>The type of the source resource. Valid values: <code>AWS::EC2::Instance</code> | <code>AWS::SSM::ManagedInstance</code> | <code>AWS::IoT::Thing</code> | <code>Microsoft.Compute/virtualMachines</code>.</p>"""
    source_location: NotRequired["capo_ssm.types.source_location.SourceLocation"]
    """<p>The location of the source resource in the third-party cloud environment.</p>"""
    availability_zone: NotRequired["capo_ssm.types.availability_zone.AvailabilityZone"]
    """<p>The Availability Zone where the managed node is located.</p>"""

activation_id instance-attribute

activation_id: NotRequired[ActivationId]

The activation ID created by Systems Manager when the server or virtual machine (VM) was registered

agent_version instance-attribute

agent_version: NotRequired[Version]

The version of SSM Agent running on your managed node.

architecture instance-attribute

architecture: NotRequired[Architecture]

The CPU architecture of the node. For example, x86_64.

association_overview instance-attribute

association_overview: NotRequired[InstanceAggregatedAssociationOverview]

association_status instance-attribute

association_status: NotRequired[StatusName]

The status of the State Manager association applied to the managed node.

availability_zone instance-attribute

availability_zone: NotRequired[AvailabilityZone]

The Availability Zone where the managed node is located.

computer_name instance-attribute

computer_name: NotRequired[ComputerName]

The fully qualified host name of the managed node.

iam_role instance-attribute

iam_role: NotRequired[IamRole]

The IAM role used in the hybrid activation to register the node with Systems Manager.

instance_id instance-attribute

instance_id: NotRequired[InstanceId]

The ID of the managed node.

instance_role instance-attribute

instance_role: NotRequired[InstanceRole]

The instance profile attached to the node. If an instance profile isn't attached to the node, this value is blank.

instance_state instance-attribute

instance_state: NotRequired[InstanceState]

The current state of the node.

instance_type instance-attribute

instance_type: NotRequired[InstanceType]

The instance type of the managed node. For example, t3.large.

ip_address instance-attribute

ip_address: NotRequired[IPAddress]

The public IPv4 address assigned to the node. If a public IPv4 address isn't assigned to the node, this value is blank.

key_name instance-attribute

key_name: NotRequired[KeyName]

The name of the key pair associated with the node. If a key pair isnt't associated with the node, this value is blank.

last_association_execution_date instance-attribute

last_association_execution_date: NotRequired[DateTime]

The date the association was last run.

last_ping_date_time instance-attribute

last_ping_date_time: NotRequired[DateTime]

The date and time when the SSM Agent last pinged the Systems Manager service.

last_successful_association_execution_date instance-attribute

last_successful_association_execution_date: NotRequired[DateTime]

The last date the association was successfully run.

launch_time instance-attribute

launch_time: NotRequired[DateTime]

The timestamp for when the node was launched.

name instance-attribute

name: NotRequired[InstanceName]

The value of the EC2 Name tag associated with the node. If a Name tag hasn't been applied to the node, this value is blank.

ping_status instance-attribute

ping_status: NotRequired[PingStatus]

Connection status of the SSM Agent on the managed node.

platform_name instance-attribute

platform_name: NotRequired[PlatformName]

The name of the operating system platform running on your managed node.

platform_type instance-attribute

platform_type: NotRequired[PlatformType]

The operating system platform type of the managed node. For example, Windows Server or Amazon Linux 2.

platform_version instance-attribute

platform_version: NotRequired[PlatformVersion]

The version of the OS platform running on your managed node.

registration_date instance-attribute

registration_date: NotRequired[DateTime]

The date the node was registered with Systems Manager.

resource_type instance-attribute

resource_type: NotRequired[String]

The type of managed node.

source_id instance-attribute

source_id: NotRequired[SourceId]

The ID of the source resource.

source_location instance-attribute

source_location: NotRequired[SourceLocation]

The location of the source resource in the third-party cloud environment.

source_type instance-attribute

source_type: NotRequired[SourceType]

The type of the source resource. Valid values: AWS::EC2::Instance | AWS::SSM::ManagedInstance | AWS::IoT::Thing | Microsoft.Compute/virtualMachines.