Interface RestApiBaseProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
LambdaRestApiProps
,RestApiOptions
,RestApiProps
,SpecRestApiProps
,StepFunctionsRestApiProps
- All Known Implementing Classes:
LambdaRestApiProps.Jsii$Proxy
,RestApiBaseProps.Jsii$Proxy
,RestApiOptions.Jsii$Proxy
,RestApiProps.Jsii$Proxy
,SpecRestApiProps.Jsii$Proxy
,StepFunctionsRestApiProps.Jsii$Proxy
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.apigateway.*; import software.amazon.awscdk.services.certificatemanager.*; import software.amazon.awscdk.services.iam.*; import software.amazon.awscdk.services.s3.*; import software.amazon.awscdk.core.*; IAccessLogDestination accessLogDestination; AccessLogFormat accessLogFormat; Bucket bucket; Certificate certificate; PolicyDocument policyDocument; RestApiBaseProps restApiBaseProps = RestApiBaseProps.builder() .cloudWatchRole(false) .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()) .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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forRestApiBaseProps
static final class
An implementation forRestApiBaseProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic RestApiBaseProps.Builder
builder()
default Boolean
Automatically configure an AWS CloudWatch role for API Gateway.default Boolean
Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.default StageOptions
Options for the API Gateway stage that will always point to the latest deployment whendeploy
is enabled.default Boolean
Specifies whether clients can invoke the API using the default execute-api endpoint.default DomainNameOptions
Configure a custom domain name and map it to this API.default String
Export name for the CfnOutput containing the API endpoint.default List<EndpointType>
A list of the endpoint types of the API.default Boolean
Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.Custom header parameters for the request.default PolicyDocument
A policy document that contains the permissions for this RestApi.default String
A name for the API Gateway RestApi resource.default Boolean
Retains old deployment resources when the API changes.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCloudWatchRole
Automatically configure an AWS CloudWatch role for API Gateway.Default: true
-
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 theDeployment
object anddeploymentStage
will refer to aStage
that points to this deployment. To customize the stage options, use thedeployOptions
property.A CloudFormation Output will also be defined with the root URL endpoint of this REST API.
Default: true
-
getDeployOptions
Options for the API Gateway stage that will always point to the latest deployment whendeploy
is enabled.If
deploy
is disabled, this value cannot be set.Default: - Based on defaults of `StageOptions`.
-
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:
-
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
Export name for the CfnOutput containing the API endpoint.Default: - when no export name is given, output will be created without export
-
getEndpointTypes
A list of the endpoint types of the API.Use this property when creating an API.
Default: EndpointType.EDGE
-
getFailOnWarnings
Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.Default: false
-
getParameters
Custom header parameters for the request.Default: - No parameters.
- See Also:
-
getPolicy
A policy document that contains the permissions for this RestApi.Default: - No policy.
-
getRestApiName
A name for the API Gateway RestApi resource.Default: - ID of the RestApi construct.
-
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
- Returns:
- a
RestApiBaseProps.Builder
ofRestApiBaseProps
-