aws-cdk-lib.aws_gamelift.CfnFleet

CfnFleet L1 construct

The AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift) fleet to host custom game server or Realtime Servers.

A fleet is a set of EC2 instances, configured with instructions to run game servers on each instance.

Construct›CfnElement›CfnRefElement›CfnResource›CfnFleet

implements

• IInspectable,
• ITaggableV2,
• IEnvironmentAware,
• IFleetRef,
• IConstruct,
• 1 more

  • IDependable

CloudFormation

AWS::GameLift::Fleet

Source

Generated code

Type last changed

v2.252.0 · 30 Apr 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_gamelift as gamelift } from 'aws-cdk-lib';
const cfnFleet = new gamelift.CfnFleet(this, 'MyCfnFleet', {
  name: 'name',

  // the properties below are optional
  anywhereConfiguration: {
    cost: 'cost',
  },
  applyCapacity: 'applyCapacity',
  buildId: 'buildId',
  certificateConfiguration: {
    certificateType: 'certificateType',
  },
  computeType: 'computeType',
  description: 'description',
  desiredEc2Instances: 123,
  ec2InboundPermissions: [{
    fromPort: 123,
    ipRange: 'ipRange',
    protocol: 'protocol',
    toPort: 123,
  }],
  ec2InstanceType: 'ec2InstanceType',
  fleetType: 'fleetType',
  instanceRoleArn: 'instanceRoleArn',
  instanceRoleCredentialsProvider: 'instanceRoleCredentialsProvider',
  locations: [{
    location: 'location',

    // the properties below are optional
    locationCapacity: {
      maxSize: 123,

      // the properties below are optional
      desiredEc2Instances: 123,
      managedCapacityConfiguration: {
        zeroCapacityStrategy: 'zeroCapacityStrategy',

        // the properties below are optional
        scaleInAfterInactivityMinutes: 123,
      },
      minSize: 123,
    },
    playerGatewayStatus: 'playerGatewayStatus',
  }],
  logPaths: ['logPaths'],
  maxSize: 123,
  metricGroups: ['metricGroups'],
  minSize: 123,
  newGameSessionProtectionPolicy: 'newGameSessionProtectionPolicy',
  peerVpcAwsAccountId: 'peerVpcAwsAccountId',
  peerVpcId: 'peerVpcId',
  playerGatewayConfiguration: {
    gameServerIpProtocolSupported: 'gameServerIpProtocolSupported',
  },
  playerGatewayMode: 'playerGatewayMode',
  resourceCreationLimitPolicy: {
    newGameSessionsPerCreator: 123,
    policyPeriodInMinutes: 123,
  },
  runtimeConfiguration: {
    gameSessionActivationTimeoutSeconds: 123,
    maxConcurrentGameSessionActivations: 123,
    serverProcesses: [{
      concurrentExecutions: 123,
      launchPath: 'launchPath',

      // the properties below are optional
      parameters: 'parameters',
    }],
  },
  scalingPolicies: [{
    name: 'name',

    // the properties below are optional
    comparisonOperator: 'comparisonOperator',
    evaluationPeriods: 123,
    location: 'location',
    metricName: 'metricName',
    policyType: 'policyType',
    scalingAdjustment: 123,
    scalingAdjustmentType: 'scalingAdjustmentType',
    status: 'status',
    targetConfiguration: {
      targetValue: 123,
    },
    threshold: 123,
    updateStatus: 'updateStatus',
  }],
  scriptId: 'scriptId',
  serverLaunchParameters: 'serverLaunchParameters',
  serverLaunchPath: 'serverLaunchPath',
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

from aws_cdk import CfnTag
# 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_fleet = gamelift.CfnFleet(self, "MyCfnFleet",
    name="name",

    # the properties below are optional
    anywhere_configuration=gamelift.CfnFleet.AnywhereConfigurationProperty(
        cost="cost"
    ),
    apply_capacity="applyCapacity",
    build_id="buildId",
    certificate_configuration=gamelift.CfnFleet.CertificateConfigurationProperty(
        certificate_type="certificateType"
    ),
    compute_type="computeType",
    description="description",
    desired_ec2_instances=123,
    ec2_inbound_permissions=[gamelift.CfnFleet.IpPermissionProperty(
        from_port=123,
        ip_range="ipRange",
        protocol="protocol",
        to_port=123
    )],
    ec2_instance_type="ec2InstanceType",
    fleet_type="fleetType",
    instance_role_arn="instanceRoleArn",
    instance_role_credentials_provider="instanceRoleCredentialsProvider",
    locations=[gamelift.CfnFleet.LocationConfigurationProperty(
        location="location",

        # the properties below are optional
        location_capacity=gamelift.CfnFleet.LocationCapacityProperty(
            max_size=123,

            # the properties below are optional
            desired_ec2_instances=123,
            managed_capacity_configuration=gamelift.CfnFleet.ManagedCapacityConfigurationProperty(
                zero_capacity_strategy="zeroCapacityStrategy",

                # the properties below are optional
                scale_in_after_inactivity_minutes=123
            ),
            min_size=123
        ),
        player_gateway_status="playerGatewayStatus"
    )],
    log_paths=["logPaths"],
    max_size=123,
    metric_groups=["metricGroups"],
    min_size=123,
    new_game_session_protection_policy="newGameSessionProtectionPolicy",
    peer_vpc_aws_account_id="peerVpcAwsAccountId",
    peer_vpc_id="peerVpcId",
    player_gateway_configuration=gamelift.CfnFleet.PlayerGatewayConfigurationProperty(
        game_server_ip_protocol_supported="gameServerIpProtocolSupported"
    ),
    player_gateway_mode="playerGatewayMode",
    resource_creation_limit_policy=gamelift.CfnFleet.ResourceCreationLimitPolicyProperty(
        new_game_sessions_per_creator=123,
        policy_period_in_minutes=123
    ),
    runtime_configuration=gamelift.CfnFleet.RuntimeConfigurationProperty(
        game_session_activation_timeout_seconds=123,
        max_concurrent_game_session_activations=123,
        server_processes=[gamelift.CfnFleet.ServerProcessProperty(
            concurrent_executions=123,
            launch_path="launchPath",

            # the properties below are optional
            parameters="parameters"
        )]
    ),
    scaling_policies=[gamelift.CfnFleet.ScalingPolicyProperty(
        name="name",

        # the properties below are optional
        comparison_operator="comparisonOperator",
        evaluation_periods=123,
        location="location",
        metric_name="metricName",
        policy_type="policyType",
        scaling_adjustment=123,
        scaling_adjustment_type="scalingAdjustmentType",
        status="status",
        target_configuration=gamelift.CfnFleet.TargetConfigurationProperty(
            target_value=123
        ),
        threshold=123,
        update_status="updateStatus"
    )],
    script_id="scriptId",
    server_launch_parameters="serverLaunchParameters",
    server_launch_path="serverLaunchPath",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.gamelift.*;

CfnFleet cfnFleet = CfnFleet.Builder.create(this, "MyCfnFleet")
        .name("name")

        // the properties below are optional
        .anywhereConfiguration(AnywhereConfigurationProperty.builder()
                .cost("cost")
                .build())
        .applyCapacity("applyCapacity")
        .buildId("buildId")
        .certificateConfiguration(CertificateConfigurationProperty.builder()
                .certificateType("certificateType")
                .build())
        .computeType("computeType")
        .description("description")
        .desiredEc2Instances(123)
        .ec2InboundPermissions(List.of(IpPermissionProperty.builder()
                .fromPort(123)
                .ipRange("ipRange")
                .protocol("protocol")
                .toPort(123)
                .build()))
        .ec2InstanceType("ec2InstanceType")
        .fleetType("fleetType")
        .instanceRoleArn("instanceRoleArn")
        .instanceRoleCredentialsProvider("instanceRoleCredentialsProvider")
        .locations(List.of(LocationConfigurationProperty.builder()
                .location("location")

                // the properties below are optional
                .locationCapacity(LocationCapacityProperty.builder()
                        .maxSize(123)

                        // the properties below are optional
                        .desiredEc2Instances(123)
                        .managedCapacityConfiguration(ManagedCapacityConfigurationProperty.builder()
                                .zeroCapacityStrategy("zeroCapacityStrategy")

                                // the properties below are optional
                                .scaleInAfterInactivityMinutes(123)
                                .build())
                        .minSize(123)
                        .build())
                .playerGatewayStatus("playerGatewayStatus")
                .build()))
        .logPaths(List.of("logPaths"))
        .maxSize(123)
        .metricGroups(List.of("metricGroups"))
        .minSize(123)
        .newGameSessionProtectionPolicy("newGameSessionProtectionPolicy")
        .peerVpcAwsAccountId("peerVpcAwsAccountId")
        .peerVpcId("peerVpcId")
        .playerGatewayConfiguration(PlayerGatewayConfigurationProperty.builder()
                .gameServerIpProtocolSupported("gameServerIpProtocolSupported")
                .build())
        .playerGatewayMode("playerGatewayMode")
        .resourceCreationLimitPolicy(ResourceCreationLimitPolicyProperty.builder()
                .newGameSessionsPerCreator(123)
                .policyPeriodInMinutes(123)
                .build())
        .runtimeConfiguration(RuntimeConfigurationProperty.builder()
                .gameSessionActivationTimeoutSeconds(123)
                .maxConcurrentGameSessionActivations(123)
                .serverProcesses(List.of(ServerProcessProperty.builder()
                        .concurrentExecutions(123)
                        .launchPath("launchPath")

                        // the properties below are optional
                        .parameters("parameters")
                        .build()))
                .build())
        .scalingPolicies(List.of(ScalingPolicyProperty.builder()
                .name("name")

                // the properties below are optional
                .comparisonOperator("comparisonOperator")
                .evaluationPeriods(123)
                .location("location")
                .metricName("metricName")
                .policyType("policyType")
                .scalingAdjustment(123)
                .scalingAdjustmentType("scalingAdjustmentType")
                .status("status")
                .targetConfiguration(TargetConfigurationProperty.builder()
                        .targetValue(123)
                        .build())
                .threshold(123)
                .updateStatus("updateStatus")
                .build()))
        .scriptId("scriptId")
        .serverLaunchParameters("serverLaunchParameters")
        .serverLaunchPath("serverLaunchPath")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GameLift;

var cfnFleet = new CfnFleet(this, "MyCfnFleet", new CfnFleetProps {
    Name = "name",

    // the properties below are optional
    AnywhereConfiguration = new AnywhereConfigurationProperty {
        Cost = "cost"
    },
    ApplyCapacity = "applyCapacity",
    BuildId = "buildId",
    CertificateConfiguration = new CertificateConfigurationProperty {
        CertificateType = "certificateType"
    },
    ComputeType = "computeType",
    Description = "description",
    DesiredEc2Instances = 123,
    Ec2InboundPermissions = new [] { new IpPermissionProperty {
        FromPort = 123,
        IpRange = "ipRange",
        Protocol = "protocol",
        ToPort = 123
    } },
    Ec2InstanceType = "ec2InstanceType",
    FleetType = "fleetType",
    InstanceRoleArn = "instanceRoleArn",
    InstanceRoleCredentialsProvider = "instanceRoleCredentialsProvider",
    Locations = new [] { new LocationConfigurationProperty {
        Location = "location",

        // the properties below are optional
        LocationCapacity = new LocationCapacityProperty {
            MaxSize = 123,

            // the properties below are optional
            DesiredEc2Instances = 123,
            ManagedCapacityConfiguration = new ManagedCapacityConfigurationProperty {
                ZeroCapacityStrategy = "zeroCapacityStrategy",

                // the properties below are optional
                ScaleInAfterInactivityMinutes = 123
            },
            MinSize = 123
        },
        PlayerGatewayStatus = "playerGatewayStatus"
    } },
    LogPaths = new [] { "logPaths" },
    MaxSize = 123,
    MetricGroups = new [] { "metricGroups" },
    MinSize = 123,
    NewGameSessionProtectionPolicy = "newGameSessionProtectionPolicy",
    PeerVpcAwsAccountId = "peerVpcAwsAccountId",
    PeerVpcId = "peerVpcId",
    PlayerGatewayConfiguration = new PlayerGatewayConfigurationProperty {
        GameServerIpProtocolSupported = "gameServerIpProtocolSupported"
    },
    PlayerGatewayMode = "playerGatewayMode",
    ResourceCreationLimitPolicy = new ResourceCreationLimitPolicyProperty {
        NewGameSessionsPerCreator = 123,
        PolicyPeriodInMinutes = 123
    },
    RuntimeConfiguration = new RuntimeConfigurationProperty {
        GameSessionActivationTimeoutSeconds = 123,
        MaxConcurrentGameSessionActivations = 123,
        ServerProcesses = new [] { new ServerProcessProperty {
            ConcurrentExecutions = 123,
            LaunchPath = "launchPath",

            // the properties below are optional
            Parameters = "parameters"
        } }
    },
    ScalingPolicies = new [] { new ScalingPolicyProperty {
        Name = "name",

        // the properties below are optional
        ComparisonOperator = "comparisonOperator",
        EvaluationPeriods = 123,
        Location = "location",
        MetricName = "metricName",
        PolicyType = "policyType",
        ScalingAdjustment = 123,
        ScalingAdjustmentType = "scalingAdjustmentType",
        Status = "status",
        TargetConfiguration = new TargetConfigurationProperty {
            TargetValue = 123
        },
        Threshold = 123,
        UpdateStatus = "updateStatus"
    } },
    ScriptId = "scriptId",
    ServerLaunchParameters = "serverLaunchParameters",
    ServerLaunchPath = "serverLaunchPath",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnFleet := awscdk.Aws_gamelift.NewCfnFleet(this, jsii.String("MyCfnFleet"), &CfnFleetProps{
	Name: jsii.String("name"),

	// the properties below are optional
	AnywhereConfiguration: &AnywhereConfigurationProperty{
		Cost: jsii.String("cost"),
	},
	ApplyCapacity: jsii.String("applyCapacity"),
	BuildId: jsii.String("buildId"),
	CertificateConfiguration: &CertificateConfigurationProperty{
		CertificateType: jsii.String("certificateType"),
	},
	ComputeType: jsii.String("computeType"),
	Description: jsii.String("description"),
	DesiredEc2Instances: jsii.Number(123),
	Ec2InboundPermissions: []interface{}{
		&IpPermissionProperty{
			FromPort: jsii.Number(123),
			IpRange: jsii.String("ipRange"),
			Protocol: jsii.String("protocol"),
			ToPort: jsii.Number(123),
		},
	},
	Ec2InstanceType: jsii.String("ec2InstanceType"),
	FleetType: jsii.String("fleetType"),
	InstanceRoleArn: jsii.String("instanceRoleArn"),
	InstanceRoleCredentialsProvider: jsii.String("instanceRoleCredentialsProvider"),
	Locations: []interface{}{
		&LocationConfigurationProperty{
			Location: jsii.String("location"),

			// the properties below are optional
			LocationCapacity: &LocationCapacityProperty{
				MaxSize: jsii.Number(123),

				// the properties below are optional
				DesiredEc2Instances: jsii.Number(123),
				ManagedCapacityConfiguration: &ManagedCapacityConfigurationProperty{
					ZeroCapacityStrategy: jsii.String("zeroCapacityStrategy"),

					// the properties below are optional
					ScaleInAfterInactivityMinutes: jsii.Number(123),
				},
				MinSize: jsii.Number(123),
			},
			PlayerGatewayStatus: jsii.String("playerGatewayStatus"),
		},
	},
	LogPaths: []*string{
		jsii.String("logPaths"),
	},
	MaxSize: jsii.Number(123),
	MetricGroups: []*string{
		jsii.String("metricGroups"),
	},
	MinSize: jsii.Number(123),
	NewGameSessionProtectionPolicy: jsii.String("newGameSessionProtectionPolicy"),
	PeerVpcAwsAccountId: jsii.String("peerVpcAwsAccountId"),
	PeerVpcId: jsii.String("peerVpcId"),
	PlayerGatewayConfiguration: &PlayerGatewayConfigurationProperty{
		GameServerIpProtocolSupported: jsii.String("gameServerIpProtocolSupported"),
	},
	PlayerGatewayMode: jsii.String("playerGatewayMode"),
	ResourceCreationLimitPolicy: &ResourceCreationLimitPolicyProperty{
		NewGameSessionsPerCreator: jsii.Number(123),
		PolicyPeriodInMinutes: jsii.Number(123),
	},
	RuntimeConfiguration: &RuntimeConfigurationProperty{
		GameSessionActivationTimeoutSeconds: jsii.Number(123),
		MaxConcurrentGameSessionActivations: jsii.Number(123),
		ServerProcesses: []interface{}{
			&ServerProcessProperty{
				ConcurrentExecutions: jsii.Number(123),
				LaunchPath: jsii.String("launchPath"),

				// the properties below are optional
				Parameters: jsii.String("parameters"),
			},
		},
	},
	ScalingPolicies: []interface{}{
		&ScalingPolicyProperty{
			Name: jsii.String("name"),

			// the properties below are optional
			ComparisonOperator: jsii.String("comparisonOperator"),
			EvaluationPeriods: jsii.Number(123),
			Location: jsii.String("location"),
			MetricName: jsii.String("metricName"),
			PolicyType: jsii.String("policyType"),
			ScalingAdjustment: jsii.Number(123),
			ScalingAdjustmentType: jsii.String("scalingAdjustmentType"),
			Status: jsii.String("status"),
			TargetConfiguration: &TargetConfigurationProperty{
				TargetValue: jsii.Number(123),
			},
			Threshold: jsii.Number(123),
			UpdateStatus: jsii.String("updateStatus"),
		},
	},
	ScriptId: jsii.String("scriptId"),
	ServerLaunchParameters: jsii.String("serverLaunchParameters"),
	ServerLaunchPath: jsii.String("serverLaunchPath"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
})

Initializer

new CfnFleet(scope: Construct, id: string, props: CfnFleetProps)

CfnFleet(scope: Construct, id: str, props: CfnFleetProps)

new CfnFleet(Construct scope, String id, CfnFleetProps props)

new CfnFleet(Construct scope, string id, CfnFleetProps props)

NewCfnFleet(Scope Construct, Id *string, Props CfnFleetProps)

Construct Props

anywhereConfiguration?optionalIResolvable | CfnFleet.AnywhereConfigurationPropertyanywhere_configuration?optionaltyping.Union[IResolvable, AnywhereConfigurationProperty]anywhereConfiguration?optionalIResolvableAnywhereConfiguration?optionalIResolvableAnywhereConfiguration?optionalinterface{}#

Amazon GameLift Servers Anywhere configuration options.

applyCapacity?optionalstringapply_capacity?optionalstrapplyCapacity?optionalStringApplyCapacity?optionalstringApplyCapacity?optional*string#

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

notes

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

Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity

buildId?optionalstringbuild_id?optionalstrbuildId?optionalStringBuildId?optionalstringBuildId?optional*string#

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

notes

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.

certificateConfiguration?optionalIResolvable | CfnFleet.CertificateConfigurationPropertycertificate_configuration?optionaltyping.Union[IResolvable, CertificateConfigurationProperty]certificateConfiguration?optionalIResolvableCertificateConfiguration?optionalIResolvableCertificateConfiguration?optionalinterface{}#

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

notes

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 .

computeType?optionalstringcompute_type?optionalstrcomputeType?optionalStringComputeType?optionalstringComputeType?optional*string#

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

notes

• 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.

description?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*string#

A description for the fleet.

desiredEc2Instances?optionalnumberdesired_ec2_instances?optionalint | floatdesiredEc2Instances?optionalNumberDesiredEc2Instances?optionaldoubleDesiredEc2Instances?optional*float64deprecated#

this property has been deprecated

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.

ec2InboundPermissions?optionalIResolvable | IResolvable | CfnFleet.IpPermissionProperty[]ec2_inbound_permissions?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, IpPermissionProperty]]]ec2InboundPermissions?optionalIResolvableEc2InboundPermissions?optionalIResolvableEc2InboundPermissions?optionalinterface{}#

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

notes

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.

ec2InstanceType?optionalstringec2_instance_type?optionalstrec2InstanceType?optionalStringEc2InstanceType?optionalstringEc2InstanceType?optional*string#

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

notes

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.

fleetType?optionalstringfleet_type?optionalstrfleetType?optionalStringFleetType?optionalstringFleetType?optional*string#

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

notes

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.

instanceRoleArn?optionalstringinstance_role_arn?optionalstrinstanceRoleArn?optionalStringInstanceRoleArn?optionalstringInstanceRoleArn?optional*string#

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

notes

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 .

instanceRoleCredentialsProvider?optionalstringinstance_role_credentials_provider?optionalstrinstanceRoleCredentialsProvider?optionalStringInstanceRoleCredentialsProvider?optionalstringInstanceRoleCredentialsProvider?optional*string#

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

notes

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 .

locations?optionalIResolvable | IResolvable | CfnFleet.LocationConfigurationProperty[]locations?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, LocationConfigurationProperty]]]locations?optionalIResolvableLocations?optionalIResolvableLocations?optionalinterface{}#

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

notes

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.

logPaths?optionalstring[]log_paths?optionaltyping.List[str]logPaths?optionalList<String>LogPaths?optionalstring[]LogPaths?optional*[]*stringdeprecated#

this property has been deprecated

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

maxSize?optionalnumbermax_size?optionalint | floatmaxSize?optionalNumberMaxSize?optionaldoubleMaxSize?optional*float64deprecated#

this property has been deprecated

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

metricGroups?optionalstring[]metric_groups?optionaltyping.List[str]metricGroups?optionalList<String>MetricGroups?optionalstring[]MetricGroups?optional*[]*string#

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.

minSize?optionalnumbermin_size?optionalint | floatminSize?optionalNumberMinSize?optionaldoubleMinSize?optional*float64deprecated#

this property has been deprecated

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

namestringnamestrnameStringNamestringName*stringrequired#

A descriptive label that is associated with a fleet.

Fleet names do not need to be unique.

newGameSessionProtectionPolicy?optionalstringnew_game_session_protection_policy?optionalstrnewGameSessionProtectionPolicy?optionalStringNewGameSessionProtectionPolicy?optionalstringNewGameSessionProtectionPolicy?optional*string#

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

notes

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.

peerVpcAwsAccountId?optionalstringpeer_vpc_aws_account_id?optionalstrpeerVpcAwsAccountId?optionalStringPeerVpcAwsAccountId?optionalstringPeerVpcAwsAccountId?optional*string#

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.

peerVpcId?optionalstringpeer_vpc_id?optionalstrpeerVpcId?optionalStringPeerVpcId?optionalstringPeerVpcId?optional*string#

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

notes

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 .

playerGatewayConfiguration?optionalIResolvable | CfnFleet.PlayerGatewayConfigurationPropertyplayer_gateway_configuration?optionaltyping.Union[IResolvable, PlayerGatewayConfigurationProperty]playerGatewayConfiguration?optionalIResolvablePlayerGatewayConfiguration?optionalIResolvablePlayerGatewayConfiguration?optionalinterface{}#

Configuration for player gateway.

playerGatewayMode?optionalstringplayer_gateway_mode?optionalstrplayerGatewayMode?optionalStringPlayerGatewayMode?optionalstringPlayerGatewayMode?optional*string#

The player gateway mode for the fleet.

resourceCreationLimitPolicy?optionalIResolvable | CfnFleet.ResourceCreationLimitPolicyPropertyresource_creation_limit_policy?optionaltyping.Union[IResolvable, ResourceCreationLimitPolicyProperty]resourceCreationLimitPolicy?optionalIResolvableResourceCreationLimitPolicy?optionalIResolvableResourceCreationLimitPolicy?optionalinterface{}#

A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.

runtimeConfiguration?optionalIResolvable | CfnFleet.RuntimeConfigurationPropertyruntime_configuration?optionaltyping.Union[IResolvable, RuntimeConfigurationProperty]runtimeConfiguration?optionalIResolvableRuntimeConfiguration?optionalIResolvableRuntimeConfiguration?optionalinterface{}#

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

notes

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.

scalingPolicies?optionalIResolvable | IResolvable | CfnFleet.ScalingPolicyProperty[]scaling_policies?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ScalingPolicyProperty]]]scalingPolicies?optionalIResolvableScalingPolicies?optionalIResolvableScalingPolicies?optionalinterface{}#

Rule that controls how a fleet is scaled.

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

scriptId?optionalstringscript_id?optionalstrscriptId?optionalStringScriptId?optionalstringScriptId?optional*string#

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

notes

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.

serverLaunchParameters?optionalstringserver_launch_parameters?optionalstrserverLaunchParameters?optionalStringServerLaunchParameters?optionalstringServerLaunchParameters?optional*stringdeprecated#

this property has been deprecated

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

serverLaunchPath?optionalstringserver_launch_path?optionalstrserverLaunchPath?optionalStringServerLaunchPath?optionalstringServerLaunchPath?optional*stringdeprecated#

this property has been deprecated

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.

tags?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

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

Properties

anywhereConfiguration?may be undefinedIResolvable | CfnFleet.AnywhereConfigurationPropertyanywhere_configuration?may be undefinedtyping.Union[IResolvable, AnywhereConfigurationProperty]anywhereConfiguration?may be undefinedIResolvableAnywhereConfiguration?may be undefinedIResolvableAnywhereConfiguration?may be undefinedinterface{}#

Amazon GameLift Servers Anywhere configuration options.

applyCapacity?may be undefinedstringapply_capacity?may be undefinedstrapplyCapacity?may be undefinedStringApplyCapacity?may be undefinedstringApplyCapacity?may be undefined*string#

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

attrFleetArnstringattr_fleet_arnstrattrFleetArnStringAttrFleetArnstringAttrFleetArn*stringrequired#

The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912` . In a GameLift fleet ARN, the resource ID matches the `FleetId` value.

attrFleetIdstringattr_fleet_idstrattrFleetIdStringAttrFleetIdstringAttrFleetId*stringrequired#

A unique identifier for the fleet.

buildId?may be undefinedstringbuild_id?may be undefinedstrbuildId?may be undefinedStringBuildId?may be undefinedstringBuildId?may be undefined*string#

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

cdkTagManagerTagManagercdk_tag_managerTagManagercdkTagManagerTagManagerCdkTagManagerTagManagerCdkTagManagerTagManagerrequired#

Tag Manager which manages the tags for this resource.

certificateConfiguration?may be undefinedIResolvable | CfnFleet.CertificateConfigurationPropertycertificate_configuration?may be undefinedtyping.Union[IResolvable, CertificateConfigurationProperty]certificateConfiguration?may be undefinedIResolvableCertificateConfiguration?may be undefinedIResolvableCertificateConfiguration?may be undefinedinterface{}#

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

CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#

The CloudFormation resource type name for this resource class.

cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#

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

cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#

AWS resource type.

computeType?may be undefinedstringcompute_type?may be undefinedstrcomputeType?may be undefinedStringComputeType?may be undefinedstringComputeType?may be undefined*string#

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

creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#

description?may be undefinedstringdescription?may be undefinedstrdescription?may be undefinedStringDescription?may be undefinedstringDescription?may be undefined*string#

A description for the fleet.

desiredEc2Instances?may be undefinednumberdesired_ec2_instances?may be undefinedint | floatdesiredEc2Instances?may be undefinedNumberDesiredEc2Instances?may be undefineddoubleDesiredEc2Instances?may be undefined*float64deprecated#

this property has been deprecated

ec2InboundPermissions?may be undefinedIResolvable | IResolvable | CfnFleet.IpPermissionProperty[]ec2_inbound_permissions?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, IpPermissionProperty]]]ec2InboundPermissions?may be undefinedIResolvableEc2InboundPermissions?may be undefinedIResolvableEc2InboundPermissions?may be undefinedinterface{}#

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

ec2InstanceType?may be undefinedstringec2_instance_type?may be undefinedstrec2InstanceType?may be undefinedStringEc2InstanceType?may be undefinedstringEc2InstanceType?may be undefined*string#

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

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

fleetRefFleetReferencefleet_refFleetReferencefleetRefFleetReferenceFleetRefFleetReferenceFleetRefFleetReferencerequired#

A reference to a Fleet resource.

fleetType?may be undefinedstringfleet_type?may be undefinedstrfleetType?may be undefinedStringFleetType?may be undefinedstringFleetType?may be undefined*string#

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

instanceRoleArn?may be undefinedstringinstance_role_arn?may be undefinedstrinstanceRoleArn?may be undefinedStringInstanceRoleArn?may be undefinedstringInstanceRoleArn?may be undefined*string#

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

instanceRoleCredentialsProvider?may be undefinedstringinstance_role_credentials_provider?may be undefinedstrinstanceRoleCredentialsProvider?may be undefinedStringInstanceRoleCredentialsProvider?may be undefinedstringInstanceRoleCredentialsProvider?may be undefined*string#

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

locations?may be undefinedIResolvable | IResolvable | CfnFleet.LocationConfigurationProperty[]locations?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, LocationConfigurationProperty]]]locations?may be undefinedIResolvableLocations?may be undefinedIResolvableLocations?may be undefinedinterface{}#

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

logicalIdstringlogical_idstrlogicalIdStringLogicalIdstringLogicalId*stringrequired#

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).

logPaths?may be undefinedstring[]log_paths?may be undefinedtyping.List[str]logPaths?may be undefinedList<String>LogPaths?may be undefinedstring[]LogPaths?may be undefined*[]*stringdeprecated#

this property has been deprecated

maxSize?may be undefinednumbermax_size?may be undefinedint | floatmaxSize?may be undefinedNumberMaxSize?may be undefineddoubleMaxSize?may be undefined*float64deprecated#

this property has been deprecated

metricGroups?may be undefinedstring[]metric_groups?may be undefinedtyping.List[str]metricGroups?may be undefinedList<String>MetricGroups?may be undefinedstring[]MetricGroups?may be undefined*[]*string#

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

minSize?may be undefinednumbermin_size?may be undefinedint | floatminSize?may be undefinedNumberMinSize?may be undefineddoubleMinSize?may be undefined*float64deprecated#

this property has been deprecated

namestringnamestrnameStringNamestringName*stringrequired#

A descriptive label that is associated with a fleet.

newGameSessionProtectionPolicy?may be undefinedstringnew_game_session_protection_policy?may be undefinedstrnewGameSessionProtectionPolicy?may be undefinedStringNewGameSessionProtectionPolicy?may be undefinedstringNewGameSessionProtectionPolicy?may be undefined*string#

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

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

peerVpcAwsAccountId?may be undefinedstringpeer_vpc_aws_account_id?may be undefinedstrpeerVpcAwsAccountId?may be undefinedStringPeerVpcAwsAccountId?may be undefinedstringPeerVpcAwsAccountId?may be undefined*string#

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

peerVpcId?may be undefinedstringpeer_vpc_id?may be undefinedstrpeerVpcId?may be undefinedStringPeerVpcId?may be undefinedstringPeerVpcId?may be undefined*string#

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

playerGatewayConfiguration?may be undefinedIResolvable | CfnFleet.PlayerGatewayConfigurationPropertyplayer_gateway_configuration?may be undefinedtyping.Union[IResolvable, PlayerGatewayConfigurationProperty]playerGatewayConfiguration?may be undefinedIResolvablePlayerGatewayConfiguration?may be undefinedIResolvablePlayerGatewayConfiguration?may be undefinedinterface{}#

Configuration for player gateway.

playerGatewayMode?may be undefinedstringplayer_gateway_mode?may be undefinedstrplayerGatewayMode?may be undefinedStringPlayerGatewayMode?may be undefinedstringPlayerGatewayMode?may be undefined*string#

The player gateway mode for the fleet.

refstringrefstrrefStringRefstringRef*stringrequired#

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 }).

resourceCreationLimitPolicy?may be undefinedIResolvable | CfnFleet.ResourceCreationLimitPolicyPropertyresource_creation_limit_policy?may be undefinedtyping.Union[IResolvable, ResourceCreationLimitPolicyProperty]resourceCreationLimitPolicy?may be undefinedIResolvableResourceCreationLimitPolicy?may be undefinedIResolvableResourceCreationLimitPolicy?may be undefinedinterface{}#

A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.

runtimeConfiguration?may be undefinedIResolvable | CfnFleet.RuntimeConfigurationPropertyruntime_configuration?may be undefinedtyping.Union[IResolvable, RuntimeConfigurationProperty]runtimeConfiguration?may be undefinedIResolvableRuntimeConfiguration?may be undefinedIResolvableRuntimeConfiguration?may be undefinedinterface{}#

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

scalingPolicies?may be undefinedIResolvable | IResolvable | CfnFleet.ScalingPolicyProperty[]scaling_policies?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ScalingPolicyProperty]]]scalingPolicies?may be undefinedIResolvableScalingPolicies?may be undefinedIResolvableScalingPolicies?may be undefinedinterface{}#

Rule that controls how a fleet is scaled.

scriptId?may be undefinedstringscript_id?may be undefinedstrscriptId?may be undefinedStringScriptId?may be undefinedstringScriptId?may be undefined*string#

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

serverLaunchParameters?may be undefinedstringserver_launch_parameters?may be undefinedstrserverLaunchParameters?may be undefinedStringServerLaunchParameters?may be undefinedstringServerLaunchParameters?may be undefined*stringdeprecated#

this property has been deprecated

serverLaunchPath?may be undefinedstringserver_launch_path?may be undefinedstrserverLaunchPath?may be undefinedStringServerLaunchPath?may be undefinedstringServerLaunchPath?may be undefined*stringdeprecated#

this property has been deprecated

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this element is defined.

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

tags?may be undefinedCfnTag[]tags?may be undefinedtyping.List[CfnTag]tags?may be undefinedList<CfnTag>Tags?may be undefinedCfnTag[]Tags?may be undefined*[]CfnTag#

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

Methods

addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#

Syntactic sugar for `addOverride(path, undefined)`.

1 parameter

Parameters

• pathpathpathpathPath — The path of the value to delete.

addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

notes

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

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#

Add a value to the CloudFormation Resource Metadata.

addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#

Adds an override to the synthesized CloudFormation resource.

notes · 2 parameters

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,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters

• pathpathpathpathPath — - The path of the property, you can use dot notation to override values in complex types.
• valuevaluevaluevalueValue — - The value.

addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#

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

1 parameter

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path to the property.

addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#

Adds an override to a resource property.

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

2 parameters

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path of the property.
• valuevaluevaluevalueValue — The value.

addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#

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

notes

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

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

1 parameter

Parameters

• strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#

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

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

arnForFleet(resource: IFleetRef): string@staticmethod def arn_for_fleet(resource: IFleetRef) -> strpublic static String arnForFleet(IFleetRef resource)public static string ArnForFleet(IFleetRef resource)func ArnForFleet(Resource IFleetRef) *stringstatic#

cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#

fromFleetArn(scope: Construct, id: string, arn: string): IFleetRef@staticmethod def from_fleet_arn(scope: Construct, id: str, arn: str) -> IFleetRefpublic static IFleetRef fromFleetArn(Construct scope, String id, String arn)public static IFleetRef FromFleetArn(Construct scope, string id, string arn)func FromFleetArn(Scope Construct, Id *string, Arn *string) IFleetRefstatic#

Creates a new IFleetRef from an ARN.

fromFleetId(scope: Construct, id: string, fleetId: string): IFleetRef@staticmethod def from_fleet_id(scope: Construct, id: str, fleet_id: str) -> IFleetRefpublic static IFleetRef fromFleetId(Construct scope, String id, String fleetId)public static IFleetRef FromFleetId(Construct scope, string id, string fleetId)func FromFleetId(Scope Construct, Id *string, FleetId *string) IFleetRefstatic#

Creates a new IFleetRef from a fleetId.

getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#

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.

1 parameter

Parameters

• attributeNameattribute_nameattributeNameattributeNameAttributeName — The name of the attribute.

getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#

Retrieve a value value from the CloudFormation Resource Metadata.

inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#

Examines the CloudFormation resource and discloses attributes.

1 parameter

Parameters

• inspectorinspectorinspectorinspectorInspector — tree inspector to collect and process attributes.

isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#

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.

returns

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

isCfnFleet(x: any): boolean@staticmethod def is_cfn_fleet(x: Any) -> boolpublic static Boolean isCfnFleet(Object x)public static bool IsCfnFleet(object x)func IsCfnFleet(X interface{}) *boolstatic#

Checks whether the given object is a CfnFleet.

isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#

Check whether the given object is a CfnResource.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#

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

1 parameter

Parameters

• newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId — The new logical ID to use for this stack element.

removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#

Use `removeResourceDependency` instead

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#

Replaces one dependency with another.

2 parameters

Parameters

• targettargettargettargetTarget — The dependency to replace.
• newTargetnew_targetnewTargetnewTargetNewTarget — The new dependency to add.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

returns

Returns: a string representation of this resource

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.