Struct aws_sdk_gamelift::model::fleet_attributes::Builder

#[non_exhaustive]
pub struct Builder { /* fields omitted */ }

A builder for FleetAttributes

Implementations

impl Builder

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

A unique identifier for the fleet.

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

A unique identifier for the fleet.

pub fn fleet_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift fleet ARN, the resource ID matches the FleetId value.

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

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift fleet ARN, the resource ID matches the FleetId value.

pub fn fleet_type(self, input: FleetType) -> Self

The kind of instances, On-Demand or Spot, that this fleet uses.

pub fn set_fleet_type(self, input: Option<FleetType>) -> Self

The kind of instances, On-Demand or Spot, that this fleet uses.

pub fn instance_type(self, input: Ec2InstanceType) -> Self

The EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

pub fn set_instance_type(self, input: Option<Ec2InstanceType>) -> Self

The EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

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

A human-readable description of the fleet.

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

A human-readable description of the fleet.

pub fn name(self, input: 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 creation_time(self, input: DateTime) -> Self

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

pub fn set_creation_time(self, input: Option<DateTime>) -> Self

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

pub fn termination_time(self, input: DateTime) -> Self

A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

pub fn set_termination_time(self, input: Option<DateTime>) -> Self

A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

pub fn status(self, input: FleetStatus) -> Self

Current status of the fleet. Possible fleet statuses include the following:

• NEW -- A new fleet has been defined and desired instances is set to 1.

• DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

• ACTIVE -- Hosts can now accept game sessions.

• ERROR -- An error occurred when downloading, validating, building, or activating the fleet.

• DELETING -- Hosts are responding to a delete fleet request.

• TERMINATED -- The fleet no longer exists.

pub fn set_status(self, input: Option<FleetStatus>) -> Self

Current status of the fleet. Possible fleet statuses include the following:

• NEW -- A new fleet has been defined and desired instances is set to 1.

• DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

• ACTIVE -- Hosts can now accept game sessions.

• ERROR -- An error occurred when downloading, validating, building, or activating the fleet.

• DELETING -- Hosts are responding to a delete fleet request.

• TERMINATED -- The fleet no longer exists.

pub fn build_id(self, input: impl Into<String>) -> Self

A unique identifier for the build resource that is deployed on instances in this fleet.

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

A unique identifier for the build resource that is deployed on instances in this fleet.

pub fn build_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

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

The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

pub fn script_id(self, input: impl Into<String>) -> Self

A unique identifier for the Realtime script resource that is deployed on instances in this fleet.

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

A unique identifier for the Realtime script resource that is deployed on instances in this fleet.

pub fn script_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

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

The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

pub fn server_launch_path(self, input: impl Into<String>) -> Self

This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

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

This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

pub fn server_launch_parameters(self, input: impl Into<String>) -> Self

This parameter is no longer used. Server launch parameters are now defined using the fleet's RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

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

This parameter is no longer used. Server launch parameters are now defined using the fleet's RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

pub fn log_paths(self, input: impl Into<String>) -> Self

Appends an item to log_paths.

To override the contents of this collection use set_log_paths.

This parameter is no longer used. Game session log paths are now defined using the GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.

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

This parameter is no longer used. Game session log paths are now defined using the GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.

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

The type of game session protection to set on all new instances that are started in the fleet.

• 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 type of game session protection to set on all new instances that are started in the fleet.

• 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 operating_system(self, input: OperatingSystem) -> Self

The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.

pub fn set_operating_system(self, input: Option<OperatingSystem>) -> Self

The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.

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

The fleet policy that limits 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

The fleet policy that limits the number of game sessions an individual player can create over a span of time.

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

Appends an item to metric_groups.

To override the contents of this collection use set_metric_groups.

Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group at a time.

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

Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group at a time.

pub fn stopped_actions(self, input: impl Into<FleetAction>) -> Self

Appends an item to stopped_actions.

To override the contents of this collection use set_stopped_actions.

A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling.

pub fn set_stopped_actions(self, input: Option<Vec<FleetAction>>) -> Self

A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling.

pub fn instance_role_arn(self, input: impl Into<String>) -> Self

A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

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

A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

pub fn certificate_configuration(self, input: CertificateConfiguration) -> Self

Indicates whether a TLS/SSL certificate was generated for the fleet.

pub fn set_certificate_configuration(
    self,
    input: Option<CertificateConfiguration>
) -> Self

Indicates whether a TLS/SSL certificate was generated for the fleet.

pub fn build(self) -> FleetAttributes

Consumes the builder and constructs a FleetAttributes

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Builder) -> bool

This method tests for !=.

impl StructuralPartialEq for Builder