pub struct UpdateContainerGroupDefinitionFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateContainerGroupDefinition
.
Updates properties in an existing container group definition. This operation doesn't replace the definition. Instead, it creates a new version of the definition and saves it separately. You can access all versions that you choose to retain.
The only property you can't update is the container group type.
Request options:
-
Update based on the latest version of the container group definition. Specify the container group definition name only, or use an ARN value without a version number. Provide updated values for the properties that you want to change only. All other values remain the same as the latest version.
-
Update based on a specific version of the container group definition. Specify the container group definition name and a source version number, or use an ARN value with a version number. Provide updated values for the properties that you want to change only. All other values remain the same as the source version.
-
Change a game server container definition. Provide the updated container definition.
-
Add or change a support container definition. Provide a complete set of container definitions, including the updated definition.
-
Remove a support container definition. Provide a complete set of container definitions, excluding the definition to remove. If the container group has only one support container definition, provide an empty set.
Results:
If successful, this operation returns the complete properties of the new container group definition version.
If the container group definition version is used in an active fleets, the update automatically initiates a new fleet deployment of the new version. You can track a fleet's deployments using ListFleetDeployments.
Implementations§
Source§impl UpdateContainerGroupDefinitionFluentBuilder
impl UpdateContainerGroupDefinitionFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateContainerGroupDefinitionInputBuilder
pub fn as_input(&self) -> &UpdateContainerGroupDefinitionInputBuilder
Access the UpdateContainerGroupDefinition as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateContainerGroupDefinitionOutput, SdkError<UpdateContainerGroupDefinitionError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateContainerGroupDefinitionOutput, SdkError<UpdateContainerGroupDefinitionError, 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<UpdateContainerGroupDefinitionOutput, UpdateContainerGroupDefinitionError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateContainerGroupDefinitionOutput, UpdateContainerGroupDefinitionError, 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 game_server_container_definition(
self,
input: GameServerContainerDefinitionInput,
) -> Self
pub fn game_server_container_definition( self, input: GameServerContainerDefinitionInput, ) -> Self
An updated definition for the game server container in this group. Define a game server container only when the container group type is GAME_SERVER
. 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
An updated definition for the game server container in this group. Define a game server container only when the container group type is GAME_SERVER
. 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>
An updated definition for the game server container in this group. Define a game server container only when the container group type is GAME_SERVER
. 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 definitions 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 definitions 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 definitions 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 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.
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.
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.
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.
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.
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.
Sourcepub fn version_description(self, input: impl Into<String>) -> Self
pub fn version_description(self, input: impl Into<String>) -> Self
A description for this update to the 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 this update to the container group definition.
Sourcepub fn get_version_description(&self) -> &Option<String>
pub fn get_version_description(&self) -> &Option<String>
A description for this update to the container group definition.
Sourcepub fn source_version_number(self, input: i32) -> Self
pub fn source_version_number(self, input: i32) -> Self
The container group definition version to update. The new version starts with values from the source version, and then updates values included in this request.
Sourcepub fn set_source_version_number(self, input: Option<i32>) -> Self
pub fn set_source_version_number(self, input: Option<i32>) -> Self
The container group definition version to update. The new version starts with values from the source version, and then updates values included in this request.
Sourcepub fn get_source_version_number(&self) -> &Option<i32>
pub fn get_source_version_number(&self) -> &Option<i32>
The container group definition version to update. The new version starts with values from the source version, and then updates values included in this request.
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.
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.
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.
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.
Trait Implementations§
Source§impl Clone for UpdateContainerGroupDefinitionFluentBuilder
impl Clone for UpdateContainerGroupDefinitionFluentBuilder
Source§fn clone(&self) -> UpdateContainerGroupDefinitionFluentBuilder
fn clone(&self) -> UpdateContainerGroupDefinitionFluentBuilder
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 UpdateContainerGroupDefinitionFluentBuilder
impl !RefUnwindSafe for UpdateContainerGroupDefinitionFluentBuilder
impl Send for UpdateContainerGroupDefinitionFluentBuilder
impl Sync for UpdateContainerGroupDefinitionFluentBuilder
impl Unpin for UpdateContainerGroupDefinitionFluentBuilder
impl !UnwindSafe for UpdateContainerGroupDefinitionFluentBuilder
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);