#[non_exhaustive]pub struct ContainerFleet {Show 22 fields
pub fleet_id: Option<String>,
pub fleet_arn: Option<String>,
pub fleet_role_arn: Option<String>,
pub game_server_container_group_definition_name: Option<String>,
pub game_server_container_group_definition_arn: Option<String>,
pub per_instance_container_group_definition_name: Option<String>,
pub per_instance_container_group_definition_arn: Option<String>,
pub instance_connection_port_range: Option<ConnectionPortRange>,
pub instance_inbound_permissions: Option<Vec<IpPermission>>,
pub game_server_container_groups_per_instance: Option<i32>,
pub maximum_game_server_container_groups_per_instance: Option<i32>,
pub instance_type: Option<String>,
pub billing_type: Option<ContainerFleetBillingType>,
pub description: Option<String>,
pub creation_time: Option<DateTime>,
pub metric_groups: Option<Vec<String>>,
pub new_game_session_protection_policy: Option<ProtectionPolicy>,
pub game_session_creation_limit_policy: Option<GameSessionCreationLimitPolicy>,
pub status: Option<ContainerFleetStatus>,
pub deployment_details: Option<DeploymentDetails>,
pub log_configuration: Option<LogConfiguration>,
pub location_attributes: Option<Vec<ContainerFleetLocationAttributes>>,
}Expand description
Describes an Amazon GameLift Servers managed container fleet.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.fleet_id: Option<String>A unique identifier for the container fleet to retrieve.
fleet_arn: Option<String>The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:. In a GameLift fleet ARN, the resource ID matches the FleetId value.
fleet_role_arn: Option<String>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 Servers. See Set up an IAM service role. This fleet property can't be changed.
game_server_container_group_definition_name: Option<String>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.
game_server_container_group_definition_arn: Option<String>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.
per_instance_container_group_definition_name: Option<String>The name of the fleet's per-instance container group definition.
per_instance_container_group_definition_arn: Option<String>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.
instance_connection_port_range: Option<ConnectionPortRange>The set of port numbers to open on each instance in a container fleet. Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.
instance_inbound_permissions: Option<Vec<IpPermission>>The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
game_server_container_groups_per_instance: Option<i32>The number of times to replicate the game server container group on each fleet instance.
maximum_game_server_container_groups_per_instance: Option<i32>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.
instance_type: Option<String>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.
billing_type: Option<ContainerFleetBillingType>Indicates whether the fleet uses On-Demand or Spot instances for this fleet. Learn more about when to use On-Demand versus Spot Instances. You can't update this fleet property.
By default, this property is set to ON_DEMAND.
description: Option<String>A meaningful description of the container fleet.
creation_time: Option<DateTime>A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
metric_groups: Option<Vec<String>>The name of an Amazon Web Services CloudWatch metric group to add this fleet to. Metric groups aggregate metrics for multiple fleets.
new_game_session_protection_policy: Option<ProtectionPolicy>Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift Servers 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
ACTIVEstatus can't be shut down.
game_session_creation_limit_policy: Option<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.
status: Option<ContainerFleetStatus>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.
deployment_details: Option<DeploymentDetails>Information about the most recent deployment for the container fleet.
log_configuration: Option<LogConfiguration>The method that is used to collect container logs for the fleet. Amazon GameLift Servers 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.
location_attributes: Option<Vec<ContainerFleetLocationAttributes>>Information about the container fleet's remote locations where fleet instances are deployed.
Implementations§
Source§impl ContainerFleet
impl ContainerFleet
Sourcepub fn fleet_id(&self) -> Option<&str>
pub fn fleet_id(&self) -> Option<&str>
A unique identifier for the container fleet to retrieve.
Sourcepub fn fleet_arn(&self) -> Option<&str>
pub fn fleet_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:. In a GameLift fleet ARN, the resource ID matches the FleetId value.
Sourcepub fn fleet_role_arn(&self) -> Option<&str>
pub fn fleet_role_arn(&self) -> Option<&str>
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 Servers. See Set up an IAM service role. This fleet property can't be changed.
Sourcepub fn game_server_container_group_definition_name(&self) -> Option<&str>
pub fn game_server_container_group_definition_name(&self) -> Option<&str>
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.
Sourcepub fn game_server_container_group_definition_arn(&self) -> Option<&str>
pub fn game_server_container_group_definition_arn(&self) -> Option<&str>
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.
Sourcepub fn per_instance_container_group_definition_name(&self) -> Option<&str>
pub fn per_instance_container_group_definition_name(&self) -> Option<&str>
The name of the fleet's per-instance container group definition.
Sourcepub fn per_instance_container_group_definition_arn(&self) -> Option<&str>
pub fn per_instance_container_group_definition_arn(&self) -> Option<&str>
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.
Sourcepub fn instance_connection_port_range(&self) -> Option<&ConnectionPortRange>
pub fn instance_connection_port_range(&self) -> Option<&ConnectionPortRange>
The set of port numbers to open on each instance in a container fleet. Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.
Sourcepub fn instance_inbound_permissions(&self) -> &[IpPermission]
pub fn instance_inbound_permissions(&self) -> &[IpPermission]
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .instance_inbound_permissions.is_none().
Sourcepub fn game_server_container_groups_per_instance(&self) -> Option<i32>
pub fn game_server_container_groups_per_instance(&self) -> Option<i32>
The number of times to replicate the game server container group on each fleet instance.
Sourcepub fn maximum_game_server_container_groups_per_instance(&self) -> Option<i32>
pub fn maximum_game_server_container_groups_per_instance(&self) -> Option<i32>
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.
Sourcepub fn instance_type(&self) -> Option<&str>
pub fn instance_type(&self) -> Option<&str>
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.
Sourcepub fn billing_type(&self) -> Option<&ContainerFleetBillingType>
pub fn billing_type(&self) -> Option<&ContainerFleetBillingType>
Indicates whether the fleet uses On-Demand or Spot instances for this fleet. Learn more about when to use On-Demand versus Spot Instances. You can't update this fleet property.
By default, this property is set to ON_DEMAND.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A meaningful description of the container fleet.
Sourcepub fn creation_time(&self) -> Option<&DateTime>
pub fn creation_time(&self) -> Option<&DateTime>
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Sourcepub fn metric_groups(&self) -> &[String]
pub fn metric_groups(&self) -> &[String]
The name of an Amazon Web Services CloudWatch metric group to add this fleet to. Metric groups aggregate metrics for multiple fleets.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .metric_groups.is_none().
Sourcepub fn new_game_session_protection_policy(&self) -> Option<&ProtectionPolicy>
pub fn new_game_session_protection_policy(&self) -> Option<&ProtectionPolicy>
Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift Servers 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
ACTIVEstatus can't be shut down.
Sourcepub fn game_session_creation_limit_policy(
&self,
) -> Option<&GameSessionCreationLimitPolicy>
pub fn game_session_creation_limit_policy( &self, ) -> Option<&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.
Sourcepub fn status(&self) -> Option<&ContainerFleetStatus>
pub fn status(&self) -> Option<&ContainerFleetStatus>
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.
Sourcepub fn deployment_details(&self) -> Option<&DeploymentDetails>
pub fn deployment_details(&self) -> Option<&DeploymentDetails>
Information about the most recent deployment for the container fleet.
Sourcepub fn log_configuration(&self) -> Option<&LogConfiguration>
pub fn log_configuration(&self) -> Option<&LogConfiguration>
The method that is used to collect container logs for the fleet. Amazon GameLift Servers 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.
Sourcepub fn location_attributes(&self) -> &[ContainerFleetLocationAttributes]
pub fn location_attributes(&self) -> &[ContainerFleetLocationAttributes]
Information about the container fleet's remote locations where fleet instances are deployed.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .location_attributes.is_none().
Source§impl ContainerFleet
impl ContainerFleet
Sourcepub fn builder() -> ContainerFleetBuilder
pub fn builder() -> ContainerFleetBuilder
Creates a new builder-style object to manufacture ContainerFleet.
Trait Implementations§
Source§impl Clone for ContainerFleet
impl Clone for ContainerFleet
Source§fn clone(&self) -> ContainerFleet
fn clone(&self) -> ContainerFleet
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ContainerFleet
impl Debug for ContainerFleet
Source§impl PartialEq for ContainerFleet
impl PartialEq for ContainerFleet
impl StructuralPartialEq for ContainerFleet
Auto Trait Implementations§
impl Freeze for ContainerFleet
impl RefUnwindSafe for ContainerFleet
impl Send for ContainerFleet
impl Sync for ContainerFleet
impl Unpin for ContainerFleet
impl UnwindSafe for ContainerFleet
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);