interface CorsPreflightOptions 🔹

Language	Type name
.NET	Amazon.CDK.AWS.APIGatewayv2.CorsPreflightOptions
Java	software.amazon.awscdk.services.apigatewayv2.CorsPreflightOptions
Python	aws_cdk.aws_apigatewayv2.CorsPreflightOptions
TypeScript (source)	@aws-cdk/aws-apigatewayv2 » CorsPreflightOptions

Options for the CORS Configuration.

Example

new apigwv2.HttpApi(this, 'HttpProxyApi', {
  corsPreflight: {
    allowHeaders: ['Authorization'],
    allowMethods: [
      apigwv2.CorsHttpMethod.GET,
      apigwv2.CorsHttpMethod.HEAD,
      apigwv2.CorsHttpMethod.OPTIONS,
      apigwv2.CorsHttpMethod.POST,
    ],
    allowOrigins: ['*'],
    maxAge: Duration.days(10),
  },
});

Properties

Name	Type	Description
allowCredentials?🔹	boolean	Specifies whether credentials are included in the CORS request.
allowHeaders?🔹	string[]	Represents a collection of allowed headers.
allowMethods?🔹	CorsHttpMethod[]	Represents a collection of allowed HTTP methods.
allowOrigins?🔹	string[]	Represents a collection of allowed origins.
exposeHeaders?🔹	string[]	Represents a collection of exposed headers.
maxAge?🔹	Duration	The duration that the browser should cache preflight request results.

---

allowCredentials?🔹

Type: boolean (optional, default: false)

Specifies whether credentials are included in the CORS request.

---

allowHeaders?🔹

Type: string[] (optional, default: No Headers are allowed.)

Represents a collection of allowed headers.

---

allowMethods?🔹

Type: CorsHttpMethod[] (optional, default: No Methods are allowed.)

Represents a collection of allowed HTTP methods.

---

allowOrigins?🔹

Type: string[] (optional, default: No Origins are allowed.)

Represents a collection of allowed origins.

---

exposeHeaders?🔹

Type: string[] (optional, default: No Expose Headers are allowed.)

Represents a collection of exposed headers.

---

maxAge?🔹

Type: Duration (optional, default: Duration.seconds(0))

The duration that the browser should cache preflight request results.