Class: AWSCDK::APIGatewayv2::CfnAPI::BodyS3LocationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
api_gatewayv2/cfn_api.rb

Overview

The BodyS3Location property specifies an S3 location from which to import an OpenAPI definition.

Supported only for HTTP APIs.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket: nil, etag: nil, key: nil, version: nil) ⇒ BodyS3LocationProperty

Returns a new instance of BodyS3LocationProperty.

Parameters:

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

    The S3 bucket that contains the OpenAPI definition to import.

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

    The Etag of the S3 object.

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

    The key of the S3 object.

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

    The version of the S3 object.



769
770
771
772
773
774
775
776
777
778
 
# File 'api_gatewayv2/cfn_api.rb', line 769

def initialize(bucket: nil, etag: nil, key: nil, version: nil)
  @bucket = bucket
  Jsii::Type.check_type(@bucket, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucket") unless @bucket.nil?
  @etag = etag
  Jsii::Type.check_type(@etag, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "etag") unless @etag.nil?
  @key = key
  Jsii::Type.check_type(@key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key") unless @key.nil?
  @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 that contains the OpenAPI definition to import.

Required if you specify a BodyS3Location for an API.

Returns:

  • (String, nil)

See Also:



786
787
788
 
# File 'api_gatewayv2/cfn_api.rb', line 786

def bucket
  @bucket
end

#etag ⇒ String? (readonly)

The Etag of the S3 object.

Returns:

  • (String, nil)

See Also:



791
792
793
 
# File 'api_gatewayv2/cfn_api.rb', line 791

def etag
  @etag
end

#key ⇒ String? (readonly)

The key of the S3 object.

Required if you specify a BodyS3Location for an API.

Returns:

  • (String, nil)

See Also:



798
799
800
 
# File 'api_gatewayv2/cfn_api.rb', line 798

def key
  @key
end

#version ⇒ String? (readonly)

The version of the S3 object.

Returns:

  • (String, nil)

See Also:



803
804
805
 
# File 'api_gatewayv2/cfn_api.rb', line 803

def version
  @version
end

Class Method Details

.jsii_properties ⇒ Object 



805
806
807
808
809
810
811
812
 
# File 'api_gatewayv2/cfn_api.rb', line 805

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

Instance Method Details

#to_jsii ⇒ Object 



814
815
816
817
818
819
820
821
822
823
 
# File 'api_gatewayv2/cfn_api.rb', line 814

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