software.amazon.awscdk.services.sam

Interface CfnApiProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.15.0 (build 585166b)",
           date="2020-12-12T01:56:07.005Z")
 @Stability(value=Stable)
public interface CfnApiProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::Serverless::Api`.

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnApiProps.Builder	builder()
default Object	getAccessLogSetting() `AWS::Serverless::Api.AccessLogSetting`.
default Object	getAuth() `AWS::Serverless::Api.Auth`.
default List<String>	getBinaryMediaTypes() `AWS::Serverless::Api.BinaryMediaTypes`.
default Object	getCacheClusterEnabled() `AWS::Serverless::Api.CacheClusterEnabled`.
default String	getCacheClusterSize() `AWS::Serverless::Api.CacheClusterSize`.
default Object	getCors() `AWS::Serverless::Api.Cors`.
default Object	getDefinitionBody() `AWS::Serverless::Api.DefinitionBody`.
default Object	getDefinitionUri() `AWS::Serverless::Api.DefinitionUri`.
default String	getEndpointConfiguration() `AWS::Serverless::Api.EndpointConfiguration`.
default Object	getMethodSettings() `AWS::Serverless::Api.MethodSettings`.
default String	getName() `AWS::Serverless::Api.Name`.
default String	getOpenApiVersion() `AWS::Serverless::Api.OpenApiVersion`.
String	getStageName() `AWS::Serverless::Api.StageName`.
default Object	getTracingEnabled() `AWS::Serverless::Api.TracingEnabled`.
default Object	getVariables() `AWS::Serverless::Api.Variables`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getStageName

@Stability(value=Stable)
 @NotNull
String getStageName()

`AWS::Serverless::Api.StageName`.

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

getAccessLogSetting

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

`AWS::Serverless::Api.AccessLogSetting`.

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

getAuth

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

`AWS::Serverless::Api.Auth`.

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

getBinaryMediaTypes

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

`AWS::Serverless::Api.BinaryMediaTypes`.

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

getCacheClusterEnabled

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

`AWS::Serverless::Api.CacheClusterEnabled`.

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

getCacheClusterSize

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

`AWS::Serverless::Api.CacheClusterSize`.

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

getCors

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

`AWS::Serverless::Api.Cors`.

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

getDefinitionBody

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

`AWS::Serverless::Api.DefinitionBody`.

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

getDefinitionUri

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

`AWS::Serverless::Api.DefinitionUri`.

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

getEndpointConfiguration

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

`AWS::Serverless::Api.EndpointConfiguration`.

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

getMethodSettings

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

`AWS::Serverless::Api.MethodSettings`.

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

getName

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

`AWS::Serverless::Api.Name`.

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

getOpenApiVersion

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

`AWS::Serverless::Api.OpenApiVersion`.

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

getTracingEnabled

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

`AWS::Serverless::Api.TracingEnabled`.

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

getVariables

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

`AWS::Serverless::Api.Variables`.

See Also:

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

builder

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

Returns:

a CfnApiProps.Builder of CfnApiProps