Experimental
@aws-cdk/aws-gamelift-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
FleetBase L2 construct
Base class for new and imported GameLift fleet.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as gamelift_alpha from '@aws-cdk/aws-gamelift-alpha';
import { aws_iam as iam } from 'aws-cdk-lib';
declare const role: iam.Role;
const fleetBase = gamelift_alpha.FleetBase.fromFleetAttributes(this, 'MyFleetBase', {
fleetArn: 'fleetArn',
fleetId: 'fleetId',
role: role,
});
Initializer
new FleetBase(scope: Construct, id: string, props?: ResourceProps)
FleetBase(scope: Construct, id: str, props: typing.Optional[ResourceProps] = None)
new FleetBase(Construct scope, String id, ResourceProps props)
new FleetBase(Construct scope, string id, ResourceProps? props = null)
NewFleetBase(Scope Construct, Id *string, Props ResourceProps)
Construct Props
accountoptionalstringaccountoptionalstraccountoptionalStringAccountoptionalstringAccountoptional*string#Default: the resource is in the same account as the stack it belongs to
environmentFromArnoptionalstringenvironment_from_arnoptionalstrenvironmentFromArnoptionalStringEnvironmentFromArnoptionalstringEnvironmentFromArnoptional*string#Default: take environment from account, region parameters, or use Stack environment.
The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources.
Cannot be supplied together with either account or region.
physicalNameoptionalstringphysical_nameoptionalstrphysicalNameoptionalStringPhysicalNameoptionalstringPhysicalNameoptional*string#Default: The physical name will be allocated by CloudFormation at deployment time
notes
undefinedimplies that a physical name will be allocated by CloudFormation during deployment.- a concrete value implies a specific physical name
PhysicalName.GENERATE_IF_NEEDEDis a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
Default: the resource is in the same region as the stack it belongs to
Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
grantPrincipalIPrincipalgrant_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipal#resourceArnForDestinationstringresource_arn_for_destinationstrresourceArnForDestinationStringResourceArnForDestinationstringResourceArnForDestination*string#Methods
addAlias(aliasName: string, options?: AliasOptions): Aliasdef add_alias(self, alias_name: str, options: typing.Optional[AliasOptions] = None) -> Aliaspublic Alias addAlias(String aliasName, AliasOptions options)public Alias AddAlias(string aliasName, AliasOptions? options = null)func AddAlias(AliasName *string, Options AliasOptions) Alias#declare const fleet: gamelift.FleetBase;
fleet.addAlias('Live');
// Is equivalent to
new gamelift.Alias(this, 'AliasLive', {
aliasName: 'Live',
fleet: fleet,
});
2 parameters
Parameters
aliasNamealias_namealiasNamealiasNameAliasName— The name of the alias.optionsoptionsoptionsoptionsOptions— Alias options.
addInternalLocation(location: Location): voiddef add_internal_location(self, location: Location) -> Nonepublic void addInternalLocation(Location location)public void AddInternalLocation(Location location)func AddInternalLocation(Location Location)#1 parameter
Parameters
locationlocationlocationlocationLocation— The location to add.
addLocation(region: string, desiredCapacity?: number, minSize?: number, maxSize?: number): voiddef add_location(self, region: str, desired_capacity: typing.Optional[int | float] = None, min_size: typing.Optional[int | float] = None, max_size: typing.Optional[int | float] = None) -> Nonepublic void addLocation(String region, Number desiredCapacity, Number minSize, Number maxSize)public void AddLocation(string region, double? desiredCapacity = null, double? minSize = null, double? maxSize = null)func AddLocation(Region *string, DesiredCapacity *float64, MinSize *float64, MaxSize *float64)#1 parameter
Parameters
regionregionregionregionRegion— The AWS region to add.
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)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#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).
fromFleetAttributes(scope: Construct, id: string, attrs: FleetAttributes): IFleet@staticmethod def from_fleet_attributes(scope: Construct, id: str, attrs: FleetAttributes) -> IFleetpublic static IFleet fromFleetAttributes(Construct scope, String id, FleetAttributes attrs)public static IFleet FromFleetAttributes(Construct scope, string id, FleetAttributes attrs)func FromFleetAttributes(Scope Construct, Id *string, Attrs FleetAttributes) IFleetstatic#grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#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#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.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#metric(metricName: string, props?: MetricOptions): Metricdef metric(self, metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, MetricOptions props)public Metric Metric(string metricName, MetricOptions? props = null)func Metric(MetricName *string, Props MetricOptions) Metric#metricActiveInstances(props?: MetricOptions): Metricdef metric_active_instances(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricActiveInstances(MetricOptions props)public Metric MetricActiveInstances(MetricOptions? props = null)func MetricActiveInstances(Props MetricOptions) Metric#The count includes idle instances and those that are hosting one or more game sessions. This metric measures current total instance capacity.
This metric can be used with automatic scaling.
metricDesiredInstances(props?: MetricOptions): Metricdef metric_desired_instances(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricDesiredInstances(MetricOptions props)public Metric MetricDesiredInstances(MetricOptions? props = null)func MetricDesiredInstances(Props MetricOptions) Metric#With automatic scaling, this value is determined based on the scaling policies currently in force. Without automatic scaling, this value is set manually. This metric is not available when viewing data for fleet metric groups.
metricIdleInstances(props?: MetricOptions): Metricdef metric_idle_instances(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricIdleInstances(MetricOptions props)public Metric MetricIdleInstances(MetricOptions? props = null)func MetricIdleInstances(Props MetricOptions) Metric#This metric measures capacity that is available but unused. This metric can be used with automatic scaling.
metricInstanceInterruptions(props?: MetricOptions): Metricdef metric_instance_interruptions(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricInstanceInterruptions(MetricOptions props)public Metric MetricInstanceInterruptions(MetricOptions? props = null)func MetricInstanceInterruptions(Props MetricOptions) Metric#metricMaxInstances(props?: MetricOptions): Metricdef metric_max_instances(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricMaxInstances(MetricOptions props)public Metric MetricMaxInstances(MetricOptions? props = null)func MetricMaxInstances(Props MetricOptions) Metric#A fleet's instance maximum determines the capacity ceiling during manual or automatic scaling up. This metric is not available when viewing data for fleet metric groups.
metricMinInstances(props?: MetricOptions): Metricdef metric_min_instances(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricMinInstances(MetricOptions props)public Metric MetricMinInstances(MetricOptions? props = null)func MetricMinInstances(Props MetricOptions) Metric#A fleet's instance minimum determines the capacity floor during manual or automatic scaling down. This metric is not available when viewing data for fleet metric groups.
metricPercentIdleInstances(props?: MetricOptions): Metricdef metric_percent_idle_instances(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricPercentIdleInstances(MetricOptions props)public Metric MetricPercentIdleInstances(MetricOptions? props = null)func MetricPercentIdleInstances(Props MetricOptions) Metric#This metric can be used for automatic scaling.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#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.