software.amazon.awscdk.services.apigateway

Interface CfnRestApiProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRestApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:15.659Z")
 @Stability(value=Stable)
public interface CfnRestApiProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::ApiGateway::RestApi`.

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.*;
 Object body;
 Object policy;
 CfnRestApiProps cfnRestApiProps = CfnRestApiProps.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)
         .endpointConfiguration(EndpointConfigurationProperty.builder()
                 .types(List.of("types"))
                 .vpcEndpointIds(List.of("vpcEndpointIds"))
                 .build())
         .failOnWarnings(false)
         .minimumCompressionSize(123)
         .mode("mode")
         .name("name")
         .parameters(Map.of(
                 "parametersKey", "parameters"))
         .policy(policy)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnRestApiProps.Builder A builder for CfnRestApiProps
static class	CfnRestApiProps.Jsii$Proxy An implementation for CfnRestApiProps

Method Summary

Modifier and Type	Method and Description
static CfnRestApiProps.Builder	builder()
default String	getApiKeySourceType() `AWS::ApiGateway::RestApi.ApiKeySourceType`.
default List<String>	getBinaryMediaTypes() `AWS::ApiGateway::RestApi.BinaryMediaTypes`.
default Object	getBody() `AWS::ApiGateway::RestApi.Body`.
default Object	getBodyS3Location() `AWS::ApiGateway::RestApi.BodyS3Location`.
default String	getCloneFrom() `AWS::ApiGateway::RestApi.CloneFrom`.
default String	getDescription() `AWS::ApiGateway::RestApi.Description`.
default Object	getDisableExecuteApiEndpoint() `AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint`.
default Object	getEndpointConfiguration() `AWS::ApiGateway::RestApi.EndpointConfiguration`.
default Object	getFailOnWarnings() `AWS::ApiGateway::RestApi.FailOnWarnings`.
default Number	getMinimumCompressionSize() `AWS::ApiGateway::RestApi.MinimumCompressionSize`.
default String	getMode() `AWS::ApiGateway::RestApi.Mode`.
default String	getName() `AWS::ApiGateway::RestApi.Name`.
default Object	getParameters() `AWS::ApiGateway::RestApi.Parameters`.
default Object	getPolicy() `AWS::ApiGateway::RestApi.Policy`.
default List<CfnTag>	getTags() `AWS::ApiGateway::RestApi.Tags`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiKeySourceType

@Stability(value=Stable)
 @Nullable
default String getApiKeySourceType()

`AWS::ApiGateway::RestApi.ApiKeySourceType`.

getBinaryMediaTypes

@Stability(value=Stable)
 @Nullable
default List<String> getBinaryMediaTypes()

`AWS::ApiGateway::RestApi.BinaryMediaTypes`.

getBody

@Stability(value=Stable)
 @Nullable
default Object getBody()

`AWS::ApiGateway::RestApi.Body`.

getBodyS3Location

@Stability(value=Stable)
 @Nullable
default Object getBodyS3Location()

`AWS::ApiGateway::RestApi.BodyS3Location`.

getCloneFrom

@Stability(value=Stable)
 @Nullable
default String getCloneFrom()

`AWS::ApiGateway::RestApi.CloneFrom`.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

`AWS::ApiGateway::RestApi.Description`.

getDisableExecuteApiEndpoint

@Stability(value=Stable)
 @Nullable
default Object getDisableExecuteApiEndpoint()

`AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint`.

getEndpointConfiguration

@Stability(value=Stable)
 @Nullable
default Object getEndpointConfiguration()

`AWS::ApiGateway::RestApi.EndpointConfiguration`.

getFailOnWarnings

@Stability(value=Stable)
 @Nullable
default Object getFailOnWarnings()

`AWS::ApiGateway::RestApi.FailOnWarnings`.

getMinimumCompressionSize

@Stability(value=Stable)
 @Nullable
default Number getMinimumCompressionSize()

`AWS::ApiGateway::RestApi.MinimumCompressionSize`.

getMode

@Stability(value=Stable)
 @Nullable
default String getMode()

`AWS::ApiGateway::RestApi.Mode`.

getName

@Stability(value=Stable)
 @Nullable
default String getName()

`AWS::ApiGateway::RestApi.Name`.

getParameters

@Stability(value=Stable)
 @Nullable
default Object getParameters()

`AWS::ApiGateway::RestApi.Parameters`.

getPolicy

@Stability(value=Stable)
 @Nullable
default Object getPolicy()

`AWS::ApiGateway::RestApi.Policy`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::ApiGateway::RestApi.Tags`.

builder

@Stability(value=Stable)
static CfnRestApiProps.Builder builder()

Returns:

a CfnRestApiProps.Builder of CfnRestApiProps