Package software.amazon.awscdk.services.apigateway

Class SpecRestApiProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigateway.SpecRestApiProps.Jsii$Proxy

All Implemented Interfaces:

RestApiBaseProps, SpecRestApiProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

SpecRestApiProps

@Stability(Stable)
@Internal
public static final class SpecRestApiProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements SpecRestApiProps

An implementation for SpecRestApiProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.SpecRestApiProps

SpecRestApiProps.Builder, SpecRestApiProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(SpecRestApiProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the SpecRestApiProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final ApiDefinition	getApiDefinition()	An OpenAPI definition compatible with API Gateway.
final Boolean	getCloudWatchRole()	Automatically configure an AWS CloudWatch role for API Gateway.
final RemovalPolicy	getCloudWatchRoleRemovalPolicy()	The removal policy applied to the AWS CloudWatch role when this resource is removed from the application.
final Boolean	getDeploy()	Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
final StageOptions	getDeployOptions()	Options for the API Gateway stage that will always point to the latest deployment when deploy is enabled.
final String	getDescription()	A description of the RestApi construct.
final Boolean	getDisableExecuteApiEndpoint()	Specifies whether clients can invoke the API using the default execute-api endpoint.
final DomainNameOptions	getDomainName()	Configure a custom domain name and map it to this API.
final EndpointConfiguration	getEndpointConfiguration()	The EndpointConfiguration property type specifies the endpoint types of a REST API.
final String	getEndpointExportName()	Export name for the CfnOutput containing the API endpoint.
final List<EndpointType>	getEndpointTypes()	A list of the endpoint types of the API.
final Boolean	getFailOnWarnings()	Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
final Size	getMinCompressionSize()	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.
final Map<String,String>	getParameters()	Custom header parameters for the request.
final PolicyDocument	getPolicy()	A policy document that contains the permissions for this RestApi.
final String	getRestApiName()	A name for the API Gateway RestApi resource.
final Boolean	getRetainDeployments()	Retains old deployment resources when the API changes.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(SpecRestApiProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the SpecRestApiProps.Builder.

Method Details

getApiDefinition

public final ApiDefinition getApiDefinition()

Description copied from interface: SpecRestApiProps

An OpenAPI definition compatible with API Gateway.

Specified by:

getApiDefinition in interface SpecRestApiProps

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html

getMinCompressionSize

public final Size getMinCompressionSize()

Description copied from interface: SpecRestApiProps

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.

When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Default: - Compression is disabled.

Specified by:

getMinCompressionSize in interface SpecRestApiProps

getCloudWatchRole

public final Boolean getCloudWatchRole()

Description copied from interface: RestApiBaseProps

Automatically configure an AWS CloudWatch role for API Gateway.

Default: - false if `@aws-cdk/aws-apigateway:disableCloudWatchRole` is enabled, true otherwise

Specified by:

getCloudWatchRole in interface RestApiBaseProps

getCloudWatchRoleRemovalPolicy

public final RemovalPolicy getCloudWatchRoleRemovalPolicy()

Description copied from interface: RestApiBaseProps

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

Specified by:

getCloudWatchRoleRemovalPolicy in interface RestApiBaseProps

getDeploy

public final Boolean getDeploy()

Description copied from interface: RestApiBaseProps

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

Specified by:

getDeploy in interface RestApiBaseProps

getDeployOptions

public final StageOptions getDeployOptions()

Description copied from interface: RestApiBaseProps

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`.

Specified by:

getDeployOptions in interface RestApiBaseProps

getDescription

public final String getDescription()

Description copied from interface: RestApiBaseProps

A description of the RestApi construct.

Default: - 'Automatically created by the RestApi construct'

Specified by:

getDescription in interface RestApiBaseProps

getDisableExecuteApiEndpoint

public final Boolean getDisableExecuteApiEndpoint()

Description copied from interface: RestApiBaseProps

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

Specified by:

getDisableExecuteApiEndpoint in interface RestApiBaseProps

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html

getDomainName

public final DomainNameOptions getDomainName()

Description copied from interface: RestApiBaseProps

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

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

Specified by:

getDomainName in interface RestApiBaseProps

getEndpointConfiguration

public final EndpointConfiguration getEndpointConfiguration()

Description copied from interface: RestApiBaseProps

The EndpointConfiguration property type specifies the endpoint types of a REST API.

Default: EndpointType.EDGE

Specified by:

getEndpointConfiguration in interface RestApiBaseProps

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html

getEndpointExportName

public final String getEndpointExportName()

Description copied from interface: RestApiBaseProps

Export name for the CfnOutput containing the API endpoint.

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

Specified by:

getEndpointExportName in interface RestApiBaseProps

getEndpointTypes

public final List<EndpointType> getEndpointTypes()

Description copied from interface: RestApiBaseProps

A list of the endpoint types of the API.

Use this property when creating an API.

Default: EndpointType.EDGE

Specified by:

getEndpointTypes in interface RestApiBaseProps

getFailOnWarnings

public final Boolean getFailOnWarnings()

Description copied from interface: RestApiBaseProps

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

Default: false

Specified by:

getFailOnWarnings in interface RestApiBaseProps

getParameters

public final Map<String,String> getParameters()

Description copied from interface: RestApiBaseProps

Custom header parameters for the request.

Default: - No parameters.

Specified by:

getParameters in interface RestApiBaseProps

See Also:

• https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html

getPolicy

public final PolicyDocument getPolicy()

Description copied from interface: RestApiBaseProps

A policy document that contains the permissions for this RestApi.

Default: - No policy.

Specified by:

getPolicy in interface RestApiBaseProps

getRestApiName

public final String getRestApiName()

Description copied from interface: RestApiBaseProps

A name for the API Gateway RestApi resource.

Default: - ID of the RestApi construct.

Specified by:

getRestApiName in interface RestApiBaseProps

getRetainDeployments

public final Boolean getRetainDeployments()

Description copied from interface: RestApiBaseProps

Retains old deployment resources when the API changes.

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

Default: false

Specified by:

getRetainDeployments in interface RestApiBaseProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object