Package software.amazon.awscdk.services.appsync

Class ApiBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.appsync.ApiBase

All Implemented Interfaces:

IApiRef, IEnvironmentAware, IResource, IApi, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

EventApiBase

@Generated(value="jsii-pacmak/1.133.0 (build 0f43e37)",
           date="2026-06-11T16:21:35.526Z")
@Stability(Stable)
public abstract class ApiBase
extends Resource
implements IApi

Base Class for API.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.appsync.IApi

IApi.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ApiBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ApiBase(software.amazon.jsii.JsiiObjectRef objRef)
protected	ApiBase(software.constructs.Construct scope, String id)
protected	ApiBase(software.constructs.Construct scope, String id, ResourceProps props)

Method Summary

Modifier and Type	Method	Description
abstract String	getApiArn()	The ARN of the AWS AppSync Api.
abstract String	getApiId()	The unique identifier for the AWS AppSync Api generated by the service.
ApiReference	getApiRef()	A reference to a Api resource.

Methods inherited from class software.amazon.awscdk.Resource

applyCrossStackReferenceStrength, applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

ApiBase

protected ApiBase(software.amazon.jsii.JsiiObjectRef objRef)

ApiBase

protected ApiBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ApiBase

@Stability(Stable)
protected ApiBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

ApiBase

@Stability(Stable)
protected ApiBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

getApiArn

@Stability(Stable)
@NotNull
public abstract String getApiArn()

The ARN of the AWS AppSync Api.

Specified by:

getApiArn in interface IApi

getApiId

@Stability(Stable)
@NotNull
public abstract String getApiId()

The unique identifier for the AWS AppSync Api generated by the service.

Specified by:

getApiId in interface IApi

getApiRef

@Stability(Stable)
@NotNull
public ApiReference getApiRef()

A reference to a Api resource.

Specified by:

getApiRef in interface IApiRef