Class: AWSCDK::APIGatewayv2::CfnRoutingRuleProps

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

Overview

Properties for defining a CfnRoutingRule.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(actions:, conditions:, domain_name_arn:, priority:) ⇒ CfnRoutingRuleProps

Returns a new instance of CfnRoutingRuleProps.

Parameters:



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

def initialize(actions:, conditions:, domain_name_arn:, priority:)
  @actions = actions
  Jsii::Type.check_type(@actions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLkNmblJvdXRpbmdSdWxlLkFjdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "actions")
  @conditions = conditions
  Jsii::Type.check_type(@conditions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLkNmblJvdXRpbmdSdWxlLkNvbmRpdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "conditions")
  @domain_name_arn = domain_name_arn
  Jsii::Type.check_type(@domain_name_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainNameArn")
  @priority = priority
  Jsii::Type.check_type(@priority, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "priority")
end

Instance Attribute Details

#actions ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::APIGatewayv2::CfnRoutingRule::ActionProperty> (readonly)

The resulting action based on matching a routing rules condition.

Only InvokeApi is supported.

Returns:

See Also:



30
31
32
 
# File 'api_gatewayv2/cfn_routing_rule_props.rb', line 30

def actions
  @actions
end

#conditions ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::APIGatewayv2::CfnRoutingRule::ConditionProperty> (readonly)

The conditions of the routing rule.

Returns:

See Also:



35
36
37
 
# File 'api_gatewayv2/cfn_routing_rule_props.rb', line 35

def conditions
  @conditions
end

#domain_name_arn ⇒ String (readonly)

The ARN of the domain name.

Returns:

  • (String)

See Also:



40
41
42
 
# File 'api_gatewayv2/cfn_routing_rule_props.rb', line 40

def domain_name_arn
  @domain_name_arn
end

#priority ⇒ Numeric (readonly)

The order in which API Gateway evaluates a rule.

Priority is evaluated from the lowest value to the highest value. Rules can't have the same priority. Priority values 1-1,000,000 are supported.

Returns:

  • (Numeric)

See Also:



47
48
49
 
# File 'api_gatewayv2/cfn_routing_rule_props.rb', line 47

def priority
  @priority
end

Class Method Details

.jsii_properties ⇒ Object 



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

def self.jsii_properties
  {
    :actions => "actions",
    :conditions => "conditions",
    :domain_name_arn => "domainNameArn",
    :priority => "priority",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "actions" => @actions,
    "conditions" => @conditions,
    "domainNameArn" => @domain_name_arn,
    "priority" => @priority,
  })
  result.compact
end