Uses of Interface
software.amazon.awscdk.interfaces.apigateway.IRestApiRef

Packages that use IRestApiRef

Package	Description
software.amazon.awscdk.cfnpropertymixins.services.apigateway
software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2
software.amazon.awscdk.interfaces.apigateway
software.amazon.awscdk.services.apigateway	Amazon API Gateway Construct Library
software.amazon.awscdk.services.apigatewayv2	AWS APIGatewayv2 Construct Library

Uses of IRestApiRef in software.amazon.awscdk.cfnpropertymixins.services.apigateway

Methods in software.amazon.awscdk.cfnpropertymixins.services.apigateway with parameters of type IRestApiRef

Modifier and Type	Method	Description
CfnUsagePlanPropsMixin.ApiStageProperty.Builder	CfnUsagePlanPropsMixin.ApiStageProperty.Builder.apiId(IRestApiRef apiId)	Sets the value of CfnUsagePlanPropsMixin.ApiStageProperty.getApiId()
CfnRestApiMixinProps.Builder	CfnRestApiMixinProps.Builder.cloneFrom(IRestApiRef cloneFrom)	Sets the value of CfnRestApiMixinProps.getCloneFrom()
CfnRestApiPropsMixin.Builder	CfnRestApiPropsMixin.Builder.cloneFrom(IRestApiRef cloneFrom)	The ID of the RestApi that you want to clone from.
CfnApiKeyPropsMixin.StageKeyProperty.Builder	CfnApiKeyPropsMixin.StageKeyProperty.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnApiKeyPropsMixin.StageKeyProperty.getRestApiId()
CfnAuthorizerMixinProps.Builder	CfnAuthorizerMixinProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnAuthorizerMixinProps.getRestApiId()
CfnAuthorizerPropsMixin.Builder	CfnAuthorizerPropsMixin.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnBasePathMappingMixinProps.Builder	CfnBasePathMappingMixinProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnBasePathMappingMixinProps.getRestApiId()
CfnBasePathMappingPropsMixin.Builder	CfnBasePathMappingPropsMixin.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnDeploymentMixinProps.Builder	CfnDeploymentMixinProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnDeploymentMixinProps.getRestApiId()
CfnDeploymentPropsMixin.Builder	CfnDeploymentPropsMixin.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnDocumentationPartMixinProps.Builder	CfnDocumentationPartMixinProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnDocumentationPartMixinProps.getRestApiId()
CfnDocumentationPartPropsMixin.Builder	CfnDocumentationPartPropsMixin.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnDocumentationVersionMixinProps.Builder	CfnDocumentationVersionMixinProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnDocumentationVersionMixinProps.getRestApiId()
CfnDocumentationVersionPropsMixin.Builder	CfnDocumentationVersionPropsMixin.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnGatewayResponseMixinProps.Builder	CfnGatewayResponseMixinProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnGatewayResponseMixinProps.getRestApiId()
CfnGatewayResponsePropsMixin.Builder	CfnGatewayResponsePropsMixin.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnMethodMixinProps.Builder	CfnMethodMixinProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnMethodMixinProps.getRestApiId()
CfnMethodPropsMixin.Builder	CfnMethodPropsMixin.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnModelMixinProps.Builder	CfnModelMixinProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnModelMixinProps.getRestApiId()
CfnModelPropsMixin.Builder	CfnModelPropsMixin.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnRequestValidatorMixinProps.Builder	CfnRequestValidatorMixinProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnRequestValidatorMixinProps.getRestApiId()
CfnRequestValidatorPropsMixin.Builder	CfnRequestValidatorPropsMixin.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnResourceMixinProps.Builder	CfnResourceMixinProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnResourceMixinProps.getRestApiId()
CfnResourcePropsMixin.Builder	CfnResourcePropsMixin.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnStageMixinProps.Builder	CfnStageMixinProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnStageMixinProps.getRestApiId()
CfnStagePropsMixin.Builder	CfnStagePropsMixin.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.

Uses of IRestApiRef in software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2

Methods in software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2 with parameters of type IRestApiRef

Modifier and Type	Method	Description
CfnApiMappingMixinProps.Builder	CfnApiMappingMixinProps.Builder.apiId(IRestApiRef apiId)	Sets the value of CfnApiMappingMixinProps.getApiId()
CfnApiMappingPropsMixin.Builder	CfnApiMappingPropsMixin.Builder.apiId(IRestApiRef apiId)	The API identifier.

Uses of IRestApiRef in software.amazon.awscdk.interfaces.apigateway

Subinterfaces of IRestApiRef in software.amazon.awscdk.interfaces.apigateway

Modifier and Type	Interface	Description
static interface	IRestApiRef.Jsii$Default	Internal default implementation for IRestApiRef.

Classes in software.amazon.awscdk.interfaces.apigateway that implement IRestApiRef

Modifier and Type	Class	Description
static final class	IRestApiRef.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Uses of IRestApiRef in software.amazon.awscdk.services.apigateway

Subinterfaces of IRestApiRef in software.amazon.awscdk.services.apigateway

Modifier and Type	Interface	Description
interface	IRestApi
static interface	IRestApi.Jsii$Default	Internal default implementation for IRestApi.

Classes in software.amazon.awscdk.services.apigateway that implement IRestApiRef

Modifier and Type	Class	Description
class	CfnRestApi	The AWS::ApiGateway::RestApi resource creates a REST API.
static final class	IRestApi.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
class	LambdaRestApi	Defines an API Gateway REST API with AWS Lambda proxy integration.
class	RestApi	Represents a REST API in Amazon API Gateway.
class	RestApiBase	Base implementation that are common to various implementations of IRestApi.
class	SpecRestApi	Represents a REST API in Amazon API Gateway, created with an OpenAPI specification.
class	StepFunctionsRestApi	Defines an API Gateway REST API with a Synchrounous Express State Machine as a proxy integration.

Methods in software.amazon.awscdk.services.apigateway that return IRestApiRef

Modifier and Type	Method	Description
static IRestApiRef	CfnRestApi.fromRestApiId(software.constructs.Construct scope, String id, String restApiId)	Creates a new IRestApiRef from a restApiId.
IRestApiRef	BasePathMappingProps.getRestApi()	The RestApi resource to target.
final IRestApiRef	BasePathMappingProps.Jsii$Proxy.getRestApi()

Methods in software.amazon.awscdk.services.apigateway with parameters of type IRestApiRef

Modifier and Type	Method	Description
BasePathMapping	DomainName.addBasePathMapping(IRestApiRef targetApi)	Maps this domain to an API endpoint.
BasePathMapping	DomainName.addBasePathMapping(IRestApiRef targetApi, BasePathMappingOptions options)	Maps this domain to an API endpoint.
static String	CfnRestApi.arnForRestApi(IRestApiRef resource)
void	ApiDefinition.bindAfterCreate(software.constructs.Construct _scope, IRestApiRef _restApi)	Called after the CFN RestApi resource has been created to allow the Api Definition to bind to it.
void	AssetApiDefinition.bindAfterCreate(software.constructs.Construct scope, IRestApiRef restApi)	Called after the CFN RestApi resource has been created to allow the Api Definition to bind to it.
CfnRestApi.Builder	CfnRestApi.Builder.cloneFrom(IRestApiRef cloneFrom)	The ID of the RestApi that you want to clone from.
CfnRestApiProps.Builder	CfnRestApiProps.Builder.cloneFrom(IRestApiRef cloneFrom)	Sets the value of CfnRestApiProps.getCloneFrom()
BasePathMapping.Builder	BasePathMapping.Builder.restApi(IRestApiRef restApi)	The RestApi resource to target.
BasePathMappingProps.Builder	BasePathMappingProps.Builder.restApi(IRestApiRef restApi)	Sets the value of BasePathMappingProps.getRestApi()
CfnAuthorizer.Builder	CfnAuthorizer.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnAuthorizerProps.Builder	CfnAuthorizerProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnAuthorizerProps.getRestApiId()
CfnBasePathMapping.Builder	CfnBasePathMapping.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnBasePathMappingProps.Builder	CfnBasePathMappingProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnBasePathMappingProps.getRestApiId()
CfnDeployment.Builder	CfnDeployment.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnDeploymentProps.Builder	CfnDeploymentProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnDeploymentProps.getRestApiId()
CfnDocumentationPart.Builder	CfnDocumentationPart.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnDocumentationPartProps.Builder	CfnDocumentationPartProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnDocumentationPartProps.getRestApiId()
CfnDocumentationVersion.Builder	CfnDocumentationVersion.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnDocumentationVersionProps.Builder	CfnDocumentationVersionProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnDocumentationVersionProps.getRestApiId()
CfnGatewayResponse.Builder	CfnGatewayResponse.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnGatewayResponseProps.Builder	CfnGatewayResponseProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnGatewayResponseProps.getRestApiId()
CfnMethod.Builder	CfnMethod.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnMethodProps.Builder	CfnMethodProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnMethodProps.getRestApiId()
CfnModel.Builder	CfnModel.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnModelProps.Builder	CfnModelProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnModelProps.getRestApiId()
CfnRequestValidator.Builder	CfnRequestValidator.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnRequestValidatorProps.Builder	CfnRequestValidatorProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnRequestValidatorProps.getRestApiId()
CfnResource.Builder	CfnResource.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnResourceProps.Builder	CfnResourceProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnResourceProps.getRestApiId()
CfnStage.Builder	CfnStage.Builder.restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnStageProps.Builder	CfnStageProps.Builder.restApiId(IRestApiRef restApiId)	Sets the value of CfnStageProps.getRestApiId()

Uses of IRestApiRef in software.amazon.awscdk.services.apigatewayv2

Methods in software.amazon.awscdk.services.apigatewayv2 with parameters of type IRestApiRef

Modifier and Type	Method	Description
CfnApiMapping.Builder	CfnApiMapping.Builder.apiId(IRestApiRef apiId)	The API identifier.
CfnApiMappingProps.Builder	CfnApiMappingProps.Builder.apiId(IRestApiRef apiId)	Sets the value of CfnApiMappingProps.getApiId()