Class: AWSCDK::GameLift::CfnBuildProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
game_lift/cfn_build_props.rb

Overview

Properties for defining a CfnBuild.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name: nil, operating_system: nil, server_sdk_version: nil, storage_location: nil, tags: nil, version: nil) ⇒ CfnBuildProps

Returns a new instance of CfnBuildProps.

Parameters:

  • name (String, nil) (defaults to: nil) —

    A descriptive label that is associated with a build.

  • operating_system (String, nil) (defaults to: nil) —

    The operating system that your game server binaries run on.

  • server_sdk_version (String, nil) (defaults to: nil) —

    A server SDK version you used when integrating your game server build with Amazon GameLift Servers.

  • storage_location (AWSCDK::IResolvable, AWSCDK::GameLift::CfnBuild::StorageLocationProperty, nil) (defaults to: nil) —

    Information indicating where your game build files are stored.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    An array of key-value pairs to apply to this resource.

  • version (String, nil) (defaults to: nil) —

    Version information that is associated with this build.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'game_lift/cfn_build_props.rb', line 15

def initialize(name: nil, operating_system: nil, server_sdk_version: nil, storage_location: nil, tags: nil, version: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @operating_system = operating_system
  Jsii::Type.check_type(@operating_system, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "operatingSystem") unless @operating_system.nil?
  @server_sdk_version = server_sdk_version
  Jsii::Type.check_type(@server_sdk_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serverSdkVersion") unless @server_sdk_version.nil?
  @storage_location = storage_location.is_a?(Hash) ? ::AWSCDK::GameLift::CfnBuild::StorageLocationProperty.new(**storage_location.transform_keys(&:to_sym)) : storage_location
  Jsii::Type.check_type(@storage_location, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nYW1lbGlmdC5DZm5CdWlsZC5TdG9yYWdlTG9jYXRpb25Qcm9wZXJ0eSJ9XX19")), "storageLocation") unless @storage_location.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @version = version
  Jsii::Type.check_type(@version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "version") unless @version.nil?
end

Instance Attribute Details

#name ⇒ String? (readonly)

A descriptive label that is associated with a build.

Build names do not need to be unique.

Returns:

  • (String, nil)

See Also:



36
37
38
 
# File 'game_lift/cfn_build_props.rb', line 36

def name
  @name
end

#operating_system ⇒ String? (readonly)

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 . For game servers that are hosted on AL2 and use server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to server SDK version 5.

Returns:

  • (String, nil)

See Also:



45
46
47
 
# File 'game_lift/cfn_build_props.rb', line 45

def operating_system
  @operating_system
end

#server_sdk_version ⇒ String? (readonly)

A server SDK version you used when integrating your game server build with Amazon GameLift Servers.

For more information see Integrate games with custom game servers . By default Amazon GameLift Servers sets this value to 4.0.2 .

Returns:

  • (String, nil)

See Also:



52
53
54
 
# File 'game_lift/cfn_build_props.rb', line 52

def server_sdk_version
  @server_sdk_version
end

#storage_location ⇒ AWSCDK::IResolvable, ... (readonly)

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 Servers 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 Servers will report a SizeOnDisk of 0.

Returns:

See Also:



61
62
63
 
# File 'game_lift/cfn_build_props.rb', line 61

def storage_location
  @storage_location
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An array of key-value pairs to apply to this resource.

Returns:

See Also:



66
67
68
 
# File 'game_lift/cfn_build_props.rb', line 66

def tags
  @tags
end

#version ⇒ String? (readonly)

Version information that is associated with this build.

Version strings do not need to be unique.

Returns:

  • (String, nil)

See Also:



73
74
75
 
# File 'game_lift/cfn_build_props.rb', line 73

def version
  @version
end

Class Method Details

.jsii_properties ⇒ Object 



75
76
77
78
79
80
81
82
83
84
 
# File 'game_lift/cfn_build_props.rb', line 75

def self.jsii_properties
  {
    :name => "name",
    :operating_system => "operatingSystem",
    :server_sdk_version => "serverSdkVersion",
    :storage_location => "storageLocation",
    :tags => "tags",
    :version => "version",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'game_lift/cfn_build_props.rb', line 86

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "operatingSystem" => @operating_system,
    "serverSdkVersion" => @server_sdk_version,
    "storageLocation" => @storage_location,
    "tags" => @tags,
    "version" => @version,
  })
  result.compact
end