software.amazon.awscdk.services.apigatewayv2

Interface HttpApiAttributes

All Known Implementing Classes:

HttpApiAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:06.956Z")
public interface HttpApiAttributes

(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.*;
 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 java.lang.String	getApiEndpoint() (experimental) The endpoint URL of the HttpApi.
java.lang.String	getHttpApiId() (experimental) The identifier of the HttpApi.

Method Detail

getHttpApiId

java.lang.String getHttpApiId()

(experimental) The identifier of the HttpApi.

getApiEndpoint

default java.lang.String getApiEndpoint()

(experimental) The endpoint URL of the HttpApi.

Default: - throws an error if apiEndpoint is accessed.

builder

static HttpApiAttributes.Builder builder()

Returns:

a HttpApiAttributes.Builder of HttpApiAttributes