package dbinstance

import "github.com/oslokommune/okctl/pkg/cfn/components/dbinstance"

Package dbinstance knows how to build a cloud formation resource for an RDS DBInstance

Index ¶

• type DBInstance
• func New( resourceName, dbIdentifier, dbName, dbSubnetGroupName string, dbParameterGroup cfn.NameReferencer, monitoringRole cfn.Namer, admin cfn.NameReferencer, securityGroup cfn.Namer, ) *DBInstance
• func (i *DBInstance) Name() string
• func (i *DBInstance) NamedOutputs() map[string]cloudformation.Output
• func (i *DBInstance) Ref() string
• func (i *DBInstance) Resource() cloudformation.Resource

Types ¶

type DBInstance ¶

type DBInstance struct {
	StoredName        string
	DBIdentifier      string
	DBName            string
	DBSubnetGroupName string
	DBParameterGroup  cfn.NameReferencer
	MonitoringRole    cfn.Namer
	Admin             cfn.NameReferencer
	SecurityGroup     cfn.Namer
}

DBInstance stores the state for a cloud formation dbinstance

func New ¶

func New(
	resourceName, dbIdentifier, dbName, dbSubnetGroupName string,
	dbParameterGroup cfn.NameReferencer,
	monitoringRole cfn.Namer,
	admin cfn.NameReferencer,
	securityGroup cfn.Namer,
) *DBInstance

New creates a database instance - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html

Things we should consider doing: - Configuring TLS for encrypted connection to the database - Enabling IAM database authentication

func (*DBInstance) Name ¶

func (i *DBInstance) Name() string

Name returns the name of the resource

func (*DBInstance) NamedOutputs ¶

func (i *DBInstance) NamedOutputs() map[string]cloudformation.Output

NamedOutputs returns the outputs commonly used by other stacks or components

func (*DBInstance) Ref ¶

func (i *DBInstance) Ref() string

Ref returns a cloud formation intrinsic ref to the resource

func (*DBInstance) Resource ¶

func (i *DBInstance) Resource() cloudformation.Resource

Resource returns the cloud formation resource for a dbinstance

Supported postgres versions: - https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.version13 Supported db instance types: - https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#Concepts.DBInstanceClass.Support

Source Files ¶

dbinstance.go