Documentation
¶
Overview ¶
api
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Api_IsConstruct ¶
func Api_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewApi_Override ¶
func NewApi_Override(a Api, scope constructs.Construct, id *string, config *ApiConfig)
Types ¶
type Api ¶
type Api interface {
cdktf.TerraformModule
// Experimental.
CdktfStack() cdktf.TerraformStack
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
DefaultHostOutput() *string
// Experimental.
DependsOn() *[]*string
// Experimental.
SetDependsOn(val *[]*string)
EndpointOutput() *string
// Experimental.
ForEach() cdktf.ITerraformIterator
// Experimental.
SetForEach(val cdktf.ITerraformIterator)
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
GatewayIdOutput() *string
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
OpenapiSpec() *string
SetOpenapiSpec(val *string)
// Experimental.
Providers() *[]interface{}
// Experimental.
RawOverrides() interface{}
Region() *string
SetRegion(val *string)
RegionOutput() *string
// Experimental.
SkipAssetCreationFromLocalModules() *bool
// Experimental.
Source() *string
StackId() *string
SetStackId(val *string)
TargetServices() *map[string]*string
SetTargetServices(val *map[string]*string)
// Experimental.
Version() *string
// Experimental.
AddOverride(path *string, value interface{})
// Experimental.
AddProvider(provider interface{})
// Experimental.
GetString(output *string) *string
// Experimental.
InterpolationForOutput(moduleOutput *string) cdktf.IResolvable
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
SynthesizeAttributes() *map[string]interface{}
SynthesizeHclAttributes() *map[string]interface{}
// Experimental.
ToHclTerraform() interface{}
// Experimental.
ToMetadata() interface{}
// Returns a string representation of this construct.
ToString() *string
// Experimental.
ToTerraform() interface{}
}
Defines an Api based on a Terraform module.
Source at ./.nitric/modules/api
type ApiConfig ¶
type ApiConfig struct {
// Experimental.
DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
// Experimental.
ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
// Experimental.
Providers *[]interface{} `field:"optional" json:"providers" yaml:"providers"`
// Experimental.
SkipAssetCreationFromLocalModules *bool `field:"optional" json:"skipAssetCreationFromLocalModules" yaml:"skipAssetCreationFromLocalModules"`
// The name of the API Gateway.
Name *string `field:"required" json:"name" yaml:"name"`
// The OpenAPI spec as a JSON string.
OpenapiSpec *string `field:"required" json:"openapiSpec" yaml:"openapiSpec"`
// The region where the API Gateway will be created.
Region *string `field:"required" json:"region" yaml:"region"`
// The ID of the stack.
StackId *string `field:"required" json:"stackId" yaml:"stackId"`
// The map of target service names The property type contains a map, they have special handling, please see {@link cdk.tf /module-map-inputs the docs}.
TargetServices *map[string]*string `field:"required" json:"targetServices" yaml:"targetServices"`
}
Source Files
Directories