Struct aws_sdk_gamelift::types::FleetAttributes

#[non_exhaustive]
pub struct FleetAttributes {

    pub fleet_id: Option<String>,
    pub fleet_arn: Option<String>,
    pub fleet_type: Option<FleetType>,
    pub instance_type: Option<Ec2InstanceType>,
    pub description: Option<String>,
    pub name: Option<String>,
    pub creation_time: Option<DateTime>,
    pub termination_time: Option<DateTime>,
    pub status: Option<FleetStatus>,
    pub build_id: Option<String>,
    pub build_arn: Option<String>,
    pub script_id: Option<String>,
    pub script_arn: Option<String>,
    pub server_launch_path: Option<String>,
    pub server_launch_parameters: Option<String>,
    pub log_paths: Option<Vec<String>>,
    pub new_game_session_protection_policy: Option<ProtectionPolicy>,
    pub operating_system: Option<OperatingSystem>,
    pub resource_creation_limit_policy: Option<ResourceCreationLimitPolicy>,
    pub metric_groups: Option<Vec<String>>,
    pub stopped_actions: Option<Vec<FleetAction>>,
    pub instance_role_arn: Option<String>,
    pub certificate_configuration: Option<CertificateConfiguration>,
    pub compute_type: Option<ComputeType>,
    pub anywhere_configuration: Option<AnywhereConfiguration>,
    pub instance_role_credentials_provider: Option<InstanceRoleCredentialsProvider>,
    pub container_groups_attributes: Option<ContainerGroupsAttributes>,
}

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Describes an Amazon GameLift fleet of game hosting resources. Attributes differ based on the fleet's compute type, as follows:

• EC2 fleet attributes identify a Build resource (for fleets with customer game server builds) or a Script resource (for Realtime Servers fleets).

• Container fleets have ContainerGroupsAttributes, which identify the fleet's ContainerGroupDefinition resources.

• Amazon GameLift Anywhere fleets have an abbreviated set of attributes, because most fleet configurations are set directly on the fleet's computes. Attributes include fleet identifiers and descriptive properties, creation/termination time, and fleet status.

Returned by: DescribeFleetAttributes

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

fleet_id: Option<String>

A unique identifier for the fleet.

fleet_arn: Option<String>

The Amazon Resource Name (ARN) that is assigned to a Amazon 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.

fleet_type: Option<FleetType>

Indicates whether the fleet uses On-Demand or Spot instances. For more information, see On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.

instance_type: Option<Ec2InstanceType>

The Amazon EC2 instance type that the fleet uses. Instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions. This attribute is used with fleets where ComputeType is "EC2" or "Container".

description: Option<String>

A human-readable description of the fleet.

name: Option<String>

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

creation_time: Option<DateTime>

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

termination_time: Option<DateTime>

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

status: Option<FleetStatus>

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 -- Amazon 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.

build_id: Option<String>

A unique identifier for the build resource that is deployed on instances in this fleet. This attribute is used with fleets where ComputeType is "EC2".

build_arn: Option<String>

The Amazon Resource Name (ARN) associated with the Amazon GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value. This attribute is used with fleets where ComputeType is "EC2".

script_id: Option<String>

A unique identifier for the Realtime script resource that is deployed on instances in this fleet. This attribute is used with fleets where ComputeType is "EC2".

script_arn: Option<String>

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.

server_launch_path: Option<String>

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

server_launch_parameters: Option<String>

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

log_paths: Option<Vec<String>>

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

new_game_session_protection_policy: Option<ProtectionPolicy>

The type of game session protection to set on all new instances that are started in the fleet. This attribute is used with fleets where ComputeType is "EC2" or "Container".

• 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.

operating_system: Option<OperatingSystem>

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. This attribute is used with fleets where ComputeType is "EC2" or "Container".

resource_creation_limit_policy: Option<ResourceCreationLimitPolicy>

A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.

The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.

metric_groups: Option<Vec<String>>

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. This attribute is used with fleets where ComputeType is "EC2" or "Container".

stopped_actions: Option<Vec<FleetAction>>

A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling. This attribute is used with fleets where ComputeType is "EC2" or "Container".

instance_role_arn: Option<String>

A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to. For more information about using the role with your game server builds, see Communicate with other Amazon Web Services resources from your fleets. This attribute is used with fleets where ComputeType is "EC2" or "Container".

certificate_configuration: Option<CertificateConfiguration>

Determines whether a TLS/SSL certificate is generated for a fleet. This feature must be enabled when creating the fleet. All instances in a fleet share the same certificate.

compute_type: Option<ComputeType>

The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.

anywhere_configuration: Option<AnywhereConfiguration>

This property is used with the Amazon GameLift containers feature, which is currently in public preview. A set of attributes that describe the container groups that are deployed on the fleet. These attributes are included for fleets with compute type CONTAINER only. This attribute is used with fleets where ComputeType is "Container".

instance_role_credentials_provider: Option<InstanceRoleCredentialsProvider>

Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn. Shared credentials allow applications that are deployed with the game server executable to communicate with other Amazon Web Services resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets. This attribute is used with fleets where ComputeType is "EC2" or "Container".

container_groups_attributes: Option<ContainerGroupsAttributes>

A set of properties that describe the container groups that are deployed to the fleet. These attributes are included for fleets with compute type CONTAINER.

Implementations

impl FleetAttributes

pub fn fleet_id(&self) -> Option<&str>

A unique identifier for the fleet.

pub fn fleet_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) that is assigned to a Amazon 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) -> Option<&FleetType>

Indicates whether the fleet uses On-Demand or Spot instances. For more information, see On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.

pub fn instance_type(&self) -> Option<&Ec2InstanceType>

The Amazon EC2 instance type that the fleet uses. Instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions. This attribute is used with fleets where ComputeType is "EC2" or "Container".

pub fn description(&self) -> Option<&str>

A human-readable description of the fleet.

pub fn name(&self) -> Option<&str>

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

pub fn creation_time(&self) -> Option<&DateTime>

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) -> Option<&DateTime>

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) -> Option<&FleetStatus>

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 -- Amazon 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) -> Option<&str>

A unique identifier for the build resource that is deployed on instances in this fleet. This attribute is used with fleets where ComputeType is "EC2".

pub fn build_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) associated with the Amazon GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value. This attribute is used with fleets where ComputeType is "EC2".

pub fn script_id(&self) -> Option<&str>

A unique identifier for the Realtime script resource that is deployed on instances in this fleet. This attribute is used with fleets where ComputeType is "EC2".

pub fn script_arn(&self) -> Option<&str>

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) -> Option<&str>

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

pub fn server_launch_parameters(&self) -> Option<&str>

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

pub fn log_paths(&self) -> &[String]

This parameter is no longer used. Game session log paths are now defined using the Amazon GameLift server API ProcessReady() logParameters. See more information in the Server 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 .log_paths.is_none().

pub fn new_game_session_protection_policy(&self) -> Option<&ProtectionPolicy>

The type of game session protection to set on all new instances that are started in the fleet. This attribute is used with fleets where ComputeType is "EC2" or "Container".

• 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) -> Option<&OperatingSystem>

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. This attribute is used with fleets where ComputeType is "EC2" or "Container".

pub fn resource_creation_limit_policy( &self ) -> Option<&ResourceCreationLimitPolicy>

A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.

The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.

pub fn metric_groups(&self) -> &[String]

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. This attribute is used with fleets where ComputeType is "EC2" or "Container".

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .metric_groups.is_none().

pub fn stopped_actions(&self) -> &[FleetAction]

A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling. This attribute is used with fleets where ComputeType is "EC2" or "Container".

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .stopped_actions.is_none().

pub fn instance_role_arn(&self) -> Option<&str>

A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to. For more information about using the role with your game server builds, see Communicate with other Amazon Web Services resources from your fleets. This attribute is used with fleets where ComputeType is "EC2" or "Container".

pub fn certificate_configuration(&self) -> Option<&CertificateConfiguration>

Determines whether a TLS/SSL certificate is generated for a fleet. This feature must be enabled when creating the fleet. All instances in a fleet share the same certificate.

pub fn compute_type(&self) -> Option<&ComputeType>

The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.

pub fn anywhere_configuration(&self) -> Option<&AnywhereConfiguration>

This property is used with the Amazon GameLift containers feature, which is currently in public preview. A set of attributes that describe the container groups that are deployed on the fleet. These attributes are included for fleets with compute type CONTAINER only. This attribute is used with fleets where ComputeType is "Container".

pub fn instance_role_credentials_provider( &self ) -> Option<&InstanceRoleCredentialsProvider>

Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn. Shared credentials allow applications that are deployed with the game server executable to communicate with other Amazon Web Services resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets. This attribute is used with fleets where ComputeType is "EC2" or "Container".

pub fn container_groups_attributes(&self) -> Option<&ContainerGroupsAttributes>

A set of properties that describe the container groups that are deployed to the fleet. These attributes are included for fleets with compute type CONTAINER.

impl FleetAttributes

pub fn builder() -> FleetAttributesBuilder

Creates a new builder-style object to manufacture FleetAttributes.

Trait Implementations

impl Clone for FleetAttributes

fn clone(&self) -> FleetAttributes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FleetAttributes

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

Formats the value using the given formatter.

impl PartialEq for FleetAttributes

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FleetAttributes