package awsapigateway import ( _init_ "github.com/aws/aws-cdk-go/awscdk/v2/jsii" _jsii_ "github.com/aws/jsii-runtime-go/runtime" "github.com/aws/aws-cdk-go/awscdk/v2" "github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway/internal" "github.com/aws/constructs-go/constructs/v10" ) type ResourceBase interface { awscdk.Resource IResource // 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. Api() IRestApi // Default options for CORS preflight OPTIONS method. DefaultCorsPreflightOptions() *CorsOptions // An integration to use as a default for all methods created within this API unless an integration is specified. DefaultIntegration() Integration // Method options to use as a default for all methods created within this API unless custom options are specified. DefaultMethodOptions() *MethodOptions // 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. Env() *awscdk.ResourceEnvironment // The tree node. Node() constructs.Node // The parent of this resource or undefined for the root resource. ParentResource() IResource // The full path of this resource. Path() *string // Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by CloudFormation // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. PhysicalName() *string // The ID of the resource. ResourceId() *string // The stack in which this resource is defined. Stack() awscdk.Stack // 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. AddCorsPreflight(options *CorsOptions) Method // Defines a new method for this resource. AddMethod(httpMethod *string, integration Integration, options *MethodOptions) Method // Adds a greedy proxy resource ("{proxy+}") and an ANY method to this route. AddProxy(options *ProxyResourceOptions) ProxyResource // Defines a new child resource where this resource is the parent. AddResource(pathPart *string, options *ResourceOptions) Resource // 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`). ApplyRemovalPolicy(policy awscdk.RemovalPolicy) GeneratePhysicalName() *string // Retrieves a child resource by path part. GetResource(pathPart *string) IResource // Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`). // // Normally, this token will resolve to `arnAttr`, but if the resource is // referenced across environments, `arnComponents` will be used to synthesize // a concrete ARN with the resource's physical name. Make sure to reference // `this.physicalName` in `arnComponents`. GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string // Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`). // // Normally, this token will resolve to `nameAttr`, but if the resource is // referenced across environments, it will be resolved to `this.physicalName`, // which will be a concrete name. GetResourceNameAttribute(nameAttr *string) *string // 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. ResourceForPath(path *string) Resource // Returns a string representation of this construct. ToString() *string } // The jsii proxy struct for ResourceBase type jsiiProxy_ResourceBase struct { internal.Type__awscdkResource jsiiProxy_IResource } func (j *jsiiProxy_ResourceBase) Api() IRestApi { var returns IRestApi _jsii_.Get( j, "api", &returns, ) return returns } func (j *jsiiProxy_ResourceBase) DefaultCorsPreflightOptions() *CorsOptions { var returns *CorsOptions _jsii_.Get( j, "defaultCorsPreflightOptions", &returns, ) return returns } func (j *jsiiProxy_ResourceBase) DefaultIntegration() Integration { var returns Integration _jsii_.Get( j, "defaultIntegration", &returns, ) return returns } func (j *jsiiProxy_ResourceBase) DefaultMethodOptions() *MethodOptions { var returns *MethodOptions _jsii_.Get( j, "defaultMethodOptions", &returns, ) return returns } func (j *jsiiProxy_ResourceBase) Env() *awscdk.ResourceEnvironment { var returns *awscdk.ResourceEnvironment _jsii_.Get( j, "env", &returns, ) return returns } func (j *jsiiProxy_ResourceBase) Node() constructs.Node { var returns constructs.Node _jsii_.Get( j, "node", &returns, ) return returns } func (j *jsiiProxy_ResourceBase) ParentResource() IResource { var returns IResource _jsii_.Get( j, "parentResource", &returns, ) return returns } func (j *jsiiProxy_ResourceBase) Path() *string { var returns *string _jsii_.Get( j, "path", &returns, ) return returns } func (j *jsiiProxy_ResourceBase) PhysicalName() *string { var returns *string _jsii_.Get( j, "physicalName", &returns, ) return returns } func (j *jsiiProxy_ResourceBase) ResourceId() *string { var returns *string _jsii_.Get( j, "resourceId", &returns, ) return returns } func (j *jsiiProxy_ResourceBase) Stack() awscdk.Stack { var returns awscdk.Stack _jsii_.Get( j, "stack", &returns, ) return returns } func NewResourceBase_Override(r ResourceBase, scope constructs.Construct, id *string) { _init_.Initialize() _jsii_.Create( "aws-cdk-lib.aws_apigateway.ResourceBase", []interface{}{scope, id}, r, ) } // Checks if `x` is a construct. // // 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. // // Returns: true if `x` is an object created from a class which extends `Construct`. func ResourceBase_IsConstruct(x interface{}) *bool { _init_.Initialize() if err := validateResourceBase_IsConstructParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_apigateway.ResourceBase", "isConstruct", []interface{}{x}, &returns, ) return returns } // Returns true if the construct was created by CDK, and false otherwise. func ResourceBase_IsOwnedResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateResourceBase_IsOwnedResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_apigateway.ResourceBase", "isOwnedResource", []interface{}{construct}, &returns, ) return returns } // Check whether the given construct is a Resource. func ResourceBase_IsResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateResourceBase_IsResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_apigateway.ResourceBase", "isResource", []interface{}{construct}, &returns, ) return returns } func (r *jsiiProxy_ResourceBase) AddCorsPreflight(options *CorsOptions) Method { if err := r.validateAddCorsPreflightParameters(options); err != nil { panic(err) } var returns Method _jsii_.Invoke( r, "addCorsPreflight", []interface{}{options}, &returns, ) return returns } func (r *jsiiProxy_ResourceBase) AddMethod(httpMethod *string, integration Integration, options *MethodOptions) Method { if err := r.validateAddMethodParameters(httpMethod, options); err != nil { panic(err) } var returns Method _jsii_.Invoke( r, "addMethod", []interface{}{httpMethod, integration, options}, &returns, ) return returns } func (r *jsiiProxy_ResourceBase) AddProxy(options *ProxyResourceOptions) ProxyResource { if err := r.validateAddProxyParameters(options); err != nil { panic(err) } var returns ProxyResource _jsii_.Invoke( r, "addProxy", []interface{}{options}, &returns, ) return returns } func (r *jsiiProxy_ResourceBase) AddResource(pathPart *string, options *ResourceOptions) Resource { if err := r.validateAddResourceParameters(pathPart, options); err != nil { panic(err) } var returns Resource _jsii_.Invoke( r, "addResource", []interface{}{pathPart, options}, &returns, ) return returns } func (r *jsiiProxy_ResourceBase) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) { if err := r.validateApplyRemovalPolicyParameters(policy); err != nil { panic(err) } _jsii_.InvokeVoid( r, "applyRemovalPolicy", []interface{}{policy}, ) } func (r *jsiiProxy_ResourceBase) GeneratePhysicalName() *string { var returns *string _jsii_.Invoke( r, "generatePhysicalName", nil, // no parameters &returns, ) return returns } func (r *jsiiProxy_ResourceBase) GetResource(pathPart *string) IResource { if err := r.validateGetResourceParameters(pathPart); err != nil { panic(err) } var returns IResource _jsii_.Invoke( r, "getResource", []interface{}{pathPart}, &returns, ) return returns } func (r *jsiiProxy_ResourceBase) GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string { if err := r.validateGetResourceArnAttributeParameters(arnAttr, arnComponents); err != nil { panic(err) } var returns *string _jsii_.Invoke( r, "getResourceArnAttribute", []interface{}{arnAttr, arnComponents}, &returns, ) return returns } func (r *jsiiProxy_ResourceBase) GetResourceNameAttribute(nameAttr *string) *string { if err := r.validateGetResourceNameAttributeParameters(nameAttr); err != nil { panic(err) } var returns *string _jsii_.Invoke( r, "getResourceNameAttribute", []interface{}{nameAttr}, &returns, ) return returns } func (r *jsiiProxy_ResourceBase) ResourceForPath(path *string) Resource { if err := r.validateResourceForPathParameters(path); err != nil { panic(err) } var returns Resource _jsii_.Invoke( r, "resourceForPath", []interface{}{path}, &returns, ) return returns } func (r *jsiiProxy_ResourceBase) ToString() *string { var returns *string _jsii_.Invoke( r, "toString", nil, // no parameters &returns, ) return returns }