Class: AWSCDK::APIGatewayv2::HttpAPI

Inherits:
Resource
  • Object
show all
Includes:
IAPI, IHttpAPI
Defined in:
api_gatewayv2/http_api.rb

Overview

Create a new API Gateway HTTP API endpoint.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ HttpAPI

Returns a new instance of HttpAPI.

Parameters:



13
14
15
16
17
18
19
# File 'api_gatewayv2/http_api.rb', line 13

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::HttpAPIProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLkh0dHBBcGlQcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_http_api_attributes(scope, id, attrs) ⇒ AWSCDK::APIGatewayv2::IHttpAPI

Import an existing HTTP API into this CDK app.

Parameters:

Returns:



65
66
67
68
69
70
71
# File 'api_gatewayv2/http_api.rb', line 65

def self.from_http_api_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::HttpAPIAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLkh0dHBBcGlBdHRyaWJ1dGVzIn0=")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigatewayv2.HttpApi", "fromHttpApiAttributes", [scope, id, attrs])
end

.jsii_overridable_methodsObject



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
51
52
53
54
55
56
57
# File 'api_gatewayv2/http_api.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_endpoint => { kind: :property, name: "apiEndpoint", is_optional: false },
    :api_id => { kind: :property, name: "apiId", is_optional: false },
    :api_ref => { kind: :property, name: "apiRef", is_optional: false },
    :http_api_id => { kind: :property, name: "httpApiId", is_optional: false },
    :is_http_api => { kind: :property, name: "isHttpApi", is_optional: false },
    :default_authorization_scopes => { kind: :property, name: "defaultAuthorizationScopes", is_optional: true },
    :default_authorizer => { kind: :property, name: "defaultAuthorizer", is_optional: true },
    :default_stage => { kind: :property, name: "defaultStage", is_optional: true },
    :disable_execute_api_endpoint => { kind: :property, name: "disableExecuteApiEndpoint", is_optional: true },
    :http_api_name => { kind: :property, name: "httpApiName", is_optional: true },
    :url => { kind: :property, name: "url", 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_routes => { kind: :method, name: "addRoutes", is_optional: false },
    :add_stage => { kind: :method, name: "addStage", is_optional: false },
    :add_vpc_link => { kind: :method, name: "addVpcLink", is_optional: false },
    :arn_for_execute_api => { kind: :method, name: "arnForExecuteApi", is_optional: false },
    :metric => { kind: :method, name: "metric", is_optional: false },
    :metric_client_error => { kind: :method, name: "metricClientError", is_optional: false },
    :metric_count => { kind: :method, name: "metricCount", is_optional: false },
    :metric_data_processed => { kind: :method, name: "metricDataProcessed", is_optional: false },
    :metric_integration_latency => { kind: :method, name: "metricIntegrationLatency", is_optional: false },
    :metric_latency => { kind: :method, name: "metricLatency", is_optional: false },
    :metric_server_error => { kind: :method, name: "metricServerError", is_optional: false },
  }
end

.PROPERTY_INJECTION_IDString

Uniquely identifies this class.

Returns:

  • (String)


119
120
121
# File 'api_gatewayv2/http_api.rb', line 119

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

Instance Method Details

#add_routes(options) ⇒ Array<AWSCDK::APIGatewayv2::HttpRoute>

Add multiple routes that uses the same configuration.

The routes all go to the same path, but for different methods.



307
308
309
310
311
# File 'api_gatewayv2/http_api.rb', line 307

def add_routes(options)
  options = options.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::AddRoutesOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLkFkZFJvdXRlc09wdGlvbnMifQ==")), "options")
  jsii_call_method("addRoutes", [options])
end

#add_stage(id, options) ⇒ AWSCDK::APIGatewayv2::HttpStage

Add a new stage.

Parameters:

Returns:



318
319
320
321
322
323
# File 'api_gatewayv2/http_api.rb', line 318

def add_stage(id, options)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::HttpStageOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLkh0dHBTdGFnZU9wdGlvbnMifQ==")), "options")
  jsii_call_method("addStage", [id, options])
end

Add a new VpcLink.



329
330
331
332
333
# File 'api_gatewayv2/http_api.rb', line 329

def add_vpc_link(options)
  options = options.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::VPCLinkProps.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLlZwY0xpbmtQcm9wcyJ9")), "options")
  jsii_call_method("addVpcLink", [options])
end

#api_endpointString

Get the default endpoint for this API.

Returns:

  • (String)


126
127
128
# File 'api_gatewayv2/http_api.rb', line 126

def api_endpoint()
  jsii_get_property("apiEndpoint")
end

#api_idString

The identifier of this API Gateway API.

Returns:

  • (String)


133
134
135
# File 'api_gatewayv2/http_api.rb', line 133

def api_id()
  jsii_get_property("apiId")
end

#api_refAWSCDK::Interfaces::AWSApigatewayv2::APIReference

A reference to a Api resource.



140
141
142
# File 'api_gatewayv2/http_api.rb', line 140

def api_ref()
  jsii_get_property("apiRef")
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:



243
244
245
246
# File 'api_gatewayv2/http_api.rb', line 243

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:



260
261
262
263
# File 'api_gatewayv2/http_api.rb', line 260

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

#arn_for_execute_api(method = nil, path = nil, stage = nil) ⇒ String

Get the "execute-api" ARN.

When 'ANY' is passed to the method, an ARN with the method set to '*' is obtained.

Parameters:

  • method (String, nil) (defaults to: nil)
  • path (String, nil) (defaults to: nil)
  • stage (String, nil) (defaults to: nil)

Returns:

  • (String)


343
344
345
346
347
348
# File 'api_gatewayv2/http_api.rb', line 343

def arn_for_execute_api(method = nil, path = nil, stage = nil)
  Jsii::Type.check_type(method, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "method") unless method.nil?
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path") unless path.nil?
  Jsii::Type.check_type(stage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stage") unless stage.nil?
  jsii_call_method("arnForExecuteApi", [method, path, stage])
end

#default_authorization_scopesArray<String>?

Default OIDC scopes attached to all routes in the gateway, unless explicitly configured on the route.

The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation.

Returns:

  • (Array<String>, nil)


167
168
169
# File 'api_gatewayv2/http_api.rb', line 167

def default_authorization_scopes()
  jsii_get_property("defaultAuthorizationScopes")
end

#default_authorizerAWSCDK::APIGatewayv2::IHttpRouteAuthorizer?

Default Authorizer applied to all routes in the gateway.



174
175
176
# File 'api_gatewayv2/http_api.rb', line 174

def default_authorizer()
  jsii_get_property("defaultAuthorizer")
end

#default_stageAWSCDK::APIGatewayv2::IHttpStage?

The default stage of this API.



181
182
183
# File 'api_gatewayv2/http_api.rb', line 181

def default_stage()
  jsii_get_property("defaultStage")
end

#disable_execute_api_endpointBoolean?

Specifies whether clients can invoke this HTTP API by using the default execute-api endpoint.

Returns:

  • (Boolean, nil)


188
189
190
# File 'api_gatewayv2/http_api.rb', line 188

def disable_execute_api_endpoint()
  jsii_get_property("disableExecuteApiEndpoint")
end

#envAWSCDK::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.



91
92
93
# File 'api_gatewayv2/http_api.rb', line 91

def env()
  jsii_get_property("env")
end

#generate_physical_nameString

Returns:

  • (String)


266
267
268
# File 'api_gatewayv2/http_api.rb', line 266

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
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)


280
281
282
283
284
285
# File 'api_gatewayv2/http_api.rb', line 280

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)


295
296
297
298
# File 'api_gatewayv2/http_api.rb', line 295

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

#http_api_idString

The identifier of the HTTP API.



148
149
150
# File 'api_gatewayv2/http_api.rb', line 148

def http_api_id()
  jsii_get_property("httpApiId")
end

#http_api_nameString?

A human friendly name for this HTTP API.

Note that this is different from http_api_id.

Returns:

  • (String, nil)


197
198
199
# File 'api_gatewayv2/http_api.rb', line 197

def http_api_name()
  jsii_get_property("httpApiName")
end

#is_http_apiBoolean

Indicates that this is an HTTP API.

Will always return true, but is necessary to prevent accidental structural equality in TypeScript.

Returns:

  • (Boolean)


158
159
160
# File 'api_gatewayv2/http_api.rb', line 158

def is_http_api()
  jsii_get_property("isHttpApi")
end

#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Return the given named metric for this Api Gateway.

Parameters:

Returns:



355
356
357
358
359
360
# File 'api_gatewayv2/http_api.rb', line 355

def metric(metric_name, props = nil)
  Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metric", [metric_name, props])
end

#metric_client_error(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Metric for the number of client-side errors captured in a given period.

Parameters:

Returns:



366
367
368
369
370
# File 'api_gatewayv2/http_api.rb', line 366

def metric_client_error(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricClientError", [props])
end

#metric_count(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Metric for the total number API requests in a given period.

Parameters:

Returns:



376
377
378
379
380
# File 'api_gatewayv2/http_api.rb', line 376

def metric_count(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricCount", [props])
end

#metric_data_processed(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Metric for the amount of data processed in bytes.

Parameters:

Returns:



386
387
388
389
390
# File 'api_gatewayv2/http_api.rb', line 386

def metric_data_processed(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricDataProcessed", [props])
end

#metric_integration_latency(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.

Parameters:

Returns:



396
397
398
399
400
# File 'api_gatewayv2/http_api.rb', line 396

def metric_integration_latency(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricIntegrationLatency", [props])
end

#metric_latency(props = nil) ⇒ AWSCDK::CloudWatch::Metric

The time between when API Gateway receives a request from a client and when it returns a response to the client.

The latency includes the integration latency and other API Gateway overhead.

Parameters:

Returns:



408
409
410
411
412
# File 'api_gatewayv2/http_api.rb', line 408

def metric_latency(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricLatency", [props])
end

#metric_server_error(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Metric for the number of server-side errors captured in a given period.

Parameters:

Returns:



418
419
420
421
422
# File 'api_gatewayv2/http_api.rb', line 418

def metric_server_error(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricServerError", [props])
end

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


76
77
78
# File 'api_gatewayv2/http_api.rb', line 76

def node()
  jsii_get_property("node")
end

#physical_nameString

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)


105
106
107
# File 'api_gatewayv2/http_api.rb', line 105

def physical_name()
  jsii_get_property("physicalName")
end

#stackAWSCDK::Stack

The stack in which this resource is defined.

Returns:



112
113
114
# File 'api_gatewayv2/http_api.rb', line 112

def stack()
  jsii_get_property("stack")
end

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)


213
214
215
# File 'api_gatewayv2/http_api.rb', line 213

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

#urlString?

Get the URL to the default stage of this API.

Returns undefined if create_default_stage is unset.

Returns:

  • (String, nil)


206
207
208
# File 'api_gatewayv2/http_api.rb', line 206

def url()
  jsii_get_property("url")
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)


226
227
228
229
230
231
# File 'api_gatewayv2/http_api.rb', line 226

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