Class CfnApiGatewayManagedOverridesPropsMixin.RouteOverridesProperty

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

Inheritance

object

CfnApiGatewayManagedOverridesPropsMixin.RouteOverridesProperty

Implements

CfnApiGatewayManagedOverridesPropsMixin.IRouteOverridesProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.ApiGatewayV2.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnApiGatewayManagedOverridesPropsMixin.RouteOverridesProperty : CfnApiGatewayManagedOverridesPropsMixin.IRouteOverridesProperty

Syntax (vb)

Public Class CfnApiGatewayManagedOverridesPropsMixin.RouteOverridesProperty Implements CfnApiGatewayManagedOverridesPropsMixin.IRouteOverridesProperty

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.ApiGatewayV2.Mixins;

             var routeOverridesProperty = new RouteOverridesProperty {
                 AuthorizationScopes = new [] { "authorizationScopes" },
                 AuthorizationType = "authorizationType",
                 AuthorizerId = "authorizerId",
                 OperationName = "operationName",
                 Target = "target"
             };

Synopsis

Constructors

RouteOverridesProperty()

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

Properties

AuthorizationScopes	The authorization scopes supported by this route.
AuthorizationType	The authorization type for the route.
AuthorizerId	The identifier of the `Authorizer` resource to be associated with this route.
OperationName	The operation name for the route.
Target	For HTTP integrations, specify a fully qualified URL.

Constructors

RouteOverridesProperty()

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

public RouteOverridesProperty()

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.ApiGatewayV2.Mixins;

             var routeOverridesProperty = new RouteOverridesProperty {
                 AuthorizationScopes = new [] { "authorizationScopes" },
                 AuthorizationType = "authorizationType",
                 AuthorizerId = "authorizerId",
                 OperationName = "operationName",
                 Target = "target"
             };

Properties

AuthorizationScopes

The authorization scopes supported by this route.

public string[]? AuthorizationScopes { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routeoverrides-authorizationscopes

AuthorizationType

The authorization type for the route.

public string? AuthorizationType { get; set; }

Property Value

string

Remarks

To learn more, see AuthorizationType .

AuthorizerId

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

public string? AuthorizerId { get; set; }

Property Value

string

Remarks

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

OperationName

The operation name for the route.

public string? OperationName { get; set; }

Property Value

string

Remarks

Target

For HTTP integrations, specify a fully qualified URL.

public string? Target { get; set; }

Property Value

string

Remarks

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

Implements

CfnApiGatewayManagedOverridesPropsMixin.IRouteOverridesProperty