Documentation
¶
Overview ¶
sql
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewSql_Override ¶
func NewSql_Override(s Sql, scope constructs.Construct, id *string, config *SqlConfig)
func Sql_IsConstruct ¶
func Sql_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`.
Types ¶
type Sql ¶
type Sql interface {
cdktf.TerraformModule
// Experimental.
CdktfStack() cdktf.TerraformStack
CodebuildRegion() *string
SetCodebuildRegion(val *string)
CodebuildRoleArn() *string
SetCodebuildRoleArn(val *string)
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
CreateDatabaseProjectName() *string
SetCreateDatabaseProjectName(val *string)
DbName() *string
SetDbName(val *string)
// Experimental.
DependsOn() *[]*string
// Experimental.
SetDependsOn(val *[]*string)
// Experimental.
ForEach() cdktf.ITerraformIterator
// Experimental.
SetForEach(val cdktf.ITerraformIterator)
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
Migrations() interface{}
SetMigrations(val interface{})
// The tree node.
Node() constructs.Node
// Experimental.
Providers() *[]interface{}
// Experimental.
RawOverrides() interface{}
RdsClusterEndpoint() *string
SetRdsClusterEndpoint(val *string)
RdsClusterPassword() *string
SetRdsClusterPassword(val *string)
RdsClusterUsername() *string
SetRdsClusterUsername(val *string)
SecurityGroupIds() *[]*string
SetSecurityGroupIds(val *[]*string)
// Experimental.
SkipAssetCreationFromLocalModules() *bool
// Experimental.
Source() *string
SubnetIds() *[]*string
SetSubnetIds(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 Sql based on a Terraform module.
Source at ./.nitric/modules/sql
type SqlConfig ¶
type SqlConfig 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 region of the codebuild project.
CodebuildRegion *string `field:"required" json:"codebuildRegion" yaml:"codebuildRegion"`
// The arn of the codebuild role.
CodebuildRoleArn *string `field:"required" json:"codebuildRoleArn" yaml:"codebuildRoleArn"`
// The name of the create database codebuild project.
CreateDatabaseProjectName *string `field:"required" json:"createDatabaseProjectName" yaml:"createDatabaseProjectName"`
// The name of the database to create.
DbName *string `field:"required" json:"dbName" yaml:"dbName"`
// The endpoint of the RDS cluster to connect to.
RdsClusterEndpoint *string `field:"required" json:"rdsClusterEndpoint" yaml:"rdsClusterEndpoint"`
// The password to connect to the RDS cluster.
RdsClusterPassword *string `field:"required" json:"rdsClusterPassword" yaml:"rdsClusterPassword"`
// The username to connect to the RDS cluster.
RdsClusterUsername *string `field:"required" json:"rdsClusterUsername" yaml:"rdsClusterUsername"`
// The security group ids to use for the codebuild project.
SecurityGroupIds *[]*string `field:"required" json:"securityGroupIds" yaml:"securityGroupIds"`
// The subnet ids to use for the codebuild project.
SubnetIds *[]*string `field:"required" json:"subnetIds" yaml:"subnetIds"`
// The vpc id to use for the codebuild project.
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
// Details of the docker image to use for the codebuild project that performs database migrations.
Migrations interface{} `field:"optional" json:"migrations" yaml:"migrations"`
}