Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Class CfnRestApiPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnRestApiPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.486Z")
@Stability(Stable)
public class CfnRestApiPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::ApiGateway::RestApi resource creates a REST API.

For more information, see restapi:create in the Amazon API Gateway REST API Reference .

On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative , becoming the foundation of the OpenAPI Specification.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.apigateway.*;
 import software.amazon.awscdk.*;
 Object body;
 IMergeStrategy mergeStrategy;
 Object policy;
 CfnRestApiPropsMixin cfnRestApiPropsMixin = CfnRestApiPropsMixin.Builder.create(CfnRestApiMixinProps.builder()
         .apiKeySourceType("apiKeySourceType")
         .binaryMediaTypes(List.of("binaryMediaTypes"))
         .body(body)
         .bodyS3Location(S3LocationProperty.builder()
                 .bucket("bucket")
                 .eTag("eTag")
                 .key("key")
                 .version("version")
                 .build())
         .cloneFrom("cloneFrom")
         .description("description")
         .disableExecuteApiEndpoint(false)
         .endpointAccessMode("endpointAccessMode")
         .endpointConfiguration(EndpointConfigurationProperty.builder()
                 .ipAddressType("ipAddressType")
                 .types(List.of("types"))
                 .vpcEndpointIds(List.of("vpcEndpointIds"))
                 .build())
         .failOnWarnings(false)
         .minimumCompressionSize(123)
         .mode("mode")
         .name("name")
         .parameters(Map.of(
                 "parametersKey", "parameters"))
         .policy(policy)
         .securityPolicy("securityPolicy")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnRestApiPropsMixin.Builder	A fluent builder for CfnRestApiPropsMixin.
static interface	CfnRestApiPropsMixin.EndpointConfigurationProperty	The EndpointConfiguration property type specifies the endpoint types and IP address types of a REST API.
static interface	CfnRestApiPropsMixin.S3LocationProperty	S3Location is a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnRestApiPropsMixin(CfnRestApiMixinProps props)	Create a mixin to apply properties to AWS::ApiGateway::RestApi.
	CfnRestApiPropsMixin(CfnRestApiMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::ApiGateway::RestApi.
protected	CfnRestApiPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRestApiPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnRestApiMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnRestApiPropsMixin

protected CfnRestApiPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnRestApiPropsMixin

protected CfnRestApiPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnRestApiPropsMixin

@Stability(Stable)
public CfnRestApiPropsMixin(@NotNull
 CfnRestApiMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::ApiGateway::RestApi.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnRestApiPropsMixin

@Stability(Stable)
public CfnRestApiPropsMixin(@NotNull
 CfnRestApiMixinProps props)

Create a mixin to apply properties to AWS::ApiGateway::RestApi.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnRestApiMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()