Class: AWSCDK::APIGateway::CfnDocumentationVersionProps

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

Overview

Properties for defining a CfnDocumentationVersion.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(documentation_version:, rest_api_id:, description: nil) ⇒ CfnDocumentationVersionProps

Returns a new instance of CfnDocumentationVersionProps.

Parameters:

  • documentation_version (String) —

    The version identifier of the to-be-updated documentation version.

  • rest_api_id (String, AWSCDK::Interfaces::AWSApigateway::IRestAPIRef) —

    The string identifier of the associated RestApi.

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

    A description about the new documentation snapshot.



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

def initialize(documentation_version:, rest_api_id:, description: nil)
  @documentation_version = documentation_version
  Jsii::Type.check_type(@documentation_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "documentationVersion")
  @rest_api_id = rest_api_id
  Jsii::Type.check_type(@rest_api_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcGlnYXRld2F5LklSZXN0QXBpUmVmIn1dfX0=")), "restApiId")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

A description about the new documentation snapshot.

Returns:

  • (String, nil)

See Also:



35
36
37
 
# File 'api_gateway/cfn_documentation_version_props.rb', line 35

def description
  @description
end

#documentation_version ⇒ String (readonly)

The version identifier of the to-be-updated documentation version.

Returns:

  • (String)

See Also:



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

def documentation_version
  @documentation_version
end

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

The string identifier of the associated RestApi.

Returns:

See Also:



30
31
32
 
# File 'api_gateway/cfn_documentation_version_props.rb', line 30

def rest_api_id
  @rest_api_id
end

Class Method Details

.jsii_properties ⇒ Object 



37
38
39
40
41
42
43
 
# File 'api_gateway/cfn_documentation_version_props.rb', line 37

def self.jsii_properties
  {
    :documentation_version => "documentationVersion",
    :rest_api_id => "restApiId",
    :description => "description",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



45
46
47
48
49
50
51
52
53
 
# File 'api_gateway/cfn_documentation_version_props.rb', line 45

def to_jsii
  result = {}
  result.merge!({
    "documentationVersion" => @documentation_version,
    "restApiId" => @rest_api_id,
    "description" => @description,
  })
  result.compact
end