software.amazon.awscdk.services.apigatewayv2.alpha

Interface HttpApiAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpApiAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-02-15T19:53:17.391Z")
 @Stability(value=Experimental)
public interface HttpApiAttributes
extends software.amazon.jsii.JsiiSerializable

(experimental) 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.alpha.*;
 HttpApiAttributes httpApiAttributes = HttpApiAttributes.builder()
         .httpApiId("httpApiId")
         // the properties below are optional
         .apiEndpoint("apiEndpoint")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getHttpApiId

@Stability(value=Experimental)
 @NotNull
String getHttpApiId()

(experimental) The identifier of the HttpApi.

getApiEndpoint

@Stability(value=Experimental)
 @Nullable
default String getApiEndpoint()

(experimental) The endpoint URL of the HttpApi.

Default: - throws an error if apiEndpoint is accessed.

builder

@Stability(value=Experimental)
static HttpApiAttributes.Builder builder()

Returns:

a HttpApiAttributes.Builder of HttpApiAttributes