Package software.amazon.awscdk.services.apigatewayv2

Interface HttpApiAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpApiAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:10.746Z")
@Stability(Stable)
public interface HttpApiAttributes
extends software.amazon.jsii.JsiiSerializable

Attributes for importing an HttpApi into the CDK.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigatewayv2.*;
 HttpApiAttributes httpApiAttributes = HttpApiAttributes.builder()
         .httpApiId("httpApiId")
         // the properties below are optional
         .apiEndpoint("apiEndpoint")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	HttpApiAttributes.Builder	A builder for HttpApiAttributes
static final class	HttpApiAttributes.Jsii$Proxy	An implementation for HttpApiAttributes

Method Summary

Modifier and Type	Method	Description
static HttpApiAttributes.Builder	builder()
default String	getApiEndpoint()	The endpoint URL of the HttpApi.
String	getHttpApiId()	The identifier of the HttpApi.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHttpApiId

@Stability(Stable)
@NotNull
String getHttpApiId()

The identifier of the HttpApi.

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#aws-resource-apigatewayv2-api-return-values

getApiEndpoint

@Stability(Stable)
@Nullable
default String getApiEndpoint()

The endpoint URL of the HttpApi.

Default: - throws an error if apiEndpoint is accessed.

builder

@Stability(Stable)
static HttpApiAttributes.Builder builder()

Returns:

a HttpApiAttributes.Builder of HttpApiAttributes