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

Interface ContainerFleet.Builder

    • Method Detail

      • fleetId

        ContainerFleet.Builder fleetId​(String fleetId)

        A unique identifier for the container fleet to retrieve.

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

      • fleetArn

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

      • fleetRoleArn

        ContainerFleet.Builder fleetRoleArn​(String fleetRoleArn)

        The unique identifier for an Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift. See Set up an IAM service role. This fleet property can't be changed.

        Parameters:
        fleetRoleArn - The unique identifier for an Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift. See Set up an IAM service role. This fleet property can't be changed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • gameServerContainerGroupDefinitionName

        ContainerFleet.Builder gameServerContainerGroupDefinitionName​(String gameServerContainerGroupDefinitionName)

        The name of the fleet's game server container group definition, which describes how to deploy containers with your game server build and support software onto each fleet instance.

        Parameters:
        gameServerContainerGroupDefinitionName - The name of the fleet's game server container group definition, which describes how to deploy containers with your game server build and support software onto each fleet instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • gameServerContainerGroupDefinitionArn

        ContainerFleet.Builder gameServerContainerGroupDefinitionArn​(String gameServerContainerGroupDefinitionArn)

        The Amazon Resource Name (ARN) that is assigned to the fleet's game server container group. The ARN value also identifies the specific container group definition version in use.

        Parameters:
        gameServerContainerGroupDefinitionArn - The Amazon Resource Name (ARN) that is assigned to the fleet's game server container group. The ARN value also identifies the specific container group definition version in use.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • perInstanceContainerGroupDefinitionName

        ContainerFleet.Builder perInstanceContainerGroupDefinitionName​(String perInstanceContainerGroupDefinitionName)

        The name of the fleet's per-instance container group definition.

        Parameters:
        perInstanceContainerGroupDefinitionName - The name of the fleet's per-instance container group definition.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • perInstanceContainerGroupDefinitionArn

        ContainerFleet.Builder perInstanceContainerGroupDefinitionArn​(String perInstanceContainerGroupDefinitionArn)

        The Amazon Resource Name (ARN) that is assigned to the fleet's per-instance container group. The ARN value also identifies the specific container group definition version in use.

        Parameters:
        perInstanceContainerGroupDefinitionArn - The Amazon Resource Name (ARN) that is assigned to the fleet's per-instance container group. The ARN value also identifies the specific container group definition version in use.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceConnectionPortRange

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

      • instanceInboundPermissions

        ContainerFleet.Builder instanceInboundPermissions​(Collection<IpPermission> instanceInboundPermissions)

        The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.

        Parameters:
        instanceInboundPermissions - The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceInboundPermissions

        ContainerFleet.Builder instanceInboundPermissions​(IpPermission... instanceInboundPermissions)

        The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.

        Parameters:
        instanceInboundPermissions - The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceInboundPermissions

        ContainerFleet.Builder instanceInboundPermissions​(Consumer<IpPermission.Builder>... instanceInboundPermissions)

        The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.

        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 #instanceInboundPermissions(List).

        Parameters:
        instanceInboundPermissions - 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:
        #instanceInboundPermissions(java.util.Collection)

      • gameServerContainerGroupsPerInstance

        ContainerFleet.Builder gameServerContainerGroupsPerInstance​(Integer gameServerContainerGroupsPerInstance)

        The number of times to replicate the game server container group on each fleet instance.

        Parameters:
        gameServerContainerGroupsPerInstance - The number of times to replicate the game server container group on each fleet instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maximumGameServerContainerGroupsPerInstance

        ContainerFleet.Builder maximumGameServerContainerGroupsPerInstance​(Integer maximumGameServerContainerGroupsPerInstance)

        The calculated maximum number of game server container group that can be deployed on each fleet instance. The calculation depends on the resource needs of the container group and the CPU and memory resources of the fleet's instance type.

        Parameters:
        maximumGameServerContainerGroupsPerInstance - The calculated maximum number of game server container group that can be deployed on each fleet instance. The calculation depends on the resource needs of the container group and the CPU and memory resources of the fleet's instance type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceType

        ContainerFleet.Builder instanceType​(String instanceType)

        The Amazon EC2 instance type to use for all instances in the fleet. Instance type determines the computing resources and processing power that's available to host your game servers. This includes including CPU, memory, storage, and networking capacity. You can't update this fleet property.

        Parameters:
        instanceType - The Amazon EC2 instance type to use for all instances in the fleet. Instance type determines the computing resources and processing power that's available to host your game servers. This includes including CPU, memory, storage, and networking capacity. You can't update this fleet property.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

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

      • creationTime

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

      • metricGroups

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

        The name of an Amazon Web Services CloudWatch metric group to add this fleet to. Metric groups aggregate metrics for multiple fleets.

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

      • metricGroups

        ContainerFleet.Builder metricGroups​(String... metricGroups)

        The name of an Amazon Web Services CloudWatch metric group to add this fleet to. Metric groups aggregate metrics for multiple fleets.

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

      • newGameSessionProtectionPolicy

        ContainerFleet.Builder newGameSessionProtectionPolicy​(String newGameSessionProtectionPolicy)

        Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using UpdateGameSession.

        • NoProtection -- Game sessions can be shut down during active gameplay.

        • FullProtection -- Game sessions in ACTIVE status can't be shut down.

        Parameters:
        newGameSessionProtectionPolicy - Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using UpdateGameSession.

        • NoProtection -- Game sessions can be shut down during active gameplay.

        • FullProtection -- Game sessions in ACTIVE status can't be shut down.

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

      • newGameSessionProtectionPolicy

        ContainerFleet.Builder newGameSessionProtectionPolicy​(ProtectionPolicy newGameSessionProtectionPolicy)

        Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using UpdateGameSession.

        • NoProtection -- Game sessions can be shut down during active gameplay.

        • FullProtection -- Game sessions in ACTIVE status can't be shut down.

        Parameters:
        newGameSessionProtectionPolicy - Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using UpdateGameSession.

        • NoProtection -- Game sessions can be shut down during active gameplay.

        • FullProtection -- Game sessions in ACTIVE status can't be shut down.

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

      • gameSessionCreationLimitPolicy

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

      • status

        ContainerFleet.Builder status​(String status)

        The current status of the container fleet.

        • PENDING -- A new container fleet has been requested.

        • CREATING -- A new container fleet resource is being created.

        • CREATED -- A new container fleet resource has been created. No fleet instances have been deployed.

        • ACTIVATING -- New container fleet instances are being deployed.

        • ACTIVE -- The container fleet has been deployed and is ready to host game sessions.

        • UPDATING -- Updates to the container fleet is being updated. A deployment is in progress.

        Parameters:
        status - The current status of the container fleet.

        • PENDING -- A new container fleet has been requested.

        • CREATING -- A new container fleet resource is being created.

        • CREATED -- A new container fleet resource has been created. No fleet instances have been deployed.

        • ACTIVATING -- New container fleet instances are being deployed.

        • ACTIVE -- The container fleet has been deployed and is ready to host game sessions.

        • UPDATING -- Updates to the container fleet is being updated. A deployment is in progress.

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

      • status

        ContainerFleet.Builder status​(ContainerFleetStatus status)

        The current status of the container fleet.

        • PENDING -- A new container fleet has been requested.

        • CREATING -- A new container fleet resource is being created.

        • CREATED -- A new container fleet resource has been created. No fleet instances have been deployed.

        • ACTIVATING -- New container fleet instances are being deployed.

        • ACTIVE -- The container fleet has been deployed and is ready to host game sessions.

        • UPDATING -- Updates to the container fleet is being updated. A deployment is in progress.

        Parameters:
        status - The current status of the container fleet.

        • PENDING -- A new container fleet has been requested.

        • CREATING -- A new container fleet resource is being created.

        • CREATED -- A new container fleet resource has been created. No fleet instances have been deployed.

        • ACTIVATING -- New container fleet instances are being deployed.

        • ACTIVE -- The container fleet has been deployed and is ready to host game sessions.

        • UPDATING -- Updates to the container fleet is being updated. A deployment is in progress.

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

      • deploymentDetails

        ContainerFleet.Builder deploymentDetails​(DeploymentDetails deploymentDetails)

        Information about the most recent deployment for the container fleet.

        Parameters:
        deploymentDetails - Information about the most recent deployment for the container fleet.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • logConfiguration

        ContainerFleet.Builder logConfiguration​(LogConfiguration logConfiguration)

        The method that is used to collect container logs for the fleet. Amazon GameLift saves all standard output for each container in logs, including game session logs.

        • CLOUDWATCH -- Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group.

        • S3 -- Store logs in an Amazon S3 bucket that you define.

        • NONE -- Don't collect container logs.

        Parameters:
        logConfiguration - The method that is used to collect container logs for the fleet. Amazon GameLift saves all standard output for each container in logs, including game session logs.

        • CLOUDWATCH -- Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group.

        • S3 -- Store logs in an Amazon S3 bucket that you define.

        • NONE -- Don't collect container logs.

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

      • locationAttributes

        ContainerFleet.Builder locationAttributes​(Collection<ContainerFleetLocationAttributes> locationAttributes)

        Information about the container fleet's remote locations where fleet instances are deployed.

        Parameters:
        locationAttributes - Information about the container fleet's remote locations where fleet instances are deployed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • locationAttributes

        ContainerFleet.Builder locationAttributes​(ContainerFleetLocationAttributes... locationAttributes)

        Information about the container fleet's remote locations where fleet instances are deployed.

        Parameters:
        locationAttributes - Information about the container fleet's remote locations where fleet instances are deployed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.