software.amazon.awssdk.services.ssm.model

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

Modifier and Type	Method and Description
InstanceInformation.Builder	activationId(String activationId) The activation ID created by Systems Manager when the server or VM was registered.
InstanceInformation.Builder	agentVersion(String agentVersion) The version of SSM Agent running on your Linux instance.
default InstanceInformation.Builder	associationOverview(Consumer<InstanceAggregatedAssociationOverview.Builder> associationOverview) Information about the association.
InstanceInformation.Builder	associationOverview(InstanceAggregatedAssociationOverview associationOverview) Information about the association.
InstanceInformation.Builder	associationStatus(String associationStatus) The status of the association.
InstanceInformation.Builder	computerName(String computerName) The fully qualified host name of the managed instance.
InstanceInformation.Builder	iamRole(String iamRole) The Amazon Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instance.
InstanceInformation.Builder	instanceId(String instanceId) The instance ID.
InstanceInformation.Builder	ipAddress(String ipAddress) The IP address of the managed instance.
InstanceInformation.Builder	isLatestVersion(Boolean isLatestVersion) Indicates whether the latest version of SSM Agent is running on your Linux Managed Instance.
InstanceInformation.Builder	lastAssociationExecutionDate(Instant lastAssociationExecutionDate) The date the association was last run.
InstanceInformation.Builder	lastPingDateTime(Instant lastPingDateTime) The date and time when the agent last pinged the Systems Manager service.
InstanceInformation.Builder	lastSuccessfulAssociationExecutionDate(Instant lastSuccessfulAssociationExecutionDate) The last date the association was successfully run.
InstanceInformation.Builder	name(String name) The name assigned to an on-premises server or virtual machine (VM) when it is activated as a Systems Manager managed instance.
InstanceInformation.Builder	pingStatus(PingStatus pingStatus) Connection status of SSM Agent.
InstanceInformation.Builder	pingStatus(String pingStatus) Connection status of SSM Agent.
InstanceInformation.Builder	platformName(String platformName) The name of the operating system platform running on your instance.
InstanceInformation.Builder	platformType(PlatformType platformType) The operating system platform type.
InstanceInformation.Builder	platformType(String platformType) The operating system platform type.
InstanceInformation.Builder	platformVersion(String platformVersion) The version of the OS platform running on your instance.
InstanceInformation.Builder	registrationDate(Instant registrationDate) The date the server or VM was registered with AWS as a managed instance.
InstanceInformation.Builder	resourceType(ResourceType resourceType) The type of instance.
InstanceInformation.Builder	resourceType(String resourceType) The type of instance.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

instanceId

InstanceInformation.Builder instanceId(String instanceId)

The instance ID.

Parameters:

instanceId - The instance 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 Inactive has been deprecated and is no longer in use.

Parameters:

pingStatus - Connection status of SSM Agent.

The status Inactive has 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 Inactive has been deprecated and is no longer in use.

Parameters:

pingStatus - Connection status of SSM Agent.

The status Inactive has 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 instance.

Parameters:

agentVersion - The version of SSM Agent running on your Linux instance.

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 Instance. This field does not indicate whether or not the latest version is installed on Windows managed instances, because some older versions of Windows Server use the EC2Config service to process SSM requests.

Parameters:

isLatestVersion - Indicates whether the latest version of SSM Agent is running on your Linux Managed Instance. This field does not indicate whether or not the latest version is installed on Windows managed instances, because some older versions of Windows Server use the EC2Config service to process SSM 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 instance.

Parameters:

platformName - The name of the operating system platform running on your instance.

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 instance.

Parameters:

platformVersion - The version of the OS platform running on your instance.

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 Systems Manager when the server or VM was registered.

Parameters:

activationId - The activation ID created by Systems Manager when the server or 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 Amazon Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instance. This call does not return the IAM role for EC2 instances. To retrieve the IAM role for an EC2 instance, use the Amazon EC2 DescribeInstances action. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the AWS CLI Command Reference.

Parameters:

iamRole - The Amazon Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instance. This call does not return the IAM role for EC2 instances. To retrieve the IAM role for an EC2 instance, use the Amazon EC2 DescribeInstances action. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the AWS 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 AWS as a managed instance.

Parameters:

registrationDate - The date the server or VM was registered with AWS as a managed instance.

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 or virtual machine (VM) when it is activated as a Systems Manager managed instance. The name is specified as the DefaultInstanceName property using the CreateActivation command. It is applied to the managed instance by specifying the Activation Code and Activation ID when you install SSM Agent on the instance, as explained in Install SSM Agent for a hybrid environment (Linux) and Install SSM Agent for a hybrid environment (Windows). To retrieve the Name tag of an EC2 instance, use the Amazon EC2 DescribeInstances action. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the AWS CLI Command Reference.

Parameters:

name - The name assigned to an on-premises server or virtual machine (VM) when it is activated as a Systems Manager managed instance. The name is specified as the DefaultInstanceName property using the CreateActivation command. It is applied to the managed instance by specifying the Activation Code and Activation ID when you install SSM Agent on the instance, as explained in Install SSM Agent for a hybrid environment (Linux) and Install SSM Agent for a hybrid environment (Windows). To retrieve the Name tag of an EC2 instance, use the Amazon EC2 DescribeInstances action. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the AWS 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 instance.

Parameters:

ipAddress - The IP address of the managed instance.

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 instance.

Parameters:

computerName - The fully qualified host name of the managed instance.

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 that creates an instance of the InstanceAggregatedAssociationOverview.Builder avoiding the need to create one manually via InstanceAggregatedAssociationOverview.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to associationOverview(InstanceAggregatedAssociationOverview).

Parameters:

associationOverview - a consumer that will call methods on InstanceAggregatedAssociationOverview.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

associationOverview(InstanceAggregatedAssociationOverview)