#[non_exhaustive]pub struct GameServerContainerDefinitionInput {
pub container_name: Option<String>,
pub depends_on: Option<Vec<ContainerDependency>>,
pub mount_points: Option<Vec<ContainerMountPoint>>,
pub environment_override: Option<Vec<ContainerEnvironment>>,
pub image_uri: Option<String>,
pub port_configuration: Option<ContainerPortConfiguration>,
pub server_sdk_version: Option<String>,
}
Expand description
Describes the configuration for a container that runs your game server executable. This definition includes container configuration, resources, and start instructions. Use this data type when creating or updating a game server container group definition. For properties of a deployed container, see GameServerContainerDefinition. A game server container is automatically considered essential; if an essential container fails, the entire container group restarts.
Use with: CreateContainerGroupDefinition, UpdateContainerGroupDefinition
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.container_name: Option<String>
A string that uniquely identifies the container definition within a container group.
depends_on: Option<Vec<ContainerDependency>>
Establishes dependencies between this container and the status of other containers in the same container group. A container can have dependencies on multiple different containers.
You can use dependencies to establish a startup/shutdown sequence across the container group. For example, you might specify that ContainerB has a START
dependency on ContainerA. This dependency means that ContainerB can't start until after ContainerA has started. This dependency is reversed on shutdown, which means that ContainerB must shut down before ContainerA can shut down.
mount_points: Option<Vec<ContainerMountPoint>>
A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.
environment_override: Option<Vec<ContainerEnvironment>>
A set of environment variables to pass to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.
image_uri: Option<String>
The location of the container image to deploy to a container fleet. Provide an image in an Amazon Elastic Container Registry public or private repository. The repository must be in the same Amazon Web Services account and Amazon Web Services Region where you're creating the container group definition. For limits on image size, see Amazon GameLift Servers endpoints and quotas. You can use any of the following image URI formats:
-
Image ID only:
\[AWS account\].dkr.ecr.\[AWS region\].amazonaws.com/\[repository ID\]
-
Image ID and digest:
\[AWS account\].dkr.ecr.\[AWS region\].amazonaws.com/\[repository ID\]@\[digest\]
-
Image ID and tag:
\[AWS account\].dkr.ecr.\[AWS region\].amazonaws.com/\[repository ID\]:\[tag\]
port_configuration: Option<ContainerPortConfiguration>
A set of ports that Amazon GameLift Servers can assign to processes in a container. The container port configuration must have enough ports for each container process that accepts inbound traffic connections. For example, a game server process requires a container port to allow game clients to connect to it. A container port configuration can have can have one or more container port ranges. Each range specifies starting and ending values as well as the supported network protocol.
Container ports aren't directly accessed by inbound traffic. Amazon GameLift Servers maps each container port to an externally accessible connection port (see the container fleet property ConnectionPortRange
).
server_sdk_version: Option<String>
The Amazon GameLift Servers server SDK version that the game server is integrated with. Only game servers using 5.2.0 or higher are compatible with container fleets.
Implementations§
Source§impl GameServerContainerDefinitionInput
impl GameServerContainerDefinitionInput
Sourcepub fn container_name(&self) -> Option<&str>
pub fn container_name(&self) -> Option<&str>
A string that uniquely identifies the container definition within a container group.
Sourcepub fn depends_on(&self) -> &[ContainerDependency]
pub fn depends_on(&self) -> &[ContainerDependency]
Establishes dependencies between this container and the status of other containers in the same container group. A container can have dependencies on multiple different containers.
You can use dependencies to establish a startup/shutdown sequence across the container group. For example, you might specify that ContainerB has a START
dependency on ContainerA. This dependency means that ContainerB can't start until after ContainerA has started. This dependency is reversed on shutdown, which means that ContainerB must shut down before ContainerA can shut down.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .depends_on.is_none()
.
Sourcepub fn mount_points(&self) -> &[ContainerMountPoint]
pub fn mount_points(&self) -> &[ContainerMountPoint]
A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .mount_points.is_none()
.
Sourcepub fn environment_override(&self) -> &[ContainerEnvironment]
pub fn environment_override(&self) -> &[ContainerEnvironment]
A set of environment variables to pass to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .environment_override.is_none()
.
Sourcepub fn image_uri(&self) -> Option<&str>
pub fn image_uri(&self) -> Option<&str>
The location of the container image to deploy to a container fleet. Provide an image in an Amazon Elastic Container Registry public or private repository. The repository must be in the same Amazon Web Services account and Amazon Web Services Region where you're creating the container group definition. For limits on image size, see Amazon GameLift Servers endpoints and quotas. You can use any of the following image URI formats:
-
Image ID only:
\[AWS account\].dkr.ecr.\[AWS region\].amazonaws.com/\[repository ID\]
-
Image ID and digest:
\[AWS account\].dkr.ecr.\[AWS region\].amazonaws.com/\[repository ID\]@\[digest\]
-
Image ID and tag:
\[AWS account\].dkr.ecr.\[AWS region\].amazonaws.com/\[repository ID\]:\[tag\]
Sourcepub fn port_configuration(&self) -> Option<&ContainerPortConfiguration>
pub fn port_configuration(&self) -> Option<&ContainerPortConfiguration>
A set of ports that Amazon GameLift Servers can assign to processes in a container. The container port configuration must have enough ports for each container process that accepts inbound traffic connections. For example, a game server process requires a container port to allow game clients to connect to it. A container port configuration can have can have one or more container port ranges. Each range specifies starting and ending values as well as the supported network protocol.
Container ports aren't directly accessed by inbound traffic. Amazon GameLift Servers maps each container port to an externally accessible connection port (see the container fleet property ConnectionPortRange
).
Sourcepub fn server_sdk_version(&self) -> Option<&str>
pub fn server_sdk_version(&self) -> Option<&str>
The Amazon GameLift Servers server SDK version that the game server is integrated with. Only game servers using 5.2.0 or higher are compatible with container fleets.
Source§impl GameServerContainerDefinitionInput
impl GameServerContainerDefinitionInput
Sourcepub fn builder() -> GameServerContainerDefinitionInputBuilder
pub fn builder() -> GameServerContainerDefinitionInputBuilder
Creates a new builder-style object to manufacture GameServerContainerDefinitionInput
.
Trait Implementations§
Source§impl Clone for GameServerContainerDefinitionInput
impl Clone for GameServerContainerDefinitionInput
Source§fn clone(&self) -> GameServerContainerDefinitionInput
fn clone(&self) -> GameServerContainerDefinitionInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for GameServerContainerDefinitionInput
impl PartialEq for GameServerContainerDefinitionInput
Source§fn eq(&self, other: &GameServerContainerDefinitionInput) -> bool
fn eq(&self, other: &GameServerContainerDefinitionInput) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for GameServerContainerDefinitionInput
Auto Trait Implementations§
impl Freeze for GameServerContainerDefinitionInput
impl RefUnwindSafe for GameServerContainerDefinitionInput
impl Send for GameServerContainerDefinitionInput
impl Sync for GameServerContainerDefinitionInput
impl Unpin for GameServerContainerDefinitionInput
impl UnwindSafe for GameServerContainerDefinitionInput
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);