CfnRestApi

class aws_cdk.aws_apigateway.CfnRestApi(scope, id, *, api_key_source_type=None, binary_media_types=None, body=None, body_s3_location=None, clone_from=None, description=None, disable_execute_api_endpoint=None, endpoint_configuration=None, fail_on_warnings=None, minimum_compression_size=None, mode=None, name=None, parameters=None, policy=None, tags=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::ApiGateway::RestApi.

CloudformationResource

AWS::ApiGateway::RestApi

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html

Create a new AWS::ApiGateway::RestApi.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • api_key_source_type (Optional[str]) – AWS::ApiGateway::RestApi.ApiKeySourceType.

  • binary_media_types (Optional[Sequence[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.

  • disable_execute_api_endpoint (Union[bool, IResolvable, None]) – AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint.

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

  • mode (Optional[str]) – AWS::ApiGateway::RestApi.Mode.

  • 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[Sequence[CfnTag]]) – AWS::ApiGateway::RestApi.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

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:

# Example automatically generated. See https://github.com/aws/jsii/issues/826
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"
       ...
     },
   ]
   ...
}
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::ApiGateway::RestApi'
api_key_source_type

AWS::ApiGateway::RestApi.ApiKeySourceType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-apikeysourcetype

Return type

Optional[str]

attr_root_resource_id

RootResourceId

Type

cloudformationAttribute

Return type

str

binary_media_types

AWS::ApiGateway::RestApi.BinaryMediaTypes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-binarymediatypes

Return type

Optional[List[str]]

body

AWS::ApiGateway::RestApi.Body.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-body

Return type

Any

body_s3_location

AWS::ApiGateway::RestApi.BodyS3Location.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-bodys3location

Return type

Union[IResolvable, S3LocationProperty, 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

clone_from

AWS::ApiGateway::RestApi.CloneFrom.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-clonefrom

Return type

Optional[str]

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]

description

AWS::ApiGateway::RestApi.Description.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-description

Return type

Optional[str]

disable_execute_api_endpoint

AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-disableexecuteapiendpoint

Return type

Union[bool, IResolvable, None]

endpoint_configuration

AWS::ApiGateway::RestApi.EndpointConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-endpointconfiguration

Return type

Union[IResolvable, EndpointConfigurationProperty, None]

fail_on_warnings

AWS::ApiGateway::RestApi.FailOnWarnings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-failonwarnings

Return type

Union[bool, IResolvable, None]

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.

minimum_compression_size

AWS::ApiGateway::RestApi.MinimumCompressionSize.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-minimumcompressionsize

Return type

Union[int, float, None]

mode

AWS::ApiGateway::RestApi.Mode.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-mode

Return type

Optional[str]

name

AWS::ApiGateway::RestApi.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-name

Return type

Optional[str]

node

The construct tree node associated with this construct.

Return type

ConstructNode

parameters

AWS::ApiGateway::RestApi.Parameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-parameters

Return type

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

policy

AWS::ApiGateway::RestApi.Policy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-policy

Return type

Any

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

tags

AWS::ApiGateway::RestApi.Tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-tags

Return type

TagManager

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

EndpointConfigurationProperty

class CfnRestApi.EndpointConfigurationProperty(*, types=None, vpc_endpoint_ids=None)

Bases: object

Parameters
  • types (Optional[Sequence[str]]) – CfnRestApi.EndpointConfigurationProperty.Types.

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html

Attributes

types

CfnRestApi.EndpointConfigurationProperty.Types.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-types

Return type

Optional[List[str]]

vpc_endpoint_ids

CfnRestApi.EndpointConfigurationProperty.VpcEndpointIds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-vpcendpointids

Return type

Optional[List[str]]

S3LocationProperty

class CfnRestApi.S3LocationProperty(*, bucket=None, e_tag=None, key=None, version=None)

Bases: object

Parameters
  • bucket (Optional[str]) – CfnRestApi.S3LocationProperty.Bucket.

  • e_tag (Optional[str]) – CfnRestApi.S3LocationProperty.ETag.

  • key (Optional[str]) – CfnRestApi.S3LocationProperty.Key.

  • version (Optional[str]) – CfnRestApi.S3LocationProperty.Version.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html

Attributes

bucket

CfnRestApi.S3LocationProperty.Bucket.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-bucket

Return type

Optional[str]

e_tag

CfnRestApi.S3LocationProperty.ETag.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-etag

Return type

Optional[str]

key

CfnRestApi.S3LocationProperty.Key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-key

Return type

Optional[str]

version

CfnRestApi.S3LocationProperty.Version.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-version

Return type

Optional[str]