Documentation
¶
Index ¶
- func Database_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func Database_IsConstruct(x interface{}) *bool
- func Database_IsTerraformElement(x interface{}) *bool
- func Database_IsTerraformResource(x interface{}) *bool
- func Database_TfResourceType() *string
- func NewDatabase_Override(d Database, scope constructs.Construct, id *string, config *DatabaseConfig)
- type Database
- type DatabaseConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Database_GenerateConfigForImport ¶
func Database_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a Database resource upon running "cdktf plan <stack-name>".
func Database_IsConstruct ¶
func Database_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 Database_IsTerraformElement ¶
func Database_IsTerraformElement(x interface{}) *bool
Experimental.
func Database_IsTerraformResource ¶
func Database_IsTerraformResource(x interface{}) *bool
Experimental.
func Database_TfResourceType ¶
func Database_TfResourceType() *string
func NewDatabase_Override ¶
func NewDatabase_Override(d Database, scope constructs.Construct, id *string, config *DatabaseConfig)
Create a new {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database postgresql_database} Resource.
Types ¶
type Database ¶
type Database interface {
cdktf.TerraformResource
AllowConnections() interface{}
SetAllowConnections(val interface{})
AllowConnectionsInput() interface{}
AlterObjectOwnership() interface{}
SetAlterObjectOwnership(val interface{})
AlterObjectOwnershipInput() interface{}
// Experimental.
CdktfStack() cdktf.TerraformStack
// Experimental.
Connection() interface{}
// Experimental.
SetConnection(val interface{})
ConnectionLimit() *float64
SetConnectionLimit(val *float64)
ConnectionLimitInput() *float64
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
// Experimental.
Count() interface{}
// Experimental.
SetCount(val interface{})
// Experimental.
DependsOn() *[]*string
// Experimental.
SetDependsOn(val *[]*string)
Encoding() *string
SetEncoding(val *string)
EncodingInput() *string
// Experimental.
ForEach() cdktf.ITerraformIterator
// Experimental.
SetForEach(val cdktf.ITerraformIterator)
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
Id() *string
SetId(val *string)
IdInput() *string
IsTemplate() interface{}
SetIsTemplate(val interface{})
IsTemplateInput() interface{}
LcCollate() *string
SetLcCollate(val *string)
LcCollateInput() *string
LcCtype() *string
SetLcCtype(val *string)
LcCtypeInput() *string
// Experimental.
Lifecycle() *cdktf.TerraformResourceLifecycle
// Experimental.
SetLifecycle(val *cdktf.TerraformResourceLifecycle)
Name() *string
SetName(val *string)
NameInput() *string
// The tree node.
Node() constructs.Node
Owner() *string
SetOwner(val *string)
OwnerInput() *string
// Experimental.
Provider() cdktf.TerraformProvider
// Experimental.
SetProvider(val cdktf.TerraformProvider)
// Experimental.
Provisioners() *[]interface{}
// Experimental.
SetProvisioners(val *[]interface{})
// Experimental.
RawOverrides() interface{}
TablespaceName() *string
SetTablespaceName(val *string)
TablespaceNameInput() *string
Template() *string
SetTemplate(val *string)
TemplateInput() *string
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformMetaArguments() *map[string]interface{}
// Experimental.
TerraformResourceType() *string
// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
// Experimental.
AddMoveTarget(moveTarget *string)
// Experimental.
AddOverride(path *string, value interface{})
// Experimental.
GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
// Experimental.
GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
// Experimental.
GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
// Experimental.
GetListAttribute(terraformAttribute *string) *[]*string
// Experimental.
GetNumberAttribute(terraformAttribute *string) *float64
// Experimental.
GetNumberListAttribute(terraformAttribute *string) *[]*float64
// Experimental.
GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
// Experimental.
GetStringAttribute(terraformAttribute *string) *string
// Experimental.
GetStringMapAttribute(terraformAttribute *string) *map[string]*string
// Experimental.
HasResourceMove() interface{}
// Experimental.
ImportFrom(id *string, provider cdktf.TerraformProvider)
// Experimental.
InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
// Move the resource corresponding to "id" to this resource.
//
// Note that the resource being moved from must be marked as moved using it's instance function.
// Experimental.
MoveFromId(id *string)
// Moves this resource to the target resource given by moveTarget.
// Experimental.
MoveTo(moveTarget *string, index interface{})
// Moves this resource to the resource corresponding to "id".
// Experimental.
MoveToId(id *string)
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
ResetAllowConnections()
ResetAlterObjectOwnership()
ResetConnectionLimit()
ResetEncoding()
ResetId()
ResetIsTemplate()
ResetLcCollate()
ResetLcCtype()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetOwner()
ResetTablespaceName()
ResetTemplate()
SynthesizeAttributes() *map[string]interface{}
SynthesizeHclAttributes() *map[string]interface{}
// Experimental.
ToHclTerraform() interface{}
// Experimental.
ToMetadata() interface{}
// Returns a string representation of this construct.
ToString() *string
// Adds this resource to the terraform JSON output.
// Experimental.
ToTerraform() interface{}
}
Represents a {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database postgresql_database}.
func NewDatabase ¶
func NewDatabase(scope constructs.Construct, id *string, config *DatabaseConfig) Database
Create a new {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database postgresql_database} Resource.
type DatabaseConfig ¶
type DatabaseConfig struct {
// Experimental.
Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
// Experimental.
Count interface{} `field:"optional" json:"count" yaml:"count"`
// Experimental.
DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
// Experimental.
ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
// Experimental.
Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
// Experimental.
Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
// Experimental.
Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
// The PostgreSQL database name to connect to.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#name Database#name}
Name *string `field:"required" json:"name" yaml:"name"`
// If false then no one can connect to this database.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#allow_connections Database#allow_connections}
AllowConnections interface{} `field:"optional" json:"allowConnections" yaml:"allowConnections"`
// If true, the owner of already existing objects will change if the owner changes.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#alter_object_ownership Database#alter_object_ownership}
AlterObjectOwnership interface{} `field:"optional" json:"alterObjectOwnership" yaml:"alterObjectOwnership"`
// How many concurrent connections can be made to this database.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#connection_limit Database#connection_limit}
ConnectionLimit *float64 `field:"optional" json:"connectionLimit" yaml:"connectionLimit"`
// Character set encoding to use in the new database.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#encoding Database#encoding}
Encoding *string `field:"optional" json:"encoding" yaml:"encoding"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#id Database#id}.
//
// Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
// If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
Id *string `field:"optional" json:"id" yaml:"id"`
// If true, then this database can be cloned by any user with CREATEDB privileges.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#is_template Database#is_template}
IsTemplate interface{} `field:"optional" json:"isTemplate" yaml:"isTemplate"`
// Collation order (LC_COLLATE) to use in the new database.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#lc_collate Database#lc_collate}
LcCollate *string `field:"optional" json:"lcCollate" yaml:"lcCollate"`
// Character classification (LC_CTYPE) to use in the new database.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#lc_ctype Database#lc_ctype}
LcCtype *string `field:"optional" json:"lcCtype" yaml:"lcCtype"`
// The ROLE which owns the database.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#owner Database#owner}
Owner *string `field:"optional" json:"owner" yaml:"owner"`
// The name of the tablespace that will be associated with the new database.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#tablespace_name Database#tablespace_name}
TablespaceName *string `field:"optional" json:"tablespaceName" yaml:"tablespaceName"`
// The name of the template from which to create the new database.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#template Database#template}
Template *string `field:"optional" json:"template" yaml:"template"`
}