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

Class ContainerFleet

    • Method Detail

      • fleetId

        public final String fleetId()

        A unique identifier for the container fleet to retrieve.

        Returns:
        A unique identifier for the container fleet to retrieve.

      • fleetArn

        public final 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.

        Returns:
        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.

      • fleetRoleArn

        public final 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.

        Returns:
        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.

      • gameServerContainerGroupDefinitionName

        public final 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.

        Returns:
        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.

      • gameServerContainerGroupDefinitionArn

        public final 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.

        Returns:
        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.

      • perInstanceContainerGroupDefinitionName

        public final String perInstanceContainerGroupDefinitionName()

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

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

      • perInstanceContainerGroupDefinitionArn

        public final 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.

        Returns:
        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.

      • instanceConnectionPortRange

        public final ConnectionPortRange instanceConnectionPortRange()
        Returns the value of the InstanceConnectionPortRange property for this object.
        Returns:
        The value of the InstanceConnectionPortRange property for this object.

      • hasInstanceInboundPermissions

        public final boolean hasInstanceInboundPermissions()
        For responses, this returns true if the service returned a value for the InstanceInboundPermissions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • instanceInboundPermissions

        public final List<IpPermission> instanceInboundPermissions()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstanceInboundPermissions() method.

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

      • gameServerContainerGroupsPerInstance

        public final Integer gameServerContainerGroupsPerInstance()

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

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

      • maximumGameServerContainerGroupsPerInstance

        public final 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.

        Returns:
        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.

      • instanceType

        public final 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.

        Returns:
        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.

      • description

        public final String description()

        A meaningful description of the container fleet.

        Returns:
        A meaningful description of the container fleet.

      • creationTime

        public final 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").

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

      • hasMetricGroups

        public final boolean hasMetricGroups()
        For responses, this returns true if the service returned a value for the MetricGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • metricGroups

        public final List<String> metricGroups()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetricGroups() method.

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

      • newGameSessionProtectionPolicy

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, newGameSessionProtectionPolicy will return ProtectionPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from newGameSessionProtectionPolicyAsString().

        Returns:
        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.

        See Also:
        ProtectionPolicy

      • newGameSessionProtectionPolicyAsString

        public final String newGameSessionProtectionPolicyAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, newGameSessionProtectionPolicy will return ProtectionPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from newGameSessionProtectionPolicyAsString().

        Returns:
        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.

        See Also:
        ProtectionPolicy

      • gameSessionCreationLimitPolicy

        public final 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.

        Returns:
        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.

      • status

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, status will return ContainerFleetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        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.

        See Also:
        ContainerFleetStatus

      • statusAsString

        public final String statusAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, status will return ContainerFleetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        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.

        See Also:
        ContainerFleetStatus

      • deploymentDetails

        public final DeploymentDetails deploymentDetails()

        Information about the most recent deployment for the container fleet.

        Returns:
        Information about the most recent deployment for the container fleet.

      • logConfiguration

        public final 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.

        Returns:
        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.

      • hasLocationAttributes

        public final boolean hasLocationAttributes()
        For responses, this returns true if the service returned a value for the LocationAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • locationAttributes

        public final List<ContainerFleetLocationAttributes> locationAttributes()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLocationAttributes() method.

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

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)