Interface InstanceInformation.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<InstanceInformation.Builder,InstanceInformation>,SdkBuilder<InstanceInformation.Builder,InstanceInformation>,SdkPojo
- Enclosing class:
- InstanceInformation
public static interface InstanceInformation.Builder extends SdkPojo, CopyableBuilder<InstanceInformation.Builder,InstanceInformation>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description InstanceInformation.BuilderactivationId(String activationId)The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.InstanceInformation.BuilderagentVersion(String agentVersion)The version of SSM Agent running on your Linux managed node.default InstanceInformation.BuilderassociationOverview(Consumer<InstanceAggregatedAssociationOverview.Builder> associationOverview)Information about the association.InstanceInformation.BuilderassociationOverview(InstanceAggregatedAssociationOverview associationOverview)Information about the association.InstanceInformation.BuilderassociationStatus(String associationStatus)The status of the association.InstanceInformation.BuildercomputerName(String computerName)The fully qualified host name of the managed node.InstanceInformation.BuilderiamRole(String iamRole)The role assigned to an Amazon EC2 instance configured with a Systems Manager Quick Setup host management configuration or the role assigned to an on-premises managed node.InstanceInformation.BuilderinstanceId(String instanceId)The managed node ID.InstanceInformation.BuilderipAddress(String ipAddress)The IP address of the managed node.InstanceInformation.BuilderisLatestVersion(Boolean isLatestVersion)Indicates whether the latest version of SSM Agent is running on your Linux managed node.InstanceInformation.BuilderlastAssociationExecutionDate(Instant lastAssociationExecutionDate)The date the association was last run.InstanceInformation.BuilderlastPingDateTime(Instant lastPingDateTime)The date and time when the agent last pinged the Systems Manager service.InstanceInformation.BuilderlastSuccessfulAssociationExecutionDate(Instant lastSuccessfulAssociationExecutionDate)The last date the association was successfully run.InstanceInformation.Buildername(String name)The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is activated as a Systems Manager managed node.InstanceInformation.BuilderpingStatus(String pingStatus)Connection status of SSM Agent.InstanceInformation.BuilderpingStatus(PingStatus pingStatus)Connection status of SSM Agent.InstanceInformation.BuilderplatformName(String platformName)The name of the operating system platform running on your managed node.InstanceInformation.BuilderplatformType(String platformType)The operating system platform type.InstanceInformation.BuilderplatformType(PlatformType platformType)The operating system platform type.InstanceInformation.BuilderplatformVersion(String platformVersion)The version of the OS platform running on your managed node.InstanceInformation.BuilderregistrationDate(Instant registrationDate)The date the server or VM was registered with Amazon Web Services as a managed node.InstanceInformation.BuilderresourceType(String resourceType)The type of instance.InstanceInformation.BuilderresourceType(ResourceType resourceType)The type of instance.InstanceInformation.BuildersourceId(String sourceId)The ID of the source resource.InstanceInformation.BuildersourceType(String sourceType)The type of the source resource.InstanceInformation.BuildersourceType(SourceType sourceType)The type of the source resource.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
instanceId
InstanceInformation.Builder instanceId(String instanceId)
The managed node ID.
- Parameters:
instanceId- The managed node ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
pingStatus
InstanceInformation.Builder pingStatus(String pingStatus)
Connection status of SSM Agent.
The status
Inactivehas been deprecated and is no longer in use.- Parameters:
pingStatus- Connection status of SSM Agent.The status
Inactivehas been deprecated and is no longer in use.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PingStatus,PingStatus
-
pingStatus
InstanceInformation.Builder pingStatus(PingStatus pingStatus)
Connection status of SSM Agent.
The status
Inactivehas been deprecated and is no longer in use.- Parameters:
pingStatus- Connection status of SSM Agent.The status
Inactivehas been deprecated and is no longer in use.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PingStatus,PingStatus
-
lastPingDateTime
InstanceInformation.Builder lastPingDateTime(Instant lastPingDateTime)
The date and time when the agent last pinged the Systems Manager service.
- Parameters:
lastPingDateTime- The date and time when the agent last pinged the Systems Manager service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
agentVersion
InstanceInformation.Builder agentVersion(String agentVersion)
The version of SSM Agent running on your Linux managed node.
- Parameters:
agentVersion- The version of SSM Agent running on your Linux managed node.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isLatestVersion
InstanceInformation.Builder isLatestVersion(Boolean isLatestVersion)
Indicates whether the latest version of SSM Agent is running on your Linux managed node. This field doesn't indicate whether or not the latest version is installed on Windows managed nodes, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.
- Parameters:
isLatestVersion- Indicates whether the latest version of SSM Agent is running on your Linux managed node. This field doesn't indicate whether or not the latest version is installed on Windows managed nodes, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
platformType
InstanceInformation.Builder platformType(String platformType)
The operating system platform type.
- Parameters:
platformType- The operating system platform type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PlatformType,PlatformType
-
platformType
InstanceInformation.Builder platformType(PlatformType platformType)
The operating system platform type.
- Parameters:
platformType- The operating system platform type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PlatformType,PlatformType
-
platformName
InstanceInformation.Builder platformName(String platformName)
The name of the operating system platform running on your managed node.
- Parameters:
platformName- The name of the operating system platform running on your managed node.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
platformVersion
InstanceInformation.Builder platformVersion(String platformVersion)
The version of the OS platform running on your managed node.
- Parameters:
platformVersion- The version of the OS platform running on your managed node.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
activationId
InstanceInformation.Builder activationId(String activationId)
The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.
- Parameters:
activationId- The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iamRole
InstanceInformation.Builder iamRole(String iamRole)
The role assigned to an Amazon EC2 instance configured with a Systems Manager Quick Setup host management configuration or the role assigned to an on-premises managed node.
This call doesn't return the IAM role for unmanaged Amazon EC2 instances (instances not configured for Systems Manager). To retrieve the role for an unmanaged instance, use the Amazon EC2
DescribeInstancesoperation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.- Parameters:
iamRole- The role assigned to an Amazon EC2 instance configured with a Systems Manager Quick Setup host management configuration or the role assigned to an on-premises managed node.This call doesn't return the IAM role for unmanaged Amazon EC2 instances (instances not configured for Systems Manager). To retrieve the role for an unmanaged instance, use the Amazon EC2
DescribeInstancesoperation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
registrationDate
InstanceInformation.Builder registrationDate(Instant registrationDate)
The date the server or VM was registered with Amazon Web Services as a managed node.
- Parameters:
registrationDate- The date the server or VM was registered with Amazon Web Services as a managed node.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceType
InstanceInformation.Builder resourceType(String resourceType)
The type of instance. Instances are either EC2 instances or managed instances.
- Parameters:
resourceType- The type of instance. Instances are either EC2 instances or managed instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ResourceType,ResourceType
-
resourceType
InstanceInformation.Builder resourceType(ResourceType resourceType)
The type of instance. Instances are either EC2 instances or managed instances.
- Parameters:
resourceType- The type of instance. Instances are either EC2 instances or managed instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ResourceType,ResourceType
-
name
InstanceInformation.Builder name(String name)
The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is activated as a Systems Manager managed node. The name is specified as the
DefaultInstanceNameproperty using the CreateActivation command. It is applied to the managed node by specifying the Activation Code and Activation ID when you install SSM Agent on the node, as explained in How to install SSM Agent on hybrid Linux nodes and How to install SSM Agent on hybrid Windows Server nodes. To retrieve theNametag of an EC2 instance, use the Amazon EC2DescribeInstancesoperation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.- Parameters:
name- The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is activated as a Systems Manager managed node. The name is specified as theDefaultInstanceNameproperty using the CreateActivation command. It is applied to the managed node by specifying the Activation Code and Activation ID when you install SSM Agent on the node, as explained in How to install SSM Agent on hybrid Linux nodes and How to install SSM Agent on hybrid Windows Server nodes. To retrieve theNametag of an EC2 instance, use the Amazon EC2DescribeInstancesoperation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ipAddress
InstanceInformation.Builder ipAddress(String ipAddress)
The IP address of the managed node.
- Parameters:
ipAddress- The IP address of the managed node.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
computerName
InstanceInformation.Builder computerName(String computerName)
The fully qualified host name of the managed node.
- Parameters:
computerName- The fully qualified host name of the managed node.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
associationStatus
InstanceInformation.Builder associationStatus(String associationStatus)
The status of the association.
- Parameters:
associationStatus- The status of the association.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastAssociationExecutionDate
InstanceInformation.Builder lastAssociationExecutionDate(Instant lastAssociationExecutionDate)
The date the association was last run.
- Parameters:
lastAssociationExecutionDate- The date the association was last run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastSuccessfulAssociationExecutionDate
InstanceInformation.Builder lastSuccessfulAssociationExecutionDate(Instant lastSuccessfulAssociationExecutionDate)
The last date the association was successfully run.
- Parameters:
lastSuccessfulAssociationExecutionDate- The last date the association was successfully run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
associationOverview
InstanceInformation.Builder associationOverview(InstanceAggregatedAssociationOverview associationOverview)
Information about the association.
- Parameters:
associationOverview- Information about the association.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
associationOverview
default InstanceInformation.Builder associationOverview(Consumer<InstanceAggregatedAssociationOverview.Builder> associationOverview)
Information about the association.
This is a convenience method that creates an instance of theInstanceAggregatedAssociationOverview.Builderavoiding the need to create one manually viaInstanceAggregatedAssociationOverview.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toassociationOverview(InstanceAggregatedAssociationOverview).- Parameters:
associationOverview- a consumer that will call methods onInstanceAggregatedAssociationOverview.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
associationOverview(InstanceAggregatedAssociationOverview)
-
sourceId
InstanceInformation.Builder sourceId(String sourceId)
The ID of the source resource. For IoT Greengrass devices,
SourceIdis the Thing name.- Parameters:
sourceId- The ID of the source resource. For IoT Greengrass devices,SourceIdis the Thing name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceType
InstanceInformation.Builder sourceType(String sourceType)
The type of the source resource. For IoT Greengrass devices,
SourceTypeisAWS::IoT::Thing.- Parameters:
sourceType- The type of the source resource. For IoT Greengrass devices,SourceTypeisAWS::IoT::Thing.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
SourceType,SourceType
-
sourceType
InstanceInformation.Builder sourceType(SourceType sourceType)
The type of the source resource. For IoT Greengrass devices,
SourceTypeisAWS::IoT::Thing.- Parameters:
sourceType- The type of the source resource. For IoT Greengrass devices,SourceTypeisAWS::IoT::Thing.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
SourceType,SourceType
-
-