Class: AWSCDK::APIGateway::CfnBasePathMappingV2Props

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

Overview

Properties for defining a CfnBasePathMappingV2.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(domain_name_arn:, rest_api_id:, base_path: nil, stage: nil) ⇒ CfnBasePathMappingV2Props

Returns a new instance of CfnBasePathMappingV2Props.

Parameters:

  • domain_name_arn (String) —

    The ARN of the domain name for the BasePathMappingV2 resource to be described.

  • rest_api_id (String) —

    The private API's identifier.

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

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

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

    Represents a unique identifier for a version of a deployed private RestApi that is callable by users.



13
14
15
16
17
18
19
20
21
22
 
# File 'api_gateway/cfn_base_path_mapping_v2_props.rb', line 13

def initialize(domain_name_arn:, rest_api_id:, base_path: nil, stage: nil)
  @domain_name_arn = domain_name_arn
  Jsii::Type.check_type(@domain_name_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainNameArn")
  @rest_api_id = rest_api_id
  Jsii::Type.check_type(@rest_api_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "restApiId")
  @base_path = base_path
  Jsii::Type.check_type(@base_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "basePath") unless @base_path.nil?
  @stage = stage
  Jsii::Type.check_type(@stage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stage") unless @stage.nil?
end

Instance Attribute Details

#base_path ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



40
41
42
 
# File 'api_gateway/cfn_base_path_mapping_v2_props.rb', line 40

def base_path
  @base_path
end

#domain_name_arn ⇒ String (readonly)

The ARN of the domain name for the BasePathMappingV2 resource to be described.

Returns:

  • (String)

See Also:



28
29
30
 
# File 'api_gateway/cfn_base_path_mapping_v2_props.rb', line 28

def domain_name_arn
  @domain_name_arn
end

#rest_api_id ⇒ String (readonly)

The private API's identifier.

This identifier is unique across all of your APIs in API Gateway.

Returns:

  • (String)

See Also:



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

def rest_api_id
  @rest_api_id
end

#stage ⇒ String? (readonly)

Represents a unique identifier for a version of a deployed private RestApi that is callable by users.

The Stage must depend on the RestApi 's stage. To create a dependency, add a DependsOn attribute to the BasePathMappingV2 resource.

Returns:

  • (String, nil)

See Also:



47
48
49
 
# File 'api_gateway/cfn_base_path_mapping_v2_props.rb', line 47

def stage
  @stage
end

Class Method Details

.jsii_properties ⇒ Object 



49
50
51
52
53
54
55
56
 
# File 'api_gateway/cfn_base_path_mapping_v2_props.rb', line 49

def self.jsii_properties
  {
    :domain_name_arn => "domainNameArn",
    :rest_api_id => "restApiId",
    :base_path => "basePath",
    :stage => "stage",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



58
59
60
61
62
63
64
65
66
67
 
# File 'api_gateway/cfn_base_path_mapping_v2_props.rb', line 58

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