pub struct CreateContainerGroupDefinitionFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateContainerGroupDefinition
.
Creates a ContainerGroupDefinition
that describes a set of containers for hosting your game server with Amazon GameLift Servers managed containers hosting. An Amazon GameLift Servers container group is similar to a container task or pod. Use container group definitions when you create a container fleet with CreateContainerFleet.
A container group definition determines how Amazon GameLift Servers deploys your containers to each instance in a container fleet. You can maintain multiple versions of a container group definition.
There are two types of container groups:
-
A game server container group has the containers that run your game server application and supporting software. A game server container group can have these container types:
-
Game server container. This container runs your game server. You can define one game server container in a game server container group.
-
Support container. This container runs software in parallel with your game server. You can define up to 8 support containers in a game server group.
When building a game server container group definition, you can choose to bundle your game server executable and all dependent software into a single game server container. Alternatively, you can separate the software into one game server container and one or more support containers.
On a container fleet instance, a game server container group can be deployed multiple times (depending on the compute resources of the instance). This means that all containers in the container group are replicated together.
-
-
A per-instance container group has containers for processes that aren't replicated on a container fleet instance. This might include background services, logging, test processes, or processes that need to persist independently of the game server container group. When building a per-instance container group, you can define up to 10 support containers.
This operation requires Identity and Access Management (IAM) permissions to access container images in Amazon ECR repositories. See IAM permissions for Amazon GameLift Servers for help setting the appropriate permissions.
Request options
Use this operation to make the following types of requests. You can specify values for the minimum required parameters and customize optional values later.
-
Create a game server container group definition. Provide the following required parameter values:
-
Name
-
ContainerGroupType
(GAME_SERVER
) -
OperatingSystem
(omit to use default value) -
TotalMemoryLimitMebibytes
(omit to use default value) -
TotalVcpuLimit
(omit to use default value) -
At least one
GameServerContainerDefinition
-
ContainerName
-
ImageUrl
-
PortConfiguration
-
ServerSdkVersion
(omit to use default value)
-
-
-
Create a per-instance container group definition. Provide the following required parameter values:
-
Name
-
ContainerGroupType
(PER_INSTANCE
) -
OperatingSystem
(omit to use default value) -
TotalMemoryLimitMebibytes
(omit to use default value) -
TotalVcpuLimit
(omit to use default value) -
At least one
SupportContainerDefinition
-
ContainerName
-
ImageUrl
-
-
Results
If successful, this request creates a ContainerGroupDefinition
resource and assigns a unique ARN value. You can update most properties of a container group definition by calling UpdateContainerGroupDefinition, and optionally save the update as a new version.
Implementations§
Source§impl CreateContainerGroupDefinitionFluentBuilder
impl CreateContainerGroupDefinitionFluentBuilder
Sourcepub fn as_input(&self) -> &CreateContainerGroupDefinitionInputBuilder
pub fn as_input(&self) -> &CreateContainerGroupDefinitionInputBuilder
Access the CreateContainerGroupDefinition as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateContainerGroupDefinitionOutput, SdkError<CreateContainerGroupDefinitionError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateContainerGroupDefinitionOutput, SdkError<CreateContainerGroupDefinitionError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateContainerGroupDefinitionOutput, CreateContainerGroupDefinitionError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateContainerGroupDefinitionOutput, CreateContainerGroupDefinitionError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.
Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.
Sourcepub fn container_group_type(self, input: ContainerGroupType) -> Self
pub fn container_group_type(self, input: ContainerGroupType) -> Self
The type of container group being defined. Container group type determines how Amazon GameLift Servers deploys the container group on each fleet instance.
Default value: GAME_SERVER
Sourcepub fn set_container_group_type(self, input: Option<ContainerGroupType>) -> Self
pub fn set_container_group_type(self, input: Option<ContainerGroupType>) -> Self
The type of container group being defined. Container group type determines how Amazon GameLift Servers deploys the container group on each fleet instance.
Default value: GAME_SERVER
Sourcepub fn get_container_group_type(&self) -> &Option<ContainerGroupType>
pub fn get_container_group_type(&self) -> &Option<ContainerGroupType>
The type of container group being defined. Container group type determines how Amazon GameLift Servers deploys the container group on each fleet instance.
Default value: GAME_SERVER
Sourcepub fn total_memory_limit_mebibytes(self, input: i32) -> Self
pub fn total_memory_limit_mebibytes(self, input: i32) -> Self
The maximum amount of memory (in MiB) to allocate to the container group. All containers in the group share this memory. If you specify memory limits for an individual container, the total value must be greater than any individual container's memory limit.
Default value: 1024
Sourcepub fn set_total_memory_limit_mebibytes(self, input: Option<i32>) -> Self
pub fn set_total_memory_limit_mebibytes(self, input: Option<i32>) -> Self
The maximum amount of memory (in MiB) to allocate to the container group. All containers in the group share this memory. If you specify memory limits for an individual container, the total value must be greater than any individual container's memory limit.
Default value: 1024
Sourcepub fn get_total_memory_limit_mebibytes(&self) -> &Option<i32>
pub fn get_total_memory_limit_mebibytes(&self) -> &Option<i32>
The maximum amount of memory (in MiB) to allocate to the container group. All containers in the group share this memory. If you specify memory limits for an individual container, the total value must be greater than any individual container's memory limit.
Default value: 1024
Sourcepub fn total_vcpu_limit(self, input: f64) -> Self
pub fn total_vcpu_limit(self, input: f64) -> Self
The maximum amount of vCPU units to allocate to the container group (1 vCPU is equal to 1024 CPU units). All containers in the group share this memory. If you specify vCPU limits for individual containers, the total value must be equal to or greater than the sum of the CPU limits for all containers in the group.
Default value: 1
Sourcepub fn set_total_vcpu_limit(self, input: Option<f64>) -> Self
pub fn set_total_vcpu_limit(self, input: Option<f64>) -> Self
The maximum amount of vCPU units to allocate to the container group (1 vCPU is equal to 1024 CPU units). All containers in the group share this memory. If you specify vCPU limits for individual containers, the total value must be equal to or greater than the sum of the CPU limits for all containers in the group.
Default value: 1
Sourcepub fn get_total_vcpu_limit(&self) -> &Option<f64>
pub fn get_total_vcpu_limit(&self) -> &Option<f64>
The maximum amount of vCPU units to allocate to the container group (1 vCPU is equal to 1024 CPU units). All containers in the group share this memory. If you specify vCPU limits for individual containers, the total value must be equal to or greater than the sum of the CPU limits for all containers in the group.
Default value: 1
Sourcepub fn game_server_container_definition(
self,
input: GameServerContainerDefinitionInput,
) -> Self
pub fn game_server_container_definition( self, input: GameServerContainerDefinitionInput, ) -> Self
The definition for the game server container in this group. Define a game server container only when the container group type is GAME_SERVER
. Game server containers specify a container image with your game server build. You can pass in your container definitions as a JSON file.
Sourcepub fn set_game_server_container_definition(
self,
input: Option<GameServerContainerDefinitionInput>,
) -> Self
pub fn set_game_server_container_definition( self, input: Option<GameServerContainerDefinitionInput>, ) -> Self
The definition for the game server container in this group. Define a game server container only when the container group type is GAME_SERVER
. Game server containers specify a container image with your game server build. You can pass in your container definitions as a JSON file.
Sourcepub fn get_game_server_container_definition(
&self,
) -> &Option<GameServerContainerDefinitionInput>
pub fn get_game_server_container_definition( &self, ) -> &Option<GameServerContainerDefinitionInput>
The definition for the game server container in this group. Define a game server container only when the container group type is GAME_SERVER
. Game server containers specify a container image with your game server build. You can pass in your container definitions as a JSON file.
Sourcepub fn support_container_definitions(
self,
input: SupportContainerDefinitionInput,
) -> Self
pub fn support_container_definitions( self, input: SupportContainerDefinitionInput, ) -> Self
Appends an item to SupportContainerDefinitions
.
To override the contents of this collection use set_support_container_definitions
.
One or more definition for support containers in this group. You can define a support container in any type of container group. You can pass in your container definitions as a JSON file.
Sourcepub fn set_support_container_definitions(
self,
input: Option<Vec<SupportContainerDefinitionInput>>,
) -> Self
pub fn set_support_container_definitions( self, input: Option<Vec<SupportContainerDefinitionInput>>, ) -> Self
One or more definition for support containers in this group. You can define a support container in any type of container group. You can pass in your container definitions as a JSON file.
Sourcepub fn get_support_container_definitions(
&self,
) -> &Option<Vec<SupportContainerDefinitionInput>>
pub fn get_support_container_definitions( &self, ) -> &Option<Vec<SupportContainerDefinitionInput>>
One or more definition for support containers in this group. You can define a support container in any type of container group. You can pass in your container definitions as a JSON file.
Sourcepub fn operating_system(self, input: ContainerOperatingSystem) -> Self
pub fn operating_system(self, input: ContainerOperatingSystem) -> Self
The platform that all containers in the group use. Containers in a group must run on the same operating system.
Default value: AMAZON_LINUX_2023
Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to server SDK version 5.
Sourcepub fn set_operating_system(
self,
input: Option<ContainerOperatingSystem>,
) -> Self
pub fn set_operating_system( self, input: Option<ContainerOperatingSystem>, ) -> Self
The platform that all containers in the group use. Containers in a group must run on the same operating system.
Default value: AMAZON_LINUX_2023
Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to server SDK version 5.
Sourcepub fn get_operating_system(&self) -> &Option<ContainerOperatingSystem>
pub fn get_operating_system(&self) -> &Option<ContainerOperatingSystem>
The platform that all containers in the group use. Containers in a group must run on the same operating system.
Default value: AMAZON_LINUX_2023
Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to server SDK version 5.
Sourcepub fn version_description(self, input: impl Into<String>) -> Self
pub fn version_description(self, input: impl Into<String>) -> Self
A description for the initial version of this container group definition.
Sourcepub fn set_version_description(self, input: Option<String>) -> Self
pub fn set_version_description(self, input: Option<String>) -> Self
A description for the initial version of this container group definition.
Sourcepub fn get_version_description(&self) -> &Option<String>
pub fn get_version_description(&self) -> &Option<String>
A description for the initial version of this container group definition.
Appends an item to Tags
.
To override the contents of this collection use set_tags
.
A list of labels to assign to the container group definition resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
A list of labels to assign to the container group definition resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
A list of labels to assign to the container group definition resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
Trait Implementations§
Source§impl Clone for CreateContainerGroupDefinitionFluentBuilder
impl Clone for CreateContainerGroupDefinitionFluentBuilder
Source§fn clone(&self) -> CreateContainerGroupDefinitionFluentBuilder
fn clone(&self) -> CreateContainerGroupDefinitionFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateContainerGroupDefinitionFluentBuilder
impl !RefUnwindSafe for CreateContainerGroupDefinitionFluentBuilder
impl Send for CreateContainerGroupDefinitionFluentBuilder
impl Sync for CreateContainerGroupDefinitionFluentBuilder
impl Unpin for CreateContainerGroupDefinitionFluentBuilder
impl !UnwindSafe for CreateContainerGroupDefinitionFluentBuilder
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);