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, domain=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
CfnApi
.- Parameters
stage_name (
str
) –AWS::Serverless::Api.StageName
.access_log_setting (
Union
[AccessLogSettingProperty
,IResolvable
,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
.domain (
Union
[IResolvable
,DomainConfigurationProperty
,None
]) –AWS::Serverless::Api.Domain
.endpoint_configuration (
Union
[str
,IResolvable
,EndpointConfigurationProperty
,None
]) –AWS::Serverless::Api.EndpointConfiguration
.gateway_responses (
Optional
[Any
]) –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 (
Optional
[Any
]) –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
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam # authorizers: Any # definition_body: Any # gateway_responses: Any # method_settings: Any # models: Any cfn_api_props = sam.CfnApiProps( stage_name="stageName", # the properties below are optional access_log_setting=sam.CfnApi.AccessLogSettingProperty( destination_arn="destinationArn", format="format" ), auth=sam.CfnApi.AuthProperty( authorizers=authorizers, default_authorizer="defaultAuthorizer" ), binary_media_types=["binaryMediaTypes"], cache_cluster_enabled=False, cache_cluster_size="cacheClusterSize", canary_setting=sam.CfnApi.CanarySettingProperty( deployment_id="deploymentId", percent_traffic=123, stage_variable_overrides={ "stage_variable_overrides_key": "stageVariableOverrides" }, use_stage_cache=False ), cors="cors", definition_body=definition_body, definition_uri="definitionUri", description="description", domain=sam.CfnApi.DomainConfigurationProperty( certificate_arn="certificateArn", domain_name="domainName", # the properties below are optional base_path=["basePath"], endpoint_configuration="endpointConfiguration", mutual_tls_authentication=sam.CfnApi.MutualTlsAuthenticationProperty( truststore_uri="truststoreUri", truststore_version="truststoreVersion" ), ownership_verification_certificate_arn="ownershipVerificationCertificateArn", route53=sam.CfnApi.Route53ConfigurationProperty( distributed_domain_name="distributedDomainName", evaluate_target_health=False, hosted_zone_id="hostedZoneId", hosted_zone_name="hostedZoneName", ip_v6=False ), security_policy="securityPolicy" ), endpoint_configuration="endpointConfiguration", gateway_responses=gateway_responses, method_settings=[method_settings], minimum_compression_size=123, models=models, name="name", open_api_version="openApiVersion", tags={ "tags_key": "tags" }, tracing_enabled=False, variables={ "variables_key": "variables" } )
Attributes
-
access_log_setting
¶ AWS::Serverless::Api.AccessLogSetting
.
-
auth
¶ AWS::Serverless::Api.Auth
.- Link
- Return type
Union
[IResolvable
,AuthProperty
,None
]
-
binary_media_types
¶ AWS::Serverless::Api.BinaryMediaTypes
.- Link
- Return type
Optional
[List
[str
]]
-
cache_cluster_enabled
¶ AWS::Serverless::Api.CacheClusterEnabled
.- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
cache_cluster_size
¶ AWS::Serverless::Api.CacheClusterSize
.- Link
- Return type
Optional
[str
]
-
canary_setting
¶ AWS::Serverless::Api.CanarySetting
.
-
cors
¶ AWS::Serverless::Api.Cors
.- Link
- Return type
Union
[str
,IResolvable
,CorsConfigurationProperty
,None
]
-
definition_body
¶ AWS::Serverless::Api.DefinitionBody
.
-
definition_uri
¶ AWS::Serverless::Api.DefinitionUri
.- Link
- Return type
Union
[str
,IResolvable
,S3LocationProperty
,None
]
-
description
¶ AWS::Serverless::Api.Description
.- Link
- Return type
Optional
[str
]
-
domain
¶ AWS::Serverless::Api.Domain
.
-
endpoint_configuration
¶ AWS::Serverless::Api.EndpointConfiguration
.- Link
- Return type
Union
[str
,IResolvable
,EndpointConfigurationProperty
,None
]
-
gateway_responses
¶ AWS::Serverless::Api.GatewayResponses
.
-
method_settings
¶ AWS::Serverless::Api.MethodSettings
.- Link
- Return type
Union
[List
[Any
],IResolvable
,None
]
-
minimum_compression_size
¶ AWS::Serverless::Api.MinimumCompressionSize
.- Link
- Return type
Union
[int
,float
,None
]
-
models
¶ AWS::Serverless::Api.Models
.
-
name
¶ AWS::Serverless::Api.Name
.- Link
- Return type
Optional
[str
]
-
open_api_version
¶ AWS::Serverless::Api.OpenApiVersion
.- Link
- Return type
Optional
[str
]
-
stage_name
¶ AWS::Serverless::Api.StageName
.
AWS::Serverless::Api.Tags
.- Link
- Return type
Optional
[Mapping
[str
,str
]]
-
tracing_enabled
¶ AWS::Serverless::Api.TracingEnabled
.- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
variables
¶ AWS::Serverless::Api.Variables
.- Link
- Return type
Union
[IResolvable
,Mapping
[str
,str
],None
]