aws_sdk_gamelift::operation::create_fleet

Struct CreateFleetInput

#[non_exhaustive]
pub struct CreateFleetInput {Show 23 fields
    pub name: Option<String>,
    pub description: Option<String>,
    pub build_id: Option<String>,
    pub script_id: Option<String>,
    pub server_launch_path: Option<String>,
    pub server_launch_parameters: Option<String>,
    pub log_paths: Option<Vec<String>>,
    pub ec2_instance_type: Option<Ec2InstanceType>,
    pub ec2_inbound_permissions: Option<Vec<IpPermission>>,
    pub new_game_session_protection_policy: Option<ProtectionPolicy>,
    pub runtime_configuration: Option<RuntimeConfiguration>,
    pub resource_creation_limit_policy: Option<ResourceCreationLimitPolicy>,
    pub metric_groups: Option<Vec<String>>,
    pub peer_vpc_aws_account_id: Option<String>,
    pub peer_vpc_id: Option<String>,
    pub fleet_type: Option<FleetType>,
    pub instance_role_arn: Option<String>,
    pub certificate_configuration: Option<CertificateConfiguration>,
    pub locations: Option<Vec<LocationConfiguration>>,
    pub tags: Option<Vec<Tag>>,
    pub compute_type: Option<ComputeType>,
    pub anywhere_configuration: Option<AnywhereConfiguration>,
    pub instance_role_credentials_provider: Option<InstanceRoleCredentialsProvider>,
}

Fields (Non-exhaustive)§

This struct is marked as 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.

§name: Option<String>

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

§description: Option<String>

A description for the fleet.

§build_id: Option<String>

The unique identifier for a custom game server build to be deployed to a fleet with compute type EC2. You can use either the build ID or ARN. The build must be uploaded to Amazon GameLift Servers and in READY status. This fleet property can't be changed after the fleet is created.

§script_id: Option<String>

The unique identifier for a Realtime configuration script to be deployed to a fleet with compute type EC2. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift Servers prior to creating the fleet. This fleet property can't be changed after the fleet is created.

§server_launch_path: Option<String>

This parameter is no longer used. Specify a server launch path using the RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

§server_launch_parameters: Option<String>

This parameter is no longer used. Specify server launch parameters using the RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

§log_paths: Option<Vec<String>>

This parameter is no longer used. To specify where Amazon GameLift Servers should store log files once a server process shuts down, use the Amazon GameLift Servers server API ProcessReady() and specify one or more directory paths in logParameters. For more information, see Initialize the server process in the Amazon GameLift Servers Developer Guide.

§ec2_instance_type: Option<Ec2InstanceType>

The Amazon GameLift Servers-supported Amazon EC2 instance type to use with managed EC2 fleets. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.

§ec2_inbound_permissions: Option<Vec<IpPermission>>

The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. Set this parameter for managed EC2 fleets. You can leave this parameter empty when creating the fleet, but you must call https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetPortSettings to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Amazon GameLift Servers Realtime fleets, Amazon GameLift Servers automatically sets TCP and UDP ranges.

§new_game_session_protection_policy: Option<ProtectionPolicy>

The status of termination protection for active game sessions on the fleet. By default, this property is set to NoProtection. You can also set game session protection for an individual game session by calling UpdateGameSession.

NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.
FullProtection - Game sessions in ACTIVE status cannot be terminated during a scale-down event.

§runtime_configuration: Option<RuntimeConfiguration>

Instructions for how to launch and run server processes on the fleet. Set runtime configuration for managed EC2 fleets. For an Anywhere fleets, set this parameter only if the fleet is running the Amazon GameLift Servers Agent. The runtime configuration defines one or more server process configurations. Each server process identifies a game executable or Realtime script file and the number of processes to run concurrently.

This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters, which are still supported for backward compatibility.

§resource_creation_limit_policy: Option<ResourceCreationLimitPolicy>

A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.

§metric_groups: Option<Vec<String>>

The name of an Amazon Web Services CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.

§peer_vpc_aws_account_id: Option<String>

Used when peering your Amazon GameLift Servers fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC. You can find your account ID in the Amazon Web Services Management Console under account settings.

§peer_vpc_id: Option<String>

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Servers Fleets.

§fleet_type: Option<FleetType>

Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.

§instance_role_arn: Option<String>

A unique identifier for an IAM role that manages access to your Amazon Web Services 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 Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server. This fleet property can't be changed after the fleet is created.

§certificate_configuration: Option<CertificateConfiguration>

Prompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet. Amazon GameLift Servers uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift Servers. By default, the CertificateConfiguration is DISABLED. You can't change this property after you create the fleet.

Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.

ACM isn't available in all Amazon Web Services regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the Certificate Manager User Guide.

§locations: Option<Vec<LocationConfiguration>>

A set of remote locations to deploy additional instances to and manage as a multi-location fleet. Use this parameter when creating a fleet in Amazon Web Services Regions that support multiple locations. You can add any Amazon Web Services Region or Local Zone that's supported by Amazon GameLift Servers. Provide a list of one or more Amazon Web Services Region codes, such as us-west-2, or Local Zone names. When using this parameter, Amazon GameLift Servers requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift Servers service locations for managed hosting.

§tags: Option<Vec<Tag>>

A list of labels to assign to the new fleet 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.

§compute_type: Option<ComputeType>

The type of compute resource used to host your game servers.

EC2 – The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the default setting.
ANYWHERE – Game servers and supporting software are deployed to compute resources that you provide and manage. With this compute type, you can also set the AnywhereConfiguration parameter.

§anywhere_configuration: Option<AnywhereConfiguration>

Amazon GameLift Servers Anywhere configuration options.

§instance_role_credentials_provider: Option<InstanceRoleCredentialsProvider>

Prompts Amazon GameLift Servers to generate a shared credentials file for the IAM role that's defined in InstanceRoleArn. The shared credentials file is stored on each fleet instance and refreshed as needed. Use shared credentials for applications that are deployed along with the game server executable, if the game server is integrated with server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets.

Struct CreateFleetInput Copy item path

Fields (Non-exhaustive)§

Implementations§

impl CreateFleetInput

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

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

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

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

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

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

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

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

pub fn ec2_inbound_permissions(&self) -> &[IpPermission]

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

pub fn runtime_configuration(&self) -> Option<&RuntimeConfiguration>

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

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

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

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

pub fn fleet_type(&self) -> Option<&FleetType>

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

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

pub fn locations(&self) -> &[LocationConfiguration]

pub fn tags(&self) -> &[Tag]

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

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

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

impl CreateFleetInput

pub fn builder() -> CreateFleetInputBuilder

Trait Implementations§

impl Clone for CreateFleetInput

fn clone(&self) -> CreateFleetInput

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

impl Debug for CreateFleetInput

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

impl PartialEq for CreateFleetInput

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

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

impl StructuralPartialEq for CreateFleetInput

Auto Trait Implementations§

impl Freeze for CreateFleetInput

impl RefUnwindSafe for CreateFleetInput

impl Send for CreateFleetInput

impl Sync for CreateFleetInput

impl Unpin for CreateFleetInput

impl UnwindSafe for CreateFleetInput

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<Unshared, Shared> IntoShared<Shared> for Unsharedwhere Shared: FromUnshared<Unshared>,

fn into_shared(self) -> Shared

impl<T> Paint for Twhere T: ?Sized,

fn fg(&self, value: Color) -> Painted<&T>

§Example

fn primary(&self) -> Painted<&T>

§Example

fn fixed(&self, color: u8) -> Painted<&T>

§Example

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

§Example

fn black(&self) -> Painted<&T>

§Example

fn red(&self) -> Painted<&T>

§Example

Struct CreateFleetInput

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

impl<T> Paint for T
where T: ?Sized,