IResource Interface
Properties
notes
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 its hash to determine the ID of the deployment. This allows us to automatically update the deployment when the model of the REST API changes.
defaultCorsPreflightOptionsmay be undefinedCorsOptionsdefault_cors_preflight_optionsmay be undefinedCorsOptionsdefaultCorsPreflightOptionsmay be undefinedCorsOptionsDefaultCorsPreflightOptionsmay be undefinedCorsOptionsDefaultCorsPreflightOptionsmay be undefinedCorsOptions#defaultIntegrationmay be undefinedIntegrationdefault_integrationmay be undefinedIntegrationdefaultIntegrationmay be undefinedIntegrationDefaultIntegrationmay be undefinedIntegrationDefaultIntegrationmay be undefinedIntegration#defaultMethodOptionsmay be undefinedMethodOptionsdefault_method_optionsmay be undefinedMethodOptionsdefaultMethodOptionsmay be undefinedMethodOptionsDefaultMethodOptionsmay be undefinedMethodOptionsDefaultMethodOptionsmay be undefinedMethodOptions#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
parentResourcemay be undefinedIResourceparent_resourcemay be undefinedIResourceparentResourcemay be undefinedIResourceParentResourcemay be undefinedIResourceParentResourcemay be undefinedIResource#resourceRefResourceReferenceresource_refResourceReferenceresourceRefResourceReferenceResourceRefResourceReferenceResourceRefResourceReference#Methods
addCorsPreflight(options: CorsOptions): Methoddef add_cors_preflight(self, options: CorsOptions) -> Methodpublic Method addCorsPreflight(CorsOptions options)public Method AddCorsPreflight(CorsOptions options)func AddCorsPreflight(Options CorsOptions) Method#notes · 1 parameter · returns
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.
Parameters
optionsoptionsoptionsoptionsOptions— CORS options.
Returns: a Method object
addMethod(httpMethod: string, target?: Integration, options?: MethodOptions): Methoddef add_method(self, http_method: str, target: typing.Optional[Integration] = None, options: typing.Optional[MethodOptions] = None) -> Methodpublic Method addMethod(String httpMethod, Integration target, MethodOptions options)public Method AddMethod(string httpMethod, Integration? target = null, MethodOptions? options = null)func AddMethod(HttpMethod *string, Target Integration, Options MethodOptions) Method#3 parameters · returns
Parameters
httpMethodhttp_methodhttpMethodhttpMethodHttpMethod— The HTTP method.targettargettargettargetTarget— The target backend integration for this method.optionsoptionsoptionsoptionsOptions— Method options, such as authentication.
Returns: The newly created Method object.
addProxy(options?: ProxyResourceOptions): ProxyResourcedef add_proxy(self, options: typing.Optional[ProxyResourceOptions] = None) -> ProxyResourcepublic ProxyResource addProxy(ProxyResourceOptions options)public ProxyResource AddProxy(ProxyResourceOptions? options = null)func AddProxy(Options ProxyResourceOptions) ProxyResource#1 parameter
Parameters
optionsoptionsoptionsoptionsOptions— Default integration and method options.
addResource(pathPart: string, options?: ResourceOptions): Resourcedef add_resource(self, path_part: str, options: typing.Optional[ResourceOptions] = None) -> Resourcepublic Resource addResource(String pathPart, ResourceOptions options)public Resource AddResource(string pathPart, ResourceOptions? options = null)func AddResource(PathPart *string, Options ResourceOptions) Resource#2 parameters · returns
Parameters
pathPartpath_partpathPartpathPartPathPart— The path part for the child resource.optionsoptionsoptionsoptionsOptions— Resource options.
Returns: A Resource object
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
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: string): IResource // chainabledef get_resource(self, path_part: str) -> IResourcepublic IResource getResource(String pathPart)public IResource GetResource(string pathPart)func GetResource(PathPart *string) IResource#1 parameter · returns
Parameters
pathPartpath_partpathPartpathPartPathPart— The path part of the child resource.
Returns: the child resource or undefined if not found
resourceForPath(path: string): Resourcedef resource_for_path(self, path: str) -> Resourcepublic Resource resourceForPath(String path)public Resource ResourceForPath(string path)func ResourceForPath(Path *string) Resource#- Path may only start with "/" if this method is called on the root resource.
- All resources are created using default options.
1 parameter · returns
Parameters
pathpathpathpathPath— The relative path.
Returns: a new or existing resource.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.
1 parameter · returns
Parameters
mixinsmixinsmixinsmixinsMixins— The mixins to apply.
Returns: This construct for chaining