CfnMethod

class aws_cdk.aws_apigateway.CfnMethod(scope, id, *, http_method, resource_id, rest_api_id, api_key_required=None, authorization_scopes=None, authorization_type=None, authorizer_id=None, integration=None, method_responses=None, operation_name=None, request_models=None, request_parameters=None, request_validator_id=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::ApiGateway::Method.

See

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

CloudformationResource

AWS::ApiGateway::Method

Create a new AWS::ApiGateway::Method.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • http_method (str) – AWS::ApiGateway::Method.HttpMethod.

  • resource_id (str) – AWS::ApiGateway::Method.ResourceId.

  • rest_api_id (str) – AWS::ApiGateway::Method.RestApiId.

  • api_key_required (Union[bool, IResolvable, None]) – AWS::ApiGateway::Method.ApiKeyRequired.

  • authorization_scopes (Optional[List[str]]) – AWS::ApiGateway::Method.AuthorizationScopes.

  • authorization_type (Optional[str]) – AWS::ApiGateway::Method.AuthorizationType.

  • authorizer_id (Optional[str]) – AWS::ApiGateway::Method.AuthorizerId.

  • integration (Union[IResolvable, IntegrationProperty, None]) – AWS::ApiGateway::Method.Integration.

  • method_responses (Union[IResolvable, List[Union[IResolvable, MethodResponseProperty]], None]) – AWS::ApiGateway::Method.MethodResponses.

  • operation_name (Optional[str]) – AWS::ApiGateway::Method.OperationName.

  • request_models (Union[IResolvable, Mapping[str, str], None]) – AWS::ApiGateway::Method.RequestModels.

  • request_parameters (Union[IResolvable, Mapping[str, Union[bool, IResolvable]], None]) – AWS::ApiGateway::Method.RequestParameters.

  • request_validator_id (Optional[str]) – AWS::ApiGateway::Method.RequestValidatorId.

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 without compilation. See https://github.com/aws/jsii/issues/826
add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
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.

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

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

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::Method'
api_key_required

AWS::ApiGateway::Method.ApiKeyRequired.

See

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

Return type

Union[bool, IResolvable, None]

authorization_scopes

AWS::ApiGateway::Method.AuthorizationScopes.

See

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

Return type

Optional[List[str]]

authorization_type

AWS::ApiGateway::Method.AuthorizationType.

See

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

Return type

Optional[str]

authorizer_id

AWS::ApiGateway::Method.AuthorizerId.

See

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

Return type

Optional[str]

cfn_options

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

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

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]

http_method

AWS::ApiGateway::Method.HttpMethod.

See

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

Return type

str

integration

AWS::ApiGateway::Method.Integration.

See

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

Return type

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

method_responses

AWS::ApiGateway::Method.MethodResponses.

See

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

Return type

Union[IResolvable, List[Union[IResolvable, MethodResponseProperty]], None]

node

The construct tree node associated with this construct.

Return type

ConstructNode

operation_name

AWS::ApiGateway::Method.OperationName.

See

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

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

request_models

AWS::ApiGateway::Method.RequestModels.

See

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

Return type

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

request_parameters

AWS::ApiGateway::Method.RequestParameters.

See

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

Return type

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

request_validator_id

AWS::ApiGateway::Method.RequestValidatorId.

See

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

Return type

Optional[str]

resource_id

AWS::ApiGateway::Method.ResourceId.

See

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

Return type

str

rest_api_id

AWS::ApiGateway::Method.RestApiId.

See

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

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

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

IntegrationProperty

class CfnMethod.IntegrationProperty(*, cache_key_parameters=None, cache_namespace=None, connection_id=None, connection_type=None, content_handling=None, credentials=None, integration_http_method=None, integration_responses=None, passthrough_behavior=None, request_parameters=None, request_templates=None, timeout_in_millis=None, type=None, uri=None)

Bases: object

Parameters
  • cache_key_parameters (Optional[List[str]]) – CfnMethod.IntegrationProperty.CacheKeyParameters.

  • cache_namespace (Optional[str]) – CfnMethod.IntegrationProperty.CacheNamespace.

  • connection_id (Optional[str]) – CfnMethod.IntegrationProperty.ConnectionId.

  • connection_type (Optional[str]) – CfnMethod.IntegrationProperty.ConnectionType.

  • content_handling (Optional[str]) – CfnMethod.IntegrationProperty.ContentHandling.

  • credentials (Optional[str]) – CfnMethod.IntegrationProperty.Credentials.

  • integration_http_method (Optional[str]) – CfnMethod.IntegrationProperty.IntegrationHttpMethod.

  • integration_responses (Union[IResolvable, List[Union[IResolvable, IntegrationResponseProperty]], None]) – CfnMethod.IntegrationProperty.IntegrationResponses.

  • passthrough_behavior (Optional[str]) – CfnMethod.IntegrationProperty.PassthroughBehavior.

  • request_parameters (Union[IResolvable, Mapping[str, str], None]) – CfnMethod.IntegrationProperty.RequestParameters.

  • request_templates (Union[IResolvable, Mapping[str, str], None]) – CfnMethod.IntegrationProperty.RequestTemplates.

  • timeout_in_millis (Union[int, float, None]) – CfnMethod.IntegrationProperty.TimeoutInMillis.

  • type (Optional[str]) – CfnMethod.IntegrationProperty.Type.

  • uri (Optional[str]) – CfnMethod.IntegrationProperty.Uri.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html

Attributes

cache_key_parameters

CfnMethod.IntegrationProperty.CacheKeyParameters.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-cachekeyparameters

Return type

Optional[List[str]]

cache_namespace

CfnMethod.IntegrationProperty.CacheNamespace.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-cachenamespace

Return type

Optional[str]

connection_id

CfnMethod.IntegrationProperty.ConnectionId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-connectionid

Return type

Optional[str]

connection_type

CfnMethod.IntegrationProperty.ConnectionType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-connectiontype

Return type

Optional[str]

content_handling

CfnMethod.IntegrationProperty.ContentHandling.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-contenthandling

Return type

Optional[str]

credentials

CfnMethod.IntegrationProperty.Credentials.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-credentials

Return type

Optional[str]

integration_http_method

CfnMethod.IntegrationProperty.IntegrationHttpMethod.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-integrationhttpmethod

Return type

Optional[str]

integration_responses

CfnMethod.IntegrationProperty.IntegrationResponses.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-integrationresponses

Return type

Union[IResolvable, List[Union[IResolvable, IntegrationResponseProperty]], None]

passthrough_behavior

CfnMethod.IntegrationProperty.PassthroughBehavior.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-passthroughbehavior

Return type

Optional[str]

request_parameters

CfnMethod.IntegrationProperty.RequestParameters.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-requestparameters

Return type

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

request_templates

CfnMethod.IntegrationProperty.RequestTemplates.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-requesttemplates

Return type

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

timeout_in_millis

CfnMethod.IntegrationProperty.TimeoutInMillis.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-timeoutinmillis

Return type

Union[int, float, None]

type

CfnMethod.IntegrationProperty.Type.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-type

Return type

Optional[str]

uri

CfnMethod.IntegrationProperty.Uri.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-uri

Return type

Optional[str]

IntegrationResponseProperty

class CfnMethod.IntegrationResponseProperty(*, status_code, content_handling=None, response_parameters=None, response_templates=None, selection_pattern=None)

Bases: object

Parameters
  • status_code (str) – CfnMethod.IntegrationResponseProperty.StatusCode.

  • content_handling (Optional[str]) – CfnMethod.IntegrationResponseProperty.ContentHandling.

  • response_parameters (Union[IResolvable, Mapping[str, str], None]) – CfnMethod.IntegrationResponseProperty.ResponseParameters.

  • response_templates (Union[IResolvable, Mapping[str, str], None]) – CfnMethod.IntegrationResponseProperty.ResponseTemplates.

  • selection_pattern (Optional[str]) – CfnMethod.IntegrationResponseProperty.SelectionPattern.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html

Attributes

content_handling

CfnMethod.IntegrationResponseProperty.ContentHandling.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integrationresponse-contenthandling

Return type

Optional[str]

response_parameters

CfnMethod.IntegrationResponseProperty.ResponseParameters.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-responseparameters

Return type

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

response_templates

CfnMethod.IntegrationResponseProperty.ResponseTemplates.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-responsetemplates

Return type

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

selection_pattern

CfnMethod.IntegrationResponseProperty.SelectionPattern.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-selectionpattern

Return type

Optional[str]

status_code

CfnMethod.IntegrationResponseProperty.StatusCode.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-statuscode

Return type

str

MethodResponseProperty

class CfnMethod.MethodResponseProperty(*, status_code, response_models=None, response_parameters=None)

Bases: object

Parameters
  • status_code (str) – CfnMethod.MethodResponseProperty.StatusCode.

  • response_models (Union[IResolvable, Mapping[str, str], None]) – CfnMethod.MethodResponseProperty.ResponseModels.

  • response_parameters (Union[IResolvable, Mapping[str, Union[bool, IResolvable]], None]) – CfnMethod.MethodResponseProperty.ResponseParameters.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html

Attributes

response_models

CfnMethod.MethodResponseProperty.ResponseModels.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-responsemodels

Return type

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

response_parameters

CfnMethod.MethodResponseProperty.ResponseParameters.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-responseparameters

Return type

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

status_code

CfnMethod.MethodResponseProperty.StatusCode.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-statuscode

Return type

str