-
Notifications
You must be signed in to change notification settings - Fork 17
/
CfnFleetProps.go
308 lines (305 loc) · 21.1 KB
/
CfnFleetProps.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
package awsgamelift
// 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 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 part of the fleet.
//
// This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any Amazon GameLift-supported AWS Region as a remote location, in the form of an AWS Region code, such as `us-west-2` or Local Zone code. To create a fleet with instances in the home Region only, don't set this parameter.
//
// When using this parameter, Amazon GameLift requires you to include your home location in the request.
// 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"`
}