Interface Instance.Builder

    • Method Detail

      • fleetId

        Instance.Builder fleetId​(String fleetId)

        A unique identifier for the fleet that the instance belongs to.

        Parameters:
        fleetId - A unique identifier for the fleet that the instance belongs to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • fleetArn

        Instance.Builder fleetArn​(String fleetArn)

        The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

        Parameters:
        fleetArn - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • instanceId

        Instance.Builder instanceId​(String instanceId)

        A unique identifier for the instance.

        Parameters:
        instanceId - A unique identifier for the instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • ipAddress

        Instance.Builder ipAddress​(String ipAddress)

        IP address that is assigned to the instance.

        Parameters:
        ipAddress - IP address that is assigned to the instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • dnsName

        Instance.Builder dnsName​(String dnsName)

        The DNS identifier assigned to the instance that is running the game session. Values have the following format:

        When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

        Parameters:
        dnsName - The DNS identifier assigned to the instance that is running the game session. Values have the following format:

        When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

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

        Instance.Builder operatingSystem​(String operatingSystem)

        Operating system that is running on this EC2 instance.

        Parameters:
        operatingSystem - Operating system that is running on this EC2 instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        OperatingSystem, OperatingSystem
      • operatingSystem

        Instance.Builder operatingSystem​(OperatingSystem operatingSystem)

        Operating system that is running on this EC2 instance.

        Parameters:
        operatingSystem - Operating system that is running on this EC2 instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        OperatingSystem, OperatingSystem
      • type

        Instance.Builder type​(String type)

        EC2 instance type that defines the computing resources of this instance.

        Parameters:
        type - EC2 instance type that defines the computing resources of this instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EC2InstanceType, EC2InstanceType
      • type

        Instance.Builder type​(EC2InstanceType type)

        EC2 instance type that defines the computing resources of this instance.

        Parameters:
        type - EC2 instance type that defines the computing resources of this instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EC2InstanceType, EC2InstanceType
      • status

        Instance.Builder status​(String status)

        Current status of the instance. Possible statuses include the following:

        • PENDING -- The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.

        • ACTIVE -- The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.

        • TERMINATING -- The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.

        Parameters:
        status - Current status of the instance. Possible statuses include the following:

        • PENDING -- The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.

        • ACTIVE -- The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.

        • TERMINATING -- The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        InstanceStatus, InstanceStatus
      • status

        Instance.Builder status​(InstanceStatus status)

        Current status of the instance. Possible statuses include the following:

        • PENDING -- The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.

        • ACTIVE -- The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.

        • TERMINATING -- The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.

        Parameters:
        status - Current status of the instance. Possible statuses include the following:

        • PENDING -- The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.

        • ACTIVE -- The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.

        • TERMINATING -- The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        InstanceStatus, InstanceStatus
      • creationTime

        Instance.Builder creationTime​(Instant creationTime)

        A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        Parameters:
        creationTime - A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • location

        Instance.Builder location​(String location)

        The fleet location of the instance, expressed as an Amazon Web Services Region code, such as us-west-2.

        Parameters:
        location - The fleet location of the instance, expressed as an Amazon Web Services Region code, such as us-west-2.
        Returns:
        Returns a reference to this object so that method calls can be chained together.