Class: AWSCDK::GameLift::CfnFleetProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
game_lift/cfn_fleet_props.rb

Overview

Properties for defining a CfnFleet.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, anywhere_configuration: nil, apply_capacity: nil, build_id: nil, certificate_configuration: nil, compute_type: nil, description: nil, desired_ec2_instances: nil, ec2_inbound_permissions: nil, ec2_instance_type: nil, fleet_type: nil, instance_role_arn: nil, instance_role_credentials_provider: nil, locations: nil, log_paths: nil, max_size: nil, metric_groups: nil, min_size: nil, new_game_session_protection_policy: nil, peer_vpc_aws_account_id: nil, peer_vpc_id: nil, player_gateway_configuration: nil, player_gateway_mode: nil, resource_creation_limit_policy: nil, runtime_configuration: nil, scaling_policies: nil, script_id: nil, server_launch_parameters: nil, server_launch_path: nil, tags: nil) ⇒ CfnFleetProps

Returns a new instance of CfnFleetProps.

Parameters:

  • name (String) —

    A descriptive label that is associated with a fleet.

  • anywhere_configuration (AWSCDK::IResolvable, AWSCDK::GameLift::CfnFleet::AnywhereConfigurationProperty, nil) (defaults to: nil) —

    Amazon GameLift Servers Anywhere configuration options.

  • apply_capacity (String, nil) (defaults to: nil) —

    Current resource capacity settings for managed EC2 fleets and managed container fleets.

  • build_id (String, nil) (defaults to: nil) —

    A unique identifier for a build to be deployed on the new fleet.

  • certificate_configuration (AWSCDK::IResolvable, AWSCDK::GameLift::CfnFleet::CertificateConfigurationProperty, nil) (defaults to: nil) —

    Prompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet.

  • compute_type (String, nil) (defaults to: nil) —

    The type of compute resource used to host your game servers.

  • description (String, nil) (defaults to: nil) —

    A description for the fleet.

  • desired_ec2_instances (Numeric, nil) (defaults to: nil) —

    [DEPRECATED] The number of EC2 instances that you want this fleet to host.

  • ec2_inbound_permissions (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::GameLift::CfnFleet::IPPermissionProperty>, nil) (defaults to: nil) —

    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, nil) (defaults to: nil) —

    The Amazon GameLift Servers-supported Amazon EC2 instance type to use with managed EC2 fleets.

  • fleet_type (String, nil) (defaults to: nil) —

    Indicates whether to use On-Demand or Spot instances for this fleet.

  • instance_role_arn (String, nil) (defaults to: nil) —

    A unique identifier for an IAM role that manages access to your AWS services.

  • instance_role_credentials_provider (String, nil) (defaults to: nil) —

    Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn .

  • locations (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::GameLift::CfnFleet::LocationConfigurationProperty>, nil) (defaults to: nil) —

    A set of remote locations to deploy additional instances to and manage as a multi-location fleet.

  • log_paths (Array<String>, nil) (defaults to: nil) —

    This parameter is no longer used.

  • max_size (Numeric, nil) (defaults to: nil) —

    [DEPRECATED] The maximum value that is allowed for the fleet's instance count.

  • metric_groups (Array<String>, nil) (defaults to: nil) —

    The name of an AWS CloudWatch metric group to add this fleet to.

  • min_size (Numeric, nil) (defaults to: nil) —

    [DEPRECATED] The minimum value allowed for the fleet's instance count.

  • new_game_session_protection_policy (String, nil) (defaults to: nil) —

    The status of termination protection for active game sessions on the fleet.

  • peer_vpc_aws_account_id (String, nil) (defaults to: nil) —

    Used when peering your Amazon GameLift Servers fleet with a VPC, the unique identifier for the AWS account that owns the VPC.

  • peer_vpc_id (String, nil) (defaults to: nil) —

    A unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet.

  • player_gateway_configuration (AWSCDK::IResolvable, AWSCDK::GameLift::CfnFleet::PlayerGatewayConfigurationProperty, nil) (defaults to: nil) —

    Configuration for player gateway.

  • player_gateway_mode (String, nil) (defaults to: nil) —

    The player gateway mode for the fleet.

  • resource_creation_limit_policy (AWSCDK::IResolvable, AWSCDK::GameLift::CfnFleet::ResourceCreationLimitPolicyProperty, nil) (defaults to: nil) —

    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 (AWSCDK::IResolvable, AWSCDK::GameLift::CfnFleet::RuntimeConfigurationProperty, nil) (defaults to: nil) —

    Instructions for how to launch and maintain server processes on instances in the fleet.

  • scaling_policies (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::GameLift::CfnFleet::ScalingPolicyProperty>, nil) (defaults to: nil) —

    Rule that controls how a fleet is scaled.

  • script_id (String, nil) (defaults to: nil) —

    The unique identifier for a Realtime configuration script to be deployed on fleet instances.

  • server_launch_parameters (String, nil) (defaults to: nil) —

    This parameter is no longer used but is retained for backward compatibility.

  • server_launch_path (String, nil) (defaults to: nil) —

    This parameter is no longer used.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    An array of key-value pairs to apply to this resource.



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'game_lift/cfn_fleet_props.rb', line 39

def initialize(name:, anywhere_configuration: nil, apply_capacity: nil, build_id: nil, certificate_configuration: nil, compute_type: nil, description: nil, desired_ec2_instances: nil, ec2_inbound_permissions: nil, ec2_instance_type: nil, fleet_type: nil, instance_role_arn: nil, instance_role_credentials_provider: nil, locations: nil, log_paths: nil, max_size: nil, metric_groups: nil, min_size: nil, new_game_session_protection_policy: nil, peer_vpc_aws_account_id: nil, peer_vpc_id: nil, player_gateway_configuration: nil, player_gateway_mode: nil, resource_creation_limit_policy: nil, runtime_configuration: nil, scaling_policies: nil, script_id: nil, server_launch_parameters: nil, server_launch_path: nil, tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @anywhere_configuration = anywhere_configuration.is_a?(Hash) ? ::AWSCDK::GameLift::CfnFleet::AnywhereConfigurationProperty.new(**anywhere_configuration.transform_keys(&:to_sym)) : anywhere_configuration
  Jsii::Type.check_type(@anywhere_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nYW1lbGlmdC5DZm5GbGVldC5Bbnl3aGVyZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "anywhereConfiguration") unless @anywhere_configuration.nil?
  @apply_capacity = apply_capacity
  Jsii::Type.check_type(@apply_capacity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applyCapacity") unless @apply_capacity.nil?
  @build_id = build_id
  Jsii::Type.check_type(@build_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "buildId") unless @build_id.nil?
  @certificate_configuration = certificate_configuration.is_a?(Hash) ? ::AWSCDK::GameLift::CfnFleet::CertificateConfigurationProperty.new(**certificate_configuration.transform_keys(&:to_sym)) : certificate_configuration
  Jsii::Type.check_type(@certificate_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nYW1lbGlmdC5DZm5GbGVldC5DZXJ0aWZpY2F0ZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "certificateConfiguration") unless @certificate_configuration.nil?
  @compute_type = compute_type
  Jsii::Type.check_type(@compute_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "computeType") unless @compute_type.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @desired_ec2_instances = desired_ec2_instances
  Jsii::Type.check_type(@desired_ec2_instances, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "desiredEc2Instances") unless @desired_ec2_instances.nil?
  @ec2_inbound_permissions = ec2_inbound_permissions
  Jsii::Type.check_type(@ec2_inbound_permissions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ2FtZWxpZnQuQ2ZuRmxlZXQuSXBQZXJtaXNzaW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "ec2InboundPermissions") unless @ec2_inbound_permissions.nil?
  @ec2_instance_type = ec2_instance_type
  Jsii::Type.check_type(@ec2_instance_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ec2InstanceType") unless @ec2_instance_type.nil?
  @fleet_type = fleet_type
  Jsii::Type.check_type(@fleet_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fleetType") unless @fleet_type.nil?
  @instance_role_arn = instance_role_arn
  Jsii::Type.check_type(@instance_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceRoleArn") unless @instance_role_arn.nil?
  @instance_role_credentials_provider = instance_role_credentials_provider
  Jsii::Type.check_type(@instance_role_credentials_provider, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceRoleCredentialsProvider") unless @instance_role_credentials_provider.nil?
  @locations = locations
  Jsii::Type.check_type(@locations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ2FtZWxpZnQuQ2ZuRmxlZXQuTG9jYXRpb25Db25maWd1cmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "locations") unless @locations.nil?
  @log_paths = log_paths
  Jsii::Type.check_type(@log_paths, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "logPaths") unless @log_paths.nil?
  @max_size = max_size
  Jsii::Type.check_type(@max_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxSize") unless @max_size.nil?
  @metric_groups = metric_groups
  Jsii::Type.check_type(@metric_groups, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "metricGroups") unless @metric_groups.nil?
  @min_size = min_size
  Jsii::Type.check_type(@min_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minSize") unless @min_size.nil?
  @new_game_session_protection_policy = new_game_session_protection_policy
  Jsii::Type.check_type(@new_game_session_protection_policy, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newGameSessionProtectionPolicy") unless @new_game_session_protection_policy.nil?
  @peer_vpc_aws_account_id = 
  Jsii::Type.check_type(@peer_vpc_aws_account_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "peerVpcAwsAccountId") unless @peer_vpc_aws_account_id.nil?
  @peer_vpc_id = peer_vpc_id
  Jsii::Type.check_type(@peer_vpc_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "peerVpcId") unless @peer_vpc_id.nil?
  @player_gateway_configuration = player_gateway_configuration.is_a?(Hash) ? ::AWSCDK::GameLift::CfnFleet::PlayerGatewayConfigurationProperty.new(**player_gateway_configuration.transform_keys(&:to_sym)) : player_gateway_configuration
  Jsii::Type.check_type(@player_gateway_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nYW1lbGlmdC5DZm5GbGVldC5QbGF5ZXJHYXRld2F5Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "playerGatewayConfiguration") unless @player_gateway_configuration.nil?
  @player_gateway_mode = player_gateway_mode
  Jsii::Type.check_type(@player_gateway_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "playerGatewayMode") unless @player_gateway_mode.nil?
  @resource_creation_limit_policy = resource_creation_limit_policy.is_a?(Hash) ? ::AWSCDK::GameLift::CfnFleet::ResourceCreationLimitPolicyProperty.new(**resource_creation_limit_policy.transform_keys(&:to_sym)) : resource_creation_limit_policy
  Jsii::Type.check_type(@resource_creation_limit_policy, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nYW1lbGlmdC5DZm5GbGVldC5SZXNvdXJjZUNyZWF0aW9uTGltaXRQb2xpY3lQcm9wZXJ0eSJ9XX19")), "resourceCreationLimitPolicy") unless @resource_creation_limit_policy.nil?
  @runtime_configuration = runtime_configuration.is_a?(Hash) ? ::AWSCDK::GameLift::CfnFleet::RuntimeConfigurationProperty.new(**runtime_configuration.transform_keys(&:to_sym)) : runtime_configuration
  Jsii::Type.check_type(@runtime_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nYW1lbGlmdC5DZm5GbGVldC5SdW50aW1lQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "runtimeConfiguration") unless @runtime_configuration.nil?
  @scaling_policies = scaling_policies
  Jsii::Type.check_type(@scaling_policies, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ2FtZWxpZnQuQ2ZuRmxlZXQuU2NhbGluZ1BvbGljeVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "scalingPolicies") unless @scaling_policies.nil?
  @script_id = script_id
  Jsii::Type.check_type(@script_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scriptId") unless @script_id.nil?
  @server_launch_parameters = server_launch_parameters
  Jsii::Type.check_type(@server_launch_parameters, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serverLaunchParameters") unless @server_launch_parameters.nil?
  @server_launch_path = server_launch_path
  Jsii::Type.check_type(@server_launch_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serverLaunchPath") unless @server_launch_path.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#anywhere_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Amazon GameLift Servers Anywhere configuration options.

Returns:

See Also:



113
114
115
 
# File 'game_lift/cfn_fleet_props.rb', line 113

def anywhere_configuration
  @anywhere_configuration
end

#apply_capacity ⇒ String? (readonly)

Current resource capacity settings for managed EC2 fleets and managed container fleets.

For multi-location fleets, location values might refer to a fleet's remote location or its home Region.

Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity

Returns:

  • (String, nil)

See Also:



122
123
124
 
# File 'game_lift/cfn_fleet_props.rb', line 122

def apply_capacity
  @apply_capacity
end

#build_id ⇒ String? (readonly)

A unique identifier for a build to be deployed on the new fleet.

If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.

Returns:

  • (String, nil)

See Also:



129
130
131
 
# File 'game_lift/cfn_fleet_props.rb', line 129

def build_id
  @build_id
end

#certificate_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Prompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet.

Amazon GameLift Servers uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift Servers. 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.

ACM isn't available in all AWS 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 .

Returns:

See Also:



140
141
142
 
# File 'game_lift/cfn_fleet_props.rb', line 140

def certificate_configuration
  @certificate_configuration
end

#compute_type ⇒ String? (readonly)

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.
  • ANYWHERE – Game servers and supporting software are deployed to compute resources that you provide and manage. With this compute type, you can also set the AnywhereConfiguration parameter.

Returns:

  • (String, nil)

See Also:



148
149
150
 
# File 'game_lift/cfn_fleet_props.rb', line 148

def compute_type
  @compute_type
end

#description ⇒ String? (readonly)

A description for the fleet.

Returns:

  • (String, nil)

See Also:



153
154
155
 
# File 'game_lift/cfn_fleet_props.rb', line 153

def description
  @description
end

#desired_ec2_instances ⇒ Numeric? (readonly)

Deprecated.

this property has been deprecated

[DEPRECATED] The number of EC2 instances that you want this fleet to host.

When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.

Returns:

  • (Numeric, nil)

See Also:



161
162
163
 
# File 'game_lift/cfn_fleet_props.rb', line 161

def desired_ec2_instances
  @desired_ec2_instances
end

#ec2_inbound_permissions ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



168
169
170
 
# File 'game_lift/cfn_fleet_props.rb', line 168

def ec2_inbound_permissions
  @ec2_inbound_permissions
end

#ec2_instance_type ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



175
176
177
 
# File 'game_lift/cfn_fleet_props.rb', line 175

def ec2_instance_type
  @ec2_instance_type
end

#fleet_type ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



182
183
184
 
# File 'game_lift/cfn_fleet_props.rb', line 182

def fleet_type
  @fleet_type
end

#instance_role_arn ⇒ String? (readonly)

A unique identifier for an 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 in the AWS Management Console . Learn more about using on-box credentials for your game servers at Access external resources from a game server . This attribute is used with fleets where ComputeType is EC2 .

Returns:

  • (String, nil)

See Also:



189
190
191
 
# File 'game_lift/cfn_fleet_props.rb', line 189

def instance_role_arn
  @instance_role_arn
end

#instance_role_credentials_provider ⇒ String? (readonly)

Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn .

Shared credentials allow applications that are deployed with the game server executable to communicate with other AWS resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other AWS resources from your fleets . This attribute is used with fleets where ComputeType is EC2 .

Returns:

  • (String, nil)

See Also:



196
197
198
 
# File 'game_lift/cfn_fleet_props.rb', line 196

def instance_role_credentials_provider
  @instance_role_credentials_provider
end

#locations ⇒ AWSCDK::IResolvable, ... (readonly)

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 AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift Servers. Provide a list of one or more AWS Region codes, such as us-west-2 , or Local Zone names. When using this parameter, Amazon GameLift Servers requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift Servers service locations for managed hosting.

Returns:

See Also:



203
204
205
 
# File 'game_lift/cfn_fleet_props.rb', line 203

def locations
  @locations
end

#log_paths ⇒ Array<String>? (readonly)

Deprecated.

this property has been deprecated

This parameter is no longer used.

When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()

Returns:

  • (Array<String>, nil)

See Also:



211
212
213
 
# File 'game_lift/cfn_fleet_props.rb', line 211

def log_paths
  @log_paths
end

#max_size ⇒ Numeric? (readonly)

Deprecated.

this property has been deprecated

[DEPRECATED] The maximum value that is allowed for the fleet's instance count.

When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.

Returns:

  • (Numeric, nil)

See Also:



219
220
221
 
# File 'game_lift/cfn_fleet_props.rb', line 219

def max_size
  @max_size
end

#metric_groups ⇒ Array<String>? (readonly)

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.

Returns:

  • (Array<String>, nil)

See Also:



226
227
228
 
# File 'game_lift/cfn_fleet_props.rb', line 226

def metric_groups
  @metric_groups
end

#min_size ⇒ Numeric? (readonly)

Deprecated.

this property has been deprecated

[DEPRECATED] The minimum value allowed for the fleet's instance count.

When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.

Returns:

  • (Numeric, nil)

See Also:



234
235
236
 
# File 'game_lift/cfn_fleet_props.rb', line 234

def min_size
  @min_size
end

#name ⇒ String (readonly)

A descriptive label that is associated with a fleet.

Fleet names do not need to be unique.

Returns:

  • (String)

See Also:



108
109
110
 
# File 'game_lift/cfn_fleet_props.rb', line 108

def name
  @name
end

#new_game_session_protection_policy ⇒ String? (readonly)

The status of termination protection for active game sessions on the fleet.

By default, this property is set to NoProtection .

  • 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, nil)

See Also:



244
245
246
 
# File 'game_lift/cfn_fleet_props.rb', line 244

def new_game_session_protection_policy
  @new_game_session_protection_policy
end

#peer_vpc_aws_account_id ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



251
252
253
 
# File 'game_lift/cfn_fleet_props.rb', line 251

def 
  @peer_vpc_aws_account_id
end

#peer_vpc_id ⇒ String? (readonly)

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet.

The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console . Learn more about VPC peering in VPC Peering with Amazon GameLift Servers Fleets .

Returns:

  • (String, nil)

See Also:



258
259
260
 
# File 'game_lift/cfn_fleet_props.rb', line 258

def peer_vpc_id
  @peer_vpc_id
end

#player_gateway_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration for player gateway.

Returns:

See Also:



263
264
265
 
# File 'game_lift/cfn_fleet_props.rb', line 263

def player_gateway_configuration
  @player_gateway_configuration
end

#player_gateway_mode ⇒ String? (readonly)

The player gateway mode for the fleet.

Returns:

  • (String, nil)

See Also:



268
269
270
 
# File 'game_lift/cfn_fleet_props.rb', line 268

def player_gateway_mode
  @player_gateway_mode
end

#resource_creation_limit_policy ⇒ AWSCDK::IResolvable, ... (readonly)

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:

See Also:



273
274
275
 
# File 'game_lift/cfn_fleet_props.rb', line 273

def resource_creation_limit_policy
  @resource_creation_limit_policy
end

#runtime_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

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.

Returns:

See Also:



282
283
284
 
# File 'game_lift/cfn_fleet_props.rb', line 282

def runtime_configuration
  @runtime_configuration
end

#scaling_policies ⇒ AWSCDK::IResolvable, ... (readonly)

Rule that controls how a fleet is scaled.

Scaling policies are uniquely identified by the combination of name and fleet ID.

Returns:

See Also:



289
290
291
 
# File 'game_lift/cfn_fleet_props.rb', line 289

def scaling_policies
  @scaling_policies
end

#script_id ⇒ String? (readonly)

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 Amazon GameLift Servers prior to creating the fleet. This fleet property cannot be changed later.

You can't use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId . Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId . Alternatively, enter a ScriptId string manually.

Returns:

  • (String, nil)

See Also:



298
299
300
 
# File 'game_lift/cfn_fleet_props.rb', line 298

def script_id
  @script_id
end

#server_launch_parameters ⇒ String? (readonly)

Deprecated.

this property has been deprecated

This parameter is no longer used but is retained for backward compatibility.

Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.

Returns:

  • (String, nil)

See Also:



306
307
308
 
# File 'game_lift/cfn_fleet_props.rb', line 306

def server_launch_parameters
  @server_launch_parameters
end

#server_launch_path ⇒ String? (readonly)

Deprecated.

this property has been deprecated

This parameter is no longer used.

Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.

Returns:

  • (String, nil)

See Also:



314
315
316
 
# File 'game_lift/cfn_fleet_props.rb', line 314

def server_launch_path
  @server_launch_path
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An array of key-value pairs to apply to this resource.

Returns:

See Also:



319
320
321
 
# File 'game_lift/cfn_fleet_props.rb', line 319

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'game_lift/cfn_fleet_props.rb', line 321

def self.jsii_properties
  {
    :name => "name",
    :anywhere_configuration => "anywhereConfiguration",
    :apply_capacity => "applyCapacity",
    :build_id => "buildId",
    :certificate_configuration => "certificateConfiguration",
    :compute_type => "computeType",
    :description => "description",
    :desired_ec2_instances => "desiredEc2Instances",
    :ec2_inbound_permissions => "ec2InboundPermissions",
    :ec2_instance_type => "ec2InstanceType",
    :fleet_type => "fleetType",
    :instance_role_arn => "instanceRoleArn",
    :instance_role_credentials_provider => "instanceRoleCredentialsProvider",
    :locations => "locations",
    :log_paths => "logPaths",
    :max_size => "maxSize",
    :metric_groups => "metricGroups",
    :min_size => "minSize",
    :new_game_session_protection_policy => "newGameSessionProtectionPolicy",
    :peer_vpc_aws_account_id => "peerVpcAwsAccountId",
    :peer_vpc_id => "peerVpcId",
    :player_gateway_configuration => "playerGatewayConfiguration",
    :player_gateway_mode => "playerGatewayMode",
    :resource_creation_limit_policy => "resourceCreationLimitPolicy",
    :runtime_configuration => "runtimeConfiguration",
    :scaling_policies => "scalingPolicies",
    :script_id => "scriptId",
    :server_launch_parameters => "serverLaunchParameters",
    :server_launch_path => "serverLaunchPath",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'game_lift/cfn_fleet_props.rb', line 356

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "anywhereConfiguration" => @anywhere_configuration,
    "applyCapacity" => @apply_capacity,
    "buildId" => @build_id,
    "certificateConfiguration" => @certificate_configuration,
    "computeType" => @compute_type,
    "description" => @description,
    "desiredEc2Instances" => @desired_ec2_instances,
    "ec2InboundPermissions" => @ec2_inbound_permissions,
    "ec2InstanceType" => @ec2_instance_type,
    "fleetType" => @fleet_type,
    "instanceRoleArn" => @instance_role_arn,
    "instanceRoleCredentialsProvider" => @instance_role_credentials_provider,
    "locations" => @locations,
    "logPaths" => @log_paths,
    "maxSize" => @max_size,
    "metricGroups" => @metric_groups,
    "minSize" => @min_size,
    "newGameSessionProtectionPolicy" => @new_game_session_protection_policy,
    "peerVpcAwsAccountId" => @peer_vpc_aws_account_id,
    "peerVpcId" => @peer_vpc_id,
    "playerGatewayConfiguration" => @player_gateway_configuration,
    "playerGatewayMode" => @player_gateway_mode,
    "resourceCreationLimitPolicy" => @resource_creation_limit_policy,
    "runtimeConfiguration" => @runtime_configuration,
    "scalingPolicies" => @scaling_policies,
    "scriptId" => @script_id,
    "serverLaunchParameters" => @server_launch_parameters,
    "serverLaunchPath" => @server_launch_path,
    "tags" => @tags,
  })
  result.compact
end