Class ApiGatewayHttpMethod

HTTP methods supported by API Gateway.

Inheritance

object

ApiGatewayHttpMethod

Namespace: Amazon.CDK.AWS.BedrockAgentCore

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class ApiGatewayHttpMethod : DeputyBase

Syntax (vb)

Public Class ApiGatewayHttpMethod Inherits DeputyBase

Remarks

ExampleMetadata: fixture=default infused

Examples

var gateway = new Gateway(this, "MyGateway", new GatewayProps {
                GatewayName = "my-gateway"
            });

            var api = new RestApi(this, "MyApi", new RestApiProps {
                RestApiName = "my-api"
            });

            // Uses IAM authorization for outbound auth by default
            var apiGatewayTarget = gateway.AddApiGatewayTarget("MyApiGatewayTarget", new AddApiGatewayTargetOptions {
                RestApi = api,
                ApiGatewayToolConfiguration = new ApiGatewayToolConfiguration {
                    ToolFilters = new [] { new ApiGatewayToolFilter {
                        FilterPath = "/pets/*",
                        Methods = new [] { ApiGatewayHttpMethod.GET }
                    } }
                }
            });

Synopsis

Properties

DELETE	DELETE method.
GET	GET method.
HEAD	HEAD method.
OPTIONS	OPTIONS method.
PATCH	PATCH method.
POST	POST method.
PUT	PUT method.
Value	The HTTP method string value.

Methods

Of(string)	Use a custom HTTP method not yet defined in this class.
ToString()	Returns the string value.

Properties

DELETE

DELETE method.

public static ApiGatewayHttpMethod DELETE { get; }

Property Value

ApiGatewayHttpMethod

Remarks

ExampleMetadata: fixture=default infused

GET

GET method.

public static ApiGatewayHttpMethod GET { get; }

Property Value

ApiGatewayHttpMethod

Remarks

ExampleMetadata: fixture=default infused

HEAD

HEAD method.

public static ApiGatewayHttpMethod HEAD { get; }

Property Value

ApiGatewayHttpMethod

Remarks

ExampleMetadata: fixture=default infused

OPTIONS

OPTIONS method.

public static ApiGatewayHttpMethod OPTIONS { get; }

Property Value

ApiGatewayHttpMethod

Remarks

ExampleMetadata: fixture=default infused

PATCH

PATCH method.

public static ApiGatewayHttpMethod PATCH { get; }

Property Value

ApiGatewayHttpMethod

Remarks

ExampleMetadata: fixture=default infused

POST

POST method.

public static ApiGatewayHttpMethod POST { get; }

Property Value

ApiGatewayHttpMethod

Remarks

ExampleMetadata: fixture=default infused

PUT

PUT method.

public static ApiGatewayHttpMethod PUT { get; }

Property Value

ApiGatewayHttpMethod

Remarks

ExampleMetadata: fixture=default infused

Value

The HTTP method string value.

public virtual string Value { get; }

Property Value

string

Remarks

ExampleMetadata: fixture=default infused

Methods

Of(string)

Use a custom HTTP method not yet defined in this class.

public static ApiGatewayHttpMethod Of(string value)

Parameters

value string

The HTTP method string value.

Returns

ApiGatewayHttpMethod

Remarks

ExampleMetadata: fixture=default infused

ToString()

Returns the string value.

public override string ToString()

Returns

string

Remarks

ExampleMetadata: fixture=default infused