pub struct CreateContainerFleetFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateContainerFleet
.
Creates a managed fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your containerized game servers. Use this operation to define how to deploy a container architecture onto each fleet instance and configure fleet settings. You can create a container fleet in any Amazon Web Services Regions that Amazon GameLift Servers supports for multi-location fleets. A container fleet can be deployed to a single location or multiple locations. Container fleets are deployed with Amazon Linux 2023 as the instance operating system.
Define the fleet's container architecture using container group definitions. Each fleet can have one of the following container group types:
-
The game server container group runs your game server build and dependent software. Amazon GameLift Servers deploys one or more replicas of this container group to each fleet instance. The number of replicas depends on the computing capabilities of the fleet instance in use.
-
An optional per-instance container group might be used to run other software that only needs to run once per instance, such as background services, logging, or test processes. One per-instance container group is deployed to each fleet instance.
Each container group can include the definition for one or more containers. A container definition specifies a container image that is stored in an Amazon Elastic Container Registry (Amazon ECR) public or private repository.
Request options
Use this operation to make the following types of requests. Most fleet settings have default values, so you can create a working fleet with a minimal configuration and default values, which you can customize later.
-
Create a fleet with no container groups. You can configure a container fleet and then add container group definitions later. In this scenario, no fleet instances are deployed, and the fleet can't host game sessions until you add a game server container group definition. Provide the following required parameter values:
-
FleetRoleArn
-
-
Create a fleet with a game server container group. Provide the following required parameter values:
-
FleetRoleArn
-
GameServerContainerGroupDefinitionName
-
-
Create a fleet with a game server container group and a per-instance container group. Provide the following required parameter values:
-
FleetRoleArn
-
GameServerContainerGroupDefinitionName
-
PerInstanceContainerGroupDefinitionName
-
Results
If successful, this operation creates a new container fleet resource, places it in PENDING
status, and initiates the fleet creation workflow. For fleets with container groups, this workflow starts a fleet deployment and transitions the status to ACTIVE
. Fleets without a container group are placed in CREATED
status.
You can update most of the properties of a fleet, including container group definitions, and deploy the update across all fleet instances. Use a fleet update to deploy a new game server version update across the container fleet.
Implementations§
Source§impl CreateContainerFleetFluentBuilder
impl CreateContainerFleetFluentBuilder
Sourcepub fn as_input(&self) -> &CreateContainerFleetInputBuilder
pub fn as_input(&self) -> &CreateContainerFleetInputBuilder
Access the CreateContainerFleet as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateContainerFleetOutput, SdkError<CreateContainerFleetError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateContainerFleetOutput, SdkError<CreateContainerFleetError, HttpResponse>>
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.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateContainerFleetOutput, CreateContainerFleetError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateContainerFleetOutput, CreateContainerFleetError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn fleet_role_arn(self, input: impl Into<String>) -> Self
pub fn fleet_role_arn(self, input: impl Into<String>) -> Self
The unique identifier for an Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift Servers. Use an IAM service role with the GameLiftContainerFleetPolicy
managed policy attached. For more information, see Set up an IAM service role. You can't change this fleet property after the fleet is created.
IAM role ARN values use the following pattern: arn:aws:iam::\[Amazon Web Services account\]:role/\[role name\]
.
Sourcepub fn set_fleet_role_arn(self, input: Option<String>) -> Self
pub fn set_fleet_role_arn(self, input: Option<String>) -> Self
The unique identifier for an Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift Servers. Use an IAM service role with the GameLiftContainerFleetPolicy
managed policy attached. For more information, see Set up an IAM service role. You can't change this fleet property after the fleet is created.
IAM role ARN values use the following pattern: arn:aws:iam::\[Amazon Web Services account\]:role/\[role name\]
.
Sourcepub fn get_fleet_role_arn(&self) -> &Option<String>
pub fn get_fleet_role_arn(&self) -> &Option<String>
The unique identifier for an Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift Servers. Use an IAM service role with the GameLiftContainerFleetPolicy
managed policy attached. For more information, see Set up an IAM service role. You can't change this fleet property after the fleet is created.
IAM role ARN values use the following pattern: arn:aws:iam::\[Amazon Web Services account\]:role/\[role name\]
.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A meaningful description of the container fleet.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A meaningful description of the container fleet.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A meaningful description of the container fleet.
Sourcepub fn game_server_container_group_definition_name(
self,
input: impl Into<String>,
) -> Self
pub fn game_server_container_group_definition_name( self, input: impl Into<String>, ) -> Self
A container group definition resource that describes how to deploy containers with your game server build and support software onto each fleet instance. You can specify the container group definition's name to use the latest version. Alternatively, provide an ARN value with a specific version number.
Create a container group definition by calling CreateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource.
Sourcepub fn set_game_server_container_group_definition_name(
self,
input: Option<String>,
) -> Self
pub fn set_game_server_container_group_definition_name( self, input: Option<String>, ) -> Self
A container group definition resource that describes how to deploy containers with your game server build and support software onto each fleet instance. You can specify the container group definition's name to use the latest version. Alternatively, provide an ARN value with a specific version number.
Create a container group definition by calling CreateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource.
Sourcepub fn get_game_server_container_group_definition_name(&self) -> &Option<String>
pub fn get_game_server_container_group_definition_name(&self) -> &Option<String>
A container group definition resource that describes how to deploy containers with your game server build and support software onto each fleet instance. You can specify the container group definition's name to use the latest version. Alternatively, provide an ARN value with a specific version number.
Create a container group definition by calling CreateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource.
Sourcepub fn per_instance_container_group_definition_name(
self,
input: impl Into<String>,
) -> Self
pub fn per_instance_container_group_definition_name( self, input: impl Into<String>, ) -> Self
The name of a container group definition resource that describes a set of axillary software. A fleet instance has one process for executables in this container group. A per-instance container group is optional. You can update the fleet to add or remove a per-instance container group at any time. You can specify the container group definition's name to use the latest version. Alternatively, provide an ARN value with a specific version number.
Create a container group definition by calling https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html. This operation creates a https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html resource.
Sourcepub fn set_per_instance_container_group_definition_name(
self,
input: Option<String>,
) -> Self
pub fn set_per_instance_container_group_definition_name( self, input: Option<String>, ) -> Self
The name of a container group definition resource that describes a set of axillary software. A fleet instance has one process for executables in this container group. A per-instance container group is optional. You can update the fleet to add or remove a per-instance container group at any time. You can specify the container group definition's name to use the latest version. Alternatively, provide an ARN value with a specific version number.
Create a container group definition by calling https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html. This operation creates a https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html resource.
Sourcepub fn get_per_instance_container_group_definition_name(
&self,
) -> &Option<String>
pub fn get_per_instance_container_group_definition_name( &self, ) -> &Option<String>
The name of a container group definition resource that describes a set of axillary software. A fleet instance has one process for executables in this container group. A per-instance container group is optional. You can update the fleet to add or remove a per-instance container group at any time. You can specify the container group definition's name to use the latest version. Alternatively, provide an ARN value with a specific version number.
Create a container group definition by calling https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html. This operation creates a https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html resource.
Sourcepub fn instance_connection_port_range(self, input: ConnectionPortRange) -> Self
pub fn instance_connection_port_range(self, input: ConnectionPortRange) -> Self
The set of port numbers to open on each fleet instance. A fleet's connection ports map to container ports that are configured in the fleet's container group definitions.
By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. To use the calculated range, don't set this parameter. The values are:
-
Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift Servers uses the following formula:
4192 + \[# of game server container groups per fleet instance\] * \[# of container ports in the game server container group definition\] + \[# of container ports in the game server container group definition\]
You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet's inbound permissions port range.
If you set values manually, Amazon GameLift Servers no longer calculates a port range for you, even if you later remove the manual settings.
Sourcepub fn set_instance_connection_port_range(
self,
input: Option<ConnectionPortRange>,
) -> Self
pub fn set_instance_connection_port_range( self, input: Option<ConnectionPortRange>, ) -> Self
The set of port numbers to open on each fleet instance. A fleet's connection ports map to container ports that are configured in the fleet's container group definitions.
By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. To use the calculated range, don't set this parameter. The values are:
-
Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift Servers uses the following formula:
4192 + \[# of game server container groups per fleet instance\] * \[# of container ports in the game server container group definition\] + \[# of container ports in the game server container group definition\]
You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet's inbound permissions port range.
If you set values manually, Amazon GameLift Servers no longer calculates a port range for you, even if you later remove the manual settings.
Sourcepub fn get_instance_connection_port_range(&self) -> &Option<ConnectionPortRange>
pub fn get_instance_connection_port_range(&self) -> &Option<ConnectionPortRange>
The set of port numbers to open on each fleet instance. A fleet's connection ports map to container ports that are configured in the fleet's container group definitions.
By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. To use the calculated range, don't set this parameter. The values are:
-
Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift Servers uses the following formula:
4192 + \[# of game server container groups per fleet instance\] * \[# of container ports in the game server container group definition\] + \[# of container ports in the game server container group definition\]
You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet's inbound permissions port range.
If you set values manually, Amazon GameLift Servers no longer calculates a port range for you, even if you later remove the manual settings.
Sourcepub fn instance_inbound_permissions(self, input: IpPermission) -> Self
pub fn instance_inbound_permissions(self, input: IpPermission) -> Self
Appends an item to InstanceInboundPermissions
.
To override the contents of this collection use set_instance_inbound_permissions
.
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. As a best practice, when remotely accessing a fleet instance, we recommend opening ports only when you need them and closing them when you're finished.
By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. To use the calculated range, don't set this parameter. The values are:
-
Protocol: UDP
-
Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift Servers uses the following formula:
4192 + \[# of game server container groups per fleet instance\] * \[# of container ports in the game server container group definition\] + \[# of container ports in the game server container group definition\]
You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet's connection port range.
If you set values manually, Amazon GameLift Servers no longer calculates a port range for you, even if you later remove the manual settings.
Sourcepub fn set_instance_inbound_permissions(
self,
input: Option<Vec<IpPermission>>,
) -> Self
pub fn set_instance_inbound_permissions( self, input: Option<Vec<IpPermission>>, ) -> Self
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. As a best practice, when remotely accessing a fleet instance, we recommend opening ports only when you need them and closing them when you're finished.
By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. To use the calculated range, don't set this parameter. The values are:
-
Protocol: UDP
-
Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift Servers uses the following formula:
4192 + \[# of game server container groups per fleet instance\] * \[# of container ports in the game server container group definition\] + \[# of container ports in the game server container group definition\]
You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet's connection port range.
If you set values manually, Amazon GameLift Servers no longer calculates a port range for you, even if you later remove the manual settings.
Sourcepub fn get_instance_inbound_permissions(&self) -> &Option<Vec<IpPermission>>
pub fn get_instance_inbound_permissions(&self) -> &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. As a best practice, when remotely accessing a fleet instance, we recommend opening ports only when you need them and closing them when you're finished.
By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. To use the calculated range, don't set this parameter. The values are:
-
Protocol: UDP
-
Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift Servers uses the following formula:
4192 + \[# of game server container groups per fleet instance\] * \[# of container ports in the game server container group definition\] + \[# of container ports in the game server container group definition\]
You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet's connection port range.
If you set values manually, Amazon GameLift Servers no longer calculates a port range for you, even if you later remove the manual settings.
Sourcepub fn game_server_container_groups_per_instance(self, input: i32) -> Self
pub fn game_server_container_groups_per_instance(self, input: i32) -> Self
The number of times to replicate the game server container group on each fleet instance.
By default, Amazon GameLift Servers calculates the maximum number of game server container groups that can fit on each instance. This calculation is based on the CPU and memory resources of the fleet's instance type). To use the calculated maximum, don't set this parameter. If you set this number manually, Amazon GameLift Servers uses your value as long as it's less than the calculated maximum.
Sourcepub fn set_game_server_container_groups_per_instance(
self,
input: Option<i32>,
) -> Self
pub fn set_game_server_container_groups_per_instance( self, input: Option<i32>, ) -> Self
The number of times to replicate the game server container group on each fleet instance.
By default, Amazon GameLift Servers calculates the maximum number of game server container groups that can fit on each instance. This calculation is based on the CPU and memory resources of the fleet's instance type). To use the calculated maximum, don't set this parameter. If you set this number manually, Amazon GameLift Servers uses your value as long as it's less than the calculated maximum.
Sourcepub fn get_game_server_container_groups_per_instance(&self) -> &Option<i32>
pub fn get_game_server_container_groups_per_instance(&self) -> &Option<i32>
The number of times to replicate the game server container group on each fleet instance.
By default, Amazon GameLift Servers calculates the maximum number of game server container groups that can fit on each instance. This calculation is based on the CPU and memory resources of the fleet's instance type). To use the calculated maximum, don't set this parameter. If you set this number manually, Amazon GameLift Servers uses your value as long as it's less than the calculated maximum.
Sourcepub fn instance_type(self, input: impl Into<String>) -> Self
pub fn instance_type(self, input: impl Into<String>) -> Self
The Amazon EC2 instance type to use for all instances in the fleet. For multi-location fleets, the instance type must be available in the home region and all remote locations. Instance type determines the computing resources and processing power that's available to host your game servers. This includes including CPU, memory, storage, and networking capacity.
By default, Amazon GameLift Servers selects an instance type that fits the needs of your container groups and is available in all selected fleet locations. You can also choose to manually set this parameter. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.
You can't update this fleet property later.
Sourcepub fn set_instance_type(self, input: Option<String>) -> Self
pub fn set_instance_type(self, input: Option<String>) -> Self
The Amazon EC2 instance type to use for all instances in the fleet. For multi-location fleets, the instance type must be available in the home region and all remote locations. Instance type determines the computing resources and processing power that's available to host your game servers. This includes including CPU, memory, storage, and networking capacity.
By default, Amazon GameLift Servers selects an instance type that fits the needs of your container groups and is available in all selected fleet locations. You can also choose to manually set this parameter. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.
You can't update this fleet property later.
Sourcepub fn get_instance_type(&self) -> &Option<String>
pub fn get_instance_type(&self) -> &Option<String>
The Amazon EC2 instance type to use for all instances in the fleet. For multi-location fleets, the instance type must be available in the home region and all remote locations. Instance type determines the computing resources and processing power that's available to host your game servers. This includes including CPU, memory, storage, and networking capacity.
By default, Amazon GameLift Servers selects an instance type that fits the needs of your container groups and is available in all selected fleet locations. You can also choose to manually set this parameter. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.
You can't update this fleet property later.
Sourcepub fn billing_type(self, input: ContainerFleetBillingType) -> Self
pub fn billing_type(self, input: ContainerFleetBillingType) -> Self
Indicates whether to use On-Demand or Spot instances for this fleet. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.
By default, this property is set to ON_DEMAND
.
You can't update this fleet property later.
Sourcepub fn set_billing_type(self, input: Option<ContainerFleetBillingType>) -> Self
pub fn set_billing_type(self, input: Option<ContainerFleetBillingType>) -> Self
Indicates whether to use On-Demand or Spot instances for this fleet. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.
By default, this property is set to ON_DEMAND
.
You can't update this fleet property later.
Sourcepub fn get_billing_type(&self) -> &Option<ContainerFleetBillingType>
pub fn get_billing_type(&self) -> &Option<ContainerFleetBillingType>
Indicates whether to use On-Demand or Spot instances for this fleet. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.
By default, this property is set to ON_DEMAND
.
You can't update this fleet property later.
Sourcepub fn locations(self, input: LocationConfiguration) -> Self
pub fn locations(self, input: LocationConfiguration) -> Self
Appends an item to Locations
.
To override the contents of this collection use set_locations
.
A set of locations to deploy container fleet instances to. 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. Also include the fleet's home Region, which is the Amazon Web Services Region where the fleet is created. For a list of supported Regions and Local Zones, see Amazon GameLift Servers service locations for managed hosting.
Sourcepub fn set_locations(self, input: Option<Vec<LocationConfiguration>>) -> Self
pub fn set_locations(self, input: Option<Vec<LocationConfiguration>>) -> Self
A set of locations to deploy container fleet instances to. 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. Also include the fleet's home Region, which is the Amazon Web Services Region where the fleet is created. For a list of supported Regions and Local Zones, see Amazon GameLift Servers service locations for managed hosting.
Sourcepub fn get_locations(&self) -> &Option<Vec<LocationConfiguration>>
pub fn get_locations(&self) -> &Option<Vec<LocationConfiguration>>
A set of locations to deploy container fleet instances to. 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. Also include the fleet's home Region, which is the Amazon Web Services Region where the fleet is created. For a list of supported Regions and Local Zones, see Amazon GameLift Servers service locations for managed hosting.
Sourcepub fn metric_groups(self, input: impl Into<String>) -> Self
pub fn metric_groups(self, input: impl Into<String>) -> Self
Appends an item to MetricGroups
.
To override the contents of this collection use set_metric_groups
.
The name of an Amazon Web Services CloudWatch metric group to add this fleet to. You can use a metric group to aggregate metrics for multiple fleets. You can specify an existing metric group name or use a new name to create a new metric group. Each fleet can have only one metric group, but you can change this value at any time.
Sourcepub fn set_metric_groups(self, input: Option<Vec<String>>) -> Self
pub fn set_metric_groups(self, input: Option<Vec<String>>) -> Self
The name of an Amazon Web Services CloudWatch metric group to add this fleet to. You can use a metric group to aggregate metrics for multiple fleets. You can specify an existing metric group name or use a new name to create a new metric group. Each fleet can have only one metric group, but you can change this value at any time.
Sourcepub fn get_metric_groups(&self) -> &Option<Vec<String>>
pub fn get_metric_groups(&self) -> &Option<Vec<String>>
The name of an Amazon Web Services CloudWatch metric group to add this fleet to. You can use a metric group to aggregate metrics for multiple fleets. You can specify an existing metric group name or use a new name to create a new metric group. Each fleet can have only one metric group, but you can change this value at any time.
Sourcepub fn new_game_session_protection_policy(self, input: ProtectionPolicy) -> Self
pub fn new_game_session_protection_policy(self, input: ProtectionPolicy) -> Self
Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift Servers might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using UpdateGameSession.
-
NoProtection -- Game sessions can be shut down during active gameplay.
-
FullProtection -- Game sessions in
ACTIVE
status can't be shut down.
By default, this property is set to NoProtection
.
Sourcepub fn set_new_game_session_protection_policy(
self,
input: Option<ProtectionPolicy>,
) -> Self
pub fn set_new_game_session_protection_policy( self, input: Option<ProtectionPolicy>, ) -> Self
Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift Servers might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using UpdateGameSession.
-
NoProtection -- Game sessions can be shut down during active gameplay.
-
FullProtection -- Game sessions in
ACTIVE
status can't be shut down.
By default, this property is set to NoProtection
.
Sourcepub fn get_new_game_session_protection_policy(
&self,
) -> &Option<ProtectionPolicy>
pub fn get_new_game_session_protection_policy( &self, ) -> &Option<ProtectionPolicy>
Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift Servers might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using UpdateGameSession.
-
NoProtection -- Game sessions can be shut down during active gameplay.
-
FullProtection -- Game sessions in
ACTIVE
status can't be shut down.
By default, this property is set to NoProtection
.
Sourcepub fn game_session_creation_limit_policy(
self,
input: GameSessionCreationLimitPolicy,
) -> Self
pub fn game_session_creation_limit_policy( self, input: GameSessionCreationLimitPolicy, ) -> Self
A policy that limits the number of game sessions that each individual player can create on instances in this fleet. The limit applies for a specified span of time.
Sourcepub fn set_game_session_creation_limit_policy(
self,
input: Option<GameSessionCreationLimitPolicy>,
) -> Self
pub fn set_game_session_creation_limit_policy( self, input: Option<GameSessionCreationLimitPolicy>, ) -> Self
A policy that limits the number of game sessions that each individual player can create on instances in this fleet. The limit applies for a specified span of time.
Sourcepub fn get_game_session_creation_limit_policy(
&self,
) -> &Option<GameSessionCreationLimitPolicy>
pub fn get_game_session_creation_limit_policy( &self, ) -> &Option<GameSessionCreationLimitPolicy>
A policy that limits the number of game sessions that each individual player can create on instances in this fleet. The limit applies for a specified span of time.
Sourcepub fn log_configuration(self, input: LogConfiguration) -> Self
pub fn log_configuration(self, input: LogConfiguration) -> Self
A method for collecting container logs for the fleet. Amazon GameLift Servers saves all standard output for each container in logs, including game session logs. You can select from the following methods:
-
CLOUDWATCH
-- Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group. -
S3
-- Store logs in an Amazon S3 bucket that you define. -
NONE
-- Don't collect container logs.
By default, this property is set to CLOUDWATCH
.
Amazon GameLift Servers requires permissions to send logs other Amazon Web Services services in your account. These permissions are included in the IAM fleet role for this container fleet (see FleetRoleArn)
.
Sourcepub fn set_log_configuration(self, input: Option<LogConfiguration>) -> Self
pub fn set_log_configuration(self, input: Option<LogConfiguration>) -> Self
A method for collecting container logs for the fleet. Amazon GameLift Servers saves all standard output for each container in logs, including game session logs. You can select from the following methods:
-
CLOUDWATCH
-- Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group. -
S3
-- Store logs in an Amazon S3 bucket that you define. -
NONE
-- Don't collect container logs.
By default, this property is set to CLOUDWATCH
.
Amazon GameLift Servers requires permissions to send logs other Amazon Web Services services in your account. These permissions are included in the IAM fleet role for this container fleet (see FleetRoleArn)
.
Sourcepub fn get_log_configuration(&self) -> &Option<LogConfiguration>
pub fn get_log_configuration(&self) -> &Option<LogConfiguration>
A method for collecting container logs for the fleet. Amazon GameLift Servers saves all standard output for each container in logs, including game session logs. You can select from the following methods:
-
CLOUDWATCH
-- Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group. -
S3
-- Store logs in an Amazon S3 bucket that you define. -
NONE
-- Don't collect container logs.
By default, this property is set to CLOUDWATCH
.
Amazon GameLift Servers requires permissions to send logs other Amazon Web Services services in your account. These permissions are included in the IAM fleet role for this container fleet (see FleetRoleArn)
.
Appends an item to Tags
.
To override the contents of this collection use set_tags
.
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.
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.
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.
Trait Implementations§
Source§impl Clone for CreateContainerFleetFluentBuilder
impl Clone for CreateContainerFleetFluentBuilder
Source§fn clone(&self) -> CreateContainerFleetFluentBuilder
fn clone(&self) -> CreateContainerFleetFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateContainerFleetFluentBuilder
impl !RefUnwindSafe for CreateContainerFleetFluentBuilder
impl Send for CreateContainerFleetFluentBuilder
impl Sync for CreateContainerFleetFluentBuilder
impl Unpin for CreateContainerFleetFluentBuilder
impl !UnwindSafe for CreateContainerFleetFluentBuilder
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);