service

Documentation

Overview

service

Index

• func NewService_Override(s Service, scope constructs.Construct, id *string, config *ServiceConfig)
• func Service_IsConstruct(x interface{}) *bool
• func Service_IsTerraformElement(x interface{}) *bool
• type Service
  • func NewService(scope constructs.Construct, id *string, config *ServiceConfig) Service
• type ServiceConfig

Functions

func NewService_Override

func NewService_Override(s Service, scope constructs.Construct, id *string, config *ServiceConfig)

func Service_IsConstruct

func Service_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 Service_IsTerraformElement

func Service_IsTerraformElement(x interface{}) *bool

Experimental.

Types

type Service

type Service interface {
	cdktf.TerraformModule
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	Environment() *map[string]*string
	SetEnvironment(val *map[string]*string)
	EphemeralStorage() *float64
	SetEphemeralStorage(val *float64)
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Image() *string
	SetImage(val *string)
	InvokeArnOutput() *string
	LambdaArnOutput() *string
	LambdaFunctionNameOutput() *string
	Memory() *float64
	SetMemory(val *float64)
	// The tree node.
	Node() constructs.Node
	// Experimental.
	Providers() *[]interface{}
	// Experimental.
	RawOverrides() interface{}
	RoleArnOutput() *string
	RoleNameOutput() *string
	SecurityGroupIds() *[]*string
	SetSecurityGroupIds(val *[]*string)
	ServiceName() *string
	SetServiceName(val *string)
	// Experimental.
	SkipAssetCreationFromLocalModules() *bool
	// Experimental.
	Source() *string
	StackId() *string
	SetStackId(val *string)
	SubnetIds() *[]*string
	SetSubnetIds(val *[]*string)
	Timeout() *float64
	SetTimeout(val *float64)
	// 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 Service based on a Terraform module.

Source at ./.nitric/modules/service

func NewService

func NewService(scope constructs.Construct, id *string, config *ServiceConfig) Service

type ServiceConfig

type ServiceConfig 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"`
	// Environment variables to set on the lambda function The property type contains a map, they have special handling, please see {@link cdk.tf /module-map-inputs the docs}.
	Environment *map[string]*string `field:"required" json:"environment" yaml:"environment"`
	// The docker image to deploy.
	Image *string `field:"required" json:"image" yaml:"image"`
	// The name of the service.
	ServiceName *string `field:"required" json:"serviceName" yaml:"serviceName"`
	// The ID of the Nitric stack.
	StackId *string `field:"required" json:"stackId" yaml:"stackId"`
	// The amount of ephemeral storage to allocate to the lambda function in MB 512.
	EphemeralStorage *float64 `field:"optional" json:"ephemeralStorage" yaml:"ephemeralStorage"`
	// The amount of memory to allocate to the lambda function in MB 128.
	Memory *float64 `field:"optional" json:"memory" yaml:"memory"`
	// The security group ids to use for the aws lambda function.
	SecurityGroupIds *[]*string `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"`
	// The subnet ids to use for the aws lambda function.
	SubnetIds *[]*string `field:"optional" json:"subnetIds" yaml:"subnetIds"`
	// The timeout for the lambda function in seconds 15.
	Timeout *float64 `field:"optional" json:"timeout" yaml:"timeout"`
}