aws-cdk-lib.aws_apigateway.ResourceAttributes

ResourceAttributes Struct

Attributes that can be specified when importing a Resource.

Source

aws-apigateway/lib/resource.ts

Example

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

declare const restApi: apigateway.RestApi;
const resourceAttributes: apigateway.ResourceAttributes = {
  path: 'path',
  resourceId: 'resourceId',
  restApi: restApi,
};

Properties

pathstringpathstrpathStringPathstringPath*stringrequired#

The full path of this resource.

resourceIdstringresource_idstrresourceIdStringResourceIdstringResourceId*stringrequired#

The ID of the resource.

restApiIRestApirest_apiIRestApirestApiIRestApiRestApiIRestApiRestApiIRestApirequired#

The rest API that this resource is part of.