CfnApiProps

class aws_cdk.aws_sam.CfnApiProps(*, stage_name, access_log_setting=None, auth=None, binary_media_types=None, cache_cluster_enabled=None, cache_cluster_size=None, canary_setting=None, cors=None, definition_body=None, definition_uri=None, description=None, endpoint_configuration=None, gateway_responses=None, method_settings=None, minimum_compression_size=None, models=None, name=None, open_api_version=None, tags=None, tracing_enabled=None, variables=None)

Bases: object

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

Parameters
  • stage_name (str) – AWS::Serverless::Api.StageName.

  • access_log_setting (Union[IResolvable, AccessLogSettingProperty, None]) – AWS::Serverless::Api.AccessLogSetting.

  • auth (Union[IResolvable, AuthProperty, None]) – AWS::Serverless::Api.Auth.

  • binary_media_types (Optional[Sequence[str]]) – AWS::Serverless::Api.BinaryMediaTypes.

  • cache_cluster_enabled (Union[bool, IResolvable, None]) – AWS::Serverless::Api.CacheClusterEnabled.

  • cache_cluster_size (Optional[str]) – AWS::Serverless::Api.CacheClusterSize.

  • canary_setting (Union[IResolvable, CanarySettingProperty, None]) – AWS::Serverless::Api.CanarySetting.

  • cors (Union[str, IResolvable, CorsConfigurationProperty, None]) – AWS::Serverless::Api.Cors.

  • definition_body (Optional[Any]) – AWS::Serverless::Api.DefinitionBody.

  • definition_uri (Union[str, IResolvable, S3LocationProperty, None]) – AWS::Serverless::Api.DefinitionUri.

  • description (Optional[str]) – AWS::Serverless::Api.Description.

  • endpoint_configuration (Union[str, IResolvable, EndpointConfigurationProperty, None]) – AWS::Serverless::Api.EndpointConfiguration.

  • gateway_responses (Union[IResolvable, Mapping[str, str], None]) – AWS::Serverless::Api.GatewayResponses.

  • method_settings (Union[Sequence[Any], IResolvable, None]) – AWS::Serverless::Api.MethodSettings.

  • minimum_compression_size (Union[int, float, None]) – AWS::Serverless::Api.MinimumCompressionSize.

  • models (Union[IResolvable, Mapping[str, str], None]) – AWS::Serverless::Api.Models.

  • name (Optional[str]) – AWS::Serverless::Api.Name.

  • open_api_version (Optional[str]) – AWS::Serverless::Api.OpenApiVersion.

  • tags (Optional[Mapping[str, str]]) – AWS::Serverless::Api.Tags.

  • tracing_enabled (Union[bool, IResolvable, None]) – AWS::Serverless::Api.TracingEnabled.

  • variables (Union[IResolvable, Mapping[str, str], None]) – AWS::Serverless::Api.Variables.

Link

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

Attributes

access_log_setting

AWS::Serverless::Api.AccessLogSetting.

Link

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

Return type

Union[IResolvable, AccessLogSettingProperty, None]

auth

AWS::Serverless::Api.Auth.

Link

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

Return type

Union[IResolvable, AuthProperty, None]

binary_media_types

AWS::Serverless::Api.BinaryMediaTypes.

Link

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

Return type

Optional[List[str]]

cache_cluster_enabled

AWS::Serverless::Api.CacheClusterEnabled.

Link

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

Return type

Union[bool, IResolvable, None]

cache_cluster_size

AWS::Serverless::Api.CacheClusterSize.

Link

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

Return type

Optional[str]

canary_setting

AWS::Serverless::Api.CanarySetting.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-api.html#sam-api-canarysetting

Return type

Union[IResolvable, CanarySettingProperty, None]

cors

AWS::Serverless::Api.Cors.

Link

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

Return type

Union[str, IResolvable, CorsConfigurationProperty, None]

definition_body

AWS::Serverless::Api.DefinitionBody.

Link

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

Return type

Any

definition_uri

AWS::Serverless::Api.DefinitionUri.

Link

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

Return type

Union[str, IResolvable, S3LocationProperty, None]

description

AWS::Serverless::Api.Description.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-api.html#sam-api-description

Return type

Optional[str]

endpoint_configuration

AWS::Serverless::Api.EndpointConfiguration.

Link

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

Return type

Union[str, IResolvable, EndpointConfigurationProperty, None]

gateway_responses

AWS::Serverless::Api.GatewayResponses.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-api.html#sam-api-gatewayresponses

Return type

Union[IResolvable, Mapping[str, str], None]

method_settings

AWS::Serverless::Api.MethodSettings.

Link

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

Return type

Union[List[Any], IResolvable, None]

minimum_compression_size

AWS::Serverless::Api.MinimumCompressionSize.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-api.html#sam-api-minimumcompressionsize

Return type

Union[int, float, None]

models

AWS::Serverless::Api.Models.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-api.html#sam-api-models

Return type

Union[IResolvable, Mapping[str, str], None]

name

AWS::Serverless::Api.Name.

Link

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

Return type

Optional[str]

open_api_version

AWS::Serverless::Api.OpenApiVersion.

Link

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

Return type

Optional[str]

stage_name

AWS::Serverless::Api.StageName.

Link

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

Return type

str

tags

AWS::Serverless::Api.Tags.

Link

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

Return type

Optional[Mapping[str, str]]

tracing_enabled

AWS::Serverless::Api.TracingEnabled.

Link

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

Return type

Union[bool, IResolvable, None]

variables

AWS::Serverless::Api.Variables.

Link

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

Return type

Union[IResolvable, Mapping[str, str], None]