Struct aws_sdk_gamelift::client::fluent_builders::UpdateFleetAttributes

pub struct UpdateFleetAttributes<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to UpdateFleetAttributes.

Updates a fleet's mutable attributes, including game session protection and resource creation limits.

To update fleet attributes, specify the fleet ID and the property values that you want to change.

If successful, an updated FleetAttributes object is returned.

Learn more

Setting up GameLift fleets

Related actions

CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by task

Implementations

impl<C, M, R> UpdateFleetAttributes<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<UpdateFleetAttributesOutput, SdkError<UpdateFleetAttributesError>> where
    R::Policy: SmithyRetryPolicy<UpdateFleetAttributesInputOperationOutputAlias, UpdateFleetAttributesOutput, UpdateFleetAttributesError, UpdateFleetAttributesInputOperationRetryAlias>, 

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.

pub fn fleet_id(self, inp: impl Into<String>) -> Self

A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.

pub fn set_fleet_id(self, input: Option<String>) -> Self

A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.

pub fn name(self, inp: impl Into<String>) -> Self

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

pub fn set_name(self, input: Option<String>) -> Self

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

pub fn description(self, inp: impl Into<String>) -> Self

A human-readable description of a fleet.

pub fn set_description(self, input: Option<String>) -> Self

A human-readable description of a fleet.

pub fn new_game_session_protection_policy(self, inp: ProtectionPolicy) -> Self

The game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

pub fn set_new_game_session_protection_policy(
    self,
    input: Option<ProtectionPolicy>
) -> Self

The game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

pub fn resource_creation_limit_policy(
    self,
    inp: ResourceCreationLimitPolicy
) -> Self

Policy settings that limit the number of game sessions an individual player can create over a span of time.

pub fn set_resource_creation_limit_policy(
    self,
    input: Option<ResourceCreationLimitPolicy>
) -> Self

Policy settings that limit the number of game sessions an individual player can create over a span of time.

pub fn metric_groups(self, inp: impl Into<String>) -> Self

Appends an item to MetricGroups.

To override the contents of this collection use set_metric_groups.

The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.

pub fn set_metric_groups(self, input: Option<Vec<String>>) -> Self

The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for UpdateFleetAttributes<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.