NAME
Paws::GameLift::CreateFleet - Arguments for method CreateFleet on Paws::GameLift
DESCRIPTION
This class represents the parameters used for calling the method CreateFleet on the Amazon GameLift service. Use the attributes of this class as arguments to method CreateFleet.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFleet.
SYNOPSIS
my $gamelift = Paws->service('GameLift');
my $CreateFleetOutput = $gamelift->CreateFleet(
EC2InstanceType => 't2.micro',
Name => 'MyNonZeroAndMaxString',
BuildId => 'MyBuildIdOrArn', # OPTIONAL
CertificateConfiguration => {
CertificateType => 'DISABLED', # values: DISABLED, GENERATED
}, # OPTIONAL
Description => 'MyNonZeroAndMaxString', # OPTIONAL
EC2InboundPermissions => [
{
FromPort => 1, # min: 1, max: 60000
IpRange => 'MyNonBlankString',
Protocol => 'TCP', # values: TCP, UDP
ToPort => 1, # min: 1, max: 60000
},
...
], # OPTIONAL
FleetType => 'ON_DEMAND', # OPTIONAL
InstanceRoleArn => 'MyNonEmptyString', # OPTIONAL
Locations => [
{
Location => 'MyLocationStringModel', # min: 1, max: 64; OPTIONAL
},
...
], # OPTIONAL
LogPaths => [
'MyNonZeroAndMaxString', ... # min: 1, max: 1024
], # OPTIONAL
MetricGroups => [
'MyMetricGroup', ... # min: 1, max: 255
], # OPTIONAL
NewGameSessionProtectionPolicy => 'NoProtection', # OPTIONAL
PeerVpcAwsAccountId => 'MyNonZeroAndMaxString', # OPTIONAL
PeerVpcId => 'MyNonZeroAndMaxString', # OPTIONAL
ResourceCreationLimitPolicy => {
NewGameSessionsPerCreator => 1, # OPTIONAL
PolicyPeriodInMinutes => 1, # OPTIONAL
}, # OPTIONAL
RuntimeConfiguration => {
GameSessionActivationTimeoutSeconds => 1, # min: 1, max: 600; OPTIONAL
MaxConcurrentGameSessionActivations =>
1, # min: 1, max: 2147483647; OPTIONAL
ServerProcesses => [
{
ConcurrentExecutions => 1, # min: 1
LaunchPath => 'MyNonZeroAndMaxString', # min: 1, max: 1024
Parameters => 'MyNonZeroAndMaxString', # min: 1, max: 1024
},
...
], # min: 1, max: 50; OPTIONAL
}, # OPTIONAL
ScriptId => 'MyScriptIdOrArn', # OPTIONAL
ServerLaunchParameters => 'MyNonZeroAndMaxString', # OPTIONAL
ServerLaunchPath => 'MyNonZeroAndMaxString', # OPTIONAL
Tags => [
{
Key => 'MyTagKey', # min: 1, max: 128
Value => 'MyTagValue', # max: 256
},
...
], # OPTIONAL
);
# Results:
my $FleetAttributes = $CreateFleetOutput->FleetAttributes;
my $LocationStates = $CreateFleetOutput->LocationStates;
# Returns a L<Paws::GameLift::CreateFleetOutput> object.Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/gamelift/CreateFleet
ATTRIBUTES
BuildId => Str
The unique identifier for a custom game server build to be deployed on fleet instances. You can use either the build ID or ARN. The build must be uploaded to GameLift and in READY status. This fleet property cannot be changed later.
CertificateConfiguration => Paws::GameLift::CertificateConfiguration
Prompts GameLift to generate a TLS/SSL certificate for the fleet. TLS certificates are used for encrypting traffic between game clients and the game servers that are running on GameLift. By default, the CertificateConfiguration is set to DISABLED. Learn more at Securing Client/Server Communication (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-howitworks.html#gamelift-howitworks-security). This property cannot be changed after the fleet is created.
Note: This feature requires the AWS Certificate Manager (ACM) service, which is not available in all AWS regions. When working in a region that does not support this feature, a fleet creation request with certificate generation fails with a 4xx error.
Description => Str
A human-readable description of the fleet.
EC2InboundPermissions => ArrayRef[Paws::GameLift::IpPermission]
The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, GameLift automatically sets TCP and UDP ranges.
REQUIRED EC2InstanceType => Str
The GameLift-supported EC2 instance type to use for all fleet instances. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types (http://aws.amazon.com/ec2/instance-types/) for detailed descriptions of EC2 instance types.
Valid values are: "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge"
FleetType => Str
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 (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot). This property cannot be changed after the fleet is created.
Valid values are: "ON_DEMAND", "SPOT"
InstanceRoleArn => Str
A unique identifier for an AWS IAM role that manages access to your AWS 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 (https://console.aws.amazon.com/iam/) in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html). This property cannot be changed after the fleet is created.
Locations => ArrayRef[Paws::GameLift::LocationConfiguration]
A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as us-west-2. To create a fleet with instances in the home Region only, omit this parameter.
LogPaths => ArrayRef[Str|Undef]
This parameter is no longer used. To specify where GameLift should store log files once a server process shuts down, use the GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api-ref.html#gamelift-sdk-server-api-ref-dataypes-process).
MetricGroups => ArrayRef[Str|Undef]
The name of an AWS 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.
REQUIRED Name => Str
A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
NewGameSessionProtectionPolicy => Str
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
ACTIVEstatus cannot be terminated during a scale-down event.
Valid values are: "NoProtection", "FullProtection"
PeerVpcAwsAccountId => Str
Used when peering your GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC. You can find your account ID in the AWS Management Console under account settings.
PeerVpcId => Str
A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard (https://console.aws.amazon.com/vpc/) in the AWS Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html).
ResourceCreationLimitPolicy => Paws::GameLift::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.
RuntimeConfiguration => Paws::GameLift::RuntimeConfiguration
Instructions for how to launch and maintain server processes on instances in the fleet. The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently.
The RuntimeConfiguration parameter is required unless the fleet is being configured using the older parameters ServerLaunchPath and ServerLaunchParameters, which are still supported for backward compatibility.
ScriptId => Str
The unique identifier for a Realtime configuration script to be deployed on fleet instances. You can use either the script ID or ARN. Scripts must be uploaded to GameLift prior to creating the fleet. This fleet property cannot be changed later.
ServerLaunchParameters => Str
This parameter is no longer used. Specify server launch parameters using the RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.
ServerLaunchPath => Str
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.
Tags => ArrayRef[Paws::GameLift::Tag]
A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the AWS General Reference. Once the fleet is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
SEE ALSO
This class forms part of Paws, documenting arguments for method CreateFleet in Paws::GameLift
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues