api

package
v0.0.0-...-8922439 Latest Latest
Warning

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

Go to latest
Published: Feb 4, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

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 Api_IsTerraformElement

func Api_IsTerraformElement(x interface{}) *bool

Experimental.

func NewApi_Override

func NewApi_Override(a Api, scope constructs.Construct, id *string, config *ApiConfig)

Types

type Api

type Api interface {
	cdktf.TerraformModule
	ApiGatewayUrlOutput() *string
	AppIdentity() *string
	SetAppIdentity(val *string)
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	Description() *string
	SetDescription(val *string)
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Location() *string
	SetLocation(val *string)
	Name() *string
	SetName(val *string)
	// The tree node.
	Node() constructs.Node
	OpenapiSpec() *string
	SetOpenapiSpec(val *string)
	OperationPolicyTemplates() *map[string]*string
	SetOperationPolicyTemplates(val *map[string]*string)
	// Experimental.
	Providers() *[]interface{}
	PublisherEmail() *string
	SetPublisherEmail(val *string)
	PublisherName() *string
	SetPublisherName(val *string)
	// Experimental.
	RawOverrides() interface{}
	ResourceGroupName() *string
	SetResourceGroupName(val *string)
	// Experimental.
	SkipAssetCreationFromLocalModules() *bool
	// Experimental.
	Source() *string
	Tags() *map[string]*string
	SetTags(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

func NewApi

func NewApi(scope constructs.Construct, id *string, config *ApiConfig) 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 identity of the app.
	AppIdentity *string `field:"required" json:"appIdentity" yaml:"appIdentity"`
	// The description of the API.
	Description *string `field:"required" json:"description" yaml:"description"`
	// The location of the API.
	Location *string `field:"required" json:"location" yaml:"location"`
	// The name of the API.
	Name *string `field:"required" json:"name" yaml:"name"`
	// The openapi spec to deploy.
	OpenapiSpec *string `field:"required" json:"openapiSpec" yaml:"openapiSpec"`
	// The policy templates to apply The property type contains a map, they have special handling, please see {@link cdk.tf /module-map-inputs the docs}.
	OperationPolicyTemplates *map[string]*string `field:"required" json:"operationPolicyTemplates" yaml:"operationPolicyTemplates"`
	// The email of the publisher.
	PublisherEmail *string `field:"required" json:"publisherEmail" yaml:"publisherEmail"`
	// The name of the publisher.
	PublisherName *string `field:"required" json:"publisherName" yaml:"publisherName"`
	// The name of the resource group.
	ResourceGroupName *string `field:"required" json:"resourceGroupName" yaml:"resourceGroupName"`
	// The tags to apply to the API The property type contains a map, they have special handling, please see {@link cdk.tf /module-map-inputs the docs}.
	Tags *map[string]*string `field:"required" json:"tags" yaml:"tags"`
}

Directories

Path Synopsis
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.

Jump to

Keyboard shortcuts

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