Documentation ¶
Index ¶
- func CfnAlias_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAlias_IsCfnElement(x interface{}) *bool
- func CfnAlias_IsCfnResource(x interface{}) *bool
- func CfnAlias_IsConstruct(x interface{}) *bool
- func CfnBuild_CFN_RESOURCE_TYPE_NAME() *string
- func CfnBuild_IsCfnElement(x interface{}) *bool
- func CfnBuild_IsCfnResource(x interface{}) *bool
- func CfnBuild_IsConstruct(x interface{}) *bool
- func CfnContainerGroupDefinition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnContainerGroupDefinition_IsCfnElement(x interface{}) *bool
- func CfnContainerGroupDefinition_IsCfnResource(x interface{}) *bool
- func CfnContainerGroupDefinition_IsConstruct(x interface{}) *bool
- func CfnFleet_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFleet_IsCfnElement(x interface{}) *bool
- func CfnFleet_IsCfnResource(x interface{}) *bool
- func CfnFleet_IsConstruct(x interface{}) *bool
- func CfnGameServerGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGameServerGroup_IsCfnElement(x interface{}) *bool
- func CfnGameServerGroup_IsCfnResource(x interface{}) *bool
- func CfnGameServerGroup_IsConstruct(x interface{}) *bool
- func CfnGameSessionQueue_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGameSessionQueue_IsCfnElement(x interface{}) *bool
- func CfnGameSessionQueue_IsCfnResource(x interface{}) *bool
- func CfnGameSessionQueue_IsConstruct(x interface{}) *bool
- func CfnLocation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLocation_IsCfnElement(x interface{}) *bool
- func CfnLocation_IsCfnResource(x interface{}) *bool
- func CfnLocation_IsConstruct(x interface{}) *bool
- func CfnMatchmakingConfiguration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMatchmakingConfiguration_IsCfnElement(x interface{}) *bool
- func CfnMatchmakingConfiguration_IsCfnResource(x interface{}) *bool
- func CfnMatchmakingConfiguration_IsConstruct(x interface{}) *bool
- func CfnMatchmakingRuleSet_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMatchmakingRuleSet_IsCfnElement(x interface{}) *bool
- func CfnMatchmakingRuleSet_IsCfnResource(x interface{}) *bool
- func CfnMatchmakingRuleSet_IsConstruct(x interface{}) *bool
- func CfnScript_CFN_RESOURCE_TYPE_NAME() *string
- func CfnScript_IsCfnElement(x interface{}) *bool
- func CfnScript_IsCfnResource(x interface{}) *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 NewCfnContainerGroupDefinition_Override(c CfnContainerGroupDefinition, scope constructs.Construct, id *string, ...)
- 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 NewCfnLocation_Override(c CfnLocation, scope constructs.Construct, id *string, props *CfnLocationProps)
- 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_StorageLocationProperty
- type CfnContainerGroupDefinition
- type CfnContainerGroupDefinitionProps
- type CfnContainerGroupDefinition_ContainerDefinitionProperty
- type CfnContainerGroupDefinition_ContainerDependencyProperty
- type CfnContainerGroupDefinition_ContainerEnvironmentProperty
- type CfnContainerGroupDefinition_ContainerHealthCheckProperty
- type CfnContainerGroupDefinition_ContainerPortRangeProperty
- type CfnContainerGroupDefinition_MemoryLimitsProperty
- type CfnContainerGroupDefinition_PortConfigurationProperty
- type CfnFleet
- type CfnFleetProps
- type CfnFleet_AnywhereConfigurationProperty
- type CfnFleet_CertificateConfigurationProperty
- type CfnFleet_ConnectionPortRangeProperty
- type CfnFleet_ContainerGroupsConfigurationProperty
- type CfnFleet_ContainerGroupsPerInstanceProperty
- type CfnFleet_IpPermissionProperty
- type CfnFleet_LocationCapacityProperty
- type CfnFleet_LocationConfigurationProperty
- type CfnFleet_ResourceCreationLimitPolicyProperty
- type CfnFleet_RuntimeConfigurationProperty
- type CfnFleet_ScalingPolicyProperty
- type CfnFleet_ServerProcessProperty
- type CfnFleet_TargetConfigurationProperty
- 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_GameSessionQueueDestinationProperty
- type CfnGameSessionQueue_PlayerLatencyPolicyProperty
- type CfnGameSessionQueue_PriorityConfigurationProperty
- type CfnLocation
- type CfnLocationProps
- 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(x interface{}) *bool
Check whether the given object 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(x interface{}) *bool
Check whether the given object 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 CfnContainerGroupDefinition_CFN_RESOURCE_TYPE_NAME ¶ added in v2.140.0
func CfnContainerGroupDefinition_CFN_RESOURCE_TYPE_NAME() *string
func CfnContainerGroupDefinition_IsCfnElement ¶ added in v2.140.0
func CfnContainerGroupDefinition_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 CfnContainerGroupDefinition_IsCfnResource ¶ added in v2.140.0
func CfnContainerGroupDefinition_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnContainerGroupDefinition_IsConstruct ¶ added in v2.140.0
func CfnContainerGroupDefinition_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(x interface{}) *bool
Check whether the given object 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(x interface{}) *bool
Check whether the given object 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(x interface{}) *bool
Check whether the given object 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 CfnLocation_CFN_RESOURCE_TYPE_NAME ¶ added in v2.55.0
func CfnLocation_CFN_RESOURCE_TYPE_NAME() *string
func CfnLocation_IsCfnElement ¶ added in v2.55.0
func CfnLocation_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 CfnLocation_IsCfnResource ¶ added in v2.55.0
func CfnLocation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnLocation_IsConstruct ¶ added in v2.55.0
func CfnLocation_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(x interface{}) *bool
Check whether the given object 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(x interface{}) *bool
Check whether the given object 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(x interface{}) *bool
Check whether the given object 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)
func NewCfnBuild_Override ¶
func NewCfnBuild_Override(c CfnBuild, scope constructs.Construct, id *string, props *CfnBuildProps)
func NewCfnContainerGroupDefinition_Override ¶ added in v2.140.0
func NewCfnContainerGroupDefinition_Override(c CfnContainerGroupDefinition, scope constructs.Construct, id *string, props *CfnContainerGroupDefinitionProps)
func NewCfnFleet_Override ¶
func NewCfnFleet_Override(c CfnFleet, scope constructs.Construct, id *string, props *CfnFleetProps)
func NewCfnGameServerGroup_Override ¶
func NewCfnGameServerGroup_Override(c CfnGameServerGroup, scope constructs.Construct, id *string, props *CfnGameServerGroupProps)
func NewCfnGameSessionQueue_Override ¶
func NewCfnGameSessionQueue_Override(c CfnGameSessionQueue, scope constructs.Construct, id *string, props *CfnGameSessionQueueProps)
func NewCfnLocation_Override ¶ added in v2.55.0
func NewCfnLocation_Override(c CfnLocation, scope constructs.Construct, id *string, props *CfnLocationProps)
func NewCfnMatchmakingConfiguration_Override ¶
func NewCfnMatchmakingConfiguration_Override(c CfnMatchmakingConfiguration, scope constructs.Construct, id *string, props *CfnMatchmakingConfigurationProps)
func NewCfnMatchmakingRuleSet_Override ¶
func NewCfnMatchmakingRuleSet_Override(c CfnMatchmakingRuleSet, scope constructs.Construct, id *string, props *CfnMatchmakingRuleSetProps)
func NewCfnScript_Override ¶
func NewCfnScript_Override(c CfnScript, scope constructs.Construct, id *string, props *CfnScriptProps)
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. 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 // Deprecated. // Deprecated: use `updatedProperties` // // 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{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. 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, typeHint awscdk.ResolutionTypeHint) 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) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // 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{}) }
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"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html
func NewCfnAlias ¶
func NewCfnAlias(scope constructs.Construct, id *string, props *CfnAliasProps) CfnAlias
type CfnAliasProps ¶
type CfnAliasProps struct { // A descriptive label that is associated with an alias. // // Alias names do not need to be unique. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-name // Name *string `field:"required" json:"name" yaml:"name"` // The routing configuration, including routing type and fleet target, for the alias. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-routingstrategy // RoutingStrategy interface{} `field:"required" json:"routingStrategy" yaml:"routingStrategy"` // A human-readable description of the alias. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-description // 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"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-type // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-fleetid // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-message // 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 // A unique identifier for the build. AttrBuildId() *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 build. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // The operating system that your game server binaries run on. 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 // A server SDK version you used when integrating your game server build with Amazon GameLift. ServerSdkVersion() *string SetServerSdkVersion(val *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. StorageLocation() interface{} SetStorageLocation(val interface{}) // Deprecated. // Deprecated: use `updatedProperties` // // 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{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Version information that is associated with this build. 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. 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, typeHint awscdk.ResolutionTypeHint) 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) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // 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{}) }
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"), ServerSdkVersion: jsii.String("serverSdkVersion"), StorageLocation: &StorageLocationProperty{ 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"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html
func NewCfnBuild ¶
func NewCfnBuild(scope constructs.Construct, id *string, props *CfnBuildProps) CfnBuild
type CfnBuildProps ¶
type CfnBuildProps struct { // A descriptive label that is associated with a build. // // Build names do not need to be unique. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-name // Name *string `field:"optional" json:"name" yaml:"name"` // The operating system that your game server binaries run on. // // This value determines the type of fleet resources that you use for this build. If your game build contains multiple executables, they all must run on the same operating system. You must specify a valid operating system in this request. There is no default value. You can't change a build's operating system later. // // > Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the [Amazon Linux 2 FAQs](https://docs.aws.amazon.com/https://aws.amazon.com/amazon-linux-2/faqs/) . For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See [Migrate to Amazon GameLift server SDK version 5.](https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html) // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-operatingsystem // OperatingSystem *string `field:"optional" json:"operatingSystem" yaml:"operatingSystem"` // A server SDK version you used when integrating your game server build with Amazon GameLift. // // For more information see [Integrate games with custom game servers](https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html) . By default Amazon GameLift sets this value to `4.0.2` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-serversdkversion // ServerSdkVersion *string `field:"optional" json:"serverSdkVersion" yaml:"serverSdkVersion"` // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-storagelocation // StorageLocation interface{} `field:"optional" json:"storageLocation" yaml:"storageLocation"` // Version information that is associated with this build. // // Version strings do not need to be unique. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-version // 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"), ServerSdkVersion: jsii.String("serverSdkVersion"), StorageLocation: &StorageLocationProperty{ 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"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html
type CfnBuild_StorageLocationProperty ¶ added in v2.57.0
type CfnBuild_StorageLocationProperty struct { // An Amazon S3 bucket identifier. The name of the S3 bucket. // // > Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storagelocation-bucket // Bucket *string `field:"required" json:"bucket" yaml:"bucket"` // The name of the zip file that contains the build files or script files. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storagelocation-key // Key *string `field:"required" json:"key" yaml:"key"` // The ARNfor an IAM role that allows Amazon GameLift to access the S3 bucket. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storagelocation-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // A version of a stored file to retrieve, if the object versioning feature is turned on for the S3 bucket. // // Use this parameter to specify a specific version. If this parameter isn't set, Amazon GameLift retrieves the latest version of the file. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storagelocation-objectversion // 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" storageLocationProperty := &StorageLocationProperty{ Bucket: jsii.String("bucket"), Key: jsii.String("key"), RoleArn: jsii.String("roleArn"), // the properties below are optional ObjectVersion: jsii.String("objectVersion"), }
type CfnContainerGroupDefinition ¶ added in v2.140.0
type CfnContainerGroupDefinition interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) that is assigned to an Amazon GameLift `ContainerGroupDefinition` resource. It uniquely identifies the resource across all AWS Regions. Format is `arn:aws:gamelift:<region>::containergroupdefinition/[container group definition name]` . AttrContainerGroupDefinitionArn() *string // A time stamp indicating when this data object was created. // // Format is a number expressed in Unix time as milliseconds (for example `"1469498468.057"` ). AttrCreationTime() *string // Current status of the container group definition resource. Values include:. // // - `COPYING` -- Amazon GameLift is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet. // - `READY` -- Amazon GameLift has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet. // - `FAILED` -- Amazon GameLift failed to create a valid container group definition resource. For more details on the cause of the failure, see `StatusReason` . A container group definition resource in failed status will be deleted within a few minutes. AttrStatus() *string // Additional information about a container group definition that's in `FAILED` status. Possible reasons include:. // // - An internal issue prevented Amazon GameLift from creating the container group definition resource. Delete the failed resource and call `CreateContainerGroupDefinition` again. // - An access-denied message means that you don't have permissions to access the container image on ECR. See [IAM permission examples](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html) for help setting up required IAM permissions for Amazon GameLift. // - The `ImageUri` value for at least one of the containers in the container group definition was invalid or not found in the current AWS account. // - At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see [Amazon GameLift endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/gamelift.html) . // - At least one of the container images referenced in the container group definition uses a different operating system than the one defined for the container group. AttrStatusReason() *string // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The set of container definitions that are included in the container group. ContainerDefinitions() interface{} SetContainerDefinitions(val interface{}) // 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 identifier for the container group definition. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // The platform required for all containers in the container group definition. 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 method for deploying the container group across fleet instances. SchedulingStrategy() *string SetSchedulingStrategy(val *string) // A specific ContainerGroupDefinition version to be updated. SourceVersionNumber() *float64 SetSourceVersionNumber(val *float64) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // A collection of support container definitions that define the containers in this group. SupportContainerDefinitions() interface{} SetSupportContainerDefinitions(val interface{}) // An array of key-value pairs to apply to this resource. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // The amount of CPU units on a fleet instance to allocate for the container group. TotalCpuLimit() *float64 SetTotalCpuLimit(val *float64) // The amount of memory (in MiB) on a fleet instance to allocate for the container group. TotalMemoryLimit() *float64 SetTotalMemoryLimit(val *float64) // Deprecated. // Deprecated: use `updatedProperties` // // 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{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. 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, typeHint awscdk.ResolutionTypeHint) 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) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // 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{}) }
*This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*.
The properties that describe a container group resource. Container group definition properties can't be updated. To change a property, create a new container group definition.
*Used with:* `CreateContainerGroupDefinition`
*Returned by:* `DescribeContainerGroupDefinition` , `ListContainerGroupDefinitions`.
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" var supportContainerDefinitions interface{} cfnContainerGroupDefinition := awscdk.Aws_gamelift.NewCfnContainerGroupDefinition(this, jsii.String("MyCfnContainerGroupDefinition"), &CfnContainerGroupDefinitionProps{ ContainerDefinitions: []interface{}{ &ContainerDefinitionProperty{ ContainerName: jsii.String("containerName"), ImageUri: jsii.String("imageUri"), // the properties below are optional Command: []*string{ jsii.String("command"), }, Cpu: jsii.Number(123), DependsOn: []interface{}{ &ContainerDependencyProperty{ Condition: jsii.String("condition"), ContainerName: jsii.String("containerName"), }, }, EntryPoint: []*string{ jsii.String("entryPoint"), }, Environment: []interface{}{ &ContainerEnvironmentProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, Essential: jsii.Boolean(false), HealthCheck: &ContainerHealthCheckProperty{ Command: []*string{ jsii.String("command"), }, // the properties below are optional Interval: jsii.Number(123), Retries: jsii.Number(123), StartPeriod: jsii.Number(123), Timeout: jsii.Number(123), }, MemoryLimits: &MemoryLimitsProperty{ HardLimit: jsii.Number(123), SoftLimit: jsii.Number(123), }, PortConfiguration: &PortConfigurationProperty{ ContainerPortRanges: []interface{}{ &ContainerPortRangeProperty{ FromPort: jsii.Number(123), Protocol: jsii.String("protocol"), ToPort: jsii.Number(123), }, }, }, ResolvedImageDigest: jsii.String("resolvedImageDigest"), WorkingDirectory: jsii.String("workingDirectory"), }, }, Name: jsii.String("name"), OperatingSystem: jsii.String("operatingSystem"), TotalCpuLimit: jsii.Number(123), TotalMemoryLimit: jsii.Number(123), // the properties below are optional SchedulingStrategy: jsii.String("schedulingStrategy"), SourceVersionNumber: jsii.Number(123), SupportContainerDefinitions: []interface{}{ supportContainerDefinitions, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnContainerGroupDefinition ¶ added in v2.140.0
func NewCfnContainerGroupDefinition(scope constructs.Construct, id *string, props *CfnContainerGroupDefinitionProps) CfnContainerGroupDefinition
type CfnContainerGroupDefinitionProps ¶ added in v2.140.0
type CfnContainerGroupDefinitionProps struct { // The set of container definitions that are included in the container group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinitions // ContainerDefinitions interface{} `field:"required" json:"containerDefinitions" yaml:"containerDefinitions"` // A descriptive identifier for the container group definition. // // The name value is unique in an AWS Region. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-name // Name *string `field:"required" json:"name" yaml:"name"` // The platform required for all containers in the container group definition. // // > Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the [Amazon Linux 2 FAQs](https://docs.aws.amazon.com/https://aws.amazon.com/amazon-linux-2/faqs/) . For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See [Migrate to Amazon GameLift server SDK version 5.](https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html) // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-operatingsystem // OperatingSystem *string `field:"required" json:"operatingSystem" yaml:"operatingSystem"` // The amount of CPU units on a fleet instance to allocate for the container group. // // All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units). // // You can set additional limits for each `ContainerDefinition` in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group. // // For more details on memory allocation, see the [Container fleet design guide](https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-totalcpulimit // TotalCpuLimit *float64 `field:"required" json:"totalCpuLimit" yaml:"totalCpuLimit"` // The amount of memory (in MiB) on a fleet instance to allocate for the container group. // // All containers in the group share these resources. // // You can set additional limits for each `ContainerDefinition` in the group. If individual containers have limits, this value must meet the following requirements: // // - Equal to or greater than the sum of all container-specific soft memory limits in the group. // - Equal to or greater than any container-specific hard limits in the group. // // For more details on memory allocation, see the [Container fleet design guide](https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-totalmemorylimit // TotalMemoryLimit *float64 `field:"required" json:"totalMemoryLimit" yaml:"totalMemoryLimit"` // The method for deploying the container group across fleet instances. // // A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-schedulingstrategy // SchedulingStrategy *string `field:"optional" json:"schedulingStrategy" yaml:"schedulingStrategy"` // A specific ContainerGroupDefinition version to be updated. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-sourceversionnumber // SourceVersionNumber *float64 `field:"optional" json:"sourceVersionNumber" yaml:"sourceVersionNumber"` // A collection of support container definitions that define the containers in this group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinitions // SupportContainerDefinitions interface{} `field:"optional" json:"supportContainerDefinitions" yaml:"supportContainerDefinitions"` // An array of key-value pairs to apply to this resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnContainerGroupDefinition`.
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" var supportContainerDefinitions interface{} cfnContainerGroupDefinitionProps := &CfnContainerGroupDefinitionProps{ ContainerDefinitions: []interface{}{ &ContainerDefinitionProperty{ ContainerName: jsii.String("containerName"), ImageUri: jsii.String("imageUri"), // the properties below are optional Command: []*string{ jsii.String("command"), }, Cpu: jsii.Number(123), DependsOn: []interface{}{ &ContainerDependencyProperty{ Condition: jsii.String("condition"), ContainerName: jsii.String("containerName"), }, }, EntryPoint: []*string{ jsii.String("entryPoint"), }, Environment: []interface{}{ &ContainerEnvironmentProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, Essential: jsii.Boolean(false), HealthCheck: &ContainerHealthCheckProperty{ Command: []*string{ jsii.String("command"), }, // the properties below are optional Interval: jsii.Number(123), Retries: jsii.Number(123), StartPeriod: jsii.Number(123), Timeout: jsii.Number(123), }, MemoryLimits: &MemoryLimitsProperty{ HardLimit: jsii.Number(123), SoftLimit: jsii.Number(123), }, PortConfiguration: &PortConfigurationProperty{ ContainerPortRanges: []interface{}{ &ContainerPortRangeProperty{ FromPort: jsii.Number(123), Protocol: jsii.String("protocol"), ToPort: jsii.Number(123), }, }, }, ResolvedImageDigest: jsii.String("resolvedImageDigest"), WorkingDirectory: jsii.String("workingDirectory"), }, }, Name: jsii.String("name"), OperatingSystem: jsii.String("operatingSystem"), TotalCpuLimit: jsii.Number(123), TotalMemoryLimit: jsii.Number(123), // the properties below are optional SchedulingStrategy: jsii.String("schedulingStrategy"), SourceVersionNumber: jsii.Number(123), SupportContainerDefinitions: []interface{}{ supportContainerDefinitions, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnContainerGroupDefinition_ContainerDefinitionProperty ¶ added in v2.140.0
type CfnContainerGroupDefinition_ContainerDefinitionProperty struct { // The container definition identifier. // // Container names are unique within a container group definition. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-containername // ContainerName *string `field:"required" json:"containerName" yaml:"containerName"` // The URI to the image that $short; // // copied and deployed to a container fleet. For a more specific identifier, see `ResolvedImageDigest` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-imageuri // ImageUri *string `field:"required" json:"imageUri" yaml:"imageUri"` // A command that's passed to the container on startup. // // Each argument for the command is an additional string in the array. See the [ContainerDefinition::command](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-command) parameter in the *Amazon Elastic Container Service API reference.* // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-command // Command *[]*string `field:"optional" json:"command" yaml:"command"` // The number of CPU units that are reserved for the container. // // Note: 1 vCPU unit equals 1024 CPU units. If no resources are reserved, the container shares the total CPU limit for the container group. // // *Related data type:* `ContainerGroupDefinition$TotalCpuLimit`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-cpu // Cpu *float64 `field:"optional" json:"cpu" yaml:"cpu"` // Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences. // // A container might have dependencies on multiple containers. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-dependson // DependsOn interface{} `field:"optional" json:"dependsOn" yaml:"dependsOn"` // The entry point that's passed to the container on startup. // // If there are multiple arguments, each argument is an additional string in the array. See the [ContainerDefinition::entryPoint](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-entryPoint) parameter in the *Amazon Elastic Container Service API Reference* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-entrypoint // EntryPoint *[]*string `field:"optional" json:"entryPoint" yaml:"entryPoint"` // A set of environment variables that's passed to the container on startup. // // See the [ContainerDefinition::environment](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-environment) parameter in the *Amazon Elastic Container Service API Reference* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-environment // Environment interface{} `field:"optional" json:"environment" yaml:"environment"` // Indicates whether the container is vital to the container group. // // If an essential container fails, the entire container group is restarted. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-essential // Essential interface{} `field:"optional" json:"essential" yaml:"essential"` // A configuration for a non-terminal health check. // // A container, which automatically restarts if it stops functioning, also restarts if it fails this health check. If an essential container in the daemon group fails a health check, the entire container group is restarted. The essential container in the replica group doesn't use this health check mechanism, because the Amazon GameLift Agent automatically handles the task. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-healthcheck // HealthCheck interface{} `field:"optional" json:"healthCheck" yaml:"healthCheck"` // The amount of memory that Amazon GameLift makes available to the container. // // If memory limits aren't set for an individual container, the container shares the container group's total memory allocation. // // *Related data type:* `ContainerGroupDefinition$TotalMemoryLimit`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-memorylimits // MemoryLimits interface{} `field:"optional" json:"memoryLimits" yaml:"memoryLimits"` // Defines the ports that are available to assign to processes in the container. // // For example, a game server process requires a container port to allow game clients to connect to it. Container ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's `ConnectionPortRange` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-portconfiguration // PortConfiguration interface{} `field:"optional" json:"portConfiguration" yaml:"portConfiguration"` // A unique and immutable identifier for the container image that is deployed to a container fleet. // // The digest is a SHA 256 hash of the container image manifest. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-resolvedimagedigest // ResolvedImageDigest *string `field:"optional" json:"resolvedImageDigest" yaml:"resolvedImageDigest"` // The directory in the container where commands are run. // // See the [ContainerDefinition::workingDirectory](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-workingDirectory) parameter in the *Amazon Elastic Container Service API Reference* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-workingdirectory // WorkingDirectory *string `field:"optional" json:"workingDirectory" yaml:"workingDirectory"` }
*This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*.
Describes a container in a container fleet, the resources available to the container, and the commands that are run when the container starts. Container properties can't be updated. To change a property, create a new container group definition. See also `ContainerDefinitionInput` .
*Part of:* `ContainerGroupDefinition`
*Returned by:* `DescribeContainerGroupDefinition` , `ListContainerGroupDefinitions`.
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" containerDefinitionProperty := &ContainerDefinitionProperty{ ContainerName: jsii.String("containerName"), ImageUri: jsii.String("imageUri"), // the properties below are optional Command: []*string{ jsii.String("command"), }, Cpu: jsii.Number(123), DependsOn: []interface{}{ &ContainerDependencyProperty{ Condition: jsii.String("condition"), ContainerName: jsii.String("containerName"), }, }, EntryPoint: []*string{ jsii.String("entryPoint"), }, Environment: []interface{}{ &ContainerEnvironmentProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, Essential: jsii.Boolean(false), HealthCheck: &ContainerHealthCheckProperty{ Command: []*string{ jsii.String("command"), }, // the properties below are optional Interval: jsii.Number(123), Retries: jsii.Number(123), StartPeriod: jsii.Number(123), Timeout: jsii.Number(123), }, MemoryLimits: &MemoryLimitsProperty{ HardLimit: jsii.Number(123), SoftLimit: jsii.Number(123), }, PortConfiguration: &PortConfigurationProperty{ ContainerPortRanges: []interface{}{ &ContainerPortRangeProperty{ FromPort: jsii.Number(123), Protocol: jsii.String("protocol"), ToPort: jsii.Number(123), }, }, }, ResolvedImageDigest: jsii.String("resolvedImageDigest"), WorkingDirectory: jsii.String("workingDirectory"), }
type CfnContainerGroupDefinition_ContainerDependencyProperty ¶ added in v2.140.0
type CfnContainerGroupDefinition_ContainerDependencyProperty struct { // The condition that the dependency container must reach before the dependent container can start. Valid conditions include:. // // - START - The dependency container must have started. // - COMPLETE - The dependency container has run to completion (exits). Use this condition with nonessential containers, such as those that run a script and then exit. The dependency container can't be an essential container. // - SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can't be an essential container. // - HEALTHY - The dependency container has passed its Docker health check. Use this condition with dependency containers that have health checks configured. This condition is confirmed at container group startup only. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdependency.html#cfn-gamelift-containergroupdefinition-containerdependency-condition // Condition *string `field:"required" json:"condition" yaml:"condition"` // A descriptive label for the container definition that this container depends on. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdependency.html#cfn-gamelift-containergroupdefinition-containerdependency-containername // ContainerName *string `field:"required" json:"containerName" yaml:"containerName"` }
*This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*.
A container's dependency on another container in the same container group. The dependency impacts how the dependent container is able to start or shut down based the status of the other container.
For example, ContainerA is configured with the following dependency: a `START` dependency on ContainerB. This means that ContainerA can't start until ContainerB has started. It also means that ContainerA must shut down before ContainerB.
*Part of:* `ContainerDefinition`.
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" containerDependencyProperty := &ContainerDependencyProperty{ Condition: jsii.String("condition"), ContainerName: jsii.String("containerName"), }
type CfnContainerGroupDefinition_ContainerEnvironmentProperty ¶ added in v2.140.0
type CfnContainerGroupDefinition_ContainerEnvironmentProperty struct { // The environment variable name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerenvironment.html#cfn-gamelift-containergroupdefinition-containerenvironment-name // Name *string `field:"required" json:"name" yaml:"name"` // The environment variable value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerenvironment.html#cfn-gamelift-containergroupdefinition-containerenvironment-value // Value *string `field:"required" json:"value" yaml:"value"` }
*This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*.
An environment variable to set inside a container, in the form of a key-value pair.
*Related data type:* `ContainerDefinition$Environment`.
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" containerEnvironmentProperty := &ContainerEnvironmentProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }
type CfnContainerGroupDefinition_ContainerHealthCheckProperty ¶ added in v2.140.0
type CfnContainerGroupDefinition_ContainerHealthCheckProperty struct { // A string array that specifies the command that the container runs to determine if it's healthy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-command // Command *[]*string `field:"required" json:"command" yaml:"command"` // The time period (in seconds) between each health check. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-interval // Interval *float64 `field:"optional" json:"interval" yaml:"interval"` // The number of times to retry a failed health check before the container is considered unhealthy. // // The first run of the command does not count as a retry. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-retries // Retries *float64 `field:"optional" json:"retries" yaml:"retries"` // The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-startperiod // StartPeriod *float64 `field:"optional" json:"startPeriod" yaml:"startPeriod"` // The time period (in seconds) to wait for a health check to succeed before a failed health check is counted. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-timeout // Timeout *float64 `field:"optional" json:"timeout" yaml:"timeout"` }
Instructions on when and how to check the health of a container in a container fleet.
When health check properties are set in a container definition, they override any Docker health checks in the container image. For more information on container health checks, see [HealthCheck command](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html#ECS-Type-HealthCheck-command) in the *Amazon Elastic Container Service API* .
The following example instructions tell the container to wait 100 seconds after launch before counting failed health checks, then initiate the health check command every 60 seconds. After issuing the health check command, wait 10 seconds for it to succeed. If it fails, retry the command 3 times before considering the container to be unhealthy.
`{"Command": [ "CMD-SHELL", "ps cax | grep "processmanager" || exit 1" ], "Interval": 300, "Timeout": 30, "Retries": 5, "StartPeriod": 100 }`
*Part of:* `ContainerDefinition$HealthCheck`.
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" containerHealthCheckProperty := &ContainerHealthCheckProperty{ Command: []*string{ jsii.String("command"), }, // the properties below are optional Interval: jsii.Number(123), Retries: jsii.Number(123), StartPeriod: jsii.Number(123), Timeout: jsii.Number(123), }
type CfnContainerGroupDefinition_ContainerPortRangeProperty ¶ added in v2.140.0
type CfnContainerGroupDefinition_ContainerPortRangeProperty struct { // A starting value for the range of allowed port numbers. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerportrange.html#cfn-gamelift-containergroupdefinition-containerportrange-fromport // FromPort *float64 `field:"required" json:"fromPort" yaml:"fromPort"` // The network protocol that these ports support. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerportrange.html#cfn-gamelift-containergroupdefinition-containerportrange-protocol // Protocol *string `field:"required" json:"protocol" yaml:"protocol"` // An ending value for the range of allowed port numbers. // // Port numbers are end-inclusive. This value must be equal to or greater than `FromPort` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerportrange.html#cfn-gamelift-containergroupdefinition-containerportrange-toport // ToPort *float64 `field:"required" json:"toPort" yaml:"toPort"` }
*This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*.
A set of one or more port numbers that can be opened on the container.
*Part of:* `ContainerPortConfiguration`.
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" containerPortRangeProperty := &ContainerPortRangeProperty{ FromPort: jsii.Number(123), Protocol: jsii.String("protocol"), ToPort: jsii.Number(123), }
type CfnContainerGroupDefinition_MemoryLimitsProperty ¶ added in v2.140.0
type CfnContainerGroupDefinition_MemoryLimitsProperty struct { // The hard limit of memory to reserve for the container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-memorylimits.html#cfn-gamelift-containergroupdefinition-memorylimits-hardlimit // HardLimit *float64 `field:"optional" json:"hardLimit" yaml:"hardLimit"` // The amount of memory that is reserved for the container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-memorylimits.html#cfn-gamelift-containergroupdefinition-memorylimits-softlimit // SoftLimit *float64 `field:"optional" json:"softLimit" yaml:"softLimit"` }
Specifies how much memory is available to the container.
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" memoryLimitsProperty := &MemoryLimitsProperty{ HardLimit: jsii.Number(123), SoftLimit: jsii.Number(123), }
type CfnContainerGroupDefinition_PortConfigurationProperty ¶ added in v2.140.0
type CfnContainerGroupDefinition_PortConfigurationProperty struct { // Specifies one or more ranges of ports on a container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-portconfiguration.html#cfn-gamelift-containergroupdefinition-portconfiguration-containerportranges // ContainerPortRanges interface{} `field:"required" json:"containerPortRanges" yaml:"containerPortRanges"` }
Defines the ports on a container.
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" portConfigurationProperty := &PortConfigurationProperty{ ContainerPortRanges: []interface{}{ &ContainerPortRangeProperty{ FromPort: jsii.Number(123), Protocol: jsii.String("protocol"), ToPort: jsii.Number(123), }, }, }
type CfnFleet ¶
type CfnFleet interface { awscdk.CfnResource awscdk.IInspectable // Amazon GameLift Anywhere configuration options. AnywhereConfiguration() interface{} SetAnywhereConfiguration(val interface{}) // Current resource capacity settings for managed EC2 fleets and container fleets. ApplyCapacity() *string SetApplyCapacity(val *string) // The maximum possible number of replica container groups that each fleet instance can have. AttrContainerGroupsConfigurationContainerGroupsPerInstanceMaxReplicaContainerGroupsPerInstance() *float64 // A unique identifier for the fleet. AttrFleetId() *string // A unique identifier for a build to be deployed on the new fleet. BuildId() *string SetBuildId(val *string) // Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. 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 // The type of compute resource used to host your game servers. ComputeType() *string SetComputeType(val *string) // *This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*. ContainerGroupsConfiguration() interface{} SetContainerGroupsConfiguration(val interface{}) // 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 description for the fleet. Description() *string SetDescription(val *string) // The number of EC2 instances that you want this fleet to host. DesiredEc2Instances() *float64 SetDesiredEc2Instances(val *float64) // The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. Ec2InboundPermissions() interface{} SetEc2InboundPermissions(val interface{}) // The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets. Ec2InstanceType() *string SetEc2InstanceType(val *string) // Indicates whether to use On-Demand or Spot instances for this fleet. FleetType() *string SetFleetType(val *string) // A unique identifier for an IAM role with access permissions to other AWS services. InstanceRoleArn() *string SetInstanceRoleArn(val *string) // Indicates that fleet instances maintain a shared credentials file for the IAM role defined in `InstanceRoleArn` . InstanceRoleCredentialsProvider() *string SetInstanceRoleCredentialsProvider(val *string) // A set of remote locations to deploy additional instances to and manage as a multi-location fleet. 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 // This parameter is no longer used. // Deprecated: this property has been deprecated. LogPaths() *[]*string // Deprecated: this property has been deprecated. SetLogPaths(val *[]*string) // The maximum number of instances that are allowed in the specified fleet location. MaxSize() *float64 SetMaxSize(val *float64) // The name of an AWS CloudWatch metric group to add this fleet to. MetricGroups() *[]*string SetMetricGroups(val *[]*string) // The minimum number of instances that are allowed in the specified fleet location. MinSize() *float64 SetMinSize(val *float64) // A descriptive label that is associated with a fleet. Name() *string SetName(val *string) // The status of termination protection for active game sessions on the fleet. NewGameSessionProtectionPolicy() *string SetNewGameSessionProtectionPolicy(val *string) // The tree node. Node() constructs.Node // Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC. PeerVpcAwsAccountId() *string SetPeerVpcAwsAccountId(val *string) // A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. 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. RuntimeConfiguration() interface{} SetRuntimeConfiguration(val interface{}) // Rule that controls how a fleet is scaled. ScalingPolicies() interface{} SetScalingPolicies(val interface{}) // The unique identifier for a Realtime configuration script to be deployed on fleet instances. ScriptId() *string SetScriptId(val *string) // This parameter is no longer used but is retained for backward compatibility. // Deprecated: this property has been deprecated. ServerLaunchParameters() *string // Deprecated: this property has been deprecated. SetServerLaunchParameters(val *string) // This parameter is no longer used. // Deprecated: this property has been deprecated. ServerLaunchPath() *string // Deprecated: this property has been deprecated. SetServerLaunchPath(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // 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{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. 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, typeHint awscdk.ResolutionTypeHint) 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) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // 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{}) }
The `AWS::GameLift::Fleet` resource creates an Amazon GameLift (GameLift) fleet to host custom game server or Realtime Servers.
A fleet is a set of EC2 instances, configured with instructions to run game servers on each instance.
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{ Name: jsii.String("name"), // the properties below are optional AnywhereConfiguration: &AnywhereConfigurationProperty{ Cost: jsii.String("cost"), }, ApplyCapacity: jsii.String("applyCapacity"), BuildId: jsii.String("buildId"), CertificateConfiguration: &CertificateConfigurationProperty{ CertificateType: jsii.String("certificateType"), }, ComputeType: jsii.String("computeType"), ContainerGroupsConfiguration: &ContainerGroupsConfigurationProperty{ ConnectionPortRange: &ConnectionPortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, ContainerGroupDefinitionNames: []*string{ jsii.String("containerGroupDefinitionNames"), }, // the properties below are optional ContainerGroupsPerInstance: &ContainerGroupsPerInstanceProperty{ DesiredReplicaContainerGroupsPerInstance: jsii.Number(123), MaxReplicaContainerGroupsPerInstance: jsii.Number(123), }, }, Description: jsii.String("description"), DesiredEc2Instances: jsii.Number(123), Ec2InboundPermissions: []interface{}{ &IpPermissionProperty{ FromPort: jsii.Number(123), IpRange: jsii.String("ipRange"), Protocol: jsii.String("protocol"), ToPort: jsii.Number(123), }, }, Ec2InstanceType: jsii.String("ec2InstanceType"), FleetType: jsii.String("fleetType"), InstanceRoleArn: jsii.String("instanceRoleArn"), InstanceRoleCredentialsProvider: jsii.String("instanceRoleCredentialsProvider"), Locations: []interface{}{ &LocationConfigurationProperty{ Location: jsii.String("location"), // the properties below are optional LocationCapacity: &LocationCapacityProperty{ DesiredEc2Instances: jsii.Number(123), MaxSize: jsii.Number(123), MinSize: jsii.Number(123), }, }, }, LogPaths: []*string{ jsii.String("logPaths"), }, MaxSize: jsii.Number(123), MetricGroups: []*string{ jsii.String("metricGroups"), }, MinSize: jsii.Number(123), NewGameSessionProtectionPolicy: jsii.String("newGameSessionProtectionPolicy"), PeerVpcAwsAccountId: jsii.String("peerVpcAwsAccountId"), PeerVpcId: jsii.String("peerVpcId"), ResourceCreationLimitPolicy: &ResourceCreationLimitPolicyProperty{ NewGameSessionsPerCreator: jsii.Number(123), PolicyPeriodInMinutes: jsii.Number(123), }, RuntimeConfiguration: &RuntimeConfigurationProperty{ GameSessionActivationTimeoutSeconds: jsii.Number(123), MaxConcurrentGameSessionActivations: jsii.Number(123), ServerProcesses: []interface{}{ &ServerProcessProperty{ ConcurrentExecutions: jsii.Number(123), LaunchPath: jsii.String("launchPath"), // the properties below are optional Parameters: jsii.String("parameters"), }, }, }, ScalingPolicies: []interface{}{ &ScalingPolicyProperty{ MetricName: jsii.String("metricName"), Name: jsii.String("name"), // the properties below are optional ComparisonOperator: jsii.String("comparisonOperator"), EvaluationPeriods: jsii.Number(123), Location: jsii.String("location"), PolicyType: jsii.String("policyType"), ScalingAdjustment: jsii.Number(123), ScalingAdjustmentType: jsii.String("scalingAdjustmentType"), Status: jsii.String("status"), TargetConfiguration: &TargetConfigurationProperty{ TargetValue: jsii.Number(123), }, Threshold: jsii.Number(123), UpdateStatus: jsii.String("updateStatus"), }, }, ScriptId: jsii.String("scriptId"), ServerLaunchParameters: jsii.String("serverLaunchParameters"), ServerLaunchPath: jsii.String("serverLaunchPath"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html
func NewCfnFleet ¶
func NewCfnFleet(scope constructs.Construct, id *string, props *CfnFleetProps) CfnFleet
type CfnFleetProps ¶
type CfnFleetProps struct { // A descriptive label that is associated with a fleet. // // Fleet names do not need to be unique. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-name // Name *string `field:"required" json:"name" yaml:"name"` // Amazon GameLift Anywhere configuration options. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-anywhereconfiguration // AnywhereConfiguration interface{} `field:"optional" json:"anywhereConfiguration" yaml:"anywhereConfiguration"` // Current resource capacity settings for managed EC2 fleets and container fleets. // // For multi-location fleets, location values might refer to a fleet's remote location or its home Region. // // *Returned by:* [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) // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-applycapacity // ApplyCapacity *string `field:"optional" json:"applyCapacity" yaml:"applyCapacity"` // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-buildid // BuildId *string `field:"optional" json:"buildId" yaml:"buildId"` // Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. // // Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-certificateconfiguration // CertificateConfiguration interface{} `field:"optional" json:"certificateConfiguration" yaml:"certificateConfiguration"` // The type of compute resource used to host your game servers. // // - `EC2` – The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the default setting. // - `CONTAINER` – Container images with your game server build and supporting software are deployed to Amazon EC2 instances for cloud hosting. With this compute type, you must specify the `ContainerGroupsConfiguration` parameter. // - `ANYWHERE` – Game servers or container images with your game server and supporting software are deployed to compute resources that are provided and managed by you. With this compute type, you can also set the `AnywhereConfiguration` parameter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-computetype // ComputeType *string `field:"optional" json:"computeType" yaml:"computeType"` // *This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*. // // Configuration details for a set of container groups, for use when creating a fleet with compute type `CONTAINER` . // // *Used with:* `CreateFleet`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-containergroupsconfiguration // ContainerGroupsConfiguration interface{} `field:"optional" json:"containerGroupsConfiguration" yaml:"containerGroupsConfiguration"` // A description for the fleet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-description // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-desiredec2instances // DesiredEc2Instances *float64 `field:"optional" json:"desiredEc2Instances" yaml:"desiredEc2Instances"` // The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. // // Set this parameter for EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call `UpdateFleetPortSettings` to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges. // // To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-ec2inboundpermissions // Ec2InboundPermissions interface{} `field:"optional" json:"ec2InboundPermissions" yaml:"ec2InboundPermissions"` // The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets. // // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-ec2instancetype // 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 fleet property can't be changed after the fleet is created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-fleettype // FleetType *string `field:"optional" json:"fleetType" yaml:"fleetType"` // A unique identifier for an IAM role with access permissions to other AWS services. // // Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with AWS resources that you own or have access to. For more information about using the role with your game server builds, see [Communicate with other AWS resources from your fleets](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html) . This attribute is used with fleets where `ComputeType` is "EC2" or "Container". // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-instancerolearn // InstanceRoleArn *string `field:"optional" json:"instanceRoleArn" yaml:"instanceRoleArn"` // Indicates that fleet instances maintain a shared credentials file for the IAM role defined in `InstanceRoleArn` . // // Shared credentials allow applications that are deployed with the game server executable to communicate with other AWS resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see [Communicate with other AWS resources from your fleets](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html) . This attribute is used with fleets where `ComputeType` is "EC2" or "Container". // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-instancerolecredentialsprovider // InstanceRoleCredentialsProvider *string `field:"optional" json:"instanceRoleCredentialsProvider" yaml:"instanceRoleCredentialsProvider"` // A set of remote locations to deploy additional instances to and manage as a multi-location fleet. // // Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift. Provide a list of one or more AWS Region codes, such as `us-west-2` , or Local Zone names. When using this parameter, Amazon GameLift requires you to include your home location in the request. For a list of supported Regions and Local Zones, see [Amazon GameLift service locations](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html) for managed hosting. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-locations // Locations interface{} `field:"optional" json:"locations" yaml:"locations"` // This parameter is no longer used. // // When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady(). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-logpaths // // Deprecated: this property has been deprecated. LogPaths *[]*string `field:"optional" json:"logPaths" yaml:"logPaths"` // The maximum number of instances that are allowed in the specified fleet location. // // If this parameter is not set, the default is 1. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-maxsize // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-metricgroups // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-minsize // MinSize *float64 `field:"optional" json:"minSize" yaml:"minSize"` // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-newgamesessionprotectionpolicy // NewGameSessionProtectionPolicy *string `field:"optional" json:"newGameSessionProtectionPolicy" yaml:"newGameSessionProtectionPolicy"` // Used when peering your Amazon 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-peervpcawsaccountid // PeerVpcAwsAccountId *string `field:"optional" json:"peerVpcAwsAccountId" yaml:"peerVpcAwsAccountId"` // A unique identifier for a VPC with resources to be accessed by your Amazon 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 Amazon GameLift Fleets](https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-peervpcid // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-resourcecreationlimitpolicy // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-runtimeconfiguration // RuntimeConfiguration interface{} `field:"optional" json:"runtimeConfiguration" yaml:"runtimeConfiguration"` // Rule that controls how a fleet is scaled. // // Scaling policies are uniquely identified by the combination of name and fleet ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-scalingpolicies // ScalingPolicies interface{} `field:"optional" json:"scalingPolicies" yaml:"scalingPolicies"` // 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 Amazon 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-scriptid // ScriptId *string `field:"optional" json:"scriptId" yaml:"scriptId"` // This parameter is no longer used but is retained for backward compatibility. // // Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-serverlaunchparameters // // Deprecated: this property has been deprecated. ServerLaunchParameters *string `field:"optional" json:"serverLaunchParameters" yaml:"serverLaunchParameters"` // This parameter is no longer used. // // Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-serverlaunchpath // // Deprecated: this property has been deprecated. ServerLaunchPath *string `field:"optional" json:"serverLaunchPath" yaml:"serverLaunchPath"` }
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{ Name: jsii.String("name"), // the properties below are optional AnywhereConfiguration: &AnywhereConfigurationProperty{ Cost: jsii.String("cost"), }, ApplyCapacity: jsii.String("applyCapacity"), BuildId: jsii.String("buildId"), CertificateConfiguration: &CertificateConfigurationProperty{ CertificateType: jsii.String("certificateType"), }, ComputeType: jsii.String("computeType"), ContainerGroupsConfiguration: &ContainerGroupsConfigurationProperty{ ConnectionPortRange: &ConnectionPortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, ContainerGroupDefinitionNames: []*string{ jsii.String("containerGroupDefinitionNames"), }, // the properties below are optional ContainerGroupsPerInstance: &ContainerGroupsPerInstanceProperty{ DesiredReplicaContainerGroupsPerInstance: jsii.Number(123), MaxReplicaContainerGroupsPerInstance: jsii.Number(123), }, }, Description: jsii.String("description"), DesiredEc2Instances: jsii.Number(123), Ec2InboundPermissions: []interface{}{ &IpPermissionProperty{ FromPort: jsii.Number(123), IpRange: jsii.String("ipRange"), Protocol: jsii.String("protocol"), ToPort: jsii.Number(123), }, }, Ec2InstanceType: jsii.String("ec2InstanceType"), FleetType: jsii.String("fleetType"), InstanceRoleArn: jsii.String("instanceRoleArn"), InstanceRoleCredentialsProvider: jsii.String("instanceRoleCredentialsProvider"), Locations: []interface{}{ &LocationConfigurationProperty{ Location: jsii.String("location"), // the properties below are optional LocationCapacity: &LocationCapacityProperty{ DesiredEc2Instances: jsii.Number(123), MaxSize: jsii.Number(123), MinSize: jsii.Number(123), }, }, }, LogPaths: []*string{ jsii.String("logPaths"), }, MaxSize: jsii.Number(123), MetricGroups: []*string{ jsii.String("metricGroups"), }, MinSize: jsii.Number(123), NewGameSessionProtectionPolicy: jsii.String("newGameSessionProtectionPolicy"), PeerVpcAwsAccountId: jsii.String("peerVpcAwsAccountId"), PeerVpcId: jsii.String("peerVpcId"), ResourceCreationLimitPolicy: &ResourceCreationLimitPolicyProperty{ NewGameSessionsPerCreator: jsii.Number(123), PolicyPeriodInMinutes: jsii.Number(123), }, RuntimeConfiguration: &RuntimeConfigurationProperty{ GameSessionActivationTimeoutSeconds: jsii.Number(123), MaxConcurrentGameSessionActivations: jsii.Number(123), ServerProcesses: []interface{}{ &ServerProcessProperty{ ConcurrentExecutions: jsii.Number(123), LaunchPath: jsii.String("launchPath"), // the properties below are optional Parameters: jsii.String("parameters"), }, }, }, ScalingPolicies: []interface{}{ &ScalingPolicyProperty{ MetricName: jsii.String("metricName"), Name: jsii.String("name"), // the properties below are optional ComparisonOperator: jsii.String("comparisonOperator"), EvaluationPeriods: jsii.Number(123), Location: jsii.String("location"), PolicyType: jsii.String("policyType"), ScalingAdjustment: jsii.Number(123), ScalingAdjustmentType: jsii.String("scalingAdjustmentType"), Status: jsii.String("status"), TargetConfiguration: &TargetConfigurationProperty{ TargetValue: jsii.Number(123), }, Threshold: jsii.Number(123), UpdateStatus: jsii.String("updateStatus"), }, }, ScriptId: jsii.String("scriptId"), ServerLaunchParameters: jsii.String("serverLaunchParameters"), ServerLaunchPath: jsii.String("serverLaunchPath"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html
type CfnFleet_AnywhereConfigurationProperty ¶ added in v2.55.0
type CfnFleet_AnywhereConfigurationProperty struct { // The cost to run your fleet per hour. // // Amazon GameLift uses the provided cost of your fleet to balance usage in queues. For more information about queues, see [Setting up queues](https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html) in the *Amazon GameLift Developer Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-anywhereconfiguration.html#cfn-gamelift-fleet-anywhereconfiguration-cost // Cost *string `field:"required" json:"cost" yaml:"cost"` }
Amazon GameLift configuration options for your Anywhere fleets.
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" anywhereConfigurationProperty := &AnywhereConfigurationProperty{ Cost: jsii.String("cost"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-certificateconfiguration.html#cfn-gamelift-fleet-certificateconfiguration-certificatetype // 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_ConnectionPortRangeProperty ¶ added in v2.140.0
type CfnFleet_ConnectionPortRangeProperty struct { // Starting value for the port range. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-connectionportrange.html#cfn-gamelift-fleet-connectionportrange-fromport // FromPort *float64 `field:"required" json:"fromPort" yaml:"fromPort"` // Ending value for the port. // // Port numbers are end-inclusive. This value must be equal to or greater than `FromPort` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-connectionportrange.html#cfn-gamelift-fleet-connectionportrange-toport // ToPort *float64 `field:"required" json:"toPort" yaml:"toPort"` }
*This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.*.
The set of port numbers to open on each instance in a container fleet. Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.
*Part of:* `ContainerGroupsConfiguration` , `ContainerGroupsAttributes`.
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" connectionPortRangeProperty := &ConnectionPortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }
type CfnFleet_ContainerGroupsConfigurationProperty ¶ added in v2.140.0
type CfnFleet_ContainerGroupsConfigurationProperty struct { // A set of ports to allow inbound traffic, including game clients, to connect to processes running in the container fleet. // // Connection ports are dynamically mapped to container ports, which are assigned to individual processes running in a container. The connection port range must have enough ports to map to all container ports across a fleet instance. To calculate the minimum connection ports needed, use the following formula: // // *[Total number of container ports as defined for containers in the replica container group] * [Desired or calculated number of replica container groups per instance] + [Total number of container ports as defined for containers in the daemon container group]* // // As a best practice, double the minimum number of connection ports. // // > Use the fleet's `EC2InboundPermissions` property to control external access to connection ports. Set this property to the connection port numbers that you want to open access to. See `IpPermission` for more details. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-containergroupsconfiguration.html#cfn-gamelift-fleet-containergroupsconfiguration-connectionportrange // ConnectionPortRange interface{} `field:"required" json:"connectionPortRange" yaml:"connectionPortRange"` // The list of container group definition names to deploy to a new container fleet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-containergroupsconfiguration.html#cfn-gamelift-fleet-containergroupsconfiguration-containergroupdefinitionnames // ContainerGroupDefinitionNames *[]*string `field:"required" json:"containerGroupDefinitionNames" yaml:"containerGroupDefinitionNames"` // The number of container groups per instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-containergroupsconfiguration.html#cfn-gamelift-fleet-containergroupsconfiguration-containergroupsperinstance // ContainerGroupsPerInstance interface{} `field:"optional" json:"containerGroupsPerInstance" yaml:"containerGroupsPerInstance"` }
*This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*.
Configuration details for a set of container groups, for use when creating a fleet with compute type `CONTAINER` .
*Used with:* `CreateFleet`.
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" containerGroupsConfigurationProperty := &ContainerGroupsConfigurationProperty{ ConnectionPortRange: &ConnectionPortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, ContainerGroupDefinitionNames: []*string{ jsii.String("containerGroupDefinitionNames"), }, // the properties below are optional ContainerGroupsPerInstance: &ContainerGroupsPerInstanceProperty{ DesiredReplicaContainerGroupsPerInstance: jsii.Number(123), MaxReplicaContainerGroupsPerInstance: jsii.Number(123), }, }
type CfnFleet_ContainerGroupsPerInstanceProperty ¶ added in v2.140.0
type CfnFleet_ContainerGroupsPerInstanceProperty struct { // The desired number of replica container groups to place on each fleet instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-containergroupsperinstance.html#cfn-gamelift-fleet-containergroupsperinstance-desiredreplicacontainergroupsperinstance // DesiredReplicaContainerGroupsPerInstance *float64 `field:"optional" json:"desiredReplicaContainerGroupsPerInstance" yaml:"desiredReplicaContainerGroupsPerInstance"` // The maximum possible number of replica container groups that each fleet instance can have. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-containergroupsperinstance.html#cfn-gamelift-fleet-containergroupsperinstance-maxreplicacontainergroupsperinstance // MaxReplicaContainerGroupsPerInstance *float64 `field:"optional" json:"maxReplicaContainerGroupsPerInstance" yaml:"maxReplicaContainerGroupsPerInstance"` }
*This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*.
Determines how many replica container groups that Amazon GameLift deploys to each instance in a container fleet.
Amazon GameLift calculates the maximum possible replica groups per instance based on the instance 's CPU and memory resources. When deploying a fleet, Amazon GameLift places replica container groups on each fleet instance based on the following:
- If no desired value is set, Amazon GameLift places the calculated maximum. - If a desired number is set to a value higher than the calculated maximum, fleet creation fails.. - If a desired number is set to a value lower than the calculated maximum, Amazon GameLift places the desired number.
*Part of:* `ContainerGroupsConfiguration` , `ContainerGroupsAttributes`
*Returned by:* `DescribeFleetAttributes` , `CreateFleet`.
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" containerGroupsPerInstanceProperty := &ContainerGroupsPerInstanceProperty{ DesiredReplicaContainerGroupsPerInstance: jsii.Number(123), MaxReplicaContainerGroupsPerInstance: jsii.Number(123), }
type CfnFleet_IpPermissionProperty ¶
type CfnFleet_IpPermissionProperty struct { // A starting value for a range of allowed port numbers. // // For fleets using Linux builds, only ports `22` and `1026-60000` are valid. // // For fleets using Windows builds, only ports `1026-60000` are valid. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ippermission.html#cfn-gamelift-fleet-ippermission-fromport // 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]` ". // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ippermission.html#cfn-gamelift-fleet-ippermission-iprange // IpRange *string `field:"required" json:"ipRange" yaml:"ipRange"` // The network communication protocol used by the fleet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ippermission.html#cfn-gamelift-fleet-ippermission-protocol // 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 equal to or greater than `FromPort` . // // For fleets using Linux builds, only ports `22` and `1026-60000` are valid. // // For fleets using Windows builds, only ports `1026-60000` are valid. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ippermission.html#cfn-gamelift-fleet-ippermission-toport // 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. Changes in desired instance value can take up to 1 minute to be reflected when viewing the fleet's capacity settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationcapacity.html#cfn-gamelift-fleet-locationcapacity-desiredec2instances // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationcapacity.html#cfn-gamelift-fleet-locationcapacity-maxsize // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationcapacity.html#cfn-gamelift-fleet-locationcapacity-minsize // MinSize *float64 `field:"required" json:"minSize" yaml:"minSize"` }
Current resource capacity settings for managed EC2 fleets and container fleets.
For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
*Returned by:* [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` . // // For a list of supported Regions and Local Zones, see [Amazon GameLift service locations](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html) for managed hosting. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationconfiguration.html#cfn-gamelift-fleet-locationconfiguration-location // Location *string `field:"required" json:"location" yaml:"location"` // Current resource capacity settings for managed EC2 fleets and container fleets. // // For multi-location fleets, location values might refer to a fleet's remote location or its home Region. // // *Returned by:* [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) // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationconfiguration.html#cfn-gamelift-fleet-locationconfiguration-locationcapacity // LocationCapacity interface{} `field:"optional" json:"locationCapacity" yaml:"locationCapacity"` }
*This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.*.
A remote location where a multi-location fleet can deploy game servers for game hosting.
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 { // A policy that puts limits on the number of game sessions that a player can create within a specified span of time. // // With this policy, you can control players' ability to consume available resources. // // The policy is evaluated when a player tries to create a new game session. On receiving a `CreateGameSession` request, Amazon GameLift checks that the player (identified by `CreatorId` ) has created fewer than game session limit in the specified time period. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html#cfn-gamelift-fleet-resourcecreationlimitpolicy-newgamesessionspercreator // NewGameSessionsPerCreator *float64 `field:"optional" json:"newGameSessionsPerCreator" yaml:"newGameSessionsPerCreator"` // The time span used in evaluating the resource creation limit policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html#cfn-gamelift-fleet-resourcecreationlimitpolicy-policyperiodinminutes // 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html#cfn-gamelift-fleet-runtimeconfiguration-gamesessionactivationtimeoutseconds // GameSessionActivationTimeoutSeconds *float64 `field:"optional" json:"gameSessionActivationTimeoutSeconds" yaml:"gameSessionActivationTimeoutSeconds"` // The number of game sessions in status `ACTIVATING` to allow on an instance or container. // // This setting limits the instance resources that can be used for new game activations at any one time. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html#cfn-gamelift-fleet-runtimeconfiguration-maxconcurrentgamesessionactivations // MaxConcurrentGameSessionActivations *float64 `field:"optional" json:"maxConcurrentGameSessionActivations" yaml:"maxConcurrentGameSessionActivations"` // A collection of server process configurations that identify what server processes to run on fleet computes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html#cfn-gamelift-fleet-runtimeconfiguration-serverprocesses // 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_ScalingPolicyProperty ¶ added in v2.109.0
type CfnFleet_ScalingPolicyProperty struct { // Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. // // For detailed descriptions of fleet metrics, see [Monitor Amazon GameLift with Amazon CloudWatch](https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html) . // // - *ActivatingGameSessions* -- Game sessions in the process of being created. // - *ActiveGameSessions* -- Game sessions that are currently running. // - *ActiveInstances* -- Fleet instances that are currently running at least one game session. // - *AvailableGameSessions* -- Additional game sessions that fleet could host simultaneously, given current capacity. // - *AvailablePlayerSessions* -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included. // - *CurrentPlayerSessions* -- Player slots in active game sessions that are being used by a player or are reserved for a player. // - *IdleInstances* -- Active instances that are currently hosting zero game sessions. // - *PercentAvailableGameSessions* -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy. // - *PercentIdleInstances* -- Percentage of the total number of active instances that are hosting zero game sessions. // - *QueueDepth* -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination. // - *WaitTime* -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-metricname // MetricName *string `field:"required" json:"metricName" yaml:"metricName"` // A descriptive label that is associated with a fleet's scaling policy. // // Policy names do not need to be unique. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-name // Name *string `field:"required" json:"name" yaml:"name"` // Comparison operator to use when measuring a metric against the threshold value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-comparisonoperator // ComparisonOperator *string `field:"optional" json:"comparisonOperator" yaml:"comparisonOperator"` // Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-evaluationperiods // EvaluationPeriods *float64 `field:"optional" json:"evaluationPeriods" yaml:"evaluationPeriods"` // The fleet location. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-location // Location *string `field:"optional" json:"location" yaml:"location"` // The type of scaling policy to create. // // For a target-based policy, set the parameter *MetricName* to 'PercentAvailableGameSessions' and specify a *TargetConfiguration* . For a rule-based policy set the following parameters: *MetricName* , *ComparisonOperator* , *Threshold* , *EvaluationPeriods* , *ScalingAdjustmentType* , and *ScalingAdjustment* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-policytype // PolicyType *string `field:"optional" json:"policyType" yaml:"policyType"` // Amount of adjustment to make, based on the scaling adjustment type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-scalingadjustment // ScalingAdjustment *float64 `field:"optional" json:"scalingAdjustment" yaml:"scalingAdjustment"` // The type of adjustment to make to a fleet's instance count. // // - *ChangeInCapacity* -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down. // - *ExactCapacity* -- set the instance count to the scaling adjustment value. // - *PercentChangeInCapacity* -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-scalingadjustmenttype // ScalingAdjustmentType *string `field:"optional" json:"scalingAdjustmentType" yaml:"scalingAdjustmentType"` // Current status of the scaling policy. // // The scaling policy can be in force only when in an `ACTIVE` status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change. // // - *ACTIVE* -- The scaling policy can be used for auto-scaling a fleet. // - *UPDATE_REQUESTED* -- A request to update the scaling policy has been received. // - *UPDATING* -- A change is being made to the scaling policy. // - *DELETE_REQUESTED* -- A request to delete the scaling policy has been received. // - *DELETING* -- The scaling policy is being deleted. // - *DELETED* -- The scaling policy has been deleted. // - *ERROR* -- An error occurred in creating the policy. It should be removed and recreated. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-status // Status *string `field:"optional" json:"status" yaml:"status"` // An object that contains settings for a target-based scaling policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-targetconfiguration // TargetConfiguration interface{} `field:"optional" json:"targetConfiguration" yaml:"targetConfiguration"` // Metric value used to trigger a scaling event. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-threshold // Threshold *float64 `field:"optional" json:"threshold" yaml:"threshold"` // The current status of the fleet's scaling policies in a requested fleet location. // // The status `PENDING_UPDATE` indicates that an update was requested for the fleet but has not yet been completed for the location. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-updatestatus // UpdateStatus *string `field:"optional" json:"updateStatus" yaml:"updateStatus"` }
Rule that controls how a fleet is scaled.
Scaling policies are uniquely identified by the combination of name and fleet ID.
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" scalingPolicyProperty := &ScalingPolicyProperty{ MetricName: jsii.String("metricName"), Name: jsii.String("name"), // the properties below are optional ComparisonOperator: jsii.String("comparisonOperator"), EvaluationPeriods: jsii.Number(123), Location: jsii.String("location"), PolicyType: jsii.String("policyType"), ScalingAdjustment: jsii.Number(123), ScalingAdjustmentType: jsii.String("scalingAdjustmentType"), Status: jsii.String("status"), TargetConfiguration: &TargetConfigurationProperty{ TargetValue: jsii.Number(123), }, Threshold: jsii.Number(123), UpdateStatus: jsii.String("updateStatus"), }
type CfnFleet_ServerProcessProperty ¶
type CfnFleet_ServerProcessProperty struct { // The number of server processes using this configuration that run concurrently on each instance or container.. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-concurrentexecutions // ConcurrentExecutions *float64 `field:"required" json:"concurrentExecutions" yaml:"concurrentExecutions"` // The location of a game build executable or Realtime script. // // 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` " // // > Amazon GameLift doesn't support the use of setup scripts that launch the game executable. For custom game builds, this parameter must indicate the executable that calls the server SDK operations `initSDK()` and `ProcessReady()` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-launchpath // LaunchPath *string `field:"required" json:"launchPath" yaml:"launchPath"` // An optional list of parameters to pass to the server executable or Realtime script on launch. // // Length Constraints: Minimum length of 1. Maximum length of 1024. // // Pattern: [A-Za-z0-9_:.+\/\\\- =@{},?'\[\]"]+ // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-parameters // 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 CfnFleet_TargetConfigurationProperty ¶ added in v2.109.0
type CfnFleet_TargetConfigurationProperty struct { // Desired value to use with a target-based scaling policy. // // The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-targetconfiguration.html#cfn-gamelift-fleet-targetconfiguration-targetvalue // TargetValue *float64 `field:"required" json:"targetValue" yaml:"targetValue"` }
Settings for a target-based scaling policy.
A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including 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" targetConfigurationProperty := &TargetConfigurationProperty{ TargetValue: jsii.Number(123), }
type CfnGameServerGroup ¶
type CfnGameServerGroup interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // 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. AutoScalingPolicy() interface{} SetAutoScalingPolicy(val interface{}) // Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. 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. DeleteOption() *string SetDeleteOption(val *string) // A developer-defined identifier for the game server group. GameServerGroupName() *string SetGameServerGroupName(val *string) // A flag that indicates whether instances in the game server group are protected from early termination. GameServerProtectionPolicy() *string SetGameServerProtectionPolicy(val *string) // The set of Amazon EC2 instance types that Amazon 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. 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. MaxSize() *float64 SetMaxSize(val *float64) // The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. 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 // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A list of labels to assign to the new game server group resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // 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{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // A list of virtual private cloud (VPC) subnets to use with instances in the game server group. 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. 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, typeHint awscdk.ResolutionTypeHint) 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) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // 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{}) }
*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"), }, }, 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"), LaunchTemplate: &LaunchTemplateProperty{ LaunchTemplateId: jsii.String("launchTemplateId"), LaunchTemplateName: jsii.String("launchTemplateName"), Version: jsii.String("version"), }, 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
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-gameservergroupname // GameServerGroupName *string `field:"required" json:"gameServerGroupName" yaml:"gameServerGroupName"` // The set of Amazon EC2 instance types that Amazon GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-instancedefinitions // InstanceDefinitions interface{} `field:"required" json:"instanceDefinitions" yaml:"instanceDefinitions"` // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-rolearn // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-autoscalingpolicy // AutoScalingPolicy interface{} `field:"optional" json:"autoScalingPolicy" yaml:"autoScalingPolicy"` // Indicates how Amazon 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-balancingstrategy // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-deleteoption // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-gameserverprotectionpolicy // GameServerProtectionPolicy *string `field:"optional" json:"gameServerProtectionPolicy" yaml:"gameServerProtectionPolicy"` // 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, Amazon GameLift FleetIQ uses your account's default VPC. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-launchtemplate // LaunchTemplate interface{} `field:"optional" json:"launchTemplate" yaml:"launchTemplate"` // The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. // // During automatic scaling events, Amazon 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-maxsize // 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, Amazon 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-minsize // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-tags // 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 Amazon 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-vpcsubnets // 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"), }, }, 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"), LaunchTemplate: &LaunchTemplateProperty{ LaunchTemplateId: jsii.String("launchTemplateId"), LaunchTemplateName: jsii.String("launchTemplateName"), Version: jsii.String("version"), }, 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-autoscalingpolicy.html#cfn-gamelift-gameservergroup-autoscalingpolicy-targettrackingconfiguration // 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 Amazon 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-autoscalingpolicy.html#cfn-gamelift-gameservergroup-autoscalingpolicy-estimatedinstancewarmup // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-instancedefinition.html#cfn-gamelift-gameservergroup-instancedefinition-instancetype // 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 Amazon 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". // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-instancedefinition.html#cfn-gamelift-gameservergroup-instancedefinition-weightedcapacity // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-launchtemplate.html#cfn-gamelift-gameservergroup-launchtemplate-launchtemplateid // LaunchTemplateId *string `field:"optional" json:"launchTemplateId" yaml:"launchTemplateId"` // A readable identifier for an existing Amazon EC2 launch template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-launchtemplate.html#cfn-gamelift-gameservergroup-launchtemplate-launchtemplatename // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-launchtemplate.html#cfn-gamelift-gameservergroup-launchtemplate-version // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-targettrackingconfiguration.html#cfn-gamelift-gameservergroup-targettrackingconfiguration-targetvalue // 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 awscdk.ITaggable // 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() interface{} SetDestinations(val interface{}) // A list of locations where a queue is allowed to place new game sessions. 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. 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. NotificationTarget() *string SetNotificationTarget(val *string) // A set of policies that act as a sliding cap on player latency. PlayerLatencyPolicies() interface{} SetPlayerLatencyPolicies(val interface{}) // Custom settings to use when prioritizing destinations and locations for game session placements. 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 // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A list of labels to assign to the new game session queue resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // The maximum time, in seconds, that a new game session placement request remains in the queue. TimeoutInSeconds() *float64 SetTimeoutInSeconds(val *float64) // Deprecated. // Deprecated: use `updatedProperties` // // 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{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. 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, typeHint awscdk.ResolutionTypeHint) 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) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // 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{}) }
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
type CfnGameSessionQueueProps ¶
type CfnGameSessionQueueProps struct { // A descriptive label that is associated with game session queue. // // Queue names must be unique within each Region. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-name // Name *string `field:"required" json:"name" yaml:"name"` // Information to be added to all events that are related to this game session queue. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-customeventdata // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-destinations // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-filterconfiguration // 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-notificationtarget // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-playerlatencypolicies // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-priorityconfiguration // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-tags // 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. By default, this property is set to `600` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-timeoutinseconds // 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 { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-destination.html#cfn-gamelift-gamesessionqueue-destination-destinationarn // DestinationArn *string `field:"optional" json:"destinationArn" yaml:"destinationArn"` }
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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-filterconfiguration.html#cfn-gamelift-gamesessionqueue-filterconfiguration-allowedlocations // 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_GameSessionQueueDestinationProperty ¶ added in v2.110.0
type CfnGameSessionQueue_GameSessionQueueDestinationProperty 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-gamesessionqueuedestination.html#cfn-gamelift-gamesessionqueue-gamesessionqueuedestination-destinationarn // 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" gameSessionQueueDestinationProperty := &GameSessionQueueDestinationProperty{ DestinationArn: jsii.String("destinationArn"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-playerlatencypolicy.html#cfn-gamelift-gamesessionqueue-playerlatencypolicy-maximumindividualplayerlatencymilliseconds // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-playerlatencypolicy.html#cfn-gamelift-gamesessionqueue-playerlatencypolicy-policydurationseconds // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-priorityconfiguration.html#cfn-gamelift-gamesessionqueue-priorityconfiguration-locationorder // 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-priorityconfiguration.html#cfn-gamelift-gamesessionqueue-priorityconfiguration-priorityorder // 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 CfnLocation ¶ added in v2.55.0
type CfnLocation interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // A unique identifier for the custom location. // // For example, `arn:aws:gamelift:[region]::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912` . AttrLocationArn() *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 descriptive name for the custom location. LocationName() *string SetLocationName(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 // 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 // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A list of labels to assign to the new resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // 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{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. 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, typeHint awscdk.ResolutionTypeHint) 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) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // 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{}) }
The AWS::GameLift::Location resource creates a custom location for use in an Anywhere fleet.
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" cfnLocation := awscdk.Aws_gamelift.NewCfnLocation(this, jsii.String("MyCfnLocation"), &CfnLocationProps{ LocationName: jsii.String("locationName"), // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html
func NewCfnLocation ¶ added in v2.55.0
func NewCfnLocation(scope constructs.Construct, id *string, props *CfnLocationProps) CfnLocation
type CfnLocationProps ¶ added in v2.55.0
type CfnLocationProps struct { // A descriptive name for the custom location. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html#cfn-gamelift-location-locationname // LocationName *string `field:"required" json:"locationName" yaml:"locationName"` // A list of labels to assign to the new 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 Rareference* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html#cfn-gamelift-location-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnLocation`.
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" cfnLocationProps := &CfnLocationProps{ LocationName: jsii.String("locationName"), // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html
type CfnMatchmakingConfiguration ¶
type CfnMatchmakingConfiguration interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // A flag that determines whether a match that was created with this configuration must be accepted by the matched players. 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. 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. 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 // A time stamp indicating when this data object was created. CreationTime() *string SetCreationTime(val *string) // Information to add to all events related to the matchmaking configuration. CustomEventData() *string SetCustomEventData(val *string) // A description for the matchmaking configuration. Description() *string SetDescription(val *string) // Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution. FlexMatchMode() *string SetFlexMatchMode(val *string) // A set of custom properties for a game session, formatted as key-value pairs. GameProperties() interface{} SetGameProperties(val interface{}) // A set of custom game session properties, formatted as a single string value. 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 Amazon 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 Amazon 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. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // An SNS topic ARN that is set up to receive matchmaking notifications. 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. RequestTimeoutSeconds() *float64 SetRequestTimeoutSeconds(val *float64) // The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) associated with the GameLift matchmaking rule set resource that this configuration uses. RuleSetArn() *string SetRuleSetArn(val *string) // A unique identifier for the matchmaking rule set to use with this configuration. 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 // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A list of labels to assign to the new matchmaking configuration resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // 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{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. 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, typeHint awscdk.ResolutionTypeHint) 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) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // 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{}) }
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"), CreationTime: jsii.String("creationTime"), 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"), RuleSetArn: jsii.String("ruleSetArn"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnMatchmakingConfiguration ¶
func NewCfnMatchmakingConfiguration(scope constructs.Construct, id *string, props *CfnMatchmakingConfigurationProps) CfnMatchmakingConfiguration
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-acceptancerequired // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-name // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-requesttimeoutseconds // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-rulesetname // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-acceptancetimeoutseconds // 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 10-person team, and the additional player count is set to 2, 10 players will be selected for the match and 2 more player slots will be open for future players. This parameter is not used if `FlexMatchMode` is set to `STANDALONE` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-additionalplayercount // 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-backfillmode // BackfillMode *string `field:"optional" json:"backfillMode" yaml:"backfillMode"` // A time stamp indicating when this data object was created. // // Format is a number expressed in Unix time as milliseconds (for example `"1469498468.057"` ). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-creationtime // CreationTime *string `field:"optional" json:"creationTime" yaml:"creationTime"` // Information to add to all events related to the matchmaking configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-customeventdata // CustomEventData *string `field:"optional" json:"customEventData" yaml:"customEventData"` // A description for the matchmaking configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-description // Description *string `field:"optional" json:"description" yaml:"description"` // Indicates whether this matchmaking configuration is being used with Amazon 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 Amazon GameLift queue to start a game session for the match. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-flexmatchmode // 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-gameproperties // 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-gamesessiondata // 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 Amazon 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 Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If `FlexMatchMode` is set to `STANDALONE` , do not set this parameter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-gamesessionqueuearns // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-notificationtarget // NotificationTarget *string `field:"optional" json:"notificationTarget" yaml:"notificationTarget"` // The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) associated with the GameLift matchmaking rule set resource that this configuration uses. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-rulesetarn // RuleSetArn *string `field:"optional" json:"ruleSetArn" yaml:"ruleSetArn"` // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-tags // 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"), CreationTime: jsii.String("creationTime"), 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"), RuleSetArn: jsii.String("ruleSetArn"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnMatchmakingConfiguration_GamePropertyProperty ¶
type CfnMatchmakingConfiguration_GamePropertyProperty struct { // The game property identifier. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-matchmakingconfiguration-gameproperty.html#cfn-gamelift-matchmakingconfiguration-gameproperty-key // Key *string `field:"required" json:"key" yaml:"key"` // The game property value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-matchmakingconfiguration-gameproperty.html#cfn-gamelift-matchmakingconfiguration-gameproperty-value // Value *string `field:"required" json:"value" yaml:"value"` }
This key-value pair can store custom data about a game session.
For example, you might use a `GameProperty` to track a game session's map, level of difficulty, or remaining time. The difficulty level could be specified like this: `{"Key": "difficulty", "Value":"Novice"}` .
You can set game properties when creating a game session. You can also modify game properties of an active game session. When searching for game sessions, you can filter on game property keys and values. You can't delete game properties from a game session.
For examples of working with game properties, see [Create a game session with properties](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties) .
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 awscdk.ITaggable // The unique Amazon Resource Name (ARN) assigned to the rule set. AttrArn() *string // A time stamp indicating when this data object was created. // // Format is a number expressed in Unix time as milliseconds (for example `"1469498468.057"` ). AttrCreationTime() *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. 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. 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 // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A list of labels to assign to the new matchmaking rule set resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // 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{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. 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, typeHint awscdk.ResolutionTypeHint) 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) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // 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{}) }
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
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#cfn-gamelift-matchmakingruleset-name // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#cfn-gamelift-matchmakingruleset-rulesetbody // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#cfn-gamelift-matchmakingruleset-tags // 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 awscdk.ITaggable // The unique Amazon Resource Name (ARN) for the script. AttrArn() *string // A time stamp indicating when this data object was created. // // Format is a number expressed in Unix time as milliseconds (for example `"1469498468.057"` ). AttrCreationTime() *string // A unique identifier for a Realtime script. AttrId() *string // The file size of the uploaded Realtime script, expressed in bytes. // // When files are uploaded from an S3 location, this value remains at "0". AttrSizeOnDisk() *float64 // 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. 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. StorageLocation() interface{} SetStorageLocation(val interface{}) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A list of labels to assign to the new script resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // 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{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The version that is associated with a build or script. 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. 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, typeHint awscdk.ResolutionTypeHint) 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) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // 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{}) }
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"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html
func NewCfnScript ¶
func NewCfnScript(scope constructs.Construct, id *string, props *CfnScriptProps) CfnScript
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-storagelocation // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-name // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-tags // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-version // 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"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html
type CfnScript_S3LocationProperty ¶
type CfnScript_S3LocationProperty struct { // An Amazon S3 bucket identifier. Thename of the S3 bucket. // // > Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-bucket // Bucket *string `field:"required" json:"bucket" yaml:"bucket"` // The name of the zip file that contains the build files or script files. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-key // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-rolearn // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-objectversion // 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"), }
Source Files ¶
- CfnAlias.go
- CfnAliasProps.go
- CfnAlias_RoutingStrategyProperty.go
- CfnAlias__checks.go
- CfnBuild.go
- CfnBuildProps.go
- CfnBuild_StorageLocationProperty.go
- CfnBuild__checks.go
- CfnContainerGroupDefinition.go
- CfnContainerGroupDefinitionProps.go
- CfnContainerGroupDefinition_ContainerDefinitionProperty.go
- CfnContainerGroupDefinition_ContainerDependencyProperty.go
- CfnContainerGroupDefinition_ContainerEnvironmentProperty.go
- CfnContainerGroupDefinition_ContainerHealthCheckProperty.go
- CfnContainerGroupDefinition_ContainerPortRangeProperty.go
- CfnContainerGroupDefinition_MemoryLimitsProperty.go
- CfnContainerGroupDefinition_PortConfigurationProperty.go
- CfnContainerGroupDefinition__checks.go
- CfnFleet.go
- CfnFleetProps.go
- CfnFleet_AnywhereConfigurationProperty.go
- CfnFleet_CertificateConfigurationProperty.go
- CfnFleet_ConnectionPortRangeProperty.go
- CfnFleet_ContainerGroupsConfigurationProperty.go
- CfnFleet_ContainerGroupsPerInstanceProperty.go
- CfnFleet_IpPermissionProperty.go
- CfnFleet_LocationCapacityProperty.go
- CfnFleet_LocationConfigurationProperty.go
- CfnFleet_ResourceCreationLimitPolicyProperty.go
- CfnFleet_RuntimeConfigurationProperty.go
- CfnFleet_ScalingPolicyProperty.go
- CfnFleet_ServerProcessProperty.go
- CfnFleet_TargetConfigurationProperty.go
- CfnFleet__checks.go
- CfnGameServerGroup.go
- CfnGameServerGroupProps.go
- CfnGameServerGroup_AutoScalingPolicyProperty.go
- CfnGameServerGroup_InstanceDefinitionProperty.go
- CfnGameServerGroup_LaunchTemplateProperty.go
- CfnGameServerGroup_TargetTrackingConfigurationProperty.go
- CfnGameServerGroup__checks.go
- CfnGameSessionQueue.go
- CfnGameSessionQueueProps.go
- CfnGameSessionQueue_DestinationProperty.go
- CfnGameSessionQueue_FilterConfigurationProperty.go
- CfnGameSessionQueue_GameSessionQueueDestinationProperty.go
- CfnGameSessionQueue_PlayerLatencyPolicyProperty.go
- CfnGameSessionQueue_PriorityConfigurationProperty.go
- CfnGameSessionQueue__checks.go
- CfnLocation.go
- CfnLocationProps.go
- CfnLocation__checks.go
- CfnMatchmakingConfiguration.go
- CfnMatchmakingConfigurationProps.go
- CfnMatchmakingConfiguration_GamePropertyProperty.go
- CfnMatchmakingConfiguration__checks.go
- CfnMatchmakingRuleSet.go
- CfnMatchmakingRuleSetProps.go
- CfnMatchmakingRuleSet__checks.go
- CfnScript.go
- CfnScriptProps.go
- CfnScript_S3LocationProperty.go
- CfnScript__checks.go
- main.go