1.204.0

class CfnRouteResponseV2 (construct) ⚠️

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.CfnRouteResponseV2
Javasoftware.amazon.awscdk.services.apigateway.CfnRouteResponseV2
Pythonaws_cdk.aws_apigateway.CfnRouteResponseV2
TypeScript (source)@aws-cdk/aws-apigateway » CfnRouteResponseV2

⚠️ Deprecated: moved to package aws-apigatewayv2

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::ApiGatewayV2::RouteResponse.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigateway from '@aws-cdk/aws-apigateway';

declare const responseModels: any;
declare const responseParameters: any;
const cfnRouteResponseV2 = new apigateway.CfnRouteResponseV2(this, 'MyCfnRouteResponseV2', {
  apiId: 'apiId',
  routeId: 'routeId',
  routeResponseKey: 'routeResponseKey',

  // the properties below are optional
  modelSelectionExpression: 'modelSelectionExpression',
  responseModels: responseModels,
  responseParameters: responseParameters,
});

Initializer

new CfnRouteResponseV2(scope: Construct, id: string, props: CfnRouteResponseV2Props)

⚠️ Deprecated: moved to package aws-apigatewayv2

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnRouteResponseV2Props — - resource properties.

Create a new AWS::ApiGatewayV2::RouteResponse.

Construct Props

NameTypeDescription
apiId⚠️stringAWS::ApiGatewayV2::RouteResponse.ApiId.
routeId⚠️stringAWS::ApiGatewayV2::RouteResponse.RouteId.
routeResponseKey⚠️stringAWS::ApiGatewayV2::RouteResponse.RouteResponseKey.
modelSelectionExpression?⚠️stringAWS::ApiGatewayV2::RouteResponse.ModelSelectionExpression.
responseModels?⚠️anyAWS::ApiGatewayV2::RouteResponse.ResponseModels.
responseParameters?⚠️anyAWS::ApiGatewayV2::RouteResponse.ResponseParameters.

apiId⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string

AWS::ApiGatewayV2::RouteResponse.ApiId.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-apiid

routeId⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string

AWS::ApiGatewayV2::RouteResponse.RouteId.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-routeid

routeResponseKey⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string

AWS::ApiGatewayV2::RouteResponse.RouteResponseKey.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-routeresponsekey

modelSelectionExpression?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::RouteResponse.ModelSelectionExpression.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-modelselectionexpression

responseModels?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: any (optional)

AWS::ApiGatewayV2::RouteResponse.ResponseModels.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-responsemodels

responseParameters?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: any (optional)

AWS::ApiGatewayV2::RouteResponse.ResponseParameters.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-responseparameters

Properties

NameTypeDescription
apiId⚠️stringAWS::ApiGatewayV2::RouteResponse.ApiId.
cfnOptions⚠️ICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties⚠️{ [string]: any }
cfnResourceType⚠️stringAWS resource type.
creationStack⚠️string[]
logicalId⚠️stringThe logical ID for this CloudFormation stack element.
node⚠️ConstructNodeThe construct tree node associated with this construct.
ref⚠️stringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
responseModels⚠️anyAWS::ApiGatewayV2::RouteResponse.ResponseModels.
responseParameters⚠️anyAWS::ApiGatewayV2::RouteResponse.ResponseParameters.
routeId⚠️stringAWS::ApiGatewayV2::RouteResponse.RouteId.
routeResponseKey⚠️stringAWS::ApiGatewayV2::RouteResponse.RouteResponseKey.
stack⚠️StackThe stack in which this element is defined.
modelSelectionExpression?⚠️stringAWS::ApiGatewayV2::RouteResponse.ModelSelectionExpression.
static CFN_RESOURCE_TYPE_NAME⚠️stringThe CloudFormation resource type name for this resource class.

apiId⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string

AWS::ApiGatewayV2::RouteResponse.ApiId.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-apiid

cfnOptions⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: ICfnResourceOptions

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

cfnProperties⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: { [string]: any }

cfnResourceType⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string

AWS resource type.

creationStack⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string[]

logicalId⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string

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

node⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: ConstructNode

The construct tree node associated with this construct.

ref⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string

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

responseModels⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: any

AWS::ApiGatewayV2::RouteResponse.ResponseModels.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-responsemodels

responseParameters⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: any

AWS::ApiGatewayV2::RouteResponse.ResponseParameters.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-responseparameters

routeId⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string

AWS::ApiGatewayV2::RouteResponse.RouteId.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-routeid

routeResponseKey⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string

AWS::ApiGatewayV2::RouteResponse.RouteResponseKey.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-routeresponsekey

stack⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: Stack

The stack in which this element is defined.

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

modelSelectionExpression?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::RouteResponse.ModelSelectionExpression.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-modelselectionexpression

static CFN_RESOURCE_TYPE_NAME⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)⚠️Syntactic sugar for addOverride(path, undefined).
addDependsOn(target)⚠️Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)⚠️Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)⚠️Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)⚠️Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)⚠️Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)⚠️Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)⚠️Returns a token for an runtime attribute of this resource.
getMetadata(key)⚠️Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)⚠️Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)⚠️Overrides the auto-generated logical ID with a specific ID.
toString()⚠️Returns a string representation of this construct.
protected renderProperties(props)⚠️

addDeletionOverride(path)⚠️

public addDeletionOverride(path: string): void

⚠️ Deprecated: moved to package aws-apigatewayv2

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: moved to package aws-apigatewayv2

Parameters

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.

addMetadata(key, value)⚠️

public addMetadata(key: string, value: any): void

⚠️ Deprecated: moved to package aws-apigatewayv2

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [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.](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.)

addOverride(path, value)⚠️

public addOverride(path: string, value: any): void

⚠️ Deprecated: moved to package aws-apigatewayv2

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The 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,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

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

addPropertyDeletionOverride(propertyPath)⚠️

public addPropertyDeletionOverride(propertyPath: string): void

⚠️ Deprecated: moved to package aws-apigatewayv2

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)⚠️

public addPropertyOverride(propertyPath: string, value: any): void

⚠️ Deprecated: moved to package aws-apigatewayv2

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)⚠️

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

⚠️ Deprecated: moved to package aws-apigatewayv2

Parameters

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

getAtt(attributeName)⚠️

public getAtt(attributeName: string): Reference

⚠️ Deprecated: moved to package aws-apigatewayv2

Parameters

  • attributeName string — The name of the attribute.

Returns

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.

getMetadata(key)⚠️

public getMetadata(key: string): any

⚠️ Deprecated: moved to package aws-apigatewayv2

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [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.](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)⚠️

public inspect(inspector: TreeInspector): void

⚠️ Deprecated: moved to package aws-apigatewayv2

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)⚠️

public overrideLogicalId(newLogicalId: string): void

⚠️ Deprecated: moved to package aws-apigatewayv2

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()⚠️

public toString(): string

⚠️ Deprecated: moved to package aws-apigatewayv2

Returns

  • string

Returns a string representation of this construct.

protected renderProperties(props)⚠️

protected renderProperties(props: { [string]: any }): { [string]: any }

⚠️ Deprecated: moved to package aws-apigatewayv2

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }
← PreviousNext →