AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
public class FleetAttributes
The FleetAttributes type exposes the following members
Name | Description | |
---|---|---|
FleetAttributes() |
Name | Type | Description | |
---|---|---|---|
AnywhereConfiguration | Amazon.GameLift.Model.AnywhereConfiguration |
Gets and sets the property 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
|
|
BuildArn | System.String |
Gets and sets the property BuildArn.
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 | System.String |
Gets and sets the property BuildId.
A unique identifier for the build resource that is deployed on instances in this fleet.
This attribute is used with fleets where |
|
CertificateConfiguration | Amazon.GameLift.Model.CertificateConfiguration |
Gets and sets the property 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. |
|
ComputeType | Amazon.GameLift.ComputeType |
Gets and sets the property 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. |
|
ContainerGroupsAttributes | Amazon.GameLift.Model.ContainerGroupsAttributes |
Gets and sets the property 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 |
|
CreationTime | System.DateTime |
Gets and sets the property CreationTime.
A time stamp indicating when this data object was created. Format is a number expressed
in Unix time as milliseconds (for example |
|
Description | System.String |
Gets and sets the property Description. A human-readable description of the fleet. |
|
FleetArn | System.String |
Gets and sets the property FleetArn.
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 |
|
FleetId | System.String |
Gets and sets the property FleetId. A unique identifier for the fleet. |
|
FleetType | Amazon.GameLift.FleetType |
Gets and sets the property 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. |
|
InstanceRoleArn | System.String |
Gets and sets the property InstanceRoleArn.
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 |
|
InstanceRoleCredentialsProvider | Amazon.GameLift.InstanceRoleCredentialsProvider |
Gets and sets the property InstanceRoleCredentialsProvider.
Indicates that fleet instances maintain a shared credentials file for the IAM role
defined in |
|
InstanceType | Amazon.GameLift.EC2InstanceType |
Gets and sets the property InstanceType.
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 |
|
LogPaths | System.Collections.Generic.List<System.String> |
Gets and sets the property LogPaths.
This parameter is no longer used. Game session log paths are now defined using
the Amazon GameLift server API |
|
MetricGroups | System.Collections.Generic.List<System.String> |
Gets and sets the property MetricGroups.
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 |
|
Name | System.String |
Gets and sets the property Name. A descriptive label that is associated with a fleet. Fleet names do not need to be unique. |
|
NewGameSessionProtectionPolicy | Amazon.GameLift.ProtectionPolicy |
Gets and sets the property NewGameSessionProtectionPolicy.
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
|
|
OperatingSystem | Amazon.GameLift.OperatingSystem |
Gets and sets the property 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 |
|
ResourceCreationLimitPolicy | Amazon.GameLift.Model.ResourceCreationLimitPolicy |
Gets and sets the property ResourceCreationLimitPolicy. |
|
ScriptArn | System.String |
Gets and sets the property ScriptArn.
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 | System.String |
Gets and sets the property ScriptId.
A unique identifier for the Realtime script resource that is deployed on instances
in this fleet. This attribute is used with fleets where |
|
ServerLaunchParameters | System.String |
Gets and sets the property ServerLaunchParameters. 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. |
|
ServerLaunchPath | System.String |
Gets and sets the property ServerLaunchPath. 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. |
|
Status | Amazon.GameLift.FleetStatus |
Gets and sets the property Status. Current status of the fleet. Possible fleet statuses include the following:
|
|
StoppedActions | System.Collections.Generic.List<System.String> |
Gets and sets the property StoppedActions.
A list of fleet activity that has been suspended using StopFleetActions.
This includes fleet auto-scaling. This attribute is used with fleets where |
|
TerminationTime | System.DateTime |
Gets and sets the property TerminationTime.
A time stamp indicating when this data object was terminated. Format is a number expressed
in Unix time as milliseconds (for example |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5