aws_db_instance

package
v0.0.0-...-4deecce Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 16, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Args

type Args struct {
	// AllocatedStorage: number, optional
	AllocatedStorage terra.NumberValue `hcl:"allocated_storage,attr"`
	// AllowMajorVersionUpgrade: bool, optional
	AllowMajorVersionUpgrade terra.BoolValue `hcl:"allow_major_version_upgrade,attr"`
	// ApplyImmediately: bool, optional
	ApplyImmediately terra.BoolValue `hcl:"apply_immediately,attr"`
	// AutoMinorVersionUpgrade: bool, optional
	AutoMinorVersionUpgrade terra.BoolValue `hcl:"auto_minor_version_upgrade,attr"`
	// AvailabilityZone: string, optional
	AvailabilityZone terra.StringValue `hcl:"availability_zone,attr"`
	// BackupRetentionPeriod: number, optional
	BackupRetentionPeriod terra.NumberValue `hcl:"backup_retention_period,attr"`
	// BackupTarget: string, optional
	BackupTarget terra.StringValue `hcl:"backup_target,attr"`
	// BackupWindow: string, optional
	BackupWindow terra.StringValue `hcl:"backup_window,attr"`
	// CaCertIdentifier: string, optional
	CaCertIdentifier terra.StringValue `hcl:"ca_cert_identifier,attr"`
	// CharacterSetName: string, optional
	CharacterSetName terra.StringValue `hcl:"character_set_name,attr"`
	// CopyTagsToSnapshot: bool, optional
	CopyTagsToSnapshot terra.BoolValue `hcl:"copy_tags_to_snapshot,attr"`
	// CustomIamInstanceProfile: string, optional
	CustomIamInstanceProfile terra.StringValue `hcl:"custom_iam_instance_profile,attr"`
	// CustomerOwnedIpEnabled: bool, optional
	CustomerOwnedIpEnabled terra.BoolValue `hcl:"customer_owned_ip_enabled,attr"`
	// DbName: string, optional
	DbName terra.StringValue `hcl:"db_name,attr"`
	// DbSubnetGroupName: string, optional
	DbSubnetGroupName terra.StringValue `hcl:"db_subnet_group_name,attr"`
	// DeleteAutomatedBackups: bool, optional
	DeleteAutomatedBackups terra.BoolValue `hcl:"delete_automated_backups,attr"`
	// DeletionProtection: bool, optional
	DeletionProtection terra.BoolValue `hcl:"deletion_protection,attr"`
	// Domain: string, optional
	Domain terra.StringValue `hcl:"domain,attr"`
	// DomainAuthSecretArn: string, optional
	DomainAuthSecretArn terra.StringValue `hcl:"domain_auth_secret_arn,attr"`
	// DomainDnsIps: set of string, optional
	DomainDnsIps terra.SetValue[terra.StringValue] `hcl:"domain_dns_ips,attr"`
	// DomainFqdn: string, optional
	DomainFqdn terra.StringValue `hcl:"domain_fqdn,attr"`
	// DomainIamRoleName: string, optional
	DomainIamRoleName terra.StringValue `hcl:"domain_iam_role_name,attr"`
	// DomainOu: string, optional
	DomainOu terra.StringValue `hcl:"domain_ou,attr"`
	// EnabledCloudwatchLogsExports: set of string, optional
	EnabledCloudwatchLogsExports terra.SetValue[terra.StringValue] `hcl:"enabled_cloudwatch_logs_exports,attr"`
	// Engine: string, optional
	Engine terra.StringValue `hcl:"engine,attr"`
	// EngineVersion: string, optional
	EngineVersion terra.StringValue `hcl:"engine_version,attr"`
	// FinalSnapshotIdentifier: string, optional
	FinalSnapshotIdentifier terra.StringValue `hcl:"final_snapshot_identifier,attr"`
	// IamDatabaseAuthenticationEnabled: bool, optional
	IamDatabaseAuthenticationEnabled terra.BoolValue `hcl:"iam_database_authentication_enabled,attr"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// Identifier: string, optional
	Identifier terra.StringValue `hcl:"identifier,attr"`
	// IdentifierPrefix: string, optional
	IdentifierPrefix terra.StringValue `hcl:"identifier_prefix,attr"`
	// InstanceClass: string, required
	InstanceClass terra.StringValue `hcl:"instance_class,attr" validate:"required"`
	// Iops: number, optional
	Iops terra.NumberValue `hcl:"iops,attr"`
	// KmsKeyId: string, optional
	KmsKeyId terra.StringValue `hcl:"kms_key_id,attr"`
	// LicenseModel: string, optional
	LicenseModel terra.StringValue `hcl:"license_model,attr"`
	// MaintenanceWindow: string, optional
	MaintenanceWindow terra.StringValue `hcl:"maintenance_window,attr"`
	// ManageMasterUserPassword: bool, optional
	ManageMasterUserPassword terra.BoolValue `hcl:"manage_master_user_password,attr"`
	// MasterUserSecretKmsKeyId: string, optional
	MasterUserSecretKmsKeyId terra.StringValue `hcl:"master_user_secret_kms_key_id,attr"`
	// MaxAllocatedStorage: number, optional
	MaxAllocatedStorage terra.NumberValue `hcl:"max_allocated_storage,attr"`
	// MonitoringInterval: number, optional
	MonitoringInterval terra.NumberValue `hcl:"monitoring_interval,attr"`
	// MonitoringRoleArn: string, optional
	MonitoringRoleArn terra.StringValue `hcl:"monitoring_role_arn,attr"`
	// MultiAz: bool, optional
	MultiAz terra.BoolValue `hcl:"multi_az,attr"`
	// NcharCharacterSetName: string, optional
	NcharCharacterSetName terra.StringValue `hcl:"nchar_character_set_name,attr"`
	// NetworkType: string, optional
	NetworkType terra.StringValue `hcl:"network_type,attr"`
	// OptionGroupName: string, optional
	OptionGroupName terra.StringValue `hcl:"option_group_name,attr"`
	// ParameterGroupName: string, optional
	ParameterGroupName terra.StringValue `hcl:"parameter_group_name,attr"`
	// Password: string, optional
	Password terra.StringValue `hcl:"password,attr"`
	// PerformanceInsightsEnabled: bool, optional
	PerformanceInsightsEnabled terra.BoolValue `hcl:"performance_insights_enabled,attr"`
	// PerformanceInsightsKmsKeyId: string, optional
	PerformanceInsightsKmsKeyId terra.StringValue `hcl:"performance_insights_kms_key_id,attr"`
	// PerformanceInsightsRetentionPeriod: number, optional
	PerformanceInsightsRetentionPeriod terra.NumberValue `hcl:"performance_insights_retention_period,attr"`
	// Port: number, optional
	Port terra.NumberValue `hcl:"port,attr"`
	// PubliclyAccessible: bool, optional
	PubliclyAccessible terra.BoolValue `hcl:"publicly_accessible,attr"`
	// ReplicaMode: string, optional
	ReplicaMode terra.StringValue `hcl:"replica_mode,attr"`
	// ReplicateSourceDb: string, optional
	ReplicateSourceDb terra.StringValue `hcl:"replicate_source_db,attr"`
	// SkipFinalSnapshot: bool, optional
	SkipFinalSnapshot terra.BoolValue `hcl:"skip_final_snapshot,attr"`
	// SnapshotIdentifier: string, optional
	SnapshotIdentifier terra.StringValue `hcl:"snapshot_identifier,attr"`
	// StorageEncrypted: bool, optional
	StorageEncrypted terra.BoolValue `hcl:"storage_encrypted,attr"`
	// StorageThroughput: number, optional
	StorageThroughput terra.NumberValue `hcl:"storage_throughput,attr"`
	// StorageType: string, optional
	StorageType terra.StringValue `hcl:"storage_type,attr"`
	// Tags: map of string, optional
	Tags terra.MapValue[terra.StringValue] `hcl:"tags,attr"`
	// TagsAll: map of string, optional
	TagsAll terra.MapValue[terra.StringValue] `hcl:"tags_all,attr"`
	// Timezone: string, optional
	Timezone terra.StringValue `hcl:"timezone,attr"`
	// Username: string, optional
	Username terra.StringValue `hcl:"username,attr"`
	// VpcSecurityGroupIds: set of string, optional
	VpcSecurityGroupIds terra.SetValue[terra.StringValue] `hcl:"vpc_security_group_ids,attr"`
	// BlueGreenUpdate: optional
	BlueGreenUpdate *BlueGreenUpdate `hcl:"blue_green_update,block"`
	// RestoreToPointInTime: optional
	RestoreToPointInTime *RestoreToPointInTime `hcl:"restore_to_point_in_time,block"`
	// S3Import: optional
	S3Import *S3Import `hcl:"s3_import,block"`
	// Timeouts: optional
	Timeouts *Timeouts `hcl:"timeouts,block"`
}

Args contains the configurations for aws_db_instance.

type BlueGreenUpdate

type BlueGreenUpdate struct {
	// Enabled: bool, optional
	Enabled terra.BoolValue `hcl:"enabled,attr"`
}

type BlueGreenUpdateAttributes

type BlueGreenUpdateAttributes struct {
	// contains filtered or unexported fields
}

func (BlueGreenUpdateAttributes) Enabled

func (BlueGreenUpdateAttributes) InternalRef

func (bgu BlueGreenUpdateAttributes) InternalRef() (terra.Reference, error)

func (BlueGreenUpdateAttributes) InternalTokens

func (bgu BlueGreenUpdateAttributes) InternalTokens() (hclwrite.Tokens, error)

func (BlueGreenUpdateAttributes) InternalWithRef

type BlueGreenUpdateState

type BlueGreenUpdateState struct {
	Enabled bool `json:"enabled"`
}

type DataArgs

type DataArgs struct {
	// DbInstanceIdentifier: string, optional
	DbInstanceIdentifier terra.StringValue `hcl:"db_instance_identifier,attr"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// Tags: map of string, optional
	Tags terra.MapValue[terra.StringValue] `hcl:"tags,attr"`
}

DataArgs contains the configurations for aws_db_instance.

type DataMasterUserSecretAttributes

type DataMasterUserSecretAttributes struct {
	// contains filtered or unexported fields
}

func (DataMasterUserSecretAttributes) InternalRef

func (mus DataMasterUserSecretAttributes) InternalRef() (terra.Reference, error)

func (DataMasterUserSecretAttributes) InternalTokens

func (mus DataMasterUserSecretAttributes) InternalTokens() (hclwrite.Tokens, error)

func (DataMasterUserSecretAttributes) InternalWithRef

func (DataMasterUserSecretAttributes) KmsKeyId

func (DataMasterUserSecretAttributes) SecretArn

func (DataMasterUserSecretAttributes) SecretStatus

type DataMasterUserSecretState

type DataMasterUserSecretState struct {
	KmsKeyId     string `json:"kms_key_id"`
	SecretArn    string `json:"secret_arn"`
	SecretStatus string `json:"secret_status"`
}

type DataSource

type DataSource struct {
	Name string
	Args DataArgs
}

DataSource represents the Terraform data resource aws_db_instance.

func Data

func Data(name string, args DataArgs) *DataSource

Data creates a new instance of DataSource.

func (*DataSource) Attributes

func (adi *DataSource) Attributes() dataAwsDbInstanceAttributes

Attributes returns the attributes for DataSource.

func (*DataSource) Configuration

func (adi *DataSource) Configuration() interface{}

Configuration returns the configuration (args) for DataSource.

func (*DataSource) DataSource

func (adi *DataSource) DataSource() string

DataSource returns the Terraform object type for DataSource.

func (*DataSource) LocalName

func (adi *DataSource) LocalName() string

LocalName returns the local name for DataSource.

type ListenerEndpointAttributes

type ListenerEndpointAttributes struct {
	// contains filtered or unexported fields
}

func (ListenerEndpointAttributes) Address

func (ListenerEndpointAttributes) HostedZoneId

func (le ListenerEndpointAttributes) HostedZoneId() terra.StringValue

func (ListenerEndpointAttributes) InternalRef

func (le ListenerEndpointAttributes) InternalRef() (terra.Reference, error)

func (ListenerEndpointAttributes) InternalTokens

func (le ListenerEndpointAttributes) InternalTokens() (hclwrite.Tokens, error)

func (ListenerEndpointAttributes) InternalWithRef

func (ListenerEndpointAttributes) Port

type ListenerEndpointState

type ListenerEndpointState struct {
	Address      string  `json:"address"`
	HostedZoneId string  `json:"hosted_zone_id"`
	Port         float64 `json:"port"`
}

type MasterUserSecretAttributes

type MasterUserSecretAttributes struct {
	// contains filtered or unexported fields
}

func (MasterUserSecretAttributes) InternalRef

func (mus MasterUserSecretAttributes) InternalRef() (terra.Reference, error)

func (MasterUserSecretAttributes) InternalTokens

func (mus MasterUserSecretAttributes) InternalTokens() (hclwrite.Tokens, error)

func (MasterUserSecretAttributes) InternalWithRef

func (MasterUserSecretAttributes) KmsKeyId

func (MasterUserSecretAttributes) SecretArn

func (MasterUserSecretAttributes) SecretStatus

func (mus MasterUserSecretAttributes) SecretStatus() terra.StringValue

type MasterUserSecretState

type MasterUserSecretState struct {
	KmsKeyId     string `json:"kms_key_id"`
	SecretArn    string `json:"secret_arn"`
	SecretStatus string `json:"secret_status"`
}

type Resource

type Resource struct {
	Name string
	Args Args

	DependsOn terra.Dependencies
	Lifecycle *terra.Lifecycle
	// contains filtered or unexported fields
}

Resource represents the Terraform resource aws_db_instance.

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (adi *Resource) Attributes() awsDbInstanceAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

func (adi *Resource) Configuration() interface{}

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

func (adi *Resource) DependOn() terra.Reference

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

func (adi *Resource) Dependencies() terra.Dependencies

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

func (adi *Resource) ImportState(state io.Reader) error

ImportState imports the given attribute values into Resource's state.

func (*Resource) LifecycleManagement

func (adi *Resource) LifecycleManagement() *terra.Lifecycle

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (adi *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (adi *Resource) State() (*awsDbInstanceState, bool)

State returns the state and a bool indicating if Resource has state.

func (*Resource) StateMust

func (adi *Resource) StateMust() *awsDbInstanceState

StateMust returns the state for Resource. Panics if the state is nil.

func (*Resource) Type

func (adi *Resource) Type() string

Type returns the Terraform object type for Resource.

type RestoreToPointInTime

type RestoreToPointInTime struct {
	// RestoreTime: string, optional
	RestoreTime terra.StringValue `hcl:"restore_time,attr"`
	// SourceDbInstanceAutomatedBackupsArn: string, optional
	SourceDbInstanceAutomatedBackupsArn terra.StringValue `hcl:"source_db_instance_automated_backups_arn,attr"`
	// SourceDbInstanceIdentifier: string, optional
	SourceDbInstanceIdentifier terra.StringValue `hcl:"source_db_instance_identifier,attr"`
	// SourceDbiResourceId: string, optional
	SourceDbiResourceId terra.StringValue `hcl:"source_dbi_resource_id,attr"`
	// UseLatestRestorableTime: bool, optional
	UseLatestRestorableTime terra.BoolValue `hcl:"use_latest_restorable_time,attr"`
}

type RestoreToPointInTimeAttributes

type RestoreToPointInTimeAttributes struct {
	// contains filtered or unexported fields
}

func (RestoreToPointInTimeAttributes) InternalRef

func (rtpit RestoreToPointInTimeAttributes) InternalRef() (terra.Reference, error)

func (RestoreToPointInTimeAttributes) InternalTokens

func (rtpit RestoreToPointInTimeAttributes) InternalTokens() (hclwrite.Tokens, error)

func (RestoreToPointInTimeAttributes) InternalWithRef

func (RestoreToPointInTimeAttributes) RestoreTime

func (rtpit RestoreToPointInTimeAttributes) RestoreTime() terra.StringValue

func (RestoreToPointInTimeAttributes) SourceDbInstanceAutomatedBackupsArn

func (rtpit RestoreToPointInTimeAttributes) SourceDbInstanceAutomatedBackupsArn() terra.StringValue

func (RestoreToPointInTimeAttributes) SourceDbInstanceIdentifier

func (rtpit RestoreToPointInTimeAttributes) SourceDbInstanceIdentifier() terra.StringValue

func (RestoreToPointInTimeAttributes) SourceDbiResourceId

func (rtpit RestoreToPointInTimeAttributes) SourceDbiResourceId() terra.StringValue

func (RestoreToPointInTimeAttributes) UseLatestRestorableTime

func (rtpit RestoreToPointInTimeAttributes) UseLatestRestorableTime() terra.BoolValue

type RestoreToPointInTimeState

type RestoreToPointInTimeState struct {
	RestoreTime                         string `json:"restore_time"`
	SourceDbInstanceAutomatedBackupsArn string `json:"source_db_instance_automated_backups_arn"`
	SourceDbInstanceIdentifier          string `json:"source_db_instance_identifier"`
	SourceDbiResourceId                 string `json:"source_dbi_resource_id"`
	UseLatestRestorableTime             bool   `json:"use_latest_restorable_time"`
}

type S3Import

type S3Import struct {
	// BucketName: string, required
	BucketName terra.StringValue `hcl:"bucket_name,attr" validate:"required"`
	// BucketPrefix: string, optional
	BucketPrefix terra.StringValue `hcl:"bucket_prefix,attr"`
	// IngestionRole: string, required
	IngestionRole terra.StringValue `hcl:"ingestion_role,attr" validate:"required"`
	// SourceEngine: string, required
	SourceEngine terra.StringValue `hcl:"source_engine,attr" validate:"required"`
	// SourceEngineVersion: string, required
	SourceEngineVersion terra.StringValue `hcl:"source_engine_version,attr" validate:"required"`
}

type S3ImportAttributes

type S3ImportAttributes struct {
	// contains filtered or unexported fields
}

func (S3ImportAttributes) BucketName

func (si S3ImportAttributes) BucketName() terra.StringValue

func (S3ImportAttributes) BucketPrefix

func (si S3ImportAttributes) BucketPrefix() terra.StringValue

func (S3ImportAttributes) IngestionRole

func (si S3ImportAttributes) IngestionRole() terra.StringValue

func (S3ImportAttributes) InternalRef

func (si S3ImportAttributes) InternalRef() (terra.Reference, error)

func (S3ImportAttributes) InternalTokens

func (si S3ImportAttributes) InternalTokens() (hclwrite.Tokens, error)

func (S3ImportAttributes) InternalWithRef

func (si S3ImportAttributes) InternalWithRef(ref terra.Reference) S3ImportAttributes

func (S3ImportAttributes) SourceEngine

func (si S3ImportAttributes) SourceEngine() terra.StringValue

func (S3ImportAttributes) SourceEngineVersion

func (si S3ImportAttributes) SourceEngineVersion() terra.StringValue

type S3ImportState

type S3ImportState struct {
	BucketName          string `json:"bucket_name"`
	BucketPrefix        string `json:"bucket_prefix"`
	IngestionRole       string `json:"ingestion_role"`
	SourceEngine        string `json:"source_engine"`
	SourceEngineVersion string `json:"source_engine_version"`
}

type Timeouts

type Timeouts struct {
	// Create: string, optional
	Create terra.StringValue `hcl:"create,attr"`
	// Delete: string, optional
	Delete terra.StringValue `hcl:"delete,attr"`
	// Update: string, optional
	Update terra.StringValue `hcl:"update,attr"`
}

type TimeoutsAttributes

type TimeoutsAttributes struct {
	// contains filtered or unexported fields
}

func (TimeoutsAttributes) Create

func (TimeoutsAttributes) Delete

func (TimeoutsAttributes) InternalRef

func (t TimeoutsAttributes) InternalRef() (terra.Reference, error)

func (TimeoutsAttributes) InternalTokens

func (t TimeoutsAttributes) InternalTokens() (hclwrite.Tokens, error)

func (TimeoutsAttributes) InternalWithRef

func (t TimeoutsAttributes) InternalWithRef(ref terra.Reference) TimeoutsAttributes

func (TimeoutsAttributes) Update

type TimeoutsState

type TimeoutsState struct {
	Create string `json:"create"`
	Delete string `json:"delete"`
	Update string `json:"update"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL