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.

DBInstance

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

type DBInstance struct { AllocatedStorage *int64 `type:"integer"` AssociatedRoles []*DBInstanceRole `locationNameList:"DBInstanceRole" type:"list"` AutoMinorVersionUpgrade *bool `type:"boolean"` AvailabilityZone *string `type:"string"` BackupRetentionPeriod *int64 `type:"integer"` CACertificateIdentifier *string `type:"string"` CharacterSetName *string `type:"string"` CopyTagsToSnapshot *bool `type:"boolean"` DBClusterIdentifier *string `type:"string"` DBInstanceArn *string `type:"string"` DBInstanceClass *string `type:"string"` DBInstanceIdentifier *string `type:"string"` DBInstanceStatus *string `type:"string"` DBName *string `type:"string"` DBParameterGroups []*DBParameterGroupStatus `locationNameList:"DBParameterGroup" type:"list"` DBSecurityGroups []*DBSecurityGroupMembership `locationNameList:"DBSecurityGroup" type:"list"` DBSubnetGroup *DBSubnetGroup `type:"structure"` DbInstancePort *int64 `type:"integer"` DbiResourceId *string `type:"string"` DeletionProtection *bool `type:"boolean"` DomainMemberships []*DomainMembership `locationNameList:"DomainMembership" type:"list"` EnabledCloudwatchLogsExports []*string `type:"list"` Endpoint *Endpoint `type:"structure"` Engine *string `type:"string"` EngineVersion *string `type:"string"` EnhancedMonitoringResourceArn *string `type:"string"` IAMDatabaseAuthenticationEnabled *bool `type:"boolean"` InstanceCreateTime *time.Time `type:"timestamp"` Iops *int64 `type:"integer"` KmsKeyId *string `type:"string"` LatestRestorableTime *time.Time `type:"timestamp"` LicenseModel *string `type:"string"` ListenerEndpoint *Endpoint `type:"structure"` MasterUsername *string `type:"string"` MonitoringInterval *int64 `type:"integer"` MonitoringRoleArn *string `type:"string"` MultiAZ *bool `type:"boolean"` OptionGroupMemberships []*OptionGroupMembership `locationNameList:"OptionGroupMembership" type:"list"` PendingModifiedValues *PendingModifiedValues `type:"structure"` PerformanceInsightsEnabled *bool `type:"boolean"` PerformanceInsightsKMSKeyId *string `type:"string"` PerformanceInsightsRetentionPeriod *int64 `type:"integer"` PreferredBackupWindow *string `type:"string"` PreferredMaintenanceWindow *string `type:"string"` ProcessorFeatures []*ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"` PromotionTier *int64 `type:"integer"` PubliclyAccessible *bool `type:"boolean"` ReadReplicaDBClusterIdentifiers []*string `locationNameList:"ReadReplicaDBClusterIdentifier" type:"list"` ReadReplicaDBInstanceIdentifiers []*string `locationNameList:"ReadReplicaDBInstanceIdentifier" type:"list"` ReadReplicaSourceDBInstanceIdentifier *string `type:"string"` SecondaryAvailabilityZone *string `type:"string"` StatusInfos []*DBInstanceStatusInfo `locationNameList:"DBInstanceStatusInfo" type:"list"` StorageEncrypted *bool `type:"boolean"` StorageType *string `type:"string"` TdeCredentialArn *string `type:"string"` Timezone *string `type:"string"` VpcSecurityGroups []*VpcSecurityGroupMembership `locationNameList:"VpcSecurityGroupMembership" type:"list"` }

Contains the details of an Amazon RDS DB instance.

This data type is used as a response element in the DescribeDBInstances action.

AllocatedStorage

Type: *int64

Specifies the allocated storage size specified in gibibytes.

AssociatedRoles

Describes an AWS Identity and Access Management (IAM) role that is associated with a DB instance.

AutoMinorVersionUpgrade

Type: *bool

Indicates that minor version patches are applied automatically.

AvailabilityZone

Type: *string

Specifies the name of the Availability Zone the DB instance is located in.

BackupRetentionPeriod

Type: *int64

Specifies the number of days for which automatic DB snapshots are retained.

CACertificateIdentifier

Type: *string

The identifier of the CA certificate for this DB instance.

CharacterSetName

Type: *string

If present, specifies the name of the character set that this instance is associated with.

CopyTagsToSnapshot

Type: *bool

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

DBClusterIdentifier

Type: *string

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

DBInstanceArn

Type: *string

The Amazon Resource Name (ARN) for the DB instance.

DBInstanceClass

Type: *string

Contains the name of the compute and memory capacity class of the DB instance.

DBInstanceIdentifier

Type: *string

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

DBInstanceStatus

Type: *string

Specifies the current state of this database.

DBName

Type: *string

The meaning of this parameter differs according to the database engine you use. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

DBParameterGroups

The status of the DB parameter group.

This data type is used as a response element in the following actions:

  • CreateDBInstance

  • CreateDBInstanceReadReplica

  • DeleteDBInstance

  • ModifyDBInstance

  • RebootDBInstance

  • RestoreDBInstanceFromDBSnapshot

DBSecurityGroups

This data type is used as a response element in the following actions:

  • ModifyDBInstance

  • RebootDBInstance

  • RestoreDBInstanceFromDBSnapshot

  • RestoreDBInstanceToPointInTime

DBSubnetGroup

Contains the details of an Amazon RDS DB subnet group.

This data type is used as a response element in the DescribeDBSubnetGroups action.

DbInstancePort

Type: *int64

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

DbiResourceId

Type: *string

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

DeletionProtection

Type: *bool

Indicates if the DB instance has deletion protection enabled. The database can't be deleted when this value is set to true. For more information, see Deleting a DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).

DomainMemberships

An Active Directory Domain membership record associated with the DB instance.

EnabledCloudwatchLogsExports

Type: []*string

A list of log types that this DB instance is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html) in the Amazon RDS User Guide.

Endpoint

This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:

  • CreateDBInstance

  • DescribeDBInstances

  • DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

Engine

Type: *string

Provides the name of the database engine to be used for this DB instance.

EngineVersion

Type: *string

Indicates the database engine version.

EnhancedMonitoringResourceArn

Type: *string

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

IAMDatabaseAuthenticationEnabled

Type: *bool

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

IAM database authentication can be enabled for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

InstanceCreateTime

Type: *time.Time

Provides the date and time the DB instance was created.

Iops

Type: *int64

Specifies the Provisioned IOPS (I/O operations per second) value.

KmsKeyId

Type: *string

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.

LatestRestorableTime

Type: *time.Time

Specifies the latest time to which a database can be restored with point-in-time restore.

LicenseModel

Type: *string

License model information for this DB instance.

ListenerEndpoint

This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:

  • CreateDBInstance

  • DescribeDBInstances

  • DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

MasterUsername

Type: *string

Contains the master username for the DB instance.

MonitoringInterval

Type: *int64

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

MonitoringRoleArn

Type: *string

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

MultiAZ

Type: *bool

Specifies if the DB instance is a Multi-AZ deployment.

OptionGroupMemberships

Provides information on the option groups the DB instance is a member of.

PendingModifiedValues

This data type is used as a response element in the ModifyDBInstance action.

PerformanceInsightsEnabled

Type: *bool

True if Performance Insights is enabled for the DB instance, and otherwise false.

PerformanceInsightsKMSKeyId

Type: *string

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

PerformanceInsightsRetentionPeriod

Type: *int64

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

PreferredBackupWindow

Type: *string

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

PreferredMaintenanceWindow

Type: *string

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

ProcessorFeatures

Contains the processor features of a DB instance class.

To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.

You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:

  • CreateDBInstance

  • ModifyDBInstance

  • RestoreDBInstanceFromDBSnapshot

  • RestoreDBInstanceFromS3

  • RestoreDBInstanceToPointInTime

You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.

In addition, you can use the following actions for DB instance class processor information:

  • DescribeDBInstances

  • DescribeDBSnapshots

  • DescribeValidDBInstanceModifications

For more information, see Configuring the Processor of the DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor) in the Amazon RDS User Guide.

PromotionTier

Type: *int64

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) in the Amazon Aurora User Guide.

PubliclyAccessible

Type: *bool

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

ReadReplicaDBClusterIdentifiers

Type: []*string

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a Read Replica. For example, when you create an Aurora Read Replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.

Currently, each RDS DB instance can have only one Aurora Read Replica.

ReadReplicaDBInstanceIdentifiers

Type: []*string

Contains one or more identifiers of the Read Replicas associated with this DB instance.

ReadReplicaSourceDBInstanceIdentifier

Type: *string

Contains the identifier of the source DB instance if this DB instance is a Read Replica.

SecondaryAvailabilityZone

Type: *string

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

StatusInfos

Provides a list of status information for a DB instance.

StorageEncrypted

Type: *bool

Specifies whether the DB instance is encrypted.

StorageType

Type: *string

Specifies the storage type associated with DB instance.

TdeCredentialArn

Type: *string

The ARN from the key store with which the instance is associated for TDE encryption.

Timezone

Type: *string

The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

VpcSecurityGroups

This data type is used as a response element for queries on VPC security group membership.

Method

GoString

func (s DBInstance) GoString() string

GoString returns the string representation

SetAllocatedStorage

func (s *DBInstance) SetAllocatedStorage(v int64) *DBInstance

SetAllocatedStorage sets the AllocatedStorage field's value.

SetAssociatedRoles

func (s *DBInstance) SetAssociatedRoles(v []*DBInstanceRole) *DBInstance

SetAssociatedRoles sets the AssociatedRoles field's value.

SetAutoMinorVersionUpgrade

func (s *DBInstance) SetAutoMinorVersionUpgrade(v bool) *DBInstance

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

SetAvailabilityZone

func (s *DBInstance) SetAvailabilityZone(v string) *DBInstance

SetAvailabilityZone sets the AvailabilityZone field's value.

SetBackupRetentionPeriod

func (s *DBInstance) SetBackupRetentionPeriod(v int64) *DBInstance

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

SetCACertificateIdentifier

func (s *DBInstance) SetCACertificateIdentifier(v string) *DBInstance

SetCACertificateIdentifier sets the CACertificateIdentifier field's value.

SetCharacterSetName

func (s *DBInstance) SetCharacterSetName(v string) *DBInstance

SetCharacterSetName sets the CharacterSetName field's value.

SetCopyTagsToSnapshot

func (s *DBInstance) SetCopyTagsToSnapshot(v bool) *DBInstance

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

SetDBClusterIdentifier

func (s *DBInstance) SetDBClusterIdentifier(v string) *DBInstance

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

SetDBInstanceArn

func (s *DBInstance) SetDBInstanceArn(v string) *DBInstance

SetDBInstanceArn sets the DBInstanceArn field's value.

SetDBInstanceClass

func (s *DBInstance) SetDBInstanceClass(v string) *DBInstance

SetDBInstanceClass sets the DBInstanceClass field's value.

SetDBInstanceIdentifier

func (s *DBInstance) SetDBInstanceIdentifier(v string) *DBInstance

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

SetDBInstanceStatus

func (s *DBInstance) SetDBInstanceStatus(v string) *DBInstance

SetDBInstanceStatus sets the DBInstanceStatus field's value.

SetDBName

func (s *DBInstance) SetDBName(v string) *DBInstance

SetDBName sets the DBName field's value.

SetDBParameterGroups

func (s *DBInstance) SetDBParameterGroups(v []*DBParameterGroupStatus) *DBInstance

SetDBParameterGroups sets the DBParameterGroups field's value.

SetDBSecurityGroups

func (s *DBInstance) SetDBSecurityGroups(v []*DBSecurityGroupMembership) *DBInstance

SetDBSecurityGroups sets the DBSecurityGroups field's value.

SetDBSubnetGroup

func (s *DBInstance) SetDBSubnetGroup(v *DBSubnetGroup) *DBInstance

SetDBSubnetGroup sets the DBSubnetGroup field's value.

SetDbInstancePort

func (s *DBInstance) SetDbInstancePort(v int64) *DBInstance

SetDbInstancePort sets the DbInstancePort field's value.

SetDbiResourceId

func (s *DBInstance) SetDbiResourceId(v string) *DBInstance

SetDbiResourceId sets the DbiResourceId field's value.

SetDeletionProtection

func (s *DBInstance) SetDeletionProtection(v bool) *DBInstance

SetDeletionProtection sets the DeletionProtection field's value.

SetDomainMemberships

func (s *DBInstance) SetDomainMemberships(v []*DomainMembership) *DBInstance

SetDomainMemberships sets the DomainMemberships field's value.

SetEnabledCloudwatchLogsExports

func (s *DBInstance) SetEnabledCloudwatchLogsExports(v []*string) *DBInstance

SetEnabledCloudwatchLogsExports sets the EnabledCloudwatchLogsExports field's value.

SetEndpoint

func (s *DBInstance) SetEndpoint(v *Endpoint) *DBInstance

SetEndpoint sets the Endpoint field's value.

SetEngine

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

SetEngine sets the Engine field's value.

SetEngineVersion

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

SetEngineVersion sets the EngineVersion field's value.

SetEnhancedMonitoringResourceArn

func (s *DBInstance) SetEnhancedMonitoringResourceArn(v string) *DBInstance

SetEnhancedMonitoringResourceArn sets the EnhancedMonitoringResourceArn field's value.

SetIAMDatabaseAuthenticationEnabled

func (s *DBInstance) SetIAMDatabaseAuthenticationEnabled(v bool) *DBInstance

SetIAMDatabaseAuthenticationEnabled sets the IAMDatabaseAuthenticationEnabled field's value.

SetInstanceCreateTime

func (s *DBInstance) SetInstanceCreateTime(v time.Time) *DBInstance

SetInstanceCreateTime sets the InstanceCreateTime field's value.

SetIops

func (s *DBInstance) SetIops(v int64) *DBInstance

SetIops sets the Iops field's value.

SetKmsKeyId

func (s *DBInstance) SetKmsKeyId(v string) *DBInstance

SetKmsKeyId sets the KmsKeyId field's value.

SetLatestRestorableTime

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

SetLatestRestorableTime sets the LatestRestorableTime field's value.

SetLicenseModel

func (s *DBInstance) SetLicenseModel(v string) *DBInstance

SetLicenseModel sets the LicenseModel field's value.

SetListenerEndpoint

func (s *DBInstance) SetListenerEndpoint(v *Endpoint) *DBInstance

SetListenerEndpoint sets the ListenerEndpoint field's value.

SetMasterUsername

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

SetMasterUsername sets the MasterUsername field's value.

SetMonitoringInterval

func (s *DBInstance) SetMonitoringInterval(v int64) *DBInstance

SetMonitoringInterval sets the MonitoringInterval field's value.

SetMonitoringRoleArn

func (s *DBInstance) SetMonitoringRoleArn(v string) *DBInstance

SetMonitoringRoleArn sets the MonitoringRoleArn field's value.

SetMultiAZ

func (s *DBInstance) SetMultiAZ(v bool) *DBInstance

SetMultiAZ sets the MultiAZ field's value.

SetOptionGroupMemberships

func (s *DBInstance) SetOptionGroupMemberships(v []*OptionGroupMembership) *DBInstance

SetOptionGroupMemberships sets the OptionGroupMemberships field's value.

SetPendingModifiedValues

func (s *DBInstance) SetPendingModifiedValues(v *PendingModifiedValues) *DBInstance

SetPendingModifiedValues sets the PendingModifiedValues field's value.

SetPerformanceInsightsEnabled

func (s *DBInstance) SetPerformanceInsightsEnabled(v bool) *DBInstance

SetPerformanceInsightsEnabled sets the PerformanceInsightsEnabled field's value.

SetPerformanceInsightsKMSKeyId

func (s *DBInstance) SetPerformanceInsightsKMSKeyId(v string) *DBInstance

SetPerformanceInsightsKMSKeyId sets the PerformanceInsightsKMSKeyId field's value.

SetPerformanceInsightsRetentionPeriod

func (s *DBInstance) SetPerformanceInsightsRetentionPeriod(v int64) *DBInstance

SetPerformanceInsightsRetentionPeriod sets the PerformanceInsightsRetentionPeriod field's value.

SetPreferredBackupWindow

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

SetPreferredMaintenanceWindow

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

SetProcessorFeatures

func (s *DBInstance) SetProcessorFeatures(v []*ProcessorFeature) *DBInstance

SetProcessorFeatures sets the ProcessorFeatures field's value.

SetPromotionTier

func (s *DBInstance) SetPromotionTier(v int64) *DBInstance

SetPromotionTier sets the PromotionTier field's value.

SetPubliclyAccessible

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

SetPubliclyAccessible sets the PubliclyAccessible field's value.

SetReadReplicaDBClusterIdentifiers

func (s *DBInstance) SetReadReplicaDBClusterIdentifiers(v []*string) *DBInstance

SetReadReplicaDBClusterIdentifiers sets the ReadReplicaDBClusterIdentifiers field's value.

SetReadReplicaDBInstanceIdentifiers

func (s *DBInstance) SetReadReplicaDBInstanceIdentifiers(v []*string) *DBInstance

SetReadReplicaDBInstanceIdentifiers sets the ReadReplicaDBInstanceIdentifiers field's value.

SetReadReplicaSourceDBInstanceIdentifier

func (s *DBInstance) SetReadReplicaSourceDBInstanceIdentifier(v string) *DBInstance

SetReadReplicaSourceDBInstanceIdentifier sets the ReadReplicaSourceDBInstanceIdentifier field's value.

SetSecondaryAvailabilityZone

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

SetSecondaryAvailabilityZone sets the SecondaryAvailabilityZone field's value.

SetStatusInfos

func (s *DBInstance) SetStatusInfos(v []*DBInstanceStatusInfo) *DBInstance

SetStatusInfos sets the StatusInfos field's value.

SetStorageEncrypted

func (s *DBInstance) SetStorageEncrypted(v bool) *DBInstance

SetStorageEncrypted sets the StorageEncrypted field's value.

SetStorageType

func (s *DBInstance) SetStorageType(v string) *DBInstance

SetStorageType sets the StorageType field's value.

SetTdeCredentialArn

func (s *DBInstance) SetTdeCredentialArn(v string) *DBInstance

SetTdeCredentialArn sets the TdeCredentialArn field's value.

SetTimezone

func (s *DBInstance) SetTimezone(v string) *DBInstance

SetTimezone sets the Timezone field's value.

SetVpcSecurityGroups

func (s *DBInstance) SetVpcSecurityGroups(v []*VpcSecurityGroupMembership) *DBInstance

SetVpcSecurityGroups sets the VpcSecurityGroups field's value.

String

func (s DBInstance) String() string

String returns the string representation

On this page: