Class: AWSCDK::GameLift::CfnBuild::StorageLocationProperty

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

Overview

The location in Amazon S3 where build or script files are stored for access by Amazon GameLift.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket:, key:, role_arn:, object_version: nil) ⇒ StorageLocationProperty

Returns a new instance of StorageLocationProperty.

Parameters:

  • bucket (String) —

    An Amazon S3 bucket identifier. The name of the S3 bucket.

  • key (String) —

    The name of the zip file that contains the build files or script files.

  • role_arn (String) —

    The ARNfor an IAM role that allows Amazon GameLift to access the S3 bucket.

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

    A version of a stored file to retrieve, if the object versioning feature is turned on for the S3 bucket.



622
623
624
625
626
627
628
629
630
631
 
# File 'game_lift/cfn_build.rb', line 622

def initialize(bucket:, key:, role_arn:, object_version: nil)
  @bucket = bucket
  Jsii::Type.check_type(@bucket, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucket")
  @key = key
  Jsii::Type.check_type(@key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @object_version = object_version
  Jsii::Type.check_type(@object_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "objectVersion") unless @object_version.nil?
end

Instance Attribute Details

#bucket ⇒ String (readonly)

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 (.).

Returns:

  • (String)

See Also:



639
640
641
 
# File 'game_lift/cfn_build.rb', line 639

def bucket
  @bucket
end

#key ⇒ String (readonly)

The name of the zip file that contains the build files or script files.

Returns:

  • (String)

See Also:



644
645
646
 
# File 'game_lift/cfn_build.rb', line 644

def key
  @key
end

#object_version ⇒ String? (readonly)

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 Servers retrieves the latest version of the file.

Returns:

  • (String, nil)

See Also:



656
657
658
 
# File 'game_lift/cfn_build.rb', line 656

def object_version
  @object_version
end

#role_arn ⇒ String (readonly)

The ARNfor an IAM role that allows Amazon GameLift to access the S3 bucket.

Returns:

  • (String)

See Also:



649
650
651
 
# File 'game_lift/cfn_build.rb', line 649

def role_arn
  @role_arn
end

Class Method Details

.jsii_properties ⇒ Object 



658
659
660
661
662
663
664
665
 
# File 'game_lift/cfn_build.rb', line 658

def self.jsii_properties
  {
    :bucket => "bucket",
    :key => "key",
    :role_arn => "roleArn",
    :object_version => "objectVersion",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



667
668
669
670
671
672
673
674
675
676
 
# File 'game_lift/cfn_build.rb', line 667

def to_jsii
  result = {}
  result.merge!({
    "bucket" => @bucket,
    "key" => @key,
    "roleArn" => @role_arn,
    "objectVersion" => @object_version,
  })
  result.compact
end