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, endpoint_configuration=None, fail_on_warnings=None, minimum_compression_size=None, name=None, parameters=None, policy=None, tags=None)

Bases: object

__init__(*, api_key_source_type=None, binary_media_types=None, body=None, body_s3_location=None, clone_from=None, description=None, endpoint_configuration=None, fail_on_warnings=None, minimum_compression_size=None, name=None, parameters=None, policy=None, tags=None)

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

Parameters
  • api_key_source_type (Optional[str]) – AWS::ApiGateway::RestApi.ApiKeySourceType.

  • binary_media_types (Optional[List[str]]) – AWS::ApiGateway::RestApi.BinaryMediaTypes.

  • body (Optional[Any]) – AWS::ApiGateway::RestApi.Body.

  • body_s3_location (Union[IResolvable, None, S3LocationProperty]) – AWS::ApiGateway::RestApi.BodyS3Location.

  • clone_from (Optional[str]) – AWS::ApiGateway::RestApi.CloneFrom.

  • description (Optional[str]) – AWS::ApiGateway::RestApi.Description.

  • endpoint_configuration (Union[IResolvable, None, EndpointConfigurationProperty]) – AWS::ApiGateway::RestApi.EndpointConfiguration.

  • fail_on_warnings (Union[bool, None, IResolvable]) – AWS::ApiGateway::RestApi.FailOnWarnings.

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

  • name (Optional[str]) – AWS::ApiGateway::RestApi.Name.

  • parameters (Union[IResolvable, None, Mapping[str, str]]) – AWS::ApiGateway::RestApi.Parameters.

  • policy (Optional[Any]) – AWS::ApiGateway::RestApi.Policy.

  • tags (Optional[List[CfnTag]]) – AWS::ApiGateway::RestApi.Tags.

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

Attributes

api_key_source_type

AWS::ApiGateway::RestApi.ApiKeySourceType.

see :see: 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.

see :see: 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.

see :see: 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.

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

Return type

Union[IResolvable, None, S3LocationProperty]

clone_from

AWS::ApiGateway::RestApi.CloneFrom.

see :see: 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.

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

Return type

Optional[str]

endpoint_configuration

AWS::ApiGateway::RestApi.EndpointConfiguration.

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

Return type

Union[IResolvable, None, EndpointConfigurationProperty]

fail_on_warnings

AWS::ApiGateway::RestApi.FailOnWarnings.

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

Return type

Union[bool, None, IResolvable]

minimum_compression_size

AWS::ApiGateway::RestApi.MinimumCompressionSize.

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

Return type

Union[int, float, None]

name

AWS::ApiGateway::RestApi.Name.

see :see: 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.

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

Return type

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

policy

AWS::ApiGateway::RestApi.Policy.

see :see: 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.

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

Return type

Optional[List[CfnTag]]