CfnHttpApi
- class aws_cdk.aws_sam.CfnHttpApi(scope, id, *, access_log_setting=None, auth=None, cors_configuration=None, default_route_settings=None, definition_body=None, definition_uri=None, description=None, disable_execute_api_endpoint=None, domain=None, fail_on_warnings=None, route_settings=None, stage_name=None, stage_variables=None, tags=None)
Bases:
CfnResourceA CloudFormation
AWS::Serverless::HttpApi.- CloudformationResource:
AWS::Serverless::HttpApi
- 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 cfn_http_api = sam.CfnHttpApi(self, "MyCfnHttpApi", access_log_setting=sam.CfnHttpApi.AccessLogSettingProperty( destination_arn="destinationArn", format="format" ), auth=sam.CfnHttpApi.HttpApiAuthProperty( authorizers=authorizers, default_authorizer="defaultAuthorizer" ), cors_configuration=False, default_route_settings=sam.CfnHttpApi.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.CfnHttpApi.HttpApiDomainConfigurationProperty( certificate_arn="certificateArn", domain_name="domainName", # the properties below are optional base_path="basePath", endpoint_configuration="endpointConfiguration", mutual_tls_authentication=sam.CfnHttpApi.MutualTlsAuthenticationProperty( truststore_uri="truststoreUri", truststore_version=False ), route53=sam.CfnHttpApi.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.CfnHttpApi.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" } )
Create a new
AWS::Serverless::HttpApi.- Parameters:
scope (
Construct) –scope in which this resource is defined.
id (
str) –scoped id of the resource.
access_log_setting (
Union[IResolvable,AccessLogSettingProperty,Dict[str,Any],None]) –AWS::Serverless::HttpApi.AccessLogSetting.auth (
Union[IResolvable,HttpApiAuthProperty,Dict[str,Any],None]) –AWS::Serverless::HttpApi.Auth.cors_configuration (
Union[bool,IResolvable,CorsConfigurationObjectProperty,Dict[str,Any],None]) –AWS::Serverless::HttpApi.CorsConfiguration.default_route_settings (
Union[IResolvable,RouteSettingsProperty,Dict[str,Any],None]) –AWS::Serverless::HttpApi.DefaultRouteSettings.definition_body (
Optional[Any]) –AWS::Serverless::HttpApi.DefinitionBody.definition_uri (
Union[str,IResolvable,S3LocationProperty,Dict[str,Any],None]) –AWS::Serverless::HttpApi.DefinitionUri.description (
Optional[str]) –AWS::Serverless::HttpApi.Description.disable_execute_api_endpoint (
Union[bool,IResolvable,None]) –AWS::Serverless::HttpApi.DisableExecuteApiEndpoint.domain (
Union[IResolvable,HttpApiDomainConfigurationProperty,Dict[str,Any],None]) –AWS::Serverless::HttpApi.Domain.fail_on_warnings (
Union[bool,IResolvable,None]) –AWS::Serverless::HttpApi.FailOnWarnings.route_settings (
Union[IResolvable,RouteSettingsProperty,Dict[str,Any],None]) –AWS::Serverless::HttpApi.RouteSettings.stage_name (
Optional[str]) –AWS::Serverless::HttpApi.StageName.stage_variables (
Union[IResolvable,Mapping[str,str],None]) –AWS::Serverless::HttpApi.StageVariables.tags (
Optional[Mapping[str,str]]) –AWS::Serverless::HttpApi.Tags.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource) –- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str) –value (
Any) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).- Parameters:
policy (
Optional[RemovalPolicy]) –apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::Serverless::HttpApi'
- REQUIRED_TRANSFORM = 'AWS::Serverless-2016-10-31'
- access_log_setting
AWS::Serverless::HttpApi.AccessLogSetting.
- auth
AWS::Serverless::HttpApi.Auth.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- cors_configuration
AWS::Serverless::HttpApi.CorsConfiguration.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- default_route_settings
AWS::Serverless::HttpApi.DefaultRouteSettings.
- definition_body
AWS::Serverless::HttpApi.DefinitionBody.
- definition_uri
AWS::Serverless::HttpApi.DefinitionUri.
- description
AWS::Serverless::HttpApi.Description.
- disable_execute_api_endpoint
AWS::Serverless::HttpApi.DisableExecuteApiEndpoint.
- domain
AWS::Serverless::HttpApi.Domain.
- fail_on_warnings
AWS::Serverless::HttpApi.FailOnWarnings.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- node
The construct tree node associated with this construct.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- route_settings
AWS::Serverless::HttpApi.RouteSettings.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- stage_name
AWS::Serverless::HttpApi.StageName.
- stage_variables
AWS::Serverless::HttpApi.StageVariables.
- tags
AWS::Serverless::HttpApi.Tags.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any) –- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct) –- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any) –- Return type:
bool
AccessLogSettingProperty
- class CfnHttpApi.AccessLogSettingProperty(*, destination_arn=None, format=None)
Bases:
object- Parameters:
destination_arn (
Optional[str]) –CfnHttpApi.AccessLogSettingProperty.DestinationArn.format (
Optional[str]) –CfnHttpApi.AccessLogSettingProperty.Format.
- 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 access_log_setting_property = sam.CfnHttpApi.AccessLogSettingProperty( destination_arn="destinationArn", format="format" )
Attributes
- destination_arn
CfnHttpApi.AccessLogSettingProperty.DestinationArn.
- format
CfnHttpApi.AccessLogSettingProperty.Format.
CorsConfigurationObjectProperty
- class CfnHttpApi.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]) –CfnHttpApi.CorsConfigurationObjectProperty.AllowCredentials.allow_headers (
Optional[Sequence[str]]) –CfnHttpApi.CorsConfigurationObjectProperty.AllowHeaders.allow_methods (
Optional[Sequence[str]]) –CfnHttpApi.CorsConfigurationObjectProperty.AllowMethods.allow_origins (
Optional[Sequence[str]]) –CfnHttpApi.CorsConfigurationObjectProperty.AllowOrigins.expose_headers (
Optional[Sequence[str]]) –CfnHttpApi.CorsConfigurationObjectProperty.ExposeHeaders.max_age (
Union[int,float,None]) –CfnHttpApi.CorsConfigurationObjectProperty.MaxAge.
- 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 cors_configuration_object_property = sam.CfnHttpApi.CorsConfigurationObjectProperty( allow_credentials=False, allow_headers=["allowHeaders"], allow_methods=["allowMethods"], allow_origins=["allowOrigins"], expose_headers=["exposeHeaders"], max_age=123 )
Attributes
- allow_credentials
CfnHttpApi.CorsConfigurationObjectProperty.AllowCredentials.
- allow_headers
CfnHttpApi.CorsConfigurationObjectProperty.AllowHeaders.
- allow_methods
CfnHttpApi.CorsConfigurationObjectProperty.AllowMethods.
- allow_origins
CfnHttpApi.CorsConfigurationObjectProperty.AllowOrigins.
- expose_headers
CfnHttpApi.CorsConfigurationObjectProperty.ExposeHeaders.
- max_age
CfnHttpApi.CorsConfigurationObjectProperty.MaxAge.
HttpApiAuthProperty
- class CfnHttpApi.HttpApiAuthProperty(*, authorizers=None, default_authorizer=None)
Bases:
object- Parameters:
authorizers (
Optional[Any]) –CfnHttpApi.HttpApiAuthProperty.Authorizers.default_authorizer (
Optional[str]) –CfnHttpApi.HttpApiAuthProperty.DefaultAuthorizer.
- 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 http_api_auth_property = sam.CfnHttpApi.HttpApiAuthProperty( authorizers=authorizers, default_authorizer="defaultAuthorizer" )
Attributes
- authorizers
CfnHttpApi.HttpApiAuthProperty.Authorizers.
- default_authorizer
CfnHttpApi.HttpApiAuthProperty.DefaultAuthorizer.
HttpApiDomainConfigurationProperty
- class CfnHttpApi.HttpApiDomainConfigurationProperty(*, certificate_arn, domain_name, base_path=None, endpoint_configuration=None, mutual_tls_authentication=None, route53=None, security_policy=None)
Bases:
object- Parameters:
certificate_arn (
str) –CfnHttpApi.HttpApiDomainConfigurationProperty.CertificateArn.domain_name (
str) –CfnHttpApi.HttpApiDomainConfigurationProperty.DomainName.base_path (
Optional[str]) –CfnHttpApi.HttpApiDomainConfigurationProperty.BasePath.endpoint_configuration (
Optional[str]) –CfnHttpApi.HttpApiDomainConfigurationProperty.EndpointConfiguration.mutual_tls_authentication (
Union[IResolvable,MutualTlsAuthenticationProperty,Dict[str,Any],None]) –CfnHttpApi.HttpApiDomainConfigurationProperty.MutualTlsAuthentication.route53 (
Union[IResolvable,Route53ConfigurationProperty,Dict[str,Any],None]) –CfnHttpApi.HttpApiDomainConfigurationProperty.Route53.security_policy (
Optional[str]) –CfnHttpApi.HttpApiDomainConfigurationProperty.SecurityPolicy.
- 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 http_api_domain_configuration_property = sam.CfnHttpApi.HttpApiDomainConfigurationProperty( certificate_arn="certificateArn", domain_name="domainName", # the properties below are optional base_path="basePath", endpoint_configuration="endpointConfiguration", mutual_tls_authentication=sam.CfnHttpApi.MutualTlsAuthenticationProperty( truststore_uri="truststoreUri", truststore_version=False ), route53=sam.CfnHttpApi.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
CfnHttpApi.HttpApiDomainConfigurationProperty.BasePath.
- certificate_arn
CfnHttpApi.HttpApiDomainConfigurationProperty.CertificateArn.
- domain_name
CfnHttpApi.HttpApiDomainConfigurationProperty.DomainName.
- endpoint_configuration
CfnHttpApi.HttpApiDomainConfigurationProperty.EndpointConfiguration.
- mutual_tls_authentication
CfnHttpApi.HttpApiDomainConfigurationProperty.MutualTlsAuthentication.
- route53
CfnHttpApi.HttpApiDomainConfigurationProperty.Route53.
- security_policy
CfnHttpApi.HttpApiDomainConfigurationProperty.SecurityPolicy.
MutualTlsAuthenticationProperty
- class CfnHttpApi.MutualTlsAuthenticationProperty(*, truststore_uri=None, truststore_version=None)
Bases:
object- Parameters:
truststore_uri (
Optional[str]) –CfnHttpApi.MutualTlsAuthenticationProperty.TruststoreUri.truststore_version (
Union[bool,IResolvable,None]) –CfnHttpApi.MutualTlsAuthenticationProperty.TruststoreVersion.
- 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 mutual_tls_authentication_property = sam.CfnHttpApi.MutualTlsAuthenticationProperty( truststore_uri="truststoreUri", truststore_version=False )
Attributes
- truststore_uri
CfnHttpApi.MutualTlsAuthenticationProperty.TruststoreUri.
- truststore_version
CfnHttpApi.MutualTlsAuthenticationProperty.TruststoreVersion.
Route53ConfigurationProperty
- class CfnHttpApi.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]) –CfnHttpApi.Route53ConfigurationProperty.DistributedDomainName.evaluate_target_health (
Union[bool,IResolvable,None]) –CfnHttpApi.Route53ConfigurationProperty.EvaluateTargetHealth.hosted_zone_id (
Optional[str]) –CfnHttpApi.Route53ConfigurationProperty.HostedZoneId.hosted_zone_name (
Optional[str]) –CfnHttpApi.Route53ConfigurationProperty.HostedZoneName.ip_v6 (
Union[bool,IResolvable,None]) –CfnHttpApi.Route53ConfigurationProperty.IpV6.
- 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 route53_configuration_property = sam.CfnHttpApi.Route53ConfigurationProperty( distributed_domain_name="distributedDomainName", evaluate_target_health=False, hosted_zone_id="hostedZoneId", hosted_zone_name="hostedZoneName", ip_v6=False )
Attributes
- distributed_domain_name
CfnHttpApi.Route53ConfigurationProperty.DistributedDomainName.
- evaluate_target_health
CfnHttpApi.Route53ConfigurationProperty.EvaluateTargetHealth.
- hosted_zone_id
CfnHttpApi.Route53ConfigurationProperty.HostedZoneId.
- hosted_zone_name
CfnHttpApi.Route53ConfigurationProperty.HostedZoneName.
- ip_v6
CfnHttpApi.Route53ConfigurationProperty.IpV6.
RouteSettingsProperty
- class CfnHttpApi.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]) –CfnHttpApi.RouteSettingsProperty.DataTraceEnabled.detailed_metrics_enabled (
Union[bool,IResolvable,None]) –CfnHttpApi.RouteSettingsProperty.DetailedMetricsEnabled.logging_level (
Optional[str]) –CfnHttpApi.RouteSettingsProperty.LoggingLevel.throttling_burst_limit (
Union[int,float,None]) –CfnHttpApi.RouteSettingsProperty.ThrottlingBurstLimit.throttling_rate_limit (
Union[int,float,None]) –CfnHttpApi.RouteSettingsProperty.ThrottlingRateLimit.
- 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 route_settings_property = sam.CfnHttpApi.RouteSettingsProperty( data_trace_enabled=False, detailed_metrics_enabled=False, logging_level="loggingLevel", throttling_burst_limit=123, throttling_rate_limit=123 )
Attributes
- data_trace_enabled
CfnHttpApi.RouteSettingsProperty.DataTraceEnabled.
- detailed_metrics_enabled
CfnHttpApi.RouteSettingsProperty.DetailedMetricsEnabled.
- logging_level
CfnHttpApi.RouteSettingsProperty.LoggingLevel.
- throttling_burst_limit
CfnHttpApi.RouteSettingsProperty.ThrottlingBurstLimit.
- throttling_rate_limit
CfnHttpApi.RouteSettingsProperty.ThrottlingRateLimit.
S3LocationProperty
- class CfnHttpApi.S3LocationProperty(*, bucket, key, version)
Bases:
object- Parameters:
bucket (
str) –CfnHttpApi.S3LocationProperty.Bucket.key (
str) –CfnHttpApi.S3LocationProperty.Key.version (
Union[int,float]) –CfnHttpApi.S3LocationProperty.Version.
- 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 s3_location_property = sam.CfnHttpApi.S3LocationProperty( bucket="bucket", key="key", version=123 )
Attributes
- bucket
CfnHttpApi.S3LocationProperty.Bucket.
- key
CfnHttpApi.S3LocationProperty.Key.
- version
CfnHttpApi.S3LocationProperty.Version.