Class: AWSCDK::APIGateway::CfnBasePathMappingProps

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

Overview

Properties for defining a CfnBasePathMapping.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(domain_name:, base_path: nil, id: nil, rest_api_id: nil, stage: nil) ⇒ CfnBasePathMappingProps

Returns a new instance of CfnBasePathMappingProps.

Parameters:



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'api_gateway/cfn_base_path_mapping_props.rb', line 14

def initialize(domain_name:, base_path: nil, id: nil, rest_api_id: nil, stage: nil)
  @domain_name = domain_name
  Jsii::Type.check_type(@domain_name, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcGlnYXRld2F5LklEb21haW5OYW1lUmVmIn1dfX0=")), "domainName")
  @base_path = base_path
  Jsii::Type.check_type(@base_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "basePath") unless @base_path.nil?
  @id = id
  Jsii::Type.check_type(@id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id") unless @id.nil?
  @rest_api_id = rest_api_id
  Jsii::Type.check_type(@rest_api_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcGlnYXRld2F5LklSZXN0QXBpUmVmIn1dfX0=")), "restApiId") unless @rest_api_id.nil?
  @stage = stage
  Jsii::Type.check_type(@stage, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcGlnYXRld2F5LklTdGFnZVJlZiJ9XX19")), "stage") unless @stage.nil?
end

Instance Attribute Details

#base_path ⇒ String? (readonly)

The base path name that callers of the API must provide as part of the URL after the domain name.

Returns:

  • (String, nil)

See Also:



36
37
38
 
# File 'api_gateway/cfn_base_path_mapping_props.rb', line 36

def base_path
  @base_path
end

#domain_name ⇒ String, AWSCDK::Interfaces::AWSApigateway::IDomainNameRef (readonly)

The domain name of the BasePathMapping resource to be described.

Returns:

See Also:



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

def domain_name
  @domain_name
end

#id ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



39
40
41
 
# File 'api_gateway/cfn_base_path_mapping_props.rb', line 39

def id
  @id
end

#rest_api_id ⇒ String, ... (readonly)

The string identifier of the associated RestApi.

Returns:

See Also:



44
45
46
 
# File 'api_gateway/cfn_base_path_mapping_props.rb', line 44

def rest_api_id
  @rest_api_id
end

#stage ⇒ String, ... (readonly)

The name of the associated stage.

Returns:

See Also:



49
50
51
 
# File 'api_gateway/cfn_base_path_mapping_props.rb', line 49

def stage
  @stage
end

Class Method Details

.jsii_properties ⇒ Object 



51
52
53
54
55
56
57
58
59
 
# File 'api_gateway/cfn_base_path_mapping_props.rb', line 51

def self.jsii_properties
  {
    :domain_name => "domainName",
    :base_path => "basePath",
    :id => "id",
    :rest_api_id => "restApiId",
    :stage => "stage",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
 
# File 'api_gateway/cfn_base_path_mapping_props.rb', line 61

def to_jsii
  result = {}
  result.merge!({
    "domainName" => @domain_name,
    "basePath" => @base_path,
    "id" => @id,
    "restApiId" => @rest_api_id,
    "stage" => @stage,
  })
  result.compact
end