CfnFleet

class aws_cdk.aws_gamelift.CfnFleet(scope, id, *, ec2_instance_type, name, build_id=None, certificate_configuration=None, description=None, desired_ec2_instances=None, ec2_inbound_permissions=None, fleet_type=None, instance_role_arn=None, log_paths=None, max_size=None, metric_groups=None, min_size=None, new_game_session_protection_policy=None, peer_vpc_aws_account_id=None, peer_vpc_id=None, resource_creation_limit_policy=None, runtime_configuration=None, script_id=None, server_launch_parameters=None, server_launch_path=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::GameLift::Fleet.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html

CloudformationResource

AWS::GameLift::Fleet

Create a new AWS::GameLift::Fleet.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • ec2_instance_type (str) – AWS::GameLift::Fleet.EC2InstanceType.

  • name (str) – AWS::GameLift::Fleet.Name.

  • build_id (Optional[str]) – AWS::GameLift::Fleet.BuildId.

  • certificate_configuration (Union[IResolvable, CertificateConfigurationProperty, None]) – AWS::GameLift::Fleet.CertificateConfiguration.

  • description (Optional[str]) – AWS::GameLift::Fleet.Description.

  • desired_ec2_instances (Union[int, float, None]) – AWS::GameLift::Fleet.DesiredEC2Instances.

  • ec2_inbound_permissions (Union[IResolvable, List[Union[IResolvable, IpPermissionProperty]], None]) – AWS::GameLift::Fleet.EC2InboundPermissions.

  • fleet_type (Optional[str]) – AWS::GameLift::Fleet.FleetType.

  • instance_role_arn (Optional[str]) – AWS::GameLift::Fleet.InstanceRoleARN.

  • log_paths (Optional[List[str]]) – AWS::GameLift::Fleet.LogPaths.

  • max_size (Union[int, float, None]) – AWS::GameLift::Fleet.MaxSize.

  • metric_groups (Optional[List[str]]) – AWS::GameLift::Fleet.MetricGroups.

  • min_size (Union[int, float, None]) – AWS::GameLift::Fleet.MinSize.

  • new_game_session_protection_policy (Optional[str]) – AWS::GameLift::Fleet.NewGameSessionProtectionPolicy.

  • peer_vpc_aws_account_id (Optional[str]) – AWS::GameLift::Fleet.PeerVpcAwsAccountId.

  • peer_vpc_id (Optional[str]) – AWS::GameLift::Fleet.PeerVpcId.

  • resource_creation_limit_policy (Union[IResolvable, ResourceCreationLimitPolicyProperty, None]) – AWS::GameLift::Fleet.ResourceCreationLimitPolicy.

  • runtime_configuration (Union[IResolvable, RuntimeConfigurationProperty, None]) – AWS::GameLift::Fleet.RuntimeConfiguration.

  • script_id (Optional[str]) – AWS::GameLift::Fleet.ScriptId.

  • server_launch_parameters (Optional[str]) – AWS::GameLift::Fleet.ServerLaunchParameters.

  • server_launch_path (Optional[str]) – AWS::GameLift::Fleet.ServerLaunchPath.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::GameLift::Fleet'
build_id

AWS::GameLift::Fleet.BuildId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-buildid

Return type

Optional[str]

certificate_configuration

AWS::GameLift::Fleet.CertificateConfiguration.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-certificateconfiguration

Return type

Union[IResolvable, CertificateConfigurationProperty, None]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

description

AWS::GameLift::Fleet.Description.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-description

Return type

Optional[str]

desired_ec2_instances

AWS::GameLift::Fleet.DesiredEC2Instances.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-desiredec2instances

Return type

Union[int, float, None]

ec2_inbound_permissions

AWS::GameLift::Fleet.EC2InboundPermissions.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-ec2inboundpermissions

Return type

Union[IResolvable, List[Union[IResolvable, IpPermissionProperty]], None]

ec2_instance_type

AWS::GameLift::Fleet.EC2InstanceType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-ec2instancetype

Return type

str

fleet_type

AWS::GameLift::Fleet.FleetType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-fleettype

Return type

Optional[str]

instance_role_arn

AWS::GameLift::Fleet.InstanceRoleARN.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-instancerolearn

Return type

Optional[str]

log_paths

AWS::GameLift::Fleet.LogPaths.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-logpaths

Return type

Optional[List[str]]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

max_size

AWS::GameLift::Fleet.MaxSize.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-maxsize

Return type

Union[int, float, None]

metric_groups

AWS::GameLift::Fleet.MetricGroups.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-metricgroups

Return type

Optional[List[str]]

min_size

AWS::GameLift::Fleet.MinSize.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-minsize

Return type

Union[int, float, None]

name

AWS::GameLift::Fleet.Name.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-name

Return type

str

new_game_session_protection_policy

AWS::GameLift::Fleet.NewGameSessionProtectionPolicy.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-newgamesessionprotectionpolicy

Return type

Optional[str]

node

The construct tree node associated with this construct.

Return type

ConstructNode

peer_vpc_aws_account_id

AWS::GameLift::Fleet.PeerVpcAwsAccountId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-peervpcawsaccountid

Return type

Optional[str]

peer_vpc_id

AWS::GameLift::Fleet.PeerVpcId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-peervpcid

Return type

Optional[str]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

resource_creation_limit_policy

AWS::GameLift::Fleet.ResourceCreationLimitPolicy.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-resourcecreationlimitpolicy

Return type

Union[IResolvable, ResourceCreationLimitPolicyProperty, None]

runtime_configuration

AWS::GameLift::Fleet.RuntimeConfiguration.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-runtimeconfiguration

Return type

Union[IResolvable, RuntimeConfigurationProperty, None]

script_id

AWS::GameLift::Fleet.ScriptId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-scriptid

Return type

Optional[str]

server_launch_parameters

AWS::GameLift::Fleet.ServerLaunchParameters.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-serverlaunchparameters

Return type

Optional[str]

server_launch_path

AWS::GameLift::Fleet.ServerLaunchPath.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-serverlaunchpath

Return type

Optional[str]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

CertificateConfigurationProperty

class CfnFleet.CertificateConfigurationProperty(*, certificate_type)

Bases: object

Parameters

certificate_type (str) – CfnFleet.CertificateConfigurationProperty.CertificateType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-certificateconfiguration.html

Attributes

certificate_type

CfnFleet.CertificateConfigurationProperty.CertificateType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-certificateconfiguration.html#cfn-gamelift-fleet-certificateconfiguration-certificatetype

Return type

str

IpPermissionProperty

class CfnFleet.IpPermissionProperty(*, from_port, ip_range, protocol, to_port)

Bases: object

Parameters
  • from_port (Union[int, float]) – CfnFleet.IpPermissionProperty.FromPort.

  • ip_range (str) – CfnFleet.IpPermissionProperty.IpRange.

  • protocol (str) – CfnFleet.IpPermissionProperty.Protocol.

  • to_port (Union[int, float]) – CfnFleet.IpPermissionProperty.ToPort.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ec2inboundpermission.html

Attributes

from_port

CfnFleet.IpPermissionProperty.FromPort.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ec2inboundpermission.html#cfn-gamelift-fleet-ec2inboundpermissions-fromport

Return type

Union[int, float]

ip_range

CfnFleet.IpPermissionProperty.IpRange.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ec2inboundpermission.html#cfn-gamelift-fleet-ec2inboundpermissions-iprange

Return type

str

protocol

CfnFleet.IpPermissionProperty.Protocol.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ec2inboundpermission.html#cfn-gamelift-fleet-ec2inboundpermissions-protocol

Return type

str

to_port

CfnFleet.IpPermissionProperty.ToPort.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ec2inboundpermission.html#cfn-gamelift-fleet-ec2inboundpermissions-toport

Return type

Union[int, float]

ResourceCreationLimitPolicyProperty

class CfnFleet.ResourceCreationLimitPolicyProperty(*, new_game_sessions_per_creator=None, policy_period_in_minutes=None)

Bases: object

Parameters
  • new_game_sessions_per_creator (Union[int, float, None]) – CfnFleet.ResourceCreationLimitPolicyProperty.NewGameSessionsPerCreator.

  • policy_period_in_minutes (Union[int, float, None]) – CfnFleet.ResourceCreationLimitPolicyProperty.PolicyPeriodInMinutes.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html

Attributes

new_game_sessions_per_creator

CfnFleet.ResourceCreationLimitPolicyProperty.NewGameSessionsPerCreator.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html#cfn-gamelift-fleet-resourcecreationlimitpolicy-newgamesessionspercreator

Return type

Union[int, float, None]

policy_period_in_minutes

CfnFleet.ResourceCreationLimitPolicyProperty.PolicyPeriodInMinutes.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html#cfn-gamelift-fleet-resourcecreationlimitpolicy-policyperiodinminutes

Return type

Union[int, float, None]

RuntimeConfigurationProperty

class CfnFleet.RuntimeConfigurationProperty(*, game_session_activation_timeout_seconds=None, max_concurrent_game_session_activations=None, server_processes=None)

Bases: object

Parameters
  • game_session_activation_timeout_seconds (Union[int, float, None]) – CfnFleet.RuntimeConfigurationProperty.GameSessionActivationTimeoutSeconds.

  • max_concurrent_game_session_activations (Union[int, float, None]) – CfnFleet.RuntimeConfigurationProperty.MaxConcurrentGameSessionActivations.

  • server_processes (Union[IResolvable, List[Union[IResolvable, ServerProcessProperty]], None]) – CfnFleet.RuntimeConfigurationProperty.ServerProcesses.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html

Attributes

game_session_activation_timeout_seconds

CfnFleet.RuntimeConfigurationProperty.GameSessionActivationTimeoutSeconds.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html#cfn-gamelift-fleet-runtimeconfiguration-gamesessionactivationtimeoutseconds

Return type

Union[int, float, None]

max_concurrent_game_session_activations

CfnFleet.RuntimeConfigurationProperty.MaxConcurrentGameSessionActivations.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html#cfn-gamelift-fleet-runtimeconfiguration-maxconcurrentgamesessionactivations

Return type

Union[int, float, None]

server_processes

CfnFleet.RuntimeConfigurationProperty.ServerProcesses.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html#cfn-gamelift-fleet-runtimeconfiguration-serverprocesses

Return type

Union[IResolvable, List[Union[IResolvable, ServerProcessProperty]], None]

ServerProcessProperty

class CfnFleet.ServerProcessProperty(*, concurrent_executions, launch_path, parameters=None)

Bases: object

Parameters
  • concurrent_executions (Union[int, float]) – CfnFleet.ServerProcessProperty.ConcurrentExecutions.

  • launch_path (str) – CfnFleet.ServerProcessProperty.LaunchPath.

  • parameters (Optional[str]) – CfnFleet.ServerProcessProperty.Parameters.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html

Attributes

concurrent_executions

CfnFleet.ServerProcessProperty.ConcurrentExecutions.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-concurrentexecutions

Return type

Union[int, float]

launch_path

CfnFleet.ServerProcessProperty.LaunchPath.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-launchpath

Return type

str

parameters

CfnFleet.ServerProcessProperty.Parameters.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-parameters

Return type

Optional[str]