Documentation ¶
Index ¶
- func CfnAlias_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAlias_IsCfnElement(x interface{}) *bool
- func CfnAlias_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnAlias_IsConstruct(x interface{}) *bool
- func CfnBuild_CFN_RESOURCE_TYPE_NAME() *string
- func CfnBuild_IsCfnElement(x interface{}) *bool
- func CfnBuild_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnBuild_IsConstruct(x interface{}) *bool
- func CfnFleet_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFleet_IsCfnElement(x interface{}) *bool
- func CfnFleet_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnFleet_IsConstruct(x interface{}) *bool
- func CfnGameServerGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGameServerGroup_IsCfnElement(x interface{}) *bool
- func CfnGameServerGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnGameServerGroup_IsConstruct(x interface{}) *bool
- func CfnGameSessionQueue_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGameSessionQueue_IsCfnElement(x interface{}) *bool
- func CfnGameSessionQueue_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnGameSessionQueue_IsConstruct(x interface{}) *bool
- func CfnMatchmakingConfiguration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMatchmakingConfiguration_IsCfnElement(x interface{}) *bool
- func CfnMatchmakingConfiguration_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnMatchmakingConfiguration_IsConstruct(x interface{}) *bool
- func CfnMatchmakingRuleSet_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMatchmakingRuleSet_IsCfnElement(x interface{}) *bool
- func CfnMatchmakingRuleSet_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnMatchmakingRuleSet_IsConstruct(x interface{}) *bool
- func CfnScript_CFN_RESOURCE_TYPE_NAME() *string
- func CfnScript_IsCfnElement(x interface{}) *bool
- func CfnScript_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnScript_IsConstruct(x interface{}) *bool
- func NewCfnAlias_Override(c CfnAlias, scope constructs.Construct, id *string, props *CfnAliasProps)
- func NewCfnBuild_Override(c CfnBuild, scope constructs.Construct, id *string, props *CfnBuildProps)
- func NewCfnFleet_Override(c CfnFleet, scope constructs.Construct, id *string, props *CfnFleetProps)
- func NewCfnGameServerGroup_Override(c CfnGameServerGroup, scope constructs.Construct, id *string, ...)
- func NewCfnGameSessionQueue_Override(c CfnGameSessionQueue, scope constructs.Construct, id *string, ...)
- func NewCfnMatchmakingConfiguration_Override(c CfnMatchmakingConfiguration, scope constructs.Construct, id *string, ...)
- func NewCfnMatchmakingRuleSet_Override(c CfnMatchmakingRuleSet, scope constructs.Construct, id *string, ...)
- func NewCfnScript_Override(c CfnScript, scope constructs.Construct, id *string, props *CfnScriptProps)
- type CfnAlias
- type CfnAliasProps
- type CfnAlias_RoutingStrategyProperty
- type CfnBuild
- type CfnBuildProps
- type CfnBuild_S3LocationProperty
- type CfnFleet
- type CfnFleetProps
- type CfnFleet_CertificateConfigurationProperty
- type CfnFleet_IpPermissionProperty
- type CfnFleet_LocationCapacityProperty
- type CfnFleet_LocationConfigurationProperty
- type CfnFleet_ResourceCreationLimitPolicyProperty
- type CfnFleet_RuntimeConfigurationProperty
- type CfnFleet_ServerProcessProperty
- type CfnGameServerGroup
- type CfnGameServerGroupProps
- type CfnGameServerGroup_AutoScalingPolicyProperty
- type CfnGameServerGroup_InstanceDefinitionProperty
- type CfnGameServerGroup_LaunchTemplateProperty
- type CfnGameServerGroup_TargetTrackingConfigurationProperty
- type CfnGameSessionQueue
- type CfnGameSessionQueueProps
- type CfnGameSessionQueue_DestinationProperty
- type CfnGameSessionQueue_FilterConfigurationProperty
- type CfnGameSessionQueue_PlayerLatencyPolicyProperty
- type CfnGameSessionQueue_PriorityConfigurationProperty
- type CfnMatchmakingConfiguration
- type CfnMatchmakingConfigurationProps
- type CfnMatchmakingConfiguration_GamePropertyProperty
- type CfnMatchmakingRuleSet
- type CfnMatchmakingRuleSetProps
- type CfnScript
- type CfnScriptProps
- type CfnScript_S3LocationProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnAlias_CFN_RESOURCE_TYPE_NAME ¶
func CfnAlias_CFN_RESOURCE_TYPE_NAME() *string
func CfnAlias_IsCfnElement ¶
func CfnAlias_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnAlias_IsCfnResource ¶
func CfnAlias_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnAlias_IsConstruct ¶
func CfnAlias_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnBuild_CFN_RESOURCE_TYPE_NAME ¶
func CfnBuild_CFN_RESOURCE_TYPE_NAME() *string
func CfnBuild_IsCfnElement ¶
func CfnBuild_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnBuild_IsCfnResource ¶
func CfnBuild_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnBuild_IsConstruct ¶
func CfnBuild_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnFleet_CFN_RESOURCE_TYPE_NAME ¶
func CfnFleet_CFN_RESOURCE_TYPE_NAME() *string
func CfnFleet_IsCfnElement ¶
func CfnFleet_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnFleet_IsCfnResource ¶
func CfnFleet_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnFleet_IsConstruct ¶
func CfnFleet_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnGameServerGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnGameServerGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnGameServerGroup_IsCfnElement ¶
func CfnGameServerGroup_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnGameServerGroup_IsCfnResource ¶
func CfnGameServerGroup_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnGameServerGroup_IsConstruct ¶
func CfnGameServerGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnGameSessionQueue_CFN_RESOURCE_TYPE_NAME ¶
func CfnGameSessionQueue_CFN_RESOURCE_TYPE_NAME() *string
func CfnGameSessionQueue_IsCfnElement ¶
func CfnGameSessionQueue_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnGameSessionQueue_IsCfnResource ¶
func CfnGameSessionQueue_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnGameSessionQueue_IsConstruct ¶
func CfnGameSessionQueue_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnMatchmakingConfiguration_CFN_RESOURCE_TYPE_NAME ¶
func CfnMatchmakingConfiguration_CFN_RESOURCE_TYPE_NAME() *string
func CfnMatchmakingConfiguration_IsCfnElement ¶
func CfnMatchmakingConfiguration_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnMatchmakingConfiguration_IsCfnResource ¶
func CfnMatchmakingConfiguration_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnMatchmakingConfiguration_IsConstruct ¶
func CfnMatchmakingConfiguration_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnMatchmakingRuleSet_CFN_RESOURCE_TYPE_NAME ¶
func CfnMatchmakingRuleSet_CFN_RESOURCE_TYPE_NAME() *string
func CfnMatchmakingRuleSet_IsCfnElement ¶
func CfnMatchmakingRuleSet_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnMatchmakingRuleSet_IsCfnResource ¶
func CfnMatchmakingRuleSet_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnMatchmakingRuleSet_IsConstruct ¶
func CfnMatchmakingRuleSet_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnScript_CFN_RESOURCE_TYPE_NAME ¶
func CfnScript_CFN_RESOURCE_TYPE_NAME() *string
func CfnScript_IsCfnElement ¶
func CfnScript_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnScript_IsCfnResource ¶
func CfnScript_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnScript_IsConstruct ¶
func CfnScript_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnAlias_Override ¶
func NewCfnAlias_Override(c CfnAlias, scope constructs.Construct, id *string, props *CfnAliasProps)
Create a new `AWS::GameLift::Alias`.
func NewCfnBuild_Override ¶
func NewCfnBuild_Override(c CfnBuild, scope constructs.Construct, id *string, props *CfnBuildProps)
Create a new `AWS::GameLift::Build`.
func NewCfnFleet_Override ¶
func NewCfnFleet_Override(c CfnFleet, scope constructs.Construct, id *string, props *CfnFleetProps)
Create a new `AWS::GameLift::Fleet`.
func NewCfnGameServerGroup_Override ¶
func NewCfnGameServerGroup_Override(c CfnGameServerGroup, scope constructs.Construct, id *string, props *CfnGameServerGroupProps)
Create a new `AWS::GameLift::GameServerGroup`.
func NewCfnGameSessionQueue_Override ¶
func NewCfnGameSessionQueue_Override(c CfnGameSessionQueue, scope constructs.Construct, id *string, props *CfnGameSessionQueueProps)
Create a new `AWS::GameLift::GameSessionQueue`.
func NewCfnMatchmakingConfiguration_Override ¶
func NewCfnMatchmakingConfiguration_Override(c CfnMatchmakingConfiguration, scope constructs.Construct, id *string, props *CfnMatchmakingConfigurationProps)
Create a new `AWS::GameLift::MatchmakingConfiguration`.
func NewCfnMatchmakingRuleSet_Override ¶
func NewCfnMatchmakingRuleSet_Override(c CfnMatchmakingRuleSet, scope constructs.Construct, id *string, props *CfnMatchmakingRuleSetProps)
Create a new `AWS::GameLift::MatchmakingRuleSet`.
func NewCfnScript_Override ¶
func NewCfnScript_Override(c CfnScript, scope constructs.Construct, id *string, props *CfnScriptProps)
Create a new `AWS::GameLift::Script`.
Types ¶
type CfnAlias ¶
type CfnAlias interface { awscdk.CfnResource awscdk.IInspectable // A unique identifier for the alias. For example, `arn:aws:gamelift:us-west-1::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`. // // Alias IDs are unique within a Region. AttrAliasId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A human-readable description of the alias. Description() *string SetDescription(val *string) // 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)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // A descriptive label that is associated with an alias. // // Alias names do not need to be unique. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The routing configuration, including routing type and fleet target, for the alias. RoutingStrategy() interface{} SetRoutingStrategy(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::GameLift::Alias`.
The `AWS::GameLift::Alias` resource creates an alias for an Amazon GameLift (GameLift) fleet destination. There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions.
Example:
// 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" cfnAlias := awscdk.Aws_gamelift.NewCfnAlias(this, jsii.String("MyCfnAlias"), &cfnAliasProps{ name: jsii.String("name"), routingStrategy: &routingStrategyProperty{ type: jsii.String("type"), // the properties below are optional fleetId: jsii.String("fleetId"), message: jsii.String("message"), }, // the properties below are optional description: jsii.String("description"), })
func NewCfnAlias ¶
func NewCfnAlias(scope constructs.Construct, id *string, props *CfnAliasProps) CfnAlias
Create a new `AWS::GameLift::Alias`.
type CfnAliasProps ¶
type CfnAliasProps struct { // A descriptive label that is associated with an alias. // // Alias names do not need to be unique. Name *string `field:"required" json:"name" yaml:"name"` // The routing configuration, including routing type and fleet target, for the alias. RoutingStrategy interface{} `field:"required" json:"routingStrategy" yaml:"routingStrategy"` // A human-readable description of the alias. Description *string `field:"optional" json:"description" yaml:"description"` }
Properties for defining a `CfnAlias`.
Example:
// 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" cfnAliasProps := &cfnAliasProps{ name: jsii.String("name"), routingStrategy: &routingStrategyProperty{ type: jsii.String("type"), // the properties below are optional fleetId: jsii.String("fleetId"), message: jsii.String("message"), }, // the properties below are optional description: jsii.String("description"), }
type CfnAlias_RoutingStrategyProperty ¶
type CfnAlias_RoutingStrategyProperty struct { // A type of routing strategy. // // Possible routing types include the following: // // - *SIMPLE* - The alias resolves to one specific fleet. Use this type when routing to active fleets. // - *TERMINAL* - The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a `TerminalRoutingStrategyException` with the message that you specified in the `Message` property. Type *string `field:"required" json:"type" yaml:"type"` // A unique identifier for a fleet that the alias points to. // // If you specify `SIMPLE` for the `Type` property, you must specify this property. FleetId *string `field:"optional" json:"fleetId" yaml:"fleetId"` // The message text to be used with a terminal routing strategy. // // If you specify `TERMINAL` for the `Type` property, you must specify this property. Message *string `field:"optional" json:"message" yaml:"message"` }
The routing configuration for a fleet alias.
Example:
// 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" routingStrategyProperty := &routingStrategyProperty{ type: jsii.String("type"), // the properties below are optional fleetId: jsii.String("fleetId"), message: jsii.String("message"), }
type CfnBuild ¶
type CfnBuild interface { awscdk.CfnResource awscdk.IInspectable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // 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)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // A descriptive label that is associated with a build. // // Build names do not need to be unique. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // The operating system that the game server binaries are built to run on. // // This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later. OperatingSystem() *string SetOperatingSystem(val *string) // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Information indicating where your game build files are stored. // // Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region. // // If a `StorageLocation` is specified, the size of your file can be found in your Amazon S3 bucket. Amazon GameLift will report a `SizeOnDisk` of 0. StorageLocation() interface{} SetStorageLocation(val interface{}) // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Version information that is associated with this build. // // Version strings do not need to be unique. Version() *string SetVersion(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::GameLift::Build`.
The `AWS::GameLift::Build` resource creates a game server build that is installed and run on instances in an Amazon GameLift fleet. This resource points to an Amazon S3 location that contains a zip file with all of the components of the game server build.
Example:
// 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" cfnBuild := awscdk.Aws_gamelift.NewCfnBuild(this, jsii.String("MyCfnBuild"), &cfnBuildProps{ name: jsii.String("name"), operatingSystem: jsii.String("operatingSystem"), storageLocation: &s3LocationProperty{ bucket: jsii.String("bucket"), key: jsii.String("key"), roleArn: jsii.String("roleArn"), // the properties below are optional objectVersion: jsii.String("objectVersion"), }, version: jsii.String("version"), })
func NewCfnBuild ¶
func NewCfnBuild(scope constructs.Construct, id *string, props *CfnBuildProps) CfnBuild
Create a new `AWS::GameLift::Build`.
type CfnBuildProps ¶
type CfnBuildProps struct { // A descriptive label that is associated with a build. // // Build names do not need to be unique. Name *string `field:"optional" json:"name" yaml:"name"` // The operating system that the game server binaries are built to run on. // // This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later. OperatingSystem *string `field:"optional" json:"operatingSystem" yaml:"operatingSystem"` // Information indicating where your game build files are stored. // // Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region. // // If a `StorageLocation` is specified, the size of your file can be found in your Amazon S3 bucket. Amazon GameLift will report a `SizeOnDisk` of 0. StorageLocation interface{} `field:"optional" json:"storageLocation" yaml:"storageLocation"` // Version information that is associated with this build. // // Version strings do not need to be unique. Version *string `field:"optional" json:"version" yaml:"version"` }
Properties for defining a `CfnBuild`.
Example:
// 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" cfnBuildProps := &cfnBuildProps{ name: jsii.String("name"), operatingSystem: jsii.String("operatingSystem"), storageLocation: &s3LocationProperty{ bucket: jsii.String("bucket"), key: jsii.String("key"), roleArn: jsii.String("roleArn"), // the properties below are optional objectVersion: jsii.String("objectVersion"), }, version: jsii.String("version"), }
type CfnBuild_S3LocationProperty ¶
type CfnBuild_S3LocationProperty struct { // An Amazon S3 bucket identifier. This is the name of the S3 bucket. // // > GameLift currently does not support uploading from Amazon S3 buckets with names that contain a dot (.). Bucket *string `field:"required" json:"bucket" yaml:"bucket"` // The name of the zip file that contains the build files or script files. Key *string `field:"required" json:"key" yaml:"key"` // The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) for an IAM role that allows Amazon GameLift to access the S3 bucket. RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // The version of the file, if object versioning is turned on for the bucket. // // Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter. ObjectVersion *string `field:"optional" json:"objectVersion" yaml:"objectVersion"` }
The location in Amazon S3 where build or script files are stored for access by Amazon GameLift.
Example:
// 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" s3LocationProperty := &s3LocationProperty{ bucket: jsii.String("bucket"), key: jsii.String("key"), roleArn: jsii.String("roleArn"), // the properties below are optional objectVersion: jsii.String("objectVersion"), }
type CfnFleet ¶
type CfnFleet interface { awscdk.CfnResource awscdk.IInspectable // A unique identifier for the fleet. AttrFleetId() *string // A unique identifier for a build to be deployed on the new fleet. // // 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. BuildId() *string SetBuildId(val *string) // Prompts GameLift to generate a TLS/SSL certificate for the fleet. // // GameLift uses the certificates to encrypt traffic between game clients and the game servers running on GameLift. By default, the `CertificateConfiguration` is `DISABLED` . You can't change this property after you create the fleet. // // AWS 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](https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html) in the *AWS Certificate Manager User Guide* . CertificateConfiguration() interface{} SetCertificateConfiguration(val interface{}) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A human-readable description of the fleet. Description() *string SetDescription(val *string) // The number of EC2 instances that you want this fleet to host. // // 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. DesiredEc2Instances() *float64 SetDesiredEc2Instances(val *float64) // The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. // // If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, GameLift automatically sets TCP and UDP ranges. Ec2InboundPermissions() interface{} SetEc2InboundPermissions(val interface{}) // The GameLift-supported Amazon EC2 instance type to use for all fleet instances. // // 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](https://docs.aws.amazon.com/ec2/instance-types/) for detailed descriptions of Amazon EC2 instance types. Ec2InstanceType() *string SetEc2InstanceType(val *string) // Indicates whether to use On-Demand or Spot instances for this fleet. // // By default, this property is set to `ON_DEMAND` . Learn more about when to use [On-Demand versus Spot Instances](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot) . This property cannot be changed after the fleet is created. FleetType() *string SetFleetType(val *string) // A unique identifier for an IAM role that manages access to your AWS services. // // 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](https://docs.aws.amazon.com/iam/) in the AWS Management Console . Learn more about using on-box credentials for your game servers at [Access external resources from a game server](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html) . This property cannot be changed after the fleet is created. InstanceRoleArn() *string SetInstanceRoleArn(val *string) // A set of remote locations to deploy additional instances to and manage as part of the fleet. // // This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as `us-west-2` . To create a fleet with instances in the home Region only, omit this parameter. Locations() interface{} SetLocations(val interface{}) // 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)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The maximum number of instances that are allowed in the specified fleet location. // // If this parameter is not set, the default is 1. MaxSize() *float64 SetMaxSize(val *float64) // 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. MetricGroups() *[]*string SetMetricGroups(val *[]*string) // The minimum number of instances that are allowed in the specified fleet location. // // If this parameter is not set, the default is 0. MinSize() *float64 SetMinSize(val *float64) // A descriptive label that is associated with a fleet. // // Fleet names do not need to be unique. Name() *string SetName(val *string) // The status of termination protection for active game sessions on the fleet. // // 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. NewGameSessionProtectionPolicy() *string SetNewGameSessionProtectionPolicy(val *string) // The tree node. Node() constructs.Node // Used when peering your GameLift 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. PeerVpcAwsAccountId() *string SetPeerVpcAwsAccountId(val *string) // A unique identifier for a VPC with resources to be accessed by your GameLift fleet. // // The VPC must be in the same Region as your fleet. To look up a VPC ID, use the [VPC Dashboard](https://docs.aws.amazon.com/vpc/) in the AWS Management Console . Learn more about VPC peering in [VPC Peering with GameLift Fleets](https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html) . PeerVpcId() *string SetPeerVpcId(val *string) // 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 })`. Ref() *string // 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. ResourceCreationLimitPolicy() interface{} SetResourceCreationLimitPolicy(val interface{}) // Instructions for how to launch and maintain server processes on instances in the fleet. // // 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. RuntimeConfiguration() interface{} SetRuntimeConfiguration(val interface{}) // The unique identifier for a Realtime configuration script to be deployed on fleet instances. // // You can use either the script ID or ARN. Scripts must be uploaded to GameLift 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. ScriptId() *string SetScriptId(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::GameLift::Fleet`.
The `AWS::GameLift::Fleet` resource creates an Amazon GameLift (GameLift) fleet to host game servers. A fleet is a set of EC2 instances, each of which can host multiple game sessions.
Example:
// 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{ buildId: jsii.String("buildId"), certificateConfiguration: &certificateConfigurationProperty{ certificateType: jsii.String("certificateType"), }, 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"), locations: []interface{}{ &locationConfigurationProperty{ location: jsii.String("location"), // the properties below are optional locationCapacity: &locationCapacityProperty{ desiredEc2Instances: jsii.Number(123), maxSize: jsii.Number(123), minSize: jsii.Number(123), }, }, }, maxSize: jsii.Number(123), metricGroups: []*string{ jsii.String("metricGroups"), }, minSize: jsii.Number(123), name: jsii.String("name"), newGameSessionProtectionPolicy: jsii.String("newGameSessionProtectionPolicy"), peerVpcAwsAccountId: jsii.String("peerVpcAwsAccountId"), peerVpcId: jsii.String("peerVpcId"), 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"), }, }, }, scriptId: jsii.String("scriptId"), })
func NewCfnFleet ¶
func NewCfnFleet(scope constructs.Construct, id *string, props *CfnFleetProps) CfnFleet
Create a new `AWS::GameLift::Fleet`.
type CfnFleetProps ¶
type CfnFleetProps struct { // A unique identifier for a build to be deployed on the new fleet. // // 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. BuildId *string `field:"optional" json:"buildId" yaml:"buildId"` // Prompts GameLift to generate a TLS/SSL certificate for the fleet. // // GameLift uses the certificates to encrypt traffic between game clients and the game servers running on GameLift. By default, the `CertificateConfiguration` is `DISABLED` . You can't change this property after you create the fleet. // // AWS 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](https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html) in the *AWS Certificate Manager User Guide* . CertificateConfiguration interface{} `field:"optional" json:"certificateConfiguration" yaml:"certificateConfiguration"` // A human-readable description of the fleet. Description *string `field:"optional" json:"description" yaml:"description"` // The number of EC2 instances that you want this fleet to host. // // 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. DesiredEc2Instances *float64 `field:"optional" json:"desiredEc2Instances" yaml:"desiredEc2Instances"` // The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. // // If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, GameLift automatically sets TCP and UDP ranges. Ec2InboundPermissions interface{} `field:"optional" json:"ec2InboundPermissions" yaml:"ec2InboundPermissions"` // The GameLift-supported Amazon EC2 instance type to use for all fleet instances. // // 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](https://docs.aws.amazon.com/ec2/instance-types/) for detailed descriptions of Amazon EC2 instance types. Ec2InstanceType *string `field:"optional" json:"ec2InstanceType" yaml:"ec2InstanceType"` // Indicates whether to use On-Demand or Spot instances for this fleet. // // By default, this property is set to `ON_DEMAND` . Learn more about when to use [On-Demand versus Spot Instances](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot) . This property cannot be changed after the fleet is created. FleetType *string `field:"optional" json:"fleetType" yaml:"fleetType"` // A unique identifier for an IAM role that manages access to your AWS services. // // 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](https://docs.aws.amazon.com/iam/) in the AWS Management Console . Learn more about using on-box credentials for your game servers at [Access external resources from a game server](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html) . This property cannot be changed after the fleet is created. InstanceRoleArn *string `field:"optional" json:"instanceRoleArn" yaml:"instanceRoleArn"` // A set of remote locations to deploy additional instances to and manage as part of the fleet. // // This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as `us-west-2` . To create a fleet with instances in the home Region only, omit this parameter. Locations interface{} `field:"optional" json:"locations" yaml:"locations"` // The maximum number of instances that are allowed in the specified fleet location. // // If this parameter is not set, the default is 1. MaxSize *float64 `field:"optional" json:"maxSize" yaml:"maxSize"` // 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. MetricGroups *[]*string `field:"optional" json:"metricGroups" yaml:"metricGroups"` // The minimum number of instances that are allowed in the specified fleet location. // // If this parameter is not set, the default is 0. MinSize *float64 `field:"optional" json:"minSize" yaml:"minSize"` // A descriptive label that is associated with a fleet. // // Fleet names do not need to be unique. Name *string `field:"optional" json:"name" yaml:"name"` // The status of termination protection for active game sessions on the fleet. // // 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. NewGameSessionProtectionPolicy *string `field:"optional" json:"newGameSessionProtectionPolicy" yaml:"newGameSessionProtectionPolicy"` // Used when peering your GameLift 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. PeerVpcAwsAccountId *string `field:"optional" json:"peerVpcAwsAccountId" yaml:"peerVpcAwsAccountId"` // A unique identifier for a VPC with resources to be accessed by your GameLift fleet. // // The VPC must be in the same Region as your fleet. To look up a VPC ID, use the [VPC Dashboard](https://docs.aws.amazon.com/vpc/) in the AWS Management Console . Learn more about VPC peering in [VPC Peering with GameLift Fleets](https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html) . PeerVpcId *string `field:"optional" json:"peerVpcId" yaml:"peerVpcId"` // 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. ResourceCreationLimitPolicy interface{} `field:"optional" json:"resourceCreationLimitPolicy" yaml:"resourceCreationLimitPolicy"` // Instructions for how to launch and maintain server processes on instances in the fleet. // // 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. RuntimeConfiguration interface{} `field:"optional" json:"runtimeConfiguration" yaml:"runtimeConfiguration"` // The unique identifier for a Realtime configuration script to be deployed on fleet instances. // // You can use either the script ID or ARN. Scripts must be uploaded to GameLift 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. ScriptId *string `field:"optional" json:"scriptId" yaml:"scriptId"` }
Properties for defining a `CfnFleet`.
Example:
// 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" cfnFleetProps := &cfnFleetProps{ buildId: jsii.String("buildId"), certificateConfiguration: &certificateConfigurationProperty{ certificateType: jsii.String("certificateType"), }, 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"), locations: []interface{}{ &locationConfigurationProperty{ location: jsii.String("location"), // the properties below are optional locationCapacity: &locationCapacityProperty{ desiredEc2Instances: jsii.Number(123), maxSize: jsii.Number(123), minSize: jsii.Number(123), }, }, }, maxSize: jsii.Number(123), metricGroups: []*string{ jsii.String("metricGroups"), }, minSize: jsii.Number(123), name: jsii.String("name"), newGameSessionProtectionPolicy: jsii.String("newGameSessionProtectionPolicy"), peerVpcAwsAccountId: jsii.String("peerVpcAwsAccountId"), peerVpcId: jsii.String("peerVpcId"), 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"), }, }, }, scriptId: jsii.String("scriptId"), }
type CfnFleet_CertificateConfigurationProperty ¶
type CfnFleet_CertificateConfigurationProperty struct { // Indicates whether a TLS/SSL certificate is generated for a fleet. // // Valid values include: // // - *GENERATED* - Generate a TLS/SSL certificate for this fleet. // - *DISABLED* - (default) Do not generate a TLS/SSL certificate for this fleet. CertificateType *string `field:"required" json:"certificateType" yaml:"certificateType"` }
Determines whether a TLS/SSL certificate is generated for a fleet.
This feature must be enabled when creating the fleet. All instances in a fleet share the same certificate. The certificate can be retrieved by calling the [GameLift Server SDK](https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html) operation `GetInstanceCertificate` .
Example:
// 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" certificateConfigurationProperty := &certificateConfigurationProperty{ certificateType: jsii.String("certificateType"), }
type CfnFleet_IpPermissionProperty ¶
type CfnFleet_IpPermissionProperty struct { // A starting value for a range of allowed port numbers. // // For fleets using Windows and Linux builds, only ports 1026-60000 are valid. FromPort *float64 `field:"required" json:"fromPort" yaml:"fromPort"` // A range of allowed IP addresses. // // This value must be expressed in CIDR notation. Example: " `000.000.000.000/[subnet mask]` " or optionally the shortened version " `0.0.0.0/[subnet mask]` ". IpRange *string `field:"required" json:"ipRange" yaml:"ipRange"` // The network communication protocol used by the fleet. Protocol *string `field:"required" json:"protocol" yaml:"protocol"` // An ending value for a range of allowed port numbers. // // Port numbers are end-inclusive. This value must be higher than `FromPort` . // // For fleets using Windows and Linux builds, only ports 1026-60000 are valid. ToPort *float64 `field:"required" json:"toPort" yaml:"toPort"` }
A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an instance in a fleet.
New game sessions are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. Fleets with custom game builds must have permissions explicitly set. For Realtime Servers fleets, GameLift automatically opens two port ranges, one for TCP messaging and one for UDP.
Example:
// 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" ipPermissionProperty := &ipPermissionProperty{ fromPort: jsii.Number(123), ipRange: jsii.String("ipRange"), protocol: jsii.String("protocol"), toPort: jsii.Number(123), }
type CfnFleet_LocationCapacityProperty ¶
type CfnFleet_LocationCapacityProperty struct { // The number of Amazon EC2 instances you want to maintain in the specified fleet location. // // This value must fall between the minimum and maximum size limits. DesiredEc2Instances *float64 `field:"required" json:"desiredEc2Instances" yaml:"desiredEc2Instances"` // The maximum number of instances that are allowed in the specified fleet location. // // If this parameter is not set, the default is 1. MaxSize *float64 `field:"required" json:"maxSize" yaml:"maxSize"` // The minimum number of instances that are allowed in the specified fleet location. // // If this parameter is not set, the default is 0. MinSize *float64 `field:"required" json:"minSize" yaml:"minSize"` }
Current resource capacity settings in a specified fleet or location.
The location value might refer to a fleet's remote location or its home Region.
*Related actions*
[DescribeFleetCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html) | [DescribeFleetLocationCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html) | [UpdateFleetCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html)
Example:
// 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" locationCapacityProperty := &locationCapacityProperty{ desiredEc2Instances: jsii.Number(123), maxSize: jsii.Number(123), minSize: jsii.Number(123), }
type CfnFleet_LocationConfigurationProperty ¶
type CfnFleet_LocationConfigurationProperty struct { // An AWS Region code, such as `us-west-2` . Location *string `field:"required" json:"location" yaml:"location"` // Current resource capacity settings in a specified fleet or location. // // The location value might refer to a fleet's remote location or its home Region. // // *Related actions* // // [DescribeFleetCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html) | [DescribeFleetLocationCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html) | [UpdateFleetCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html) LocationCapacity interface{} `field:"optional" json:"locationCapacity" yaml:"locationCapacity"` }
A remote location where a multi-location fleet can deploy EC2 instances for game hosting.
*Related actions*
[CreateFleet](https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html)
Example:
// 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" locationConfigurationProperty := &locationConfigurationProperty{ location: jsii.String("location"), // the properties below are optional locationCapacity: &locationCapacityProperty{ desiredEc2Instances: jsii.Number(123), maxSize: jsii.Number(123), minSize: jsii.Number(123), }, }
type CfnFleet_ResourceCreationLimitPolicyProperty ¶
type CfnFleet_ResourceCreationLimitPolicyProperty struct { // The maximum number of game sessions that an individual can create during the policy period. NewGameSessionsPerCreator *float64 `field:"optional" json:"newGameSessionsPerCreator" yaml:"newGameSessionsPerCreator"` // The time span used in evaluating the resource creation limit policy. PolicyPeriodInMinutes *float64 `field:"optional" json:"policyPeriodInMinutes" yaml:"policyPeriodInMinutes"` }
A policy that limits the number of game sessions a player can create on the same fleet.
This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period".
The policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a `CreateGameSession` request, Amazon GameLift checks that the player (identified by `CreatorId` ) has created fewer than 10 game sessions in the past 60 minutes.
Example:
// 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" resourceCreationLimitPolicyProperty := &resourceCreationLimitPolicyProperty{ newGameSessionsPerCreator: jsii.Number(123), policyPeriodInMinutes: jsii.Number(123), }
type CfnFleet_RuntimeConfigurationProperty ¶
type CfnFleet_RuntimeConfigurationProperty struct { // The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. // // During this time, the game session is in status `ACTIVATING` . If the game session does not become active before the timeout, it is ended and the game session status is changed to `TERMINATED` . GameSessionActivationTimeoutSeconds *float64 `field:"optional" json:"gameSessionActivationTimeoutSeconds" yaml:"gameSessionActivationTimeoutSeconds"` // The number of game sessions in status `ACTIVATING` to allow on an instance. // // This setting limits the instance resources that can be used for new game activations at any one time. MaxConcurrentGameSessionActivations *float64 `field:"optional" json:"maxConcurrentGameSessionActivations" yaml:"maxConcurrentGameSessionActivations"` // A collection of server process configurations that identify what server processes to run on each instance in a fleet. ServerProcesses interface{} `field:"optional" json:"serverProcesses" yaml:"serverProcesses"` }
A collection of server process configurations that describe the set of processes to run on each instance in a fleet.
Server processes run either an executable in a custom game build or a Realtime Servers script. GameLift launches the configured processes, manages their life cycle, and replaces them as needed. Each instance checks regularly for an updated runtime configuration.
A GameLift instance is limited to 50 processes running concurrently. To calculate the total number of processes in a runtime configuration, add the values of the `ConcurrentExecutions` parameter for each ServerProcess. Learn more about [Running Multiple Processes on a Fleet](https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html) .
Example:
// 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" runtimeConfigurationProperty := &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"), }, }, }
type CfnFleet_ServerProcessProperty ¶
type CfnFleet_ServerProcessProperty struct { // The number of server processes using this configuration that run concurrently on each instance. ConcurrentExecutions *float64 `field:"required" json:"concurrentExecutions" yaml:"concurrentExecutions"` // The location of a game build executable or the Realtime script file that contains the `Init()` function. // // Game builds and Realtime scripts are installed on instances at the root: // // - Windows (custom game builds only): `C:\game` . Example: " `C:\game\MyGame\server.exe` " // - Linux: `/local/game` . Examples: " `/local/game/MyGame/server.exe` " or " `/local/game/MyRealtimeScript.js` " LaunchPath *string `field:"required" json:"launchPath" yaml:"launchPath"` // An optional list of parameters to pass to the server executable or Realtime script on launch. Parameters *string `field:"optional" json:"parameters" yaml:"parameters"` }
A set of instructions for launching server processes on each instance in a fleet.
Server processes run either an executable in a custom game build or a Realtime Servers script.
Example:
// 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" serverProcessProperty := &serverProcessProperty{ concurrentExecutions: jsii.Number(123), launchPath: jsii.String("launchPath"), // the properties below are optional parameters: jsii.String("parameters"), }
type CfnGameServerGroup ¶
type CfnGameServerGroup interface { awscdk.CfnResource awscdk.IInspectable // A unique identifier for the auto scaling group. AttrAutoScalingGroupArn() *string // A unique identifier for the game server group. AttrGameServerGroupArn() *string // Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. // // The scaling policy uses the metric `"PercentUtilizedGameServers"` to maintain a buffer of idle game servers that can immediately accommodate new games and players. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs. AutoScalingPolicy() interface{} SetAutoScalingPolicy(val interface{}) // Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. // // Method options include the following: // // - `SPOT_ONLY` - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced. // - `SPOT_PREFERRED` - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances. // - `ON_DEMAND_ONLY` - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force. BalancingStrategy() *string SetBalancingStrategy(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The type of delete to perform. // // To delete a game server group, specify the `DeleteOption` . Options include the following: // // - `SAFE_DELETE` – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in `UTILIZED` status. // - `FORCE_DELETE` – Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group. // - `RETAIN` – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is. DeleteOption() *string SetDeleteOption(val *string) // A developer-defined identifier for the game server group. // // The name is unique for each Region in each AWS account. GameServerGroupName() *string SetGameServerGroupName(val *string) // A flag that indicates whether instances in the game server group are protected from early termination. // // Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status. GameServerProtectionPolicy() *string SetGameServerProtectionPolicy(val *string) // The set of Amazon EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group. InstanceDefinitions() interface{} SetInstanceDefinitions(val interface{}) // The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. // // You can specify the template using either the template name or ID. For help with creating a launch template, see [Creating a Launch Template for an Auto Scaling Group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon Elastic Compute Cloud Auto Scaling User Guide* . After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs. // // > If you specify network interfaces in your launch template, you must explicitly set the property `AssociatePublicIpAddress` to "true". If no network interface is specified in the launch template, GameLift FleetIQ uses your account's default VPC. LaunchTemplate() interface{} SetLaunchTemplate(val interface{}) // 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)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. // // During automatic scaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs. MaxSize() *float64 SetMaxSize(val *float64) // The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. // // During automatic scaling events, GameLift FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs. MinSize() *float64 SetMinSize(val *float64) // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups. RoleArn() *string SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // A list of labels to assign to the new game server group resource. // // Tags are developer-defined key-value pairs. Tagging AWS resources is useful for resource management, access management, and cost allocation. For more information, see [Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *AWS General Reference* . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags, respectively. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits. Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // A list of virtual private cloud (VPC) subnets to use with instances in the game server group. // // By default, all GameLift FleetIQ-supported Availability Zones are used. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly. VpcSubnets() *[]*string SetVpcSubnets(val *[]*string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::GameLift::GameServerGroup`.
*This operation is used with the Amazon GameLift FleetIQ solution and game server groups.*
Creates a GameLift FleetIQ game server group for managing game hosting on a collection of Amazon EC2 instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your AWS account , and establishes a link between the two groups. You can view the status of your game server groups in the GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch.
Before creating a new game server group, you must have the following:
- An Amazon EC2 launch template that specifies how to launch Amazon EC2 instances with your game server build. For more information, see [Launching an Instance from a Launch Template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide* . - An IAM role that extends limited access to your AWS account to allow GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see [Create IAM roles for cross-service interaction](https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-iam-permissions-roles.html) in the *GameLift FleetIQ Developer Guide* .
To create a new game server group, specify a unique group name, IAM role and Amazon EC2 launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ metric.
Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.
*Learn more*
[GameLift FleetIQ Guide](https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html)
Example:
// 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" cfnGameServerGroup := awscdk.Aws_gamelift.NewCfnGameServerGroup(this, jsii.String("MyCfnGameServerGroup"), &cfnGameServerGroupProps{ gameServerGroupName: jsii.String("gameServerGroupName"), instanceDefinitions: []interface{}{ &instanceDefinitionProperty{ instanceType: jsii.String("instanceType"), // the properties below are optional weightedCapacity: jsii.String("weightedCapacity"), }, }, launchTemplate: &launchTemplateProperty{ launchTemplateId: jsii.String("launchTemplateId"), launchTemplateName: jsii.String("launchTemplateName"), version: jsii.String("version"), }, roleArn: jsii.String("roleArn"), // the properties below are optional autoScalingPolicy: &autoScalingPolicyProperty{ targetTrackingConfiguration: &targetTrackingConfigurationProperty{ targetValue: jsii.Number(123), }, // the properties below are optional estimatedInstanceWarmup: jsii.Number(123), }, balancingStrategy: jsii.String("balancingStrategy"), deleteOption: jsii.String("deleteOption"), gameServerProtectionPolicy: jsii.String("gameServerProtectionPolicy"), maxSize: jsii.Number(123), minSize: jsii.Number(123), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, vpcSubnets: []*string{ jsii.String("vpcSubnets"), }, })
func NewCfnGameServerGroup ¶
func NewCfnGameServerGroup(scope constructs.Construct, id *string, props *CfnGameServerGroupProps) CfnGameServerGroup
Create a new `AWS::GameLift::GameServerGroup`.
type CfnGameServerGroupProps ¶
type CfnGameServerGroupProps struct { // A developer-defined identifier for the game server group. // // The name is unique for each Region in each AWS account. GameServerGroupName *string `field:"required" json:"gameServerGroupName" yaml:"gameServerGroupName"` // The set of Amazon EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group. InstanceDefinitions interface{} `field:"required" json:"instanceDefinitions" yaml:"instanceDefinitions"` // The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. // // You can specify the template using either the template name or ID. For help with creating a launch template, see [Creating a Launch Template for an Auto Scaling Group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon Elastic Compute Cloud Auto Scaling User Guide* . After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs. // // > If you specify network interfaces in your launch template, you must explicitly set the property `AssociatePublicIpAddress` to "true". If no network interface is specified in the launch template, GameLift FleetIQ uses your account's default VPC. LaunchTemplate interface{} `field:"required" json:"launchTemplate" yaml:"launchTemplate"` // The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups. RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. // // The scaling policy uses the metric `"PercentUtilizedGameServers"` to maintain a buffer of idle game servers that can immediately accommodate new games and players. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs. AutoScalingPolicy interface{} `field:"optional" json:"autoScalingPolicy" yaml:"autoScalingPolicy"` // Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. // // Method options include the following: // // - `SPOT_ONLY` - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced. // - `SPOT_PREFERRED` - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances. // - `ON_DEMAND_ONLY` - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force. BalancingStrategy *string `field:"optional" json:"balancingStrategy" yaml:"balancingStrategy"` // The type of delete to perform. // // To delete a game server group, specify the `DeleteOption` . Options include the following: // // - `SAFE_DELETE` – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in `UTILIZED` status. // - `FORCE_DELETE` – Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group. // - `RETAIN` – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is. DeleteOption *string `field:"optional" json:"deleteOption" yaml:"deleteOption"` // A flag that indicates whether instances in the game server group are protected from early termination. // // Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status. GameServerProtectionPolicy *string `field:"optional" json:"gameServerProtectionPolicy" yaml:"gameServerProtectionPolicy"` // The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. // // During automatic scaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs. MaxSize *float64 `field:"optional" json:"maxSize" yaml:"maxSize"` // The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. // // During automatic scaling events, GameLift FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs. MinSize *float64 `field:"optional" json:"minSize" yaml:"minSize"` // A list of labels to assign to the new game server group resource. // // Tags are developer-defined key-value pairs. Tagging AWS resources is useful for resource management, access management, and cost allocation. For more information, see [Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *AWS General Reference* . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags, respectively. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // A list of virtual private cloud (VPC) subnets to use with instances in the game server group. // // By default, all GameLift FleetIQ-supported Availability Zones are used. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly. VpcSubnets *[]*string `field:"optional" json:"vpcSubnets" yaml:"vpcSubnets"` }
Properties for defining a `CfnGameServerGroup`.
Example:
// 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" cfnGameServerGroupProps := &cfnGameServerGroupProps{ gameServerGroupName: jsii.String("gameServerGroupName"), instanceDefinitions: []interface{}{ &instanceDefinitionProperty{ instanceType: jsii.String("instanceType"), // the properties below are optional weightedCapacity: jsii.String("weightedCapacity"), }, }, launchTemplate: &launchTemplateProperty{ launchTemplateId: jsii.String("launchTemplateId"), launchTemplateName: jsii.String("launchTemplateName"), version: jsii.String("version"), }, roleArn: jsii.String("roleArn"), // the properties below are optional autoScalingPolicy: &autoScalingPolicyProperty{ targetTrackingConfiguration: &targetTrackingConfigurationProperty{ targetValue: jsii.Number(123), }, // the properties below are optional estimatedInstanceWarmup: jsii.Number(123), }, balancingStrategy: jsii.String("balancingStrategy"), deleteOption: jsii.String("deleteOption"), gameServerProtectionPolicy: jsii.String("gameServerProtectionPolicy"), maxSize: jsii.Number(123), minSize: jsii.Number(123), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, vpcSubnets: []*string{ jsii.String("vpcSubnets"), }, }
type CfnGameServerGroup_AutoScalingPolicyProperty ¶
type CfnGameServerGroup_AutoScalingPolicyProperty struct { // Settings for a target-based scaling policy applied to Auto Scaling group. // // These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric `PercentUtilizedGameServers` and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value. TargetTrackingConfiguration interface{} `field:"required" json:"targetTrackingConfiguration" yaml:"targetTrackingConfiguration"` // Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ. // // Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances. EstimatedInstanceWarmup *float64 `field:"optional" json:"estimatedInstanceWarmup" yaml:"estimatedInstanceWarmup"` }
*This data type is used with the GameLift FleetIQ and game server groups.*.
Configuration settings for intelligent automatic scaling that uses target tracking. After the Auto Scaling group is created, all updates to Auto Scaling policies, including changing this policy and adding or removing other policies, is done directly on the Auto Scaling group.
Example:
// 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" autoScalingPolicyProperty := &autoScalingPolicyProperty{ targetTrackingConfiguration: &targetTrackingConfigurationProperty{ targetValue: jsii.Number(123), }, // the properties below are optional estimatedInstanceWarmup: jsii.Number(123), }
type CfnGameServerGroup_InstanceDefinitionProperty ¶
type CfnGameServerGroup_InstanceDefinitionProperty struct { // An Amazon EC2 instance type designation. InstanceType *string `field:"required" json:"instanceType" yaml:"instanceType"` // Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. // // Instance weights are used by GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see [Instance Weighting](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html) in the *Amazon Elastic Compute Cloud Auto Scaling User Guide* . Default value is "1". WeightedCapacity *string `field:"optional" json:"weightedCapacity" yaml:"weightedCapacity"` }
*This data type is used with the Amazon GameLift FleetIQ and game server groups.*.
An allowed instance type for a `GameServerGroup` . All game server groups must have at least two instance types defined for it. GameLift FleetIQ periodically evaluates each defined instance type for viability. It then updates the Auto Scaling group with the list of viable instance types.
Example:
// 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" instanceDefinitionProperty := &instanceDefinitionProperty{ instanceType: jsii.String("instanceType"), // the properties below are optional weightedCapacity: jsii.String("weightedCapacity"), }
type CfnGameServerGroup_LaunchTemplateProperty ¶
type CfnGameServerGroup_LaunchTemplateProperty struct { // A unique identifier for an existing Amazon EC2 launch template. LaunchTemplateId *string `field:"optional" json:"launchTemplateId" yaml:"launchTemplateId"` // A readable identifier for an existing Amazon EC2 launch template. LaunchTemplateName *string `field:"optional" json:"launchTemplateName" yaml:"launchTemplateName"` // The version of the Amazon EC2 launch template to use. // // If no version is specified, the default version will be used. With Amazon EC2, you can specify a default version for a launch template. If none is set, the default is the first version created. Version *string `field:"optional" json:"version" yaml:"version"` }
*This data type is used with the GameLift FleetIQ and game server groups.*.
An Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in a game server group. The launch template is specified when creating a new game server group with `GameServerGroup` .
Example:
// 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" launchTemplateProperty := &launchTemplateProperty{ launchTemplateId: jsii.String("launchTemplateId"), launchTemplateName: jsii.String("launchTemplateName"), version: jsii.String("version"), }
type CfnGameServerGroup_TargetTrackingConfigurationProperty ¶
type CfnGameServerGroup_TargetTrackingConfigurationProperty struct { // Desired value to use with a game server group target-based scaling policy. TargetValue *float64 `field:"required" json:"targetValue" yaml:"targetValue"` }
*This data type is used with the Amazon GameLift FleetIQ and game server groups.*.
Settings for a target-based scaling policy as part of a `GameServerGroupAutoScalingPolicy` . These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric `"PercentUtilizedGameServers"` and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.
Example:
// 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" targetTrackingConfigurationProperty := &targetTrackingConfigurationProperty{ targetValue: jsii.Number(123), }
type CfnGameSessionQueue ¶
type CfnGameSessionQueue interface { awscdk.CfnResource awscdk.IInspectable // The unique Amazon Resource Name (ARN) for the `GameSessionQueue` . AttrArn() *string // A descriptive label that is associated with a game session queue. // // Names are unique within each Region. AttrName() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Information to be added to all events that are related to this game session queue. CustomEventData() *string SetCustomEventData(val *string) // 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. Destinations() interface{} SetDestinations(val interface{}) // 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. FilterConfiguration() interface{} SetFilterConfiguration(val interface{}) // 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)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // A descriptive label that is associated with game session queue. // // Queue names must be unique within each Region. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // An SNS topic ARN that is set up to receive game session placement notifications. // // See [Setting up notifications for game session placement](https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html) . NotificationTarget() *string SetNotificationTarget(val *string) // A set of policies that act as a sliding cap on player latency. // // FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. PlayerLatencyPolicies() interface{} SetPlayerLatencyPolicies(val interface{}) // 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. PriorityConfiguration() interface{} SetPriorityConfiguration(val interface{}) // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // A list of labels to assign to the new game session queue resource. // // 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](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) 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. Tags() awscdk.TagManager // 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. TimeoutInSeconds() *float64 SetTimeoutInSeconds(val *float64) // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::GameLift::GameSessionQueue`.
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:
// 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), })
func NewCfnGameSessionQueue ¶
func NewCfnGameSessionQueue(scope constructs.Construct, id *string, props *CfnGameSessionQueueProps) CfnGameSessionQueue
Create a new `AWS::GameLift::GameSessionQueue`.
type CfnGameSessionQueueProps ¶
type CfnGameSessionQueueProps struct { // A descriptive label that is associated with game session queue. // // Queue names must be unique within each Region. Name *string `field:"required" json:"name" yaml:"name"` // Information to be added to all events that are related to this game session queue. CustomEventData *string `field:"optional" json:"customEventData" yaml:"customEventData"` // 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. Destinations interface{} `field:"optional" json:"destinations" yaml:"destinations"` // 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. FilterConfiguration interface{} `field:"optional" json:"filterConfiguration" yaml:"filterConfiguration"` // An SNS topic ARN that is set up to receive game session placement notifications. // // See [Setting up notifications for game session placement](https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html) . NotificationTarget *string `field:"optional" json:"notificationTarget" yaml:"notificationTarget"` // A set of policies that act as a sliding cap on player latency. // // FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. PlayerLatencyPolicies interface{} `field:"optional" json:"playerLatencyPolicies" yaml:"playerLatencyPolicies"` // 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. PriorityConfiguration interface{} `field:"optional" json:"priorityConfiguration" yaml:"priorityConfiguration"` // A list of labels to assign to the new game session queue resource. // // 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](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) 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. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // 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. TimeoutInSeconds *float64 `field:"optional" json:"timeoutInSeconds" yaml:"timeoutInSeconds"` }
Properties for defining a `CfnGameSessionQueue`.
Example:
// 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" cfnGameSessionQueueProps := &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), }
type CfnGameSessionQueue_DestinationProperty ¶
type CfnGameSessionQueue_DestinationProperty struct { // The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. // // ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions. DestinationArn *string `field:"optional" json:"destinationArn" yaml:"destinationArn"` }
A fleet or alias designated in a game session queue.
Queues fulfill requests for new game sessions by placing a new game session on any of the queue's destinations.
Example:
// 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" destinationProperty := &destinationProperty{ destinationArn: jsii.String("destinationArn"), }
type CfnGameSessionQueue_FilterConfigurationProperty ¶
type CfnGameSessionQueue_FilterConfigurationProperty struct { // A list of locations to allow game session placement in, in the form of AWS Region codes such as `us-west-2` . AllowedLocations *[]*string `field:"optional" json:"allowedLocations" yaml:"allowedLocations"` }
A list of fleet locations where a game session queue can place new game sessions.
You can use a filter to temporarily turn off placements for specific locations. For queues that have multi-location fleets, you can use a filter configuration allow placement with some, but not all of these locations.
Example:
// 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" filterConfigurationProperty := &filterConfigurationProperty{ allowedLocations: []*string{ jsii.String("allowedLocations"), }, }
type CfnGameSessionQueue_PlayerLatencyPolicyProperty ¶
type CfnGameSessionQueue_PlayerLatencyPolicyProperty struct { // The maximum latency value that is allowed for any player, in milliseconds. // // All policies must have a value set for this property. MaximumIndividualPlayerLatencyMilliseconds *float64 `field:"optional" json:"maximumIndividualPlayerLatencyMilliseconds" yaml:"maximumIndividualPlayerLatencyMilliseconds"` // The length of time, in seconds, that the policy is enforced while placing a new game session. // // A null value for this property means that the policy is enforced until the queue times out. PolicyDurationSeconds *float64 `field:"optional" json:"policyDurationSeconds" yaml:"policyDurationSeconds"` }
The queue setting that determines the highest latency allowed for individual players when placing a game session.
When a latency policy is in force, a game session cannot be placed with any fleet in a Region where a player reports latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information.
Example:
// 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" playerLatencyPolicyProperty := &playerLatencyPolicyProperty{ maximumIndividualPlayerLatencyMilliseconds: jsii.Number(123), policyDurationSeconds: jsii.Number(123), }
type CfnGameSessionQueue_PriorityConfigurationProperty ¶
type CfnGameSessionQueue_PriorityConfigurationProperty struct { // The prioritization order to use for fleet locations, when the `PriorityOrder` property includes `LOCATION` . // // Locations are identified by AWS Region codes such as `us-west-2` . Each location can only be listed once. LocationOrder *[]*string `field:"optional" json:"locationOrder" yaml:"locationOrder"` // The recommended sequence to use when prioritizing where to place new game sessions. // // Each type can only be listed once. // // - `LATENCY` -- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest. // - `COST` -- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue. // - `DESTINATION` -- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration. // - `LOCATION` -- FleetIQ prioritizes based on the provided order of locations, as defined in `LocationOrder` . PriorityOrder *[]*string `field:"optional" json:"priorityOrder" yaml:"priorityOrder"` }
Custom prioritization settings for use by a game session queue when placing new game sessions with available game servers.
When defined, this configuration replaces the default FleetIQ prioritization process, which is as follows:
- If player latency data is included in a game session request, destinations and locations are prioritized first based on lowest average latency (1), then on lowest hosting cost (2), then on destination list order (3), and finally on location (alphabetical) (4). This approach ensures that the queue's top priority is to place game sessions where average player latency is lowest, and--if latency is the same--where the hosting cost is less, etc. - If player latency data is not included, destinations and locations are prioritized first on destination list order (1), and then on location (alphabetical) (2). This approach ensures that the queue's top priority is to place game sessions on the first destination fleet listed. If that fleet has multiple locations, the game session is placed on the first location (when listed alphabetically).
Changing the priority order will affect how game sessions are placed.
Example:
// 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" priorityConfigurationProperty := &priorityConfigurationProperty{ locationOrder: []*string{ jsii.String("locationOrder"), }, priorityOrder: []*string{ jsii.String("priorityOrder"), }, }
type CfnMatchmakingConfiguration ¶
type CfnMatchmakingConfiguration interface { awscdk.CfnResource awscdk.IInspectable // A flag that determines whether a match that was created with this configuration must be accepted by the matched players. // // To require acceptance, set to `TRUE` . With this option enabled, matchmaking tickets use the status `REQUIRES_ACCEPTANCE` to indicate when a completed potential match is waiting for player acceptance. AcceptanceRequired() interface{} SetAcceptanceRequired(val interface{}) // The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. AcceptanceTimeoutSeconds() *float64 SetAcceptanceTimeoutSeconds(val *float64) // The number of player slots in a match to keep open for future players. // // For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if `FlexMatchMode` is set to `STANDALONE` . AdditionalPlayerCount() *float64 SetAdditionalPlayerCount(val *float64) // The unique Amazon Resource Name (ARN) for the `MatchmakingConfiguration` . AttrArn() *string // The `MatchmakingConfiguration` name, which is unique. AttrName() *string // The method used to backfill game sessions that are created with this matchmaking configuration. // // Specify `MANUAL` when your game manages backfill requests manually or does not use the match backfill feature. Specify `AUTOMATIC` to have GameLift create a `StartMatchBackfill` request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in [Backfill Existing Games with FlexMatch](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html) . Automatic backfill is not available when `FlexMatchMode` is set to `STANDALONE` . BackfillMode() *string SetBackfillMode(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Information to add to all events related to the matchmaking configuration. CustomEventData() *string SetCustomEventData(val *string) // A descriptive label that is associated with matchmaking configuration. Description() *string SetDescription(val *string) // Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution. // // - *STANDALONE* - FlexMatch forms matches and returns match information, including players and team assignments, in a [MatchmakingSucceeded](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded) event. // - *WITH_QUEUE* - FlexMatch forms matches and uses the specified GameLift queue to start a game session for the match. FlexMatchMode() *string SetFlexMatchMode(val *string) // A set of custom properties for a game session, formatted as key-value pairs. // // These properties are passed to a game server process with a request to start a new game session. See [Start a Game Session](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) . This parameter is not used if `FlexMatchMode` is set to `STANDALONE` . GameProperties() interface{} SetGameProperties(val interface{}) // A set of custom game session properties, formatted as a single string value. // // This data is passed to a game server process with a request to start a new game session. See [Start a Game Session](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) . This parameter is not used if `FlexMatchMode` is set to `STANDALONE` . GameSessionData() *string SetGameSessionData(val *string) // The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:<region>::gamesessionqueue/<queue name>` . Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If `FlexMatchMode` is set to `STANDALONE` , do not set this parameter. GameSessionQueueArns() *[]*string SetGameSessionQueueArns(val *[]*string) // 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)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // A unique identifier for the matchmaking configuration. // // This name is used to identify the configuration associated with a matchmaking request or ticket. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // An SNS topic ARN that is set up to receive matchmaking notifications. // // See [Setting up notifications for matchmaking](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html) for more information. NotificationTarget() *string SetNotificationTarget(val *string) // 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 })`. Ref() *string // The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. // // Requests that fail due to timing out can be resubmitted as needed. RequestTimeoutSeconds() *float64 SetRequestTimeoutSeconds(val *float64) // A unique identifier for the matchmaking rule set to use with this configuration. // // You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region. RuleSetName() *string SetRuleSetName(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // A list of labels to assign to the new matchmaking configuration resource. // // 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](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) 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. Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::GameLift::MatchmakingConfiguration`.
The `AWS::GameLift::MatchmakingConfiguration` resource defines a new matchmaking configuration for use with FlexMatch. Whether you're using FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're using GameLift hosting, it also defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes that are consistent with that configuration.
Example:
// 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" cfnMatchmakingConfiguration := awscdk.Aws_gamelift.NewCfnMatchmakingConfiguration(this, jsii.String("MyCfnMatchmakingConfiguration"), &cfnMatchmakingConfigurationProps{ acceptanceRequired: jsii.Boolean(false), name: jsii.String("name"), requestTimeoutSeconds: jsii.Number(123), ruleSetName: jsii.String("ruleSetName"), // the properties below are optional acceptanceTimeoutSeconds: jsii.Number(123), additionalPlayerCount: jsii.Number(123), backfillMode: jsii.String("backfillMode"), customEventData: jsii.String("customEventData"), description: jsii.String("description"), flexMatchMode: jsii.String("flexMatchMode"), gameProperties: []interface{}{ &gamePropertyProperty{ key: jsii.String("key"), value: jsii.String("value"), }, }, gameSessionData: jsii.String("gameSessionData"), gameSessionQueueArns: []*string{ jsii.String("gameSessionQueueArns"), }, notificationTarget: jsii.String("notificationTarget"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, })
func NewCfnMatchmakingConfiguration ¶
func NewCfnMatchmakingConfiguration(scope constructs.Construct, id *string, props *CfnMatchmakingConfigurationProps) CfnMatchmakingConfiguration
Create a new `AWS::GameLift::MatchmakingConfiguration`.
type CfnMatchmakingConfigurationProps ¶
type CfnMatchmakingConfigurationProps struct { // A flag that determines whether a match that was created with this configuration must be accepted by the matched players. // // To require acceptance, set to `TRUE` . With this option enabled, matchmaking tickets use the status `REQUIRES_ACCEPTANCE` to indicate when a completed potential match is waiting for player acceptance. AcceptanceRequired interface{} `field:"required" json:"acceptanceRequired" yaml:"acceptanceRequired"` // A unique identifier for the matchmaking configuration. // // This name is used to identify the configuration associated with a matchmaking request or ticket. Name *string `field:"required" json:"name" yaml:"name"` // The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. // // Requests that fail due to timing out can be resubmitted as needed. RequestTimeoutSeconds *float64 `field:"required" json:"requestTimeoutSeconds" yaml:"requestTimeoutSeconds"` // A unique identifier for the matchmaking rule set to use with this configuration. // // You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region. RuleSetName *string `field:"required" json:"ruleSetName" yaml:"ruleSetName"` // The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. AcceptanceTimeoutSeconds *float64 `field:"optional" json:"acceptanceTimeoutSeconds" yaml:"acceptanceTimeoutSeconds"` // The number of player slots in a match to keep open for future players. // // For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if `FlexMatchMode` is set to `STANDALONE` . AdditionalPlayerCount *float64 `field:"optional" json:"additionalPlayerCount" yaml:"additionalPlayerCount"` // The method used to backfill game sessions that are created with this matchmaking configuration. // // Specify `MANUAL` when your game manages backfill requests manually or does not use the match backfill feature. Specify `AUTOMATIC` to have GameLift create a `StartMatchBackfill` request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in [Backfill Existing Games with FlexMatch](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html) . Automatic backfill is not available when `FlexMatchMode` is set to `STANDALONE` . BackfillMode *string `field:"optional" json:"backfillMode" yaml:"backfillMode"` // Information to add to all events related to the matchmaking configuration. CustomEventData *string `field:"optional" json:"customEventData" yaml:"customEventData"` // A descriptive label that is associated with matchmaking configuration. Description *string `field:"optional" json:"description" yaml:"description"` // Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution. // // - *STANDALONE* - FlexMatch forms matches and returns match information, including players and team assignments, in a [MatchmakingSucceeded](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded) event. // - *WITH_QUEUE* - FlexMatch forms matches and uses the specified GameLift queue to start a game session for the match. FlexMatchMode *string `field:"optional" json:"flexMatchMode" yaml:"flexMatchMode"` // A set of custom properties for a game session, formatted as key-value pairs. // // These properties are passed to a game server process with a request to start a new game session. See [Start a Game Session](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) . This parameter is not used if `FlexMatchMode` is set to `STANDALONE` . GameProperties interface{} `field:"optional" json:"gameProperties" yaml:"gameProperties"` // A set of custom game session properties, formatted as a single string value. // // This data is passed to a game server process with a request to start a new game session. See [Start a Game Session](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) . This parameter is not used if `FlexMatchMode` is set to `STANDALONE` . GameSessionData *string `field:"optional" json:"gameSessionData" yaml:"gameSessionData"` // The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:<region>::gamesessionqueue/<queue name>` . Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If `FlexMatchMode` is set to `STANDALONE` , do not set this parameter. GameSessionQueueArns *[]*string `field:"optional" json:"gameSessionQueueArns" yaml:"gameSessionQueueArns"` // An SNS topic ARN that is set up to receive matchmaking notifications. // // See [Setting up notifications for matchmaking](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html) for more information. NotificationTarget *string `field:"optional" json:"notificationTarget" yaml:"notificationTarget"` // A list of labels to assign to the new matchmaking configuration resource. // // 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](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) 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. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnMatchmakingConfiguration`.
Example:
// 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" cfnMatchmakingConfigurationProps := &cfnMatchmakingConfigurationProps{ acceptanceRequired: jsii.Boolean(false), name: jsii.String("name"), requestTimeoutSeconds: jsii.Number(123), ruleSetName: jsii.String("ruleSetName"), // the properties below are optional acceptanceTimeoutSeconds: jsii.Number(123), additionalPlayerCount: jsii.Number(123), backfillMode: jsii.String("backfillMode"), customEventData: jsii.String("customEventData"), description: jsii.String("description"), flexMatchMode: jsii.String("flexMatchMode"), gameProperties: []interface{}{ &gamePropertyProperty{ key: jsii.String("key"), value: jsii.String("value"), }, }, gameSessionData: jsii.String("gameSessionData"), gameSessionQueueArns: []*string{ jsii.String("gameSessionQueueArns"), }, notificationTarget: jsii.String("notificationTarget"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnMatchmakingConfiguration_GamePropertyProperty ¶
type CfnMatchmakingConfiguration_GamePropertyProperty struct { // The game property identifier. Key *string `field:"required" json:"key" yaml:"key"` // The game property value. Value *string `field:"required" json:"value" yaml:"value"` }
Set of key-value pairs that contain information about a game session.
When included in a game session request, these properties communicate details to be used when setting up the new game session. For example, a game property might specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session. For more information, see the [GameLift Developer Guide](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-create) .
Example:
// 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" gamePropertyProperty := &gamePropertyProperty{ key: jsii.String("key"), value: jsii.String("value"), }
type CfnMatchmakingRuleSet ¶
type CfnMatchmakingRuleSet interface { awscdk.CfnResource awscdk.IInspectable // The unique Amazon Resource Name (ARN) assigned to the rule set. AttrArn() *string // The unique name of the rule set. AttrName() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // 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)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // A unique identifier for the matchmaking rule set. // // A matchmaking configuration identifies the rule set it uses by this name value. Note that the rule set name is different from the optional `name` field in the rule set body. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // 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 })`. Ref() *string // A collection of matchmaking rules, formatted as a JSON string. // // Comments are not allowed in JSON, but most elements support a description field. RuleSetBody() *string SetRuleSetBody(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // A list of labels to assign to the new matchmaking rule set resource. // // 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](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) 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. Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::GameLift::MatchmakingRuleSet`.
Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams. It also sets the parameters for acceptable player matches, such as minimum skill level or character type.
To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration they are used with.
Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax.
*Learn more*
- [Build a rule set](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html) - [Design a matchmaker](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html) - [Matchmaking with FlexMatch](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-intro.html)
Example:
// 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" cfnMatchmakingRuleSet := awscdk.Aws_gamelift.NewCfnMatchmakingRuleSet(this, jsii.String("MyCfnMatchmakingRuleSet"), &cfnMatchmakingRuleSetProps{ name: jsii.String("name"), ruleSetBody: jsii.String("ruleSetBody"), // the properties below are optional tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, })
func NewCfnMatchmakingRuleSet ¶
func NewCfnMatchmakingRuleSet(scope constructs.Construct, id *string, props *CfnMatchmakingRuleSetProps) CfnMatchmakingRuleSet
Create a new `AWS::GameLift::MatchmakingRuleSet`.
type CfnMatchmakingRuleSetProps ¶
type CfnMatchmakingRuleSetProps struct { // A unique identifier for the matchmaking rule set. // // A matchmaking configuration identifies the rule set it uses by this name value. Note that the rule set name is different from the optional `name` field in the rule set body. Name *string `field:"required" json:"name" yaml:"name"` // A collection of matchmaking rules, formatted as a JSON string. // // Comments are not allowed in JSON, but most elements support a description field. RuleSetBody *string `field:"required" json:"ruleSetBody" yaml:"ruleSetBody"` // A list of labels to assign to the new matchmaking rule set resource. // // 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](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) 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. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnMatchmakingRuleSet`.
Example:
// 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" cfnMatchmakingRuleSetProps := &cfnMatchmakingRuleSetProps{ name: jsii.String("name"), ruleSetBody: jsii.String("ruleSetBody"), // the properties below are optional tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnScript ¶
type CfnScript interface { awscdk.CfnResource awscdk.IInspectable // The unique Amazon Resource Name (ARN) for the script. AttrArn() *string // A unique identifier for a Realtime script. AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // 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)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // A descriptive label that is associated with a script. // // Script names do not need to be unique. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. // // The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the `ObjectVersion` parameter to specify an earlier version. StorageLocation() interface{} SetStorageLocation(val interface{}) // A list of labels to assign to the new script resource. // // 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](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) 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. Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // The version that is associated with a build or script. // // Version strings do not need to be unique. Version() *string SetVersion(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::GameLift::Script`.
The `AWS::GameLift::Script` resource creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.
Example:
// 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" cfnScript := awscdk.Aws_gamelift.NewCfnScript(this, jsii.String("MyCfnScript"), &cfnScriptProps{ storageLocation: &s3LocationProperty{ bucket: jsii.String("bucket"), key: jsii.String("key"), roleArn: jsii.String("roleArn"), // the properties below are optional objectVersion: jsii.String("objectVersion"), }, // the properties below are optional name: jsii.String("name"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, version: jsii.String("version"), })
func NewCfnScript ¶
func NewCfnScript(scope constructs.Construct, id *string, props *CfnScriptProps) CfnScript
Create a new `AWS::GameLift::Script`.
type CfnScriptProps ¶
type CfnScriptProps struct { // The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. // // The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the `ObjectVersion` parameter to specify an earlier version. StorageLocation interface{} `field:"required" json:"storageLocation" yaml:"storageLocation"` // A descriptive label that is associated with a script. // // Script names do not need to be unique. Name *string `field:"optional" json:"name" yaml:"name"` // A list of labels to assign to the new script resource. // // 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](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) 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. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // The version that is associated with a build or script. // // Version strings do not need to be unique. Version *string `field:"optional" json:"version" yaml:"version"` }
Properties for defining a `CfnScript`.
Example:
// 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" cfnScriptProps := &cfnScriptProps{ storageLocation: &s3LocationProperty{ bucket: jsii.String("bucket"), key: jsii.String("key"), roleArn: jsii.String("roleArn"), // the properties below are optional objectVersion: jsii.String("objectVersion"), }, // the properties below are optional name: jsii.String("name"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, version: jsii.String("version"), }
type CfnScript_S3LocationProperty ¶
type CfnScript_S3LocationProperty struct { // An Amazon S3 bucket identifier. This is the name of the S3 bucket. // // > GameLift currently does not support uploading from Amazon S3 buckets with names that contain a dot (.). Bucket *string `field:"required" json:"bucket" yaml:"bucket"` // The name of the zip file that contains the build files or script files. Key *string `field:"required" json:"key" yaml:"key"` // The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) for an IAM role that allows Amazon GameLift to access the S3 bucket. RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // The version of the file, if object versioning is turned on for the bucket. // // Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved. ObjectVersion *string `field:"optional" json:"objectVersion" yaml:"objectVersion"` }
The location in Amazon S3 where build or script files can be stored for access by Amazon GameLift.
Example:
// 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" s3LocationProperty := &s3LocationProperty{ bucket: jsii.String("bucket"), key: jsii.String("key"), roleArn: jsii.String("roleArn"), // the properties below are optional objectVersion: jsii.String("objectVersion"), }