All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:: LambdaRestApiProps, RestApiProps, SpecRestApiProps, StepFunctionsRestApiProps

All Known Implementing Classes:: LambdaRestApiProps.Jsii$Proxy, RestApiBaseProps.Jsii$Proxy, RestApiProps.Jsii$Proxy, SpecRestApiProps.Jsii$Proxy, StepFunctionsRestApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:23:56.268Z") @Stability(Stable) public interface RestApiBaseProps extends software.amazon.jsii.JsiiSerializable

Represents the props that all Rest APIs share.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.apigateway.*;
 import software.amazon.awscdk.services.certificatemanager.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.s3.*;
 IAccessLogDestination accessLogDestination;
 AccessLogFormat accessLogFormat;
 Bucket bucket;
 Certificate certificate;
 PolicyDocument policyDocument;
 RestApiBaseProps restApiBaseProps = RestApiBaseProps.builder()
         .cloudWatchRole(false)
         .cloudWatchRoleRemovalPolicy(RemovalPolicy.DESTROY)
         .deploy(false)
         .deployOptions(StageOptions.builder()
                 .accessLogDestination(accessLogDestination)
                 .accessLogFormat(accessLogFormat)
                 .cacheClusterEnabled(false)
                 .cacheClusterSize("cacheClusterSize")
                 .cacheDataEncrypted(false)
                 .cacheTtl(Duration.minutes(30))
                 .cachingEnabled(false)
                 .clientCertificateId("clientCertificateId")
                 .dataTraceEnabled(false)
                 .description("description")
                 .documentationVersion("documentationVersion")
                 .loggingLevel(MethodLoggingLevel.OFF)
                 .methodOptions(Map.of(
                         "methodOptionsKey", MethodDeploymentOptions.builder()
                                 .cacheDataEncrypted(false)
                                 .cacheTtl(Duration.minutes(30))
                                 .cachingEnabled(false)
                                 .dataTraceEnabled(false)
                                 .loggingLevel(MethodLoggingLevel.OFF)
                                 .metricsEnabled(false)
                                 .throttlingBurstLimit(123)
                                 .throttlingRateLimit(123)
                                 .build()))
                 .metricsEnabled(false)
                 .stageName("stageName")
                 .throttlingBurstLimit(123)
                 .throttlingRateLimit(123)
                 .tracingEnabled(false)
                 .variables(Map.of(
                         "variablesKey", "variables"))
                 .build())
         .description("description")
         .disableExecuteApiEndpoint(false)
         .domainName(DomainNameOptions.builder()
                 .certificate(certificate)
                 .domainName("domainName")
                 // the properties below are optional
                 .basePath("basePath")
                 .endpointType(EndpointType.EDGE)
                 .mtls(MTLSConfig.builder()
                         .bucket(bucket)
                         .key("key")
                         // the properties below are optional
                         .version("version")
                         .build())
                 .securityPolicy(SecurityPolicy.TLS_1_0)
                 .build())
         .endpointExportName("endpointExportName")
         .endpointTypes(List.of(EndpointType.EDGE))
         .failOnWarnings(false)
         .parameters(Map.of(
                 "parametersKey", "parameters"))
         .policy(policyDocument)
         .restApiName("restApiName")
         .retainDeployments(false)
         .build();

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

RestApiBaseProps.Builder

A builder for RestApiBaseProps

static final class

RestApiBaseProps.Jsii$Proxy

An implementation for RestApiBaseProps
Method Summary

Modifier and Type

Method

Description

static RestApiBaseProps.Builder

builder()

default Boolean

getCloudWatchRole()

Automatically configure an AWS CloudWatch role for API Gateway.

default RemovalPolicy

getCloudWatchRoleRemovalPolicy()

The removal policy applied to the AWS CloudWatch role when this resource is removed from the application.

default Boolean

getDeploy()

Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.

default StageOptions

getDeployOptions()

Options for the API Gateway stage that will always point to the latest deployment when deploy is enabled.

default String

getDescription()

A description of the RestApi construct.

default Boolean

getDisableExecuteApiEndpoint()

Specifies whether clients can invoke the API using the default execute-api endpoint.

default DomainNameOptions

getDomainName()

Configure a custom domain name and map it to this API.

default String

getEndpointExportName()

Export name for the CfnOutput containing the API endpoint.

default List<EndpointType>

getEndpointTypes()

A list of the endpoint types of the API.

default Boolean

getFailOnWarnings()

Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.

default Map<String,String>

getParameters()

Custom header parameters for the request.

default PolicyDocument

getPolicy()

A policy document that contains the permissions for this RestApi.

default String

getRestApiName()

A name for the API Gateway RestApi resource.

default Boolean

getRetainDeployments()

Retains old deployment resources when the API changes.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getCloudWatchRole
  
  @Stability(Stable) @Nullable default Boolean getCloudWatchRole()
  
  Automatically configure an AWS CloudWatch role for API Gateway.
  Default: - false if `@aws-cdk/aws-apigateway:disableCloudWatchRole` is enabled, true otherwise
- getCloudWatchRoleRemovalPolicy
  
  @Stability(Stable) @Nullable default RemovalPolicy getCloudWatchRoleRemovalPolicy()
  
  The removal policy applied to the AWS CloudWatch role when this resource is removed from the application.
  Requires cloudWatchRole to be enabled.
  Default: - RemovalPolicy.RETAIN
- getDeploy
  
  @Stability(Stable) @Nullable default Boolean getDeploy()
  
  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
- getDeployOptions
  
  @Stability(Stable) @Nullable default StageOptions getDeployOptions()
  
  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`.
- getDescription
  
  @Stability(Stable) @Nullable default String getDescription()
  
  A description of the RestApi construct.
  Default: - 'Automatically created by the RestApi construct'
- getDisableExecuteApiEndpoint
  
  @Stability(Stable) @Nullable default Boolean getDisableExecuteApiEndpoint()
  
  Specifies whether clients can invoke the API using the default execute-api endpoint.
  To require that clients use a custom domain name to invoke the API, disable the default endpoint.
  Default: false
  See Also:
  
  https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html
- getDomainName
  
  @Stability(Stable) @Nullable default DomainNameOptions getDomainName()
  
  Configure a custom domain name and map it to this API.
  Default: - no domain name is defined, use `addDomainName` or directly define a `DomainName`.
- getEndpointExportName
  
  @Stability(Stable) @Nullable default String getEndpointExportName()
  
  Export name for the CfnOutput containing the API endpoint.
  Default: - when no export name is given, output will be created without export
- getEndpointTypes
  
  @Stability(Stable) @Nullable default List<EndpointType> getEndpointTypes()
  
  A list of the endpoint types of the API.
  Use this property when creating an API.
  Default: EndpointType.EDGE
- getFailOnWarnings
  
  @Stability(Stable) @Nullable default Boolean getFailOnWarnings()
  
  Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
  Default: false
- getParameters
  
  @Stability(Stable) @Nullable default Map<String,String> getParameters()
  
  Custom header parameters for the request.
  Default: - No parameters.
  See Also:
  
  https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html
- getPolicy
  
  @Stability(Stable) @Nullable default PolicyDocument getPolicy()
  
  A policy document that contains the permissions for this RestApi.
  Default: - No policy.
- getRestApiName
  
  @Stability(Stable) @Nullable default String getRestApiName()
  
  A name for the API Gateway RestApi resource.
  Default: - ID of the RestApi construct.
- getRetainDeployments
  
  @Stability(Stable) @Nullable default Boolean getRetainDeployments()
  
  Retains old deployment resources when the API changes.
  This allows manually reverting stages to point to old deployments via the AWS Console.
  Default: false
- builder
  
  @Stability(Stable) static RestApiBaseProps.Builder builder()
  
  Returns:
  
  a RestApiBaseProps.Builder of RestApiBaseProps

Interface RestApiBaseProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getCloudWatchRole

getCloudWatchRoleRemovalPolicy

getDeploy

getDeployOptions

getDescription

getDisableExecuteApiEndpoint

getDomainName

getEndpointExportName

getEndpointTypes

getFailOnWarnings

getParameters

getPolicy

getRestApiName

getRetainDeployments

builder