Class: Aws::GameLift::Types::CreateFleetInput

Inherits:

Struct

Object
Struct
Aws::GameLift::Types::CreateFleetInput

show all

Includes:: Structure

Defined in:: lib/aws-sdk-gamelift/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#anywhere_configuration ⇒ Types::AnywhereConfiguration

Amazon GameLift Anywhere configuration options.
#build_id ⇒ String

The unique identifier for a custom game server build to be deployed to a fleet with compute type ‘EC2`.
#certificate_configuration ⇒ Types::CertificateConfiguration

Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.
#compute_type ⇒ String

The type of compute resource used to host your game servers.
#container_groups_configuration ⇒ Types::ContainerGroupsConfiguration

The container groups to deploy to instances in the container fleet and other fleet-level configuration settings.
#description ⇒ String

A description for the fleet.
#ec2_inbound_permissions ⇒ Array<Types::IpPermission>

The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
#ec2_instance_type ⇒ String

The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets.
#fleet_type ⇒ String

Indicates whether to use On-Demand or Spot instances for this fleet.
#instance_role_arn ⇒ String

A unique identifier for an IAM role with access permissions to other Amazon Web Services services.
#instance_role_credentials_provider ⇒ String

Prompts Amazon GameLift to generate a shared credentials file for the IAM role that’s defined in ‘InstanceRoleArn`.
#locations ⇒ Array<Types::LocationConfiguration>

A set of remote locations to deploy additional instances to and manage as a multi-location fleet.
#log_paths ⇒ Array<String>

**This parameter is no longer used.** To specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ‘ProcessReady()` and specify one or more directory paths in `logParameters`.
#metric_groups ⇒ Array<String>

The name of an Amazon Web Services CloudWatch metric group to add this fleet to.
#name ⇒ String

A descriptive label that is associated with a fleet.
#new_game_session_protection_policy ⇒ String

The status of termination protection for active game sessions on the fleet.
#peer_vpc_aws_account_id ⇒ String

Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC.
#peer_vpc_id ⇒ String

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.
#resource_creation_limit_policy ⇒ Types::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.
#runtime_configuration ⇒ Types::RuntimeConfiguration

Instructions for how to launch and run server processes on the fleet.
#script_id ⇒ String

The unique identifier for a Realtime configuration script to be deployed to a fleet with compute type ‘EC2`.
#server_launch_parameters ⇒ String

**This parameter is no longer used.** Specify server launch parameters using the ‘RuntimeConfiguration` parameter.
#server_launch_path ⇒ String

**This parameter is no longer used.** Specify a server launch path using the ‘RuntimeConfiguration` parameter.
#tags ⇒ Array<Types::Tag>

A list of labels to assign to the new fleet resource.

Instance Attribute Details

#anywhere_configuration ⇒ `Types::AnywhereConfiguration`

Amazon GameLift Anywhere configuration options.

Returns:

(Types::AnywhereConfiguration)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#build_id ⇒ `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 and in `READY` status. This fleet property can’t be changed after the fleet is created.

Returns:

(String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_configuration ⇒ `Types::CertificateConfiguration`

Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. 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.

<note markdown=“1”> 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*.

</note>

[1]: docs.aws.amazon.com/acm/latest/userguide/acm-regions.html

Returns:

(Types::CertificateConfiguration)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#compute_type ⇒ `String`

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.
‘CONTAINER` – Container images with your game server build and supporting software are deployed to Amazon EC2 instances for cloud hosting. With this compute type, you must specify the `ContainerGroupsConfiguration` parameter.
‘ANYWHERE` – Game servers or container images with your game server and supporting software are deployed to compute resources that are provided and managed by you. With this compute type, you can also set the `AnywhereConfiguration` parameter.

Returns:

(String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#container_groups_configuration ⇒ `Types::ContainerGroupsConfiguration`

The container groups to deploy to instances in the container fleet and other fleet-level configuration settings. Use the CreateContainerGroupDefinition action to create container groups. A container fleet must have exactly one replica container group, and can optionally have one daemon container group. You can’t change this property after you create the fleet.

Returns:

(Types::ContainerGroupsConfiguration)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A description for the fleet.

Returns:

(String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_inbound_permissions ⇒ `Array<Types::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 EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call 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 Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.

To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet’s connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.

Returns:

(Array<Types::IpPermission>)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_instance_type ⇒ `String`

The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container 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.

[1]: aws.amazon.com/ec2/instance-types/

Returns:

(String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#fleet_type ⇒ `String`

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.

[1]: docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot

Returns:

(String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#instance_role_arn ⇒ `String`

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 fleet property can’t be changed after the fleet is created.

[1]: docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html

Returns:

(String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#instance_role_credentials_provider ⇒ `String`

Prompts Amazon GameLift 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].

[1]: docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html

Returns:

(String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#locations ⇒ `Array<Types::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. 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 requires you to include your home location in the request. For a list of supported Regions and Local Zones, see [ Amazon GameLift service locations] for managed hosting.

[1]: docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html

Returns:

(Array<Types::LocationConfiguration>)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#log_paths ⇒ `Array<String>`

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

[1]: docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize

Returns:

(Array<String>)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#metric_groups ⇒ `Array<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.

Returns:

(Array<String>)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#new_game_session_protection_policy ⇒ `String`

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](gamelift/latest/apireference/API_UpdateGameSession.html).

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.

Returns:

(String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#peer_vpc_aws_account_id ⇒ `String`

Used when peering your Amazon GameLift 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.

Returns:

(String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#peer_vpc_id ⇒ `String`

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift 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 Fleets].

[1]: console.aws.amazon.com/vpc/ [2]: docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html

Returns:

(String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#resource_creation_limit_policy ⇒ `Types::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.

Returns:

(Types::ResourceCreationLimitPolicy)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#runtime_configuration ⇒ `Types::RuntimeConfiguration`

Instructions for how to launch and run server processes on the fleet. Set runtime configuration for EC2 fleets and container fleets. For an Anywhere fleets, set this parameter only if the fleet is running the Amazon GameLift 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.

<note markdown=“1”> This parameter replaces the parameters ‘ServerLaunchPath` and `ServerLaunchParameters`, which are still supported for backward compatibility.

</note>

Returns:

(Types::RuntimeConfiguration)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#script_id ⇒ `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 prior to creating the fleet. This fleet property can’t be changed after the fleet is created.

Returns:

(String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#server_launch_parameters ⇒ `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.

Returns:

(String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#server_launch_path ⇒ `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.

Returns:

(String)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::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*.

[1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-gamelift/types.rb', line 2096

class CreateFleetInput < Struct.new(
  :name,
  :description,
  :build_id,
  :script_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :ec2_instance_type,
  :ec2_inbound_permissions,
  :new_game_session_protection_policy,
  :runtime_configuration,
  :resource_creation_limit_policy,
  :metric_groups,
  :peer_vpc_aws_account_id,
  :peer_vpc_id,
  :fleet_type,
  :instance_role_arn,
  :certificate_configuration,
  :locations,
  :tags,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_configuration)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::GameLift::Types::CreateFleetInput

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#anywhere_configuration ⇒ Types::AnywhereConfiguration

#build_id ⇒ String

#certificate_configuration ⇒ Types::CertificateConfiguration

#compute_type ⇒ String

#container_groups_configuration ⇒ Types::ContainerGroupsConfiguration

#description ⇒ String

#ec2_inbound_permissions ⇒ Array<Types::IpPermission>

#ec2_instance_type ⇒ String

#fleet_type ⇒ String

#instance_role_arn ⇒ String

#instance_role_credentials_provider ⇒ String

#locations ⇒ Array<Types::LocationConfiguration>

#log_paths ⇒ Array<String>

#metric_groups ⇒ Array<String>

#name ⇒ String

#new_game_session_protection_policy ⇒ String

#peer_vpc_aws_account_id ⇒ String

#peer_vpc_id ⇒ String

#resource_creation_limit_policy ⇒ Types::ResourceCreationLimitPolicy

#runtime_configuration ⇒ Types::RuntimeConfiguration

#script_id ⇒ String

#server_launch_parameters ⇒ String

#server_launch_path ⇒ String

#tags ⇒ Array<Types::Tag>

#anywhere_configuration ⇒ `Types::AnywhereConfiguration`

#build_id ⇒ `String`

#certificate_configuration ⇒ `Types::CertificateConfiguration`

#compute_type ⇒ `String`

#container_groups_configuration ⇒ `Types::ContainerGroupsConfiguration`

#description ⇒ `String`

#ec2_inbound_permissions ⇒ `Array<Types::IpPermission>`

#ec2_instance_type ⇒ `String`

#fleet_type ⇒ `String`

#instance_role_arn ⇒ `String`

#instance_role_credentials_provider ⇒ `String`

#locations ⇒ `Array<Types::LocationConfiguration>`

#log_paths ⇒ `Array<String>`

#metric_groups ⇒ `Array<String>`

#name ⇒ `String`

#new_game_session_protection_policy ⇒ `String`

#peer_vpc_aws_account_id ⇒ `String`

#peer_vpc_id ⇒ `String`

#resource_creation_limit_policy ⇒ `Types::ResourceCreationLimitPolicy`

#runtime_configuration ⇒ `Types::RuntimeConfiguration`

#script_id ⇒ `String`

#server_launch_parameters ⇒ `String`

#server_launch_path ⇒ `String`

#tags ⇒ `Array<Types::Tag>`