CfnApi

class aws_cdk.aws_sam.CfnApi(scope, id, *, 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: aws_cdk.core.CfnResource

A CloudFormation AWS::Serverless::Api.

CloudformationResource

AWS::Serverless::Api

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

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 = sam.CfnApi(self, "MyCfnApi",
    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"
    }
)

Create a new AWS::Serverless::Api.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • 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.

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

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.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “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 value argument to addOverride will 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: true

  • default (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

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

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.

Return type

Any

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::Api'
REQUIRED_TRANSFORM = 'AWS::Serverless-2016-10-31'
access_log_setting

AWS::Serverless::Api.AccessLogSetting.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Return type

Union[AccessLogSettingProperty, IResolvable, None]

auth

AWS::Serverless::Api.Auth.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Return type

Union[IResolvable, AuthProperty, None]

binary_media_types

AWS::Serverless::Api.BinaryMediaTypes.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Return type

Optional[List[str]]

cache_cluster_enabled

AWS::Serverless::Api.CacheClusterEnabled.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Return type

Union[bool, IResolvable, None]

cache_cluster_size

AWS::Serverless::Api.CacheClusterSize.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Return type

Optional[str]

canary_setting

AWS::Serverless::Api.CanarySetting.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-api.html#sam-api-canarysetting

Return type

Union[IResolvable, CanarySettingProperty, None]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

cors

AWS::Serverless::Api.Cors.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Return type

Union[str, IResolvable, CorsConfigurationProperty, None]

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.

Return type

List[str]

definition_body

AWS::Serverless::Api.DefinitionBody.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Return type

Any

definition_uri

AWS::Serverless::Api.DefinitionUri.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Return type

Union[str, IResolvable, S3LocationProperty, None]

description

AWS::Serverless::Api.Description.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-api.html#sam-api-description

Return type

Optional[str]

domain

AWS::Serverless::Api.Domain.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-api.html#sam-api-domain

Return type

Union[IResolvable, DomainConfigurationProperty, None]

endpoint_configuration

AWS::Serverless::Api.EndpointConfiguration.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Return type

Union[str, IResolvable, EndpointConfigurationProperty, None]

gateway_responses

AWS::Serverless::Api.GatewayResponses.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-api.html#sam-api-gatewayresponses

Return type

Any

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).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

method_settings

AWS::Serverless::Api.MethodSettings.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Return type

Union[List[Any], IResolvable, None]

minimum_compression_size

AWS::Serverless::Api.MinimumCompressionSize.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-api.html#sam-api-minimumcompressionsize

Return type

Union[int, float, None]

models

AWS::Serverless::Api.Models.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-api.html#sam-api-models

Return type

Any

name

AWS::Serverless::Api.Name.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Return type

Optional[str]

node

The construct tree node associated with this construct.

Return type

ConstructNode

open_api_version

AWS::Serverless::Api.OpenApiVersion.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Return type

Optional[str]

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 }).

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

stage_name

AWS::Serverless::Api.StageName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Return type

str

tags

AWS::Serverless::Api.Tags.

Link

https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

Return type

TagManager

tracing_enabled

AWS::Serverless::Api.TracingEnabled.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Return type

Union[bool, IResolvable, None]

variables

AWS::Serverless::Api.Variables.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi

Return type

Union[IResolvable, Mapping[str, str], None]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to 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 CfnApi.AccessLogSettingProperty(*, destination_arn=None, format=None)

Bases: object

Parameters
  • destination_arn (Optional[str]) – CfnApi.AccessLogSettingProperty.DestinationArn.

  • format (Optional[str]) – CfnApi.AccessLogSettingProperty.Format.

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html

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.CfnApi.AccessLogSettingProperty(
    destination_arn="destinationArn",
    format="format"
)

Attributes

destination_arn

CfnApi.AccessLogSettingProperty.DestinationArn.

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html#cfn-apigateway-stage-accesslogsetting-destinationarn

Return type

Optional[str]

format

CfnApi.AccessLogSettingProperty.Format.

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html#cfn-apigateway-stage-accesslogsetting-format

Return type

Optional[str]

AuthProperty

class CfnApi.AuthProperty(*, authorizers=None, default_authorizer=None)

Bases: object

Parameters
  • authorizers (Optional[Any]) – CfnApi.AuthProperty.Authorizers.

  • default_authorizer (Optional[str]) – CfnApi.AuthProperty.DefaultAuthorizer.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api-auth-object

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

auth_property = sam.CfnApi.AuthProperty(
    authorizers=authorizers,
    default_authorizer="defaultAuthorizer"
)

Attributes

authorizers

CfnApi.AuthProperty.Authorizers.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api-auth-object

Return type

Any

default_authorizer

CfnApi.AuthProperty.DefaultAuthorizer.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api-auth-object

Return type

Optional[str]

CanarySettingProperty

class CfnApi.CanarySettingProperty(*, deployment_id=None, percent_traffic=None, stage_variable_overrides=None, use_stage_cache=None)

Bases: object

Parameters
  • deployment_id (Optional[str]) – CfnApi.CanarySettingProperty.DeploymentId.

  • percent_traffic (Union[int, float, None]) – CfnApi.CanarySettingProperty.PercentTraffic.

  • stage_variable_overrides (Union[IResolvable, Mapping[str, str], None]) – CfnApi.CanarySettingProperty.StageVariableOverrides.

  • use_stage_cache (Union[bool, IResolvable, None]) – CfnApi.CanarySettingProperty.UseStageCache.

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html

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

canary_setting_property = sam.CfnApi.CanarySettingProperty(
    deployment_id="deploymentId",
    percent_traffic=123,
    stage_variable_overrides={
        "stage_variable_overrides_key": "stageVariableOverrides"
    },
    use_stage_cache=False
)

Attributes

deployment_id

CfnApi.CanarySettingProperty.DeploymentId.

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-deploymentid

Return type

Optional[str]

percent_traffic

CfnApi.CanarySettingProperty.PercentTraffic.

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-percenttraffic

Return type

Union[int, float, None]

stage_variable_overrides

CfnApi.CanarySettingProperty.StageVariableOverrides.

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-stagevariableoverrides

Return type

Union[IResolvable, Mapping[str, str], None]

use_stage_cache

CfnApi.CanarySettingProperty.UseStageCache.

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-usestagecache

Return type

Union[bool, IResolvable, None]

CorsConfigurationProperty

class CfnApi.CorsConfigurationProperty(*, allow_origin, allow_credentials=None, allow_headers=None, allow_methods=None, max_age=None)

Bases: object

Parameters
  • allow_origin (str) – CfnApi.CorsConfigurationProperty.AllowOrigin.

  • allow_credentials (Union[bool, IResolvable, None]) – CfnApi.CorsConfigurationProperty.AllowCredentials.

  • allow_headers (Optional[str]) – CfnApi.CorsConfigurationProperty.AllowHeaders.

  • allow_methods (Optional[str]) – CfnApi.CorsConfigurationProperty.AllowMethods.

  • max_age (Optional[str]) – CfnApi.CorsConfigurationProperty.MaxAge.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#cors-configuration

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_property = sam.CfnApi.CorsConfigurationProperty(
    allow_origin="allowOrigin",

    # the properties below are optional
    allow_credentials=False,
    allow_headers="allowHeaders",
    allow_methods="allowMethods",
    max_age="maxAge"
)

Attributes

allow_credentials

CfnApi.CorsConfigurationProperty.AllowCredentials.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#cors-configuration

Return type

Union[bool, IResolvable, None]

allow_headers

CfnApi.CorsConfigurationProperty.AllowHeaders.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#cors-configuration

Return type

Optional[str]

allow_methods

CfnApi.CorsConfigurationProperty.AllowMethods.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#cors-configuration

Return type

Optional[str]

allow_origin

CfnApi.CorsConfigurationProperty.AllowOrigin.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#cors-configuration

Return type

str

max_age

CfnApi.CorsConfigurationProperty.MaxAge.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#cors-configuration

Return type

Optional[str]

DomainConfigurationProperty

class CfnApi.DomainConfigurationProperty(*, certificate_arn, domain_name, base_path=None, endpoint_configuration=None, mutual_tls_authentication=None, ownership_verification_certificate_arn=None, route53=None, security_policy=None)

Bases: object

Parameters
  • certificate_arn (str) – CfnApi.DomainConfigurationProperty.CertificateArn.

  • domain_name (str) – CfnApi.DomainConfigurationProperty.DomainName.

  • base_path (Optional[Sequence[str]]) – CfnApi.DomainConfigurationProperty.BasePath.

  • endpoint_configuration (Optional[str]) – CfnApi.DomainConfigurationProperty.EndpointConfiguration.

  • mutual_tls_authentication (Union[IResolvable, MutualTlsAuthenticationProperty, None]) – CfnApi.DomainConfigurationProperty.MutualTlsAuthentication.

  • ownership_verification_certificate_arn (Optional[str]) – CfnApi.DomainConfigurationProperty.OwnershipVerificationCertificateArn.

  • route53 (Union[IResolvable, Route53ConfigurationProperty, None]) – CfnApi.DomainConfigurationProperty.Route53.

  • security_policy (Optional[str]) – CfnApi.DomainConfigurationProperty.SecurityPolicy.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-domainconfiguration.html

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

domain_configuration_property = 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"
)

Attributes

base_path

CfnApi.DomainConfigurationProperty.BasePath.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-domainconfiguration.html#sam-api-domainconfiguration-basepath

Return type

Optional[List[str]]

certificate_arn

CfnApi.DomainConfigurationProperty.CertificateArn.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-domainconfiguration.html#sam-api-domainconfiguration-certificatearn

Return type

str

domain_name

CfnApi.DomainConfigurationProperty.DomainName.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-domainconfiguration.html#sam-api-domainconfiguration-domainname

Return type

str

endpoint_configuration

CfnApi.DomainConfigurationProperty.EndpointConfiguration.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-domainconfiguration.html#sam-api-domainconfiguration-endpointconfiguration

Return type

Optional[str]

mutual_tls_authentication

CfnApi.DomainConfigurationProperty.MutualTlsAuthentication.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-domainconfiguration.html#sam-api-domainconfiguration-mutualtlsauthentication

Return type

Union[IResolvable, MutualTlsAuthenticationProperty, None]

ownership_verification_certificate_arn

CfnApi.DomainConfigurationProperty.OwnershipVerificationCertificateArn.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-domainconfiguration.html#sam-api-domainconfiguration-ownershipverificationcertificatearn

Return type

Optional[str]

route53

CfnApi.DomainConfigurationProperty.Route53.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-domainconfiguration.html#sam-api-domainconfiguration-route53

Return type

Union[IResolvable, Route53ConfigurationProperty, None]

security_policy

CfnApi.DomainConfigurationProperty.SecurityPolicy.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-domainconfiguration.html#sam-api-domainconfiguration-securitypolicy

Return type

Optional[str]

EndpointConfigurationProperty

class CfnApi.EndpointConfigurationProperty(*, type=None, vpc_endpoint_ids=None)

Bases: object

Parameters
  • type (Optional[str]) – CfnApi.EndpointConfigurationProperty.Type.

  • vpc_endpoint_ids (Optional[Sequence[str]]) – CfnApi.EndpointConfigurationProperty.VpcEndpointIds.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-endpointconfiguration.html

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

endpoint_configuration_property = sam.CfnApi.EndpointConfigurationProperty(
    type="type",
    vpc_endpoint_ids=["vpcEndpointIds"]
)

Attributes

type

CfnApi.EndpointConfigurationProperty.Type.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-endpointconfiguration.html#sam-api-endpointconfiguration-type

Return type

Optional[str]

vpc_endpoint_ids

CfnApi.EndpointConfigurationProperty.VpcEndpointIds.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-endpointconfiguration.html#sam-api-endpointconfiguration-vpcendpointids

Return type

Optional[List[str]]

MutualTlsAuthenticationProperty

class CfnApi.MutualTlsAuthenticationProperty(*, truststore_uri=None, truststore_version=None)

Bases: object

Parameters
  • truststore_uri (Optional[str]) – CfnApi.MutualTlsAuthenticationProperty.TruststoreUri.

  • truststore_version (Optional[str]) – CfnApi.MutualTlsAuthenticationProperty.TruststoreVersion.

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html

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.CfnApi.MutualTlsAuthenticationProperty(
    truststore_uri="truststoreUri",
    truststore_version="truststoreVersion"
)

Attributes

truststore_uri

CfnApi.MutualTlsAuthenticationProperty.TruststoreUri.

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html#cfn-apigateway-domainname-mutualtlsauthentication-truststoreuri

Return type

Optional[str]

truststore_version

CfnApi.MutualTlsAuthenticationProperty.TruststoreVersion.

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html#cfn-apigateway-domainname-mutualtlsauthentication-truststoreversion

Return type

Optional[str]

Route53ConfigurationProperty

class CfnApi.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]) – CfnApi.Route53ConfigurationProperty.DistributedDomainName.

  • evaluate_target_health (Union[bool, IResolvable, None]) – CfnApi.Route53ConfigurationProperty.EvaluateTargetHealth.

  • hosted_zone_id (Optional[str]) – CfnApi.Route53ConfigurationProperty.HostedZoneId.

  • hosted_zone_name (Optional[str]) – CfnApi.Route53ConfigurationProperty.HostedZoneName.

  • ip_v6 (Union[bool, IResolvable, None]) – CfnApi.Route53ConfigurationProperty.IpV6.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-route53configuration.html

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.CfnApi.Route53ConfigurationProperty(
    distributed_domain_name="distributedDomainName",
    evaluate_target_health=False,
    hosted_zone_id="hostedZoneId",
    hosted_zone_name="hostedZoneName",
    ip_v6=False
)

Attributes

distributed_domain_name

CfnApi.Route53ConfigurationProperty.DistributedDomainName.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-route53configuration.html#sam-api-route53configuration-distributiondomainname

Return type

Optional[str]

evaluate_target_health

CfnApi.Route53ConfigurationProperty.EvaluateTargetHealth.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-route53configuration.html#sam-api-route53configuration-evaluatetargethealth

Return type

Union[bool, IResolvable, None]

hosted_zone_id

CfnApi.Route53ConfigurationProperty.HostedZoneId.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-route53configuration.html#sam-api-route53configuration-hostedzoneid

Return type

Optional[str]

hosted_zone_name

CfnApi.Route53ConfigurationProperty.HostedZoneName.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-route53configuration.html#sam-api-route53configuration-hostedzonename

Return type

Optional[str]

ip_v6

CfnApi.Route53ConfigurationProperty.IpV6.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-route53configuration.html#sam-api-route53configuration-ipv6

Return type

Union[bool, IResolvable, None]

S3LocationProperty

class CfnApi.S3LocationProperty(*, bucket, key, version)

Bases: object

Parameters
  • bucket (str) – CfnApi.S3LocationProperty.Bucket.

  • key (str) – CfnApi.S3LocationProperty.Key.

  • version (Union[int, float]) – CfnApi.S3LocationProperty.Version.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#s3-location-object

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.CfnApi.S3LocationProperty(
    bucket="bucket",
    key="key",
    version=123
)

Attributes

bucket

CfnApi.S3LocationProperty.Bucket.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#s3-location-object

Return type

str

key

CfnApi.S3LocationProperty.Key.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#s3-location-object

Return type

str

version

CfnApi.S3LocationProperty.Version.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#s3-location-object

Return type

Union[int, float]