interfacesawsapigatewayv2

package
v2.226.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 20, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiGatewayManagedOverridesReference

type ApiGatewayManagedOverridesReference struct {
	// The Id of the ApiGatewayManagedOverrides resource.
	ApiGatewayManagedOverridesId *string `field:"required" json:"apiGatewayManagedOverridesId" yaml:"apiGatewayManagedOverridesId"`
}

A reference to a ApiGatewayManagedOverrides resource.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

apiGatewayManagedOverridesReference := &ApiGatewayManagedOverridesReference{
	ApiGatewayManagedOverridesId: jsii.String("apiGatewayManagedOverridesId"),
}

type ApiMappingReference

type ApiMappingReference struct {
	// The ApiMappingId of the ApiMapping resource.
	ApiMappingId *string `field:"required" json:"apiMappingId" yaml:"apiMappingId"`
	// The DomainName of the ApiMapping resource.
	DomainName *string `field:"required" json:"domainName" yaml:"domainName"`
}

A reference to a ApiMapping resource.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

apiMappingReference := &ApiMappingReference{
	ApiMappingId: jsii.String("apiMappingId"),
	DomainName: jsii.String("domainName"),
}

type ApiReference

type ApiReference struct {
	// The ApiId of the Api resource.
	ApiId *string `field:"required" json:"apiId" yaml:"apiId"`
}

A reference to a Api resource.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

apiReference := &ApiReference{
	ApiId: jsii.String("apiId"),
}

type AuthorizerReference

type AuthorizerReference struct {
	// The ApiId of the Authorizer resource.
	ApiId *string `field:"required" json:"apiId" yaml:"apiId"`
	// The AuthorizerId of the Authorizer resource.
	AuthorizerId *string `field:"required" json:"authorizerId" yaml:"authorizerId"`
}

A reference to a Authorizer resource.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

authorizerReference := &AuthorizerReference{
	ApiId: jsii.String("apiId"),
	AuthorizerId: jsii.String("authorizerId"),
}

type DeploymentReference

type DeploymentReference struct {
	// The ApiId of the Deployment resource.
	ApiId *string `field:"required" json:"apiId" yaml:"apiId"`
	// The DeploymentId of the Deployment resource.
	DeploymentId *string `field:"required" json:"deploymentId" yaml:"deploymentId"`
}

A reference to a Deployment resource.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

deploymentReference := &DeploymentReference{
	ApiId: jsii.String("apiId"),
	DeploymentId: jsii.String("deploymentId"),
}

type DomainNameReference

type DomainNameReference struct {
	// The DomainName of the DomainName resource.
	DomainName *string `field:"required" json:"domainName" yaml:"domainName"`
	// The ARN of the DomainName resource.
	DomainNameArn *string `field:"required" json:"domainNameArn" yaml:"domainNameArn"`
}

A reference to a DomainName resource.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

domainNameReference := &DomainNameReference{
	DomainName: jsii.String("domainName"),
	DomainNameArn: jsii.String("domainNameArn"),
}

type IApiGatewayManagedOverridesRef

type IApiGatewayManagedOverridesRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a ApiGatewayManagedOverrides resource.
	// Experimental.
	ApiGatewayManagedOverridesRef() *ApiGatewayManagedOverridesReference
}

Indicates that this resource can be referenced as a ApiGatewayManagedOverrides. Experimental.

type IApiMappingRef

type IApiMappingRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a ApiMapping resource.
	// Experimental.
	ApiMappingRef() *ApiMappingReference
}

Indicates that this resource can be referenced as a ApiMapping. Experimental.

type IApiRef

type IApiRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a Api resource.
	// Experimental.
	ApiRef() *ApiReference
}

Indicates that this resource can be referenced as a Api. Experimental.

type IAuthorizerRef

type IAuthorizerRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a Authorizer resource.
	// Experimental.
	AuthorizerRef() *AuthorizerReference
}

Indicates that this resource can be referenced as a Authorizer. Experimental.

type IDeploymentRef

type IDeploymentRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a Deployment resource.
	// Experimental.
	DeploymentRef() *DeploymentReference
}

Indicates that this resource can be referenced as a Deployment. Experimental.

type IDomainNameRef

type IDomainNameRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a DomainName resource.
	// Experimental.
	DomainNameRef() *DomainNameReference
}

Indicates that this resource can be referenced as a DomainName. Experimental.

type IIntegrationRef

type IIntegrationRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a Integration resource.
	// Experimental.
	IntegrationRef() *IntegrationReference
}

Indicates that this resource can be referenced as a Integration. Experimental.

type IIntegrationResponseRef

type IIntegrationResponseRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a IntegrationResponse resource.
	// Experimental.
	IntegrationResponseRef() *IntegrationResponseReference
}

Indicates that this resource can be referenced as a IntegrationResponse. Experimental.

type IModelRef

type IModelRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a Model resource.
	// Experimental.
	ModelRef() *ModelReference
}

Indicates that this resource can be referenced as a Model. Experimental.

type IRouteRef

type IRouteRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a Route resource.
	// Experimental.
	RouteRef() *RouteReference
}

Indicates that this resource can be referenced as a Route. Experimental.

type IRouteResponseRef

type IRouteResponseRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a RouteResponse resource.
	// Experimental.
	RouteResponseRef() *RouteResponseReference
}

Indicates that this resource can be referenced as a RouteResponse. Experimental.

type IRoutingRuleRef

type IRoutingRuleRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a RoutingRule resource.
	// Experimental.
	RoutingRuleRef() *RoutingRuleReference
}

Indicates that this resource can be referenced as a RoutingRule. Experimental.

type IStageRef

type IStageRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a Stage resource.
	// Experimental.
	StageRef() *StageReference
}

Indicates that this resource can be referenced as a Stage. Experimental.

type IVpcLinkRef

type IVpcLinkRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a VpcLink resource.
	// Experimental.
	VpcLinkRef() *VpcLinkReference
}

Indicates that this resource can be referenced as a VpcLink. Experimental.

type IntegrationReference

type IntegrationReference struct {
	// The ApiId of the Integration resource.
	ApiId *string `field:"required" json:"apiId" yaml:"apiId"`
	// The IntegrationId of the Integration resource.
	IntegrationId *string `field:"required" json:"integrationId" yaml:"integrationId"`
}

A reference to a Integration resource.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

integrationReference := &IntegrationReference{
	ApiId: jsii.String("apiId"),
	IntegrationId: jsii.String("integrationId"),
}

type IntegrationResponseReference

type IntegrationResponseReference struct {
	// The ApiId of the IntegrationResponse resource.
	ApiId *string `field:"required" json:"apiId" yaml:"apiId"`
	// The IntegrationId of the IntegrationResponse resource.
	IntegrationId *string `field:"required" json:"integrationId" yaml:"integrationId"`
	// The IntegrationResponseId of the IntegrationResponse resource.
	IntegrationResponseId *string `field:"required" json:"integrationResponseId" yaml:"integrationResponseId"`
}

A reference to a IntegrationResponse resource.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

integrationResponseReference := &IntegrationResponseReference{
	ApiId: jsii.String("apiId"),
	IntegrationId: jsii.String("integrationId"),
	IntegrationResponseId: jsii.String("integrationResponseId"),
}

type ModelReference

type ModelReference struct {
	// The ApiId of the Model resource.
	ApiId *string `field:"required" json:"apiId" yaml:"apiId"`
	// The ModelId of the Model resource.
	ModelId *string `field:"required" json:"modelId" yaml:"modelId"`
}

A reference to a Model resource.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

modelReference := &ModelReference{
	ApiId: jsii.String("apiId"),
	ModelId: jsii.String("modelId"),
}

type RouteReference

type RouteReference struct {
	// The ApiId of the Route resource.
	ApiId *string `field:"required" json:"apiId" yaml:"apiId"`
	// The RouteId of the Route resource.
	RouteId *string `field:"required" json:"routeId" yaml:"routeId"`
}

A reference to a Route resource.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

routeReference := &RouteReference{
	ApiId: jsii.String("apiId"),
	RouteId: jsii.String("routeId"),
}

type RouteResponseReference

type RouteResponseReference struct {
	// The ApiId of the RouteResponse resource.
	ApiId *string `field:"required" json:"apiId" yaml:"apiId"`
	// The RouteId of the RouteResponse resource.
	RouteId *string `field:"required" json:"routeId" yaml:"routeId"`
	// The RouteResponseId of the RouteResponse resource.
	RouteResponseId *string `field:"required" json:"routeResponseId" yaml:"routeResponseId"`
}

A reference to a RouteResponse resource.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

routeResponseReference := &RouteResponseReference{
	ApiId: jsii.String("apiId"),
	RouteId: jsii.String("routeId"),
	RouteResponseId: jsii.String("routeResponseId"),
}

type RoutingRuleReference

type RoutingRuleReference struct {
	// The RoutingRuleArn of the RoutingRule resource.
	RoutingRuleArn *string `field:"required" json:"routingRuleArn" yaml:"routingRuleArn"`
}

A reference to a RoutingRule resource.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

routingRuleReference := &RoutingRuleReference{
	RoutingRuleArn: jsii.String("routingRuleArn"),
}

type StageReference

type StageReference struct {
	// The Id of the Stage resource.
	StageId *string `field:"required" json:"stageId" yaml:"stageId"`
}

A reference to a Stage resource.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

stageReference := &StageReference{
	StageId: jsii.String("stageId"),
}

type VpcLinkReference

type VpcLinkReference struct {
	// The VpcLinkId of the VpcLink resource.
	VpcLinkId *string `field:"required" json:"vpcLinkId" yaml:"vpcLinkId"`
}

A reference to a VpcLink resource.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

vpcLinkReference := &VpcLinkReference{
	VpcLinkId: jsii.String("vpcLinkId"),
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL