CfnContainerFleetProps
- class aws_cdk.aws_gamelift.CfnContainerFleetProps(*, fleet_role_arn, billing_type=None, deployment_configuration=None, description=None, game_server_container_group_definition_name=None, game_server_container_groups_per_instance=None, game_session_creation_limit_policy=None, instance_connection_port_range=None, instance_inbound_permissions=None, instance_type=None, locations=None, log_configuration=None, metric_groups=None, new_game_session_protection_policy=None, per_instance_container_group_definition_name=None, scaling_policies=None, tags=None)
Bases:
objectProperties for defining a
CfnContainerFleet.- Parameters:
fleet_role_arn (
str) – The unique identifier for an AWS Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift Servers. See Set up an IAM service role . This fleet property can’t be changed.billing_type (
Optional[str]) – Indicates whether the fleet uses On-Demand or Spot instances for this fleet. Learn more about when to use On-Demand versus Spot Instances . You can’t update this fleet property. By default, this property is set toON_DEMAND.deployment_configuration (
Union[IResolvable,DeploymentConfigurationProperty,Dict[str,Any],None]) – Set of rules for processing a deployment for a container fleet update.description (
Optional[str]) – A meaningful description of the container fleet.game_server_container_group_definition_name (
Optional[str]) – The name of the fleet’s game server container group definition, which describes how to deploy containers with your game server build and support software onto each fleet instance.game_server_container_groups_per_instance (
Union[int,float,None]) – The number of times to replicate the game server container group on each fleet instance.game_session_creation_limit_policy (
Union[IResolvable,GameSessionCreationLimitPolicyProperty,Dict[str,Any],None]) – 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.instance_connection_port_range (
Union[IResolvable,ConnectionPortRangeProperty,Dict[str,Any],None]) – The set of port numbers to open on each instance in a container fleet. Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.instance_inbound_permissions (
Union[IResolvable,Sequence[Union[IResolvable,IpPermissionProperty,Dict[str,Any]]],None]) – The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.instance_type (
Optional[str]) – The Amazon EC2 instance type to use for all instances in the fleet. 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. You can’t update this fleet property.locations (
Union[IResolvable,Sequence[Union[IResolvable,LocationConfigurationProperty,Dict[str,Any]]],None]) –log_configuration (
Union[IResolvable,LogConfigurationProperty,Dict[str,Any],None]) – The method that is used to collect container logs for the fleet. Amazon GameLift Servers saves all standard output for each container in logs, including game session logs. -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.metric_groups (
Optional[Sequence[str]]) – The name of an AWS CloudWatch metric group to add this fleet to. Metric groups aggregate metrics for multiple fleets.new_game_session_protection_policy (
Optional[str]) – 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 inACTIVEstatus can’t be shut down.per_instance_container_group_definition_name (
Optional[str]) – The name of the fleet’s per-instance container group definition.scaling_policies (
Union[IResolvable,Sequence[Union[IResolvable,ScalingPolicyProperty,Dict[str,Any]]],None]) – A list of rules that control how a fleet is scaled.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – An array of key-value pairs to apply to this resource.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_gamelift as gamelift cfn_container_fleet_props = gamelift.CfnContainerFleetProps( fleet_role_arn="fleetRoleArn", # the properties below are optional billing_type="billingType", deployment_configuration=gamelift.CfnContainerFleet.DeploymentConfigurationProperty( impairment_strategy="impairmentStrategy", minimum_healthy_percentage=123, protection_strategy="protectionStrategy" ), description="description", game_server_container_group_definition_name="gameServerContainerGroupDefinitionName", game_server_container_groups_per_instance=123, game_session_creation_limit_policy=gamelift.CfnContainerFleet.GameSessionCreationLimitPolicyProperty( new_game_sessions_per_creator=123, policy_period_in_minutes=123 ), instance_connection_port_range=gamelift.CfnContainerFleet.ConnectionPortRangeProperty( from_port=123, to_port=123 ), instance_inbound_permissions=[gamelift.CfnContainerFleet.IpPermissionProperty( from_port=123, ip_range="ipRange", protocol="protocol", to_port=123 )], instance_type="instanceType", locations=[gamelift.CfnContainerFleet.LocationConfigurationProperty( location="location", # the properties below are optional location_capacity=gamelift.CfnContainerFleet.LocationCapacityProperty( desired_ec2_instances=123, max_size=123, min_size=123 ), stopped_actions=["stoppedActions"] )], log_configuration=gamelift.CfnContainerFleet.LogConfigurationProperty( log_destination="logDestination", s3_bucket_name="s3BucketName" ), metric_groups=["metricGroups"], new_game_session_protection_policy="newGameSessionProtectionPolicy", per_instance_container_group_definition_name="perInstanceContainerGroupDefinitionName", scaling_policies=[gamelift.CfnContainerFleet.ScalingPolicyProperty( metric_name="metricName", name="name", # the properties below are optional comparison_operator="comparisonOperator", evaluation_periods=123, policy_type="policyType", scaling_adjustment=123, scaling_adjustment_type="scalingAdjustmentType", target_configuration=gamelift.CfnContainerFleet.TargetConfigurationProperty( target_value=123 ), threshold=123 )], tags=[CfnTag( key="key", value="value" )] )
Attributes
- billing_type
Indicates whether the fleet uses On-Demand or Spot instances for this fleet.
Learn more about when to use On-Demand versus Spot Instances . You can’t update this fleet property.
By default, this property is set to
ON_DEMAND.
- deployment_configuration
Set of rules for processing a deployment for a container fleet update.
- description
A meaningful description of the container fleet.
- fleet_role_arn
The unique identifier for an AWS Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift Servers.
See Set up an IAM service role . This fleet property can’t be changed.
- game_server_container_group_definition_name
The name of the fleet’s game server container group definition, which describes how to deploy containers with your game server build and support software onto each fleet instance.
- game_server_container_groups_per_instance
The number of times to replicate the game server container group on each fleet instance.
- game_session_creation_limit_policy
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.
- instance_connection_port_range
The set of port numbers to open on each instance in a container fleet.
Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.
- 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.
- instance_type
The Amazon EC2 instance type to use for all instances in the fleet.
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. You can’t update this fleet property.
- locations
-
- Type:
see
- log_configuration
The method that is used to collect container logs for the fleet.
Amazon GameLift Servers saves all standard output for each container in logs, including game session logs.
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.
- metric_groups
The name of an AWS CloudWatch metric group to add this fleet to.
Metric groups aggregate metrics for multiple fleets.
- new_game_session_protection_policy
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
ACTIVEstatus can’t be shut down.
- per_instance_container_group_definition_name
The name of the fleet’s per-instance container group definition.
- scaling_policies
A list of rules that control how a fleet is scaled.
- tags
An array of key-value pairs to apply to this resource.