Class: AWSCDK::APIGateway::APIDefinitionS3Location

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
api_gateway/api_definition_s3_location.rb

Overview

S3 location of the API definition file.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket:, key:, version: nil) ⇒ APIDefinitionS3Location

Returns a new instance of APIDefinitionS3Location.

Parameters:

  • bucket (String) —

    The S3 bucket.

  • key (String) —

    The S3 key.

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

    An optional version.



10
11
12
13
14
15
16
17
 
# File 'api_gateway/api_definition_s3_location.rb', line 10

def initialize(bucket:, key:, 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")
  @version = version
  Jsii::Type.check_type(@version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "version") unless @version.nil?
end

Instance Attribute Details

#bucket ⇒ String (readonly)

The S3 bucket.

Returns:

  • (String) 


22
23
24
 
# File 'api_gateway/api_definition_s3_location.rb', line 22

def bucket
  @bucket
end

#key ⇒ String (readonly)

The S3 key.

Returns:

  • (String) 


26
27
28
 
# File 'api_gateway/api_definition_s3_location.rb', line 26

def key
  @key
end

#version ⇒ String? (readonly)

Note:

Default: - latest version

An optional version.

Returns:

  • (String, nil) 


31
32
33
 
# File 'api_gateway/api_definition_s3_location.rb', line 31

def version
  @version
end

Class Method Details

.jsii_properties ⇒ Object 



33
34
35
36
37
38
39
 
# File 'api_gateway/api_definition_s3_location.rb', line 33

def self.jsii_properties
  {
    :bucket => "bucket",
    :key => "key",
    :version => "version",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



41
42
43
44
45
46
47
48
49
 
# File 'api_gateway/api_definition_s3_location.rb', line 41

def to_jsii
  result = {}
  result.merge!({
    "bucket" => @bucket,
    "key" => @key,
    "version" => @version,
  })
  result.compact
end