interfacesawsapigateway

type AccountReference ¶

type AccountReference struct {
	// The Id of the Account resource.
	AccountId *string `field:"required" json:"accountId" yaml:"accountId"`
}

A reference to a Account 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"

accountReference := &AccountReference{
	AccountId: jsii.String("accountId"),
}

type ApiKeyReference ¶

type ApiKeyReference struct {
	// The APIKeyId of the ApiKey resource.
	ApiKeyId *string `field:"required" json:"apiKeyId" yaml:"apiKeyId"`
}

A reference to a ApiKey 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"

apiKeyReference := &ApiKeyReference{
	ApiKeyId: jsii.String("apiKeyId"),
}

type AuthorizerReference ¶

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

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{
	AuthorizerId: jsii.String("authorizerId"),
	RestApiId: jsii.String("restApiId"),
}

type BasePathMappingReference ¶

type BasePathMappingReference struct {
	// The BasePath of the BasePathMapping resource.
	BasePath *string `field:"required" json:"basePath" yaml:"basePath"`
	// The DomainName of the BasePathMapping resource.
	DomainName *string `field:"required" json:"domainName" yaml:"domainName"`
}

A reference to a BasePathMapping 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"

basePathMappingReference := &BasePathMappingReference{
	BasePath: jsii.String("basePath"),
	DomainName: jsii.String("domainName"),
}

type BasePathMappingV2Reference ¶

type BasePathMappingV2Reference struct {
	// The BasePathMappingArn of the BasePathMappingV2 resource.
	BasePathMappingArn *string `field:"required" json:"basePathMappingArn" yaml:"basePathMappingArn"`
}

A reference to a BasePathMappingV2 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"

basePathMappingV2Reference := &BasePathMappingV2Reference{
	BasePathMappingArn: jsii.String("basePathMappingArn"),
}

type ClientCertificateReference ¶

type ClientCertificateReference struct {
	// The ClientCertificateId of the ClientCertificate resource.
	ClientCertificateId *string `field:"required" json:"clientCertificateId" yaml:"clientCertificateId"`
}

A reference to a ClientCertificate 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"

clientCertificateReference := &ClientCertificateReference{
	ClientCertificateId: jsii.String("clientCertificateId"),
}

type DeploymentReference ¶

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

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{
	DeploymentId: jsii.String("deploymentId"),
	RestApiId: jsii.String("restApiId"),
}

type DocumentationPartReference ¶

type DocumentationPartReference struct {
	// The DocumentationPartId of the DocumentationPart resource.
	DocumentationPartId *string `field:"required" json:"documentationPartId" yaml:"documentationPartId"`
	// The RestApiId of the DocumentationPart resource.
	RestApiId *string `field:"required" json:"restApiId" yaml:"restApiId"`
}

A reference to a DocumentationPart 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"

documentationPartReference := &DocumentationPartReference{
	DocumentationPartId: jsii.String("documentationPartId"),
	RestApiId: jsii.String("restApiId"),
}

type DocumentationVersionReference ¶

type DocumentationVersionReference struct {
	// The DocumentationVersion of the DocumentationVersion resource.
	DocumentationVersion *string `field:"required" json:"documentationVersion" yaml:"documentationVersion"`
	// The RestApiId of the DocumentationVersion resource.
	RestApiId *string `field:"required" json:"restApiId" yaml:"restApiId"`
}

A reference to a DocumentationVersion 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"

documentationVersionReference := &DocumentationVersionReference{
	DocumentationVersion: jsii.String("documentationVersion"),
	RestApiId: jsii.String("restApiId"),
}

type DomainNameAccessAssociationReference ¶

type DomainNameAccessAssociationReference struct {
	// The DomainNameAccessAssociationArn of the DomainNameAccessAssociation resource.
	DomainNameAccessAssociationArn *string `field:"required" json:"domainNameAccessAssociationArn" yaml:"domainNameAccessAssociationArn"`
}

A reference to a DomainNameAccessAssociation 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"

domainNameAccessAssociationReference := &DomainNameAccessAssociationReference{
	DomainNameAccessAssociationArn: jsii.String("domainNameAccessAssociationArn"),
}

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 DomainNameV2Reference ¶

type DomainNameV2Reference struct {
	// The DomainNameArn of the DomainNameV2 resource.
	DomainNameArn *string `field:"required" json:"domainNameArn" yaml:"domainNameArn"`
}

A reference to a DomainNameV2 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"

domainNameV2Reference := &DomainNameV2Reference{
	DomainNameArn: jsii.String("domainNameArn"),
}

type GatewayResponseReference ¶

type GatewayResponseReference struct {
	// The Id of the GatewayResponse resource.
	GatewayResponseId *string `field:"required" json:"gatewayResponseId" yaml:"gatewayResponseId"`
}

A reference to a GatewayResponse 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"

gatewayResponseReference := &GatewayResponseReference{
	GatewayResponseId: jsii.String("gatewayResponseId"),
}

type IAccountRef ¶

type IAccountRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a Account resource.
	// Experimental.
	AccountRef() *AccountReference
}

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

type IApiKeyRef ¶

type IApiKeyRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a ApiKey resource.
	// Experimental.
	ApiKeyRef() *ApiKeyReference
}

Indicates that this resource can be referenced as a ApiKey. 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 IBasePathMappingRef ¶

type IBasePathMappingRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a BasePathMapping resource.
	// Experimental.
	BasePathMappingRef() *BasePathMappingReference
}

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

type IBasePathMappingV2Ref ¶

type IBasePathMappingV2Ref interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a BasePathMappingV2 resource.
	// Experimental.
	BasePathMappingV2Ref() *BasePathMappingV2Reference
}

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

type IClientCertificateRef ¶

type IClientCertificateRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a ClientCertificate resource.
	// Experimental.
	ClientCertificateRef() *ClientCertificateReference
}

Indicates that this resource can be referenced as a ClientCertificate. 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 IDocumentationPartRef ¶

type IDocumentationPartRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a DocumentationPart resource.
	// Experimental.
	DocumentationPartRef() *DocumentationPartReference
}

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

type IDocumentationVersionRef ¶

type IDocumentationVersionRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a DocumentationVersion resource.
	// Experimental.
	DocumentationVersionRef() *DocumentationVersionReference
}

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

type IDomainNameAccessAssociationRef ¶

type IDomainNameAccessAssociationRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a DomainNameAccessAssociation resource.
	// Experimental.
	DomainNameAccessAssociationRef() *DomainNameAccessAssociationReference
}

Indicates that this resource can be referenced as a DomainNameAccessAssociation. 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 IDomainNameV2Ref ¶

type IDomainNameV2Ref interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a DomainNameV2 resource.
	// Experimental.
	DomainNameV2Ref() *DomainNameV2Reference
}

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

type IGatewayResponseRef ¶

type IGatewayResponseRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a GatewayResponse resource.
	// Experimental.
	GatewayResponseRef() *GatewayResponseReference
}

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

type IMethodRef ¶

type IMethodRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a Method resource.
	// Experimental.
	MethodRef() *MethodReference
}

Indicates that this resource can be referenced as a Method. 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 IRequestValidatorRef ¶

type IRequestValidatorRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a RequestValidator resource.
	// Experimental.
	RequestValidatorRef() *RequestValidatorReference
}

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

type IResourceRef ¶

type IResourceRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a Resource resource.
	// Experimental.
	ResourceRef() *ResourceReference
}

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

type IRestApiRef ¶

type IRestApiRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a RestApi resource.
	// Experimental.
	RestApiRef() *RestApiReference
}

Indicates that this resource can be referenced as a RestApi. 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 IUsagePlanKeyRef ¶

type IUsagePlanKeyRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a UsagePlanKey resource.
	// Experimental.
	UsagePlanKeyRef() *UsagePlanKeyReference
}

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

type IUsagePlanRef ¶

type IUsagePlanRef interface {
	constructs.IConstruct
	interfaces.IEnvironmentAware
	// A reference to a UsagePlan resource.
	// Experimental.
	UsagePlanRef() *UsagePlanReference
}

Indicates that this resource can be referenced as a UsagePlan. 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 MethodReference ¶

type MethodReference struct {
	// The HttpMethod of the Method resource.
	HttpMethod *string `field:"required" json:"httpMethod" yaml:"httpMethod"`
	// The ResourceId of the Method resource.
	ResourceId *string `field:"required" json:"resourceId" yaml:"resourceId"`
	// The RestApiId of the Method resource.
	RestApiId *string `field:"required" json:"restApiId" yaml:"restApiId"`
}

A reference to a Method 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"

methodReference := &MethodReference{
	HttpMethod: jsii.String("httpMethod"),
	ResourceId: jsii.String("resourceId"),
	RestApiId: jsii.String("restApiId"),
}

type ModelReference ¶

type ModelReference struct {
	// The Name of the Model resource.
	ModelName *string `field:"required" json:"modelName" yaml:"modelName"`
}

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{
	ModelName: jsii.String("modelName"),
}

type RequestValidatorReference ¶

type RequestValidatorReference struct {
	// The RequestValidatorId of the RequestValidator resource.
	RequestValidatorId *string `field:"required" json:"requestValidatorId" yaml:"requestValidatorId"`
}

A reference to a RequestValidator 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"

requestValidatorReference := &RequestValidatorReference{
	RequestValidatorId: jsii.String("requestValidatorId"),
}

type ResourceReference ¶

type ResourceReference struct {
	// The ResourceId of the Resource resource.
	ResourceId *string `field:"required" json:"resourceId" yaml:"resourceId"`
	// The RestApiId of the Resource resource.
	RestApiId *string `field:"required" json:"restApiId" yaml:"restApiId"`
}

A reference to a Resource 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"

resourceReference := &ResourceReference{
	ResourceId: jsii.String("resourceId"),
	RestApiId: jsii.String("restApiId"),
}

type RestApiReference ¶

type RestApiReference struct {
	// The RestApiId of the RestApi resource.
	RestApiId *string `field:"required" json:"restApiId" yaml:"restApiId"`
}

A reference to a RestApi 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"

restApiReference := &RestApiReference{
	RestApiId: jsii.String("restApiId"),
}

type StageReference ¶

type StageReference struct {
	// The RestApiId of the Stage resource.
	RestApiId *string `field:"required" json:"restApiId" yaml:"restApiId"`
	// The StageName of the Stage resource.
	StageName *string `field:"required" json:"stageName" yaml:"stageName"`
}

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{
	RestApiId: jsii.String("restApiId"),
	StageName: jsii.String("stageName"),
}

type UsagePlanKeyReference ¶

type UsagePlanKeyReference struct {
	// The Id of the UsagePlanKey resource.
	UsagePlanKeyId *string `field:"required" json:"usagePlanKeyId" yaml:"usagePlanKeyId"`
}

A reference to a UsagePlanKey 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"

usagePlanKeyReference := &UsagePlanKeyReference{
	UsagePlanKeyId: jsii.String("usagePlanKeyId"),
}

type UsagePlanReference ¶

type UsagePlanReference struct {
	// The Id of the UsagePlan resource.
	UsagePlanId *string `field:"required" json:"usagePlanId" yaml:"usagePlanId"`
}

A reference to a UsagePlan 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"

usagePlanReference := &UsagePlanReference{
	UsagePlanId: jsii.String("usagePlanId"),
}

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"),
}