ResourceBase L2 construct
Initializer
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.
defaultCorsPreflightOptionsCorsOptionsdefault_cors_preflight_optionsCorsOptionsdefaultCorsPreflightOptionsCorsOptionsDefaultCorsPreflightOptionsCorsOptionsDefaultCorsPreflightOptionsCorsOptions#defaultIntegrationIntegrationdefault_integrationIntegrationdefaultIntegrationIntegrationDefaultIntegrationIntegrationDefaultIntegrationIntegration#defaultMethodOptionsMethodOptionsdefault_method_optionsMethodOptionsdefaultMethodOptionsMethodOptionsDefaultMethodOptionsMethodOptionsDefaultMethodOptionsMethodOptions#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#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.
parentResourceIResourceparent_resourceIResourceparentResourceIResourceParentResourceIResourceParentResourceIResource#resourceRefResourceReferenceresource_refResourceReferenceresourceRefResourceReferenceResourceRefResourceReferenceResourceRefResourceReferencerequired#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
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: string, integration?: Integration, options?: MethodOptions): Methoddef add_method(self, http_method: str, integration: typing.Optional[Integration] = None, options: typing.Optional[MethodOptions] = None) -> Methodpublic Method addMethod(String httpMethod, Integration integration, MethodOptions options)public Method AddMethod(string httpMethod, Integration? integration = null, MethodOptions? options = null)func AddMethod(HttpMethod *string, Integration Integration, Options MethodOptions) Method#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#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#applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
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): IResourcedef get_resource(self, path_part: str) -> IResourcepublic IResource getResource(String pathPart)public IResource GetResource(string pathPart)func GetResource(PathPart *string) IResource#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#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.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#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. Use multiple with() calls if subsequent mixins should apply to added constructs.