class ResourceBase
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.APIGateway.ResourceBase |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#ResourceBase |
![]() | software.amazon.awscdk.services.apigateway.ResourceBase |
![]() | aws_cdk.aws_apigateway.ResourceBase |
![]() | aws-cdk-lib » aws_apigateway » ResourceBase |
Implements
IConstruct
, IDependable
, IResource
, IResource
Extends
Resource
Implemented by
Proxy
, Resource
Initializer
new ResourceBase(scope: Construct, id: string)
Parameters
- scope
Construct
- id
string
Properties
Name | Type | Description |
---|---|---|
api | IRest | The rest API that this resource is part of. |
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
path | string | The full path of this resource. |
resource | string | The ID of the resource. |
stack | Stack | The stack in which this resource is defined. |
default | Cors | Default options for CORS preflight OPTIONS method. |
default | Integration | An integration to use as a default for all methods created within this API unless an integration is specified. |
default | Method | Method options to use as a default for all methods created within this API unless custom options are specified. |
parent | IResource | The parent of this resource or undefined for the root resource. |
api
Type:
IRest
The rest API that this resource is part of.
The reason we need the RestApi object itself and not just the ID is because the model is being tracked by the top-level RestApi object for the purpose of calculating it's hash to determine the ID of the deployment. This allows us to automatically update the deployment when the model of the REST API changes.
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
node
Type:
Node
The tree node.
path
Type:
string
The full path of this resource.
resourceId
Type:
string
The ID of the resource.
stack
Type:
Stack
The stack in which this resource is defined.
defaultCorsPreflightOptions?
Type:
Cors
(optional)
Default options for CORS preflight OPTIONS method.
defaultIntegration?
Type:
Integration
(optional)
An integration to use as a default for all methods created within this API unless an integration is specified.
defaultMethodOptions?
Type:
Method
(optional)
Method options to use as a default for all methods created within this API unless custom options are specified.
parentResource?
Type:
IResource
(optional)
The parent of this resource or undefined for the root resource.
Methods
Name | Description |
---|---|
add | Adds an OPTIONS method to this resource which responds to Cross-Origin Resource Sharing (CORS) preflight requests. |
add | Defines a new method for this resource. |
add | Adds a greedy proxy resource ("{proxy+}") and an ANY method to this route. |
add | Defines a new child resource where this resource is the parent. |
apply | Apply the given removal policy to this resource. |
get | Retrieves a child resource by path part. |
resource | Gets or create all resources leading up to the specified path. |
to | Returns a string representation of this construct. |
addCorsPreflight(options)
public addCorsPreflight(options: CorsOptions): Method
Parameters
- options
Cors
Options
Returns
Adds an OPTIONS method to this resource which responds to Cross-Origin Resource Sharing (CORS) preflight requests.
Cross-Origin Resource Sharing (CORS) is a mechanism that uses additional HTTP headers to tell browsers to give a web application running at one origin, access to selected resources from a different origin. A web application executes a cross-origin HTTP request when it requests a resource that has a different origin (domain, protocol, or port) from its own.
addMethod(httpMethod, integration?, options?)
public addMethod(httpMethod: string, integration?: Integration, options?: MethodOptions): Method
Parameters
- httpMethod
string
- integration
Integration
- options
Method
Options
Returns
Defines a new method for this resource.
addProxy(options?)
public addProxy(options?: ProxyResourceOptions): ProxyResource
Parameters
- options
Proxy
Resource Options
Returns
Adds a greedy proxy resource ("{proxy+}") and an ANY method to this route.
addResource(pathPart, options?)
public addResource(pathPart: string, options?: ResourceOptions): Resource
Parameters
- pathPart
string
- options
Resource
Options
Returns
Defines a new child resource where this resource is the parent.
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
Apply the given removal policy to this resource.
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
).
getResource(pathPart)
public getResource(pathPart: string): IResource
Parameters
- pathPart
string
Returns
Retrieves a child resource by path part.
resourceForPath(path)
public resourceForPath(path: string): Resource
Parameters
- path
string
Returns
Gets or create all resources leading up to the specified path.
- Path may only start with "/" if this method is called on the root resource.
- All resources are created using default options.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.