@Internal public static interface IResource.Jsii$Default extends IResource, IResource.Jsii$Default
IResource
.IResource.Jsii$Default, IResource.Jsii$Proxy
Modifier and Type | Method and Description |
---|---|
default Method |
addCorsPreflight(CorsOptions options)
Adds an OPTIONS method to this resource which responds to Cross-Origin Resource Sharing (CORS) preflight requests.
|
default Method |
addMethod(String httpMethod,
Integration target,
MethodOptions options)
Defines a new method for this resource.
|
default ProxyResource |
addProxy(ProxyResourceOptions options)
Adds a greedy proxy resource ("{proxy+}") and an ANY method to this route.
|
default Resource |
addResource(String pathPart,
ResourceOptions options)
Defines a new child resource where this resource is the parent.
|
default void |
applyRemovalPolicy(RemovalPolicy policy)
Apply the given removal policy to this resource.
|
default IRestApi |
getApi()
The rest API that this resource is part of.
|
default CorsOptions |
getDefaultCorsPreflightOptions()
Default options for CORS preflight OPTIONS method.
|
default Integration |
getDefaultIntegration()
An integration to use as a default for all methods created within this API unless an integration is specified.
|
default MethodOptions |
getDefaultMethodOptions()
Method options to use as a default for all methods created within this API unless custom options are specified.
|
default ResourceEnvironment |
getEnv()
The environment this resource belongs to.
|
default ConstructNode |
getNode()
The construct tree node for this construct.
|
default IResource |
getParentResource()
The parent of this resource or undefined for the root resource.
|
default String |
getPath()
The full path of this resource.
|
default IResource |
getResource(String pathPart)
Retrieves a child resource by path part.
|
default String |
getResourceId()
The ID of the resource.
|
default RestApi |
getRestApi()
Deprecated.
- Throws an error if this Resource is not associated with an instance of `RestApi`. Use `api` instead.
|
default Stack |
getStack()
The stack in which this resource is defined.
|
default Resource |
resourceForPath(String path)
Gets or create all resources leading up to the specified path.
|
addMethod, addMethod, addProxy, addResource
@Stability(value=Stable) @NotNull default ConstructNode getNode()
getNode
in interface IResource.Jsii$Default
@Stability(value=Stable) @NotNull default ResourceEnvironment getEnv()
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.
getEnv
in interface IResource
getEnv
in interface IResource.Jsii$Default
@Stability(value=Stable) @NotNull default Stack getStack()
getStack
in interface IResource
getStack
in interface IResource.Jsii$Default
@Stability(value=Stable) @NotNull default IRestApi getApi()
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.
@Stability(value=Stable) @NotNull default String getPath()
@Stability(value=Stable) @NotNull default String getResourceId()
@Stability(value=Deprecated) @Deprecated @NotNull default RestApi getRestApi()
@Stability(value=Stable) @Nullable default CorsOptions getDefaultCorsPreflightOptions()
@Stability(value=Stable) @Nullable default Integration getDefaultIntegration()
@Stability(value=Stable) @Nullable default MethodOptions getDefaultMethodOptions()
@Stability(value=Stable) @Nullable default IResource getParentResource()
@Stability(value=Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy policy)
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
).
applyRemovalPolicy
in interface IResource
applyRemovalPolicy
in interface IResource.Jsii$Default
policy
- This parameter is required.@Stability(value=Stable) @NotNull default Method addCorsPreflight(@NotNull CorsOptions options)
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.
options
- CORS options. This parameter is required.@Stability(value=Stable) @NotNull default Method addMethod(@NotNull String httpMethod, @Nullable Integration target, @Nullable MethodOptions options)
httpMethod
- The HTTP method. This parameter is required.target
- The target backend integration for this method.options
- Method options, such as authentication.@Stability(value=Stable) @NotNull default ProxyResource addProxy(@Nullable ProxyResourceOptions options)
options
- Default integration and method options.@Stability(value=Stable) @NotNull default Resource addResource(@NotNull String pathPart, @Nullable ResourceOptions options)
pathPart
- The path part for the child resource. This parameter is required.options
- Resource options.@Stability(value=Stable) @Nullable default IResource getResource(@NotNull String pathPart)
pathPart
- The path part of the child resource. This parameter is required.@Stability(value=Stable) @NotNull default Resource resourceForPath(@NotNull String path)
path
- The relative path. This parameter is required.Copyright © 2023. All rights reserved.