CfnRestApiProps¶

class aws_cdk.aws_apigateway.CfnRestApiProps(*, api_key_source_type=None, binary_media_types=None, body=None, body_s3_location=None, clone_from=None, description=None, disable_execute_api_endpoint=None, endpoint_configuration=None, fail_on_warnings=None, minimum_compression_size=None, mode=None, name=None, parameters=None, policy=None, tags=None)¶

Bases: object

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

Parameters

api_key_source_type (Optional[str]) – AWS::ApiGateway::RestApi.ApiKeySourceType.
binary_media_types (Optional[Sequence[str]]) – AWS::ApiGateway::RestApi.BinaryMediaTypes.
body (Optional[Any]) – AWS::ApiGateway::RestApi.Body.
body_s3_location (Union[IResolvable, S3LocationProperty, None]) – AWS::ApiGateway::RestApi.BodyS3Location.
clone_from (Optional[str]) – AWS::ApiGateway::RestApi.CloneFrom.
description (Optional[str]) – AWS::ApiGateway::RestApi.Description.
disable_execute_api_endpoint (Union[bool, IResolvable, None]) – AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint.
endpoint_configuration (Union[IResolvable, EndpointConfigurationProperty, None]) – AWS::ApiGateway::RestApi.EndpointConfiguration.
fail_on_warnings (Union[bool, IResolvable, None]) – AWS::ApiGateway::RestApi.FailOnWarnings.
minimum_compression_size (Union[int, float, None]) – AWS::ApiGateway::RestApi.MinimumCompressionSize.
mode (Optional[str]) – AWS::ApiGateway::RestApi.Mode.
name (Optional[str]) – AWS::ApiGateway::RestApi.Name.
parameters (Union[IResolvable, Mapping[str, str], None]) – AWS::ApiGateway::RestApi.Parameters.
policy (Optional[Any]) – AWS::ApiGateway::RestApi.Policy.
tags (Optional[Sequence[CfnTag]]) – AWS::ApiGateway::RestApi.Tags.

Link

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

Attributes

api_key_source_type¶

AWS::ApiGateway::RestApi.ApiKeySourceType.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-apikeysourcetype
Return type: Optional[str]

binary_media_types¶

AWS::ApiGateway::RestApi.BinaryMediaTypes.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-binarymediatypes
Return type: Optional[List[str]]

body¶

AWS::ApiGateway::RestApi.Body.

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

body_s3_location¶

AWS::ApiGateway::RestApi.BodyS3Location.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-bodys3location
Return type: Union[IResolvable, S3LocationProperty, None]

clone_from¶

AWS::ApiGateway::RestApi.CloneFrom.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-clonefrom
Return type: Optional[str]

description¶

AWS::ApiGateway::RestApi.Description.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-description
Return type: Optional[str]

disable_execute_api_endpoint¶

AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-disableexecuteapiendpoint
Return type: Union[bool, IResolvable, None]

endpoint_configuration¶

AWS::ApiGateway::RestApi.EndpointConfiguration.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-endpointconfiguration
Return type: Union[IResolvable, EndpointConfigurationProperty, None]

fail_on_warnings¶

AWS::ApiGateway::RestApi.FailOnWarnings.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-failonwarnings
Return type: Union[bool, IResolvable, None]

minimum_compression_size¶

AWS::ApiGateway::RestApi.MinimumCompressionSize.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-minimumcompressionsize
Return type: Union[int, float, None]

mode¶

AWS::ApiGateway::RestApi.Mode.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-mode
Return type: Optional[str]

name¶

AWS::ApiGateway::RestApi.Name.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-name
Return type: Optional[str]

parameters¶

AWS::ApiGateway::RestApi.Parameters.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-parameters
Return type: Union[IResolvable, Mapping[str, str], None]

policy¶

AWS::ApiGateway::RestApi.Policy.

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

tags¶

AWS::ApiGateway::RestApi.Tags.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-tags
Return type: Optional[List[CfnTag]]