Uses of Class
software.amazon.awscdk.services.apigateway.StepFunctionsRestApi.Builder
Packages that use StepFunctionsRestApi.Builder
-
Uses of StepFunctionsRestApi.Builder in software.amazon.awscdk.services.apigateway
Methods in software.amazon.awscdk.services.apigateway that return StepFunctionsRestApi.BuilderModifier and TypeMethodDescriptionStepFunctionsRestApi.Builder.apiKeySourceType
(ApiKeySourceType apiKeySourceType) The source of the API key for metering requests according to a usage plan.StepFunctionsRestApi.Builder.authorizer
(Boolean authorizer) If the whole authorizer object, including custom context values should be in the execution input.StepFunctionsRestApi.Builder.binaryMediaTypes
(List<String> binaryMediaTypes) The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream".The ID of the API Gateway RestApi resource that you want to clone.StepFunctionsRestApi.Builder.cloudWatchRole
(Boolean cloudWatchRole) Automatically configure an AWS CloudWatch role for API Gateway.StepFunctionsRestApi.Builder.cloudWatchRoleRemovalPolicy
(RemovalPolicy cloudWatchRoleRemovalPolicy) The removal policy applied to the AWS CloudWatch role when this resource is removed from the application.static StepFunctionsRestApi.Builder
StepFunctionsRestApi.Builder.defaultCorsPreflightOptions
(CorsOptions defaultCorsPreflightOptions) Adds a CORS preflight OPTIONS method to this resource and all child resources.StepFunctionsRestApi.Builder.defaultIntegration
(Integration defaultIntegration) An integration to use as a default for all methods created within this API unless an integration is specified.StepFunctionsRestApi.Builder.defaultMethodOptions
(MethodOptions defaultMethodOptions) Method options to use as a default for all methods created within this API unless custom options are specified.Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.StepFunctionsRestApi.Builder.deployOptions
(StageOptions deployOptions) Options for the API Gateway stage that will always point to the latest deployment whendeploy
is enabled.StepFunctionsRestApi.Builder.description
(String description) A description of the RestApi construct.StepFunctionsRestApi.Builder.disableExecuteApiEndpoint
(Boolean disableExecuteApiEndpoint) Specifies whether clients can invoke the API using the default execute-api endpoint.StepFunctionsRestApi.Builder.domainName
(DomainNameOptions domainName) Configure a custom domain name and map it to this API.StepFunctionsRestApi.Builder.endpointConfiguration
(EndpointConfiguration endpointConfiguration) The EndpointConfiguration property type specifies the endpoint types of a REST API.StepFunctionsRestApi.Builder.endpointExportName
(String endpointExportName) Export name for the CfnOutput containing the API endpoint.StepFunctionsRestApi.Builder.endpointTypes
(List<? extends EndpointType> endpointTypes) A list of the endpoint types of the API.StepFunctionsRestApi.Builder.failOnWarnings
(Boolean failOnWarnings) Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.Check if header is to be included inside the execution input.StepFunctionsRestApi.Builder.minCompressionSize
(Size minCompressionSize) A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API.StepFunctionsRestApi.Builder.minimumCompressionSize
(Number minimumCompressionSize) Deprecated.StepFunctionsRestApi.Builder.parameters
(Map<String, String> parameters) Custom header parameters for the request.Check if path is to be included inside the execution input.StepFunctionsRestApi.Builder.policy
(PolicyDocument policy) A policy document that contains the permissions for this RestApi.StepFunctionsRestApi.Builder.querystring
(Boolean querystring) Check if querystring is to be included inside the execution input.StepFunctionsRestApi.Builder.requestContext
(RequestContext requestContext) Which details of the incoming request must be passed onto the underlying state machine, such as, account id, user identity, request id, etc.StepFunctionsRestApi.Builder.restApiName
(String restApiName) A name for the API Gateway RestApi resource.StepFunctionsRestApi.Builder.retainDeployments
(Boolean retainDeployments) Retains old deployment resources when the API changes.An IAM role that API Gateway will assume to start the execution of the state machine.StepFunctionsRestApi.Builder.stateMachine
(IStateMachine stateMachine) The default State Machine that handles all requests from this API.StepFunctionsRestApi.Builder.useDefaultMethodResponses
(Boolean useDefaultMethodResponses) Whether to add default response models with 200, 400, and 500 status codes to the method.
minCompressionSize