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

Interface UpdateContainerFleetRequest.Builder

    • Method Detail

      • fleetId

        UpdateContainerFleetRequest.Builder fleetId​(String fleetId)

        A unique identifier for the container fleet to update. You can use either the fleet ID or ARN value.

        Parameters:
        fleetId - A unique identifier for the container fleet to update. You can use either the fleet ID or ARN value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • gameServerContainerGroupDefinitionName

        UpdateContainerFleetRequest.Builder gameServerContainerGroupDefinitionName​(String gameServerContainerGroupDefinitionName)

        The name or ARN value of a new game server container group definition to deploy on the fleet. If you're updating the fleet to a specific version of a container group definition, use the ARN value and include the version number. If you're updating the fleet to the latest version of a container group definition, you can use the name value. You can't remove a fleet's game server container group definition, you can only update or replace it with another definition.

        Update a container group definition by calling UpdateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource with an incremented version.

        Parameters:
        gameServerContainerGroupDefinitionName - The name or ARN value of a new game server container group definition to deploy on the fleet. If you're updating the fleet to a specific version of a container group definition, use the ARN value and include the version number. If you're updating the fleet to the latest version of a container group definition, you can use the name value. You can't remove a fleet's game server container group definition, you can only update or replace it with another definition.

        Update a container group definition by calling UpdateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource with an incremented version.

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

      • perInstanceContainerGroupDefinitionName

        UpdateContainerFleetRequest.Builder perInstanceContainerGroupDefinitionName​(String perInstanceContainerGroupDefinitionName)

        The name or ARN value of a new per-instance container group definition to deploy on the fleet. If you're updating the fleet to a specific version of a container group definition, use the ARN value and include the version number. If you're updating the fleet to the latest version of a container group definition, you can use the name value.

        Update a container group definition by calling UpdateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource with an incremented version.

        To remove a fleet's per-instance container group definition, leave this parameter empty and use the parameter RemoveAttributes.

        Parameters:
        perInstanceContainerGroupDefinitionName - The name or ARN value of a new per-instance container group definition to deploy on the fleet. If you're updating the fleet to a specific version of a container group definition, use the ARN value and include the version number. If you're updating the fleet to the latest version of a container group definition, you can use the name value.

        Update a container group definition by calling UpdateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource with an incremented version.

        To remove a fleet's per-instance container group definition, leave this parameter empty and use the parameter RemoveAttributes.

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

      • gameServerContainerGroupsPerInstance

        UpdateContainerFleetRequest.Builder gameServerContainerGroupsPerInstance​(Integer gameServerContainerGroupsPerInstance)

        The number of times to replicate the game server container group on each fleet instance. By default, Amazon GameLift calculates the maximum number of game server container groups that can fit on each instance. You can remove this property value to use the calculated value, or set it manually. If you set this number manually, Amazon GameLift uses your value as long as it's less than the calculated maximum.

        Parameters:
        gameServerContainerGroupsPerInstance - The number of times to replicate the game server container group on each fleet instance. By default, Amazon GameLift calculates the maximum number of game server container groups that can fit on each instance. You can remove this property value to use the calculated value, or set it manually. If you set this number manually, Amazon GameLift uses your value as long as it's less than the calculated maximum.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceConnectionPortRange

        UpdateContainerFleetRequest.Builder instanceConnectionPortRange​(ConnectionPortRange instanceConnectionPortRange)

        A revised set of port numbers to open on each fleet instance. By default, Amazon GameLift calculates an optimal port range based on your fleet configuration. If you previously set this parameter manually, you can't reset this to use the calculated settings.

        Parameters:
        instanceConnectionPortRange - A revised set of port numbers to open on each fleet instance. By default, Amazon GameLift calculates an optimal port range based on your fleet configuration. If you previously set this parameter manually, you can't reset this to use the calculated settings.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceInboundPermissionAuthorizations

        UpdateContainerFleetRequest.Builder instanceInboundPermissionAuthorizations​(Collection<IpPermission> instanceInboundPermissionAuthorizations)

        A set of ports to add to the container fleet's inbound permissions.

        Parameters:
        instanceInboundPermissionAuthorizations - A set of ports to add to the container fleet's inbound permissions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceInboundPermissionAuthorizations

        UpdateContainerFleetRequest.Builder instanceInboundPermissionAuthorizations​(IpPermission... instanceInboundPermissionAuthorizations)

        A set of ports to add to the container fleet's inbound permissions.

        Parameters:
        instanceInboundPermissionAuthorizations - A set of ports to add to the container fleet's inbound permissions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceInboundPermissionAuthorizations

        UpdateContainerFleetRequest.Builder instanceInboundPermissionAuthorizations​(Consumer<IpPermission.Builder>... instanceInboundPermissionAuthorizations)

        A set of ports to add to the container fleet's inbound permissions.

        This is a convenience method that creates an instance of the IpPermission.Builder avoiding the need to create one manually via IpPermission.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #instanceInboundPermissionAuthorizations(List).

        Parameters:
        instanceInboundPermissionAuthorizations - a consumer that will call methods on IpPermission.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #instanceInboundPermissionAuthorizations(java.util.Collection)

      • instanceInboundPermissionRevocations

        UpdateContainerFleetRequest.Builder instanceInboundPermissionRevocations​(Collection<IpPermission> instanceInboundPermissionRevocations)

        A set of ports to remove from the container fleet's inbound permissions.

        Parameters:
        instanceInboundPermissionRevocations - A set of ports to remove from the container fleet's inbound permissions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceInboundPermissionRevocations

        UpdateContainerFleetRequest.Builder instanceInboundPermissionRevocations​(IpPermission... instanceInboundPermissionRevocations)

        A set of ports to remove from the container fleet's inbound permissions.

        Parameters:
        instanceInboundPermissionRevocations - A set of ports to remove from the container fleet's inbound permissions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceInboundPermissionRevocations

        UpdateContainerFleetRequest.Builder instanceInboundPermissionRevocations​(Consumer<IpPermission.Builder>... instanceInboundPermissionRevocations)

        A set of ports to remove from the container fleet's inbound permissions.

        This is a convenience method that creates an instance of the IpPermission.Builder avoiding the need to create one manually via IpPermission.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #instanceInboundPermissionRevocations(List).

        Parameters:
        instanceInboundPermissionRevocations - a consumer that will call methods on IpPermission.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #instanceInboundPermissionRevocations(java.util.Collection)

      • deploymentConfiguration

        UpdateContainerFleetRequest.Builder deploymentConfiguration​(DeploymentConfiguration deploymentConfiguration)

        Instructions for how to deploy updates to a container fleet, if the fleet update initiates a deployment. The deployment configuration lets you determine how to replace fleet instances and what actions to take if the deployment fails.

        Parameters:
        deploymentConfiguration - Instructions for how to deploy updates to a container fleet, if the fleet update initiates a deployment. The deployment configuration lets you determine how to replace fleet instances and what actions to take if the deployment fails.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        UpdateContainerFleetRequest.Builder description​(String description)

        A meaningful description of the container fleet.

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

      • metricGroups

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

        The name of an Amazon Web Services CloudWatch metric group to add this fleet to.

        Parameters:
        metricGroups - The name of an Amazon Web Services CloudWatch metric group to add this fleet to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • metricGroups

        UpdateContainerFleetRequest.Builder metricGroups​(String... metricGroups)

        The name of an Amazon Web Services CloudWatch metric group to add this fleet to.

        Parameters:
        metricGroups - The name of an Amazon Web Services CloudWatch metric group to add this fleet to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • newGameSessionProtectionPolicy

        UpdateContainerFleetRequest.Builder newGameSessionProtectionPolicy​(String newGameSessionProtectionPolicy)

        The game session protection policy to apply to all new game sessions that are started in this fleet. Game sessions that already exist are not affected.

        Parameters:
        newGameSessionProtectionPolicy - The game session protection policy to apply to all new game sessions that are started in this fleet. Game sessions that already exist are not affected.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProtectionPolicy, ProtectionPolicy

      • newGameSessionProtectionPolicy

        UpdateContainerFleetRequest.Builder newGameSessionProtectionPolicy​(ProtectionPolicy newGameSessionProtectionPolicy)

        The game session protection policy to apply to all new game sessions that are started in this fleet. Game sessions that already exist are not affected.

        Parameters:
        newGameSessionProtectionPolicy - The game session protection policy to apply to all new game sessions that are started in this fleet. Game sessions that already exist are not affected.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProtectionPolicy, ProtectionPolicy

      • gameSessionCreationLimitPolicy

        UpdateContainerFleetRequest.Builder gameSessionCreationLimitPolicy​(GameSessionCreationLimitPolicy gameSessionCreationLimitPolicy)

        A policy that limits the number of game sessions that each individual player can create on instances in this fleet. The limit applies for a specified span of time.

        Parameters:
        gameSessionCreationLimitPolicy - A policy that limits the number of game sessions that each individual player can create on instances in this fleet. The limit applies for a specified span of time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • logConfiguration

        UpdateContainerFleetRequest.Builder logConfiguration​(LogConfiguration logConfiguration)

        The method for collecting container logs for the fleet.

        Parameters:
        logConfiguration - The method for collecting container logs for the fleet.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • removeAttributesWithStrings

        UpdateContainerFleetRequest.Builder removeAttributesWithStrings​(Collection<String> removeAttributes)

        If set, this update removes a fleet's per-instance container group definition. You can't remove a fleet's game server container group definition.

        Parameters:
        removeAttributes - If set, this update removes a fleet's per-instance container group definition. You can't remove a fleet's game server container group definition.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • removeAttributesWithStrings

        UpdateContainerFleetRequest.Builder removeAttributesWithStrings​(String... removeAttributes)

        If set, this update removes a fleet's per-instance container group definition. You can't remove a fleet's game server container group definition.

        Parameters:
        removeAttributes - If set, this update removes a fleet's per-instance container group definition. You can't remove a fleet's game server container group definition.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • removeAttributes

        UpdateContainerFleetRequest.Builder removeAttributes​(Collection<ContainerFleetRemoveAttribute> removeAttributes)

        If set, this update removes a fleet's per-instance container group definition. You can't remove a fleet's game server container group definition.

        Parameters:
        removeAttributes - If set, this update removes a fleet's per-instance container group definition. You can't remove a fleet's game server container group definition.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • removeAttributes

        UpdateContainerFleetRequest.Builder removeAttributes​(ContainerFleetRemoveAttribute... removeAttributes)

        If set, this update removes a fleet's per-instance container group definition. You can't remove a fleet's game server container group definition.

        Parameters:
        removeAttributes - If set, this update removes a fleet's per-instance container group definition. You can't remove a fleet's game server container group definition.
        Returns:
        Returns a reference to this object so that method calls can be chained together.