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.14.1 (build 828de8a)",
           date="2020-11-24T22:28:02.342Z")
 @Stability(value=Stable)
public interface CfnRestApiProps
extends software.amazon.jsii.JsiiSerializable

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

See Also:

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

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	getEndpointConfiguration() `AWS::ApiGateway::RestApi.EndpointConfiguration`.
default Object	getFailOnWarnings() `AWS::ApiGateway::RestApi.FailOnWarnings`.
default Number	getMinimumCompressionSize() `AWS::ApiGateway::RestApi.MinimumCompressionSize`.
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`.

See Also:

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

getBinaryMediaTypes

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

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

See Also:

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

getBody

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

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

See Also:

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

getBodyS3Location

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

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

See Also:

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

getCloneFrom

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

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

See Also:

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

getDescription

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

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

See Also:

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

getEndpointConfiguration

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

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

See Also:

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

getFailOnWarnings

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

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

See Also:

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

getMinimumCompressionSize

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

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

See Also:

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

getName

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

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

See Also:

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

getParameters

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

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

See Also:

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

getPolicy

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

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

See Also:

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

getTags

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

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

See Also:

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

builder

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

Returns:

a CfnRestApiProps.Builder of CfnRestApiProps