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
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
,S3LocationProperty
,None
]) –AWS::ApiGateway::RestApi.BodyS3Location
.clone_from (
Optional
[str
]) –AWS::ApiGateway::RestApi.CloneFrom
.description (
Optional
[str
]) –AWS::ApiGateway::RestApi.Description
.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
.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
[List
[CfnTag
]]) –AWS::ApiGateway::RestApi.Tags
.
- See
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html
Attributes
-
api_key_source_type
¶ AWS::ApiGateway::RestApi.ApiKeySourceType
.
-
binary_media_types
¶ AWS::ApiGateway::RestApi.BinaryMediaTypes
.- See
- Return type
Optional
[List
[str
]]
-
body
¶ AWS::ApiGateway::RestApi.Body
.
-
body_s3_location
¶ AWS::ApiGateway::RestApi.BodyS3Location
.
-
clone_from
¶ AWS::ApiGateway::RestApi.CloneFrom
.
-
description
¶ AWS::ApiGateway::RestApi.Description
.
-
endpoint_configuration
¶ AWS::ApiGateway::RestApi.EndpointConfiguration
.
-
fail_on_warnings
¶ AWS::ApiGateway::RestApi.FailOnWarnings
.
-
minimum_compression_size
¶ AWS::ApiGateway::RestApi.MinimumCompressionSize
.- See
- Return type
Union
[int
,float
,None
]
-
name
¶ AWS::ApiGateway::RestApi.Name
.
-
parameters
¶ AWS::ApiGateway::RestApi.Parameters
.- See
- Return type
Union
[IResolvable
,Mapping
[str
,str
],None
]
-
policy
¶ AWS::ApiGateway::RestApi.Policy
.
AWS::ApiGateway::RestApi.Tags
.- See
- Return type
Optional
[List
[CfnTag
]]