Class: AWSCDK::APIGateway::CfnDocumentationPartProps

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

Overview

Properties for defining a CfnDocumentationPart.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(location:, properties:, rest_api_id:) ⇒ CfnDocumentationPartProps

Returns a new instance of CfnDocumentationPartProps.

Parameters:



12
13
14
15
16
17
18
19
 
# File 'api_gateway/cfn_documentation_part_props.rb', line 12

def initialize(location:, properties:, rest_api_id:)
  @location = location.is_a?(Hash) ? ::AWSCDK::APIGateway::CfnDocumentationPart::LocationProperty.new(**location.transform_keys(&:to_sym)) : location
  Jsii::Type.check_type(@location, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcGlnYXRld2F5LkNmbkRvY3VtZW50YXRpb25QYXJ0LkxvY2F0aW9uUHJvcGVydHkifV19fQ==")), "location")
  @properties = properties
  Jsii::Type.check_type(@properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "properties")
  @rest_api_id = rest_api_id
  Jsii::Type.check_type(@rest_api_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcGlnYXRld2F5LklSZXN0QXBpUmVmIn1dfX0=")), "restApiId")
end

Instance Attribute Details

#location ⇒ AWSCDK::IResolvable, AWSCDK::APIGateway::CfnDocumentationPart::LocationProperty (readonly)

The location of the targeted API entity of the to-be-created documentation part.

Returns:

See Also:



25
26
27
 
# File 'api_gateway/cfn_documentation_part_props.rb', line 25

def location
  @location
end

#properties ⇒ String (readonly)

The new documentation content map of the targeted API entity.

Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

Returns:

  • (String)

See Also:



32
33
34
 
# File 'api_gateway/cfn_documentation_part_props.rb', line 32

def properties
  @properties
end

#rest_api_id ⇒ String, AWSCDK::Interfaces::AWSApigateway::IRestAPIRef (readonly)

The string identifier of the associated RestApi.

Returns:

See Also:



37
38
39
 
# File 'api_gateway/cfn_documentation_part_props.rb', line 37

def rest_api_id
  @rest_api_id
end

Class Method Details

.jsii_properties ⇒ Object 



39
40
41
42
43
44
45
 
# File 'api_gateway/cfn_documentation_part_props.rb', line 39

def self.jsii_properties
  {
    :location => "location",
    :properties => "properties",
    :rest_api_id => "restApiId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



47
48
49
50
51
52
53
54
55
 
# File 'api_gateway/cfn_documentation_part_props.rb', line 47

def to_jsii
  result = {}
  result.merge!({
    "location" => @location,
    "properties" => @properties,
    "restApiId" => @rest_api_id,
  })
  result.compact
end