#[non_exhaustive]pub struct InstanceBuilder { /* private fields */ }
Expand description
A builder for Instance
.
Implementations§
Source§impl InstanceBuilder
impl InstanceBuilder
Sourcepub fn fleet_id(self, input: impl Into<String>) -> Self
pub fn fleet_id(self, input: impl Into<String>) -> Self
A unique identifier for the fleet that the instance belongs to.
Sourcepub fn set_fleet_id(self, input: Option<String>) -> Self
pub fn set_fleet_id(self, input: Option<String>) -> Self
A unique identifier for the fleet that the instance belongs to.
Sourcepub fn get_fleet_id(&self) -> &Option<String>
pub fn get_fleet_id(&self) -> &Option<String>
A unique identifier for the fleet that the instance belongs to.
Sourcepub fn fleet_arn(self, input: impl Into<String>) -> Self
pub fn fleet_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:
.
Sourcepub fn set_fleet_arn(self, input: Option<String>) -> Self
pub fn set_fleet_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:
.
Sourcepub fn get_fleet_arn(&self) -> &Option<String>
pub fn get_fleet_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:
.
Sourcepub fn instance_id(self, input: impl Into<String>) -> Self
pub fn instance_id(self, input: impl Into<String>) -> Self
A unique identifier for the instance.
Sourcepub fn set_instance_id(self, input: Option<String>) -> Self
pub fn set_instance_id(self, input: Option<String>) -> Self
A unique identifier for the instance.
Sourcepub fn get_instance_id(&self) -> &Option<String>
pub fn get_instance_id(&self) -> &Option<String>
A unique identifier for the instance.
Sourcepub fn ip_address(self, input: impl Into<String>) -> Self
pub fn ip_address(self, input: impl Into<String>) -> Self
IP address that is assigned to the instance.
Sourcepub fn set_ip_address(self, input: Option<String>) -> Self
pub fn set_ip_address(self, input: Option<String>) -> Self
IP address that is assigned to the instance.
Sourcepub fn get_ip_address(&self) -> &Option<String>
pub fn get_ip_address(&self) -> &Option<String>
IP address that is assigned to the instance.
Sourcepub fn dns_name(self, input: impl Into<String>) -> Self
pub fn dns_name(self, input: impl Into<String>) -> Self
The DNS identifier assigned to the instance that is running the game session. Values have the following format:
-
TLS-enabled fleets:
.. .amazongamelift.com -
Non-TLS-enabled fleets:
ec2-
. (See Amazon EC2 Instance IP Addressing.).compute.amazonaws.com
When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
Sourcepub fn set_dns_name(self, input: Option<String>) -> Self
pub fn set_dns_name(self, input: Option<String>) -> Self
The DNS identifier assigned to the instance that is running the game session. Values have the following format:
-
TLS-enabled fleets:
.. .amazongamelift.com -
Non-TLS-enabled fleets:
ec2-
. (See Amazon EC2 Instance IP Addressing.).compute.amazonaws.com
When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
Sourcepub fn get_dns_name(&self) -> &Option<String>
pub fn get_dns_name(&self) -> &Option<String>
The DNS identifier assigned to the instance that is running the game session. Values have the following format:
-
TLS-enabled fleets:
.. .amazongamelift.com -
Non-TLS-enabled fleets:
ec2-
. (See Amazon EC2 Instance IP Addressing.).compute.amazonaws.com
When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
Sourcepub fn operating_system(self, input: OperatingSystem) -> Self
pub fn operating_system(self, input: OperatingSystem) -> Self
Operating system that is running on this EC2 instance.
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<OperatingSystem>) -> Self
pub fn set_operating_system(self, input: Option<OperatingSystem>) -> Self
Operating system that is running on this EC2 instance.
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<OperatingSystem>
pub fn get_operating_system(&self) -> &Option<OperatingSystem>
Operating system that is running on this EC2 instance.
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 type(self, input: Ec2InstanceType) -> Self
pub fn type(self, input: Ec2InstanceType) -> Self
EC2 instance type that defines the computing resources of this instance.
Sourcepub fn set_type(self, input: Option<Ec2InstanceType>) -> Self
pub fn set_type(self, input: Option<Ec2InstanceType>) -> Self
EC2 instance type that defines the computing resources of this instance.
Sourcepub fn get_type(&self) -> &Option<Ec2InstanceType>
pub fn get_type(&self) -> &Option<Ec2InstanceType>
EC2 instance type that defines the computing resources of this instance.
Sourcepub fn status(self, input: InstanceStatus) -> Self
pub fn status(self, input: InstanceStatus) -> Self
Current status of the instance. Possible statuses include the following:
-
PENDING -- The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.
-
ACTIVE -- The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift Servers that it is ready to host a game session. The instance is now considered ready to host game sessions.
-
TERMINATING -- The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.
Sourcepub fn set_status(self, input: Option<InstanceStatus>) -> Self
pub fn set_status(self, input: Option<InstanceStatus>) -> Self
Current status of the instance. Possible statuses include the following:
-
PENDING -- The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.
-
ACTIVE -- The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift Servers that it is ready to host a game session. The instance is now considered ready to host game sessions.
-
TERMINATING -- The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.
Sourcepub fn get_status(&self) -> &Option<InstanceStatus>
pub fn get_status(&self) -> &Option<InstanceStatus>
Current status of the instance. Possible statuses include the following:
-
PENDING -- The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.
-
ACTIVE -- The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift Servers that it is ready to host a game session. The instance is now considered ready to host game sessions.
-
TERMINATING -- The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.
Sourcepub fn creation_time(self, input: DateTime) -> Self
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"
).
Sourcepub fn set_creation_time(self, input: Option<DateTime>) -> Self
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"
).
Sourcepub fn get_creation_time(&self) -> &Option<DateTime>
pub fn get_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"
).
Sourcepub fn location(self, input: impl Into<String>) -> Self
pub fn location(self, input: impl Into<String>) -> Self
The fleet location of the instance, expressed as an Amazon Web Services Region code, such as us-west-2
.
Sourcepub fn set_location(self, input: Option<String>) -> Self
pub fn set_location(self, input: Option<String>) -> Self
The fleet location of the instance, expressed as an Amazon Web Services Region code, such as us-west-2
.
Sourcepub fn get_location(&self) -> &Option<String>
pub fn get_location(&self) -> &Option<String>
The fleet location of the instance, expressed as an Amazon Web Services Region code, such as us-west-2
.
Trait Implementations§
Source§impl Clone for InstanceBuilder
impl Clone for InstanceBuilder
Source§fn clone(&self) -> InstanceBuilder
fn clone(&self) -> InstanceBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for InstanceBuilder
impl Debug for InstanceBuilder
Source§impl Default for InstanceBuilder
impl Default for InstanceBuilder
Source§fn default() -> InstanceBuilder
fn default() -> InstanceBuilder
Source§impl PartialEq for InstanceBuilder
impl PartialEq for InstanceBuilder
impl StructuralPartialEq for InstanceBuilder
Auto Trait Implementations§
impl Freeze for InstanceBuilder
impl RefUnwindSafe for InstanceBuilder
impl Send for InstanceBuilder
impl Sync for InstanceBuilder
impl Unpin for InstanceBuilder
impl UnwindSafe for InstanceBuilder
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);