Class: AWSCDK::APIGatewayv2::CfnAPIGatewayManagedOverrides::RouteOverridesProperty

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

Overview

The RouteOverrides property overrides the route configuration for an API Gateway-managed route.

If you remove this property, API Gateway restores the default values.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(authorization_scopes: nil, authorization_type: nil, authorizer_id: nil, operation_name: nil, target: nil) ⇒ RouteOverridesProperty

Returns a new instance of RouteOverridesProperty.

Parameters:

  • authorization_scopes (Array<String>, nil) (defaults to: nil) —

    The authorization scopes supported by this route.

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

    The authorization type for the route.

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

    The identifier of the Authorizer resource to be associated with this route.

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

    The operation name for the route.

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

    For HTTP integrations, specify a fully qualified URL.



666
667
668
669
670
671
672
673
674
675
676
677
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 666

def initialize(authorization_scopes: nil, authorization_type: nil, authorizer_id: nil, operation_name: nil, target: nil)
  @authorization_scopes = authorization_scopes
  Jsii::Type.check_type(@authorization_scopes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "authorizationScopes") unless @authorization_scopes.nil?
  @authorization_type = authorization_type
  Jsii::Type.check_type(@authorization_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authorizationType") unless @authorization_type.nil?
  @authorizer_id = authorizer_id
  Jsii::Type.check_type(@authorizer_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authorizerId") unless @authorizer_id.nil?
  @operation_name = operation_name
  Jsii::Type.check_type(@operation_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "operationName") unless @operation_name.nil?
  @target = target
  Jsii::Type.check_type(@target, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "target") unless @target.nil?
end

Instance Attribute Details

#authorization_scopes ⇒ Array<String>? (readonly)

The authorization scopes supported by this route.

Returns:

  • (Array<String>, nil)

See Also:



683
684
685
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 683

def authorization_scopes
  @authorization_scopes
end

#authorization_type ⇒ String? (readonly)

The authorization type for the route.

To learn more, see AuthorizationType .

Returns:

  • (String, nil)

See Also:



690
691
692
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 690

def authorization_type
  @authorization_type
end

#authorizer_id ⇒ String? (readonly)

The identifier of the Authorizer resource to be associated with this route.

The authorizer identifier is generated by API Gateway when you created the authorizer.

Returns:

  • (String, nil)

See Also:



697
698
699
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 697

def authorizer_id
  @authorizer_id
end

#operation_name ⇒ String? (readonly)

The operation name for the route.

Returns:

  • (String, nil)

See Also:



702
703
704
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 702

def operation_name
  @operation_name
end

#target ⇒ String? (readonly)

For HTTP integrations, specify a fully qualified URL.

For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively.

Returns:

  • (String, nil)

See Also:



709
710
711
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 709

def target
  @target
end

Class Method Details

.jsii_properties ⇒ Object 



711
712
713
714
715
716
717
718
719
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 711

def self.jsii_properties
  {
    :authorization_scopes => "authorizationScopes",
    :authorization_type => "authorizationType",
    :authorizer_id => "authorizerId",
    :operation_name => "operationName",
    :target => "target",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



721
722
723
724
725
726
727
728
729
730
731
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 721

def to_jsii
  result = {}
  result.merge!({
    "authorizationScopes" => @authorization_scopes,
    "authorizationType" => @authorization_type,
    "authorizerId" => @authorizer_id,
    "operationName" => @operation_name,
    "target" => @target,
  })
  result.compact
end