rds

Documentation

Overview

rds

Index

• func NewRds_Override(r Rds, scope constructs.Construct, id *string, config *RdsConfig)
• func Rds_IsConstruct(x interface{}) *bool
• func Rds_IsTerraformElement(x interface{}) *bool
• type Rds
  • func NewRds(scope constructs.Construct, id *string, config *RdsConfig) Rds
• type RdsConfig

Functions

func NewRds_Override

func NewRds_Override(r Rds, scope constructs.Construct, id *string, config *RdsConfig)

func Rds_IsConstruct

func Rds_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 Rds_IsTerraformElement

func Rds_IsTerraformElement(x interface{}) *bool

Experimental.

Types

type Rds

type Rds interface {
	cdktf.TerraformModule
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	ClusterEndpointOutput() *string
	ClusterPasswordOutput() *string
	ClusterUsernameOutput() *string
	CodebuildRoleArnOutput() *string
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	CreateDatabaseProjectNameOutput() *string
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	MaxCapacity() *float64
	SetMaxCapacity(val *float64)
	MinCapacity() *float64
	SetMinCapacity(val *float64)
	// The tree node.
	Node() constructs.Node
	PrivateSubnetIds() *[]*string
	SetPrivateSubnetIds(val *[]*string)
	// Experimental.
	Providers() *[]interface{}
	// Experimental.
	RawOverrides() interface{}
	SecurityGroupIdOutput() *string
	// Experimental.
	SkipAssetCreationFromLocalModules() *bool
	// Experimental.
	Source() *string
	StackId() *string
	SetStackId(val *string)
	// Experimental.
	Version() *string
	VpcId() *string
	SetVpcId(val *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 Rds based on a Terraform module.

Source at ./.nitric/modules/rds

func NewRds

func NewRds(scope constructs.Construct, id *string, config *RdsConfig) Rds

type RdsConfig

type RdsConfig 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 maximum capacity of the RDS cluster.
	MaxCapacity *float64 `field:"required" json:"maxCapacity" yaml:"maxCapacity"`
	// the minimum capacity of the RDS cluster.
	MinCapacity *float64 `field:"required" json:"minCapacity" yaml:"minCapacity"`
	// private subnets to assign to the RDS cluster.
	PrivateSubnetIds *[]*string `field:"required" json:"privateSubnetIds" yaml:"privateSubnetIds"`
	// The nitric stack ID.
	StackId *string `field:"required" json:"stackId" yaml:"stackId"`
	// the VPC to assign to the RDS cluster.
	VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
}