Skip to content
v2.274.0

CfnGameSessionQueue L1 construct ​

The AWS::GameLift::GameSessionQueue resource creates a placement queue that processes requests for new game sessions.

A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server, then prompts the game server to start a new game session. Queues can have destinations (GameLift fleets or aliases), which determine where the queue can place new game sessions. A queue can have destinations with varied fleet type (Spot and On-Demand), instance type, and AWS Region .

Example ​

ts
// 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 cfnGameSessionQueue = new gamelift.CfnGameSessionQueue(this, 'MyCfnGameSessionQueue', {
  name: 'name',

  // the properties below are optional
  customEventData: 'customEventData',
  destinations: [{
    destinationArn: 'destinationArn',
  }],
  filterConfiguration: {
    allowedLocations: ['allowedLocations'],
  },
  notificationTarget: 'notificationTarget',
  playerLatencyPolicies: [{
    maximumIndividualPlayerLatencyMilliseconds: 123,
    policyDurationSeconds: 123,
  }],
  priorityConfiguration: {
    locationOrder: ['locationOrder'],
    priorityOrder: ['priorityOrder'],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  timeoutInSeconds: 123,
});
python
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_game_session_queue = gamelift.CfnGameSessionQueue(self, "MyCfnGameSessionQueue",
    name="name",

    # the properties below are optional
    custom_event_data="customEventData",
    destinations=[gamelift.CfnGameSessionQueue.DestinationProperty(
        destination_arn="destinationArn"
    )],
    filter_configuration=gamelift.CfnGameSessionQueue.FilterConfigurationProperty(
        allowed_locations=["allowedLocations"]
    ),
    notification_target="notificationTarget",
    player_latency_policies=[gamelift.CfnGameSessionQueue.PlayerLatencyPolicyProperty(
        maximum_individual_player_latency_milliseconds=123,
        policy_duration_seconds=123
    )],
    priority_configuration=gamelift.CfnGameSessionQueue.PriorityConfigurationProperty(
        location_order=["locationOrder"],
        priority_order=["priorityOrder"]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    timeout_in_seconds=123
)
java
// 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.*;

CfnGameSessionQueue cfnGameSessionQueue = CfnGameSessionQueue.Builder.create(this, "MyCfnGameSessionQueue")
        .name("name")

        // the properties below are optional
        .customEventData("customEventData")
        .destinations(List.of(DestinationProperty.builder()
                .destinationArn("destinationArn")
                .build()))
        .filterConfiguration(FilterConfigurationProperty.builder()
                .allowedLocations(List.of("allowedLocations"))
                .build())
        .notificationTarget("notificationTarget")
        .playerLatencyPolicies(List.of(PlayerLatencyPolicyProperty.builder()
                .maximumIndividualPlayerLatencyMilliseconds(123)
                .policyDurationSeconds(123)
                .build()))
        .priorityConfiguration(PriorityConfigurationProperty.builder()
                .locationOrder(List.of("locationOrder"))
                .priorityOrder(List.of("priorityOrder"))
                .build())
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .timeoutInSeconds(123)
        .build();
csharp
// 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 cfnGameSessionQueue = new CfnGameSessionQueue(this, "MyCfnGameSessionQueue", new CfnGameSessionQueueProps {
    Name = "name",

    // the properties below are optional
    CustomEventData = "customEventData",
    Destinations = new [] { new DestinationProperty {
        DestinationArn = "destinationArn"
    } },
    FilterConfiguration = new FilterConfigurationProperty {
        AllowedLocations = new [] { "allowedLocations" }
    },
    NotificationTarget = "notificationTarget",
    PlayerLatencyPolicies = new [] { new PlayerLatencyPolicyProperty {
        MaximumIndividualPlayerLatencyMilliseconds = 123,
        PolicyDurationSeconds = 123
    } },
    PriorityConfiguration = new PriorityConfigurationProperty {
        LocationOrder = new [] { "locationOrder" },
        PriorityOrder = new [] { "priorityOrder" }
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    TimeoutInSeconds = 123
});
go
// 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"

cfnGameSessionQueue := awscdk.Aws_gamelift.NewCfnGameSessionQueue(this, jsii.String("MyCfnGameSessionQueue"), &CfnGameSessionQueueProps{
	Name: jsii.String("name"),

	// the properties below are optional
	CustomEventData: jsii.String("customEventData"),
	Destinations: []interface{}{
		&DestinationProperty{
			DestinationArn: jsii.String("destinationArn"),
		},
	},
	FilterConfiguration: &FilterConfigurationProperty{
		AllowedLocations: []*string{
			jsii.String("allowedLocations"),
		},
	},
	NotificationTarget: jsii.String("notificationTarget"),
	PlayerLatencyPolicies: []interface{}{
		&PlayerLatencyPolicyProperty{
			MaximumIndividualPlayerLatencyMilliseconds: jsii.Number(123),
			PolicyDurationSeconds: jsii.Number(123),
		},
	},
	PriorityConfiguration: &PriorityConfigurationProperty{
		LocationOrder: []*string{
			jsii.String("locationOrder"),
		},
		PriorityOrder: []*string{
			jsii.String("priorityOrder"),
		},
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	TimeoutInSeconds: jsii.Number(123),
})

Initializer ​

ts
new CfnGameSessionQueue(scope: Construct, id: string, props: CfnGameSessionQueueProps)
python
CfnGameSessionQueue(scope: Construct, id: str, props: CfnGameSessionQueueProps)
java
new CfnGameSessionQueue(Construct scope, String id, CfnGameSessionQueueProps props)
csharp
new CfnGameSessionQueue(Construct scope, string id, CfnGameSessionQueueProps props)
go
NewCfnGameSessionQueue(Scope Construct, Id *string, Props CfnGameSessionQueueProps)

Construct Props ​

customEventDataoptionalstringcustom_event_dataoptionalstrcustomEventDataoptionalStringCustomEventDataoptionalstringCustomEventDataoptional*string#
Information to be added to all events that are related to this game session queue.
destinationsoptionalIResolvable | IResolvable | CfnGameSessionQueue.DestinationProperty[]destinationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DestinationProperty]]]destinationsoptionalIResolvableDestinationsoptionalIResolvableDestinationsoptionalinterface{}#
A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.

Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.

filterConfigurationoptionalIResolvable | CfnGameSessionQueue.FilterConfigurationPropertyfilter_configurationoptionaltyping.Union[IResolvable, FilterConfigurationProperty]filterConfigurationoptionalIResolvableFilterConfigurationoptionalIResolvableFilterConfigurationoptionalinterface{}#
A list of locations where a queue is allowed to place new game sessions.

Locations are specified in the form of AWS Region codes, such as us-west-2 . If this parameter is not set, game sessions can be placed in any queue location.

namestringnamestrnameStringNamestringName*stringrequired#
A descriptive label that is associated with game session queue.

Queue names must be unique within each Region.

notificationTargetoptionalstringnotification_targetoptionalstrnotificationTargetoptionalStringNotificationTargetoptionalstringNotificationTargetoptional*string#
An SNS topic ARN that is set up to receive game session placement notifications.
playerLatencyPoliciesoptionalIResolvable | IResolvable | CfnGameSessionQueue.PlayerLatencyPolicyProperty[]player_latency_policiesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PlayerLatencyPolicyProperty]]]playerLatencyPoliciesoptionalIResolvablePlayerLatencyPoliciesoptionalIResolvablePlayerLatencyPoliciesoptionalinterface{}#
A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests.

Use multiple policies to gradually relax the cap over time if Amazon GameLift Servers can't make a placement. Policies are evaluated in order starting with the lowest maximum latency value.

priorityConfigurationoptionalIResolvable | CfnGameSessionQueue.PriorityConfigurationPropertypriority_configurationoptionaltyping.Union[IResolvable, PriorityConfigurationProperty]priorityConfigurationoptionalIResolvablePriorityConfigurationoptionalIResolvablePriorityConfigurationoptionalinterface{}#
Custom settings to use when prioritizing destinations and locations for game session placements.

This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
A list of labels to assign to the new game session queue resource.
notes

Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

timeoutInSecondsoptionalnumbertimeout_in_secondsoptionalint | floattimeoutInSecondsoptionalNumberTimeoutInSecondsoptionaldoubleTimeoutInSecondsoptional*float64#
The maximum time, in seconds, that a new game session placement request remains in the queue.

When a request exceeds this time, the game session placement changes to a TIMED_OUT status. If you don't specify a request timeout, the queue uses a default value.

Properties ​

attrArnstringattr_arnstrattrArnStringAttrArnstringAttrArn*stringrequired#
The unique Amazon Resource Name (ARN) for the `GameSessionQueue` .
attrNamestringattr_namestrattrNameStringAttrNamestringAttrName*stringrequired#
A descriptive label that is associated with a game session queue.

Names are unique within each Region.

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.
Options for this resource, such as condition, update policy etc.
cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#
AWS resource type.
creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#
customEventDatamay be undefinedstringcustom_event_datamay be undefinedstrcustomEventDatamay be undefinedStringCustomEventDatamay be undefinedstringCustomEventDatamay be undefined*string#
Information to be added to all events that are related to this game session queue.
destinationsmay be undefinedIResolvable | IResolvable | CfnGameSessionQueue.DestinationProperty[]destinationsmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DestinationProperty]]]destinationsmay be undefinedIResolvableDestinationsmay be undefinedIResolvableDestinationsmay be undefinedinterface{}#
A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
filterConfigurationmay be undefinedIResolvable | CfnGameSessionQueue.FilterConfigurationPropertyfilter_configurationmay be undefinedtyping.Union[IResolvable, FilterConfigurationProperty]filterConfigurationmay be undefinedIResolvableFilterConfigurationmay be undefinedIResolvableFilterConfigurationmay be undefinedinterface{}#
A list of locations where a queue is allowed to place new game sessions.
gameSessionQueueRefGameSessionQueueReferencegame_session_queue_refGameSessionQueueReferencegameSessionQueueRefGameSessionQueueReferenceGameSessionQueueRefGameSessionQueueReferenceGameSessionQueueRefGameSessionQueueReferencerequired#
A reference to a GameSessionQueue resource.
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).

namestringnamestrnameStringNamestringName*stringrequired#
A descriptive label that is associated with game session queue.
nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
notificationTargetmay be undefinedstringnotification_targetmay be undefinedstrnotificationTargetmay be undefinedStringNotificationTargetmay be undefinedstringNotificationTargetmay be undefined*string#
An SNS topic ARN that is set up to receive game session placement notifications.
playerLatencyPoliciesmay be undefinedIResolvable | IResolvable | CfnGameSessionQueue.PlayerLatencyPolicyProperty[]player_latency_policiesmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PlayerLatencyPolicyProperty]]]playerLatencyPoliciesmay be undefinedIResolvablePlayerLatencyPoliciesmay be undefinedIResolvablePlayerLatencyPoliciesmay be undefinedinterface{}#
A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests.
priorityConfigurationmay be undefinedIResolvable | CfnGameSessionQueue.PriorityConfigurationPropertypriority_configurationmay be undefinedtyping.Union[IResolvable, PriorityConfigurationProperty]priorityConfigurationmay be undefinedIResolvablePriorityConfigurationmay be undefinedIResolvablePriorityConfigurationmay be undefinedinterface{}#
Custom settings to use when prioritizing destinations and locations for game session placements.
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 }).

stackStackstackStackstackStackStackStackStackStackrequired#
The stack in which this element is defined.

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

Tag Manager which manages the tags for this resource.
tagsRawmay be undefinedCfnTag[]tags_rawmay be undefinedtyping.List[CfnTag]tagsRawmay be undefinedList<CfnTag>TagsRawmay be undefinedCfnTag[]TagsRawmay be undefined*[]CfnTag#
A list of labels to assign to the new game session queue resource.
timeoutInSecondsmay be undefinednumbertimeout_in_secondsmay be undefinedint | floattimeoutInSecondsmay be undefinedNumberTimeoutInSecondsmay be undefineddoubleTimeoutInSecondsmay be undefined*float64#
The maximum time, in seconds, that a new game session placement request remains in the queue.

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,

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

would add the overrides

json
"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:

arnForGameSessionQueue(resource: IGameSessionQueueRef): string@staticmethod def arn_for_game_session_queue(resource: IGameSessionQueueRef) -> strpublic static String arnForGameSessionQueue(IGameSessionQueueRef resource)public static string ArnForGameSessionQueue(IGameSessionQueueRef resource)func ArnForGameSessionQueue(Resource IGameSessionQueueRef) *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#
fromGameSessionQueueArn(scope: Construct, id: string, arn: string): IGameSessionQueueRef@staticmethod def from_game_session_queue_arn(scope: Construct, id: str, arn: str) -> IGameSessionQueueRefpublic static IGameSessionQueueRef fromGameSessionQueueArn(Construct scope, String id, String arn)public static IGameSessionQueueRef FromGameSessionQueueArn(Construct scope, string id, string arn)func FromGameSessionQueueArn(Scope Construct, Id *string, Arn *string) IGameSessionQueueRefstatic#
Creates a new IGameSessionQueueRef from an ARN.
fromGameSessionQueueName(scope: Construct, id: string, gameSessionQueueName: string): IGameSessionQueueRef@staticmethod def from_game_session_queue_name(scope: Construct, id: str, game_session_queue_name: str) -> IGameSessionQueueRefpublic static IGameSessionQueueRef fromGameSessionQueueName(Construct scope, String id, String gameSessionQueueName)public static IGameSessionQueueRef FromGameSessionQueueName(Construct scope, string id, string gameSessionQueueName)func FromGameSessionQueueName(Scope Construct, Id *string, GameSessionQueueName *string) IGameSessionQueueRefstatic#
Creates a new IGameSessionQueueRef from a gameSessionQueueName.
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.

isCfnGameSessionQueue(x: any): boolean@staticmethod def is_cfn_game_session_queue(x: Any) -> boolpublic static Boolean isCfnGameSessionQueue(Object x)public static bool IsCfnGameSessionQueue(object x)func IsCfnGameSessionQueue(X interface{}) *boolstatic#
Checks whether the given object is a CfnGameSessionQueue.
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.