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.- Return type
Optional[str]
-
binary_media_types¶ AWS::ApiGateway::RestApi.BinaryMediaTypes.- Return type
Optional[List[str]]
-
body¶ AWS::ApiGateway::RestApi.Body.- Return type
Any
-
body_s3_location¶ AWS::ApiGateway::RestApi.BodyS3Location.- Return type
Union[IResolvable,None,S3LocationProperty]
-
clone_from¶ AWS::ApiGateway::RestApi.CloneFrom.- Return type
Optional[str]
-
description¶ AWS::ApiGateway::RestApi.Description.- Return type
Optional[str]
-
endpoint_configuration¶ AWS::ApiGateway::RestApi.EndpointConfiguration.- Return type
Union[IResolvable,None,EndpointConfigurationProperty]
-
fail_on_warnings¶ AWS::ApiGateway::RestApi.FailOnWarnings.- Return type
Union[bool,None,IResolvable]
-
minimum_compression_size¶ AWS::ApiGateway::RestApi.MinimumCompressionSize.- Return type
Union[int,float,None]
-
name¶ AWS::ApiGateway::RestApi.Name.- Return type
Optional[str]
-
parameters¶ AWS::ApiGateway::RestApi.Parameters.- Return type
Union[IResolvable,None,Mapping[str,str]]
-
policy¶ AWS::ApiGateway::RestApi.Policy.- Return type
Any
AWS::ApiGateway::RestApi.Tags.- Return type
Optional[List[CfnTag]]
-