RestApiBuilder (FsCDK)

RestApiBuilder Type

Namespace: FsCDK
Assembly: FsCDK.dll
Base Type: obj

Constructors

Constructor Description

Constructor	Description
`RestApiBuilder(name)` Full Usage: `RestApiBuilder(name)` Parameters: name : `string` Returns: `RestApiBuilder`	name : `string` Returns: `RestApiBuilder`


                
                  
                    
                      RestApiBuilder(name)

Full Usage: RestApiBuilder(name)

Parameters:

name : string

Returns: RestApiBuilder

name : string

Returns: RestApiBuilder

Instance members

Instance member	Description
`apiKeySourceType sourceType` Full Usage: `apiKeySourceType sourceType` Parameters: sourceType : `ApiKeySourceType` Returns: `RestApiConfig`	Sets the source of the API key for requests. sourceType : `ApiKeySourceType` Returns: `RestApiConfig`
`binaryMediaType mediaType` Full Usage: `binaryMediaType mediaType` Parameters: mediaType : `string` Returns: `RestApiConfig`	Adds a binary media type. mediaType : `string` Returns: `RestApiConfig`
`binaryMediaTypes mediaTypes` Full Usage: `binaryMediaTypes mediaTypes` Parameters: mediaTypes : `string list` Returns: `RestApiConfig`	Adds multiple binary media types. mediaTypes : `string list` Returns: `RestApiConfig`
`cloudWatchRole enabled` Full Usage: `cloudWatchRole enabled` Parameters: enabled : `bool` Returns: `RestApiConfig`	Controls whether to automatically create CloudWatch role for logging. enabled : `bool` Returns: `RestApiConfig`
`this.Combine` Full Usage: `this.Combine` Parameters: state1 : `RestApiConfig` state2 : `RestApiConfig` Returns: `RestApiConfig`	state1 : `RestApiConfig` state2 : `RestApiConfig` Returns: `RestApiConfig`
`constructId id` Full Usage: `constructId id` Parameters: id : `string` Returns: `RestApiConfig`	Sets a custom construct ID. id : `string` Returns: `RestApiConfig`
`defaultCorsPreflightOptions corsOptions` Full Usage: `defaultCorsPreflightOptions corsOptions` Parameters: corsOptions : `CorsOptions` Returns: `RestApiConfig`	Sets default CORS preflight options for all methods. corsOptions : `CorsOptions` Returns: `RestApiConfig`
`defaultIntegration integration` Full Usage: `defaultIntegration integration` Parameters: integration : `Integration` Returns: `RestApiConfig`	Sets the default integration for all methods. integration : `Integration` Returns: `RestApiConfig`
`defaultMethodOptions options` Full Usage: `defaultMethodOptions options` Parameters: options : `MethodOptions` Returns: `RestApiConfig`	Sets default method options for all methods. options : `MethodOptions` Returns: `RestApiConfig`
`this.Delay` Full Usage: `this.Delay` Parameters: f : `unit -> RestApiConfig` Returns: `RestApiConfig` Modifiers: inline	f : `unit -> RestApiConfig` Returns: `RestApiConfig`
`deploy deploy` Full Usage: `deploy deploy` Parameters: deploy : `bool` Returns: `RestApiConfig`	Controls whether to automatically deploy the API. deploy : `bool` Returns: `RestApiConfig`
`deployOptions options` Full Usage: `deployOptions options` Parameters: options : `StageOptions` Returns: `RestApiConfig`	Sets the deployment stage options. options : `StageOptions` Returns: `RestApiConfig`
`description description` Full Usage: `description description` Parameters: description : `string` Returns: `RestApiConfig`	Sets the description for the REST API. description : `string` Returns: `RestApiConfig`
`disableExecuteApiEndpoint disable` Full Usage: `disableExecuteApiEndpoint disable` Parameters: disable : `bool` Returns: `RestApiConfig`	Disables the default execute-api endpoint. disable : `bool` Returns: `RestApiConfig`
`endpointType endpointType` Full Usage: `endpointType endpointType` Parameters: endpointType : `EndpointType` Returns: `RestApiConfig`	Sets a single endpoint type. endpointType : `EndpointType` Returns: `RestApiConfig`
`endpointTypes endpointTypes` Full Usage: `endpointTypes endpointTypes` Parameters: endpointTypes : `EndpointType list` Returns: `RestApiConfig`	Sets multiple endpoint types. endpointTypes : `EndpointType list` Returns: `RestApiConfig`
`this.For` Full Usage: `this.For` Parameters: config : `RestApiConfig` f : `unit -> RestApiConfig` Returns: `RestApiConfig` Modifiers: inline	config : `RestApiConfig` f : `unit -> RestApiConfig` Returns: `RestApiConfig`
`minimumCompressionSize size` Full Usage: `minimumCompressionSize size` Parameters: size : `Size` Returns: `RestApiConfig`	Sets the minimum response compression size in bytes. size : `Size` Returns: `RestApiConfig`
`policy policy` Full Usage: `policy policy` Parameters: policy : `PolicyDocument` Returns: `RestApiConfig`	Sets the resource policy for the API. policy : `PolicyDocument` Returns: `RestApiConfig`
`this.Run` Full Usage: `this.Run` Parameters: config : `RestApiConfig` Returns: `RestApiSpec`	config : `RestApiConfig` Returns: `RestApiSpec`
`this.Yield` Full Usage: `this.Yield` Parameters: () : `unit` Returns: `RestApiConfig`	() : `unit` Returns: `RestApiConfig`
`this.Zero` Full Usage: `this.Zero` Returns: `RestApiConfig`	Returns: `RestApiConfig`