Package software.amazon.awssdk.services.gamelift.model

Interface FleetAttributes.Builder

    • Method Detail

      • fleetId

        FleetAttributes.Builder fleetId​(String fleetId)

        A unique identifier for the fleet.

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

      • fleetArn

        FleetAttributes.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. In a GameLift fleet ARN, the resource ID matches the FleetId value.

        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. In a GameLift fleet ARN, the resource ID matches the FleetId value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • fleetType

        FleetAttributes.Builder fleetType​(String fleetType)

        Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.

        Parameters:
        fleetType - Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        FleetType, FleetType

      • fleetType

        FleetAttributes.Builder fleetType​(FleetType fleetType)

        Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.

        Parameters:
        fleetType - Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        FleetType, FleetType

      • instanceType

        FleetAttributes.Builder instanceType​(String instanceType)

        The Amazon EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.

        Parameters:
        instanceType - The Amazon EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EC2InstanceType, EC2InstanceType

      • description

        FleetAttributes.Builder description​(String description)

        A human-readable description of the fleet.

        Parameters:
        description - A human-readable description of the fleet.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        FleetAttributes.Builder name​(String name)

        A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

        Parameters:
        name - A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationTime

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

      • terminationTime

        FleetAttributes.Builder terminationTime​(Instant terminationTime)

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

        Parameters:
        terminationTime - A time stamp indicating when this data object was terminated. 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.

      • status

        FleetAttributes.Builder status​(String status)

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

        • NEW -- A new fleet has been defined and desired instances is set to 1.

        • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

        • ACTIVE -- Hosts can now accept game sessions.

        • ERROR -- An error occurred when downloading, validating, building, or activating the fleet.

        • DELETING -- Hosts are responding to a delete fleet request.

        • TERMINATED -- The fleet no longer exists.

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

        • NEW -- A new fleet has been defined and desired instances is set to 1.

        • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

        • ACTIVE -- Hosts can now accept game sessions.

        • ERROR -- An error occurred when downloading, validating, building, or activating the fleet.

        • DELETING -- Hosts are responding to a delete fleet request.

        • TERMINATED -- The fleet no longer exists.

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

      • status

        FleetAttributes.Builder status​(FleetStatus status)

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

        • NEW -- A new fleet has been defined and desired instances is set to 1.

        • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

        • ACTIVE -- Hosts can now accept game sessions.

        • ERROR -- An error occurred when downloading, validating, building, or activating the fleet.

        • DELETING -- Hosts are responding to a delete fleet request.

        • TERMINATED -- The fleet no longer exists.

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

        • NEW -- A new fleet has been defined and desired instances is set to 1.

        • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

        • ACTIVE -- Hosts can now accept game sessions.

        • ERROR -- An error occurred when downloading, validating, building, or activating the fleet.

        • DELETING -- Hosts are responding to a delete fleet request.

        • TERMINATED -- The fleet no longer exists.

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

      • buildId

        FleetAttributes.Builder buildId​(String buildId)

        A unique identifier for the build resource that is deployed on instances in this fleet.

        Parameters:
        buildId - A unique identifier for the build resource that is deployed on instances in this fleet.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • buildArn

        FleetAttributes.Builder buildArn​(String buildArn)

        The Amazon Resource Name (ARN) associated with the Amazon GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

        Parameters:
        buildArn - The Amazon Resource Name (ARN) associated with the Amazon GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • scriptId

        FleetAttributes.Builder scriptId​(String scriptId)

        A unique identifier for the Realtime script resource that is deployed on instances in this fleet.

        Parameters:
        scriptId - A unique identifier for the Realtime script resource that is deployed on instances in this fleet.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • scriptArn

        FleetAttributes.Builder scriptArn​(String scriptArn)

        The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

        Parameters:
        scriptArn - The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serverLaunchPath

        FleetAttributes.Builder serverLaunchPath​(String serverLaunchPath)

        This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration . Requests that use this parameter instead continue to be valid.

        Parameters:
        serverLaunchPath - This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration . Requests that use this parameter instead continue to be valid.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serverLaunchParameters

        FleetAttributes.Builder serverLaunchParameters​(String serverLaunchParameters)

        This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime configuration . Requests that use this parameter instead continue to be valid.

        Parameters:
        serverLaunchParameters - This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime configuration . Requests that use this parameter instead continue to be valid.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • logPaths

        FleetAttributes.Builder logPaths​(Collection<String> logPaths)

        This parameter is no longer used. Game session log paths are now defined using the Amazon GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.

        Parameters:
        logPaths - This parameter is no longer used. Game session log paths are now defined using the Amazon GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • logPaths

        FleetAttributes.Builder logPaths​(String... logPaths)

        This parameter is no longer used. Game session log paths are now defined using the Amazon GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.

        Parameters:
        logPaths - This parameter is no longer used. Game session log paths are now defined using the Amazon GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • newGameSessionProtectionPolicy

        FleetAttributes.Builder newGameSessionProtectionPolicy​(String newGameSessionProtectionPolicy)

        The type of game session protection to set on all new instances that are started in the fleet.

        • NoProtection -- The game session can be terminated during a scale-down event.

        • FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

        Parameters:
        newGameSessionProtectionPolicy - The type of game session protection to set on all new instances that are started in the fleet.

        • NoProtection -- The game session can be terminated during a scale-down event.

        • FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

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

      • newGameSessionProtectionPolicy

        FleetAttributes.Builder newGameSessionProtectionPolicy​(ProtectionPolicy newGameSessionProtectionPolicy)

        The type of game session protection to set on all new instances that are started in the fleet.

        • NoProtection -- The game session can be terminated during a scale-down event.

        • FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

        Parameters:
        newGameSessionProtectionPolicy - The type of game session protection to set on all new instances that are started in the fleet.

        • NoProtection -- The game session can be terminated during a scale-down event.

        • FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

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

      • operatingSystem

        FleetAttributes.Builder operatingSystem​(String operatingSystem)

        The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.

        Parameters:
        operatingSystem - The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        OperatingSystem, OperatingSystem

      • operatingSystem

        FleetAttributes.Builder operatingSystem​(OperatingSystem operatingSystem)

        The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.

        Parameters:
        operatingSystem - The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        OperatingSystem, OperatingSystem

      • resourceCreationLimitPolicy

        FleetAttributes.Builder resourceCreationLimitPolicy​(ResourceCreationLimitPolicy resourceCreationLimitPolicy)
        Sets the value of the ResourceCreationLimitPolicy property for this object.
        Parameters:
        resourceCreationLimitPolicy - The new value for the ResourceCreationLimitPolicy property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • metricGroups

        FleetAttributes.Builder metricGroups​(Collection<String> metricGroups)

        Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group at a time.

        Parameters:
        metricGroups - Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group at a time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • metricGroups

        FleetAttributes.Builder metricGroups​(String... metricGroups)

        Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group at a time.

        Parameters:
        metricGroups - Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group at a time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stoppedActionsWithStrings

        FleetAttributes.Builder stoppedActionsWithStrings​(Collection<String> stoppedActions)

        A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.

        Parameters:
        stoppedActions - A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stoppedActionsWithStrings

        FleetAttributes.Builder stoppedActionsWithStrings​(String... stoppedActions)

        A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.

        Parameters:
        stoppedActions - A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stoppedActions

        FleetAttributes.Builder stoppedActions​(Collection<FleetAction> stoppedActions)

        A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.

        Parameters:
        stoppedActions - A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stoppedActions

        FleetAttributes.Builder stoppedActions​(FleetAction... stoppedActions)

        A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.

        Parameters:
        stoppedActions - A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceRoleArn

        FleetAttributes.Builder instanceRoleArn​(String instanceRoleArn)

        A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to. For more information about using the role with your game server builds, see Communicate with other Amazon Web Services resources from your fleets.

        Parameters:
        instanceRoleArn - A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to. For more information about using the role with your game server builds, see Communicate with other Amazon Web Services resources from your fleets.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • certificateConfiguration

        FleetAttributes.Builder certificateConfiguration​(CertificateConfiguration certificateConfiguration)
        Sets the value of the CertificateConfiguration property for this object.
        Parameters:
        certificateConfiguration - The new value for the CertificateConfiguration property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • computeType

        FleetAttributes.Builder computeType​(String computeType)

        The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.

        Parameters:
        computeType - The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ComputeType, ComputeType

      • computeType

        FleetAttributes.Builder computeType​(ComputeType computeType)

        The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.

        Parameters:
        computeType - The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ComputeType, ComputeType

      • anywhereConfiguration

        FleetAttributes.Builder anywhereConfiguration​(AnywhereConfiguration anywhereConfiguration)
        Sets the value of the AnywhereConfiguration property for this object.
        Parameters:
        anywhereConfiguration - The new value for the AnywhereConfiguration property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceRoleCredentialsProvider

        FleetAttributes.Builder instanceRoleCredentialsProvider​(String instanceRoleCredentialsProvider)

        Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn. Shared credentials allow applications that are deployed with the game server executable to communicate with other Amazon Web Services resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets.

        Parameters:
        instanceRoleCredentialsProvider - Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn. Shared credentials allow applications that are deployed with the game server executable to communicate with other Amazon Web Services resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        InstanceRoleCredentialsProvider, InstanceRoleCredentialsProvider

      • instanceRoleCredentialsProvider

        FleetAttributes.Builder instanceRoleCredentialsProvider​(InstanceRoleCredentialsProvider instanceRoleCredentialsProvider)

        Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn. Shared credentials allow applications that are deployed with the game server executable to communicate with other Amazon Web Services resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets.

        Parameters:
        instanceRoleCredentialsProvider - Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn. Shared credentials allow applications that are deployed with the game server executable to communicate with other Amazon Web Services resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        InstanceRoleCredentialsProvider, InstanceRoleCredentialsProvider