-
Notifications
You must be signed in to change notification settings - Fork 17
/
ApiMappingProps.go
41 lines (38 loc) · 1.22 KB
/
ApiMappingProps.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
package awsapigatewayv2
// Properties used to create the 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"
//
// var api iApi
// var domainName domainName
// var stage iStage
//
// apiMappingProps := &ApiMappingProps{
// Api: api,
// DomainName: domainName,
//
// // the properties below are optional
// ApiMappingKey: jsii.String("apiMappingKey"),
// Stage: stage,
// }
//
// Experimental.
type ApiMappingProps struct {
// The Api to which this mapping is applied.
// Experimental.
Api IApi `field:"required" json:"api" yaml:"api"`
// custom domain name of the mapping target.
// Experimental.
DomainName IDomainName `field:"required" json:"domainName" yaml:"domainName"`
// Api mapping key.
//
// The path where this stage should be mapped to on the domain.
// Experimental.
ApiMappingKey *string `field:"optional" json:"apiMappingKey" yaml:"apiMappingKey"`
// stage for the ApiMapping resource required for WebSocket API defaults to default stage of an HTTP API.
// Experimental.
Stage IStage `field:"optional" json:"stage" yaml:"stage"`
}