CfnHttpApiPropsMixin
- class aws_cdk.mixins_preview.aws_sam.mixins.CfnHttpApiPropsMixin(props, *, strategy=None)
Bases:
Mixin- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html
- CloudformationResource:
AWS::Serverless::HttpApi
- Mixin:
true
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview import mixins from aws_cdk.mixins_preview.aws_sam import mixins as sam_mixins # authorizers: Any # definition_body: Any cfn_http_api_props_mixin = sam_mixins.CfnHttpApiPropsMixin(sam_mixins.CfnHttpApiMixinProps( access_log_setting=sam_mixins.CfnHttpApiPropsMixin.AccessLogSettingProperty( destination_arn="destinationArn", format="format" ), auth=sam_mixins.CfnHttpApiPropsMixin.HttpApiAuthProperty( authorizers=authorizers, default_authorizer="defaultAuthorizer" ), cors_configuration=False, default_route_settings=sam_mixins.CfnHttpApiPropsMixin.RouteSettingsProperty( data_trace_enabled=False, detailed_metrics_enabled=False, logging_level="loggingLevel", throttling_burst_limit=123, throttling_rate_limit=123 ), definition_body=definition_body, definition_uri="definitionUri", description="description", disable_execute_api_endpoint=False, domain=sam_mixins.CfnHttpApiPropsMixin.HttpApiDomainConfigurationProperty( base_path="basePath", certificate_arn="certificateArn", domain_name="domainName", endpoint_configuration="endpointConfiguration", mutual_tls_authentication=sam_mixins.CfnHttpApiPropsMixin.MutualTlsAuthenticationProperty( truststore_uri="truststoreUri", truststore_version=False ), route53=sam_mixins.CfnHttpApiPropsMixin.Route53ConfigurationProperty( distributed_domain_name="distributedDomainName", evaluate_target_health=False, hosted_zone_id="hostedZoneId", hosted_zone_name="hostedZoneName", ip_v6=False ), security_policy="securityPolicy" ), fail_on_warnings=False, route_settings=sam_mixins.CfnHttpApiPropsMixin.RouteSettingsProperty( data_trace_enabled=False, detailed_metrics_enabled=False, logging_level="loggingLevel", throttling_burst_limit=123, throttling_rate_limit=123 ), stage_name="stageName", stage_variables={ "stage_variables_key": "stageVariables" }, tags={ "tags_key": "tags" } ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::Serverless::HttpApi.- Parameters:
props (
Union[CfnHttpApiMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['accessLogSetting', 'auth', 'corsConfiguration', 'defaultRouteSettings', 'definitionBody', 'definitionUri', 'description', 'disableExecuteApiEndpoint', 'domain', 'failOnWarnings', 'routeSettings', 'stageName', 'stageVariables', 'tags']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
AccessLogSettingProperty
- class CfnHttpApiPropsMixin.AccessLogSettingProperty(*, destination_arn=None, format=None)
Bases:
object- Parameters:
destination_arn (
Optional[str])format (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_sam import mixins as sam_mixins access_log_setting_property = sam_mixins.CfnHttpApiPropsMixin.AccessLogSettingProperty( destination_arn="destinationArn", format="format" )
Attributes
- destination_arn
-
- Type:
see
CorsConfigurationObjectProperty
- class CfnHttpApiPropsMixin.CorsConfigurationObjectProperty(*, allow_credentials=None, allow_headers=None, allow_methods=None, allow_origins=None, expose_headers=None, max_age=None)
Bases:
object- Parameters:
allow_credentials (
Union[bool,IResolvable,None])allow_headers (
Optional[Sequence[str]])allow_methods (
Optional[Sequence[str]])allow_origins (
Optional[Sequence[str]])expose_headers (
Optional[Sequence[str]])max_age (
Union[int,float,None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_sam import mixins as sam_mixins cors_configuration_object_property = sam_mixins.CfnHttpApiPropsMixin.CorsConfigurationObjectProperty( allow_credentials=False, allow_headers=["allowHeaders"], allow_methods=["allowMethods"], allow_origins=["allowOrigins"], expose_headers=["exposeHeaders"], max_age=123 )
Attributes
- allow_credentials
-
- Type:
see
- allow_headers
-
- Type:
see
- allow_methods
-
- Type:
see
- allow_origins
-
- Type:
see
- expose_headers
-
- Type:
see
HttpApiAuthProperty
- class CfnHttpApiPropsMixin.HttpApiAuthProperty(*, authorizers=None, default_authorizer=None)
Bases:
object- Parameters:
authorizers (
Any)default_authorizer (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_sam import mixins as sam_mixins # authorizers: Any http_api_auth_property = sam_mixins.CfnHttpApiPropsMixin.HttpApiAuthProperty( authorizers=authorizers, default_authorizer="defaultAuthorizer" )
Attributes
- authorizers
-
- Type:
see
HttpApiDomainConfigurationProperty
- class CfnHttpApiPropsMixin.HttpApiDomainConfigurationProperty(*, base_path=None, certificate_arn=None, domain_name=None, endpoint_configuration=None, mutual_tls_authentication=None, route53=None, security_policy=None)
Bases:
object- Parameters:
base_path (
Optional[str])certificate_arn (
Optional[str])domain_name (
Optional[str])endpoint_configuration (
Optional[str])mutual_tls_authentication (
Union[IResolvable,MutualTlsAuthenticationProperty,Dict[str,Any],None])route53 (
Union[IResolvable,Route53ConfigurationProperty,Dict[str,Any],None])security_policy (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_sam import mixins as sam_mixins http_api_domain_configuration_property = sam_mixins.CfnHttpApiPropsMixin.HttpApiDomainConfigurationProperty( base_path="basePath", certificate_arn="certificateArn", domain_name="domainName", endpoint_configuration="endpointConfiguration", mutual_tls_authentication=sam_mixins.CfnHttpApiPropsMixin.MutualTlsAuthenticationProperty( truststore_uri="truststoreUri", truststore_version=False ), route53=sam_mixins.CfnHttpApiPropsMixin.Route53ConfigurationProperty( distributed_domain_name="distributedDomainName", evaluate_target_health=False, hosted_zone_id="hostedZoneId", hosted_zone_name="hostedZoneName", ip_v6=False ), security_policy="securityPolicy" )
Attributes
- base_path
-
- Type:
see
- certificate_arn
-
- Type:
see
- domain_name
-
- Type:
see
- endpoint_configuration
-
- Type:
see
- mutual_tls_authentication
-
- Type:
see
- route53
-
- Type:
see
MutualTlsAuthenticationProperty
- class CfnHttpApiPropsMixin.MutualTlsAuthenticationProperty(*, truststore_uri=None, truststore_version=None)
Bases:
object- Parameters:
truststore_uri (
Optional[str])truststore_version (
Union[bool,IResolvable,None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_sam import mixins as sam_mixins mutual_tls_authentication_property = sam_mixins.CfnHttpApiPropsMixin.MutualTlsAuthenticationProperty( truststore_uri="truststoreUri", truststore_version=False )
Attributes
- truststore_uri
-
- Type:
see
Route53ConfigurationProperty
- class CfnHttpApiPropsMixin.Route53ConfigurationProperty(*, distributed_domain_name=None, evaluate_target_health=None, hosted_zone_id=None, hosted_zone_name=None, ip_v6=None)
Bases:
object- Parameters:
distributed_domain_name (
Optional[str])evaluate_target_health (
Union[bool,IResolvable,None])hosted_zone_id (
Optional[str])hosted_zone_name (
Optional[str])ip_v6 (
Union[bool,IResolvable,None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_sam import mixins as sam_mixins route53_configuration_property = sam_mixins.CfnHttpApiPropsMixin.Route53ConfigurationProperty( distributed_domain_name="distributedDomainName", evaluate_target_health=False, hosted_zone_id="hostedZoneId", hosted_zone_name="hostedZoneName", ip_v6=False )
Attributes
- distributed_domain_name
-
- Type:
see
- evaluate_target_health
-
- Type:
see
- hosted_zone_id
-
- Type:
see
- hosted_zone_name
-
- Type:
see
RouteSettingsProperty
- class CfnHttpApiPropsMixin.RouteSettingsProperty(*, data_trace_enabled=None, detailed_metrics_enabled=None, logging_level=None, throttling_burst_limit=None, throttling_rate_limit=None)
Bases:
object- Parameters:
data_trace_enabled (
Union[bool,IResolvable,None])detailed_metrics_enabled (
Union[bool,IResolvable,None])logging_level (
Optional[str])throttling_burst_limit (
Union[int,float,None])throttling_rate_limit (
Union[int,float,None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_sam import mixins as sam_mixins route_settings_property = sam_mixins.CfnHttpApiPropsMixin.RouteSettingsProperty( data_trace_enabled=False, detailed_metrics_enabled=False, logging_level="loggingLevel", throttling_burst_limit=123, throttling_rate_limit=123 )
Attributes
- data_trace_enabled
-
- Type:
see
- detailed_metrics_enabled
-
- Type:
see
- logging_level
-
- Type:
see
- throttling_burst_limit
-
- Type:
see
S3LocationProperty
- class CfnHttpApiPropsMixin.S3LocationProperty(*, bucket=None, key=None, version=None)
Bases:
object- Parameters:
bucket (
Optional[str])key (
Optional[str])version (
Union[int,float,None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_sam import mixins as sam_mixins s3_location_property = sam_mixins.CfnHttpApiPropsMixin.S3LocationProperty( bucket="bucket", key="key", version=123 )
Attributes
- bucket
-
- Type:
see
- key
-
- Type:
see