AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

RelationalDatabase

import "github.com/aws/aws-sdk-go/service/lightsail"

type RelationalDatabase struct { Arn *string `locationName:"arn" type:"string"` BackupRetentionEnabled *bool `locationName:"backupRetentionEnabled" type:"boolean"` CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` Engine *string `locationName:"engine" type:"string"` EngineVersion *string `locationName:"engineVersion" type:"string"` Hardware *RelationalDatabaseHardware `locationName:"hardware" type:"structure"` LatestRestorableTime *time.Time `locationName:"latestRestorableTime" type:"timestamp"` Location *ResourceLocation `locationName:"location" type:"structure"` MasterDatabaseName *string `locationName:"masterDatabaseName" type:"string"` MasterEndpoint *RelationalDatabaseEndpoint `locationName:"masterEndpoint" type:"structure"` MasterUsername *string `locationName:"masterUsername" type:"string"` Name *string `locationName:"name" type:"string"` ParameterApplyStatus *string `locationName:"parameterApplyStatus" type:"string"` PendingMaintenanceActions []*PendingMaintenanceAction `locationName:"pendingMaintenanceActions" type:"list"` PendingModifiedValues *PendingModifiedRelationalDatabaseValues `locationName:"pendingModifiedValues" type:"structure"` PreferredBackupWindow *string `locationName:"preferredBackupWindow" type:"string"` PreferredMaintenanceWindow *string `locationName:"preferredMaintenanceWindow" type:"string"` PubliclyAccessible *bool `locationName:"publiclyAccessible" type:"boolean"` RelationalDatabaseBlueprintId *string `locationName:"relationalDatabaseBlueprintId" type:"string"` RelationalDatabaseBundleId *string `locationName:"relationalDatabaseBundleId" type:"string"` ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"` SecondaryAvailabilityZone *string `locationName:"secondaryAvailabilityZone" type:"string"` State *string `locationName:"state" type:"string"` SupportCode *string `locationName:"supportCode" type:"string"` Tags []*Tag `locationName:"tags" type:"list"` }

Describes a database.

Arn

Type: *string

The Amazon Resource Name (ARN) of the database.

BackupRetentionEnabled

Type: *bool

A Boolean value indicating whether automated backup retention is enabled for the database.

CreatedAt

Type: *time.Time

The timestamp when the database was created. Formatted in Unix time.

Engine

Type: *string

The database software (for example, MySQL).

EngineVersion

Type: *string

The database engine version (for example, 5.7.23).

Hardware

Describes the hardware of a database.

LatestRestorableTime

Type: *time.Time

The latest point in time to which the database can be restored. Formatted in Unix time.

Location

Describes the resource location.

MasterDatabaseName

Type: *string

The name of the master database created when the Lightsail database resource is created.

MasterEndpoint

Describes an endpoint for a database.

MasterUsername

Type: *string

The master user name of the database.

Name

Type: *string

The unique name of the database resource in Lightsail.

ParameterApplyStatus

Type: *string

The status of parameter updates for the database.

PendingMaintenanceActions

Describes a pending database maintenance action.

PendingModifiedValues

Describes a pending database value modification.

PreferredBackupWindow

Type: *string

The daily time range during which automated backups are created for the database (for example, 16:00-16:30).

PreferredMaintenanceWindow

Type: *string

The weekly time range during which system maintenance can occur on the database.

In the format ddd:hh24:mi-ddd:hh24:mi. For example, Tue:17:00-Tue:17:30.

PubliclyAccessible

Type: *bool

A Boolean value indicating whether the database is publicly accessible.

RelationalDatabaseBlueprintId

Type: *string

The blueprint ID for the database. A blueprint describes the major engine version of a database.

RelationalDatabaseBundleId

Type: *string

The bundle ID for the database. A bundle describes the performance specifications for your database.

ResourceType

Type: *string

The Lightsail resource type for the database (for example, RelationalDatabase).

SecondaryAvailabilityZone

Type: *string

Describes the secondary Availability Zone of a high availability database.

The secondary database is used for failover support of a high availability database.

State

Type: *string

Describes the current state of the database.

SupportCode

Type: *string

The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.

Tags

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags).

Method

GoString

func (s RelationalDatabase) GoString() string

GoString returns the string representation

SetArn

func (s *RelationalDatabase) SetArn(v string) *RelationalDatabase

SetArn sets the Arn field's value.

SetBackupRetentionEnabled

func (s *RelationalDatabase) SetBackupRetentionEnabled(v bool) *RelationalDatabase

SetBackupRetentionEnabled sets the BackupRetentionEnabled field's value.

SetCreatedAt

func (s *RelationalDatabase) SetCreatedAt(v time.Time) *RelationalDatabase

SetCreatedAt sets the CreatedAt field's value.

SetEngine

func (s *RelationalDatabase) SetEngine(v string) *RelationalDatabase

SetEngine sets the Engine field's value.

SetEngineVersion

func (s *RelationalDatabase) SetEngineVersion(v string) *RelationalDatabase

SetEngineVersion sets the EngineVersion field's value.

SetHardware

func (s *RelationalDatabase) SetHardware(v *RelationalDatabaseHardware) *RelationalDatabase

SetHardware sets the Hardware field's value.

SetLatestRestorableTime

func (s *RelationalDatabase) SetLatestRestorableTime(v time.Time) *RelationalDatabase

SetLatestRestorableTime sets the LatestRestorableTime field's value.

SetLocation

func (s *RelationalDatabase) SetLocation(v *ResourceLocation) *RelationalDatabase

SetLocation sets the Location field's value.

SetMasterDatabaseName

func (s *RelationalDatabase) SetMasterDatabaseName(v string) *RelationalDatabase

SetMasterDatabaseName sets the MasterDatabaseName field's value.

SetMasterEndpoint

func (s *RelationalDatabase) SetMasterEndpoint(v *RelationalDatabaseEndpoint) *RelationalDatabase

SetMasterEndpoint sets the MasterEndpoint field's value.

SetMasterUsername

func (s *RelationalDatabase) SetMasterUsername(v string) *RelationalDatabase

SetMasterUsername sets the MasterUsername field's value.

SetName

func (s *RelationalDatabase) SetName(v string) *RelationalDatabase

SetName sets the Name field's value.

SetParameterApplyStatus

func (s *RelationalDatabase) SetParameterApplyStatus(v string) *RelationalDatabase

SetParameterApplyStatus sets the ParameterApplyStatus field's value.

SetPendingMaintenanceActions

func (s *RelationalDatabase) SetPendingMaintenanceActions(v []*PendingMaintenanceAction) *RelationalDatabase

SetPendingMaintenanceActions sets the PendingMaintenanceActions field's value.

SetPendingModifiedValues

func (s *RelationalDatabase) SetPendingModifiedValues(v *PendingModifiedRelationalDatabaseValues) *RelationalDatabase

SetPendingModifiedValues sets the PendingModifiedValues field's value.

SetPreferredBackupWindow

func (s *RelationalDatabase) SetPreferredBackupWindow(v string) *RelationalDatabase

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

SetPreferredMaintenanceWindow

func (s *RelationalDatabase) SetPreferredMaintenanceWindow(v string) *RelationalDatabase

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

SetPubliclyAccessible

func (s *RelationalDatabase) SetPubliclyAccessible(v bool) *RelationalDatabase

SetPubliclyAccessible sets the PubliclyAccessible field's value.

SetRelationalDatabaseBlueprintId

func (s *RelationalDatabase) SetRelationalDatabaseBlueprintId(v string) *RelationalDatabase

SetRelationalDatabaseBlueprintId sets the RelationalDatabaseBlueprintId field's value.

SetRelationalDatabaseBundleId

func (s *RelationalDatabase) SetRelationalDatabaseBundleId(v string) *RelationalDatabase

SetRelationalDatabaseBundleId sets the RelationalDatabaseBundleId field's value.

SetResourceType

func (s *RelationalDatabase) SetResourceType(v string) *RelationalDatabase

SetResourceType sets the ResourceType field's value.

SetSecondaryAvailabilityZone

func (s *RelationalDatabase) SetSecondaryAvailabilityZone(v string) *RelationalDatabase

SetSecondaryAvailabilityZone sets the SecondaryAvailabilityZone field's value.

SetState

func (s *RelationalDatabase) SetState(v string) *RelationalDatabase

SetState sets the State field's value.

SetSupportCode

func (s *RelationalDatabase) SetSupportCode(v string) *RelationalDatabase

SetSupportCode sets the SupportCode field's value.

SetTags

func (s *RelationalDatabase) SetTags(v []*Tag) *RelationalDatabase

SetTags sets the Tags field's value.

String

func (s RelationalDatabase) String() string

String returns the string representation

On this page: