Class RestApiOptions.Builder
java.lang.Object
software.amazon.awscdk.services.apigateway.RestApiOptions.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<RestApiOptions>
- Enclosing interface:
RestApiOptions
@Stability(Deprecated)
@Deprecated
public static final class RestApiOptions.Builder
extends Object
implements software.amazon.jsii.Builder<RestApiOptions>
Deprecated.
A builder for
RestApiOptions
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Deprecated.cloudWatchRole
(Boolean cloudWatchRole) Deprecated.Sets the value ofRestApiBaseProps.getCloudWatchRole()
defaultCorsPreflightOptions
(CorsOptions defaultCorsPreflightOptions) Deprecated.Sets the value ofResourceOptions.getDefaultCorsPreflightOptions()
defaultIntegration
(Integration defaultIntegration) Deprecated.Sets the value ofResourceOptions.getDefaultIntegration()
defaultMethodOptions
(MethodOptions defaultMethodOptions) Deprecated.Sets the value ofResourceOptions.getDefaultMethodOptions()
Deprecated.Sets the value ofRestApiBaseProps.getDeploy()
deployOptions
(StageOptions deployOptions) Deprecated.Sets the value ofRestApiBaseProps.getDeployOptions()
disableExecuteApiEndpoint
(Boolean disableExecuteApiEndpoint) Deprecated.Sets the value ofRestApiBaseProps.getDisableExecuteApiEndpoint()
domainName
(DomainNameOptions domainName) Deprecated.Sets the value ofRestApiBaseProps.getDomainName()
endpointExportName
(String endpointExportName) Deprecated.Sets the value ofRestApiBaseProps.getEndpointExportName()
endpointTypes
(List<? extends EndpointType> endpointTypes) Deprecated.Sets the value ofRestApiBaseProps.getEndpointTypes()
failOnWarnings
(Boolean failOnWarnings) Deprecated.Sets the value ofRestApiBaseProps.getFailOnWarnings()
parameters
(Map<String, String> parameters) Deprecated.Sets the value ofRestApiBaseProps.getParameters()
policy
(PolicyDocument policy) Deprecated.Sets the value ofRestApiBaseProps.getPolicy()
restApiName
(String restApiName) Deprecated.Sets the value ofRestApiBaseProps.getRestApiName()
retainDeployments
(Boolean retainDeployments) Deprecated.Sets the value ofRestApiBaseProps.getRetainDeployments()
-
Constructor Details
-
Builder
public Builder()Deprecated.
-
-
Method Details
-
cloudWatchRole
Deprecated.Sets the value ofRestApiBaseProps.getCloudWatchRole()
- Parameters:
cloudWatchRole
- Automatically configure an AWS CloudWatch role for API Gateway.- Returns:
this
-
deploy
Deprecated.Sets the value ofRestApiBaseProps.getDeploy()
- Parameters:
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 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.
- Returns:
this
-
deployOptions
Deprecated.Sets the value ofRestApiBaseProps.getDeployOptions()
- Parameters:
deployOptions
- Options for the API Gateway stage that will always point to the latest deployment whendeploy
is enabled. Ifdeploy
is disabled, this value cannot be set.- Returns:
this
-
disableExecuteApiEndpoint
@Stability(Stable) public RestApiOptions.Builder disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint) Deprecated.Sets the value ofRestApiBaseProps.getDisableExecuteApiEndpoint()
- Parameters:
disableExecuteApiEndpoint
- 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.- Returns:
this
-
domainName
Deprecated.Sets the value ofRestApiBaseProps.getDomainName()
- Parameters:
domainName
- Configure a custom domain name and map it to this API.- Returns:
this
-
endpointExportName
Deprecated.Sets the value ofRestApiBaseProps.getEndpointExportName()
- Parameters:
endpointExportName
- Export name for the CfnOutput containing the API endpoint.- Returns:
this
-
endpointTypes
@Stability(Stable) public RestApiOptions.Builder endpointTypes(List<? extends EndpointType> endpointTypes) Deprecated.Sets the value ofRestApiBaseProps.getEndpointTypes()
- Parameters:
endpointTypes
- A list of the endpoint types of the API. Use this property when creating an API.- Returns:
this
-
failOnWarnings
Deprecated.Sets the value ofRestApiBaseProps.getFailOnWarnings()
- Parameters:
failOnWarnings
- Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.- Returns:
this
-
parameters
Deprecated.Sets the value ofRestApiBaseProps.getParameters()
- Parameters:
parameters
- Custom header parameters for the request.- Returns:
this
-
policy
Deprecated.Sets the value ofRestApiBaseProps.getPolicy()
- Parameters:
policy
- A policy document that contains the permissions for this RestApi.- Returns:
this
-
restApiName
Deprecated.Sets the value ofRestApiBaseProps.getRestApiName()
- Parameters:
restApiName
- A name for the API Gateway RestApi resource.- Returns:
this
-
retainDeployments
Deprecated.Sets the value ofRestApiBaseProps.getRetainDeployments()
- Parameters:
retainDeployments
- Retains old deployment resources when the API changes. This allows manually reverting stages to point to old deployments via the AWS Console.- Returns:
this
-
defaultCorsPreflightOptions
@Stability(Stable) public RestApiOptions.Builder defaultCorsPreflightOptions(CorsOptions defaultCorsPreflightOptions) Deprecated.Sets the value ofResourceOptions.getDefaultCorsPreflightOptions()
- Parameters:
defaultCorsPreflightOptions
- Adds a CORS preflight OPTIONS method to this resource and all child resources. You can add CORS at the resource-level usingaddCorsPreflight
.- Returns:
this
-
defaultIntegration
Deprecated.Sets the value ofResourceOptions.getDefaultIntegration()
- Parameters:
defaultIntegration
- An integration to use as a default for all methods created within this API unless an integration is specified.- Returns:
this
-
defaultMethodOptions
@Stability(Stable) public RestApiOptions.Builder defaultMethodOptions(MethodOptions defaultMethodOptions) Deprecated.Sets the value ofResourceOptions.getDefaultMethodOptions()
- Parameters:
defaultMethodOptions
- Method options to use as a default for all methods created within this API unless custom options are specified.- Returns:
this
-
build
Deprecated.Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<RestApiOptions>
- Returns:
- a new instance of
RestApiOptions
- Throws:
NullPointerException
- if any required attribute was not provided
-