« blib/lib/Paws/SSM/InstanceAssociationStatusInfo.pm
↑ Summary
blib/lib/Paws/SSM/InstanceInformationFilter.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SSM::InstanceInformation; | ||
| 3 | use Moose; | ||
| 4 | has ActivationId => (is => 'ro', isa => 'Str'); | ||
| 5 | has AgentVersion => (is => 'ro', isa => 'Str'); | ||
| 6 | has AssociationOverview => (is => 'ro', isa => 'Paws::SSM::InstanceAggregatedAssociationOverview'); | ||
| 7 | has AssociationStatus => (is => 'ro', isa => 'Str'); | ||
| 8 | has ComputerName => (is => 'ro', isa => 'Str'); | ||
| 9 | has IamRole => (is => 'ro', isa => 'Str'); | ||
| 10 | has InstanceId => (is => 'ro', isa => 'Str'); | ||
| 11 | has IPAddress => (is => 'ro', isa => 'Str'); | ||
| 12 | has IsLatestVersion => (is => 'ro', isa => 'Bool'); | ||
| 13 | has LastAssociationExecutionDate => (is => 'ro', isa => 'Str'); | ||
| 14 | has LastPingDateTime => (is => 'ro', isa => 'Str'); | ||
| 15 | has LastSuccessfulAssociationExecutionDate => (is => 'ro', isa => 'Str'); | ||
| 16 | has Name => (is => 'ro', isa => 'Str'); | ||
| 17 | has PingStatus => (is => 'ro', isa => 'Str'); | ||
| 18 | has PlatformName => (is => 'ro', isa => 'Str'); | ||
| 19 | has PlatformType => (is => 'ro', isa => 'Str'); | ||
| 20 | has PlatformVersion => (is => 'ro', isa => 'Str'); | ||
| 21 | has RegistrationDate => (is => 'ro', isa => 'Str'); | ||
| 22 | has ResourceType => (is => 'ro', isa => 'Str'); | ||
| 23 | |||
| 24 | 1; | ||
| 25 | |||
| 26 | ### main pod documentation begin ### | ||
| 27 | |||
| 28 | =head1 NAME | ||
| 29 | |||
| 30 | Paws::SSM::InstanceInformation | ||
| 31 | |||
| 32 | =head1 USAGE | ||
| 33 | |||
| 34 | This class represents one of two things: | ||
| 35 | |||
| 36 | =head3 Arguments in a call to a service | ||
| 37 | |||
| 38 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 39 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 40 | |||
| 41 | As an example, if Att1 is expected to be a Paws::SSM::InstanceInformation object: | ||
| 42 | |||
| 43 | $service_obj->Method(Att1 => { ActivationId => $value, ..., ResourceType => $value }); | ||
| 44 | |||
| 45 | =head3 Results returned from an API call | ||
| 46 | |||
| 47 | Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::InstanceInformation object: | ||
| 48 | |||
| 49 | $result = $service_obj->Method(...); | ||
| 50 | $result->Att1->ActivationId | ||
| 51 | |||
| 52 | =head1 DESCRIPTION | ||
| 53 | |||
| 54 | Describes a filter for a specific list of instances. | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 ActivationId => Str | ||
| 60 | |||
| 61 | The activation ID created by Systems Manager when the server or VM was | ||
| 62 | registered. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 AgentVersion => Str | ||
| 66 | |||
| 67 | The version of SSM Agent running on your Linux instance. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 AssociationOverview => L<Paws::SSM::InstanceAggregatedAssociationOverview> | ||
| 71 | |||
| 72 | Information about the association. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 AssociationStatus => Str | ||
| 76 | |||
| 77 | The status of the association. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 ComputerName => Str | ||
| 81 | |||
| 82 | The fully qualified host name of the managed instance. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 IamRole => Str | ||
| 86 | |||
| 87 | The Amazon Identity and Access Management (IAM) role assigned to the | ||
| 88 | on-premises Systems Manager managed instance. This call does not return | ||
| 89 | the IAM role for EC2 instances. To retrieve the IAM role for an EC2 | ||
| 90 | instance, use the Amazon EC2 C<DescribeInstances> action. For | ||
| 91 | information, see DescribeInstances | ||
| 92 | (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) | ||
| 93 | in the I<Amazon EC2 API Reference> or describe-instances | ||
| 94 | (https://docs.aws.amazon.com/cli/latest/ec2/describe-instances.html) in | ||
| 95 | the I<AWS CLI Command Reference>. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 InstanceId => Str | ||
| 99 | |||
| 100 | The instance ID. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 IPAddress => Str | ||
| 104 | |||
| 105 | The IP address of the managed instance. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 IsLatestVersion => Bool | ||
| 109 | |||
| 110 | Indicates whether the latest version of SSM Agent is running on your | ||
| 111 | Linux Managed Instance. This field does not indicate whether or not the | ||
| 112 | latest version is installed on Windows managed instances, because some | ||
| 113 | older versions of Windows Server use the EC2Config service to process | ||
| 114 | SSM requests. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 LastAssociationExecutionDate => Str | ||
| 118 | |||
| 119 | The date the association was last run. | ||
| 120 | |||
| 121 | |||
| 122 | =head2 LastPingDateTime => Str | ||
| 123 | |||
| 124 | The date and time when the agent last pinged the Systems Manager | ||
| 125 | service. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 LastSuccessfulAssociationExecutionDate => Str | ||
| 129 | |||
| 130 | The last date the association was successfully run. | ||
| 131 | |||
| 132 | |||
| 133 | =head2 Name => Str | ||
| 134 | |||
| 135 | The name assigned to an on-premises server or virtual machine (VM) when | ||
| 136 | it is activated as a Systems Manager managed instance. The name is | ||
| 137 | specified as the C<DefaultInstanceName> property using the | ||
| 138 | CreateActivation command. It is applied to the managed instance by | ||
| 139 | specifying the Activation Code and Activation ID when you install SSM | ||
| 140 | Agent on the instance, as explained in Install SSM Agent for a hybrid | ||
| 141 | environment (Linux) | ||
| 142 | (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-linux.html) | ||
| 143 | and Install SSM Agent for a hybrid environment (Windows) | ||
| 144 | (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-win.html). | ||
| 145 | To retrieve the Name tag of an EC2 instance, use the Amazon EC2 | ||
| 146 | C<DescribeInstances> action. For information, see DescribeInstances | ||
| 147 | (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) | ||
| 148 | in the I<Amazon EC2 API Reference> or describe-instances | ||
| 149 | (https://docs.aws.amazon.com/cli/latest/ec2/describe-instances.html) in | ||
| 150 | the I<AWS CLI Command Reference>. | ||
| 151 | |||
| 152 | |||
| 153 | =head2 PingStatus => Str | ||
| 154 | |||
| 155 | Connection status of SSM Agent. | ||
| 156 | |||
| 157 | The status C<Inactive> has been deprecated and is no longer in use. | ||
| 158 | |||
| 159 | |||
| 160 | =head2 PlatformName => Str | ||
| 161 | |||
| 162 | The name of the operating system platform running on your instance. | ||
| 163 | |||
| 164 | |||
| 165 | =head2 PlatformType => Str | ||
| 166 | |||
| 167 | The operating system platform type. | ||
| 168 | |||
| 169 | |||
| 170 | =head2 PlatformVersion => Str | ||
| 171 | |||
| 172 | The version of the OS platform running on your instance. | ||
| 173 | |||
| 174 | |||
| 175 | =head2 RegistrationDate => Str | ||
| 176 | |||
| 177 | The date the server or VM was registered with AWS as a managed | ||
| 178 | instance. | ||
| 179 | |||
| 180 | |||
| 181 | =head2 ResourceType => Str | ||
| 182 | |||
| 183 | The type of instance. Instances are either EC2 instances or managed | ||
| 184 | instances. | ||
| 185 | |||
| 186 | |||
| 187 | |||
| 188 | =head1 SEE ALSO | ||
| 189 | |||
| 190 | This class forms part of L<Paws>, describing an object used in L<Paws::SSM> | ||
| 191 | |||
| 192 | =head1 BUGS and CONTRIBUTIONS | ||
| 193 | |||
| 194 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 195 | |||
| 196 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 197 | |||
| 198 | =cut | ||
| 199 |