Class: AWSCDK::APIGateway::ProxyResource

Inherits:
Resource
  • Object
show all
Defined in:
api_gateway/proxy_resource.rb

Overview

Defines a proxy+ greedy resource and an ANY method on a route.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ ProxyResource

Returns a new instance of ProxyResource.

Parameters:



13
14
15
16
17
18
19
 
# File 'api_gateway/proxy_resource.rb', line 13

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::APIGateway::ProxyResourceProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5Qcm94eVJlc291cmNlUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'api_gateway/proxy_resource.rb', line 21

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :api => { kind: :property, name: "api", is_optional: false },
    :path => { kind: :property, name: "path", is_optional: false },
    :resource_id => { kind: :property, name: "resourceId", is_optional: false },
    :resource_ref => { kind: :property, name: "resourceRef", is_optional: false },
    :default_cors_preflight_options => { kind: :property, name: "defaultCorsPreflightOptions", is_optional: true },
    :default_integration => { kind: :property, name: "defaultIntegration", is_optional: true },
    :default_method_options => { kind: :property, name: "defaultMethodOptions", is_optional: true },
    :parent_resource => { kind: :property, name: "parentResource", is_optional: true },
    :any_method => { kind: :property, name: "anyMethod", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_cors_preflight => { kind: :method, name: "addCorsPreflight", is_optional: false },
    :add_method => { kind: :method, name: "addMethod", is_optional: false },
    :add_proxy => { kind: :method, name: "addProxy", is_optional: false },
    :add_resource => { kind: :method, name: "addResource", is_optional: false },
    :get_resource => { kind: :method, name: "getResource", is_optional: false },
    :resource_for_path => { kind: :method, name: "resourceForPath", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


159
160
161
 
# File 'api_gateway/proxy_resource.rb', line 159

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ProxyResource", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_cors_preflight(options) ⇒ AWSCDK::APIGateway::Method

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.

Parameters:

Returns:



271
272
273
274
275
 
# File 'api_gateway/proxy_resource.rb', line 271

def add_cors_preflight(options)
  options = options.is_a?(Hash) ? ::AWSCDK::APIGateway::CorsOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5Db3JzT3B0aW9ucyJ9")), "options")
  jsii_call_method("addCorsPreflight", [options])
end

#add_method(http_method, integration = nil, options = nil) ⇒ AWSCDK::APIGateway::Method

Defines a new method for this resource.

Parameters:

Returns:



283
284
285
286
287
288
289
 
# File 'api_gateway/proxy_resource.rb', line 283

def add_method(http_method, integration = nil, options = nil)
  Jsii::Type.check_type(http_method, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "httpMethod")
  Jsii::Type.check_type(integration, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5JbnRlZ3JhdGlvbiJ9")), "integration") unless integration.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::APIGateway::MethodOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5NZXRob2RPcHRpb25zIn0=")), "options") unless options.nil?
  jsii_call_method("addMethod", [http_method, integration, options])
end

#add_proxy(options = nil) ⇒ AWSCDK::APIGateway::ProxyResource

Adds a greedy proxy resource ("proxy+") and an ANY method to this route.

Parameters:

Returns:

  • (AWSCDK::APIGateway::ProxyResource) 


295
296
297
298
299
 
# File 'api_gateway/proxy_resource.rb', line 295

def add_proxy(options = nil)
  options = options.is_a?(Hash) ? ::AWSCDK::APIGateway::ProxyResourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5Qcm94eVJlc291cmNlT3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("addProxy", [options])
end

#add_resource(path_part, options = nil) ⇒ AWSCDK::APIGateway::Resource

Defines a new child resource where this resource is the parent.

Parameters:

Returns:



306
307
308
309
310
311
 
# File 'api_gateway/proxy_resource.rb', line 306

def add_resource(path_part, options = nil)
  Jsii::Type.check_type(path_part, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pathPart")
  options = options.is_a?(Hash) ? ::AWSCDK::APIGateway::ResourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5SZXNvdXJjZU9wdGlvbnMifQ==")), "options") unless options.nil?
  jsii_call_method("addResource", [path_part, options])
end

#any_method ⇒ AWSCDK::APIGateway::Method?

If props.anyMethod is true, this will be the reference to the 'ANY' method associated with this proxy resource.

Returns:



166
167
168
 
# File 'api_gateway/proxy_resource.rb', line 166

def any_method()
  jsii_get_property("anyMethod")
end

#api ⇒ AWSCDK::APIGateway::IRestAPI

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 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.

Returns:



103
104
105
 
# File 'api_gateway/proxy_resource.rb', line 103

def api()
  jsii_get_property("api")
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

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:



203
204
205
206
 
# File 'api_gateway/proxy_resource.rb', line 203

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

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).

Parameters:



220
221
222
223
 
# File 'api_gateway/proxy_resource.rb', line 220

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#default_cors_preflight_options ⇒ AWSCDK::APIGateway::CorsOptions?

Default options for CORS preflight OPTIONS method.

Returns:



131
132
133
 
# File 'api_gateway/proxy_resource.rb', line 131

def default_cors_preflight_options()
  jsii_get_property("defaultCorsPreflightOptions")
end

#default_integration ⇒ AWSCDK::APIGateway::Integration?

An integration to use as a default for all methods created within this API unless an integration is specified.

Returns:



138
139
140
 
# File 'api_gateway/proxy_resource.rb', line 138

def default_integration()
  jsii_get_property("defaultIntegration")
end

#default_method_options ⇒ AWSCDK::APIGateway::MethodOptions?

Method options to use as a default for all methods created within this API unless custom options are specified.

Returns:



145
146
147
 
# File 'api_gateway/proxy_resource.rb', line 145

def default_method_options()
  jsii_get_property("defaultMethodOptions")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

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.

Returns:



70
71
72
 
# File 'api_gateway/proxy_resource.rb', line 70

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


226
227
228
 
# File 'api_gateway/proxy_resource.rb', line 226

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource(path_part) ⇒ AWSCDK::APIGateway::IResource?

Retrieves a child resource by path part.

Parameters:

  • path_part (String)

Returns:



317
318
319
320
 
# File 'api_gateway/proxy_resource.rb', line 317

def get_resource(path_part)
  Jsii::Type.check_type(path_part, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pathPart")
  jsii_call_method("getResource", [path_part])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

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 arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


240
241
242
243
244
245
 
# File 'api_gateway/proxy_resource.rb', line 240

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ 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 name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


255
256
257
258
 
# File 'api_gateway/proxy_resource.rb', line 255

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


55
56
57
 
# File 'api_gateway/proxy_resource.rb', line 55

def node()
  jsii_get_property("node")
end

#parent_resource ⇒ AWSCDK::APIGateway::IResource?

The parent of this resource or undefined for the root resource.

Returns:



152
153
154
 
# File 'api_gateway/proxy_resource.rb', line 152

def parent_resource()
  jsii_get_property("parentResource")
end

#path ⇒ String

The full path of this resource.

Returns:

  • (String) 


110
111
112
 
# File 'api_gateway/proxy_resource.rb', line 110

def path()
  jsii_get_property("path")
end

#physical_name ⇒ 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.

Returns:

  • (String) 


84
85
86
 
# File 'api_gateway/proxy_resource.rb', line 84

def physical_name()
  jsii_get_property("physicalName")
end

#resource_for_path(path) ⇒ AWSCDK::APIGateway::Resource

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.

Parameters:

  • path (String)

Returns:



329
330
331
332
 
# File 'api_gateway/proxy_resource.rb', line 329

def resource_for_path(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("resourceForPath", [path])
end

#resource_id ⇒ String

The ID of the resource.

Returns:

  • (String) 


117
118
119
 
# File 'api_gateway/proxy_resource.rb', line 117

def resource_id()
  jsii_get_property("resourceId")
end

#resource_ref ⇒ AWSCDK::Interfaces::AWSApigateway::ResourceReference

A reference to a Resource resource.

Returns:



124
125
126
 
# File 'api_gateway/proxy_resource.rb', line 124

def resource_ref()
  jsii_get_property("resourceRef")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



91
92
93
 
# File 'api_gateway/proxy_resource.rb', line 91

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


173
174
175
 
# File 'api_gateway/proxy_resource.rb', line 173

def to_string()
  jsii_call_method("toString", [])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

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.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


186
187
188
189
190
191
 
# File 'api_gateway/proxy_resource.rb', line 186

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end