Package software.aws.awsprototypingsdk.openapigateway

Class OpenApiGatewayLambdaApi.Builder

    • Method Detail

      • cloudWatchRole

        @Stability(Stable)
public OpenApiGatewayLambdaApi.Builder cloudWatchRole​(Boolean cloudWatchRole)
        Automatically configure an AWS CloudWatch role for API Gateway.

        Default: true

        Parameters:
        cloudWatchRole - Automatically configure an AWS CloudWatch role for API Gateway. This parameter is required.
        Returns:
        this

      • deploy

        @Stability(Stable)
public OpenApiGatewayLambdaApi.Builder deploy​(Boolean deploy)
        Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.

        Since API Gateway deployments are immutable, When this option is enabled (by default), an AWS::ApiGateway::Deployment resource will automatically created with a logical ID that hashes the API model (methods, resources and options). This means that when the model changes, the logical ID of this CloudFormation resource will change, and a new deployment will be created.

        If this is set, latestDeployment will refer to the Deployment object and deploymentStage will refer to a Stage that points to this deployment. To customize the stage options, use the deployOptions property.

        A CloudFormation Output will also be defined with the root URL endpoint of this REST API.

        Default: true

        Parameters:
        deploy - Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes. This parameter is required.
        Returns:
        this

      • deployOptions

        @Stability(Stable)
public OpenApiGatewayLambdaApi.Builder deployOptions​(software.amazon.awscdk.services.apigateway.StageOptions deployOptions)
        Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled.

        If deploy is disabled, this value cannot be set.

        Default: - Based on defaults of `StageOptions`.

        Parameters:
        deployOptions - Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled. This parameter is required.
        Returns:
        this

      • domainName

        @Stability(Stable)
public OpenApiGatewayLambdaApi.Builder domainName​(software.amazon.awscdk.services.apigateway.DomainNameOptions domainName)
        Configure a custom domain name and map it to this API.

        Default: - no domain name is defined, use `addDomainName` or directly define a `DomainName`.

        Parameters:
        domainName - Configure a custom domain name and map it to this API. This parameter is required.
        Returns:
        this

      • endpointExportName

        @Stability(Stable)
public OpenApiGatewayLambdaApi.Builder endpointExportName​(String endpointExportName)
        Export name for the CfnOutput containing the API endpoint.

        Default: - when no export name is given, output will be created without export

        Parameters:
        endpointExportName - Export name for the CfnOutput containing the API endpoint. This parameter is required.
        Returns:
        this

      • endpointTypes

        @Stability(Stable)
public OpenApiGatewayLambdaApi.Builder endpointTypes​(List<? extends software.amazon.awscdk.services.apigateway.EndpointType> endpointTypes)
        A list of the endpoint types of the API.

        Use this property when creating an API.

        Default: EndpointType.EDGE

        Parameters:
        endpointTypes - A list of the endpoint types of the API. This parameter is required.
        Returns:
        this

      • failOnWarnings

        @Stability(Stable)
public OpenApiGatewayLambdaApi.Builder failOnWarnings​(Boolean failOnWarnings)
        Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.

        Default: false

        Parameters:
        failOnWarnings - Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. This parameter is required.
        Returns:
        this

      • policy

        @Stability(Stable)
public OpenApiGatewayLambdaApi.Builder policy​(software.amazon.awscdk.services.iam.PolicyDocument policy)
        A policy document that contains the permissions for this RestApi.

        Default: - No policy.

        Parameters:
        policy - A policy document that contains the permissions for this RestApi. This parameter is required.
        Returns:
        this

      • restApiName

        @Stability(Stable)
public OpenApiGatewayLambdaApi.Builder restApiName​(String restApiName)
        A name for the API Gateway RestApi resource.

        Default: - ID of the RestApi construct.

        Parameters:
        restApiName - A name for the API Gateway RestApi resource. This parameter is required.
        Returns:
        this

      • retainDeployments

        @Stability(Stable)
public OpenApiGatewayLambdaApi.Builder retainDeployments​(Boolean retainDeployments)
        Retains old deployment resources when the API changes.

        This allows manually reverting stages to point to old deployments via the AWS Console.

        Default: false

        Parameters:
        retainDeployments - Retains old deployment resources when the API changes. This parameter is required.
        Returns:
        this

      • integrations

        @Stability(Experimental)
public OpenApiGatewayLambdaApi.Builder integrations​(Map<String,​? extends OpenApiIntegration> integrations)
        (experimental) A mapping of API operation to its integration.

        Parameters:
        integrations - A mapping of API operation to its integration. This parameter is required.
        Returns:
        this

      • operationLookup

        @Stability(Experimental)
public OpenApiGatewayLambdaApi.Builder operationLookup​(Map<String,​? extends MethodAndPath> operationLookup)
        (experimental) Details about each operation.

        Parameters:
        operationLookup - Details about each operation. This parameter is required.
        Returns:
        this

      • corsOptions

        @Stability(Experimental)
public OpenApiGatewayLambdaApi.Builder corsOptions​(software.amazon.awscdk.services.apigateway.CorsOptions corsOptions)
        (experimental) Cross Origin Resource Sharing options for the API.

        Parameters:
        corsOptions - Cross Origin Resource Sharing options for the API. This parameter is required.
        Returns:
        this

      • defaultAuthorizer

        @Stability(Experimental)
public OpenApiGatewayLambdaApi.Builder defaultAuthorizer​(Authorizer defaultAuthorizer)
        (experimental) The default authorizer to use for your api.

        When omitted, no authorizer is used. Authorizers specified at the integration level will override this for that operation.

        Parameters:
        defaultAuthorizer - The default authorizer to use for your api. This parameter is required.
        Returns:
        this

      • spec

        @Stability(Experimental)
public OpenApiGatewayLambdaApi.Builder spec​(Object spec)
        (experimental) The parsed OpenAPI specification.

        Parameters:
        spec - The parsed OpenAPI specification. This parameter is required.
        Returns:
        this