rds

package
v1.44.96 Latest Latest
Warning

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

Go to latest
Published: Sep 12, 2022 License: Apache-2.0 Imports: 11 Imported by: 858

Documentation

Overview

Package rds provides the client and types for making API requests to Amazon Relational Database Service.

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.

Amazon RDS API Reference

Amazon RDS User Guide

See https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31 for more information on this service.

See rds package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/rds/

Using the Client

To contact Amazon Relational Database Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Relational Database Service client RDS for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/rds/#New

IAM User or Role Database Authentication

The rdsutil package's BuildAuthToken function provides a connection authentication token builder. Given an endpoint of the RDS database, AWS region, DB user, and AWS credentials the function will create an presigned URL to use as the authentication token for the database's connection.

The following example shows how to use BuildAuthToken to create an authentication token for connecting to a MySQL database in RDS.

authToken, err := rdsutils.BuildAuthToken(dbEndpoint, awsRegion, dbUser, awsCreds)

// Create the MySQL DNS string for the DB connection
// user:password@protocol(endpoint)/dbname?<params>
dnsStr = fmt.Sprintf("%s:%s@tcp(%s)/%s?tls=true",
   dbUser, authToken, dbEndpoint, dbName,
)

// Use db to perform SQL operations on database
db, err := sql.Open("mysql", dnsStr)

See rdsutil package for more information. http://docs.aws.amazon.com/sdk-for-go/api/service/rds/rdsutils/

Index

Examples

Constants

View Source
const (
	// ActivityStreamModeSync is a ActivityStreamMode enum value
	ActivityStreamModeSync = "sync"

	// ActivityStreamModeAsync is a ActivityStreamMode enum value
	ActivityStreamModeAsync = "async"
)
View Source
const (
	// ActivityStreamPolicyStatusLocked is a ActivityStreamPolicyStatus enum value
	ActivityStreamPolicyStatusLocked = "locked"

	// ActivityStreamPolicyStatusUnlocked is a ActivityStreamPolicyStatus enum value
	ActivityStreamPolicyStatusUnlocked = "unlocked"

	// ActivityStreamPolicyStatusLockingPolicy is a ActivityStreamPolicyStatus enum value
	ActivityStreamPolicyStatusLockingPolicy = "locking-policy"

	// ActivityStreamPolicyStatusUnlockingPolicy is a ActivityStreamPolicyStatus enum value
	ActivityStreamPolicyStatusUnlockingPolicy = "unlocking-policy"
)
View Source
const (
	// ActivityStreamStatusStopped is a ActivityStreamStatus enum value
	ActivityStreamStatusStopped = "stopped"

	// ActivityStreamStatusStarting is a ActivityStreamStatus enum value
	ActivityStreamStatusStarting = "starting"

	// ActivityStreamStatusStarted is a ActivityStreamStatus enum value
	ActivityStreamStatusStarted = "started"

	// ActivityStreamStatusStopping is a ActivityStreamStatus enum value
	ActivityStreamStatusStopping = "stopping"
)
View Source
const (
	// ApplyMethodImmediate is a ApplyMethod enum value
	ApplyMethodImmediate = "immediate"

	// ApplyMethodPendingReboot is a ApplyMethod enum value
	ApplyMethodPendingReboot = "pending-reboot"
)
View Source
const (
	// AuditPolicyStateLocked is a AuditPolicyState enum value
	AuditPolicyStateLocked = "locked"

	// AuditPolicyStateUnlocked is a AuditPolicyState enum value
	AuditPolicyStateUnlocked = "unlocked"
)
View Source
const (
	// AutomationModeFull is a AutomationMode enum value
	AutomationModeFull = "full"

	// AutomationModeAllPaused is a AutomationMode enum value
	AutomationModeAllPaused = "all-paused"
)
View Source
const (
	// CustomEngineVersionStatusAvailable is a CustomEngineVersionStatus enum value
	CustomEngineVersionStatusAvailable = "available"

	// CustomEngineVersionStatusInactive is a CustomEngineVersionStatus enum value
	CustomEngineVersionStatusInactive = "inactive"

	// CustomEngineVersionStatusInactiveExceptRestore is a CustomEngineVersionStatus enum value
	CustomEngineVersionStatusInactiveExceptRestore = "inactive-except-restore"
)
View Source
const (
	// DBProxyEndpointStatusAvailable is a DBProxyEndpointStatus enum value
	DBProxyEndpointStatusAvailable = "available"

	// DBProxyEndpointStatusModifying is a DBProxyEndpointStatus enum value
	DBProxyEndpointStatusModifying = "modifying"

	// DBProxyEndpointStatusIncompatibleNetwork is a DBProxyEndpointStatus enum value
	DBProxyEndpointStatusIncompatibleNetwork = "incompatible-network"

	// DBProxyEndpointStatusInsufficientResourceLimits is a DBProxyEndpointStatus enum value
	DBProxyEndpointStatusInsufficientResourceLimits = "insufficient-resource-limits"

	// DBProxyEndpointStatusCreating is a DBProxyEndpointStatus enum value
	DBProxyEndpointStatusCreating = "creating"

	// DBProxyEndpointStatusDeleting is a DBProxyEndpointStatus enum value
	DBProxyEndpointStatusDeleting = "deleting"
)
View Source
const (
	// DBProxyEndpointTargetRoleReadWrite is a DBProxyEndpointTargetRole enum value
	DBProxyEndpointTargetRoleReadWrite = "READ_WRITE"

	// DBProxyEndpointTargetRoleReadOnly is a DBProxyEndpointTargetRole enum value
	DBProxyEndpointTargetRoleReadOnly = "READ_ONLY"
)
View Source
const (
	// DBProxyStatusAvailable is a DBProxyStatus enum value
	DBProxyStatusAvailable = "available"

	// DBProxyStatusModifying is a DBProxyStatus enum value
	DBProxyStatusModifying = "modifying"

	// DBProxyStatusIncompatibleNetwork is a DBProxyStatus enum value
	DBProxyStatusIncompatibleNetwork = "incompatible-network"

	// DBProxyStatusInsufficientResourceLimits is a DBProxyStatus enum value
	DBProxyStatusInsufficientResourceLimits = "insufficient-resource-limits"

	// DBProxyStatusCreating is a DBProxyStatus enum value
	DBProxyStatusCreating = "creating"

	// DBProxyStatusDeleting is a DBProxyStatus enum value
	DBProxyStatusDeleting = "deleting"

	// DBProxyStatusSuspended is a DBProxyStatus enum value
	DBProxyStatusSuspended = "suspended"

	// DBProxyStatusSuspending is a DBProxyStatus enum value
	DBProxyStatusSuspending = "suspending"

	// DBProxyStatusReactivating is a DBProxyStatus enum value
	DBProxyStatusReactivating = "reactivating"
)
View Source
const (
	// EngineFamilyMysql is a EngineFamily enum value
	EngineFamilyMysql = "MYSQL"

	// EngineFamilyPostgresql is a EngineFamily enum value
	EngineFamilyPostgresql = "POSTGRESQL"
)
View Source
const (
	// FailoverStatusPending is a FailoverStatus enum value
	FailoverStatusPending = "pending"

	// FailoverStatusFailingOver is a FailoverStatus enum value
	FailoverStatusFailingOver = "failing-over"

	// FailoverStatusCancelling is a FailoverStatus enum value
	FailoverStatusCancelling = "cancelling"
)
View Source
const (
	// IAMAuthModeDisabled is a IAMAuthMode enum value
	IAMAuthModeDisabled = "DISABLED"

	// IAMAuthModeRequired is a IAMAuthMode enum value
	IAMAuthModeRequired = "REQUIRED"
)
View Source
const (
	// ReplicaModeOpenReadOnly is a ReplicaMode enum value
	ReplicaModeOpenReadOnly = "open-read-only"

	// ReplicaModeMounted is a ReplicaMode enum value
	ReplicaModeMounted = "mounted"
)
View Source
const (
	// SourceTypeDbInstance is a SourceType enum value
	SourceTypeDbInstance = "db-instance"

	// SourceTypeDbParameterGroup is a SourceType enum value
	SourceTypeDbParameterGroup = "db-parameter-group"

	// SourceTypeDbSecurityGroup is a SourceType enum value
	SourceTypeDbSecurityGroup = "db-security-group"

	// SourceTypeDbSnapshot is a SourceType enum value
	SourceTypeDbSnapshot = "db-snapshot"

	// SourceTypeDbCluster is a SourceType enum value
	SourceTypeDbCluster = "db-cluster"

	// SourceTypeDbClusterSnapshot is a SourceType enum value
	SourceTypeDbClusterSnapshot = "db-cluster-snapshot"

	// SourceTypeCustomEngineVersion is a SourceType enum value
	SourceTypeCustomEngineVersion = "custom-engine-version"

	// SourceTypeDbProxy is a SourceType enum value
	SourceTypeDbProxy = "db-proxy"
)
View Source
const (
	// TargetHealthReasonUnreachable is a TargetHealthReason enum value
	TargetHealthReasonUnreachable = "UNREACHABLE"

	// TargetHealthReasonConnectionFailed is a TargetHealthReason enum value
	TargetHealthReasonConnectionFailed = "CONNECTION_FAILED"

	// TargetHealthReasonAuthFailure is a TargetHealthReason enum value
	TargetHealthReasonAuthFailure = "AUTH_FAILURE"

	// TargetHealthReasonPendingProxyCapacity is a TargetHealthReason enum value
	TargetHealthReasonPendingProxyCapacity = "PENDING_PROXY_CAPACITY"

	// TargetHealthReasonInvalidReplicationState is a TargetHealthReason enum value
	TargetHealthReasonInvalidReplicationState = "INVALID_REPLICATION_STATE"
)
View Source
const (
	// TargetRoleReadWrite is a TargetRole enum value
	TargetRoleReadWrite = "READ_WRITE"

	// TargetRoleReadOnly is a TargetRole enum value
	TargetRoleReadOnly = "READ_ONLY"

	// TargetRoleUnknown is a TargetRole enum value
	TargetRoleUnknown = "UNKNOWN"
)
View Source
const (
	// TargetStateRegistering is a TargetState enum value
	TargetStateRegistering = "REGISTERING"

	// TargetStateAvailable is a TargetState enum value
	TargetStateAvailable = "AVAILABLE"

	// TargetStateUnavailable is a TargetState enum value
	TargetStateUnavailable = "UNAVAILABLE"
)
View Source
const (
	// TargetTypeRdsInstance is a TargetType enum value
	TargetTypeRdsInstance = "RDS_INSTANCE"

	// TargetTypeRdsServerlessEndpoint is a TargetType enum value
	TargetTypeRdsServerlessEndpoint = "RDS_SERVERLESS_ENDPOINT"

	// TargetTypeTrackedCluster is a TargetType enum value
	TargetTypeTrackedCluster = "TRACKED_CLUSTER"
)
View Source
const (
	// WriteForwardingStatusEnabled is a WriteForwardingStatus enum value
	WriteForwardingStatusEnabled = "enabled"

	// WriteForwardingStatusDisabled is a WriteForwardingStatus enum value
	WriteForwardingStatusDisabled = "disabled"

	// WriteForwardingStatusEnabling is a WriteForwardingStatus enum value
	WriteForwardingStatusEnabling = "enabling"

	// WriteForwardingStatusDisabling is a WriteForwardingStatus enum value
	WriteForwardingStatusDisabling = "disabling"

	// WriteForwardingStatusUnknown is a WriteForwardingStatus enum value
	WriteForwardingStatusUnknown = "unknown"
)
View Source
const (

	// ErrCodeAuthorizationAlreadyExistsFault for service response error code
	// "AuthorizationAlreadyExists".
	//
	// The specified CIDR IP range or Amazon EC2 security group is already authorized
	// for the specified DB security group.
	ErrCodeAuthorizationAlreadyExistsFault = "AuthorizationAlreadyExists"

	// ErrCodeAuthorizationNotFoundFault for service response error code
	// "AuthorizationNotFound".
	//
	// The specified CIDR IP range or Amazon EC2 security group might not be authorized
	// for the specified DB security group.
	//
	// Or, RDS might not be authorized to perform necessary actions using IAM on
	// your behalf.
	ErrCodeAuthorizationNotFoundFault = "AuthorizationNotFound"

	// ErrCodeAuthorizationQuotaExceededFault for service response error code
	// "AuthorizationQuotaExceeded".
	//
	// The DB security group authorization quota has been reached.
	ErrCodeAuthorizationQuotaExceededFault = "AuthorizationQuotaExceeded"

	// ErrCodeBackupPolicyNotFoundFault for service response error code
	// "BackupPolicyNotFoundFault".
	ErrCodeBackupPolicyNotFoundFault = "BackupPolicyNotFoundFault"

	// ErrCodeCertificateNotFoundFault for service response error code
	// "CertificateNotFound".
	//
	// CertificateIdentifier doesn't refer to an existing certificate.
	ErrCodeCertificateNotFoundFault = "CertificateNotFound"

	// ErrCodeCustomAvailabilityZoneNotFoundFault for service response error code
	// "CustomAvailabilityZoneNotFound".
	//
	// CustomAvailabilityZoneId doesn't refer to an existing custom Availability
	// Zone identifier.
	ErrCodeCustomAvailabilityZoneNotFoundFault = "CustomAvailabilityZoneNotFound"

	// ErrCodeCustomDBEngineVersionAlreadyExistsFault for service response error code
	// "CustomDBEngineVersionAlreadyExistsFault".
	//
	// A CEV with the specified name already exists.
	ErrCodeCustomDBEngineVersionAlreadyExistsFault = "CustomDBEngineVersionAlreadyExistsFault"

	// ErrCodeCustomDBEngineVersionNotFoundFault for service response error code
	// "CustomDBEngineVersionNotFoundFault".
	//
	// The specified CEV was not found.
	ErrCodeCustomDBEngineVersionNotFoundFault = "CustomDBEngineVersionNotFoundFault"

	// ErrCodeCustomDBEngineVersionQuotaExceededFault for service response error code
	// "CustomDBEngineVersionQuotaExceededFault".
	//
	// You have exceeded your CEV quota.
	ErrCodeCustomDBEngineVersionQuotaExceededFault = "CustomDBEngineVersionQuotaExceededFault"

	// ErrCodeDBClusterAlreadyExistsFault for service response error code
	// "DBClusterAlreadyExistsFault".
	//
	// The user already has a DB cluster with the given identifier.
	ErrCodeDBClusterAlreadyExistsFault = "DBClusterAlreadyExistsFault"

	// ErrCodeDBClusterBacktrackNotFoundFault for service response error code
	// "DBClusterBacktrackNotFoundFault".
	//
	// BacktrackIdentifier doesn't refer to an existing backtrack.
	ErrCodeDBClusterBacktrackNotFoundFault = "DBClusterBacktrackNotFoundFault"

	// ErrCodeDBClusterEndpointAlreadyExistsFault for service response error code
	// "DBClusterEndpointAlreadyExistsFault".
	//
	// The specified custom endpoint can't be created because it already exists.
	ErrCodeDBClusterEndpointAlreadyExistsFault = "DBClusterEndpointAlreadyExistsFault"

	// ErrCodeDBClusterEndpointNotFoundFault for service response error code
	// "DBClusterEndpointNotFoundFault".
	//
	// The specified custom endpoint doesn't exist.
	ErrCodeDBClusterEndpointNotFoundFault = "DBClusterEndpointNotFoundFault"

	// ErrCodeDBClusterEndpointQuotaExceededFault for service response error code
	// "DBClusterEndpointQuotaExceededFault".
	//
	// The cluster already has the maximum number of custom endpoints.
	ErrCodeDBClusterEndpointQuotaExceededFault = "DBClusterEndpointQuotaExceededFault"

	// ErrCodeDBClusterNotFoundFault for service response error code
	// "DBClusterNotFoundFault".
	//
	// DBClusterIdentifier doesn't refer to an existing DB cluster.
	ErrCodeDBClusterNotFoundFault = "DBClusterNotFoundFault"

	// ErrCodeDBClusterParameterGroupNotFoundFault for service response error code
	// "DBClusterParameterGroupNotFound".
	//
	// DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter
	// group.
	ErrCodeDBClusterParameterGroupNotFoundFault = "DBClusterParameterGroupNotFound"

	// ErrCodeDBClusterQuotaExceededFault for service response error code
	// "DBClusterQuotaExceededFault".
	//
	// The user attempted to create a new DB cluster and the user has already reached
	// the maximum allowed DB cluster quota.
	ErrCodeDBClusterQuotaExceededFault = "DBClusterQuotaExceededFault"

	// ErrCodeDBClusterRoleAlreadyExistsFault for service response error code
	// "DBClusterRoleAlreadyExists".
	//
	// The specified IAM role Amazon Resource Name (ARN) is already associated with
	// the specified DB cluster.
	ErrCodeDBClusterRoleAlreadyExistsFault = "DBClusterRoleAlreadyExists"

	// ErrCodeDBClusterRoleNotFoundFault for service response error code
	// "DBClusterRoleNotFound".
	//
	// The specified IAM role Amazon Resource Name (ARN) isn't associated with the
	// specified DB cluster.
	ErrCodeDBClusterRoleNotFoundFault = "DBClusterRoleNotFound"

	// ErrCodeDBClusterRoleQuotaExceededFault for service response error code
	// "DBClusterRoleQuotaExceeded".
	//
	// You have exceeded the maximum number of IAM roles that can be associated
	// with the specified DB cluster.
	ErrCodeDBClusterRoleQuotaExceededFault = "DBClusterRoleQuotaExceeded"

	// ErrCodeDBClusterSnapshotAlreadyExistsFault for service response error code
	// "DBClusterSnapshotAlreadyExistsFault".
	//
	// The user already has a DB cluster snapshot with the given identifier.
	ErrCodeDBClusterSnapshotAlreadyExistsFault = "DBClusterSnapshotAlreadyExistsFault"

	// ErrCodeDBClusterSnapshotNotFoundFault for service response error code
	// "DBClusterSnapshotNotFoundFault".
	//
	// DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
	ErrCodeDBClusterSnapshotNotFoundFault = "DBClusterSnapshotNotFoundFault"

	// ErrCodeDBInstanceAlreadyExistsFault for service response error code
	// "DBInstanceAlreadyExists".
	//
	// The user already has a DB instance with the given identifier.
	ErrCodeDBInstanceAlreadyExistsFault = "DBInstanceAlreadyExists"

	// ErrCodeDBInstanceAutomatedBackupNotFoundFault for service response error code
	// "DBInstanceAutomatedBackupNotFound".
	//
	// No automated backup for this DB instance was found.
	ErrCodeDBInstanceAutomatedBackupNotFoundFault = "DBInstanceAutomatedBackupNotFound"

	// ErrCodeDBInstanceAutomatedBackupQuotaExceededFault for service response error code
	// "DBInstanceAutomatedBackupQuotaExceeded".
	//
	// The quota for retained automated backups was exceeded. This prevents you
	// from retaining any additional automated backups. The retained automated backups
	// quota is the same as your DB Instance quota.
	ErrCodeDBInstanceAutomatedBackupQuotaExceededFault = "DBInstanceAutomatedBackupQuotaExceeded"

	// ErrCodeDBInstanceNotFoundFault for service response error code
	// "DBInstanceNotFound".
	//
	// DBInstanceIdentifier doesn't refer to an existing DB instance.
	ErrCodeDBInstanceNotFoundFault = "DBInstanceNotFound"

	// ErrCodeDBInstanceRoleAlreadyExistsFault for service response error code
	// "DBInstanceRoleAlreadyExists".
	//
	// The specified RoleArn or FeatureName value is already associated with the
	// DB instance.
	ErrCodeDBInstanceRoleAlreadyExistsFault = "DBInstanceRoleAlreadyExists"

	// ErrCodeDBInstanceRoleNotFoundFault for service response error code
	// "DBInstanceRoleNotFound".
	//
	// The specified RoleArn value doesn't match the specified feature for the DB
	// instance.
	ErrCodeDBInstanceRoleNotFoundFault = "DBInstanceRoleNotFound"

	// ErrCodeDBInstanceRoleQuotaExceededFault for service response error code
	// "DBInstanceRoleQuotaExceeded".
	//
	// You can't associate any more Amazon Web Services Identity and Access Management
	// (IAM) roles with the DB instance because the quota has been reached.
	ErrCodeDBInstanceRoleQuotaExceededFault = "DBInstanceRoleQuotaExceeded"

	// ErrCodeDBLogFileNotFoundFault for service response error code
	// "DBLogFileNotFoundFault".
	//
	// LogFileName doesn't refer to an existing DB log file.
	ErrCodeDBLogFileNotFoundFault = "DBLogFileNotFoundFault"

	// ErrCodeDBParameterGroupAlreadyExistsFault for service response error code
	// "DBParameterGroupAlreadyExists".
	//
	// A DB parameter group with the same name exists.
	ErrCodeDBParameterGroupAlreadyExistsFault = "DBParameterGroupAlreadyExists"

	// ErrCodeDBParameterGroupNotFoundFault for service response error code
	// "DBParameterGroupNotFound".
	//
	// DBParameterGroupName doesn't refer to an existing DB parameter group.
	ErrCodeDBParameterGroupNotFoundFault = "DBParameterGroupNotFound"

	// ErrCodeDBParameterGroupQuotaExceededFault for service response error code
	// "DBParameterGroupQuotaExceeded".
	//
	// The request would result in the user exceeding the allowed number of DB parameter
	// groups.
	ErrCodeDBParameterGroupQuotaExceededFault = "DBParameterGroupQuotaExceeded"

	// ErrCodeDBProxyAlreadyExistsFault for service response error code
	// "DBProxyAlreadyExistsFault".
	//
	// The specified proxy name must be unique for all proxies owned by your Amazon
	// Web Services account in the specified Amazon Web Services Region.
	ErrCodeDBProxyAlreadyExistsFault = "DBProxyAlreadyExistsFault"

	// ErrCodeDBProxyEndpointAlreadyExistsFault for service response error code
	// "DBProxyEndpointAlreadyExistsFault".
	//
	// The specified DB proxy endpoint name must be unique for all DB proxy endpoints
	// owned by your Amazon Web Services account in the specified Amazon Web Services
	// Region.
	ErrCodeDBProxyEndpointAlreadyExistsFault = "DBProxyEndpointAlreadyExistsFault"

	// ErrCodeDBProxyEndpointNotFoundFault for service response error code
	// "DBProxyEndpointNotFoundFault".
	//
	// The DB proxy endpoint doesn't exist.
	ErrCodeDBProxyEndpointNotFoundFault = "DBProxyEndpointNotFoundFault"

	// ErrCodeDBProxyEndpointQuotaExceededFault for service response error code
	// "DBProxyEndpointQuotaExceededFault".
	//
	// The DB proxy already has the maximum number of endpoints.
	ErrCodeDBProxyEndpointQuotaExceededFault = "DBProxyEndpointQuotaExceededFault"

	// ErrCodeDBProxyNotFoundFault for service response error code
	// "DBProxyNotFoundFault".
	//
	// The specified proxy name doesn't correspond to a proxy owned by your Amazon
	// Web Services account in the specified Amazon Web Services Region.
	ErrCodeDBProxyNotFoundFault = "DBProxyNotFoundFault"

	// ErrCodeDBProxyQuotaExceededFault for service response error code
	// "DBProxyQuotaExceededFault".
	//
	// Your Amazon Web Services account already has the maximum number of proxies
	// in the specified Amazon Web Services Region.
	ErrCodeDBProxyQuotaExceededFault = "DBProxyQuotaExceededFault"

	// ErrCodeDBProxyTargetAlreadyRegisteredFault for service response error code
	// "DBProxyTargetAlreadyRegisteredFault".
	//
	// The proxy is already associated with the specified RDS DB instance or Aurora
	// DB cluster.
	ErrCodeDBProxyTargetAlreadyRegisteredFault = "DBProxyTargetAlreadyRegisteredFault"

	// ErrCodeDBProxyTargetGroupNotFoundFault for service response error code
	// "DBProxyTargetGroupNotFoundFault".
	//
	// The specified target group isn't available for a proxy owned by your Amazon
	// Web Services account in the specified Amazon Web Services Region.
	ErrCodeDBProxyTargetGroupNotFoundFault = "DBProxyTargetGroupNotFoundFault"

	// ErrCodeDBProxyTargetNotFoundFault for service response error code
	// "DBProxyTargetNotFoundFault".
	//
	// The specified RDS DB instance or Aurora DB cluster isn't available for a
	// proxy owned by your Amazon Web Services account in the specified Amazon Web
	// Services Region.
	ErrCodeDBProxyTargetNotFoundFault = "DBProxyTargetNotFoundFault"

	// ErrCodeDBSecurityGroupAlreadyExistsFault for service response error code
	// "DBSecurityGroupAlreadyExists".
	//
	// A DB security group with the name specified in DBSecurityGroupName already
	// exists.
	ErrCodeDBSecurityGroupAlreadyExistsFault = "DBSecurityGroupAlreadyExists"

	// ErrCodeDBSecurityGroupNotFoundFault for service response error code
	// "DBSecurityGroupNotFound".
	//
	// DBSecurityGroupName doesn't refer to an existing DB security group.
	ErrCodeDBSecurityGroupNotFoundFault = "DBSecurityGroupNotFound"

	// ErrCodeDBSecurityGroupNotSupportedFault for service response error code
	// "DBSecurityGroupNotSupported".
	//
	// A DB security group isn't allowed for this action.
	ErrCodeDBSecurityGroupNotSupportedFault = "DBSecurityGroupNotSupported"

	// ErrCodeDBSecurityGroupQuotaExceededFault for service response error code
	// "QuotaExceeded.DBSecurityGroup".
	//
	// The request would result in the user exceeding the allowed number of DB security
	// groups.
	ErrCodeDBSecurityGroupQuotaExceededFault = "QuotaExceeded.DBSecurityGroup"

	// ErrCodeDBSnapshotAlreadyExistsFault for service response error code
	// "DBSnapshotAlreadyExists".
	//
	// DBSnapshotIdentifier is already used by an existing snapshot.
	ErrCodeDBSnapshotAlreadyExistsFault = "DBSnapshotAlreadyExists"

	// ErrCodeDBSnapshotNotFoundFault for service response error code
	// "DBSnapshotNotFound".
	//
	// DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
	ErrCodeDBSnapshotNotFoundFault = "DBSnapshotNotFound"

	// ErrCodeDBSubnetGroupAlreadyExistsFault for service response error code
	// "DBSubnetGroupAlreadyExists".
	//
	// DBSubnetGroupName is already used by an existing DB subnet group.
	ErrCodeDBSubnetGroupAlreadyExistsFault = "DBSubnetGroupAlreadyExists"

	// ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs for service response error code
	// "DBSubnetGroupDoesNotCoverEnoughAZs".
	//
	// Subnets in the DB subnet group should cover at least two Availability Zones
	// unless there is only one Availability Zone.
	ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs = "DBSubnetGroupDoesNotCoverEnoughAZs"

	// ErrCodeDBSubnetGroupNotAllowedFault for service response error code
	// "DBSubnetGroupNotAllowedFault".
	//
	// The DBSubnetGroup shouldn't be specified while creating read replicas that
	// lie in the same region as the source instance.
	ErrCodeDBSubnetGroupNotAllowedFault = "DBSubnetGroupNotAllowedFault"

	// ErrCodeDBSubnetGroupNotFoundFault for service response error code
	// "DBSubnetGroupNotFoundFault".
	//
	// DBSubnetGroupName doesn't refer to an existing DB subnet group.
	ErrCodeDBSubnetGroupNotFoundFault = "DBSubnetGroupNotFoundFault"

	// ErrCodeDBSubnetGroupQuotaExceededFault for service response error code
	// "DBSubnetGroupQuotaExceeded".
	//
	// The request would result in the user exceeding the allowed number of DB subnet
	// groups.
	ErrCodeDBSubnetGroupQuotaExceededFault = "DBSubnetGroupQuotaExceeded"

	// ErrCodeDBSubnetQuotaExceededFault for service response error code
	// "DBSubnetQuotaExceededFault".
	//
	// The request would result in the user exceeding the allowed number of subnets
	// in a DB subnet groups.
	ErrCodeDBSubnetQuotaExceededFault = "DBSubnetQuotaExceededFault"

	// ErrCodeDBUpgradeDependencyFailureFault for service response error code
	// "DBUpgradeDependencyFailure".
	//
	// The DB upgrade failed because a resource the DB depends on can't be modified.
	ErrCodeDBUpgradeDependencyFailureFault = "DBUpgradeDependencyFailure"

	// ErrCodeDomainNotFoundFault for service response error code
	// "DomainNotFoundFault".
	//
	// Domain doesn't refer to an existing Active Directory domain.
	ErrCodeDomainNotFoundFault = "DomainNotFoundFault"

	// ErrCodeEventSubscriptionQuotaExceededFault for service response error code
	// "EventSubscriptionQuotaExceeded".
	//
	// You have reached the maximum number of event subscriptions.
	ErrCodeEventSubscriptionQuotaExceededFault = "EventSubscriptionQuotaExceeded"

	// ErrCodeExportTaskAlreadyExistsFault for service response error code
	// "ExportTaskAlreadyExists".
	//
	// You can't start an export task that's already running.
	ErrCodeExportTaskAlreadyExistsFault = "ExportTaskAlreadyExists"

	// ErrCodeExportTaskNotFoundFault for service response error code
	// "ExportTaskNotFound".
	//
	// The export task doesn't exist.
	ErrCodeExportTaskNotFoundFault = "ExportTaskNotFound"

	// ErrCodeGlobalClusterAlreadyExistsFault for service response error code
	// "GlobalClusterAlreadyExistsFault".
	//
	// The GlobalClusterIdentifier already exists. Choose a new global database
	// identifier (unique name) to create a new global database cluster.
	ErrCodeGlobalClusterAlreadyExistsFault = "GlobalClusterAlreadyExistsFault"

	// ErrCodeGlobalClusterNotFoundFault for service response error code
	// "GlobalClusterNotFoundFault".
	//
	// The GlobalClusterIdentifier doesn't refer to an existing global database
	// cluster.
	ErrCodeGlobalClusterNotFoundFault = "GlobalClusterNotFoundFault"

	// ErrCodeGlobalClusterQuotaExceededFault for service response error code
	// "GlobalClusterQuotaExceededFault".
	//
	// The number of global database clusters for this account is already at the
	// maximum allowed.
	ErrCodeGlobalClusterQuotaExceededFault = "GlobalClusterQuotaExceededFault"

	// ErrCodeIamRoleMissingPermissionsFault for service response error code
	// "IamRoleMissingPermissions".
	//
	// The IAM role requires additional permissions to export to an Amazon S3 bucket.
	ErrCodeIamRoleMissingPermissionsFault = "IamRoleMissingPermissions"

	// ErrCodeIamRoleNotFoundFault for service response error code
	// "IamRoleNotFound".
	//
	// The IAM role is missing for exporting to an Amazon S3 bucket.
	ErrCodeIamRoleNotFoundFault = "IamRoleNotFound"

	// ErrCodeInstanceQuotaExceededFault for service response error code
	// "InstanceQuotaExceeded".
	//
	// The request would result in the user exceeding the allowed number of DB instances.
	ErrCodeInstanceQuotaExceededFault = "InstanceQuotaExceeded"

	// ErrCodeInsufficientAvailableIPsInSubnetFault for service response error code
	// "InsufficientAvailableIPsInSubnetFault".
	//
	// The requested operation can't be performed because there aren't enough available
	// IP addresses in the proxy's subnets. Add more CIDR blocks to the VPC or remove
	// IP address that aren't required from the subnets.
	ErrCodeInsufficientAvailableIPsInSubnetFault = "InsufficientAvailableIPsInSubnetFault"

	// ErrCodeInsufficientDBClusterCapacityFault for service response error code
	// "InsufficientDBClusterCapacityFault".
	//
	// The DB cluster doesn't have enough capacity for the current operation.
	ErrCodeInsufficientDBClusterCapacityFault = "InsufficientDBClusterCapacityFault"

	// ErrCodeInsufficientDBInstanceCapacityFault for service response error code
	// "InsufficientDBInstanceCapacity".
	//
	// The specified DB instance class isn't available in the specified Availability
	// Zone.
	ErrCodeInsufficientDBInstanceCapacityFault = "InsufficientDBInstanceCapacity"

	// ErrCodeInsufficientStorageClusterCapacityFault for service response error code
	// "InsufficientStorageClusterCapacity".
	//
	// There is insufficient storage available for the current action. You might
	// be able to resolve this error by updating your subnet group to use different
	// Availability Zones that have more storage available.
	ErrCodeInsufficientStorageClusterCapacityFault = "InsufficientStorageClusterCapacity"

	// ErrCodeInvalidCustomDBEngineVersionStateFault for service response error code
	// "InvalidCustomDBEngineVersionStateFault".
	//
	// You can't delete the CEV.
	ErrCodeInvalidCustomDBEngineVersionStateFault = "InvalidCustomDBEngineVersionStateFault"

	// ErrCodeInvalidDBClusterCapacityFault for service response error code
	// "InvalidDBClusterCapacityFault".
	//
	// Capacity isn't a valid Aurora Serverless DB cluster capacity. Valid capacity
	// values are 2, 4, 8, 16, 32, 64, 128, and 256.
	ErrCodeInvalidDBClusterCapacityFault = "InvalidDBClusterCapacityFault"

	// ErrCodeInvalidDBClusterEndpointStateFault for service response error code
	// "InvalidDBClusterEndpointStateFault".
	//
	// The requested operation can't be performed on the endpoint while the endpoint
	// is in this state.
	ErrCodeInvalidDBClusterEndpointStateFault = "InvalidDBClusterEndpointStateFault"

	// ErrCodeInvalidDBClusterSnapshotStateFault for service response error code
	// "InvalidDBClusterSnapshotStateFault".
	//
	// The supplied value isn't a valid DB cluster snapshot state.
	ErrCodeInvalidDBClusterSnapshotStateFault = "InvalidDBClusterSnapshotStateFault"

	// ErrCodeInvalidDBClusterStateFault for service response error code
	// "InvalidDBClusterStateFault".
	//
	// The requested operation can't be performed while the cluster is in this state.
	ErrCodeInvalidDBClusterStateFault = "InvalidDBClusterStateFault"

	// ErrCodeInvalidDBInstanceAutomatedBackupStateFault for service response error code
	// "InvalidDBInstanceAutomatedBackupState".
	//
	// The automated backup is in an invalid state. For example, this automated
	// backup is associated with an active instance.
	ErrCodeInvalidDBInstanceAutomatedBackupStateFault = "InvalidDBInstanceAutomatedBackupState"

	// ErrCodeInvalidDBInstanceStateFault for service response error code
	// "InvalidDBInstanceState".
	//
	// The DB instance isn't in a valid state.
	ErrCodeInvalidDBInstanceStateFault = "InvalidDBInstanceState"

	// ErrCodeInvalidDBParameterGroupStateFault for service response error code
	// "InvalidDBParameterGroupState".
	//
	// The DB parameter group is in use or is in an invalid state. If you are attempting
	// to delete the parameter group, you can't delete it when the parameter group
	// is in this state.
	ErrCodeInvalidDBParameterGroupStateFault = "InvalidDBParameterGroupState"

	// ErrCodeInvalidDBProxyEndpointStateFault for service response error code
	// "InvalidDBProxyEndpointStateFault".
	//
	// You can't perform this operation while the DB proxy endpoint is in a particular
	// state.
	ErrCodeInvalidDBProxyEndpointStateFault = "InvalidDBProxyEndpointStateFault"

	// ErrCodeInvalidDBProxyStateFault for service response error code
	// "InvalidDBProxyStateFault".
	//
	// The requested operation can't be performed while the proxy is in this state.
	ErrCodeInvalidDBProxyStateFault = "InvalidDBProxyStateFault"

	// ErrCodeInvalidDBSecurityGroupStateFault for service response error code
	// "InvalidDBSecurityGroupState".
	//
	// The state of the DB security group doesn't allow deletion.
	ErrCodeInvalidDBSecurityGroupStateFault = "InvalidDBSecurityGroupState"

	// ErrCodeInvalidDBSnapshotStateFault for service response error code
	// "InvalidDBSnapshotState".
	//
	// The state of the DB snapshot doesn't allow deletion.
	ErrCodeInvalidDBSnapshotStateFault = "InvalidDBSnapshotState"

	// ErrCodeInvalidDBSubnetGroupFault for service response error code
	// "InvalidDBSubnetGroupFault".
	//
	// The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region
	// read replica of the same source instance.
	ErrCodeInvalidDBSubnetGroupFault = "InvalidDBSubnetGroupFault"

	// ErrCodeInvalidDBSubnetGroupStateFault for service response error code
	// "InvalidDBSubnetGroupStateFault".
	//
	// The DB subnet group cannot be deleted because it's in use.
	ErrCodeInvalidDBSubnetGroupStateFault = "InvalidDBSubnetGroupStateFault"

	// ErrCodeInvalidDBSubnetStateFault for service response error code
	// "InvalidDBSubnetStateFault".
	//
	// The DB subnet isn't in the available state.
	ErrCodeInvalidDBSubnetStateFault = "InvalidDBSubnetStateFault"

	// ErrCodeInvalidEventSubscriptionStateFault for service response error code
	// "InvalidEventSubscriptionState".
	//
	// This error can occur if someone else is modifying a subscription. You should
	// retry the action.
	ErrCodeInvalidEventSubscriptionStateFault = "InvalidEventSubscriptionState"

	// ErrCodeInvalidExportOnlyFault for service response error code
	// "InvalidExportOnly".
	//
	// The export is invalid for exporting to an Amazon S3 bucket.
	ErrCodeInvalidExportOnlyFault = "InvalidExportOnly"

	// ErrCodeInvalidExportSourceStateFault for service response error code
	// "InvalidExportSourceState".
	//
	// The state of the export snapshot is invalid for exporting to an Amazon S3
	// bucket.
	ErrCodeInvalidExportSourceStateFault = "InvalidExportSourceState"

	// ErrCodeInvalidExportTaskStateFault for service response error code
	// "InvalidExportTaskStateFault".
	//
	// You can't cancel an export task that has completed.
	ErrCodeInvalidExportTaskStateFault = "InvalidExportTaskStateFault"

	// ErrCodeInvalidGlobalClusterStateFault for service response error code
	// "InvalidGlobalClusterStateFault".
	//
	// The global cluster is in an invalid state and can't perform the requested
	// operation.
	ErrCodeInvalidGlobalClusterStateFault = "InvalidGlobalClusterStateFault"

	// ErrCodeInvalidOptionGroupStateFault for service response error code
	// "InvalidOptionGroupStateFault".
	//
	// The option group isn't in the available state.
	ErrCodeInvalidOptionGroupStateFault = "InvalidOptionGroupStateFault"

	// ErrCodeInvalidRestoreFault for service response error code
	// "InvalidRestoreFault".
	//
	// Cannot restore from VPC backup to non-VPC DB instance.
	ErrCodeInvalidRestoreFault = "InvalidRestoreFault"

	// ErrCodeInvalidS3BucketFault for service response error code
	// "InvalidS3BucketFault".
	//
	// The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized
	// to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and
	// S3IngestionRoleArn values and try again.
	ErrCodeInvalidS3BucketFault = "InvalidS3BucketFault"

	// ErrCodeInvalidSubnet for service response error code
	// "InvalidSubnet".
	//
	// The requested subnet is invalid, or multiple subnets were requested that
	// are not all in a common VPC.
	ErrCodeInvalidSubnet = "InvalidSubnet"

	// ErrCodeInvalidVPCNetworkStateFault for service response error code
	// "InvalidVPCNetworkStateFault".
	//
	// The DB subnet group doesn't cover all Availability Zones after it's created
	// because of users' change.
	ErrCodeInvalidVPCNetworkStateFault = "InvalidVPCNetworkStateFault"

	// ErrCodeKMSKeyNotAccessibleFault for service response error code
	// "KMSKeyNotAccessibleFault".
	//
	// An error occurred accessing an Amazon Web Services KMS key.
	ErrCodeKMSKeyNotAccessibleFault = "KMSKeyNotAccessibleFault"

	// ErrCodeNetworkTypeNotSupported for service response error code
	// "NetworkTypeNotSupported".
	//
	// The network type is invalid for the DB instance. Valid nework type values
	// are IPV4 and DUAL.
	ErrCodeNetworkTypeNotSupported = "NetworkTypeNotSupported"

	// ErrCodeOptionGroupAlreadyExistsFault for service response error code
	// "OptionGroupAlreadyExistsFault".
	//
	// The option group you are trying to create already exists.
	ErrCodeOptionGroupAlreadyExistsFault = "OptionGroupAlreadyExistsFault"

	// ErrCodeOptionGroupNotFoundFault for service response error code
	// "OptionGroupNotFoundFault".
	//
	// The specified option group could not be found.
	ErrCodeOptionGroupNotFoundFault = "OptionGroupNotFoundFault"

	// ErrCodeOptionGroupQuotaExceededFault for service response error code
	// "OptionGroupQuotaExceededFault".
	//
	// The quota of 20 option groups was exceeded for this Amazon Web Services account.
	ErrCodeOptionGroupQuotaExceededFault = "OptionGroupQuotaExceededFault"

	// ErrCodePointInTimeRestoreNotEnabledFault for service response error code
	// "PointInTimeRestoreNotEnabled".
	//
	// SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod
	// equal to 0.
	ErrCodePointInTimeRestoreNotEnabledFault = "PointInTimeRestoreNotEnabled"

	// ErrCodeProvisionedIopsNotAvailableInAZFault for service response error code
	// "ProvisionedIopsNotAvailableInAZFault".
	//
	// Provisioned IOPS not available in the specified Availability Zone.
	ErrCodeProvisionedIopsNotAvailableInAZFault = "ProvisionedIopsNotAvailableInAZFault"

	// ErrCodeReservedDBInstanceAlreadyExistsFault for service response error code
	// "ReservedDBInstanceAlreadyExists".
	//
	// User already has a reservation with the given identifier.
	ErrCodeReservedDBInstanceAlreadyExistsFault = "ReservedDBInstanceAlreadyExists"

	// ErrCodeReservedDBInstanceNotFoundFault for service response error code
	// "ReservedDBInstanceNotFound".
	//
	// The specified reserved DB Instance not found.
	ErrCodeReservedDBInstanceNotFoundFault = "ReservedDBInstanceNotFound"

	// ErrCodeReservedDBInstanceQuotaExceededFault for service response error code
	// "ReservedDBInstanceQuotaExceeded".
	//
	// Request would exceed the user's DB Instance quota.
	ErrCodeReservedDBInstanceQuotaExceededFault = "ReservedDBInstanceQuotaExceeded"

	// ErrCodeReservedDBInstancesOfferingNotFoundFault for service response error code
	// "ReservedDBInstancesOfferingNotFound".
	//
	// Specified offering does not exist.
	ErrCodeReservedDBInstancesOfferingNotFoundFault = "ReservedDBInstancesOfferingNotFound"

	// ErrCodeResourceNotFoundFault for service response error code
	// "ResourceNotFoundFault".
	//
	// The specified resource ID was not found.
	ErrCodeResourceNotFoundFault = "ResourceNotFoundFault"

	// ErrCodeSNSInvalidTopicFault for service response error code
	// "SNSInvalidTopic".
	//
	// SNS has responded that there is a problem with the SNS topic specified.
	ErrCodeSNSInvalidTopicFault = "SNSInvalidTopic"

	// ErrCodeSNSNoAuthorizationFault for service response error code
	// "SNSNoAuthorization".
	//
	// You do not have permission to publish to the SNS topic ARN.
	ErrCodeSNSNoAuthorizationFault = "SNSNoAuthorization"

	// ErrCodeSNSTopicArnNotFoundFault for service response error code
	// "SNSTopicArnNotFound".
	//
	// The SNS topic ARN does not exist.
	ErrCodeSNSTopicArnNotFoundFault = "SNSTopicArnNotFound"

	// ErrCodeSharedSnapshotQuotaExceededFault for service response error code
	// "SharedSnapshotQuotaExceeded".
	//
	// You have exceeded the maximum number of accounts that you can share a manual
	// DB snapshot with.
	ErrCodeSharedSnapshotQuotaExceededFault = "SharedSnapshotQuotaExceeded"

	// ErrCodeSnapshotQuotaExceededFault for service response error code
	// "SnapshotQuotaExceeded".
	//
	// The request would result in the user exceeding the allowed number of DB snapshots.
	ErrCodeSnapshotQuotaExceededFault = "SnapshotQuotaExceeded"

	// ErrCodeSourceNotFoundFault for service response error code
	// "SourceNotFound".
	//
	// The requested source could not be found.
	ErrCodeSourceNotFoundFault = "SourceNotFound"

	// ErrCodeStorageQuotaExceededFault for service response error code
	// "StorageQuotaExceeded".
	//
	// The request would result in the user exceeding the allowed amount of storage
	// available across all DB instances.
	ErrCodeStorageQuotaExceededFault = "StorageQuotaExceeded"

	// ErrCodeStorageTypeNotSupportedFault for service response error code
	// "StorageTypeNotSupported".
	//
	// Storage of the StorageType specified can't be associated with the DB instance.
	ErrCodeStorageTypeNotSupportedFault = "StorageTypeNotSupported"

	// ErrCodeSubnetAlreadyInUse for service response error code
	// "SubnetAlreadyInUse".
	//
	// The DB subnet is already in use in the Availability Zone.
	ErrCodeSubnetAlreadyInUse = "SubnetAlreadyInUse"

	// ErrCodeSubscriptionAlreadyExistFault for service response error code
	// "SubscriptionAlreadyExist".
	//
	// The supplied subscription name already exists.
	ErrCodeSubscriptionAlreadyExistFault = "SubscriptionAlreadyExist"

	// ErrCodeSubscriptionCategoryNotFoundFault for service response error code
	// "SubscriptionCategoryNotFound".
	//
	// The supplied category does not exist.
	ErrCodeSubscriptionCategoryNotFoundFault = "SubscriptionCategoryNotFound"

	// ErrCodeSubscriptionNotFoundFault for service response error code
	// "SubscriptionNotFound".
	//
	// The subscription name does not exist.
	ErrCodeSubscriptionNotFoundFault = "SubscriptionNotFound"
)
View Source
const (
	ServiceName = "rds"       // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "RDS"       // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// AuthSchemeSecrets is a AuthScheme enum value
	AuthSchemeSecrets = "SECRETS"
)

Variables

This section is empty.

Functions

func ActivityStreamMode_Values added in v1.34.3

func ActivityStreamMode_Values() []string

ActivityStreamMode_Values returns all elements of the ActivityStreamMode enum

func ActivityStreamPolicyStatus_Values added in v1.44.61

func ActivityStreamPolicyStatus_Values() []string

ActivityStreamPolicyStatus_Values returns all elements of the ActivityStreamPolicyStatus enum

func ActivityStreamStatus_Values added in v1.34.3

func ActivityStreamStatus_Values() []string

ActivityStreamStatus_Values returns all elements of the ActivityStreamStatus enum

func ApplyMethod_Values added in v1.34.3

func ApplyMethod_Values() []string

ApplyMethod_Values returns all elements of the ApplyMethod enum

func AuditPolicyState_Values added in v1.44.61

func AuditPolicyState_Values() []string

AuditPolicyState_Values returns all elements of the AuditPolicyState enum

func AuthScheme_Values added in v1.34.3

func AuthScheme_Values() []string

AuthScheme_Values returns all elements of the AuthScheme enum

func AutomationMode_Values added in v1.41.10

func AutomationMode_Values() []string

AutomationMode_Values returns all elements of the AutomationMode enum

func CustomEngineVersionStatus_Values added in v1.41.10

func CustomEngineVersionStatus_Values() []string

CustomEngineVersionStatus_Values returns all elements of the CustomEngineVersionStatus enum

func DBProxyEndpointStatus_Values added in v1.37.27

func DBProxyEndpointStatus_Values() []string

DBProxyEndpointStatus_Values returns all elements of the DBProxyEndpointStatus enum

func DBProxyEndpointTargetRole_Values added in v1.37.27

func DBProxyEndpointTargetRole_Values() []string

DBProxyEndpointTargetRole_Values returns all elements of the DBProxyEndpointTargetRole enum

func DBProxyStatus_Values added in v1.34.3

func DBProxyStatus_Values() []string

DBProxyStatus_Values returns all elements of the DBProxyStatus enum

func EngineFamily_Values added in v1.34.3

func EngineFamily_Values() []string

EngineFamily_Values returns all elements of the EngineFamily enum

func FailoverStatus_Values added in v1.37.9

func FailoverStatus_Values() []string

FailoverStatus_Values returns all elements of the FailoverStatus enum

func IAMAuthMode_Values added in v1.34.3

func IAMAuthMode_Values() []string

IAMAuthMode_Values returns all elements of the IAMAuthMode enum

func ReplicaMode_Values added in v1.34.4

func ReplicaMode_Values() []string

ReplicaMode_Values returns all elements of the ReplicaMode enum

func SourceType_Values added in v1.34.3

func SourceType_Values() []string

SourceType_Values returns all elements of the SourceType enum

func TargetHealthReason_Values added in v1.34.3

func TargetHealthReason_Values() []string

TargetHealthReason_Values returns all elements of the TargetHealthReason enum

func TargetRole_Values added in v1.37.27

func TargetRole_Values() []string

TargetRole_Values returns all elements of the TargetRole enum

func TargetState_Values added in v1.34.3

func TargetState_Values() []string

TargetState_Values returns all elements of the TargetState enum

func TargetType_Values added in v1.34.3

func TargetType_Values() []string

TargetType_Values returns all elements of the TargetType enum

func WriteForwardingStatus_Values added in v1.34.3

func WriteForwardingStatus_Values() []string

WriteForwardingStatus_Values returns all elements of the WriteForwardingStatus enum

Types

type AccountQuota

type AccountQuota struct {

	// The name of the Amazon RDS quota for this Amazon Web Services account.
	AccountQuotaName *string `type:"string"`

	// The maximum allowed value for the quota.
	Max *int64 `type:"long"`

	// The amount currently used toward the quota maximum.
	Used *int64 `type:"long"`
	// contains filtered or unexported fields
}

Describes a quota for an Amazon Web Services account.

The following are account quotas:

  • AllocatedStorage - The total allocated storage per account, in GiB. The used value is the total allocated storage in the account, in GiB.

  • AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. The used value is the highest number of ingress rules in a DB security group in the account. Other DB security groups in the account might have a lower number of ingress rules.

  • CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. The used value is the highest number of custom endpoints in a DB clusters in the account. Other DB clusters in the account might have a lower number of custom endpoints.

  • DBClusterParameterGroups - The number of DB cluster parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB cluster parameter groups in the account.

  • DBClusterRoles - The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. The used value is the highest number of associated IAM roles for a DB cluster in the account. Other DB clusters in the account might have a lower number of associated IAM roles.

  • DBClusters - The number of DB clusters per account. The used value is the count of DB clusters in the account.

  • DBInstanceRoles - The number of associated IAM roles per DB instance. The used value is the highest number of associated IAM roles for a DB instance in the account. Other DB instances in the account might have a lower number of associated IAM roles.

  • DBInstances - The number of DB instances per account. The used value is the count of the DB instances in the account. Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB instances apply to this quota.

  • DBParameterGroups - The number of DB parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB parameter groups in the account.

  • DBSecurityGroups - The number of DB security groups (not VPC security groups) per account, excluding the default security group. The used value is the count of nondefault DB security groups in the account.

  • DBSubnetGroups - The number of DB subnet groups per account. The used value is the count of the DB subnet groups in the account.

  • EventSubscriptions - The number of event subscriptions per account. The used value is the count of the event subscriptions in the account.

  • ManualClusterSnapshots - The number of manual DB cluster snapshots per account. The used value is the count of the manual DB cluster snapshots in the account.

  • ManualSnapshots - The number of manual DB instance snapshots per account. The used value is the count of the manual DB instance snapshots in the account.

  • OptionGroups - The number of DB option groups per account, excluding default option groups. The used value is the count of nondefault DB option groups in the account.

  • ReadReplicasPerMaster - The number of read replicas per DB instance. The used value is the highest number of read replicas for a DB instance in the account. Other DB instances in the account might have a lower number of read replicas.

  • ReservedDBInstances - The number of reserved DB instances per account. The used value is the count of the active reserved DB instances in the account.

  • SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. The used value is highest number of subnets for a DB subnet group in the account. Other DB subnet groups in the account might have a lower number of subnets.

For more information, see Quotas for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html) in the Amazon RDS User Guide and Quotas for Amazon Aurora (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html) in the Amazon Aurora User Guide.

func (AccountQuota) GoString added in v0.6.5

func (s AccountQuota) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountQuota) SetAccountQuotaName added in v1.5.0

func (s *AccountQuota) SetAccountQuotaName(v string) *AccountQuota

SetAccountQuotaName sets the AccountQuotaName field's value.

func (*AccountQuota) SetMax added in v1.5.0

func (s *AccountQuota) SetMax(v int64) *AccountQuota

SetMax sets the Max field's value.

func (*AccountQuota) SetUsed added in v1.5.0

func (s *AccountQuota) SetUsed(v int64) *AccountQuota

SetUsed sets the Used field's value.

func (AccountQuota) String added in v0.6.5

func (s AccountQuota) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AddRoleToDBClusterInput added in v1.4.19

type AddRoleToDBClusterInput struct {

	// The name of the DB cluster to associate the IAM role with.
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The name of the feature for the DB cluster that the IAM role is to be associated
	// with. For information about supported feature names, see DBEngineVersion.
	FeatureName *string `type:"string"`

	// The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora
	// DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AddRoleToDBClusterInput) GoString added in v1.4.19

func (s AddRoleToDBClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddRoleToDBClusterInput) SetDBClusterIdentifier added in v1.5.0

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*AddRoleToDBClusterInput) SetFeatureName added in v1.19.16

SetFeatureName sets the FeatureName field's value.

func (*AddRoleToDBClusterInput) SetRoleArn added in v1.5.0

SetRoleArn sets the RoleArn field's value.

func (AddRoleToDBClusterInput) String added in v1.4.19

func (s AddRoleToDBClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddRoleToDBClusterInput) Validate added in v1.4.19

func (s *AddRoleToDBClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AddRoleToDBClusterOutput added in v1.4.19

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

func (AddRoleToDBClusterOutput) GoString added in v1.4.19

func (s AddRoleToDBClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AddRoleToDBClusterOutput) String added in v1.4.19

func (s AddRoleToDBClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AddRoleToDBInstanceInput added in v1.16.25

type AddRoleToDBInstanceInput struct {

	// The name of the DB instance to associate the IAM role with.
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`

	// The name of the feature for the DB instance that the IAM role is to be associated
	// with. For information about supported feature names, see DBEngineVersion.
	//
	// FeatureName is a required field
	FeatureName *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance,
	// for example arn:aws:iam::123456789012:role/AccessRole.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AddRoleToDBInstanceInput) GoString added in v1.16.25

func (s AddRoleToDBInstanceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddRoleToDBInstanceInput) SetDBInstanceIdentifier added in v1.16.25

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*AddRoleToDBInstanceInput) SetFeatureName added in v1.16.25

SetFeatureName sets the FeatureName field's value.

func (*AddRoleToDBInstanceInput) SetRoleArn added in v1.16.25

SetRoleArn sets the RoleArn field's value.

func (AddRoleToDBInstanceInput) String added in v1.16.25

func (s AddRoleToDBInstanceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddRoleToDBInstanceInput) Validate added in v1.16.25

func (s *AddRoleToDBInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AddRoleToDBInstanceOutput added in v1.16.25

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

func (AddRoleToDBInstanceOutput) GoString added in v1.16.25

func (s AddRoleToDBInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AddRoleToDBInstanceOutput) String added in v1.16.25

func (s AddRoleToDBInstanceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AddSourceIdentifierToSubscriptionInput

type AddSourceIdentifierToSubscriptionInput struct {

	// The identifier of the event source to be added.
	//
	// Constraints:
	//
	//    * If the source type is a DB instance, a DBInstanceIdentifier value must
	//    be supplied.
	//
	//    * If the source type is a DB cluster, a DBClusterIdentifier value must
	//    be supplied.
	//
	//    * If the source type is a DB parameter group, a DBParameterGroupName value
	//    must be supplied.
	//
	//    * If the source type is a DB security group, a DBSecurityGroupName value
	//    must be supplied.
	//
	//    * If the source type is a DB snapshot, a DBSnapshotIdentifier value must
	//    be supplied.
	//
	//    * If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier
	//    value must be supplied.
	//
	//    * If the source type is an RDS Proxy, a DBProxyName value must be supplied.
	//
	// SourceIdentifier is a required field
	SourceIdentifier *string `type:"string" required:"true"`

	// The name of the RDS event notification subscription you want to add a source
	// identifier to.
	//
	// SubscriptionName is a required field
	SubscriptionName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AddSourceIdentifierToSubscriptionInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddSourceIdentifierToSubscriptionInput) SetSourceIdentifier added in v1.5.0

SetSourceIdentifier sets the SourceIdentifier field's value.

func (*AddSourceIdentifierToSubscriptionInput) SetSubscriptionName added in v1.5.0

SetSubscriptionName sets the SubscriptionName field's value.

func (AddSourceIdentifierToSubscriptionInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddSourceIdentifierToSubscriptionInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type AddSourceIdentifierToSubscriptionOutput

type AddSourceIdentifierToSubscriptionOutput struct {

	// Contains the results of a successful invocation of the DescribeEventSubscriptions
	// action.
	EventSubscription *EventSubscription `type:"structure"`
	// contains filtered or unexported fields
}

func (AddSourceIdentifierToSubscriptionOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddSourceIdentifierToSubscriptionOutput) SetEventSubscription added in v1.5.0

SetEventSubscription sets the EventSubscription field's value.

func (AddSourceIdentifierToSubscriptionOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AddTagsToResourceInput

type AddTagsToResourceInput struct {

	// The Amazon RDS resource that the tags are added to. This value is an Amazon
	// Resource Name (ARN). For information about creating an ARN, see Constructing
	// an RDS Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing).
	//
	// ResourceName is a required field
	ResourceName *string `type:"string" required:"true"`

	// The tags to be assigned to the Amazon RDS resource.
	//
	// Tags is a required field
	Tags []*Tag `locationNameList:"Tag" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (AddTagsToResourceInput) GoString added in v0.6.5

func (s AddTagsToResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddTagsToResourceInput) SetResourceName added in v1.5.0

func (s *AddTagsToResourceInput) SetResourceName(v string) *AddTagsToResourceInput

SetResourceName sets the ResourceName field's value.

func (*AddTagsToResourceInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (AddTagsToResourceInput) String added in v0.6.5

func (s AddTagsToResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddTagsToResourceInput) Validate added in v1.1.21

func (s *AddTagsToResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AddTagsToResourceOutput

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

func (AddTagsToResourceOutput) GoString added in v0.6.5

func (s AddTagsToResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AddTagsToResourceOutput) String added in v0.6.5

func (s AddTagsToResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ApplyPendingMaintenanceActionInput

type ApplyPendingMaintenanceActionInput struct {

	// The pending maintenance action to apply to this resource.
	//
	// Valid values: system-update, db-upgrade, hardware-maintenance, ca-certificate-rotation
	//
	// ApplyAction is a required field
	ApplyAction *string `type:"string" required:"true"`

	// A value that specifies the type of opt-in request, or undoes an opt-in request.
	// An opt-in request of type immediate can't be undone.
	//
	// Valid values:
	//
	//    * immediate - Apply the maintenance action immediately.
	//
	//    * next-maintenance - Apply the maintenance action during the next maintenance
	//    window for the resource.
	//
	//    * undo-opt-in - Cancel any existing next-maintenance opt-in requests.
	//
	// OptInType is a required field
	OptInType *string `type:"string" required:"true"`

	// The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance
	// action applies to. For information about creating an ARN, see Constructing
	// an RDS Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing).
	//
	// ResourceIdentifier is a required field
	ResourceIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ApplyPendingMaintenanceActionInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ApplyPendingMaintenanceActionInput) SetApplyAction added in v1.5.0

SetApplyAction sets the ApplyAction field's value.

func (*ApplyPendingMaintenanceActionInput) SetOptInType added in v1.5.0

SetOptInType sets the OptInType field's value.

func (*ApplyPendingMaintenanceActionInput) SetResourceIdentifier added in v1.5.0

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (ApplyPendingMaintenanceActionInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ApplyPendingMaintenanceActionInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type ApplyPendingMaintenanceActionOutput

type ApplyPendingMaintenanceActionOutput struct {

	// Describes the pending maintenance actions for a resource.
	ResourcePendingMaintenanceActions *ResourcePendingMaintenanceActions `type:"structure"`
	// contains filtered or unexported fields
}

func (ApplyPendingMaintenanceActionOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ApplyPendingMaintenanceActionOutput) SetResourcePendingMaintenanceActions added in v1.5.0

SetResourcePendingMaintenanceActions sets the ResourcePendingMaintenanceActions field's value.

func (ApplyPendingMaintenanceActionOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AuthorizeDBSecurityGroupIngressInput

type AuthorizeDBSecurityGroupIngressInput struct {

	// The IP range to authorize.
	CIDRIP *string `type:"string"`

	// The name of the DB security group to add authorization to.
	//
	// DBSecurityGroupName is a required field
	DBSecurityGroupName *string `type:"string" required:"true"`

	// Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId
	// must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName
	// or EC2SecurityGroupId must be provided.
	EC2SecurityGroupId *string `type:"string"`

	// Name of the EC2 security group to authorize. For VPC DB security groups,
	// EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and
	// either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
	EC2SecurityGroupName *string `type:"string"`

	// Amazon Web Services account number of the owner of the EC2 security group
	// specified in the EC2SecurityGroupName parameter. The Amazon Web Services
	// access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId
	// must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName
	// or EC2SecurityGroupId must be provided.
	EC2SecurityGroupOwnerId *string `type:"string"`
	// contains filtered or unexported fields
}

func (AuthorizeDBSecurityGroupIngressInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthorizeDBSecurityGroupIngressInput) SetCIDRIP added in v1.5.0

SetCIDRIP sets the CIDRIP field's value.

func (*AuthorizeDBSecurityGroupIngressInput) SetDBSecurityGroupName added in v1.5.0

SetDBSecurityGroupName sets the DBSecurityGroupName field's value.

func (*AuthorizeDBSecurityGroupIngressInput) SetEC2SecurityGroupId added in v1.5.0

SetEC2SecurityGroupId sets the EC2SecurityGroupId field's value.

func (*AuthorizeDBSecurityGroupIngressInput) SetEC2SecurityGroupName added in v1.5.0

SetEC2SecurityGroupName sets the EC2SecurityGroupName field's value.

func (*AuthorizeDBSecurityGroupIngressInput) SetEC2SecurityGroupOwnerId added in v1.5.0

SetEC2SecurityGroupOwnerId sets the EC2SecurityGroupOwnerId field's value.

func (AuthorizeDBSecurityGroupIngressInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthorizeDBSecurityGroupIngressInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type AuthorizeDBSecurityGroupIngressOutput

type AuthorizeDBSecurityGroupIngressOutput struct {

	// Contains the details for an Amazon RDS DB security group.
	//
	// This data type is used as a response element in the DescribeDBSecurityGroups
	// action.
	DBSecurityGroup *DBSecurityGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (AuthorizeDBSecurityGroupIngressOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthorizeDBSecurityGroupIngressOutput) SetDBSecurityGroup added in v1.5.0

SetDBSecurityGroup sets the DBSecurityGroup field's value.

func (AuthorizeDBSecurityGroupIngressOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AvailabilityZone

type AvailabilityZone struct {

	// The name of the Availability Zone.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Contains Availability Zone information.

This data type is used as an element in the OrderableDBInstanceOption data type.

func (AvailabilityZone) GoString added in v0.6.5

func (s AvailabilityZone) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AvailabilityZone) SetName added in v1.5.0

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

SetName sets the Name field's value.

func (AvailabilityZone) String added in v0.6.5

func (s AvailabilityZone) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AvailableProcessorFeature added in v1.14.1

type AvailableProcessorFeature struct {

	// The allowed values for the processor feature of the DB instance class.
	AllowedValues *string `type:"string"`

	// The default value for the processor feature of the DB instance class.
	DefaultValue *string `type:"string"`

	// The name of the processor feature. Valid names are coreCount and threadsPerCore.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the available processor feature information for the DB instance class of a DB instance.

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.

func (AvailableProcessorFeature) GoString added in v1.14.1

func (s AvailableProcessorFeature) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AvailableProcessorFeature) SetAllowedValues added in v1.14.1

SetAllowedValues sets the AllowedValues field's value.

func (*AvailableProcessorFeature) SetDefaultValue added in v1.14.1

SetDefaultValue sets the DefaultValue field's value.

func (*AvailableProcessorFeature) SetName added in v1.14.1

SetName sets the Name field's value.

func (AvailableProcessorFeature) String added in v1.14.1

func (s AvailableProcessorFeature) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BacktrackDBClusterInput added in v1.13.45

type BacktrackDBClusterInput struct {

	// The timestamp of the time to backtrack the DB cluster to, specified in ISO
	// 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia
	// page. (http://en.wikipedia.org/wiki/ISO_8601)
	//
	// If the specified time isn't a consistent time for the DB cluster, Aurora
	// automatically chooses the nearest possible consistent time for the DB cluster.
	//
	// Constraints:
	//
	//    * Must contain a valid ISO 8601 timestamp.
	//
	//    * Can't contain a timestamp set in the future.
	//
	// Example: 2017-07-08T18:00Z
	//
	// BacktrackTo is a required field
	BacktrackTo *time.Time `type:"timestamp" required:"true"`

	// The DB cluster identifier of the DB cluster to be backtracked. This parameter
	// is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 alphanumeric characters or hyphens.
	//
	//    * First character must be a letter.
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens.
	//
	// Example: my-cluster1
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// A value that indicates whether to force the DB cluster to backtrack when
	// binary logging is enabled. Otherwise, an error occurs when binary logging
	// is enabled.
	Force *bool `type:"boolean"`

	// A value that indicates whether to backtrack the DB cluster to the earliest
	// possible backtrack time when BacktrackTo is set to a timestamp earlier than
	// the earliest backtrack time. When this parameter is disabled and BacktrackTo
	// is set to a timestamp earlier than the earliest backtrack time, an error
	// occurs.
	UseEarliestTimeOnPointInTimeUnavailable *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (BacktrackDBClusterInput) GoString added in v1.13.45

func (s BacktrackDBClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BacktrackDBClusterInput) SetBacktrackTo added in v1.13.45

SetBacktrackTo sets the BacktrackTo field's value.

func (*BacktrackDBClusterInput) SetDBClusterIdentifier added in v1.13.45

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*BacktrackDBClusterInput) SetForce added in v1.13.45

SetForce sets the Force field's value.

func (*BacktrackDBClusterInput) SetUseEarliestTimeOnPointInTimeUnavailable added in v1.13.45

func (s *BacktrackDBClusterInput) SetUseEarliestTimeOnPointInTimeUnavailable(v bool) *BacktrackDBClusterInput

SetUseEarliestTimeOnPointInTimeUnavailable sets the UseEarliestTimeOnPointInTimeUnavailable field's value.

func (BacktrackDBClusterInput) String added in v1.13.45

func (s BacktrackDBClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BacktrackDBClusterInput) Validate added in v1.13.45

func (s *BacktrackDBClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BacktrackDBClusterOutput added in v1.13.45

type BacktrackDBClusterOutput struct {

	// Contains the backtrack identifier.
	BacktrackIdentifier *string `type:"string"`

	// The timestamp of the time at which the backtrack was requested.
	BacktrackRequestCreationTime *time.Time `type:"timestamp"`

	// The timestamp of the time to which the DB cluster was backtracked.
	BacktrackTo *time.Time `type:"timestamp"`

	// The timestamp of the time from which the DB cluster was backtracked.
	BacktrackedFrom *time.Time `type:"timestamp"`

	// Contains a user-supplied DB cluster identifier. This identifier is the unique
	// key that identifies a DB cluster.
	DBClusterIdentifier *string `type:"string"`

	// The status of the backtrack. This property returns one of the following values:
	//
	//    * applying - The backtrack is currently being applied to or rolled back
	//    from the DB cluster.
	//
	//    * completed - The backtrack has successfully been applied to or rolled
	//    back from the DB cluster.
	//
	//    * failed - An error occurred while the backtrack was applied to or rolled
	//    back from the DB cluster.
	//
	//    * pending - The backtrack is currently pending application to or rollback
	//    from the DB cluster.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (BacktrackDBClusterOutput) GoString added in v1.13.45

func (s BacktrackDBClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BacktrackDBClusterOutput) SetBacktrackIdentifier added in v1.13.45

func (s *BacktrackDBClusterOutput) SetBacktrackIdentifier(v string) *BacktrackDBClusterOutput

SetBacktrackIdentifier sets the BacktrackIdentifier field's value.

func (*BacktrackDBClusterOutput) SetBacktrackRequestCreationTime added in v1.13.45

func (s *BacktrackDBClusterOutput) SetBacktrackRequestCreationTime(v time.Time) *BacktrackDBClusterOutput

SetBacktrackRequestCreationTime sets the BacktrackRequestCreationTime field's value.

func (*BacktrackDBClusterOutput) SetBacktrackTo added in v1.13.45

SetBacktrackTo sets the BacktrackTo field's value.

func (*BacktrackDBClusterOutput) SetBacktrackedFrom added in v1.13.45

func (s *BacktrackDBClusterOutput) SetBacktrackedFrom(v time.Time) *BacktrackDBClusterOutput

SetBacktrackedFrom sets the BacktrackedFrom field's value.

func (*BacktrackDBClusterOutput) SetDBClusterIdentifier added in v1.13.45

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*BacktrackDBClusterOutput) SetStatus added in v1.13.45

SetStatus sets the Status field's value.

func (BacktrackDBClusterOutput) String added in v1.13.45

func (s BacktrackDBClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CancelExportTaskInput added in v1.28.8

type CancelExportTaskInput struct {

	// The identifier of the snapshot export task to cancel.
	//
	// ExportTaskIdentifier is a required field
	ExportTaskIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelExportTaskInput) GoString added in v1.28.8

func (s CancelExportTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelExportTaskInput) SetExportTaskIdentifier added in v1.28.8

func (s *CancelExportTaskInput) SetExportTaskIdentifier(v string) *CancelExportTaskInput

SetExportTaskIdentifier sets the ExportTaskIdentifier field's value.

func (CancelExportTaskInput) String added in v1.28.8

func (s CancelExportTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelExportTaskInput) Validate added in v1.28.8

func (s *CancelExportTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelExportTaskOutput added in v1.28.8

type CancelExportTaskOutput struct {

	// The data exported from the snapshot. Valid values are the following:
	//
	//    * database - Export all the data from a specified database.
	//
	//    * database.table table-name - Export a table of the snapshot. This format
	//    is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
	//
	//    * database.schema schema-name - Export a database schema of the snapshot.
	//    This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
	//
	//    * database.schema.table table-name - Export a table of the database schema.
	//    This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
	ExportOnly []*string `type:"list"`

	// A unique identifier for the snapshot export task. This ID isn't an identifier
	// for the Amazon S3 bucket where the snapshot is exported to.
	ExportTaskIdentifier *string `type:"string"`

	// The reason the export failed, if it failed.
	FailureCause *string `type:"string"`

	// The name of the IAM role that is used to write to Amazon S3 when exporting
	// a snapshot.
	IamRoleArn *string `type:"string"`

	// The key identifier of the Amazon Web Services KMS key that is used to encrypt
	// the snapshot when it's exported to Amazon S3. The KMS key identifier is its
	// key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot
	// export must have encryption and decryption permissions to use this KMS key.
	KmsKeyId *string `type:"string"`

	// The progress of the snapshot export task as a percentage.
	PercentProgress *int64 `type:"integer"`

	// The Amazon S3 bucket that the snapshot is exported to.
	S3Bucket *string `type:"string"`

	// The Amazon S3 bucket prefix that is the file name and path of the exported
	// snapshot.
	S3Prefix *string `type:"string"`

	// The time that the snapshot was created.
	SnapshotTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
	SourceArn *string `type:"string"`

	// The progress status of the export task.
	Status *string `type:"string"`

	// The time that the snapshot export task completed.
	TaskEndTime *time.Time `type:"timestamp"`

	// The time that the snapshot export task started.
	TaskStartTime *time.Time `type:"timestamp"`

	// The total amount of data exported, in gigabytes.
	TotalExtractedDataInGB *int64 `type:"integer"`

	// A warning about the snapshot export task.
	WarningMessage *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the details of a snapshot export to Amazon S3.

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

func (CancelExportTaskOutput) GoString added in v1.28.8

func (s CancelExportTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelExportTaskOutput) SetExportOnly added in v1.28.8

func (s *CancelExportTaskOutput) SetExportOnly(v []*string) *CancelExportTaskOutput

SetExportOnly sets the ExportOnly field's value.

func (*CancelExportTaskOutput) SetExportTaskIdentifier added in v1.28.8

func (s *CancelExportTaskOutput) SetExportTaskIdentifier(v string) *CancelExportTaskOutput

SetExportTaskIdentifier sets the ExportTaskIdentifier field's value.

func (*CancelExportTaskOutput) SetFailureCause added in v1.28.8

func (s *CancelExportTaskOutput) SetFailureCause(v string) *CancelExportTaskOutput

SetFailureCause sets the FailureCause field's value.

func (*CancelExportTaskOutput) SetIamRoleArn added in v1.28.8

SetIamRoleArn sets the IamRoleArn field's value.

func (*CancelExportTaskOutput) SetKmsKeyId added in v1.28.8

SetKmsKeyId sets the KmsKeyId field's value.

func (*CancelExportTaskOutput) SetPercentProgress added in v1.28.8

func (s *CancelExportTaskOutput) SetPercentProgress(v int64) *CancelExportTaskOutput

SetPercentProgress sets the PercentProgress field's value.

func (*CancelExportTaskOutput) SetS3Bucket added in v1.28.8

SetS3Bucket sets the S3Bucket field's value.

func (*CancelExportTaskOutput) SetS3Prefix added in v1.28.8

SetS3Prefix sets the S3Prefix field's value.

func (*CancelExportTaskOutput) SetSnapshotTime added in v1.28.8

func (s *CancelExportTaskOutput) SetSnapshotTime(v time.Time) *CancelExportTaskOutput

SetSnapshotTime sets the SnapshotTime field's value.

func (*CancelExportTaskOutput) SetSourceArn added in v1.28.8

SetSourceArn sets the SourceArn field's value.

func (*CancelExportTaskOutput) SetStatus added in v1.28.8

SetStatus sets the Status field's value.

func (*CancelExportTaskOutput) SetTaskEndTime added in v1.28.8

SetTaskEndTime sets the TaskEndTime field's value.

func (*CancelExportTaskOutput) SetTaskStartTime added in v1.28.8

func (s *CancelExportTaskOutput) SetTaskStartTime(v time.Time) *CancelExportTaskOutput

SetTaskStartTime sets the TaskStartTime field's value.

func (*CancelExportTaskOutput) SetTotalExtractedDataInGB added in v1.28.8

func (s *CancelExportTaskOutput) SetTotalExtractedDataInGB(v int64) *CancelExportTaskOutput

SetTotalExtractedDataInGB sets the TotalExtractedDataInGB field's value.

func (*CancelExportTaskOutput) SetWarningMessage added in v1.28.8

func (s *CancelExportTaskOutput) SetWarningMessage(v string) *CancelExportTaskOutput

SetWarningMessage sets the WarningMessage field's value.

func (CancelExportTaskOutput) String added in v1.28.8

func (s CancelExportTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Certificate

type Certificate struct {

	// The Amazon Resource Name (ARN) for the certificate.
	CertificateArn *string `type:"string"`

	// The unique key that identifies a certificate.
	CertificateIdentifier *string `type:"string"`

	// The type of the certificate.
	CertificateType *string `type:"string"`

	// Whether there is an override for the default certificate identifier.
	CustomerOverride *bool `type:"boolean"`

	// If there is an override for the default certificate identifier, when the
	// override expires.
	CustomerOverrideValidTill *time.Time `type:"timestamp"`

	// The thumbprint of the certificate.
	Thumbprint *string `type:"string"`

	// The starting date from which the certificate is valid.
	ValidFrom *time.Time `type:"timestamp"`

	// The final date that the certificate continues to be valid.
	ValidTill *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

A CA certificate for an Amazon Web Services account.

func (Certificate) GoString added in v0.6.5

func (s Certificate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Certificate) SetCertificateArn added in v1.5.0

func (s *Certificate) SetCertificateArn(v string) *Certificate

SetCertificateArn sets the CertificateArn field's value.

func (*Certificate) SetCertificateIdentifier added in v1.5.0

func (s *Certificate) SetCertificateIdentifier(v string) *Certificate

SetCertificateIdentifier sets the CertificateIdentifier field's value.

func (*Certificate) SetCertificateType added in v1.5.0

func (s *Certificate) SetCertificateType(v string) *Certificate

SetCertificateType sets the CertificateType field's value.

func (*Certificate) SetCustomerOverride added in v1.28.0

func (s *Certificate) SetCustomerOverride(v bool) *Certificate

SetCustomerOverride sets the CustomerOverride field's value.

func (*Certificate) SetCustomerOverrideValidTill added in v1.28.0

func (s *Certificate) SetCustomerOverrideValidTill(v time.Time) *Certificate

SetCustomerOverrideValidTill sets the CustomerOverrideValidTill field's value.

func (*Certificate) SetThumbprint added in v1.5.0

func (s *Certificate) SetThumbprint(v string) *Certificate

SetThumbprint sets the Thumbprint field's value.

func (*Certificate) SetValidFrom added in v1.5.0

func (s *Certificate) SetValidFrom(v time.Time) *Certificate

SetValidFrom sets the ValidFrom field's value.

func (*Certificate) SetValidTill added in v1.5.0

func (s *Certificate) SetValidTill(v time.Time) *Certificate

SetValidTill sets the ValidTill field's value.

func (Certificate) String added in v0.6.5

func (s Certificate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CharacterSet

type CharacterSet struct {

	// The description of the character set.
	CharacterSetDescription *string `type:"string"`

	// The name of the character set.
	CharacterSetName *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (CharacterSet) GoString added in v0.6.5

func (s CharacterSet) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CharacterSet) SetCharacterSetDescription added in v1.5.0

func (s *CharacterSet) SetCharacterSetDescription(v string) *CharacterSet

SetCharacterSetDescription sets the CharacterSetDescription field's value.

func (*CharacterSet) SetCharacterSetName added in v1.5.0

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

SetCharacterSetName sets the CharacterSetName field's value.

func (CharacterSet) String added in v0.6.5

func (s CharacterSet) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CloudwatchLogsExportConfiguration added in v1.12.63

type CloudwatchLogsExportConfiguration struct {

	// The list of log types to disable.
	DisableLogTypes []*string `type:"list"`

	// The list of log types to enable.
	EnableLogTypes []*string `type:"list"`
	// contains filtered or unexported fields
}

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used.

For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the Amazon RDS User Guide.

For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the Amazon Aurora User Guide.

func (CloudwatchLogsExportConfiguration) GoString added in v1.12.63

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloudwatchLogsExportConfiguration) SetDisableLogTypes added in v1.12.63

SetDisableLogTypes sets the DisableLogTypes field's value.

func (*CloudwatchLogsExportConfiguration) SetEnableLogTypes added in v1.12.63

SetEnableLogTypes sets the EnableLogTypes field's value.

func (CloudwatchLogsExportConfiguration) String added in v1.12.63

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClusterPendingModifiedValues added in v1.36.12

type ClusterPendingModifiedValues struct {

	// The DBClusterIdentifier value for the DB cluster.
	DBClusterIdentifier *string `type:"string"`

	// The database engine version.
	EngineVersion *string `type:"string"`

	// A value that indicates whether mapping of Amazon Web Services Identity and
	// Access Management (IAM) accounts to database accounts is enabled.
	IAMDatabaseAuthenticationEnabled *bool `type:"boolean"`

	// The master credentials for the DB cluster.
	MasterUserPassword *string `type:"string"`

	// A list of the log types whose configuration is still pending. In other words,
	// these log types are in the process of being activated or deactivated.
	PendingCloudwatchLogsExports *PendingCloudwatchLogsExports `type:"structure"`
	// contains filtered or unexported fields
}

This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

func (ClusterPendingModifiedValues) GoString added in v1.36.12

func (s ClusterPendingModifiedValues) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusterPendingModifiedValues) SetDBClusterIdentifier added in v1.36.12

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*ClusterPendingModifiedValues) SetEngineVersion added in v1.36.12

SetEngineVersion sets the EngineVersion field's value.

func (*ClusterPendingModifiedValues) SetIAMDatabaseAuthenticationEnabled added in v1.36.12

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

SetIAMDatabaseAuthenticationEnabled sets the IAMDatabaseAuthenticationEnabled field's value.

func (*ClusterPendingModifiedValues) SetMasterUserPassword added in v1.36.12

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*ClusterPendingModifiedValues) SetPendingCloudwatchLogsExports added in v1.36.12

SetPendingCloudwatchLogsExports sets the PendingCloudwatchLogsExports field's value.

func (ClusterPendingModifiedValues) String added in v1.36.12

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectionPoolConfiguration added in v1.25.47

type ConnectionPoolConfiguration struct {

	// The number of seconds for a proxy to wait for a connection to become available
	// in the connection pool. Only applies when the proxy has opened its maximum
	// number of connections and all connections are busy with client sessions.
	//
	// Default: 120
	//
	// Constraints: between 1 and 3600, or 0 representing unlimited
	ConnectionBorrowTimeout *int64 `type:"integer"`

	// One or more SQL statements for the proxy to run when opening each new database
	// connection. Typically used with SET statements to make sure that each connection
	// has identical settings such as time zone and character set. For multiple
	// statements, use semicolons as the separator. You can also include multiple
	// variables in a single SET statement, such as SET x=1, y=2.
	//
	// Default: no initialization query
	InitQuery *string `type:"string"`

	// The maximum size of the connection pool for each target in a target group.
	// The value is expressed as a percentage of the max_connections setting for
	// the RDS DB instance or Aurora DB cluster used by the target group.
	//
	// Default: 100
	//
	// Constraints: between 1 and 100
	MaxConnectionsPercent *int64 `type:"integer"`

	// Controls how actively the proxy closes idle database connections in the connection
	// pool. The value is expressed as a percentage of the max_connections setting
	// for the RDS DB instance or Aurora DB cluster used by the target group. With
	// a high value, the proxy leaves a high percentage of idle database connections
	// open. A low value causes the proxy to close more idle connections and return
	// them to the database.
	//
	// Default: 50
	//
	// Constraints: between 0 and MaxConnectionsPercent
	MaxIdleConnectionsPercent *int64 `type:"integer"`

	// Each item in the list represents a class of SQL operations that normally
	// cause all later statements in a session using a proxy to be pinned to the
	// same underlying database connection. Including an item in the list exempts
	// that class of SQL operations from the pinning behavior.
	//
	// Default: no session pinning filters
	SessionPinningFilters []*string `type:"list"`
	// contains filtered or unexported fields
}

Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup.

func (ConnectionPoolConfiguration) GoString added in v1.25.47

func (s ConnectionPoolConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionPoolConfiguration) SetConnectionBorrowTimeout added in v1.25.47

func (s *ConnectionPoolConfiguration) SetConnectionBorrowTimeout(v int64) *ConnectionPoolConfiguration

SetConnectionBorrowTimeout sets the ConnectionBorrowTimeout field's value.

func (*ConnectionPoolConfiguration) SetInitQuery added in v1.25.47

SetInitQuery sets the InitQuery field's value.

func (*ConnectionPoolConfiguration) SetMaxConnectionsPercent added in v1.25.47

func (s *ConnectionPoolConfiguration) SetMaxConnectionsPercent(v int64) *ConnectionPoolConfiguration

SetMaxConnectionsPercent sets the MaxConnectionsPercent field's value.

func (*ConnectionPoolConfiguration) SetMaxIdleConnectionsPercent added in v1.25.47

func (s *ConnectionPoolConfiguration) SetMaxIdleConnectionsPercent(v int64) *ConnectionPoolConfiguration

SetMaxIdleConnectionsPercent sets the MaxIdleConnectionsPercent field's value.

func (*ConnectionPoolConfiguration) SetSessionPinningFilters added in v1.25.47

func (s *ConnectionPoolConfiguration) SetSessionPinningFilters(v []*string) *ConnectionPoolConfiguration

SetSessionPinningFilters sets the SessionPinningFilters field's value.

func (ConnectionPoolConfiguration) String added in v1.25.47

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectionPoolConfigurationInfo added in v1.25.47

type ConnectionPoolConfigurationInfo struct {

	// The number of seconds for a proxy to wait for a connection to become available
	// in the connection pool. Only applies when the proxy has opened its maximum
	// number of connections and all connections are busy with client sessions.
	ConnectionBorrowTimeout *int64 `type:"integer"`

	// One or more SQL statements for the proxy to run when opening each new database
	// connection. Typically used with SET statements to make sure that each connection
	// has identical settings such as time zone and character set. This setting
	// is empty by default. For multiple statements, use semicolons as the separator.
	// You can also include multiple variables in a single SET statement, such as
	// SET x=1, y=2.
	InitQuery *string `type:"string"`

	// The maximum size of the connection pool for each target in a target group.
	// The value is expressed as a percentage of the max_connections setting for
	// the RDS DB instance or Aurora DB cluster used by the target group.
	MaxConnectionsPercent *int64 `type:"integer"`

	// Controls how actively the proxy closes idle database connections in the connection
	// pool. The value is expressed as a percentage of the max_connections setting
	// for the RDS DB instance or Aurora DB cluster used by the target group. With
	// a high value, the proxy leaves a high percentage of idle database connections
	// open. A low value causes the proxy to close more idle connections and return
	// them to the database.
	MaxIdleConnectionsPercent *int64 `type:"integer"`

	// Each item in the list represents a class of SQL operations that normally
	// cause all later statements in a session using a proxy to be pinned to the
	// same underlying database connection. Including an item in the list exempts
	// that class of SQL operations from the pinning behavior. Currently, the only
	// allowed value is EXCLUDE_VARIABLE_SETS.
	SessionPinningFilters []*string `type:"list"`
	// contains filtered or unexported fields
}

Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.

func (ConnectionPoolConfigurationInfo) GoString added in v1.25.47

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionPoolConfigurationInfo) SetConnectionBorrowTimeout added in v1.25.47

func (s *ConnectionPoolConfigurationInfo) SetConnectionBorrowTimeout(v int64) *ConnectionPoolConfigurationInfo

SetConnectionBorrowTimeout sets the ConnectionBorrowTimeout field's value.

func (*ConnectionPoolConfigurationInfo) SetInitQuery added in v1.25.47

SetInitQuery sets the InitQuery field's value.

func (*ConnectionPoolConfigurationInfo) SetMaxConnectionsPercent added in v1.25.47

SetMaxConnectionsPercent sets the MaxConnectionsPercent field's value.

func (*ConnectionPoolConfigurationInfo) SetMaxIdleConnectionsPercent added in v1.25.47

func (s *ConnectionPoolConfigurationInfo) SetMaxIdleConnectionsPercent(v int64) *ConnectionPoolConfigurationInfo

SetMaxIdleConnectionsPercent sets the MaxIdleConnectionsPercent field's value.

func (*ConnectionPoolConfigurationInfo) SetSessionPinningFilters added in v1.25.47

func (s *ConnectionPoolConfigurationInfo) SetSessionPinningFilters(v []*string) *ConnectionPoolConfigurationInfo

SetSessionPinningFilters sets the SessionPinningFilters field's value.

func (ConnectionPoolConfigurationInfo) String added in v1.25.47

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CopyDBClusterParameterGroupInput added in v1.2.5

type CopyDBClusterParameterGroupInput struct {

	// The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter
	// group. For information about creating an ARN, see Constructing an ARN for
	// Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing)
	// in the Amazon Aurora User Guide.
	//
	// Constraints:
	//
	//    * Must specify a valid DB cluster parameter group.
	//
	// SourceDBClusterParameterGroupIdentifier is a required field
	SourceDBClusterParameterGroupIdentifier *string `type:"string" required:"true"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// A description for the copied DB cluster parameter group.
	//
	// TargetDBClusterParameterGroupDescription is a required field
	TargetDBClusterParameterGroupDescription *string `type:"string" required:"true"`

	// The identifier for the copied DB cluster parameter group.
	//
	// Constraints:
	//
	//    * Can't be null, empty, or blank
	//
	//    * Must contain from 1 to 255 letters, numbers, or hyphens
	//
	//    * First character must be a letter
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens
	//
	// Example: my-cluster-param-group1
	//
	// TargetDBClusterParameterGroupIdentifier is a required field
	TargetDBClusterParameterGroupIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CopyDBClusterParameterGroupInput) GoString added in v1.2.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyDBClusterParameterGroupInput) SetSourceDBClusterParameterGroupIdentifier added in v1.5.0

func (s *CopyDBClusterParameterGroupInput) SetSourceDBClusterParameterGroupIdentifier(v string) *CopyDBClusterParameterGroupInput

SetSourceDBClusterParameterGroupIdentifier sets the SourceDBClusterParameterGroupIdentifier field's value.

func (*CopyDBClusterParameterGroupInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (*CopyDBClusterParameterGroupInput) SetTargetDBClusterParameterGroupDescription added in v1.5.0

func (s *CopyDBClusterParameterGroupInput) SetTargetDBClusterParameterGroupDescription(v string) *CopyDBClusterParameterGroupInput

SetTargetDBClusterParameterGroupDescription sets the TargetDBClusterParameterGroupDescription field's value.

func (*CopyDBClusterParameterGroupInput) SetTargetDBClusterParameterGroupIdentifier added in v1.5.0

func (s *CopyDBClusterParameterGroupInput) SetTargetDBClusterParameterGroupIdentifier(v string) *CopyDBClusterParameterGroupInput

SetTargetDBClusterParameterGroupIdentifier sets the TargetDBClusterParameterGroupIdentifier field's value.

func (CopyDBClusterParameterGroupInput) String added in v1.2.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyDBClusterParameterGroupInput) Validate added in v1.2.5

Validate inspects the fields of the type to determine if they are valid.

type CopyDBClusterParameterGroupOutput added in v1.2.5

type CopyDBClusterParameterGroupOutput struct {

	// Contains the details of an Amazon RDS DB cluster parameter group.
	//
	// This data type is used as a response element in the DescribeDBClusterParameterGroups
	// action.
	DBClusterParameterGroup *DBClusterParameterGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CopyDBClusterParameterGroupOutput) GoString added in v1.2.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyDBClusterParameterGroupOutput) SetDBClusterParameterGroup added in v1.5.0

SetDBClusterParameterGroup sets the DBClusterParameterGroup field's value.

func (CopyDBClusterParameterGroupOutput) String added in v1.2.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CopyDBClusterSnapshotInput added in v0.7.1

type CopyDBClusterSnapshotInput struct {

	// A value that indicates whether to copy all tags from the source DB cluster
	// snapshot to the target DB cluster snapshot. By default, tags are not copied.
	CopyTags *bool `type:"boolean"`

	// DestinationRegion is used for presigning the request to a given region.
	DestinationRegion *string `type:"string"`

	// The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot.
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the Amazon Web Services KMS key.
	//
	// If you copy an encrypted DB cluster snapshot from your Amazon Web Services
	// account, you can specify a value for KmsKeyId to encrypt the copy with a
	// new KMS key. If you don't specify a value for KmsKeyId, then the copy of
	// the DB cluster snapshot is encrypted with the same KMS key as the source
	// DB cluster snapshot.
	//
	// If you copy an encrypted DB cluster snapshot that is shared from another
	// Amazon Web Services account, then you must specify a value for KmsKeyId.
	//
	// To copy an encrypted DB cluster snapshot to another Amazon Web Services Region,
	// you must set KmsKeyId to the Amazon Web Services KMS key identifier you want
	// to use to encrypt the copy of the DB cluster snapshot in the destination
	// Amazon Web Services Region. KMS keys are specific to the Amazon Web Services
	// Region that they are created in, and you can't use KMS keys from one Amazon
	// Web Services Region in another Amazon Web Services Region.
	//
	// If you copy an unencrypted DB cluster snapshot and specify a value for the
	// KmsKeyId parameter, an error is returned.
	KmsKeyId *string `type:"string"`

	// When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud
	// (US) Region to another, the URL that contains a Signature Version 4 signed
	// request for the CopyDBClusterSnapshot API operation in the Amazon Web Services
	// Region that contains the source DB cluster snapshot to copy. Use the PreSignedUrl
	// parameter when copying an encrypted DB cluster snapshot from another Amazon
	// Web Services Region. Don't specify PreSignedUrl when copying an encrypted
	// DB cluster snapshot in the same Amazon Web Services Region.
	//
	// This setting applies only to Amazon Web Services GovCloud (US) Regions. It's
	// ignored in other Amazon Web Services Regions.
	//
	// The presigned URL must be a valid request for the CopyDBClusterSnapshot API
	// operation that can run in the source Amazon Web Services Region that contains
	// the encrypted DB cluster snapshot to copy. The presigned URL request must
	// contain the following parameter values:
	//
	//    * KmsKeyId - The KMS key identifier for the KMS key to use to encrypt
	//    the copy of the DB cluster snapshot in the destination Amazon Web Services
	//    Region. This is the same identifier for both the CopyDBClusterSnapshot
	//    operation that is called in the destination Amazon Web Services Region,
	//    and the operation contained in the presigned URL.
	//
	//    * DestinationRegion - The name of the Amazon Web Services Region that
	//    the DB cluster snapshot is to be created in.
	//
	//    * SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier
	//    for the encrypted DB cluster snapshot to be copied. This identifier must
	//    be in the Amazon Resource Name (ARN) format for the source Amazon Web
	//    Services Region. For example, if you are copying an encrypted DB cluster
	//    snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier
	//    looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
	//
	// To learn how to generate a Signature Version 4 signed request, see Authenticating
	// Requests: Using Query Parameters (Amazon Web Services Signature Version 4)
	// (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html)
	// and Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).
	//
	// If you are using an Amazon Web Services SDK tool or the CLI, you can specify
	// SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl
	// manually. Specifying SourceRegion autogenerates a presigned URL that is a
	// valid request for the operation that can run in the source Amazon Web Services
	// Region.
	PreSignedUrl *string `type:"string"`

	// The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.
	//
	// You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web
	// Services Region to another.
	//
	// Constraints:
	//
	//    * Must specify a valid system snapshot in the "available" state.
	//
	//    * If the source snapshot is in the same Amazon Web Services Region as
	//    the copy, specify a valid DB snapshot identifier.
	//
	//    * If the source snapshot is in a different Amazon Web Services Region
	//    than the copy, specify a valid DB cluster snapshot ARN. For more information,
	//    go to Copying Snapshots Across Amazon Web Services Regions (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html#USER_CopySnapshot.AcrossRegions)
	//    in the Amazon Aurora User Guide.
	//
	// Example: my-cluster-snapshot1
	//
	// SourceDBClusterSnapshotIdentifier is a required field
	SourceDBClusterSnapshotIdentifier *string `type:"string" required:"true"`

	// SourceRegion is the source region where the resource exists. This is not
	// sent over the wire and is only used for presigning. This value should always
	// have the same region as the source ARN.
	SourceRegion *string `type:"string" ignore:"true"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// The identifier of the new DB cluster snapshot to create from the source DB
	// cluster snapshot. This parameter isn't case-sensitive.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 letters, numbers, or hyphens.
	//
	//    * First character must be a letter.
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens.
	//
	// Example: my-cluster-snapshot2
	//
	// TargetDBClusterSnapshotIdentifier is a required field
	TargetDBClusterSnapshotIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CopyDBClusterSnapshotInput) GoString added in v0.7.1

func (s CopyDBClusterSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyDBClusterSnapshotInput) SetCopyTags added in v1.7.5

SetCopyTags sets the CopyTags field's value.

func (*CopyDBClusterSnapshotInput) SetDestinationRegion added in v1.7.5

func (s *CopyDBClusterSnapshotInput) SetDestinationRegion(v string) *CopyDBClusterSnapshotInput

SetDestinationRegion sets the DestinationRegion field's value.

func (*CopyDBClusterSnapshotInput) SetKmsKeyId added in v1.7.5

SetKmsKeyId sets the KmsKeyId field's value.

func (*CopyDBClusterSnapshotInput) SetPreSignedUrl added in v1.7.5

SetPreSignedUrl sets the PreSignedUrl field's value.

func (*CopyDBClusterSnapshotInput) SetSourceDBClusterSnapshotIdentifier added in v1.5.0

func (s *CopyDBClusterSnapshotInput) SetSourceDBClusterSnapshotIdentifier(v string) *CopyDBClusterSnapshotInput

SetSourceDBClusterSnapshotIdentifier sets the SourceDBClusterSnapshotIdentifier field's value.

func (*CopyDBClusterSnapshotInput) SetSourceRegion added in v1.7.5

SetSourceRegion sets the SourceRegion field's value.

func (*CopyDBClusterSnapshotInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (*CopyDBClusterSnapshotInput) SetTargetDBClusterSnapshotIdentifier added in v1.5.0

func (s *CopyDBClusterSnapshotInput) SetTargetDBClusterSnapshotIdentifier(v string) *CopyDBClusterSnapshotInput

SetTargetDBClusterSnapshotIdentifier sets the TargetDBClusterSnapshotIdentifier field's value.

func (CopyDBClusterSnapshotInput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyDBClusterSnapshotInput) Validate added in v1.1.21

func (s *CopyDBClusterSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CopyDBClusterSnapshotOutput added in v0.7.1

type CopyDBClusterSnapshotOutput struct {

	// Contains the details for an Amazon RDS DB cluster snapshot
	//
	// This data type is used as a response element in the DescribeDBClusterSnapshots
	// action.
	DBClusterSnapshot *DBClusterSnapshot `type:"structure"`
	// contains filtered or unexported fields
}

func (CopyDBClusterSnapshotOutput) GoString added in v0.7.1

func (s CopyDBClusterSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyDBClusterSnapshotOutput) SetDBClusterSnapshot added in v1.5.0

SetDBClusterSnapshot sets the DBClusterSnapshot field's value.

func (CopyDBClusterSnapshotOutput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CopyDBParameterGroupInput

type CopyDBParameterGroupInput struct {

	// The identifier or ARN for the source DB parameter group. For information
	// about creating an ARN, see Constructing an ARN for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing)
	// in the Amazon RDS User Guide.
	//
	// Constraints:
	//
	//    * Must specify a valid DB parameter group.
	//
	// SourceDBParameterGroupIdentifier is a required field
	SourceDBParameterGroupIdentifier *string `type:"string" required:"true"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// A description for the copied DB parameter group.
	//
	// TargetDBParameterGroupDescription is a required field
	TargetDBParameterGroupDescription *string `type:"string" required:"true"`

	// The identifier for the copied DB parameter group.
	//
	// Constraints:
	//
	//    * Can't be null, empty, or blank
	//
	//    * Must contain from 1 to 255 letters, numbers, or hyphens
	//
	//    * First character must be a letter
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens
	//
	// Example: my-db-parameter-group
	//
	// TargetDBParameterGroupIdentifier is a required field
	TargetDBParameterGroupIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CopyDBParameterGroupInput) GoString added in v0.6.5

func (s CopyDBParameterGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyDBParameterGroupInput) SetSourceDBParameterGroupIdentifier added in v1.5.0

func (s *CopyDBParameterGroupInput) SetSourceDBParameterGroupIdentifier(v string) *CopyDBParameterGroupInput

SetSourceDBParameterGroupIdentifier sets the SourceDBParameterGroupIdentifier field's value.

func (*CopyDBParameterGroupInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (*CopyDBParameterGroupInput) SetTargetDBParameterGroupDescription added in v1.5.0

func (s *CopyDBParameterGroupInput) SetTargetDBParameterGroupDescription(v string) *CopyDBParameterGroupInput

SetTargetDBParameterGroupDescription sets the TargetDBParameterGroupDescription field's value.

func (*CopyDBParameterGroupInput) SetTargetDBParameterGroupIdentifier added in v1.5.0

func (s *CopyDBParameterGroupInput) SetTargetDBParameterGroupIdentifier(v string) *CopyDBParameterGroupInput

SetTargetDBParameterGroupIdentifier sets the TargetDBParameterGroupIdentifier field's value.

func (CopyDBParameterGroupInput) String added in v0.6.5

func (s CopyDBParameterGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyDBParameterGroupInput) Validate added in v1.1.21

func (s *CopyDBParameterGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CopyDBParameterGroupOutput

type CopyDBParameterGroupOutput struct {

	// Contains the details of an Amazon RDS DB parameter group.
	//
	// This data type is used as a response element in the DescribeDBParameterGroups
	// action.
	DBParameterGroup *DBParameterGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CopyDBParameterGroupOutput) GoString added in v0.6.5

func (s CopyDBParameterGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyDBParameterGroupOutput) SetDBParameterGroup added in v1.5.0

SetDBParameterGroup sets the DBParameterGroup field's value.

func (CopyDBParameterGroupOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CopyDBSnapshotInput

type CopyDBSnapshotInput struct {

	// A value that indicates whether to copy all tags from the source DB snapshot
	// to the target DB snapshot. By default, tags are not copied.
	CopyTags *bool `type:"boolean"`

	// DestinationRegion is used for presigning the request to a given region.
	DestinationRegion *string `type:"string"`

	// The Amazon Web Services KMS key identifier for an encrypted DB snapshot.
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key.
	//
	// If you copy an encrypted DB snapshot from your Amazon Web Services account,
	// you can specify a value for this parameter to encrypt the copy with a new
	// KMS key. If you don't specify a value for this parameter, then the copy of
	// the DB snapshot is encrypted with the same Amazon Web Services KMS key as
	// the source DB snapshot.
	//
	// If you copy an encrypted DB snapshot that is shared from another Amazon Web
	// Services account, then you must specify a value for this parameter.
	//
	// If you specify this parameter when you copy an unencrypted snapshot, the
	// copy is encrypted.
	//
	// If you copy an encrypted snapshot to a different Amazon Web Services Region,
	// then you must specify an Amazon Web Services KMS key identifier for the destination
	// Amazon Web Services Region. KMS keys are specific to the Amazon Web Services
	// Region that they are created in, and you can't use KMS keys from one Amazon
	// Web Services Region in another Amazon Web Services Region.
	KmsKeyId *string `type:"string"`

	// The name of an option group to associate with the copy of the snapshot.
	//
	// Specify this option if you are copying a snapshot from one Amazon Web Services
	// Region to another, and your DB instance uses a nondefault option group. If
	// your source DB instance uses Transparent Data Encryption for Oracle or Microsoft
	// SQL Server, you must specify this option when copying across Amazon Web Services
	// Regions. For more information, see Option group considerations (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options)
	// in the Amazon RDS User Guide.
	OptionGroupName *string `type:"string"`

	// When you are copying a snapshot from one Amazon Web Services GovCloud (US)
	// Region to another, the URL that contains a Signature Version 4 signed request
	// for the CopyDBSnapshot API operation in the source Amazon Web Services Region
	// that contains the source DB snapshot to copy.
	//
	// This setting applies only to Amazon Web Services GovCloud (US) Regions. It's
	// ignored in other Amazon Web Services Regions.
	//
	// You must specify this parameter when you copy an encrypted DB snapshot from
	// another Amazon Web Services Region by using the Amazon RDS API. Don't specify
	// PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon
	// Web Services Region.
	//
	// The presigned URL must be a valid request for the CopyDBClusterSnapshot API
	// operation that can run in the source Amazon Web Services Region that contains
	// the encrypted DB cluster snapshot to copy. The presigned URL request must
	// contain the following parameter values:
	//
	//    * DestinationRegion - The Amazon Web Services Region that the encrypted
	//    DB snapshot is copied to. This Amazon Web Services Region is the same
	//    one where the CopyDBSnapshot operation is called that contains this presigned
	//    URL. For example, if you copy an encrypted DB snapshot from the us-west-2
	//    Amazon Web Services Region to the us-east-1 Amazon Web Services Region,
	//    then you call the CopyDBSnapshot operation in the us-east-1 Amazon Web
	//    Services Region and provide a presigned URL that contains a call to the
	//    CopyDBSnapshot operation in the us-west-2 Amazon Web Services Region.
	//    For this example, the DestinationRegion in the presigned URL must be set
	//    to the us-east-1 Amazon Web Services Region.
	//
	//    * KmsKeyId - The KMS key identifier for the KMS key to use to encrypt
	//    the copy of the DB snapshot in the destination Amazon Web Services Region.
	//    This is the same identifier for both the CopyDBSnapshot operation that
	//    is called in the destination Amazon Web Services Region, and the operation
	//    contained in the presigned URL.
	//
	//    * SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted
	//    snapshot to be copied. This identifier must be in the Amazon Resource
	//    Name (ARN) format for the source Amazon Web Services Region. For example,
	//    if you are copying an encrypted DB snapshot from the us-west-2 Amazon
	//    Web Services Region, then your SourceDBSnapshotIdentifier looks like the
	//    following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
	//
	// To learn how to generate a Signature Version 4 signed request, see Authenticating
	// Requests: Using Query Parameters (Amazon Web Services Signature Version 4)
	// (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html)
	// and Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).
	//
	// If you are using an Amazon Web Services SDK tool or the CLI, you can specify
	// SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl
	// manually. Specifying SourceRegion autogenerates a presigned URL that is a
	// valid request for the operation that can run in the source Amazon Web Services
	// Region.
	PreSignedUrl *string `type:"string"`

	// The identifier for the source DB snapshot.
	//
	// If the source snapshot is in the same Amazon Web Services Region as the copy,
	// specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.
	//
	// If the source snapshot is in a different Amazon Web Services Region than
	// the copy, specify a valid DB snapshot ARN. For example, you might specify
	// arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
	//
	// If you are copying from a shared manual DB snapshot, this parameter must
	// be the Amazon Resource Name (ARN) of the shared DB snapshot.
	//
	// If you are copying an encrypted snapshot this parameter must be in the ARN
	// format for the source Amazon Web Services Region.
	//
	// Constraints:
	//
	//    * Must specify a valid system snapshot in the "available" state.
	//
	// Example: rds:mydb-2012-04-02-00-01
	//
	// Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
	//
	// SourceDBSnapshotIdentifier is a required field
	SourceDBSnapshotIdentifier *string `type:"string" required:"true"`

	// SourceRegion is the source region where the resource exists. This is not
	// sent over the wire and is only used for presigning. This value should always
	// have the same region as the source ARN.
	SourceRegion *string `type:"string" ignore:"true"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// The external custom Availability Zone (CAZ) identifier for the target CAZ.
	//
	// Example: rds-caz-aiqhTgQv.
	TargetCustomAvailabilityZone *string `type:"string"`

	// The identifier for the copy of the snapshot.
	//
	// Constraints:
	//
	//    * Can't be null, empty, or blank
	//
	//    * Must contain from 1 to 255 letters, numbers, or hyphens
	//
	//    * First character must be a letter
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens
	//
	// Example: my-db-snapshot
	//
	// TargetDBSnapshotIdentifier is a required field
	TargetDBSnapshotIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CopyDBSnapshotInput) GoString added in v0.6.5

func (s CopyDBSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyDBSnapshotInput) SetCopyTags added in v1.5.0

func (s *CopyDBSnapshotInput) SetCopyTags(v bool) *CopyDBSnapshotInput

SetCopyTags sets the CopyTags field's value.

func (*CopyDBSnapshotInput) SetDestinationRegion added in v1.6.7

func (s *CopyDBSnapshotInput) SetDestinationRegion(v string) *CopyDBSnapshotInput

SetDestinationRegion sets the DestinationRegion field's value.

func (*CopyDBSnapshotInput) SetKmsKeyId added in v1.5.0

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*CopyDBSnapshotInput) SetOptionGroupName added in v1.8.40

func (s *CopyDBSnapshotInput) SetOptionGroupName(v string) *CopyDBSnapshotInput

SetOptionGroupName sets the OptionGroupName field's value.

func (*CopyDBSnapshotInput) SetPreSignedUrl added in v1.6.7

func (s *CopyDBSnapshotInput) SetPreSignedUrl(v string) *CopyDBSnapshotInput

SetPreSignedUrl sets the PreSignedUrl field's value.

func (*CopyDBSnapshotInput) SetSourceDBSnapshotIdentifier added in v1.5.0

func (s *CopyDBSnapshotInput) SetSourceDBSnapshotIdentifier(v string) *CopyDBSnapshotInput

SetSourceDBSnapshotIdentifier sets the SourceDBSnapshotIdentifier field's value.

func (*CopyDBSnapshotInput) SetSourceRegion added in v1.6.7

func (s *CopyDBSnapshotInput) SetSourceRegion(v string) *CopyDBSnapshotInput

SetSourceRegion sets the SourceRegion field's value.

func (*CopyDBSnapshotInput) SetTags added in v1.5.0

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

SetTags sets the Tags field's value.

func (*CopyDBSnapshotInput) SetTargetCustomAvailabilityZone added in v1.35.30

func (s *CopyDBSnapshotInput) SetTargetCustomAvailabilityZone(v string) *CopyDBSnapshotInput

SetTargetCustomAvailabilityZone sets the TargetCustomAvailabilityZone field's value.

func (*CopyDBSnapshotInput) SetTargetDBSnapshotIdentifier added in v1.5.0

func (s *CopyDBSnapshotInput) SetTargetDBSnapshotIdentifier(v string) *CopyDBSnapshotInput

SetTargetDBSnapshotIdentifier sets the TargetDBSnapshotIdentifier field's value.

func (CopyDBSnapshotInput) String added in v0.6.5

func (s CopyDBSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyDBSnapshotInput) Validate added in v1.1.21

func (s *CopyDBSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CopyDBSnapshotOutput

type CopyDBSnapshotOutput struct {

	// Contains the details of an Amazon RDS DB snapshot.
	//
	// This data type is used as a response element in the DescribeDBSnapshots action.
	DBSnapshot *DBSnapshot `type:"structure"`
	// contains filtered or unexported fields
}

func (CopyDBSnapshotOutput) GoString added in v0.6.5

func (s CopyDBSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyDBSnapshotOutput) SetDBSnapshot added in v1.5.0

SetDBSnapshot sets the DBSnapshot field's value.

func (CopyDBSnapshotOutput) String added in v0.6.5

func (s CopyDBSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CopyOptionGroupInput

type CopyOptionGroupInput struct {

	// The identifier for the source option group.
	//
	// Constraints:
	//
	//    * Must specify a valid option group.
	//
	// SourceOptionGroupIdentifier is a required field
	SourceOptionGroupIdentifier *string `type:"string" required:"true"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// The description for the copied option group.
	//
	// TargetOptionGroupDescription is a required field
	TargetOptionGroupDescription *string `type:"string" required:"true"`

	// The identifier for the copied option group.
	//
	// Constraints:
	//
	//    * Can't be null, empty, or blank
	//
	//    * Must contain from 1 to 255 letters, numbers, or hyphens
	//
	//    * First character must be a letter
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens
	//
	// Example: my-option-group
	//
	// TargetOptionGroupIdentifier is a required field
	TargetOptionGroupIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CopyOptionGroupInput) GoString added in v0.6.5

func (s CopyOptionGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyOptionGroupInput) SetSourceOptionGroupIdentifier added in v1.5.0

func (s *CopyOptionGroupInput) SetSourceOptionGroupIdentifier(v string) *CopyOptionGroupInput

SetSourceOptionGroupIdentifier sets the SourceOptionGroupIdentifier field's value.

func (*CopyOptionGroupInput) SetTags added in v1.5.0

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

SetTags sets the Tags field's value.

func (*CopyOptionGroupInput) SetTargetOptionGroupDescription added in v1.5.0

func (s *CopyOptionGroupInput) SetTargetOptionGroupDescription(v string) *CopyOptionGroupInput

SetTargetOptionGroupDescription sets the TargetOptionGroupDescription field's value.

func (*CopyOptionGroupInput) SetTargetOptionGroupIdentifier added in v1.5.0

func (s *CopyOptionGroupInput) SetTargetOptionGroupIdentifier(v string) *CopyOptionGroupInput

SetTargetOptionGroupIdentifier sets the TargetOptionGroupIdentifier field's value.

func (CopyOptionGroupInput) String added in v0.6.5

func (s CopyOptionGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyOptionGroupInput) Validate added in v1.1.21

func (s *CopyOptionGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CopyOptionGroupOutput

type CopyOptionGroupOutput struct {
	OptionGroup *OptionGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CopyOptionGroupOutput) GoString added in v0.6.5

func (s CopyOptionGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyOptionGroupOutput) SetOptionGroup added in v1.5.0

SetOptionGroup sets the OptionGroup field's value.

func (CopyOptionGroupOutput) String added in v0.6.5

func (s CopyOptionGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateCustomDBEngineVersionInput added in v1.41.10

type CreateCustomDBEngineVersionInput struct {

	// The name of an Amazon S3 bucket that contains database installation files
	// for your CEV. For example, a valid bucket name is my-custom-installation-files.
	//
	// DatabaseInstallationFilesS3BucketName is a required field
	DatabaseInstallationFilesS3BucketName *string `min:"3" type:"string" required:"true"`

	// The Amazon S3 directory that contains the database installation files for
	// your CEV. For example, a valid bucket name is 123456789012/cev1. If this
	// setting isn't specified, no prefix is assumed.
	DatabaseInstallationFilesS3Prefix *string `min:"1" type:"string"`

	// An optional description of your CEV.
	Description *string `min:"1" type:"string"`

	// The database engine to use for your custom engine version (CEV). The only
	// supported value is custom-oracle-ee.
	//
	// Engine is a required field
	Engine *string `min:"1" type:"string" required:"true"`

	// The name of your CEV. The name format is 19.customized_string . For example,
	// a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle,
	// but optional for Amazon RDS. The combination of Engine and EngineVersion
	// is unique per customer per Region.
	//
	// EngineVersion is a required field
	EngineVersion *string `min:"1" type:"string" required:"true"`

	// The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric
	// encryption KMS key is required for RDS Custom, but optional for Amazon RDS.
	//
	// If you have an existing symmetric encryption KMS key in your account, you
	// can use it with RDS Custom. No further action is necessary. If you don't
	// already have a symmetric encryption KMS key in your account, follow the instructions
	// in Creating a symmetric encryption KMS key (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk)
	// in the Amazon Web Services Key Management Service Developer Guide.
	//
	// You can choose the same symmetric encryption key when you create a CEV and
	// a DB instance, or choose different keys.
	//
	// KMSKeyId is a required field
	KMSKeyId *string `min:"1" type:"string" required:"true"`

	// The CEV manifest, which is a JSON document that describes the installation
	// .zip files stored in Amazon S3. Specify the name/value pairs in a file or
	// a quoted string. RDS Custom applies the patches in the order in which they
	// are listed.
	//
	// The following JSON fields are valid:
	//
	// MediaImportTemplateVersion
	//
	// Version of the CEV manifest. The date is in the format YYYY-MM-DD.
	//
	// databaseInstallationFileNames
	//
	// Ordered list of installation files for the CEV.
	//
	// opatchFileNames
	//
	// Ordered list of OPatch installers used for the Oracle DB engine.
	//
	// psuRuPatchFileNames
	//
	// The PSU and RU patches for this CEV.
	//
	// OtherPatchFileNames
	//
	// The patches that are not in the list of PSU and RU patches. Amazon RDS applies
	// these patches after applying the PSU and RU patches.
	//
	// For more information, see Creating the CEV manifest (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest)
	// in the Amazon RDS User Guide.
	//
	// Manifest is a required field
	Manifest *string `min:"1" type:"string" required:"true"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

func (CreateCustomDBEngineVersionInput) GoString added in v1.41.10

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCustomDBEngineVersionInput) SetDatabaseInstallationFilesS3BucketName added in v1.41.10

func (s *CreateCustomDBEngineVersionInput) SetDatabaseInstallationFilesS3BucketName(v string) *CreateCustomDBEngineVersionInput

SetDatabaseInstallationFilesS3BucketName sets the DatabaseInstallationFilesS3BucketName field's value.

func (*CreateCustomDBEngineVersionInput) SetDatabaseInstallationFilesS3Prefix added in v1.41.10

func (s *CreateCustomDBEngineVersionInput) SetDatabaseInstallationFilesS3Prefix(v string) *CreateCustomDBEngineVersionInput

SetDatabaseInstallationFilesS3Prefix sets the DatabaseInstallationFilesS3Prefix field's value.

func (*CreateCustomDBEngineVersionInput) SetDescription added in v1.41.10

SetDescription sets the Description field's value.

func (*CreateCustomDBEngineVersionInput) SetEngine added in v1.41.10

SetEngine sets the Engine field's value.

func (*CreateCustomDBEngineVersionInput) SetEngineVersion added in v1.41.10

SetEngineVersion sets the EngineVersion field's value.

func (*CreateCustomDBEngineVersionInput) SetKMSKeyId added in v1.41.10

SetKMSKeyId sets the KMSKeyId field's value.

func (*CreateCustomDBEngineVersionInput) SetManifest added in v1.41.10

SetManifest sets the Manifest field's value.

func (*CreateCustomDBEngineVersionInput) SetTags added in v1.41.10

SetTags sets the Tags field's value.

func (CreateCustomDBEngineVersionInput) String added in v1.41.10

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCustomDBEngineVersionInput) Validate added in v1.41.10

Validate inspects the fields of the type to determine if they are valid.

type CreateCustomDBEngineVersionOutput added in v1.41.10

type CreateCustomDBEngineVersionOutput struct {

	// The creation time of the DB engine version.
	CreateTime *time.Time `type:"timestamp"`

	// The description of the database engine.
	DBEngineDescription *string `type:"string"`

	// The ARN of the custom engine version.
	DBEngineVersionArn *string `type:"string"`

	// The description of the database engine version.
	DBEngineVersionDescription *string `type:"string"`

	// The name of the DB parameter group family for the database engine.
	DBParameterGroupFamily *string `type:"string"`

	// The name of the Amazon S3 bucket that contains your database installation
	// files.
	DatabaseInstallationFilesS3BucketName *string `type:"string"`

	// The Amazon S3 directory that contains the database installation files. If
	// not specified, then no prefix is assumed.
	DatabaseInstallationFilesS3Prefix *string `type:"string"`

	// The default character set for new instances of this engine version, if the
	// CharacterSetName parameter of the CreateDBInstance API isn't specified.
	DefaultCharacterSet *CharacterSet `type:"structure"`

	// The name of the database engine.
	Engine *string `type:"string"`

	// The version number of the database engine.
	EngineVersion *string `type:"string"`

	// The types of logs that the database engine has available for export to CloudWatch
	// Logs.
	ExportableLogTypes []*string `type:"list"`

	// The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter
	// is required for RDS Custom, but optional for Amazon RDS.
	KMSKeyId *string `type:"string"`

	// The major engine version of the CEV.
	MajorEngineVersion *string `type:"string"`

	// The status of the DB engine version, either available or deprecated.
	Status *string `type:"string"`

	// A list of the character sets supported by this engine for the CharacterSetName
	// parameter of the CreateDBInstance operation.
	SupportedCharacterSets []*CharacterSet `locationNameList:"CharacterSet" type:"list"`

	// A list of the supported DB engine modes.
	SupportedEngineModes []*string `type:"list"`

	// A list of features supported by the DB engine.
	//
	// The supported features vary by DB engine and DB engine version.
	//
	// To determine the supported features for a specific DB engine and DB engine
	// version using the CLI, use the following command:
	//
	// aws rds describe-db-engine-versions --engine <engine_name> --engine-version
	// <engine_version>
	//
	// For example, to determine the supported features for RDS for PostgreSQL version
	// 13.3 using the CLI, use the following command:
	//
	// aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
	//
	// The supported features are listed under SupportedFeatureNames in the output.
	SupportedFeatureNames []*string `type:"list"`

	// A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName
	// parameter of the CreateDBInstance operation.
	SupportedNcharCharacterSets []*CharacterSet `locationNameList:"CharacterSet" type:"list"`

	// A list of the time zones supported by this engine for the Timezone parameter
	// of the CreateDBInstance action.
	SupportedTimezones []*Timezone `locationNameList:"Timezone" type:"list"`

	// A value that indicates whether the engine version supports Babelfish for
	// Aurora PostgreSQL.
	SupportsBabelfish *bool `type:"boolean"`

	// A value that indicates whether you can use Aurora global databases with a
	// specific DB engine version.
	SupportsGlobalDatabases *bool `type:"boolean"`

	// A value that indicates whether the engine version supports exporting the
	// log types specified by ExportableLogTypes to CloudWatch Logs.
	SupportsLogExportsToCloudwatchLogs *bool `type:"boolean"`

	// A value that indicates whether you can use Aurora parallel query with a specific
	// DB engine version.
	SupportsParallelQuery *bool `type:"boolean"`

	// Indicates whether the database engine version supports read replicas.
	SupportsReadReplica *bool `type:"boolean"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	TagList []*Tag `locationNameList:"Tag" type:"list"`

	// A list of engine versions that this database engine version can be upgraded
	// to.
	ValidUpgradeTarget []*UpgradeTarget `locationNameList:"UpgradeTarget" type:"list"`
	// contains filtered or unexported fields
}

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

func (CreateCustomDBEngineVersionOutput) GoString added in v1.41.10

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCustomDBEngineVersionOutput) SetCreateTime added in v1.41.10

SetCreateTime sets the CreateTime field's value.

func (*CreateCustomDBEngineVersionOutput) SetDBEngineDescription added in v1.41.10

SetDBEngineDescription sets the DBEngineDescription field's value.

func (*CreateCustomDBEngineVersionOutput) SetDBEngineVersionArn added in v1.41.10

SetDBEngineVersionArn sets the DBEngineVersionArn field's value.

func (*CreateCustomDBEngineVersionOutput) SetDBEngineVersionDescription added in v1.41.10

func (s *CreateCustomDBEngineVersionOutput) SetDBEngineVersionDescription(v string) *CreateCustomDBEngineVersionOutput

SetDBEngineVersionDescription sets the DBEngineVersionDescription field's value.

func (*CreateCustomDBEngineVersionOutput) SetDBParameterGroupFamily added in v1.41.10

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*CreateCustomDBEngineVersionOutput) SetDatabaseInstallationFilesS3BucketName added in v1.41.10

func (s *CreateCustomDBEngineVersionOutput) SetDatabaseInstallationFilesS3BucketName(v string) *CreateCustomDBEngineVersionOutput

SetDatabaseInstallationFilesS3BucketName sets the DatabaseInstallationFilesS3BucketName field's value.

func (*CreateCustomDBEngineVersionOutput) SetDatabaseInstallationFilesS3Prefix added in v1.41.10

func (s *CreateCustomDBEngineVersionOutput) SetDatabaseInstallationFilesS3Prefix(v string) *CreateCustomDBEngineVersionOutput

SetDatabaseInstallationFilesS3Prefix sets the DatabaseInstallationFilesS3Prefix field's value.

func (*CreateCustomDBEngineVersionOutput) SetDefaultCharacterSet added in v1.41.10

SetDefaultCharacterSet sets the DefaultCharacterSet field's value.

func (*CreateCustomDBEngineVersionOutput) SetEngine added in v1.41.10

SetEngine sets the Engine field's value.

func (*CreateCustomDBEngineVersionOutput) SetEngineVersion added in v1.41.10

SetEngineVersion sets the EngineVersion field's value.

func (*CreateCustomDBEngineVersionOutput) SetExportableLogTypes added in v1.41.10

SetExportableLogTypes sets the ExportableLogTypes field's value.

func (*CreateCustomDBEngineVersionOutput) SetKMSKeyId added in v1.41.10

SetKMSKeyId sets the KMSKeyId field's value.

func (*CreateCustomDBEngineVersionOutput) SetMajorEngineVersion added in v1.41.10

SetMajorEngineVersion sets the MajorEngineVersion field's value.

func (*CreateCustomDBEngineVersionOutput) SetStatus added in v1.41.10

SetStatus sets the Status field's value.

func (*CreateCustomDBEngineVersionOutput) SetSupportedCharacterSets added in v1.41.10

SetSupportedCharacterSets sets the SupportedCharacterSets field's value.

func (*CreateCustomDBEngineVersionOutput) SetSupportedEngineModes added in v1.41.10

SetSupportedEngineModes sets the SupportedEngineModes field's value.

func (*CreateCustomDBEngineVersionOutput) SetSupportedFeatureNames added in v1.41.10

SetSupportedFeatureNames sets the SupportedFeatureNames field's value.

func (*CreateCustomDBEngineVersionOutput) SetSupportedNcharCharacterSets added in v1.41.10

func (s *CreateCustomDBEngineVersionOutput) SetSupportedNcharCharacterSets(v []*CharacterSet) *CreateCustomDBEngineVersionOutput

SetSupportedNcharCharacterSets sets the SupportedNcharCharacterSets field's value.

func (*CreateCustomDBEngineVersionOutput) SetSupportedTimezones added in v1.41.10

SetSupportedTimezones sets the SupportedTimezones field's value.

func (*CreateCustomDBEngineVersionOutput) SetSupportsBabelfish added in v1.42.53

SetSupportsBabelfish sets the SupportsBabelfish field's value.

func (*CreateCustomDBEngineVersionOutput) SetSupportsGlobalDatabases added in v1.41.10

SetSupportsGlobalDatabases sets the SupportsGlobalDatabases field's value.

func (*CreateCustomDBEngineVersionOutput) SetSupportsLogExportsToCloudwatchLogs added in v1.41.10

func (s *CreateCustomDBEngineVersionOutput) SetSupportsLogExportsToCloudwatchLogs(v bool) *CreateCustomDBEngineVersionOutput

SetSupportsLogExportsToCloudwatchLogs sets the SupportsLogExportsToCloudwatchLogs field's value.

func (*CreateCustomDBEngineVersionOutput) SetSupportsParallelQuery added in v1.41.10

SetSupportsParallelQuery sets the SupportsParallelQuery field's value.

func (*CreateCustomDBEngineVersionOutput) SetSupportsReadReplica added in v1.41.10

SetSupportsReadReplica sets the SupportsReadReplica field's value.

func (*CreateCustomDBEngineVersionOutput) SetTagList added in v1.41.10

SetTagList sets the TagList field's value.

func (*CreateCustomDBEngineVersionOutput) SetValidUpgradeTarget added in v1.41.10

SetValidUpgradeTarget sets the ValidUpgradeTarget field's value.

func (CreateCustomDBEngineVersionOutput) String added in v1.41.10

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDBClusterEndpointInput added in v1.15.74

type CreateDBClusterEndpointInput struct {

	// The identifier to use for the new endpoint. This parameter is stored as a
	// lowercase string.
	//
	// DBClusterEndpointIdentifier is a required field
	DBClusterEndpointIdentifier *string `type:"string" required:"true"`

	// The DB cluster identifier of the DB cluster associated with the endpoint.
	// This parameter is stored as a lowercase string.
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The type of the endpoint, one of: READER, WRITER, ANY.
	//
	// EndpointType is a required field
	EndpointType *string `type:"string" required:"true"`

	// List of DB instance identifiers that aren't part of the custom endpoint group.
	// All other eligible instances are reachable through the custom endpoint. This
	// parameter is relevant only if the list of static members is empty.
	ExcludedMembers []*string `type:"list"`

	// List of DB instance identifiers that are part of the custom endpoint group.
	StaticMembers []*string `type:"list"`

	// The tags to be assigned to the Amazon RDS resource.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDBClusterEndpointInput) GoString added in v1.15.74

func (s CreateDBClusterEndpointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBClusterEndpointInput) SetDBClusterEndpointIdentifier added in v1.15.74

func (s *CreateDBClusterEndpointInput) SetDBClusterEndpointIdentifier(v string) *CreateDBClusterEndpointInput

SetDBClusterEndpointIdentifier sets the DBClusterEndpointIdentifier field's value.

func (*CreateDBClusterEndpointInput) SetDBClusterIdentifier added in v1.15.74

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*CreateDBClusterEndpointInput) SetEndpointType added in v1.15.74

SetEndpointType sets the EndpointType field's value.

func (*CreateDBClusterEndpointInput) SetExcludedMembers added in v1.15.74

SetExcludedMembers sets the ExcludedMembers field's value.

func (*CreateDBClusterEndpointInput) SetStaticMembers added in v1.15.74

SetStaticMembers sets the StaticMembers field's value.

func (*CreateDBClusterEndpointInput) SetTags added in v1.25.42

SetTags sets the Tags field's value.

func (CreateDBClusterEndpointInput) String added in v1.15.74

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBClusterEndpointInput) Validate added in v1.15.74

func (s *CreateDBClusterEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDBClusterEndpointOutput added in v1.15.74

type CreateDBClusterEndpointOutput struct {

	// The type associated with a custom endpoint. One of: READER, WRITER, ANY.
	CustomEndpointType *string `type:"string"`

	// The Amazon Resource Name (ARN) for the endpoint.
	DBClusterEndpointArn *string `type:"string"`

	// The identifier associated with the endpoint. This parameter is stored as
	// a lowercase string.
	DBClusterEndpointIdentifier *string `type:"string"`

	// A unique system-generated identifier for an endpoint. It remains the same
	// for the whole life of the endpoint.
	DBClusterEndpointResourceIdentifier *string `type:"string"`

	// The DB cluster identifier of the DB cluster associated with the endpoint.
	// This parameter is stored as a lowercase string.
	DBClusterIdentifier *string `type:"string"`

	// The DNS address of the endpoint.
	Endpoint *string `type:"string"`

	// The type of the endpoint. One of: READER, WRITER, CUSTOM.
	EndpointType *string `type:"string"`

	// List of DB instance identifiers that aren't part of the custom endpoint group.
	// All other eligible instances are reachable through the custom endpoint. Only
	// relevant if the list of static members is empty.
	ExcludedMembers []*string `type:"list"`

	// List of DB instance identifiers that are part of the custom endpoint group.
	StaticMembers []*string `type:"list"`

	// The current status of the endpoint. One of: creating, available, deleting,
	// inactive, modifying. The inactive state applies to an endpoint that can't
	// be used for a certain kind of cluster, such as a writer endpoint for a read-only
	// secondary cluster in a global database.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

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

  • CreateDBClusterEndpoint

  • DescribeDBClusterEndpoints

  • ModifyDBClusterEndpoint

  • DeleteDBClusterEndpoint

For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

func (CreateDBClusterEndpointOutput) GoString added in v1.15.74

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBClusterEndpointOutput) SetCustomEndpointType added in v1.15.74

SetCustomEndpointType sets the CustomEndpointType field's value.

func (*CreateDBClusterEndpointOutput) SetDBClusterEndpointArn added in v1.15.74

SetDBClusterEndpointArn sets the DBClusterEndpointArn field's value.

func (*CreateDBClusterEndpointOutput) SetDBClusterEndpointIdentifier added in v1.15.74

func (s *CreateDBClusterEndpointOutput) SetDBClusterEndpointIdentifier(v string) *CreateDBClusterEndpointOutput

SetDBClusterEndpointIdentifier sets the DBClusterEndpointIdentifier field's value.

func (*CreateDBClusterEndpointOutput) SetDBClusterEndpointResourceIdentifier added in v1.15.74

func (s *CreateDBClusterEndpointOutput) SetDBClusterEndpointResourceIdentifier(v string) *CreateDBClusterEndpointOutput

SetDBClusterEndpointResourceIdentifier sets the DBClusterEndpointResourceIdentifier field's value.

func (*CreateDBClusterEndpointOutput) SetDBClusterIdentifier added in v1.15.74

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*CreateDBClusterEndpointOutput) SetEndpoint added in v1.15.74

SetEndpoint sets the Endpoint field's value.

func (*CreateDBClusterEndpointOutput) SetEndpointType added in v1.15.74

SetEndpointType sets the EndpointType field's value.

func (*CreateDBClusterEndpointOutput) SetExcludedMembers added in v1.15.74

SetExcludedMembers sets the ExcludedMembers field's value.

func (*CreateDBClusterEndpointOutput) SetStaticMembers added in v1.15.74

SetStaticMembers sets the StaticMembers field's value.

func (*CreateDBClusterEndpointOutput) SetStatus added in v1.15.74

SetStatus sets the Status field's value.

func (CreateDBClusterEndpointOutput) String added in v1.15.74

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDBClusterInput added in v0.7.1

type CreateDBClusterInput struct {

	// The amount of storage in gibibytes (GiB) to allocate to each DB instance
	// in the Multi-AZ DB cluster.
	//
	// This setting is required to create a Multi-AZ DB cluster.
	//
	// Valid for: Multi-AZ DB clusters only
	AllocatedStorage *int64 `type:"integer"`

	// A value that indicates whether minor engine upgrades are applied automatically
	// to the DB cluster during the maintenance window. By default, minor engine
	// upgrades are applied automatically.
	//
	// Valid for: Multi-AZ DB clusters only
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// A list of Availability Zones (AZs) where DB instances in the DB cluster can
	// be created.
	//
	// For information on Amazon Web Services Regions and Availability Zones, see
	// Choosing the Regions and Availability Zones (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html)
	// in the Amazon Aurora User Guide.
	//
	// Valid for: Aurora DB clusters only
	AvailabilityZones []*string `locationNameList:"AvailabilityZone" type:"list"`

	// The target backtrack window, in seconds. To disable backtracking, set this
	// value to 0.
	//
	// Default: 0
	//
	// Constraints:
	//
	//    * If specified, this value must be set to a number from 0 to 259,200 (72
	//    hours).
	//
	// Valid for: Aurora MySQL DB clusters only
	BacktrackWindow *int64 `type:"long"`

	// The number of days for which automated backups are retained.
	//
	// Default: 1
	//
	// Constraints:
	//
	//    * Must be a value from 1 to 35
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	BackupRetentionPeriod *int64 `type:"integer"`

	// A value that indicates that the DB cluster should be associated with the
	// specified CharacterSet.
	//
	// Valid for: Aurora DB clusters only
	CharacterSetName *string `type:"string"`

	// A value that indicates whether to copy all tags from the DB cluster to snapshots
	// of the DB cluster. The default is not to copy them.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	CopyTagsToSnapshot *bool `type:"boolean"`

	// The DB cluster identifier. This parameter is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 letters, numbers, or hyphens.
	//
	//    * First character must be a letter.
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens.
	//
	// Example: my-cluster1
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The compute and memory capacity of each DB instance in the Multi-AZ DB cluster,
	// for example db.m6g.xlarge. Not all DB instance classes are available in all
	// Amazon Web Services Regions, or for all database engines.
	//
	// For the full list of DB instance classes and availability for your engine,
	// see DB instance class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)
	// in the Amazon RDS User Guide.
	//
	// This setting is required to create a Multi-AZ DB cluster.
	//
	// Valid for: Multi-AZ DB clusters only
	DBClusterInstanceClass *string `type:"string"`

	// The name of the DB cluster parameter group to associate with this DB cluster.
	// If you do not specify a value, then the default DB cluster parameter group
	// for the specified DB engine and version is used.
	//
	// Constraints:
	//
	//    * If supplied, must match the name of an existing DB cluster parameter
	//    group.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	DBClusterParameterGroupName *string `type:"string"`

	// A DB subnet group to associate with this DB cluster.
	//
	// This setting is required to create a Multi-AZ DB cluster.
	//
	// Constraints: Must match the name of an existing DBSubnetGroup. Must not be
	// default.
	//
	// Example: mydbsubnetgroup
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	DBSubnetGroupName *string `type:"string"`

	// The name for your database of up to 64 alphanumeric characters. If you do
	// not provide a name, Amazon RDS doesn't create a database in the DB cluster
	// you are creating.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	DatabaseName *string `type:"string"`

	// A value that indicates whether the DB cluster has deletion protection enabled.
	// The database can't be deleted when deletion protection is enabled. By default,
	// deletion protection isn't enabled.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	DeletionProtection *bool `type:"boolean"`

	// DestinationRegion is used for presigning the request to a given region.
	DestinationRegion *string `type:"string"`

	// The Active Directory directory ID to create the DB cluster in.
	//
	// For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication
	// to authenticate users that connect to the DB cluster.
	//
	// For more information, see Kerberos authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html)
	// in the Amazon Aurora User Guide.
	//
	// Valid for: Aurora DB clusters only
	Domain *string `type:"string"`

	// Specify the name of the IAM role to be used when making API calls to the
	// Directory Service.
	//
	// Valid for: Aurora DB clusters only
	DomainIAMRoleName *string `type:"string"`

	// The list of log types that need to be enabled for exporting to CloudWatch
	// Logs. The values in the list depend on the DB engine being used.
	//
	// RDS for MySQL
	//
	// Possible values are error, general, and slowquery.
	//
	// RDS for PostgreSQL
	//
	// Possible values are postgresql and upgrade.
	//
	// Aurora MySQL
	//
	// Possible values are audit, error, general, and slowquery.
	//
	// Aurora PostgreSQL
	//
	// Possible value is postgresql.
	//
	// For more information about exporting CloudWatch Logs for Amazon RDS, see
	// Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
	// in the Amazon RDS User Guide.
	//
	// For more information about exporting CloudWatch Logs for Amazon Aurora, see
	// Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
	// in the Amazon Aurora User Guide.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	EnableCloudwatchLogsExports []*string `type:"list"`

	// A value that indicates whether to enable this DB cluster to forward write
	// operations to the primary cluster of an Aurora global database (GlobalCluster).
	// By default, write operations are not allowed on Aurora DB clusters that are
	// secondary clusters in an Aurora global database.
	//
	// You can set this value only on Aurora DB clusters that are members of an
	// Aurora global database. With this parameter enabled, a secondary cluster
	// can forward writes to the current primary cluster and the resulting changes
	// are replicated back to this cluster. For the primary DB cluster of an Aurora
	// global database, this value is used immediately if the primary is demoted
	// by the FailoverGlobalCluster API operation, but it does nothing until then.
	//
	// Valid for: Aurora DB clusters only
	EnableGlobalWriteForwarding *bool `type:"boolean"`

	// A value that indicates whether to enable the HTTP endpoint for an Aurora
	// Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.
	//
	// When enabled, the HTTP endpoint provides a connectionless web service API
	// for running SQL queries on the Aurora Serverless v1 DB cluster. You can also
	// query your database from inside the RDS console with the query editor.
	//
	// For more information, see Using the Data API for Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html)
	// in the Amazon Aurora User Guide.
	//
	// Valid for: Aurora DB clusters only
	EnableHttpEndpoint *bool `type:"boolean"`

	// A value that indicates whether to enable mapping of Amazon Web Services Identity
	// and Access Management (IAM) accounts to database accounts. By default, mapping
	// isn't enabled.
	//
	// For more information, see IAM Database Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html)
	// in the Amazon Aurora User Guide.
	//
	// Valid for: Aurora DB clusters only
	EnableIAMDatabaseAuthentication *bool `type:"boolean"`

	// A value that indicates whether to turn on Performance Insights for the DB
	// cluster.
	//
	// For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)
	// in the Amazon RDS User Guide.
	//
	// Valid for: Multi-AZ DB clusters only
	EnablePerformanceInsights *bool `type:"boolean"`

	// The name of the database engine to be used for this DB cluster.
	//
	// Valid Values:
	//
	//    * aurora (for MySQL 5.6-compatible Aurora)
	//
	//    * aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
	//
	//    * aurora-postgresql
	//
	//    * mysql
	//
	//    * postgres
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	//
	// Engine is a required field
	Engine *string `type:"string" required:"true"`

	// The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery,
	// global, or multimaster.
	//
	// The parallelquery engine mode isn't required for Aurora MySQL version 1.23
	// and higher 1.x versions, and version 2.09 and higher 2.x versions.
	//
	// The global engine mode isn't required for Aurora MySQL version 1.22 and higher
	// 1.x versions, and global engine mode isn't required for any 2.x versions.
	//
	// The multimaster engine mode only applies for DB clusters created with Aurora
	// MySQL version 5.6.10a.
	//
	// The serverless engine mode only applies for Aurora Serverless v1 DB clusters.
	//
	// For Aurora PostgreSQL, the global engine mode isn't required, and both the
	// parallelquery and the multimaster engine modes currently aren't supported.
	//
	// Limitations and requirements apply to some DB engine modes. For more information,
	// see the following sections in the Amazon Aurora User Guide:
	//
	//    * Limitations of Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations)
	//
	//    * Requirements for Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html)
	//
	//    * Limitations of Parallel Query (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations)
	//
	//    * Limitations of Aurora Global Databases (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations)
	//
	//    * Limitations of Multi-Master Clusters (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations)
	//
	// Valid for: Aurora DB clusters only
	EngineMode *string `type:"string"`

	// The version number of the database engine to use.
	//
	// To list all of the available engine versions for MySQL 5.6-compatible Aurora,
	// use the following command:
	//
	// aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
	//
	// To list all of the available engine versions for MySQL 5.7-compatible and
	// MySQL 8.0-compatible Aurora, use the following command:
	//
	// aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
	//
	// To list all of the available engine versions for Aurora PostgreSQL, use the
	// following command:
	//
	// aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
	//
	// To list all of the available engine versions for RDS for MySQL, use the following
	// command:
	//
	// aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
	//
	// To list all of the available engine versions for RDS for PostgreSQL, use
	// the following command:
	//
	// aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
	//
	// Aurora MySQL
	//
	// For information, see MySQL on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html)
	// in the Amazon Aurora User Guide.
	//
	// Aurora PostgreSQL
	//
	// For information, see Amazon Aurora PostgreSQL releases and engine versions
	// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html)
	// in the Amazon Aurora User Guide.
	//
	// MySQL
	//
	// For information, see MySQL on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)
	// in the Amazon RDS User Guide.
	//
	// PostgreSQL
	//
	// For information, see Amazon RDS for PostgreSQL versions and extensions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts)
	// in the Amazon RDS User Guide.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	EngineVersion *string `type:"string"`

	// The global cluster ID of an Aurora cluster that becomes the primary cluster
	// in the new global database cluster.
	//
	// Valid for: Aurora DB clusters only
	GlobalClusterIdentifier *string `type:"string"`

	// The amount of Provisioned IOPS (input/output operations per second) to be
	// initially allocated for each DB instance in the Multi-AZ DB cluster.
	//
	// For information about valid Iops values, see Amazon RDS Provisioned IOPS
	// storage to improve performance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS)
	// in the Amazon RDS User Guide.
	//
	// This setting is required to create a Multi-AZ DB cluster.
	//
	// Constraints: Must be a multiple between .5 and 50 of the storage amount for
	// the DB cluster.
	//
	// Valid for: Multi-AZ DB clusters only
	Iops *int64 `type:"integer"`

	// The Amazon Web Services KMS key identifier for an encrypted DB cluster.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key. To use a KMS key in a different Amazon
	// Web Services account, specify the key ARN or alias ARN.
	//
	// When a KMS key isn't specified in KmsKeyId:
	//
	//    * If ReplicationSourceIdentifier identifies an encrypted source, then
	//    Amazon RDS will use the KMS key used to encrypt the source. Otherwise,
	//    Amazon RDS will use your default KMS key.
	//
	//    * If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier
	//    isn't specified, then Amazon RDS will use your default KMS key.
	//
	// There is a default KMS key for your Amazon Web Services account. Your Amazon
	// Web Services account has a different default KMS key for each Amazon Web
	// Services Region.
	//
	// If you create a read replica of an encrypted DB cluster in another Amazon
	// Web Services Region, you must set KmsKeyId to a KMS key identifier that is
	// valid in the destination Amazon Web Services Region. This KMS key is used
	// to encrypt the read replica in that Amazon Web Services Region.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	KmsKeyId *string `type:"string"`

	// The password for the master database user. This password can contain any
	// printable ASCII character except "/", """, or "@".
	//
	// Constraints: Must contain from 8 to 41 characters.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	MasterUserPassword *string `type:"string"`

	// The name of the master user for the DB cluster.
	//
	// Constraints:
	//
	//    * Must be 1 to 16 letters or numbers.
	//
	//    * First character must be a letter.
	//
	//    * Can't be a reserved word for the chosen database engine.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	MasterUsername *string `type:"string"`

	// The interval, in seconds, between points when Enhanced Monitoring metrics
	// are collected for the DB cluster. To turn off collecting Enhanced Monitoring
	// metrics, specify 0. The default is 0.
	//
	// If MonitoringRoleArn is specified, also set MonitoringInterval to a value
	// other than 0.
	//
	// Valid Values: 0, 1, 5, 10, 15, 30, 60
	//
	// Valid for: Multi-AZ DB clusters only
	MonitoringInterval *int64 `type:"integer"`

	// The Amazon Resource Name (ARN) for the IAM role that permits RDS to send
	// Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess.
	// For information on creating a monitoring role, see Setting up and enabling
	// Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling)
	// in the Amazon RDS User Guide.
	//
	// If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn
	// value.
	//
	// Valid for: Multi-AZ DB clusters only
	MonitoringRoleArn *string `type:"string"`

	// The network type of the DB cluster.
	//
	// Valid values:
	//
	//    * IPV4
	//
	//    * DUAL
	//
	// The network type is determined by the DBSubnetGroup specified for the DB
	// cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and
	// the IPv6 protocols (DUAL).
	//
	// For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
	// in the Amazon Aurora User Guide.
	//
	// Valid for: Aurora DB clusters only
	NetworkType *string `type:"string"`

	// A value that indicates that the DB cluster should be associated with the
	// specified option group.
	//
	// DB clusters are associated with a default option group that can't be modified.
	OptionGroupName *string `type:"string"`

	// The Amazon Web Services KMS key identifier for encryption of Performance
	// Insights data.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key.
	//
	// If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon
	// RDS uses your default KMS key. There is a default KMS key for your Amazon
	// Web Services account. Your Amazon Web Services account has a different default
	// KMS key for each Amazon Web Services Region.
	//
	// Valid for: Multi-AZ DB clusters only
	PerformanceInsightsKMSKeyId *string `type:"string"`

	// The number of days to retain Performance Insights data. The default is 7
	// days. The following values are valid:
	//
	//    * 7
	//
	//    * month * 31, where month is a number of months from 1-23
	//
	//    * 731
	//
	// For example, the following values are valid:
	//
	//    * 93 (3 months * 31)
	//
	//    * 341 (11 months * 31)
	//
	//    * 589 (19 months * 31)
	//
	//    * 731
	//
	// If you specify a retention period such as 94, which isn't a valid value,
	// RDS issues an error.
	//
	// Valid for: Multi-AZ DB clusters only
	PerformanceInsightsRetentionPeriod *int64 `type:"integer"`

	// The port number on which the instances in the DB cluster accept connections.
	//
	// RDS for MySQL and Aurora MySQL
	//
	// Default: 3306
	//
	// Valid values: 1150-65535
	//
	// RDS for PostgreSQL and Aurora PostgreSQL
	//
	// Default: 5432
	//
	// Valid values: 1150-65535
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	Port *int64 `type:"integer"`

	// When you are replicating a DB cluster from one Amazon Web Services GovCloud
	// (US) Region to another, an URL that contains a Signature Version 4 signed
	// request for the CreateDBCluster operation to be called in the source Amazon
	// Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl
	// only when you are performing cross-Region replication from an encrypted DB
	// cluster.
	//
	// The presigned URL must be a valid request for the CreateDBCluster API operation
	// that can run in the source Amazon Web Services Region that contains the encrypted
	// DB cluster to copy.
	//
	// The presigned URL request must contain the following parameter values:
	//
	//    * KmsKeyId - The KMS key identifier for the KMS key to use to encrypt
	//    the copy of the DB cluster in the destination Amazon Web Services Region.
	//    This should refer to the same KMS key for both the CreateDBCluster operation
	//    that is called in the destination Amazon Web Services Region, and the
	//    operation contained in the presigned URL.
	//
	//    * DestinationRegion - The name of the Amazon Web Services Region that
	//    Aurora read replica will be created in.
	//
	//    * ReplicationSourceIdentifier - The DB cluster identifier for the encrypted
	//    DB cluster to be copied. This identifier must be in the Amazon Resource
	//    Name (ARN) format for the source Amazon Web Services Region. For example,
	//    if you are copying an encrypted DB cluster from the us-west-2 Amazon Web
	//    Services Region, then your ReplicationSourceIdentifier would look like
	//    Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
	//
	// To learn how to generate a Signature Version 4 signed request, see Authenticating
	// Requests: Using Query Parameters (Amazon Web Services Signature Version 4)
	// (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html)
	// and Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).
	//
	// If you are using an Amazon Web Services SDK tool or the CLI, you can specify
	// SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl
	// manually. Specifying SourceRegion autogenerates a presigned URL that is a
	// valid request for the operation that can run in the source Amazon Web Services
	// Region.
	//
	// Valid for: Aurora DB clusters only
	PreSignedUrl *string `type:"string"`

	// The daily time range during which automated backups are created if automated
	// backups are enabled using the BackupRetentionPeriod parameter.
	//
	// The default is a 30-minute window selected at random from an 8-hour block
	// of time for each Amazon Web Services Region. To view the time blocks available,
	// see Backup window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow)
	// in the Amazon Aurora User Guide.
	//
	// Constraints:
	//
	//    * Must be in the format hh24:mi-hh24:mi.
	//
	//    * Must be in Universal Coordinated Time (UTC).
	//
	//    * Must not conflict with the preferred maintenance window.
	//
	//    * Must be at least 30 minutes.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	PreferredBackupWindow *string `type:"string"`

	// The weekly time range during which system maintenance can occur, in Universal
	// Coordinated Time (UTC).
	//
	// Format: ddd:hh24:mi-ddd:hh24:mi
	//
	// The default is a 30-minute window selected at random from an 8-hour block
	// of time for each Amazon Web Services Region, occurring on a random day of
	// the week. To see the time blocks available, see Adjusting the Preferred DB
	// Cluster Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora)
	// in the Amazon Aurora User Guide.
	//
	// Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
	//
	// Constraints: Minimum 30-minute window.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	PreferredMaintenanceWindow *string `type:"string"`

	// A value that indicates whether the DB cluster is publicly accessible.
	//
	// When the DB cluster is publicly accessible, its Domain Name System (DNS)
	// endpoint resolves to the private IP address from within the DB cluster's
	// virtual private cloud (VPC). It resolves to the public IP address from outside
	// of the DB cluster's VPC. Access to the DB cluster is ultimately controlled
	// by the security group it uses. That public access isn't permitted if the
	// security group assigned to the DB cluster doesn't permit it.
	//
	// When the DB cluster isn't publicly accessible, it is an internal DB cluster
	// with a DNS name that resolves to a private IP address.
	//
	// Default: The default behavior varies depending on whether DBSubnetGroupName
	// is specified.
	//
	// If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified,
	// the following applies:
	//
	//    * If the default VPC in the target Region doesn’t have an internet gateway
	//    attached to it, the DB cluster is private.
	//
	//    * If the default VPC in the target Region has an internet gateway attached
	//    to it, the DB cluster is public.
	//
	// If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified,
	// the following applies:
	//
	//    * If the subnets are part of a VPC that doesn’t have an internet gateway
	//    attached to it, the DB cluster is private.
	//
	//    * If the subnets are part of a VPC that has an internet gateway attached
	//    to it, the DB cluster is public.
	//
	// Valid for: Multi-AZ DB clusters only
	PubliclyAccessible *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the source DB instance or DB cluster if
	// this DB cluster is created as a read replica.
	//
	// Valid for: Aurora DB clusters only
	ReplicationSourceIdentifier *string `type:"string"`

	// For DB clusters in serverless DB engine mode, the scaling properties of the
	// DB cluster.
	//
	// Valid for: Aurora DB clusters only
	ScalingConfiguration *ScalingConfiguration `type:"structure"`

	// Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
	//
	// For more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html)
	// in the Amazon Aurora User Guide.
	ServerlessV2ScalingConfiguration *ServerlessV2ScalingConfiguration `type:"structure"`

	// SourceRegion is the source region where the resource exists. This is not
	// sent over the wire and is only used for presigning. This value should always
	// have the same region as the source ARN.
	SourceRegion *string `type:"string" ignore:"true"`

	// A value that indicates whether the DB cluster is encrypted.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	StorageEncrypted *bool `type:"boolean"`

	// Specifies the storage type to be associated with the DB cluster.
	//
	// This setting is required to create a Multi-AZ DB cluster.
	//
	// Valid values: io1
	//
	// When specified, a value for the Iops parameter is required.
	//
	// Default: io1
	//
	// Valid for: Multi-AZ DB clusters only
	StorageType *string `type:"string"`

	// Tags to assign to the DB cluster.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// A list of EC2 VPC security groups to associate with this DB cluster.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDBClusterInput) GoString added in v0.7.1

func (s CreateDBClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBClusterInput) SetAllocatedStorage added in v1.42.11

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

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*CreateDBClusterInput) SetAutoMinorVersionUpgrade added in v1.42.11

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*CreateDBClusterInput) SetAvailabilityZones added in v1.5.0

func (s *CreateDBClusterInput) SetAvailabilityZones(v []*string) *CreateDBClusterInput

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*CreateDBClusterInput) SetBacktrackWindow added in v1.13.45

func (s *CreateDBClusterInput) SetBacktrackWindow(v int64) *CreateDBClusterInput

SetBacktrackWindow sets the BacktrackWindow field's value.

func (*CreateDBClusterInput) SetBackupRetentionPeriod added in v1.5.0

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*CreateDBClusterInput) SetCharacterSetName added in v1.5.0

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

SetCharacterSetName sets the CharacterSetName field's value.

func (*CreateDBClusterInput) SetCopyTagsToSnapshot added in v1.17.13

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

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*CreateDBClusterInput) SetDBClusterIdentifier added in v1.5.0

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*CreateDBClusterInput) SetDBClusterInstanceClass added in v1.42.11

func (s *CreateDBClusterInput) SetDBClusterInstanceClass(v string) *CreateDBClusterInput

SetDBClusterInstanceClass sets the DBClusterInstanceClass field's value.

func (*CreateDBClusterInput) SetDBClusterParameterGroupName added in v1.5.0

func (s *CreateDBClusterInput) SetDBClusterParameterGroupName(v string) *CreateDBClusterInput

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*CreateDBClusterInput) SetDBSubnetGroupName added in v1.5.0

func (s *CreateDBClusterInput) SetDBSubnetGroupName(v string) *CreateDBClusterInput

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*CreateDBClusterInput) SetDatabaseName added in v1.5.0

func (s *CreateDBClusterInput) SetDatabaseName(v string) *CreateDBClusterInput

SetDatabaseName sets the DatabaseName field's value.

func (*CreateDBClusterInput) SetDeletionProtection added in v1.15.43

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

SetDeletionProtection sets the DeletionProtection field's value.

func (*CreateDBClusterInput) SetDestinationRegion added in v1.7.5

func (s *CreateDBClusterInput) SetDestinationRegion(v string) *CreateDBClusterInput

SetDestinationRegion sets the DestinationRegion field's value.

func (*CreateDBClusterInput) SetDomain added in v1.29.5

SetDomain sets the Domain field's value.

func (*CreateDBClusterInput) SetDomainIAMRoleName added in v1.29.5

func (s *CreateDBClusterInput) SetDomainIAMRoleName(v string) *CreateDBClusterInput

SetDomainIAMRoleName sets the DomainIAMRoleName field's value.

func (*CreateDBClusterInput) SetEnableCloudwatchLogsExports added in v1.13.55

func (s *CreateDBClusterInput) SetEnableCloudwatchLogsExports(v []*string) *CreateDBClusterInput

SetEnableCloudwatchLogsExports sets the EnableCloudwatchLogsExports field's value.

func (*CreateDBClusterInput) SetEnableGlobalWriteForwarding added in v1.32.5

func (s *CreateDBClusterInput) SetEnableGlobalWriteForwarding(v bool) *CreateDBClusterInput

SetEnableGlobalWriteForwarding sets the EnableGlobalWriteForwarding field's value.

func (*CreateDBClusterInput) SetEnableHttpEndpoint added in v1.23.7

func (s *CreateDBClusterInput) SetEnableHttpEndpoint(v bool) *CreateDBClusterInput

SetEnableHttpEndpoint sets the EnableHttpEndpoint field's value.

func (*CreateDBClusterInput) SetEnableIAMDatabaseAuthentication added in v1.8.17

func (s *CreateDBClusterInput) SetEnableIAMDatabaseAuthentication(v bool) *CreateDBClusterInput

SetEnableIAMDatabaseAuthentication sets the EnableIAMDatabaseAuthentication field's value.

func (*CreateDBClusterInput) SetEnablePerformanceInsights added in v1.42.11

func (s *CreateDBClusterInput) SetEnablePerformanceInsights(v bool) *CreateDBClusterInput

SetEnablePerformanceInsights sets the EnablePerformanceInsights field's value.

func (*CreateDBClusterInput) SetEngine added in v1.5.0

SetEngine sets the Engine field's value.

func (*CreateDBClusterInput) SetEngineMode added in v1.15.9

func (s *CreateDBClusterInput) SetEngineMode(v string) *CreateDBClusterInput

SetEngineMode sets the EngineMode field's value.

func (*CreateDBClusterInput) SetEngineVersion added in v1.5.0

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

SetEngineVersion sets the EngineVersion field's value.

func (*CreateDBClusterInput) SetGlobalClusterIdentifier added in v1.15.85

func (s *CreateDBClusterInput) SetGlobalClusterIdentifier(v string) *CreateDBClusterInput

SetGlobalClusterIdentifier sets the GlobalClusterIdentifier field's value.

func (*CreateDBClusterInput) SetIops added in v1.42.11

SetIops sets the Iops field's value.

func (*CreateDBClusterInput) SetKmsKeyId added in v1.5.0

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateDBClusterInput) SetMasterUserPassword added in v1.5.0

func (s *CreateDBClusterInput) SetMasterUserPassword(v string) *CreateDBClusterInput

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*CreateDBClusterInput) SetMasterUsername added in v1.5.0

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

SetMasterUsername sets the MasterUsername field's value.

func (*CreateDBClusterInput) SetMonitoringInterval added in v1.42.11

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

SetMonitoringInterval sets the MonitoringInterval field's value.

func (*CreateDBClusterInput) SetMonitoringRoleArn added in v1.42.11

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

SetMonitoringRoleArn sets the MonitoringRoleArn field's value.

func (*CreateDBClusterInput) SetNetworkType added in v1.44.79

func (s *CreateDBClusterInput) SetNetworkType(v string) *CreateDBClusterInput

SetNetworkType sets the NetworkType field's value.

func (*CreateDBClusterInput) SetOptionGroupName added in v1.5.0

func (s *CreateDBClusterInput) SetOptionGroupName(v string) *CreateDBClusterInput

SetOptionGroupName sets the OptionGroupName field's value.

func (*CreateDBClusterInput) SetPerformanceInsightsKMSKeyId added in v1.42.11

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

SetPerformanceInsightsKMSKeyId sets the PerformanceInsightsKMSKeyId field's value.

func (*CreateDBClusterInput) SetPerformanceInsightsRetentionPeriod added in v1.42.11

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

SetPerformanceInsightsRetentionPeriod sets the PerformanceInsightsRetentionPeriod field's value.

func (*CreateDBClusterInput) SetPort added in v1.5.0

SetPort sets the Port field's value.

func (*CreateDBClusterInput) SetPreSignedUrl added in v1.7.5

func (s *CreateDBClusterInput) SetPreSignedUrl(v string) *CreateDBClusterInput

SetPreSignedUrl sets the PreSignedUrl field's value.

func (*CreateDBClusterInput) SetPreferredBackupWindow added in v1.5.0

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*CreateDBClusterInput) SetPreferredMaintenanceWindow added in v1.5.0

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*CreateDBClusterInput) SetPubliclyAccessible added in v1.42.11

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

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*CreateDBClusterInput) SetReplicationSourceIdentifier added in v1.5.0

func (s *CreateDBClusterInput) SetReplicationSourceIdentifier(v string) *CreateDBClusterInput

SetReplicationSourceIdentifier sets the ReplicationSourceIdentifier field's value.

func (*CreateDBClusterInput) SetScalingConfiguration added in v1.15.9

func (s *CreateDBClusterInput) SetScalingConfiguration(v *ScalingConfiguration) *CreateDBClusterInput

SetScalingConfiguration sets the ScalingConfiguration field's value.

func (*CreateDBClusterInput) SetServerlessV2ScalingConfiguration added in v1.43.43

func (s *CreateDBClusterInput) SetServerlessV2ScalingConfiguration(v *ServerlessV2ScalingConfiguration) *CreateDBClusterInput

SetServerlessV2ScalingConfiguration sets the ServerlessV2ScalingConfiguration field's value.

func (*CreateDBClusterInput) SetSourceRegion added in v1.7.5

func (s *CreateDBClusterInput) SetSourceRegion(v string) *CreateDBClusterInput

SetSourceRegion sets the SourceRegion field's value.

func (*CreateDBClusterInput) SetStorageEncrypted added in v1.5.0

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

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*CreateDBClusterInput) SetStorageType added in v1.42.11

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

SetStorageType sets the StorageType field's value.

func (*CreateDBClusterInput) SetTags added in v1.5.0

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

SetTags sets the Tags field's value.

func (*CreateDBClusterInput) SetVpcSecurityGroupIds added in v1.5.0

func (s *CreateDBClusterInput) SetVpcSecurityGroupIds(v []*string) *CreateDBClusterInput

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (CreateDBClusterInput) String added in v0.7.1

func (s CreateDBClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBClusterInput) Validate added in v1.1.21

func (s *CreateDBClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDBClusterOutput added in v0.7.1

type CreateDBClusterOutput struct {

	// Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
	//
	// For an Amazon Aurora DB cluster, this data type is used as a response element
	// in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot,
	// RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
	//
	// For a Multi-AZ DB cluster, this data type is used as a response element in
	// the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
	//
	// For more information on Amazon Aurora DB clusters, see What is Amazon Aurora?
	// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)
	// in the Amazon Aurora User Guide.
	//
	// For more information on Multi-AZ DB clusters, see Multi-AZ deployments with
	// two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
	// in the Amazon RDS User Guide.
	DBCluster *DBCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDBClusterOutput) GoString added in v0.7.1

func (s CreateDBClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBClusterOutput) SetDBCluster added in v1.5.0

SetDBCluster sets the DBCluster field's value.

func (CreateDBClusterOutput) String added in v0.7.1

func (s CreateDBClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDBClusterParameterGroupInput added in v0.7.1

type CreateDBClusterParameterGroupInput struct {

	// The name of the DB cluster parameter group.
	//
	// Constraints:
	//
	//    * Must not match the name of an existing DB cluster parameter group.
	//
	// This value is stored as a lowercase string.
	//
	// DBClusterParameterGroupName is a required field
	DBClusterParameterGroupName *string `type:"string" required:"true"`

	// The DB cluster parameter group family name. A DB cluster parameter group
	// can be associated with one and only one DB cluster parameter group family,
	// and can be applied only to a DB cluster running a database engine and engine
	// version compatible with that DB cluster parameter group family.
	//
	// Aurora MySQL
	//
	// Example: aurora5.6, aurora-mysql5.7, aurora-mysql8.0
	//
	// Aurora PostgreSQL
	//
	// Example: aurora-postgresql9.6
	//
	// RDS for MySQL
	//
	// Example: mysql8.0
	//
	// RDS for PostgreSQL
	//
	// Example: postgres12
	//
	// To list all of the available parameter group families for a DB engine, use
	// the following command:
	//
	// aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"
	// --engine <engine>
	//
	// For example, to list all of the available parameter group families for the
	// Aurora PostgreSQL DB engine, use the following command:
	//
	// aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"
	// --engine aurora-postgresql
	//
	// The output contains duplicates.
	//
	// The following are the valid DB engine values:
	//
	//    * aurora (for MySQL 5.6-compatible Aurora)
	//
	//    * aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
	//
	//    * aurora-postgresql
	//
	//    * mysql
	//
	//    * postgres
	//
	// DBParameterGroupFamily is a required field
	DBParameterGroupFamily *string `type:"string" required:"true"`

	// The description for the DB cluster parameter group.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// Tags to assign to the DB cluster parameter group.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDBClusterParameterGroupInput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBClusterParameterGroupInput) SetDBClusterParameterGroupName added in v1.5.0

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*CreateDBClusterParameterGroupInput) SetDBParameterGroupFamily added in v1.5.0

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*CreateDBClusterParameterGroupInput) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (*CreateDBClusterParameterGroupInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (CreateDBClusterParameterGroupInput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBClusterParameterGroupInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type CreateDBClusterParameterGroupOutput added in v0.7.1

type CreateDBClusterParameterGroupOutput struct {

	// Contains the details of an Amazon RDS DB cluster parameter group.
	//
	// This data type is used as a response element in the DescribeDBClusterParameterGroups
	// action.
	DBClusterParameterGroup *DBClusterParameterGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDBClusterParameterGroupOutput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBClusterParameterGroupOutput) SetDBClusterParameterGroup added in v1.5.0

SetDBClusterParameterGroup sets the DBClusterParameterGroup field's value.

func (CreateDBClusterParameterGroupOutput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDBClusterSnapshotInput added in v0.7.1

type CreateDBClusterSnapshotInput struct {

	// The identifier of the DB cluster to create a snapshot for. This parameter
	// isn't case-sensitive.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBCluster.
	//
	// Example: my-cluster1
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The identifier of the DB cluster snapshot. This parameter is stored as a
	// lowercase string.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 letters, numbers, or hyphens.
	//
	//    * First character must be a letter.
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens.
	//
	// Example: my-cluster1-snapshot1
	//
	// DBClusterSnapshotIdentifier is a required field
	DBClusterSnapshotIdentifier *string `type:"string" required:"true"`

	// The tags to be assigned to the DB cluster snapshot.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDBClusterSnapshotInput) GoString added in v0.7.1

func (s CreateDBClusterSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBClusterSnapshotInput) SetDBClusterIdentifier added in v1.5.0

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*CreateDBClusterSnapshotInput) SetDBClusterSnapshotIdentifier added in v1.5.0

func (s *CreateDBClusterSnapshotInput) SetDBClusterSnapshotIdentifier(v string) *CreateDBClusterSnapshotInput

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (*CreateDBClusterSnapshotInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (CreateDBClusterSnapshotInput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBClusterSnapshotInput) Validate added in v1.1.21

func (s *CreateDBClusterSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDBClusterSnapshotOutput added in v0.7.1

type CreateDBClusterSnapshotOutput struct {

	// Contains the details for an Amazon RDS DB cluster snapshot
	//
	// This data type is used as a response element in the DescribeDBClusterSnapshots
	// action.
	DBClusterSnapshot *DBClusterSnapshot `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDBClusterSnapshotOutput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBClusterSnapshotOutput) SetDBClusterSnapshot added in v1.5.0

SetDBClusterSnapshot sets the DBClusterSnapshot field's value.

func (CreateDBClusterSnapshotOutput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDBInstanceInput

type CreateDBInstanceInput struct {

	// The amount of storage in gibibytes (GiB) to allocate for the DB instance.
	//
	// Type: Integer
	//
	// Amazon Aurora
	//
	// Not applicable. Aurora cluster volumes automatically grow as the amount of
	// data in your database increases, though you are only charged for the space
	// that you use in an Aurora cluster volume.
	//
	// Amazon RDS Custom
	//
	// Constraints to the amount of storage for each storage type are the following:
	//
	//    * General Purpose (SSD) storage (gp2): Must be an integer from 40 to 65536
	//    for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
	//
	//    * Provisioned IOPS storage (io1): Must be an integer from 40 to 65536
	//    for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
	//
	// MySQL
	//
	// Constraints to the amount of storage for each storage type are the following:
	//
	//    * General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
	//
	//    * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
	//
	//    * Magnetic storage (standard): Must be an integer from 5 to 3072.
	//
	// MariaDB
	//
	// Constraints to the amount of storage for each storage type are the following:
	//
	//    * General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
	//
	//    * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
	//
	//    * Magnetic storage (standard): Must be an integer from 5 to 3072.
	//
	// PostgreSQL
	//
	// Constraints to the amount of storage for each storage type are the following:
	//
	//    * General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
	//
	//    * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
	//
	//    * Magnetic storage (standard): Must be an integer from 5 to 3072.
	//
	// Oracle
	//
	// Constraints to the amount of storage for each storage type are the following:
	//
	//    * General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
	//
	//    * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
	//
	//    * Magnetic storage (standard): Must be an integer from 10 to 3072.
	//
	// SQL Server
	//
	// Constraints to the amount of storage for each storage type are the following:
	//
	//    * General Purpose (SSD) storage (gp2): Enterprise and Standard editions:
	//    Must be an integer from 20 to 16384. Web and Express editions: Must be
	//    an integer from 20 to 16384.
	//
	//    * Provisioned IOPS storage (io1): Enterprise and Standard editions: Must
	//    be an integer from 100 to 16384. Web and Express editions: Must be an
	//    integer from 100 to 16384.
	//
	//    * Magnetic storage (standard): Enterprise and Standard editions: Must
	//    be an integer from 20 to 1024. Web and Express editions: Must be an integer
	//    from 20 to 1024.
	AllocatedStorage *int64 `type:"integer"`

	// A value that indicates whether minor engine upgrades are applied automatically
	// to the DB instance during the maintenance window. By default, minor engine
	// upgrades are applied automatically.
	//
	// If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade
	// to false.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// The Availability Zone (AZ) where the database will be created. For information
	// on Amazon Web Services Regions and Availability Zones, see Regions and Availability
	// Zones (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).
	//
	// Amazon Aurora
	//
	// Each Aurora DB cluster hosts copies of its storage in three separate Availability
	// Zones. Specify one of these Availability Zones. Aurora automatically chooses
	// an appropriate Availability Zone if you don't specify one.
	//
	// Default: A random, system-chosen Availability Zone in the endpoint's Amazon
	// Web Services Region.
	//
	// Example: us-east-1d
	//
	// Constraint: The AvailabilityZone parameter can't be specified if the DB instance
	// is a Multi-AZ deployment. The specified Availability Zone must be in the
	// same Amazon Web Services Region as the current endpoint.
	AvailabilityZone *string `type:"string"`

	// The number of days for which automated backups are retained. Setting this
	// parameter to a positive number enables backups. Setting this parameter to
	// 0 disables automated backups.
	//
	// Amazon Aurora
	//
	// Not applicable. The retention period for automated backups is managed by
	// the DB cluster.
	//
	// Default: 1
	//
	// Constraints:
	//
	//    * Must be a value from 0 to 35
	//
	//    * Can't be set to 0 if the DB instance is a source to read replicas
	//
	//    * Can't be set to 0 for an RDS Custom for Oracle DB instance
	BackupRetentionPeriod *int64 `type:"integer"`

	// Specifies where automated backups and manual snapshots are stored.
	//
	// Possible values are outposts (Amazon Web Services Outposts) and region (Amazon
	// Web Services Region). The default is region.
	//
	// For more information, see Working with Amazon RDS on Amazon Web Services
	// Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)
	// in the Amazon RDS User Guide.
	BackupTarget *string `type:"string"`

	// For supported engines, this value indicates that the DB instance should be
	// associated with the specified CharacterSet.
	//
	// This setting doesn't apply to RDS Custom. However, if you need to change
	// the character set, you can change it on the database itself.
	//
	// Amazon Aurora
	//
	// Not applicable. The character set is managed by the DB cluster. For more
	// information, see CreateDBCluster.
	CharacterSetName *string `type:"string"`

	// A value that indicates whether to copy tags from the DB instance to snapshots
	// of the DB instance. By default, tags are not copied.
	//
	// Amazon Aurora
	//
	// Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting
	// this value for an Aurora DB instance has no effect on the DB cluster setting.
	CopyTagsToSnapshot *bool `type:"boolean"`

	// The instance profile associated with the underlying Amazon EC2 instance of
	// an RDS Custom DB instance. The instance profile must meet the following requirements:
	//
	//    * The profile must exist in your account.
	//
	//    * The profile must have an IAM role that Amazon EC2 has permissions to
	//    assume.
	//
	//    * The instance profile name and the associated IAM role name must start
	//    with the prefix AWSRDSCustom.
	//
	// For the list of permissions required for the IAM role, see Configure IAM
	// and your VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc)
	// in the Amazon RDS User Guide.
	//
	// This setting is required for RDS Custom.
	CustomIamInstanceProfile *string `type:"string"`

	// The identifier of the DB cluster that the instance will belong to.
	//
	// This setting doesn't apply to RDS Custom.
	DBClusterIdentifier *string `type:"string"`

	// The compute and memory capacity of the DB instance, for example db.m5.large.
	// Not all DB instance classes are available in all Amazon Web Services Regions,
	// or for all database engines. For the full list of DB instance classes, and
	// availability for your engine, see DB instance classes (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)
	// in the Amazon RDS User Guide or Aurora DB instance classes (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html)
	// in the Amazon Aurora User Guide.
	//
	// DBInstanceClass is a required field
	DBInstanceClass *string `type:"string" required:"true"`

	// The DB instance identifier. This parameter is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 letters, numbers, or hyphens.
	//
	//    * First character must be a letter.
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens.
	//
	// Example: mydbinstance
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`

	// The meaning of this parameter differs according to the database engine you
	// use.
	//
	// MySQL
	//
	// The name of the database to create when the DB instance is created. If this
	// parameter isn't specified, no database is created in the DB instance.
	//
	// Constraints:
	//
	//    * Must contain 1 to 64 letters or numbers.
	//
	//    * Must begin with a letter. Subsequent characters can be letters, underscores,
	//    or digits (0-9).
	//
	//    * Can't be a word reserved by the specified database engine
	//
	// MariaDB
	//
	// The name of the database to create when the DB instance is created. If this
	// parameter isn't specified, no database is created in the DB instance.
	//
	// Constraints:
	//
	//    * Must contain 1 to 64 letters or numbers.
	//
	//    * Must begin with a letter. Subsequent characters can be letters, underscores,
	//    or digits (0-9).
	//
	//    * Can't be a word reserved by the specified database engine
	//
	// PostgreSQL
	//
	// The name of the database to create when the DB instance is created. If this
	// parameter isn't specified, a database named postgres is created in the DB
	// instance.
	//
	// Constraints:
	//
	//    * Must contain 1 to 63 letters, numbers, or underscores.
	//
	//    * Must begin with a letter. Subsequent characters can be letters, underscores,
	//    or digits (0-9).
	//
	//    * Can't be a word reserved by the specified database engine
	//
	// Oracle
	//
	// The Oracle System ID (SID) of the created DB instance. If you specify null,
	// the default value ORCL is used. You can't specify the string NULL, or any
	// other reserved word, for DBName.
	//
	// Default: ORCL
	//
	// Constraints:
	//
	//    * Can't be longer than 8 characters
	//
	// Amazon RDS Custom for Oracle
	//
	// The Oracle System ID (SID) of the created RDS Custom DB instance. If you
	// don't specify a value, the default value is ORCL.
	//
	// Default: ORCL
	//
	// Constraints:
	//
	//    * It must contain 1 to 8 alphanumeric characters.
	//
	//    * It must contain a letter.
	//
	//    * It can't be a word reserved by the database engine.
	//
	// Amazon RDS Custom for SQL Server
	//
	// Not applicable. Must be null.
	//
	// SQL Server
	//
	// Not applicable. Must be null.
	//
	// Amazon Aurora MySQL
	//
	// The name of the database to create when the primary DB instance of the Aurora
	// MySQL DB cluster is created. If this parameter isn't specified for an Aurora
	// MySQL DB cluster, no database is created in the DB cluster.
	//
	// Constraints:
	//
	//    * It must contain 1 to 64 alphanumeric characters.
	//
	//    * It can't be a word reserved by the database engine.
	//
	// Amazon Aurora PostgreSQL
	//
	// The name of the database to create when the primary DB instance of the Aurora
	// PostgreSQL DB cluster is created. If this parameter isn't specified for an
	// Aurora PostgreSQL DB cluster, a database named postgres is created in the
	// DB cluster.
	//
	// Constraints:
	//
	//    * It must contain 1 to 63 alphanumeric characters.
	//
	//    * It must begin with a letter or an underscore. Subsequent characters
	//    can be letters, underscores, or digits (0 to 9).
	//
	//    * It can't be a word reserved by the database engine.
	DBName *string `type:"string"`

	// The name of the DB parameter group to associate with this DB instance. If
	// you do not specify a value, then the default DB parameter group for the specified
	// DB engine and version is used.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Constraints:
	//
	//    * Must be 1 to 255 letters, numbers, or hyphens.
	//
	//    * First character must be a letter
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens
	DBParameterGroupName *string `type:"string"`

	// A list of DB security groups to associate with this DB instance.
	//
	// This setting applies to the legacy EC2-Classic platform, which is no longer
	// used to create new DB instances. Use the VpcSecurityGroupIds setting instead.
	DBSecurityGroups []*string `locationNameList:"DBSecurityGroupName" type:"list"`

	// A DB subnet group to associate with this DB instance.
	//
	// Constraints: Must match the name of an existing DBSubnetGroup. Must not be
	// default.
	//
	// Example: mydbsubnetgroup
	DBSubnetGroupName *string `type:"string"`

	// A value that indicates whether the DB instance has deletion protection enabled.
	// The database can't be deleted when deletion protection is enabled. By default,
	// deletion protection isn't enabled. For more information, see Deleting a DB
	// Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
	//
	// Amazon Aurora
	//
	// Not applicable. You can enable or disable deletion protection for the DB
	// cluster. For more information, see CreateDBCluster. DB instances in a DB
	// cluster can be deleted even when deletion protection is enabled for the DB
	// cluster.
	DeletionProtection *bool `type:"boolean"`

	// The Active Directory directory ID to create the DB instance in. Currently,
	// only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can
	// be created in an Active Directory Domain.
	//
	// For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html)
	// in the Amazon RDS User Guide.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Amazon Aurora
	//
	// Not applicable. The domain is managed by the DB cluster.
	Domain *string `type:"string"`

	// Specify the name of the IAM role to be used when making API calls to the
	// Directory Service.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Amazon Aurora
	//
	// Not applicable. The domain is managed by the DB cluster.
	DomainIAMRoleName *string `type:"string"`

	// The list of log types that need to be enabled for exporting to CloudWatch
	// Logs. The values in the list depend on the DB engine. For more information,
	// see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
	// in the Amazon RDS User Guide.
	//
	// Amazon Aurora
	//
	// Not applicable. CloudWatch Logs exports are managed by the DB cluster.
	//
	// RDS Custom
	//
	// Not applicable.
	//
	// MariaDB
	//
	// Possible values are audit, error, general, and slowquery.
	//
	// Microsoft SQL Server
	//
	// Possible values are agent and error.
	//
	// MySQL
	//
	// Possible values are audit, error, general, and slowquery.
	//
	// Oracle
	//
	// Possible values are alert, audit, listener, trace, and oemagent.
	//
	// PostgreSQL
	//
	// Possible values are postgresql and upgrade.
	EnableCloudwatchLogsExports []*string `type:"list"`

	// A value that indicates whether to enable a customer-owned IP address (CoIP)
	// for an RDS on Outposts DB instance.
	//
	// A CoIP provides local or external connectivity to resources in your Outpost
	// subnets through your on-premises network. For some use cases, a CoIP can
	// provide lower latency for connections to the DB instance from outside of
	// its virtual private cloud (VPC) on your local network.
	//
	// For more information about RDS on Outposts, see Working with Amazon RDS on
	// Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)
	// in the Amazon RDS User Guide.
	//
	// For more information about CoIPs, see Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing)
	// in the Amazon Web Services Outposts User Guide.
	EnableCustomerOwnedIp *bool `type:"boolean"`

	// A value that indicates whether to enable mapping of Amazon Web Services Identity
	// and Access Management (IAM) accounts to database accounts. By default, mapping
	// isn't enabled.
	//
	// For more information, see IAM Database Authentication for MySQL and PostgreSQL
	// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html)
	// in the Amazon RDS User Guide.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Amazon Aurora
	//
	// Not applicable. Mapping Amazon Web Services IAM accounts to database accounts
	// is managed by the DB cluster.
	EnableIAMDatabaseAuthentication *bool `type:"boolean"`

	// A value that indicates whether to enable Performance Insights for the DB
	// instance. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)
	// in the Amazon RDS User Guide.
	//
	// This setting doesn't apply to RDS Custom.
	EnablePerformanceInsights *bool `type:"boolean"`

	// The name of the database engine to be used for this instance.
	//
	// Not every database engine is available for every Amazon Web Services Region.
	//
	// Valid Values:
	//
	//    * aurora (for MySQL 5.6-compatible Aurora)
	//
	//    * aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
	//
	//    * aurora-postgresql
	//
	//    * custom-oracle-ee (for RDS Custom for Oracle instances)
	//
	//    * custom-sqlserver-ee (for RDS Custom for SQL Server instances)
	//
	//    * custom-sqlserver-se (for RDS Custom for SQL Server instances)
	//
	//    * custom-sqlserver-web (for RDS Custom for SQL Server instances)
	//
	//    * mariadb
	//
	//    * mysql
	//
	//    * oracle-ee
	//
	//    * oracle-ee-cdb
	//
	//    * oracle-se2
	//
	//    * oracle-se2-cdb
	//
	//    * postgres
	//
	//    * sqlserver-ee
	//
	//    * sqlserver-se
	//
	//    * sqlserver-ex
	//
	//    * sqlserver-web
	//
	// Engine is a required field
	Engine *string `type:"string" required:"true"`

	// The version number of the database engine to use.
	//
	// For a list of valid engine versions, use the DescribeDBEngineVersions operation.
	//
	// The following are the database engines and links to information about the
	// major and minor versions that are available with Amazon RDS. Not every database
	// engine is available for every Amazon Web Services Region.
	//
	// Amazon Aurora
	//
	// Not applicable. The version number of the database engine to be used by the
	// DB instance is managed by the DB cluster.
	//
	// Amazon RDS Custom for Oracle
	//
	// A custom engine version (CEV) that you have previously created. This setting
	// is required for RDS Custom for Oracle. The CEV name has the following format:
	// 19.customized_string . An example identifier is 19.my_cev1. For more information,
	// see Creating an RDS Custom for Oracle DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create)
	// in the Amazon RDS User Guide.
	//
	// Amazon RDS Custom for SQL Server
	//
	// See RDS Custom for SQL Server general requirements (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html)
	// in the Amazon RDS User Guide.
	//
	// MariaDB
	//
	// For information, see MariaDB on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)
	// in the Amazon RDS User Guide.
	//
	// Microsoft SQL Server
	//
	// For information, see Microsoft SQL Server Versions on Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport)
	// in the Amazon RDS User Guide.
	//
	// MySQL
	//
	// For information, see MySQL on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)
	// in the Amazon RDS User Guide.
	//
	// Oracle
	//
	// For information, see Oracle Database Engine Release Notes (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html)
	// in the Amazon RDS User Guide.
	//
	// PostgreSQL
	//
	// For information, see Amazon RDS for PostgreSQL versions and extensions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts)
	// in the Amazon RDS User Guide.
	EngineVersion *string `type:"string"`

	// The amount of Provisioned IOPS (input/output operations per second) to be
	// initially allocated for the DB instance. For information about valid Iops
	// values, see Amazon RDS Provisioned IOPS storage to improve performance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS)
	// in the Amazon RDS User Guide.
	//
	// Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must
	// be a multiple between .5 and 50 of the storage amount for the DB instance.
	// For SQL Server DB instances, must be a multiple between 1 and 50 of the storage
	// amount for the DB instance.
	//
	// Amazon Aurora
	//
	// Not applicable. Storage is managed by the DB cluster.
	Iops *int64 `type:"integer"`

	// The Amazon Web Services KMS key identifier for an encrypted DB instance.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key. To use a KMS key in a different Amazon
	// Web Services account, specify the key ARN or alias ARN.
	//
	// Amazon Aurora
	//
	// Not applicable. The Amazon Web Services KMS key identifier is managed by
	// the DB cluster. For more information, see CreateDBCluster.
	//
	// If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId
	// parameter, then Amazon RDS uses your default KMS key. There is a default
	// KMS key for your Amazon Web Services account. Your Amazon Web Services account
	// has a different default KMS key for each Amazon Web Services Region.
	//
	// Amazon RDS Custom
	//
	// A KMS key is required for RDS Custom instances. For most RDS engines, if
	// you leave this parameter empty while enabling StorageEncrypted, the engine
	// uses the default KMS key. However, RDS Custom doesn't use the default key
	// when this parameter is empty. You must explicitly specify a key.
	KmsKeyId *string `type:"string"`

	// License model information for this DB instance.
	//
	// Valid values: license-included | bring-your-own-license | general-public-license
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Amazon Aurora
	//
	// Not applicable.
	LicenseModel *string `type:"string"`

	// The password for the master user. The password can include any printable
	// ASCII character except "/", """, or "@".
	//
	// Amazon Aurora
	//
	// Not applicable. The password for the master user is managed by the DB cluster.
	//
	// MariaDB
	//
	// Constraints: Must contain from 8 to 41 characters.
	//
	// Microsoft SQL Server
	//
	// Constraints: Must contain from 8 to 128 characters.
	//
	// MySQL
	//
	// Constraints: Must contain from 8 to 41 characters.
	//
	// Oracle
	//
	// Constraints: Must contain from 8 to 30 characters.
	//
	// PostgreSQL
	//
	// Constraints: Must contain from 8 to 128 characters.
	MasterUserPassword *string `type:"string"`

	// The name for the master user.
	//
	// Amazon Aurora
	//
	// Not applicable. The name for the master user is managed by the DB cluster.
	//
	// Amazon RDS
	//
	// Constraints:
	//
	//    * Required.
	//
	//    * Must be 1 to 16 letters, numbers, or underscores.
	//
	//    * First character must be a letter.
	//
	//    * Can't be a reserved word for the chosen database engine.
	MasterUsername *string `type:"string"`

	// The upper limit in gibibytes (GiB) to which Amazon RDS can automatically
	// scale the storage of the DB instance.
	//
	// For more information about this setting, including limitations that apply
	// to it, see Managing capacity automatically with Amazon RDS storage autoscaling
	// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling)
	// in the Amazon RDS User Guide.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Amazon Aurora
	//
	// Not applicable. Storage is managed by the DB cluster.
	MaxAllocatedStorage *int64 `type:"integer"`

	// The interval, in seconds, between points when Enhanced Monitoring metrics
	// are collected for the DB instance. To disable collection of Enhanced Monitoring
	// metrics, specify 0. The default is 0.
	//
	// If MonitoringRoleArn is specified, then you must set MonitoringInterval to
	// a value other than 0.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Valid Values: 0, 1, 5, 10, 15, 30, 60
	MonitoringInterval *int64 `type:"integer"`

	// The ARN for the IAM role that permits RDS to send enhanced monitoring metrics
	// to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.
	// For information on creating a monitoring role, see Setting Up and Enabling
	// Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling)
	// in the Amazon RDS User Guide.
	//
	// If MonitoringInterval is set to a value other than 0, then you must supply
	// a MonitoringRoleArn value.
	//
	// This setting doesn't apply to RDS Custom.
	MonitoringRoleArn *string `type:"string"`

	// A value that indicates whether the DB instance is a Multi-AZ deployment.
	// You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ
	// deployment.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Amazon Aurora
	//
	// Not applicable. DB instance Availability Zones (AZs) are managed by the DB
	// cluster.
	MultiAZ *bool `type:"boolean"`

	// The name of the NCHAR character set for the Oracle DB instance.
	//
	// This parameter doesn't apply to RDS Custom.
	NcharCharacterSetName *string `type:"string"`

	// The network type of the DB instance.
	//
	// Valid values:
	//
	//    * IPV4
	//
	//    * DUAL
	//
	// The network type is determined by the DBSubnetGroup specified for the DB
	// instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4
	// and the IPv6 protocols (DUAL).
	//
	// For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
	// in the Amazon RDS User Guide.
	NetworkType *string `type:"string"`

	// A value that indicates that the DB instance should be associated with the
	// specified option group.
	//
	// Permanent options, such as the TDE option for Oracle Advanced Security TDE,
	// can't be removed from an option group. Also, that option group can't be removed
	// from a DB instance after it is associated with a DB instance.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Amazon Aurora
	//
	// Not applicable.
	OptionGroupName *string `type:"string"`

	// The Amazon Web Services KMS key identifier for encryption of Performance
	// Insights data.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key.
	//
	// If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon
	// RDS uses your default KMS key. There is a default KMS key for your Amazon
	// Web Services account. Your Amazon Web Services account has a different default
	// KMS key for each Amazon Web Services Region.
	//
	// This setting doesn't apply to RDS Custom.
	PerformanceInsightsKMSKeyId *string `type:"string"`

	// The number of days to retain Performance Insights data. The default is 7
	// days. The following values are valid:
	//
	//    * 7
	//
	//    * month * 31, where month is a number of months from 1-23
	//
	//    * 731
	//
	// For example, the following values are valid:
	//
	//    * 93 (3 months * 31)
	//
	//    * 341 (11 months * 31)
	//
	//    * 589 (19 months * 31)
	//
	//    * 731
	//
	// If you specify a retention period such as 94, which isn't a valid value,
	// RDS issues an error.
	//
	// This setting doesn't apply to RDS Custom.
	PerformanceInsightsRetentionPeriod *int64 `type:"integer"`

	// The port number on which the database accepts connections.
	//
	// MySQL
	//
	// Default: 3306
	//
	// Valid values: 1150-65535
	//
	// Type: Integer
	//
	// MariaDB
	//
	// Default: 3306
	//
	// Valid values: 1150-65535
	//
	// Type: Integer
	//
	// PostgreSQL
	//
	// Default: 5432
	//
	// Valid values: 1150-65535
	//
	// Type: Integer
	//
	// Oracle
	//
	// Default: 1521
	//
	// Valid values: 1150-65535
	//
	// SQL Server
	//
	// Default: 1433
	//
	// Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and
	// 49152-49156.
	//
	// Amazon Aurora
	//
	// Default: 3306
	//
	// Valid values: 1150-65535
	//
	// Type: Integer
	Port *int64 `type:"integer"`

	// The daily time range during which automated backups are created if automated
	// backups are enabled, using the BackupRetentionPeriod parameter. The default
	// is a 30-minute window selected at random from an 8-hour block of time for
	// each Amazon Web Services Region. For more information, see Backup window
	// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow)
	// in the Amazon RDS User Guide.
	//
	// Amazon Aurora
	//
	// Not applicable. The daily time range for creating automated backups is managed
	// by the DB cluster.
	//
	// Constraints:
	//
	//    * Must be in the format hh24:mi-hh24:mi.
	//
	//    * Must be in Universal Coordinated Time (UTC).
	//
	//    * Must not conflict with the preferred maintenance window.
	//
	//    * Must be at least 30 minutes.
	PreferredBackupWindow *string `type:"string"`

	// The time range each week during which system maintenance can occur, in Universal
	// Coordinated Time (UTC). For more information, see Amazon RDS Maintenance
	// Window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance).
	//
	// Format: ddd:hh24:mi-ddd:hh24:mi
	//
	// The default is a 30-minute window selected at random from an 8-hour block
	// of time for each Amazon Web Services Region, occurring on a random day of
	// the week.
	//
	// Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
	//
	// Constraints: Minimum 30-minute window.
	PreferredMaintenanceWindow *string `type:"string"`

	// The number of CPU cores and the number of threads per core for the DB instance
	// class of the DB instance.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Amazon Aurora
	//
	// Not applicable.
	ProcessorFeatures []*ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"`

	// 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.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Default: 1
	//
	// Valid Values: 0 - 15
	PromotionTier *int64 `type:"integer"`

	// A value that indicates whether the DB instance is publicly accessible.
	//
	// When the DB instance is publicly accessible, its Domain Name System (DNS)
	// endpoint resolves to the private IP address from within the DB instance's
	// virtual private cloud (VPC). It resolves to the public IP address from outside
	// of the DB instance's VPC. Access to the DB instance is ultimately controlled
	// by the security group it uses. That public access is not permitted if the
	// security group assigned to the DB instance doesn't permit it.
	//
	// When the DB instance isn't publicly accessible, it is an internal DB instance
	// with a DNS name that resolves to a private IP address.
	//
	// Default: The default behavior varies depending on whether DBSubnetGroupName
	// is specified.
	//
	// If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified,
	// the following applies:
	//
	//    * If the default VPC in the target Region doesn’t have an internet gateway
	//    attached to it, the DB instance is private.
	//
	//    * If the default VPC in the target Region has an internet gateway attached
	//    to it, the DB instance is public.
	//
	// If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified,
	// the following applies:
	//
	//    * If the subnets are part of a VPC that doesn’t have an internet gateway
	//    attached to it, the DB instance is private.
	//
	//    * If the subnets are part of a VPC that has an internet gateway attached
	//    to it, the DB instance is public.
	PubliclyAccessible *bool `type:"boolean"`

	// A value that indicates whether the DB instance is encrypted. By default,
	// it isn't encrypted.
	//
	// For RDS Custom instances, either set this parameter to true or leave it unset.
	// If you set this parameter to false, RDS reports an error.
	//
	// Amazon Aurora
	//
	// Not applicable. The encryption for DB instances is managed by the DB cluster.
	StorageEncrypted *bool `type:"boolean"`

	// Specifies the storage type to be associated with the DB instance.
	//
	// Valid values: standard | gp2 | io1
	//
	// If you specify io1, you must also include a value for the Iops parameter.
	//
	// Default: io1 if the Iops parameter is specified, otherwise gp2
	//
	// Amazon Aurora
	//
	// Not applicable. Storage is managed by the DB cluster.
	StorageType *string `type:"string"`

	// Tags to assign to the DB instance.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// The ARN from the key store with which to associate the instance for TDE encryption.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Amazon Aurora
	//
	// Not applicable.
	TdeCredentialArn *string `type:"string"`

	// The password for the given ARN from the key store in order to access the
	// device.
	//
	// This setting doesn't apply to RDS Custom.
	TdeCredentialPassword *string `type:"string"`

	// The time zone of the DB instance. The time zone parameter is currently supported
	// only by Microsoft SQL Server (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone).
	Timezone *string `type:"string"`

	// A list of Amazon EC2 VPC security groups to associate with this DB instance.
	//
	// Amazon Aurora
	//
	// Not applicable. The associated list of EC2 VPC security groups is managed
	// by the DB cluster.
	//
	// Default: The default EC2 VPC security group for the DB subnet group's VPC.
	VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDBInstanceInput) GoString added in v0.6.5

func (s CreateDBInstanceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBInstanceInput) SetAllocatedStorage added in v1.5.0

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

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*CreateDBInstanceInput) SetAutoMinorVersionUpgrade added in v1.5.0

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*CreateDBInstanceInput) SetAvailabilityZone added in v1.5.0

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

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*CreateDBInstanceInput) SetBackupRetentionPeriod added in v1.5.0

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*CreateDBInstanceInput) SetBackupTarget added in v1.42.10

func (s *CreateDBInstanceInput) SetBackupTarget(v string) *CreateDBInstanceInput

SetBackupTarget sets the BackupTarget field's value.

func (*CreateDBInstanceInput) SetCharacterSetName added in v1.5.0

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

SetCharacterSetName sets the CharacterSetName field's value.

func (*CreateDBInstanceInput) SetCopyTagsToSnapshot added in v1.5.0

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

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*CreateDBInstanceInput) SetCustomIamInstanceProfile added in v1.41.10

func (s *CreateDBInstanceInput) SetCustomIamInstanceProfile(v string) *CreateDBInstanceInput

SetCustomIamInstanceProfile sets the CustomIamInstanceProfile field's value.

func (*CreateDBInstanceInput) SetDBClusterIdentifier added in v1.5.0

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*CreateDBInstanceInput) SetDBInstanceClass added in v1.5.0

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

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*CreateDBInstanceInput) SetDBInstanceIdentifier added in v1.5.0

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*CreateDBInstanceInput) SetDBName added in v1.5.0

SetDBName sets the DBName field's value.

func (*CreateDBInstanceInput) SetDBParameterGroupName added in v1.5.0

func (s *CreateDBInstanceInput) SetDBParameterGroupName(v string) *CreateDBInstanceInput

SetDBParameterGroupName sets the DBParameterGroupName field's value.

func (*CreateDBInstanceInput) SetDBSecurityGroups added in v1.5.0

func (s *CreateDBInstanceInput) SetDBSecurityGroups(v []*string) *CreateDBInstanceInput

SetDBSecurityGroups sets the DBSecurityGroups field's value.

func (*CreateDBInstanceInput) SetDBSubnetGroupName added in v1.5.0

func (s *CreateDBInstanceInput) SetDBSubnetGroupName(v string) *CreateDBInstanceInput

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*CreateDBInstanceInput) SetDeletionProtection added in v1.15.43

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

SetDeletionProtection sets the DeletionProtection field's value.

func (*CreateDBInstanceInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*CreateDBInstanceInput) SetDomainIAMRoleName added in v1.5.0

func (s *CreateDBInstanceInput) SetDomainIAMRoleName(v string) *CreateDBInstanceInput

SetDomainIAMRoleName sets the DomainIAMRoleName field's value.

func (*CreateDBInstanceInput) SetEnableCloudwatchLogsExports added in v1.12.63

func (s *CreateDBInstanceInput) SetEnableCloudwatchLogsExports(v []*string) *CreateDBInstanceInput

SetEnableCloudwatchLogsExports sets the EnableCloudwatchLogsExports field's value.

func (*CreateDBInstanceInput) SetEnableCustomerOwnedIp added in v1.36.14

func (s *CreateDBInstanceInput) SetEnableCustomerOwnedIp(v bool) *CreateDBInstanceInput

SetEnableCustomerOwnedIp sets the EnableCustomerOwnedIp field's value.

func (*CreateDBInstanceInput) SetEnableIAMDatabaseAuthentication added in v1.8.17

func (s *CreateDBInstanceInput) SetEnableIAMDatabaseAuthentication(v bool) *CreateDBInstanceInput

SetEnableIAMDatabaseAuthentication sets the EnableIAMDatabaseAuthentication field's value.

func (*CreateDBInstanceInput) SetEnablePerformanceInsights added in v1.10.50

func (s *CreateDBInstanceInput) SetEnablePerformanceInsights(v bool) *CreateDBInstanceInput

SetEnablePerformanceInsights sets the EnablePerformanceInsights field's value.

func (*CreateDBInstanceInput) SetEngine added in v1.5.0

SetEngine sets the Engine field's value.

func (*CreateDBInstanceInput) SetEngineVersion added in v1.5.0

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

SetEngineVersion sets the EngineVersion field's value.

func (*CreateDBInstanceInput) SetIops added in v1.5.0

SetIops sets the Iops field's value.

func (*CreateDBInstanceInput) SetKmsKeyId added in v1.5.0

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateDBInstanceInput) SetLicenseModel added in v1.5.0

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

SetLicenseModel sets the LicenseModel field's value.

func (*CreateDBInstanceInput) SetMasterUserPassword added in v1.5.0

func (s *CreateDBInstanceInput) SetMasterUserPassword(v string) *CreateDBInstanceInput

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*CreateDBInstanceInput) SetMasterUsername added in v1.5.0

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

SetMasterUsername sets the MasterUsername field's value.

func (*CreateDBInstanceInput) SetMaxAllocatedStorage added in v1.20.5

func (s *CreateDBInstanceInput) SetMaxAllocatedStorage(v int64) *CreateDBInstanceInput

SetMaxAllocatedStorage sets the MaxAllocatedStorage field's value.

func (*CreateDBInstanceInput) SetMonitoringInterval added in v1.5.0

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

SetMonitoringInterval sets the MonitoringInterval field's value.

func (*CreateDBInstanceInput) SetMonitoringRoleArn added in v1.5.0

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

SetMonitoringRoleArn sets the MonitoringRoleArn field's value.

func (*CreateDBInstanceInput) SetMultiAZ added in v1.5.0

SetMultiAZ sets the MultiAZ field's value.

func (*CreateDBInstanceInput) SetNcharCharacterSetName added in v1.35.2

func (s *CreateDBInstanceInput) SetNcharCharacterSetName(v string) *CreateDBInstanceInput

SetNcharCharacterSetName sets the NcharCharacterSetName field's value.

func (*CreateDBInstanceInput) SetNetworkType added in v1.44.4

func (s *CreateDBInstanceInput) SetNetworkType(v string) *CreateDBInstanceInput

SetNetworkType sets the NetworkType field's value.

func (*CreateDBInstanceInput) SetOptionGroupName added in v1.5.0

func (s *CreateDBInstanceInput) SetOptionGroupName(v string) *CreateDBInstanceInput

SetOptionGroupName sets the OptionGroupName field's value.

func (*CreateDBInstanceInput) SetPerformanceInsightsKMSKeyId added in v1.10.50

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

SetPerformanceInsightsKMSKeyId sets the PerformanceInsightsKMSKeyId field's value.

func (*CreateDBInstanceInput) SetPerformanceInsightsRetentionPeriod added in v1.14.10

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

SetPerformanceInsightsRetentionPeriod sets the PerformanceInsightsRetentionPeriod field's value.

func (*CreateDBInstanceInput) SetPort added in v1.5.0

SetPort sets the Port field's value.

func (*CreateDBInstanceInput) SetPreferredBackupWindow added in v1.5.0

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*CreateDBInstanceInput) SetPreferredMaintenanceWindow added in v1.5.0

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*CreateDBInstanceInput) SetProcessorFeatures added in v1.14.1

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

SetProcessorFeatures sets the ProcessorFeatures field's value.

func (*CreateDBInstanceInput) SetPromotionTier added in v1.5.0

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

SetPromotionTier sets the PromotionTier field's value.

func (*CreateDBInstanceInput) SetPubliclyAccessible added in v1.5.0

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

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*CreateDBInstanceInput) SetStorageEncrypted added in v1.5.0

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

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*CreateDBInstanceInput) SetStorageType added in v1.5.0

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

SetStorageType sets the StorageType field's value.

func (*CreateDBInstanceInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (*CreateDBInstanceInput) SetTdeCredentialArn added in v1.5.0

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

SetTdeCredentialArn sets the TdeCredentialArn field's value.

func (*CreateDBInstanceInput) SetTdeCredentialPassword added in v1.5.0

func (s *CreateDBInstanceInput) SetTdeCredentialPassword(v string) *CreateDBInstanceInput

SetTdeCredentialPassword sets the TdeCredentialPassword field's value.

func (*CreateDBInstanceInput) SetTimezone added in v1.5.0

SetTimezone sets the Timezone field's value.

func (*CreateDBInstanceInput) SetVpcSecurityGroupIds added in v1.5.0

func (s *CreateDBInstanceInput) SetVpcSecurityGroupIds(v []*string) *CreateDBInstanceInput

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (CreateDBInstanceInput) String added in v0.6.5

func (s CreateDBInstanceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBInstanceInput) Validate added in v1.1.21

func (s *CreateDBInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDBInstanceOutput

type CreateDBInstanceOutput struct {

	// Contains the details of an Amazon RDS DB instance.
	//
	// This data type is used as a response element in the operations CreateDBInstance,
	// CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance,
	// PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,
	// RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
	DBInstance *DBInstance `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDBInstanceOutput) GoString added in v0.6.5

func (s CreateDBInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBInstanceOutput) SetDBInstance added in v1.5.0

SetDBInstance sets the DBInstance field's value.

func (CreateDBInstanceOutput) String added in v0.6.5

func (s CreateDBInstanceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDBInstanceReadReplicaInput

type CreateDBInstanceReadReplicaInput struct {

	// A value that indicates whether minor engine upgrades are applied automatically
	// to the read replica during the maintenance window.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Default: Inherits from the source DB instance
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// The Availability Zone (AZ) where the read replica will be created.
	//
	// Default: A random, system-chosen Availability Zone in the endpoint's Amazon
	// Web Services Region.
	//
	// Example: us-east-1d
	AvailabilityZone *string `type:"string"`

	// A value that indicates whether to copy all tags from the read replica to
	// snapshots of the read replica. By default, tags are not copied.
	CopyTagsToSnapshot *bool `type:"boolean"`

	// The instance profile associated with the underlying Amazon EC2 instance of
	// an RDS Custom DB instance. The instance profile must meet the following requirements:
	//
	//    * The profile must exist in your account.
	//
	//    * The profile must have an IAM role that Amazon EC2 has permissions to
	//    assume.
	//
	//    * The instance profile name and the associated IAM role name must start
	//    with the prefix AWSRDSCustom.
	//
	// For the list of permissions required for the IAM role, see Configure IAM
	// and your VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc)
	// in the Amazon RDS User Guide.
	//
	// This setting is required for RDS Custom.
	CustomIamInstanceProfile *string `type:"string"`

	// The compute and memory capacity of the read replica, for example db.m4.large.
	// Not all DB instance classes are available in all Amazon Web Services Regions,
	// or for all database engines. For the full list of DB instance classes, and
	// availability for your engine, see DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)
	// in the Amazon RDS User Guide.
	//
	// Default: Inherits from the source DB instance.
	DBInstanceClass *string `type:"string"`

	// The DB instance identifier of the read replica. This identifier is the unique
	// key that identifies a DB instance. This parameter is stored as a lowercase
	// string.
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`

	// The name of the DB parameter group to associate with this DB instance.
	//
	// If you do not specify a value for DBParameterGroupName, then Amazon RDS uses
	// the DBParameterGroup of source DB instance for a same Region read replica,
	// or the default DBParameterGroup for the specified DB engine for a cross-Region
	// read replica.
	//
	// Specifying a parameter group for this operation is only supported for MySQL
	// and Oracle DB instances. It isn't supported for RDS Custom.
	//
	// Constraints:
	//
	//    * Must be 1 to 255 letters, numbers, or hyphens.
	//
	//    * First character must be a letter
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens
	DBParameterGroupName *string `type:"string"`

	// Specifies a DB subnet group for the DB instance. The new DB instance is created
	// in the VPC associated with the DB subnet group. If no DB subnet group is
	// specified, then the new DB instance isn't created in a VPC.
	//
	// Constraints:
	//
	//    * Can only be specified if the source DB instance identifier specifies
	//    a DB instance in another Amazon Web Services Region.
	//
	//    * If supplied, must match the name of an existing DBSubnetGroup.
	//
	//    * The specified DB subnet group must be in the same Amazon Web Services
	//    Region in which the operation is running.
	//
	//    * All read replicas in one Amazon Web Services Region that are created
	//    from the same source DB instance must either:> Specify DB subnet groups
	//    from the same VPC. All these read replicas are created in the same VPC.
	//    Not specify a DB subnet group. All these read replicas are created outside
	//    of any VPC.
	//
	// Example: mydbsubnetgroup
	DBSubnetGroupName *string `type:"string"`

	// A value that indicates whether the DB instance has deletion protection enabled.
	// The database can't be deleted when deletion protection is enabled. By default,
	// deletion protection isn't enabled. For more information, see Deleting a DB
	// Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
	DeletionProtection *bool `type:"boolean"`

	// DestinationRegion is used for presigning the request to a given region.
	DestinationRegion *string `type:"string"`

	// The Active Directory directory ID to create the DB instance in. Currently,
	// only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can
	// be created in an Active Directory Domain.
	//
	// For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html)
	// in the Amazon RDS User Guide.
	//
	// This setting doesn't apply to RDS Custom.
	Domain *string `type:"string"`

	// Specify the name of the IAM role to be used when making API calls to the
	// Directory Service.
	//
	// This setting doesn't apply to RDS Custom.
	DomainIAMRoleName *string `type:"string"`

	// The list of logs that the new DB instance is to export to CloudWatch Logs.
	// The values in the list depend on the DB engine being used. For more information,
	// see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
	// in the Amazon RDS User Guide.
	//
	// This setting doesn't apply to RDS Custom.
	EnableCloudwatchLogsExports []*string `type:"list"`

	// A value that indicates whether to enable mapping of Amazon Web Services Identity
	// and Access Management (IAM) accounts to database accounts. By default, mapping
	// isn't enabled.
	//
	// For more information about IAM database authentication, see IAM Database
	// Authentication for MySQL and PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html)
	// in the Amazon RDS User Guide.
	//
	// This setting doesn't apply to RDS Custom.
	EnableIAMDatabaseAuthentication *bool `type:"boolean"`

	// A value that indicates whether to enable Performance Insights for the read
	// replica.
	//
	// For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)
	// in the Amazon RDS User Guide.
	//
	// This setting doesn't apply to RDS Custom.
	EnablePerformanceInsights *bool `type:"boolean"`

	// The amount of Provisioned IOPS (input/output operations per second) to be
	// initially allocated for the DB instance.
	Iops *int64 `type:"integer"`

	// The Amazon Web Services KMS key identifier for an encrypted read replica.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key.
	//
	// If you create an encrypted read replica in the same Amazon Web Services Region
	// as the source DB instance, then do not specify a value for this parameter.
	// A read replica in the same Amazon Web Services Region is always encrypted
	// with the same KMS key as the source DB instance.
	//
	// If you create an encrypted read replica in a different Amazon Web Services
	// Region, then you must specify a KMS key identifier for the destination Amazon
	// Web Services Region. KMS keys are specific to the Amazon Web Services Region
	// that they are created in, and you can't use KMS keys from one Amazon Web
	// Services Region in another Amazon Web Services Region.
	//
	// You can't create an encrypted read replica from an unencrypted DB instance.
	//
	// This setting doesn't apply to RDS Custom, which uses the same KMS key as
	// the primary replica.
	KmsKeyId *string `type:"string"`

	// The upper limit in gibibytes (GiB) to which Amazon RDS can automatically
	// scale the storage of the DB instance.
	//
	// For more information about this setting, including limitations that apply
	// to it, see Managing capacity automatically with Amazon RDS storage autoscaling
	// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling)
	// in the Amazon RDS User Guide.
	MaxAllocatedStorage *int64 `type:"integer"`

	// The interval, in seconds, between points when Enhanced Monitoring metrics
	// are collected for the read replica. To disable collecting Enhanced Monitoring
	// metrics, specify 0. The default is 0.
	//
	// If MonitoringRoleArn is specified, then you must also set MonitoringInterval
	// to a value other than 0.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Valid Values: 0, 1, 5, 10, 15, 30, 60
	MonitoringInterval *int64 `type:"integer"`

	// The ARN for the IAM role that permits RDS to send enhanced monitoring metrics
	// to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.
	// For information on creating a monitoring role, go to To create an IAM role
	// for Amazon RDS Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole)
	// in the Amazon RDS User Guide.
	//
	// If MonitoringInterval is set to a value other than 0, then you must supply
	// a MonitoringRoleArn value.
	//
	// This setting doesn't apply to RDS Custom.
	MonitoringRoleArn *string `type:"string"`

	// A value that indicates whether the read replica is in a Multi-AZ deployment.
	//
	// You can create a read replica as a Multi-AZ DB instance. RDS creates a standby
	// of your replica in another Availability Zone for failover support for the
	// replica. Creating your read replica as a Multi-AZ DB instance is independent
	// of whether the source database is a Multi-AZ DB instance.
	//
	// This setting doesn't apply to RDS Custom.
	MultiAZ *bool `type:"boolean"`

	// The network type of the DB instance.
	//
	// Valid values:
	//
	//    * IPV4
	//
	//    * DUAL
	//
	// The network type is determined by the DBSubnetGroup specified for read replica.
	// A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6
	// protocols (DUAL).
	//
	// For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
	// in the Amazon RDS User Guide.
	NetworkType *string `type:"string"`

	// The option group the DB instance is associated with. If omitted, the option
	// group associated with the source instance is used.
	//
	// For SQL Server, you must use the option group associated with the source
	// instance.
	//
	// This setting doesn't apply to RDS Custom.
	OptionGroupName *string `type:"string"`

	// The Amazon Web Services KMS key identifier for encryption of Performance
	// Insights data.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key.
	//
	// If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon
	// RDS uses your default KMS key. There is a default KMS key for your Amazon
	// Web Services account. Your Amazon Web Services account has a different default
	// KMS key for each Amazon Web Services Region.
	//
	// This setting doesn't apply to RDS Custom.
	PerformanceInsightsKMSKeyId *string `type:"string"`

	// The number of days to retain Performance Insights data. The default is 7
	// days. The following values are valid:
	//
	//    * 7
	//
	//    * month * 31, where month is a number of months from 1-23
	//
	//    * 731
	//
	// For example, the following values are valid:
	//
	//    * 93 (3 months * 31)
	//
	//    * 341 (11 months * 31)
	//
	//    * 589 (19 months * 31)
	//
	//    * 731
	//
	// If you specify a retention period such as 94, which isn't a valid value,
	// RDS issues an error.
	//
	// This setting doesn't apply to RDS Custom.
	PerformanceInsightsRetentionPeriod *int64 `type:"integer"`

	// The port number that the DB instance uses for connections.
	//
	// Default: Inherits from the source DB instance
	//
	// Valid Values: 1150-65535
	Port *int64 `type:"integer"`

	// When you are creating a read replica from one Amazon Web Services GovCloud
	// (US) Region to another or from one China Amazon Web Services Region to another,
	// the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica
	// API operation in the source Amazon Web Services Region that contains the
	// source DB instance.
	//
	// This setting applies only to Amazon Web Services GovCloud (US) Regions and
	// China Amazon Web Services Regions. It's ignored in other Amazon Web Services
	// Regions.
	//
	// You must specify this parameter when you create an encrypted read replica
	// from another Amazon Web Services Region by using the Amazon RDS API. Don't
	// specify PreSignedUrl when you are creating an encrypted read replica in the
	// same Amazon Web Services Region.
	//
	// The presigned URL must be a valid request for the CreateDBInstanceReadReplica
	// API operation that can run in the source Amazon Web Services Region that
	// contains the encrypted source DB instance. The presigned URL request must
	// contain the following parameter values:
	//
	//    * DestinationRegion - The Amazon Web Services Region that the encrypted
	//    read replica is created in. This Amazon Web Services Region is the same
	//    one where the CreateDBInstanceReadReplica operation is called that contains
	//    this presigned URL. For example, if you create an encrypted DB instance
	//    in the us-west-1 Amazon Web Services Region, from a source DB instance
	//    in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica
	//    operation in the us-east-1 Amazon Web Services Region and provide a presigned
	//    URL that contains a call to the CreateDBInstanceReadReplica operation
	//    in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion
	//    in the presigned URL must be set to the us-east-1 Amazon Web Services
	//    Region.
	//
	//    * KmsKeyId - The KMS key identifier for the key to use to encrypt the
	//    read replica in the destination Amazon Web Services Region. This is the
	//    same identifier for both the CreateDBInstanceReadReplica operation that
	//    is called in the destination Amazon Web Services Region, and the operation
	//    contained in the presigned URL.
	//
	//    * SourceDBInstanceIdentifier - The DB instance identifier for the encrypted
	//    DB instance to be replicated. This identifier must be in the Amazon Resource
	//    Name (ARN) format for the source Amazon Web Services Region. For example,
	//    if you are creating an encrypted read replica from a DB instance in the
	//    us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier
	//    looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
	//
	// To learn how to generate a Signature Version 4 signed request, see Authenticating
	// Requests: Using Query Parameters (Amazon Web Services Signature Version 4)
	// (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html)
	// and Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).
	//
	// If you are using an Amazon Web Services SDK tool or the CLI, you can specify
	// SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl
	// manually. Specifying SourceRegion autogenerates a presigned URL that is a
	// valid request for the operation that can run in the source Amazon Web Services
	// Region.
	//
	// SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server
	// doesn't support cross-Region read replicas.
	//
	// This setting doesn't apply to RDS Custom.
	PreSignedUrl *string `type:"string"`

	// The number of CPU cores and the number of threads per core for the DB instance
	// class of the DB instance.
	//
	// This setting doesn't apply to RDS Custom.
	ProcessorFeatures []*ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"`

	// A value that indicates whether the DB instance is publicly accessible.
	//
	// When the DB cluster is publicly accessible, its Domain Name System (DNS)
	// endpoint resolves to the private IP address from within the DB cluster's
	// virtual private cloud (VPC). It resolves to the public IP address from outside
	// of the DB cluster's VPC. Access to the DB cluster is ultimately controlled
	// by the security group it uses. That public access isn't permitted if the
	// security group assigned to the DB cluster doesn't permit it.
	//
	// When the DB instance isn't publicly accessible, it is an internal DB instance
	// with a DNS name that resolves to a private IP address.
	//
	// For more information, see CreateDBInstance.
	PubliclyAccessible *bool `type:"boolean"`

	// The open mode of the replica database: mounted or read-only.
	//
	// This parameter is only supported for Oracle DB instances.
	//
	// Mounted DB replicas are included in Oracle Database Enterprise Edition. The
	// main use case for mounted replicas is cross-Region disaster recovery. The
	// primary database doesn't use Active Data Guard to transmit information to
	// the mounted replica. Because it doesn't accept user connections, a mounted
	// replica can't serve a read-only workload.
	//
	// You can create a combination of mounted and read-only DB replicas for the
	// same primary DB instance. For more information, see Working with Oracle Read
	// Replicas for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html)
	// in the Amazon RDS User Guide.
	//
	// For RDS Custom, you must specify this parameter and set it to mounted. The
	// value won't be set by default. After replica creation, you can manage the
	// open mode manually.
	ReplicaMode *string `type:"string" enum:"ReplicaMode"`

	// The identifier of the DB instance that will act as the source for the read
	// replica. Each DB instance can have up to five read replicas.
	//
	// Constraints:
	//
	//    * Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL,
	//    or SQL Server DB instance.
	//
	//    * Can specify a DB instance that is a MySQL read replica only if the source
	//    is running MySQL 5.6 or later.
	//
	//    * For the limitations of Oracle read replicas, see Read Replica Limitations
	//    with Oracle (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html)
	//    in the Amazon RDS User Guide.
	//
	//    * For the limitations of SQL Server read replicas, see Read Replica Limitations
	//    with Microsoft SQL Server (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.Limitations.html)
	//    in the Amazon RDS User Guide.
	//
	//    * Can specify a PostgreSQL DB instance only if the source is running PostgreSQL
	//    9.3.5 or later (9.4.7 and higher for cross-Region replication).
	//
	//    * The specified DB instance must have automatic backups enabled, that
	//    is, its backup retention period must be greater than 0.
	//
	//    * If the source DB instance is in the same Amazon Web Services Region
	//    as the read replica, specify a valid DB instance identifier.
	//
	//    * If the source DB instance is in a different Amazon Web Services Region
	//    from the read replica, specify a valid DB instance ARN. For more information,
	//    see Constructing an ARN for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing)
	//    in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS
	//    Custom, which don't support cross-Region replicas.
	//
	// SourceDBInstanceIdentifier is a required field
	SourceDBInstanceIdentifier *string `type:"string" required:"true"`

	// SourceRegion is the source region where the resource exists. This is not
	// sent over the wire and is only used for presigning. This value should always
	// have the same region as the source ARN.
	SourceRegion *string `type:"string" ignore:"true"`

	// Specifies the storage type to be associated with the read replica.
	//
	// Valid values: standard | gp2 | io1
	//
	// If you specify io1, you must also include a value for the Iops parameter.
	//
	// Default: io1 if the Iops parameter is specified, otherwise gp2
	StorageType *string `type:"string"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// A value that indicates whether the DB instance class of the DB instance uses
	// its default processor features.
	//
	// This setting doesn't apply to RDS Custom.
	UseDefaultProcessorFeatures *bool `type:"boolean"`

	// A list of Amazon EC2 VPC security groups to associate with the read replica.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Default: The default EC2 VPC security group for the DB subnet group's VPC.
	VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDBInstanceReadReplicaInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBInstanceReadReplicaInput) SetAutoMinorVersionUpgrade added in v1.5.0

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*CreateDBInstanceReadReplicaInput) SetAvailabilityZone added in v1.5.0

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*CreateDBInstanceReadReplicaInput) SetCopyTagsToSnapshot added in v1.5.0

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*CreateDBInstanceReadReplicaInput) SetCustomIamInstanceProfile added in v1.41.10

SetCustomIamInstanceProfile sets the CustomIamInstanceProfile field's value.

func (*CreateDBInstanceReadReplicaInput) SetDBInstanceClass added in v1.5.0

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*CreateDBInstanceReadReplicaInput) SetDBInstanceIdentifier added in v1.5.0

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*CreateDBInstanceReadReplicaInput) SetDBParameterGroupName added in v1.23.20

SetDBParameterGroupName sets the DBParameterGroupName field's value.

func (*CreateDBInstanceReadReplicaInput) SetDBSubnetGroupName added in v1.5.0

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*CreateDBInstanceReadReplicaInput) SetDeletionProtection added in v1.15.43

SetDeletionProtection sets the DeletionProtection field's value.

func (*CreateDBInstanceReadReplicaInput) SetDestinationRegion added in v1.6.17

SetDestinationRegion sets the DestinationRegion field's value.

func (*CreateDBInstanceReadReplicaInput) SetDomain added in v1.25.2

SetDomain sets the Domain field's value.

func (*CreateDBInstanceReadReplicaInput) SetDomainIAMRoleName added in v1.25.2

SetDomainIAMRoleName sets the DomainIAMRoleName field's value.

func (*CreateDBInstanceReadReplicaInput) SetEnableCloudwatchLogsExports added in v1.12.63

func (s *CreateDBInstanceReadReplicaInput) SetEnableCloudwatchLogsExports(v []*string) *CreateDBInstanceReadReplicaInput

SetEnableCloudwatchLogsExports sets the EnableCloudwatchLogsExports field's value.

func (*CreateDBInstanceReadReplicaInput) SetEnableIAMDatabaseAuthentication added in v1.8.17

func (s *CreateDBInstanceReadReplicaInput) SetEnableIAMDatabaseAuthentication(v bool) *CreateDBInstanceReadReplicaInput

SetEnableIAMDatabaseAuthentication sets the EnableIAMDatabaseAuthentication field's value.

func (*CreateDBInstanceReadReplicaInput) SetEnablePerformanceInsights added in v1.10.50

func (s *CreateDBInstanceReadReplicaInput) SetEnablePerformanceInsights(v bool) *CreateDBInstanceReadReplicaInput

SetEnablePerformanceInsights sets the EnablePerformanceInsights field's value.

func (*CreateDBInstanceReadReplicaInput) SetIops added in v1.5.0

SetIops sets the Iops field's value.

func (*CreateDBInstanceReadReplicaInput) SetKmsKeyId added in v1.6.17

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateDBInstanceReadReplicaInput) SetMaxAllocatedStorage added in v1.35.22

SetMaxAllocatedStorage sets the MaxAllocatedStorage field's value.

func (*CreateDBInstanceReadReplicaInput) SetMonitoringInterval added in v1.5.0

SetMonitoringInterval sets the MonitoringInterval field's value.

func (*CreateDBInstanceReadReplicaInput) SetMonitoringRoleArn added in v1.5.0

SetMonitoringRoleArn sets the MonitoringRoleArn field's value.

func (*CreateDBInstanceReadReplicaInput) SetMultiAZ added in v1.12.60

SetMultiAZ sets the MultiAZ field's value.

func (*CreateDBInstanceReadReplicaInput) SetNetworkType added in v1.44.4

SetNetworkType sets the NetworkType field's value.

func (*CreateDBInstanceReadReplicaInput) SetOptionGroupName added in v1.5.0

SetOptionGroupName sets the OptionGroupName field's value.

func (*CreateDBInstanceReadReplicaInput) SetPerformanceInsightsKMSKeyId added in v1.10.50

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

SetPerformanceInsightsKMSKeyId sets the PerformanceInsightsKMSKeyId field's value.

func (*CreateDBInstanceReadReplicaInput) SetPerformanceInsightsRetentionPeriod added in v1.14.10

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

SetPerformanceInsightsRetentionPeriod sets the PerformanceInsightsRetentionPeriod field's value.

func (*CreateDBInstanceReadReplicaInput) SetPort added in v1.5.0

SetPort sets the Port field's value.

func (*CreateDBInstanceReadReplicaInput) SetPreSignedUrl added in v1.6.17

SetPreSignedUrl sets the PreSignedUrl field's value.

func (*CreateDBInstanceReadReplicaInput) SetProcessorFeatures added in v1.14.1

SetProcessorFeatures sets the ProcessorFeatures field's value.

func (*CreateDBInstanceReadReplicaInput) SetPubliclyAccessible added in v1.5.0

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*CreateDBInstanceReadReplicaInput) SetReplicaMode added in v1.34.4

SetReplicaMode sets the ReplicaMode field's value.

func (*CreateDBInstanceReadReplicaInput) SetSourceDBInstanceIdentifier added in v1.5.0

func (s *CreateDBInstanceReadReplicaInput) SetSourceDBInstanceIdentifier(v string) *CreateDBInstanceReadReplicaInput

SetSourceDBInstanceIdentifier sets the SourceDBInstanceIdentifier field's value.

func (*CreateDBInstanceReadReplicaInput) SetSourceRegion added in v1.6.17

SetSourceRegion sets the SourceRegion field's value.

func (*CreateDBInstanceReadReplicaInput) SetStorageType added in v1.5.0

SetStorageType sets the StorageType field's value.

func (*CreateDBInstanceReadReplicaInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (*CreateDBInstanceReadReplicaInput) SetUseDefaultProcessorFeatures added in v1.14.1

func (s *CreateDBInstanceReadReplicaInput) SetUseDefaultProcessorFeatures(v bool) *CreateDBInstanceReadReplicaInput

SetUseDefaultProcessorFeatures sets the UseDefaultProcessorFeatures field's value.

func (*CreateDBInstanceReadReplicaInput) SetVpcSecurityGroupIds added in v1.15.79

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (CreateDBInstanceReadReplicaInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBInstanceReadReplicaInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type CreateDBInstanceReadReplicaOutput

type CreateDBInstanceReadReplicaOutput struct {

	// Contains the details of an Amazon RDS DB instance.
	//
	// This data type is used as a response element in the operations CreateDBInstance,
	// CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance,
	// PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,
	// RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
	DBInstance *DBInstance `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDBInstanceReadReplicaOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBInstanceReadReplicaOutput) SetDBInstance added in v1.5.0

SetDBInstance sets the DBInstance field's value.

func (CreateDBInstanceReadReplicaOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDBParameterGroupInput

type CreateDBParameterGroupInput struct {

	// The DB parameter group family name. A DB parameter group can be associated
	// with one and only one DB parameter group family, and can be applied only
	// to a DB instance running a database engine and engine version compatible
	// with that DB parameter group family.
	//
	// To list all of the available parameter group families for a DB engine, use
	// the following command:
	//
	// aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"
	// --engine <engine>
	//
	// For example, to list all of the available parameter group families for the
	// MySQL DB engine, use the following command:
	//
	// aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"
	// --engine mysql
	//
	// The output contains duplicates.
	//
	// The following are the valid DB engine values:
	//
	//    * aurora (for MySQL 5.6-compatible Aurora)
	//
	//    * aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
	//
	//    * aurora-postgresql
	//
	//    * mariadb
	//
	//    * mysql
	//
	//    * oracle-ee
	//
	//    * oracle-ee-cdb
	//
	//    * oracle-se2
	//
	//    * oracle-se2-cdb
	//
	//    * postgres
	//
	//    * sqlserver-ee
	//
	//    * sqlserver-se
	//
	//    * sqlserver-ex
	//
	//    * sqlserver-web
	//
	// DBParameterGroupFamily is a required field
	DBParameterGroupFamily *string `type:"string" required:"true"`

	// The name of the DB parameter group.
	//
	// Constraints:
	//
	//    * Must be 1 to 255 letters, numbers, or hyphens.
	//
	//    * First character must be a letter
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens
	//
	// This value is stored as a lowercase string.
	//
	// DBParameterGroupName is a required field
	DBParameterGroupName *string `type:"string" required:"true"`

	// The description for the DB parameter group.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// Tags to assign to the DB parameter group.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDBParameterGroupInput) GoString added in v0.6.5

func (s CreateDBParameterGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBParameterGroupInput) SetDBParameterGroupFamily added in v1.5.0

func (s *CreateDBParameterGroupInput) SetDBParameterGroupFamily(v string) *CreateDBParameterGroupInput

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*CreateDBParameterGroupInput) SetDBParameterGroupName added in v1.5.0

func (s *CreateDBParameterGroupInput) SetDBParameterGroupName(v string) *CreateDBParameterGroupInput

SetDBParameterGroupName sets the DBParameterGroupName field's value.

func (*CreateDBParameterGroupInput) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (*CreateDBParameterGroupInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (CreateDBParameterGroupInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBParameterGroupInput) Validate added in v1.1.21

func (s *CreateDBParameterGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDBParameterGroupOutput

type CreateDBParameterGroupOutput struct {

	// Contains the details of an Amazon RDS DB parameter group.
	//
	// This data type is used as a response element in the DescribeDBParameterGroups
	// action.
	DBParameterGroup *DBParameterGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDBParameterGroupOutput) GoString added in v0.6.5

func (s CreateDBParameterGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBParameterGroupOutput) SetDBParameterGroup added in v1.5.0

SetDBParameterGroup sets the DBParameterGroup field's value.

func (CreateDBParameterGroupOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDBProxyEndpointInput added in v1.37.27

type CreateDBProxyEndpointInput struct {

	// The name of the DB proxy endpoint to create.
	//
	// DBProxyEndpointName is a required field
	DBProxyEndpointName *string `min:"1" type:"string" required:"true"`

	// The name of the DB proxy associated with the DB proxy endpoint that you create.
	//
	// DBProxyName is a required field
	DBProxyName *string `min:"1" type:"string" required:"true"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// A value that indicates whether the DB proxy endpoint can be used for read/write
	// or read-only operations. The default is READ_WRITE.
	TargetRole *string `type:"string" enum:"DBProxyEndpointTargetRole"`

	// The VPC security group IDs for the DB proxy endpoint that you create. You
	// can specify a different set of security group IDs than for the original DB
	// proxy. The default is the default security group for the VPC.
	VpcSecurityGroupIds []*string `type:"list"`

	// The VPC subnet IDs for the DB proxy endpoint that you create. You can specify
	// a different set of subnet IDs than for the original DB proxy.
	//
	// VpcSubnetIds is a required field
	VpcSubnetIds []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateDBProxyEndpointInput) GoString added in v1.37.27

func (s CreateDBProxyEndpointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBProxyEndpointInput) SetDBProxyEndpointName added in v1.37.27

func (s *CreateDBProxyEndpointInput) SetDBProxyEndpointName(v string) *CreateDBProxyEndpointInput

SetDBProxyEndpointName sets the DBProxyEndpointName field's value.

func (*CreateDBProxyEndpointInput) SetDBProxyName added in v1.37.27

SetDBProxyName sets the DBProxyName field's value.

func (*CreateDBProxyEndpointInput) SetTags added in v1.37.27

SetTags sets the Tags field's value.

func (*CreateDBProxyEndpointInput) SetTargetRole added in v1.37.27

SetTargetRole sets the TargetRole field's value.

func (*CreateDBProxyEndpointInput) SetVpcSecurityGroupIds added in v1.37.27

func (s *CreateDBProxyEndpointInput) SetVpcSecurityGroupIds(v []*string) *CreateDBProxyEndpointInput

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (*CreateDBProxyEndpointInput) SetVpcSubnetIds added in v1.37.27

SetVpcSubnetIds sets the VpcSubnetIds field's value.

func (CreateDBProxyEndpointInput) String added in v1.37.27

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBProxyEndpointInput) Validate added in v1.37.27

func (s *CreateDBProxyEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDBProxyEndpointOutput added in v1.37.27

type CreateDBProxyEndpointOutput struct {

	// The DBProxyEndpoint object that is created by the API operation. The DB proxy
	// endpoint that you create might provide capabilities such as read/write or
	// read-only operations, or using a different VPC than the proxy's default VPC.
	DBProxyEndpoint *DBProxyEndpoint `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDBProxyEndpointOutput) GoString added in v1.37.27

func (s CreateDBProxyEndpointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBProxyEndpointOutput) SetDBProxyEndpoint added in v1.37.27

SetDBProxyEndpoint sets the DBProxyEndpoint field's value.

func (CreateDBProxyEndpointOutput) String added in v1.37.27

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDBProxyInput added in v1.25.47

type CreateDBProxyInput struct {

	// The authorization mechanism that the proxy uses.
	//
	// Auth is a required field
	Auth []*UserAuthConfig `type:"list" required:"true"`

	// The identifier for the proxy. This name must be unique for all proxies owned
	// by your Amazon Web Services account in the specified Amazon Web Services
	// Region. An identifier must begin with a letter and must contain only ASCII
	// letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive
	// hyphens.
	//
	// DBProxyName is a required field
	DBProxyName *string `type:"string" required:"true"`

	// Whether the proxy includes detailed information about SQL statements in its
	// logs. This information helps you to debug issues involving SQL behavior or
	// the performance and scalability of the proxy connections. The debug information
	// includes the text of SQL statements that you submit through the proxy. Thus,
	// only enable this setting when needed for debugging, and only when you have
	// security measures in place to safeguard any sensitive information that appears
	// in the logs.
	DebugLogging *bool `type:"boolean"`

	// The kinds of databases that the proxy can connect to. This value determines
	// which database network protocol the proxy recognizes when it interprets network
	// traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and
	// RDS for MySQL databases, specify MYSQL. For Aurora PostgreSQL and RDS for
	// PostgreSQL databases, specify POSTGRESQL.
	//
	// EngineFamily is a required field
	EngineFamily *string `type:"string" required:"true" enum:"EngineFamily"`

	// The number of seconds that a connection to the proxy can be inactive before
	// the proxy disconnects it. You can set this value higher or lower than the
	// connection timeout limit for the associated database.
	IdleClientTimeout *int64 `type:"integer"`

	// A Boolean parameter that specifies whether Transport Layer Security (TLS)
	// encryption is required for connections to the proxy. By enabling this setting,
	// you can enforce encrypted TLS connections to the proxy.
	RequireTLS *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access
	// secrets in Amazon Web Services Secrets Manager.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`

	// An optional set of key-value pairs to associate arbitrary data of your choosing
	// with the proxy.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// One or more VPC security group IDs to associate with the new proxy.
	VpcSecurityGroupIds []*string `type:"list"`

	// One or more VPC subnet IDs to associate with the new proxy.
	//
	// VpcSubnetIds is a required field
	VpcSubnetIds []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateDBProxyInput) GoString added in v1.25.47

func (s CreateDBProxyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBProxyInput) SetAuth added in v1.25.47

SetAuth sets the Auth field's value.

func (*CreateDBProxyInput) SetDBProxyName added in v1.25.47

func (s *CreateDBProxyInput) SetDBProxyName(v string) *CreateDBProxyInput

SetDBProxyName sets the DBProxyName field's value.

func (*CreateDBProxyInput) SetDebugLogging added in v1.25.47

func (s *CreateDBProxyInput) SetDebugLogging(v bool) *CreateDBProxyInput

SetDebugLogging sets the DebugLogging field's value.

func (*CreateDBProxyInput) SetEngineFamily added in v1.25.47

func (s *CreateDBProxyInput) SetEngineFamily(v string) *CreateDBProxyInput

SetEngineFamily sets the EngineFamily field's value.

func (*CreateDBProxyInput) SetIdleClientTimeout added in v1.25.47

func (s *CreateDBProxyInput) SetIdleClientTimeout(v int64) *CreateDBProxyInput

SetIdleClientTimeout sets the IdleClientTimeout field's value.

func (*CreateDBProxyInput) SetRequireTLS added in v1.25.47

func (s *CreateDBProxyInput) SetRequireTLS(v bool) *CreateDBProxyInput

SetRequireTLS sets the RequireTLS field's value.

func (*CreateDBProxyInput) SetRoleArn added in v1.25.47

func (s *CreateDBProxyInput) SetRoleArn(v string) *CreateDBProxyInput

SetRoleArn sets the RoleArn field's value.

func (*CreateDBProxyInput) SetTags added in v1.25.47

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

SetTags sets the Tags field's value.

func (*CreateDBProxyInput) SetVpcSecurityGroupIds added in v1.25.47

func (s *CreateDBProxyInput) SetVpcSecurityGroupIds(v []*string) *CreateDBProxyInput

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (*CreateDBProxyInput) SetVpcSubnetIds added in v1.25.47

func (s *CreateDBProxyInput) SetVpcSubnetIds(v []*string) *CreateDBProxyInput

SetVpcSubnetIds sets the VpcSubnetIds field's value.

func (CreateDBProxyInput) String added in v1.25.47

func (s CreateDBProxyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBProxyInput) Validate added in v1.25.47

func (s *CreateDBProxyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDBProxyOutput added in v1.25.47

type CreateDBProxyOutput struct {

	// The DBProxy structure corresponding to the new proxy.
	DBProxy *DBProxy `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDBProxyOutput) GoString added in v1.25.47

func (s CreateDBProxyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBProxyOutput) SetDBProxy added in v1.25.47

func (s *CreateDBProxyOutput) SetDBProxy(v *DBProxy) *CreateDBProxyOutput

SetDBProxy sets the DBProxy field's value.

func (CreateDBProxyOutput) String added in v1.25.47

func (s CreateDBProxyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDBSecurityGroupInput

type CreateDBSecurityGroupInput struct {

	// The description for the DB security group.
	//
	// DBSecurityGroupDescription is a required field
	DBSecurityGroupDescription *string `type:"string" required:"true"`

	// The name for the DB security group. This value is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * Must be 1 to 255 letters, numbers, or hyphens.
	//
	//    * First character must be a letter
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens
	//
	//    * Must not be "Default"
	//
	// Example: mysecuritygroup
	//
	// DBSecurityGroupName is a required field
	DBSecurityGroupName *string `type:"string" required:"true"`

	// Tags to assign to the DB security group.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDBSecurityGroupInput) GoString added in v0.6.5

func (s CreateDBSecurityGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBSecurityGroupInput) SetDBSecurityGroupDescription added in v1.5.0

func (s *CreateDBSecurityGroupInput) SetDBSecurityGroupDescription(v string) *CreateDBSecurityGroupInput

SetDBSecurityGroupDescription sets the DBSecurityGroupDescription field's value.

func (*CreateDBSecurityGroupInput) SetDBSecurityGroupName added in v1.5.0

func (s *CreateDBSecurityGroupInput) SetDBSecurityGroupName(v string) *CreateDBSecurityGroupInput

SetDBSecurityGroupName sets the DBSecurityGroupName field's value.

func (*CreateDBSecurityGroupInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (CreateDBSecurityGroupInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBSecurityGroupInput) Validate added in v1.1.21

func (s *CreateDBSecurityGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDBSecurityGroupOutput

type CreateDBSecurityGroupOutput struct {

	// Contains the details for an Amazon RDS DB security group.
	//
	// This data type is used as a response element in the DescribeDBSecurityGroups
	// action.
	DBSecurityGroup *DBSecurityGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDBSecurityGroupOutput) GoString added in v0.6.5

func (s CreateDBSecurityGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBSecurityGroupOutput) SetDBSecurityGroup added in v1.5.0

SetDBSecurityGroup sets the DBSecurityGroup field's value.

func (CreateDBSecurityGroupOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDBSnapshotInput

type CreateDBSnapshotInput struct {

	// The identifier of the DB instance that you want to create the snapshot of.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBInstance.
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`

	// The identifier for the DB snapshot.
	//
	// Constraints:
	//
	//    * Can't be null, empty, or blank
	//
	//    * Must contain from 1 to 255 letters, numbers, or hyphens
	//
	//    * First character must be a letter
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens
	//
	// Example: my-snapshot-id
	//
	// DBSnapshotIdentifier is a required field
	DBSnapshotIdentifier *string `type:"string" required:"true"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDBSnapshotInput) GoString added in v0.6.5

func (s CreateDBSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBSnapshotInput) SetDBInstanceIdentifier added in v1.5.0

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*CreateDBSnapshotInput) SetDBSnapshotIdentifier added in v1.5.0

func (s *CreateDBSnapshotInput) SetDBSnapshotIdentifier(v string) *CreateDBSnapshotInput

SetDBSnapshotIdentifier sets the DBSnapshotIdentifier field's value.

func (*CreateDBSnapshotInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (CreateDBSnapshotInput) String added in v0.6.5

func (s CreateDBSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBSnapshotInput) Validate added in v1.1.21

func (s *CreateDBSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDBSnapshotOutput

type CreateDBSnapshotOutput struct {

	// Contains the details of an Amazon RDS DB snapshot.
	//
	// This data type is used as a response element in the DescribeDBSnapshots action.
	DBSnapshot *DBSnapshot `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDBSnapshotOutput) GoString added in v0.6.5

func (s CreateDBSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBSnapshotOutput) SetDBSnapshot added in v1.5.0

SetDBSnapshot sets the DBSnapshot field's value.

func (CreateDBSnapshotOutput) String added in v0.6.5

func (s CreateDBSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDBSubnetGroupInput

type CreateDBSubnetGroupInput struct {

	// The description for the DB subnet group.
	//
	// DBSubnetGroupDescription is a required field
	DBSubnetGroupDescription *string `type:"string" required:"true"`

	// The name for the DB subnet group. This value is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * Must contain no more than 255 letters, numbers, periods, underscores,
	//    spaces, or hyphens.
	//
	//    * Must not be default.
	//
	//    * First character must be a letter.
	//
	// Example: mydbsubnetgroup
	//
	// DBSubnetGroupName is a required field
	DBSubnetGroupName *string `type:"string" required:"true"`

	// The EC2 Subnet IDs for the DB subnet group.
	//
	// SubnetIds is a required field
	SubnetIds []*string `locationNameList:"SubnetIdentifier" type:"list" required:"true"`

	// Tags to assign to the DB subnet group.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDBSubnetGroupInput) GoString added in v0.6.5

func (s CreateDBSubnetGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBSubnetGroupInput) SetDBSubnetGroupDescription added in v1.5.0

func (s *CreateDBSubnetGroupInput) SetDBSubnetGroupDescription(v string) *CreateDBSubnetGroupInput

SetDBSubnetGroupDescription sets the DBSubnetGroupDescription field's value.

func (*CreateDBSubnetGroupInput) SetDBSubnetGroupName added in v1.5.0

func (s *CreateDBSubnetGroupInput) SetDBSubnetGroupName(v string) *CreateDBSubnetGroupInput

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*CreateDBSubnetGroupInput) SetSubnetIds added in v1.5.0

SetSubnetIds sets the SubnetIds field's value.

func (*CreateDBSubnetGroupInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (CreateDBSubnetGroupInput) String added in v0.6.5

func (s CreateDBSubnetGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBSubnetGroupInput) Validate added in v1.1.21

func (s *CreateDBSubnetGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDBSubnetGroupOutput

type CreateDBSubnetGroupOutput struct {

	// Contains the details of an Amazon RDS DB subnet group.
	//
	// This data type is used as a response element in the DescribeDBSubnetGroups
	// action.
	DBSubnetGroup *DBSubnetGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDBSubnetGroupOutput) GoString added in v0.6.5

func (s CreateDBSubnetGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDBSubnetGroupOutput) SetDBSubnetGroup added in v1.5.0

SetDBSubnetGroup sets the DBSubnetGroup field's value.

func (CreateDBSubnetGroupOutput) String added in v0.6.5

func (s CreateDBSubnetGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateEventSubscriptionInput

type CreateEventSubscriptionInput struct {

	// A value that indicates whether to activate the subscription. If the event
	// notification subscription isn't activated, the subscription is created but
	// not active.
	Enabled *bool `type:"boolean"`

	// A list of event categories for a particular source type (SourceType) that
	// you want to subscribe to. You can see a list of the categories for a given
	// source type in the "Amazon RDS event categories and event messages" section
	// of the Amazon RDS User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html)
	// or the Amazon Aurora User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html).
	// You can also see this list by using the DescribeEventCategories operation.
	EventCategories []*string `locationNameList:"EventCategory" type:"list"`

	// The Amazon Resource Name (ARN) of the SNS topic created for event notification.
	// The ARN is created by Amazon SNS when you create a topic and subscribe to
	// it.
	//
	// SnsTopicArn is a required field
	SnsTopicArn *string `type:"string" required:"true"`

	// The list of identifiers of the event sources for which events are returned.
	// If not specified, then all sources are included in the response. An identifier
	// must begin with a letter and must contain only ASCII letters, digits, and
	// hyphens. It can't end with a hyphen or contain two consecutive hyphens.
	//
	// Constraints:
	//
	//    * If SourceIds are supplied, SourceType must also be provided.
	//
	//    * If the source type is a DB instance, a DBInstanceIdentifier value must
	//    be supplied.
	//
	//    * If the source type is a DB cluster, a DBClusterIdentifier value must
	//    be supplied.
	//
	//    * If the source type is a DB parameter group, a DBParameterGroupName value
	//    must be supplied.
	//
	//    * If the source type is a DB security group, a DBSecurityGroupName value
	//    must be supplied.
	//
	//    * If the source type is a DB snapshot, a DBSnapshotIdentifier value must
	//    be supplied.
	//
	//    * If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier
	//    value must be supplied.
	//
	//    * If the source type is an RDS Proxy, a DBProxyName value must be supplied.
	SourceIds []*string `locationNameList:"SourceId" type:"list"`

	// The type of source that is generating the events. For example, if you want
	// to be notified of events generated by a DB instance, you set this parameter
	// to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't
	// specified, all events are returned.
	//
	// Valid values: db-instance | db-cluster | db-parameter-group | db-security-group
	// | db-snapshot | db-cluster-snapshot | db-proxy
	SourceType *string `type:"string"`

	// The name of the subscription.
	//
	// Constraints: The name must be less than 255 characters.
	//
	// SubscriptionName is a required field
	SubscriptionName *string `type:"string" required:"true"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

func (CreateEventSubscriptionInput) GoString added in v0.6.5

func (s CreateEventSubscriptionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEventSubscriptionInput) SetEnabled added in v1.5.0

SetEnabled sets the Enabled field's value.

func (*CreateEventSubscriptionInput) SetEventCategories added in v1.5.0

SetEventCategories sets the EventCategories field's value.

func (*CreateEventSubscriptionInput) SetSnsTopicArn added in v1.5.0

SetSnsTopicArn sets the SnsTopicArn field's value.

func (*CreateEventSubscriptionInput) SetSourceIds added in v1.5.0

SetSourceIds sets the SourceIds field's value.

func (*CreateEventSubscriptionInput) SetSourceType added in v1.5.0

SetSourceType sets the SourceType field's value.

func (*CreateEventSubscriptionInput) SetSubscriptionName added in v1.5.0

SetSubscriptionName sets the SubscriptionName field's value.

func (*CreateEventSubscriptionInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (CreateEventSubscriptionInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEventSubscriptionInput) Validate added in v1.1.21

func (s *CreateEventSubscriptionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateEventSubscriptionOutput

type CreateEventSubscriptionOutput struct {

	// Contains the results of a successful invocation of the DescribeEventSubscriptions
	// action.
	EventSubscription *EventSubscription `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateEventSubscriptionOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEventSubscriptionOutput) SetEventSubscription added in v1.5.0

SetEventSubscription sets the EventSubscription field's value.

func (CreateEventSubscriptionOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateGlobalClusterInput added in v1.15.85

type CreateGlobalClusterInput struct {

	// The name for your database of up to 64 alphanumeric characters. If you do
	// not provide a name, Amazon Aurora will not create a database in the global
	// database cluster you are creating.
	DatabaseName *string `type:"string"`

	// The deletion protection setting for the new global database. The global database
	// can't be deleted when deletion protection is enabled.
	DeletionProtection *bool `type:"boolean"`

	// The name of the database engine to be used for this DB cluster.
	Engine *string `type:"string"`

	// The engine version of the Aurora global database.
	EngineVersion *string `type:"string"`

	// The cluster identifier of the new global database cluster.
	GlobalClusterIdentifier *string `type:"string"`

	// The Amazon Resource Name (ARN) to use as the primary cluster of the global
	// database. This parameter is optional.
	SourceDBClusterIdentifier *string `type:"string"`

	// The storage encryption setting for the new global database cluster.
	StorageEncrypted *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (CreateGlobalClusterInput) GoString added in v1.15.85

func (s CreateGlobalClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGlobalClusterInput) SetDatabaseName added in v1.15.85

SetDatabaseName sets the DatabaseName field's value.

func (*CreateGlobalClusterInput) SetDeletionProtection added in v1.15.85

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

SetDeletionProtection sets the DeletionProtection field's value.

func (*CreateGlobalClusterInput) SetEngine added in v1.15.85

SetEngine sets the Engine field's value.

func (*CreateGlobalClusterInput) SetEngineVersion added in v1.15.85

SetEngineVersion sets the EngineVersion field's value.

func (*CreateGlobalClusterInput) SetGlobalClusterIdentifier added in v1.15.85

func (s *CreateGlobalClusterInput) SetGlobalClusterIdentifier(v string) *CreateGlobalClusterInput

SetGlobalClusterIdentifier sets the GlobalClusterIdentifier field's value.

func (*CreateGlobalClusterInput) SetSourceDBClusterIdentifier added in v1.15.85

func (s *CreateGlobalClusterInput) SetSourceDBClusterIdentifier(v string) *CreateGlobalClusterInput

SetSourceDBClusterIdentifier sets the SourceDBClusterIdentifier field's value.

func (*CreateGlobalClusterInput) SetStorageEncrypted added in v1.15.85

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

SetStorageEncrypted sets the StorageEncrypted field's value.

func (CreateGlobalClusterInput) String added in v1.15.85

func (s CreateGlobalClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateGlobalClusterOutput added in v1.15.85

type CreateGlobalClusterOutput struct {

	// A data type representing an Aurora global database.
	GlobalCluster *GlobalCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateGlobalClusterOutput) GoString added in v1.15.85

func (s CreateGlobalClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGlobalClusterOutput) SetGlobalCluster added in v1.15.85

SetGlobalCluster sets the GlobalCluster field's value.

func (CreateGlobalClusterOutput) String added in v1.15.85

func (s CreateGlobalClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateOptionGroupInput

type CreateOptionGroupInput struct {

	// Specifies the name of the engine that this option group should be associated
	// with.
	//
	// Valid Values:
	//
	//    * mariadb
	//
	//    * mysql
	//
	//    * oracle-ee
	//
	//    * oracle-ee-cdb
	//
	//    * oracle-se2
	//
	//    * oracle-se2-cdb
	//
	//    * postgres
	//
	//    * sqlserver-ee
	//
	//    * sqlserver-se
	//
	//    * sqlserver-ex
	//
	//    * sqlserver-web
	//
	// EngineName is a required field
	EngineName *string `type:"string" required:"true"`

	// Specifies the major version of the engine that this option group should be
	// associated with.
	//
	// MajorEngineVersion is a required field
	MajorEngineVersion *string `type:"string" required:"true"`

	// The description of the option group.
	//
	// OptionGroupDescription is a required field
	OptionGroupDescription *string `type:"string" required:"true"`

	// Specifies the name of the option group to be created.
	//
	// Constraints:
	//
	//    * Must be 1 to 255 letters, numbers, or hyphens
	//
	//    * First character must be a letter
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens
	//
	// Example: myoptiongroup
	//
	// OptionGroupName is a required field
	OptionGroupName *string `type:"string" required:"true"`

	// Tags to assign to the option group.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

func (CreateOptionGroupInput) GoString added in v0.6.5

func (s CreateOptionGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateOptionGroupInput) SetEngineName added in v1.5.0

SetEngineName sets the EngineName field's value.

func (*CreateOptionGroupInput) SetMajorEngineVersion added in v1.5.0

func (s *CreateOptionGroupInput) SetMajorEngineVersion(v string) *CreateOptionGroupInput

SetMajorEngineVersion sets the MajorEngineVersion field's value.

func (*CreateOptionGroupInput) SetOptionGroupDescription added in v1.5.0

func (s *CreateOptionGroupInput) SetOptionGroupDescription(v string) *CreateOptionGroupInput

SetOptionGroupDescription sets the OptionGroupDescription field's value.

func (*CreateOptionGroupInput) SetOptionGroupName added in v1.5.0

func (s *CreateOptionGroupInput) SetOptionGroupName(v string) *CreateOptionGroupInput

SetOptionGroupName sets the OptionGroupName field's value.

func (*CreateOptionGroupInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (CreateOptionGroupInput) String added in v0.6.5

func (s CreateOptionGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateOptionGroupInput) Validate added in v1.1.21

func (s *CreateOptionGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateOptionGroupOutput

type CreateOptionGroupOutput struct {
	OptionGroup *OptionGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateOptionGroupOutput) GoString added in v0.6.5

func (s CreateOptionGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateOptionGroupOutput) SetOptionGroup added in v1.5.0

SetOptionGroup sets the OptionGroup field's value.

func (CreateOptionGroupOutput) String added in v0.6.5

func (s CreateOptionGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBCluster added in v0.7.1

type DBCluster struct {

	// The name of the Amazon Kinesis data stream used for the database activity
	// stream.
	ActivityStreamKinesisStreamName *string `type:"string"`

	// The Amazon Web Services KMS key identifier used for encrypting messages in
	// the database activity stream.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key.
	ActivityStreamKmsKeyId *string `type:"string"`

	// The mode of the database activity stream. Database events such as a change
	// or access generate an activity stream event. The database session can handle
	// these events either synchronously or asynchronously.
	ActivityStreamMode *string `type:"string" enum:"ActivityStreamMode"`

	// The status of the database activity stream.
	ActivityStreamStatus *string `type:"string" enum:"ActivityStreamStatus"`

	// For all database engines except Amazon Aurora, AllocatedStorage specifies
	// the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage
	// always returns 1, because Aurora DB cluster storage size isn't fixed, but
	// instead automatically adjusts as needed.
	AllocatedStorage *int64 `type:"integer"`

	// Provides a list of the Amazon Web Services Identity and Access Management
	// (IAM) roles that are associated with the DB cluster. IAM roles that are associated
	// with a DB cluster grant permission for the DB cluster to access other Amazon
	// Web Services on your behalf.
	AssociatedRoles []*DBClusterRole `locationNameList:"DBClusterRole" type:"list"`

	// A value that indicates that minor version patches are applied automatically.
	//
	// This setting is only for non-Aurora Multi-AZ DB clusters.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// The time when a stopped DB cluster is restarted automatically.
	AutomaticRestartTime *time.Time `type:"timestamp"`

	// Provides the list of Availability Zones (AZs) where instances in the DB cluster
	// can be created.
	AvailabilityZones []*string `locationNameList:"AvailabilityZone" type:"list"`

	// The number of change records stored for Backtrack.
	BacktrackConsumedChangeRecords *int64 `type:"long"`

	// The target backtrack window, in seconds. If this value is set to 0, backtracking
	// is disabled for the DB cluster. Otherwise, backtracking is enabled.
	BacktrackWindow *int64 `type:"long"`

	// Specifies the number of days for which automatic DB snapshots are retained.
	BackupRetentionPeriod *int64 `type:"integer"`

	// The current capacity of an Aurora Serverless v1 DB cluster. The capacity
	// is 0 (zero) when the cluster is paused.
	//
	// For more information about Aurora Serverless v1, see Using Amazon Aurora
	// Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html)
	// in the Amazon Aurora User Guide.
	Capacity *int64 `type:"integer"`

	// If present, specifies the name of the character set that this cluster is
	// associated with.
	CharacterSetName *string `type:"string"`

	// Identifies the clone group to which the DB cluster is associated.
	CloneGroupId *string `type:"string"`

	// Specifies the time when the DB cluster was created, in Universal Coordinated
	// Time (UTC).
	ClusterCreateTime *time.Time `type:"timestamp"`

	// Specifies whether tags are copied from the DB cluster to snapshots of the
	// DB cluster.
	CopyTagsToSnapshot *bool `type:"boolean"`

	// Specifies whether the DB cluster is a clone of a DB cluster owned by a different
	// Amazon Web Services account.
	CrossAccountClone *bool `type:"boolean"`

	// Identifies all custom endpoints associated with the cluster.
	CustomEndpoints []*string `type:"list"`

	// The Amazon Resource Name (ARN) for the DB cluster.
	DBClusterArn *string `type:"string"`

	// Contains a user-supplied DB cluster identifier. This identifier is the unique
	// key that identifies a DB cluster.
	DBClusterIdentifier *string `type:"string"`

	// The name of the compute and memory capacity class of the DB instance.
	//
	// This setting is only for non-Aurora Multi-AZ DB clusters.
	DBClusterInstanceClass *string `type:"string"`

	// Provides the list of instances that make up the DB cluster.
	DBClusterMembers []*DBClusterMember `locationNameList:"DBClusterMember" type:"list"`

	// Provides the list of option group memberships for this DB cluster.
	DBClusterOptionGroupMemberships []*DBClusterOptionGroupStatus `locationNameList:"DBClusterOptionGroup" type:"list"`

	// Specifies the name of the DB cluster parameter group for the DB cluster.
	DBClusterParameterGroup *string `type:"string"`

	// Specifies information on the subnet group associated with the DB cluster,
	// including the name, description, and subnets in the subnet group.
	DBSubnetGroup *string `type:"string"`

	// Contains the name of the initial database of this DB cluster that was provided
	// at create time, if one was specified when the DB cluster was created. This
	// same name is returned for the life of the DB cluster.
	DatabaseName *string `type:"string"`

	// The Amazon Web Services Region-unique, immutable identifier for the DB cluster.
	// This identifier is found in Amazon Web Services CloudTrail log entries whenever
	// the KMS key for the DB cluster is accessed.
	DbClusterResourceId *string `type:"string"`

	// Indicates if the DB cluster has deletion protection enabled. The database
	// can't be deleted when deletion protection is enabled.
	DeletionProtection *bool `type:"boolean"`

	// The Active Directory Domain membership records associated with the DB cluster.
	DomainMemberships []*DomainMembership `locationNameList:"DomainMembership" type:"list"`

	// The earliest time to which a DB cluster can be backtracked.
	EarliestBacktrackTime *time.Time `type:"timestamp"`

	// The earliest time to which a database can be restored with point-in-time
	// restore.
	EarliestRestorableTime *time.Time `type:"timestamp"`

	// A list of log types that this DB cluster 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/AuroraUserGuide/USER_LogAccess.html)
	// in the Amazon Aurora User Guide.
	EnabledCloudwatchLogsExports []*string `type:"list"`

	// Specifies the connection endpoint for the primary instance of the DB cluster.
	Endpoint *string `type:"string"`

	// The name of the database engine to be used for this DB cluster.
	Engine *string `type:"string"`

	// The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery,
	// global, or multimaster.
	//
	// For more information, see CreateDBCluster (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html).
	EngineMode *string `type:"string"`

	// Indicates the database engine version.
	EngineVersion *string `type:"string"`

	// Specifies whether you have requested to enable write forwarding for a secondary
	// cluster in an Aurora global database. Because write forwarding takes time
	// to enable, check the value of GlobalWriteForwardingStatus to confirm that
	// the request has completed before using the write forwarding feature for this
	// cluster.
	GlobalWriteForwardingRequested *bool `type:"boolean"`

	// Specifies whether a secondary cluster in an Aurora global database has write
	// forwarding enabled, not enabled, or is in the process of enabling it.
	GlobalWriteForwardingStatus *string `type:"string" enum:"WriteForwardingStatus"`

	// Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
	HostedZoneId *string `type:"string"`

	// A value that indicates whether the HTTP endpoint for an Aurora Serverless
	// v1 DB cluster is enabled.
	//
	// When enabled, the HTTP endpoint provides a connectionless web service API
	// for running SQL queries on the Aurora Serverless v1 DB cluster. You can also
	// query your database from inside the RDS console with the query editor.
	//
	// For more information, see Using the Data API for Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html)
	// in the Amazon Aurora User Guide.
	HttpEndpointEnabled *bool `type:"boolean"`

	// A value that indicates whether the mapping of Amazon Web Services Identity
	// and Access Management (IAM) accounts to database accounts is enabled.
	IAMDatabaseAuthenticationEnabled *bool `type:"boolean"`

	// The Provisioned IOPS (I/O operations per second) value.
	//
	// This setting is only for non-Aurora Multi-AZ DB clusters.
	Iops *int64 `type:"integer"`

	// If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier
	// for the encrypted DB cluster.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key.
	KmsKeyId *string `type:"string"`

	// Specifies the latest time to which a database can be restored with point-in-time
	// restore.
	LatestRestorableTime *time.Time `type:"timestamp"`

	// Contains the master username for the DB cluster.
	MasterUsername *string `type:"string"`

	// The interval, in seconds, between points when Enhanced Monitoring metrics
	// are collected for the DB cluster.
	//
	// This setting is only for non-Aurora Multi-AZ DB clusters.
	MonitoringInterval *int64 `type:"integer"`

	// The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics
	// to Amazon CloudWatch Logs.
	//
	// This setting is only for non-Aurora Multi-AZ DB clusters.
	MonitoringRoleArn *string `type:"string"`

	// Specifies whether the DB cluster has instances in multiple Availability Zones.
	MultiAZ *bool `type:"boolean"`

	// The network type of the DB instance.
	//
	// Valid values:
	//
	//    * IPV4
	//
	//    * DUAL
	//
	// The network type is determined by the DBSubnetGroup specified for the DB
	// cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and
	// the IPv6 protocols (DUAL).
	//
	// For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
	// in the Amazon Aurora User Guide.
	//
	// This setting is only for Aurora DB clusters.
	NetworkType *string `type:"string"`

	// A value that specifies that changes to the DB cluster are pending. This element
	// is only included when changes are pending. Specific changes are identified
	// by subelements.
	PendingModifiedValues *ClusterPendingModifiedValues `type:"structure"`

	// Specifies the progress of the operation as a percentage.
	PercentProgress *string `type:"string"`

	// True if Performance Insights is enabled for the DB cluster, and otherwise
	// false.
	//
	// This setting is only for non-Aurora Multi-AZ DB clusters.
	PerformanceInsightsEnabled *bool `type:"boolean"`

	// The Amazon Web Services KMS key identifier for encryption of Performance
	// Insights data.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key.
	//
	// This setting is only for non-Aurora Multi-AZ DB clusters.
	PerformanceInsightsKMSKeyId *string `type:"string"`

	// The number of days to retain Performance Insights data. The default is 7
	// days. The following values are valid:
	//
	//    * 7
	//
	//    * month * 31, where month is a number of months from 1-23
	//
	//    * 731
	//
	// For example, the following values are valid:
	//
	//    * 93 (3 months * 31)
	//
	//    * 341 (11 months * 31)
	//
	//    * 589 (19 months * 31)
	//
	//    * 731
	//
	// This setting is only for non-Aurora Multi-AZ DB clusters.
	PerformanceInsightsRetentionPeriod *int64 `type:"integer"`

	// Specifies the port that the database engine is listening on.
	Port *int64 `type:"integer"`

	// Specifies the daily time range during which automated backups are created
	// if automated backups are enabled, as determined by the BackupRetentionPeriod.
	PreferredBackupWindow *string `type:"string"`

	// Specifies the weekly time range during which system maintenance can occur,
	// in Universal Coordinated Time (UTC).
	PreferredMaintenanceWindow *string `type:"string"`

	// Specifies the accessibility options for the DB instance.
	//
	// When the DB instance is publicly accessible, its Domain Name System (DNS)
	// endpoint resolves to the private IP address from within the DB instance's
	// virtual private cloud (VPC). It resolves to the public IP address from outside
	// of the DB instance's VPC. Access to the DB instance is ultimately controlled
	// by the security group it uses. That public access is not permitted if the
	// security group assigned to the DB instance doesn't permit it.
	//
	// When the DB instance isn't publicly accessible, it is an internal DB instance
	// with a DNS name that resolves to a private IP address.
	//
	// For more information, see CreateDBInstance.
	//
	// This setting is only for non-Aurora Multi-AZ DB clusters.
	PubliclyAccessible *bool `type:"boolean"`

	// Contains one or more identifiers of the read replicas associated with this
	// DB cluster.
	ReadReplicaIdentifiers []*string `locationNameList:"ReadReplicaIdentifier" type:"list"`

	// The reader endpoint for the DB cluster. The reader endpoint for a DB cluster
	// load-balances connections across the Aurora Replicas that are available in
	// a DB cluster. As clients request new connections to the reader endpoint,
	// Aurora distributes the connection requests among the Aurora Replicas in the
	// DB cluster. This functionality can help balance your read workload across
	// multiple Aurora Replicas in your DB cluster.
	//
	// If a failover occurs, and the Aurora Replica that you are connected to is
	// promoted to be the primary instance, your connection is dropped. To continue
	// sending your read workload to other Aurora Replicas in the cluster, you can
	// then reconnect to the reader endpoint.
	ReaderEndpoint *string `type:"string"`

	// Contains the identifier of the source DB cluster if this DB cluster is a
	// read replica.
	ReplicationSourceIdentifier *string `type:"string"`

	// Shows the scaling configuration for an Aurora DB cluster in serverless DB
	// engine mode.
	//
	// For more information, see Using Amazon Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html)
	// in the Amazon Aurora User Guide.
	ScalingConfigurationInfo *ScalingConfigurationInfo `type:"structure"`

	// Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
	//
	// For more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html)
	// in the Amazon Aurora User Guide.
	ServerlessV2ScalingConfiguration *ServerlessV2ScalingConfigurationInfo `type:"structure"`

	// Specifies the current state of this DB cluster.
	Status *string `type:"string"`

	// Specifies whether the DB cluster is encrypted.
	StorageEncrypted *bool `type:"boolean"`

	// The storage type associated with the DB cluster.
	//
	// This setting is only for non-Aurora Multi-AZ DB clusters.
	StorageType *string `type:"string"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	TagList []*Tag `locationNameList:"Tag" type:"list"`

	// Provides a list of VPC security groups that the DB cluster belongs to.
	VpcSecurityGroups []*VpcSecurityGroupMembership `locationNameList:"VpcSecurityGroupMembership" type:"list"`
	// contains filtered or unexported fields
}

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

func (DBCluster) GoString added in v0.7.1

func (s DBCluster) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBCluster) SetActivityStreamKinesisStreamName added in v1.19.41

func (s *DBCluster) SetActivityStreamKinesisStreamName(v string) *DBCluster

SetActivityStreamKinesisStreamName sets the ActivityStreamKinesisStreamName field's value.

func (*DBCluster) SetActivityStreamKmsKeyId added in v1.19.41

func (s *DBCluster) SetActivityStreamKmsKeyId(v string) *DBCluster

SetActivityStreamKmsKeyId sets the ActivityStreamKmsKeyId field's value.

func (*DBCluster) SetActivityStreamMode added in v1.19.41

func (s *DBCluster) SetActivityStreamMode(v string) *DBCluster

SetActivityStreamMode sets the ActivityStreamMode field's value.

func (*DBCluster) SetActivityStreamStatus added in v1.19.41

func (s *DBCluster) SetActivityStreamStatus(v string) *DBCluster

SetActivityStreamStatus sets the ActivityStreamStatus field's value.

func (*DBCluster) SetAllocatedStorage added in v1.5.0

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

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*DBCluster) SetAssociatedRoles added in v1.5.0

func (s *DBCluster) SetAssociatedRoles(v []*DBClusterRole) *DBCluster

SetAssociatedRoles sets the AssociatedRoles field's value.

func (*DBCluster) SetAutoMinorVersionUpgrade added in v1.42.11

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*DBCluster) SetAutomaticRestartTime added in v1.40.15

func (s *DBCluster) SetAutomaticRestartTime(v time.Time) *DBCluster

SetAutomaticRestartTime sets the AutomaticRestartTime field's value.

func (*DBCluster) SetAvailabilityZones added in v1.5.0

func (s *DBCluster) SetAvailabilityZones(v []*string) *DBCluster

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*DBCluster) SetBacktrackConsumedChangeRecords added in v1.13.45

func (s *DBCluster) SetBacktrackConsumedChangeRecords(v int64) *DBCluster

SetBacktrackConsumedChangeRecords sets the BacktrackConsumedChangeRecords field's value.

func (*DBCluster) SetBacktrackWindow added in v1.13.45

func (s *DBCluster) SetBacktrackWindow(v int64) *DBCluster

SetBacktrackWindow sets the BacktrackWindow field's value.

func (*DBCluster) SetBackupRetentionPeriod added in v1.5.0

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*DBCluster) SetCapacity added in v1.15.9

func (s *DBCluster) SetCapacity(v int64) *DBCluster

SetCapacity sets the Capacity field's value.

func (*DBCluster) SetCharacterSetName added in v1.5.0

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

SetCharacterSetName sets the CharacterSetName field's value.

func (*DBCluster) SetCloneGroupId added in v1.8.40

func (s *DBCluster) SetCloneGroupId(v string) *DBCluster

SetCloneGroupId sets the CloneGroupId field's value.

func (*DBCluster) SetClusterCreateTime added in v1.6.2

func (s *DBCluster) SetClusterCreateTime(v time.Time) *DBCluster

SetClusterCreateTime sets the ClusterCreateTime field's value.

func (*DBCluster) SetCopyTagsToSnapshot added in v1.17.13

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

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*DBCluster) SetCrossAccountClone added in v1.20.15

func (s *DBCluster) SetCrossAccountClone(v bool) *DBCluster

SetCrossAccountClone sets the CrossAccountClone field's value.

func (*DBCluster) SetCustomEndpoints added in v1.15.74

func (s *DBCluster) SetCustomEndpoints(v []*string) *DBCluster

SetCustomEndpoints sets the CustomEndpoints field's value.

func (*DBCluster) SetDBClusterArn added in v1.5.0

func (s *DBCluster) SetDBClusterArn(v string) *DBCluster

SetDBClusterArn sets the DBClusterArn field's value.

func (*DBCluster) SetDBClusterIdentifier added in v1.5.0

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DBCluster) SetDBClusterInstanceClass added in v1.42.11

func (s *DBCluster) SetDBClusterInstanceClass(v string) *DBCluster

SetDBClusterInstanceClass sets the DBClusterInstanceClass field's value.

func (*DBCluster) SetDBClusterMembers added in v1.5.0

func (s *DBCluster) SetDBClusterMembers(v []*DBClusterMember) *DBCluster

SetDBClusterMembers sets the DBClusterMembers field's value.

func (*DBCluster) SetDBClusterOptionGroupMemberships added in v1.5.0

func (s *DBCluster) SetDBClusterOptionGroupMemberships(v []*DBClusterOptionGroupStatus) *DBCluster

SetDBClusterOptionGroupMemberships sets the DBClusterOptionGroupMemberships field's value.

func (*DBCluster) SetDBClusterParameterGroup added in v1.5.0

func (s *DBCluster) SetDBClusterParameterGroup(v string) *DBCluster

SetDBClusterParameterGroup sets the DBClusterParameterGroup field's value.

func (*DBCluster) SetDBSubnetGroup added in v1.5.0

func (s *DBCluster) SetDBSubnetGroup(v string) *DBCluster

SetDBSubnetGroup sets the DBSubnetGroup field's value.

func (*DBCluster) SetDatabaseName added in v1.5.0

func (s *DBCluster) SetDatabaseName(v string) *DBCluster

SetDatabaseName sets the DatabaseName field's value.

func (*DBCluster) SetDbClusterResourceId added in v1.5.0

func (s *DBCluster) SetDbClusterResourceId(v string) *DBCluster

SetDbClusterResourceId sets the DbClusterResourceId field's value.

func (*DBCluster) SetDeletionProtection added in v1.15.43

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

SetDeletionProtection sets the DeletionProtection field's value.

func (*DBCluster) SetDomainMemberships added in v1.29.5

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

SetDomainMemberships sets the DomainMemberships field's value.

func (*DBCluster) SetEarliestBacktrackTime added in v1.13.45

func (s *DBCluster) SetEarliestBacktrackTime(v time.Time) *DBCluster

SetEarliestBacktrackTime sets the EarliestBacktrackTime field's value.

func (*DBCluster) SetEarliestRestorableTime added in v1.5.0

func (s *DBCluster) SetEarliestRestorableTime(v time.Time) *DBCluster

SetEarliestRestorableTime sets the EarliestRestorableTime field's value.

func (*DBCluster) SetEnabledCloudwatchLogsExports added in v1.13.55

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

SetEnabledCloudwatchLogsExports sets the EnabledCloudwatchLogsExports field's value.

func (*DBCluster) SetEndpoint added in v1.5.0

func (s *DBCluster) SetEndpoint(v string) *DBCluster

SetEndpoint sets the Endpoint field's value.

func (*DBCluster) SetEngine added in v1.5.0

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

SetEngine sets the Engine field's value.

func (*DBCluster) SetEngineMode added in v1.15.9

func (s *DBCluster) SetEngineMode(v string) *DBCluster

SetEngineMode sets the EngineMode field's value.

func (*DBCluster) SetEngineVersion added in v1.5.0

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

SetEngineVersion sets the EngineVersion field's value.

func (*DBCluster) SetGlobalWriteForwardingRequested added in v1.32.5

func (s *DBCluster) SetGlobalWriteForwardingRequested(v bool) *DBCluster

SetGlobalWriteForwardingRequested sets the GlobalWriteForwardingRequested field's value.

func (*DBCluster) SetGlobalWriteForwardingStatus added in v1.32.5

func (s *DBCluster) SetGlobalWriteForwardingStatus(v string) *DBCluster

SetGlobalWriteForwardingStatus sets the GlobalWriteForwardingStatus field's value.

func (*DBCluster) SetHostedZoneId added in v1.5.0

func (s *DBCluster) SetHostedZoneId(v string) *DBCluster

SetHostedZoneId sets the HostedZoneId field's value.

func (*DBCluster) SetHttpEndpointEnabled added in v1.15.85

func (s *DBCluster) SetHttpEndpointEnabled(v bool) *DBCluster

SetHttpEndpointEnabled sets the HttpEndpointEnabled field's value.

func (*DBCluster) SetIAMDatabaseAuthenticationEnabled added in v1.8.17

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

SetIAMDatabaseAuthenticationEnabled sets the IAMDatabaseAuthenticationEnabled field's value.

func (*DBCluster) SetIops added in v1.42.11

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

SetIops sets the Iops field's value.

func (*DBCluster) SetKmsKeyId added in v1.5.0

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*DBCluster) SetLatestRestorableTime added in v1.5.0

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

SetLatestRestorableTime sets the LatestRestorableTime field's value.

func (*DBCluster) SetMasterUsername added in v1.5.0

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

SetMasterUsername sets the MasterUsername field's value.

func (*DBCluster) SetMonitoringInterval added in v1.42.11

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

SetMonitoringInterval sets the MonitoringInterval field's value.

func (*DBCluster) SetMonitoringRoleArn added in v1.42.11

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

SetMonitoringRoleArn sets the MonitoringRoleArn field's value.

func (*DBCluster) SetMultiAZ added in v1.6.2

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

SetMultiAZ sets the MultiAZ field's value.

func (*DBCluster) SetNetworkType added in v1.44.79

func (s *DBCluster) SetNetworkType(v string) *DBCluster

SetNetworkType sets the NetworkType field's value.

func (*DBCluster) SetPendingModifiedValues added in v1.36.12

func (s *DBCluster) SetPendingModifiedValues(v *ClusterPendingModifiedValues) *DBCluster

SetPendingModifiedValues sets the PendingModifiedValues field's value.

func (*DBCluster) SetPercentProgress added in v1.5.0

func (s *DBCluster) SetPercentProgress(v string) *DBCluster

SetPercentProgress sets the PercentProgress field's value.

func (*DBCluster) SetPerformanceInsightsEnabled added in v1.42.11

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

SetPerformanceInsightsEnabled sets the PerformanceInsightsEnabled field's value.

func (*DBCluster) SetPerformanceInsightsKMSKeyId added in v1.42.11

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

SetPerformanceInsightsKMSKeyId sets the PerformanceInsightsKMSKeyId field's value.

func (*DBCluster) SetPerformanceInsightsRetentionPeriod added in v1.42.11

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

SetPerformanceInsightsRetentionPeriod sets the PerformanceInsightsRetentionPeriod field's value.

func (*DBCluster) SetPort added in v1.5.0

func (s *DBCluster) SetPort(v int64) *DBCluster

SetPort sets the Port field's value.

func (*DBCluster) SetPreferredBackupWindow added in v1.5.0

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*DBCluster) SetPreferredMaintenanceWindow added in v1.5.0

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*DBCluster) SetPubliclyAccessible added in v1.42.11

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

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*DBCluster) SetReadReplicaIdentifiers added in v1.5.0

func (s *DBCluster) SetReadReplicaIdentifiers(v []*string) *DBCluster

SetReadReplicaIdentifiers sets the ReadReplicaIdentifiers field's value.

func (*DBCluster) SetReaderEndpoint added in v1.5.0

func (s *DBCluster) SetReaderEndpoint(v string) *DBCluster

SetReaderEndpoint sets the ReaderEndpoint field's value.

func (*DBCluster) SetReplicationSourceIdentifier added in v1.5.0

func (s *DBCluster) SetReplicationSourceIdentifier(v string) *DBCluster

SetReplicationSourceIdentifier sets the ReplicationSourceIdentifier field's value.

func (*DBCluster) SetScalingConfigurationInfo added in v1.15.9

func (s *DBCluster) SetScalingConfigurationInfo(v *ScalingConfigurationInfo) *DBCluster

SetScalingConfigurationInfo sets the ScalingConfigurationInfo field's value.

func (*DBCluster) SetServerlessV2ScalingConfiguration added in v1.43.43

func (s *DBCluster) SetServerlessV2ScalingConfiguration(v *ServerlessV2ScalingConfigurationInfo) *DBCluster

SetServerlessV2ScalingConfiguration sets the ServerlessV2ScalingConfiguration field's value.

func (*DBCluster) SetStatus added in v1.5.0

func (s *DBCluster) SetStatus(v string) *DBCluster

SetStatus sets the Status field's value.

func (*DBCluster) SetStorageEncrypted added in v1.5.0

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

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*DBCluster) SetStorageType added in v1.42.11

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

SetStorageType sets the StorageType field's value.

func (*DBCluster) SetTagList added in v1.35.8

func (s *DBCluster) SetTagList(v []*Tag) *DBCluster

SetTagList sets the TagList field's value.

func (*DBCluster) SetVpcSecurityGroups added in v1.5.0

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

SetVpcSecurityGroups sets the VpcSecurityGroups field's value.

func (DBCluster) String added in v0.7.1

func (s DBCluster) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBClusterEndpoint added in v1.15.74

type DBClusterEndpoint struct {

	// The type associated with a custom endpoint. One of: READER, WRITER, ANY.
	CustomEndpointType *string `type:"string"`

	// The Amazon Resource Name (ARN) for the endpoint.
	DBClusterEndpointArn *string `type:"string"`

	// The identifier associated with the endpoint. This parameter is stored as
	// a lowercase string.
	DBClusterEndpointIdentifier *string `type:"string"`

	// A unique system-generated identifier for an endpoint. It remains the same
	// for the whole life of the endpoint.
	DBClusterEndpointResourceIdentifier *string `type:"string"`

	// The DB cluster identifier of the DB cluster associated with the endpoint.
	// This parameter is stored as a lowercase string.
	DBClusterIdentifier *string `type:"string"`

	// The DNS address of the endpoint.
	Endpoint *string `type:"string"`

	// The type of the endpoint. One of: READER, WRITER, CUSTOM.
	EndpointType *string `type:"string"`

	// List of DB instance identifiers that aren't part of the custom endpoint group.
	// All other eligible instances are reachable through the custom endpoint. Only
	// relevant if the list of static members is empty.
	ExcludedMembers []*string `type:"list"`

	// List of DB instance identifiers that are part of the custom endpoint group.
	StaticMembers []*string `type:"list"`

	// The current status of the endpoint. One of: creating, available, deleting,
	// inactive, modifying. The inactive state applies to an endpoint that can't
	// be used for a certain kind of cluster, such as a writer endpoint for a read-only
	// secondary cluster in a global database.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

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

  • CreateDBClusterEndpoint

  • DescribeDBClusterEndpoints

  • ModifyDBClusterEndpoint

  • DeleteDBClusterEndpoint

For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

func (DBClusterEndpoint) GoString added in v1.15.74

func (s DBClusterEndpoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBClusterEndpoint) SetCustomEndpointType added in v1.15.74

func (s *DBClusterEndpoint) SetCustomEndpointType(v string) *DBClusterEndpoint

SetCustomEndpointType sets the CustomEndpointType field's value.

func (*DBClusterEndpoint) SetDBClusterEndpointArn added in v1.15.74

func (s *DBClusterEndpoint) SetDBClusterEndpointArn(v string) *DBClusterEndpoint

SetDBClusterEndpointArn sets the DBClusterEndpointArn field's value.

func (*DBClusterEndpoint) SetDBClusterEndpointIdentifier added in v1.15.74

func (s *DBClusterEndpoint) SetDBClusterEndpointIdentifier(v string) *DBClusterEndpoint

SetDBClusterEndpointIdentifier sets the DBClusterEndpointIdentifier field's value.

func (*DBClusterEndpoint) SetDBClusterEndpointResourceIdentifier added in v1.15.74

func (s *DBClusterEndpoint) SetDBClusterEndpointResourceIdentifier(v string) *DBClusterEndpoint

SetDBClusterEndpointResourceIdentifier sets the DBClusterEndpointResourceIdentifier field's value.

func (*DBClusterEndpoint) SetDBClusterIdentifier added in v1.15.74

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DBClusterEndpoint) SetEndpoint added in v1.15.74

func (s *DBClusterEndpoint) SetEndpoint(v string) *DBClusterEndpoint

SetEndpoint sets the Endpoint field's value.

func (*DBClusterEndpoint) SetEndpointType added in v1.15.74

func (s *DBClusterEndpoint) SetEndpointType(v string) *DBClusterEndpoint

SetEndpointType sets the EndpointType field's value.

func (*DBClusterEndpoint) SetExcludedMembers added in v1.15.74

func (s *DBClusterEndpoint) SetExcludedMembers(v []*string) *DBClusterEndpoint

SetExcludedMembers sets the ExcludedMembers field's value.

func (*DBClusterEndpoint) SetStaticMembers added in v1.15.74

func (s *DBClusterEndpoint) SetStaticMembers(v []*string) *DBClusterEndpoint

SetStaticMembers sets the StaticMembers field's value.

func (*DBClusterEndpoint) SetStatus added in v1.15.74

func (s *DBClusterEndpoint) SetStatus(v string) *DBClusterEndpoint

SetStatus sets the Status field's value.

func (DBClusterEndpoint) String added in v1.15.74

func (s DBClusterEndpoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBClusterMember added in v0.7.1

type DBClusterMember struct {

	// Specifies the status of the DB cluster parameter group for this member of
	// the DB cluster.
	DBClusterParameterGroupStatus *string `type:"string"`

	// Specifies the instance identifier for this member of the DB cluster.
	DBInstanceIdentifier *string `type:"string"`

	// Value that is true if the cluster member is the primary instance for the
	// DB cluster and false otherwise.
	IsClusterWriter *bool `type:"boolean"`

	// 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.
	PromotionTier *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Contains information about an instance that is part of a DB cluster.

func (DBClusterMember) GoString added in v0.7.1

func (s DBClusterMember) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBClusterMember) SetDBClusterParameterGroupStatus added in v1.5.0

func (s *DBClusterMember) SetDBClusterParameterGroupStatus(v string) *DBClusterMember

SetDBClusterParameterGroupStatus sets the DBClusterParameterGroupStatus field's value.

func (*DBClusterMember) SetDBInstanceIdentifier added in v1.5.0

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*DBClusterMember) SetIsClusterWriter added in v1.5.0

func (s *DBClusterMember) SetIsClusterWriter(v bool) *DBClusterMember

SetIsClusterWriter sets the IsClusterWriter field's value.

func (*DBClusterMember) SetPromotionTier added in v1.5.0

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

SetPromotionTier sets the PromotionTier field's value.

func (DBClusterMember) String added in v0.7.1

func (s DBClusterMember) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBClusterOptionGroupStatus added in v0.7.1

type DBClusterOptionGroupStatus struct {

	// Specifies the name of the DB cluster option group.
	DBClusterOptionGroupName *string `type:"string"`

	// Specifies the status of the DB cluster option group.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Contains status information for a DB cluster option group.

func (DBClusterOptionGroupStatus) GoString added in v0.7.1

func (s DBClusterOptionGroupStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBClusterOptionGroupStatus) SetDBClusterOptionGroupName added in v1.5.0

func (s *DBClusterOptionGroupStatus) SetDBClusterOptionGroupName(v string) *DBClusterOptionGroupStatus

SetDBClusterOptionGroupName sets the DBClusterOptionGroupName field's value.

func (*DBClusterOptionGroupStatus) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (DBClusterOptionGroupStatus) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBClusterParameterGroup added in v0.7.1

type DBClusterParameterGroup struct {

	// The Amazon Resource Name (ARN) for the DB cluster parameter group.
	DBClusterParameterGroupArn *string `type:"string"`

	// The name of the DB cluster parameter group.
	DBClusterParameterGroupName *string `type:"string"`

	// The name of the DB parameter group family that this DB cluster parameter
	// group is compatible with.
	DBParameterGroupFamily *string `type:"string"`

	// Provides the customer-specified description for this DB cluster parameter
	// group.
	Description *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the details of an Amazon RDS DB cluster parameter group.

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

func (DBClusterParameterGroup) GoString added in v0.7.1

func (s DBClusterParameterGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBClusterParameterGroup) SetDBClusterParameterGroupArn added in v1.5.0

func (s *DBClusterParameterGroup) SetDBClusterParameterGroupArn(v string) *DBClusterParameterGroup

SetDBClusterParameterGroupArn sets the DBClusterParameterGroupArn field's value.

func (*DBClusterParameterGroup) SetDBClusterParameterGroupName added in v1.5.0

func (s *DBClusterParameterGroup) SetDBClusterParameterGroupName(v string) *DBClusterParameterGroup

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*DBClusterParameterGroup) SetDBParameterGroupFamily added in v1.5.0

func (s *DBClusterParameterGroup) SetDBParameterGroupFamily(v string) *DBClusterParameterGroup

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*DBClusterParameterGroup) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (DBClusterParameterGroup) String added in v0.7.1

func (s DBClusterParameterGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBClusterParameterGroupNameMessage added in v0.7.1

type DBClusterParameterGroupNameMessage struct {

	// The name of the DB cluster parameter group.
	//
	// Constraints:
	//
	//    * Must be 1 to 255 letters or numbers.
	//
	//    * First character must be a letter
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens
	//
	// This value is stored as a lowercase string.
	DBClusterParameterGroupName *string `type:"string"`
	// contains filtered or unexported fields
}

func (DBClusterParameterGroupNameMessage) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBClusterParameterGroupNameMessage) SetDBClusterParameterGroupName added in v1.5.0

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (DBClusterParameterGroupNameMessage) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBClusterRole added in v1.4.19

type DBClusterRole struct {

	// The name of the feature associated with the Amazon Web Services Identity
	// and Access Management (IAM) role. For information about supported feature
	// names, see DBEngineVersion.
	FeatureName *string `type:"string"`

	// The Amazon Resource Name (ARN) of the IAM role that is associated with the
	// DB cluster.
	RoleArn *string `type:"string"`

	// Describes the state of association between the IAM role and the DB cluster.
	// The Status property returns one of the following values:
	//
	//    * ACTIVE - the IAM role ARN is associated with the DB cluster and can
	//    be used to access other Amazon Web Services on your behalf.
	//
	//    * PENDING - the IAM role ARN is being associated with the DB cluster.
	//
	//    * INVALID - the IAM role ARN is associated with the DB cluster, but the
	//    DB cluster is unable to assume the IAM role in order to access other Amazon
	//    Web Services on your behalf.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.

func (DBClusterRole) GoString added in v1.4.19

func (s DBClusterRole) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBClusterRole) SetFeatureName added in v1.15.9

func (s *DBClusterRole) SetFeatureName(v string) *DBClusterRole

SetFeatureName sets the FeatureName field's value.

func (*DBClusterRole) SetRoleArn added in v1.5.0

func (s *DBClusterRole) SetRoleArn(v string) *DBClusterRole

SetRoleArn sets the RoleArn field's value.

func (*DBClusterRole) SetStatus added in v1.5.0

func (s *DBClusterRole) SetStatus(v string) *DBClusterRole

SetStatus sets the Status field's value.

func (DBClusterRole) String added in v1.4.19

func (s DBClusterRole) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBClusterSnapshot added in v0.7.1

type DBClusterSnapshot struct {

	// Specifies the allocated storage size in gibibytes (GiB).
	AllocatedStorage *int64 `type:"integer"`

	// Provides the list of Availability Zones (AZs) where instances in the DB cluster
	// snapshot can be restored.
	AvailabilityZones []*string `locationNameList:"AvailabilityZone" type:"list"`

	// Specifies the time when the DB cluster was created, in Universal Coordinated
	// Time (UTC).
	ClusterCreateTime *time.Time `type:"timestamp"`

	// Specifies the DB cluster identifier of the DB cluster that this DB cluster
	// snapshot was created from.
	DBClusterIdentifier *string `type:"string"`

	// The Amazon Resource Name (ARN) for the DB cluster snapshot.
	DBClusterSnapshotArn *string `type:"string"`

	// Specifies the identifier for the DB cluster snapshot.
	DBClusterSnapshotIdentifier *string `type:"string"`

	// Specifies the name of the database engine for this DB cluster snapshot.
	Engine *string `type:"string"`

	// Provides the engine mode of the database engine for this DB cluster snapshot.
	EngineMode *string `type:"string"`

	// Provides the version of the database engine for this DB cluster snapshot.
	EngineVersion *string `type:"string"`

	// True if mapping of Amazon Web Services Identity and Access Management (IAM)
	// accounts to database accounts is enabled, and otherwise false.
	IAMDatabaseAuthenticationEnabled *bool `type:"boolean"`

	// If StorageEncrypted is true, the Amazon Web Services KMS key identifier for
	// the encrypted DB cluster snapshot.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key.
	KmsKeyId *string `type:"string"`

	// Provides the license model information for this DB cluster snapshot.
	LicenseModel *string `type:"string"`

	// Provides the master username for this DB cluster snapshot.
	MasterUsername *string `type:"string"`

	// Specifies the percentage of the estimated data that has been transferred.
	PercentProgress *int64 `type:"integer"`

	// Specifies the port that the DB cluster was listening on at the time of the
	// snapshot.
	Port *int64 `type:"integer"`

	// Provides the time when the snapshot was taken, in Universal Coordinated Time
	// (UTC).
	SnapshotCreateTime *time.Time `type:"timestamp"`

	// Provides the type of the DB cluster snapshot.
	SnapshotType *string `type:"string"`

	// If the DB cluster snapshot was copied from a source DB cluster snapshot,
	// the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise,
	// a null value.
	SourceDBClusterSnapshotArn *string `type:"string"`

	// Specifies the status of this DB cluster snapshot. Valid statuses are the
	// following:
	//
	//    * available
	//
	//    * copying
	//
	//    * creating
	Status *string `type:"string"`

	// Specifies whether the DB cluster snapshot is encrypted.
	StorageEncrypted *bool `type:"boolean"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	TagList []*Tag `locationNameList:"Tag" type:"list"`

	// Provides the VPC ID associated with the DB cluster snapshot.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the details for an Amazon RDS DB cluster snapshot

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

func (DBClusterSnapshot) GoString added in v0.7.1

func (s DBClusterSnapshot) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBClusterSnapshot) SetAllocatedStorage added in v1.5.0

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

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*DBClusterSnapshot) SetAvailabilityZones added in v1.5.0

func (s *DBClusterSnapshot) SetAvailabilityZones(v []*string) *DBClusterSnapshot

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*DBClusterSnapshot) SetClusterCreateTime added in v1.5.0

func (s *DBClusterSnapshot) SetClusterCreateTime(v time.Time) *DBClusterSnapshot

SetClusterCreateTime sets the ClusterCreateTime field's value.

func (*DBClusterSnapshot) SetDBClusterIdentifier added in v1.5.0

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DBClusterSnapshot) SetDBClusterSnapshotArn added in v1.5.0

func (s *DBClusterSnapshot) SetDBClusterSnapshotArn(v string) *DBClusterSnapshot

SetDBClusterSnapshotArn sets the DBClusterSnapshotArn field's value.

func (*DBClusterSnapshot) SetDBClusterSnapshotIdentifier added in v1.5.0

func (s *DBClusterSnapshot) SetDBClusterSnapshotIdentifier(v string) *DBClusterSnapshot

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (*DBClusterSnapshot) SetEngine added in v1.5.0

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

SetEngine sets the Engine field's value.

func (*DBClusterSnapshot) SetEngineMode added in v1.37.10

func (s *DBClusterSnapshot) SetEngineMode(v string) *DBClusterSnapshot

SetEngineMode sets the EngineMode field's value.

func (*DBClusterSnapshot) SetEngineVersion added in v1.5.0

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

SetEngineVersion sets the EngineVersion field's value.

func (*DBClusterSnapshot) SetIAMDatabaseAuthenticationEnabled added in v1.8.17

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

SetIAMDatabaseAuthenticationEnabled sets the IAMDatabaseAuthenticationEnabled field's value.

func (*DBClusterSnapshot) SetKmsKeyId added in v1.5.0

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*DBClusterSnapshot) SetLicenseModel added in v1.5.0

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

SetLicenseModel sets the LicenseModel field's value.

func (*DBClusterSnapshot) SetMasterUsername added in v1.5.0

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

SetMasterUsername sets the MasterUsername field's value.

func (*DBClusterSnapshot) SetPercentProgress added in v1.5.0

func (s *DBClusterSnapshot) SetPercentProgress(v int64) *DBClusterSnapshot

SetPercentProgress sets the PercentProgress field's value.

func (*DBClusterSnapshot) SetPort added in v1.5.0

func (s *DBClusterSnapshot) SetPort(v int64) *DBClusterSnapshot

SetPort sets the Port field's value.

func (*DBClusterSnapshot) SetSnapshotCreateTime added in v1.5.0

func (s *DBClusterSnapshot) SetSnapshotCreateTime(v time.Time) *DBClusterSnapshot

SetSnapshotCreateTime sets the SnapshotCreateTime field's value.

func (*DBClusterSnapshot) SetSnapshotType added in v1.5.0

func (s *DBClusterSnapshot) SetSnapshotType(v string) *DBClusterSnapshot

SetSnapshotType sets the SnapshotType field's value.

func (*DBClusterSnapshot) SetSourceDBClusterSnapshotArn added in v1.8.18

func (s *DBClusterSnapshot) SetSourceDBClusterSnapshotArn(v string) *DBClusterSnapshot

SetSourceDBClusterSnapshotArn sets the SourceDBClusterSnapshotArn field's value.

func (*DBClusterSnapshot) SetStatus added in v1.5.0

func (s *DBClusterSnapshot) SetStatus(v string) *DBClusterSnapshot

SetStatus sets the Status field's value.

func (*DBClusterSnapshot) SetStorageEncrypted added in v1.5.0

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

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*DBClusterSnapshot) SetTagList added in v1.35.8

func (s *DBClusterSnapshot) SetTagList(v []*Tag) *DBClusterSnapshot

SetTagList sets the TagList field's value.

func (*DBClusterSnapshot) SetVpcId added in v1.5.0

func (s *DBClusterSnapshot) SetVpcId(v string) *DBClusterSnapshot

SetVpcId sets the VpcId field's value.

func (DBClusterSnapshot) String added in v0.7.1

func (s DBClusterSnapshot) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBClusterSnapshotAttribute added in v1.1.30

type DBClusterSnapshotAttribute struct {

	// The name of the manual DB cluster snapshot attribute.
	//
	// The attribute named restore refers to the list of Amazon Web Services accounts
	// that have permission to copy or restore the manual DB cluster snapshot. For
	// more information, see the ModifyDBClusterSnapshotAttribute API action.
	AttributeName *string `type:"string"`

	// The value(s) for the manual DB cluster snapshot attribute.
	//
	// If the AttributeName field is set to restore, then this element returns a
	// list of IDs of the Amazon Web Services accounts that are authorized to copy
	// or restore the manual DB cluster snapshot. If a value of all is in the list,
	// then the manual DB cluster snapshot is public and available for any Amazon
	// Web Services account to copy or restore.
	AttributeValues []*string `locationNameList:"AttributeValue" type:"list"`
	// contains filtered or unexported fields
}

Contains the name and values of a manual DB cluster snapshot attribute.

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

func (DBClusterSnapshotAttribute) GoString added in v1.1.30

func (s DBClusterSnapshotAttribute) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBClusterSnapshotAttribute) SetAttributeName added in v1.5.0

SetAttributeName sets the AttributeName field's value.

func (*DBClusterSnapshotAttribute) SetAttributeValues added in v1.5.0

func (s *DBClusterSnapshotAttribute) SetAttributeValues(v []*string) *DBClusterSnapshotAttribute

SetAttributeValues sets the AttributeValues field's value.

func (DBClusterSnapshotAttribute) String added in v1.1.30

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBClusterSnapshotAttributesResult added in v1.1.30

type DBClusterSnapshotAttributesResult struct {

	// The list of attributes and values for the manual DB cluster snapshot.
	DBClusterSnapshotAttributes []*DBClusterSnapshotAttribute `locationNameList:"DBClusterSnapshotAttribute" type:"list"`

	// The identifier of the manual DB cluster snapshot that the attributes apply
	// to.
	DBClusterSnapshotIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

func (DBClusterSnapshotAttributesResult) GoString added in v1.1.30

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBClusterSnapshotAttributesResult) SetDBClusterSnapshotAttributes added in v1.5.0

SetDBClusterSnapshotAttributes sets the DBClusterSnapshotAttributes field's value.

func (*DBClusterSnapshotAttributesResult) SetDBClusterSnapshotIdentifier added in v1.5.0

func (s *DBClusterSnapshotAttributesResult) SetDBClusterSnapshotIdentifier(v string) *DBClusterSnapshotAttributesResult

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (DBClusterSnapshotAttributesResult) String added in v1.1.30

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBEngineVersion

type DBEngineVersion struct {

	// The creation time of the DB engine version.
	CreateTime *time.Time `type:"timestamp"`

	// The description of the database engine.
	DBEngineDescription *string `type:"string"`

	// The ARN of the custom engine version.
	DBEngineVersionArn *string `type:"string"`

	// The description of the database engine version.
	DBEngineVersionDescription *string `type:"string"`

	// The name of the DB parameter group family for the database engine.
	DBParameterGroupFamily *string `type:"string"`

	// The name of the Amazon S3 bucket that contains your database installation
	// files.
	DatabaseInstallationFilesS3BucketName *string `type:"string"`

	// The Amazon S3 directory that contains the database installation files. If
	// not specified, then no prefix is assumed.
	DatabaseInstallationFilesS3Prefix *string `type:"string"`

	// The default character set for new instances of this engine version, if the
	// CharacterSetName parameter of the CreateDBInstance API isn't specified.
	DefaultCharacterSet *CharacterSet `type:"structure"`

	// The name of the database engine.
	Engine *string `type:"string"`

	// The version number of the database engine.
	EngineVersion *string `type:"string"`

	// The types of logs that the database engine has available for export to CloudWatch
	// Logs.
	ExportableLogTypes []*string `type:"list"`

	// The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter
	// is required for RDS Custom, but optional for Amazon RDS.
	KMSKeyId *string `type:"string"`

	// The major engine version of the CEV.
	MajorEngineVersion *string `type:"string"`

	// The status of the DB engine version, either available or deprecated.
	Status *string `type:"string"`

	// A list of the character sets supported by this engine for the CharacterSetName
	// parameter of the CreateDBInstance operation.
	SupportedCharacterSets []*CharacterSet `locationNameList:"CharacterSet" type:"list"`

	// A list of the supported DB engine modes.
	SupportedEngineModes []*string `type:"list"`

	// A list of features supported by the DB engine.
	//
	// The supported features vary by DB engine and DB engine version.
	//
	// To determine the supported features for a specific DB engine and DB engine
	// version using the CLI, use the following command:
	//
	// aws rds describe-db-engine-versions --engine <engine_name> --engine-version
	// <engine_version>
	//
	// For example, to determine the supported features for RDS for PostgreSQL version
	// 13.3 using the CLI, use the following command:
	//
	// aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
	//
	// The supported features are listed under SupportedFeatureNames in the output.
	SupportedFeatureNames []*string `type:"list"`

	// A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName
	// parameter of the CreateDBInstance operation.
	SupportedNcharCharacterSets []*CharacterSet `locationNameList:"CharacterSet" type:"list"`

	// A list of the time zones supported by this engine for the Timezone parameter
	// of the CreateDBInstance action.
	SupportedTimezones []*Timezone `locationNameList:"Timezone" type:"list"`

	// A value that indicates whether the engine version supports Babelfish for
	// Aurora PostgreSQL.
	SupportsBabelfish *bool `type:"boolean"`

	// A value that indicates whether you can use Aurora global databases with a
	// specific DB engine version.
	SupportsGlobalDatabases *bool `type:"boolean"`

	// A value that indicates whether the engine version supports exporting the
	// log types specified by ExportableLogTypes to CloudWatch Logs.
	SupportsLogExportsToCloudwatchLogs *bool `type:"boolean"`

	// A value that indicates whether you can use Aurora parallel query with a specific
	// DB engine version.
	SupportsParallelQuery *bool `type:"boolean"`

	// Indicates whether the database engine version supports read replicas.
	SupportsReadReplica *bool `type:"boolean"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	TagList []*Tag `locationNameList:"Tag" type:"list"`

	// A list of engine versions that this database engine version can be upgraded
	// to.
	ValidUpgradeTarget []*UpgradeTarget `locationNameList:"UpgradeTarget" type:"list"`
	// contains filtered or unexported fields
}

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

func (DBEngineVersion) GoString added in v0.6.5

func (s DBEngineVersion) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBEngineVersion) SetCreateTime added in v1.41.10

func (s *DBEngineVersion) SetCreateTime(v time.Time) *DBEngineVersion

SetCreateTime sets the CreateTime field's value.

func (*DBEngineVersion) SetDBEngineDescription added in v1.5.0

func (s *DBEngineVersion) SetDBEngineDescription(v string) *DBEngineVersion

SetDBEngineDescription sets the DBEngineDescription field's value.

func (*DBEngineVersion) SetDBEngineVersionArn added in v1.41.10

func (s *DBEngineVersion) SetDBEngineVersionArn(v string) *DBEngineVersion

SetDBEngineVersionArn sets the DBEngineVersionArn field's value.

func (*DBEngineVersion) SetDBEngineVersionDescription added in v1.5.0

func (s *DBEngineVersion) SetDBEngineVersionDescription(v string) *DBEngineVersion

SetDBEngineVersionDescription sets the DBEngineVersionDescription field's value.

func (*DBEngineVersion) SetDBParameterGroupFamily added in v1.5.0

func (s *DBEngineVersion) SetDBParameterGroupFamily(v string) *DBEngineVersion

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*DBEngineVersion) SetDatabaseInstallationFilesS3BucketName added in v1.41.10

func (s *DBEngineVersion) SetDatabaseInstallationFilesS3BucketName(v string) *DBEngineVersion

SetDatabaseInstallationFilesS3BucketName sets the DatabaseInstallationFilesS3BucketName field's value.

func (*DBEngineVersion) SetDatabaseInstallationFilesS3Prefix added in v1.41.10

func (s *DBEngineVersion) SetDatabaseInstallationFilesS3Prefix(v string) *DBEngineVersion

SetDatabaseInstallationFilesS3Prefix sets the DatabaseInstallationFilesS3Prefix field's value.

func (*DBEngineVersion) SetDefaultCharacterSet added in v1.5.0

func (s *DBEngineVersion) SetDefaultCharacterSet(v *CharacterSet) *DBEngineVersion

SetDefaultCharacterSet sets the DefaultCharacterSet field's value.

func (*DBEngineVersion) SetEngine added in v1.5.0

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

SetEngine sets the Engine field's value.

func (*DBEngineVersion) SetEngineVersion added in v1.5.0

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

SetEngineVersion sets the EngineVersion field's value.

func (*DBEngineVersion) SetExportableLogTypes added in v1.12.63

func (s *DBEngineVersion) SetExportableLogTypes(v []*string) *DBEngineVersion

SetExportableLogTypes sets the ExportableLogTypes field's value.

func (*DBEngineVersion) SetKMSKeyId added in v1.41.10

func (s *DBEngineVersion) SetKMSKeyId(v string) *DBEngineVersion

SetKMSKeyId sets the KMSKeyId field's value.

func (*DBEngineVersion) SetMajorEngineVersion added in v1.41.10

func (s *DBEngineVersion) SetMajorEngineVersion(v string) *DBEngineVersion

SetMajorEngineVersion sets the MajorEngineVersion field's value.

func (*DBEngineVersion) SetStatus added in v1.19.39

func (s *DBEngineVersion) SetStatus(v string) *DBEngineVersion

SetStatus sets the Status field's value.

func (*DBEngineVersion) SetSupportedCharacterSets added in v1.5.0

func (s *DBEngineVersion) SetSupportedCharacterSets(v []*CharacterSet) *DBEngineVersion

SetSupportedCharacterSets sets the SupportedCharacterSets field's value.

func (*DBEngineVersion) SetSupportedEngineModes added in v1.15.9

func (s *DBEngineVersion) SetSupportedEngineModes(v []*string) *DBEngineVersion

SetSupportedEngineModes sets the SupportedEngineModes field's value.

func (*DBEngineVersion) SetSupportedFeatureNames added in v1.16.25

func (s *DBEngineVersion) SetSupportedFeatureNames(v []*string) *DBEngineVersion

SetSupportedFeatureNames sets the SupportedFeatureNames field's value.

func (*DBEngineVersion) SetSupportedNcharCharacterSets added in v1.35.2

func (s *DBEngineVersion) SetSupportedNcharCharacterSets(v []*CharacterSet) *DBEngineVersion

SetSupportedNcharCharacterSets sets the SupportedNcharCharacterSets field's value.

func (*DBEngineVersion) SetSupportedTimezones added in v1.5.0

func (s *DBEngineVersion) SetSupportedTimezones(v []*Timezone) *DBEngineVersion

SetSupportedTimezones sets the SupportedTimezones field's value.

func (*DBEngineVersion) SetSupportsBabelfish added in v1.42.53

func (s *DBEngineVersion) SetSupportsBabelfish(v bool) *DBEngineVersion

SetSupportsBabelfish sets the SupportsBabelfish field's value.

func (*DBEngineVersion) SetSupportsGlobalDatabases added in v1.33.8

func (s *DBEngineVersion) SetSupportsGlobalDatabases(v bool) *DBEngineVersion

SetSupportsGlobalDatabases sets the SupportsGlobalDatabases field's value.

func (*DBEngineVersion) SetSupportsLogExportsToCloudwatchLogs added in v1.12.63

func (s *DBEngineVersion) SetSupportsLogExportsToCloudwatchLogs(v bool) *DBEngineVersion

SetSupportsLogExportsToCloudwatchLogs sets the SupportsLogExportsToCloudwatchLogs field's value.

func (*DBEngineVersion) SetSupportsParallelQuery added in v1.33.8

func (s *DBEngineVersion) SetSupportsParallelQuery(v bool) *DBEngineVersion

SetSupportsParallelQuery sets the SupportsParallelQuery field's value.

func (*DBEngineVersion) SetSupportsReadReplica added in v1.12.79

func (s *DBEngineVersion) SetSupportsReadReplica(v bool) *DBEngineVersion

SetSupportsReadReplica sets the SupportsReadReplica field's value.

func (*DBEngineVersion) SetTagList added in v1.41.10

func (s *DBEngineVersion) SetTagList(v []*Tag) *DBEngineVersion

SetTagList sets the TagList field's value.

func (*DBEngineVersion) SetValidUpgradeTarget added in v1.5.0

func (s *DBEngineVersion) SetValidUpgradeTarget(v []*UpgradeTarget) *DBEngineVersion

SetValidUpgradeTarget sets the ValidUpgradeTarget field's value.

func (DBEngineVersion) String added in v0.6.5

func (s DBEngineVersion) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBInstance

type DBInstance struct {

	// Indicates whether engine-native audit fields are included in the database
	// activity stream.
	ActivityStreamEngineNativeAuditFieldsIncluded *bool `type:"boolean"`

	// The name of the Amazon Kinesis data stream used for the database activity
	// stream.
	ActivityStreamKinesisStreamName *string `type:"string"`

	// The Amazon Web Services KMS key identifier used for encrypting messages in
	// the database activity stream. The Amazon Web Services KMS key identifier
	// is the key ARN, key ID, alias ARN, or alias name for the KMS key.
	ActivityStreamKmsKeyId *string `type:"string"`

	// The mode of the database activity stream. Database events such as a change
	// or access generate an activity stream event. RDS for Oracle always handles
	// these events asynchronously.
	ActivityStreamMode *string `type:"string" enum:"ActivityStreamMode"`

	// The status of the policy state of the activity stream.
	ActivityStreamPolicyStatus *string `type:"string" enum:"ActivityStreamPolicyStatus"`

	// The status of the database activity stream.
	ActivityStreamStatus *string `type:"string" enum:"ActivityStreamStatus"`

	// Specifies the allocated storage size specified in gibibytes (GiB).
	AllocatedStorage *int64 `type:"integer"`

	// The Amazon Web Services Identity and Access Management (IAM) roles associated
	// with the DB instance.
	AssociatedRoles []*DBInstanceRole `locationNameList:"DBInstanceRole" type:"list"`

	// A value that indicates that minor version patches are applied automatically.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// The time when a stopped DB instance is restarted automatically.
	AutomaticRestartTime *time.Time `type:"timestamp"`

	// The automation mode of the RDS Custom DB instance: full or all paused. If
	// full, the DB instance automates monitoring and instance recovery. If all
	// paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
	AutomationMode *string `type:"string" enum:"AutomationMode"`

	// Specifies the name of the Availability Zone the DB instance is located in.
	AvailabilityZone *string `type:"string"`

	// The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services
	// Backup.
	AwsBackupRecoveryPointArn *string `type:"string"`

	// Specifies the number of days for which automatic DB snapshots are retained.
	BackupRetentionPeriod *int64 `type:"integer"`

	// Specifies where automated backups and manual snapshots are stored: Amazon
	// Web Services Outposts or the Amazon Web Services Region.
	BackupTarget *string `type:"string"`

	// The identifier of the CA certificate for this DB instance.
	CACertificateIdentifier *string `type:"string"`

	// If present, specifies the name of the character set that this instance is
	// associated with.
	CharacterSetName *string `type:"string"`

	// Specifies whether tags are copied from the DB instance to snapshots of the
	// DB instance.
	//
	// Amazon Aurora
	//
	// Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting
	// this value for an Aurora DB instance has no effect on the DB cluster setting.
	// For more information, see DBCluster.
	CopyTagsToSnapshot *bool `type:"boolean"`

	// The instance profile associated with the underlying Amazon EC2 instance of
	// an RDS Custom DB instance. The instance profile must meet the following requirements:
	//
	//    * The profile must exist in your account.
	//
	//    * The profile must have an IAM role that Amazon EC2 has permissions to
	//    assume.
	//
	//    * The instance profile name and the associated IAM role name must start
	//    with the prefix AWSRDSCustom.
	//
	// For the list of permissions required for the IAM role, see Configure IAM
	// and your VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc)
	// in the Amazon RDS User Guide.
	CustomIamInstanceProfile *string `type:"string"`

	// Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS
	// on Outposts DB instance.
	//
	// A CoIP provides local or external connectivity to resources in your Outpost
	// subnets through your on-premises network. For some use cases, a CoIP can
	// provide lower latency for connections to the DB instance from outside of
	// its virtual private cloud (VPC) on your local network.
	//
	// For more information about RDS on Outposts, see Working with Amazon RDS on
	// Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)
	// in the Amazon RDS User Guide.
	//
	// For more information about CoIPs, see Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing)
	// in the Amazon Web Services Outposts User Guide.
	CustomerOwnedIpEnabled *bool `type:"boolean"`

	// 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.
	DBClusterIdentifier *string `type:"string"`

	// The Amazon Resource Name (ARN) for the DB instance.
	DBInstanceArn *string `type:"string"`

	// The list of replicated automated backups associated with the DB instance.
	DBInstanceAutomatedBackupsReplications []*DBInstanceAutomatedBackupsReplication `locationNameList:"DBInstanceAutomatedBackupsReplication" type:"list"`

	// Contains the name of the compute and memory capacity class of the DB instance.
	DBInstanceClass *string `type:"string"`

	// Contains a user-supplied database identifier. This identifier is the unique
	// key that identifies a DB instance.
	DBInstanceIdentifier *string `type:"string"`

	// Specifies the current state of this database.
	//
	// For information about DB instance statuses, see Viewing DB instance status
	// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/accessing-monitoring.html#Overview.DBInstance.Status)
	// in the Amazon RDS User Guide.
	DBInstanceStatus *string `type:"string"`

	// The meaning of this parameter differs according to the database engine you
	// use.
	//
	// 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.
	DBName *string `type:"string"`

	// Provides the list of DB parameter groups applied to this DB instance.
	DBParameterGroups []*DBParameterGroupStatus `locationNameList:"DBParameterGroup" type:"list"`

	// A list of DB security group elements containing DBSecurityGroup.Name and
	// DBSecurityGroup.Status subelements.
	DBSecurityGroups []*DBSecurityGroupMembership `locationNameList:"DBSecurityGroup" type:"list"`

	// Specifies information on the subnet group associated with the DB instance,
	// including the name, description, and subnets in the subnet group.
	DBSubnetGroup *DBSubnetGroup `type:"structure"`

	// 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.
	DbInstancePort *int64 `type:"integer"`

	// The Amazon Web Services Region-unique, immutable identifier for the DB instance.
	// This identifier is found in Amazon Web Services CloudTrail log entries whenever
	// the Amazon Web Services KMS key for the DB instance is accessed.
	DbiResourceId *string `type:"string"`

	// Indicates if the DB instance has deletion protection enabled. The database
	// can't be deleted when deletion protection is enabled. For more information,
	// see Deleting a DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
	DeletionProtection *bool `type:"boolean"`

	// The Active Directory Domain membership records associated with the DB instance.
	DomainMemberships []*DomainMembership `locationNameList:"DomainMembership" type:"list"`

	// 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.
	EnabledCloudwatchLogsExports []*string `type:"list"`

	// Specifies the connection endpoint.
	//
	// The endpoint might not be shown for instances whose status is creating.
	Endpoint *Endpoint `type:"structure"`

	// The name of the database engine to be used for this DB instance.
	Engine *string `type:"string"`

	// Indicates the database engine version.
	EngineVersion *string `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.
	EnhancedMonitoringResourceArn *string `type:"string"`

	// True if mapping of Amazon Web Services 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.
	IAMDatabaseAuthenticationEnabled *bool `type:"boolean"`

	// Provides the date and time the DB instance was created.
	InstanceCreateTime *time.Time `type:"timestamp"`

	// Specifies the Provisioned IOPS (I/O operations per second) value.
	Iops *int64 `type:"integer"`

	// If StorageEncrypted is true, the Amazon Web Services KMS key identifier for
	// the encrypted DB instance.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key.
	KmsKeyId *string `type:"string"`

	// Specifies the latest time to which a database can be restored with point-in-time
	// restore.
	LatestRestorableTime *time.Time `type:"timestamp"`

	// License model information for this DB instance. This setting doesn't apply
	// to RDS Custom.
	LicenseModel *string `type:"string"`

	// Specifies the listener connection endpoint for SQL Server Always On.
	ListenerEndpoint *Endpoint `type:"structure"`

	// Contains the master username for the DB instance.
	MasterUsername *string `type:"string"`

	// The upper limit in gibibytes (GiB) to which Amazon RDS can automatically
	// scale the storage of the DB instance.
	MaxAllocatedStorage *int64 `type:"integer"`

	// The interval, in seconds, between points when Enhanced Monitoring metrics
	// are collected for the DB instance.
	MonitoringInterval *int64 `type:"integer"`

	// The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics
	// to Amazon CloudWatch Logs.
	MonitoringRoleArn *string `type:"string"`

	// Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't
	// apply to RDS Custom.
	MultiAZ *bool `type:"boolean"`

	// The name of the NCHAR character set for the Oracle DB instance. This character
	// set specifies the Unicode encoding for data stored in table columns of type
	// NCHAR, NCLOB, or NVARCHAR2.
	NcharCharacterSetName *string `type:"string"`

	// The network type of the DB instance.
	//
	// Valid values:
	//
	//    * IPV4
	//
	//    * DUAL
	//
	// The network type is determined by the DBSubnetGroup specified for the DB
	// instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4
	// and the IPv6 protocols (DUAL).
	//
	// For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
	// in the Amazon RDS User Guide and Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
	// in the Amazon Aurora User Guide.
	NetworkType *string `type:"string"`

	// Provides the list of option group memberships for this DB instance.
	OptionGroupMemberships []*OptionGroupMembership `locationNameList:"OptionGroupMembership" type:"list"`

	// A value that specifies that changes to the DB instance are pending. This
	// element is only included when changes are pending. Specific changes are identified
	// by subelements.
	PendingModifiedValues *PendingModifiedValues `type:"structure"`

	// True if Performance Insights is enabled for the DB instance, and otherwise
	// false.
	PerformanceInsightsEnabled *bool `type:"boolean"`

	// The Amazon Web Services KMS key identifier for encryption of Performance
	// Insights data.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key.
	PerformanceInsightsKMSKeyId *string `type:"string"`

	// The number of days to retain Performance Insights data. The default is 7
	// days. The following values are valid:
	//
	//    * 7
	//
	//    * month * 31, where month is a number of months from 1-23
	//
	//    * 731
	//
	// For example, the following values are valid:
	//
	//    * 93 (3 months * 31)
	//
	//    * 341 (11 months * 31)
	//
	//    * 589 (19 months * 31)
	//
	//    * 731
	PerformanceInsightsRetentionPeriod *int64 `type:"integer"`

	// Specifies the daily time range during which automated backups are created
	// if automated backups are enabled, as determined by the BackupRetentionPeriod.
	PreferredBackupWindow *string `type:"string"`

	// Specifies the weekly time range during which system maintenance can occur,
	// in Universal Coordinated Time (UTC).
	PreferredMaintenanceWindow *string `type:"string"`

	// The number of CPU cores and the number of threads per core for the DB instance
	// class of the DB instance.
	ProcessorFeatures []*ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"`

	// 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.
	PromotionTier *int64 `type:"integer"`

	// Specifies the accessibility options for the DB instance.
	//
	// When the DB cluster is publicly accessible, its Domain Name System (DNS)
	// endpoint resolves to the private IP address from within the DB cluster's
	// virtual private cloud (VPC). It resolves to the public IP address from outside
	// of the DB cluster's VPC. Access to the DB cluster is ultimately controlled
	// by the security group it uses. That public access isn't permitted if the
	// security group assigned to the DB cluster doesn't permit it.
	//
	// When the DB instance isn't publicly accessible, it is an internal DB instance
	// with a DNS name that resolves to a private IP address.
	//
	// For more information, see CreateDBInstance.
	PubliclyAccessible *bool `type:"boolean"`

	// 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 for MySQL DB instance, the Aurora MySQL DB
	// cluster for the Aurora read replica is shown. This output doesn't contain
	// information about cross-Region Aurora read replicas.
	//
	// Currently, each RDS DB instance can have only one Aurora read replica.
	ReadReplicaDBClusterIdentifiers []*string `locationNameList:"ReadReplicaDBClusterIdentifier" type:"list"`

	// Contains one or more identifiers of the read replicas associated with this
	// DB instance.
	ReadReplicaDBInstanceIdentifiers []*string `locationNameList:"ReadReplicaDBInstanceIdentifier" type:"list"`

	// Contains the identifier of the source DB instance if this DB instance is
	// a read replica.
	ReadReplicaSourceDBInstanceIdentifier *string `type:"string"`

	// The open mode of an Oracle read replica. The default is open-read-only. For
	// more information, see Working with Oracle Read Replicas for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html)
	// in the Amazon RDS User Guide.
	//
	// This attribute is only supported in RDS for Oracle.
	ReplicaMode *string `type:"string" enum:"ReplicaMode"`

	// The number of minutes to pause the automation. When the time period ends,
	// RDS Custom resumes full automation. The minimum value is 60 (default). The
	// maximum value is 1,440.
	ResumeFullAutomationModeTime *time.Time `type:"timestamp"`

	// If present, specifies the name of the secondary Availability Zone for a DB
	// instance with multi-AZ support.
	SecondaryAvailabilityZone *string `type:"string"`

	// The status of a read replica. If the instance isn't a read replica, this
	// is blank.
	StatusInfos []*DBInstanceStatusInfo `locationNameList:"DBInstanceStatusInfo" type:"list"`

	// Specifies whether the DB instance is encrypted.
	StorageEncrypted *bool `type:"boolean"`

	// Specifies the storage type associated with DB instance.
	StorageType *string `type:"string"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	TagList []*Tag `locationNameList:"Tag" type:"list"`

	// The ARN from the key store with which the instance is associated for TDE
	// encryption.
	TdeCredentialArn *string `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.
	Timezone *string `type:"string"`

	// Provides a list of VPC security group elements that the DB instance belongs
	// to.
	VpcSecurityGroups []*VpcSecurityGroupMembership `locationNameList:"VpcSecurityGroupMembership" type:"list"`
	// contains filtered or unexported fields
}

Contains the details of an Amazon RDS DB instance.

This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.

func (DBInstance) GoString added in v0.6.5

func (s DBInstance) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBInstance) SetActivityStreamEngineNativeAuditFieldsIncluded added in v1.38.64

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

SetActivityStreamEngineNativeAuditFieldsIncluded sets the ActivityStreamEngineNativeAuditFieldsIncluded field's value.

func (*DBInstance) SetActivityStreamKinesisStreamName added in v1.38.64

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

SetActivityStreamKinesisStreamName sets the ActivityStreamKinesisStreamName field's value.

func (*DBInstance) SetActivityStreamKmsKeyId added in v1.38.64

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

SetActivityStreamKmsKeyId sets the ActivityStreamKmsKeyId field's value.

func (*DBInstance) SetActivityStreamMode added in v1.38.64

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

SetActivityStreamMode sets the ActivityStreamMode field's value.

func (*DBInstance) SetActivityStreamPolicyStatus added in v1.44.61

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

SetActivityStreamPolicyStatus sets the ActivityStreamPolicyStatus field's value.

func (*DBInstance) SetActivityStreamStatus added in v1.38.64

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

SetActivityStreamStatus sets the ActivityStreamStatus field's value.

func (*DBInstance) SetAllocatedStorage added in v1.5.0

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

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*DBInstance) SetAssociatedRoles added in v1.16.25

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

SetAssociatedRoles sets the AssociatedRoles field's value.

func (*DBInstance) SetAutoMinorVersionUpgrade added in v1.5.0

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*DBInstance) SetAutomaticRestartTime added in v1.40.15

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

SetAutomaticRestartTime sets the AutomaticRestartTime field's value.

func (*DBInstance) SetAutomationMode added in v1.41.10

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

SetAutomationMode sets the AutomationMode field's value.

func (*DBInstance) SetAvailabilityZone added in v1.5.0

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

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*DBInstance) SetAwsBackupRecoveryPointArn added in v1.37.15

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

SetAwsBackupRecoveryPointArn sets the AwsBackupRecoveryPointArn field's value.

func (*DBInstance) SetBackupRetentionPeriod added in v1.5.0

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*DBInstance) SetBackupTarget added in v1.42.10

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

SetBackupTarget sets the BackupTarget field's value.

func (*DBInstance) SetCACertificateIdentifier added in v1.5.0

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

SetCACertificateIdentifier sets the CACertificateIdentifier field's value.

func (*DBInstance) SetCharacterSetName added in v1.5.0

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

SetCharacterSetName sets the CharacterSetName field's value.

func (*DBInstance) SetCopyTagsToSnapshot added in v1.5.0

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

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*DBInstance) SetCustomIamInstanceProfile added in v1.41.10

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

SetCustomIamInstanceProfile sets the CustomIamInstanceProfile field's value.

func (*DBInstance) SetCustomerOwnedIpEnabled added in v1.36.14

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

SetCustomerOwnedIpEnabled sets the CustomerOwnedIpEnabled field's value.

func (*DBInstance) SetDBClusterIdentifier added in v1.5.0

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DBInstance) SetDBInstanceArn added in v1.5.0

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

SetDBInstanceArn sets the DBInstanceArn field's value.

func (*DBInstance) SetDBInstanceAutomatedBackupsReplications added in v1.36.2

func (s *DBInstance) SetDBInstanceAutomatedBackupsReplications(v []*DBInstanceAutomatedBackupsReplication) *DBInstance

SetDBInstanceAutomatedBackupsReplications sets the DBInstanceAutomatedBackupsReplications field's value.

func (*DBInstance) SetDBInstanceClass added in v1.5.0

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

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*DBInstance) SetDBInstanceIdentifier added in v1.5.0

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*DBInstance) SetDBInstanceStatus added in v1.5.0

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

SetDBInstanceStatus sets the DBInstanceStatus field's value.

func (*DBInstance) SetDBName added in v1.5.0

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

SetDBName sets the DBName field's value.

func (*DBInstance) SetDBParameterGroups added in v1.5.0

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

SetDBParameterGroups sets the DBParameterGroups field's value.

func (*DBInstance) SetDBSecurityGroups added in v1.5.0

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

SetDBSecurityGroups sets the DBSecurityGroups field's value.

func (*DBInstance) SetDBSubnetGroup added in v1.5.0

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

SetDBSubnetGroup sets the DBSubnetGroup field's value.

func (*DBInstance) SetDbInstancePort added in v1.5.0

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

SetDbInstancePort sets the DbInstancePort field's value.

func (*DBInstance) SetDbiResourceId added in v1.5.0

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

SetDbiResourceId sets the DbiResourceId field's value.

func (*DBInstance) SetDeletionProtection added in v1.15.43

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

SetDeletionProtection sets the DeletionProtection field's value.

func (*DBInstance) SetDomainMemberships added in v1.5.0

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

SetDomainMemberships sets the DomainMemberships field's value.

func (*DBInstance) SetEnabledCloudwatchLogsExports added in v1.12.63

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

SetEnabledCloudwatchLogsExports sets the EnabledCloudwatchLogsExports field's value.

func (*DBInstance) SetEndpoint added in v1.5.0

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

SetEndpoint sets the Endpoint field's value.

func (*DBInstance) SetEngine added in v1.5.0

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

SetEngine sets the Engine field's value.

func (*DBInstance) SetEngineVersion added in v1.5.0

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

SetEngineVersion sets the EngineVersion field's value.

func (*DBInstance) SetEnhancedMonitoringResourceArn added in v1.5.0

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

SetEnhancedMonitoringResourceArn sets the EnhancedMonitoringResourceArn field's value.

func (*DBInstance) SetIAMDatabaseAuthenticationEnabled added in v1.8.17

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

SetIAMDatabaseAuthenticationEnabled sets the IAMDatabaseAuthenticationEnabled field's value.

func (*DBInstance) SetInstanceCreateTime added in v1.5.0

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

SetInstanceCreateTime sets the InstanceCreateTime field's value.

func (*DBInstance) SetIops added in v1.5.0

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

SetIops sets the Iops field's value.

func (*DBInstance) SetKmsKeyId added in v1.5.0

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*DBInstance) SetLatestRestorableTime added in v1.5.0

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

SetLatestRestorableTime sets the LatestRestorableTime field's value.

func (*DBInstance) SetLicenseModel added in v1.5.0

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

SetLicenseModel sets the LicenseModel field's value.

func (*DBInstance) SetListenerEndpoint added in v1.15.65

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

SetListenerEndpoint sets the ListenerEndpoint field's value.

func (*DBInstance) SetMasterUsername added in v1.5.0

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

SetMasterUsername sets the MasterUsername field's value.

func (*DBInstance) SetMaxAllocatedStorage added in v1.20.5

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

SetMaxAllocatedStorage sets the MaxAllocatedStorage field's value.

func (*DBInstance) SetMonitoringInterval added in v1.5.0

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

SetMonitoringInterval sets the MonitoringInterval field's value.

func (*DBInstance) SetMonitoringRoleArn added in v1.5.0

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

SetMonitoringRoleArn sets the MonitoringRoleArn field's value.

func (*DBInstance) SetMultiAZ added in v1.5.0

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

SetMultiAZ sets the MultiAZ field's value.

func (*DBInstance) SetNcharCharacterSetName added in v1.35.2

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

SetNcharCharacterSetName sets the NcharCharacterSetName field's value.

func (*DBInstance) SetNetworkType added in v1.44.4

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

SetNetworkType sets the NetworkType field's value.

func (*DBInstance) SetOptionGroupMemberships added in v1.5.0

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

SetOptionGroupMemberships sets the OptionGroupMemberships field's value.

func (*DBInstance) SetPendingModifiedValues added in v1.5.0

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

SetPendingModifiedValues sets the PendingModifiedValues field's value.

func (*DBInstance) SetPerformanceInsightsEnabled added in v1.10.50

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

SetPerformanceInsightsEnabled sets the PerformanceInsightsEnabled field's value.

func (*DBInstance) SetPerformanceInsightsKMSKeyId added in v1.10.50

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

SetPerformanceInsightsKMSKeyId sets the PerformanceInsightsKMSKeyId field's value.

func (*DBInstance) SetPerformanceInsightsRetentionPeriod added in v1.14.10

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

SetPerformanceInsightsRetentionPeriod sets the PerformanceInsightsRetentionPeriod field's value.

func (*DBInstance) SetPreferredBackupWindow added in v1.5.0

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*DBInstance) SetPreferredMaintenanceWindow added in v1.5.0

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*DBInstance) SetProcessorFeatures added in v1.14.1

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

SetProcessorFeatures sets the ProcessorFeatures field's value.

func (*DBInstance) SetPromotionTier added in v1.5.0

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

SetPromotionTier sets the PromotionTier field's value.

func (*DBInstance) SetPubliclyAccessible added in v1.5.0

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

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*DBInstance) SetReadReplicaDBClusterIdentifiers added in v1.6.13

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

SetReadReplicaDBClusterIdentifiers sets the ReadReplicaDBClusterIdentifiers field's value.

func (*DBInstance) SetReadReplicaDBInstanceIdentifiers added in v1.5.0

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

SetReadReplicaDBInstanceIdentifiers sets the ReadReplicaDBInstanceIdentifiers field's value.

func (*DBInstance) SetReadReplicaSourceDBInstanceIdentifier added in v1.5.0

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

SetReadReplicaSourceDBInstanceIdentifier sets the ReadReplicaSourceDBInstanceIdentifier field's value.

func (*DBInstance) SetReplicaMode added in v1.34.4

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

SetReplicaMode sets the ReplicaMode field's value.

func (*DBInstance) SetResumeFullAutomationModeTime added in v1.41.10

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

SetResumeFullAutomationModeTime sets the ResumeFullAutomationModeTime field's value.

func (*DBInstance) SetSecondaryAvailabilityZone added in v1.5.0

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

SetSecondaryAvailabilityZone sets the SecondaryAvailabilityZone field's value.

func (*DBInstance) SetStatusInfos added in v1.5.0

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

SetStatusInfos sets the StatusInfos field's value.

func (*DBInstance) SetStorageEncrypted added in v1.5.0

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

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*DBInstance) SetStorageType added in v1.5.0

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

SetStorageType sets the StorageType field's value.

func (*DBInstance) SetTagList added in v1.35.8

func (s *DBInstance) SetTagList(v []*Tag) *DBInstance

SetTagList sets the TagList field's value.

func (*DBInstance) SetTdeCredentialArn added in v1.5.0

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

SetTdeCredentialArn sets the TdeCredentialArn field's value.

func (*DBInstance) SetTimezone added in v1.5.0

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

SetTimezone sets the Timezone field's value.

func (*DBInstance) SetVpcSecurityGroups added in v1.5.0

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

SetVpcSecurityGroups sets the VpcSecurityGroups field's value.

func (DBInstance) String added in v0.6.5

func (s DBInstance) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBInstanceAutomatedBackup added in v1.15.77

type DBInstanceAutomatedBackup struct {

	// Specifies the allocated storage size in gibibytes (GiB).
	AllocatedStorage *int64 `type:"integer"`

	// The Availability Zone that the automated backup was created in. For information
	// on Amazon Web Services Regions and Availability Zones, see Regions and Availability
	// Zones (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).
	AvailabilityZone *string `type:"string"`

	// The retention period for the automated backups.
	BackupRetentionPeriod *int64 `type:"integer"`

	// Specifies where automated backups are stored: Amazon Web Services Outposts
	// or the Amazon Web Services Region.
	BackupTarget *string `type:"string"`

	// The Amazon Resource Name (ARN) for the automated backups.
	DBInstanceArn *string `type:"string"`

	// The Amazon Resource Name (ARN) for the replicated automated backups.
	DBInstanceAutomatedBackupsArn *string `type:"string"`

	// The list of replications to different Amazon Web Services Regions associated
	// with the automated backup.
	DBInstanceAutomatedBackupsReplications []*DBInstanceAutomatedBackupsReplication `locationNameList:"DBInstanceAutomatedBackupsReplication" type:"list"`

	// The customer id of the instance that is/was associated with the automated
	// backup.
	DBInstanceIdentifier *string `type:"string"`

	// The identifier for the source DB instance, which can't be changed and which
	// is unique to an Amazon Web Services Region.
	DbiResourceId *string `type:"string"`

	// Specifies whether the automated backup is encrypted.
	Encrypted *bool `type:"boolean"`

	// The name of the database engine for this automated backup.
	Engine *string `type:"string"`

	// The version of the database engine for the automated backup.
	EngineVersion *string `type:"string"`

	// True if mapping of Amazon Web Services Identity and Access Management (IAM)
	// accounts to database accounts is enabled, and otherwise false.
	IAMDatabaseAuthenticationEnabled *bool `type:"boolean"`

	// Provides the date and time that the DB instance was created.
	InstanceCreateTime *time.Time `type:"timestamp"`

	// The IOPS (I/O operations per second) value for the automated backup.
	Iops *int64 `type:"integer"`

	// The Amazon Web Services KMS key ID for an automated backup.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key.
	KmsKeyId *string `type:"string"`

	// License model information for the automated backup.
	LicenseModel *string `type:"string"`

	// The license model of an automated backup.
	MasterUsername *string `type:"string"`

	// The option group the automated backup is associated with. If omitted, the
	// default option group for the engine specified is used.
	OptionGroupName *string `type:"string"`

	// The port number that the automated backup used for connections.
	//
	// Default: Inherits from the source DB instance
	//
	// Valid Values: 1150-65535
	Port *int64 `type:"integer"`

	// The Amazon Web Services Region associated with the automated backup.
	Region *string `type:"string"`

	// Earliest and latest time an instance can be restored to.
	RestoreWindow *RestoreWindow `type:"structure"`

	// Provides a list of status information for an automated backup:
	//
	//    * active - automated backups for current instances
	//
	//    * retained - automated backups for deleted instances
	//
	//    * creating - automated backups that are waiting for the first automated
	//    snapshot to be available.
	Status *string `type:"string"`

	// Specifies the storage type associated with the automated backup.
	StorageType *string `type:"string"`

	// The ARN from the key store with which the automated backup is associated
	// for TDE encryption.
	TdeCredentialArn *string `type:"string"`

	// The time zone of the automated backup. 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.
	Timezone *string `type:"string"`

	// Provides the VPC ID associated with the DB instance
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.

func (DBInstanceAutomatedBackup) GoString added in v1.15.77

func (s DBInstanceAutomatedBackup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBInstanceAutomatedBackup) SetAllocatedStorage added in v1.15.77

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

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*DBInstanceAutomatedBackup) SetAvailabilityZone added in v1.15.77

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

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*DBInstanceAutomatedBackup) SetBackupRetentionPeriod added in v1.36.2

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*DBInstanceAutomatedBackup) SetBackupTarget added in v1.42.10

SetBackupTarget sets the BackupTarget field's value.

func (*DBInstanceAutomatedBackup) SetDBInstanceArn added in v1.15.77

SetDBInstanceArn sets the DBInstanceArn field's value.

func (*DBInstanceAutomatedBackup) SetDBInstanceAutomatedBackupsArn added in v1.36.2

func (s *DBInstanceAutomatedBackup) SetDBInstanceAutomatedBackupsArn(v string) *DBInstanceAutomatedBackup

SetDBInstanceAutomatedBackupsArn sets the DBInstanceAutomatedBackupsArn field's value.

func (*DBInstanceAutomatedBackup) SetDBInstanceAutomatedBackupsReplications added in v1.36.2

func (s *DBInstanceAutomatedBackup) SetDBInstanceAutomatedBackupsReplications(v []*DBInstanceAutomatedBackupsReplication) *DBInstanceAutomatedBackup

SetDBInstanceAutomatedBackupsReplications sets the DBInstanceAutomatedBackupsReplications field's value.

func (*DBInstanceAutomatedBackup) SetDBInstanceIdentifier added in v1.15.77

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*DBInstanceAutomatedBackup) SetDbiResourceId added in v1.15.77

SetDbiResourceId sets the DbiResourceId field's value.

func (*DBInstanceAutomatedBackup) SetEncrypted added in v1.15.77

SetEncrypted sets the Encrypted field's value.

func (*DBInstanceAutomatedBackup) SetEngine added in v1.15.77

SetEngine sets the Engine field's value.

func (*DBInstanceAutomatedBackup) SetEngineVersion added in v1.15.77

SetEngineVersion sets the EngineVersion field's value.

func (*DBInstanceAutomatedBackup) SetIAMDatabaseAuthenticationEnabled added in v1.15.77

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

SetIAMDatabaseAuthenticationEnabled sets the IAMDatabaseAuthenticationEnabled field's value.

func (*DBInstanceAutomatedBackup) SetInstanceCreateTime added in v1.15.77

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

SetInstanceCreateTime sets the InstanceCreateTime field's value.

func (*DBInstanceAutomatedBackup) SetIops added in v1.15.77

SetIops sets the Iops field's value.

func (*DBInstanceAutomatedBackup) SetKmsKeyId added in v1.15.77

SetKmsKeyId sets the KmsKeyId field's value.

func (*DBInstanceAutomatedBackup) SetLicenseModel added in v1.15.77

SetLicenseModel sets the LicenseModel field's value.

func (*DBInstanceAutomatedBackup) SetMasterUsername added in v1.15.77

SetMasterUsername sets the MasterUsername field's value.

func (*DBInstanceAutomatedBackup) SetOptionGroupName added in v1.15.77

SetOptionGroupName sets the OptionGroupName field's value.

func (*DBInstanceAutomatedBackup) SetPort added in v1.15.77

SetPort sets the Port field's value.

func (*DBInstanceAutomatedBackup) SetRegion added in v1.15.77

SetRegion sets the Region field's value.

func (*DBInstanceAutomatedBackup) SetRestoreWindow added in v1.15.77

SetRestoreWindow sets the RestoreWindow field's value.

func (*DBInstanceAutomatedBackup) SetStatus added in v1.15.77

SetStatus sets the Status field's value.

func (*DBInstanceAutomatedBackup) SetStorageType added in v1.15.77

SetStorageType sets the StorageType field's value.

func (*DBInstanceAutomatedBackup) SetTdeCredentialArn added in v1.15.77

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

SetTdeCredentialArn sets the TdeCredentialArn field's value.

func (*DBInstanceAutomatedBackup) SetTimezone added in v1.15.77

SetTimezone sets the Timezone field's value.

func (*DBInstanceAutomatedBackup) SetVpcId added in v1.15.77

SetVpcId sets the VpcId field's value.

func (DBInstanceAutomatedBackup) String added in v1.15.77

func (s DBInstanceAutomatedBackup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBInstanceAutomatedBackupsReplication added in v1.36.2

type DBInstanceAutomatedBackupsReplication struct {

	// The Amazon Resource Name (ARN) of the replicated automated backups.
	DBInstanceAutomatedBackupsArn *string `type:"string"`
	// contains filtered or unexported fields
}

Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.

func (DBInstanceAutomatedBackupsReplication) GoString added in v1.36.2

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBInstanceAutomatedBackupsReplication) SetDBInstanceAutomatedBackupsArn added in v1.36.2

SetDBInstanceAutomatedBackupsArn sets the DBInstanceAutomatedBackupsArn field's value.

func (DBInstanceAutomatedBackupsReplication) String added in v1.36.2

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBInstanceRole added in v1.16.25

type DBInstanceRole struct {

	// The name of the feature associated with the Amazon Web Services Identity
	// and Access Management (IAM) role. For information about supported feature
	// names, see DBEngineVersion.
	FeatureName *string `type:"string"`

	// The Amazon Resource Name (ARN) of the IAM role that is associated with the
	// DB instance.
	RoleArn *string `type:"string"`

	// Describes the state of association between the IAM role and the DB instance.
	// The Status property returns one of the following values:
	//
	//    * ACTIVE - the IAM role ARN is associated with the DB instance and can
	//    be used to access other Amazon Web Services services on your behalf.
	//
	//    * PENDING - the IAM role ARN is being associated with the DB instance.
	//
	//    * INVALID - the IAM role ARN is associated with the DB instance, but the
	//    DB instance is unable to assume the IAM role in order to access other
	//    Amazon Web Services services on your behalf.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (DBInstanceRole) GoString added in v1.16.25

func (s DBInstanceRole) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBInstanceRole) SetFeatureName added in v1.16.25

func (s *DBInstanceRole) SetFeatureName(v string) *DBInstanceRole

SetFeatureName sets the FeatureName field's value.

func (*DBInstanceRole) SetRoleArn added in v1.16.25

func (s *DBInstanceRole) SetRoleArn(v string) *DBInstanceRole

SetRoleArn sets the RoleArn field's value.

func (*DBInstanceRole) SetStatus added in v1.16.25

func (s *DBInstanceRole) SetStatus(v string) *DBInstanceRole

SetStatus sets the Status field's value.

func (DBInstanceRole) String added in v1.16.25

func (s DBInstanceRole) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBInstanceStatusInfo

type DBInstanceStatusInfo struct {

	// Details of the error if there is an error for the instance. If the instance
	// isn't in an error state, this value is blank.
	Message *string `type:"string"`

	// Boolean value that is true if the instance is operating normally, or false
	// if the instance is in an error state.
	Normal *bool `type:"boolean"`

	// Status of the DB instance. For a StatusType of read replica, the values can
	// be replicating, replication stop point set, replication stop point reached,
	// error, stopped, or terminated.
	Status *string `type:"string"`

	// This value is currently "read replication."
	StatusType *string `type:"string"`
	// contains filtered or unexported fields
}

Provides a list of status information for a DB instance.

func (DBInstanceStatusInfo) GoString added in v0.6.5

func (s DBInstanceStatusInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBInstanceStatusInfo) SetMessage added in v1.5.0

SetMessage sets the Message field's value.

func (*DBInstanceStatusInfo) SetNormal added in v1.5.0

SetNormal sets the Normal field's value.

func (*DBInstanceStatusInfo) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (*DBInstanceStatusInfo) SetStatusType added in v1.5.0

func (s *DBInstanceStatusInfo) SetStatusType(v string) *DBInstanceStatusInfo

SetStatusType sets the StatusType field's value.

func (DBInstanceStatusInfo) String added in v0.6.5

func (s DBInstanceStatusInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBParameterGroup

type DBParameterGroup struct {

	// The Amazon Resource Name (ARN) for the DB parameter group.
	DBParameterGroupArn *string `type:"string"`

	// The name of the DB parameter group family that this DB parameter group is
	// compatible with.
	DBParameterGroupFamily *string `type:"string"`

	// The name of the DB parameter group.
	DBParameterGroupName *string `type:"string"`

	// Provides the customer-specified description for this DB parameter group.
	Description *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the details of an Amazon RDS DB parameter group.

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

func (DBParameterGroup) GoString added in v0.6.5

func (s DBParameterGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBParameterGroup) SetDBParameterGroupArn added in v1.5.0

func (s *DBParameterGroup) SetDBParameterGroupArn(v string) *DBParameterGroup

SetDBParameterGroupArn sets the DBParameterGroupArn field's value.

func (*DBParameterGroup) SetDBParameterGroupFamily added in v1.5.0

func (s *DBParameterGroup) SetDBParameterGroupFamily(v string) *DBParameterGroup

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*DBParameterGroup) SetDBParameterGroupName added in v1.5.0

func (s *DBParameterGroup) SetDBParameterGroupName(v string) *DBParameterGroup

SetDBParameterGroupName sets the DBParameterGroupName field's value.

func (*DBParameterGroup) SetDescription added in v1.5.0

func (s *DBParameterGroup) SetDescription(v string) *DBParameterGroup

SetDescription sets the Description field's value.

func (DBParameterGroup) String added in v0.6.5

func (s DBParameterGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBParameterGroupNameMessage

type DBParameterGroupNameMessage struct {

	// The name of the DB parameter group.
	DBParameterGroupName *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

func (DBParameterGroupNameMessage) GoString added in v0.6.5

func (s DBParameterGroupNameMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBParameterGroupNameMessage) SetDBParameterGroupName added in v1.5.0

func (s *DBParameterGroupNameMessage) SetDBParameterGroupName(v string) *DBParameterGroupNameMessage

SetDBParameterGroupName sets the DBParameterGroupName field's value.

func (DBParameterGroupNameMessage) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBParameterGroupStatus

type DBParameterGroupStatus struct {

	// The name of the DB parameter group.
	DBParameterGroupName *string `type:"string"`

	// The status of parameter updates.
	ParameterApplyStatus *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (DBParameterGroupStatus) GoString added in v0.6.5

func (s DBParameterGroupStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBParameterGroupStatus) SetDBParameterGroupName added in v1.5.0

func (s *DBParameterGroupStatus) SetDBParameterGroupName(v string) *DBParameterGroupStatus

SetDBParameterGroupName sets the DBParameterGroupName field's value.

func (*DBParameterGroupStatus) SetParameterApplyStatus added in v1.5.0

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

SetParameterApplyStatus sets the ParameterApplyStatus field's value.

func (DBParameterGroupStatus) String added in v0.6.5

func (s DBParameterGroupStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBProxy added in v1.25.47

type DBProxy struct {

	// One or more data structures specifying the authorization mechanism to connect
	// to the associated RDS DB instance or Aurora DB cluster.
	Auth []*UserAuthConfigInfo `type:"list"`

	// The date and time when the proxy was first created.
	CreatedDate *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) for the proxy.
	DBProxyArn *string `type:"string"`

	// The identifier for the proxy. This name must be unique for all proxies owned
	// by your Amazon Web Services account in the specified Amazon Web Services
	// Region.
	DBProxyName *string `type:"string"`

	// Whether the proxy includes detailed information about SQL statements in its
	// logs. This information helps you to debug issues involving SQL behavior or
	// the performance and scalability of the proxy connections. The debug information
	// includes the text of SQL statements that you submit through the proxy. Thus,
	// only enable this setting when needed for debugging, and only when you have
	// security measures in place to safeguard any sensitive information that appears
	// in the logs.
	DebugLogging *bool `type:"boolean"`

	// The endpoint that you can use to connect to the DB proxy. You include the
	// endpoint value in the connection string for a database client application.
	Endpoint *string `type:"string"`

	// The kinds of databases that the proxy can connect to. This value determines
	// which database network protocol the proxy recognizes when it interprets network
	// traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB,
	// and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS
	// for PostgreSQL databases.
	EngineFamily *string `type:"string"`

	// The number of seconds a connection to the proxy can have no activity before
	// the proxy drops the client connection. The proxy keeps the underlying database
	// connection open and puts it back into the connection pool for reuse by later
	// connection requests.
	//
	// Default: 1800 (30 minutes)
	//
	// Constraints: 1 to 28,800
	IdleClientTimeout *int64 `type:"integer"`

	// Indicates whether Transport Layer Security (TLS) encryption is required for
	// connections to the proxy.
	RequireTLS *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access
	// Amazon Secrets Manager.
	RoleArn *string `type:"string"`

	// The current status of this proxy. A status of available means the proxy is
	// ready to handle requests. Other values indicate that you must wait for the
	// proxy to be ready, or take some action to resolve an issue.
	Status *string `type:"string" enum:"DBProxyStatus"`

	// The date and time when the proxy was last updated.
	UpdatedDate *time.Time `type:"timestamp"`

	// Provides the VPC ID of the DB proxy.
	VpcId *string `type:"string"`

	// Provides a list of VPC security groups that the proxy belongs to.
	VpcSecurityGroupIds []*string `type:"list"`

	// The EC2 subnet IDs for the proxy.
	VpcSubnetIds []*string `type:"list"`
	// contains filtered or unexported fields
}

The data structure representing a proxy managed by the RDS Proxy.

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

func (DBProxy) GoString added in v1.25.47

func (s DBProxy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBProxy) SetAuth added in v1.25.47

func (s *DBProxy) SetAuth(v []*UserAuthConfigInfo) *DBProxy

SetAuth sets the Auth field's value.

func (*DBProxy) SetCreatedDate added in v1.25.47

func (s *DBProxy) SetCreatedDate(v time.Time) *DBProxy

SetCreatedDate sets the CreatedDate field's value.

func (*DBProxy) SetDBProxyArn added in v1.25.47

func (s *DBProxy) SetDBProxyArn(v string) *DBProxy

SetDBProxyArn sets the DBProxyArn field's value.

func (*DBProxy) SetDBProxyName added in v1.25.47

func (s *DBProxy) SetDBProxyName(v string) *DBProxy

SetDBProxyName sets the DBProxyName field's value.

func (*DBProxy) SetDebugLogging added in v1.25.47

func (s *DBProxy) SetDebugLogging(v bool) *DBProxy

SetDebugLogging sets the DebugLogging field's value.

func (*DBProxy) SetEndpoint added in v1.25.47

func (s *DBProxy) SetEndpoint(v string) *DBProxy

SetEndpoint sets the Endpoint field's value.

func (*DBProxy) SetEngineFamily added in v1.25.47

func (s *DBProxy) SetEngineFamily(v string) *DBProxy

SetEngineFamily sets the EngineFamily field's value.

func (*DBProxy) SetIdleClientTimeout added in v1.25.47

func (s *DBProxy) SetIdleClientTimeout(v int64) *DBProxy

SetIdleClientTimeout sets the IdleClientTimeout field's value.

func (*DBProxy) SetRequireTLS added in v1.25.47

func (s *DBProxy) SetRequireTLS(v bool) *DBProxy

SetRequireTLS sets the RequireTLS field's value.

func (*DBProxy) SetRoleArn added in v1.25.47

func (s *DBProxy) SetRoleArn(v string) *DBProxy

SetRoleArn sets the RoleArn field's value.

func (*DBProxy) SetStatus added in v1.25.47

func (s *DBProxy) SetStatus(v string) *DBProxy

SetStatus sets the Status field's value.

func (*DBProxy) SetUpdatedDate added in v1.25.47

func (s *DBProxy) SetUpdatedDate(v time.Time) *DBProxy

SetUpdatedDate sets the UpdatedDate field's value.

func (*DBProxy) SetVpcId added in v1.37.27

func (s *DBProxy) SetVpcId(v string) *DBProxy

SetVpcId sets the VpcId field's value.

func (*DBProxy) SetVpcSecurityGroupIds added in v1.25.47

func (s *DBProxy) SetVpcSecurityGroupIds(v []*string) *DBProxy

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (*DBProxy) SetVpcSubnetIds added in v1.25.47

func (s *DBProxy) SetVpcSubnetIds(v []*string) *DBProxy

SetVpcSubnetIds sets the VpcSubnetIds field's value.

func (DBProxy) String added in v1.25.47

func (s DBProxy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBProxyEndpoint added in v1.37.27

type DBProxyEndpoint struct {

	// The date and time when the DB proxy endpoint was first created.
	CreatedDate *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) for the DB proxy endpoint.
	DBProxyEndpointArn *string `type:"string"`

	// The name for the DB proxy endpoint. An identifier must begin with a letter
	// and must contain only ASCII letters, digits, and hyphens; it can't end with
	// a hyphen or contain two consecutive hyphens.
	DBProxyEndpointName *string `type:"string"`

	// The identifier for the DB proxy that is associated with this DB proxy endpoint.
	DBProxyName *string `type:"string"`

	// The endpoint that you can use to connect to the DB proxy. You include the
	// endpoint value in the connection string for a database client application.
	Endpoint *string `type:"string"`

	// A value that indicates whether this endpoint is the default endpoint for
	// the associated DB proxy. Default DB proxy endpoints always have read/write
	// capability. Other endpoints that you associate with the DB proxy can be either
	// read/write or read-only.
	IsDefault *bool `type:"boolean"`

	// The current status of this DB proxy endpoint. A status of available means
	// the endpoint is ready to handle requests. Other values indicate that you
	// must wait for the endpoint to be ready, or take some action to resolve an
	// issue.
	Status *string `type:"string" enum:"DBProxyEndpointStatus"`

	// A value that indicates whether the DB proxy endpoint can be used for read/write
	// or read-only operations.
	TargetRole *string `type:"string" enum:"DBProxyEndpointTargetRole"`

	// Provides the VPC ID of the DB proxy endpoint.
	VpcId *string `type:"string"`

	// Provides a list of VPC security groups that the DB proxy endpoint belongs
	// to.
	VpcSecurityGroupIds []*string `type:"list"`

	// The EC2 subnet IDs for the DB proxy endpoint.
	VpcSubnetIds []*string `type:"list"`
	// contains filtered or unexported fields
}

The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy.

This data type is used as a response element in the DescribeDBProxyEndpoints operation.

func (DBProxyEndpoint) GoString added in v1.37.27

func (s DBProxyEndpoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBProxyEndpoint) SetCreatedDate added in v1.37.27

func (s *DBProxyEndpoint) SetCreatedDate(v time.Time) *DBProxyEndpoint

SetCreatedDate sets the CreatedDate field's value.

func (*DBProxyEndpoint) SetDBProxyEndpointArn added in v1.37.27

func (s *DBProxyEndpoint) SetDBProxyEndpointArn(v string) *DBProxyEndpoint

SetDBProxyEndpointArn sets the DBProxyEndpointArn field's value.

func (*DBProxyEndpoint) SetDBProxyEndpointName added in v1.37.27

func (s *DBProxyEndpoint) SetDBProxyEndpointName(v string) *DBProxyEndpoint

SetDBProxyEndpointName sets the DBProxyEndpointName field's value.

func (*DBProxyEndpoint) SetDBProxyName added in v1.37.27

func (s *DBProxyEndpoint) SetDBProxyName(v string) *DBProxyEndpoint

SetDBProxyName sets the DBProxyName field's value.

func (*DBProxyEndpoint) SetEndpoint added in v1.37.27

func (s *DBProxyEndpoint) SetEndpoint(v string) *DBProxyEndpoint

SetEndpoint sets the Endpoint field's value.

func (*DBProxyEndpoint) SetIsDefault added in v1.37.27

func (s *DBProxyEndpoint) SetIsDefault(v bool) *DBProxyEndpoint

SetIsDefault sets the IsDefault field's value.

func (*DBProxyEndpoint) SetStatus added in v1.37.27

func (s *DBProxyEndpoint) SetStatus(v string) *DBProxyEndpoint

SetStatus sets the Status field's value.

func (*DBProxyEndpoint) SetTargetRole added in v1.37.27

func (s *DBProxyEndpoint) SetTargetRole(v string) *DBProxyEndpoint

SetTargetRole sets the TargetRole field's value.

func (*DBProxyEndpoint) SetVpcId added in v1.37.27

func (s *DBProxyEndpoint) SetVpcId(v string) *DBProxyEndpoint

SetVpcId sets the VpcId field's value.

func (*DBProxyEndpoint) SetVpcSecurityGroupIds added in v1.37.27

func (s *DBProxyEndpoint) SetVpcSecurityGroupIds(v []*string) *DBProxyEndpoint

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (*DBProxyEndpoint) SetVpcSubnetIds added in v1.37.27

func (s *DBProxyEndpoint) SetVpcSubnetIds(v []*string) *DBProxyEndpoint

SetVpcSubnetIds sets the VpcSubnetIds field's value.

func (DBProxyEndpoint) String added in v1.37.27

func (s DBProxyEndpoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBProxyTarget added in v1.25.47

type DBProxyTarget struct {

	// The writer endpoint for the RDS DB instance or Aurora DB cluster.
	Endpoint *string `type:"string"`

	// The port that the RDS Proxy uses to connect to the target RDS DB instance
	// or Aurora DB cluster.
	Port *int64 `type:"integer"`

	// The identifier representing the target. It can be the instance identifier
	// for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.
	RdsResourceId *string `type:"string"`

	// A value that indicates whether the target of the proxy can be used for read/write
	// or read-only operations.
	Role *string `type:"string" enum:"TargetRole"`

	// The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
	TargetArn *string `type:"string"`

	// Information about the connection health of the RDS Proxy target.
	TargetHealth *TargetHealth `type:"structure"`

	// The DB cluster identifier when the target represents an Aurora DB cluster.
	// This field is blank when the target represents an RDS DB instance.
	TrackedClusterId *string `type:"string"`

	// Specifies the kind of database, such as an RDS DB instance or an Aurora DB
	// cluster, that the target represents.
	Type *string `type:"string" enum:"TargetType"`
	// contains filtered or unexported fields
}

Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.

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

func (DBProxyTarget) GoString added in v1.25.47

func (s DBProxyTarget) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBProxyTarget) SetEndpoint added in v1.25.47

func (s *DBProxyTarget) SetEndpoint(v string) *DBProxyTarget

SetEndpoint sets the Endpoint field's value.

func (*DBProxyTarget) SetPort added in v1.25.47

func (s *DBProxyTarget) SetPort(v int64) *DBProxyTarget

SetPort sets the Port field's value.

func (*DBProxyTarget) SetRdsResourceId added in v1.25.47

func (s *DBProxyTarget) SetRdsResourceId(v string) *DBProxyTarget

SetRdsResourceId sets the RdsResourceId field's value.

func (*DBProxyTarget) SetRole added in v1.37.27

func (s *DBProxyTarget) SetRole(v string) *DBProxyTarget

SetRole sets the Role field's value.

func (*DBProxyTarget) SetTargetArn added in v1.25.47

func (s *DBProxyTarget) SetTargetArn(v string) *DBProxyTarget

SetTargetArn sets the TargetArn field's value.

func (*DBProxyTarget) SetTargetHealth added in v1.30.8

func (s *DBProxyTarget) SetTargetHealth(v *TargetHealth) *DBProxyTarget

SetTargetHealth sets the TargetHealth field's value.

func (*DBProxyTarget) SetTrackedClusterId added in v1.25.47

func (s *DBProxyTarget) SetTrackedClusterId(v string) *DBProxyTarget

SetTrackedClusterId sets the TrackedClusterId field's value.

func (*DBProxyTarget) SetType added in v1.25.47

func (s *DBProxyTarget) SetType(v string) *DBProxyTarget

SetType sets the Type field's value.

func (DBProxyTarget) String added in v1.25.47

func (s DBProxyTarget) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBProxyTargetGroup added in v1.25.47

type DBProxyTargetGroup struct {

	// The settings that determine the size and behavior of the connection pool
	// for the target group.
	ConnectionPoolConfig *ConnectionPoolConfigurationInfo `type:"structure"`

	// The date and time when the target group was first created.
	CreatedDate *time.Time `type:"timestamp"`

	// The identifier for the RDS proxy associated with this target group.
	DBProxyName *string `type:"string"`

	// Whether this target group is the first one used for connection requests by
	// the associated proxy. Because each proxy is currently associated with a single
	// target group, currently this setting is always true.
	IsDefault *bool `type:"boolean"`

	// The current status of this target group. A status of available means the
	// target group is correctly associated with a database. Other values indicate
	// that you must wait for the target group to be ready, or take some action
	// to resolve an issue.
	Status *string `type:"string"`

	// The Amazon Resource Name (ARN) representing the target group.
	TargetGroupArn *string `type:"string"`

	// The identifier for the target group. This name must be unique for all target
	// groups owned by your Amazon Web Services account in the specified Amazon
	// Web Services Region.
	TargetGroupName *string `type:"string"`

	// The date and time when the target group was last updated.
	UpdatedDate *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster.

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

func (DBProxyTargetGroup) GoString added in v1.25.47

func (s DBProxyTargetGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBProxyTargetGroup) SetConnectionPoolConfig added in v1.25.47

SetConnectionPoolConfig sets the ConnectionPoolConfig field's value.

func (*DBProxyTargetGroup) SetCreatedDate added in v1.25.47

func (s *DBProxyTargetGroup) SetCreatedDate(v time.Time) *DBProxyTargetGroup

SetCreatedDate sets the CreatedDate field's value.

func (*DBProxyTargetGroup) SetDBProxyName added in v1.25.47

func (s *DBProxyTargetGroup) SetDBProxyName(v string) *DBProxyTargetGroup

SetDBProxyName sets the DBProxyName field's value.

func (*DBProxyTargetGroup) SetIsDefault added in v1.25.47

func (s *DBProxyTargetGroup) SetIsDefault(v bool) *DBProxyTargetGroup

SetIsDefault sets the IsDefault field's value.

func (*DBProxyTargetGroup) SetStatus added in v1.25.47

func (s *DBProxyTargetGroup) SetStatus(v string) *DBProxyTargetGroup

SetStatus sets the Status field's value.

func (*DBProxyTargetGroup) SetTargetGroupArn added in v1.25.47

func (s *DBProxyTargetGroup) SetTargetGroupArn(v string) *DBProxyTargetGroup

SetTargetGroupArn sets the TargetGroupArn field's value.

func (*DBProxyTargetGroup) SetTargetGroupName added in v1.25.47

func (s *DBProxyTargetGroup) SetTargetGroupName(v string) *DBProxyTargetGroup

SetTargetGroupName sets the TargetGroupName field's value.

func (*DBProxyTargetGroup) SetUpdatedDate added in v1.25.47

func (s *DBProxyTargetGroup) SetUpdatedDate(v time.Time) *DBProxyTargetGroup

SetUpdatedDate sets the UpdatedDate field's value.

func (DBProxyTargetGroup) String added in v1.25.47

func (s DBProxyTargetGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBSecurityGroup

type DBSecurityGroup struct {

	// The Amazon Resource Name (ARN) for the DB security group.
	DBSecurityGroupArn *string `type:"string"`

	// Provides the description of the DB security group.
	DBSecurityGroupDescription *string `type:"string"`

	// Specifies the name of the DB security group.
	DBSecurityGroupName *string `type:"string"`

	// Contains a list of EC2SecurityGroup elements.
	EC2SecurityGroups []*EC2SecurityGroup `locationNameList:"EC2SecurityGroup" type:"list"`

	// Contains a list of IPRange elements.
	IPRanges []*IPRange `locationNameList:"IPRange" type:"list"`

	// Provides the Amazon Web Services ID of the owner of a specific DB security
	// group.
	OwnerId *string `type:"string"`

	// Provides the VpcId of the DB security group.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the details for an Amazon RDS DB security group.

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

func (DBSecurityGroup) GoString added in v0.6.5

func (s DBSecurityGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBSecurityGroup) SetDBSecurityGroupArn added in v1.5.0

func (s *DBSecurityGroup) SetDBSecurityGroupArn(v string) *DBSecurityGroup

SetDBSecurityGroupArn sets the DBSecurityGroupArn field's value.

func (*DBSecurityGroup) SetDBSecurityGroupDescription added in v1.5.0

func (s *DBSecurityGroup) SetDBSecurityGroupDescription(v string) *DBSecurityGroup

SetDBSecurityGroupDescription sets the DBSecurityGroupDescription field's value.

func (*DBSecurityGroup) SetDBSecurityGroupName added in v1.5.0

func (s *DBSecurityGroup) SetDBSecurityGroupName(v string) *DBSecurityGroup

SetDBSecurityGroupName sets the DBSecurityGroupName field's value.

func (*DBSecurityGroup) SetEC2SecurityGroups added in v1.5.0

func (s *DBSecurityGroup) SetEC2SecurityGroups(v []*EC2SecurityGroup) *DBSecurityGroup

SetEC2SecurityGroups sets the EC2SecurityGroups field's value.

func (*DBSecurityGroup) SetIPRanges added in v1.5.0

func (s *DBSecurityGroup) SetIPRanges(v []*IPRange) *DBSecurityGroup

SetIPRanges sets the IPRanges field's value.

func (*DBSecurityGroup) SetOwnerId added in v1.5.0

func (s *DBSecurityGroup) SetOwnerId(v string) *DBSecurityGroup

SetOwnerId sets the OwnerId field's value.

func (*DBSecurityGroup) SetVpcId added in v1.5.0

func (s *DBSecurityGroup) SetVpcId(v string) *DBSecurityGroup

SetVpcId sets the VpcId field's value.

func (DBSecurityGroup) String added in v0.6.5

func (s DBSecurityGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBSecurityGroupMembership

type DBSecurityGroupMembership struct {

	// The name of the DB security group.
	DBSecurityGroupName *string `type:"string"`

	// The status of the DB security group.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

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

  • ModifyDBInstance

  • RebootDBInstance

  • RestoreDBInstanceFromDBSnapshot

  • RestoreDBInstanceToPointInTime

func (DBSecurityGroupMembership) GoString added in v0.6.5

func (s DBSecurityGroupMembership) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBSecurityGroupMembership) SetDBSecurityGroupName added in v1.5.0

func (s *DBSecurityGroupMembership) SetDBSecurityGroupName(v string) *DBSecurityGroupMembership

SetDBSecurityGroupName sets the DBSecurityGroupName field's value.

func (*DBSecurityGroupMembership) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (DBSecurityGroupMembership) String added in v0.6.5

func (s DBSecurityGroupMembership) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBSnapshot

type DBSnapshot struct {

	// Specifies the allocated storage size in gibibytes (GiB).
	AllocatedStorage *int64 `type:"integer"`

	// Specifies the name of the Availability Zone the DB instance was located in
	// at the time of the DB snapshot.
	AvailabilityZone *string `type:"string"`

	// Specifies the DB instance identifier of the DB instance this DB snapshot
	// was created from.
	DBInstanceIdentifier *string `type:"string"`

	// The Amazon Resource Name (ARN) for the DB snapshot.
	DBSnapshotArn *string `type:"string"`

	// Specifies the identifier for the DB snapshot.
	DBSnapshotIdentifier *string `type:"string"`

	// The identifier for the source DB instance, which can't be changed and which
	// is unique to an Amazon Web Services Region.
	DbiResourceId *string `type:"string"`

	// Specifies whether the DB snapshot is encrypted.
	Encrypted *bool `type:"boolean"`

	// Specifies the name of the database engine.
	Engine *string `type:"string"`

	// Specifies the version of the database engine.
	EngineVersion *string `type:"string"`

	// True if mapping of Amazon Web Services Identity and Access Management (IAM)
	// accounts to database accounts is enabled, and otherwise false.
	IAMDatabaseAuthenticationEnabled *bool `type:"boolean"`

	// Specifies the time in Coordinated Universal Time (UTC) when the DB instance,
	// from which the snapshot was taken, was created.
	InstanceCreateTime *time.Time `type:"timestamp"`

	// Specifies the Provisioned IOPS (I/O operations per second) value of the DB
	// instance at the time of the snapshot.
	Iops *int64 `type:"integer"`

	// If Encrypted is true, the Amazon Web Services KMS key identifier for the
	// encrypted DB snapshot.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key.
	KmsKeyId *string `type:"string"`

	// License model information for the restored DB instance.
	LicenseModel *string `type:"string"`

	// Provides the master username for the DB snapshot.
	MasterUsername *string `type:"string"`

	// Provides the option group name for the DB snapshot.
	OptionGroupName *string `type:"string"`

	// Specifies the time of the CreateDBSnapshot operation in Coordinated Universal
	// Time (UTC). Doesn't change when the snapshot is copied.
	OriginalSnapshotCreateTime *time.Time `type:"timestamp"`

	// The percentage of the estimated data that has been transferred.
	PercentProgress *int64 `type:"integer"`

	// Specifies the port that the database engine was listening on at the time
	// of the snapshot.
	Port *int64 `type:"integer"`

	// The number of CPU cores and the number of threads per core for the DB instance
	// class of the DB instance when the DB snapshot was created.
	ProcessorFeatures []*ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"`

	// Specifies when the snapshot was taken in Coordinated Universal Time (UTC).
	// Changes for the copy when the snapshot is copied.
	SnapshotCreateTime *time.Time `type:"timestamp"`

	// The timestamp of the most recent transaction applied to the database that
	// you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime
	// is the most recent transaction in the restored DB instance. In contrast,
	// originalSnapshotCreateTime specifies the system time that the snapshot completed.
	//
	// If you back up a read replica, you can determine the replica lag by comparing
	// SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime
	// is two hours later than SnapshotDatabaseTime, then the replica lag is two
	// hours.
	SnapshotDatabaseTime *time.Time `type:"timestamp"`

	// Specifies where manual snapshots are stored: Amazon Web Services Outposts
	// or the Amazon Web Services Region.
	SnapshotTarget *string `type:"string"`

	// Provides the type of the DB snapshot.
	SnapshotType *string `type:"string"`

	// The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied
	// from. It only has a value in the case of a cross-account or cross-Region
	// copy.
	SourceDBSnapshotIdentifier *string `type:"string"`

	// The Amazon Web Services Region that the DB snapshot was created in or copied
	// from.
	SourceRegion *string `type:"string"`

	// Specifies the status of this DB snapshot.
	Status *string `type:"string"`

	// Specifies the storage type associated with DB snapshot.
	StorageType *string `type:"string"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	TagList []*Tag `locationNameList:"Tag" type:"list"`

	// The ARN from the key store with which to associate the instance for TDE encryption.
	TdeCredentialArn *string `type:"string"`

	// The time zone of the DB snapshot. In most cases, the Timezone element is
	// empty. Timezone content appears only for snapshots taken from Microsoft SQL
	// Server DB instances that were created with a time zone specified.
	Timezone *string `type:"string"`

	// Provides the VPC ID associated with the DB snapshot.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the details of an Amazon RDS DB snapshot.

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

func (DBSnapshot) GoString added in v0.6.5

func (s DBSnapshot) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBSnapshot) SetAllocatedStorage added in v1.5.0

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

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*DBSnapshot) SetAvailabilityZone added in v1.5.0

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

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*DBSnapshot) SetDBInstanceIdentifier added in v1.5.0

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*DBSnapshot) SetDBSnapshotArn added in v1.5.0

func (s *DBSnapshot) SetDBSnapshotArn(v string) *DBSnapshot

SetDBSnapshotArn sets the DBSnapshotArn field's value.

func (*DBSnapshot) SetDBSnapshotIdentifier added in v1.5.0

func (s *DBSnapshot) SetDBSnapshotIdentifier(v string) *DBSnapshot

SetDBSnapshotIdentifier sets the DBSnapshotIdentifier field's value.

func (*DBSnapshot) SetDbiResourceId added in v1.15.77

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

SetDbiResourceId sets the DbiResourceId field's value.

func (*DBSnapshot) SetEncrypted added in v1.5.0

func (s *DBSnapshot) SetEncrypted(v bool) *DBSnapshot

SetEncrypted sets the Encrypted field's value.

func (*DBSnapshot) SetEngine added in v1.5.0

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

SetEngine sets the Engine field's value.

func (*DBSnapshot) SetEngineVersion added in v1.5.0

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

SetEngineVersion sets the EngineVersion field's value.

func (*DBSnapshot) SetIAMDatabaseAuthenticationEnabled added in v1.8.17

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

SetIAMDatabaseAuthenticationEnabled sets the IAMDatabaseAuthenticationEnabled field's value.

func (*DBSnapshot) SetInstanceCreateTime added in v1.5.0

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

SetInstanceCreateTime sets the InstanceCreateTime field's value.

func (*DBSnapshot) SetIops added in v1.5.0

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

SetIops sets the Iops field's value.

func (*DBSnapshot) SetKmsKeyId added in v1.5.0

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*DBSnapshot) SetLicenseModel added in v1.5.0

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

SetLicenseModel sets the LicenseModel field's value.

func (*DBSnapshot) SetMasterUsername added in v1.5.0

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

SetMasterUsername sets the MasterUsername field's value.

func (*DBSnapshot) SetOptionGroupName added in v1.5.0

func (s *DBSnapshot) SetOptionGroupName(v string) *DBSnapshot

SetOptionGroupName sets the OptionGroupName field's value.

func (*DBSnapshot) SetOriginalSnapshotCreateTime added in v1.40.5

func (s *DBSnapshot) SetOriginalSnapshotCreateTime(v time.Time) *DBSnapshot

SetOriginalSnapshotCreateTime sets the OriginalSnapshotCreateTime field's value.

func (*DBSnapshot) SetPercentProgress added in v1.5.0

func (s *DBSnapshot) SetPercentProgress(v int64) *DBSnapshot

SetPercentProgress sets the PercentProgress field's value.

func (*DBSnapshot) SetPort added in v1.5.0

func (s *DBSnapshot) SetPort(v int64) *DBSnapshot

SetPort sets the Port field's value.

func (*DBSnapshot) SetProcessorFeatures added in v1.14.1

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

SetProcessorFeatures sets the ProcessorFeatures field's value.

func (*DBSnapshot) SetSnapshotCreateTime added in v1.5.0

func (s *DBSnapshot) SetSnapshotCreateTime(v time.Time) *DBSnapshot

SetSnapshotCreateTime sets the SnapshotCreateTime field's value.

func (*DBSnapshot) SetSnapshotDatabaseTime added in v1.44.83

func (s *DBSnapshot) SetSnapshotDatabaseTime(v time.Time) *DBSnapshot

SetSnapshotDatabaseTime sets the SnapshotDatabaseTime field's value.

func (*DBSnapshot) SetSnapshotTarget added in v1.42.10

func (s *DBSnapshot) SetSnapshotTarget(v string) *DBSnapshot

SetSnapshotTarget sets the SnapshotTarget field's value.

func (*DBSnapshot) SetSnapshotType added in v1.5.0

func (s *DBSnapshot) SetSnapshotType(v string) *DBSnapshot

SetSnapshotType sets the SnapshotType field's value.

func (*DBSnapshot) SetSourceDBSnapshotIdentifier added in v1.5.0

func (s *DBSnapshot) SetSourceDBSnapshotIdentifier(v string) *DBSnapshot

SetSourceDBSnapshotIdentifier sets the SourceDBSnapshotIdentifier field's value.

func (*DBSnapshot) SetSourceRegion added in v1.5.0

func (s *DBSnapshot) SetSourceRegion(v string) *DBSnapshot

SetSourceRegion sets the SourceRegion field's value.

func (*DBSnapshot) SetStatus added in v1.5.0

func (s *DBSnapshot) SetStatus(v string) *DBSnapshot

SetStatus sets the Status field's value.

func (*DBSnapshot) SetStorageType added in v1.5.0

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

SetStorageType sets the StorageType field's value.

func (*DBSnapshot) SetTagList added in v1.35.8

func (s *DBSnapshot) SetTagList(v []*Tag) *DBSnapshot

SetTagList sets the TagList field's value.

func (*DBSnapshot) SetTdeCredentialArn added in v1.5.0

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

SetTdeCredentialArn sets the TdeCredentialArn field's value.

func (*DBSnapshot) SetTimezone added in v1.5.0

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

SetTimezone sets the Timezone field's value.

func (*DBSnapshot) SetVpcId added in v1.5.0

func (s *DBSnapshot) SetVpcId(v string) *DBSnapshot

SetVpcId sets the VpcId field's value.

func (DBSnapshot) String added in v0.6.5

func (s DBSnapshot) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBSnapshotAttribute added in v0.10.4

type DBSnapshotAttribute struct {

	// The name of the manual DB snapshot attribute.
	//
	// The attribute named restore refers to the list of Amazon Web Services accounts
	// that have permission to copy or restore the manual DB cluster snapshot. For
	// more information, see the ModifyDBSnapshotAttribute API action.
	AttributeName *string `type:"string"`

	// The value or values for the manual DB snapshot attribute.
	//
	// If the AttributeName field is set to restore, then this element returns a
	// list of IDs of the Amazon Web Services accounts that are authorized to copy
	// or restore the manual DB snapshot. If a value of all is in the list, then
	// the manual DB snapshot is public and available for any Amazon Web Services
	// account to copy or restore.
	AttributeValues []*string `locationNameList:"AttributeValue" type:"list"`
	// contains filtered or unexported fields
}

Contains the name and values of a manual DB snapshot attribute

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API.

func (DBSnapshotAttribute) GoString added in v0.10.4

func (s DBSnapshotAttribute) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBSnapshotAttribute) SetAttributeName added in v1.5.0

func (s *DBSnapshotAttribute) SetAttributeName(v string) *DBSnapshotAttribute

SetAttributeName sets the AttributeName field's value.

func (*DBSnapshotAttribute) SetAttributeValues added in v1.5.0

func (s *DBSnapshotAttribute) SetAttributeValues(v []*string) *DBSnapshotAttribute

SetAttributeValues sets the AttributeValues field's value.

func (DBSnapshotAttribute) String added in v0.10.4

func (s DBSnapshotAttribute) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBSnapshotAttributesResult added in v0.10.4

type DBSnapshotAttributesResult struct {

	// The list of attributes and values for the manual DB snapshot.
	DBSnapshotAttributes []*DBSnapshotAttribute `locationNameList:"DBSnapshotAttribute" type:"list"`

	// The identifier of the manual DB snapshot that the attributes apply to.
	DBSnapshotIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the results of a successful call to the DescribeDBSnapshotAttributes API action.

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

func (DBSnapshotAttributesResult) GoString added in v0.10.4

func (s DBSnapshotAttributesResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBSnapshotAttributesResult) SetDBSnapshotAttributes added in v1.5.0

SetDBSnapshotAttributes sets the DBSnapshotAttributes field's value.

func (*DBSnapshotAttributesResult) SetDBSnapshotIdentifier added in v1.5.0

func (s *DBSnapshotAttributesResult) SetDBSnapshotIdentifier(v string) *DBSnapshotAttributesResult

SetDBSnapshotIdentifier sets the DBSnapshotIdentifier field's value.

func (DBSnapshotAttributesResult) String added in v0.10.4

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DBSubnetGroup

type DBSubnetGroup struct {

	// The Amazon Resource Name (ARN) for the DB subnet group.
	DBSubnetGroupArn *string `type:"string"`

	// Provides the description of the DB subnet group.
	DBSubnetGroupDescription *string `type:"string"`

	// The name of the DB subnet group.
	DBSubnetGroupName *string `type:"string"`

	// Provides the status of the DB subnet group.
	SubnetGroupStatus *string `type:"string"`

	// Contains a list of Subnet elements.
	Subnets []*Subnet `locationNameList:"Subnet" type:"list"`

	// The network type of the DB subnet group.
	//
	// Valid values:
	//
	//    * IPV4
	//
	//    * DUAL
	//
	// A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6
	// protocols (DUAL).
	//
	// For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
	// in the Amazon RDS User Guide.
	SupportedNetworkTypes []*string `type:"list"`

	// Provides the VpcId of the DB subnet group.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the details of an Amazon RDS DB subnet group.

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

func (DBSubnetGroup) GoString added in v0.6.5

func (s DBSubnetGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DBSubnetGroup) SetDBSubnetGroupArn added in v1.5.0

func (s *DBSubnetGroup) SetDBSubnetGroupArn(v string) *DBSubnetGroup

SetDBSubnetGroupArn sets the DBSubnetGroupArn field's value.

func (*DBSubnetGroup) SetDBSubnetGroupDescription added in v1.5.0

func (s *DBSubnetGroup) SetDBSubnetGroupDescription(v string) *DBSubnetGroup

SetDBSubnetGroupDescription sets the DBSubnetGroupDescription field's value.

func (*DBSubnetGroup) SetDBSubnetGroupName added in v1.5.0

func (s *DBSubnetGroup) SetDBSubnetGroupName(v string) *DBSubnetGroup

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*DBSubnetGroup) SetSubnetGroupStatus added in v1.5.0

func (s *DBSubnetGroup) SetSubnetGroupStatus(v string) *DBSubnetGroup

SetSubnetGroupStatus sets the SubnetGroupStatus field's value.

func (*DBSubnetGroup) SetSubnets added in v1.5.0

func (s *DBSubnetGroup) SetSubnets(v []*Subnet) *DBSubnetGroup

SetSubnets sets the Subnets field's value.

func (*DBSubnetGroup) SetSupportedNetworkTypes added in v1.44.4

func (s *DBSubnetGroup) SetSupportedNetworkTypes(v []*string) *DBSubnetGroup

SetSupportedNetworkTypes sets the SupportedNetworkTypes field's value.

func (*DBSubnetGroup) SetVpcId added in v1.5.0

func (s *DBSubnetGroup) SetVpcId(v string) *DBSubnetGroup

SetVpcId sets the VpcId field's value.

func (DBSubnetGroup) String added in v0.6.5

func (s DBSubnetGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteCustomDBEngineVersionInput added in v1.41.10

type DeleteCustomDBEngineVersionInput struct {

	// The database engine. The only supported engine is custom-oracle-ee.
	//
	// Engine is a required field
	Engine *string `min:"1" type:"string" required:"true"`

	// The custom engine version (CEV) for your DB instance. This option is required
	// for RDS Custom, but optional for Amazon RDS. The combination of Engine and
	// EngineVersion is unique per customer per Amazon Web Services Region.
	//
	// EngineVersion is a required field
	EngineVersion *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteCustomDBEngineVersionInput) GoString added in v1.41.10

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCustomDBEngineVersionInput) SetEngine added in v1.41.10

SetEngine sets the Engine field's value.

func (*DeleteCustomDBEngineVersionInput) SetEngineVersion added in v1.41.10

SetEngineVersion sets the EngineVersion field's value.

func (DeleteCustomDBEngineVersionInput) String added in v1.41.10

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCustomDBEngineVersionInput) Validate added in v1.41.10

Validate inspects the fields of the type to determine if they are valid.

type DeleteCustomDBEngineVersionOutput added in v1.41.10

type DeleteCustomDBEngineVersionOutput struct {

	// The creation time of the DB engine version.
	CreateTime *time.Time `type:"timestamp"`

	// The description of the database engine.
	DBEngineDescription *string `type:"string"`

	// The ARN of the custom engine version.
	DBEngineVersionArn *string `type:"string"`

	// The description of the database engine version.
	DBEngineVersionDescription *string `type:"string"`

	// The name of the DB parameter group family for the database engine.
	DBParameterGroupFamily *string `type:"string"`

	// The name of the Amazon S3 bucket that contains your database installation
	// files.
	DatabaseInstallationFilesS3BucketName *string `type:"string"`

	// The Amazon S3 directory that contains the database installation files. If
	// not specified, then no prefix is assumed.
	DatabaseInstallationFilesS3Prefix *string `type:"string"`

	// The default character set for new instances of this engine version, if the
	// CharacterSetName parameter of the CreateDBInstance API isn't specified.
	DefaultCharacterSet *CharacterSet `type:"structure"`

	// The name of the database engine.
	Engine *string `type:"string"`

	// The version number of the database engine.
	EngineVersion *string `type:"string"`

	// The types of logs that the database engine has available for export to CloudWatch
	// Logs.
	ExportableLogTypes []*string `type:"list"`

	// The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter
	// is required for RDS Custom, but optional for Amazon RDS.
	KMSKeyId *string `type:"string"`

	// The major engine version of the CEV.
	MajorEngineVersion *string `type:"string"`

	// The status of the DB engine version, either available or deprecated.
	Status *string `type:"string"`

	// A list of the character sets supported by this engine for the CharacterSetName
	// parameter of the CreateDBInstance operation.
	SupportedCharacterSets []*CharacterSet `locationNameList:"CharacterSet" type:"list"`

	// A list of the supported DB engine modes.
	SupportedEngineModes []*string `type:"list"`

	// A list of features supported by the DB engine.
	//
	// The supported features vary by DB engine and DB engine version.
	//
	// To determine the supported features for a specific DB engine and DB engine
	// version using the CLI, use the following command:
	//
	// aws rds describe-db-engine-versions --engine <engine_name> --engine-version
	// <engine_version>
	//
	// For example, to determine the supported features for RDS for PostgreSQL version
	// 13.3 using the CLI, use the following command:
	//
	// aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
	//
	// The supported features are listed under SupportedFeatureNames in the output.
	SupportedFeatureNames []*string `type:"list"`

	// A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName
	// parameter of the CreateDBInstance operation.
	SupportedNcharCharacterSets []*CharacterSet `locationNameList:"CharacterSet" type:"list"`

	// A list of the time zones supported by this engine for the Timezone parameter
	// of the CreateDBInstance action.
	SupportedTimezones []*Timezone `locationNameList:"Timezone" type:"list"`

	// A value that indicates whether the engine version supports Babelfish for
	// Aurora PostgreSQL.
	SupportsBabelfish *bool `type:"boolean"`

	// A value that indicates whether you can use Aurora global databases with a
	// specific DB engine version.
	SupportsGlobalDatabases *bool `type:"boolean"`

	// A value that indicates whether the engine version supports exporting the
	// log types specified by ExportableLogTypes to CloudWatch Logs.
	SupportsLogExportsToCloudwatchLogs *bool `type:"boolean"`

	// A value that indicates whether you can use Aurora parallel query with a specific
	// DB engine version.
	SupportsParallelQuery *bool `type:"boolean"`

	// Indicates whether the database engine version supports read replicas.
	SupportsReadReplica *bool `type:"boolean"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	TagList []*Tag `locationNameList:"Tag" type:"list"`

	// A list of engine versions that this database engine version can be upgraded
	// to.
	ValidUpgradeTarget []*UpgradeTarget `locationNameList:"UpgradeTarget" type:"list"`
	// contains filtered or unexported fields
}

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

func (DeleteCustomDBEngineVersionOutput) GoString added in v1.41.10

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCustomDBEngineVersionOutput) SetCreateTime added in v1.41.10

SetCreateTime sets the CreateTime field's value.

func (*DeleteCustomDBEngineVersionOutput) SetDBEngineDescription added in v1.41.10

SetDBEngineDescription sets the DBEngineDescription field's value.

func (*DeleteCustomDBEngineVersionOutput) SetDBEngineVersionArn added in v1.41.10

SetDBEngineVersionArn sets the DBEngineVersionArn field's value.

func (*DeleteCustomDBEngineVersionOutput) SetDBEngineVersionDescription added in v1.41.10

func (s *DeleteCustomDBEngineVersionOutput) SetDBEngineVersionDescription(v string) *DeleteCustomDBEngineVersionOutput

SetDBEngineVersionDescription sets the DBEngineVersionDescription field's value.

func (*DeleteCustomDBEngineVersionOutput) SetDBParameterGroupFamily added in v1.41.10

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*DeleteCustomDBEngineVersionOutput) SetDatabaseInstallationFilesS3BucketName added in v1.41.10

func (s *DeleteCustomDBEngineVersionOutput) SetDatabaseInstallationFilesS3BucketName(v string) *DeleteCustomDBEngineVersionOutput

SetDatabaseInstallationFilesS3BucketName sets the DatabaseInstallationFilesS3BucketName field's value.

func (*DeleteCustomDBEngineVersionOutput) SetDatabaseInstallationFilesS3Prefix added in v1.41.10

func (s *DeleteCustomDBEngineVersionOutput) SetDatabaseInstallationFilesS3Prefix(v string) *DeleteCustomDBEngineVersionOutput

SetDatabaseInstallationFilesS3Prefix sets the DatabaseInstallationFilesS3Prefix field's value.

func (*DeleteCustomDBEngineVersionOutput) SetDefaultCharacterSet added in v1.41.10

SetDefaultCharacterSet sets the DefaultCharacterSet field's value.

func (*DeleteCustomDBEngineVersionOutput) SetEngine added in v1.41.10

SetEngine sets the Engine field's value.

func (*DeleteCustomDBEngineVersionOutput) SetEngineVersion added in v1.41.10

SetEngineVersion sets the EngineVersion field's value.

func (*DeleteCustomDBEngineVersionOutput) SetExportableLogTypes added in v1.41.10

SetExportableLogTypes sets the ExportableLogTypes field's value.

func (*DeleteCustomDBEngineVersionOutput) SetKMSKeyId added in v1.41.10

SetKMSKeyId sets the KMSKeyId field's value.

func (*DeleteCustomDBEngineVersionOutput) SetMajorEngineVersion added in v1.41.10

SetMajorEngineVersion sets the MajorEngineVersion field's value.

func (*DeleteCustomDBEngineVersionOutput) SetStatus added in v1.41.10

SetStatus sets the Status field's value.

func (*DeleteCustomDBEngineVersionOutput) SetSupportedCharacterSets added in v1.41.10

SetSupportedCharacterSets sets the SupportedCharacterSets field's value.

func (*DeleteCustomDBEngineVersionOutput) SetSupportedEngineModes added in v1.41.10

SetSupportedEngineModes sets the SupportedEngineModes field's value.

func (*DeleteCustomDBEngineVersionOutput) SetSupportedFeatureNames added in v1.41.10

SetSupportedFeatureNames sets the SupportedFeatureNames field's value.

func (*DeleteCustomDBEngineVersionOutput) SetSupportedNcharCharacterSets added in v1.41.10

func (s *DeleteCustomDBEngineVersionOutput) SetSupportedNcharCharacterSets(v []*CharacterSet) *DeleteCustomDBEngineVersionOutput

SetSupportedNcharCharacterSets sets the SupportedNcharCharacterSets field's value.

func (*DeleteCustomDBEngineVersionOutput) SetSupportedTimezones added in v1.41.10

SetSupportedTimezones sets the SupportedTimezones field's value.

func (*DeleteCustomDBEngineVersionOutput) SetSupportsBabelfish added in v1.42.53

SetSupportsBabelfish sets the SupportsBabelfish field's value.

func (*DeleteCustomDBEngineVersionOutput) SetSupportsGlobalDatabases added in v1.41.10

SetSupportsGlobalDatabases sets the SupportsGlobalDatabases field's value.

func (*DeleteCustomDBEngineVersionOutput) SetSupportsLogExportsToCloudwatchLogs added in v1.41.10

func (s *DeleteCustomDBEngineVersionOutput) SetSupportsLogExportsToCloudwatchLogs(v bool) *DeleteCustomDBEngineVersionOutput

SetSupportsLogExportsToCloudwatchLogs sets the SupportsLogExportsToCloudwatchLogs field's value.

func (*DeleteCustomDBEngineVersionOutput) SetSupportsParallelQuery added in v1.41.10

SetSupportsParallelQuery sets the SupportsParallelQuery field's value.

func (*DeleteCustomDBEngineVersionOutput) SetSupportsReadReplica added in v1.41.10

SetSupportsReadReplica sets the SupportsReadReplica field's value.

func (*DeleteCustomDBEngineVersionOutput) SetTagList added in v1.41.10

SetTagList sets the TagList field's value.

func (*DeleteCustomDBEngineVersionOutput) SetValidUpgradeTarget added in v1.41.10

SetValidUpgradeTarget sets the ValidUpgradeTarget field's value.

func (DeleteCustomDBEngineVersionOutput) String added in v1.41.10

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDBClusterEndpointInput added in v1.15.74

type DeleteDBClusterEndpointInput struct {

	// The identifier associated with the custom endpoint. This parameter is stored
	// as a lowercase string.
	//
	// DBClusterEndpointIdentifier is a required field
	DBClusterEndpointIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDBClusterEndpointInput) GoString added in v1.15.74

func (s DeleteDBClusterEndpointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBClusterEndpointInput) SetDBClusterEndpointIdentifier added in v1.15.74

func (s *DeleteDBClusterEndpointInput) SetDBClusterEndpointIdentifier(v string) *DeleteDBClusterEndpointInput

SetDBClusterEndpointIdentifier sets the DBClusterEndpointIdentifier field's value.

func (DeleteDBClusterEndpointInput) String added in v1.15.74

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBClusterEndpointInput) Validate added in v1.15.74

func (s *DeleteDBClusterEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDBClusterEndpointOutput added in v1.15.74

type DeleteDBClusterEndpointOutput struct {

	// The type associated with a custom endpoint. One of: READER, WRITER, ANY.
	CustomEndpointType *string `type:"string"`

	// The Amazon Resource Name (ARN) for the endpoint.
	DBClusterEndpointArn *string `type:"string"`

	// The identifier associated with the endpoint. This parameter is stored as
	// a lowercase string.
	DBClusterEndpointIdentifier *string `type:"string"`

	// A unique system-generated identifier for an endpoint. It remains the same
	// for the whole life of the endpoint.
	DBClusterEndpointResourceIdentifier *string `type:"string"`

	// The DB cluster identifier of the DB cluster associated with the endpoint.
	// This parameter is stored as a lowercase string.
	DBClusterIdentifier *string `type:"string"`

	// The DNS address of the endpoint.
	Endpoint *string `type:"string"`

	// The type of the endpoint. One of: READER, WRITER, CUSTOM.
	EndpointType *string `type:"string"`

	// List of DB instance identifiers that aren't part of the custom endpoint group.
	// All other eligible instances are reachable through the custom endpoint. Only
	// relevant if the list of static members is empty.
	ExcludedMembers []*string `type:"list"`

	// List of DB instance identifiers that are part of the custom endpoint group.
	StaticMembers []*string `type:"list"`

	// The current status of the endpoint. One of: creating, available, deleting,
	// inactive, modifying. The inactive state applies to an endpoint that can't
	// be used for a certain kind of cluster, such as a writer endpoint for a read-only
	// secondary cluster in a global database.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

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

  • CreateDBClusterEndpoint

  • DescribeDBClusterEndpoints

  • ModifyDBClusterEndpoint

  • DeleteDBClusterEndpoint

For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

func (DeleteDBClusterEndpointOutput) GoString added in v1.15.74

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBClusterEndpointOutput) SetCustomEndpointType added in v1.15.74

SetCustomEndpointType sets the CustomEndpointType field's value.

func (*DeleteDBClusterEndpointOutput) SetDBClusterEndpointArn added in v1.15.74

SetDBClusterEndpointArn sets the DBClusterEndpointArn field's value.

func (*DeleteDBClusterEndpointOutput) SetDBClusterEndpointIdentifier added in v1.15.74

func (s *DeleteDBClusterEndpointOutput) SetDBClusterEndpointIdentifier(v string) *DeleteDBClusterEndpointOutput

SetDBClusterEndpointIdentifier sets the DBClusterEndpointIdentifier field's value.

func (*DeleteDBClusterEndpointOutput) SetDBClusterEndpointResourceIdentifier added in v1.15.74

func (s *DeleteDBClusterEndpointOutput) SetDBClusterEndpointResourceIdentifier(v string) *DeleteDBClusterEndpointOutput

SetDBClusterEndpointResourceIdentifier sets the DBClusterEndpointResourceIdentifier field's value.

func (*DeleteDBClusterEndpointOutput) SetDBClusterIdentifier added in v1.15.74

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DeleteDBClusterEndpointOutput) SetEndpoint added in v1.15.74

SetEndpoint sets the Endpoint field's value.

func (*DeleteDBClusterEndpointOutput) SetEndpointType added in v1.15.74

SetEndpointType sets the EndpointType field's value.

func (*DeleteDBClusterEndpointOutput) SetExcludedMembers added in v1.15.74

SetExcludedMembers sets the ExcludedMembers field's value.

func (*DeleteDBClusterEndpointOutput) SetStaticMembers added in v1.15.74

SetStaticMembers sets the StaticMembers field's value.

func (*DeleteDBClusterEndpointOutput) SetStatus added in v1.15.74

SetStatus sets the Status field's value.

func (DeleteDBClusterEndpointOutput) String added in v1.15.74

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDBClusterInput added in v0.7.1

type DeleteDBClusterInput struct {

	// The DB cluster identifier for the DB cluster to be deleted. This parameter
	// isn't case-sensitive.
	//
	// Constraints:
	//
	//    * Must match an existing DBClusterIdentifier.
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The DB cluster snapshot identifier of the new DB cluster snapshot created
	// when SkipFinalSnapshot is disabled.
	//
	// Specifying this parameter and also skipping the creation of a final DB cluster
	// snapshot with the SkipFinalShapshot parameter results in an error.
	//
	// Constraints:
	//
	//    * Must be 1 to 255 letters, numbers, or hyphens.
	//
	//    * First character must be a letter
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens
	FinalDBSnapshotIdentifier *string `type:"string"`

	// A value that indicates whether to skip the creation of a final DB cluster
	// snapshot before the DB cluster is deleted. If skip is specified, no DB cluster
	// snapshot is created. If skip isn't specified, a DB cluster snapshot is created
	// before the DB cluster is deleted. By default, skip isn't specified, and the
	// DB cluster snapshot is created. By default, this parameter is disabled.
	//
	// You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot
	// is disabled.
	SkipFinalSnapshot *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (DeleteDBClusterInput) GoString added in v0.7.1

func (s DeleteDBClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBClusterInput) SetDBClusterIdentifier added in v1.5.0

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DeleteDBClusterInput) SetFinalDBSnapshotIdentifier added in v1.5.0

func (s *DeleteDBClusterInput) SetFinalDBSnapshotIdentifier(v string) *DeleteDBClusterInput

SetFinalDBSnapshotIdentifier sets the FinalDBSnapshotIdentifier field's value.

func (*DeleteDBClusterInput) SetSkipFinalSnapshot added in v1.5.0

func (s *DeleteDBClusterInput) SetSkipFinalSnapshot(v bool) *DeleteDBClusterInput

SetSkipFinalSnapshot sets the SkipFinalSnapshot field's value.

func (DeleteDBClusterInput) String added in v0.7.1

func (s DeleteDBClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBClusterInput) Validate added in v1.1.21

func (s *DeleteDBClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDBClusterOutput added in v0.7.1

type DeleteDBClusterOutput struct {

	// Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
	//
	// For an Amazon Aurora DB cluster, this data type is used as a response element
	// in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot,
	// RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
	//
	// For a Multi-AZ DB cluster, this data type is used as a response element in
	// the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
	//
	// For more information on Amazon Aurora DB clusters, see What is Amazon Aurora?
	// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)
	// in the Amazon Aurora User Guide.
	//
	// For more information on Multi-AZ DB clusters, see Multi-AZ deployments with
	// two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
	// in the Amazon RDS User Guide.
	DBCluster *DBCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteDBClusterOutput) GoString added in v0.7.1

func (s DeleteDBClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBClusterOutput) SetDBCluster added in v1.5.0

SetDBCluster sets the DBCluster field's value.

func (DeleteDBClusterOutput) String added in v0.7.1

func (s DeleteDBClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDBClusterParameterGroupInput added in v0.7.1

type DeleteDBClusterParameterGroupInput struct {

	// The name of the DB cluster parameter group.
	//
	// Constraints:
	//
	//    * Must be the name of an existing DB cluster parameter group.
	//
	//    * You can't delete a default DB cluster parameter group.
	//
	//    * Can't be associated with any DB clusters.
	//
	// DBClusterParameterGroupName is a required field
	DBClusterParameterGroupName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDBClusterParameterGroupInput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBClusterParameterGroupInput) SetDBClusterParameterGroupName added in v1.5.0

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (DeleteDBClusterParameterGroupInput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBClusterParameterGroupInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DeleteDBClusterParameterGroupOutput added in v0.7.1

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

func (DeleteDBClusterParameterGroupOutput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDBClusterParameterGroupOutput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDBClusterSnapshotInput added in v0.7.1

type DeleteDBClusterSnapshotInput struct {

	// The identifier of the DB cluster snapshot to delete.
	//
	// Constraints: Must be the name of an existing DB cluster snapshot in the available
	// state.
	//
	// DBClusterSnapshotIdentifier is a required field
	DBClusterSnapshotIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDBClusterSnapshotInput) GoString added in v0.7.1

func (s DeleteDBClusterSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBClusterSnapshotInput) SetDBClusterSnapshotIdentifier added in v1.5.0

func (s *DeleteDBClusterSnapshotInput) SetDBClusterSnapshotIdentifier(v string) *DeleteDBClusterSnapshotInput

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (DeleteDBClusterSnapshotInput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBClusterSnapshotInput) Validate added in v1.1.21

func (s *DeleteDBClusterSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDBClusterSnapshotOutput added in v0.7.1

type DeleteDBClusterSnapshotOutput struct {

	// Contains the details for an Amazon RDS DB cluster snapshot
	//
	// This data type is used as a response element in the DescribeDBClusterSnapshots
	// action.
	DBClusterSnapshot *DBClusterSnapshot `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteDBClusterSnapshotOutput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBClusterSnapshotOutput) SetDBClusterSnapshot added in v1.5.0

SetDBClusterSnapshot sets the DBClusterSnapshot field's value.

func (DeleteDBClusterSnapshotOutput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDBInstanceAutomatedBackupInput added in v1.15.77

type DeleteDBInstanceAutomatedBackupInput struct {

	// The Amazon Resource Name (ARN) of the automated backups to delete, for example,
	// arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
	//
	// This setting doesn't apply to RDS Custom.
	DBInstanceAutomatedBackupsArn *string `type:"string"`

	// The identifier for the source DB instance, which can't be changed and which
	// is unique to an Amazon Web Services Region.
	DbiResourceId *string `type:"string"`
	// contains filtered or unexported fields
}

Parameter input for the DeleteDBInstanceAutomatedBackup operation.

func (DeleteDBInstanceAutomatedBackupInput) GoString added in v1.15.77

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBInstanceAutomatedBackupInput) SetDBInstanceAutomatedBackupsArn added in v1.36.2

SetDBInstanceAutomatedBackupsArn sets the DBInstanceAutomatedBackupsArn field's value.

func (*DeleteDBInstanceAutomatedBackupInput) SetDbiResourceId added in v1.15.77

SetDbiResourceId sets the DbiResourceId field's value.

func (DeleteDBInstanceAutomatedBackupInput) String added in v1.15.77

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDBInstanceAutomatedBackupOutput added in v1.15.77

type DeleteDBInstanceAutomatedBackupOutput struct {

	// An automated backup of a DB instance. It consists of system backups, transaction
	// logs, and the database instance properties that existed at the time you deleted
	// the source instance.
	DBInstanceAutomatedBackup *DBInstanceAutomatedBackup `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteDBInstanceAutomatedBackupOutput) GoString added in v1.15.77

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBInstanceAutomatedBackupOutput) SetDBInstanceAutomatedBackup added in v1.15.77

SetDBInstanceAutomatedBackup sets the DBInstanceAutomatedBackup field's value.

func (DeleteDBInstanceAutomatedBackupOutput) String added in v1.15.77

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDBInstanceInput

type DeleteDBInstanceInput struct {

	// The DB instance identifier for the DB instance to be deleted. This parameter
	// isn't case-sensitive.
	//
	// Constraints:
	//
	//    * Must match the name of an existing DB instance.
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`

	// A value that indicates whether to remove automated backups immediately after
	// the DB instance is deleted. This parameter isn't case-sensitive. The default
	// is to remove automated backups immediately after the DB instance is deleted.
	DeleteAutomatedBackups *bool `type:"boolean"`

	// The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot
	// parameter is disabled.
	//
	// If you enable this parameter and also enable SkipFinalShapshot, the command
	// results in an error.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Constraints:
	//
	//    * Must be 1 to 255 letters or numbers.
	//
	//    * First character must be a letter.
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens.
	//
	//    * Can't be specified when deleting a read replica.
	FinalDBSnapshotIdentifier *string `type:"string"`

	// A value that indicates whether to skip the creation of a final DB snapshot
	// before deleting the instance. If you enable this parameter, RDS doesn't create
	// a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot
	// before the DB instance is deleted. By default, skip isn't enabled, and the
	// DB snapshot is created.
	//
	// If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier
	// parameter.
	//
	// When a DB instance is in a failure state and has a status of failed, incompatible-restore,
	// or incompatible-network, RDS can delete the instance only if you enable this
	// parameter.
	//
	// If you delete a read replica or an RDS Custom instance, you must enable this
	// setting.
	//
	// This setting is required for RDS Custom.
	SkipFinalSnapshot *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (DeleteDBInstanceInput) GoString added in v0.6.5

func (s DeleteDBInstanceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBInstanceInput) SetDBInstanceIdentifier added in v1.5.0

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*DeleteDBInstanceInput) SetDeleteAutomatedBackups added in v1.15.77

func (s *DeleteDBInstanceInput) SetDeleteAutomatedBackups(v bool) *DeleteDBInstanceInput

SetDeleteAutomatedBackups sets the DeleteAutomatedBackups field's value.

func (*DeleteDBInstanceInput) SetFinalDBSnapshotIdentifier added in v1.5.0

func (s *DeleteDBInstanceInput) SetFinalDBSnapshotIdentifier(v string) *DeleteDBInstanceInput

SetFinalDBSnapshotIdentifier sets the FinalDBSnapshotIdentifier field's value.

func (*DeleteDBInstanceInput) SetSkipFinalSnapshot added in v1.5.0

func (s *DeleteDBInstanceInput) SetSkipFinalSnapshot(v bool) *DeleteDBInstanceInput

SetSkipFinalSnapshot sets the SkipFinalSnapshot field's value.

func (DeleteDBInstanceInput) String added in v0.6.5

func (s DeleteDBInstanceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBInstanceInput) Validate added in v1.1.21

func (s *DeleteDBInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDBInstanceOutput

type DeleteDBInstanceOutput struct {

	// Contains the details of an Amazon RDS DB instance.
	//
	// This data type is used as a response element in the operations CreateDBInstance,
	// CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance,
	// PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,
	// RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
	DBInstance *DBInstance `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteDBInstanceOutput) GoString added in v0.6.5

func (s DeleteDBInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBInstanceOutput) SetDBInstance added in v1.5.0

SetDBInstance sets the DBInstance field's value.

func (DeleteDBInstanceOutput) String added in v0.6.5

func (s DeleteDBInstanceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDBParameterGroupInput

type DeleteDBParameterGroupInput struct {

	// The name of the DB parameter group.
	//
	// Constraints:
	//
	//    * Must be the name of an existing DB parameter group
	//
	//    * You can't delete a default DB parameter group
	//
	//    * Can't be associated with any DB instances
	//
	// DBParameterGroupName is a required field
	DBParameterGroupName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDBParameterGroupInput) GoString added in v0.6.5

func (s DeleteDBParameterGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBParameterGroupInput) SetDBParameterGroupName added in v1.5.0

func (s *DeleteDBParameterGroupInput) SetDBParameterGroupName(v string) *DeleteDBParameterGroupInput

SetDBParameterGroupName sets the DBParameterGroupName field's value.

func (DeleteDBParameterGroupInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBParameterGroupInput) Validate added in v1.1.21

func (s *DeleteDBParameterGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDBParameterGroupOutput

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

func (DeleteDBParameterGroupOutput) GoString added in v0.6.5

func (s DeleteDBParameterGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDBParameterGroupOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDBProxyEndpointInput added in v1.37.27

type DeleteDBProxyEndpointInput struct {

	// The name of the DB proxy endpoint to delete.
	//
	// DBProxyEndpointName is a required field
	DBProxyEndpointName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDBProxyEndpointInput) GoString added in v1.37.27

func (s DeleteDBProxyEndpointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBProxyEndpointInput) SetDBProxyEndpointName added in v1.37.27

func (s *DeleteDBProxyEndpointInput) SetDBProxyEndpointName(v string) *DeleteDBProxyEndpointInput

SetDBProxyEndpointName sets the DBProxyEndpointName field's value.

func (DeleteDBProxyEndpointInput) String added in v1.37.27

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBProxyEndpointInput) Validate added in v1.37.27

func (s *DeleteDBProxyEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDBProxyEndpointOutput added in v1.37.27

type DeleteDBProxyEndpointOutput struct {

	// The data structure representing the details of the DB proxy endpoint that
	// you delete.
	DBProxyEndpoint *DBProxyEndpoint `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteDBProxyEndpointOutput) GoString added in v1.37.27

func (s DeleteDBProxyEndpointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBProxyEndpointOutput) SetDBProxyEndpoint added in v1.37.27

SetDBProxyEndpoint sets the DBProxyEndpoint field's value.

func (DeleteDBProxyEndpointOutput) String added in v1.37.27

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDBProxyInput added in v1.25.47

type DeleteDBProxyInput struct {

	// The name of the DB proxy to delete.
	//
	// DBProxyName is a required field
	DBProxyName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDBProxyInput) GoString added in v1.25.47

func (s DeleteDBProxyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBProxyInput) SetDBProxyName added in v1.25.47

func (s *DeleteDBProxyInput) SetDBProxyName(v string) *DeleteDBProxyInput

SetDBProxyName sets the DBProxyName field's value.

func (DeleteDBProxyInput) String added in v1.25.47

func (s DeleteDBProxyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBProxyInput) Validate added in v1.25.47

func (s *DeleteDBProxyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDBProxyOutput added in v1.25.47

type DeleteDBProxyOutput struct {

	// The data structure representing the details of the DB proxy that you delete.
	DBProxy *DBProxy `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteDBProxyOutput) GoString added in v1.25.47

func (s DeleteDBProxyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBProxyOutput) SetDBProxy added in v1.25.47

func (s *DeleteDBProxyOutput) SetDBProxy(v *DBProxy) *DeleteDBProxyOutput

SetDBProxy sets the DBProxy field's value.

func (DeleteDBProxyOutput) String added in v1.25.47

func (s DeleteDBProxyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDBSecurityGroupInput

type DeleteDBSecurityGroupInput struct {

	// The name of the DB security group to delete.
	//
	// You can't delete the default DB security group.
	//
	// Constraints:
	//
	//    * Must be 1 to 255 letters, numbers, or hyphens.
	//
	//    * First character must be a letter
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens
	//
	//    * Must not be "Default"
	//
	// DBSecurityGroupName is a required field
	DBSecurityGroupName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDBSecurityGroupInput) GoString added in v0.6.5

func (s DeleteDBSecurityGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBSecurityGroupInput) SetDBSecurityGroupName added in v1.5.0

func (s *DeleteDBSecurityGroupInput) SetDBSecurityGroupName(v string) *DeleteDBSecurityGroupInput

SetDBSecurityGroupName sets the DBSecurityGroupName field's value.

func (DeleteDBSecurityGroupInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBSecurityGroupInput) Validate added in v1.1.21

func (s *DeleteDBSecurityGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDBSecurityGroupOutput

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

func (DeleteDBSecurityGroupOutput) GoString added in v0.6.5

func (s DeleteDBSecurityGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDBSecurityGroupOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDBSnapshotInput

type DeleteDBSnapshotInput struct {

	// The DB snapshot identifier.
	//
	// Constraints: Must be the name of an existing DB snapshot in the available
	// state.
	//
	// DBSnapshotIdentifier is a required field
	DBSnapshotIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDBSnapshotInput) GoString added in v0.6.5

func (s DeleteDBSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBSnapshotInput) SetDBSnapshotIdentifier added in v1.5.0

func (s *DeleteDBSnapshotInput) SetDBSnapshotIdentifier(v string) *DeleteDBSnapshotInput

SetDBSnapshotIdentifier sets the DBSnapshotIdentifier field's value.

func (DeleteDBSnapshotInput) String added in v0.6.5

func (s DeleteDBSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBSnapshotInput) Validate added in v1.1.21

func (s *DeleteDBSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDBSnapshotOutput

type DeleteDBSnapshotOutput struct {

	// Contains the details of an Amazon RDS DB snapshot.
	//
	// This data type is used as a response element in the DescribeDBSnapshots action.
	DBSnapshot *DBSnapshot `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteDBSnapshotOutput) GoString added in v0.6.5

func (s DeleteDBSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBSnapshotOutput) SetDBSnapshot added in v1.5.0

SetDBSnapshot sets the DBSnapshot field's value.

func (DeleteDBSnapshotOutput) String added in v0.6.5

func (s DeleteDBSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDBSubnetGroupInput

type DeleteDBSubnetGroupInput struct {

	// The name of the database subnet group to delete.
	//
	// You can't delete the default subnet group.
	//
	// Constraints: Must match the name of an existing DBSubnetGroup. Must not be
	// default.
	//
	// Example: mydbsubnetgroup
	//
	// DBSubnetGroupName is a required field
	DBSubnetGroupName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDBSubnetGroupInput) GoString added in v0.6.5

func (s DeleteDBSubnetGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBSubnetGroupInput) SetDBSubnetGroupName added in v1.5.0

func (s *DeleteDBSubnetGroupInput) SetDBSubnetGroupName(v string) *DeleteDBSubnetGroupInput

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (DeleteDBSubnetGroupInput) String added in v0.6.5

func (s DeleteDBSubnetGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDBSubnetGroupInput) Validate added in v1.1.21

func (s *DeleteDBSubnetGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDBSubnetGroupOutput

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

func (DeleteDBSubnetGroupOutput) GoString added in v0.6.5

func (s DeleteDBSubnetGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDBSubnetGroupOutput) String added in v0.6.5

func (s DeleteDBSubnetGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteEventSubscriptionInput

type DeleteEventSubscriptionInput struct {

	// The name of the RDS event notification subscription you want to delete.
	//
	// SubscriptionName is a required field
	SubscriptionName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEventSubscriptionInput) GoString added in v0.6.5

func (s DeleteEventSubscriptionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEventSubscriptionInput) SetSubscriptionName added in v1.5.0

SetSubscriptionName sets the SubscriptionName field's value.

func (DeleteEventSubscriptionInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEventSubscriptionInput) Validate added in v1.1.21

func (s *DeleteEventSubscriptionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteEventSubscriptionOutput

type DeleteEventSubscriptionOutput struct {

	// Contains the results of a successful invocation of the DescribeEventSubscriptions
	// action.
	EventSubscription *EventSubscription `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteEventSubscriptionOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEventSubscriptionOutput) SetEventSubscription added in v1.5.0

SetEventSubscription sets the EventSubscription field's value.

func (DeleteEventSubscriptionOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteGlobalClusterInput added in v1.15.85

type DeleteGlobalClusterInput struct {

	// The cluster identifier of the global database cluster being deleted.
	//
	// GlobalClusterIdentifier is a required field
	GlobalClusterIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteGlobalClusterInput) GoString added in v1.15.85

func (s DeleteGlobalClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGlobalClusterInput) SetGlobalClusterIdentifier added in v1.15.85

func (s *DeleteGlobalClusterInput) SetGlobalClusterIdentifier(v string) *DeleteGlobalClusterInput

SetGlobalClusterIdentifier sets the GlobalClusterIdentifier field's value.

func (DeleteGlobalClusterInput) String added in v1.15.85

func (s DeleteGlobalClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGlobalClusterInput) Validate added in v1.15.85

func (s *DeleteGlobalClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteGlobalClusterOutput added in v1.15.85

type DeleteGlobalClusterOutput struct {

	// A data type representing an Aurora global database.
	GlobalCluster *GlobalCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteGlobalClusterOutput) GoString added in v1.15.85

func (s DeleteGlobalClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGlobalClusterOutput) SetGlobalCluster added in v1.15.85

SetGlobalCluster sets the GlobalCluster field's value.

func (DeleteGlobalClusterOutput) String added in v1.15.85

func (s DeleteGlobalClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteOptionGroupInput

type DeleteOptionGroupInput struct {

	// The name of the option group to be deleted.
	//
	// You can't delete default option groups.
	//
	// OptionGroupName is a required field
	OptionGroupName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteOptionGroupInput) GoString added in v0.6.5

func (s DeleteOptionGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteOptionGroupInput) SetOptionGroupName added in v1.5.0

func (s *DeleteOptionGroupInput) SetOptionGroupName(v string) *DeleteOptionGroupInput

SetOptionGroupName sets the OptionGroupName field's value.

func (DeleteOptionGroupInput) String added in v0.6.5

func (s DeleteOptionGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteOptionGroupInput) Validate added in v1.1.21

func (s *DeleteOptionGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteOptionGroupOutput

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

func (DeleteOptionGroupOutput) GoString added in v0.6.5

func (s DeleteOptionGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteOptionGroupOutput) String added in v0.6.5

func (s DeleteOptionGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeregisterDBProxyTargetsInput added in v1.25.47

type DeregisterDBProxyTargetsInput struct {

	// One or more DB cluster identifiers.
	DBClusterIdentifiers []*string `type:"list"`

	// One or more DB instance identifiers.
	DBInstanceIdentifiers []*string `type:"list"`

	// The identifier of the DBProxy that is associated with the DBProxyTargetGroup.
	//
	// DBProxyName is a required field
	DBProxyName *string `type:"string" required:"true"`

	// The identifier of the DBProxyTargetGroup.
	TargetGroupName *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeregisterDBProxyTargetsInput) GoString added in v1.25.47

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeregisterDBProxyTargetsInput) SetDBClusterIdentifiers added in v1.25.47

func (s *DeregisterDBProxyTargetsInput) SetDBClusterIdentifiers(v []*string) *DeregisterDBProxyTargetsInput

SetDBClusterIdentifiers sets the DBClusterIdentifiers field's value.

func (*DeregisterDBProxyTargetsInput) SetDBInstanceIdentifiers added in v1.25.47

func (s *DeregisterDBProxyTargetsInput) SetDBInstanceIdentifiers(v []*string) *DeregisterDBProxyTargetsInput

SetDBInstanceIdentifiers sets the DBInstanceIdentifiers field's value.

func (*DeregisterDBProxyTargetsInput) SetDBProxyName added in v1.25.47

SetDBProxyName sets the DBProxyName field's value.

func (*DeregisterDBProxyTargetsInput) SetTargetGroupName added in v1.25.47

SetTargetGroupName sets the TargetGroupName field's value.

func (DeregisterDBProxyTargetsInput) String added in v1.25.47

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeregisterDBProxyTargetsInput) Validate added in v1.25.47

func (s *DeregisterDBProxyTargetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeregisterDBProxyTargetsOutput added in v1.25.47

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

func (DeregisterDBProxyTargetsOutput) GoString added in v1.25.47

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeregisterDBProxyTargetsOutput) String added in v1.25.47

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAccountAttributesInput

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

func (DescribeAccountAttributesInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeAccountAttributesInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAccountAttributesOutput

type DescribeAccountAttributesOutput struct {

	// A list of AccountQuota objects. Within this list, each quota has a name,
	// a count of usage toward the quota maximum, and a maximum value for the quota.
	AccountQuotas []*AccountQuota `locationNameList:"AccountQuota" type:"list"`
	// contains filtered or unexported fields
}

Data returned by the DescribeAccountAttributes action.

func (DescribeAccountAttributesOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccountAttributesOutput) SetAccountQuotas added in v1.5.0

SetAccountQuotas sets the AccountQuotas field's value.

func (DescribeAccountAttributesOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeCertificatesInput

type DescribeCertificatesInput struct {

	// The user-supplied certificate identifier. If this parameter is specified,
	// information for only the identified certificate is returned. This parameter
	// isn't case-sensitive.
	//
	// Constraints:
	//
	//    * Must match an existing CertificateIdentifier.
	CertificateIdentifier *string `type:"string"`

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous DescribeCertificates
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeCertificatesInput) GoString added in v0.6.5

func (s DescribeCertificatesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCertificatesInput) SetCertificateIdentifier added in v1.5.0

func (s *DescribeCertificatesInput) SetCertificateIdentifier(v string) *DescribeCertificatesInput

SetCertificateIdentifier sets the CertificateIdentifier field's value.

func (*DescribeCertificatesInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeCertificatesInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeCertificatesInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (DescribeCertificatesInput) String added in v0.6.5

func (s DescribeCertificatesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCertificatesInput) Validate added in v1.1.21

func (s *DescribeCertificatesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeCertificatesOutput

type DescribeCertificatesOutput struct {

	// The list of Certificate objects for the Amazon Web Services account.
	Certificates []*Certificate `locationNameList:"Certificate" type:"list"`

	// An optional pagination token provided by a previous DescribeCertificates
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords .
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Data returned by the DescribeCertificates action.

func (DescribeCertificatesOutput) GoString added in v0.6.5

func (s DescribeCertificatesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCertificatesOutput) SetCertificates added in v1.5.0

SetCertificates sets the Certificates field's value.

func (*DescribeCertificatesOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (DescribeCertificatesOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBClusterBacktracksInput added in v1.13.45

type DescribeDBClusterBacktracksInput struct {

	// If specified, this value is the backtrack identifier of the backtrack to
	// be described.
	//
	// Constraints:
	//
	//    * Must contain a valid universally unique identifier (UUID). For more
	//    information about UUIDs, see A Universally Unique Identifier (UUID) URN
	//    Namespace (http://www.ietf.org/rfc/rfc4122.txt).
	//
	// Example: 123e4567-e89b-12d3-a456-426655440000
	BacktrackIdentifier *string `type:"string"`

	// The DB cluster identifier of the DB cluster to be described. This parameter
	// is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 alphanumeric characters or hyphens.
	//
	//    * First character must be a letter.
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens.
	//
	// Example: my-cluster1
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// A filter that specifies one or more DB clusters to describe. Supported filters
	// include the following:
	//
	//    * db-cluster-backtrack-id - Accepts backtrack identifiers. The results
	//    list includes information about only the backtracks identified by these
	//    identifiers.
	//
	//    * db-cluster-backtrack-status - Accepts any of the following backtrack
	//    status values: applying completed failed pending The results list includes
	//    information about only the backtracks identified by these values.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous DescribeDBClusterBacktracks
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeDBClusterBacktracksInput) GoString added in v1.13.45

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClusterBacktracksInput) SetBacktrackIdentifier added in v1.13.45

SetBacktrackIdentifier sets the BacktrackIdentifier field's value.

func (*DescribeDBClusterBacktracksInput) SetDBClusterIdentifier added in v1.13.45

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DescribeDBClusterBacktracksInput) SetFilters added in v1.13.45

SetFilters sets the Filters field's value.

func (*DescribeDBClusterBacktracksInput) SetMarker added in v1.13.45

SetMarker sets the Marker field's value.

func (*DescribeDBClusterBacktracksInput) SetMaxRecords added in v1.13.45

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBClusterBacktracksInput) String added in v1.13.45

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClusterBacktracksInput) Validate added in v1.13.45

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBClusterBacktracksOutput added in v1.13.45

type DescribeDBClusterBacktracksOutput struct {

	// Contains a list of backtracks for the user.
	DBClusterBacktracks []*BacktrackDBClusterOutput `locationNameList:"DBClusterBacktrack" type:"list"`

	// A pagination token that can be used in a later DescribeDBClusterBacktracks
	// request.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.

func (DescribeDBClusterBacktracksOutput) GoString added in v1.13.45

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClusterBacktracksOutput) SetDBClusterBacktracks added in v1.13.45

SetDBClusterBacktracks sets the DBClusterBacktracks field's value.

func (*DescribeDBClusterBacktracksOutput) SetMarker added in v1.13.45

SetMarker sets the Marker field's value.

func (DescribeDBClusterBacktracksOutput) String added in v1.13.45

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBClusterEndpointsInput added in v1.15.74

type DescribeDBClusterEndpointsInput struct {

	// The identifier of the endpoint to describe. This parameter is stored as a
	// lowercase string.
	DBClusterEndpointIdentifier *string `type:"string"`

	// The DB cluster identifier of the DB cluster associated with the endpoint.
	// This parameter is stored as a lowercase string.
	DBClusterIdentifier *string `type:"string"`

	// A set of name-value pairs that define which endpoints to include in the output.
	// The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....
	// Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type,
	// db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type
	// filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type
	// filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status
	// filter can be one or more of: available, creating, deleting, inactive, modifying.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous DescribeDBClusterEndpoints
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeDBClusterEndpointsInput) GoString added in v1.15.74

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClusterEndpointsInput) SetDBClusterEndpointIdentifier added in v1.15.74

func (s *DescribeDBClusterEndpointsInput) SetDBClusterEndpointIdentifier(v string) *DescribeDBClusterEndpointsInput

SetDBClusterEndpointIdentifier sets the DBClusterEndpointIdentifier field's value.

func (*DescribeDBClusterEndpointsInput) SetDBClusterIdentifier added in v1.15.74

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DescribeDBClusterEndpointsInput) SetFilters added in v1.15.74

SetFilters sets the Filters field's value.

func (*DescribeDBClusterEndpointsInput) SetMarker added in v1.15.74

SetMarker sets the Marker field's value.

func (*DescribeDBClusterEndpointsInput) SetMaxRecords added in v1.15.74

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBClusterEndpointsInput) String added in v1.15.74

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClusterEndpointsInput) Validate added in v1.15.74

func (s *DescribeDBClusterEndpointsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBClusterEndpointsOutput added in v1.15.74

type DescribeDBClusterEndpointsOutput struct {

	// Contains the details of the endpoints associated with the cluster and matching
	// any filter conditions.
	DBClusterEndpoints []*DBClusterEndpoint `locationNameList:"DBClusterEndpointList" type:"list"`

	// An optional pagination token provided by a previous DescribeDBClusterEndpoints
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDBClusterEndpointsOutput) GoString added in v1.15.74

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClusterEndpointsOutput) SetDBClusterEndpoints added in v1.15.74

SetDBClusterEndpoints sets the DBClusterEndpoints field's value.

func (*DescribeDBClusterEndpointsOutput) SetMarker added in v1.15.74

SetMarker sets the Marker field's value.

func (DescribeDBClusterEndpointsOutput) String added in v1.15.74

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBClusterParameterGroupsInput added in v0.7.1

type DescribeDBClusterParameterGroupsInput struct {

	// The name of a specific DB cluster parameter group to return details for.
	//
	// Constraints:
	//
	//    * If supplied, must match the name of an existing DBClusterParameterGroup.
	DBClusterParameterGroupName *string `type:"string"`

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous DescribeDBClusterParameterGroups
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeDBClusterParameterGroupsInput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClusterParameterGroupsInput) SetDBClusterParameterGroupName added in v1.5.0

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*DescribeDBClusterParameterGroupsInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeDBClusterParameterGroupsInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeDBClusterParameterGroupsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBClusterParameterGroupsInput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClusterParameterGroupsInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBClusterParameterGroupsOutput added in v0.7.1

type DescribeDBClusterParameterGroupsOutput struct {

	// A list of DB cluster parameter groups.
	DBClusterParameterGroups []*DBClusterParameterGroup `locationNameList:"DBClusterParameterGroup" type:"list"`

	// An optional pagination token provided by a previous DescribeDBClusterParameterGroups
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDBClusterParameterGroupsOutput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClusterParameterGroupsOutput) SetDBClusterParameterGroups added in v1.5.0

SetDBClusterParameterGroups sets the DBClusterParameterGroups field's value.

func (*DescribeDBClusterParameterGroupsOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (DescribeDBClusterParameterGroupsOutput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBClusterParametersInput added in v0.7.1

type DescribeDBClusterParametersInput struct {

	// The name of a specific DB cluster parameter group to return parameter details
	// for.
	//
	// Constraints:
	//
	//    * If supplied, must match the name of an existing DBClusterParameterGroup.
	//
	// DBClusterParameterGroupName is a required field
	DBClusterParameterGroupName *string `type:"string" required:"true"`

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous DescribeDBClusterParameters
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`

	// A value that indicates to return only parameters for a specific source. Parameter
	// sources can be engine, service, or customer.
	Source *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDBClusterParametersInput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClusterParametersInput) SetDBClusterParameterGroupName added in v1.5.0

func (s *DescribeDBClusterParametersInput) SetDBClusterParameterGroupName(v string) *DescribeDBClusterParametersInput

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*DescribeDBClusterParametersInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeDBClusterParametersInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeDBClusterParametersInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeDBClusterParametersInput) SetSource added in v1.5.0

SetSource sets the Source field's value.

func (DescribeDBClusterParametersInput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClusterParametersInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBClusterParametersOutput added in v0.7.1

type DescribeDBClusterParametersOutput struct {

	// An optional pagination token provided by a previous DescribeDBClusterParameters
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// Provides a list of parameters for the DB cluster parameter group.
	Parameters []*Parameter `locationNameList:"Parameter" type:"list"`
	// contains filtered or unexported fields
}

Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.

func (DescribeDBClusterParametersOutput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClusterParametersOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeDBClusterParametersOutput) SetParameters added in v1.5.0

SetParameters sets the Parameters field's value.

func (DescribeDBClusterParametersOutput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBClusterSnapshotAttributesInput added in v1.1.30

type DescribeDBClusterSnapshotAttributesInput struct {

	// The identifier for the DB cluster snapshot to describe the attributes for.
	//
	// DBClusterSnapshotIdentifier is a required field
	DBClusterSnapshotIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDBClusterSnapshotAttributesInput) GoString added in v1.1.30

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClusterSnapshotAttributesInput) SetDBClusterSnapshotIdentifier added in v1.5.0

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (DescribeDBClusterSnapshotAttributesInput) String added in v1.1.30

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClusterSnapshotAttributesInput) Validate added in v1.1.30

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBClusterSnapshotAttributesOutput added in v1.1.30

type DescribeDBClusterSnapshotAttributesOutput struct {

	// Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes
	// API action.
	//
	// Manual DB cluster snapshot attributes are used to authorize other Amazon
	// Web Services accounts to copy or restore a manual DB cluster snapshot. For
	// more information, see the ModifyDBClusterSnapshotAttribute API action.
	DBClusterSnapshotAttributesResult *DBClusterSnapshotAttributesResult `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDBClusterSnapshotAttributesOutput) GoString added in v1.1.30

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClusterSnapshotAttributesOutput) SetDBClusterSnapshotAttributesResult added in v1.5.0

SetDBClusterSnapshotAttributesResult sets the DBClusterSnapshotAttributesResult field's value.

func (DescribeDBClusterSnapshotAttributesOutput) String added in v1.1.30

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBClusterSnapshotsInput added in v0.7.1

type DescribeDBClusterSnapshotsInput struct {

	// The ID of the DB cluster to retrieve the list of DB cluster snapshots for.
	// This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier
	// parameter. This parameter isn't case-sensitive.
	//
	// Constraints:
	//
	//    * If supplied, must match the identifier of an existing DBCluster.
	DBClusterIdentifier *string `type:"string"`

	// A specific DB cluster snapshot identifier to describe. This parameter can't
	// be used in conjunction with the DBClusterIdentifier parameter. This value
	// is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * If supplied, must match the identifier of an existing DBClusterSnapshot.
	//
	//    * If this identifier is for an automated snapshot, the SnapshotType parameter
	//    must also be specified.
	DBClusterSnapshotIdentifier *string `type:"string"`

	// A filter that specifies one or more DB cluster snapshots to describe.
	//
	// Supported filters:
	//
	//    * db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon
	//    Resource Names (ARNs).
	//
	//    * db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.
	//
	//    * snapshot-type - Accepts types of DB cluster snapshots.
	//
	//    * engine - Accepts names of database engines.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// A value that indicates whether to include manual DB cluster snapshots that
	// are public and can be copied or restored by any Amazon Web Services account.
	// By default, the public snapshots are not included.
	//
	// You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute
	// API action.
	IncludePublic *bool `type:"boolean"`

	// A value that indicates whether to include shared manual DB cluster snapshots
	// from other Amazon Web Services accounts that this Amazon Web Services account
	// has been given permission to copy or restore. By default, these snapshots
	// are not included.
	//
	// You can give an Amazon Web Services account permission to restore a manual
	// DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute
	// API action.
	IncludeShared *bool `type:"boolean"`

	// An optional pagination token provided by a previous DescribeDBClusterSnapshots
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`

	// The type of DB cluster snapshots to be returned. You can specify one of the
	// following values:
	//
	//    * automated - Return all DB cluster snapshots that have been automatically
	//    taken by Amazon RDS for my Amazon Web Services account.
	//
	//    * manual - Return all DB cluster snapshots that have been taken by my
	//    Amazon Web Services account.
	//
	//    * shared - Return all manual DB cluster snapshots that have been shared
	//    to my Amazon Web Services account.
	//
	//    * public - Return all DB cluster snapshots that have been marked as public.
	//
	// If you don't specify a SnapshotType value, then both automated and manual
	// DB cluster snapshots are returned. You can include shared DB cluster snapshots
	// with these results by enabling the IncludeShared parameter. You can include
	// public DB cluster snapshots with these results by enabling the IncludePublic
	// parameter.
	//
	// The IncludeShared and IncludePublic parameters don't apply for SnapshotType
	// values of manual or automated. The IncludePublic parameter doesn't apply
	// when SnapshotType is set to shared. The IncludeShared parameter doesn't apply
	// when SnapshotType is set to public.
	SnapshotType *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDBClusterSnapshotsInput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClusterSnapshotsInput) SetDBClusterIdentifier added in v1.5.0

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DescribeDBClusterSnapshotsInput) SetDBClusterSnapshotIdentifier added in v1.5.0

func (s *DescribeDBClusterSnapshotsInput) SetDBClusterSnapshotIdentifier(v string) *DescribeDBClusterSnapshotsInput

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (*DescribeDBClusterSnapshotsInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeDBClusterSnapshotsInput) SetIncludePublic added in v1.5.0

SetIncludePublic sets the IncludePublic field's value.

func (*DescribeDBClusterSnapshotsInput) SetIncludeShared added in v1.5.0

SetIncludeShared sets the IncludeShared field's value.

func (*DescribeDBClusterSnapshotsInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeDBClusterSnapshotsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeDBClusterSnapshotsInput) SetSnapshotType added in v1.5.0

SetSnapshotType sets the SnapshotType field's value.

func (DescribeDBClusterSnapshotsInput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClusterSnapshotsInput) Validate added in v1.1.21

func (s *DescribeDBClusterSnapshotsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBClusterSnapshotsOutput added in v0.7.1

type DescribeDBClusterSnapshotsOutput struct {

	// Provides a list of DB cluster snapshots for the user.
	DBClusterSnapshots []*DBClusterSnapshot `locationNameList:"DBClusterSnapshot" type:"list"`

	// An optional pagination token provided by a previous DescribeDBClusterSnapshots
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

func (DescribeDBClusterSnapshotsOutput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClusterSnapshotsOutput) SetDBClusterSnapshots added in v1.5.0

SetDBClusterSnapshots sets the DBClusterSnapshots field's value.

func (*DescribeDBClusterSnapshotsOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (DescribeDBClusterSnapshotsOutput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBClustersInput added in v0.7.1

type DescribeDBClustersInput struct {

	// The user-supplied DB cluster identifier. If this parameter is specified,
	// information from only the specific DB cluster is returned. This parameter
	// isn't case-sensitive.
	//
	// Constraints:
	//
	//    * If supplied, must match an existing DBClusterIdentifier.
	DBClusterIdentifier *string `type:"string"`

	// A filter that specifies one or more DB clusters to describe.
	//
	// Supported filters:
	//
	//    * clone-group-id - Accepts clone group identifiers. The results list only
	//    includes information about the DB clusters associated with these clone
	//    groups.
	//
	//    * db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon
	//    Resource Names (ARNs). The results list only includes information about
	//    the DB clusters identified by these ARNs.
	//
	//    * domain - Accepts Active Directory directory IDs. The results list only
	//    includes information about the DB clusters associated with these domains.
	//
	//    * engine - Accepts engine names. The results list only includes information
	//    about the DB clusters for these engines.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// Optional Boolean parameter that specifies whether the output includes information
	// about clusters shared from other Amazon Web Services accounts.
	IncludeShared *bool `type:"boolean"`

	// An optional pagination token provided by a previous DescribeDBClusters request.
	// If this parameter is specified, the response includes only records beyond
	// the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeDBClustersInput) GoString added in v0.7.1

func (s DescribeDBClustersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClustersInput) SetDBClusterIdentifier added in v1.5.0

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DescribeDBClustersInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeDBClustersInput) SetIncludeShared added in v1.20.15

func (s *DescribeDBClustersInput) SetIncludeShared(v bool) *DescribeDBClustersInput

SetIncludeShared sets the IncludeShared field's value.

func (*DescribeDBClustersInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeDBClustersInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBClustersInput) String added in v0.7.1

func (s DescribeDBClustersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClustersInput) Validate added in v1.1.21

func (s *DescribeDBClustersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBClustersOutput added in v0.7.1

type DescribeDBClustersOutput struct {

	// Contains a list of DB clusters for the user.
	DBClusters []*DBCluster `locationNameList:"DBCluster" type:"list"`

	// A pagination token that can be used in a later DescribeDBClusters request.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the result of a successful invocation of the DescribeDBClusters action.

func (DescribeDBClustersOutput) GoString added in v0.7.1

func (s DescribeDBClustersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBClustersOutput) SetDBClusters added in v1.5.0

SetDBClusters sets the DBClusters field's value.

func (*DescribeDBClustersOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (DescribeDBClustersOutput) String added in v0.7.1

func (s DescribeDBClustersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBEngineVersionsInput

type DescribeDBEngineVersionsInput struct {

	// The name of a specific DB parameter group family to return details for.
	//
	// Constraints:
	//
	//    * If supplied, must match an existing DBParameterGroupFamily.
	DBParameterGroupFamily *string `type:"string"`

	// A value that indicates whether only the default version of the specified
	// engine or engine and major version combination is returned.
	DefaultOnly *bool `type:"boolean"`

	// The database engine to return.
	//
	// Valid Values:
	//
	//    * aurora (for MySQL 5.6-compatible Aurora)
	//
	//    * aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
	//
	//    * aurora-postgresql
	//
	//    * mariadb
	//
	//    * mysql
	//
	//    * oracle-ee
	//
	//    * oracle-ee-cdb
	//
	//    * oracle-se2
	//
	//    * oracle-se2-cdb
	//
	//    * postgres
	//
	//    * sqlserver-ee
	//
	//    * sqlserver-se
	//
	//    * sqlserver-ex
	//
	//    * sqlserver-web
	Engine *string `type:"string"`

	// The database engine version to return.
	//
	// Example: 5.1.49
	EngineVersion *string `type:"string"`

	// A filter that specifies one or more DB engine versions to describe.
	//
	// Supported filters:
	//
	//    * db-parameter-group-family - Accepts parameter groups family names. The
	//    results list only includes information about the DB engine versions for
	//    these parameter group families.
	//
	//    * engine - Accepts engine names. The results list only includes information
	//    about the DB engine versions for these engines.
	//
	//    * engine-mode - Accepts DB engine modes. The results list only includes
	//    information about the DB engine versions for these engine modes. Valid
	//    DB engine modes are the following: global multimaster parallelquery provisioned
	//    serverless
	//
	//    * engine-version - Accepts engine versions. The results list only includes
	//    information about the DB engine versions for these engine versions.
	//
	//    * status - Accepts engine version statuses. The results list only includes
	//    information about the DB engine versions for these statuses. Valid statuses
	//    are the following: available deprecated
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// A value that indicates whether to include engine versions that aren't available
	// in the list. The default is to list only available engine versions.
	IncludeAll *bool `type:"boolean"`

	// A value that indicates whether to list the supported character sets for each
	// engine version.
	//
	// If this parameter is enabled and the requested engine supports the CharacterSetName
	// parameter for CreateDBInstance, the response includes a list of supported
	// character sets for each engine version.
	//
	// For RDS Custom, the default is not to list supported character sets. If you
	// set ListSupportedCharacterSets to true, RDS Custom returns no results.
	ListSupportedCharacterSets *bool `type:"boolean"`

	// A value that indicates whether to list the supported time zones for each
	// engine version.
	//
	// If this parameter is enabled and the requested engine supports the TimeZone
	// parameter for CreateDBInstance, the response includes a list of supported
	// time zones for each engine version.
	//
	// For RDS Custom, the default is not to list supported time zones. If you set
	// ListSupportedTimezones to true, RDS Custom returns no results.
	ListSupportedTimezones *bool `type:"boolean"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more than the
	// MaxRecords value is available, a pagination token called a marker is included
	// in the response so you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeDBEngineVersionsInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBEngineVersionsInput) SetDBParameterGroupFamily added in v1.5.0

func (s *DescribeDBEngineVersionsInput) SetDBParameterGroupFamily(v string) *DescribeDBEngineVersionsInput

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*DescribeDBEngineVersionsInput) SetDefaultOnly added in v1.5.0

SetDefaultOnly sets the DefaultOnly field's value.

func (*DescribeDBEngineVersionsInput) SetEngine added in v1.5.0

SetEngine sets the Engine field's value.

func (*DescribeDBEngineVersionsInput) SetEngineVersion added in v1.5.0

SetEngineVersion sets the EngineVersion field's value.

func (*DescribeDBEngineVersionsInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeDBEngineVersionsInput) SetIncludeAll added in v1.19.39

SetIncludeAll sets the IncludeAll field's value.

func (*DescribeDBEngineVersionsInput) SetListSupportedCharacterSets added in v1.5.0

func (s *DescribeDBEngineVersionsInput) SetListSupportedCharacterSets(v bool) *DescribeDBEngineVersionsInput

SetListSupportedCharacterSets sets the ListSupportedCharacterSets field's value.

func (*DescribeDBEngineVersionsInput) SetListSupportedTimezones added in v1.5.0

func (s *DescribeDBEngineVersionsInput) SetListSupportedTimezones(v bool) *DescribeDBEngineVersionsInput

SetListSupportedTimezones sets the ListSupportedTimezones field's value.

func (*DescribeDBEngineVersionsInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeDBEngineVersionsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBEngineVersionsInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBEngineVersionsInput) Validate added in v1.1.21

func (s *DescribeDBEngineVersionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBEngineVersionsOutput

type DescribeDBEngineVersionsOutput struct {

	// A list of DBEngineVersion elements.
	DBEngineVersions []*DBEngineVersion `locationNameList:"DBEngineVersion" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

func (DescribeDBEngineVersionsOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBEngineVersionsOutput) SetDBEngineVersions added in v1.5.0

SetDBEngineVersions sets the DBEngineVersions field's value.

func (*DescribeDBEngineVersionsOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (DescribeDBEngineVersionsOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBInstanceAutomatedBackupsInput added in v1.15.77

type DescribeDBInstanceAutomatedBackupsInput struct {

	// The Amazon Resource Name (ARN) of the replicated automated backups, for example,
	// arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
	//
	// This setting doesn't apply to RDS Custom.
	DBInstanceAutomatedBackupsArn *string `type:"string"`

	// (Optional) The user-supplied instance identifier. If this parameter is specified,
	// it must match the identifier of an existing DB instance. It returns information
	// from the specific DB instance' automated backup. This parameter isn't case-sensitive.
	DBInstanceIdentifier *string `type:"string"`

	// The resource ID of the DB instance that is the source of the automated backup.
	// This parameter isn't case-sensitive.
	DbiResourceId *string `type:"string"`

	// A filter that specifies which resources to return based on status.
	//
	// Supported filters are the following:
	//
	//    * status active - automated backups for current instances retained - automated
	//    backups for deleted instances and after backup replication is stopped
	//    creating - automated backups that are waiting for the first automated
	//    snapshot to be available
	//
	//    * db-instance-id - Accepts DB instance identifiers and Amazon Resource
	//    Names (ARNs). The results list includes only information about the DB
	//    instance automated backups identified by these ARNs.
	//
	//    * dbi-resource-id - Accepts DB resource identifiers and Amazon Resource
	//    Names (ARNs). The results list includes only information about the DB
	//    instance resources identified by these ARNs.
	//
	// Returns all resources by default. The status for each resource is specified
	// in the response.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// The pagination token provided in the previous request. If this parameter
	// is specified the response includes only records beyond the marker, up to
	// MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that you can retrieve the remaining results.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Parameter input for DescribeDBInstanceAutomatedBackups.

func (DescribeDBInstanceAutomatedBackupsInput) GoString added in v1.15.77

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBInstanceAutomatedBackupsInput) SetDBInstanceAutomatedBackupsArn added in v1.36.2

SetDBInstanceAutomatedBackupsArn sets the DBInstanceAutomatedBackupsArn field's value.

func (*DescribeDBInstanceAutomatedBackupsInput) SetDBInstanceIdentifier added in v1.15.77

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*DescribeDBInstanceAutomatedBackupsInput) SetDbiResourceId added in v1.15.77

SetDbiResourceId sets the DbiResourceId field's value.

func (*DescribeDBInstanceAutomatedBackupsInput) SetFilters added in v1.15.77

SetFilters sets the Filters field's value.

func (*DescribeDBInstanceAutomatedBackupsInput) SetMarker added in v1.15.77

SetMarker sets the Marker field's value.

func (*DescribeDBInstanceAutomatedBackupsInput) SetMaxRecords added in v1.15.77

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBInstanceAutomatedBackupsInput) String added in v1.15.77

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBInstanceAutomatedBackupsInput) Validate added in v1.15.77

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBInstanceAutomatedBackupsOutput added in v1.15.77

type DescribeDBInstanceAutomatedBackupsOutput struct {

	// A list of DBInstanceAutomatedBackup instances.
	DBInstanceAutomatedBackups []*DBInstanceAutomatedBackup `locationNameList:"DBInstanceAutomatedBackup" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.

func (DescribeDBInstanceAutomatedBackupsOutput) GoString added in v1.15.77

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBInstanceAutomatedBackupsOutput) SetDBInstanceAutomatedBackups added in v1.15.77

SetDBInstanceAutomatedBackups sets the DBInstanceAutomatedBackups field's value.

func (*DescribeDBInstanceAutomatedBackupsOutput) SetMarker added in v1.15.77

SetMarker sets the Marker field's value.

func (DescribeDBInstanceAutomatedBackupsOutput) String added in v1.15.77

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBInstancesInput

type DescribeDBInstancesInput struct {

	// The user-supplied instance identifier. If this parameter is specified, information
	// from only the specific DB instance is returned. This parameter isn't case-sensitive.
	//
	// Constraints:
	//
	//    * If supplied, must match the identifier of an existing DBInstance.
	DBInstanceIdentifier *string `type:"string"`

	// A filter that specifies one or more DB instances to describe.
	//
	// Supported filters:
	//
	//    * db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon
	//    Resource Names (ARNs). The results list only includes information about
	//    the DB instances associated with the DB clusters identified by these ARNs.
	//
	//    * db-instance-id - Accepts DB instance identifiers and DB instance Amazon
	//    Resource Names (ARNs). The results list only includes information about
	//    the DB instances identified by these ARNs.
	//
	//    * dbi-resource-id - Accepts DB instance resource identifiers. The results
	//    list will only include information about the DB instances identified by
	//    these DB instance resource identifiers.
	//
	//    * domain - Accepts Active Directory directory IDs. The results list only
	//    includes information about the DB instances associated with these domains.
	//
	//    * engine - Accepts engine names. The results list only includes information
	//    about the DB instances for these engines.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous DescribeDBInstances request.
	// If this parameter is specified, the response includes only records beyond
	// the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeDBInstancesInput) GoString added in v0.6.5

func (s DescribeDBInstancesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBInstancesInput) SetDBInstanceIdentifier added in v1.5.0

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*DescribeDBInstancesInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeDBInstancesInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeDBInstancesInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBInstancesInput) String added in v0.6.5

func (s DescribeDBInstancesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBInstancesInput) Validate added in v1.1.21

func (s *DescribeDBInstancesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBInstancesOutput

type DescribeDBInstancesOutput struct {

	// A list of DBInstance instances.
	DBInstances []*DBInstance `locationNameList:"DBInstance" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords .
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the result of a successful invocation of the DescribeDBInstances action.

func (DescribeDBInstancesOutput) GoString added in v0.6.5

func (s DescribeDBInstancesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBInstancesOutput) SetDBInstances added in v1.5.0

SetDBInstances sets the DBInstances field's value.

func (*DescribeDBInstancesOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (DescribeDBInstancesOutput) String added in v0.6.5

func (s DescribeDBInstancesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBLogFilesDetails

type DescribeDBLogFilesDetails struct {

	// A POSIX timestamp when the last log entry was written.
	LastWritten *int64 `type:"long"`

	// The name of the log file for the specified DB instance.
	LogFileName *string `type:"string"`

	// The size, in bytes, of the log file for the specified DB instance.
	Size *int64 `type:"long"`
	// contains filtered or unexported fields
}

This data type is used as a response element to DescribeDBLogFiles.

func (DescribeDBLogFilesDetails) GoString added in v0.6.5

func (s DescribeDBLogFilesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBLogFilesDetails) SetLastWritten added in v1.5.0

SetLastWritten sets the LastWritten field's value.

func (*DescribeDBLogFilesDetails) SetLogFileName added in v1.5.0

SetLogFileName sets the LogFileName field's value.

func (*DescribeDBLogFilesDetails) SetSize added in v1.5.0

SetSize sets the Size field's value.

func (DescribeDBLogFilesDetails) String added in v0.6.5

func (s DescribeDBLogFilesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBLogFilesInput

type DescribeDBLogFilesInput struct {

	// The customer-assigned name of the DB instance that contains the log files
	// you want to list.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBInstance.
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`

	// Filters the available log files for files written since the specified date,
	// in POSIX timestamp format with milliseconds.
	FileLastWritten *int64 `type:"long"`

	// Filters the available log files for files larger than the specified size.
	FileSize *int64 `type:"long"`

	// Filters the available log files for log file names that contain the specified
	// string.
	FilenameContains *string `type:"string"`

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// The pagination token provided in the previous request. If this parameter
	// is specified the response includes only records beyond the marker, up to
	// MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so you can retrieve the remaining results.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeDBLogFilesInput) GoString added in v0.6.5

func (s DescribeDBLogFilesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBLogFilesInput) SetDBInstanceIdentifier added in v1.5.0

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*DescribeDBLogFilesInput) SetFileLastWritten added in v1.5.0

func (s *DescribeDBLogFilesInput) SetFileLastWritten(v int64) *DescribeDBLogFilesInput

SetFileLastWritten sets the FileLastWritten field's value.

func (*DescribeDBLogFilesInput) SetFileSize added in v1.5.0

SetFileSize sets the FileSize field's value.

func (*DescribeDBLogFilesInput) SetFilenameContains added in v1.5.0

func (s *DescribeDBLogFilesInput) SetFilenameContains(v string) *DescribeDBLogFilesInput

SetFilenameContains sets the FilenameContains field's value.

func (*DescribeDBLogFilesInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeDBLogFilesInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeDBLogFilesInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBLogFilesInput) String added in v0.6.5

func (s DescribeDBLogFilesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBLogFilesInput) Validate added in v1.1.21

func (s *DescribeDBLogFilesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBLogFilesOutput

type DescribeDBLogFilesOutput struct {

	// The DB log files returned.
	DescribeDBLogFiles []*DescribeDBLogFilesDetails `locationNameList:"DescribeDBLogFilesDetails" type:"list"`

	// A pagination token that can be used in a later DescribeDBLogFiles request.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

The response from a call to DescribeDBLogFiles.

func (DescribeDBLogFilesOutput) GoString added in v0.6.5

func (s DescribeDBLogFilesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBLogFilesOutput) SetDescribeDBLogFiles added in v1.5.0

SetDescribeDBLogFiles sets the DescribeDBLogFiles field's value.

func (*DescribeDBLogFilesOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (DescribeDBLogFilesOutput) String added in v0.6.5

func (s DescribeDBLogFilesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBParameterGroupsInput

type DescribeDBParameterGroupsInput struct {

	// The name of a specific DB parameter group to return details for.
	//
	// Constraints:
	//
	//    * If supplied, must match the name of an existing DBClusterParameterGroup.
	DBParameterGroupName *string `type:"string"`

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous DescribeDBParameterGroups
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeDBParameterGroupsInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBParameterGroupsInput) SetDBParameterGroupName added in v1.5.0

SetDBParameterGroupName sets the DBParameterGroupName field's value.

func (*DescribeDBParameterGroupsInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeDBParameterGroupsInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeDBParameterGroupsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBParameterGroupsInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBParameterGroupsInput) Validate added in v1.1.21

func (s *DescribeDBParameterGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBParameterGroupsOutput

type DescribeDBParameterGroupsOutput struct {

	// A list of DBParameterGroup instances.
	DBParameterGroups []*DBParameterGroup `locationNameList:"DBParameterGroup" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

func (DescribeDBParameterGroupsOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBParameterGroupsOutput) SetDBParameterGroups added in v1.5.0

SetDBParameterGroups sets the DBParameterGroups field's value.

func (*DescribeDBParameterGroupsOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (DescribeDBParameterGroupsOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBParametersInput

type DescribeDBParametersInput struct {

	// The name of a specific DB parameter group to return details for.
	//
	// Constraints:
	//
	//    * If supplied, must match the name of an existing DBParameterGroup.
	//
	// DBParameterGroupName is a required field
	DBParameterGroupName *string `type:"string" required:"true"`

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous DescribeDBParameters
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`

	// The parameter types to return.
	//
	// Default: All parameter types returned
	//
	// Valid Values: user | system | engine-default
	Source *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDBParametersInput) GoString added in v0.6.5

func (s DescribeDBParametersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBParametersInput) SetDBParameterGroupName added in v1.5.0

func (s *DescribeDBParametersInput) SetDBParameterGroupName(v string) *DescribeDBParametersInput

SetDBParameterGroupName sets the DBParameterGroupName field's value.

func (*DescribeDBParametersInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeDBParametersInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeDBParametersInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeDBParametersInput) SetSource added in v1.5.0

SetSource sets the Source field's value.

func (DescribeDBParametersInput) String added in v0.6.5

func (s DescribeDBParametersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBParametersInput) Validate added in v1.1.21

func (s *DescribeDBParametersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBParametersOutput

type DescribeDBParametersOutput struct {

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// A list of Parameter values.
	Parameters []*Parameter `locationNameList:"Parameter" type:"list"`
	// contains filtered or unexported fields
}

Contains the result of a successful invocation of the DescribeDBParameters action.

func (DescribeDBParametersOutput) GoString added in v0.6.5

func (s DescribeDBParametersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBParametersOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeDBParametersOutput) SetParameters added in v1.5.0

SetParameters sets the Parameters field's value.

func (DescribeDBParametersOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBProxiesInput added in v1.25.47

type DescribeDBProxiesInput struct {

	// The name of the DB proxy. If you omit this parameter, the output includes
	// information about all DB proxies owned by your Amazon Web Services account
	// ID.
	DBProxyName *string `type:"string"`

	// This parameter is not currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `min:"20" type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeDBProxiesInput) GoString added in v1.25.47

func (s DescribeDBProxiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBProxiesInput) SetDBProxyName added in v1.25.47

SetDBProxyName sets the DBProxyName field's value.

func (*DescribeDBProxiesInput) SetFilters added in v1.25.47

SetFilters sets the Filters field's value.

func (*DescribeDBProxiesInput) SetMarker added in v1.25.47

SetMarker sets the Marker field's value.

func (*DescribeDBProxiesInput) SetMaxRecords added in v1.25.47

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBProxiesInput) String added in v1.25.47

func (s DescribeDBProxiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBProxiesInput) Validate added in v1.25.47

func (s *DescribeDBProxiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBProxiesOutput added in v1.25.47

type DescribeDBProxiesOutput struct {

	// A return value representing an arbitrary number of DBProxy data structures.
	DBProxies []*DBProxy `type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDBProxiesOutput) GoString added in v1.25.47

func (s DescribeDBProxiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBProxiesOutput) SetDBProxies added in v1.25.47

SetDBProxies sets the DBProxies field's value.

func (*DescribeDBProxiesOutput) SetMarker added in v1.25.47

SetMarker sets the Marker field's value.

func (DescribeDBProxiesOutput) String added in v1.25.47

func (s DescribeDBProxiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBProxyEndpointsInput added in v1.37.27

type DescribeDBProxyEndpointsInput struct {

	// The name of a DB proxy endpoint to describe. If you omit this parameter,
	// the output includes information about all DB proxy endpoints associated with
	// the specified proxy.
	DBProxyEndpointName *string `min:"1" type:"string"`

	// The name of the DB proxy whose endpoints you want to describe. If you omit
	// this parameter, the output includes information about all DB proxy endpoints
	// associated with all your DB proxies.
	DBProxyName *string `min:"1" type:"string"`

	// This parameter is not currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `min:"20" type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeDBProxyEndpointsInput) GoString added in v1.37.27

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBProxyEndpointsInput) SetDBProxyEndpointName added in v1.37.27

SetDBProxyEndpointName sets the DBProxyEndpointName field's value.

func (*DescribeDBProxyEndpointsInput) SetDBProxyName added in v1.37.27

SetDBProxyName sets the DBProxyName field's value.

func (*DescribeDBProxyEndpointsInput) SetFilters added in v1.37.27

SetFilters sets the Filters field's value.

func (*DescribeDBProxyEndpointsInput) SetMarker added in v1.37.27

SetMarker sets the Marker field's value.

func (*DescribeDBProxyEndpointsInput) SetMaxRecords added in v1.37.27

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBProxyEndpointsInput) String added in v1.37.27

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBProxyEndpointsInput) Validate added in v1.37.27

func (s *DescribeDBProxyEndpointsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBProxyEndpointsOutput added in v1.37.27

type DescribeDBProxyEndpointsOutput struct {

	// The list of ProxyEndpoint objects returned by the API operation.
	DBProxyEndpoints []*DBProxyEndpoint `type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDBProxyEndpointsOutput) GoString added in v1.37.27

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBProxyEndpointsOutput) SetDBProxyEndpoints added in v1.37.27

SetDBProxyEndpoints sets the DBProxyEndpoints field's value.

func (*DescribeDBProxyEndpointsOutput) SetMarker added in v1.37.27

SetMarker sets the Marker field's value.

func (DescribeDBProxyEndpointsOutput) String added in v1.37.27

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBProxyTargetGroupsInput added in v1.25.47

type DescribeDBProxyTargetGroupsInput struct {

	// The identifier of the DBProxy associated with the target group.
	//
	// DBProxyName is a required field
	DBProxyName *string `type:"string" required:"true"`

	// This parameter is not currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `min:"20" type:"integer"`

	// The identifier of the DBProxyTargetGroup to describe.
	TargetGroupName *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDBProxyTargetGroupsInput) GoString added in v1.25.47

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBProxyTargetGroupsInput) SetDBProxyName added in v1.25.47

SetDBProxyName sets the DBProxyName field's value.

func (*DescribeDBProxyTargetGroupsInput) SetFilters added in v1.25.47

SetFilters sets the Filters field's value.

func (*DescribeDBProxyTargetGroupsInput) SetMarker added in v1.25.47

SetMarker sets the Marker field's value.

func (*DescribeDBProxyTargetGroupsInput) SetMaxRecords added in v1.25.47

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeDBProxyTargetGroupsInput) SetTargetGroupName added in v1.25.47

SetTargetGroupName sets the TargetGroupName field's value.

func (DescribeDBProxyTargetGroupsInput) String added in v1.25.47

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBProxyTargetGroupsInput) Validate added in v1.25.47

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBProxyTargetGroupsOutput added in v1.25.47

type DescribeDBProxyTargetGroupsOutput struct {

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// An arbitrary number of DBProxyTargetGroup objects, containing details of
	// the corresponding target groups.
	TargetGroups []*DBProxyTargetGroup `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeDBProxyTargetGroupsOutput) GoString added in v1.25.47

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBProxyTargetGroupsOutput) SetMarker added in v1.25.47

SetMarker sets the Marker field's value.

func (*DescribeDBProxyTargetGroupsOutput) SetTargetGroups added in v1.25.47

SetTargetGroups sets the TargetGroups field's value.

func (DescribeDBProxyTargetGroupsOutput) String added in v1.25.47

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBProxyTargetsInput added in v1.25.47

type DescribeDBProxyTargetsInput struct {

	// The identifier of the DBProxyTarget to describe.
	//
	// DBProxyName is a required field
	DBProxyName *string `type:"string" required:"true"`

	// This parameter is not currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `min:"20" type:"integer"`

	// The identifier of the DBProxyTargetGroup to describe.
	TargetGroupName *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDBProxyTargetsInput) GoString added in v1.25.47

func (s DescribeDBProxyTargetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBProxyTargetsInput) SetDBProxyName added in v1.25.47

SetDBProxyName sets the DBProxyName field's value.

func (*DescribeDBProxyTargetsInput) SetFilters added in v1.25.47

SetFilters sets the Filters field's value.

func (*DescribeDBProxyTargetsInput) SetMarker added in v1.25.47

SetMarker sets the Marker field's value.

func (*DescribeDBProxyTargetsInput) SetMaxRecords added in v1.25.47

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeDBProxyTargetsInput) SetTargetGroupName added in v1.25.47

SetTargetGroupName sets the TargetGroupName field's value.

func (DescribeDBProxyTargetsInput) String added in v1.25.47

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBProxyTargetsInput) Validate added in v1.25.47

func (s *DescribeDBProxyTargetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBProxyTargetsOutput added in v1.25.47

type DescribeDBProxyTargetsOutput struct {

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// An arbitrary number of DBProxyTarget objects, containing details of the corresponding
	// targets.
	Targets []*DBProxyTarget `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeDBProxyTargetsOutput) GoString added in v1.25.47

func (s DescribeDBProxyTargetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBProxyTargetsOutput) SetMarker added in v1.25.47

SetMarker sets the Marker field's value.

func (*DescribeDBProxyTargetsOutput) SetTargets added in v1.25.47

SetTargets sets the Targets field's value.

func (DescribeDBProxyTargetsOutput) String added in v1.25.47

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBSecurityGroupsInput

type DescribeDBSecurityGroupsInput struct {

	// The name of the DB security group to return details for.
	DBSecurityGroupName *string `type:"string"`

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous DescribeDBSecurityGroups
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeDBSecurityGroupsInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBSecurityGroupsInput) SetDBSecurityGroupName added in v1.5.0

SetDBSecurityGroupName sets the DBSecurityGroupName field's value.

func (*DescribeDBSecurityGroupsInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeDBSecurityGroupsInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeDBSecurityGroupsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBSecurityGroupsInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBSecurityGroupsInput) Validate added in v1.1.21

func (s *DescribeDBSecurityGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBSecurityGroupsOutput

type DescribeDBSecurityGroupsOutput struct {

	// A list of DBSecurityGroup instances.
	DBSecurityGroups []*DBSecurityGroup `locationNameList:"DBSecurityGroup" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

func (DescribeDBSecurityGroupsOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBSecurityGroupsOutput) SetDBSecurityGroups added in v1.5.0

SetDBSecurityGroups sets the DBSecurityGroups field's value.

func (*DescribeDBSecurityGroupsOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (DescribeDBSecurityGroupsOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBSnapshotAttributesInput added in v0.10.4

type DescribeDBSnapshotAttributesInput struct {

	// The identifier for the DB snapshot to describe the attributes for.
	//
	// DBSnapshotIdentifier is a required field
	DBSnapshotIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDBSnapshotAttributesInput) GoString added in v0.10.4

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBSnapshotAttributesInput) SetDBSnapshotIdentifier added in v1.5.0

SetDBSnapshotIdentifier sets the DBSnapshotIdentifier field's value.

func (DescribeDBSnapshotAttributesInput) String added in v0.10.4

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBSnapshotAttributesInput) Validate added in v1.1.30

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBSnapshotAttributesOutput added in v0.10.4

type DescribeDBSnapshotAttributesOutput struct {

	// Contains the results of a successful call to the DescribeDBSnapshotAttributes
	// API action.
	//
	// Manual DB snapshot attributes are used to authorize other Amazon Web Services
	// accounts to copy or restore a manual DB snapshot. For more information, see
	// the ModifyDBSnapshotAttribute API action.
	DBSnapshotAttributesResult *DBSnapshotAttributesResult `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDBSnapshotAttributesOutput) GoString added in v0.10.4

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBSnapshotAttributesOutput) SetDBSnapshotAttributesResult added in v1.5.0

SetDBSnapshotAttributesResult sets the DBSnapshotAttributesResult field's value.

func (DescribeDBSnapshotAttributesOutput) String added in v0.10.4

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBSnapshotsInput

type DescribeDBSnapshotsInput struct {

	// The ID of the DB instance to retrieve the list of DB snapshots for. This
	// parameter isn't case-sensitive.
	//
	// Constraints:
	//
	//    * If supplied, must match the identifier of an existing DBInstance.
	DBInstanceIdentifier *string `type:"string"`

	// A specific DB snapshot identifier to describe. This value is stored as a
	// lowercase string.
	//
	// Constraints:
	//
	//    * If supplied, must match the identifier of an existing DBSnapshot.
	//
	//    * If this identifier is for an automated snapshot, the SnapshotType parameter
	//    must also be specified.
	DBSnapshotIdentifier *string `type:"string"`

	// A specific DB resource ID to describe.
	DbiResourceId *string `type:"string"`

	// A filter that specifies one or more DB snapshots to describe.
	//
	// Supported filters:
	//
	//    * db-instance-id - Accepts DB instance identifiers and DB instance Amazon
	//    Resource Names (ARNs).
	//
	//    * db-snapshot-id - Accepts DB snapshot identifiers.
	//
	//    * dbi-resource-id - Accepts identifiers of source DB instances.
	//
	//    * snapshot-type - Accepts types of DB snapshots.
	//
	//    * engine - Accepts names of database engines.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// A value that indicates whether to include manual DB cluster snapshots that
	// are public and can be copied or restored by any Amazon Web Services account.
	// By default, the public snapshots are not included.
	//
	// You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute
	// API.
	//
	// This setting doesn't apply to RDS Custom.
	IncludePublic *bool `type:"boolean"`

	// A value that indicates whether to include shared manual DB cluster snapshots
	// from other Amazon Web Services accounts that this Amazon Web Services account
	// has been given permission to copy or restore. By default, these snapshots
	// are not included.
	//
	// You can give an Amazon Web Services account permission to restore a manual
	// DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute
	// API action.
	//
	// This setting doesn't apply to RDS Custom.
	IncludeShared *bool `type:"boolean"`

	// An optional pagination token provided by a previous DescribeDBSnapshots request.
	// If this parameter is specified, the response includes only records beyond
	// the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`

	// The type of snapshots to be returned. You can specify one of the following
	// values:
	//
	//    * automated - Return all DB snapshots that have been automatically taken
	//    by Amazon RDS for my Amazon Web Services account.
	//
	//    * manual - Return all DB snapshots that have been taken by my Amazon Web
	//    Services account.
	//
	//    * shared - Return all manual DB snapshots that have been shared to my
	//    Amazon Web Services account.
	//
	//    * public - Return all DB snapshots that have been marked as public.
	//
	//    * awsbackup - Return the DB snapshots managed by the Amazon Web Services
	//    Backup service. For information about Amazon Web Services Backup, see
	//    the Amazon Web Services Backup Developer Guide. (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html)
	//    The awsbackup type does not apply to Aurora.
	//
	// If you don't specify a SnapshotType value, then both automated and manual
	// snapshots are returned. Shared and public DB snapshots are not included in
	// the returned results by default. You can include shared snapshots with these
	// results by enabling the IncludeShared parameter. You can include public snapshots
	// with these results by enabling the IncludePublic parameter.
	//
	// The IncludeShared and IncludePublic parameters don't apply for SnapshotType
	// values of manual or automated. The IncludePublic parameter doesn't apply
	// when SnapshotType is set to shared. The IncludeShared parameter doesn't apply
	// when SnapshotType is set to public.
	SnapshotType *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDBSnapshotsInput) GoString added in v0.6.5

func (s DescribeDBSnapshotsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBSnapshotsInput) SetDBInstanceIdentifier added in v1.5.0

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*DescribeDBSnapshotsInput) SetDBSnapshotIdentifier added in v1.5.0

func (s *DescribeDBSnapshotsInput) SetDBSnapshotIdentifier(v string) *DescribeDBSnapshotsInput

SetDBSnapshotIdentifier sets the DBSnapshotIdentifier field's value.

func (*DescribeDBSnapshotsInput) SetDbiResourceId added in v1.15.77

SetDbiResourceId sets the DbiResourceId field's value.

func (*DescribeDBSnapshotsInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeDBSnapshotsInput) SetIncludePublic added in v1.5.0

func (s *DescribeDBSnapshotsInput) SetIncludePublic(v bool) *DescribeDBSnapshotsInput

SetIncludePublic sets the IncludePublic field's value.

func (*DescribeDBSnapshotsInput) SetIncludeShared added in v1.5.0

func (s *DescribeDBSnapshotsInput) SetIncludeShared(v bool) *DescribeDBSnapshotsInput

SetIncludeShared sets the IncludeShared field's value.

func (*DescribeDBSnapshotsInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeDBSnapshotsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeDBSnapshotsInput) SetSnapshotType added in v1.5.0

SetSnapshotType sets the SnapshotType field's value.

func (DescribeDBSnapshotsInput) String added in v0.6.5

func (s DescribeDBSnapshotsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBSnapshotsInput) Validate added in v1.1.21

func (s *DescribeDBSnapshotsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBSnapshotsOutput

type DescribeDBSnapshotsOutput struct {

	// A list of DBSnapshot instances.
	DBSnapshots []*DBSnapshot `locationNameList:"DBSnapshot" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the result of a successful invocation of the DescribeDBSnapshots action.

func (DescribeDBSnapshotsOutput) GoString added in v0.6.5

func (s DescribeDBSnapshotsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBSnapshotsOutput) SetDBSnapshots added in v1.5.0

SetDBSnapshots sets the DBSnapshots field's value.

func (*DescribeDBSnapshotsOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (DescribeDBSnapshotsOutput) String added in v0.6.5

func (s DescribeDBSnapshotsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDBSubnetGroupsInput

type DescribeDBSubnetGroupsInput struct {

	// The name of the DB subnet group to return details for.
	DBSubnetGroupName *string `type:"string"`

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous DescribeDBSubnetGroups
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeDBSubnetGroupsInput) GoString added in v0.6.5

func (s DescribeDBSubnetGroupsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBSubnetGroupsInput) SetDBSubnetGroupName added in v1.5.0

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*DescribeDBSubnetGroupsInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeDBSubnetGroupsInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeDBSubnetGroupsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBSubnetGroupsInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBSubnetGroupsInput) Validate added in v1.1.21

func (s *DescribeDBSubnetGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDBSubnetGroupsOutput

type DescribeDBSubnetGroupsOutput struct {

	// A list of DBSubnetGroup instances.
	DBSubnetGroups []*DBSubnetGroup `locationNameList:"DBSubnetGroup" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

func (DescribeDBSubnetGroupsOutput) GoString added in v0.6.5

func (s DescribeDBSubnetGroupsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDBSubnetGroupsOutput) SetDBSubnetGroups added in v1.5.0

SetDBSubnetGroups sets the DBSubnetGroups field's value.

func (*DescribeDBSubnetGroupsOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (DescribeDBSubnetGroupsOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEngineDefaultClusterParametersInput added in v0.7.1

type DescribeEngineDefaultClusterParametersInput struct {

	// The name of the DB cluster parameter group family to return engine parameter
	// information for.
	//
	// DBParameterGroupFamily is a required field
	DBParameterGroupFamily *string `type:"string" required:"true"`

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeEngineDefaultClusterParametersInput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEngineDefaultClusterParametersInput) SetDBParameterGroupFamily added in v1.5.0

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*DescribeEngineDefaultClusterParametersInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeEngineDefaultClusterParametersInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeEngineDefaultClusterParametersInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (DescribeEngineDefaultClusterParametersInput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEngineDefaultClusterParametersInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeEngineDefaultClusterParametersOutput added in v0.7.1

type DescribeEngineDefaultClusterParametersOutput struct {

	// Contains the result of a successful invocation of the DescribeEngineDefaultParameters
	// action.
	EngineDefaults *EngineDefaults `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeEngineDefaultClusterParametersOutput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEngineDefaultClusterParametersOutput) SetEngineDefaults added in v1.5.0

SetEngineDefaults sets the EngineDefaults field's value.

func (DescribeEngineDefaultClusterParametersOutput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEngineDefaultParametersInput

type DescribeEngineDefaultParametersInput struct {

	// The name of the DB parameter group family.
	//
	// Valid Values:
	//
	//    * aurora5.6
	//
	//    * aurora-mysql5.7
	//
	//    * aurora-mysql8.0
	//
	//    * aurora-postgresql10
	//
	//    * aurora-postgresql11
	//
	//    * aurora-postgresql12
	//
	//    * aurora-postgresql13
	//
	//    * mariadb10.2
	//
	//    * mariadb10.3
	//
	//    * mariadb10.4
	//
	//    * mariadb10.5
	//
	//    * mariadb10.6
	//
	//    * mysql5.7
	//
	//    * mysql8.0
	//
	//    * postgres10
	//
	//    * postgres11
	//
	//    * postgres12
	//
	//    * postgres13
	//
	//    * postgres14
	//
	//    * sqlserver-ee-11.0
	//
	//    * sqlserver-ee-12.0
	//
	//    * sqlserver-ee-13.0
	//
	//    * sqlserver-ee-14.0
	//
	//    * sqlserver-ee-15.0
	//
	//    * sqlserver-ex-11.0
	//
	//    * sqlserver-ex-12.0
	//
	//    * sqlserver-ex-13.0
	//
	//    * sqlserver-ex-14.0
	//
	//    * sqlserver-ex-15.0
	//
	//    * sqlserver-se-11.0
	//
	//    * sqlserver-se-12.0
	//
	//    * sqlserver-se-13.0
	//
	//    * sqlserver-se-14.0
	//
	//    * sqlserver-se-15.0
	//
	//    * sqlserver-web-11.0
	//
	//    * sqlserver-web-12.0
	//
	//    * sqlserver-web-13.0
	//
	//    * sqlserver-web-14.0
	//
	//    * sqlserver-web-15.0
	//
	// DBParameterGroupFamily is a required field
	DBParameterGroupFamily *string `type:"string" required:"true"`

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous DescribeEngineDefaultParameters
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeEngineDefaultParametersInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEngineDefaultParametersInput) SetDBParameterGroupFamily added in v1.5.0

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*DescribeEngineDefaultParametersInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeEngineDefaultParametersInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeEngineDefaultParametersInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (DescribeEngineDefaultParametersInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEngineDefaultParametersInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeEngineDefaultParametersOutput

type DescribeEngineDefaultParametersOutput struct {

	// Contains the result of a successful invocation of the DescribeEngineDefaultParameters
	// action.
	EngineDefaults *EngineDefaults `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeEngineDefaultParametersOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEngineDefaultParametersOutput) SetEngineDefaults added in v1.5.0

SetEngineDefaults sets the EngineDefaults field's value.

func (DescribeEngineDefaultParametersOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEventCategoriesInput

type DescribeEventCategoriesInput struct {

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// The type of source that is generating the events. For RDS Proxy events, specify
	// db-proxy.
	//
	// Valid values: db-instance | db-cluster | db-parameter-group | db-security-group
	// | db-snapshot | db-cluster-snapshot | db-proxy
	SourceType *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEventCategoriesInput) GoString added in v0.6.5

func (s DescribeEventCategoriesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventCategoriesInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeEventCategoriesInput) SetSourceType added in v1.5.0

SetSourceType sets the SourceType field's value.

func (DescribeEventCategoriesInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventCategoriesInput) Validate added in v1.1.21

func (s *DescribeEventCategoriesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEventCategoriesOutput

type DescribeEventCategoriesOutput struct {

	// A list of EventCategoriesMap data types.
	EventCategoriesMapList []*EventCategoriesMap `locationNameList:"EventCategoriesMap" type:"list"`
	// contains filtered or unexported fields
}

Data returned from the DescribeEventCategories operation.

func (DescribeEventCategoriesOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventCategoriesOutput) SetEventCategoriesMapList added in v1.5.0

SetEventCategoriesMapList sets the EventCategoriesMapList field's value.

func (DescribeEventCategoriesOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEventSubscriptionsInput

type DescribeEventSubscriptionsInput struct {

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords .
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`

	// The name of the RDS event notification subscription you want to describe.
	SubscriptionName *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEventSubscriptionsInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventSubscriptionsInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeEventSubscriptionsInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeEventSubscriptionsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeEventSubscriptionsInput) SetSubscriptionName added in v1.5.0

SetSubscriptionName sets the SubscriptionName field's value.

func (DescribeEventSubscriptionsInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventSubscriptionsInput) Validate added in v1.1.21

func (s *DescribeEventSubscriptionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEventSubscriptionsOutput

type DescribeEventSubscriptionsOutput struct {

	// A list of EventSubscriptions data types.
	EventSubscriptionsList []*EventSubscription `locationNameList:"EventSubscription" type:"list"`

	// An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Data returned by the DescribeEventSubscriptions action.

func (DescribeEventSubscriptionsOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventSubscriptionsOutput) SetEventSubscriptionsList added in v1.5.0

SetEventSubscriptionsList sets the EventSubscriptionsList field's value.

func (*DescribeEventSubscriptionsOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (DescribeEventSubscriptionsOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEventsInput

type DescribeEventsInput struct {

	// The number of minutes to retrieve events for.
	//
	// Default: 60
	Duration *int64 `type:"integer"`

	// The end of the time interval for which to retrieve events, specified in ISO
	// 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia
	// page. (http://en.wikipedia.org/wiki/ISO_8601)
	//
	// Example: 2009-07-08T18:00Z
	EndTime *time.Time `type:"timestamp"`

	// A list of event categories that trigger notifications for a event notification
	// subscription.
	EventCategories []*string `locationNameList:"EventCategory" type:"list"`

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous DescribeEvents request.
	// If this parameter is specified, the response includes only records beyond
	// the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`

	// The identifier of the event source for which events are returned. If not
	// specified, then all sources are included in the response.
	//
	// Constraints:
	//
	//    * If SourceIdentifier is supplied, SourceType must also be provided.
	//
	//    * If the source type is a DB instance, a DBInstanceIdentifier value must
	//    be supplied.
	//
	//    * If the source type is a DB cluster, a DBClusterIdentifier value must
	//    be supplied.
	//
	//    * If the source type is a DB parameter group, a DBParameterGroupName value
	//    must be supplied.
	//
	//    * If the source type is a DB security group, a DBSecurityGroupName value
	//    must be supplied.
	//
	//    * If the source type is a DB snapshot, a DBSnapshotIdentifier value must
	//    be supplied.
	//
	//    * If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier
	//    value must be supplied.
	//
	//    * If the source type is an RDS Proxy, a DBProxyName value must be supplied.
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens.
	SourceIdentifier *string `type:"string"`

	// The event source to retrieve events for. If no value is specified, all events
	// are returned.
	SourceType *string `type:"string" enum:"SourceType"`

	// The beginning of the time interval to retrieve events for, specified in ISO
	// 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia
	// page. (http://en.wikipedia.org/wiki/ISO_8601)
	//
	// Example: 2009-07-08T18:00Z
	StartTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (DescribeEventsInput) GoString added in v0.6.5

func (s DescribeEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventsInput) SetDuration added in v1.5.0

func (s *DescribeEventsInput) SetDuration(v int64) *DescribeEventsInput

SetDuration sets the Duration field's value.

func (*DescribeEventsInput) SetEndTime added in v1.5.0

SetEndTime sets the EndTime field's value.

func (*DescribeEventsInput) SetEventCategories added in v1.5.0

func (s *DescribeEventsInput) SetEventCategories(v []*string) *DescribeEventsInput

SetEventCategories sets the EventCategories field's value.

func (*DescribeEventsInput) SetFilters added in v1.5.0

func (s *DescribeEventsInput) SetFilters(v []*Filter) *DescribeEventsInput

SetFilters sets the Filters field's value.

func (*DescribeEventsInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeEventsInput) SetMaxRecords added in v1.5.0

func (s *DescribeEventsInput) SetMaxRecords(v int64) *DescribeEventsInput

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeEventsInput) SetSourceIdentifier added in v1.5.0

func (s *DescribeEventsInput) SetSourceIdentifier(v string) *DescribeEventsInput

SetSourceIdentifier sets the SourceIdentifier field's value.

func (*DescribeEventsInput) SetSourceType added in v1.5.0

func (s *DescribeEventsInput) SetSourceType(v string) *DescribeEventsInput

SetSourceType sets the SourceType field's value.

func (*DescribeEventsInput) SetStartTime added in v1.5.0

func (s *DescribeEventsInput) SetStartTime(v time.Time) *DescribeEventsInput

SetStartTime sets the StartTime field's value.

func (DescribeEventsInput) String added in v0.6.5

func (s DescribeEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventsInput) Validate added in v1.1.21

func (s *DescribeEventsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEventsOutput

type DescribeEventsOutput struct {

	// A list of Event instances.
	Events []*Event `locationNameList:"Event" type:"list"`

	// An optional pagination token provided by a previous Events request. If this
	// parameter is specified, the response includes only records beyond the marker,
	// up to the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the result of a successful invocation of the DescribeEvents action.

func (DescribeEventsOutput) GoString added in v0.6.5

func (s DescribeEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventsOutput) SetEvents added in v1.5.0

func (s *DescribeEventsOutput) SetEvents(v []*Event) *DescribeEventsOutput

SetEvents sets the Events field's value.

func (*DescribeEventsOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (DescribeEventsOutput) String added in v0.6.5

func (s DescribeEventsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeExportTasksInput added in v1.28.8

type DescribeExportTasksInput struct {

	// The identifier of the snapshot export task to be described.
	ExportTaskIdentifier *string `type:"string"`

	// Filters specify one or more snapshot exports to describe. The filters are
	// specified as name-value pairs that define what to include in the output.
	// Filter names and values are case-sensitive.
	//
	// Supported filters include the following:
	//
	//    * export-task-identifier - An identifier for the snapshot export task.
	//
	//    * s3-bucket - The Amazon S3 bucket the snapshot is exported to.
	//
	//    * source-arn - The Amazon Resource Name (ARN) of the snapshot exported
	//    to Amazon S3
	//
	//    * status - The status of the export task. Must be lowercase. Valid statuses
	//    are the following: canceled canceling complete failed in_progress starting
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous DescribeExportTasks request.
	// If you specify this parameter, the response includes only records beyond
	// the marker, up to the value specified by the MaxRecords parameter.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified value, a pagination token called a marker is included
	// in the response. You can use the marker in a later DescribeExportTasks request
	// to retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `min:"20" type:"integer"`

	// The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
	SourceArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeExportTasksInput) GoString added in v1.28.8

func (s DescribeExportTasksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExportTasksInput) SetExportTaskIdentifier added in v1.28.8

func (s *DescribeExportTasksInput) SetExportTaskIdentifier(v string) *DescribeExportTasksInput

SetExportTaskIdentifier sets the ExportTaskIdentifier field's value.

func (*DescribeExportTasksInput) SetFilters added in v1.28.8

SetFilters sets the Filters field's value.

func (*DescribeExportTasksInput) SetMarker added in v1.28.8

SetMarker sets the Marker field's value.

func (*DescribeExportTasksInput) SetMaxRecords added in v1.28.8

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeExportTasksInput) SetSourceArn added in v1.28.8

SetSourceArn sets the SourceArn field's value.

func (DescribeExportTasksInput) String added in v1.28.8

func (s DescribeExportTasksInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExportTasksInput) Validate added in v1.28.8

func (s *DescribeExportTasksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeExportTasksOutput added in v1.28.8

type DescribeExportTasksOutput struct {

	// Information about an export of a snapshot to Amazon S3.
	ExportTasks []*ExportTask `locationNameList:"ExportTask" type:"list"`

	// A pagination token that can be used in a later DescribeExportTasks request.
	// A marker is used for pagination to identify the location to begin output
	// for the next response of DescribeExportTasks.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeExportTasksOutput) GoString added in v1.28.8

func (s DescribeExportTasksOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExportTasksOutput) SetExportTasks added in v1.28.8

SetExportTasks sets the ExportTasks field's value.

func (*DescribeExportTasksOutput) SetMarker added in v1.28.8

SetMarker sets the Marker field's value.

func (DescribeExportTasksOutput) String added in v1.28.8

func (s DescribeExportTasksOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeGlobalClustersInput added in v1.15.85

type DescribeGlobalClustersInput struct {

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// The user-supplied DB cluster identifier. If this parameter is specified,
	// information from only the specific DB cluster is returned. This parameter
	// isn't case-sensitive.
	//
	// Constraints:
	//
	//    * If supplied, must match an existing DBClusterIdentifier.
	GlobalClusterIdentifier *string `type:"string"`

	// An optional pagination token provided by a previous DescribeGlobalClusters
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeGlobalClustersInput) GoString added in v1.15.85

func (s DescribeGlobalClustersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGlobalClustersInput) SetFilters added in v1.15.85

SetFilters sets the Filters field's value.

func (*DescribeGlobalClustersInput) SetGlobalClusterIdentifier added in v1.15.85

func (s *DescribeGlobalClustersInput) SetGlobalClusterIdentifier(v string) *DescribeGlobalClustersInput

SetGlobalClusterIdentifier sets the GlobalClusterIdentifier field's value.

func (*DescribeGlobalClustersInput) SetMarker added in v1.15.85

SetMarker sets the Marker field's value.

func (*DescribeGlobalClustersInput) SetMaxRecords added in v1.15.85

SetMaxRecords sets the MaxRecords field's value.

func (DescribeGlobalClustersInput) String added in v1.15.85

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGlobalClustersInput) Validate added in v1.15.85

func (s *DescribeGlobalClustersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeGlobalClustersOutput added in v1.15.85

type DescribeGlobalClustersOutput struct {

	// The list of global clusters returned by this request.
	GlobalClusters []*GlobalCluster `locationNameList:"GlobalClusterMember" type:"list"`

	// An optional pagination token provided by a previous DescribeGlobalClusters
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeGlobalClustersOutput) GoString added in v1.15.85

func (s DescribeGlobalClustersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGlobalClustersOutput) SetGlobalClusters added in v1.15.85

SetGlobalClusters sets the GlobalClusters field's value.

func (*DescribeGlobalClustersOutput) SetMarker added in v1.15.85

SetMarker sets the Marker field's value.

func (DescribeGlobalClustersOutput) String added in v1.15.85

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeOptionGroupOptionsInput

type DescribeOptionGroupOptionsInput struct {

	// A required parameter. Options available for the given engine name are described.
	//
	// Valid Values:
	//
	//    * mariadb
	//
	//    * mysql
	//
	//    * oracle-ee
	//
	//    * oracle-ee-cdb
	//
	//    * oracle-se2
	//
	//    * oracle-se2-cdb
	//
	//    * postgres
	//
	//    * sqlserver-ee
	//
	//    * sqlserver-se
	//
	//    * sqlserver-ex
	//
	//    * sqlserver-web
	//
	// EngineName is a required field
	EngineName *string `type:"string" required:"true"`

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// If specified, filters the results to include only options for the specified
	// major engine version.
	MajorEngineVersion *string `type:"string"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeOptionGroupOptionsInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeOptionGroupOptionsInput) SetEngineName added in v1.5.0

SetEngineName sets the EngineName field's value.

func (*DescribeOptionGroupOptionsInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeOptionGroupOptionsInput) SetMajorEngineVersion added in v1.5.0

SetMajorEngineVersion sets the MajorEngineVersion field's value.

func (*DescribeOptionGroupOptionsInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeOptionGroupOptionsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (DescribeOptionGroupOptionsInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeOptionGroupOptionsInput) Validate added in v1.1.21

func (s *DescribeOptionGroupOptionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeOptionGroupOptionsOutput

type DescribeOptionGroupOptionsOutput struct {

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// List of available option group options.
	OptionGroupOptions []*OptionGroupOption `locationNameList:"OptionGroupOption" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeOptionGroupOptionsOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeOptionGroupOptionsOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeOptionGroupOptionsOutput) SetOptionGroupOptions added in v1.5.0

SetOptionGroupOptions sets the OptionGroupOptions field's value.

func (DescribeOptionGroupOptionsOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeOptionGroupsInput

type DescribeOptionGroupsInput struct {

	// Filters the list of option groups to only include groups associated with
	// a specific database engine.
	//
	// Valid Values:
	//
	//    * mariadb
	//
	//    * mysql
	//
	//    * oracle-ee
	//
	//    * oracle-ee-cdb
	//
	//    * oracle-se2
	//
	//    * oracle-se2-cdb
	//
	//    * postgres
	//
	//    * sqlserver-ee
	//
	//    * sqlserver-se
	//
	//    * sqlserver-ex
	//
	//    * sqlserver-web
	EngineName *string `type:"string"`

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// Filters the list of option groups to only include groups associated with
	// a specific database engine version. If specified, then EngineName must also
	// be specified.
	MajorEngineVersion *string `type:"string"`

	// An optional pagination token provided by a previous DescribeOptionGroups
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`

	// The name of the option group to describe. Can't be supplied together with
	// EngineName or MajorEngineVersion.
	OptionGroupName *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeOptionGroupsInput) GoString added in v0.6.5

func (s DescribeOptionGroupsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeOptionGroupsInput) SetEngineName added in v1.5.0

SetEngineName sets the EngineName field's value.

func (*DescribeOptionGroupsInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeOptionGroupsInput) SetMajorEngineVersion added in v1.5.0

func (s *DescribeOptionGroupsInput) SetMajorEngineVersion(v string) *DescribeOptionGroupsInput

SetMajorEngineVersion sets the MajorEngineVersion field's value.

func (*DescribeOptionGroupsInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeOptionGroupsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeOptionGroupsInput) SetOptionGroupName added in v1.5.0

SetOptionGroupName sets the OptionGroupName field's value.

func (DescribeOptionGroupsInput) String added in v0.6.5

func (s DescribeOptionGroupsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeOptionGroupsInput) Validate added in v1.1.21

func (s *DescribeOptionGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeOptionGroupsOutput

type DescribeOptionGroupsOutput struct {

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// List of option groups.
	OptionGroupsList []*OptionGroup `locationNameList:"OptionGroup" type:"list"`
	// contains filtered or unexported fields
}

List of option groups.

func (DescribeOptionGroupsOutput) GoString added in v0.6.5

func (s DescribeOptionGroupsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeOptionGroupsOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeOptionGroupsOutput) SetOptionGroupsList added in v1.5.0

SetOptionGroupsList sets the OptionGroupsList field's value.

func (DescribeOptionGroupsOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeOrderableDBInstanceOptionsInput

type DescribeOrderableDBInstanceOptionsInput struct {

	// The Availability Zone group associated with a Local Zone. Specify this parameter
	// to retrieve available offerings for the Local Zones in the group.
	//
	// Omit this parameter to show the available offerings in the specified Amazon
	// Web Services Region.
	//
	// This setting doesn't apply to RDS Custom.
	AvailabilityZoneGroup *string `type:"string"`

	// The DB instance class filter value. Specify this parameter to show only the
	// available offerings matching the specified DB instance class.
	DBInstanceClass *string `type:"string"`

	// The name of the engine to retrieve DB instance options for.
	//
	// Valid Values:
	//
	//    * aurora (for MySQL 5.6-compatible Aurora)
	//
	//    * aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
	//
	//    * aurora-postgresql
	//
	//    * mariadb
	//
	//    * mysql
	//
	//    * oracle-ee
	//
	//    * oracle-ee-cdb
	//
	//    * oracle-se2
	//
	//    * oracle-se2-cdb
	//
	//    * postgres
	//
	//    * sqlserver-ee
	//
	//    * sqlserver-se
	//
	//    * sqlserver-ex
	//
	//    * sqlserver-web
	//
	// Engine is a required field
	Engine *string `type:"string" required:"true"`

	// The engine version filter value. Specify this parameter to show only the
	// available offerings matching the specified engine version.
	EngineVersion *string `type:"string"`

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// The license model filter value. Specify this parameter to show only the available
	// offerings matching the specified license model.
	//
	// RDS Custom supports only the BYOL licensing model.
	LicenseModel *string `type:"string"`

	// An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 10000.
	MaxRecords *int64 `type:"integer"`

	// A value that indicates whether to show only VPC or non-VPC offerings. RDS
	// Custom supports only VPC offerings.
	//
	// RDS Custom supports only VPC offerings. If you describe non-VPC offerings
	// for RDS Custom, the output shows VPC offerings.
	Vpc *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (DescribeOrderableDBInstanceOptionsInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeOrderableDBInstanceOptionsInput) SetAvailabilityZoneGroup added in v1.30.13

SetAvailabilityZoneGroup sets the AvailabilityZoneGroup field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetDBInstanceClass added in v1.5.0

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetEngine added in v1.5.0

SetEngine sets the Engine field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetEngineVersion added in v1.5.0

SetEngineVersion sets the EngineVersion field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetLicenseModel added in v1.5.0

SetLicenseModel sets the LicenseModel field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetVpc added in v1.5.0

SetVpc sets the Vpc field's value.

func (DescribeOrderableDBInstanceOptionsInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeOrderableDBInstanceOptionsInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeOrderableDBInstanceOptionsOutput

type DescribeOrderableDBInstanceOptionsOutput struct {

	// An optional pagination token provided by a previous OrderableDBInstanceOptions
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// An OrderableDBInstanceOption structure containing information about orderable
	// options for the DB instance.
	OrderableDBInstanceOptions []*OrderableDBInstanceOption `locationNameList:"OrderableDBInstanceOption" type:"list"`
	// contains filtered or unexported fields
}

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

func (DescribeOrderableDBInstanceOptionsOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeOrderableDBInstanceOptionsOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeOrderableDBInstanceOptionsOutput) SetOrderableDBInstanceOptions added in v1.5.0

SetOrderableDBInstanceOptions sets the OrderableDBInstanceOptions field's value.

func (DescribeOrderableDBInstanceOptionsOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribePendingMaintenanceActionsInput

type DescribePendingMaintenanceActionsInput struct {

	// A filter that specifies one or more resources to return pending maintenance
	// actions for.
	//
	// Supported filters:
	//
	//    * db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon
	//    Resource Names (ARNs). The results list only includes pending maintenance
	//    actions for the DB clusters identified by these ARNs.
	//
	//    * db-instance-id - Accepts DB instance identifiers and DB instance ARNs.
	//    The results list only includes pending maintenance actions for the DB
	//    instances identified by these ARNs.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous DescribePendingMaintenanceActions
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to a number of records specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`

	// The ARN of a resource to return pending maintenance actions for.
	ResourceIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribePendingMaintenanceActionsInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePendingMaintenanceActionsInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribePendingMaintenanceActionsInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribePendingMaintenanceActionsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribePendingMaintenanceActionsInput) SetResourceIdentifier added in v1.5.0

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (DescribePendingMaintenanceActionsInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePendingMaintenanceActionsInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribePendingMaintenanceActionsOutput

type DescribePendingMaintenanceActionsOutput struct {

	// An optional pagination token provided by a previous DescribePendingMaintenanceActions
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to a number of records specified by MaxRecords.
	Marker *string `type:"string"`

	// A list of the pending maintenance actions for the resource.
	PendingMaintenanceActions []*ResourcePendingMaintenanceActions `locationNameList:"ResourcePendingMaintenanceActions" type:"list"`
	// contains filtered or unexported fields
}

Data returned from the DescribePendingMaintenanceActions action.

func (DescribePendingMaintenanceActionsOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePendingMaintenanceActionsOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribePendingMaintenanceActionsOutput) SetPendingMaintenanceActions added in v1.5.0

SetPendingMaintenanceActions sets the PendingMaintenanceActions field's value.

func (DescribePendingMaintenanceActionsOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeReservedDBInstancesInput

type DescribeReservedDBInstancesInput struct {

	// The DB instance class filter value. Specify this parameter to show only those
	// reservations matching the specified DB instances class.
	DBInstanceClass *string `type:"string"`

	// The duration filter value, specified in years or seconds. Specify this parameter
	// to show only reservations for this duration.
	//
	// Valid Values: 1 | 3 | 31536000 | 94608000
	Duration *string `type:"string"`

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// The lease identifier filter value. Specify this parameter to show only the
	// reservation that matches the specified lease ID.
	//
	// Amazon Web Services Support might request the lease ID for an issue related
	// to a reserved DB instance.
	LeaseId *string `type:"string"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more than the
	// MaxRecords value is available, a pagination token called a marker is included
	// in the response so you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`

	// A value that indicates whether to show only those reservations that support
	// Multi-AZ.
	MultiAZ *bool `type:"boolean"`

	// The offering type filter value. Specify this parameter to show only the available
	// offerings matching the specified offering type.
	//
	// Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
	OfferingType *string `type:"string"`

	// The product description filter value. Specify this parameter to show only
	// those reservations matching the specified product description.
	ProductDescription *string `type:"string"`

	// The reserved DB instance identifier filter value. Specify this parameter
	// to show only the reservation that matches the specified reservation ID.
	ReservedDBInstanceId *string `type:"string"`

	// The offering identifier filter value. Specify this parameter to show only
	// purchased reservations matching the specified offering identifier.
	ReservedDBInstancesOfferingId *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeReservedDBInstancesInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedDBInstancesInput) SetDBInstanceClass added in v1.5.0

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*DescribeReservedDBInstancesInput) SetDuration added in v1.5.0

SetDuration sets the Duration field's value.

func (*DescribeReservedDBInstancesInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeReservedDBInstancesInput) SetLeaseId added in v1.24.3

SetLeaseId sets the LeaseId field's value.

func (*DescribeReservedDBInstancesInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeReservedDBInstancesInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeReservedDBInstancesInput) SetMultiAZ added in v1.5.0

SetMultiAZ sets the MultiAZ field's value.

func (*DescribeReservedDBInstancesInput) SetOfferingType added in v1.5.0

SetOfferingType sets the OfferingType field's value.

func (*DescribeReservedDBInstancesInput) SetProductDescription added in v1.5.0

SetProductDescription sets the ProductDescription field's value.

func (*DescribeReservedDBInstancesInput) SetReservedDBInstanceId added in v1.5.0

SetReservedDBInstanceId sets the ReservedDBInstanceId field's value.

func (*DescribeReservedDBInstancesInput) SetReservedDBInstancesOfferingId added in v1.5.0

func (s *DescribeReservedDBInstancesInput) SetReservedDBInstancesOfferingId(v string) *DescribeReservedDBInstancesInput

SetReservedDBInstancesOfferingId sets the ReservedDBInstancesOfferingId field's value.

func (DescribeReservedDBInstancesInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedDBInstancesInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeReservedDBInstancesOfferingsInput

type DescribeReservedDBInstancesOfferingsInput struct {

	// The DB instance class filter value. Specify this parameter to show only the
	// available offerings matching the specified DB instance class.
	DBInstanceClass *string `type:"string"`

	// Duration filter value, specified in years or seconds. Specify this parameter
	// to show only reservations for this duration.
	//
	// Valid Values: 1 | 3 | 31536000 | 94608000
	Duration *string `type:"string"`

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more than the
	// MaxRecords value is available, a pagination token called a marker is included
	// in the response so you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`

	// A value that indicates whether to show only those reservations that support
	// Multi-AZ.
	MultiAZ *bool `type:"boolean"`

	// The offering type filter value. Specify this parameter to show only the available
	// offerings matching the specified offering type.
	//
	// Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
	OfferingType *string `type:"string"`

	// Product description filter value. Specify this parameter to show only the
	// available offerings that contain the specified product description.
	//
	// The results show offerings that partially match the filter value.
	ProductDescription *string `type:"string"`

	// The offering identifier filter value. Specify this parameter to show only
	// the available offering that matches the specified reservation identifier.
	//
	// Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
	ReservedDBInstancesOfferingId *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeReservedDBInstancesOfferingsInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedDBInstancesOfferingsInput) SetDBInstanceClass added in v1.5.0

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*DescribeReservedDBInstancesOfferingsInput) SetDuration added in v1.5.0

SetDuration sets the Duration field's value.

func (*DescribeReservedDBInstancesOfferingsInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeReservedDBInstancesOfferingsInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeReservedDBInstancesOfferingsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeReservedDBInstancesOfferingsInput) SetMultiAZ added in v1.5.0

SetMultiAZ sets the MultiAZ field's value.

func (*DescribeReservedDBInstancesOfferingsInput) SetOfferingType added in v1.5.0

SetOfferingType sets the OfferingType field's value.

func (*DescribeReservedDBInstancesOfferingsInput) SetProductDescription added in v1.5.0

SetProductDescription sets the ProductDescription field's value.

func (*DescribeReservedDBInstancesOfferingsInput) SetReservedDBInstancesOfferingId added in v1.5.0

SetReservedDBInstancesOfferingId sets the ReservedDBInstancesOfferingId field's value.

func (DescribeReservedDBInstancesOfferingsInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedDBInstancesOfferingsInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeReservedDBInstancesOfferingsOutput

type DescribeReservedDBInstancesOfferingsOutput struct {

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// A list of reserved DB instance offerings.
	ReservedDBInstancesOfferings []*ReservedDBInstancesOffering `locationNameList:"ReservedDBInstancesOffering" type:"list"`
	// contains filtered or unexported fields
}

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

func (DescribeReservedDBInstancesOfferingsOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedDBInstancesOfferingsOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeReservedDBInstancesOfferingsOutput) SetReservedDBInstancesOfferings added in v1.5.0

SetReservedDBInstancesOfferings sets the ReservedDBInstancesOfferings field's value.

func (DescribeReservedDBInstancesOfferingsOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeReservedDBInstancesOutput

type DescribeReservedDBInstancesOutput struct {

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// A list of reserved DB instances.
	ReservedDBInstances []*ReservedDBInstance `locationNameList:"ReservedDBInstance" type:"list"`
	// contains filtered or unexported fields
}

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

func (DescribeReservedDBInstancesOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedDBInstancesOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeReservedDBInstancesOutput) SetReservedDBInstances added in v1.5.0

SetReservedDBInstances sets the ReservedDBInstances field's value.

func (DescribeReservedDBInstancesOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeSourceRegionsInput added in v1.4.7

type DescribeSourceRegionsInput struct {

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous DescribeSourceRegions
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so you can retrieve the remaining results.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`

	// The source Amazon Web Services Region name. For example, us-east-1.
	//
	// Constraints:
	//
	//    * Must specify a valid Amazon Web Services Region name.
	RegionName *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeSourceRegionsInput) GoString added in v1.4.7

func (s DescribeSourceRegionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSourceRegionsInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeSourceRegionsInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeSourceRegionsInput) SetMaxRecords added in v1.5.0

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeSourceRegionsInput) SetRegionName added in v1.5.0

SetRegionName sets the RegionName field's value.

func (DescribeSourceRegionsInput) String added in v1.4.7

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSourceRegionsInput) Validate added in v1.4.7

func (s *DescribeSourceRegionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeSourceRegionsOutput added in v1.4.7

type DescribeSourceRegionsOutput struct {

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// A list of SourceRegion instances that contains each source Amazon Web Services
	// Region that the current Amazon Web Services Region can get a read replica
	// or a DB snapshot from.
	SourceRegions []*SourceRegion `locationNameList:"SourceRegion" type:"list"`
	// contains filtered or unexported fields
}

Contains the result of a successful invocation of the DescribeSourceRegions action.

func (DescribeSourceRegionsOutput) GoString added in v1.4.7

func (s DescribeSourceRegionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSourceRegionsOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DescribeSourceRegionsOutput) SetSourceRegions added in v1.5.0

SetSourceRegions sets the SourceRegions field's value.

func (DescribeSourceRegionsOutput) String added in v1.4.7

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeValidDBInstanceModificationsInput added in v1.12.10

type DescribeValidDBInstanceModificationsInput struct {

	// The customer identifier or the ARN of your DB instance.
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeValidDBInstanceModificationsInput) GoString added in v1.12.10

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeValidDBInstanceModificationsInput) SetDBInstanceIdentifier added in v1.12.10

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (DescribeValidDBInstanceModificationsInput) String added in v1.12.10

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeValidDBInstanceModificationsInput) Validate added in v1.12.10

Validate inspects the fields of the type to determine if they are valid.

type DescribeValidDBInstanceModificationsOutput added in v1.12.10

type DescribeValidDBInstanceModificationsOutput struct {

	// Information about valid modifications that you can make to your DB instance.
	// Contains the result of a successful call to the DescribeValidDBInstanceModifications
	// action. You can use this information when you call ModifyDBInstance.
	ValidDBInstanceModificationsMessage *ValidDBInstanceModificationsMessage `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeValidDBInstanceModificationsOutput) GoString added in v1.12.10

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeValidDBInstanceModificationsOutput) SetValidDBInstanceModificationsMessage added in v1.12.10

SetValidDBInstanceModificationsMessage sets the ValidDBInstanceModificationsMessage field's value.

func (DescribeValidDBInstanceModificationsOutput) String added in v1.12.10

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainMembership added in v1.1.14

type DomainMembership struct {

	// The identifier of the Active Directory Domain.
	Domain *string `type:"string"`

	// The fully qualified domain name of the Active Directory Domain.
	FQDN *string `type:"string"`

	// The name of the IAM role to be used when making API calls to the Directory
	// Service.
	IAMRoleName *string `type:"string"`

	// The status of the Active Directory Domain membership for the DB instance
	// or cluster. Values include joined, pending-join, failed, and so on.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (DomainMembership) GoString added in v1.1.14

func (s DomainMembership) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainMembership) SetDomain added in v1.5.0

func (s *DomainMembership) SetDomain(v string) *DomainMembership

SetDomain sets the Domain field's value.

func (*DomainMembership) SetFQDN added in v1.5.0

func (s *DomainMembership) SetFQDN(v string) *DomainMembership

SetFQDN sets the FQDN field's value.

func (*DomainMembership) SetIAMRoleName added in v1.5.0

func (s *DomainMembership) SetIAMRoleName(v string) *DomainMembership

SetIAMRoleName sets the IAMRoleName field's value.

func (*DomainMembership) SetStatus added in v1.5.0

func (s *DomainMembership) SetStatus(v string) *DomainMembership

SetStatus sets the Status field's value.

func (DomainMembership) String added in v1.1.14

func (s DomainMembership) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DoubleRange added in v1.12.10

type DoubleRange struct {

	// The minimum value in the range.
	From *float64 `type:"double"`

	// The maximum value in the range.
	To *float64 `type:"double"`
	// contains filtered or unexported fields
}

A range of double values.

func (DoubleRange) GoString added in v1.12.10

func (s DoubleRange) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DoubleRange) SetFrom added in v1.12.10

func (s *DoubleRange) SetFrom(v float64) *DoubleRange

SetFrom sets the From field's value.

func (*DoubleRange) SetTo added in v1.12.10

func (s *DoubleRange) SetTo(v float64) *DoubleRange

SetTo sets the To field's value.

func (DoubleRange) String added in v1.12.10

func (s DoubleRange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DownloadDBLogFilePortionInput

type DownloadDBLogFilePortionInput struct {

	// The customer-assigned name of the DB instance that contains the log files
	// you want to list.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBInstance.
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`

	// The name of the log file to be downloaded.
	//
	// LogFileName is a required field
	LogFileName *string `type:"string" required:"true"`

	// The pagination token provided in the previous request or "0". If the Marker
	// parameter is specified the response includes only records beyond the marker
	// until the end of the file or up to NumberOfLines.
	Marker *string `type:"string"`

	// The number of lines to download. If the number of lines specified results
	// in a file over 1 MB in size, the file is truncated at 1 MB in size.
	//
	// If the NumberOfLines parameter is specified, then the block of lines returned
	// can be from the beginning or the end of the log file, depending on the value
	// of the Marker parameter.
	//
	//    * If neither Marker or NumberOfLines are specified, the entire log file
	//    is returned up to a maximum of 10000 lines, starting with the most recent
	//    log entries first.
	//
	//    * If NumberOfLines is specified and Marker isn't specified, then the most
	//    recent lines from the end of the log file are returned.
	//
	//    * If Marker is specified as "0", then the specified number of lines from
	//    the beginning of the log file are returned.
	//
	//    * You can download the log file in blocks of lines by specifying the size
	//    of the block using the NumberOfLines parameter, and by specifying a value
	//    of "0" for the Marker parameter in your first request. Include the Marker
	//    value returned in the response as the Marker value for the next request,
	//    continuing until the AdditionalDataPending response element returns false.
	NumberOfLines *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DownloadDBLogFilePortionInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DownloadDBLogFilePortionInput) SetDBInstanceIdentifier added in v1.5.0

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*DownloadDBLogFilePortionInput) SetLogFileName added in v1.5.0

SetLogFileName sets the LogFileName field's value.

func (*DownloadDBLogFilePortionInput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (*DownloadDBLogFilePortionInput) SetNumberOfLines added in v1.5.0

SetNumberOfLines sets the NumberOfLines field's value.

func (DownloadDBLogFilePortionInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DownloadDBLogFilePortionInput) Validate added in v1.1.21

func (s *DownloadDBLogFilePortionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DownloadDBLogFilePortionOutput

type DownloadDBLogFilePortionOutput struct {

	// Boolean value that if true, indicates there is more data to be downloaded.
	AdditionalDataPending *bool `type:"boolean"`

	// Entries from the specified log file.
	LogFileData *string `type:"string"`

	// A pagination token that can be used in a later DownloadDBLogFilePortion request.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

This data type is used as a response element to DownloadDBLogFilePortion.

func (DownloadDBLogFilePortionOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DownloadDBLogFilePortionOutput) SetAdditionalDataPending added in v1.5.0

func (s *DownloadDBLogFilePortionOutput) SetAdditionalDataPending(v bool) *DownloadDBLogFilePortionOutput

SetAdditionalDataPending sets the AdditionalDataPending field's value.

func (*DownloadDBLogFilePortionOutput) SetLogFileData added in v1.5.0

SetLogFileData sets the LogFileData field's value.

func (*DownloadDBLogFilePortionOutput) SetMarker added in v1.5.0

SetMarker sets the Marker field's value.

func (DownloadDBLogFilePortionOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EC2SecurityGroup

type EC2SecurityGroup struct {

	// Specifies the id of the EC2 security group.
	EC2SecurityGroupId *string `type:"string"`

	// Specifies the name of the EC2 security group.
	EC2SecurityGroupName *string `type:"string"`

	// Specifies the Amazon Web Services ID of the owner of the EC2 security group
	// specified in the EC2SecurityGroupName field.
	EC2SecurityGroupOwnerId *string `type:"string"`

	// Provides the status of the EC2 security group. Status can be "authorizing",
	// "authorized", "revoking", and "revoked".
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

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

  • AuthorizeDBSecurityGroupIngress

  • DescribeDBSecurityGroups

  • RevokeDBSecurityGroupIngress

func (EC2SecurityGroup) GoString added in v0.6.5

func (s EC2SecurityGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EC2SecurityGroup) SetEC2SecurityGroupId added in v1.5.0

func (s *EC2SecurityGroup) SetEC2SecurityGroupId(v string) *EC2SecurityGroup

SetEC2SecurityGroupId sets the EC2SecurityGroupId field's value.

func (*EC2SecurityGroup) SetEC2SecurityGroupName added in v1.5.0

func (s *EC2SecurityGroup) SetEC2SecurityGroupName(v string) *EC2SecurityGroup

SetEC2SecurityGroupName sets the EC2SecurityGroupName field's value.

func (*EC2SecurityGroup) SetEC2SecurityGroupOwnerId added in v1.5.0

func (s *EC2SecurityGroup) SetEC2SecurityGroupOwnerId(v string) *EC2SecurityGroup

SetEC2SecurityGroupOwnerId sets the EC2SecurityGroupOwnerId field's value.

func (*EC2SecurityGroup) SetStatus added in v1.5.0

func (s *EC2SecurityGroup) SetStatus(v string) *EC2SecurityGroup

SetStatus sets the Status field's value.

func (EC2SecurityGroup) String added in v0.6.5

func (s EC2SecurityGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Endpoint

type Endpoint struct {

	// Specifies the DNS address of the DB instance.
	Address *string `type:"string"`

	// Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
	HostedZoneId *string `type:"string"`

	// Specifies the port that the database engine is listening on.
	Port *int64 `type:"integer"`
	// contains filtered or unexported fields
}

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.

func (Endpoint) GoString added in v0.6.5

func (s Endpoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Endpoint) SetAddress added in v1.5.0

func (s *Endpoint) SetAddress(v string) *Endpoint

SetAddress sets the Address field's value.

func (*Endpoint) SetHostedZoneId added in v1.5.0

func (s *Endpoint) SetHostedZoneId(v string) *Endpoint

SetHostedZoneId sets the HostedZoneId field's value.

func (*Endpoint) SetPort added in v1.5.0

func (s *Endpoint) SetPort(v int64) *Endpoint

SetPort sets the Port field's value.

func (Endpoint) String added in v0.6.5

func (s Endpoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EngineDefaults

type EngineDefaults struct {

	// Specifies the name of the DB parameter group family that the engine default
	// parameters apply to.
	DBParameterGroupFamily *string `type:"string"`

	// An optional pagination token provided by a previous EngineDefaults request.
	// If this parameter is specified, the response includes only records beyond
	// the marker, up to the value specified by MaxRecords .
	Marker *string `type:"string"`

	// Contains a list of engine default parameters.
	Parameters []*Parameter `locationNameList:"Parameter" type:"list"`
	// contains filtered or unexported fields
}

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

func (EngineDefaults) GoString added in v0.6.5

func (s EngineDefaults) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EngineDefaults) SetDBParameterGroupFamily added in v1.5.0

func (s *EngineDefaults) SetDBParameterGroupFamily(v string) *EngineDefaults

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*EngineDefaults) SetMarker added in v1.5.0

func (s *EngineDefaults) SetMarker(v string) *EngineDefaults

SetMarker sets the Marker field's value.

func (*EngineDefaults) SetParameters added in v1.5.0

func (s *EngineDefaults) SetParameters(v []*Parameter) *EngineDefaults

SetParameters sets the Parameters field's value.

func (EngineDefaults) String added in v0.6.5

func (s EngineDefaults) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Event

type Event struct {

	// Specifies the date and time of the event.
	Date *time.Time `type:"timestamp"`

	// Specifies the category for the event.
	EventCategories []*string `locationNameList:"EventCategory" type:"list"`

	// Provides the text of this event.
	Message *string `type:"string"`

	// The Amazon Resource Name (ARN) for the event.
	SourceArn *string `type:"string"`

	// Provides the identifier for the source of the event.
	SourceIdentifier *string `type:"string"`

	// Specifies the source type for this event.
	SourceType *string `type:"string" enum:"SourceType"`
	// contains filtered or unexported fields
}

This data type is used as a response element in the DescribeEvents (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEvents.html) action.

func (Event) GoString added in v0.6.5

func (s Event) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Event) SetDate added in v1.5.0

func (s *Event) SetDate(v time.Time) *Event

SetDate sets the Date field's value.

func (*Event) SetEventCategories added in v1.5.0

func (s *Event) SetEventCategories(v []*string) *Event

SetEventCategories sets the EventCategories field's value.

func (*Event) SetMessage added in v1.5.0

func (s *Event) SetMessage(v string) *Event

SetMessage sets the Message field's value.

func (*Event) SetSourceArn added in v1.5.0

func (s *Event) SetSourceArn(v string) *Event

SetSourceArn sets the SourceArn field's value.

func (*Event) SetSourceIdentifier added in v1.5.0

func (s *Event) SetSourceIdentifier(v string) *Event

SetSourceIdentifier sets the SourceIdentifier field's value.

func (*Event) SetSourceType added in v1.5.0

func (s *Event) SetSourceType(v string) *Event

SetSourceType sets the SourceType field's value.

func (Event) String added in v0.6.5

func (s Event) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EventCategoriesMap

type EventCategoriesMap struct {

	// The event categories for the specified source type
	EventCategories []*string `locationNameList:"EventCategory" type:"list"`

	// The source type that the returned categories belong to
	SourceType *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the results of a successful invocation of the DescribeEventCategories (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEventCategories.html) operation.

func (EventCategoriesMap) GoString added in v0.6.5

func (s EventCategoriesMap) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventCategoriesMap) SetEventCategories added in v1.5.0

func (s *EventCategoriesMap) SetEventCategories(v []*string) *EventCategoriesMap

SetEventCategories sets the EventCategories field's value.

func (*EventCategoriesMap) SetSourceType added in v1.5.0

func (s *EventCategoriesMap) SetSourceType(v string) *EventCategoriesMap

SetSourceType sets the SourceType field's value.

func (EventCategoriesMap) String added in v0.6.5

func (s EventCategoriesMap) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EventSubscription

type EventSubscription struct {

	// The RDS event notification subscription Id.
	CustSubscriptionId *string `type:"string"`

	// The Amazon Web Services customer account associated with the RDS event notification
	// subscription.
	CustomerAwsId *string `type:"string"`

	// A Boolean value indicating if the subscription is enabled. True indicates
	// the subscription is enabled.
	Enabled *bool `type:"boolean"`

	// A list of event categories for the RDS event notification subscription.
	EventCategoriesList []*string `locationNameList:"EventCategory" type:"list"`

	// The Amazon Resource Name (ARN) for the event subscription.
	EventSubscriptionArn *string `type:"string"`

	// The topic ARN of the RDS event notification subscription.
	SnsTopicArn *string `type:"string"`

	// A list of source IDs for the RDS event notification subscription.
	SourceIdsList []*string `locationNameList:"SourceId" type:"list"`

	// The source type for the RDS event notification subscription.
	SourceType *string `type:"string"`

	// The status of the RDS event notification subscription.
	//
	// Constraints:
	//
	// Can be one of the following: creating | modifying | deleting | active | no-permission
	// | topic-not-exist
	//
	// The status "no-permission" indicates that RDS no longer has permission to
	// post to the SNS topic. The status "topic-not-exist" indicates that the topic
	// was deleted after the subscription was created.
	Status *string `type:"string"`

	// The time the RDS event notification subscription was created.
	SubscriptionCreationTime *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

func (EventSubscription) GoString added in v0.6.5

func (s EventSubscription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventSubscription) SetCustSubscriptionId added in v1.5.0

func (s *EventSubscription) SetCustSubscriptionId(v string) *EventSubscription

SetCustSubscriptionId sets the CustSubscriptionId field's value.

func (*EventSubscription) SetCustomerAwsId added in v1.5.0

func (s *EventSubscription) SetCustomerAwsId(v string) *EventSubscription

SetCustomerAwsId sets the CustomerAwsId field's value.

func (*EventSubscription) SetEnabled added in v1.5.0

func (s *EventSubscription) SetEnabled(v bool) *EventSubscription

SetEnabled sets the Enabled field's value.

func (*EventSubscription) SetEventCategoriesList added in v1.5.0

func (s *EventSubscription) SetEventCategoriesList(v []*string) *EventSubscription

SetEventCategoriesList sets the EventCategoriesList field's value.

func (*EventSubscription) SetEventSubscriptionArn added in v1.5.0

func (s *EventSubscription) SetEventSubscriptionArn(v string) *EventSubscription

SetEventSubscriptionArn sets the EventSubscriptionArn field's value.

func (*EventSubscription) SetSnsTopicArn added in v1.5.0

func (s *EventSubscription) SetSnsTopicArn(v string) *EventSubscription

SetSnsTopicArn sets the SnsTopicArn field's value.

func (*EventSubscription) SetSourceIdsList added in v1.5.0

func (s *EventSubscription) SetSourceIdsList(v []*string) *EventSubscription

SetSourceIdsList sets the SourceIdsList field's value.

func (*EventSubscription) SetSourceType added in v1.5.0

func (s *EventSubscription) SetSourceType(v string) *EventSubscription

SetSourceType sets the SourceType field's value.

func (*EventSubscription) SetStatus added in v1.5.0

func (s *EventSubscription) SetStatus(v string) *EventSubscription

SetStatus sets the Status field's value.

func (*EventSubscription) SetSubscriptionCreationTime added in v1.5.0

func (s *EventSubscription) SetSubscriptionCreationTime(v string) *EventSubscription

SetSubscriptionCreationTime sets the SubscriptionCreationTime field's value.

func (EventSubscription) String added in v0.6.5

func (s EventSubscription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExportTask added in v1.28.8

type ExportTask struct {

	// The data exported from the snapshot. Valid values are the following:
	//
	//    * database - Export all the data from a specified database.
	//
	//    * database.table table-name - Export a table of the snapshot. This format
	//    is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
	//
	//    * database.schema schema-name - Export a database schema of the snapshot.
	//    This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
	//
	//    * database.schema.table table-name - Export a table of the database schema.
	//    This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
	ExportOnly []*string `type:"list"`

	// A unique identifier for the snapshot export task. This ID isn't an identifier
	// for the Amazon S3 bucket where the snapshot is exported to.
	ExportTaskIdentifier *string `type:"string"`

	// The reason the export failed, if it failed.
	FailureCause *string `type:"string"`

	// The name of the IAM role that is used to write to Amazon S3 when exporting
	// a snapshot.
	IamRoleArn *string `type:"string"`

	// The key identifier of the Amazon Web Services KMS key that is used to encrypt
	// the snapshot when it's exported to Amazon S3. The KMS key identifier is its
	// key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot
	// export must have encryption and decryption permissions to use this KMS key.
	KmsKeyId *string `type:"string"`

	// The progress of the snapshot export task as a percentage.
	PercentProgress *int64 `type:"integer"`

	// The Amazon S3 bucket that the snapshot is exported to.
	S3Bucket *string `type:"string"`

	// The Amazon S3 bucket prefix that is the file name and path of the exported
	// snapshot.
	S3Prefix *string `type:"string"`

	// The time that the snapshot was created.
	SnapshotTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
	SourceArn *string `type:"string"`

	// The progress status of the export task.
	Status *string `type:"string"`

	// The time that the snapshot export task completed.
	TaskEndTime *time.Time `type:"timestamp"`

	// The time that the snapshot export task started.
	TaskStartTime *time.Time `type:"timestamp"`

	// The total amount of data exported, in gigabytes.
	TotalExtractedDataInGB *int64 `type:"integer"`

	// A warning about the snapshot export task.
	WarningMessage *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the details of a snapshot export to Amazon S3.

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

func (ExportTask) GoString added in v1.28.8

func (s ExportTask) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportTask) SetExportOnly added in v1.28.8

func (s *ExportTask) SetExportOnly(v []*string) *ExportTask

SetExportOnly sets the ExportOnly field's value.

func (*ExportTask) SetExportTaskIdentifier added in v1.28.8

func (s *ExportTask) SetExportTaskIdentifier(v string) *ExportTask

SetExportTaskIdentifier sets the ExportTaskIdentifier field's value.

func (*ExportTask) SetFailureCause added in v1.28.8

func (s *ExportTask) SetFailureCause(v string) *ExportTask

SetFailureCause sets the FailureCause field's value.

func (*ExportTask) SetIamRoleArn added in v1.28.8

func (s *ExportTask) SetIamRoleArn(v string) *ExportTask

SetIamRoleArn sets the IamRoleArn field's value.

func (*ExportTask) SetKmsKeyId added in v1.28.8

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*ExportTask) SetPercentProgress added in v1.28.8

func (s *ExportTask) SetPercentProgress(v int64) *ExportTask

SetPercentProgress sets the PercentProgress field's value.

func (*ExportTask) SetS3Bucket added in v1.28.8

func (s *ExportTask) SetS3Bucket(v string) *ExportTask

SetS3Bucket sets the S3Bucket field's value.

func (*ExportTask) SetS3Prefix added in v1.28.8

func (s *ExportTask) SetS3Prefix(v string) *ExportTask

SetS3Prefix sets the S3Prefix field's value.

func (*ExportTask) SetSnapshotTime added in v1.28.8

func (s *ExportTask) SetSnapshotTime(v time.Time) *ExportTask

SetSnapshotTime sets the SnapshotTime field's value.

func (*ExportTask) SetSourceArn added in v1.28.8

func (s *ExportTask) SetSourceArn(v string) *ExportTask

SetSourceArn sets the SourceArn field's value.

func (*ExportTask) SetStatus added in v1.28.8

func (s *ExportTask) SetStatus(v string) *ExportTask

SetStatus sets the Status field's value.

func (*ExportTask) SetTaskEndTime added in v1.28.8

func (s *ExportTask) SetTaskEndTime(v time.Time) *ExportTask

SetTaskEndTime sets the TaskEndTime field's value.

func (*ExportTask) SetTaskStartTime added in v1.28.8

func (s *ExportTask) SetTaskStartTime(v time.Time) *ExportTask

SetTaskStartTime sets the TaskStartTime field's value.

func (*ExportTask) SetTotalExtractedDataInGB added in v1.28.8

func (s *ExportTask) SetTotalExtractedDataInGB(v int64) *ExportTask

SetTotalExtractedDataInGB sets the TotalExtractedDataInGB field's value.

func (*ExportTask) SetWarningMessage added in v1.28.8

func (s *ExportTask) SetWarningMessage(v string) *ExportTask

SetWarningMessage sets the WarningMessage field's value.

func (ExportTask) String added in v1.28.8

func (s ExportTask) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FailoverDBClusterInput added in v0.7.1

type FailoverDBClusterInput struct {

	// A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBCluster.
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The name of the DB instance to promote to the primary DB instance.
	//
	// Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable
	// standby in the DB cluster, for example mydbcluster-replica1.
	//
	// This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
	TargetDBInstanceIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

func (FailoverDBClusterInput) GoString added in v0.7.1

func (s FailoverDBClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailoverDBClusterInput) SetDBClusterIdentifier added in v1.5.0

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*FailoverDBClusterInput) SetTargetDBInstanceIdentifier added in v1.5.0

func (s *FailoverDBClusterInput) SetTargetDBInstanceIdentifier(v string) *FailoverDBClusterInput

SetTargetDBInstanceIdentifier sets the TargetDBInstanceIdentifier field's value.

func (FailoverDBClusterInput) String added in v0.7.1

func (s FailoverDBClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailoverDBClusterInput) Validate added in v1.15.85

func (s *FailoverDBClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FailoverDBClusterOutput added in v0.7.1

type FailoverDBClusterOutput struct {

	// Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
	//
	// For an Amazon Aurora DB cluster, this data type is used as a response element
	// in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot,
	// RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
	//
	// For a Multi-AZ DB cluster, this data type is used as a response element in
	// the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
	//
	// For more information on Amazon Aurora DB clusters, see What is Amazon Aurora?
	// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)
	// in the Amazon Aurora User Guide.
	//
	// For more information on Multi-AZ DB clusters, see Multi-AZ deployments with
	// two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
	// in the Amazon RDS User Guide.
	DBCluster *DBCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (FailoverDBClusterOutput) GoString added in v0.7.1

func (s FailoverDBClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailoverDBClusterOutput) SetDBCluster added in v1.5.0

SetDBCluster sets the DBCluster field's value.

func (FailoverDBClusterOutput) String added in v0.7.1

func (s FailoverDBClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FailoverGlobalClusterInput added in v1.37.9

type FailoverGlobalClusterInput struct {

	// Identifier of the Aurora global database (GlobalCluster) that should be failed
	// over. The identifier is the unique key assigned by the user when the Aurora
	// global database was created. In other words, it's the name of the Aurora
	// global database that you want to fail over.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing GlobalCluster (Aurora global
	//    database).
	//
	// GlobalClusterIdentifier is a required field
	GlobalClusterIdentifier *string `min:"1" type:"string" required:"true"`

	// Identifier of the secondary Aurora DB cluster that you want to promote to
	// primary for the Aurora global database (GlobalCluster.) Use the Amazon Resource
	// Name (ARN) for the identifier so that Aurora can locate the cluster in its
	// Amazon Web Services Region.
	//
	// TargetDbClusterIdentifier is a required field
	TargetDbClusterIdentifier *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (FailoverGlobalClusterInput) GoString added in v1.37.9

func (s FailoverGlobalClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailoverGlobalClusterInput) SetGlobalClusterIdentifier added in v1.37.9

func (s *FailoverGlobalClusterInput) SetGlobalClusterIdentifier(v string) *FailoverGlobalClusterInput

SetGlobalClusterIdentifier sets the GlobalClusterIdentifier field's value.

func (*FailoverGlobalClusterInput) SetTargetDbClusterIdentifier added in v1.37.9

func (s *FailoverGlobalClusterInput) SetTargetDbClusterIdentifier(v string) *FailoverGlobalClusterInput

SetTargetDbClusterIdentifier sets the TargetDbClusterIdentifier field's value.

func (FailoverGlobalClusterInput) String added in v1.37.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailoverGlobalClusterInput) Validate added in v1.37.9

func (s *FailoverGlobalClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FailoverGlobalClusterOutput added in v1.37.9

type FailoverGlobalClusterOutput struct {

	// A data type representing an Aurora global database.
	GlobalCluster *GlobalCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (FailoverGlobalClusterOutput) GoString added in v1.37.9

func (s FailoverGlobalClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailoverGlobalClusterOutput) SetGlobalCluster added in v1.37.9

SetGlobalCluster sets the GlobalCluster field's value.

func (FailoverGlobalClusterOutput) String added in v1.37.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FailoverState added in v1.37.9

type FailoverState struct {

	// The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently
	// being demoted, and which is associated with this state.
	FromDbClusterArn *string `type:"string"`

	// The current status of the Aurora global database (GlobalCluster). Possible
	// values are as follows:
	//
	//    * pending – A request to fail over the Aurora global database (GlobalCluster)
	//    has been received by the service. The GlobalCluster's primary DB cluster
	//    and the specified secondary DB cluster are being verified before the failover
	//    process can start.
	//
	//    * failing-over – This status covers the range of Aurora internal operations
	//    that take place during the failover process, such as demoting the primary
	//    Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing
	//    replicas.
	//
	//    * cancelling – The request to fail over the Aurora global database (GlobalCluster)
	//    was cancelled and the primary Aurora DB cluster and the selected secondary
	//    Aurora DB cluster are returning to their previous states.
	Status *string `type:"string" enum:"FailoverStatus"`

	// The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently
	// being promoted, and which is associated with this state.
	ToDbClusterArn *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the state of scheduled or in-process failover operations on an Aurora global database (GlobalCluster). This Data type is empty unless a failover operation is scheduled or is currently underway on the Aurora global database.

func (FailoverState) GoString added in v1.37.9

func (s FailoverState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailoverState) SetFromDbClusterArn added in v1.37.9

func (s *FailoverState) SetFromDbClusterArn(v string) *FailoverState

SetFromDbClusterArn sets the FromDbClusterArn field's value.

func (*FailoverState) SetStatus added in v1.37.9

func (s *FailoverState) SetStatus(v string) *FailoverState

SetStatus sets the Status field's value.

func (*FailoverState) SetToDbClusterArn added in v1.37.9

func (s *FailoverState) SetToDbClusterArn(v string) *FailoverState

SetToDbClusterArn sets the ToDbClusterArn field's value.

func (FailoverState) String added in v1.37.9

func (s FailoverState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Filter

type Filter struct {

	// The name of the filter. Filter names are case-sensitive.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// One or more filter values. Filter values are case-sensitive.
	//
	// Values is a required field
	Values []*string `locationNameList:"Value" type:"list" required:"true"`
	// contains filtered or unexported fields
}

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Currently, wildcards are not supported in filters.

The following actions can be filtered:

  • DescribeDBClusterBacktracks

  • DescribeDBClusterEndpoints

  • DescribeDBClusters

  • DescribeDBInstances

  • DescribePendingMaintenanceActions

func (Filter) GoString added in v0.6.5

func (s Filter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Filter) SetName added in v1.5.0

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

SetName sets the Name field's value.

func (*Filter) SetValues added in v1.5.0

func (s *Filter) SetValues(v []*string) *Filter

SetValues sets the Values field's value.

func (Filter) String added in v0.6.5

func (s Filter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Filter) Validate added in v1.1.21

func (s *Filter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GlobalCluster added in v1.15.85

type GlobalCluster struct {

	// The default database name within the new global database cluster.
	DatabaseName *string `type:"string"`

	// The deletion protection setting for the new global database cluster.
	DeletionProtection *bool `type:"boolean"`

	// The Aurora database engine used by the global database cluster.
	Engine *string `type:"string"`

	// Indicates the database engine version.
	EngineVersion *string `type:"string"`

	// A data object containing all properties for the current state of an in-process
	// or pending failover process for this Aurora global database. This object
	// is empty unless the FailoverGlobalCluster API operation has been called on
	// this Aurora global database (GlobalCluster).
	FailoverState *FailoverState `type:"structure"`

	// The Amazon Resource Name (ARN) for the global database cluster.
	GlobalClusterArn *string `type:"string"`

	// Contains a user-supplied global database cluster identifier. This identifier
	// is the unique key that identifies a global database cluster.
	GlobalClusterIdentifier *string `type:"string"`

	// The list of cluster IDs for secondary clusters within the global database
	// cluster. Currently limited to 1 item.
	GlobalClusterMembers []*GlobalClusterMember `locationNameList:"GlobalClusterMember" type:"list"`

	// The Amazon Web Services Region-unique, immutable identifier for the global
	// database cluster. This identifier is found in Amazon Web Services CloudTrail
	// log entries whenever the Amazon Web Services KMS key for the DB cluster is
	// accessed.
	GlobalClusterResourceId *string `type:"string"`

	// Specifies the current state of this global database cluster.
	Status *string `type:"string"`

	// The storage encryption setting for the global database cluster.
	StorageEncrypted *bool `type:"boolean"`
	// contains filtered or unexported fields
}

A data type representing an Aurora global database.

func (GlobalCluster) GoString added in v1.15.85

func (s GlobalCluster) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GlobalCluster) SetDatabaseName added in v1.15.85

func (s *GlobalCluster) SetDatabaseName(v string) *GlobalCluster

SetDatabaseName sets the DatabaseName field's value.

func (*GlobalCluster) SetDeletionProtection added in v1.15.85

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

SetDeletionProtection sets the DeletionProtection field's value.

func (*GlobalCluster) SetEngine added in v1.15.85

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

SetEngine sets the Engine field's value.

func (*GlobalCluster) SetEngineVersion added in v1.15.85

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

SetEngineVersion sets the EngineVersion field's value.

func (*GlobalCluster) SetFailoverState added in v1.37.9

func (s *GlobalCluster) SetFailoverState(v *FailoverState) *GlobalCluster

SetFailoverState sets the FailoverState field's value.

func (*GlobalCluster) SetGlobalClusterArn added in v1.15.85

func (s *GlobalCluster) SetGlobalClusterArn(v string) *GlobalCluster

SetGlobalClusterArn sets the GlobalClusterArn field's value.

func (*GlobalCluster) SetGlobalClusterIdentifier added in v1.15.85

func (s *GlobalCluster) SetGlobalClusterIdentifier(v string) *GlobalCluster

SetGlobalClusterIdentifier sets the GlobalClusterIdentifier field's value.

func (*GlobalCluster) SetGlobalClusterMembers added in v1.15.85

func (s *GlobalCluster) SetGlobalClusterMembers(v []*GlobalClusterMember) *GlobalCluster

SetGlobalClusterMembers sets the GlobalClusterMembers field's value.

func (*GlobalCluster) SetGlobalClusterResourceId added in v1.15.85

func (s *GlobalCluster) SetGlobalClusterResourceId(v string) *GlobalCluster

SetGlobalClusterResourceId sets the GlobalClusterResourceId field's value.

func (*GlobalCluster) SetStatus added in v1.15.85

func (s *GlobalCluster) SetStatus(v string) *GlobalCluster

SetStatus sets the Status field's value.

func (*GlobalCluster) SetStorageEncrypted added in v1.15.85

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

SetStorageEncrypted sets the StorageEncrypted field's value.

func (GlobalCluster) String added in v1.15.85

func (s GlobalCluster) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GlobalClusterMember added in v1.15.85

type GlobalClusterMember struct {

	// The Amazon Resource Name (ARN) for each Aurora cluster.
	DBClusterArn *string `type:"string"`

	// Specifies whether a secondary cluster in an Aurora global database has write
	// forwarding enabled, not enabled, or is in the process of enabling it.
	GlobalWriteForwardingStatus *string `type:"string" enum:"WriteForwardingStatus"`

	// Specifies whether the Aurora cluster is the primary cluster (that is, has
	// read-write capability) for the Aurora global database with which it is associated.
	IsWriter *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) for each read-only secondary cluster associated
	// with the Aurora global database.
	Readers []*string `type:"list"`
	// contains filtered or unexported fields
}

A data structure with information about any primary and secondary clusters associated with an Aurora global database.

func (GlobalClusterMember) GoString added in v1.15.85

func (s GlobalClusterMember) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GlobalClusterMember) SetDBClusterArn added in v1.15.85

func (s *GlobalClusterMember) SetDBClusterArn(v string) *GlobalClusterMember

SetDBClusterArn sets the DBClusterArn field's value.

func (*GlobalClusterMember) SetGlobalWriteForwardingStatus added in v1.32.5

func (s *GlobalClusterMember) SetGlobalWriteForwardingStatus(v string) *GlobalClusterMember

SetGlobalWriteForwardingStatus sets the GlobalWriteForwardingStatus field's value.

func (*GlobalClusterMember) SetIsWriter added in v1.15.85

func (s *GlobalClusterMember) SetIsWriter(v bool) *GlobalClusterMember

SetIsWriter sets the IsWriter field's value.

func (*GlobalClusterMember) SetReaders added in v1.15.85

func (s *GlobalClusterMember) SetReaders(v []*string) *GlobalClusterMember

SetReaders sets the Readers field's value.

func (GlobalClusterMember) String added in v1.15.85

func (s GlobalClusterMember) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IPRange

type IPRange struct {

	// Specifies the IP range.
	CIDRIP *string `type:"string"`

	// Specifies the status of the IP range. Status can be "authorizing", "authorized",
	// "revoking", and "revoked".
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (IPRange) GoString added in v0.6.5

func (s IPRange) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IPRange) SetCIDRIP added in v1.5.0

func (s *IPRange) SetCIDRIP(v string) *IPRange

SetCIDRIP sets the CIDRIP field's value.

func (*IPRange) SetStatus added in v1.5.0

func (s *IPRange) SetStatus(v string) *IPRange

SetStatus sets the Status field's value.

func (IPRange) String added in v0.6.5

func (s IPRange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// This parameter isn't currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// The Amazon RDS resource with tags to be listed. This value is an Amazon Resource
	// Name (ARN). For information about creating an ARN, see Constructing an ARN
	// for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing)
	// in the Amazon RDS User Guide.
	//
	// ResourceName is a required field
	ResourceName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v0.6.5

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*ListTagsForResourceInput) SetResourceName added in v1.5.0

SetResourceName sets the ResourceName field's value.

func (ListTagsForResourceInput) String added in v0.6.5

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.1.21

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// List of tags returned by the ListTagsForResource operation.
	TagList []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v0.6.5

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTagList added in v1.5.0

SetTagList sets the TagList field's value.

func (ListTagsForResourceOutput) String added in v0.6.5

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MinimumEngineVersionPerAllowedValue added in v1.15.41

type MinimumEngineVersionPerAllowedValue struct {

	// The allowed value for an option setting.
	AllowedValue *string `type:"string"`

	// The minimum DB engine version required for the allowed value.
	MinimumEngineVersion *string `type:"string"`
	// contains filtered or unexported fields
}

The minimum DB engine version required for each corresponding allowed value for an option setting.

func (MinimumEngineVersionPerAllowedValue) GoString added in v1.15.41

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MinimumEngineVersionPerAllowedValue) SetAllowedValue added in v1.15.41

SetAllowedValue sets the AllowedValue field's value.

func (*MinimumEngineVersionPerAllowedValue) SetMinimumEngineVersion added in v1.15.41

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (MinimumEngineVersionPerAllowedValue) String added in v1.15.41

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyActivityStreamInput added in v1.44.61

type ModifyActivityStreamInput struct {

	// The audit policy state. When a policy is unlocked, it is read/write. When
	// it is locked, it is read-only. You can edit your audit policy only when the
	// activity stream is unlocked or stopped.
	AuditPolicyState *string `type:"string" enum:"AuditPolicyState"`

	// The Amazon Resource Name (ARN) of the RDS for Oracle DB instance, for example,
	// arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db.
	ResourceArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (ModifyActivityStreamInput) GoString added in v1.44.61

func (s ModifyActivityStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyActivityStreamInput) SetAuditPolicyState added in v1.44.61

func (s *ModifyActivityStreamInput) SetAuditPolicyState(v string) *ModifyActivityStreamInput

SetAuditPolicyState sets the AuditPolicyState field's value.

func (*ModifyActivityStreamInput) SetResourceArn added in v1.44.61

SetResourceArn sets the ResourceArn field's value.

func (ModifyActivityStreamInput) String added in v1.44.61

func (s ModifyActivityStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyActivityStreamOutput added in v1.44.61

type ModifyActivityStreamOutput struct {

	// Indicates whether engine-native audit fields are included in the database
	// activity stream.
	EngineNativeAuditFieldsIncluded *bool `type:"boolean"`

	// The name of the Amazon Kinesis data stream to be used for the database activity
	// stream.
	KinesisStreamName *string `type:"string"`

	// The Amazon Web Services KMS key identifier for encryption of messages in
	// the database activity stream.
	KmsKeyId *string `type:"string"`

	// The mode of the database activity stream.
	Mode *string `type:"string" enum:"ActivityStreamMode"`

	// The status of the modification to the policy state of the database activity
	// stream.
	PolicyStatus *string `type:"string" enum:"ActivityStreamPolicyStatus"`

	// The status of the modification to the database activity stream.
	Status *string `type:"string" enum:"ActivityStreamStatus"`
	// contains filtered or unexported fields
}

func (ModifyActivityStreamOutput) GoString added in v1.44.61

func (s ModifyActivityStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyActivityStreamOutput) SetEngineNativeAuditFieldsIncluded added in v1.44.61

func (s *ModifyActivityStreamOutput) SetEngineNativeAuditFieldsIncluded(v bool) *ModifyActivityStreamOutput

SetEngineNativeAuditFieldsIncluded sets the EngineNativeAuditFieldsIncluded field's value.

func (*ModifyActivityStreamOutput) SetKinesisStreamName added in v1.44.61

func (s *ModifyActivityStreamOutput) SetKinesisStreamName(v string) *ModifyActivityStreamOutput

SetKinesisStreamName sets the KinesisStreamName field's value.

func (*ModifyActivityStreamOutput) SetKmsKeyId added in v1.44.61

SetKmsKeyId sets the KmsKeyId field's value.

func (*ModifyActivityStreamOutput) SetMode added in v1.44.61

SetMode sets the Mode field's value.

func (*ModifyActivityStreamOutput) SetPolicyStatus added in v1.44.61

SetPolicyStatus sets the PolicyStatus field's value.

func (*ModifyActivityStreamOutput) SetStatus added in v1.44.61

SetStatus sets the Status field's value.

func (ModifyActivityStreamOutput) String added in v1.44.61

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyCertificatesInput added in v1.28.0

type ModifyCertificatesInput struct {

	// The new default certificate identifier to override the current one with.
	//
	// To determine the valid values, use the describe-certificates CLI command
	// or the DescribeCertificates API operation.
	CertificateIdentifier *string `type:"string"`

	// A value that indicates whether to remove the override for the default certificate.
	// If the override is removed, the default certificate is the system default.
	RemoveCustomerOverride *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (ModifyCertificatesInput) GoString added in v1.28.0

func (s ModifyCertificatesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyCertificatesInput) SetCertificateIdentifier added in v1.28.0

func (s *ModifyCertificatesInput) SetCertificateIdentifier(v string) *ModifyCertificatesInput

SetCertificateIdentifier sets the CertificateIdentifier field's value.

func (*ModifyCertificatesInput) SetRemoveCustomerOverride added in v1.28.0

func (s *ModifyCertificatesInput) SetRemoveCustomerOverride(v bool) *ModifyCertificatesInput

SetRemoveCustomerOverride sets the RemoveCustomerOverride field's value.

func (ModifyCertificatesInput) String added in v1.28.0

func (s ModifyCertificatesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyCertificatesOutput added in v1.28.0

type ModifyCertificatesOutput struct {

	// A CA certificate for an Amazon Web Services account.
	Certificate *Certificate `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyCertificatesOutput) GoString added in v1.28.0

func (s ModifyCertificatesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyCertificatesOutput) SetCertificate added in v1.28.0

SetCertificate sets the Certificate field's value.

func (ModifyCertificatesOutput) String added in v1.28.0

func (s ModifyCertificatesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyCurrentDBClusterCapacityInput added in v1.15.9

type ModifyCurrentDBClusterCapacityInput struct {

	// The DB cluster capacity.
	//
	// When you change the capacity of a paused Aurora Serverless v1 DB cluster,
	// it automatically resumes.
	//
	// Constraints:
	//
	//    * For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64,
	//    128, and 256.
	//
	//    * For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64,
	//    192, and 384.
	Capacity *int64 `type:"integer"`

	// The DB cluster identifier for the cluster being modified. This parameter
	// isn't case-sensitive.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DB cluster.
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The amount of time, in seconds, that Aurora Serverless v1 tries to find a
	// scaling point to perform seamless scaling before enforcing the timeout action.
	// The default is 300.
	//
	// Specify a value between 10 and 600 seconds.
	SecondsBeforeTimeout *int64 `type:"integer"`

	// The action to take when the timeout is reached, either ForceApplyCapacityChange
	// or RollbackCapacityChange.
	//
	// ForceApplyCapacityChange, the default, sets the capacity to the specified
	// value as soon as possible.
	//
	// RollbackCapacityChange ignores the capacity change if a scaling point isn't
	// found in the timeout period.
	TimeoutAction *string `type:"string"`
	// contains filtered or unexported fields
}

func (ModifyCurrentDBClusterCapacityInput) GoString added in v1.15.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyCurrentDBClusterCapacityInput) SetCapacity added in v1.15.9

SetCapacity sets the Capacity field's value.

func (*ModifyCurrentDBClusterCapacityInput) SetDBClusterIdentifier added in v1.15.9

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*ModifyCurrentDBClusterCapacityInput) SetSecondsBeforeTimeout added in v1.15.9

SetSecondsBeforeTimeout sets the SecondsBeforeTimeout field's value.

func (*ModifyCurrentDBClusterCapacityInput) SetTimeoutAction added in v1.15.9

SetTimeoutAction sets the TimeoutAction field's value.

func (ModifyCurrentDBClusterCapacityInput) String added in v1.15.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyCurrentDBClusterCapacityInput) Validate added in v1.15.9

Validate inspects the fields of the type to determine if they are valid.

type ModifyCurrentDBClusterCapacityOutput added in v1.15.9

type ModifyCurrentDBClusterCapacityOutput struct {

	// The current capacity of the DB cluster.
	CurrentCapacity *int64 `type:"integer"`

	// A user-supplied DB cluster identifier. This identifier is the unique key
	// that identifies a DB cluster.
	DBClusterIdentifier *string `type:"string"`

	// A value that specifies the capacity that the DB cluster scales to next.
	PendingCapacity *int64 `type:"integer"`

	// The number of seconds before a call to ModifyCurrentDBClusterCapacity times
	// out.
	SecondsBeforeTimeout *int64 `type:"integer"`

	// The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange
	// or RollbackCapacityChange.
	TimeoutAction *string `type:"string"`
	// contains filtered or unexported fields
}

func (ModifyCurrentDBClusterCapacityOutput) GoString added in v1.15.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyCurrentDBClusterCapacityOutput) SetCurrentCapacity added in v1.15.9

SetCurrentCapacity sets the CurrentCapacity field's value.

func (*ModifyCurrentDBClusterCapacityOutput) SetDBClusterIdentifier added in v1.15.9

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*ModifyCurrentDBClusterCapacityOutput) SetPendingCapacity added in v1.15.9

SetPendingCapacity sets the PendingCapacity field's value.

func (*ModifyCurrentDBClusterCapacityOutput) SetSecondsBeforeTimeout added in v1.15.9

SetSecondsBeforeTimeout sets the SecondsBeforeTimeout field's value.

func (*ModifyCurrentDBClusterCapacityOutput) SetTimeoutAction added in v1.15.9

SetTimeoutAction sets the TimeoutAction field's value.

func (ModifyCurrentDBClusterCapacityOutput) String added in v1.15.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyCustomDBEngineVersionInput added in v1.41.10

type ModifyCustomDBEngineVersionInput struct {

	// An optional description of your CEV.
	Description *string `min:"1" type:"string"`

	// The DB engine. The only supported value is custom-oracle-ee.
	//
	// Engine is a required field
	Engine *string `min:"1" type:"string" required:"true"`

	// The custom engine version (CEV) that you want to modify. This option is required
	// for RDS Custom for Oracle, but optional for Amazon RDS. The combination of
	// Engine and EngineVersion is unique per customer per Amazon Web Services Region.
	//
	// EngineVersion is a required field
	EngineVersion *string `min:"1" type:"string" required:"true"`

	// The availability status to be assigned to the CEV. Valid values are as follows:
	//
	// available
	//
	// You can use this CEV to create a new RDS Custom DB instance.
	//
	// inactive
	//
	// You can create a new RDS Custom instance by restoring a DB snapshot with
	// this CEV. You can't patch or create new instances with this CEV.
	//
	// You can change any status to any status. A typical reason to change status
	// is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible
	// for use again. For example, you might change the status of your CEV from
	// available to inactive, and from inactive back to available. To change the
	// availability status of the CEV, it must not currently be in use by an RDS
	// Custom instance, snapshot, or automated backup.
	Status *string `type:"string" enum:"CustomEngineVersionStatus"`
	// contains filtered or unexported fields
}

func (ModifyCustomDBEngineVersionInput) GoString added in v1.41.10

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyCustomDBEngineVersionInput) SetDescription added in v1.41.10

SetDescription sets the Description field's value.

func (*ModifyCustomDBEngineVersionInput) SetEngine added in v1.41.10

SetEngine sets the Engine field's value.

func (*ModifyCustomDBEngineVersionInput) SetEngineVersion added in v1.41.10

SetEngineVersion sets the EngineVersion field's value.

func (*ModifyCustomDBEngineVersionInput) SetStatus added in v1.41.10

SetStatus sets the Status field's value.

func (ModifyCustomDBEngineVersionInput) String added in v1.41.10

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyCustomDBEngineVersionInput) Validate added in v1.41.10

Validate inspects the fields of the type to determine if they are valid.

type ModifyCustomDBEngineVersionOutput added in v1.41.10

type ModifyCustomDBEngineVersionOutput struct {

	// The creation time of the DB engine version.
	CreateTime *time.Time `type:"timestamp"`

	// The description of the database engine.
	DBEngineDescription *string `type:"string"`

	// The ARN of the custom engine version.
	DBEngineVersionArn *string `type:"string"`

	// The description of the database engine version.
	DBEngineVersionDescription *string `type:"string"`

	// The name of the DB parameter group family for the database engine.
	DBParameterGroupFamily *string `type:"string"`

	// The name of the Amazon S3 bucket that contains your database installation
	// files.
	DatabaseInstallationFilesS3BucketName *string `type:"string"`

	// The Amazon S3 directory that contains the database installation files. If
	// not specified, then no prefix is assumed.
	DatabaseInstallationFilesS3Prefix *string `type:"string"`

	// The default character set for new instances of this engine version, if the
	// CharacterSetName parameter of the CreateDBInstance API isn't specified.
	DefaultCharacterSet *CharacterSet `type:"structure"`

	// The name of the database engine.
	Engine *string `type:"string"`

	// The version number of the database engine.
	EngineVersion *string `type:"string"`

	// The types of logs that the database engine has available for export to CloudWatch
	// Logs.
	ExportableLogTypes []*string `type:"list"`

	// The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter
	// is required for RDS Custom, but optional for Amazon RDS.
	KMSKeyId *string `type:"string"`

	// The major engine version of the CEV.
	MajorEngineVersion *string `type:"string"`

	// The status of the DB engine version, either available or deprecated.
	Status *string `type:"string"`

	// A list of the character sets supported by this engine for the CharacterSetName
	// parameter of the CreateDBInstance operation.
	SupportedCharacterSets []*CharacterSet `locationNameList:"CharacterSet" type:"list"`

	// A list of the supported DB engine modes.
	SupportedEngineModes []*string `type:"list"`

	// A list of features supported by the DB engine.
	//
	// The supported features vary by DB engine and DB engine version.
	//
	// To determine the supported features for a specific DB engine and DB engine
	// version using the CLI, use the following command:
	//
	// aws rds describe-db-engine-versions --engine <engine_name> --engine-version
	// <engine_version>
	//
	// For example, to determine the supported features for RDS for PostgreSQL version
	// 13.3 using the CLI, use the following command:
	//
	// aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
	//
	// The supported features are listed under SupportedFeatureNames in the output.
	SupportedFeatureNames []*string `type:"list"`

	// A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName
	// parameter of the CreateDBInstance operation.
	SupportedNcharCharacterSets []*CharacterSet `locationNameList:"CharacterSet" type:"list"`

	// A list of the time zones supported by this engine for the Timezone parameter
	// of the CreateDBInstance action.
	SupportedTimezones []*Timezone `locationNameList:"Timezone" type:"list"`

	// A value that indicates whether the engine version supports Babelfish for
	// Aurora PostgreSQL.
	SupportsBabelfish *bool `type:"boolean"`

	// A value that indicates whether you can use Aurora global databases with a
	// specific DB engine version.
	SupportsGlobalDatabases *bool `type:"boolean"`

	// A value that indicates whether the engine version supports exporting the
	// log types specified by ExportableLogTypes to CloudWatch Logs.
	SupportsLogExportsToCloudwatchLogs *bool `type:"boolean"`

	// A value that indicates whether you can use Aurora parallel query with a specific
	// DB engine version.
	SupportsParallelQuery *bool `type:"boolean"`

	// Indicates whether the database engine version supports read replicas.
	SupportsReadReplica *bool `type:"boolean"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	TagList []*Tag `locationNameList:"Tag" type:"list"`

	// A list of engine versions that this database engine version can be upgraded
	// to.
	ValidUpgradeTarget []*UpgradeTarget `locationNameList:"UpgradeTarget" type:"list"`
	// contains filtered or unexported fields
}

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

func (ModifyCustomDBEngineVersionOutput) GoString added in v1.41.10

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyCustomDBEngineVersionOutput) SetCreateTime added in v1.41.10

SetCreateTime sets the CreateTime field's value.

func (*ModifyCustomDBEngineVersionOutput) SetDBEngineDescription added in v1.41.10

SetDBEngineDescription sets the DBEngineDescription field's value.

func (*ModifyCustomDBEngineVersionOutput) SetDBEngineVersionArn added in v1.41.10

SetDBEngineVersionArn sets the DBEngineVersionArn field's value.

func (*ModifyCustomDBEngineVersionOutput) SetDBEngineVersionDescription added in v1.41.10

func (s *ModifyCustomDBEngineVersionOutput) SetDBEngineVersionDescription(v string) *ModifyCustomDBEngineVersionOutput

SetDBEngineVersionDescription sets the DBEngineVersionDescription field's value.

func (*ModifyCustomDBEngineVersionOutput) SetDBParameterGroupFamily added in v1.41.10

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*ModifyCustomDBEngineVersionOutput) SetDatabaseInstallationFilesS3BucketName added in v1.41.10

func (s *ModifyCustomDBEngineVersionOutput) SetDatabaseInstallationFilesS3BucketName(v string) *ModifyCustomDBEngineVersionOutput

SetDatabaseInstallationFilesS3BucketName sets the DatabaseInstallationFilesS3BucketName field's value.

func (*ModifyCustomDBEngineVersionOutput) SetDatabaseInstallationFilesS3Prefix added in v1.41.10

func (s *ModifyCustomDBEngineVersionOutput) SetDatabaseInstallationFilesS3Prefix(v string) *ModifyCustomDBEngineVersionOutput

SetDatabaseInstallationFilesS3Prefix sets the DatabaseInstallationFilesS3Prefix field's value.

func (*ModifyCustomDBEngineVersionOutput) SetDefaultCharacterSet added in v1.41.10

SetDefaultCharacterSet sets the DefaultCharacterSet field's value.

func (*ModifyCustomDBEngineVersionOutput) SetEngine added in v1.41.10

SetEngine sets the Engine field's value.

func (*ModifyCustomDBEngineVersionOutput) SetEngineVersion added in v1.41.10

SetEngineVersion sets the EngineVersion field's value.

func (*ModifyCustomDBEngineVersionOutput) SetExportableLogTypes added in v1.41.10

SetExportableLogTypes sets the ExportableLogTypes field's value.

func (*ModifyCustomDBEngineVersionOutput) SetKMSKeyId added in v1.41.10

SetKMSKeyId sets the KMSKeyId field's value.

func (*ModifyCustomDBEngineVersionOutput) SetMajorEngineVersion added in v1.41.10

SetMajorEngineVersion sets the MajorEngineVersion field's value.

func (*ModifyCustomDBEngineVersionOutput) SetStatus added in v1.41.10

SetStatus sets the Status field's value.

func (*ModifyCustomDBEngineVersionOutput) SetSupportedCharacterSets added in v1.41.10

SetSupportedCharacterSets sets the SupportedCharacterSets field's value.

func (*ModifyCustomDBEngineVersionOutput) SetSupportedEngineModes added in v1.41.10

SetSupportedEngineModes sets the SupportedEngineModes field's value.

func (*ModifyCustomDBEngineVersionOutput) SetSupportedFeatureNames added in v1.41.10

SetSupportedFeatureNames sets the SupportedFeatureNames field's value.

func (*ModifyCustomDBEngineVersionOutput) SetSupportedNcharCharacterSets added in v1.41.10

func (s *ModifyCustomDBEngineVersionOutput) SetSupportedNcharCharacterSets(v []*CharacterSet) *ModifyCustomDBEngineVersionOutput

SetSupportedNcharCharacterSets sets the SupportedNcharCharacterSets field's value.

func (*ModifyCustomDBEngineVersionOutput) SetSupportedTimezones added in v1.41.10

SetSupportedTimezones sets the SupportedTimezones field's value.

func (*ModifyCustomDBEngineVersionOutput) SetSupportsBabelfish added in v1.42.53

SetSupportsBabelfish sets the SupportsBabelfish field's value.

func (*ModifyCustomDBEngineVersionOutput) SetSupportsGlobalDatabases added in v1.41.10

SetSupportsGlobalDatabases sets the SupportsGlobalDatabases field's value.

func (*ModifyCustomDBEngineVersionOutput) SetSupportsLogExportsToCloudwatchLogs added in v1.41.10

func (s *ModifyCustomDBEngineVersionOutput) SetSupportsLogExportsToCloudwatchLogs(v bool) *ModifyCustomDBEngineVersionOutput

SetSupportsLogExportsToCloudwatchLogs sets the SupportsLogExportsToCloudwatchLogs field's value.

func (*ModifyCustomDBEngineVersionOutput) SetSupportsParallelQuery added in v1.41.10

SetSupportsParallelQuery sets the SupportsParallelQuery field's value.

func (*ModifyCustomDBEngineVersionOutput) SetSupportsReadReplica added in v1.41.10

SetSupportsReadReplica sets the SupportsReadReplica field's value.

func (*ModifyCustomDBEngineVersionOutput) SetTagList added in v1.41.10

SetTagList sets the TagList field's value.

func (*ModifyCustomDBEngineVersionOutput) SetValidUpgradeTarget added in v1.41.10

SetValidUpgradeTarget sets the ValidUpgradeTarget field's value.

func (ModifyCustomDBEngineVersionOutput) String added in v1.41.10

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyDBClusterEndpointInput added in v1.15.74

type ModifyDBClusterEndpointInput struct {

	// The identifier of the endpoint to modify. This parameter is stored as a lowercase
	// string.
	//
	// DBClusterEndpointIdentifier is a required field
	DBClusterEndpointIdentifier *string `type:"string" required:"true"`

	// The type of the endpoint. One of: READER, WRITER, ANY.
	EndpointType *string `type:"string"`

	// List of DB instance identifiers that aren't part of the custom endpoint group.
	// All other eligible instances are reachable through the custom endpoint. Only
	// relevant if the list of static members is empty.
	ExcludedMembers []*string `type:"list"`

	// List of DB instance identifiers that are part of the custom endpoint group.
	StaticMembers []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ModifyDBClusterEndpointInput) GoString added in v1.15.74

func (s ModifyDBClusterEndpointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBClusterEndpointInput) SetDBClusterEndpointIdentifier added in v1.15.74

func (s *ModifyDBClusterEndpointInput) SetDBClusterEndpointIdentifier(v string) *ModifyDBClusterEndpointInput

SetDBClusterEndpointIdentifier sets the DBClusterEndpointIdentifier field's value.

func (*ModifyDBClusterEndpointInput) SetEndpointType added in v1.15.74

SetEndpointType sets the EndpointType field's value.

func (*ModifyDBClusterEndpointInput) SetExcludedMembers added in v1.15.74

SetExcludedMembers sets the ExcludedMembers field's value.

func (*ModifyDBClusterEndpointInput) SetStaticMembers added in v1.15.74

SetStaticMembers sets the StaticMembers field's value.

func (ModifyDBClusterEndpointInput) String added in v1.15.74

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBClusterEndpointInput) Validate added in v1.15.74

func (s *ModifyDBClusterEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyDBClusterEndpointOutput added in v1.15.74

type ModifyDBClusterEndpointOutput struct {

	// The type associated with a custom endpoint. One of: READER, WRITER, ANY.
	CustomEndpointType *string `type:"string"`

	// The Amazon Resource Name (ARN) for the endpoint.
	DBClusterEndpointArn *string `type:"string"`

	// The identifier associated with the endpoint. This parameter is stored as
	// a lowercase string.
	DBClusterEndpointIdentifier *string `type:"string"`

	// A unique system-generated identifier for an endpoint. It remains the same
	// for the whole life of the endpoint.
	DBClusterEndpointResourceIdentifier *string `type:"string"`

	// The DB cluster identifier of the DB cluster associated with the endpoint.
	// This parameter is stored as a lowercase string.
	DBClusterIdentifier *string `type:"string"`

	// The DNS address of the endpoint.
	Endpoint *string `type:"string"`

	// The type of the endpoint. One of: READER, WRITER, CUSTOM.
	EndpointType *string `type:"string"`

	// List of DB instance identifiers that aren't part of the custom endpoint group.
	// All other eligible instances are reachable through the custom endpoint. Only
	// relevant if the list of static members is empty.
	ExcludedMembers []*string `type:"list"`

	// List of DB instance identifiers that are part of the custom endpoint group.
	StaticMembers []*string `type:"list"`

	// The current status of the endpoint. One of: creating, available, deleting,
	// inactive, modifying. The inactive state applies to an endpoint that can't
	// be used for a certain kind of cluster, such as a writer endpoint for a read-only
	// secondary cluster in a global database.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

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

  • CreateDBClusterEndpoint

  • DescribeDBClusterEndpoints

  • ModifyDBClusterEndpoint

  • DeleteDBClusterEndpoint

For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

func (ModifyDBClusterEndpointOutput) GoString added in v1.15.74

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBClusterEndpointOutput) SetCustomEndpointType added in v1.15.74

SetCustomEndpointType sets the CustomEndpointType field's value.

func (*ModifyDBClusterEndpointOutput) SetDBClusterEndpointArn added in v1.15.74

SetDBClusterEndpointArn sets the DBClusterEndpointArn field's value.

func (*ModifyDBClusterEndpointOutput) SetDBClusterEndpointIdentifier added in v1.15.74

func (s *ModifyDBClusterEndpointOutput) SetDBClusterEndpointIdentifier(v string) *ModifyDBClusterEndpointOutput

SetDBClusterEndpointIdentifier sets the DBClusterEndpointIdentifier field's value.

func (*ModifyDBClusterEndpointOutput) SetDBClusterEndpointResourceIdentifier added in v1.15.74

func (s *ModifyDBClusterEndpointOutput) SetDBClusterEndpointResourceIdentifier(v string) *ModifyDBClusterEndpointOutput

SetDBClusterEndpointResourceIdentifier sets the DBClusterEndpointResourceIdentifier field's value.

func (*ModifyDBClusterEndpointOutput) SetDBClusterIdentifier added in v1.15.74

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*ModifyDBClusterEndpointOutput) SetEndpoint added in v1.15.74

SetEndpoint sets the Endpoint field's value.

func (*ModifyDBClusterEndpointOutput) SetEndpointType added in v1.15.74

SetEndpointType sets the EndpointType field's value.

func (*ModifyDBClusterEndpointOutput) SetExcludedMembers added in v1.15.74

SetExcludedMembers sets the ExcludedMembers field's value.

func (*ModifyDBClusterEndpointOutput) SetStaticMembers added in v1.15.74

SetStaticMembers sets the StaticMembers field's value.

func (*ModifyDBClusterEndpointOutput) SetStatus added in v1.15.74

SetStatus sets the Status field's value.

func (ModifyDBClusterEndpointOutput) String added in v1.15.74

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyDBClusterInput added in v0.7.1

type ModifyDBClusterInput struct {

	// The amount of storage in gibibytes (GiB) to allocate to each DB instance
	// in the Multi-AZ DB cluster.
	//
	// Type: Integer
	//
	// Valid for: Multi-AZ DB clusters only
	AllocatedStorage *int64 `type:"integer"`

	// A value that indicates whether major version upgrades are allowed.
	//
	// Constraints: You must allow major version upgrades when specifying a value
	// for the EngineVersion parameter that is a different major version than the
	// DB cluster's current version.
	//
	// Valid for: Aurora DB clusters only
	AllowMajorVersionUpgrade *bool `type:"boolean"`

	// A value that indicates whether the modifications in this request and any
	// pending modifications are asynchronously applied as soon as possible, regardless
	// of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter
	// is disabled, changes to the DB cluster are applied during the next maintenance
	// window.
	//
	// The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication,
	// MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately
	// parameter is disabled, then changes to the EnableIAMDatabaseAuthentication,
	// MasterUserPassword, and NewDBClusterIdentifier values are applied during
	// the next maintenance window. All other changes are applied immediately, regardless
	// of the value of the ApplyImmediately parameter.
	//
	// By default, this parameter is disabled.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	ApplyImmediately *bool `type:"boolean"`

	// A value that indicates whether minor engine upgrades are applied automatically
	// to the DB cluster during the maintenance window. By default, minor engine
	// upgrades are applied automatically.
	//
	// Valid for: Multi-AZ DB clusters only
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// The target backtrack window, in seconds. To disable backtracking, set this
	// value to 0.
	//
	// Default: 0
	//
	// Constraints:
	//
	//    * If specified, this value must be set to a number from 0 to 259,200 (72
	//    hours).
	//
	// Valid for: Aurora MySQL DB clusters only
	BacktrackWindow *int64 `type:"long"`

	// The number of days for which automated backups are retained. Specify a minimum
	// value of 1.
	//
	// Default: 1
	//
	// Constraints:
	//
	//    * Must be a value from 1 to 35
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	BackupRetentionPeriod *int64 `type:"integer"`

	// The configuration setting for the log types to be enabled for export to CloudWatch
	// Logs for a specific DB cluster. The values in the list depend on the DB engine
	// being used.
	//
	// RDS for MySQL
	//
	// Possible values are error, general, and slowquery.
	//
	// RDS for PostgreSQL
	//
	// Possible values are postgresql and upgrade.
	//
	// Aurora MySQL
	//
	// Possible values are audit, error, general, and slowquery.
	//
	// Aurora PostgreSQL
	//
	// Possible value is postgresql.
	//
	// For more information about exporting CloudWatch Logs for Amazon RDS, see
	// Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
	// in the Amazon RDS User Guide.
	//
	// For more information about exporting CloudWatch Logs for Amazon Aurora, see
	// Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
	// in the Amazon Aurora User Guide.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	CloudwatchLogsExportConfiguration *CloudwatchLogsExportConfiguration `type:"structure"`

	// A value that indicates whether to copy all tags from the DB cluster to snapshots
	// of the DB cluster. The default is not to copy them.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	CopyTagsToSnapshot *bool `type:"boolean"`

	// The DB cluster identifier for the cluster being modified. This parameter
	// isn't case-sensitive.
	//
	// Constraints: This identifier must match the identifier of an existing DB
	// cluster.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The compute and memory capacity of each DB instance in the Multi-AZ DB cluster,
	// for example db.m6g.xlarge. Not all DB instance classes are available in all
	// Amazon Web Services Regions, or for all database engines.
	//
	// For the full list of DB instance classes and availability for your engine,
	// see DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)
	// in the Amazon RDS User Guide.
	//
	// Valid for: Multi-AZ DB clusters only
	DBClusterInstanceClass *string `type:"string"`

	// The name of the DB cluster parameter group to use for the DB cluster.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	DBClusterParameterGroupName *string `type:"string"`

	// The name of the DB parameter group to apply to all instances of the DB cluster.
	//
	// When you apply a parameter group using the DBInstanceParameterGroupName parameter,
	// the DB cluster isn't rebooted automatically. Also, parameter changes are
	// applied immediately rather than during the next maintenance window.
	//
	// Default: The existing name setting
	//
	// Constraints:
	//
	//    * The DB parameter group must be in the same DB parameter group family
	//    as this DB cluster.
	//
	//    * The DBInstanceParameterGroupName parameter is valid in combination with
	//    the AllowMajorVersionUpgrade parameter for a major version upgrade only.
	//
	// Valid for: Aurora DB clusters only
	DBInstanceParameterGroupName *string `type:"string"`

	// A value that indicates whether the DB cluster has deletion protection enabled.
	// The database can't be deleted when deletion protection is enabled. By default,
	// deletion protection isn't enabled.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	DeletionProtection *bool `type:"boolean"`

	// The Active Directory directory ID to move the DB cluster to. Specify none
	// to remove the cluster from its current domain. The domain must be created
	// prior to this operation.
	//
	// For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html)
	// in the Amazon Aurora User Guide.
	//
	// Valid for: Aurora DB clusters only
	Domain *string `type:"string"`

	// Specify the name of the IAM role to be used when making API calls to the
	// Directory Service.
	//
	// Valid for: Aurora DB clusters only
	DomainIAMRoleName *string `type:"string"`

	// A value that indicates whether to enable this DB cluster to forward write
	// operations to the primary cluster of an Aurora global database (GlobalCluster).
	// By default, write operations are not allowed on Aurora DB clusters that are
	// secondary clusters in an Aurora global database.
	//
	// You can set this value only on Aurora DB clusters that are members of an
	// Aurora global database. With this parameter enabled, a secondary cluster
	// can forward writes to the current primary cluster and the resulting changes
	// are replicated back to this cluster. For the primary DB cluster of an Aurora
	// global database, this value is used immediately if the primary is demoted
	// by the FailoverGlobalCluster API operation, but it does nothing until then.
	//
	// Valid for: Aurora DB clusters only
	EnableGlobalWriteForwarding *bool `type:"boolean"`

	// A value that indicates whether to enable the HTTP endpoint for an Aurora
	// Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.
	//
	// When enabled, the HTTP endpoint provides a connectionless web service API
	// for running SQL queries on the Aurora Serverless v1 DB cluster. You can also
	// query your database from inside the RDS console with the query editor.
	//
	// For more information, see Using the Data API for Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html)
	// in the Amazon Aurora User Guide.
	//
	// Valid for: Aurora DB clusters only
	EnableHttpEndpoint *bool `type:"boolean"`

	// A value that indicates whether to enable mapping of Amazon Web Services Identity
	// and Access Management (IAM) accounts to database accounts. By default, mapping
	// isn't enabled.
	//
	// For more information, see IAM Database Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html)
	// in the Amazon Aurora User Guide.
	//
	// Valid for: Aurora DB clusters only
	EnableIAMDatabaseAuthentication *bool `type:"boolean"`

	// A value that indicates whether to turn on Performance Insights for the DB
	// cluster.
	//
	// For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)
	// in the Amazon RDS User Guide.
	//
	// Valid for: Multi-AZ DB clusters only
	EnablePerformanceInsights *bool `type:"boolean"`

	// The version number of the database engine to which you want to upgrade. Changing
	// this parameter results in an outage. The change is applied during the next
	// maintenance window unless ApplyImmediately is enabled.
	//
	// To list all of the available engine versions for MySQL 5.6-compatible Aurora,
	// use the following command:
	//
	// aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
	//
	// To list all of the available engine versions for MySQL 5.7-compatible and
	// MySQL 8.0-compatible Aurora, use the following command:
	//
	// aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
	//
	// To list all of the available engine versions for Aurora PostgreSQL, use the
	// following command:
	//
	// aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
	//
	// To list all of the available engine versions for RDS for MySQL, use the following
	// command:
	//
	// aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
	//
	// To list all of the available engine versions for RDS for PostgreSQL, use
	// the following command:
	//
	// aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	EngineVersion *string `type:"string"`

	// The amount of Provisioned IOPS (input/output operations per second) to be
	// initially allocated for each DB instance in the Multi-AZ DB cluster.
	//
	// For information about valid Iops values, see Amazon RDS Provisioned IOPS
	// Storage to Improve Performance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS)
	// in the Amazon RDS User Guide.
	//
	// Constraints: Must be a multiple between .5 and 50 of the storage amount for
	// the DB cluster.
	//
	// Valid for: Multi-AZ DB clusters only
	Iops *int64 `type:"integer"`

	// The new password for the master database user. This password can contain
	// any printable ASCII character except "/", """, or "@".
	//
	// Constraints: Must contain from 8 to 41 characters.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	MasterUserPassword *string `type:"string"`

	// The interval, in seconds, between points when Enhanced Monitoring metrics
	// are collected for the DB cluster. To turn off collecting Enhanced Monitoring
	// metrics, specify 0. The default is 0.
	//
	// If MonitoringRoleArn is specified, also set MonitoringInterval to a value
	// other than 0.
	//
	// Valid Values: 0, 1, 5, 10, 15, 30, 60
	//
	// Valid for: Multi-AZ DB clusters only
	MonitoringInterval *int64 `type:"integer"`

	// The Amazon Resource Name (ARN) for the IAM role that permits RDS to send
	// Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess.
	// For information on creating a monitoring role, see To create an IAM role
	// for Amazon RDS Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole)
	// in the Amazon RDS User Guide.
	//
	// If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn
	// value.
	//
	// Valid for: Multi-AZ DB clusters only
	MonitoringRoleArn *string `type:"string"`

	// The network type of the DB cluster.
	//
	// Valid values:
	//
	//    * IPV4
	//
	//    * DUAL
	//
	// The network type is determined by the DBSubnetGroup specified for the DB
	// cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and
	// the IPv6 protocols (DUAL).
	//
	// For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
	// in the Amazon Aurora User Guide.
	//
	// Valid for: Aurora DB clusters only
	NetworkType *string `type:"string"`

	// The new DB cluster identifier for the DB cluster when renaming a DB cluster.
	// This value is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 letters, numbers, or hyphens
	//
	//    * The first character must be a letter
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens
	//
	// Example: my-cluster2
	//
	// Valid for: Aurora DB clusters only
	NewDBClusterIdentifier *string `type:"string"`

	// A value that indicates that the DB cluster should be associated with the
	// specified option group.
	//
	// DB clusters are associated with a default option group that can't be modified.
	OptionGroupName *string `type:"string"`

	// The Amazon Web Services KMS key identifier for encryption of Performance
	// Insights data.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key.
	//
	// If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon
	// RDS uses your default KMS key. There is a default KMS key for your Amazon
	// Web Services account. Your Amazon Web Services account has a different default
	// KMS key for each Amazon Web Services Region.
	//
	// Valid for: Multi-AZ DB clusters only
	PerformanceInsightsKMSKeyId *string `type:"string"`

	// The number of days to retain Performance Insights data. The default is 7
	// days. The following values are valid:
	//
	//    * 7
	//
	//    * month * 31, where month is a number of months from 1-23
	//
	//    * 731
	//
	// For example, the following values are valid:
	//
	//    * 93 (3 months * 31)
	//
	//    * 341 (11 months * 31)
	//
	//    * 589 (19 months * 31)
	//
	//    * 731
	//
	// If you specify a retention period such as 94, which isn't a valid value,
	// RDS issues an error.
	//
	// Valid for: Multi-AZ DB clusters only
	PerformanceInsightsRetentionPeriod *int64 `type:"integer"`

	// The port number on which the DB cluster accepts connections.
	//
	// Constraints: Value must be 1150-65535
	//
	// Default: The same port as the original DB cluster.
	//
	// Valid for: Aurora DB clusters only
	Port *int64 `type:"integer"`

	// The daily time range during which automated backups are created if automated
	// backups are enabled, using the BackupRetentionPeriod parameter.
	//
	// The default is a 30-minute window selected at random from an 8-hour block
	// of time for each Amazon Web Services Region. To view the time blocks available,
	// see Backup window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow)
	// in the Amazon Aurora User Guide.
	//
	// Constraints:
	//
	//    * Must be in the format hh24:mi-hh24:mi.
	//
	//    * Must be in Universal Coordinated Time (UTC).
	//
	//    * Must not conflict with the preferred maintenance window.
	//
	//    * Must be at least 30 minutes.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	PreferredBackupWindow *string `type:"string"`

	// The weekly time range during which system maintenance can occur, in Universal
	// Coordinated Time (UTC).
	//
	// Format: ddd:hh24:mi-ddd:hh24:mi
	//
	// The default is a 30-minute window selected at random from an 8-hour block
	// of time for each Amazon Web Services Region, occurring on a random day of
	// the week. To see the time blocks available, see Adjusting the Preferred DB
	// Cluster Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora)
	// in the Amazon Aurora User Guide.
	//
	// Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
	//
	// Constraints: Minimum 30-minute window.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	PreferredMaintenanceWindow *string `type:"string"`

	// The scaling properties of the DB cluster. You can only modify scaling properties
	// for DB clusters in serverless DB engine mode.
	//
	// Valid for: Aurora DB clusters only
	ScalingConfiguration *ScalingConfiguration `type:"structure"`

	// Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
	//
	// For more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html)
	// in the Amazon Aurora User Guide.
	ServerlessV2ScalingConfiguration *ServerlessV2ScalingConfiguration `type:"structure"`

	// Specifies the storage type to be associated with the DB cluster.
	//
	// Valid values: io1
	//
	// When specified, a value for the Iops parameter is required.
	//
	// Default: io1
	//
	// Valid for: Multi-AZ DB clusters only
	StorageType *string `type:"string"`

	// A list of VPC security groups that the DB cluster will belong to.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"`
	// contains filtered or unexported fields
}

func (ModifyDBClusterInput) GoString added in v0.7.1

func (s ModifyDBClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBClusterInput) SetAllocatedStorage added in v1.42.11

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

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*ModifyDBClusterInput) SetAllowMajorVersionUpgrade added in v1.20.13

func (s *ModifyDBClusterInput) SetAllowMajorVersionUpgrade(v bool) *ModifyDBClusterInput

SetAllowMajorVersionUpgrade sets the AllowMajorVersionUpgrade field's value.

func (*ModifyDBClusterInput) SetApplyImmediately added in v1.5.0

func (s *ModifyDBClusterInput) SetApplyImmediately(v bool) *ModifyDBClusterInput

SetApplyImmediately sets the ApplyImmediately field's value.

func (*ModifyDBClusterInput) SetAutoMinorVersionUpgrade added in v1.42.11

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*ModifyDBClusterInput) SetBacktrackWindow added in v1.13.45

func (s *ModifyDBClusterInput) SetBacktrackWindow(v int64) *ModifyDBClusterInput

SetBacktrackWindow sets the BacktrackWindow field's value.

func (*ModifyDBClusterInput) SetBackupRetentionPeriod added in v1.5.0

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*ModifyDBClusterInput) SetCloudwatchLogsExportConfiguration added in v1.13.55

func (s *ModifyDBClusterInput) SetCloudwatchLogsExportConfiguration(v *CloudwatchLogsExportConfiguration) *ModifyDBClusterInput

SetCloudwatchLogsExportConfiguration sets the CloudwatchLogsExportConfiguration field's value.

func (*ModifyDBClusterInput) SetCopyTagsToSnapshot added in v1.17.13

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

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*ModifyDBClusterInput) SetDBClusterIdentifier added in v1.5.0

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*ModifyDBClusterInput) SetDBClusterInstanceClass added in v1.42.11

func (s *ModifyDBClusterInput) SetDBClusterInstanceClass(v string) *ModifyDBClusterInput

SetDBClusterInstanceClass sets the DBClusterInstanceClass field's value.

func (*ModifyDBClusterInput) SetDBClusterParameterGroupName added in v1.5.0

func (s *ModifyDBClusterInput) SetDBClusterParameterGroupName(v string) *ModifyDBClusterInput

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*ModifyDBClusterInput) SetDBInstanceParameterGroupName added in v1.20.13

func (s *ModifyDBClusterInput) SetDBInstanceParameterGroupName(v string) *ModifyDBClusterInput

SetDBInstanceParameterGroupName sets the DBInstanceParameterGroupName field's value.

func (*ModifyDBClusterInput) SetDeletionProtection added in v1.15.43

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

SetDeletionProtection sets the DeletionProtection field's value.

func (*ModifyDBClusterInput) SetDomain added in v1.29.5

SetDomain sets the Domain field's value.

func (*ModifyDBClusterInput) SetDomainIAMRoleName added in v1.29.5

func (s *ModifyDBClusterInput) SetDomainIAMRoleName(v string) *ModifyDBClusterInput

SetDomainIAMRoleName sets the DomainIAMRoleName field's value.

func (*ModifyDBClusterInput) SetEnableGlobalWriteForwarding added in v1.32.5

func (s *ModifyDBClusterInput) SetEnableGlobalWriteForwarding(v bool) *ModifyDBClusterInput

SetEnableGlobalWriteForwarding sets the EnableGlobalWriteForwarding field's value.

func (*ModifyDBClusterInput) SetEnableHttpEndpoint added in v1.15.85

func (s *ModifyDBClusterInput) SetEnableHttpEndpoint(v bool) *ModifyDBClusterInput

SetEnableHttpEndpoint sets the EnableHttpEndpoint field's value.

func (*ModifyDBClusterInput) SetEnableIAMDatabaseAuthentication added in v1.8.17

func (s *ModifyDBClusterInput) SetEnableIAMDatabaseAuthentication(v bool) *ModifyDBClusterInput

SetEnableIAMDatabaseAuthentication sets the EnableIAMDatabaseAuthentication field's value.

func (*ModifyDBClusterInput) SetEnablePerformanceInsights added in v1.42.11

func (s *ModifyDBClusterInput) SetEnablePerformanceInsights(v bool) *ModifyDBClusterInput

SetEnablePerformanceInsights sets the EnablePerformanceInsights field's value.

func (*ModifyDBClusterInput) SetEngineVersion added in v1.13.33

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

SetEngineVersion sets the EngineVersion field's value.

func (*ModifyDBClusterInput) SetIops added in v1.42.11

SetIops sets the Iops field's value.

func (*ModifyDBClusterInput) SetMasterUserPassword added in v1.5.0

func (s *ModifyDBClusterInput) SetMasterUserPassword(v string) *ModifyDBClusterInput

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*ModifyDBClusterInput) SetMonitoringInterval added in v1.42.11

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

SetMonitoringInterval sets the MonitoringInterval field's value.

func (*ModifyDBClusterInput) SetMonitoringRoleArn added in v1.42.11

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

SetMonitoringRoleArn sets the MonitoringRoleArn field's value.

func (*ModifyDBClusterInput) SetNetworkType added in v1.44.79

func (s *ModifyDBClusterInput) SetNetworkType(v string) *ModifyDBClusterInput

SetNetworkType sets the NetworkType field's value.

func (*ModifyDBClusterInput) SetNewDBClusterIdentifier added in v1.5.0

func (s *ModifyDBClusterInput) SetNewDBClusterIdentifier(v string) *ModifyDBClusterInput

SetNewDBClusterIdentifier sets the NewDBClusterIdentifier field's value.

func (*ModifyDBClusterInput) SetOptionGroupName added in v1.5.0

func (s *ModifyDBClusterInput) SetOptionGroupName(v string) *ModifyDBClusterInput

SetOptionGroupName sets the OptionGroupName field's value.

func (*ModifyDBClusterInput) SetPerformanceInsightsKMSKeyId added in v1.42.11

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

SetPerformanceInsightsKMSKeyId sets the PerformanceInsightsKMSKeyId field's value.

func (*ModifyDBClusterInput) SetPerformanceInsightsRetentionPeriod added in v1.42.11

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

SetPerformanceInsightsRetentionPeriod sets the PerformanceInsightsRetentionPeriod field's value.

func (*ModifyDBClusterInput) SetPort added in v1.5.0

SetPort sets the Port field's value.

func (*ModifyDBClusterInput) SetPreferredBackupWindow added in v1.5.0

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*ModifyDBClusterInput) SetPreferredMaintenanceWindow added in v1.5.0

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*ModifyDBClusterInput) SetScalingConfiguration added in v1.15.9

func (s *ModifyDBClusterInput) SetScalingConfiguration(v *ScalingConfiguration) *ModifyDBClusterInput

SetScalingConfiguration sets the ScalingConfiguration field's value.

func (*ModifyDBClusterInput) SetServerlessV2ScalingConfiguration added in v1.43.43

func (s *ModifyDBClusterInput) SetServerlessV2ScalingConfiguration(v *ServerlessV2ScalingConfiguration) *ModifyDBClusterInput

SetServerlessV2ScalingConfiguration sets the ServerlessV2ScalingConfiguration field's value.

func (*ModifyDBClusterInput) SetStorageType added in v1.42.11

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

SetStorageType sets the StorageType field's value.

func (*ModifyDBClusterInput) SetVpcSecurityGroupIds added in v1.5.0

func (s *ModifyDBClusterInput) SetVpcSecurityGroupIds(v []*string) *ModifyDBClusterInput

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (ModifyDBClusterInput) String added in v0.7.1

func (s ModifyDBClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBClusterInput) Validate added in v1.1.21

func (s *ModifyDBClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyDBClusterOutput added in v0.7.1

type ModifyDBClusterOutput struct {

	// Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
	//
	// For an Amazon Aurora DB cluster, this data type is used as a response element
	// in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot,
	// RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
	//
	// For a Multi-AZ DB cluster, this data type is used as a response element in
	// the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
	//
	// For more information on Amazon Aurora DB clusters, see What is Amazon Aurora?
	// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)
	// in the Amazon Aurora User Guide.
	//
	// For more information on Multi-AZ DB clusters, see Multi-AZ deployments with
	// two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
	// in the Amazon RDS User Guide.
	DBCluster *DBCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyDBClusterOutput) GoString added in v0.7.1

func (s ModifyDBClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBClusterOutput) SetDBCluster added in v1.5.0

SetDBCluster sets the DBCluster field's value.

func (ModifyDBClusterOutput) String added in v0.7.1

func (s ModifyDBClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyDBClusterParameterGroupInput added in v0.7.1

type ModifyDBClusterParameterGroupInput struct {

	// The name of the DB cluster parameter group to modify.
	//
	// DBClusterParameterGroupName is a required field
	DBClusterParameterGroupName *string `type:"string" required:"true"`

	// A list of parameters in the DB cluster parameter group to modify.
	//
	// Valid Values (for the application method): immediate | pending-reboot
	//
	// You can use the immediate value with dynamic parameters only. You can use
	// the pending-reboot value for both dynamic and static parameters.
	//
	// When the application method is immediate, changes to dynamic parameters are
	// applied immediately to the DB clusters associated with the parameter group.
	// When the application method is pending-reboot, changes to dynamic and static
	// parameters are applied after a reboot without failover to the DB clusters
	// associated with the parameter group.
	//
	// Parameters is a required field
	Parameters []*Parameter `locationNameList:"Parameter" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ModifyDBClusterParameterGroupInput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBClusterParameterGroupInput) SetDBClusterParameterGroupName added in v1.5.0

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*ModifyDBClusterParameterGroupInput) SetParameters added in v1.5.0

SetParameters sets the Parameters field's value.

func (ModifyDBClusterParameterGroupInput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBClusterParameterGroupInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type ModifyDBClusterSnapshotAttributeInput added in v1.1.30

type ModifyDBClusterSnapshotAttributeInput struct {

	// The name of the DB cluster snapshot attribute to modify.
	//
	// To manage authorization for other Amazon Web Services accounts to copy or
	// restore a manual DB cluster snapshot, set this value to restore.
	//
	// To view the list of attributes available to modify, use the DescribeDBClusterSnapshotAttributes
	// API operation.
	//
	// AttributeName is a required field
	AttributeName *string `type:"string" required:"true"`

	// The identifier for the DB cluster snapshot to modify the attributes for.
	//
	// DBClusterSnapshotIdentifier is a required field
	DBClusterSnapshotIdentifier *string `type:"string" required:"true"`

	// A list of DB cluster snapshot attributes to add to the attribute specified
	// by AttributeName.
	//
	// To authorize other Amazon Web Services accounts to copy or restore a manual
	// DB cluster snapshot, set this list to include one or more Amazon Web Services
	// account IDs, or all to make the manual DB cluster snapshot restorable by
	// any Amazon Web Services account. Do not add the all value for any manual
	// DB cluster snapshots that contain private information that you don't want
	// available to all Amazon Web Services accounts.
	ValuesToAdd []*string `locationNameList:"AttributeValue" type:"list"`

	// A list of DB cluster snapshot attributes to remove from the attribute specified
	// by AttributeName.
	//
	// To remove authorization for other Amazon Web Services accounts to copy or
	// restore a manual DB cluster snapshot, set this list to include one or more
	// Amazon Web Services account identifiers, or all to remove authorization for
	// any Amazon Web Services account to copy or restore the DB cluster snapshot.
	// If you specify all, an Amazon Web Services account whose account ID is explicitly
	// added to the restore attribute can still copy or restore a manual DB cluster
	// snapshot.
	ValuesToRemove []*string `locationNameList:"AttributeValue" type:"list"`
	// contains filtered or unexported fields
}

func (ModifyDBClusterSnapshotAttributeInput) GoString added in v1.1.30

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBClusterSnapshotAttributeInput) SetAttributeName added in v1.5.0

SetAttributeName sets the AttributeName field's value.

func (*ModifyDBClusterSnapshotAttributeInput) SetDBClusterSnapshotIdentifier added in v1.5.0

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (*ModifyDBClusterSnapshotAttributeInput) SetValuesToAdd added in v1.5.0

SetValuesToAdd sets the ValuesToAdd field's value.

func (*ModifyDBClusterSnapshotAttributeInput) SetValuesToRemove added in v1.5.0

SetValuesToRemove sets the ValuesToRemove field's value.

func (ModifyDBClusterSnapshotAttributeInput) String added in v1.1.30

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBClusterSnapshotAttributeInput) Validate added in v1.1.30

Validate inspects the fields of the type to determine if they are valid.

type ModifyDBClusterSnapshotAttributeOutput added in v1.1.30

type ModifyDBClusterSnapshotAttributeOutput struct {

	// Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes
	// API action.
	//
	// Manual DB cluster snapshot attributes are used to authorize other Amazon
	// Web Services accounts to copy or restore a manual DB cluster snapshot. For
	// more information, see the ModifyDBClusterSnapshotAttribute API action.
	DBClusterSnapshotAttributesResult *DBClusterSnapshotAttributesResult `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyDBClusterSnapshotAttributeOutput) GoString added in v1.1.30

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBClusterSnapshotAttributeOutput) SetDBClusterSnapshotAttributesResult added in v1.5.0

SetDBClusterSnapshotAttributesResult sets the DBClusterSnapshotAttributesResult field's value.

func (ModifyDBClusterSnapshotAttributeOutput) String added in v1.1.30

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyDBInstanceInput

type ModifyDBInstanceInput struct {

	// The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
	//
	// For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at
	// least 10% greater than the current value. Values that are not at least 10%
	// greater than the existing value are rounded up so that they are 10% greater
	// than the current value.
	//
	// For the valid values for allocated storage for each engine, see CreateDBInstance.
	AllocatedStorage *int64 `type:"integer"`

	// A value that indicates whether major version upgrades are allowed. Changing
	// this parameter doesn't result in an outage and the change is asynchronously
	// applied as soon as possible.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Constraints: Major version upgrades must be allowed when specifying a value
	// for the EngineVersion parameter that is a different major version than the
	// DB instance's current version.
	AllowMajorVersionUpgrade *bool `type:"boolean"`

	// A value that indicates whether the modifications in this request and any
	// pending modifications are asynchronously applied as soon as possible, regardless
	// of the PreferredMaintenanceWindow setting for the DB instance. By default,
	// this parameter is disabled.
	//
	// If this parameter is disabled, changes to the DB instance are applied during
	// the next maintenance window. Some parameter changes can cause an outage and
	// are applied on the next call to RebootDBInstance, or the next failure reboot.
	// Review the table of parameters in Modifying a DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html)
	// in the Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately
	// for each modified parameter and to determine when the changes are applied.
	ApplyImmediately *bool `type:"boolean"`

	// A value that indicates whether minor version upgrades are applied automatically
	// to the DB instance during the maintenance window. An outage occurs when all
	// the following conditions are met:
	//
	//    * The automatic upgrade is enabled for the maintenance window.
	//
	//    * A newer minor version is available.
	//
	//    * RDS has enabled automatic patching for the engine version.
	//
	// If any of the preceding conditions isn't met, RDS applies the change as soon
	// as possible and doesn't cause an outage.
	//
	// For an RDS Custom DB instance, set AutoMinorVersionUpgrade to false. Otherwise,
	// the operation returns an error.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// The automation mode of the RDS Custom DB instance: full or all paused. If
	// full, the DB instance automates monitoring and instance recovery. If all
	// paused, the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes.
	AutomationMode *string `type:"string" enum:"AutomationMode"`

	// The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services
	// Backup.
	//
	// This setting doesn't apply to RDS Custom.
	AwsBackupRecoveryPointArn *string `min:"43" type:"string"`

	// The number of days to retain automated backups. Setting this parameter to
	// a positive number enables backups. Setting this parameter to 0 disables automated
	// backups.
	//
	// Enabling and disabling backups can result in a brief I/O suspension that
	// lasts from a few seconds to a few minutes, depending on the size and class
	// of your DB instance.
	//
	// These changes are applied during the next maintenance window unless the ApplyImmediately
	// parameter is enabled for this request. If you change the parameter from one
	// non-zero value to another non-zero value, the change is asynchronously applied
	// as soon as possible.
	//
	// Amazon Aurora
	//
	// Not applicable. The retention period for automated backups is managed by
	// the DB cluster. For more information, see ModifyDBCluster.
	//
	// Default: Uses existing setting
	//
	// Constraints:
	//
	//    * It must be a value from 0 to 35. It can't be set to 0 if the DB instance
	//    is a source to read replicas. It can't be set to 0 for an RDS Custom for
	//    Oracle DB instance.
	//
	//    * It can be specified for a MySQL read replica only if the source is running
	//    MySQL 5.6 or later.
	//
	//    * It can be specified for a PostgreSQL read replica only if the source
	//    is running PostgreSQL 9.3.5.
	BackupRetentionPeriod *int64 `type:"integer"`

	// Specifies the certificate to associate with the DB instance.
	//
	// This setting doesn't apply to RDS Custom.
	CACertificateIdentifier *string `type:"string"`

	// A value that indicates whether the DB instance is restarted when you rotate
	// your SSL/TLS certificate.
	//
	// By default, the DB instance is restarted when you rotate your SSL/TLS certificate.
	// The certificate is not updated until the DB instance is restarted.
	//
	// Set this parameter only if you are not using SSL/TLS to connect to the DB
	// instance.
	//
	// If you are using SSL/TLS to connect to the DB instance, follow the appropriate
	// instructions for your DB engine to rotate your SSL/TLS certificate:
	//
	//    * For more information about rotating your SSL/TLS certificate for RDS
	//    DB engines, see Rotating Your SSL/TLS Certificate. (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html)
	//    in the Amazon RDS User Guide.
	//
	//    * For more information about rotating your SSL/TLS certificate for Aurora
	//    DB engines, see Rotating Your SSL/TLS Certificate (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html)
	//    in the Amazon Aurora User Guide.
	//
	// This setting doesn't apply to RDS Custom.
	CertificateRotationRestart *bool `type:"boolean"`

	// The configuration setting for the log types to be enabled for export to CloudWatch
	// Logs for a specific DB instance.
	//
	// A change to the CloudwatchLogsExportConfiguration parameter is always applied
	// to the DB instance immediately. Therefore, the ApplyImmediately parameter
	// has no effect.
	//
	// This setting doesn't apply to RDS Custom.
	CloudwatchLogsExportConfiguration *CloudwatchLogsExportConfiguration `type:"structure"`

	// A value that indicates whether to copy all tags from the DB instance to snapshots
	// of the DB instance. By default, tags are not copied.
	//
	// Amazon Aurora
	//
	// Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting
	// this value for an Aurora DB instance has no effect on the DB cluster setting.
	// For more information, see ModifyDBCluster.
	CopyTagsToSnapshot *bool `type:"boolean"`

	// The new compute and memory capacity of the DB instance, for example db.m4.large.
	// Not all DB instance classes are available in all Amazon Web Services Regions,
	// or for all database engines. For the full list of DB instance classes, and
	// availability for your engine, see DB instance classes (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)
	// in the Amazon RDS User Guide or Aurora DB instance classes (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html)
	// in the Amazon Aurora User Guide.
	//
	// If you modify the DB instance class, an outage occurs during the change.
	// The change is applied during the next maintenance window, unless ApplyImmediately
	// is enabled for this request.
	//
	// This setting doesn't apply to RDS Custom for Oracle.
	//
	// Default: Uses existing setting
	DBInstanceClass *string `type:"string"`

	// The DB instance identifier. This value is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBInstance.
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`

	// The name of the DB parameter group to apply to the DB instance.
	//
	// Changing this setting doesn't result in an outage. The parameter group name
	// itself is changed immediately, but the actual parameter changes are not applied
	// until you reboot the instance without failover. In this case, the DB instance
	// isn't rebooted automatically, and the parameter changes aren't applied during
	// the next maintenance window. However, if you modify dynamic parameters in
	// the newly associated DB parameter group, these changes are applied immediately
	// without a reboot.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Default: Uses existing setting
	//
	// Constraints: The DB parameter group must be in the same DB parameter group
	// family as the DB instance.
	DBParameterGroupName *string `type:"string"`

	// The port number on which the database accepts connections.
	//
	// The value of the DBPortNumber parameter must not match any of the port values
	// specified for options in the option group for the DB instance.
	//
	// If you change the DBPortNumber value, your database restarts regardless of
	// the value of the ApplyImmediately parameter.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// MySQL
	//
	// Default: 3306
	//
	// Valid values: 1150-65535
	//
	// MariaDB
	//
	// Default: 3306
	//
	// Valid values: 1150-65535
	//
	// PostgreSQL
	//
	// Default: 5432
	//
	// Valid values: 1150-65535
	//
	// Type: Integer
	//
	// Oracle
	//
	// Default: 1521
	//
	// Valid values: 1150-65535
	//
	// SQL Server
	//
	// Default: 1433
	//
	// Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and
	// 49152-49156.
	//
	// Amazon Aurora
	//
	// Default: 3306
	//
	// Valid values: 1150-65535
	DBPortNumber *int64 `type:"integer"`

	// A list of DB security groups to authorize on this DB instance. Changing this
	// setting doesn't result in an outage and the change is asynchronously applied
	// as soon as possible.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Constraints:
	//
	//    * If supplied, must match existing DBSecurityGroups.
	DBSecurityGroups []*string `locationNameList:"DBSecurityGroupName" type:"list"`

	// The new DB subnet group for the DB instance. You can use this parameter to
	// move your DB instance to a different VPC. If your DB instance isn't in a
	// VPC, you can also use this parameter to move your DB instance into a VPC.
	// For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC)
	// in the Amazon RDS User Guide.
	//
	// Changing the subnet group causes an outage during the change. The change
	// is applied during the next maintenance window, unless you enable ApplyImmediately.
	//
	// This parameter doesn't apply to RDS Custom.
	//
	// Constraints: If supplied, must match the name of an existing DBSubnetGroup.
	//
	// Example: mydbsubnetgroup
	DBSubnetGroupName *string `type:"string"`

	// A value that indicates whether the DB instance has deletion protection enabled.
	// The database can't be deleted when deletion protection is enabled. By default,
	// deletion protection isn't enabled. For more information, see Deleting a DB
	// Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
	DeletionProtection *bool `type:"boolean"`

	// The Active Directory directory ID to move the DB instance to. Specify none
	// to remove the instance from its current domain. You must create the domain
	// before this operation. Currently, you can create only MySQL, Microsoft SQL
	// Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
	//
	// For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html)
	// in the Amazon RDS User Guide.
	//
	// This setting doesn't apply to RDS Custom.
	Domain *string `type:"string"`

	// The name of the IAM role to use when making API calls to the Directory Service.
	//
	// This setting doesn't apply to RDS Custom.
	DomainIAMRoleName *string `type:"string"`

	// A value that indicates whether to enable a customer-owned IP address (CoIP)
	// for an RDS on Outposts DB instance.
	//
	// A CoIP provides local or external connectivity to resources in your Outpost
	// subnets through your on-premises network. For some use cases, a CoIP can
	// provide lower latency for connections to the DB instance from outside of
	// its virtual private cloud (VPC) on your local network.
	//
	// For more information about RDS on Outposts, see Working with Amazon RDS on
	// Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)
	// in the Amazon RDS User Guide.
	//
	// For more information about CoIPs, see Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing)
	// in the Amazon Web Services Outposts User Guide.
	EnableCustomerOwnedIp *bool `type:"boolean"`

	// A value that indicates whether to enable mapping of Amazon Web Services Identity
	// and Access Management (IAM) accounts to database accounts. By default, mapping
	// isn't enabled.
	//
	// This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services
	// IAM accounts to database accounts is managed by the DB cluster.
	//
	// For more information about IAM database authentication, see IAM Database
	// Authentication for MySQL and PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html)
	// in the Amazon RDS User Guide.
	//
	// This setting doesn't apply to RDS Custom.
	EnableIAMDatabaseAuthentication *bool `type:"boolean"`

	// A value that indicates whether to enable Performance Insights for the DB
	// instance.
	//
	// For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)
	// in the Amazon RDS User Guide.
	//
	// This setting doesn't apply to RDS Custom.
	EnablePerformanceInsights *bool `type:"boolean"`

	// The version number of the database engine to upgrade to. Changing this parameter
	// results in an outage and the change is applied during the next maintenance
	// window unless the ApplyImmediately parameter is enabled for this request.
	//
	// For major version upgrades, if a nondefault DB parameter group is currently
	// in use, a new DB parameter group in the DB parameter group family for the
	// new engine version must be specified. The new DB parameter group can be the
	// default for that DB parameter group family.
	//
	// If you specify only a major version, Amazon RDS will update the DB instance
	// to the default minor version if the current minor version is lower. For information
	// about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
	//
	// In RDS Custom for Oracle, this parameter is supported for read replicas only
	// if they are in the PATCH_DB_FAILURE lifecycle.
	EngineVersion *string `type:"string"`

	// The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
	//
	// Changing this setting doesn't result in an outage and the change is applied
	// during the next maintenance window unless the ApplyImmediately parameter
	// is enabled for this request. If you are migrating from Provisioned IOPS to
	// standard storage, set this value to 0. The DB instance will require a reboot
	// for the change in storage type to take effect.
	//
	// If you choose to migrate your DB instance from using standard storage to
	// using Provisioned IOPS, or from using Provisioned IOPS to using standard
	// storage, the process can take time. The duration of the migration depends
	// on several factors such as database load, storage size, storage type (standard
	// or Provisioned IOPS), amount of IOPS provisioned (if any), and the number
	// of prior scale storage operations. Typical migration times are under 24 hours,
	// but the process can take up to several days in some cases. During the migration,
	// the DB instance is available for use, but might experience performance degradation.
	// While the migration takes place, nightly backups for the instance are suspended.
	// No other Amazon RDS operations can take place for the instance, including
	// modifying the instance, rebooting the instance, deleting the instance, creating
	// a read replica for the instance, and creating a DB snapshot of the instance.
	//
	// Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied
	// must be at least 10% greater than the current value. Values that are not
	// at least 10% greater than the existing value are rounded up so that they
	// are 10% greater than the current value.
	//
	// Default: Uses existing setting
	Iops *int64 `type:"integer"`

	// The license model for the DB instance.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Valid values: license-included | bring-your-own-license | general-public-license
	LicenseModel *string `type:"string"`

	// The new password for the master user. The password can include any printable
	// ASCII character except "/", """, or "@".
	//
	// Changing this parameter doesn't result in an outage and the change is asynchronously
	// applied as soon as possible. Between the time of the request and the completion
	// of the request, the MasterUserPassword element exists in the PendingModifiedValues
	// element of the operation response.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Amazon Aurora
	//
	// Not applicable. The password for the master user is managed by the DB cluster.
	// For more information, see ModifyDBCluster.
	//
	// Default: Uses existing setting
	//
	// MariaDB
	//
	// Constraints: Must contain from 8 to 41 characters.
	//
	// Microsoft SQL Server
	//
	// Constraints: Must contain from 8 to 128 characters.
	//
	// MySQL
	//
	// Constraints: Must contain from 8 to 41 characters.
	//
	// Oracle
	//
	// Constraints: Must contain from 8 to 30 characters.
	//
	// PostgreSQL
	//
	// Constraints: Must contain from 8 to 128 characters.
	//
	// Amazon RDS API operations never return the password, so this action provides
	// a way to regain access to a primary instance user if the password is lost.
	// This includes restoring privileges that might have been accidentally revoked.
	MasterUserPassword *string `type:"string"`

	// The upper limit in gibibytes (GiB) to which Amazon RDS can automatically
	// scale the storage of the DB instance.
	//
	// For more information about this setting, including limitations that apply
	// to it, see Managing capacity automatically with Amazon RDS storage autoscaling
	// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling)
	// in the Amazon RDS User Guide.
	//
	// This setting doesn't apply to RDS Custom.
	MaxAllocatedStorage *int64 `type:"integer"`

	// The interval, in seconds, between points when Enhanced Monitoring metrics
	// are collected for the DB instance. To disable collecting Enhanced Monitoring
	// metrics, specify 0, which is the default.
	//
	// If MonitoringRoleArn is specified, set MonitoringInterval to a value other
	// than 0.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Valid Values: 0, 1, 5, 10, 15, 30, 60
	MonitoringInterval *int64 `type:"integer"`

	// The ARN for the IAM role that permits RDS to send enhanced monitoring metrics
	// to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.
	// For information on creating a monitoring role, see To create an IAM role
	// for Amazon RDS Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole)
	// in the Amazon RDS User Guide.
	//
	// If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn
	// value.
	//
	// This setting doesn't apply to RDS Custom.
	MonitoringRoleArn *string `type:"string"`

	// A value that indicates whether the DB instance is a Multi-AZ deployment.
	// Changing this parameter doesn't result in an outage. The change is applied
	// during the next maintenance window unless the ApplyImmediately parameter
	// is enabled for this request.
	//
	// This setting doesn't apply to RDS Custom.
	MultiAZ *bool `type:"boolean"`

	// The network type of the DB instance.
	//
	// Valid values:
	//
	//    * IPV4
	//
	//    * DUAL
	//
	// The network type is determined by the DBSubnetGroup specified for the DB
	// instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4
	// and the IPv6 protocols (DUAL).
	//
	// For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
	// in the Amazon RDS User Guide.
	NetworkType *string `type:"string"`

	// The new DB instance identifier for the DB instance when renaming a DB instance.
	// When you change the DB instance identifier, an instance reboot occurs immediately
	// if you enable ApplyImmediately, or will occur during the next maintenance
	// window if you disable Apply Immediately. This value is stored as a lowercase
	// string.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 letters, numbers, or hyphens.
	//
	//    * The first character must be a letter.
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens.
	//
	// Example: mydbinstance
	NewDBInstanceIdentifier *string `type:"string"`

	// A value that indicates the DB instance should be associated with the specified
	// option group.
	//
	// Changing this parameter doesn't result in an outage, with one exception.
	// If the parameter change results in an option group that enables OEM, it can
	// cause a brief period, lasting less than a second, during which new connections
	// are rejected but existing connections aren't interrupted.
	//
	// The change is applied during the next maintenance window unless the ApplyImmediately
	// parameter is enabled for this request.
	//
	// Permanent options, such as the TDE option for Oracle Advanced Security TDE,
	// can't be removed from an option group, and that option group can't be removed
	// from a DB instance after it is associated with a DB instance.
	//
	// This setting doesn't apply to RDS Custom.
	OptionGroupName *string `type:"string"`

	// The Amazon Web Services KMS key identifier for encryption of Performance
	// Insights data.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key.
	//
	// If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon
	// RDS uses your default KMS key. There is a default KMS key for your Amazon
	// Web Services account. Your Amazon Web Services account has a different default
	// KMS key for each Amazon Web Services Region.
	//
	// This setting doesn't apply to RDS Custom.
	PerformanceInsightsKMSKeyId *string `type:"string"`

	// The number of days to retain Performance Insights data. The default is 7
	// days. The following values are valid:
	//
	//    * 7
	//
	//    * month * 31, where month is a number of months from 1-23
	//
	//    * 731
	//
	// For example, the following values are valid:
	//
	//    * 93 (3 months * 31)
	//
	//    * 341 (11 months * 31)
	//
	//    * 589 (19 months * 31)
	//
	//    * 731
	//
	// If you specify a retention period such as 94, which isn't a valid value,
	// RDS issues an error.
	//
	// This setting doesn't apply to RDS Custom.
	PerformanceInsightsRetentionPeriod *int64 `type:"integer"`

	// The daily time range during which automated backups are created if automated
	// backups are enabled, as determined by the BackupRetentionPeriod parameter.
	// Changing this parameter doesn't result in an outage and the change is asynchronously
	// applied as soon as possible. The default is a 30-minute window selected at
	// random from an 8-hour block of time for each Amazon Web Services Region.
	// For more information, see Backup window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow)
	// in the Amazon RDS User Guide.
	//
	// Amazon Aurora
	//
	// Not applicable. The daily time range for creating automated backups is managed
	// by the DB cluster. For more information, see ModifyDBCluster.
	//
	// Constraints:
	//
	//    * Must be in the format hh24:mi-hh24:mi
	//
	//    * Must be in Universal Time Coordinated (UTC)
	//
	//    * Must not conflict with the preferred maintenance window
	//
	//    * Must be at least 30 minutes
	PreferredBackupWindow *string `type:"string"`

	// The weekly time range (in UTC) during which system maintenance can occur,
	// which might result in an outage. Changing this parameter doesn't result in
	// an outage, except in the following situation, and the change is asynchronously
	// applied as soon as possible. If there are pending actions that cause a reboot,
	// and the maintenance window is changed to include the current time, then changing
	// this parameter will cause a reboot of the DB instance. If moving this window
	// to the current time, there must be at least 30 minutes between the current
	// time and end of the window to ensure pending changes are applied.
	//
	// For more information, see Amazon RDS Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance)
	// in the Amazon RDS User Guide.
	//
	// Default: Uses existing setting
	//
	// Format: ddd:hh24:mi-ddd:hh24:mi
	//
	// Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
	//
	// Constraints: Must be at least 30 minutes
	PreferredMaintenanceWindow *string `type:"string"`

	// The number of CPU cores and the number of threads per core for the DB instance
	// class of the DB instance.
	//
	// This setting doesn't apply to RDS Custom.
	ProcessorFeatures []*ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"`

	// 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.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Default: 1
	//
	// Valid Values: 0 - 15
	PromotionTier *int64 `type:"integer"`

	// A value that indicates whether the DB instance is publicly accessible.
	//
	// When the DB cluster is publicly accessible, its Domain Name System (DNS)
	// endpoint resolves to the private IP address from within the DB cluster's
	// virtual private cloud (VPC). It resolves to the public IP address from outside
	// of the DB cluster's VPC. Access to the DB cluster is ultimately controlled
	// by the security group it uses. That public access isn't permitted if the
	// security group assigned to the DB cluster doesn't permit it.
	//
	// When the DB instance isn't publicly accessible, it is an internal DB instance
	// with a DNS name that resolves to a private IP address.
	//
	// PubliclyAccessible only applies to DB instances in a VPC. The DB instance
	// must be part of a public subnet and PubliclyAccessible must be enabled for
	// it to be publicly accessible.
	//
	// Changes to the PubliclyAccessible parameter are applied immediately regardless
	// of the value of the ApplyImmediately parameter.
	PubliclyAccessible *bool `type:"boolean"`

	// A value that sets the open mode of a replica database to either mounted or
	// read-only.
	//
	// Currently, this parameter is only supported for Oracle DB instances.
	//
	// Mounted DB replicas are included in Oracle Enterprise Edition. The main use
	// case for mounted replicas is cross-Region disaster recovery. The primary
	// database doesn't use Active Data Guard to transmit information to the mounted
	// replica. Because it doesn't accept user connections, a mounted replica can't
	// serve a read-only workload. For more information, see Working with Oracle
	// Read Replicas for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html)
	// in the Amazon RDS User Guide.
	//
	// This setting doesn't apply to RDS Custom.
	ReplicaMode *string `type:"string" enum:"ReplicaMode"`

	// The number of minutes to pause the automation. When the time period ends,
	// RDS Custom resumes full automation. The minimum value is 60 (default). The
	// maximum value is 1,440.
	ResumeFullAutomationModeMinutes *int64 `type:"integer"`

	// Specifies the storage type to be associated with the DB instance.
	//
	// If you specify Provisioned IOPS (io1), you must also include a value for
	// the Iops parameter.
	//
	// If you choose to migrate your DB instance from using standard storage to
	// using Provisioned IOPS, or from using Provisioned IOPS to using standard
	// storage, the process can take time. The duration of the migration depends
	// on several factors such as database load, storage size, storage type (standard
	// or Provisioned IOPS), amount of IOPS provisioned (if any), and the number
	// of prior scale storage operations. Typical migration times are under 24 hours,
	// but the process can take up to several days in some cases. During the migration,
	// the DB instance is available for use, but might experience performance degradation.
	// While the migration takes place, nightly backups for the instance are suspended.
	// No other Amazon RDS operations can take place for the instance, including
	// modifying the instance, rebooting the instance, deleting the instance, creating
	// a read replica for the instance, and creating a DB snapshot of the instance.
	//
	// Valid values: standard | gp2 | io1
	//
	// Default: io1 if the Iops parameter is specified, otherwise gp2
	StorageType *string `type:"string"`

	// The ARN from the key store with which to associate the instance for TDE encryption.
	//
	// This setting doesn't apply to RDS Custom.
	TdeCredentialArn *string `type:"string"`

	// The password for the given ARN from the key store in order to access the
	// device.
	//
	// This setting doesn't apply to RDS Custom.
	TdeCredentialPassword *string `type:"string"`

	// A value that indicates whether the DB instance class of the DB instance uses
	// its default processor features.
	//
	// This setting doesn't apply to RDS Custom.
	UseDefaultProcessorFeatures *bool `type:"boolean"`

	// A list of Amazon EC2 VPC security groups to authorize on this DB instance.
	// This change is asynchronously applied as soon as possible.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Amazon Aurora
	//
	// Not applicable. The associated list of EC2 VPC security groups is managed
	// by the DB cluster. For more information, see ModifyDBCluster.
	//
	// Constraints:
	//
	//    * If supplied, must match existing VpcSecurityGroupIds.
	VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"`
	// contains filtered or unexported fields
}

func (ModifyDBInstanceInput) GoString added in v0.6.5

func (s ModifyDBInstanceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBInstanceInput) SetAllocatedStorage added in v1.5.0

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

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*ModifyDBInstanceInput) SetAllowMajorVersionUpgrade added in v1.5.0

func (s *ModifyDBInstanceInput) SetAllowMajorVersionUpgrade(v bool) *ModifyDBInstanceInput

SetAllowMajorVersionUpgrade sets the AllowMajorVersionUpgrade field's value.

func (*ModifyDBInstanceInput) SetApplyImmediately added in v1.5.0

func (s *ModifyDBInstanceInput) SetApplyImmediately(v bool) *ModifyDBInstanceInput

SetApplyImmediately sets the ApplyImmediately field's value.

func (*ModifyDBInstanceInput) SetAutoMinorVersionUpgrade added in v1.5.0

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*ModifyDBInstanceInput) SetAutomationMode added in v1.41.10

func (s *ModifyDBInstanceInput) SetAutomationMode(v string) *ModifyDBInstanceInput

SetAutomationMode sets the AutomationMode field's value.

func (*ModifyDBInstanceInput) SetAwsBackupRecoveryPointArn added in v1.37.15

func (s *ModifyDBInstanceInput) SetAwsBackupRecoveryPointArn(v string) *ModifyDBInstanceInput

SetAwsBackupRecoveryPointArn sets the AwsBackupRecoveryPointArn field's value.

func (*ModifyDBInstanceInput) SetBackupRetentionPeriod added in v1.5.0

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*ModifyDBInstanceInput) SetCACertificateIdentifier added in v1.5.0

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

SetCACertificateIdentifier sets the CACertificateIdentifier field's value.

func (*ModifyDBInstanceInput) SetCertificateRotationRestart added in v1.26.7

func (s *ModifyDBInstanceInput) SetCertificateRotationRestart(v bool) *ModifyDBInstanceInput

SetCertificateRotationRestart sets the CertificateRotationRestart field's value.

func (*ModifyDBInstanceInput) SetCloudwatchLogsExportConfiguration added in v1.12.63

func (s *ModifyDBInstanceInput) SetCloudwatchLogsExportConfiguration(v *CloudwatchLogsExportConfiguration) *ModifyDBInstanceInput

SetCloudwatchLogsExportConfiguration sets the CloudwatchLogsExportConfiguration field's value.

func (*ModifyDBInstanceInput) SetCopyTagsToSnapshot added in v1.5.0

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

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*ModifyDBInstanceInput) SetDBInstanceClass added in v1.5.0

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

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*ModifyDBInstanceInput) SetDBInstanceIdentifier added in v1.5.0

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*ModifyDBInstanceInput) SetDBParameterGroupName added in v1.5.0

func (s *ModifyDBInstanceInput) SetDBParameterGroupName(v string) *ModifyDBInstanceInput

SetDBParameterGroupName sets the DBParameterGroupName field's value.

func (*ModifyDBInstanceInput) SetDBPortNumber added in v1.5.0

func (s *ModifyDBInstanceInput) SetDBPortNumber(v int64) *ModifyDBInstanceInput

SetDBPortNumber sets the DBPortNumber field's value.

func (*ModifyDBInstanceInput) SetDBSecurityGroups added in v1.5.0

func (s *ModifyDBInstanceInput) SetDBSecurityGroups(v []*string) *ModifyDBInstanceInput

SetDBSecurityGroups sets the DBSecurityGroups field's value.

func (*ModifyDBInstanceInput) SetDBSubnetGroupName added in v1.5.0

func (s *ModifyDBInstanceInput) SetDBSubnetGroupName(v string) *ModifyDBInstanceInput

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*ModifyDBInstanceInput) SetDeletionProtection added in v1.15.43

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

SetDeletionProtection sets the DeletionProtection field's value.

func (*ModifyDBInstanceInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*ModifyDBInstanceInput) SetDomainIAMRoleName added in v1.5.0

func (s *ModifyDBInstanceInput) SetDomainIAMRoleName(v string) *ModifyDBInstanceInput

SetDomainIAMRoleName sets the DomainIAMRoleName field's value.

func (*ModifyDBInstanceInput) SetEnableCustomerOwnedIp added in v1.36.14

func (s *ModifyDBInstanceInput) SetEnableCustomerOwnedIp(v bool) *ModifyDBInstanceInput

SetEnableCustomerOwnedIp sets the EnableCustomerOwnedIp field's value.

func (*ModifyDBInstanceInput) SetEnableIAMDatabaseAuthentication added in v1.8.17

func (s *ModifyDBInstanceInput) SetEnableIAMDatabaseAuthentication(v bool) *ModifyDBInstanceInput

SetEnableIAMDatabaseAuthentication sets the EnableIAMDatabaseAuthentication field's value.

func (*ModifyDBInstanceInput) SetEnablePerformanceInsights added in v1.10.50

func (s *ModifyDBInstanceInput) SetEnablePerformanceInsights(v bool) *ModifyDBInstanceInput

SetEnablePerformanceInsights sets the EnablePerformanceInsights field's value.

func (*ModifyDBInstanceInput) SetEngineVersion added in v1.5.0

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

SetEngineVersion sets the EngineVersion field's value.

func (*ModifyDBInstanceInput) SetIops added in v1.5.0

SetIops sets the Iops field's value.

func (*ModifyDBInstanceInput) SetLicenseModel added in v1.5.0

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

SetLicenseModel sets the LicenseModel field's value.

func (*ModifyDBInstanceInput) SetMasterUserPassword added in v1.5.0

func (s *ModifyDBInstanceInput) SetMasterUserPassword(v string) *ModifyDBInstanceInput

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*ModifyDBInstanceInput) SetMaxAllocatedStorage added in v1.20.5

func (s *ModifyDBInstanceInput) SetMaxAllocatedStorage(v int64) *ModifyDBInstanceInput

SetMaxAllocatedStorage sets the MaxAllocatedStorage field's value.

func (*ModifyDBInstanceInput) SetMonitoringInterval added in v1.5.0

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

SetMonitoringInterval sets the MonitoringInterval field's value.

func (*ModifyDBInstanceInput) SetMonitoringRoleArn added in v1.5.0

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

SetMonitoringRoleArn sets the MonitoringRoleArn field's value.

func (*ModifyDBInstanceInput) SetMultiAZ added in v1.5.0

SetMultiAZ sets the MultiAZ field's value.

func (*ModifyDBInstanceInput) SetNetworkType added in v1.44.4

func (s *ModifyDBInstanceInput) SetNetworkType(v string) *ModifyDBInstanceInput

SetNetworkType sets the NetworkType field's value.

func (*ModifyDBInstanceInput) SetNewDBInstanceIdentifier added in v1.5.0

func (s *ModifyDBInstanceInput) SetNewDBInstanceIdentifier(v string) *ModifyDBInstanceInput

SetNewDBInstanceIdentifier sets the NewDBInstanceIdentifier field's value.

func (*ModifyDBInstanceInput) SetOptionGroupName added in v1.5.0

func (s *ModifyDBInstanceInput) SetOptionGroupName(v string) *ModifyDBInstanceInput

SetOptionGroupName sets the OptionGroupName field's value.

func (*ModifyDBInstanceInput) SetPerformanceInsightsKMSKeyId added in v1.10.50

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

SetPerformanceInsightsKMSKeyId sets the PerformanceInsightsKMSKeyId field's value.

func (*ModifyDBInstanceInput) SetPerformanceInsightsRetentionPeriod added in v1.14.10

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

SetPerformanceInsightsRetentionPeriod sets the PerformanceInsightsRetentionPeriod field's value.

func (*ModifyDBInstanceInput) SetPreferredBackupWindow added in v1.5.0

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*ModifyDBInstanceInput) SetPreferredMaintenanceWindow added in v1.5.0

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*ModifyDBInstanceInput) SetProcessorFeatures added in v1.14.1

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

SetProcessorFeatures sets the ProcessorFeatures field's value.

func (*ModifyDBInstanceInput) SetPromotionTier added in v1.5.0

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

SetPromotionTier sets the PromotionTier field's value.

func (*ModifyDBInstanceInput) SetPubliclyAccessible added in v1.5.0

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

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*ModifyDBInstanceInput) SetReplicaMode added in v1.34.4

func (s *ModifyDBInstanceInput) SetReplicaMode(v string) *ModifyDBInstanceInput

SetReplicaMode sets the ReplicaMode field's value.

func (*ModifyDBInstanceInput) SetResumeFullAutomationModeMinutes added in v1.41.10

func (s *ModifyDBInstanceInput) SetResumeFullAutomationModeMinutes(v int64) *ModifyDBInstanceInput

SetResumeFullAutomationModeMinutes sets the ResumeFullAutomationModeMinutes field's value.

func (*ModifyDBInstanceInput) SetStorageType added in v1.5.0

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

SetStorageType sets the StorageType field's value.

func (*ModifyDBInstanceInput) SetTdeCredentialArn added in v1.5.0

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

SetTdeCredentialArn sets the TdeCredentialArn field's value.

func (*ModifyDBInstanceInput) SetTdeCredentialPassword added in v1.5.0

func (s *ModifyDBInstanceInput) SetTdeCredentialPassword(v string) *ModifyDBInstanceInput

SetTdeCredentialPassword sets the TdeCredentialPassword field's value.

func (*ModifyDBInstanceInput) SetUseDefaultProcessorFeatures added in v1.14.1

func (s *ModifyDBInstanceInput) SetUseDefaultProcessorFeatures(v bool) *ModifyDBInstanceInput

SetUseDefaultProcessorFeatures sets the UseDefaultProcessorFeatures field's value.

func (*ModifyDBInstanceInput) SetVpcSecurityGroupIds added in v1.5.0

func (s *ModifyDBInstanceInput) SetVpcSecurityGroupIds(v []*string) *ModifyDBInstanceInput

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (ModifyDBInstanceInput) String added in v0.6.5

func (s ModifyDBInstanceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBInstanceInput) Validate added in v1.1.21

func (s *ModifyDBInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyDBInstanceOutput

type ModifyDBInstanceOutput struct {

	// Contains the details of an Amazon RDS DB instance.
	//
	// This data type is used as a response element in the operations CreateDBInstance,
	// CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance,
	// PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,
	// RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
	DBInstance *DBInstance `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyDBInstanceOutput) GoString added in v0.6.5

func (s ModifyDBInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBInstanceOutput) SetDBInstance added in v1.5.0

SetDBInstance sets the DBInstance field's value.

func (ModifyDBInstanceOutput) String added in v0.6.5

func (s ModifyDBInstanceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyDBParameterGroupInput

type ModifyDBParameterGroupInput struct {

	// The name of the DB parameter group.
	//
	// Constraints:
	//
	//    * If supplied, must match the name of an existing DBParameterGroup.
	//
	// DBParameterGroupName is a required field
	DBParameterGroupName *string `type:"string" required:"true"`

	// An array of parameter names, values, and the application methods for the
	// parameter update. At least one parameter name, value, and application method
	// must be supplied; later arguments are optional. A maximum of 20 parameters
	// can be modified in a single request.
	//
	// Valid Values (for the application method): immediate | pending-reboot
	//
	// You can use the immediate value with dynamic parameters only. You can use
	// the pending-reboot value for both dynamic and static parameters.
	//
	// When the application method is immediate, changes to dynamic parameters are
	// applied immediately to the DB instances associated with the parameter group.
	//
	// When the application method is pending-reboot, changes to dynamic and static
	// parameters are applied after a reboot without failover to the DB instances
	// associated with the parameter group.
	//
	// You can't use pending-reboot with dynamic parameters on RDS for SQL Server
	// DB instances. Use immediate.
	//
	// For more information on modifying DB parameters, see Working with DB parameter
	// groups (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html)
	// in the Amazon RDS User Guide.
	//
	// Parameters is a required field
	Parameters []*Parameter `locationNameList:"Parameter" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ModifyDBParameterGroupInput) GoString added in v0.6.5

func (s ModifyDBParameterGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBParameterGroupInput) SetDBParameterGroupName added in v1.5.0

func (s *ModifyDBParameterGroupInput) SetDBParameterGroupName(v string) *ModifyDBParameterGroupInput

SetDBParameterGroupName sets the DBParameterGroupName field's value.

func (*ModifyDBParameterGroupInput) SetParameters added in v1.5.0

SetParameters sets the Parameters field's value.

func (ModifyDBParameterGroupInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBParameterGroupInput) Validate added in v1.1.21

func (s *ModifyDBParameterGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyDBProxyEndpointInput added in v1.37.27

type ModifyDBProxyEndpointInput struct {

	// The name of the DB proxy sociated with the DB proxy endpoint that you want
	// to modify.
	//
	// DBProxyEndpointName is a required field
	DBProxyEndpointName *string `min:"1" type:"string" required:"true"`

	// The new identifier for the DBProxyEndpoint. An identifier must begin with
	// a letter and must contain only ASCII letters, digits, and hyphens; it can't
	// end with a hyphen or contain two consecutive hyphens.
	NewDBProxyEndpointName *string `min:"1" type:"string"`

	// The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint
	// uses a different VPC than the original proxy, you also specify a different
	// set of security group IDs than for the original proxy.
	VpcSecurityGroupIds []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ModifyDBProxyEndpointInput) GoString added in v1.37.27

func (s ModifyDBProxyEndpointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBProxyEndpointInput) SetDBProxyEndpointName added in v1.37.27

func (s *ModifyDBProxyEndpointInput) SetDBProxyEndpointName(v string) *ModifyDBProxyEndpointInput

SetDBProxyEndpointName sets the DBProxyEndpointName field's value.

func (*ModifyDBProxyEndpointInput) SetNewDBProxyEndpointName added in v1.37.27

func (s *ModifyDBProxyEndpointInput) SetNewDBProxyEndpointName(v string) *ModifyDBProxyEndpointInput

SetNewDBProxyEndpointName sets the NewDBProxyEndpointName field's value.

func (*ModifyDBProxyEndpointInput) SetVpcSecurityGroupIds added in v1.37.27

func (s *ModifyDBProxyEndpointInput) SetVpcSecurityGroupIds(v []*string) *ModifyDBProxyEndpointInput

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (ModifyDBProxyEndpointInput) String added in v1.37.27

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBProxyEndpointInput) Validate added in v1.37.27

func (s *ModifyDBProxyEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyDBProxyEndpointOutput added in v1.37.27

type ModifyDBProxyEndpointOutput struct {

	// The DBProxyEndpoint object representing the new settings for the DB proxy
	// endpoint.
	DBProxyEndpoint *DBProxyEndpoint `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyDBProxyEndpointOutput) GoString added in v1.37.27

func (s ModifyDBProxyEndpointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBProxyEndpointOutput) SetDBProxyEndpoint added in v1.37.27

SetDBProxyEndpoint sets the DBProxyEndpoint field's value.

func (ModifyDBProxyEndpointOutput) String added in v1.37.27

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyDBProxyInput added in v1.25.47

type ModifyDBProxyInput struct {

	// The new authentication settings for the DBProxy.
	Auth []*UserAuthConfig `type:"list"`

	// The identifier for the DBProxy to modify.
	//
	// DBProxyName is a required field
	DBProxyName *string `type:"string" required:"true"`

	// Whether the proxy includes detailed information about SQL statements in its
	// logs. This information helps you to debug issues involving SQL behavior or
	// the performance and scalability of the proxy connections. The debug information
	// includes the text of SQL statements that you submit through the proxy. Thus,
	// only enable this setting when needed for debugging, and only when you have
	// security measures in place to safeguard any sensitive information that appears
	// in the logs.
	DebugLogging *bool `type:"boolean"`

	// The number of seconds that a connection to the proxy can be inactive before
	// the proxy disconnects it. You can set this value higher or lower than the
	// connection timeout limit for the associated database.
	IdleClientTimeout *int64 `type:"integer"`

	// The new identifier for the DBProxy. An identifier must begin with a letter
	// and must contain only ASCII letters, digits, and hyphens; it can't end with
	// a hyphen or contain two consecutive hyphens.
	NewDBProxyName *string `type:"string"`

	// Whether Transport Layer Security (TLS) encryption is required for connections
	// to the proxy. By enabling this setting, you can enforce encrypted TLS connections
	// to the proxy, even if the associated database doesn't use TLS.
	RequireTLS *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access
	// secrets in Amazon Web Services Secrets Manager.
	RoleArn *string `type:"string"`

	// The new list of security groups for the DBProxy.
	SecurityGroups []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ModifyDBProxyInput) GoString added in v1.25.47

func (s ModifyDBProxyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBProxyInput) SetAuth added in v1.25.47

SetAuth sets the Auth field's value.

func (*ModifyDBProxyInput) SetDBProxyName added in v1.25.47

func (s *ModifyDBProxyInput) SetDBProxyName(v string) *ModifyDBProxyInput

SetDBProxyName sets the DBProxyName field's value.

func (*ModifyDBProxyInput) SetDebugLogging added in v1.25.47

func (s *ModifyDBProxyInput) SetDebugLogging(v bool) *ModifyDBProxyInput

SetDebugLogging sets the DebugLogging field's value.

func (*ModifyDBProxyInput) SetIdleClientTimeout added in v1.25.47

func (s *ModifyDBProxyInput) SetIdleClientTimeout(v int64) *ModifyDBProxyInput

SetIdleClientTimeout sets the IdleClientTimeout field's value.

func (*ModifyDBProxyInput) SetNewDBProxyName added in v1.25.47

func (s *ModifyDBProxyInput) SetNewDBProxyName(v string) *ModifyDBProxyInput

SetNewDBProxyName sets the NewDBProxyName field's value.

func (*ModifyDBProxyInput) SetRequireTLS added in v1.25.47

func (s *ModifyDBProxyInput) SetRequireTLS(v bool) *ModifyDBProxyInput

SetRequireTLS sets the RequireTLS field's value.

func (*ModifyDBProxyInput) SetRoleArn added in v1.25.47

func (s *ModifyDBProxyInput) SetRoleArn(v string) *ModifyDBProxyInput

SetRoleArn sets the RoleArn field's value.

func (*ModifyDBProxyInput) SetSecurityGroups added in v1.25.47

func (s *ModifyDBProxyInput) SetSecurityGroups(v []*string) *ModifyDBProxyInput

SetSecurityGroups sets the SecurityGroups field's value.

func (ModifyDBProxyInput) String added in v1.25.47

func (s ModifyDBProxyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBProxyInput) Validate added in v1.25.47

func (s *ModifyDBProxyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyDBProxyOutput added in v1.25.47

type ModifyDBProxyOutput struct {

	// The DBProxy object representing the new settings for the proxy.
	DBProxy *DBProxy `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyDBProxyOutput) GoString added in v1.25.47

func (s ModifyDBProxyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBProxyOutput) SetDBProxy added in v1.25.47

func (s *ModifyDBProxyOutput) SetDBProxy(v *DBProxy) *ModifyDBProxyOutput

SetDBProxy sets the DBProxy field's value.

func (ModifyDBProxyOutput) String added in v1.25.47

func (s ModifyDBProxyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyDBProxyTargetGroupInput added in v1.25.47

type ModifyDBProxyTargetGroupInput struct {

	// The settings that determine the size and behavior of the connection pool
	// for the target group.
	ConnectionPoolConfig *ConnectionPoolConfiguration `type:"structure"`

	// The name of the proxy.
	//
	// DBProxyName is a required field
	DBProxyName *string `type:"string" required:"true"`

	// The new name for the modified DBProxyTarget. An identifier must begin with
	// a letter and must contain only ASCII letters, digits, and hyphens; it can't
	// end with a hyphen or contain two consecutive hyphens.
	NewName *string `type:"string"`

	// The name of the target group to modify.
	//
	// TargetGroupName is a required field
	TargetGroupName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ModifyDBProxyTargetGroupInput) GoString added in v1.25.47

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBProxyTargetGroupInput) SetConnectionPoolConfig added in v1.25.47

SetConnectionPoolConfig sets the ConnectionPoolConfig field's value.

func (*ModifyDBProxyTargetGroupInput) SetDBProxyName added in v1.25.47

SetDBProxyName sets the DBProxyName field's value.

func (*ModifyDBProxyTargetGroupInput) SetNewName added in v1.25.47

SetNewName sets the NewName field's value.

func (*ModifyDBProxyTargetGroupInput) SetTargetGroupName added in v1.25.47

SetTargetGroupName sets the TargetGroupName field's value.

func (ModifyDBProxyTargetGroupInput) String added in v1.25.47

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBProxyTargetGroupInput) Validate added in v1.25.47

func (s *ModifyDBProxyTargetGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyDBProxyTargetGroupOutput added in v1.25.47

type ModifyDBProxyTargetGroupOutput struct {

	// The settings of the modified DBProxyTarget.
	DBProxyTargetGroup *DBProxyTargetGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyDBProxyTargetGroupOutput) GoString added in v1.25.47

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBProxyTargetGroupOutput) SetDBProxyTargetGroup added in v1.25.47

SetDBProxyTargetGroup sets the DBProxyTargetGroup field's value.

func (ModifyDBProxyTargetGroupOutput) String added in v1.25.47

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyDBSnapshotAttributeInput added in v0.10.4

type ModifyDBSnapshotAttributeInput struct {

	// The name of the DB snapshot attribute to modify.
	//
	// To manage authorization for other Amazon Web Services accounts to copy or
	// restore a manual DB snapshot, set this value to restore.
	//
	// To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes
	// API operation.
	//
	// AttributeName is a required field
	AttributeName *string `type:"string" required:"true"`

	// The identifier for the DB snapshot to modify the attributes for.
	//
	// DBSnapshotIdentifier is a required field
	DBSnapshotIdentifier *string `type:"string" required:"true"`

	// A list of DB snapshot attributes to add to the attribute specified by AttributeName.
	//
	// To authorize other Amazon Web Services accounts to copy or restore a manual
	// snapshot, set this list to include one or more Amazon Web Services account
	// IDs, or all to make the manual DB snapshot restorable by any Amazon Web Services
	// account. Do not add the all value for any manual DB snapshots that contain
	// private information that you don't want available to all Amazon Web Services
	// accounts.
	ValuesToAdd []*string `locationNameList:"AttributeValue" type:"list"`

	// A list of DB snapshot attributes to remove from the attribute specified by
	// AttributeName.
	//
	// To remove authorization for other Amazon Web Services accounts to copy or
	// restore a manual snapshot, set this list to include one or more Amazon Web
	// Services account identifiers, or all to remove authorization for any Amazon
	// Web Services account to copy or restore the DB snapshot. If you specify all,
	// an Amazon Web Services account whose account ID is explicitly added to the
	// restore attribute can still copy or restore the manual DB snapshot.
	ValuesToRemove []*string `locationNameList:"AttributeValue" type:"list"`
	// contains filtered or unexported fields
}

func (ModifyDBSnapshotAttributeInput) GoString added in v0.10.4

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBSnapshotAttributeInput) SetAttributeName added in v1.5.0

SetAttributeName sets the AttributeName field's value.

func (*ModifyDBSnapshotAttributeInput) SetDBSnapshotIdentifier added in v1.5.0

SetDBSnapshotIdentifier sets the DBSnapshotIdentifier field's value.

func (*ModifyDBSnapshotAttributeInput) SetValuesToAdd added in v1.5.0

SetValuesToAdd sets the ValuesToAdd field's value.

func (*ModifyDBSnapshotAttributeInput) SetValuesToRemove added in v1.5.0

SetValuesToRemove sets the ValuesToRemove field's value.

func (ModifyDBSnapshotAttributeInput) String added in v0.10.4

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBSnapshotAttributeInput) Validate added in v1.1.21

func (s *ModifyDBSnapshotAttributeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyDBSnapshotAttributeOutput added in v0.10.4

type ModifyDBSnapshotAttributeOutput struct {

	// Contains the results of a successful call to the DescribeDBSnapshotAttributes
	// API action.
	//
	// Manual DB snapshot attributes are used to authorize other Amazon Web Services
	// accounts to copy or restore a manual DB snapshot. For more information, see
	// the ModifyDBSnapshotAttribute API action.
	DBSnapshotAttributesResult *DBSnapshotAttributesResult `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyDBSnapshotAttributeOutput) GoString added in v0.10.4

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBSnapshotAttributeOutput) SetDBSnapshotAttributesResult added in v1.5.0

SetDBSnapshotAttributesResult sets the DBSnapshotAttributesResult field's value.

func (ModifyDBSnapshotAttributeOutput) String added in v0.10.4

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyDBSnapshotInput added in v1.6.18

type ModifyDBSnapshotInput struct {

	// The identifier of the DB snapshot to modify.
	//
	// DBSnapshotIdentifier is a required field
	DBSnapshotIdentifier *string `type:"string" required:"true"`

	// The engine version to upgrade the DB snapshot to.
	//
	// The following are the database engines and engine versions that are available
	// when you upgrade a DB snapshot.
	//
	// MySQL
	//
	//    * 5.5.46 (supported for 5.1 DB snapshots)
	//
	// Oracle
	//
	//    * 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
	//
	//    * 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
	//
	//    * 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)
	//
	// PostgreSQL
	//
	// For the list of engine versions that are available for upgrading a DB snapshot,
	// see Upgrading the PostgreSQL DB Engine for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.PostgreSQL.html#USER_UpgradeDBInstance.PostgreSQL.MajorVersion).
	EngineVersion *string `type:"string"`

	// The option group to identify with the upgraded DB snapshot.
	//
	// You can specify this parameter when you upgrade an Oracle DB snapshot. The
	// same option group considerations apply when upgrading a DB snapshot as when
	// upgrading a DB instance. For more information, see Option group considerations
	// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.OGPG.OG)
	// in the Amazon RDS User Guide.
	OptionGroupName *string `type:"string"`
	// contains filtered or unexported fields
}

func (ModifyDBSnapshotInput) GoString added in v1.6.18

func (s ModifyDBSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBSnapshotInput) SetDBSnapshotIdentifier added in v1.6.18

func (s *ModifyDBSnapshotInput) SetDBSnapshotIdentifier(v string) *ModifyDBSnapshotInput

SetDBSnapshotIdentifier sets the DBSnapshotIdentifier field's value.

func (*ModifyDBSnapshotInput) SetEngineVersion added in v1.6.18

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

SetEngineVersion sets the EngineVersion field's value.

func (*ModifyDBSnapshotInput) SetOptionGroupName added in v1.10.50

func (s *ModifyDBSnapshotInput) SetOptionGroupName(v string) *ModifyDBSnapshotInput

SetOptionGroupName sets the OptionGroupName field's value.

func (ModifyDBSnapshotInput) String added in v1.6.18

func (s ModifyDBSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBSnapshotInput) Validate added in v1.6.18

func (s *ModifyDBSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyDBSnapshotOutput added in v1.6.18

type ModifyDBSnapshotOutput struct {

	// Contains the details of an Amazon RDS DB snapshot.
	//
	// This data type is used as a response element in the DescribeDBSnapshots action.
	DBSnapshot *DBSnapshot `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyDBSnapshotOutput) GoString added in v1.6.18

func (s ModifyDBSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBSnapshotOutput) SetDBSnapshot added in v1.6.18

SetDBSnapshot sets the DBSnapshot field's value.

func (ModifyDBSnapshotOutput) String added in v1.6.18

func (s ModifyDBSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyDBSubnetGroupInput

type ModifyDBSubnetGroupInput struct {

	// The description for the DB subnet group.
	DBSubnetGroupDescription *string `type:"string"`

	// The name for the DB subnet group. This value is stored as a lowercase string.
	// You can't modify the default subnet group.
	//
	// Constraints: Must match the name of an existing DBSubnetGroup. Must not be
	// default.
	//
	// Example: mydbsubnetgroup
	//
	// DBSubnetGroupName is a required field
	DBSubnetGroupName *string `type:"string" required:"true"`

	// The EC2 subnet IDs for the DB subnet group.
	//
	// SubnetIds is a required field
	SubnetIds []*string `locationNameList:"SubnetIdentifier" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ModifyDBSubnetGroupInput) GoString added in v0.6.5

func (s ModifyDBSubnetGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBSubnetGroupInput) SetDBSubnetGroupDescription added in v1.5.0

func (s *ModifyDBSubnetGroupInput) SetDBSubnetGroupDescription(v string) *ModifyDBSubnetGroupInput

SetDBSubnetGroupDescription sets the DBSubnetGroupDescription field's value.

func (*ModifyDBSubnetGroupInput) SetDBSubnetGroupName added in v1.5.0

func (s *ModifyDBSubnetGroupInput) SetDBSubnetGroupName(v string) *ModifyDBSubnetGroupInput

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*ModifyDBSubnetGroupInput) SetSubnetIds added in v1.5.0

SetSubnetIds sets the SubnetIds field's value.

func (ModifyDBSubnetGroupInput) String added in v0.6.5

func (s ModifyDBSubnetGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBSubnetGroupInput) Validate added in v1.1.21

func (s *ModifyDBSubnetGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyDBSubnetGroupOutput

type ModifyDBSubnetGroupOutput struct {

	// Contains the details of an Amazon RDS DB subnet group.
	//
	// This data type is used as a response element in the DescribeDBSubnetGroups
	// action.
	DBSubnetGroup *DBSubnetGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyDBSubnetGroupOutput) GoString added in v0.6.5

func (s ModifyDBSubnetGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyDBSubnetGroupOutput) SetDBSubnetGroup added in v1.5.0

SetDBSubnetGroup sets the DBSubnetGroup field's value.

func (ModifyDBSubnetGroupOutput) String added in v0.6.5

func (s ModifyDBSubnetGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyEventSubscriptionInput

type ModifyEventSubscriptionInput struct {

	// A value that indicates whether to activate the subscription.
	Enabled *bool `type:"boolean"`

	// A list of event categories for a source type (SourceType) that you want to
	// subscribe to. You can see a list of the categories for a given source type
	// in Events (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html)
	// in the Amazon RDS User Guide or by using the DescribeEventCategories operation.
	EventCategories []*string `locationNameList:"EventCategory" type:"list"`

	// The Amazon Resource Name (ARN) of the SNS topic created for event notification.
	// The ARN is created by Amazon SNS when you create a topic and subscribe to
	// it.
	SnsTopicArn *string `type:"string"`

	// The type of source that is generating the events. For example, if you want
	// to be notified of events generated by a DB instance, you would set this parameter
	// to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't
	// specified, all events are returned.
	//
	// Valid values: db-instance | db-cluster | db-parameter-group | db-security-group
	// | db-snapshot | db-cluster-snapshot | db-proxy
	SourceType *string `type:"string"`

	// The name of the RDS event notification subscription.
	//
	// SubscriptionName is a required field
	SubscriptionName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ModifyEventSubscriptionInput) GoString added in v0.6.5

func (s ModifyEventSubscriptionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyEventSubscriptionInput) SetEnabled added in v1.5.0

SetEnabled sets the Enabled field's value.

func (*ModifyEventSubscriptionInput) SetEventCategories added in v1.5.0

SetEventCategories sets the EventCategories field's value.

func (*ModifyEventSubscriptionInput) SetSnsTopicArn added in v1.5.0

SetSnsTopicArn sets the SnsTopicArn field's value.

func (*ModifyEventSubscriptionInput) SetSourceType added in v1.5.0

SetSourceType sets the SourceType field's value.

func (*ModifyEventSubscriptionInput) SetSubscriptionName added in v1.5.0

SetSubscriptionName sets the SubscriptionName field's value.

func (ModifyEventSubscriptionInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyEventSubscriptionInput) Validate added in v1.1.21

func (s *ModifyEventSubscriptionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyEventSubscriptionOutput

type ModifyEventSubscriptionOutput struct {

	// Contains the results of a successful invocation of the DescribeEventSubscriptions
	// action.
	EventSubscription *EventSubscription `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyEventSubscriptionOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyEventSubscriptionOutput) SetEventSubscription added in v1.5.0

SetEventSubscription sets the EventSubscription field's value.

func (ModifyEventSubscriptionOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyGlobalClusterInput added in v1.15.85

type ModifyGlobalClusterInput struct {

	// A value that indicates whether major version upgrades are allowed.
	//
	// Constraints: You must allow major version upgrades when specifying a value
	// for the EngineVersion parameter that is a different major version than the
	// DB cluster's current version.
	//
	// If you upgrade the major version of a global database, the cluster and DB
	// instance parameter groups are set to the default parameter groups for the
	// new version. Apply any custom parameter groups after completing the upgrade.
	AllowMajorVersionUpgrade *bool `type:"boolean"`

	// Indicates if the global database cluster has deletion protection enabled.
	// The global database cluster can't be deleted when deletion protection is
	// enabled.
	DeletionProtection *bool `type:"boolean"`

	// The version number of the database engine to which you want to upgrade. Changing
	// this parameter results in an outage. The change is applied during the next
	// maintenance window unless ApplyImmediately is enabled.
	//
	// To list all of the available engine versions for aurora (for MySQL 5.6-compatible
	// Aurora), use the following command:
	//
	// aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases
	// == `true`].[EngineVersion]'
	//
	// To list all of the available engine versions for aurora-mysql (for MySQL
	// 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:
	//
	// aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases
	// == `true`].[EngineVersion]'
	//
	// To list all of the available engine versions for aurora-postgresql, use the
	// following command:
	//
	// aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases
	// == `true`].[EngineVersion]'
	EngineVersion *string `type:"string"`

	// The DB cluster identifier for the global cluster being modified. This parameter
	// isn't case-sensitive.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing global database cluster.
	GlobalClusterIdentifier *string `type:"string"`

	// The new cluster identifier for the global database cluster when modifying
	// a global database cluster. This value is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 letters, numbers, or hyphens
	//
	//    * The first character must be a letter
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens
	//
	// Example: my-cluster2
	NewGlobalClusterIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

func (ModifyGlobalClusterInput) GoString added in v1.15.85

func (s ModifyGlobalClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyGlobalClusterInput) SetAllowMajorVersionUpgrade added in v1.36.24

func (s *ModifyGlobalClusterInput) SetAllowMajorVersionUpgrade(v bool) *ModifyGlobalClusterInput

SetAllowMajorVersionUpgrade sets the AllowMajorVersionUpgrade field's value.

func (*ModifyGlobalClusterInput) SetDeletionProtection added in v1.15.85

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

SetDeletionProtection sets the DeletionProtection field's value.

func (*ModifyGlobalClusterInput) SetEngineVersion added in v1.36.24

SetEngineVersion sets the EngineVersion field's value.

func (*ModifyGlobalClusterInput) SetGlobalClusterIdentifier added in v1.15.85

func (s *ModifyGlobalClusterInput) SetGlobalClusterIdentifier(v string) *ModifyGlobalClusterInput

SetGlobalClusterIdentifier sets the GlobalClusterIdentifier field's value.

func (*ModifyGlobalClusterInput) SetNewGlobalClusterIdentifier added in v1.15.85

func (s *ModifyGlobalClusterInput) SetNewGlobalClusterIdentifier(v string) *ModifyGlobalClusterInput

SetNewGlobalClusterIdentifier sets the NewGlobalClusterIdentifier field's value.

func (ModifyGlobalClusterInput) String added in v1.15.85

func (s ModifyGlobalClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyGlobalClusterOutput added in v1.15.85

type ModifyGlobalClusterOutput struct {

	// A data type representing an Aurora global database.
	GlobalCluster *GlobalCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyGlobalClusterOutput) GoString added in v1.15.85

func (s ModifyGlobalClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyGlobalClusterOutput) SetGlobalCluster added in v1.15.85

SetGlobalCluster sets the GlobalCluster field's value.

func (ModifyGlobalClusterOutput) String added in v1.15.85

func (s ModifyGlobalClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyOptionGroupInput

type ModifyOptionGroupInput struct {

	// A value that indicates whether to apply the change immediately or during
	// the next maintenance window for each instance associated with the option
	// group.
	ApplyImmediately *bool `type:"boolean"`

	// The name of the option group to be modified.
	//
	// Permanent options, such as the TDE option for Oracle Advanced Security TDE,
	// can't be removed from an option group, and that option group can't be removed
	// from a DB instance once it is associated with a DB instance
	//
	// OptionGroupName is a required field
	OptionGroupName *string `type:"string" required:"true"`

	// Options in this list are added to the option group or, if already present,
	// the specified configuration is used to update the existing configuration.
	OptionsToInclude []*OptionConfiguration `locationNameList:"OptionConfiguration" type:"list"`

	// Options in this list are removed from the option group.
	OptionsToRemove []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ModifyOptionGroupInput) GoString added in v0.6.5

func (s ModifyOptionGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyOptionGroupInput) SetApplyImmediately added in v1.5.0

func (s *ModifyOptionGroupInput) SetApplyImmediately(v bool) *ModifyOptionGroupInput

SetApplyImmediately sets the ApplyImmediately field's value.

func (*ModifyOptionGroupInput) SetOptionGroupName added in v1.5.0

func (s *ModifyOptionGroupInput) SetOptionGroupName(v string) *ModifyOptionGroupInput

SetOptionGroupName sets the OptionGroupName field's value.

func (*ModifyOptionGroupInput) SetOptionsToInclude added in v1.5.0

SetOptionsToInclude sets the OptionsToInclude field's value.

func (*ModifyOptionGroupInput) SetOptionsToRemove added in v1.5.0

func (s *ModifyOptionGroupInput) SetOptionsToRemove(v []*string) *ModifyOptionGroupInput

SetOptionsToRemove sets the OptionsToRemove field's value.

func (ModifyOptionGroupInput) String added in v0.6.5

func (s ModifyOptionGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyOptionGroupInput) Validate added in v1.1.21

func (s *ModifyOptionGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyOptionGroupOutput

type ModifyOptionGroupOutput struct {
	OptionGroup *OptionGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyOptionGroupOutput) GoString added in v0.6.5

func (s ModifyOptionGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyOptionGroupOutput) SetOptionGroup added in v1.5.0

SetOptionGroup sets the OptionGroup field's value.

func (ModifyOptionGroupOutput) String added in v0.6.5

func (s ModifyOptionGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Option

type Option struct {

	// If the option requires access to a port, then this DB security group allows
	// access to the port.
	DBSecurityGroupMemberships []*DBSecurityGroupMembership `locationNameList:"DBSecurityGroup" type:"list"`

	// The description of the option.
	OptionDescription *string `type:"string"`

	// The name of the option.
	OptionName *string `type:"string"`

	// The option settings for this option.
	OptionSettings []*OptionSetting `locationNameList:"OptionSetting" type:"list"`

	// The version of the option.
	OptionVersion *string `type:"string"`

	// Indicate if this option is permanent.
	Permanent *bool `type:"boolean"`

	// Indicate if this option is persistent.
	Persistent *bool `type:"boolean"`

	// If required, the port configured for this option to use.
	Port *int64 `type:"integer"`

	// If the option requires access to a port, then this VPC security group allows
	// access to the port.
	VpcSecurityGroupMemberships []*VpcSecurityGroupMembership `locationNameList:"VpcSecurityGroupMembership" type:"list"`
	// contains filtered or unexported fields
}

Option details.

func (Option) GoString added in v0.6.5

func (s Option) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Option) SetDBSecurityGroupMemberships added in v1.5.0

func (s *Option) SetDBSecurityGroupMemberships(v []*DBSecurityGroupMembership) *Option

SetDBSecurityGroupMemberships sets the DBSecurityGroupMemberships field's value.

func (*Option) SetOptionDescription added in v1.5.0

func (s *Option) SetOptionDescription(v string) *Option

SetOptionDescription sets the OptionDescription field's value.

func (*Option) SetOptionName added in v1.5.0

func (s *Option) SetOptionName(v string) *Option

SetOptionName sets the OptionName field's value.

func (*Option) SetOptionSettings added in v1.5.0

func (s *Option) SetOptionSettings(v []*OptionSetting) *Option

SetOptionSettings sets the OptionSettings field's value.

func (*Option) SetOptionVersion added in v1.5.0

func (s *Option) SetOptionVersion(v string) *Option

SetOptionVersion sets the OptionVersion field's value.

func (*Option) SetPermanent added in v1.5.0

func (s *Option) SetPermanent(v bool) *Option

SetPermanent sets the Permanent field's value.

func (*Option) SetPersistent added in v1.5.0

func (s *Option) SetPersistent(v bool) *Option

SetPersistent sets the Persistent field's value.

func (*Option) SetPort added in v1.5.0

func (s *Option) SetPort(v int64) *Option

SetPort sets the Port field's value.

func (*Option) SetVpcSecurityGroupMemberships added in v1.5.0

func (s *Option) SetVpcSecurityGroupMemberships(v []*VpcSecurityGroupMembership) *Option

SetVpcSecurityGroupMemberships sets the VpcSecurityGroupMemberships field's value.

func (Option) String added in v0.6.5

func (s Option) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OptionConfiguration

type OptionConfiguration struct {

	// A list of DBSecurityGroupMembership name strings used for this option.
	DBSecurityGroupMemberships []*string `locationNameList:"DBSecurityGroupName" type:"list"`

	// The configuration of options to include in a group.
	//
	// OptionName is a required field
	OptionName *string `type:"string" required:"true"`

	// The option settings to include in an option group.
	OptionSettings []*OptionSetting `locationNameList:"OptionSetting" type:"list"`

	// The version for the option.
	OptionVersion *string `type:"string"`

	// The optional port for the option.
	Port *int64 `type:"integer"`

	// A list of VpcSecurityGroupMembership name strings used for this option.
	VpcSecurityGroupMemberships []*string `locationNameList:"VpcSecurityGroupId" type:"list"`
	// contains filtered or unexported fields
}

A list of all available options

func (OptionConfiguration) GoString added in v0.6.5

func (s OptionConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OptionConfiguration) SetDBSecurityGroupMemberships added in v1.5.0

func (s *OptionConfiguration) SetDBSecurityGroupMemberships(v []*string) *OptionConfiguration

SetDBSecurityGroupMemberships sets the DBSecurityGroupMemberships field's value.

func (*OptionConfiguration) SetOptionName added in v1.5.0

func (s *OptionConfiguration) SetOptionName(v string) *OptionConfiguration

SetOptionName sets the OptionName field's value.

func (*OptionConfiguration) SetOptionSettings added in v1.5.0

func (s *OptionConfiguration) SetOptionSettings(v []*OptionSetting) *OptionConfiguration

SetOptionSettings sets the OptionSettings field's value.

func (*OptionConfiguration) SetOptionVersion added in v1.5.0

func (s *OptionConfiguration) SetOptionVersion(v string) *OptionConfiguration

SetOptionVersion sets the OptionVersion field's value.

func (*OptionConfiguration) SetPort added in v1.5.0

SetPort sets the Port field's value.

func (*OptionConfiguration) SetVpcSecurityGroupMemberships added in v1.5.0

func (s *OptionConfiguration) SetVpcSecurityGroupMemberships(v []*string) *OptionConfiguration

SetVpcSecurityGroupMemberships sets the VpcSecurityGroupMemberships field's value.

func (OptionConfiguration) String added in v0.6.5

func (s OptionConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OptionConfiguration) Validate added in v1.1.21

func (s *OptionConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OptionGroup

type OptionGroup struct {

	// Indicates whether this option group can be applied to both VPC and non-VPC
	// instances. The value true indicates the option group can be applied to both
	// VPC and non-VPC instances.
	AllowsVpcAndNonVpcInstanceMemberships *bool `type:"boolean"`

	// Indicates the name of the engine that this option group can be applied to.
	EngineName *string `type:"string"`

	// Indicates the major engine version associated with this option group.
	MajorEngineVersion *string `type:"string"`

	// The Amazon Resource Name (ARN) for the option group.
	OptionGroupArn *string `type:"string"`

	// Provides a description of the option group.
	OptionGroupDescription *string `type:"string"`

	// Specifies the name of the option group.
	OptionGroupName *string `type:"string"`

	// Indicates what options are available in the option group.
	Options []*Option `locationNameList:"Option" type:"list"`

	// If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If
	// AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then
	// this option group can be applied to both VPC and non-VPC instances. If this
	// field contains a value, then this option group can only be applied to instances
	// that are in the VPC indicated by this field.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

func (OptionGroup) GoString added in v0.6.5

func (s OptionGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OptionGroup) SetAllowsVpcAndNonVpcInstanceMemberships added in v1.5.0

func (s *OptionGroup) SetAllowsVpcAndNonVpcInstanceMemberships(v bool) *OptionGroup

SetAllowsVpcAndNonVpcInstanceMemberships sets the AllowsVpcAndNonVpcInstanceMemberships field's value.

func (*OptionGroup) SetEngineName added in v1.5.0

func (s *OptionGroup) SetEngineName(v string) *OptionGroup

SetEngineName sets the EngineName field's value.

func (*OptionGroup) SetMajorEngineVersion added in v1.5.0

func (s *OptionGroup) SetMajorEngineVersion(v string) *OptionGroup

SetMajorEngineVersion sets the MajorEngineVersion field's value.

func (*OptionGroup) SetOptionGroupArn added in v1.5.0

func (s *OptionGroup) SetOptionGroupArn(v string) *OptionGroup

SetOptionGroupArn sets the OptionGroupArn field's value.

func (*OptionGroup) SetOptionGroupDescription added in v1.5.0

func (s *OptionGroup) SetOptionGroupDescription(v string) *OptionGroup

SetOptionGroupDescription sets the OptionGroupDescription field's value.

func (*OptionGroup) SetOptionGroupName added in v1.5.0

func (s *OptionGroup) SetOptionGroupName(v string) *OptionGroup

SetOptionGroupName sets the OptionGroupName field's value.

func (*OptionGroup) SetOptions added in v1.5.0

func (s *OptionGroup) SetOptions(v []*Option) *OptionGroup

SetOptions sets the Options field's value.

func (*OptionGroup) SetVpcId added in v1.5.0

func (s *OptionGroup) SetVpcId(v string) *OptionGroup

SetVpcId sets the VpcId field's value.

func (OptionGroup) String added in v0.6.5

func (s OptionGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OptionGroupMembership

type OptionGroupMembership struct {

	// The name of the option group that the instance belongs to.
	OptionGroupName *string `type:"string"`

	// The status of the DB instance's option group membership. Valid values are:
	// in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal,
	// applying, removing, and failed.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (OptionGroupMembership) GoString added in v0.6.5

func (s OptionGroupMembership) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OptionGroupMembership) SetOptionGroupName added in v1.5.0

func (s *OptionGroupMembership) SetOptionGroupName(v string) *OptionGroupMembership

SetOptionGroupName sets the OptionGroupName field's value.

func (*OptionGroupMembership) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (OptionGroupMembership) String added in v0.6.5

func (s OptionGroupMembership) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OptionGroupOption

type OptionGroupOption struct {

	// If the option requires a port, specifies the default port for the option.
	DefaultPort *int64 `type:"integer"`

	// The description of the option.
	Description *string `type:"string"`

	// The name of the engine that this option can be applied to.
	EngineName *string `type:"string"`

	// Indicates the major engine version that the option is available for.
	MajorEngineVersion *string `type:"string"`

	// The minimum required engine version for the option to be applied.
	MinimumRequiredMinorEngineVersion *string `type:"string"`

	// The name of the option.
	Name *string `type:"string"`

	// The option settings that are available (and the default value) for each option
	// in an option group.
	OptionGroupOptionSettings []*OptionGroupOptionSetting `locationNameList:"OptionGroupOptionSetting" type:"list"`

	// The versions that are available for the option.
	OptionGroupOptionVersions []*OptionVersion `locationNameList:"OptionVersion" type:"list"`

	// The options that conflict with this option.
	OptionsConflictsWith []*string `locationNameList:"OptionConflictName" type:"list"`

	// The options that are prerequisites for this option.
	OptionsDependedOn []*string `locationNameList:"OptionName" type:"list"`

	// Permanent options can never be removed from an option group. An option group
	// containing a permanent option can't be removed from a DB instance.
	Permanent *bool `type:"boolean"`

	// Persistent options can't be removed from an option group while DB instances
	// are associated with the option group. If you disassociate all DB instances
	// from the option group, your can remove the persistent option from the option
	// group.
	Persistent *bool `type:"boolean"`

	// Specifies whether the option requires a port.
	PortRequired *bool `type:"boolean"`

	// If true, you must enable the Auto Minor Version Upgrade setting for your
	// DB instance before you can use this option. You can enable Auto Minor Version
	// Upgrade when you first create your DB instance, or by modifying your DB instance
	// later.
	RequiresAutoMinorEngineVersionUpgrade *bool `type:"boolean"`

	// If true, you can change the option to an earlier version of the option. This
	// only applies to options that have different versions available.
	SupportsOptionVersionDowngrade *bool `type:"boolean"`

	// If true, you can only use this option with a DB instance that is in a VPC.
	VpcOnly *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Available option.

func (OptionGroupOption) GoString added in v0.6.5

func (s OptionGroupOption) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OptionGroupOption) SetDefaultPort added in v1.5.0

func (s *OptionGroupOption) SetDefaultPort(v int64) *OptionGroupOption

SetDefaultPort sets the DefaultPort field's value.

func (*OptionGroupOption) SetDescription added in v1.5.0

func (s *OptionGroupOption) SetDescription(v string) *OptionGroupOption

SetDescription sets the Description field's value.

func (*OptionGroupOption) SetEngineName added in v1.5.0

func (s *OptionGroupOption) SetEngineName(v string) *OptionGroupOption

SetEngineName sets the EngineName field's value.

func (*OptionGroupOption) SetMajorEngineVersion added in v1.5.0

func (s *OptionGroupOption) SetMajorEngineVersion(v string) *OptionGroupOption

SetMajorEngineVersion sets the MajorEngineVersion field's value.

func (*OptionGroupOption) SetMinimumRequiredMinorEngineVersion added in v1.5.0

func (s *OptionGroupOption) SetMinimumRequiredMinorEngineVersion(v string) *OptionGroupOption

SetMinimumRequiredMinorEngineVersion sets the MinimumRequiredMinorEngineVersion field's value.

func (*OptionGroupOption) SetName added in v1.5.0

SetName sets the Name field's value.

func (*OptionGroupOption) SetOptionGroupOptionSettings added in v1.5.0

func (s *OptionGroupOption) SetOptionGroupOptionSettings(v []*OptionGroupOptionSetting) *OptionGroupOption

SetOptionGroupOptionSettings sets the OptionGroupOptionSettings field's value.

func (*OptionGroupOption) SetOptionGroupOptionVersions added in v1.5.0

func (s *OptionGroupOption) SetOptionGroupOptionVersions(v []*OptionVersion) *OptionGroupOption

SetOptionGroupOptionVersions sets the OptionGroupOptionVersions field's value.

func (*OptionGroupOption) SetOptionsConflictsWith added in v1.5.0

func (s *OptionGroupOption) SetOptionsConflictsWith(v []*string) *OptionGroupOption

SetOptionsConflictsWith sets the OptionsConflictsWith field's value.

func (*OptionGroupOption) SetOptionsDependedOn added in v1.5.0

func (s *OptionGroupOption) SetOptionsDependedOn(v []*string) *OptionGroupOption

SetOptionsDependedOn sets the OptionsDependedOn field's value.

func (*OptionGroupOption) SetPermanent added in v1.5.0

func (s *OptionGroupOption) SetPermanent(v bool) *OptionGroupOption

SetPermanent sets the Permanent field's value.

func (*OptionGroupOption) SetPersistent added in v1.5.0

func (s *OptionGroupOption) SetPersistent(v bool) *OptionGroupOption

SetPersistent sets the Persistent field's value.

func (*OptionGroupOption) SetPortRequired added in v1.5.0

func (s *OptionGroupOption) SetPortRequired(v bool) *OptionGroupOption

SetPortRequired sets the PortRequired field's value.

func (*OptionGroupOption) SetRequiresAutoMinorEngineVersionUpgrade added in v1.10.33

func (s *OptionGroupOption) SetRequiresAutoMinorEngineVersionUpgrade(v bool) *OptionGroupOption

SetRequiresAutoMinorEngineVersionUpgrade sets the RequiresAutoMinorEngineVersionUpgrade field's value.

func (*OptionGroupOption) SetSupportsOptionVersionDowngrade added in v1.10.33

func (s *OptionGroupOption) SetSupportsOptionVersionDowngrade(v bool) *OptionGroupOption

SetSupportsOptionVersionDowngrade sets the SupportsOptionVersionDowngrade field's value.

func (*OptionGroupOption) SetVpcOnly added in v1.10.33

func (s *OptionGroupOption) SetVpcOnly(v bool) *OptionGroupOption

SetVpcOnly sets the VpcOnly field's value.

func (OptionGroupOption) String added in v0.6.5

func (s OptionGroupOption) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OptionGroupOptionSetting

type OptionGroupOptionSetting struct {

	// Indicates the acceptable values for the option group option.
	AllowedValues *string `type:"string"`

	// The DB engine specific parameter type for the option group option.
	ApplyType *string `type:"string"`

	// The default value for the option group option.
	DefaultValue *string `type:"string"`

	// Boolean value where true indicates that this option group option can be changed
	// from the default value.
	IsModifiable *bool `type:"boolean"`

	// Boolean value where true indicates that a value must be specified for this
	// option setting of the option group option.
	IsRequired *bool `type:"boolean"`

	// The minimum DB engine version required for the corresponding allowed value
	// for this option setting.
	MinimumEngineVersionPerAllowedValue []*MinimumEngineVersionPerAllowedValue `locationNameList:"MinimumEngineVersionPerAllowedValue" type:"list"`

	// The description of the option group option.
	SettingDescription *string `type:"string"`

	// The name of the option group option.
	SettingName *string `type:"string"`
	// contains filtered or unexported fields
}

Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

func (OptionGroupOptionSetting) GoString added in v0.6.5

func (s OptionGroupOptionSetting) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OptionGroupOptionSetting) SetAllowedValues added in v1.5.0

SetAllowedValues sets the AllowedValues field's value.

func (*OptionGroupOptionSetting) SetApplyType added in v1.5.0

SetApplyType sets the ApplyType field's value.

func (*OptionGroupOptionSetting) SetDefaultValue added in v1.5.0

SetDefaultValue sets the DefaultValue field's value.

func (*OptionGroupOptionSetting) SetIsModifiable added in v1.5.0

SetIsModifiable sets the IsModifiable field's value.

func (*OptionGroupOptionSetting) SetIsRequired added in v1.15.41

SetIsRequired sets the IsRequired field's value.

func (*OptionGroupOptionSetting) SetMinimumEngineVersionPerAllowedValue added in v1.15.41

func (s *OptionGroupOptionSetting) SetMinimumEngineVersionPerAllowedValue(v []*MinimumEngineVersionPerAllowedValue) *OptionGroupOptionSetting

SetMinimumEngineVersionPerAllowedValue sets the MinimumEngineVersionPerAllowedValue field's value.

func (*OptionGroupOptionSetting) SetSettingDescription added in v1.5.0

func (s *OptionGroupOptionSetting) SetSettingDescription(v string) *OptionGroupOptionSetting

SetSettingDescription sets the SettingDescription field's value.

func (*OptionGroupOptionSetting) SetSettingName added in v1.5.0

SetSettingName sets the SettingName field's value.

func (OptionGroupOptionSetting) String added in v0.6.5

func (s OptionGroupOptionSetting) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OptionSetting

type OptionSetting struct {

	// The allowed values of the option setting.
	AllowedValues *string `type:"string"`

	// The DB engine specific parameter type.
	ApplyType *string `type:"string"`

	// The data type of the option setting.
	DataType *string `type:"string"`

	// The default value of the option setting.
	DefaultValue *string `type:"string"`

	// The description of the option setting.
	Description *string `type:"string"`

	// Indicates if the option setting is part of a collection.
	IsCollection *bool `type:"boolean"`

	// A Boolean value that, when true, indicates the option setting can be modified
	// from the default.
	IsModifiable *bool `type:"boolean"`

	// The name of the option that has settings that you can set.
	Name *string `type:"string"`

	// The current value of the option setting.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

func (OptionSetting) GoString added in v0.6.5

func (s OptionSetting) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OptionSetting) SetAllowedValues added in v1.5.0

func (s *OptionSetting) SetAllowedValues(v string) *OptionSetting

SetAllowedValues sets the AllowedValues field's value.

func (*OptionSetting) SetApplyType added in v1.5.0

func (s *OptionSetting) SetApplyType(v string) *OptionSetting

SetApplyType sets the ApplyType field's value.

func (*OptionSetting) SetDataType added in v1.5.0

func (s *OptionSetting) SetDataType(v string) *OptionSetting

SetDataType sets the DataType field's value.

func (*OptionSetting) SetDefaultValue added in v1.5.0

func (s *OptionSetting) SetDefaultValue(v string) *OptionSetting

SetDefaultValue sets the DefaultValue field's value.

func (*OptionSetting) SetDescription added in v1.5.0

func (s *OptionSetting) SetDescription(v string) *OptionSetting

SetDescription sets the Description field's value.

func (*OptionSetting) SetIsCollection added in v1.5.0

func (s *OptionSetting) SetIsCollection(v bool) *OptionSetting

SetIsCollection sets the IsCollection field's value.

func (*OptionSetting) SetIsModifiable added in v1.5.0

func (s *OptionSetting) SetIsModifiable(v bool) *OptionSetting

SetIsModifiable sets the IsModifiable field's value.

func (*OptionSetting) SetName added in v1.5.0

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

SetName sets the Name field's value.

func (*OptionSetting) SetValue added in v1.5.0

func (s *OptionSetting) SetValue(v string) *OptionSetting

SetValue sets the Value field's value.

func (OptionSetting) String added in v0.6.5

func (s OptionSetting) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OptionVersion added in v1.3.0

type OptionVersion struct {

	// True if the version is the default version of the option, and otherwise false.
	IsDefault *bool `type:"boolean"`

	// The version of the option.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions action.

func (OptionVersion) GoString added in v1.3.0

func (s OptionVersion) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OptionVersion) SetIsDefault added in v1.5.0

func (s *OptionVersion) SetIsDefault(v bool) *OptionVersion

SetIsDefault sets the IsDefault field's value.

func (*OptionVersion) SetVersion added in v1.5.0

func (s *OptionVersion) SetVersion(v string) *OptionVersion

SetVersion sets the Version field's value.

func (OptionVersion) String added in v1.3.0

func (s OptionVersion) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OrderableDBInstanceOption

type OrderableDBInstanceOption struct {

	// The Availability Zone group for a DB instance.
	AvailabilityZoneGroup *string `type:"string"`

	// A list of Availability Zones for a DB instance.
	AvailabilityZones []*AvailabilityZone `locationNameList:"AvailabilityZone" type:"list"`

	// A list of the available processor features for the DB instance class of a
	// DB instance.
	AvailableProcessorFeatures []*AvailableProcessorFeature `locationNameList:"AvailableProcessorFeature" type:"list"`

	// The DB instance class for a DB instance.
	DBInstanceClass *string `type:"string"`

	// The engine type of a DB instance.
	Engine *string `type:"string"`

	// The engine version of a DB instance.
	EngineVersion *string `type:"string"`

	// The license model for a DB instance.
	LicenseModel *string `type:"string"`

	// Maximum total provisioned IOPS for a DB instance.
	MaxIopsPerDbInstance *int64 `type:"integer"`

	// Maximum provisioned IOPS per GiB for a DB instance.
	MaxIopsPerGib *float64 `type:"double"`

	// Maximum storage size for a DB instance.
	MaxStorageSize *int64 `type:"integer"`

	// Minimum total provisioned IOPS for a DB instance.
	MinIopsPerDbInstance *int64 `type:"integer"`

	// Minimum provisioned IOPS per GiB for a DB instance.
	MinIopsPerGib *float64 `type:"double"`

	// Minimum storage size for a DB instance.
	MinStorageSize *int64 `type:"integer"`

	// Indicates whether a DB instance is Multi-AZ capable.
	MultiAZCapable *bool `type:"boolean"`

	// Whether a DB instance supports RDS on Outposts.
	//
	// For more information about RDS on Outposts, see Amazon RDS on Amazon Web
	// Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)
	// in the Amazon RDS User Guide.
	OutpostCapable *bool `type:"boolean"`

	// Indicates whether a DB instance can have a read replica.
	ReadReplicaCapable *bool `type:"boolean"`

	// Indicates the storage type for a DB instance.
	StorageType *string `type:"string"`

	// The list of supported modes for Database Activity Streams. Aurora PostgreSQL
	// returns the value [sync, async]. Aurora MySQL and RDS for Oracle return [async]
	// only. If Database Activity Streams isn't supported, the return value is an
	// empty list.
	SupportedActivityStreamModes []*string `type:"list"`

	// A list of the supported DB engine modes.
	SupportedEngineModes []*string `type:"list"`

	// The network types supported by the DB instance (IPV4 or DUAL).
	//
	// A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6
	// protocols (DUAL).
	//
	// For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
	// in the Amazon RDS User Guide.
	SupportedNetworkTypes []*string `type:"list"`

	// Whether DB instances can be configured as a Multi-AZ DB cluster.
	//
	// For more information on Multi-AZ DB clusters, see Multi-AZ deployments with
	// two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
	// in the Amazon RDS User Guide.
	SupportsClusters *bool `type:"boolean"`

	// Indicates whether a DB instance supports Enhanced Monitoring at intervals
	// from 1 to 60 seconds.
	SupportsEnhancedMonitoring *bool `type:"boolean"`

	// A value that indicates whether you can use Aurora global databases with a
	// specific combination of other DB engine attributes.
	SupportsGlobalDatabases *bool `type:"boolean"`

	// Indicates whether a DB instance supports IAM database authentication.
	SupportsIAMDatabaseAuthentication *bool `type:"boolean"`

	// Indicates whether a DB instance supports provisioned IOPS.
	SupportsIops *bool `type:"boolean"`

	// Whether a DB instance supports Kerberos Authentication.
	SupportsKerberosAuthentication *bool `type:"boolean"`

	// True if a DB instance supports Performance Insights, otherwise false.
	SupportsPerformanceInsights *bool `type:"boolean"`

	// Whether Amazon RDS can automatically scale storage for DB instances that
	// use the specified DB instance class.
	SupportsStorageAutoscaling *bool `type:"boolean"`

	// Indicates whether a DB instance supports encrypted storage.
	SupportsStorageEncryption *bool `type:"boolean"`

	// Indicates whether a DB instance is in a VPC.
	Vpc *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Contains a list of available options for a DB instance.

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

func (OrderableDBInstanceOption) GoString added in v0.6.5

func (s OrderableDBInstanceOption) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OrderableDBInstanceOption) SetAvailabilityZoneGroup added in v1.30.13

func (s *OrderableDBInstanceOption) SetAvailabilityZoneGroup(v string) *OrderableDBInstanceOption

SetAvailabilityZoneGroup sets the AvailabilityZoneGroup field's value.

func (*OrderableDBInstanceOption) SetAvailabilityZones added in v1.5.0

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*OrderableDBInstanceOption) SetAvailableProcessorFeatures added in v1.14.1

func (s *OrderableDBInstanceOption) SetAvailableProcessorFeatures(v []*AvailableProcessorFeature) *OrderableDBInstanceOption

SetAvailableProcessorFeatures sets the AvailableProcessorFeatures field's value.

func (*OrderableDBInstanceOption) SetDBInstanceClass added in v1.5.0

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*OrderableDBInstanceOption) SetEngine added in v1.5.0

SetEngine sets the Engine field's value.

func (*OrderableDBInstanceOption) SetEngineVersion added in v1.5.0

SetEngineVersion sets the EngineVersion field's value.

func (*OrderableDBInstanceOption) SetLicenseModel added in v1.5.0

SetLicenseModel sets the LicenseModel field's value.

func (*OrderableDBInstanceOption) SetMaxIopsPerDbInstance added in v1.12.24

func (s *OrderableDBInstanceOption) SetMaxIopsPerDbInstance(v int64) *OrderableDBInstanceOption

SetMaxIopsPerDbInstance sets the MaxIopsPerDbInstance field's value.

func (*OrderableDBInstanceOption) SetMaxIopsPerGib added in v1.12.24

SetMaxIopsPerGib sets the MaxIopsPerGib field's value.

func (*OrderableDBInstanceOption) SetMaxStorageSize added in v1.12.24

SetMaxStorageSize sets the MaxStorageSize field's value.

func (*OrderableDBInstanceOption) SetMinIopsPerDbInstance added in v1.12.24

func (s *OrderableDBInstanceOption) SetMinIopsPerDbInstance(v int64) *OrderableDBInstanceOption

SetMinIopsPerDbInstance sets the MinIopsPerDbInstance field's value.

func (*OrderableDBInstanceOption) SetMinIopsPerGib added in v1.12.24

SetMinIopsPerGib sets the MinIopsPerGib field's value.

func (*OrderableDBInstanceOption) SetMinStorageSize added in v1.12.24

SetMinStorageSize sets the MinStorageSize field's value.

func (*OrderableDBInstanceOption) SetMultiAZCapable added in v1.5.0

func (s *OrderableDBInstanceOption) SetMultiAZCapable(v bool) *OrderableDBInstanceOption

SetMultiAZCapable sets the MultiAZCapable field's value.

func (*OrderableDBInstanceOption) SetOutpostCapable added in v1.33.2

func (s *OrderableDBInstanceOption) SetOutpostCapable(v bool) *OrderableDBInstanceOption

SetOutpostCapable sets the OutpostCapable field's value.

func (*OrderableDBInstanceOption) SetReadReplicaCapable added in v1.5.0

func (s *OrderableDBInstanceOption) SetReadReplicaCapable(v bool) *OrderableDBInstanceOption

SetReadReplicaCapable sets the ReadReplicaCapable field's value.

func (*OrderableDBInstanceOption) SetStorageType added in v1.5.0

SetStorageType sets the StorageType field's value.

func (*OrderableDBInstanceOption) SetSupportedActivityStreamModes added in v1.38.64

func (s *OrderableDBInstanceOption) SetSupportedActivityStreamModes(v []*string) *OrderableDBInstanceOption

SetSupportedActivityStreamModes sets the SupportedActivityStreamModes field's value.

func (*OrderableDBInstanceOption) SetSupportedEngineModes added in v1.15.9

func (s *OrderableDBInstanceOption) SetSupportedEngineModes(v []*string) *OrderableDBInstanceOption

SetSupportedEngineModes sets the SupportedEngineModes field's value.

func (*OrderableDBInstanceOption) SetSupportedNetworkTypes added in v1.44.4

func (s *OrderableDBInstanceOption) SetSupportedNetworkTypes(v []*string) *OrderableDBInstanceOption

SetSupportedNetworkTypes sets the SupportedNetworkTypes field's value.

func (*OrderableDBInstanceOption) SetSupportsClusters added in v1.42.11

func (s *OrderableDBInstanceOption) SetSupportsClusters(v bool) *OrderableDBInstanceOption

SetSupportsClusters sets the SupportsClusters field's value.

func (*OrderableDBInstanceOption) SetSupportsEnhancedMonitoring added in v1.5.0

func (s *OrderableDBInstanceOption) SetSupportsEnhancedMonitoring(v bool) *OrderableDBInstanceOption

SetSupportsEnhancedMonitoring sets the SupportsEnhancedMonitoring field's value.

func (*OrderableDBInstanceOption) SetSupportsGlobalDatabases added in v1.33.8

func (s *OrderableDBInstanceOption) SetSupportsGlobalDatabases(v bool) *OrderableDBInstanceOption

SetSupportsGlobalDatabases sets the SupportsGlobalDatabases field's value.

func (*OrderableDBInstanceOption) SetSupportsIAMDatabaseAuthentication added in v1.8.17

func (s *OrderableDBInstanceOption) SetSupportsIAMDatabaseAuthentication(v bool) *OrderableDBInstanceOption

SetSupportsIAMDatabaseAuthentication sets the SupportsIAMDatabaseAuthentication field's value.

func (*OrderableDBInstanceOption) SetSupportsIops added in v1.5.0

SetSupportsIops sets the SupportsIops field's value.

func (*OrderableDBInstanceOption) SetSupportsKerberosAuthentication added in v1.25.2

func (s *OrderableDBInstanceOption) SetSupportsKerberosAuthentication(v bool) *OrderableDBInstanceOption

SetSupportsKerberosAuthentication sets the SupportsKerberosAuthentication field's value.

func (*OrderableDBInstanceOption) SetSupportsPerformanceInsights added in v1.10.50

func (s *OrderableDBInstanceOption) SetSupportsPerformanceInsights(v bool) *OrderableDBInstanceOption

SetSupportsPerformanceInsights sets the SupportsPerformanceInsights field's value.

func (*OrderableDBInstanceOption) SetSupportsStorageAutoscaling added in v1.20.5

func (s *OrderableDBInstanceOption) SetSupportsStorageAutoscaling(v bool) *OrderableDBInstanceOption

SetSupportsStorageAutoscaling sets the SupportsStorageAutoscaling field's value.

func (*OrderableDBInstanceOption) SetSupportsStorageEncryption added in v1.5.0

func (s *OrderableDBInstanceOption) SetSupportsStorageEncryption(v bool) *OrderableDBInstanceOption

SetSupportsStorageEncryption sets the SupportsStorageEncryption field's value.

func (*OrderableDBInstanceOption) SetVpc added in v1.5.0

SetVpc sets the Vpc field's value.

func (OrderableDBInstanceOption) String added in v0.6.5

func (s OrderableDBInstanceOption) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Outpost added in v1.33.2

type Outpost struct {

	// The Amazon Resource Name (ARN) of the Outpost.
	Arn *string `type:"string"`
	// contains filtered or unexported fields
}

A data type that represents an Outpost.

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the Amazon RDS User Guide.

func (Outpost) GoString added in v1.33.2

func (s Outpost) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Outpost) SetArn added in v1.33.2

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

SetArn sets the Arn field's value.

func (Outpost) String added in v1.33.2

func (s Outpost) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Parameter

type Parameter struct {

	// Specifies the valid range of values for the parameter.
	AllowedValues *string `type:"string"`

	// Indicates when to apply parameter updates.
	ApplyMethod *string `type:"string" enum:"ApplyMethod"`

	// Specifies the engine specific parameters type.
	ApplyType *string `type:"string"`

	// Specifies the valid data type for the parameter.
	DataType *string `type:"string"`

	// Provides a description of the parameter.
	Description *string `type:"string"`

	// Indicates whether (true) or not (false) the parameter can be modified. Some
	// parameters have security or operational implications that prevent them from
	// being changed.
	IsModifiable *bool `type:"boolean"`

	// The earliest engine version to which the parameter can apply.
	MinimumEngineVersion *string `type:"string"`

	// Specifies the name of the parameter.
	ParameterName *string `type:"string"`

	// Specifies the value of the parameter.
	ParameterValue *string `type:"string"`

	// Indicates the source of the parameter value.
	Source *string `type:"string"`

	// The valid DB engine modes.
	SupportedEngineModes []*string `type:"list"`
	// contains filtered or unexported fields
}

This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

func (Parameter) GoString added in v0.6.5

func (s Parameter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Parameter) SetAllowedValues added in v1.5.0

func (s *Parameter) SetAllowedValues(v string) *Parameter

SetAllowedValues sets the AllowedValues field's value.

func (*Parameter) SetApplyMethod added in v1.5.0

func (s *Parameter) SetApplyMethod(v string) *Parameter

SetApplyMethod sets the ApplyMethod field's value.

func (*Parameter) SetApplyType added in v1.5.0

func (s *Parameter) SetApplyType(v string) *Parameter

SetApplyType sets the ApplyType field's value.

func (*Parameter) SetDataType added in v1.5.0

func (s *Parameter) SetDataType(v string) *Parameter

SetDataType sets the DataType field's value.

func (*Parameter) SetDescription added in v1.5.0

func (s *Parameter) SetDescription(v string) *Parameter

SetDescription sets the Description field's value.

func (*Parameter) SetIsModifiable added in v1.5.0

func (s *Parameter) SetIsModifiable(v bool) *Parameter

SetIsModifiable sets the IsModifiable field's value.

func (*Parameter) SetMinimumEngineVersion added in v1.5.0

func (s *Parameter) SetMinimumEngineVersion(v string) *Parameter

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*Parameter) SetParameterName added in v1.5.0

func (s *Parameter) SetParameterName(v string) *Parameter

SetParameterName sets the ParameterName field's value.

func (*Parameter) SetParameterValue added in v1.5.0

func (s *Parameter) SetParameterValue(v string) *Parameter

SetParameterValue sets the ParameterValue field's value.

func (*Parameter) SetSource added in v1.5.0

func (s *Parameter) SetSource(v string) *Parameter

SetSource sets the Source field's value.

func (*Parameter) SetSupportedEngineModes added in v1.15.9

func (s *Parameter) SetSupportedEngineModes(v []*string) *Parameter

SetSupportedEngineModes sets the SupportedEngineModes field's value.

func (Parameter) String added in v0.6.5

func (s Parameter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PendingCloudwatchLogsExports added in v1.12.63

type PendingCloudwatchLogsExports struct {

	// Log types that are in the process of being enabled. After they are enabled,
	// these log types are exported to CloudWatch Logs.
	LogTypesToDisable []*string `type:"list"`

	// Log types that are in the process of being deactivated. After they are deactivated,
	// these log types aren't exported to CloudWatch Logs.
	LogTypesToEnable []*string `type:"list"`
	// contains filtered or unexported fields
}

A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

func (PendingCloudwatchLogsExports) GoString added in v1.12.63

func (s PendingCloudwatchLogsExports) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PendingCloudwatchLogsExports) SetLogTypesToDisable added in v1.12.63

func (s *PendingCloudwatchLogsExports) SetLogTypesToDisable(v []*string) *PendingCloudwatchLogsExports

SetLogTypesToDisable sets the LogTypesToDisable field's value.

func (*PendingCloudwatchLogsExports) SetLogTypesToEnable added in v1.12.63

SetLogTypesToEnable sets the LogTypesToEnable field's value.

func (PendingCloudwatchLogsExports) String added in v1.12.63

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PendingMaintenanceAction

type PendingMaintenanceAction struct {

	// The type of pending maintenance action that is available for the resource.
	// Valid actions are system-update, db-upgrade, hardware-maintenance, and ca-certificate-rotation.
	Action *string `type:"string"`

	// The date of the maintenance window when the action is applied. The maintenance
	// action is applied to the resource during its first maintenance window after
	// this date.
	AutoAppliedAfterDate *time.Time `type:"timestamp"`

	// The effective date when the pending maintenance action is applied to the
	// resource. This date takes into account opt-in requests received from the
	// ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate.
	// This value is blank if an opt-in request has not been received and nothing
	// has been specified as AutoAppliedAfterDate or ForcedApplyDate.
	CurrentApplyDate *time.Time `type:"timestamp"`

	// A description providing more detail about the maintenance action.
	Description *string `type:"string"`

	// The date when the maintenance action is automatically applied.
	//
	// On this date, the maintenance action is applied to the resource as soon as
	// possible, regardless of the maintenance window for the resource. There might
	// be a delay of one or more days from this date before the maintenance action
	// is applied.
	ForcedApplyDate *time.Time `type:"timestamp"`

	// Indicates the type of opt-in request that has been received for the resource.
	OptInStatus *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a pending maintenance action for a resource.

func (PendingMaintenanceAction) GoString added in v0.6.5

func (s PendingMaintenanceAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PendingMaintenanceAction) SetAction added in v1.5.0

SetAction sets the Action field's value.

func (*PendingMaintenanceAction) SetAutoAppliedAfterDate added in v1.5.0

func (s *PendingMaintenanceAction) SetAutoAppliedAfterDate(v time.Time) *PendingMaintenanceAction

SetAutoAppliedAfterDate sets the AutoAppliedAfterDate field's value.

func (*PendingMaintenanceAction) SetCurrentApplyDate added in v1.5.0

func (s *PendingMaintenanceAction) SetCurrentApplyDate(v time.Time) *PendingMaintenanceAction

SetCurrentApplyDate sets the CurrentApplyDate field's value.

func (*PendingMaintenanceAction) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (*PendingMaintenanceAction) SetForcedApplyDate added in v1.5.0

func (s *PendingMaintenanceAction) SetForcedApplyDate(v time.Time) *PendingMaintenanceAction

SetForcedApplyDate sets the ForcedApplyDate field's value.

func (*PendingMaintenanceAction) SetOptInStatus added in v1.5.0

SetOptInStatus sets the OptInStatus field's value.

func (PendingMaintenanceAction) String added in v0.6.5

func (s PendingMaintenanceAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PendingModifiedValues

type PendingModifiedValues struct {

	// The allocated storage size for the DB instance specified in gibibytes (GiB).
	AllocatedStorage *int64 `type:"integer"`

	// The automation mode of the RDS Custom DB instance: full or all-paused. If
	// full, the DB instance automates monitoring and instance recovery. If all-paused,
	// the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
	AutomationMode *string `type:"string" enum:"AutomationMode"`

	// The number of days for which automated backups are retained.
	BackupRetentionPeriod *int64 `type:"integer"`

	// The identifier of the CA certificate for the DB instance.
	CACertificateIdentifier *string `type:"string"`

	// The name of the compute and memory capacity class for the DB instance.
	DBInstanceClass *string `type:"string"`

	// The database identifier for the DB instance.
	DBInstanceIdentifier *string `type:"string"`

	// The DB subnet group for the DB instance.
	DBSubnetGroupName *string `type:"string"`

	// The database engine version.
	EngineVersion *string `type:"string"`

	// Whether mapping of Amazon Web Services Identity and Access Management (IAM)
	// accounts to database accounts is enabled.
	IAMDatabaseAuthenticationEnabled *bool `type:"boolean"`

	// The Provisioned IOPS value for the DB instance.
	Iops *int64 `type:"integer"`

	// The license model for the DB instance.
	//
	// Valid values: license-included | bring-your-own-license | general-public-license
	LicenseModel *string `type:"string"`

	// The master credentials for the DB instance.
	MasterUserPassword *string `type:"string"`

	// A value that indicates that the Single-AZ DB instance will change to a Multi-AZ
	// deployment.
	MultiAZ *bool `type:"boolean"`

	// A list of the log types whose configuration is still pending. In other words,
	// these log types are in the process of being activated or deactivated.
	PendingCloudwatchLogsExports *PendingCloudwatchLogsExports `type:"structure"`

	// The port for the DB instance.
	Port *int64 `type:"integer"`

	// The number of CPU cores and the number of threads per core for the DB instance
	// class of the DB instance.
	ProcessorFeatures []*ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"`

	// The number of minutes to pause the automation. When the time period ends,
	// RDS Custom resumes full automation. The minimum value is 60 (default). The
	// maximum value is 1,440.
	ResumeFullAutomationModeTime *time.Time `type:"timestamp"`

	// The storage type of the DB instance.
	StorageType *string `type:"string"`
	// contains filtered or unexported fields
}

This data type is used as a response element in the ModifyDBInstance operation and contains changes that will be applied during the next maintenance window.

func (PendingModifiedValues) GoString added in v0.6.5

func (s PendingModifiedValues) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PendingModifiedValues) SetAllocatedStorage added in v1.5.0

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

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*PendingModifiedValues) SetAutomationMode added in v1.41.10

func (s *PendingModifiedValues) SetAutomationMode(v string) *PendingModifiedValues

SetAutomationMode sets the AutomationMode field's value.

func (*PendingModifiedValues) SetBackupRetentionPeriod added in v1.5.0

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*PendingModifiedValues) SetCACertificateIdentifier added in v1.5.0

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

SetCACertificateIdentifier sets the CACertificateIdentifier field's value.

func (*PendingModifiedValues) SetDBInstanceClass added in v1.5.0

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

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*PendingModifiedValues) SetDBInstanceIdentifier added in v1.5.0

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*PendingModifiedValues) SetDBSubnetGroupName added in v1.5.0

func (s *PendingModifiedValues) SetDBSubnetGroupName(v string) *PendingModifiedValues

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*PendingModifiedValues) SetEngineVersion added in v1.5.0

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

SetEngineVersion sets the EngineVersion field's value.

func (*PendingModifiedValues) SetIAMDatabaseAuthenticationEnabled added in v1.36.12

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

SetIAMDatabaseAuthenticationEnabled sets the IAMDatabaseAuthenticationEnabled field's value.

func (*PendingModifiedValues) SetIops added in v1.5.0

SetIops sets the Iops field's value.

func (*PendingModifiedValues) SetLicenseModel added in v1.5.0

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

SetLicenseModel sets the LicenseModel field's value.

func (*PendingModifiedValues) SetMasterUserPassword added in v1.5.0

func (s *PendingModifiedValues) SetMasterUserPassword(v string) *PendingModifiedValues

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*PendingModifiedValues) SetMultiAZ added in v1.5.0

SetMultiAZ sets the MultiAZ field's value.

func (*PendingModifiedValues) SetPendingCloudwatchLogsExports added in v1.12.63

func (s *PendingModifiedValues) SetPendingCloudwatchLogsExports(v *PendingCloudwatchLogsExports) *PendingModifiedValues

SetPendingCloudwatchLogsExports sets the PendingCloudwatchLogsExports field's value.

func (*PendingModifiedValues) SetPort added in v1.5.0

SetPort sets the Port field's value.

func (*PendingModifiedValues) SetProcessorFeatures added in v1.14.1

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

SetProcessorFeatures sets the ProcessorFeatures field's value.

func (*PendingModifiedValues) SetResumeFullAutomationModeTime added in v1.41.10

func (s *PendingModifiedValues) SetResumeFullAutomationModeTime(v time.Time) *PendingModifiedValues

SetResumeFullAutomationModeTime sets the ResumeFullAutomationModeTime field's value.

func (*PendingModifiedValues) SetStorageType added in v1.5.0

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

SetStorageType sets the StorageType field's value.

func (PendingModifiedValues) String added in v0.6.5

func (s PendingModifiedValues) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProcessorFeature added in v1.14.1

type ProcessorFeature struct {

	// The name of the processor feature. Valid names are coreCount and threadsPerCore.
	Name *string `type:"string"`

	// The value of a processor feature name.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

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

If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:

  • You are accessing an Oracle DB instance.

  • Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.

  • The current number CPU cores and threads is set to a non-default value.

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.

func (ProcessorFeature) GoString added in v1.14.1

func (s ProcessorFeature) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProcessorFeature) SetName added in v1.14.1

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

SetName sets the Name field's value.

func (*ProcessorFeature) SetValue added in v1.14.1

func (s *ProcessorFeature) SetValue(v string) *ProcessorFeature

SetValue sets the Value field's value.

func (ProcessorFeature) String added in v1.14.1

func (s ProcessorFeature) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PromoteReadReplicaDBClusterInput added in v1.1.35

type PromoteReadReplicaDBClusterInput struct {

	// The identifier of the DB cluster read replica to promote. This parameter
	// isn't case-sensitive.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DB cluster read replica.
	//
	// Example: my-cluster-replica1
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PromoteReadReplicaDBClusterInput) GoString added in v1.1.35

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PromoteReadReplicaDBClusterInput) SetDBClusterIdentifier added in v1.5.0

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (PromoteReadReplicaDBClusterInput) String added in v1.1.35

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PromoteReadReplicaDBClusterInput) Validate added in v1.1.35

Validate inspects the fields of the type to determine if they are valid.

type PromoteReadReplicaDBClusterOutput added in v1.1.35

type PromoteReadReplicaDBClusterOutput struct {

	// Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
	//
	// For an Amazon Aurora DB cluster, this data type is used as a response element
	// in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot,
	// RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
	//
	// For a Multi-AZ DB cluster, this data type is used as a response element in
	// the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
	//
	// For more information on Amazon Aurora DB clusters, see What is Amazon Aurora?
	// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)
	// in the Amazon Aurora User Guide.
	//
	// For more information on Multi-AZ DB clusters, see Multi-AZ deployments with
	// two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
	// in the Amazon RDS User Guide.
	DBCluster *DBCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (PromoteReadReplicaDBClusterOutput) GoString added in v1.1.35

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PromoteReadReplicaDBClusterOutput) SetDBCluster added in v1.5.0

SetDBCluster sets the DBCluster field's value.

func (PromoteReadReplicaDBClusterOutput) String added in v1.1.35

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PromoteReadReplicaInput

type PromoteReadReplicaInput struct {

	// The number of days for which automated backups are retained. Setting this
	// parameter to a positive number enables backups. Setting this parameter to
	// 0 disables automated backups.
	//
	// Default: 1
	//
	// Constraints:
	//
	//    * Must be a value from 0 to 35.
	//
	//    * Can't be set to 0 if the DB instance is a source to read replicas.
	BackupRetentionPeriod *int64 `type:"integer"`

	// The DB instance identifier. This value is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing read replica DB instance.
	//
	// Example: mydbinstance
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`

	// The daily time range during which automated backups are created if automated
	// backups are enabled, using the BackupRetentionPeriod parameter.
	//
	// The default is a 30-minute window selected at random from an 8-hour block
	// of time for each Amazon Web Services Region. To see the time blocks available,
	// see Adjusting the Preferred Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html)
	// in the Amazon RDS User Guide.
	//
	// Constraints:
	//
	//    * Must be in the format hh24:mi-hh24:mi.
	//
	//    * Must be in Universal Coordinated Time (UTC).
	//
	//    * Must not conflict with the preferred maintenance window.
	//
	//    * Must be at least 30 minutes.
	PreferredBackupWindow *string `type:"string"`
	// contains filtered or unexported fields
}

func (PromoteReadReplicaInput) GoString added in v0.6.5

func (s PromoteReadReplicaInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PromoteReadReplicaInput) SetBackupRetentionPeriod added in v1.5.0

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*PromoteReadReplicaInput) SetDBInstanceIdentifier added in v1.5.0

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*PromoteReadReplicaInput) SetPreferredBackupWindow added in v1.5.0

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (PromoteReadReplicaInput) String added in v0.6.5

func (s PromoteReadReplicaInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PromoteReadReplicaInput) Validate added in v1.1.21

func (s *PromoteReadReplicaInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PromoteReadReplicaOutput

type PromoteReadReplicaOutput struct {

	// Contains the details of an Amazon RDS DB instance.
	//
	// This data type is used as a response element in the operations CreateDBInstance,
	// CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance,
	// PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,
	// RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
	DBInstance *DBInstance `type:"structure"`
	// contains filtered or unexported fields
}

func (PromoteReadReplicaOutput) GoString added in v0.6.5

func (s PromoteReadReplicaOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PromoteReadReplicaOutput) SetDBInstance added in v1.5.0

SetDBInstance sets the DBInstance field's value.

func (PromoteReadReplicaOutput) String added in v0.6.5

func (s PromoteReadReplicaOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PurchaseReservedDBInstancesOfferingInput

type PurchaseReservedDBInstancesOfferingInput struct {

	// The number of instances to reserve.
	//
	// Default: 1
	DBInstanceCount *int64 `type:"integer"`

	// Customer-specified identifier to track this reservation.
	//
	// Example: myreservationID
	ReservedDBInstanceId *string `type:"string"`

	// The ID of the Reserved DB instance offering to purchase.
	//
	// Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
	//
	// ReservedDBInstancesOfferingId is a required field
	ReservedDBInstancesOfferingId *string `type:"string" required:"true"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

func (PurchaseReservedDBInstancesOfferingInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PurchaseReservedDBInstancesOfferingInput) SetDBInstanceCount added in v1.5.0

SetDBInstanceCount sets the DBInstanceCount field's value.

func (*PurchaseReservedDBInstancesOfferingInput) SetReservedDBInstanceId added in v1.5.0

SetReservedDBInstanceId sets the ReservedDBInstanceId field's value.

func (*PurchaseReservedDBInstancesOfferingInput) SetReservedDBInstancesOfferingId added in v1.5.0

SetReservedDBInstancesOfferingId sets the ReservedDBInstancesOfferingId field's value.

func (*PurchaseReservedDBInstancesOfferingInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (PurchaseReservedDBInstancesOfferingInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PurchaseReservedDBInstancesOfferingInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type PurchaseReservedDBInstancesOfferingOutput

type PurchaseReservedDBInstancesOfferingOutput struct {

	// This data type is used as a response element in the DescribeReservedDBInstances
	// and PurchaseReservedDBInstancesOffering actions.
	ReservedDBInstance *ReservedDBInstance `type:"structure"`
	// contains filtered or unexported fields
}

func (PurchaseReservedDBInstancesOfferingOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PurchaseReservedDBInstancesOfferingOutput) SetReservedDBInstance added in v1.5.0

SetReservedDBInstance sets the ReservedDBInstance field's value.

func (PurchaseReservedDBInstancesOfferingOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RDS

type RDS struct {
	*client.Client
}

RDS provides the API operation methods for making requests to Amazon Relational Database Service. See this package's package overview docs for details on the service.

RDS methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *RDS

New creates a new instance of the RDS client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a RDS client from just a session.
svc := rds.New(mySession)

// Create a RDS client with additional configuration
svc := rds.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*RDS) AddRoleToDBCluster added in v1.4.19

func (c *RDS) AddRoleToDBCluster(input *AddRoleToDBClusterInput) (*AddRoleToDBClusterOutput, error)

AddRoleToDBCluster API operation for Amazon Relational Database Service.

Associates an Identity and Access Management (IAM) role with a DB cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation AddRoleToDBCluster for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeDBClusterRoleAlreadyExistsFault "DBClusterRoleAlreadyExists" The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeDBClusterRoleQuotaExceededFault "DBClusterRoleQuotaExceeded" You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/AddRoleToDBCluster

func (*RDS) AddRoleToDBClusterRequest added in v1.4.19

func (c *RDS) AddRoleToDBClusterRequest(input *AddRoleToDBClusterInput) (req *request.Request, output *AddRoleToDBClusterOutput)

AddRoleToDBClusterRequest generates a "aws/request.Request" representing the client's request for the AddRoleToDBCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddRoleToDBCluster for more information on using the AddRoleToDBCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AddRoleToDBClusterRequest method.
req, resp := client.AddRoleToDBClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/AddRoleToDBCluster

func (*RDS) AddRoleToDBClusterWithContext added in v1.8.0

func (c *RDS) AddRoleToDBClusterWithContext(ctx aws.Context, input *AddRoleToDBClusterInput, opts ...request.Option) (*AddRoleToDBClusterOutput, error)

AddRoleToDBClusterWithContext is the same as AddRoleToDBCluster with the addition of the ability to pass a context and additional request options.

See AddRoleToDBCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) AddRoleToDBInstance added in v1.16.25

func (c *RDS) AddRoleToDBInstance(input *AddRoleToDBInstanceInput) (*AddRoleToDBInstanceOutput, error)

AddRoleToDBInstance API operation for Amazon Relational Database Service.

Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

To add a role to a DB instance, the status of the DB instance must be available.

This command doesn't apply to RDS Custom.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation AddRoleToDBInstance for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeDBInstanceRoleAlreadyExistsFault "DBInstanceRoleAlreadyExists" The specified RoleArn or FeatureName value is already associated with the DB instance.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

  • ErrCodeDBInstanceRoleQuotaExceededFault "DBInstanceRoleQuotaExceeded" You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/AddRoleToDBInstance

func (*RDS) AddRoleToDBInstanceRequest added in v1.16.25

func (c *RDS) AddRoleToDBInstanceRequest(input *AddRoleToDBInstanceInput) (req *request.Request, output *AddRoleToDBInstanceOutput)

AddRoleToDBInstanceRequest generates a "aws/request.Request" representing the client's request for the AddRoleToDBInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddRoleToDBInstance for more information on using the AddRoleToDBInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AddRoleToDBInstanceRequest method.
req, resp := client.AddRoleToDBInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/AddRoleToDBInstance

func (*RDS) AddRoleToDBInstanceWithContext added in v1.16.25

func (c *RDS) AddRoleToDBInstanceWithContext(ctx aws.Context, input *AddRoleToDBInstanceInput, opts ...request.Option) (*AddRoleToDBInstanceOutput, error)

AddRoleToDBInstanceWithContext is the same as AddRoleToDBInstance with the addition of the ability to pass a context and additional request options.

See AddRoleToDBInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) AddSourceIdentifierToSubscription

func (c *RDS) AddSourceIdentifierToSubscription(input *AddSourceIdentifierToSubscriptionInput) (*AddSourceIdentifierToSubscriptionOutput, error)

AddSourceIdentifierToSubscription API operation for Amazon Relational Database Service.

Adds a source identifier to an existing RDS event notification subscription.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation AddSourceIdentifierToSubscription for usage and error information.

Returned Error Codes:

  • ErrCodeSubscriptionNotFoundFault "SubscriptionNotFound" The subscription name does not exist.

  • ErrCodeSourceNotFoundFault "SourceNotFound" The requested source could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/AddSourceIdentifierToSubscription

Example (Shared00)

To add a source identifier to an event notification subscription This example add a source identifier to an event notification subscription.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.AddSourceIdentifierToSubscriptionInput{
		SourceIdentifier: aws.String("mymysqlinstance"),
		SubscriptionName: aws.String("mymysqleventsubscription"),
	}

	result, err := svc.AddSourceIdentifierToSubscription(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeSubscriptionNotFoundFault:
				fmt.Println(rds.ErrCodeSubscriptionNotFoundFault, aerr.Error())
			case rds.ErrCodeSourceNotFoundFault:
				fmt.Println(rds.ErrCodeSourceNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) AddSourceIdentifierToSubscriptionRequest

func (c *RDS) AddSourceIdentifierToSubscriptionRequest(input *AddSourceIdentifierToSubscriptionInput) (req *request.Request, output *AddSourceIdentifierToSubscriptionOutput)

AddSourceIdentifierToSubscriptionRequest generates a "aws/request.Request" representing the client's request for the AddSourceIdentifierToSubscription operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddSourceIdentifierToSubscription for more information on using the AddSourceIdentifierToSubscription API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AddSourceIdentifierToSubscriptionRequest method.
req, resp := client.AddSourceIdentifierToSubscriptionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/AddSourceIdentifierToSubscription

func (*RDS) AddSourceIdentifierToSubscriptionWithContext added in v1.8.0

func (c *RDS) AddSourceIdentifierToSubscriptionWithContext(ctx aws.Context, input *AddSourceIdentifierToSubscriptionInput, opts ...request.Option) (*AddSourceIdentifierToSubscriptionOutput, error)

AddSourceIdentifierToSubscriptionWithContext is the same as AddSourceIdentifierToSubscription with the addition of the ability to pass a context and additional request options.

See AddSourceIdentifierToSubscription for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) AddTagsToResource

func (c *RDS) AddTagsToResource(input *AddTagsToResourceInput) (*AddTagsToResourceOutput, error)

AddTagsToResource API operation for Amazon Relational Database Service.

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation AddTagsToResource for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound" DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

  • ErrCodeDBProxyNotFoundFault "DBProxyNotFoundFault" The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeDBProxyTargetGroupNotFoundFault "DBProxyTargetGroupNotFoundFault" The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/AddTagsToResource

Example (Shared00)

To add tags to a resource This example adds a tag to an option group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.AddTagsToResourceInput{
		ResourceName: aws.String("arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup"),
		Tags: []*rds.Tag{
			{
				Key:   aws.String("Staging"),
				Value: aws.String("LocationDB"),
			},
		},
	}

	result, err := svc.AddTagsToResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBInstanceNotFoundFault:
				fmt.Println(rds.ErrCodeDBInstanceNotFoundFault, aerr.Error())
			case rds.ErrCodeDBClusterNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterNotFoundFault, aerr.Error())
			case rds.ErrCodeDBSnapshotNotFoundFault:
				fmt.Println(rds.ErrCodeDBSnapshotNotFoundFault, aerr.Error())
			case rds.ErrCodeDBProxyNotFoundFault:
				fmt.Println(rds.ErrCodeDBProxyNotFoundFault, aerr.Error())
			case rds.ErrCodeDBProxyTargetGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBProxyTargetGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) AddTagsToResourceRequest

func (c *RDS) AddTagsToResourceRequest(input *AddTagsToResourceInput) (req *request.Request, output *AddTagsToResourceOutput)

AddTagsToResourceRequest generates a "aws/request.Request" representing the client's request for the AddTagsToResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddTagsToResource for more information on using the AddTagsToResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AddTagsToResourceRequest method.
req, resp := client.AddTagsToResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/AddTagsToResource

func (*RDS) AddTagsToResourceWithContext added in v1.8.0

func (c *RDS) AddTagsToResourceWithContext(ctx aws.Context, input *AddTagsToResourceInput, opts ...request.Option) (*AddTagsToResourceOutput, error)

AddTagsToResourceWithContext is the same as AddTagsToResource with the addition of the ability to pass a context and additional request options.

See AddTagsToResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ApplyPendingMaintenanceAction

func (c *RDS) ApplyPendingMaintenanceAction(input *ApplyPendingMaintenanceActionInput) (*ApplyPendingMaintenanceActionOutput, error)

ApplyPendingMaintenanceAction API operation for Amazon Relational Database Service.

Applies a pending maintenance action to a resource (for example, to a DB instance).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ApplyPendingMaintenanceAction for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundFault "ResourceNotFoundFault" The specified resource ID was not found.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ApplyPendingMaintenanceAction

Example (Shared00)

To apply a pending maintenance action This example immediately applies a pending system update to a DB instance.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.ApplyPendingMaintenanceActionInput{
		ApplyAction:        aws.String("system-update"),
		OptInType:          aws.String("immediate"),
		ResourceIdentifier: aws.String("arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance"),
	}

	result, err := svc.ApplyPendingMaintenanceAction(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeResourceNotFoundFault:
				fmt.Println(rds.ErrCodeResourceNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidDBClusterStateFault:
				fmt.Println(rds.ErrCodeInvalidDBClusterStateFault, aerr.Error())
			case rds.ErrCodeInvalidDBInstanceStateFault:
				fmt.Println(rds.ErrCodeInvalidDBInstanceStateFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) ApplyPendingMaintenanceActionRequest

func (c *RDS) ApplyPendingMaintenanceActionRequest(input *ApplyPendingMaintenanceActionInput) (req *request.Request, output *ApplyPendingMaintenanceActionOutput)

ApplyPendingMaintenanceActionRequest generates a "aws/request.Request" representing the client's request for the ApplyPendingMaintenanceAction operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ApplyPendingMaintenanceAction for more information on using the ApplyPendingMaintenanceAction API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ApplyPendingMaintenanceActionRequest method.
req, resp := client.ApplyPendingMaintenanceActionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ApplyPendingMaintenanceAction

func (*RDS) ApplyPendingMaintenanceActionWithContext added in v1.8.0

func (c *RDS) ApplyPendingMaintenanceActionWithContext(ctx aws.Context, input *ApplyPendingMaintenanceActionInput, opts ...request.Option) (*ApplyPendingMaintenanceActionOutput, error)

ApplyPendingMaintenanceActionWithContext is the same as ApplyPendingMaintenanceAction with the addition of the ability to pass a context and additional request options.

See ApplyPendingMaintenanceAction for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) AuthorizeDBSecurityGroupIngress

func (c *RDS) AuthorizeDBSecurityGroupIngress(input *AuthorizeDBSecurityGroupIngressInput) (*AuthorizeDBSecurityGroupIngressOutput, error)

AuthorizeDBSecurityGroupIngress API operation for Amazon Relational Database Service.

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

For an overview of CIDR ranges, go to the Wikipedia Tutorial (http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare (http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/), and Moving a DB instance not in a VPC into a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation AuthorizeDBSecurityGroupIngress for usage and error information.

Returned Error Codes:

  • ErrCodeDBSecurityGroupNotFoundFault "DBSecurityGroupNotFound" DBSecurityGroupName doesn't refer to an existing DB security group.

  • ErrCodeInvalidDBSecurityGroupStateFault "InvalidDBSecurityGroupState" The state of the DB security group doesn't allow deletion.

  • ErrCodeAuthorizationAlreadyExistsFault "AuthorizationAlreadyExists" The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB security group.

  • ErrCodeAuthorizationQuotaExceededFault "AuthorizationQuotaExceeded" The DB security group authorization quota has been reached.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/AuthorizeDBSecurityGroupIngress

Example (Shared00)

To authorize DB security group integress This example authorizes access to the specified security group by the specified CIDR block.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.AuthorizeDBSecurityGroupIngressInput{
		CIDRIP:              aws.String("203.0.113.5/32"),
		DBSecurityGroupName: aws.String("mydbsecuritygroup"),
	}

	result, err := svc.AuthorizeDBSecurityGroupIngress(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBSecurityGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSecurityGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidDBSecurityGroupStateFault:
				fmt.Println(rds.ErrCodeInvalidDBSecurityGroupStateFault, aerr.Error())
			case rds.ErrCodeAuthorizationAlreadyExistsFault:
				fmt.Println(rds.ErrCodeAuthorizationAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeAuthorizationQuotaExceededFault:
				fmt.Println(rds.ErrCodeAuthorizationQuotaExceededFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) AuthorizeDBSecurityGroupIngressRequest

func (c *RDS) AuthorizeDBSecurityGroupIngressRequest(input *AuthorizeDBSecurityGroupIngressInput) (req *request.Request, output *AuthorizeDBSecurityGroupIngressOutput)

AuthorizeDBSecurityGroupIngressRequest generates a "aws/request.Request" representing the client's request for the AuthorizeDBSecurityGroupIngress operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AuthorizeDBSecurityGroupIngress for more information on using the AuthorizeDBSecurityGroupIngress API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AuthorizeDBSecurityGroupIngressRequest method.
req, resp := client.AuthorizeDBSecurityGroupIngressRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/AuthorizeDBSecurityGroupIngress

func (*RDS) AuthorizeDBSecurityGroupIngressWithContext added in v1.8.0

func (c *RDS) AuthorizeDBSecurityGroupIngressWithContext(ctx aws.Context, input *AuthorizeDBSecurityGroupIngressInput, opts ...request.Option) (*AuthorizeDBSecurityGroupIngressOutput, error)

AuthorizeDBSecurityGroupIngressWithContext is the same as AuthorizeDBSecurityGroupIngress with the addition of the ability to pass a context and additional request options.

See AuthorizeDBSecurityGroupIngress for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) BacktrackDBCluster added in v1.13.45

func (c *RDS) BacktrackDBCluster(input *BacktrackDBClusterInput) (*BacktrackDBClusterOutput, error)

BacktrackDBCluster API operation for Amazon Relational Database Service.

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

For more information on backtracking, see Backtracking an Aurora DB Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html) in the Amazon Aurora User Guide.

This action applies only to Aurora MySQL DB clusters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation BacktrackDBCluster for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/BacktrackDBCluster

func (*RDS) BacktrackDBClusterRequest added in v1.13.45

func (c *RDS) BacktrackDBClusterRequest(input *BacktrackDBClusterInput) (req *request.Request, output *BacktrackDBClusterOutput)

BacktrackDBClusterRequest generates a "aws/request.Request" representing the client's request for the BacktrackDBCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BacktrackDBCluster for more information on using the BacktrackDBCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BacktrackDBClusterRequest method.
req, resp := client.BacktrackDBClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/BacktrackDBCluster

func (*RDS) BacktrackDBClusterWithContext added in v1.13.45

func (c *RDS) BacktrackDBClusterWithContext(ctx aws.Context, input *BacktrackDBClusterInput, opts ...request.Option) (*BacktrackDBClusterOutput, error)

BacktrackDBClusterWithContext is the same as BacktrackDBCluster with the addition of the ability to pass a context and additional request options.

See BacktrackDBCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CancelExportTask added in v1.28.8

func (c *RDS) CancelExportTask(input *CancelExportTaskInput) (*CancelExportTaskOutput, error)

CancelExportTask API operation for Amazon Relational Database Service.

Cancels an export task in progress that is exporting a snapshot to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CancelExportTask for usage and error information.

Returned Error Codes:

  • ErrCodeExportTaskNotFoundFault "ExportTaskNotFound" The export task doesn't exist.

  • ErrCodeInvalidExportTaskStateFault "InvalidExportTaskStateFault" You can't cancel an export task that has completed.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CancelExportTask

func (*RDS) CancelExportTaskRequest added in v1.28.8

func (c *RDS) CancelExportTaskRequest(input *CancelExportTaskInput) (req *request.Request, output *CancelExportTaskOutput)

CancelExportTaskRequest generates a "aws/request.Request" representing the client's request for the CancelExportTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelExportTask for more information on using the CancelExportTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CancelExportTaskRequest method.
req, resp := client.CancelExportTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CancelExportTask

func (*RDS) CancelExportTaskWithContext added in v1.28.8

func (c *RDS) CancelExportTaskWithContext(ctx aws.Context, input *CancelExportTaskInput, opts ...request.Option) (*CancelExportTaskOutput, error)

CancelExportTaskWithContext is the same as CancelExportTask with the addition of the ability to pass a context and additional request options.

See CancelExportTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CopyDBClusterParameterGroup added in v1.2.5

func (c *RDS) CopyDBClusterParameterGroup(input *CopyDBClusterParameterGroupInput) (*CopyDBClusterParameterGroupOutput, error)

CopyDBClusterParameterGroup API operation for Amazon Relational Database Service.

Copies the specified DB cluster parameter group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CopyDBClusterParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing DB parameter group.

  • ErrCodeDBParameterGroupQuotaExceededFault "DBParameterGroupQuotaExceeded" The request would result in the user exceeding the allowed number of DB parameter groups.

  • ErrCodeDBParameterGroupAlreadyExistsFault "DBParameterGroupAlreadyExists" A DB parameter group with the same name exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CopyDBClusterParameterGroup

Example (Shared00)

To copy a DB cluster parameter group This example copies a DB cluster parameter group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.CopyDBClusterParameterGroupInput{
		SourceDBClusterParameterGroupIdentifier:  aws.String("mydbclusterparametergroup"),
		TargetDBClusterParameterGroupDescription: aws.String("My DB cluster parameter group copy"),
		TargetDBClusterParameterGroupIdentifier:  aws.String("mydbclusterparametergroup-copy"),
	}

	result, err := svc.CopyDBClusterParameterGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBParameterGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeDBParameterGroupQuotaExceededFault:
				fmt.Println(rds.ErrCodeDBParameterGroupQuotaExceededFault, aerr.Error())
			case rds.ErrCodeDBParameterGroupAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBParameterGroupAlreadyExistsFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) CopyDBClusterParameterGroupRequest added in v1.2.5

func (c *RDS) CopyDBClusterParameterGroupRequest(input *CopyDBClusterParameterGroupInput) (req *request.Request, output *CopyDBClusterParameterGroupOutput)

CopyDBClusterParameterGroupRequest generates a "aws/request.Request" representing the client's request for the CopyDBClusterParameterGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CopyDBClusterParameterGroup for more information on using the CopyDBClusterParameterGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CopyDBClusterParameterGroupRequest method.
req, resp := client.CopyDBClusterParameterGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CopyDBClusterParameterGroup

func (*RDS) CopyDBClusterParameterGroupWithContext added in v1.8.0

func (c *RDS) CopyDBClusterParameterGroupWithContext(ctx aws.Context, input *CopyDBClusterParameterGroupInput, opts ...request.Option) (*CopyDBClusterParameterGroupOutput, error)

CopyDBClusterParameterGroupWithContext is the same as CopyDBClusterParameterGroup with the addition of the ability to pass a context and additional request options.

See CopyDBClusterParameterGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CopyDBClusterSnapshot added in v0.7.1

func (c *RDS) CopyDBClusterSnapshot(input *CopyDBClusterSnapshotInput) (*CopyDBClusterSnapshotOutput, error)

CopyDBClusterSnapshot API operation for Amazon Relational Database Service.

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values:

  • KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the presigned URL.

To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.

For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html) in the Amazon Aurora User Guide.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CopyDBClusterSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterSnapshotAlreadyExistsFault "DBClusterSnapshotAlreadyExistsFault" The user already has a DB cluster snapshot with the given identifier.

  • ErrCodeDBClusterSnapshotNotFoundFault "DBClusterSnapshotNotFoundFault" DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeInvalidDBClusterSnapshotStateFault "InvalidDBClusterSnapshotStateFault" The supplied value isn't a valid DB cluster snapshot state.

  • ErrCodeSnapshotQuotaExceededFault "SnapshotQuotaExceeded" The request would result in the user exceeding the allowed number of DB snapshots.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred accessing an Amazon Web Services KMS key.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CopyDBClusterSnapshot

Example (Shared00)

To copy a DB cluster snapshot The following example copies an automated snapshot of a DB cluster to a new DB cluster snapshot.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.CopyDBClusterSnapshotInput{
		SourceDBClusterSnapshotIdentifier: aws.String("rds:sample-cluster-2016-09-14-10-38"),
		TargetDBClusterSnapshotIdentifier: aws.String("cluster-snapshot-copy-1"),
	}

	result, err := svc.CopyDBClusterSnapshot(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBClusterSnapshotAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBClusterSnapshotAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeDBClusterSnapshotNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterSnapshotNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidDBClusterStateFault:
				fmt.Println(rds.ErrCodeInvalidDBClusterStateFault, aerr.Error())
			case rds.ErrCodeInvalidDBClusterSnapshotStateFault:
				fmt.Println(rds.ErrCodeInvalidDBClusterSnapshotStateFault, aerr.Error())
			case rds.ErrCodeSnapshotQuotaExceededFault:
				fmt.Println(rds.ErrCodeSnapshotQuotaExceededFault, aerr.Error())
			case rds.ErrCodeKMSKeyNotAccessibleFault:
				fmt.Println(rds.ErrCodeKMSKeyNotAccessibleFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) CopyDBClusterSnapshotRequest added in v0.7.1

func (c *RDS) CopyDBClusterSnapshotRequest(input *CopyDBClusterSnapshotInput) (req *request.Request, output *CopyDBClusterSnapshotOutput)

CopyDBClusterSnapshotRequest generates a "aws/request.Request" representing the client's request for the CopyDBClusterSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CopyDBClusterSnapshot for more information on using the CopyDBClusterSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CopyDBClusterSnapshotRequest method.
req, resp := client.CopyDBClusterSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CopyDBClusterSnapshot

func (*RDS) CopyDBClusterSnapshotWithContext added in v1.8.0

func (c *RDS) CopyDBClusterSnapshotWithContext(ctx aws.Context, input *CopyDBClusterSnapshotInput, opts ...request.Option) (*CopyDBClusterSnapshotOutput, error)

CopyDBClusterSnapshotWithContext is the same as CopyDBClusterSnapshot with the addition of the ability to pass a context and additional request options.

See CopyDBClusterSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CopyDBParameterGroup

func (c *RDS) CopyDBParameterGroup(input *CopyDBParameterGroupInput) (*CopyDBParameterGroupOutput, error)

CopyDBParameterGroup API operation for Amazon Relational Database Service.

Copies the specified DB parameter group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CopyDBParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing DB parameter group.

  • ErrCodeDBParameterGroupAlreadyExistsFault "DBParameterGroupAlreadyExists" A DB parameter group with the same name exists.

  • ErrCodeDBParameterGroupQuotaExceededFault "DBParameterGroupQuotaExceeded" The request would result in the user exceeding the allowed number of DB parameter groups.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CopyDBParameterGroup

Example (Shared00)

To copy a DB parameter group This example copies a DB parameter group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.CopyDBParameterGroupInput{
		SourceDBParameterGroupIdentifier:  aws.String("mymysqlparametergroup"),
		TargetDBParameterGroupDescription: aws.String("My MySQL parameter group copy"),
		TargetDBParameterGroupIdentifier:  aws.String("mymysqlparametergroup-copy"),
	}

	result, err := svc.CopyDBParameterGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBParameterGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeDBParameterGroupAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBParameterGroupAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeDBParameterGroupQuotaExceededFault:
				fmt.Println(rds.ErrCodeDBParameterGroupQuotaExceededFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) CopyDBParameterGroupRequest

func (c *RDS) CopyDBParameterGroupRequest(input *CopyDBParameterGroupInput) (req *request.Request, output *CopyDBParameterGroupOutput)

CopyDBParameterGroupRequest generates a "aws/request.Request" representing the client's request for the CopyDBParameterGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CopyDBParameterGroup for more information on using the CopyDBParameterGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CopyDBParameterGroupRequest method.
req, resp := client.CopyDBParameterGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CopyDBParameterGroup

func (*RDS) CopyDBParameterGroupWithContext added in v1.8.0

func (c *RDS) CopyDBParameterGroupWithContext(ctx aws.Context, input *CopyDBParameterGroupInput, opts ...request.Option) (*CopyDBParameterGroupOutput, error)

CopyDBParameterGroupWithContext is the same as CopyDBParameterGroup with the addition of the ability to pass a context and additional request options.

See CopyDBParameterGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CopyDBSnapshot

func (c *RDS) CopyDBSnapshot(input *CopyDBSnapshotInput) (*CopyDBSnapshotOutput, error)

CopyDBSnapshot API operation for Amazon Relational Database Service.

Copies the specified DB snapshot. The source DB snapshot must be in the available state.

You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination Amazon Web Services Region for the DB snapshot copy.

This command doesn't apply to RDS Custom.

For more information about copying snapshots, see Copying a DB Snapshot (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopyDBSnapshot) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CopyDBSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeDBSnapshotAlreadyExistsFault "DBSnapshotAlreadyExists" DBSnapshotIdentifier is already used by an existing snapshot.

  • ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound" DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

  • ErrCodeInvalidDBSnapshotStateFault "InvalidDBSnapshotState" The state of the DB snapshot doesn't allow deletion.

  • ErrCodeSnapshotQuotaExceededFault "SnapshotQuotaExceeded" The request would result in the user exceeding the allowed number of DB snapshots.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred accessing an Amazon Web Services KMS key.

  • ErrCodeCustomAvailabilityZoneNotFoundFault "CustomAvailabilityZoneNotFound" CustomAvailabilityZoneId doesn't refer to an existing custom Availability Zone identifier.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CopyDBSnapshot

Example (Shared00)

To copy a DB snapshot This example copies a DB snapshot.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.CopyDBSnapshotInput{
		SourceDBSnapshotIdentifier: aws.String("mydbsnapshot"),
		TargetDBSnapshotIdentifier: aws.String("mydbsnapshot-copy"),
	}

	result, err := svc.CopyDBSnapshot(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBSnapshotAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBSnapshotAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeDBSnapshotNotFoundFault:
				fmt.Println(rds.ErrCodeDBSnapshotNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidDBSnapshotStateFault:
				fmt.Println(rds.ErrCodeInvalidDBSnapshotStateFault, aerr.Error())
			case rds.ErrCodeSnapshotQuotaExceededFault:
				fmt.Println(rds.ErrCodeSnapshotQuotaExceededFault, aerr.Error())
			case rds.ErrCodeKMSKeyNotAccessibleFault:
				fmt.Println(rds.ErrCodeKMSKeyNotAccessibleFault, aerr.Error())
			case rds.ErrCodeCustomAvailabilityZoneNotFoundFault:
				fmt.Println(rds.ErrCodeCustomAvailabilityZoneNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) CopyDBSnapshotRequest

func (c *RDS) CopyDBSnapshotRequest(input *CopyDBSnapshotInput) (req *request.Request, output *CopyDBSnapshotOutput)

CopyDBSnapshotRequest generates a "aws/request.Request" representing the client's request for the CopyDBSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CopyDBSnapshot for more information on using the CopyDBSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CopyDBSnapshotRequest method.
req, resp := client.CopyDBSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CopyDBSnapshot

func (*RDS) CopyDBSnapshotWithContext added in v1.8.0

func (c *RDS) CopyDBSnapshotWithContext(ctx aws.Context, input *CopyDBSnapshotInput, opts ...request.Option) (*CopyDBSnapshotOutput, error)

CopyDBSnapshotWithContext is the same as CopyDBSnapshot with the addition of the ability to pass a context and additional request options.

See CopyDBSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CopyOptionGroup

func (c *RDS) CopyOptionGroup(input *CopyOptionGroupInput) (*CopyOptionGroupOutput, error)

CopyOptionGroup API operation for Amazon Relational Database Service.

Copies the specified option group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CopyOptionGroup for usage and error information.

Returned Error Codes:

  • ErrCodeOptionGroupAlreadyExistsFault "OptionGroupAlreadyExistsFault" The option group you are trying to create already exists.

  • ErrCodeOptionGroupNotFoundFault "OptionGroupNotFoundFault" The specified option group could not be found.

  • ErrCodeOptionGroupQuotaExceededFault "OptionGroupQuotaExceededFault" The quota of 20 option groups was exceeded for this Amazon Web Services account.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CopyOptionGroup

Example (Shared00)

To copy an option group This example copies an option group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.CopyOptionGroupInput{
		SourceOptionGroupIdentifier:  aws.String("mymysqloptiongroup"),
		TargetOptionGroupDescription: aws.String("My MySQL option group copy"),
		TargetOptionGroupIdentifier:  aws.String("mymysqloptiongroup-copy"),
	}

	result, err := svc.CopyOptionGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeOptionGroupAlreadyExistsFault:
				fmt.Println(rds.ErrCodeOptionGroupAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeOptionGroupNotFoundFault:
				fmt.Println(rds.ErrCodeOptionGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeOptionGroupQuotaExceededFault:
				fmt.Println(rds.ErrCodeOptionGroupQuotaExceededFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) CopyOptionGroupRequest

func (c *RDS) CopyOptionGroupRequest(input *CopyOptionGroupInput) (req *request.Request, output *CopyOptionGroupOutput)

CopyOptionGroupRequest generates a "aws/request.Request" representing the client's request for the CopyOptionGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CopyOptionGroup for more information on using the CopyOptionGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CopyOptionGroupRequest method.
req, resp := client.CopyOptionGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CopyOptionGroup

func (*RDS) CopyOptionGroupWithContext added in v1.8.0

func (c *RDS) CopyOptionGroupWithContext(ctx aws.Context, input *CopyOptionGroupInput, opts ...request.Option) (*CopyOptionGroupOutput, error)

CopyOptionGroupWithContext is the same as CopyOptionGroup with the addition of the ability to pass a context and additional request options.

See CopyOptionGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CreateCustomDBEngineVersion added in v1.41.10

func (c *RDS) CreateCustomDBEngineVersion(input *CreateCustomDBEngineVersionInput) (*CreateCustomDBEngineVersionOutput, error)

CreateCustomDBEngineVersion API operation for Amazon Relational Database Service.

Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific AMI. The supported engines are the following:

  • Oracle Database 12.1 Enterprise Edition with the January 2021 or later RU/RUR

  • Oracle Database 19c Enterprise Edition with the January 2021 or later RU/RUR

Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software. The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create your database. With Amazon RDS Custom for Oracle, you upload your database installation files in Amazon S3.

When you create a custom engine version, you specify the files in a JSON document called a CEV manifest. This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from the installation files that you provided. This service model is called Bring Your Own Media (BYOM).

Creation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with the message Creation failed for custom engine version, and includes details about the failure. For example, the event prints missing files.

After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or inactive.

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the CreateCustomDbEngineVersion event.

For more information, see Creating a CEV (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.create) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CreateCustomDBEngineVersion for usage and error information.

Returned Error Codes:

  • ErrCodeCustomDBEngineVersionAlreadyExistsFault "CustomDBEngineVersionAlreadyExistsFault" A CEV with the specified name already exists.

  • ErrCodeCustomDBEngineVersionQuotaExceededFault "CustomDBEngineVersionQuotaExceededFault" You have exceeded your CEV quota.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred accessing an Amazon Web Services KMS key.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateCustomDBEngineVersion

func (*RDS) CreateCustomDBEngineVersionRequest added in v1.41.10

func (c *RDS) CreateCustomDBEngineVersionRequest(input *CreateCustomDBEngineVersionInput) (req *request.Request, output *CreateCustomDBEngineVersionOutput)

CreateCustomDBEngineVersionRequest generates a "aws/request.Request" representing the client's request for the CreateCustomDBEngineVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCustomDBEngineVersion for more information on using the CreateCustomDBEngineVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateCustomDBEngineVersionRequest method.
req, resp := client.CreateCustomDBEngineVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateCustomDBEngineVersion

func (*RDS) CreateCustomDBEngineVersionWithContext added in v1.41.10

func (c *RDS) CreateCustomDBEngineVersionWithContext(ctx aws.Context, input *CreateCustomDBEngineVersionInput, opts ...request.Option) (*CreateCustomDBEngineVersionOutput, error)

CreateCustomDBEngineVersionWithContext is the same as CreateCustomDBEngineVersion with the addition of the ability to pass a context and additional request options.

See CreateCustomDBEngineVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CreateDBCluster added in v0.7.1

func (c *RDS) CreateDBCluster(input *CreateDBClusterInput) (*CreateDBClusterOutput, error)

CreateDBCluster API operation for Amazon Relational Database Service.

Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.

You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or PostgreSQL DB instance.

For more information on Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CreateDBCluster for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterAlreadyExistsFault "DBClusterAlreadyExistsFault" The user already has a DB cluster with the given identifier.

  • ErrCodeInsufficientStorageClusterCapacityFault "InsufficientStorageClusterCapacity" There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

  • ErrCodeDBClusterQuotaExceededFault "DBClusterQuotaExceededFault" The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

  • ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" The request would result in the user exceeding the allowed amount of storage available across all DB instances.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing DB subnet group.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeInvalidDBSubnetGroupStateFault "InvalidDBSubnetGroupStateFault" The DB subnet group cannot be deleted because it's in use.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

  • ErrCodeDBClusterParameterGroupNotFoundFault "DBClusterParameterGroupNotFound" DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred accessing an Amazon Web Services KMS key.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs "DBSubnetGroupDoesNotCoverEnoughAZs" Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

  • ErrCodeGlobalClusterNotFoundFault "GlobalClusterNotFoundFault" The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

  • ErrCodeInvalidGlobalClusterStateFault "InvalidGlobalClusterStateFault" The global cluster is in an invalid state and can't perform the requested operation.

  • ErrCodeDomainNotFoundFault "DomainNotFoundFault" Domain doesn't refer to an existing Active Directory domain.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBCluster

Example (Shared00)

To create a DB cluster This example creates a DB cluster.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.CreateDBClusterInput{
		AvailabilityZones: []*string{
			aws.String("us-east-1a"),
		},
		BackupRetentionPeriod:       aws.Int64(1),
		DBClusterIdentifier:         aws.String("mydbcluster"),
		DBClusterParameterGroupName: aws.String("mydbclusterparametergroup"),
		DatabaseName:                aws.String("myauroradb"),
		Engine:                      aws.String("aurora"),
		EngineVersion:               aws.String("5.6.10a"),
		MasterUserPassword:          aws.String("mypassword"),
		MasterUsername:              aws.String("myuser"),
		Port:                        aws.Int64(3306),
		StorageEncrypted:            aws.Bool(true),
	}

	result, err := svc.CreateDBCluster(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBClusterAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBClusterAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeInsufficientStorageClusterCapacityFault:
				fmt.Println(rds.ErrCodeInsufficientStorageClusterCapacityFault, aerr.Error())
			case rds.ErrCodeDBClusterQuotaExceededFault:
				fmt.Println(rds.ErrCodeDBClusterQuotaExceededFault, aerr.Error())
			case rds.ErrCodeStorageQuotaExceededFault:
				fmt.Println(rds.ErrCodeStorageQuotaExceededFault, aerr.Error())
			case rds.ErrCodeDBSubnetGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSubnetGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidVPCNetworkStateFault:
				fmt.Println(rds.ErrCodeInvalidVPCNetworkStateFault, aerr.Error())
			case rds.ErrCodeInvalidDBClusterStateFault:
				fmt.Println(rds.ErrCodeInvalidDBClusterStateFault, aerr.Error())
			case rds.ErrCodeInvalidDBSubnetGroupStateFault:
				fmt.Println(rds.ErrCodeInvalidDBSubnetGroupStateFault, aerr.Error())
			case rds.ErrCodeInvalidSubnet:
				fmt.Println(rds.ErrCodeInvalidSubnet, aerr.Error())
			case rds.ErrCodeInvalidDBInstanceStateFault:
				fmt.Println(rds.ErrCodeInvalidDBInstanceStateFault, aerr.Error())
			case rds.ErrCodeDBClusterParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterParameterGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeKMSKeyNotAccessibleFault:
				fmt.Println(rds.ErrCodeKMSKeyNotAccessibleFault, aerr.Error())
			case rds.ErrCodeDBClusterNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterNotFoundFault, aerr.Error())
			case rds.ErrCodeDBInstanceNotFoundFault:
				fmt.Println(rds.ErrCodeDBInstanceNotFoundFault, aerr.Error())
			case rds.ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs:
				fmt.Println(rds.ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs, aerr.Error())
			case rds.ErrCodeGlobalClusterNotFoundFault:
				fmt.Println(rds.ErrCodeGlobalClusterNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidGlobalClusterStateFault:
				fmt.Println(rds.ErrCodeInvalidGlobalClusterStateFault, aerr.Error())
			case rds.ErrCodeDomainNotFoundFault:
				fmt.Println(rds.ErrCodeDomainNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) CreateDBClusterEndpoint added in v1.15.74

func (c *RDS) CreateDBClusterEndpoint(input *CreateDBClusterEndpointInput) (*CreateDBClusterEndpointOutput, error)

CreateDBClusterEndpoint API operation for Amazon Relational Database Service.

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

This action applies only to Aurora DB clusters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CreateDBClusterEndpoint for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterEndpointQuotaExceededFault "DBClusterEndpointQuotaExceededFault" The cluster already has the maximum number of custom endpoints.

  • ErrCodeDBClusterEndpointAlreadyExistsFault "DBClusterEndpointAlreadyExistsFault" The specified custom endpoint can't be created because it already exists.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBClusterEndpoint

func (*RDS) CreateDBClusterEndpointRequest added in v1.15.74

func (c *RDS) CreateDBClusterEndpointRequest(input *CreateDBClusterEndpointInput) (req *request.Request, output *CreateDBClusterEndpointOutput)

CreateDBClusterEndpointRequest generates a "aws/request.Request" representing the client's request for the CreateDBClusterEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDBClusterEndpoint for more information on using the CreateDBClusterEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDBClusterEndpointRequest method.
req, resp := client.CreateDBClusterEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBClusterEndpoint

func (*RDS) CreateDBClusterEndpointWithContext added in v1.15.74

func (c *RDS) CreateDBClusterEndpointWithContext(ctx aws.Context, input *CreateDBClusterEndpointInput, opts ...request.Option) (*CreateDBClusterEndpointOutput, error)

CreateDBClusterEndpointWithContext is the same as CreateDBClusterEndpoint with the addition of the ability to pass a context and additional request options.

See CreateDBClusterEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CreateDBClusterParameterGroup added in v0.7.1

func (c *RDS) CreateDBClusterParameterGroup(input *CreateDBClusterParameterGroupInput) (*CreateDBClusterParameterGroupOutput, error)

CreateDBClusterParameterGroup API operation for Amazon Relational Database Service.

Creates a new DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster.

When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console (https://console.aws.amazon.com/rds/) or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.

For more information on Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CreateDBClusterParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeDBParameterGroupQuotaExceededFault "DBParameterGroupQuotaExceeded" The request would result in the user exceeding the allowed number of DB parameter groups.

  • ErrCodeDBParameterGroupAlreadyExistsFault "DBParameterGroupAlreadyExists" A DB parameter group with the same name exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBClusterParameterGroup

Example (Shared00)

To create a DB cluster parameter group This example creates a DB cluster parameter group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.CreateDBClusterParameterGroupInput{
		DBClusterParameterGroupName: aws.String("mydbclusterparametergroup"),
		DBParameterGroupFamily:      aws.String("aurora5.6"),
		Description:                 aws.String("My DB cluster parameter group"),
	}

	result, err := svc.CreateDBClusterParameterGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBParameterGroupQuotaExceededFault:
				fmt.Println(rds.ErrCodeDBParameterGroupQuotaExceededFault, aerr.Error())
			case rds.ErrCodeDBParameterGroupAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBParameterGroupAlreadyExistsFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) CreateDBClusterParameterGroupRequest added in v0.7.1

func (c *RDS) CreateDBClusterParameterGroupRequest(input *CreateDBClusterParameterGroupInput) (req *request.Request, output *CreateDBClusterParameterGroupOutput)

CreateDBClusterParameterGroupRequest generates a "aws/request.Request" representing the client's request for the CreateDBClusterParameterGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDBClusterParameterGroup for more information on using the CreateDBClusterParameterGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDBClusterParameterGroupRequest method.
req, resp := client.CreateDBClusterParameterGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBClusterParameterGroup

func (*RDS) CreateDBClusterParameterGroupWithContext added in v1.8.0

func (c *RDS) CreateDBClusterParameterGroupWithContext(ctx aws.Context, input *CreateDBClusterParameterGroupInput, opts ...request.Option) (*CreateDBClusterParameterGroupOutput, error)

CreateDBClusterParameterGroupWithContext is the same as CreateDBClusterParameterGroup with the addition of the ability to pass a context and additional request options.

See CreateDBClusterParameterGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CreateDBClusterRequest added in v0.7.1

func (c *RDS) CreateDBClusterRequest(input *CreateDBClusterInput) (req *request.Request, output *CreateDBClusterOutput)

CreateDBClusterRequest generates a "aws/request.Request" representing the client's request for the CreateDBCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDBCluster for more information on using the CreateDBCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDBClusterRequest method.
req, resp := client.CreateDBClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBCluster

func (*RDS) CreateDBClusterSnapshot added in v0.7.1

func (c *RDS) CreateDBClusterSnapshot(input *CreateDBClusterSnapshotInput) (*CreateDBClusterSnapshotOutput, error)

CreateDBClusterSnapshot API operation for Amazon Relational Database Service.

Creates a snapshot of a DB cluster.

For more information on Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CreateDBClusterSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterSnapshotAlreadyExistsFault "DBClusterSnapshotAlreadyExistsFault" The user already has a DB cluster snapshot with the given identifier.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeSnapshotQuotaExceededFault "SnapshotQuotaExceeded" The request would result in the user exceeding the allowed number of DB snapshots.

  • ErrCodeInvalidDBClusterSnapshotStateFault "InvalidDBClusterSnapshotStateFault" The supplied value isn't a valid DB cluster snapshot state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBClusterSnapshot

Example (Shared00)

To create a DB cluster snapshot This example creates a DB cluster snapshot.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.CreateDBClusterSnapshotInput{
		DBClusterIdentifier:         aws.String("mydbcluster"),
		DBClusterSnapshotIdentifier: aws.String("mydbclustersnapshot"),
	}

	result, err := svc.CreateDBClusterSnapshot(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBClusterSnapshotAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBClusterSnapshotAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeInvalidDBClusterStateFault:
				fmt.Println(rds.ErrCodeInvalidDBClusterStateFault, aerr.Error())
			case rds.ErrCodeDBClusterNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterNotFoundFault, aerr.Error())
			case rds.ErrCodeSnapshotQuotaExceededFault:
				fmt.Println(rds.ErrCodeSnapshotQuotaExceededFault, aerr.Error())
			case rds.ErrCodeInvalidDBClusterSnapshotStateFault:
				fmt.Println(rds.ErrCodeInvalidDBClusterSnapshotStateFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) CreateDBClusterSnapshotRequest added in v0.7.1

func (c *RDS) CreateDBClusterSnapshotRequest(input *CreateDBClusterSnapshotInput) (req *request.Request, output *CreateDBClusterSnapshotOutput)

CreateDBClusterSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateDBClusterSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDBClusterSnapshot for more information on using the CreateDBClusterSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDBClusterSnapshotRequest method.
req, resp := client.CreateDBClusterSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBClusterSnapshot

func (*RDS) CreateDBClusterSnapshotWithContext added in v1.8.0

func (c *RDS) CreateDBClusterSnapshotWithContext(ctx aws.Context, input *CreateDBClusterSnapshotInput, opts ...request.Option) (*CreateDBClusterSnapshotOutput, error)

CreateDBClusterSnapshotWithContext is the same as CreateDBClusterSnapshot with the addition of the ability to pass a context and additional request options.

See CreateDBClusterSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CreateDBClusterWithContext added in v1.8.0

func (c *RDS) CreateDBClusterWithContext(ctx aws.Context, input *CreateDBClusterInput, opts ...request.Option) (*CreateDBClusterOutput, error)

CreateDBClusterWithContext is the same as CreateDBCluster with the addition of the ability to pass a context and additional request options.

See CreateDBCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CreateDBInstance

func (c *RDS) CreateDBInstance(input *CreateDBInstanceInput) (*CreateDBInstanceOutput, error)

CreateDBInstance API operation for Amazon Relational Database Service.

Creates a new DB instance.

The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster.

For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the Amazon RDS User Guide.

For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the Amazon Aurora User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CreateDBInstance for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceAlreadyExistsFault "DBInstanceAlreadyExists" The user already has a DB instance with the given identifier.

  • ErrCodeInsufficientDBInstanceCapacityFault "InsufficientDBInstanceCapacity" The specified DB instance class isn't available in the specified Availability Zone.

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing DB parameter group.

  • ErrCodeDBSecurityGroupNotFoundFault "DBSecurityGroupNotFound" DBSecurityGroupName doesn't refer to an existing DB security group.

  • ErrCodeInstanceQuotaExceededFault "InstanceQuotaExceeded" The request would result in the user exceeding the allowed number of DB instances.

  • ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" The request would result in the user exceeding the allowed amount of storage available across all DB instances.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing DB subnet group.

  • ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs "DBSubnetGroupDoesNotCoverEnoughAZs" Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

  • ErrCodeProvisionedIopsNotAvailableInAZFault "ProvisionedIopsNotAvailableInAZFault" Provisioned IOPS not available in the specified Availability Zone.

  • ErrCodeOptionGroupNotFoundFault "OptionGroupNotFoundFault" The specified option group could not be found.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeStorageTypeNotSupportedFault "StorageTypeNotSupported" Storage of the StorageType specified can't be associated with the DB instance.

  • ErrCodeAuthorizationNotFoundFault "AuthorizationNotFound" The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.

    Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred accessing an Amazon Web Services KMS key.

  • ErrCodeDomainNotFoundFault "DomainNotFoundFault" Domain doesn't refer to an existing Active Directory domain.

  • ErrCodeBackupPolicyNotFoundFault "BackupPolicyNotFoundFault"

  • ErrCodeNetworkTypeNotSupported "NetworkTypeNotSupported" The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstance

Example (Shared00)

To create a DB instance. This example creates a DB instance.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.CreateDBInstanceInput{
		AllocatedStorage:     aws.Int64(5),
		DBInstanceClass:      aws.String("db.t2.micro"),
		DBInstanceIdentifier: aws.String("mymysqlinstance"),
		Engine:               aws.String("MySQL"),
		MasterUserPassword:   aws.String("MyPassword"),
		MasterUsername:       aws.String("MyUser"),
	}

	result, err := svc.CreateDBInstance(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBInstanceAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBInstanceAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeInsufficientDBInstanceCapacityFault:
				fmt.Println(rds.ErrCodeInsufficientDBInstanceCapacityFault, aerr.Error())
			case rds.ErrCodeDBParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBParameterGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeDBSecurityGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSecurityGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeInstanceQuotaExceededFault:
				fmt.Println(rds.ErrCodeInstanceQuotaExceededFault, aerr.Error())
			case rds.ErrCodeStorageQuotaExceededFault:
				fmt.Println(rds.ErrCodeStorageQuotaExceededFault, aerr.Error())
			case rds.ErrCodeDBSubnetGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSubnetGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs:
				fmt.Println(rds.ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs, aerr.Error())
			case rds.ErrCodeInvalidDBClusterStateFault:
				fmt.Println(rds.ErrCodeInvalidDBClusterStateFault, aerr.Error())
			case rds.ErrCodeInvalidSubnet:
				fmt.Println(rds.ErrCodeInvalidSubnet, aerr.Error())
			case rds.ErrCodeInvalidVPCNetworkStateFault:
				fmt.Println(rds.ErrCodeInvalidVPCNetworkStateFault, aerr.Error())
			case rds.ErrCodeProvisionedIopsNotAvailableInAZFault:
				fmt.Println(rds.ErrCodeProvisionedIopsNotAvailableInAZFault, aerr.Error())
			case rds.ErrCodeOptionGroupNotFoundFault:
				fmt.Println(rds.ErrCodeOptionGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeDBClusterNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterNotFoundFault, aerr.Error())
			case rds.ErrCodeStorageTypeNotSupportedFault:
				fmt.Println(rds.ErrCodeStorageTypeNotSupportedFault, aerr.Error())
			case rds.ErrCodeAuthorizationNotFoundFault:
				fmt.Println(rds.ErrCodeAuthorizationNotFoundFault, aerr.Error())
			case rds.ErrCodeKMSKeyNotAccessibleFault:
				fmt.Println(rds.ErrCodeKMSKeyNotAccessibleFault, aerr.Error())
			case rds.ErrCodeDomainNotFoundFault:
				fmt.Println(rds.ErrCodeDomainNotFoundFault, aerr.Error())
			case rds.ErrCodeBackupPolicyNotFoundFault:
				fmt.Println(rds.ErrCodeBackupPolicyNotFoundFault, aerr.Error())
			case rds.ErrCodeNetworkTypeNotSupported:
				fmt.Println(rds.ErrCodeNetworkTypeNotSupported, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) CreateDBInstanceReadReplica

func (c *RDS) CreateDBInstanceReadReplica(input *CreateDBInstanceReadReplicaInput) (*CreateDBInstanceReadReplicaOutput, error)

CreateDBInstanceReadReplica API operation for Amazon Relational Database Service.

Creates a new DB instance that acts as a read replica for an existing source DB instance. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read Replicas (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html) in the Amazon RDS User Guide.

Amazon Aurora doesn't support this operation. Call the CreateDBInstance operation to create a DB instance for an Aurora DB cluster.

All read replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified.

Your source DB instance must have backup retention enabled.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CreateDBInstanceReadReplica for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceAlreadyExistsFault "DBInstanceAlreadyExists" The user already has a DB instance with the given identifier.

  • ErrCodeInsufficientDBInstanceCapacityFault "InsufficientDBInstanceCapacity" The specified DB instance class isn't available in the specified Availability Zone.

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing DB parameter group.

  • ErrCodeDBSecurityGroupNotFoundFault "DBSecurityGroupNotFound" DBSecurityGroupName doesn't refer to an existing DB security group.

  • ErrCodeInstanceQuotaExceededFault "InstanceQuotaExceeded" The request would result in the user exceeding the allowed number of DB instances.

  • ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" The request would result in the user exceeding the allowed amount of storage available across all DB instances.

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing DB subnet group.

  • ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs "DBSubnetGroupDoesNotCoverEnoughAZs" Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

  • ErrCodeProvisionedIopsNotAvailableInAZFault "ProvisionedIopsNotAvailableInAZFault" Provisioned IOPS not available in the specified Availability Zone.

  • ErrCodeOptionGroupNotFoundFault "OptionGroupNotFoundFault" The specified option group could not be found.

  • ErrCodeDBSubnetGroupNotAllowedFault "DBSubnetGroupNotAllowedFault" The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the source instance.

  • ErrCodeInvalidDBSubnetGroupFault "InvalidDBSubnetGroupFault" The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.

  • ErrCodeStorageTypeNotSupportedFault "StorageTypeNotSupported" Storage of the StorageType specified can't be associated with the DB instance.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred accessing an Amazon Web Services KMS key.

  • ErrCodeDomainNotFoundFault "DomainNotFoundFault" Domain doesn't refer to an existing Active Directory domain.

  • ErrCodeNetworkTypeNotSupported "NetworkTypeNotSupported" The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceReadReplica

Example (Shared00)

To create a DB instance read replica. This example creates a DB instance read replica.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.CreateDBInstanceReadReplicaInput{
		AvailabilityZone:           aws.String("us-east-1a"),
		CopyTagsToSnapshot:         aws.Bool(true),
		DBInstanceClass:            aws.String("db.t2.micro"),
		DBInstanceIdentifier:       aws.String("mydbreadreplica"),
		PubliclyAccessible:         aws.Bool(true),
		SourceDBInstanceIdentifier: aws.String("mymysqlinstance"),
		StorageType:                aws.String("gp2"),
		Tags: []*rds.Tag{
			{
				Key:   aws.String("mydbreadreplicakey"),
				Value: aws.String("mydbreadreplicavalue"),
			},
		},
	}

	result, err := svc.CreateDBInstanceReadReplica(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBInstanceAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBInstanceAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeInsufficientDBInstanceCapacityFault:
				fmt.Println(rds.ErrCodeInsufficientDBInstanceCapacityFault, aerr.Error())
			case rds.ErrCodeDBParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBParameterGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeDBSecurityGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSecurityGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeInstanceQuotaExceededFault:
				fmt.Println(rds.ErrCodeInstanceQuotaExceededFault, aerr.Error())
			case rds.ErrCodeStorageQuotaExceededFault:
				fmt.Println(rds.ErrCodeStorageQuotaExceededFault, aerr.Error())
			case rds.ErrCodeDBInstanceNotFoundFault:
				fmt.Println(rds.ErrCodeDBInstanceNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidDBInstanceStateFault:
				fmt.Println(rds.ErrCodeInvalidDBInstanceStateFault, aerr.Error())
			case rds.ErrCodeDBSubnetGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSubnetGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs:
				fmt.Println(rds.ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs, aerr.Error())
			case rds.ErrCodeInvalidSubnet:
				fmt.Println(rds.ErrCodeInvalidSubnet, aerr.Error())
			case rds.ErrCodeInvalidVPCNetworkStateFault:
				fmt.Println(rds.ErrCodeInvalidVPCNetworkStateFault, aerr.Error())
			case rds.ErrCodeProvisionedIopsNotAvailableInAZFault:
				fmt.Println(rds.ErrCodeProvisionedIopsNotAvailableInAZFault, aerr.Error())
			case rds.ErrCodeOptionGroupNotFoundFault:
				fmt.Println(rds.ErrCodeOptionGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeDBSubnetGroupNotAllowedFault:
				fmt.Println(rds.ErrCodeDBSubnetGroupNotAllowedFault, aerr.Error())
			case rds.ErrCodeInvalidDBSubnetGroupFault:
				fmt.Println(rds.ErrCodeInvalidDBSubnetGroupFault, aerr.Error())
			case rds.ErrCodeStorageTypeNotSupportedFault:
				fmt.Println(rds.ErrCodeStorageTypeNotSupportedFault, aerr.Error())
			case rds.ErrCodeKMSKeyNotAccessibleFault:
				fmt.Println(rds.ErrCodeKMSKeyNotAccessibleFault, aerr.Error())
			case rds.ErrCodeDomainNotFoundFault:
				fmt.Println(rds.ErrCodeDomainNotFoundFault, aerr.Error())
			case rds.ErrCodeNetworkTypeNotSupported:
				fmt.Println(rds.ErrCodeNetworkTypeNotSupported, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) CreateDBInstanceReadReplicaRequest

func (c *RDS) CreateDBInstanceReadReplicaRequest(input *CreateDBInstanceReadReplicaInput) (req *request.Request, output *CreateDBInstanceReadReplicaOutput)

CreateDBInstanceReadReplicaRequest generates a "aws/request.Request" representing the client's request for the CreateDBInstanceReadReplica operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDBInstanceReadReplica for more information on using the CreateDBInstanceReadReplica API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDBInstanceReadReplicaRequest method.
req, resp := client.CreateDBInstanceReadReplicaRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceReadReplica

func (*RDS) CreateDBInstanceReadReplicaWithContext added in v1.8.0

func (c *RDS) CreateDBInstanceReadReplicaWithContext(ctx aws.Context, input *CreateDBInstanceReadReplicaInput, opts ...request.Option) (*CreateDBInstanceReadReplicaOutput, error)

CreateDBInstanceReadReplicaWithContext is the same as CreateDBInstanceReadReplica with the addition of the ability to pass a context and additional request options.

See CreateDBInstanceReadReplica for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CreateDBInstanceRequest

func (c *RDS) CreateDBInstanceRequest(input *CreateDBInstanceInput) (req *request.Request, output *CreateDBInstanceOutput)

CreateDBInstanceRequest generates a "aws/request.Request" representing the client's request for the CreateDBInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDBInstance for more information on using the CreateDBInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDBInstanceRequest method.
req, resp := client.CreateDBInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstance

func (*RDS) CreateDBInstanceWithContext added in v1.8.0

func (c *RDS) CreateDBInstanceWithContext(ctx aws.Context, input *CreateDBInstanceInput, opts ...request.Option) (*CreateDBInstanceOutput, error)

CreateDBInstanceWithContext is the same as CreateDBInstance with the addition of the ability to pass a context and additional request options.

See CreateDBInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CreateDBParameterGroup

func (c *RDS) CreateDBParameterGroup(input *CreateDBParameterGroupInput) (*CreateDBParameterGroupOutput, error)

CreateDBParameterGroup API operation for Amazon Relational Database Service.

Creates a new DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

This command doesn't apply to RDS Custom.

After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console (https://console.aws.amazon.com/rds/) or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CreateDBParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeDBParameterGroupQuotaExceededFault "DBParameterGroupQuotaExceeded" The request would result in the user exceeding the allowed number of DB parameter groups.

  • ErrCodeDBParameterGroupAlreadyExistsFault "DBParameterGroupAlreadyExists" A DB parameter group with the same name exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBParameterGroup

Example (Shared00)

To create a DB parameter group. This example creates a DB parameter group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.CreateDBParameterGroupInput{
		DBParameterGroupFamily: aws.String("mysql5.6"),
		DBParameterGroupName:   aws.String("mymysqlparametergroup"),
		Description:            aws.String("My MySQL parameter group"),
	}

	result, err := svc.CreateDBParameterGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBParameterGroupQuotaExceededFault:
				fmt.Println(rds.ErrCodeDBParameterGroupQuotaExceededFault, aerr.Error())
			case rds.ErrCodeDBParameterGroupAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBParameterGroupAlreadyExistsFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) CreateDBParameterGroupRequest

func (c *RDS) CreateDBParameterGroupRequest(input *CreateDBParameterGroupInput) (req *request.Request, output *CreateDBParameterGroupOutput)

CreateDBParameterGroupRequest generates a "aws/request.Request" representing the client's request for the CreateDBParameterGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDBParameterGroup for more information on using the CreateDBParameterGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDBParameterGroupRequest method.
req, resp := client.CreateDBParameterGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBParameterGroup

func (*RDS) CreateDBParameterGroupWithContext added in v1.8.0

func (c *RDS) CreateDBParameterGroupWithContext(ctx aws.Context, input *CreateDBParameterGroupInput, opts ...request.Option) (*CreateDBParameterGroupOutput, error)

CreateDBParameterGroupWithContext is the same as CreateDBParameterGroup with the addition of the ability to pass a context and additional request options.

See CreateDBParameterGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CreateDBProxy added in v1.25.47

func (c *RDS) CreateDBProxy(input *CreateDBProxyInput) (*CreateDBProxyOutput, error)

CreateDBProxy API operation for Amazon Relational Database Service.

Creates a new DB proxy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CreateDBProxy for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

  • ErrCodeDBProxyAlreadyExistsFault "DBProxyAlreadyExistsFault" The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeDBProxyQuotaExceededFault "DBProxyQuotaExceededFault" Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web Services Region.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBProxy

func (*RDS) CreateDBProxyEndpoint added in v1.37.27

func (c *RDS) CreateDBProxyEndpoint(input *CreateDBProxyEndpointInput) (*CreateDBProxyEndpointOutput, error)

CreateDBProxyEndpoint API operation for Amazon Relational Database Service.

Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CreateDBProxyEndpoint for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

  • ErrCodeDBProxyNotFoundFault "DBProxyNotFoundFault" The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeDBProxyEndpointAlreadyExistsFault "DBProxyEndpointAlreadyExistsFault" The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeDBProxyEndpointQuotaExceededFault "DBProxyEndpointQuotaExceededFault" The DB proxy already has the maximum number of endpoints.

  • ErrCodeInvalidDBProxyStateFault "InvalidDBProxyStateFault" The requested operation can't be performed while the proxy is in this state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBProxyEndpoint

func (*RDS) CreateDBProxyEndpointRequest added in v1.37.27

func (c *RDS) CreateDBProxyEndpointRequest(input *CreateDBProxyEndpointInput) (req *request.Request, output *CreateDBProxyEndpointOutput)

CreateDBProxyEndpointRequest generates a "aws/request.Request" representing the client's request for the CreateDBProxyEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDBProxyEndpoint for more information on using the CreateDBProxyEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDBProxyEndpointRequest method.
req, resp := client.CreateDBProxyEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBProxyEndpoint

func (*RDS) CreateDBProxyEndpointWithContext added in v1.37.27

func (c *RDS) CreateDBProxyEndpointWithContext(ctx aws.Context, input *CreateDBProxyEndpointInput, opts ...request.Option) (*CreateDBProxyEndpointOutput, error)

CreateDBProxyEndpointWithContext is the same as CreateDBProxyEndpoint with the addition of the ability to pass a context and additional request options.

See CreateDBProxyEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CreateDBProxyRequest added in v1.25.47

func (c *RDS) CreateDBProxyRequest(input *CreateDBProxyInput) (req *request.Request, output *CreateDBProxyOutput)

CreateDBProxyRequest generates a "aws/request.Request" representing the client's request for the CreateDBProxy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDBProxy for more information on using the CreateDBProxy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDBProxyRequest method.
req, resp := client.CreateDBProxyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBProxy

func (*RDS) CreateDBProxyWithContext added in v1.25.47

func (c *RDS) CreateDBProxyWithContext(ctx aws.Context, input *CreateDBProxyInput, opts ...request.Option) (*CreateDBProxyOutput, error)

CreateDBProxyWithContext is the same as CreateDBProxy with the addition of the ability to pass a context and additional request options.

See CreateDBProxy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CreateDBSecurityGroup

func (c *RDS) CreateDBSecurityGroup(input *CreateDBSecurityGroupInput) (*CreateDBSecurityGroupOutput, error)

CreateDBSecurityGroup API operation for Amazon Relational Database Service.

Creates a new DB security group. DB security groups control access to a DB instance.

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare (http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/), and Moving a DB instance not in a VPC into a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CreateDBSecurityGroup for usage and error information.

Returned Error Codes:

  • ErrCodeDBSecurityGroupAlreadyExistsFault "DBSecurityGroupAlreadyExists" A DB security group with the name specified in DBSecurityGroupName already exists.

  • ErrCodeDBSecurityGroupQuotaExceededFault "QuotaExceeded.DBSecurityGroup" The request would result in the user exceeding the allowed number of DB security groups.

  • ErrCodeDBSecurityGroupNotSupportedFault "DBSecurityGroupNotSupported" A DB security group isn't allowed for this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBSecurityGroup

Example (Shared00)

To create a DB security group. This example creates a DB security group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.CreateDBSecurityGroupInput{
		DBSecurityGroupDescription: aws.String("My DB security group"),
		DBSecurityGroupName:        aws.String("mydbsecuritygroup"),
	}

	result, err := svc.CreateDBSecurityGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBSecurityGroupAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBSecurityGroupAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeDBSecurityGroupQuotaExceededFault:
				fmt.Println(rds.ErrCodeDBSecurityGroupQuotaExceededFault, aerr.Error())
			case rds.ErrCodeDBSecurityGroupNotSupportedFault:
				fmt.Println(rds.ErrCodeDBSecurityGroupNotSupportedFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) CreateDBSecurityGroupRequest

func (c *RDS) CreateDBSecurityGroupRequest(input *CreateDBSecurityGroupInput) (req *request.Request, output *CreateDBSecurityGroupOutput)

CreateDBSecurityGroupRequest generates a "aws/request.Request" representing the client's request for the CreateDBSecurityGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDBSecurityGroup for more information on using the CreateDBSecurityGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDBSecurityGroupRequest method.
req, resp := client.CreateDBSecurityGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBSecurityGroup

func (*RDS) CreateDBSecurityGroupWithContext added in v1.8.0

func (c *RDS) CreateDBSecurityGroupWithContext(ctx aws.Context, input *CreateDBSecurityGroupInput, opts ...request.Option) (*CreateDBSecurityGroupOutput, error)

CreateDBSecurityGroupWithContext is the same as CreateDBSecurityGroup with the addition of the ability to pass a context and additional request options.

See CreateDBSecurityGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CreateDBSnapshot

func (c *RDS) CreateDBSnapshot(input *CreateDBSnapshotInput) (*CreateDBSnapshotOutput, error)

CreateDBSnapshot API operation for Amazon Relational Database Service.

Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CreateDBSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeDBSnapshotAlreadyExistsFault "DBSnapshotAlreadyExists" DBSnapshotIdentifier is already used by an existing snapshot.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeSnapshotQuotaExceededFault "SnapshotQuotaExceeded" The request would result in the user exceeding the allowed number of DB snapshots.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBSnapshot

Example (Shared00)

To create a DB snapshot. This example creates a DB snapshot.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.CreateDBSnapshotInput{
		DBInstanceIdentifier: aws.String("mymysqlinstance"),
		DBSnapshotIdentifier: aws.String("mydbsnapshot"),
	}

	result, err := svc.CreateDBSnapshot(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBSnapshotAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBSnapshotAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeInvalidDBInstanceStateFault:
				fmt.Println(rds.ErrCodeInvalidDBInstanceStateFault, aerr.Error())
			case rds.ErrCodeDBInstanceNotFoundFault:
				fmt.Println(rds.ErrCodeDBInstanceNotFoundFault, aerr.Error())
			case rds.ErrCodeSnapshotQuotaExceededFault:
				fmt.Println(rds.ErrCodeSnapshotQuotaExceededFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) CreateDBSnapshotRequest

func (c *RDS) CreateDBSnapshotRequest(input *CreateDBSnapshotInput) (req *request.Request, output *CreateDBSnapshotOutput)

CreateDBSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateDBSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDBSnapshot for more information on using the CreateDBSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDBSnapshotRequest method.
req, resp := client.CreateDBSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBSnapshot

func (*RDS) CreateDBSnapshotWithContext added in v1.8.0

func (c *RDS) CreateDBSnapshotWithContext(ctx aws.Context, input *CreateDBSnapshotInput, opts ...request.Option) (*CreateDBSnapshotOutput, error)

CreateDBSnapshotWithContext is the same as CreateDBSnapshot with the addition of the ability to pass a context and additional request options.

See CreateDBSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CreateDBSubnetGroup

func (c *RDS) CreateDBSubnetGroup(input *CreateDBSubnetGroupInput) (*CreateDBSubnetGroupOutput, error)

CreateDBSubnetGroup API operation for Amazon Relational Database Service.

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CreateDBSubnetGroup for usage and error information.

Returned Error Codes:

  • ErrCodeDBSubnetGroupAlreadyExistsFault "DBSubnetGroupAlreadyExists" DBSubnetGroupName is already used by an existing DB subnet group.

  • ErrCodeDBSubnetGroupQuotaExceededFault "DBSubnetGroupQuotaExceeded" The request would result in the user exceeding the allowed number of DB subnet groups.

  • ErrCodeDBSubnetQuotaExceededFault "DBSubnetQuotaExceededFault" The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.

  • ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs "DBSubnetGroupDoesNotCoverEnoughAZs" Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBSubnetGroup

Example (Shared00)

To create a DB subnet group. This example creates a DB subnet group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.CreateDBSubnetGroupInput{
		DBSubnetGroupDescription: aws.String("My DB subnet group"),
		DBSubnetGroupName:        aws.String("mydbsubnetgroup"),
		SubnetIds: []*string{
			aws.String("subnet-1fab8a69"),
			aws.String("subnet-d43a468c"),
		},
	}

	result, err := svc.CreateDBSubnetGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBSubnetGroupAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBSubnetGroupAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeDBSubnetGroupQuotaExceededFault:
				fmt.Println(rds.ErrCodeDBSubnetGroupQuotaExceededFault, aerr.Error())
			case rds.ErrCodeDBSubnetQuotaExceededFault:
				fmt.Println(rds.ErrCodeDBSubnetQuotaExceededFault, aerr.Error())
			case rds.ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs:
				fmt.Println(rds.ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs, aerr.Error())
			case rds.ErrCodeInvalidSubnet:
				fmt.Println(rds.ErrCodeInvalidSubnet, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) CreateDBSubnetGroupRequest

func (c *RDS) CreateDBSubnetGroupRequest(input *CreateDBSubnetGroupInput) (req *request.Request, output *CreateDBSubnetGroupOutput)

CreateDBSubnetGroupRequest generates a "aws/request.Request" representing the client's request for the CreateDBSubnetGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDBSubnetGroup for more information on using the CreateDBSubnetGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDBSubnetGroupRequest method.
req, resp := client.CreateDBSubnetGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBSubnetGroup

func (*RDS) CreateDBSubnetGroupWithContext added in v1.8.0

func (c *RDS) CreateDBSubnetGroupWithContext(ctx aws.Context, input *CreateDBSubnetGroupInput, opts ...request.Option) (*CreateDBSubnetGroupOutput, error)

CreateDBSubnetGroupWithContext is the same as CreateDBSubnetGroup with the addition of the ability to pass a context and additional request options.

See CreateDBSubnetGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CreateEventSubscription

func (c *RDS) CreateEventSubscription(input *CreateEventSubscriptionInput) (*CreateEventSubscriptionOutput, error)

CreateEventSubscription API operation for Amazon Relational Database Service.

Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) that you want to be notified of and provide a list of RDS sources (SourceIds) that triggers the events. You can also provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIds = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify SourceIds, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the SourceIds, you are notified of events generated from all RDS sources belonging to your customer account.

For more information about subscribing to an event for RDS DB engines, see Subscribing to Amazon RDS event notification (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Subscribing.html) in the Amazon RDS User Guide.

For more information about subscribing to an event for Aurora DB engines, see Subscribing to Amazon RDS event notification (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Subscribing.html) in the Amazon Aurora User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CreateEventSubscription for usage and error information.

Returned Error Codes:

  • ErrCodeEventSubscriptionQuotaExceededFault "EventSubscriptionQuotaExceeded" You have reached the maximum number of event subscriptions.

  • ErrCodeSubscriptionAlreadyExistFault "SubscriptionAlreadyExist" The supplied subscription name already exists.

  • ErrCodeSNSInvalidTopicFault "SNSInvalidTopic" SNS has responded that there is a problem with the SNS topic specified.

  • ErrCodeSNSNoAuthorizationFault "SNSNoAuthorization" You do not have permission to publish to the SNS topic ARN.

  • ErrCodeSNSTopicArnNotFoundFault "SNSTopicArnNotFound" The SNS topic ARN does not exist.

  • ErrCodeSubscriptionCategoryNotFoundFault "SubscriptionCategoryNotFound" The supplied category does not exist.

  • ErrCodeSourceNotFoundFault "SourceNotFound" The requested source could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateEventSubscription

Example (Shared00)

To create an event notification subscription This example creates an event notification subscription.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.CreateEventSubscriptionInput{
		Enabled: aws.Bool(true),
		EventCategories: []*string{
			aws.String("availability"),
		},
		SnsTopicArn: aws.String("arn:aws:sns:us-east-1:992648334831:MyDemoSNSTopic"),
		SourceIds: []*string{
			aws.String("mymysqlinstance"),
		},
		SourceType:       aws.String("db-instance"),
		SubscriptionName: aws.String("mymysqleventsubscription"),
	}

	result, err := svc.CreateEventSubscription(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeEventSubscriptionQuotaExceededFault:
				fmt.Println(rds.ErrCodeEventSubscriptionQuotaExceededFault, aerr.Error())
			case rds.ErrCodeSubscriptionAlreadyExistFault:
				fmt.Println(rds.ErrCodeSubscriptionAlreadyExistFault, aerr.Error())
			case rds.ErrCodeSNSInvalidTopicFault:
				fmt.Println(rds.ErrCodeSNSInvalidTopicFault, aerr.Error())
			case rds.ErrCodeSNSNoAuthorizationFault:
				fmt.Println(rds.ErrCodeSNSNoAuthorizationFault, aerr.Error())
			case rds.ErrCodeSNSTopicArnNotFoundFault:
				fmt.Println(rds.ErrCodeSNSTopicArnNotFoundFault, aerr.Error())
			case rds.ErrCodeSubscriptionCategoryNotFoundFault:
				fmt.Println(rds.ErrCodeSubscriptionCategoryNotFoundFault, aerr.Error())
			case rds.ErrCodeSourceNotFoundFault:
				fmt.Println(rds.ErrCodeSourceNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) CreateEventSubscriptionRequest

func (c *RDS) CreateEventSubscriptionRequest(input *CreateEventSubscriptionInput) (req *request.Request, output *CreateEventSubscriptionOutput)

CreateEventSubscriptionRequest generates a "aws/request.Request" representing the client's request for the CreateEventSubscription operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateEventSubscription for more information on using the CreateEventSubscription API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateEventSubscriptionRequest method.
req, resp := client.CreateEventSubscriptionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateEventSubscription

func (*RDS) CreateEventSubscriptionWithContext added in v1.8.0

func (c *RDS) CreateEventSubscriptionWithContext(ctx aws.Context, input *CreateEventSubscriptionInput, opts ...request.Option) (*CreateEventSubscriptionOutput, error)

CreateEventSubscriptionWithContext is the same as CreateEventSubscription with the addition of the ability to pass a context and additional request options.

See CreateEventSubscription for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CreateGlobalCluster added in v1.15.85

func (c *RDS) CreateGlobalCluster(input *CreateGlobalClusterInput) (*CreateGlobalClusterOutput, error)

CreateGlobalCluster API operation for Amazon Relational Database Service.

Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.

You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.

This action applies only to Aurora DB clusters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CreateGlobalCluster for usage and error information.

Returned Error Codes:

  • ErrCodeGlobalClusterAlreadyExistsFault "GlobalClusterAlreadyExistsFault" The GlobalClusterIdentifier already exists. Choose a new global database identifier (unique name) to create a new global database cluster.

  • ErrCodeGlobalClusterQuotaExceededFault "GlobalClusterQuotaExceededFault" The number of global database clusters for this account is already at the maximum allowed.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateGlobalCluster

func (*RDS) CreateGlobalClusterRequest added in v1.15.85

func (c *RDS) CreateGlobalClusterRequest(input *CreateGlobalClusterInput) (req *request.Request, output *CreateGlobalClusterOutput)

CreateGlobalClusterRequest generates a "aws/request.Request" representing the client's request for the CreateGlobalCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateGlobalCluster for more information on using the CreateGlobalCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateGlobalClusterRequest method.
req, resp := client.CreateGlobalClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateGlobalCluster

func (*RDS) CreateGlobalClusterWithContext added in v1.15.85

func (c *RDS) CreateGlobalClusterWithContext(ctx aws.Context, input *CreateGlobalClusterInput, opts ...request.Option) (*CreateGlobalClusterOutput, error)

CreateGlobalClusterWithContext is the same as CreateGlobalCluster with the addition of the ability to pass a context and additional request options.

See CreateGlobalCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) CreateOptionGroup

func (c *RDS) CreateOptionGroup(input *CreateOptionGroupInput) (*CreateOptionGroupOutput, error)

CreateOptionGroup API operation for Amazon Relational Database Service.

Creates a new option group. You can create up to 20 option groups.

This command doesn't apply to RDS Custom.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation CreateOptionGroup for usage and error information.

Returned Error Codes:

  • ErrCodeOptionGroupAlreadyExistsFault "OptionGroupAlreadyExistsFault" The option group you are trying to create already exists.

  • ErrCodeOptionGroupQuotaExceededFault "OptionGroupQuotaExceededFault" The quota of 20 option groups was exceeded for this Amazon Web Services account.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateOptionGroup

Example (Shared00)

To create an option group This example creates an option group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.CreateOptionGroupInput{
		EngineName:             aws.String("MySQL"),
		MajorEngineVersion:     aws.String("5.6"),
		OptionGroupDescription: aws.String("My MySQL 5.6 option group"),
		OptionGroupName:        aws.String("mymysqloptiongroup"),
	}

	result, err := svc.CreateOptionGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeOptionGroupAlreadyExistsFault:
				fmt.Println(rds.ErrCodeOptionGroupAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeOptionGroupQuotaExceededFault:
				fmt.Println(rds.ErrCodeOptionGroupQuotaExceededFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) CreateOptionGroupRequest

func (c *RDS) CreateOptionGroupRequest(input *CreateOptionGroupInput) (req *request.Request, output *CreateOptionGroupOutput)

CreateOptionGroupRequest generates a "aws/request.Request" representing the client's request for the CreateOptionGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateOptionGroup for more information on using the CreateOptionGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateOptionGroupRequest method.
req, resp := client.CreateOptionGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateOptionGroup

func (*RDS) CreateOptionGroupWithContext added in v1.8.0

func (c *RDS) CreateOptionGroupWithContext(ctx aws.Context, input *CreateOptionGroupInput, opts ...request.Option) (*CreateOptionGroupOutput, error)

CreateOptionGroupWithContext is the same as CreateOptionGroup with the addition of the ability to pass a context and additional request options.

See CreateOptionGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DeleteCustomDBEngineVersion added in v1.41.10

func (c *RDS) DeleteCustomDBEngineVersion(input *DeleteCustomDBEngineVersionInput) (*DeleteCustomDBEngineVersionOutput, error)

DeleteCustomDBEngineVersion API operation for Amazon Relational Database Service.

Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:

  • The CEV must not be the default for RDS Custom. If it is, change the default before running this command.

  • The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance.

Typically, deletion takes a few minutes.

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the DeleteCustomDbEngineVersion event.

For more information, see Deleting a CEV (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.delete) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DeleteCustomDBEngineVersion for usage and error information.

Returned Error Codes:

  • ErrCodeCustomDBEngineVersionNotFoundFault "CustomDBEngineVersionNotFoundFault" The specified CEV was not found.

  • ErrCodeInvalidCustomDBEngineVersionStateFault "InvalidCustomDBEngineVersionStateFault" You can't delete the CEV.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteCustomDBEngineVersion

func (*RDS) DeleteCustomDBEngineVersionRequest added in v1.41.10

func (c *RDS) DeleteCustomDBEngineVersionRequest(input *DeleteCustomDBEngineVersionInput) (req *request.Request, output *DeleteCustomDBEngineVersionOutput)

DeleteCustomDBEngineVersionRequest generates a "aws/request.Request" representing the client's request for the DeleteCustomDBEngineVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCustomDBEngineVersion for more information on using the DeleteCustomDBEngineVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteCustomDBEngineVersionRequest method.
req, resp := client.DeleteCustomDBEngineVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteCustomDBEngineVersion

func (*RDS) DeleteCustomDBEngineVersionWithContext added in v1.41.10

func (c *RDS) DeleteCustomDBEngineVersionWithContext(ctx aws.Context, input *DeleteCustomDBEngineVersionInput, opts ...request.Option) (*DeleteCustomDBEngineVersionOutput, error)

DeleteCustomDBEngineVersionWithContext is the same as DeleteCustomDBEngineVersion with the addition of the ability to pass a context and additional request options.

See DeleteCustomDBEngineVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DeleteDBCluster added in v0.7.1

func (c *RDS) DeleteDBCluster(input *DeleteDBClusterInput) (*DeleteDBClusterOutput, error)

DeleteDBCluster API operation for Amazon Relational Database Service.

The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

For more information on Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DeleteDBCluster for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeDBClusterSnapshotAlreadyExistsFault "DBClusterSnapshotAlreadyExistsFault" The user already has a DB cluster snapshot with the given identifier.

  • ErrCodeSnapshotQuotaExceededFault "SnapshotQuotaExceeded" The request would result in the user exceeding the allowed number of DB snapshots.

  • ErrCodeInvalidDBClusterSnapshotStateFault "InvalidDBClusterSnapshotStateFault" The supplied value isn't a valid DB cluster snapshot state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBCluster

Example (Shared00)

To delete a DB cluster. This example deletes the specified DB cluster.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DeleteDBClusterInput{
		DBClusterIdentifier: aws.String("mydbcluster"),
		SkipFinalSnapshot:   aws.Bool(true),
	}

	result, err := svc.DeleteDBCluster(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBClusterNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidDBClusterStateFault:
				fmt.Println(rds.ErrCodeInvalidDBClusterStateFault, aerr.Error())
			case rds.ErrCodeDBClusterSnapshotAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBClusterSnapshotAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeSnapshotQuotaExceededFault:
				fmt.Println(rds.ErrCodeSnapshotQuotaExceededFault, aerr.Error())
			case rds.ErrCodeInvalidDBClusterSnapshotStateFault:
				fmt.Println(rds.ErrCodeInvalidDBClusterSnapshotStateFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DeleteDBClusterEndpoint added in v1.15.74

func (c *RDS) DeleteDBClusterEndpoint(input *DeleteDBClusterEndpointInput) (*DeleteDBClusterEndpointOutput, error)

DeleteDBClusterEndpoint API operation for Amazon Relational Database Service.

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DeleteDBClusterEndpoint for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBClusterEndpointStateFault "InvalidDBClusterEndpointStateFault" The requested operation can't be performed on the endpoint while the endpoint is in this state.

  • ErrCodeDBClusterEndpointNotFoundFault "DBClusterEndpointNotFoundFault" The specified custom endpoint doesn't exist.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBClusterEndpoint

func (*RDS) DeleteDBClusterEndpointRequest added in v1.15.74

func (c *RDS) DeleteDBClusterEndpointRequest(input *DeleteDBClusterEndpointInput) (req *request.Request, output *DeleteDBClusterEndpointOutput)

DeleteDBClusterEndpointRequest generates a "aws/request.Request" representing the client's request for the DeleteDBClusterEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDBClusterEndpoint for more information on using the DeleteDBClusterEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDBClusterEndpointRequest method.
req, resp := client.DeleteDBClusterEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBClusterEndpoint

func (*RDS) DeleteDBClusterEndpointWithContext added in v1.15.74

func (c *RDS) DeleteDBClusterEndpointWithContext(ctx aws.Context, input *DeleteDBClusterEndpointInput, opts ...request.Option) (*DeleteDBClusterEndpointOutput, error)

DeleteDBClusterEndpointWithContext is the same as DeleteDBClusterEndpoint with the addition of the ability to pass a context and additional request options.

See DeleteDBClusterEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DeleteDBClusterParameterGroup added in v0.7.1

func (c *RDS) DeleteDBClusterParameterGroup(input *DeleteDBClusterParameterGroupInput) (*DeleteDBClusterParameterGroupOutput, error)

DeleteDBClusterParameterGroup API operation for Amazon Relational Database Service.

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

For more information on Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DeleteDBClusterParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBParameterGroupStateFault "InvalidDBParameterGroupState" The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing DB parameter group.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBClusterParameterGroup

Example (Shared00)

To delete a DB cluster parameter group. This example deletes the specified DB cluster parameter group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DeleteDBClusterParameterGroupInput{
		DBClusterParameterGroupName: aws.String("mydbclusterparametergroup"),
	}

	result, err := svc.DeleteDBClusterParameterGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeInvalidDBParameterGroupStateFault:
				fmt.Println(rds.ErrCodeInvalidDBParameterGroupStateFault, aerr.Error())
			case rds.ErrCodeDBParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBParameterGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DeleteDBClusterParameterGroupRequest added in v0.7.1

func (c *RDS) DeleteDBClusterParameterGroupRequest(input *DeleteDBClusterParameterGroupInput) (req *request.Request, output *DeleteDBClusterParameterGroupOutput)

DeleteDBClusterParameterGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteDBClusterParameterGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDBClusterParameterGroup for more information on using the DeleteDBClusterParameterGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDBClusterParameterGroupRequest method.
req, resp := client.DeleteDBClusterParameterGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBClusterParameterGroup

func (*RDS) DeleteDBClusterParameterGroupWithContext added in v1.8.0

func (c *RDS) DeleteDBClusterParameterGroupWithContext(ctx aws.Context, input *DeleteDBClusterParameterGroupInput, opts ...request.Option) (*DeleteDBClusterParameterGroupOutput, error)

DeleteDBClusterParameterGroupWithContext is the same as DeleteDBClusterParameterGroup with the addition of the ability to pass a context and additional request options.

See DeleteDBClusterParameterGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DeleteDBClusterRequest added in v0.7.1

func (c *RDS) DeleteDBClusterRequest(input *DeleteDBClusterInput) (req *request.Request, output *DeleteDBClusterOutput)

DeleteDBClusterRequest generates a "aws/request.Request" representing the client's request for the DeleteDBCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDBCluster for more information on using the DeleteDBCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDBClusterRequest method.
req, resp := client.DeleteDBClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBCluster

func (*RDS) DeleteDBClusterSnapshot added in v0.7.1

func (c *RDS) DeleteDBClusterSnapshot(input *DeleteDBClusterSnapshotInput) (*DeleteDBClusterSnapshotOutput, error)

DeleteDBClusterSnapshot API operation for Amazon Relational Database Service.

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The DB cluster snapshot must be in the available state to be deleted.

For more information on Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DeleteDBClusterSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBClusterSnapshotStateFault "InvalidDBClusterSnapshotStateFault" The supplied value isn't a valid DB cluster snapshot state.

  • ErrCodeDBClusterSnapshotNotFoundFault "DBClusterSnapshotNotFoundFault" DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBClusterSnapshot

Example (Shared00)

To delete a DB cluster snapshot. This example deletes the specified DB cluster snapshot.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DeleteDBClusterSnapshotInput{
		DBClusterSnapshotIdentifier: aws.String("mydbclustersnapshot"),
	}

	result, err := svc.DeleteDBClusterSnapshot(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeInvalidDBClusterSnapshotStateFault:
				fmt.Println(rds.ErrCodeInvalidDBClusterSnapshotStateFault, aerr.Error())
			case rds.ErrCodeDBClusterSnapshotNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterSnapshotNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DeleteDBClusterSnapshotRequest added in v0.7.1

func (c *RDS) DeleteDBClusterSnapshotRequest(input *DeleteDBClusterSnapshotInput) (req *request.Request, output *DeleteDBClusterSnapshotOutput)

DeleteDBClusterSnapshotRequest generates a "aws/request.Request" representing the client's request for the DeleteDBClusterSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDBClusterSnapshot for more information on using the DeleteDBClusterSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDBClusterSnapshotRequest method.
req, resp := client.DeleteDBClusterSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBClusterSnapshot

func (*RDS) DeleteDBClusterSnapshotWithContext added in v1.8.0

func (c *RDS) DeleteDBClusterSnapshotWithContext(ctx aws.Context, input *DeleteDBClusterSnapshotInput, opts ...request.Option) (*DeleteDBClusterSnapshotOutput, error)

DeleteDBClusterSnapshotWithContext is the same as DeleteDBClusterSnapshot with the addition of the ability to pass a context and additional request options.

See DeleteDBClusterSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DeleteDBClusterWithContext added in v1.8.0

func (c *RDS) DeleteDBClusterWithContext(ctx aws.Context, input *DeleteDBClusterInput, opts ...request.Option) (*DeleteDBClusterOutput, error)

DeleteDBClusterWithContext is the same as DeleteDBCluster with the addition of the ability to pass a context and additional request options.

See DeleteDBCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DeleteDBInstance

func (c *RDS) DeleteDBInstance(input *DeleteDBInstanceInput) (*DeleteDBInstanceOutput, error)

DeleteDBInstance API operation for Amazon Relational Database Service.

The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:

  • The DB cluster is a read replica of another Amazon Aurora DB cluster.

  • The DB instance is the only instance in the DB cluster.

To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DeleteDBInstance for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

  • ErrCodeDBSnapshotAlreadyExistsFault "DBSnapshotAlreadyExists" DBSnapshotIdentifier is already used by an existing snapshot.

  • ErrCodeSnapshotQuotaExceededFault "SnapshotQuotaExceeded" The request would result in the user exceeding the allowed number of DB snapshots.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeDBInstanceAutomatedBackupQuotaExceededFault "DBInstanceAutomatedBackupQuotaExceeded" The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB Instance quota.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstance

Example (Shared00)

To delete a DB instance. This example deletes the specified DB instance.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DeleteDBInstanceInput{
		DBInstanceIdentifier: aws.String("mymysqlinstance"),
		SkipFinalSnapshot:    aws.Bool(true),
	}

	result, err := svc.DeleteDBInstance(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBInstanceNotFoundFault:
				fmt.Println(rds.ErrCodeDBInstanceNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidDBInstanceStateFault:
				fmt.Println(rds.ErrCodeInvalidDBInstanceStateFault, aerr.Error())
			case rds.ErrCodeDBSnapshotAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBSnapshotAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeSnapshotQuotaExceededFault:
				fmt.Println(rds.ErrCodeSnapshotQuotaExceededFault, aerr.Error())
			case rds.ErrCodeInvalidDBClusterStateFault:
				fmt.Println(rds.ErrCodeInvalidDBClusterStateFault, aerr.Error())
			case rds.ErrCodeDBInstanceAutomatedBackupQuotaExceededFault:
				fmt.Println(rds.ErrCodeDBInstanceAutomatedBackupQuotaExceededFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DeleteDBInstanceAutomatedBackup added in v1.15.77

func (c *RDS) DeleteDBInstanceAutomatedBackup(input *DeleteDBInstanceAutomatedBackupInput) (*DeleteDBInstanceAutomatedBackupOutput, error)

DeleteDBInstanceAutomatedBackup API operation for Amazon Relational Database Service.

Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DeleteDBInstanceAutomatedBackup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBInstanceAutomatedBackupStateFault "InvalidDBInstanceAutomatedBackupState" The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.

  • ErrCodeDBInstanceAutomatedBackupNotFoundFault "DBInstanceAutomatedBackupNotFound" No automated backup for this DB instance was found.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstanceAutomatedBackup

func (*RDS) DeleteDBInstanceAutomatedBackupRequest added in v1.15.77

func (c *RDS) DeleteDBInstanceAutomatedBackupRequest(input *DeleteDBInstanceAutomatedBackupInput) (req *request.Request, output *DeleteDBInstanceAutomatedBackupOutput)

DeleteDBInstanceAutomatedBackupRequest generates a "aws/request.Request" representing the client's request for the DeleteDBInstanceAutomatedBackup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDBInstanceAutomatedBackup for more information on using the DeleteDBInstanceAutomatedBackup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDBInstanceAutomatedBackupRequest method.
req, resp := client.DeleteDBInstanceAutomatedBackupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstanceAutomatedBackup

func (*RDS) DeleteDBInstanceAutomatedBackupWithContext added in v1.15.77

func (c *RDS) DeleteDBInstanceAutomatedBackupWithContext(ctx aws.Context, input *DeleteDBInstanceAutomatedBackupInput, opts ...request.Option) (*DeleteDBInstanceAutomatedBackupOutput, error)

DeleteDBInstanceAutomatedBackupWithContext is the same as DeleteDBInstanceAutomatedBackup with the addition of the ability to pass a context and additional request options.

See DeleteDBInstanceAutomatedBackup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DeleteDBInstanceRequest

func (c *RDS) DeleteDBInstanceRequest(input *DeleteDBInstanceInput) (req *request.Request, output *DeleteDBInstanceOutput)

DeleteDBInstanceRequest generates a "aws/request.Request" representing the client's request for the DeleteDBInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDBInstance for more information on using the DeleteDBInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDBInstanceRequest method.
req, resp := client.DeleteDBInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstance

func (*RDS) DeleteDBInstanceWithContext added in v1.8.0

func (c *RDS) DeleteDBInstanceWithContext(ctx aws.Context, input *DeleteDBInstanceInput, opts ...request.Option) (*DeleteDBInstanceOutput, error)

DeleteDBInstanceWithContext is the same as DeleteDBInstance with the addition of the ability to pass a context and additional request options.

See DeleteDBInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DeleteDBParameterGroup

func (c *RDS) DeleteDBParameterGroup(input *DeleteDBParameterGroupInput) (*DeleteDBParameterGroupOutput, error)

DeleteDBParameterGroup API operation for Amazon Relational Database Service.

Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DeleteDBParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBParameterGroupStateFault "InvalidDBParameterGroupState" The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing DB parameter group.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBParameterGroup

Example (Shared00)

To delete a DB parameter group The following example deletes a DB parameter group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DeleteDBParameterGroupInput{
		DBParameterGroupName: aws.String("mydbparamgroup3"),
	}

	result, err := svc.DeleteDBParameterGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeInvalidDBParameterGroupStateFault:
				fmt.Println(rds.ErrCodeInvalidDBParameterGroupStateFault, aerr.Error())
			case rds.ErrCodeDBParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBParameterGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DeleteDBParameterGroupRequest

func (c *RDS) DeleteDBParameterGroupRequest(input *DeleteDBParameterGroupInput) (req *request.Request, output *DeleteDBParameterGroupOutput)

DeleteDBParameterGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteDBParameterGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDBParameterGroup for more information on using the DeleteDBParameterGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDBParameterGroupRequest method.
req, resp := client.DeleteDBParameterGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBParameterGroup

func (*RDS) DeleteDBParameterGroupWithContext added in v1.8.0

func (c *RDS) DeleteDBParameterGroupWithContext(ctx aws.Context, input *DeleteDBParameterGroupInput, opts ...request.Option) (*DeleteDBParameterGroupOutput, error)

DeleteDBParameterGroupWithContext is the same as DeleteDBParameterGroup with the addition of the ability to pass a context and additional request options.

See DeleteDBParameterGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DeleteDBProxy added in v1.25.47

func (c *RDS) DeleteDBProxy(input *DeleteDBProxyInput) (*DeleteDBProxyOutput, error)

DeleteDBProxy API operation for Amazon Relational Database Service.

Deletes an existing DB proxy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DeleteDBProxy for usage and error information.

Returned Error Codes:

  • ErrCodeDBProxyNotFoundFault "DBProxyNotFoundFault" The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeInvalidDBProxyStateFault "InvalidDBProxyStateFault" The requested operation can't be performed while the proxy is in this state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBProxy

func (*RDS) DeleteDBProxyEndpoint added in v1.37.27

func (c *RDS) DeleteDBProxyEndpoint(input *DeleteDBProxyEndpointInput) (*DeleteDBProxyEndpointOutput, error)

DeleteDBProxyEndpoint API operation for Amazon Relational Database Service.

Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy's default VPC.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DeleteDBProxyEndpoint for usage and error information.

Returned Error Codes:

  • ErrCodeDBProxyEndpointNotFoundFault "DBProxyEndpointNotFoundFault" The DB proxy endpoint doesn't exist.

  • ErrCodeInvalidDBProxyEndpointStateFault "InvalidDBProxyEndpointStateFault" You can't perform this operation while the DB proxy endpoint is in a particular state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBProxyEndpoint

func (*RDS) DeleteDBProxyEndpointRequest added in v1.37.27

func (c *RDS) DeleteDBProxyEndpointRequest(input *DeleteDBProxyEndpointInput) (req *request.Request, output *DeleteDBProxyEndpointOutput)

DeleteDBProxyEndpointRequest generates a "aws/request.Request" representing the client's request for the DeleteDBProxyEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDBProxyEndpoint for more information on using the DeleteDBProxyEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDBProxyEndpointRequest method.
req, resp := client.DeleteDBProxyEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBProxyEndpoint

func (*RDS) DeleteDBProxyEndpointWithContext added in v1.37.27

func (c *RDS) DeleteDBProxyEndpointWithContext(ctx aws.Context, input *DeleteDBProxyEndpointInput, opts ...request.Option) (*DeleteDBProxyEndpointOutput, error)

DeleteDBProxyEndpointWithContext is the same as DeleteDBProxyEndpoint with the addition of the ability to pass a context and additional request options.

See DeleteDBProxyEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DeleteDBProxyRequest added in v1.25.47

func (c *RDS) DeleteDBProxyRequest(input *DeleteDBProxyInput) (req *request.Request, output *DeleteDBProxyOutput)

DeleteDBProxyRequest generates a "aws/request.Request" representing the client's request for the DeleteDBProxy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDBProxy for more information on using the DeleteDBProxy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDBProxyRequest method.
req, resp := client.DeleteDBProxyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBProxy

func (*RDS) DeleteDBProxyWithContext added in v1.25.47

func (c *RDS) DeleteDBProxyWithContext(ctx aws.Context, input *DeleteDBProxyInput, opts ...request.Option) (*DeleteDBProxyOutput, error)

DeleteDBProxyWithContext is the same as DeleteDBProxy with the addition of the ability to pass a context and additional request options.

See DeleteDBProxy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DeleteDBSecurityGroup

func (c *RDS) DeleteDBSecurityGroup(input *DeleteDBSecurityGroupInput) (*DeleteDBSecurityGroupOutput, error)

DeleteDBSecurityGroup API operation for Amazon Relational Database Service.

Deletes a DB security group.

The specified DB security group must not be associated with any DB instances.

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare (http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/), and Moving a DB instance not in a VPC into a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DeleteDBSecurityGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBSecurityGroupStateFault "InvalidDBSecurityGroupState" The state of the DB security group doesn't allow deletion.

  • ErrCodeDBSecurityGroupNotFoundFault "DBSecurityGroupNotFound" DBSecurityGroupName doesn't refer to an existing DB security group.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBSecurityGroup

Example (Shared00)

To delete a DB security group The following example deletes a DB security group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DeleteDBSecurityGroupInput{
		DBSecurityGroupName: aws.String("mysecgroup"),
	}

	result, err := svc.DeleteDBSecurityGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeInvalidDBSecurityGroupStateFault:
				fmt.Println(rds.ErrCodeInvalidDBSecurityGroupStateFault, aerr.Error())
			case rds.ErrCodeDBSecurityGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSecurityGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DeleteDBSecurityGroupRequest

func (c *RDS) DeleteDBSecurityGroupRequest(input *DeleteDBSecurityGroupInput) (req *request.Request, output *DeleteDBSecurityGroupOutput)

DeleteDBSecurityGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteDBSecurityGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDBSecurityGroup for more information on using the DeleteDBSecurityGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDBSecurityGroupRequest method.
req, resp := client.DeleteDBSecurityGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBSecurityGroup

func (*RDS) DeleteDBSecurityGroupWithContext added in v1.8.0

func (c *RDS) DeleteDBSecurityGroupWithContext(ctx aws.Context, input *DeleteDBSecurityGroupInput, opts ...request.Option) (*DeleteDBSecurityGroupOutput, error)

DeleteDBSecurityGroupWithContext is the same as DeleteDBSecurityGroup with the addition of the ability to pass a context and additional request options.

See DeleteDBSecurityGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DeleteDBSnapshot

func (c *RDS) DeleteDBSnapshot(input *DeleteDBSnapshotInput) (*DeleteDBSnapshotOutput, error)

DeleteDBSnapshot API operation for Amazon Relational Database Service.

Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.

The DB snapshot must be in the available state to be deleted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DeleteDBSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBSnapshotStateFault "InvalidDBSnapshotState" The state of the DB snapshot doesn't allow deletion.

  • ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound" DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBSnapshot

Example (Shared00)

To delete a DB cluster snapshot. This example deletes the specified DB snapshot.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DeleteDBSnapshotInput{
		DBSnapshotIdentifier: aws.String("mydbsnapshot"),
	}

	result, err := svc.DeleteDBSnapshot(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeInvalidDBSnapshotStateFault:
				fmt.Println(rds.ErrCodeInvalidDBSnapshotStateFault, aerr.Error())
			case rds.ErrCodeDBSnapshotNotFoundFault:
				fmt.Println(rds.ErrCodeDBSnapshotNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DeleteDBSnapshotRequest

func (c *RDS) DeleteDBSnapshotRequest(input *DeleteDBSnapshotInput) (req *request.Request, output *DeleteDBSnapshotOutput)

DeleteDBSnapshotRequest generates a "aws/request.Request" representing the client's request for the DeleteDBSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDBSnapshot for more information on using the DeleteDBSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDBSnapshotRequest method.
req, resp := client.DeleteDBSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBSnapshot

func (*RDS) DeleteDBSnapshotWithContext added in v1.8.0

func (c *RDS) DeleteDBSnapshotWithContext(ctx aws.Context, input *DeleteDBSnapshotInput, opts ...request.Option) (*DeleteDBSnapshotOutput, error)

DeleteDBSnapshotWithContext is the same as DeleteDBSnapshot with the addition of the ability to pass a context and additional request options.

See DeleteDBSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DeleteDBSubnetGroup

func (c *RDS) DeleteDBSubnetGroup(input *DeleteDBSubnetGroupInput) (*DeleteDBSubnetGroupOutput, error)

DeleteDBSubnetGroup API operation for Amazon Relational Database Service.

Deletes a DB subnet group.

The specified database subnet group must not be associated with any DB instances.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DeleteDBSubnetGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBSubnetGroupStateFault "InvalidDBSubnetGroupStateFault" The DB subnet group cannot be deleted because it's in use.

  • ErrCodeInvalidDBSubnetStateFault "InvalidDBSubnetStateFault" The DB subnet isn't in the available state.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing DB subnet group.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBSubnetGroup

Example (Shared00)

To delete a DB subnet group. This example deletes the specified DB subnetgroup.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DeleteDBSubnetGroupInput{
		DBSubnetGroupName: aws.String("mydbsubnetgroup"),
	}

	result, err := svc.DeleteDBSubnetGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeInvalidDBSubnetGroupStateFault:
				fmt.Println(rds.ErrCodeInvalidDBSubnetGroupStateFault, aerr.Error())
			case rds.ErrCodeInvalidDBSubnetStateFault:
				fmt.Println(rds.ErrCodeInvalidDBSubnetStateFault, aerr.Error())
			case rds.ErrCodeDBSubnetGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSubnetGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DeleteDBSubnetGroupRequest

func (c *RDS) DeleteDBSubnetGroupRequest(input *DeleteDBSubnetGroupInput) (req *request.Request, output *DeleteDBSubnetGroupOutput)

DeleteDBSubnetGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteDBSubnetGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDBSubnetGroup for more information on using the DeleteDBSubnetGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDBSubnetGroupRequest method.
req, resp := client.DeleteDBSubnetGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBSubnetGroup

func (*RDS) DeleteDBSubnetGroupWithContext added in v1.8.0

func (c *RDS) DeleteDBSubnetGroupWithContext(ctx aws.Context, input *DeleteDBSubnetGroupInput, opts ...request.Option) (*DeleteDBSubnetGroupOutput, error)

DeleteDBSubnetGroupWithContext is the same as DeleteDBSubnetGroup with the addition of the ability to pass a context and additional request options.

See DeleteDBSubnetGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DeleteEventSubscription

func (c *RDS) DeleteEventSubscription(input *DeleteEventSubscriptionInput) (*DeleteEventSubscriptionOutput, error)

DeleteEventSubscription API operation for Amazon Relational Database Service.

Deletes an RDS event notification subscription.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DeleteEventSubscription for usage and error information.

Returned Error Codes:

  • ErrCodeSubscriptionNotFoundFault "SubscriptionNotFound" The subscription name does not exist.

  • ErrCodeInvalidEventSubscriptionStateFault "InvalidEventSubscriptionState" This error can occur if someone else is modifying a subscription. You should retry the action.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteEventSubscription

Example (Shared00)

To delete a DB event subscription. This example deletes the specified DB event subscription.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DeleteEventSubscriptionInput{
		SubscriptionName: aws.String("myeventsubscription"),
	}

	result, err := svc.DeleteEventSubscription(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeSubscriptionNotFoundFault:
				fmt.Println(rds.ErrCodeSubscriptionNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidEventSubscriptionStateFault:
				fmt.Println(rds.ErrCodeInvalidEventSubscriptionStateFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DeleteEventSubscriptionRequest

func (c *RDS) DeleteEventSubscriptionRequest(input *DeleteEventSubscriptionInput) (req *request.Request, output *DeleteEventSubscriptionOutput)

DeleteEventSubscriptionRequest generates a "aws/request.Request" representing the client's request for the DeleteEventSubscription operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteEventSubscription for more information on using the DeleteEventSubscription API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteEventSubscriptionRequest method.
req, resp := client.DeleteEventSubscriptionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteEventSubscription

func (*RDS) DeleteEventSubscriptionWithContext added in v1.8.0

func (c *RDS) DeleteEventSubscriptionWithContext(ctx aws.Context, input *DeleteEventSubscriptionInput, opts ...request.Option) (*DeleteEventSubscriptionOutput, error)

DeleteEventSubscriptionWithContext is the same as DeleteEventSubscription with the addition of the ability to pass a context and additional request options.

See DeleteEventSubscription for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DeleteGlobalCluster added in v1.15.85

func (c *RDS) DeleteGlobalCluster(input *DeleteGlobalClusterInput) (*DeleteGlobalClusterOutput, error)

DeleteGlobalCluster API operation for Amazon Relational Database Service.

Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.

This action only applies to Aurora DB clusters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DeleteGlobalCluster for usage and error information.

Returned Error Codes:

  • ErrCodeGlobalClusterNotFoundFault "GlobalClusterNotFoundFault" The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

  • ErrCodeInvalidGlobalClusterStateFault "InvalidGlobalClusterStateFault" The global cluster is in an invalid state and can't perform the requested operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteGlobalCluster

func (*RDS) DeleteGlobalClusterRequest added in v1.15.85

func (c *RDS) DeleteGlobalClusterRequest(input *DeleteGlobalClusterInput) (req *request.Request, output *DeleteGlobalClusterOutput)

DeleteGlobalClusterRequest generates a "aws/request.Request" representing the client's request for the DeleteGlobalCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteGlobalCluster for more information on using the DeleteGlobalCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteGlobalClusterRequest method.
req, resp := client.DeleteGlobalClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteGlobalCluster

func (*RDS) DeleteGlobalClusterWithContext added in v1.15.85

func (c *RDS) DeleteGlobalClusterWithContext(ctx aws.Context, input *DeleteGlobalClusterInput, opts ...request.Option) (*DeleteGlobalClusterOutput, error)

DeleteGlobalClusterWithContext is the same as DeleteGlobalCluster with the addition of the ability to pass a context and additional request options.

See DeleteGlobalCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DeleteOptionGroup

func (c *RDS) DeleteOptionGroup(input *DeleteOptionGroupInput) (*DeleteOptionGroupOutput, error)

DeleteOptionGroup API operation for Amazon Relational Database Service.

Deletes an existing option group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DeleteOptionGroup for usage and error information.

Returned Error Codes:

  • ErrCodeOptionGroupNotFoundFault "OptionGroupNotFoundFault" The specified option group could not be found.

  • ErrCodeInvalidOptionGroupStateFault "InvalidOptionGroupStateFault" The option group isn't in the available state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteOptionGroup

Example (Shared00)

To delete an option group. This example deletes the specified option group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DeleteOptionGroupInput{
		OptionGroupName: aws.String("mydboptiongroup"),
	}

	result, err := svc.DeleteOptionGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeOptionGroupNotFoundFault:
				fmt.Println(rds.ErrCodeOptionGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidOptionGroupStateFault:
				fmt.Println(rds.ErrCodeInvalidOptionGroupStateFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DeleteOptionGroupRequest

func (c *RDS) DeleteOptionGroupRequest(input *DeleteOptionGroupInput) (req *request.Request, output *DeleteOptionGroupOutput)

DeleteOptionGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteOptionGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteOptionGroup for more information on using the DeleteOptionGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteOptionGroupRequest method.
req, resp := client.DeleteOptionGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteOptionGroup

func (*RDS) DeleteOptionGroupWithContext added in v1.8.0

func (c *RDS) DeleteOptionGroupWithContext(ctx aws.Context, input *DeleteOptionGroupInput, opts ...request.Option) (*DeleteOptionGroupOutput, error)

DeleteOptionGroupWithContext is the same as DeleteOptionGroup with the addition of the ability to pass a context and additional request options.

See DeleteOptionGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DeregisterDBProxyTargets added in v1.25.47

func (c *RDS) DeregisterDBProxyTargets(input *DeregisterDBProxyTargetsInput) (*DeregisterDBProxyTargetsOutput, error)

DeregisterDBProxyTargets API operation for Amazon Relational Database Service.

Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DeregisterDBProxyTargets for usage and error information.

Returned Error Codes:

  • ErrCodeDBProxyTargetNotFoundFault "DBProxyTargetNotFoundFault" The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeDBProxyTargetGroupNotFoundFault "DBProxyTargetGroupNotFoundFault" The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeDBProxyNotFoundFault "DBProxyNotFoundFault" The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeInvalidDBProxyStateFault "InvalidDBProxyStateFault" The requested operation can't be performed while the proxy is in this state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeregisterDBProxyTargets

func (*RDS) DeregisterDBProxyTargetsRequest added in v1.25.47

func (c *RDS) DeregisterDBProxyTargetsRequest(input *DeregisterDBProxyTargetsInput) (req *request.Request, output *DeregisterDBProxyTargetsOutput)

DeregisterDBProxyTargetsRequest generates a "aws/request.Request" representing the client's request for the DeregisterDBProxyTargets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeregisterDBProxyTargets for more information on using the DeregisterDBProxyTargets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeregisterDBProxyTargetsRequest method.
req, resp := client.DeregisterDBProxyTargetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeregisterDBProxyTargets

func (*RDS) DeregisterDBProxyTargetsWithContext added in v1.25.47

func (c *RDS) DeregisterDBProxyTargetsWithContext(ctx aws.Context, input *DeregisterDBProxyTargetsInput, opts ...request.Option) (*DeregisterDBProxyTargetsOutput, error)

DeregisterDBProxyTargetsWithContext is the same as DeregisterDBProxyTargets with the addition of the ability to pass a context and additional request options.

See DeregisterDBProxyTargets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeAccountAttributes

func (c *RDS) DescribeAccountAttributes(input *DescribeAccountAttributesInput) (*DescribeAccountAttributesOutput, error)

DescribeAccountAttributes API operation for Amazon Relational Database Service.

Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

This command doesn't take any parameters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeAccountAttributes for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeAccountAttributes

Example (Shared00)

To list account attributes This example lists account attributes.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeAccountAttributesInput{}

	result, err := svc.DescribeAccountAttributes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeAccountAttributesRequest

func (c *RDS) DescribeAccountAttributesRequest(input *DescribeAccountAttributesInput) (req *request.Request, output *DescribeAccountAttributesOutput)

DescribeAccountAttributesRequest generates a "aws/request.Request" representing the client's request for the DescribeAccountAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAccountAttributes for more information on using the DescribeAccountAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAccountAttributesRequest method.
req, resp := client.DescribeAccountAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeAccountAttributes

func (*RDS) DescribeAccountAttributesWithContext added in v1.8.0

func (c *RDS) DescribeAccountAttributesWithContext(ctx aws.Context, input *DescribeAccountAttributesInput, opts ...request.Option) (*DescribeAccountAttributesOutput, error)

DescribeAccountAttributesWithContext is the same as DescribeAccountAttributes with the addition of the ability to pass a context and additional request options.

See DescribeAccountAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeCertificates

func (c *RDS) DescribeCertificates(input *DescribeCertificatesInput) (*DescribeCertificatesOutput, error)

DescribeCertificates API operation for Amazon Relational Database Service.

Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeCertificates for usage and error information.

Returned Error Codes:

  • ErrCodeCertificateNotFoundFault "CertificateNotFound" CertificateIdentifier doesn't refer to an existing certificate.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeCertificates

Example (Shared00)

To list certificates This example lists up to 20 certificates for the specified certificate identifier.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeCertificatesInput{
		CertificateIdentifier: aws.String("rds-ca-2015"),
		MaxRecords:            aws.Int64(20),
	}

	result, err := svc.DescribeCertificates(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeCertificateNotFoundFault:
				fmt.Println(rds.ErrCodeCertificateNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeCertificatesPages added in v1.32.7

func (c *RDS) DescribeCertificatesPages(input *DescribeCertificatesInput, fn func(*DescribeCertificatesOutput, bool) bool) error

DescribeCertificatesPages iterates over the pages of a DescribeCertificates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeCertificates method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeCertificates operation.
pageNum := 0
err := client.DescribeCertificatesPages(params,
    func(page *rds.DescribeCertificatesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeCertificatesPagesWithContext added in v1.32.7

func (c *RDS) DescribeCertificatesPagesWithContext(ctx aws.Context, input *DescribeCertificatesInput, fn func(*DescribeCertificatesOutput, bool) bool, opts ...request.Option) error

DescribeCertificatesPagesWithContext same as DescribeCertificatesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeCertificatesRequest

func (c *RDS) DescribeCertificatesRequest(input *DescribeCertificatesInput) (req *request.Request, output *DescribeCertificatesOutput)

DescribeCertificatesRequest generates a "aws/request.Request" representing the client's request for the DescribeCertificates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCertificates for more information on using the DescribeCertificates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeCertificatesRequest method.
req, resp := client.DescribeCertificatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeCertificates

func (*RDS) DescribeCertificatesWithContext added in v1.8.0

func (c *RDS) DescribeCertificatesWithContext(ctx aws.Context, input *DescribeCertificatesInput, opts ...request.Option) (*DescribeCertificatesOutput, error)

DescribeCertificatesWithContext is the same as DescribeCertificates with the addition of the ability to pass a context and additional request options.

See DescribeCertificates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBClusterBacktracks added in v1.13.45

func (c *RDS) DescribeDBClusterBacktracks(input *DescribeDBClusterBacktracksInput) (*DescribeDBClusterBacktracksOutput, error)

DescribeDBClusterBacktracks API operation for Amazon Relational Database Service.

Returns information about backtracks for a DB cluster.

For more information on Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

This action only applies to Aurora MySQL DB clusters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBClusterBacktracks for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeDBClusterBacktrackNotFoundFault "DBClusterBacktrackNotFoundFault" BacktrackIdentifier doesn't refer to an existing backtrack.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusterBacktracks

func (*RDS) DescribeDBClusterBacktracksPages added in v1.32.7

func (c *RDS) DescribeDBClusterBacktracksPages(input *DescribeDBClusterBacktracksInput, fn func(*DescribeDBClusterBacktracksOutput, bool) bool) error

DescribeDBClusterBacktracksPages iterates over the pages of a DescribeDBClusterBacktracks operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDBClusterBacktracks method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDBClusterBacktracks operation.
pageNum := 0
err := client.DescribeDBClusterBacktracksPages(params,
    func(page *rds.DescribeDBClusterBacktracksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeDBClusterBacktracksPagesWithContext added in v1.32.7

func (c *RDS) DescribeDBClusterBacktracksPagesWithContext(ctx aws.Context, input *DescribeDBClusterBacktracksInput, fn func(*DescribeDBClusterBacktracksOutput, bool) bool, opts ...request.Option) error

DescribeDBClusterBacktracksPagesWithContext same as DescribeDBClusterBacktracksPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBClusterBacktracksRequest added in v1.13.45

func (c *RDS) DescribeDBClusterBacktracksRequest(input *DescribeDBClusterBacktracksInput) (req *request.Request, output *DescribeDBClusterBacktracksOutput)

DescribeDBClusterBacktracksRequest generates a "aws/request.Request" representing the client's request for the DescribeDBClusterBacktracks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBClusterBacktracks for more information on using the DescribeDBClusterBacktracks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBClusterBacktracksRequest method.
req, resp := client.DescribeDBClusterBacktracksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusterBacktracks

func (*RDS) DescribeDBClusterBacktracksWithContext added in v1.13.45

func (c *RDS) DescribeDBClusterBacktracksWithContext(ctx aws.Context, input *DescribeDBClusterBacktracksInput, opts ...request.Option) (*DescribeDBClusterBacktracksOutput, error)

DescribeDBClusterBacktracksWithContext is the same as DescribeDBClusterBacktracks with the addition of the ability to pass a context and additional request options.

See DescribeDBClusterBacktracks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBClusterEndpoints added in v1.15.74

func (c *RDS) DescribeDBClusterEndpoints(input *DescribeDBClusterEndpointsInput) (*DescribeDBClusterEndpointsOutput, error)

DescribeDBClusterEndpoints API operation for Amazon Relational Database Service.

Returns information about endpoints for an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBClusterEndpoints for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusterEndpoints

func (*RDS) DescribeDBClusterEndpointsPages added in v1.32.7

func (c *RDS) DescribeDBClusterEndpointsPages(input *DescribeDBClusterEndpointsInput, fn func(*DescribeDBClusterEndpointsOutput, bool) bool) error

DescribeDBClusterEndpointsPages iterates over the pages of a DescribeDBClusterEndpoints operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDBClusterEndpoints method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDBClusterEndpoints operation.
pageNum := 0
err := client.DescribeDBClusterEndpointsPages(params,
    func(page *rds.DescribeDBClusterEndpointsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeDBClusterEndpointsPagesWithContext added in v1.32.7

func (c *RDS) DescribeDBClusterEndpointsPagesWithContext(ctx aws.Context, input *DescribeDBClusterEndpointsInput, fn func(*DescribeDBClusterEndpointsOutput, bool) bool, opts ...request.Option) error

DescribeDBClusterEndpointsPagesWithContext same as DescribeDBClusterEndpointsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBClusterEndpointsRequest added in v1.15.74

func (c *RDS) DescribeDBClusterEndpointsRequest(input *DescribeDBClusterEndpointsInput) (req *request.Request, output *DescribeDBClusterEndpointsOutput)

DescribeDBClusterEndpointsRequest generates a "aws/request.Request" representing the client's request for the DescribeDBClusterEndpoints operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBClusterEndpoints for more information on using the DescribeDBClusterEndpoints API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBClusterEndpointsRequest method.
req, resp := client.DescribeDBClusterEndpointsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusterEndpoints

func (*RDS) DescribeDBClusterEndpointsWithContext added in v1.15.74

func (c *RDS) DescribeDBClusterEndpointsWithContext(ctx aws.Context, input *DescribeDBClusterEndpointsInput, opts ...request.Option) (*DescribeDBClusterEndpointsOutput, error)

DescribeDBClusterEndpointsWithContext is the same as DescribeDBClusterEndpoints with the addition of the ability to pass a context and additional request options.

See DescribeDBClusterEndpoints for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBClusterParameterGroups added in v0.7.1

func (c *RDS) DescribeDBClusterParameterGroups(input *DescribeDBClusterParameterGroupsInput) (*DescribeDBClusterParameterGroupsOutput, error)

DescribeDBClusterParameterGroups API operation for Amazon Relational Database Service.

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

For more information on Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBClusterParameterGroups for usage and error information.

Returned Error Codes:

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing DB parameter group.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusterParameterGroups

Example (Shared00)

To list DB cluster parameter group settings This example lists settings for the specified DB cluster parameter group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeDBClusterParameterGroupsInput{
		DBClusterParameterGroupName: aws.String("mydbclusterparametergroup"),
	}

	result, err := svc.DescribeDBClusterParameterGroups(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBParameterGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeDBClusterParameterGroupsPages added in v1.32.7

func (c *RDS) DescribeDBClusterParameterGroupsPages(input *DescribeDBClusterParameterGroupsInput, fn func(*DescribeDBClusterParameterGroupsOutput, bool) bool) error

DescribeDBClusterParameterGroupsPages iterates over the pages of a DescribeDBClusterParameterGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDBClusterParameterGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDBClusterParameterGroups operation.
pageNum := 0
err := client.DescribeDBClusterParameterGroupsPages(params,
    func(page *rds.DescribeDBClusterParameterGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeDBClusterParameterGroupsPagesWithContext added in v1.32.7

func (c *RDS) DescribeDBClusterParameterGroupsPagesWithContext(ctx aws.Context, input *DescribeDBClusterParameterGroupsInput, fn func(*DescribeDBClusterParameterGroupsOutput, bool) bool, opts ...request.Option) error

DescribeDBClusterParameterGroupsPagesWithContext same as DescribeDBClusterParameterGroupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBClusterParameterGroupsRequest added in v0.7.1

func (c *RDS) DescribeDBClusterParameterGroupsRequest(input *DescribeDBClusterParameterGroupsInput) (req *request.Request, output *DescribeDBClusterParameterGroupsOutput)

DescribeDBClusterParameterGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeDBClusterParameterGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBClusterParameterGroups for more information on using the DescribeDBClusterParameterGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBClusterParameterGroupsRequest method.
req, resp := client.DescribeDBClusterParameterGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusterParameterGroups

func (*RDS) DescribeDBClusterParameterGroupsWithContext added in v1.8.0

func (c *RDS) DescribeDBClusterParameterGroupsWithContext(ctx aws.Context, input *DescribeDBClusterParameterGroupsInput, opts ...request.Option) (*DescribeDBClusterParameterGroupsOutput, error)

DescribeDBClusterParameterGroupsWithContext is the same as DescribeDBClusterParameterGroups with the addition of the ability to pass a context and additional request options.

See DescribeDBClusterParameterGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBClusterParameters added in v0.7.1

func (c *RDS) DescribeDBClusterParameters(input *DescribeDBClusterParametersInput) (*DescribeDBClusterParametersOutput, error)

DescribeDBClusterParameters API operation for Amazon Relational Database Service.

Returns the detailed parameter list for a particular DB cluster parameter group.

For more information on Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBClusterParameters for usage and error information.

Returned Error Codes:

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing DB parameter group.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusterParameters

Example (Shared00)

To list DB cluster parameters This example lists system parameters for the specified DB cluster parameter group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeDBClusterParametersInput{
		DBClusterParameterGroupName: aws.String("mydbclusterparametergroup"),
		Source:                      aws.String("system"),
	}

	result, err := svc.DescribeDBClusterParameters(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBParameterGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeDBClusterParametersPages added in v1.32.7

func (c *RDS) DescribeDBClusterParametersPages(input *DescribeDBClusterParametersInput, fn func(*DescribeDBClusterParametersOutput, bool) bool) error

DescribeDBClusterParametersPages iterates over the pages of a DescribeDBClusterParameters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDBClusterParameters method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDBClusterParameters operation.
pageNum := 0
err := client.DescribeDBClusterParametersPages(params,
    func(page *rds.DescribeDBClusterParametersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeDBClusterParametersPagesWithContext added in v1.32.7

func (c *RDS) DescribeDBClusterParametersPagesWithContext(ctx aws.Context, input *DescribeDBClusterParametersInput, fn func(*DescribeDBClusterParametersOutput, bool) bool, opts ...request.Option) error

DescribeDBClusterParametersPagesWithContext same as DescribeDBClusterParametersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBClusterParametersRequest added in v0.7.1

func (c *RDS) DescribeDBClusterParametersRequest(input *DescribeDBClusterParametersInput) (req *request.Request, output *DescribeDBClusterParametersOutput)

DescribeDBClusterParametersRequest generates a "aws/request.Request" representing the client's request for the DescribeDBClusterParameters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBClusterParameters for more information on using the DescribeDBClusterParameters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBClusterParametersRequest method.
req, resp := client.DescribeDBClusterParametersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusterParameters

func (*RDS) DescribeDBClusterParametersWithContext added in v1.8.0

func (c *RDS) DescribeDBClusterParametersWithContext(ctx aws.Context, input *DescribeDBClusterParametersInput, opts ...request.Option) (*DescribeDBClusterParametersOutput, error)

DescribeDBClusterParametersWithContext is the same as DescribeDBClusterParameters with the addition of the ability to pass a context and additional request options.

See DescribeDBClusterParameters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBClusterSnapshotAttributes added in v1.1.30

func (c *RDS) DescribeDBClusterSnapshotAttributes(input *DescribeDBClusterSnapshotAttributesInput) (*DescribeDBClusterSnapshotAttributesOutput, error)

DescribeDBClusterSnapshotAttributes API operation for Amazon Relational Database Service.

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.

To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBClusterSnapshotAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterSnapshotNotFoundFault "DBClusterSnapshotNotFoundFault" DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusterSnapshotAttributes

Example (Shared00)

To list DB cluster snapshot attributes This example lists attributes for the specified DB cluster snapshot.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeDBClusterSnapshotAttributesInput{
		DBClusterSnapshotIdentifier: aws.String("mydbclustersnapshot"),
	}

	result, err := svc.DescribeDBClusterSnapshotAttributes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBClusterSnapshotNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterSnapshotNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeDBClusterSnapshotAttributesRequest added in v1.1.30

func (c *RDS) DescribeDBClusterSnapshotAttributesRequest(input *DescribeDBClusterSnapshotAttributesInput) (req *request.Request, output *DescribeDBClusterSnapshotAttributesOutput)

DescribeDBClusterSnapshotAttributesRequest generates a "aws/request.Request" representing the client's request for the DescribeDBClusterSnapshotAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBClusterSnapshotAttributes for more information on using the DescribeDBClusterSnapshotAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBClusterSnapshotAttributesRequest method.
req, resp := client.DescribeDBClusterSnapshotAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusterSnapshotAttributes

func (*RDS) DescribeDBClusterSnapshotAttributesWithContext added in v1.8.0

func (c *RDS) DescribeDBClusterSnapshotAttributesWithContext(ctx aws.Context, input *DescribeDBClusterSnapshotAttributesInput, opts ...request.Option) (*DescribeDBClusterSnapshotAttributesOutput, error)

DescribeDBClusterSnapshotAttributesWithContext is the same as DescribeDBClusterSnapshotAttributes with the addition of the ability to pass a context and additional request options.

See DescribeDBClusterSnapshotAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBClusterSnapshots added in v0.7.1

func (c *RDS) DescribeDBClusterSnapshots(input *DescribeDBClusterSnapshotsInput) (*DescribeDBClusterSnapshotsOutput, error)

DescribeDBClusterSnapshots API operation for Amazon Relational Database Service.

Returns information about DB cluster snapshots. This API action supports pagination.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBClusterSnapshots for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterSnapshotNotFoundFault "DBClusterSnapshotNotFoundFault" DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusterSnapshots

Example (Shared00)

To list DB cluster snapshots This example lists settings for the specified, manually-created cluster snapshot.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeDBClusterSnapshotsInput{
		DBClusterSnapshotIdentifier: aws.String("mydbclustersnapshot"),
		SnapshotType:                aws.String("manual"),
	}

	result, err := svc.DescribeDBClusterSnapshots(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBClusterSnapshotNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterSnapshotNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeDBClusterSnapshotsPages added in v1.32.7

func (c *RDS) DescribeDBClusterSnapshotsPages(input *DescribeDBClusterSnapshotsInput, fn func(*DescribeDBClusterSnapshotsOutput, bool) bool) error

DescribeDBClusterSnapshotsPages iterates over the pages of a DescribeDBClusterSnapshots operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDBClusterSnapshots method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDBClusterSnapshots operation.
pageNum := 0
err := client.DescribeDBClusterSnapshotsPages(params,
    func(page *rds.DescribeDBClusterSnapshotsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeDBClusterSnapshotsPagesWithContext added in v1.32.7

func (c *RDS) DescribeDBClusterSnapshotsPagesWithContext(ctx aws.Context, input *DescribeDBClusterSnapshotsInput, fn func(*DescribeDBClusterSnapshotsOutput, bool) bool, opts ...request.Option) error

DescribeDBClusterSnapshotsPagesWithContext same as DescribeDBClusterSnapshotsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBClusterSnapshotsRequest added in v0.7.1

func (c *RDS) DescribeDBClusterSnapshotsRequest(input *DescribeDBClusterSnapshotsInput) (req *request.Request, output *DescribeDBClusterSnapshotsOutput)

DescribeDBClusterSnapshotsRequest generates a "aws/request.Request" representing the client's request for the DescribeDBClusterSnapshots operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBClusterSnapshots for more information on using the DescribeDBClusterSnapshots API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBClusterSnapshotsRequest method.
req, resp := client.DescribeDBClusterSnapshotsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusterSnapshots

func (*RDS) DescribeDBClusterSnapshotsWithContext added in v1.8.0

func (c *RDS) DescribeDBClusterSnapshotsWithContext(ctx aws.Context, input *DescribeDBClusterSnapshotsInput, opts ...request.Option) (*DescribeDBClusterSnapshotsOutput, error)

DescribeDBClusterSnapshotsWithContext is the same as DescribeDBClusterSnapshots with the addition of the ability to pass a context and additional request options.

See DescribeDBClusterSnapshots for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBClusters added in v0.7.1

func (c *RDS) DescribeDBClusters(input *DescribeDBClustersInput) (*DescribeDBClustersOutput, error)

DescribeDBClusters API operation for Amazon Relational Database Service.

Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBClusters for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusters

Example (Shared00)

To list DB clusters This example lists settings for the specified DB cluster.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeDBClustersInput{
		DBClusterIdentifier: aws.String("mynewdbcluster"),
	}

	result, err := svc.DescribeDBClusters(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBClusterNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeDBClustersPages added in v1.15.17

func (c *RDS) DescribeDBClustersPages(input *DescribeDBClustersInput, fn func(*DescribeDBClustersOutput, bool) bool) error

DescribeDBClustersPages iterates over the pages of a DescribeDBClusters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDBClusters method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDBClusters operation.
pageNum := 0
err := client.DescribeDBClustersPages(params,
    func(page *rds.DescribeDBClustersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeDBClustersPagesWithContext added in v1.15.17

func (c *RDS) DescribeDBClustersPagesWithContext(ctx aws.Context, input *DescribeDBClustersInput, fn func(*DescribeDBClustersOutput, bool) bool, opts ...request.Option) error

DescribeDBClustersPagesWithContext same as DescribeDBClustersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBClustersRequest added in v0.7.1

func (c *RDS) DescribeDBClustersRequest(input *DescribeDBClustersInput) (req *request.Request, output *DescribeDBClustersOutput)

DescribeDBClustersRequest generates a "aws/request.Request" representing the client's request for the DescribeDBClusters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBClusters for more information on using the DescribeDBClusters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBClustersRequest method.
req, resp := client.DescribeDBClustersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusters

func (*RDS) DescribeDBClustersWithContext added in v1.8.0

func (c *RDS) DescribeDBClustersWithContext(ctx aws.Context, input *DescribeDBClustersInput, opts ...request.Option) (*DescribeDBClustersOutput, error)

DescribeDBClustersWithContext is the same as DescribeDBClusters with the addition of the ability to pass a context and additional request options.

See DescribeDBClusters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBEngineVersions

func (c *RDS) DescribeDBEngineVersions(input *DescribeDBEngineVersionsInput) (*DescribeDBEngineVersionsOutput, error)

DescribeDBEngineVersions API operation for Amazon Relational Database Service.

Returns a list of the available DB engines.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBEngineVersions for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBEngineVersions

Example (Shared00)

To list DB engine version settings This example lists settings for the specified DB engine version.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeDBEngineVersionsInput{
		DBParameterGroupFamily:     aws.String("mysql5.6"),
		DefaultOnly:                aws.Bool(true),
		Engine:                     aws.String("mysql"),
		EngineVersion:              aws.String("5.6"),
		ListSupportedCharacterSets: aws.Bool(true),
	}

	result, err := svc.DescribeDBEngineVersions(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeDBEngineVersionsPages

func (c *RDS) DescribeDBEngineVersionsPages(input *DescribeDBEngineVersionsInput, fn func(*DescribeDBEngineVersionsOutput, bool) bool) error

DescribeDBEngineVersionsPages iterates over the pages of a DescribeDBEngineVersions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDBEngineVersions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDBEngineVersions operation.
pageNum := 0
err := client.DescribeDBEngineVersionsPages(params,
    func(page *rds.DescribeDBEngineVersionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeDBEngineVersionsPagesWithContext added in v1.8.0

func (c *RDS) DescribeDBEngineVersionsPagesWithContext(ctx aws.Context, input *DescribeDBEngineVersionsInput, fn func(*DescribeDBEngineVersionsOutput, bool) bool, opts ...request.Option) error

DescribeDBEngineVersionsPagesWithContext same as DescribeDBEngineVersionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBEngineVersionsRequest

func (c *RDS) DescribeDBEngineVersionsRequest(input *DescribeDBEngineVersionsInput) (req *request.Request, output *DescribeDBEngineVersionsOutput)

DescribeDBEngineVersionsRequest generates a "aws/request.Request" representing the client's request for the DescribeDBEngineVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBEngineVersions for more information on using the DescribeDBEngineVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBEngineVersionsRequest method.
req, resp := client.DescribeDBEngineVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBEngineVersions

func (*RDS) DescribeDBEngineVersionsWithContext added in v1.8.0

func (c *RDS) DescribeDBEngineVersionsWithContext(ctx aws.Context, input *DescribeDBEngineVersionsInput, opts ...request.Option) (*DescribeDBEngineVersionsOutput, error)

DescribeDBEngineVersionsWithContext is the same as DescribeDBEngineVersions with the addition of the ability to pass a context and additional request options.

See DescribeDBEngineVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBInstanceAutomatedBackups added in v1.15.77

func (c *RDS) DescribeDBInstanceAutomatedBackups(input *DescribeDBInstanceAutomatedBackupsInput) (*DescribeDBInstanceAutomatedBackupsOutput, error)

DescribeDBInstanceAutomatedBackups API operation for Amazon Relational Database Service.

Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.

All parameters are optional.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBInstanceAutomatedBackups for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceAutomatedBackupNotFoundFault "DBInstanceAutomatedBackupNotFound" No automated backup for this DB instance was found.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBInstanceAutomatedBackups

func (*RDS) DescribeDBInstanceAutomatedBackupsPages added in v1.15.77

func (c *RDS) DescribeDBInstanceAutomatedBackupsPages(input *DescribeDBInstanceAutomatedBackupsInput, fn func(*DescribeDBInstanceAutomatedBackupsOutput, bool) bool) error

DescribeDBInstanceAutomatedBackupsPages iterates over the pages of a DescribeDBInstanceAutomatedBackups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDBInstanceAutomatedBackups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDBInstanceAutomatedBackups operation.
pageNum := 0
err := client.DescribeDBInstanceAutomatedBackupsPages(params,
    func(page *rds.DescribeDBInstanceAutomatedBackupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeDBInstanceAutomatedBackupsPagesWithContext added in v1.15.77

func (c *RDS) DescribeDBInstanceAutomatedBackupsPagesWithContext(ctx aws.Context, input *DescribeDBInstanceAutomatedBackupsInput, fn func(*DescribeDBInstanceAutomatedBackupsOutput, bool) bool, opts ...request.Option) error

DescribeDBInstanceAutomatedBackupsPagesWithContext same as DescribeDBInstanceAutomatedBackupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBInstanceAutomatedBackupsRequest added in v1.15.77

func (c *RDS) DescribeDBInstanceAutomatedBackupsRequest(input *DescribeDBInstanceAutomatedBackupsInput) (req *request.Request, output *DescribeDBInstanceAutomatedBackupsOutput)

DescribeDBInstanceAutomatedBackupsRequest generates a "aws/request.Request" representing the client's request for the DescribeDBInstanceAutomatedBackups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBInstanceAutomatedBackups for more information on using the DescribeDBInstanceAutomatedBackups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBInstanceAutomatedBackupsRequest method.
req, resp := client.DescribeDBInstanceAutomatedBackupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBInstanceAutomatedBackups

func (*RDS) DescribeDBInstanceAutomatedBackupsWithContext added in v1.15.77

func (c *RDS) DescribeDBInstanceAutomatedBackupsWithContext(ctx aws.Context, input *DescribeDBInstanceAutomatedBackupsInput, opts ...request.Option) (*DescribeDBInstanceAutomatedBackupsOutput, error)

DescribeDBInstanceAutomatedBackupsWithContext is the same as DescribeDBInstanceAutomatedBackups with the addition of the ability to pass a context and additional request options.

See DescribeDBInstanceAutomatedBackups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBInstances

func (c *RDS) DescribeDBInstances(input *DescribeDBInstancesInput) (*DescribeDBInstancesOutput, error)

DescribeDBInstances API operation for Amazon Relational Database Service.

Returns information about provisioned RDS instances. This API supports pagination.

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBInstances for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBInstances

Example (Shared00)

To list DB instance settings This example lists settings for the specified DB instance.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeDBInstancesInput{
		DBInstanceIdentifier: aws.String("mymysqlinstance"),
	}

	result, err := svc.DescribeDBInstances(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBInstanceNotFoundFault:
				fmt.Println(rds.ErrCodeDBInstanceNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeDBInstancesPages

func (c *RDS) DescribeDBInstancesPages(input *DescribeDBInstancesInput, fn func(*DescribeDBInstancesOutput, bool) bool) error

DescribeDBInstancesPages iterates over the pages of a DescribeDBInstances operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDBInstances method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDBInstances operation.
pageNum := 0
err := client.DescribeDBInstancesPages(params,
    func(page *rds.DescribeDBInstancesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeDBInstancesPagesWithContext added in v1.8.0

func (c *RDS) DescribeDBInstancesPagesWithContext(ctx aws.Context, input *DescribeDBInstancesInput, fn func(*DescribeDBInstancesOutput, bool) bool, opts ...request.Option) error

DescribeDBInstancesPagesWithContext same as DescribeDBInstancesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBInstancesRequest

func (c *RDS) DescribeDBInstancesRequest(input *DescribeDBInstancesInput) (req *request.Request, output *DescribeDBInstancesOutput)

DescribeDBInstancesRequest generates a "aws/request.Request" representing the client's request for the DescribeDBInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBInstances for more information on using the DescribeDBInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBInstancesRequest method.
req, resp := client.DescribeDBInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBInstances

func (*RDS) DescribeDBInstancesWithContext added in v1.8.0

func (c *RDS) DescribeDBInstancesWithContext(ctx aws.Context, input *DescribeDBInstancesInput, opts ...request.Option) (*DescribeDBInstancesOutput, error)

DescribeDBInstancesWithContext is the same as DescribeDBInstances with the addition of the ability to pass a context and additional request options.

See DescribeDBInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBLogFiles

func (c *RDS) DescribeDBLogFiles(input *DescribeDBLogFilesInput) (*DescribeDBLogFilesOutput, error)

DescribeDBLogFiles API operation for Amazon Relational Database Service.

Returns a list of DB log files for the DB instance.

This command doesn't apply to RDS Custom.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBLogFiles for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBLogFiles

Example (Shared00)

To list DB log file names This example lists matching log file names for the specified DB instance, file name pattern, last write date in POSIX time with milleseconds, and minimum file size.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeDBLogFilesInput{
		DBInstanceIdentifier: aws.String("mymysqlinstance"),
		FileLastWritten:      aws.Int64(1470873600000),
		FileSize:             aws.Int64(0),
		FilenameContains:     aws.String("error"),
	}

	result, err := svc.DescribeDBLogFiles(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBInstanceNotFoundFault:
				fmt.Println(rds.ErrCodeDBInstanceNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeDBLogFilesPages

func (c *RDS) DescribeDBLogFilesPages(input *DescribeDBLogFilesInput, fn func(*DescribeDBLogFilesOutput, bool) bool) error

DescribeDBLogFilesPages iterates over the pages of a DescribeDBLogFiles operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDBLogFiles method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDBLogFiles operation.
pageNum := 0
err := client.DescribeDBLogFilesPages(params,
    func(page *rds.DescribeDBLogFilesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeDBLogFilesPagesWithContext added in v1.8.0

func (c *RDS) DescribeDBLogFilesPagesWithContext(ctx aws.Context, input *DescribeDBLogFilesInput, fn func(*DescribeDBLogFilesOutput, bool) bool, opts ...request.Option) error

DescribeDBLogFilesPagesWithContext same as DescribeDBLogFilesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBLogFilesRequest

func (c *RDS) DescribeDBLogFilesRequest(input *DescribeDBLogFilesInput) (req *request.Request, output *DescribeDBLogFilesOutput)

DescribeDBLogFilesRequest generates a "aws/request.Request" representing the client's request for the DescribeDBLogFiles operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBLogFiles for more information on using the DescribeDBLogFiles API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBLogFilesRequest method.
req, resp := client.DescribeDBLogFilesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBLogFiles

func (*RDS) DescribeDBLogFilesWithContext added in v1.8.0

func (c *RDS) DescribeDBLogFilesWithContext(ctx aws.Context, input *DescribeDBLogFilesInput, opts ...request.Option) (*DescribeDBLogFilesOutput, error)

DescribeDBLogFilesWithContext is the same as DescribeDBLogFiles with the addition of the ability to pass a context and additional request options.

See DescribeDBLogFiles for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBParameterGroups

func (c *RDS) DescribeDBParameterGroups(input *DescribeDBParameterGroupsInput) (*DescribeDBParameterGroupsOutput, error)

DescribeDBParameterGroups API operation for Amazon Relational Database Service.

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBParameterGroups for usage and error information.

Returned Error Codes:

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing DB parameter group.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBParameterGroups

Example (Shared00)

To list information about DB parameter groups This example lists information about the specified DB parameter group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeDBParameterGroupsInput{
		DBParameterGroupName: aws.String("mymysqlparametergroup"),
	}

	result, err := svc.DescribeDBParameterGroups(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBParameterGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeDBParameterGroupsPages

func (c *RDS) DescribeDBParameterGroupsPages(input *DescribeDBParameterGroupsInput, fn func(*DescribeDBParameterGroupsOutput, bool) bool) error

DescribeDBParameterGroupsPages iterates over the pages of a DescribeDBParameterGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDBParameterGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDBParameterGroups operation.
pageNum := 0
err := client.DescribeDBParameterGroupsPages(params,
    func(page *rds.DescribeDBParameterGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeDBParameterGroupsPagesWithContext added in v1.8.0

func (c *RDS) DescribeDBParameterGroupsPagesWithContext(ctx aws.Context, input *DescribeDBParameterGroupsInput, fn func(*DescribeDBParameterGroupsOutput, bool) bool, opts ...request.Option) error

DescribeDBParameterGroupsPagesWithContext same as DescribeDBParameterGroupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBParameterGroupsRequest

func (c *RDS) DescribeDBParameterGroupsRequest(input *DescribeDBParameterGroupsInput) (req *request.Request, output *DescribeDBParameterGroupsOutput)

DescribeDBParameterGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeDBParameterGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBParameterGroups for more information on using the DescribeDBParameterGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBParameterGroupsRequest method.
req, resp := client.DescribeDBParameterGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBParameterGroups

func (*RDS) DescribeDBParameterGroupsWithContext added in v1.8.0

func (c *RDS) DescribeDBParameterGroupsWithContext(ctx aws.Context, input *DescribeDBParameterGroupsInput, opts ...request.Option) (*DescribeDBParameterGroupsOutput, error)

DescribeDBParameterGroupsWithContext is the same as DescribeDBParameterGroups with the addition of the ability to pass a context and additional request options.

See DescribeDBParameterGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBParameters

func (c *RDS) DescribeDBParameters(input *DescribeDBParametersInput) (*DescribeDBParametersOutput, error)

DescribeDBParameters API operation for Amazon Relational Database Service.

Returns the detailed parameter list for a particular DB parameter group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBParameters for usage and error information.

Returned Error Codes:

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing DB parameter group.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBParameters

Example (Shared00)

To list information about DB parameters This example lists information for up to the first 20 system parameters for the specified DB parameter group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeDBParametersInput{
		DBParameterGroupName: aws.String("mymysqlparametergroup"),
		MaxRecords:           aws.Int64(20),
		Source:               aws.String("system"),
	}

	result, err := svc.DescribeDBParameters(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBParameterGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeDBParametersPages

func (c *RDS) DescribeDBParametersPages(input *DescribeDBParametersInput, fn func(*DescribeDBParametersOutput, bool) bool) error

DescribeDBParametersPages iterates over the pages of a DescribeDBParameters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDBParameters method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDBParameters operation.
pageNum := 0
err := client.DescribeDBParametersPages(params,
    func(page *rds.DescribeDBParametersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeDBParametersPagesWithContext added in v1.8.0

func (c *RDS) DescribeDBParametersPagesWithContext(ctx aws.Context, input *DescribeDBParametersInput, fn func(*DescribeDBParametersOutput, bool) bool, opts ...request.Option) error

DescribeDBParametersPagesWithContext same as DescribeDBParametersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBParametersRequest

func (c *RDS) DescribeDBParametersRequest(input *DescribeDBParametersInput) (req *request.Request, output *DescribeDBParametersOutput)

DescribeDBParametersRequest generates a "aws/request.Request" representing the client's request for the DescribeDBParameters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBParameters for more information on using the DescribeDBParameters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBParametersRequest method.
req, resp := client.DescribeDBParametersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBParameters

func (*RDS) DescribeDBParametersWithContext added in v1.8.0

func (c *RDS) DescribeDBParametersWithContext(ctx aws.Context, input *DescribeDBParametersInput, opts ...request.Option) (*DescribeDBParametersOutput, error)

DescribeDBParametersWithContext is the same as DescribeDBParameters with the addition of the ability to pass a context and additional request options.

See DescribeDBParameters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBProxies added in v1.25.47

func (c *RDS) DescribeDBProxies(input *DescribeDBProxiesInput) (*DescribeDBProxiesOutput, error)

DescribeDBProxies API operation for Amazon Relational Database Service.

Returns information about DB proxies.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBProxies for usage and error information.

Returned Error Codes:

  • ErrCodeDBProxyNotFoundFault "DBProxyNotFoundFault" The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBProxies

func (*RDS) DescribeDBProxiesPages added in v1.25.47

func (c *RDS) DescribeDBProxiesPages(input *DescribeDBProxiesInput, fn func(*DescribeDBProxiesOutput, bool) bool) error

DescribeDBProxiesPages iterates over the pages of a DescribeDBProxies operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDBProxies method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDBProxies operation.
pageNum := 0
err := client.DescribeDBProxiesPages(params,
    func(page *rds.DescribeDBProxiesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeDBProxiesPagesWithContext added in v1.25.47

func (c *RDS) DescribeDBProxiesPagesWithContext(ctx aws.Context, input *DescribeDBProxiesInput, fn func(*DescribeDBProxiesOutput, bool) bool, opts ...request.Option) error

DescribeDBProxiesPagesWithContext same as DescribeDBProxiesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBProxiesRequest added in v1.25.47

func (c *RDS) DescribeDBProxiesRequest(input *DescribeDBProxiesInput) (req *request.Request, output *DescribeDBProxiesOutput)

DescribeDBProxiesRequest generates a "aws/request.Request" representing the client's request for the DescribeDBProxies operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBProxies for more information on using the DescribeDBProxies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBProxiesRequest method.
req, resp := client.DescribeDBProxiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBProxies

func (*RDS) DescribeDBProxiesWithContext added in v1.25.47

func (c *RDS) DescribeDBProxiesWithContext(ctx aws.Context, input *DescribeDBProxiesInput, opts ...request.Option) (*DescribeDBProxiesOutput, error)

DescribeDBProxiesWithContext is the same as DescribeDBProxies with the addition of the ability to pass a context and additional request options.

See DescribeDBProxies for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBProxyEndpoints added in v1.37.27

func (c *RDS) DescribeDBProxyEndpoints(input *DescribeDBProxyEndpointsInput) (*DescribeDBProxyEndpointsOutput, error)

DescribeDBProxyEndpoints API operation for Amazon Relational Database Service.

Returns information about DB proxy endpoints.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBProxyEndpoints for usage and error information.

Returned Error Codes:

  • ErrCodeDBProxyNotFoundFault "DBProxyNotFoundFault" The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeDBProxyEndpointNotFoundFault "DBProxyEndpointNotFoundFault" The DB proxy endpoint doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBProxyEndpoints

func (*RDS) DescribeDBProxyEndpointsPages added in v1.37.27

func (c *RDS) DescribeDBProxyEndpointsPages(input *DescribeDBProxyEndpointsInput, fn func(*DescribeDBProxyEndpointsOutput, bool) bool) error

DescribeDBProxyEndpointsPages iterates over the pages of a DescribeDBProxyEndpoints operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDBProxyEndpoints method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDBProxyEndpoints operation.
pageNum := 0
err := client.DescribeDBProxyEndpointsPages(params,
    func(page *rds.DescribeDBProxyEndpointsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeDBProxyEndpointsPagesWithContext added in v1.37.27

func (c *RDS) DescribeDBProxyEndpointsPagesWithContext(ctx aws.Context, input *DescribeDBProxyEndpointsInput, fn func(*DescribeDBProxyEndpointsOutput, bool) bool, opts ...request.Option) error

DescribeDBProxyEndpointsPagesWithContext same as DescribeDBProxyEndpointsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBProxyEndpointsRequest added in v1.37.27

func (c *RDS) DescribeDBProxyEndpointsRequest(input *DescribeDBProxyEndpointsInput) (req *request.Request, output *DescribeDBProxyEndpointsOutput)

DescribeDBProxyEndpointsRequest generates a "aws/request.Request" representing the client's request for the DescribeDBProxyEndpoints operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBProxyEndpoints for more information on using the DescribeDBProxyEndpoints API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBProxyEndpointsRequest method.
req, resp := client.DescribeDBProxyEndpointsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBProxyEndpoints

func (*RDS) DescribeDBProxyEndpointsWithContext added in v1.37.27

func (c *RDS) DescribeDBProxyEndpointsWithContext(ctx aws.Context, input *DescribeDBProxyEndpointsInput, opts ...request.Option) (*DescribeDBProxyEndpointsOutput, error)

DescribeDBProxyEndpointsWithContext is the same as DescribeDBProxyEndpoints with the addition of the ability to pass a context and additional request options.

See DescribeDBProxyEndpoints for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBProxyTargetGroups added in v1.25.47

func (c *RDS) DescribeDBProxyTargetGroups(input *DescribeDBProxyTargetGroupsInput) (*DescribeDBProxyTargetGroupsOutput, error)

DescribeDBProxyTargetGroups API operation for Amazon Relational Database Service.

Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBProxyTargetGroups for usage and error information.

Returned Error Codes:

  • ErrCodeDBProxyNotFoundFault "DBProxyNotFoundFault" The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeDBProxyTargetGroupNotFoundFault "DBProxyTargetGroupNotFoundFault" The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeInvalidDBProxyStateFault "InvalidDBProxyStateFault" The requested operation can't be performed while the proxy is in this state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBProxyTargetGroups

func (*RDS) DescribeDBProxyTargetGroupsPages added in v1.25.47

func (c *RDS) DescribeDBProxyTargetGroupsPages(input *DescribeDBProxyTargetGroupsInput, fn func(*DescribeDBProxyTargetGroupsOutput, bool) bool) error

DescribeDBProxyTargetGroupsPages iterates over the pages of a DescribeDBProxyTargetGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDBProxyTargetGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDBProxyTargetGroups operation.
pageNum := 0
err := client.DescribeDBProxyTargetGroupsPages(params,
    func(page *rds.DescribeDBProxyTargetGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeDBProxyTargetGroupsPagesWithContext added in v1.25.47

func (c *RDS) DescribeDBProxyTargetGroupsPagesWithContext(ctx aws.Context, input *DescribeDBProxyTargetGroupsInput, fn func(*DescribeDBProxyTargetGroupsOutput, bool) bool, opts ...request.Option) error

DescribeDBProxyTargetGroupsPagesWithContext same as DescribeDBProxyTargetGroupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBProxyTargetGroupsRequest added in v1.25.47

func (c *RDS) DescribeDBProxyTargetGroupsRequest(input *DescribeDBProxyTargetGroupsInput) (req *request.Request, output *DescribeDBProxyTargetGroupsOutput)

DescribeDBProxyTargetGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeDBProxyTargetGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBProxyTargetGroups for more information on using the DescribeDBProxyTargetGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBProxyTargetGroupsRequest method.
req, resp := client.DescribeDBProxyTargetGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBProxyTargetGroups

func (*RDS) DescribeDBProxyTargetGroupsWithContext added in v1.25.47

func (c *RDS) DescribeDBProxyTargetGroupsWithContext(ctx aws.Context, input *DescribeDBProxyTargetGroupsInput, opts ...request.Option) (*DescribeDBProxyTargetGroupsOutput, error)

DescribeDBProxyTargetGroupsWithContext is the same as DescribeDBProxyTargetGroups with the addition of the ability to pass a context and additional request options.

See DescribeDBProxyTargetGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBProxyTargets added in v1.25.47

func (c *RDS) DescribeDBProxyTargets(input *DescribeDBProxyTargetsInput) (*DescribeDBProxyTargetsOutput, error)

DescribeDBProxyTargets API operation for Amazon Relational Database Service.

Returns information about DBProxyTarget objects. This API supports pagination.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBProxyTargets for usage and error information.

Returned Error Codes:

  • ErrCodeDBProxyNotFoundFault "DBProxyNotFoundFault" The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeDBProxyTargetNotFoundFault "DBProxyTargetNotFoundFault" The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeDBProxyTargetGroupNotFoundFault "DBProxyTargetGroupNotFoundFault" The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeInvalidDBProxyStateFault "InvalidDBProxyStateFault" The requested operation can't be performed while the proxy is in this state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBProxyTargets

func (*RDS) DescribeDBProxyTargetsPages added in v1.25.47

func (c *RDS) DescribeDBProxyTargetsPages(input *DescribeDBProxyTargetsInput, fn func(*DescribeDBProxyTargetsOutput, bool) bool) error

DescribeDBProxyTargetsPages iterates over the pages of a DescribeDBProxyTargets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDBProxyTargets method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDBProxyTargets operation.
pageNum := 0
err := client.DescribeDBProxyTargetsPages(params,
    func(page *rds.DescribeDBProxyTargetsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeDBProxyTargetsPagesWithContext added in v1.25.47

func (c *RDS) DescribeDBProxyTargetsPagesWithContext(ctx aws.Context, input *DescribeDBProxyTargetsInput, fn func(*DescribeDBProxyTargetsOutput, bool) bool, opts ...request.Option) error

DescribeDBProxyTargetsPagesWithContext same as DescribeDBProxyTargetsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBProxyTargetsRequest added in v1.25.47

func (c *RDS) DescribeDBProxyTargetsRequest(input *DescribeDBProxyTargetsInput) (req *request.Request, output *DescribeDBProxyTargetsOutput)

DescribeDBProxyTargetsRequest generates a "aws/request.Request" representing the client's request for the DescribeDBProxyTargets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBProxyTargets for more information on using the DescribeDBProxyTargets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBProxyTargetsRequest method.
req, resp := client.DescribeDBProxyTargetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBProxyTargets

func (*RDS) DescribeDBProxyTargetsWithContext added in v1.25.47

func (c *RDS) DescribeDBProxyTargetsWithContext(ctx aws.Context, input *DescribeDBProxyTargetsInput, opts ...request.Option) (*DescribeDBProxyTargetsOutput, error)

DescribeDBProxyTargetsWithContext is the same as DescribeDBProxyTargets with the addition of the ability to pass a context and additional request options.

See DescribeDBProxyTargets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBSecurityGroups

func (c *RDS) DescribeDBSecurityGroups(input *DescribeDBSecurityGroupsInput) (*DescribeDBSecurityGroupsOutput, error)

DescribeDBSecurityGroups API operation for Amazon Relational Database Service.

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare (http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/), and Moving a DB instance not in a VPC into a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBSecurityGroups for usage and error information.

Returned Error Codes:

  • ErrCodeDBSecurityGroupNotFoundFault "DBSecurityGroupNotFound" DBSecurityGroupName doesn't refer to an existing DB security group.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBSecurityGroups

Example (Shared00)

To list DB security group settings This example lists settings for the specified security group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeDBSecurityGroupsInput{
		DBSecurityGroupName: aws.String("mydbsecuritygroup"),
	}

	result, err := svc.DescribeDBSecurityGroups(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBSecurityGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSecurityGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeDBSecurityGroupsPages

func (c *RDS) DescribeDBSecurityGroupsPages(input *DescribeDBSecurityGroupsInput, fn func(*DescribeDBSecurityGroupsOutput, bool) bool) error

DescribeDBSecurityGroupsPages iterates over the pages of a DescribeDBSecurityGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDBSecurityGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDBSecurityGroups operation.
pageNum := 0
err := client.DescribeDBSecurityGroupsPages(params,
    func(page *rds.DescribeDBSecurityGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeDBSecurityGroupsPagesWithContext added in v1.8.0

func (c *RDS) DescribeDBSecurityGroupsPagesWithContext(ctx aws.Context, input *DescribeDBSecurityGroupsInput, fn func(*DescribeDBSecurityGroupsOutput, bool) bool, opts ...request.Option) error

DescribeDBSecurityGroupsPagesWithContext same as DescribeDBSecurityGroupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBSecurityGroupsRequest

func (c *RDS) DescribeDBSecurityGroupsRequest(input *DescribeDBSecurityGroupsInput) (req *request.Request, output *DescribeDBSecurityGroupsOutput)

DescribeDBSecurityGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeDBSecurityGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBSecurityGroups for more information on using the DescribeDBSecurityGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBSecurityGroupsRequest method.
req, resp := client.DescribeDBSecurityGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBSecurityGroups

func (*RDS) DescribeDBSecurityGroupsWithContext added in v1.8.0

func (c *RDS) DescribeDBSecurityGroupsWithContext(ctx aws.Context, input *DescribeDBSecurityGroupsInput, opts ...request.Option) (*DescribeDBSecurityGroupsOutput, error)

DescribeDBSecurityGroupsWithContext is the same as DescribeDBSecurityGroups with the addition of the ability to pass a context and additional request options.

See DescribeDBSecurityGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBSnapshotAttributes added in v0.10.4

func (c *RDS) DescribeDBSnapshotAttributes(input *DescribeDBSnapshotAttributesInput) (*DescribeDBSnapshotAttributesOutput, error)

DescribeDBSnapshotAttributes API operation for Amazon Relational Database Service.

Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all Amazon Web Services accounts.

To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBSnapshotAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound" DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBSnapshotAttributes

Example (Shared00)

To list DB snapshot attributes This example lists attributes for the specified DB snapshot.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeDBSnapshotAttributesInput{
		DBSnapshotIdentifier: aws.String("mydbsnapshot"),
	}

	result, err := svc.DescribeDBSnapshotAttributes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBSnapshotNotFoundFault:
				fmt.Println(rds.ErrCodeDBSnapshotNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeDBSnapshotAttributesRequest added in v0.10.4

func (c *RDS) DescribeDBSnapshotAttributesRequest(input *DescribeDBSnapshotAttributesInput) (req *request.Request, output *DescribeDBSnapshotAttributesOutput)

DescribeDBSnapshotAttributesRequest generates a "aws/request.Request" representing the client's request for the DescribeDBSnapshotAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBSnapshotAttributes for more information on using the DescribeDBSnapshotAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBSnapshotAttributesRequest method.
req, resp := client.DescribeDBSnapshotAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBSnapshotAttributes

func (*RDS) DescribeDBSnapshotAttributesWithContext added in v1.8.0

func (c *RDS) DescribeDBSnapshotAttributesWithContext(ctx aws.Context, input *DescribeDBSnapshotAttributesInput, opts ...request.Option) (*DescribeDBSnapshotAttributesOutput, error)

DescribeDBSnapshotAttributesWithContext is the same as DescribeDBSnapshotAttributes with the addition of the ability to pass a context and additional request options.

See DescribeDBSnapshotAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBSnapshots

func (c *RDS) DescribeDBSnapshots(input *DescribeDBSnapshotsInput) (*DescribeDBSnapshotsOutput, error)

DescribeDBSnapshots API operation for Amazon Relational Database Service.

Returns information about DB snapshots. This API action supports pagination.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBSnapshots for usage and error information.

Returned Error Codes:

  • ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound" DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBSnapshots

Example (Shared00)

To list DB snapshot attributes This example lists all manually-created, shared snapshots for the specified DB instance.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeDBSnapshotsInput{
		DBInstanceIdentifier: aws.String("mymysqlinstance"),
		IncludePublic:        aws.Bool(false),
		IncludeShared:        aws.Bool(true),
		SnapshotType:         aws.String("manual"),
	}

	result, err := svc.DescribeDBSnapshots(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBSnapshotNotFoundFault:
				fmt.Println(rds.ErrCodeDBSnapshotNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeDBSnapshotsPages

func (c *RDS) DescribeDBSnapshotsPages(input *DescribeDBSnapshotsInput, fn func(*DescribeDBSnapshotsOutput, bool) bool) error

DescribeDBSnapshotsPages iterates over the pages of a DescribeDBSnapshots operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDBSnapshots method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDBSnapshots operation.
pageNum := 0
err := client.DescribeDBSnapshotsPages(params,
    func(page *rds.DescribeDBSnapshotsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeDBSnapshotsPagesWithContext added in v1.8.0

func (c *RDS) DescribeDBSnapshotsPagesWithContext(ctx aws.Context, input *DescribeDBSnapshotsInput, fn func(*DescribeDBSnapshotsOutput, bool) bool, opts ...request.Option) error

DescribeDBSnapshotsPagesWithContext same as DescribeDBSnapshotsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBSnapshotsRequest

func (c *RDS) DescribeDBSnapshotsRequest(input *DescribeDBSnapshotsInput) (req *request.Request, output *DescribeDBSnapshotsOutput)

DescribeDBSnapshotsRequest generates a "aws/request.Request" representing the client's request for the DescribeDBSnapshots operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBSnapshots for more information on using the DescribeDBSnapshots API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBSnapshotsRequest method.
req, resp := client.DescribeDBSnapshotsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBSnapshots

func (*RDS) DescribeDBSnapshotsWithContext added in v1.8.0

func (c *RDS) DescribeDBSnapshotsWithContext(ctx aws.Context, input *DescribeDBSnapshotsInput, opts ...request.Option) (*DescribeDBSnapshotsOutput, error)

DescribeDBSnapshotsWithContext is the same as DescribeDBSnapshots with the addition of the ability to pass a context and additional request options.

See DescribeDBSnapshots for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBSubnetGroups

func (c *RDS) DescribeDBSubnetGroups(input *DescribeDBSubnetGroupsInput) (*DescribeDBSubnetGroupsOutput, error)

DescribeDBSubnetGroups API operation for Amazon Relational Database Service.

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial (http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeDBSubnetGroups for usage and error information.

Returned Error Codes:

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing DB subnet group.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBSubnetGroups

Example (Shared00)

To list information about DB subnet groups This example lists information about the specified DB subnet group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeDBSubnetGroupsInput{
		DBSubnetGroupName: aws.String("mydbsubnetgroup"),
	}

	result, err := svc.DescribeDBSubnetGroups(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBSubnetGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSubnetGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeDBSubnetGroupsPages

func (c *RDS) DescribeDBSubnetGroupsPages(input *DescribeDBSubnetGroupsInput, fn func(*DescribeDBSubnetGroupsOutput, bool) bool) error

DescribeDBSubnetGroupsPages iterates over the pages of a DescribeDBSubnetGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDBSubnetGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDBSubnetGroups operation.
pageNum := 0
err := client.DescribeDBSubnetGroupsPages(params,
    func(page *rds.DescribeDBSubnetGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeDBSubnetGroupsPagesWithContext added in v1.8.0

func (c *RDS) DescribeDBSubnetGroupsPagesWithContext(ctx aws.Context, input *DescribeDBSubnetGroupsInput, fn func(*DescribeDBSubnetGroupsOutput, bool) bool, opts ...request.Option) error

DescribeDBSubnetGroupsPagesWithContext same as DescribeDBSubnetGroupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeDBSubnetGroupsRequest

func (c *RDS) DescribeDBSubnetGroupsRequest(input *DescribeDBSubnetGroupsInput) (req *request.Request, output *DescribeDBSubnetGroupsOutput)

DescribeDBSubnetGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeDBSubnetGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDBSubnetGroups for more information on using the DescribeDBSubnetGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDBSubnetGroupsRequest method.
req, resp := client.DescribeDBSubnetGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBSubnetGroups

func (*RDS) DescribeDBSubnetGroupsWithContext added in v1.8.0

func (c *RDS) DescribeDBSubnetGroupsWithContext(ctx aws.Context, input *DescribeDBSubnetGroupsInput, opts ...request.Option) (*DescribeDBSubnetGroupsOutput, error)

DescribeDBSubnetGroupsWithContext is the same as DescribeDBSubnetGroups with the addition of the ability to pass a context and additional request options.

See DescribeDBSubnetGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeEngineDefaultClusterParameters added in v0.7.1

func (c *RDS) DescribeEngineDefaultClusterParameters(input *DescribeEngineDefaultClusterParametersInput) (*DescribeEngineDefaultClusterParametersOutput, error)

DescribeEngineDefaultClusterParameters API operation for Amazon Relational Database Service.

Returns the default engine and system parameter information for the cluster database engine.

For more information on Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeEngineDefaultClusterParameters for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeEngineDefaultClusterParameters

Example (Shared00)

To list default parameters for a DB cluster engine This example lists default parameters for the specified DB cluster engine.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeEngineDefaultClusterParametersInput{
		DBParameterGroupFamily: aws.String("aurora5.6"),
	}

	result, err := svc.DescribeEngineDefaultClusterParameters(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeEngineDefaultClusterParametersRequest added in v0.7.1

func (c *RDS) DescribeEngineDefaultClusterParametersRequest(input *DescribeEngineDefaultClusterParametersInput) (req *request.Request, output *DescribeEngineDefaultClusterParametersOutput)

DescribeEngineDefaultClusterParametersRequest generates a "aws/request.Request" representing the client's request for the DescribeEngineDefaultClusterParameters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEngineDefaultClusterParameters for more information on using the DescribeEngineDefaultClusterParameters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEngineDefaultClusterParametersRequest method.
req, resp := client.DescribeEngineDefaultClusterParametersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeEngineDefaultClusterParameters

func (*RDS) DescribeEngineDefaultClusterParametersWithContext added in v1.8.0

func (c *RDS) DescribeEngineDefaultClusterParametersWithContext(ctx aws.Context, input *DescribeEngineDefaultClusterParametersInput, opts ...request.Option) (*DescribeEngineDefaultClusterParametersOutput, error)

DescribeEngineDefaultClusterParametersWithContext is the same as DescribeEngineDefaultClusterParameters with the addition of the ability to pass a context and additional request options.

See DescribeEngineDefaultClusterParameters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeEngineDefaultParameters

func (c *RDS) DescribeEngineDefaultParameters(input *DescribeEngineDefaultParametersInput) (*DescribeEngineDefaultParametersOutput, error)

DescribeEngineDefaultParameters API operation for Amazon Relational Database Service.

Returns the default engine and system parameter information for the specified database engine.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeEngineDefaultParameters for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeEngineDefaultParameters

Example (Shared00)

To list default parameters for a DB engine This example lists default parameters for the specified DB engine.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeEngineDefaultParametersInput{
		DBParameterGroupFamily: aws.String("mysql5.6"),
	}

	result, err := svc.DescribeEngineDefaultParameters(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeEngineDefaultParametersPages

func (c *RDS) DescribeEngineDefaultParametersPages(input *DescribeEngineDefaultParametersInput, fn func(*DescribeEngineDefaultParametersOutput, bool) bool) error

DescribeEngineDefaultParametersPages iterates over the pages of a DescribeEngineDefaultParameters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeEngineDefaultParameters method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeEngineDefaultParameters operation.
pageNum := 0
err := client.DescribeEngineDefaultParametersPages(params,
    func(page *rds.DescribeEngineDefaultParametersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeEngineDefaultParametersPagesWithContext added in v1.8.0

func (c *RDS) DescribeEngineDefaultParametersPagesWithContext(ctx aws.Context, input *DescribeEngineDefaultParametersInput, fn func(*DescribeEngineDefaultParametersOutput, bool) bool, opts ...request.Option) error

DescribeEngineDefaultParametersPagesWithContext same as DescribeEngineDefaultParametersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeEngineDefaultParametersRequest

func (c *RDS) DescribeEngineDefaultParametersRequest(input *DescribeEngineDefaultParametersInput) (req *request.Request, output *DescribeEngineDefaultParametersOutput)

DescribeEngineDefaultParametersRequest generates a "aws/request.Request" representing the client's request for the DescribeEngineDefaultParameters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEngineDefaultParameters for more information on using the DescribeEngineDefaultParameters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEngineDefaultParametersRequest method.
req, resp := client.DescribeEngineDefaultParametersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeEngineDefaultParameters

func (*RDS) DescribeEngineDefaultParametersWithContext added in v1.8.0

func (c *RDS) DescribeEngineDefaultParametersWithContext(ctx aws.Context, input *DescribeEngineDefaultParametersInput, opts ...request.Option) (*DescribeEngineDefaultParametersOutput, error)

DescribeEngineDefaultParametersWithContext is the same as DescribeEngineDefaultParameters with the addition of the ability to pass a context and additional request options.

See DescribeEngineDefaultParameters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeEventCategories

func (c *RDS) DescribeEventCategories(input *DescribeEventCategoriesInput) (*DescribeEventCategoriesOutput, error)

DescribeEventCategories API operation for Amazon Relational Database Service.

Displays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) or the Amazon Aurora User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeEventCategories for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeEventCategories

Example (Shared00)

To list event categories. This example lists all DB instance event categories.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeEventCategoriesInput{
		SourceType: aws.String("db-instance"),
	}

	result, err := svc.DescribeEventCategories(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeEventCategoriesRequest

func (c *RDS) DescribeEventCategoriesRequest(input *DescribeEventCategoriesInput) (req *request.Request, output *DescribeEventCategoriesOutput)

DescribeEventCategoriesRequest generates a "aws/request.Request" representing the client's request for the DescribeEventCategories operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEventCategories for more information on using the DescribeEventCategories API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEventCategoriesRequest method.
req, resp := client.DescribeEventCategoriesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeEventCategories

func (*RDS) DescribeEventCategoriesWithContext added in v1.8.0

func (c *RDS) DescribeEventCategoriesWithContext(ctx aws.Context, input *DescribeEventCategoriesInput, opts ...request.Option) (*DescribeEventCategoriesOutput, error)

DescribeEventCategoriesWithContext is the same as DescribeEventCategories with the addition of the ability to pass a context and additional request options.

See DescribeEventCategories for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeEventSubscriptions

func (c *RDS) DescribeEventSubscriptions(input *DescribeEventSubscriptionsInput) (*DescribeEventSubscriptionsOutput, error)

DescribeEventSubscriptions API operation for Amazon Relational Database Service.

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeEventSubscriptions for usage and error information.

Returned Error Codes:

  • ErrCodeSubscriptionNotFoundFault "SubscriptionNotFound" The subscription name does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeEventSubscriptions

Example (Shared00)

To list information about DB event notification subscriptions This example lists information for the specified DB event notification subscription.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeEventSubscriptionsInput{
		SubscriptionName: aws.String("mymysqleventsubscription"),
	}

	result, err := svc.DescribeEventSubscriptions(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeSubscriptionNotFoundFault:
				fmt.Println(rds.ErrCodeSubscriptionNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeEventSubscriptionsPages

func (c *RDS) DescribeEventSubscriptionsPages(input *DescribeEventSubscriptionsInput, fn func(*DescribeEventSubscriptionsOutput, bool) bool) error

DescribeEventSubscriptionsPages iterates over the pages of a DescribeEventSubscriptions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeEventSubscriptions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeEventSubscriptions operation.
pageNum := 0
err := client.DescribeEventSubscriptionsPages(params,
    func(page *rds.DescribeEventSubscriptionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeEventSubscriptionsPagesWithContext added in v1.8.0

func (c *RDS) DescribeEventSubscriptionsPagesWithContext(ctx aws.Context, input *DescribeEventSubscriptionsInput, fn func(*DescribeEventSubscriptionsOutput, bool) bool, opts ...request.Option) error

DescribeEventSubscriptionsPagesWithContext same as DescribeEventSubscriptionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeEventSubscriptionsRequest

func (c *RDS) DescribeEventSubscriptionsRequest(input *DescribeEventSubscriptionsInput) (req *request.Request, output *DescribeEventSubscriptionsOutput)

DescribeEventSubscriptionsRequest generates a "aws/request.Request" representing the client's request for the DescribeEventSubscriptions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEventSubscriptions for more information on using the DescribeEventSubscriptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEventSubscriptionsRequest method.
req, resp := client.DescribeEventSubscriptionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeEventSubscriptions

func (*RDS) DescribeEventSubscriptionsWithContext added in v1.8.0

func (c *RDS) DescribeEventSubscriptionsWithContext(ctx aws.Context, input *DescribeEventSubscriptionsInput, opts ...request.Option) (*DescribeEventSubscriptionsOutput, error)

DescribeEventSubscriptionsWithContext is the same as DescribeEventSubscriptions with the addition of the ability to pass a context and additional request options.

See DescribeEventSubscriptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeEvents

func (c *RDS) DescribeEvents(input *DescribeEventsInput) (*DescribeEventsOutput, error)

DescribeEvents API operation for Amazon Relational Database Service.

Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.

For more information on working with events, see Monitoring Amazon RDS events (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/working-with-events.html) in the Amazon RDS User Guide and Monitoring Amazon Aurora events (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/working-with-events.html) in the Amazon Aurora User Guide.

By default, RDS returns events that were generated in the past hour.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeEvents for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeEvents

Example (Shared00)

To list information about events This example lists information for all backup-related events for the specified DB instance for the past 7 days (7 days * 24 hours * 60 minutes = 10,080 minutes).

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeEventsInput{
		Duration: aws.Int64(10080),
		EventCategories: []*string{
			aws.String("backup"),
		},
		SourceIdentifier: aws.String("mymysqlinstance"),
		SourceType:       aws.String("db-instance"),
	}

	result, err := svc.DescribeEvents(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeEventsPages

func (c *RDS) DescribeEventsPages(input *DescribeEventsInput, fn func(*DescribeEventsOutput, bool) bool) error

DescribeEventsPages iterates over the pages of a DescribeEvents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeEvents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeEvents operation.
pageNum := 0
err := client.DescribeEventsPages(params,
    func(page *rds.DescribeEventsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeEventsPagesWithContext added in v1.8.0

func (c *RDS) DescribeEventsPagesWithContext(ctx aws.Context, input *DescribeEventsInput, fn func(*DescribeEventsOutput, bool) bool, opts ...request.Option) error

DescribeEventsPagesWithContext same as DescribeEventsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeEventsRequest

func (c *RDS) DescribeEventsRequest(input *DescribeEventsInput) (req *request.Request, output *DescribeEventsOutput)

DescribeEventsRequest generates a "aws/request.Request" representing the client's request for the DescribeEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEvents for more information on using the DescribeEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEventsRequest method.
req, resp := client.DescribeEventsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeEvents

func (*RDS) DescribeEventsWithContext added in v1.8.0

func (c *RDS) DescribeEventsWithContext(ctx aws.Context, input *DescribeEventsInput, opts ...request.Option) (*DescribeEventsOutput, error)

DescribeEventsWithContext is the same as DescribeEvents with the addition of the ability to pass a context and additional request options.

See DescribeEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeExportTasks added in v1.28.8

func (c *RDS) DescribeExportTasks(input *DescribeExportTasksInput) (*DescribeExportTasksOutput, error)

DescribeExportTasks API operation for Amazon Relational Database Service.

Returns information about a snapshot export to Amazon S3. This API operation supports pagination.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeExportTasks for usage and error information.

Returned Error Codes:

  • ErrCodeExportTaskNotFoundFault "ExportTaskNotFound" The export task doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeExportTasks

func (*RDS) DescribeExportTasksPages added in v1.28.8

func (c *RDS) DescribeExportTasksPages(input *DescribeExportTasksInput, fn func(*DescribeExportTasksOutput, bool) bool) error

DescribeExportTasksPages iterates over the pages of a DescribeExportTasks operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeExportTasks method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeExportTasks operation.
pageNum := 0
err := client.DescribeExportTasksPages(params,
    func(page *rds.DescribeExportTasksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeExportTasksPagesWithContext added in v1.28.8

func (c *RDS) DescribeExportTasksPagesWithContext(ctx aws.Context, input *DescribeExportTasksInput, fn func(*DescribeExportTasksOutput, bool) bool, opts ...request.Option) error

DescribeExportTasksPagesWithContext same as DescribeExportTasksPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeExportTasksRequest added in v1.28.8

func (c *RDS) DescribeExportTasksRequest(input *DescribeExportTasksInput) (req *request.Request, output *DescribeExportTasksOutput)

DescribeExportTasksRequest generates a "aws/request.Request" representing the client's request for the DescribeExportTasks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeExportTasks for more information on using the DescribeExportTasks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeExportTasksRequest method.
req, resp := client.DescribeExportTasksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeExportTasks

func (*RDS) DescribeExportTasksWithContext added in v1.28.8

func (c *RDS) DescribeExportTasksWithContext(ctx aws.Context, input *DescribeExportTasksInput, opts ...request.Option) (*DescribeExportTasksOutput, error)

DescribeExportTasksWithContext is the same as DescribeExportTasks with the addition of the ability to pass a context and additional request options.

See DescribeExportTasks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeGlobalClusters added in v1.15.85

func (c *RDS) DescribeGlobalClusters(input *DescribeGlobalClustersInput) (*DescribeGlobalClustersOutput, error)

DescribeGlobalClusters API operation for Amazon Relational Database Service.

Returns information about Aurora global database clusters. This API supports pagination.

For more information on Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeGlobalClusters for usage and error information.

Returned Error Codes:

  • ErrCodeGlobalClusterNotFoundFault "GlobalClusterNotFoundFault" The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeGlobalClusters

func (*RDS) DescribeGlobalClustersPages added in v1.15.85

func (c *RDS) DescribeGlobalClustersPages(input *DescribeGlobalClustersInput, fn func(*DescribeGlobalClustersOutput, bool) bool) error

DescribeGlobalClustersPages iterates over the pages of a DescribeGlobalClusters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeGlobalClusters method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeGlobalClusters operation.
pageNum := 0
err := client.DescribeGlobalClustersPages(params,
    func(page *rds.DescribeGlobalClustersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeGlobalClustersPagesWithContext added in v1.15.85

func (c *RDS) DescribeGlobalClustersPagesWithContext(ctx aws.Context, input *DescribeGlobalClustersInput, fn func(*DescribeGlobalClustersOutput, bool) bool, opts ...request.Option) error

DescribeGlobalClustersPagesWithContext same as DescribeGlobalClustersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeGlobalClustersRequest added in v1.15.85

func (c *RDS) DescribeGlobalClustersRequest(input *DescribeGlobalClustersInput) (req *request.Request, output *DescribeGlobalClustersOutput)

DescribeGlobalClustersRequest generates a "aws/request.Request" representing the client's request for the DescribeGlobalClusters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeGlobalClusters for more information on using the DescribeGlobalClusters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeGlobalClustersRequest method.
req, resp := client.DescribeGlobalClustersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeGlobalClusters

func (*RDS) DescribeGlobalClustersWithContext added in v1.15.85

func (c *RDS) DescribeGlobalClustersWithContext(ctx aws.Context, input *DescribeGlobalClustersInput, opts ...request.Option) (*DescribeGlobalClustersOutput, error)

DescribeGlobalClustersWithContext is the same as DescribeGlobalClusters with the addition of the ability to pass a context and additional request options.

See DescribeGlobalClusters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeOptionGroupOptions

func (c *RDS) DescribeOptionGroupOptions(input *DescribeOptionGroupOptionsInput) (*DescribeOptionGroupOptionsOutput, error)

DescribeOptionGroupOptions API operation for Amazon Relational Database Service.

Describes all available options.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeOptionGroupOptions for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeOptionGroupOptions

Example (Shared00)

To list information about DB option group options This example lists information for all option group options for the specified DB engine.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeOptionGroupOptionsInput{
		EngineName:         aws.String("mysql"),
		MajorEngineVersion: aws.String("5.6"),
	}

	result, err := svc.DescribeOptionGroupOptions(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeOptionGroupOptionsPages

func (c *RDS) DescribeOptionGroupOptionsPages(input *DescribeOptionGroupOptionsInput, fn func(*DescribeOptionGroupOptionsOutput, bool) bool) error

DescribeOptionGroupOptionsPages iterates over the pages of a DescribeOptionGroupOptions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeOptionGroupOptions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeOptionGroupOptions operation.
pageNum := 0
err := client.DescribeOptionGroupOptionsPages(params,
    func(page *rds.DescribeOptionGroupOptionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeOptionGroupOptionsPagesWithContext added in v1.8.0

func (c *RDS) DescribeOptionGroupOptionsPagesWithContext(ctx aws.Context, input *DescribeOptionGroupOptionsInput, fn func(*DescribeOptionGroupOptionsOutput, bool) bool, opts ...request.Option) error

DescribeOptionGroupOptionsPagesWithContext same as DescribeOptionGroupOptionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeOptionGroupOptionsRequest

func (c *RDS) DescribeOptionGroupOptionsRequest(input *DescribeOptionGroupOptionsInput) (req *request.Request, output *DescribeOptionGroupOptionsOutput)

DescribeOptionGroupOptionsRequest generates a "aws/request.Request" representing the client's request for the DescribeOptionGroupOptions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeOptionGroupOptions for more information on using the DescribeOptionGroupOptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeOptionGroupOptionsRequest method.
req, resp := client.DescribeOptionGroupOptionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeOptionGroupOptions

func (*RDS) DescribeOptionGroupOptionsWithContext added in v1.8.0

func (c *RDS) DescribeOptionGroupOptionsWithContext(ctx aws.Context, input *DescribeOptionGroupOptionsInput, opts ...request.Option) (*DescribeOptionGroupOptionsOutput, error)

DescribeOptionGroupOptionsWithContext is the same as DescribeOptionGroupOptions with the addition of the ability to pass a context and additional request options.

See DescribeOptionGroupOptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeOptionGroups

func (c *RDS) DescribeOptionGroups(input *DescribeOptionGroupsInput) (*DescribeOptionGroupsOutput, error)

DescribeOptionGroups API operation for Amazon Relational Database Service.

Describes the available option groups.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeOptionGroups for usage and error information.

Returned Error Codes:

  • ErrCodeOptionGroupNotFoundFault "OptionGroupNotFoundFault" The specified option group could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeOptionGroups

Example (Shared00)

To list information about DB option groups This example lists information for all option groups for the specified DB engine.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeOptionGroupsInput{
		EngineName:         aws.String("mysql"),
		MajorEngineVersion: aws.String("5.6"),
	}

	result, err := svc.DescribeOptionGroups(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeOptionGroupNotFoundFault:
				fmt.Println(rds.ErrCodeOptionGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeOptionGroupsPages

func (c *RDS) DescribeOptionGroupsPages(input *DescribeOptionGroupsInput, fn func(*DescribeOptionGroupsOutput, bool) bool) error

DescribeOptionGroupsPages iterates over the pages of a DescribeOptionGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeOptionGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeOptionGroups operation.
pageNum := 0
err := client.DescribeOptionGroupsPages(params,
    func(page *rds.DescribeOptionGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeOptionGroupsPagesWithContext added in v1.8.0

func (c *RDS) DescribeOptionGroupsPagesWithContext(ctx aws.Context, input *DescribeOptionGroupsInput, fn func(*DescribeOptionGroupsOutput, bool) bool, opts ...request.Option) error

DescribeOptionGroupsPagesWithContext same as DescribeOptionGroupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeOptionGroupsRequest

func (c *RDS) DescribeOptionGroupsRequest(input *DescribeOptionGroupsInput) (req *request.Request, output *DescribeOptionGroupsOutput)

DescribeOptionGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeOptionGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeOptionGroups for more information on using the DescribeOptionGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeOptionGroupsRequest method.
req, resp := client.DescribeOptionGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeOptionGroups

func (*RDS) DescribeOptionGroupsWithContext added in v1.8.0

func (c *RDS) DescribeOptionGroupsWithContext(ctx aws.Context, input *DescribeOptionGroupsInput, opts ...request.Option) (*DescribeOptionGroupsOutput, error)

DescribeOptionGroupsWithContext is the same as DescribeOptionGroups with the addition of the ability to pass a context and additional request options.

See DescribeOptionGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeOrderableDBInstanceOptions

func (c *RDS) DescribeOrderableDBInstanceOptions(input *DescribeOrderableDBInstanceOptionsInput) (*DescribeOrderableDBInstanceOptionsOutput, error)

DescribeOrderableDBInstanceOptions API operation for Amazon Relational Database Service.

Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeOrderableDBInstanceOptions for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeOrderableDBInstanceOptions

Example (Shared00)

To list information about orderable DB instance options This example lists information for all orderable DB instance options for the specified DB engine, engine version, DB instance class, license model, and VPC settings.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeOrderableDBInstanceOptionsInput{
		DBInstanceClass: aws.String("db.t2.micro"),
		Engine:          aws.String("mysql"),
		EngineVersion:   aws.String("5.6.27"),
		LicenseModel:    aws.String("general-public-license"),
		Vpc:             aws.Bool(true),
	}

	result, err := svc.DescribeOrderableDBInstanceOptions(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeOrderableDBInstanceOptionsPages

func (c *RDS) DescribeOrderableDBInstanceOptionsPages(input *DescribeOrderableDBInstanceOptionsInput, fn func(*DescribeOrderableDBInstanceOptionsOutput, bool) bool) error

DescribeOrderableDBInstanceOptionsPages iterates over the pages of a DescribeOrderableDBInstanceOptions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeOrderableDBInstanceOptions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeOrderableDBInstanceOptions operation.
pageNum := 0
err := client.DescribeOrderableDBInstanceOptionsPages(params,
    func(page *rds.DescribeOrderableDBInstanceOptionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeOrderableDBInstanceOptionsPagesWithContext added in v1.8.0

func (c *RDS) DescribeOrderableDBInstanceOptionsPagesWithContext(ctx aws.Context, input *DescribeOrderableDBInstanceOptionsInput, fn func(*DescribeOrderableDBInstanceOptionsOutput, bool) bool, opts ...request.Option) error

DescribeOrderableDBInstanceOptionsPagesWithContext same as DescribeOrderableDBInstanceOptionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeOrderableDBInstanceOptionsRequest

func (c *RDS) DescribeOrderableDBInstanceOptionsRequest(input *DescribeOrderableDBInstanceOptionsInput) (req *request.Request, output *DescribeOrderableDBInstanceOptionsOutput)

DescribeOrderableDBInstanceOptionsRequest generates a "aws/request.Request" representing the client's request for the DescribeOrderableDBInstanceOptions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeOrderableDBInstanceOptions for more information on using the DescribeOrderableDBInstanceOptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeOrderableDBInstanceOptionsRequest method.
req, resp := client.DescribeOrderableDBInstanceOptionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeOrderableDBInstanceOptions

func (*RDS) DescribeOrderableDBInstanceOptionsWithContext added in v1.8.0

func (c *RDS) DescribeOrderableDBInstanceOptionsWithContext(ctx aws.Context, input *DescribeOrderableDBInstanceOptionsInput, opts ...request.Option) (*DescribeOrderableDBInstanceOptionsOutput, error)

DescribeOrderableDBInstanceOptionsWithContext is the same as DescribeOrderableDBInstanceOptions with the addition of the ability to pass a context and additional request options.

See DescribeOrderableDBInstanceOptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribePendingMaintenanceActions

func (c *RDS) DescribePendingMaintenanceActions(input *DescribePendingMaintenanceActionsInput) (*DescribePendingMaintenanceActionsOutput, error)

DescribePendingMaintenanceActions API operation for Amazon Relational Database Service.

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribePendingMaintenanceActions for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundFault "ResourceNotFoundFault" The specified resource ID was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribePendingMaintenanceActions

Example (Shared00)

To list information about pending maintenance actions This example lists information for all pending maintenance actions for the specified DB instance.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribePendingMaintenanceActionsInput{
		ResourceIdentifier: aws.String("arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance"),
	}

	result, err := svc.DescribePendingMaintenanceActions(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeResourceNotFoundFault:
				fmt.Println(rds.ErrCodeResourceNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribePendingMaintenanceActionsPages added in v1.32.7

func (c *RDS) DescribePendingMaintenanceActionsPages(input *DescribePendingMaintenanceActionsInput, fn func(*DescribePendingMaintenanceActionsOutput, bool) bool) error

DescribePendingMaintenanceActionsPages iterates over the pages of a DescribePendingMaintenanceActions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribePendingMaintenanceActions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribePendingMaintenanceActions operation.
pageNum := 0
err := client.DescribePendingMaintenanceActionsPages(params,
    func(page *rds.DescribePendingMaintenanceActionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribePendingMaintenanceActionsPagesWithContext added in v1.32.7

func (c *RDS) DescribePendingMaintenanceActionsPagesWithContext(ctx aws.Context, input *DescribePendingMaintenanceActionsInput, fn func(*DescribePendingMaintenanceActionsOutput, bool) bool, opts ...request.Option) error

DescribePendingMaintenanceActionsPagesWithContext same as DescribePendingMaintenanceActionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribePendingMaintenanceActionsRequest

func (c *RDS) DescribePendingMaintenanceActionsRequest(input *DescribePendingMaintenanceActionsInput) (req *request.Request, output *DescribePendingMaintenanceActionsOutput)

DescribePendingMaintenanceActionsRequest generates a "aws/request.Request" representing the client's request for the DescribePendingMaintenanceActions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePendingMaintenanceActions for more information on using the DescribePendingMaintenanceActions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribePendingMaintenanceActionsRequest method.
req, resp := client.DescribePendingMaintenanceActionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribePendingMaintenanceActions

func (*RDS) DescribePendingMaintenanceActionsWithContext added in v1.8.0

func (c *RDS) DescribePendingMaintenanceActionsWithContext(ctx aws.Context, input *DescribePendingMaintenanceActionsInput, opts ...request.Option) (*DescribePendingMaintenanceActionsOutput, error)

DescribePendingMaintenanceActionsWithContext is the same as DescribePendingMaintenanceActions with the addition of the ability to pass a context and additional request options.

See DescribePendingMaintenanceActions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeReservedDBInstances

func (c *RDS) DescribeReservedDBInstances(input *DescribeReservedDBInstancesInput) (*DescribeReservedDBInstancesOutput, error)

DescribeReservedDBInstances API operation for Amazon Relational Database Service.

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeReservedDBInstances for usage and error information.

Returned Error Codes:

  • ErrCodeReservedDBInstanceNotFoundFault "ReservedDBInstanceNotFound" The specified reserved DB Instance not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeReservedDBInstances

Example (Shared00)

To list information about reserved DB instances This example lists information for all reserved DB instances for the specified DB instance class, duration, product, offering type, and availability zone settings.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeReservedDBInstancesInput{
		DBInstanceClass:    aws.String("db.t2.micro"),
		Duration:           aws.String("1y"),
		MultiAZ:            aws.Bool(false),
		OfferingType:       aws.String("No Upfront"),
		ProductDescription: aws.String("mysql"),
	}

	result, err := svc.DescribeReservedDBInstances(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeReservedDBInstanceNotFoundFault:
				fmt.Println(rds.ErrCodeReservedDBInstanceNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeReservedDBInstancesOfferings

func (c *RDS) DescribeReservedDBInstancesOfferings(input *DescribeReservedDBInstancesOfferingsInput) (*DescribeReservedDBInstancesOfferingsOutput, error)

DescribeReservedDBInstancesOfferings API operation for Amazon Relational Database Service.

Lists available reserved DB instance offerings.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeReservedDBInstancesOfferings for usage and error information.

Returned Error Codes:

  • ErrCodeReservedDBInstancesOfferingNotFoundFault "ReservedDBInstancesOfferingNotFound" Specified offering does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeReservedDBInstancesOfferings

Example (Shared00)

To list information about reserved DB instance offerings This example lists information for all reserved DB instance offerings for the specified DB instance class, duration, product, offering type, and availability zone settings.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeReservedDBInstancesOfferingsInput{
		DBInstanceClass:    aws.String("db.t2.micro"),
		Duration:           aws.String("1y"),
		MultiAZ:            aws.Bool(false),
		OfferingType:       aws.String("No Upfront"),
		ProductDescription: aws.String("mysql"),
	}

	result, err := svc.DescribeReservedDBInstancesOfferings(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeReservedDBInstancesOfferingNotFoundFault:
				fmt.Println(rds.ErrCodeReservedDBInstancesOfferingNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeReservedDBInstancesOfferingsPages

func (c *RDS) DescribeReservedDBInstancesOfferingsPages(input *DescribeReservedDBInstancesOfferingsInput, fn func(*DescribeReservedDBInstancesOfferingsOutput, bool) bool) error

DescribeReservedDBInstancesOfferingsPages iterates over the pages of a DescribeReservedDBInstancesOfferings operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeReservedDBInstancesOfferings method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeReservedDBInstancesOfferings operation.
pageNum := 0
err := client.DescribeReservedDBInstancesOfferingsPages(params,
    func(page *rds.DescribeReservedDBInstancesOfferingsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeReservedDBInstancesOfferingsPagesWithContext added in v1.8.0

func (c *RDS) DescribeReservedDBInstancesOfferingsPagesWithContext(ctx aws.Context, input *DescribeReservedDBInstancesOfferingsInput, fn func(*DescribeReservedDBInstancesOfferingsOutput, bool) bool, opts ...request.Option) error

DescribeReservedDBInstancesOfferingsPagesWithContext same as DescribeReservedDBInstancesOfferingsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeReservedDBInstancesOfferingsRequest

func (c *RDS) DescribeReservedDBInstancesOfferingsRequest(input *DescribeReservedDBInstancesOfferingsInput) (req *request.Request, output *DescribeReservedDBInstancesOfferingsOutput)

DescribeReservedDBInstancesOfferingsRequest generates a "aws/request.Request" representing the client's request for the DescribeReservedDBInstancesOfferings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeReservedDBInstancesOfferings for more information on using the DescribeReservedDBInstancesOfferings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeReservedDBInstancesOfferingsRequest method.
req, resp := client.DescribeReservedDBInstancesOfferingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeReservedDBInstancesOfferings

func (*RDS) DescribeReservedDBInstancesOfferingsWithContext added in v1.8.0

func (c *RDS) DescribeReservedDBInstancesOfferingsWithContext(ctx aws.Context, input *DescribeReservedDBInstancesOfferingsInput, opts ...request.Option) (*DescribeReservedDBInstancesOfferingsOutput, error)

DescribeReservedDBInstancesOfferingsWithContext is the same as DescribeReservedDBInstancesOfferings with the addition of the ability to pass a context and additional request options.

See DescribeReservedDBInstancesOfferings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeReservedDBInstancesPages

func (c *RDS) DescribeReservedDBInstancesPages(input *DescribeReservedDBInstancesInput, fn func(*DescribeReservedDBInstancesOutput, bool) bool) error

DescribeReservedDBInstancesPages iterates over the pages of a DescribeReservedDBInstances operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeReservedDBInstances method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeReservedDBInstances operation.
pageNum := 0
err := client.DescribeReservedDBInstancesPages(params,
    func(page *rds.DescribeReservedDBInstancesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeReservedDBInstancesPagesWithContext added in v1.8.0

func (c *RDS) DescribeReservedDBInstancesPagesWithContext(ctx aws.Context, input *DescribeReservedDBInstancesInput, fn func(*DescribeReservedDBInstancesOutput, bool) bool, opts ...request.Option) error

DescribeReservedDBInstancesPagesWithContext same as DescribeReservedDBInstancesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeReservedDBInstancesRequest

func (c *RDS) DescribeReservedDBInstancesRequest(input *DescribeReservedDBInstancesInput) (req *request.Request, output *DescribeReservedDBInstancesOutput)

DescribeReservedDBInstancesRequest generates a "aws/request.Request" representing the client's request for the DescribeReservedDBInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeReservedDBInstances for more information on using the DescribeReservedDBInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeReservedDBInstancesRequest method.
req, resp := client.DescribeReservedDBInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeReservedDBInstances

func (*RDS) DescribeReservedDBInstancesWithContext added in v1.8.0

func (c *RDS) DescribeReservedDBInstancesWithContext(ctx aws.Context, input *DescribeReservedDBInstancesInput, opts ...request.Option) (*DescribeReservedDBInstancesOutput, error)

DescribeReservedDBInstancesWithContext is the same as DescribeReservedDBInstances with the addition of the ability to pass a context and additional request options.

See DescribeReservedDBInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeSourceRegions added in v1.4.7

func (c *RDS) DescribeSourceRegions(input *DescribeSourceRegionsInput) (*DescribeSourceRegionsOutput, error)

DescribeSourceRegions API operation for Amazon Relational Database Service.

Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. This API action supports pagination.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeSourceRegions for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeSourceRegions

Example (Shared00)

To describe source regions To list the AWS regions where a Read Replica can be created.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DescribeSourceRegionsInput{}

	result, err := svc.DescribeSourceRegions(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DescribeSourceRegionsPages added in v1.32.7

func (c *RDS) DescribeSourceRegionsPages(input *DescribeSourceRegionsInput, fn func(*DescribeSourceRegionsOutput, bool) bool) error

DescribeSourceRegionsPages iterates over the pages of a DescribeSourceRegions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeSourceRegions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeSourceRegions operation.
pageNum := 0
err := client.DescribeSourceRegionsPages(params,
    func(page *rds.DescribeSourceRegionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DescribeSourceRegionsPagesWithContext added in v1.32.7

func (c *RDS) DescribeSourceRegionsPagesWithContext(ctx aws.Context, input *DescribeSourceRegionsInput, fn func(*DescribeSourceRegionsOutput, bool) bool, opts ...request.Option) error

DescribeSourceRegionsPagesWithContext same as DescribeSourceRegionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeSourceRegionsRequest added in v1.4.7

func (c *RDS) DescribeSourceRegionsRequest(input *DescribeSourceRegionsInput) (req *request.Request, output *DescribeSourceRegionsOutput)

DescribeSourceRegionsRequest generates a "aws/request.Request" representing the client's request for the DescribeSourceRegions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSourceRegions for more information on using the DescribeSourceRegions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeSourceRegionsRequest method.
req, resp := client.DescribeSourceRegionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeSourceRegions

func (*RDS) DescribeSourceRegionsWithContext added in v1.8.0

func (c *RDS) DescribeSourceRegionsWithContext(ctx aws.Context, input *DescribeSourceRegionsInput, opts ...request.Option) (*DescribeSourceRegionsOutput, error)

DescribeSourceRegionsWithContext is the same as DescribeSourceRegions with the addition of the ability to pass a context and additional request options.

See DescribeSourceRegions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DescribeValidDBInstanceModifications added in v1.12.10

func (c *RDS) DescribeValidDBInstanceModifications(input *DescribeValidDBInstanceModificationsInput) (*DescribeValidDBInstanceModificationsOutput, error)

DescribeValidDBInstanceModifications API operation for Amazon Relational Database Service.

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.

This command doesn't apply to RDS Custom.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DescribeValidDBInstanceModifications for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeValidDBInstanceModifications

func (*RDS) DescribeValidDBInstanceModificationsRequest added in v1.12.10

func (c *RDS) DescribeValidDBInstanceModificationsRequest(input *DescribeValidDBInstanceModificationsInput) (req *request.Request, output *DescribeValidDBInstanceModificationsOutput)

DescribeValidDBInstanceModificationsRequest generates a "aws/request.Request" representing the client's request for the DescribeValidDBInstanceModifications operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeValidDBInstanceModifications for more information on using the DescribeValidDBInstanceModifications API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeValidDBInstanceModificationsRequest method.
req, resp := client.DescribeValidDBInstanceModificationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeValidDBInstanceModifications

func (*RDS) DescribeValidDBInstanceModificationsWithContext added in v1.12.10

func (c *RDS) DescribeValidDBInstanceModificationsWithContext(ctx aws.Context, input *DescribeValidDBInstanceModificationsInput, opts ...request.Option) (*DescribeValidDBInstanceModificationsOutput, error)

DescribeValidDBInstanceModificationsWithContext is the same as DescribeValidDBInstanceModifications with the addition of the ability to pass a context and additional request options.

See DescribeValidDBInstanceModifications for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DownloadDBLogFilePortion

func (c *RDS) DownloadDBLogFilePortion(input *DownloadDBLogFilePortionInput) (*DownloadDBLogFilePortionOutput, error)

DownloadDBLogFilePortion API operation for Amazon Relational Database Service.

Downloads all or a portion of the specified log file, up to 1 MB in size.

This command doesn't apply to RDS Custom.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation DownloadDBLogFilePortion for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeDBLogFileNotFoundFault "DBLogFileNotFoundFault" LogFileName doesn't refer to an existing DB log file.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DownloadDBLogFilePortion

Example (Shared00)

To list information about DB log files This example lists information for the specified log file for the specified DB instance.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.DownloadDBLogFilePortionInput{
		DBInstanceIdentifier: aws.String("mymysqlinstance"),
		LogFileName:          aws.String("mysqlUpgrade"),
	}

	result, err := svc.DownloadDBLogFilePortion(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBInstanceNotFoundFault:
				fmt.Println(rds.ErrCodeDBInstanceNotFoundFault, aerr.Error())
			case rds.ErrCodeDBLogFileNotFoundFault:
				fmt.Println(rds.ErrCodeDBLogFileNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) DownloadDBLogFilePortionPages

func (c *RDS) DownloadDBLogFilePortionPages(input *DownloadDBLogFilePortionInput, fn func(*DownloadDBLogFilePortionOutput, bool) bool) error

DownloadDBLogFilePortionPages iterates over the pages of a DownloadDBLogFilePortion operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DownloadDBLogFilePortion method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DownloadDBLogFilePortion operation.
pageNum := 0
err := client.DownloadDBLogFilePortionPages(params,
    func(page *rds.DownloadDBLogFilePortionOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RDS) DownloadDBLogFilePortionPagesWithContext added in v1.8.0

func (c *RDS) DownloadDBLogFilePortionPagesWithContext(ctx aws.Context, input *DownloadDBLogFilePortionInput, fn func(*DownloadDBLogFilePortionOutput, bool) bool, opts ...request.Option) error

DownloadDBLogFilePortionPagesWithContext same as DownloadDBLogFilePortionPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) DownloadDBLogFilePortionRequest

func (c *RDS) DownloadDBLogFilePortionRequest(input *DownloadDBLogFilePortionInput) (req *request.Request, output *DownloadDBLogFilePortionOutput)

DownloadDBLogFilePortionRequest generates a "aws/request.Request" representing the client's request for the DownloadDBLogFilePortion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DownloadDBLogFilePortion for more information on using the DownloadDBLogFilePortion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DownloadDBLogFilePortionRequest method.
req, resp := client.DownloadDBLogFilePortionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DownloadDBLogFilePortion

func (*RDS) DownloadDBLogFilePortionWithContext added in v1.8.0

func (c *RDS) DownloadDBLogFilePortionWithContext(ctx aws.Context, input *DownloadDBLogFilePortionInput, opts ...request.Option) (*DownloadDBLogFilePortionOutput, error)

DownloadDBLogFilePortionWithContext is the same as DownloadDBLogFilePortion with the addition of the ability to pass a context and additional request options.

See DownloadDBLogFilePortion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) FailoverDBCluster added in v0.7.1

func (c *RDS) FailoverDBCluster(input *FailoverDBClusterInput) (*FailoverDBClusterOutput, error)

FailoverDBCluster API operation for Amazon Relational Database Service.

Forces a failover for a DB cluster.

For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).

For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).

An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.

To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation FailoverDBCluster for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/FailoverDBCluster

Example (Shared00)

To perform a failover for a DB cluster This example performs a failover for the specified DB cluster to the specified DB instance.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.FailoverDBClusterInput{
		DBClusterIdentifier:        aws.String("myaurorainstance-cluster"),
		TargetDBInstanceIdentifier: aws.String("myaurorareplica"),
	}

	result, err := svc.FailoverDBCluster(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBClusterNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidDBClusterStateFault:
				fmt.Println(rds.ErrCodeInvalidDBClusterStateFault, aerr.Error())
			case rds.ErrCodeInvalidDBInstanceStateFault:
				fmt.Println(rds.ErrCodeInvalidDBInstanceStateFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) FailoverDBClusterRequest added in v0.7.1

func (c *RDS) FailoverDBClusterRequest(input *FailoverDBClusterInput) (req *request.Request, output *FailoverDBClusterOutput)

FailoverDBClusterRequest generates a "aws/request.Request" representing the client's request for the FailoverDBCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See FailoverDBCluster for more information on using the FailoverDBCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the FailoverDBClusterRequest method.
req, resp := client.FailoverDBClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/FailoverDBCluster

func (*RDS) FailoverDBClusterWithContext added in v1.8.0

func (c *RDS) FailoverDBClusterWithContext(ctx aws.Context, input *FailoverDBClusterInput, opts ...request.Option) (*FailoverDBClusterOutput, error)

FailoverDBClusterWithContext is the same as FailoverDBCluster with the addition of the ability to pass a context and additional request options.

See FailoverDBCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) FailoverGlobalCluster added in v1.37.9

func (c *RDS) FailoverGlobalCluster(input *FailoverGlobalClusterInput) (*FailoverGlobalClusterOutput, error)

FailoverGlobalCluster API operation for Amazon Relational Database Service.

Initiates the failover process for an Aurora global database (GlobalCluster).

A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database.

For more information about failing over an Amazon Aurora global database, see Managed planned failover for Amazon Aurora global databases (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-disaster-recovery.managed-failover) in the Amazon Aurora User Guide.

This action applies to GlobalCluster (Aurora global databases) only. Use this action only on healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to reconfigure your Aurora global database topology.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation FailoverGlobalCluster for usage and error information.

Returned Error Codes:

  • ErrCodeGlobalClusterNotFoundFault "GlobalClusterNotFoundFault" The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

  • ErrCodeInvalidGlobalClusterStateFault "InvalidGlobalClusterStateFault" The global cluster is in an invalid state and can't perform the requested operation.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/FailoverGlobalCluster

func (*RDS) FailoverGlobalClusterRequest added in v1.37.9

func (c *RDS) FailoverGlobalClusterRequest(input *FailoverGlobalClusterInput) (req *request.Request, output *FailoverGlobalClusterOutput)

FailoverGlobalClusterRequest generates a "aws/request.Request" representing the client's request for the FailoverGlobalCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See FailoverGlobalCluster for more information on using the FailoverGlobalCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the FailoverGlobalClusterRequest method.
req, resp := client.FailoverGlobalClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/FailoverGlobalCluster

func (*RDS) FailoverGlobalClusterWithContext added in v1.37.9

func (c *RDS) FailoverGlobalClusterWithContext(ctx aws.Context, input *FailoverGlobalClusterInput, opts ...request.Option) (*FailoverGlobalClusterOutput, error)

FailoverGlobalClusterWithContext is the same as FailoverGlobalCluster with the addition of the ability to pass a context and additional request options.

See FailoverGlobalCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ListTagsForResource

func (c *RDS) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Relational Database Service.

Lists all tags on an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ListTagsForResource for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound" DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeDBProxyNotFoundFault "DBProxyNotFoundFault" The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeDBProxyTargetGroupNotFoundFault "DBProxyTargetGroupNotFoundFault" The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ListTagsForResource

Example (Shared00)

To list information about tags associated with a resource This example lists information about all tags associated with the specified DB option group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.ListTagsForResourceInput{
		ResourceName: aws.String("arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup"),
	}

	result, err := svc.ListTagsForResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBInstanceNotFoundFault:
				fmt.Println(rds.ErrCodeDBInstanceNotFoundFault, aerr.Error())
			case rds.ErrCodeDBSnapshotNotFoundFault:
				fmt.Println(rds.ErrCodeDBSnapshotNotFoundFault, aerr.Error())
			case rds.ErrCodeDBClusterNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterNotFoundFault, aerr.Error())
			case rds.ErrCodeDBProxyNotFoundFault:
				fmt.Println(rds.ErrCodeDBProxyNotFoundFault, aerr.Error())
			case rds.ErrCodeDBProxyTargetGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBProxyTargetGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) ListTagsForResourceRequest

func (c *RDS) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ListTagsForResource

func (*RDS) ListTagsForResourceWithContext added in v1.8.0

func (c *RDS) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ModifyActivityStream added in v1.44.61

func (c *RDS) ModifyActivityStream(input *ModifyActivityStreamInput) (*ModifyActivityStreamOutput, error)

ModifyActivityStream API operation for Amazon Relational Database Service.

Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.Modifying.html) in the Amazon RDS User Guide.

This operation is supported for RDS for Oracle only.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ModifyActivityStream for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

  • ErrCodeResourceNotFoundFault "ResourceNotFoundFault" The specified resource ID was not found.

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyActivityStream

func (*RDS) ModifyActivityStreamRequest added in v1.44.61

func (c *RDS) ModifyActivityStreamRequest(input *ModifyActivityStreamInput) (req *request.Request, output *ModifyActivityStreamOutput)

ModifyActivityStreamRequest generates a "aws/request.Request" representing the client's request for the ModifyActivityStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyActivityStream for more information on using the ModifyActivityStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyActivityStreamRequest method.
req, resp := client.ModifyActivityStreamRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyActivityStream

func (*RDS) ModifyActivityStreamWithContext added in v1.44.61

func (c *RDS) ModifyActivityStreamWithContext(ctx aws.Context, input *ModifyActivityStreamInput, opts ...request.Option) (*ModifyActivityStreamOutput, error)

ModifyActivityStreamWithContext is the same as ModifyActivityStream with the addition of the ability to pass a context and additional request options.

See ModifyActivityStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ModifyCertificates added in v1.28.0

func (c *RDS) ModifyCertificates(input *ModifyCertificatesInput) (*ModifyCertificatesOutput, error)

ModifyCertificates API operation for Amazon Relational Database Service.

Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.

By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.

You might need to override the default certificate in the following situations:

  • You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified Amazon Web Services Region.

  • RDS has already moved to a new default CA certificate for the specified Amazon Web Services Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes.

For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the Amazon RDS User Guide.

For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the Amazon Aurora User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ModifyCertificates for usage and error information.

Returned Error Codes:

  • ErrCodeCertificateNotFoundFault "CertificateNotFound" CertificateIdentifier doesn't refer to an existing certificate.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyCertificates

func (*RDS) ModifyCertificatesRequest added in v1.28.0

func (c *RDS) ModifyCertificatesRequest(input *ModifyCertificatesInput) (req *request.Request, output *ModifyCertificatesOutput)

ModifyCertificatesRequest generates a "aws/request.Request" representing the client's request for the ModifyCertificates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyCertificates for more information on using the ModifyCertificates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyCertificatesRequest method.
req, resp := client.ModifyCertificatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyCertificates

func (*RDS) ModifyCertificatesWithContext added in v1.28.0

func (c *RDS) ModifyCertificatesWithContext(ctx aws.Context, input *ModifyCertificatesInput, opts ...request.Option) (*ModifyCertificatesOutput, error)

ModifyCertificatesWithContext is the same as ModifyCertificates with the addition of the ability to pass a context and additional request options.

See ModifyCertificates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ModifyCurrentDBClusterCapacity added in v1.15.9

func (c *RDS) ModifyCurrentDBClusterCapacity(input *ModifyCurrentDBClusterCapacityInput) (*ModifyCurrentDBClusterCapacityOutput, error)

ModifyCurrentDBClusterCapacity API operation for Amazon Relational Database Service.

Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.

Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly.

After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) in the Amazon Aurora User Guide.

If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling) in the Amazon Aurora User Guide.

This action only applies to Aurora Serverless v1 DB clusters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ModifyCurrentDBClusterCapacity for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeInvalidDBClusterCapacityFault "InvalidDBClusterCapacityFault" Capacity isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyCurrentDBClusterCapacity

func (*RDS) ModifyCurrentDBClusterCapacityRequest added in v1.15.9

func (c *RDS) ModifyCurrentDBClusterCapacityRequest(input *ModifyCurrentDBClusterCapacityInput) (req *request.Request, output *ModifyCurrentDBClusterCapacityOutput)

ModifyCurrentDBClusterCapacityRequest generates a "aws/request.Request" representing the client's request for the ModifyCurrentDBClusterCapacity operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyCurrentDBClusterCapacity for more information on using the ModifyCurrentDBClusterCapacity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyCurrentDBClusterCapacityRequest method.
req, resp := client.ModifyCurrentDBClusterCapacityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyCurrentDBClusterCapacity

func (*RDS) ModifyCurrentDBClusterCapacityWithContext added in v1.15.9

func (c *RDS) ModifyCurrentDBClusterCapacityWithContext(ctx aws.Context, input *ModifyCurrentDBClusterCapacityInput, opts ...request.Option) (*ModifyCurrentDBClusterCapacityOutput, error)

ModifyCurrentDBClusterCapacityWithContext is the same as ModifyCurrentDBClusterCapacity with the addition of the ability to pass a context and additional request options.

See ModifyCurrentDBClusterCapacity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ModifyCustomDBEngineVersion added in v1.41.10

func (c *RDS) ModifyCustomDBEngineVersion(input *ModifyCustomDBEngineVersionInput) (*ModifyCustomDBEngineVersionOutput, error)

ModifyCustomDBEngineVersion API operation for Amazon Relational Database Service.

Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions.

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event.

For more information, see Modifying CEV status (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.modify) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ModifyCustomDBEngineVersion for usage and error information.

Returned Error Codes:

  • ErrCodeCustomDBEngineVersionNotFoundFault "CustomDBEngineVersionNotFoundFault" The specified CEV was not found.

  • ErrCodeInvalidCustomDBEngineVersionStateFault "InvalidCustomDBEngineVersionStateFault" You can't delete the CEV.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyCustomDBEngineVersion

func (*RDS) ModifyCustomDBEngineVersionRequest added in v1.41.10

func (c *RDS) ModifyCustomDBEngineVersionRequest(input *ModifyCustomDBEngineVersionInput) (req *request.Request, output *ModifyCustomDBEngineVersionOutput)

ModifyCustomDBEngineVersionRequest generates a "aws/request.Request" representing the client's request for the ModifyCustomDBEngineVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyCustomDBEngineVersion for more information on using the ModifyCustomDBEngineVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyCustomDBEngineVersionRequest method.
req, resp := client.ModifyCustomDBEngineVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyCustomDBEngineVersion

func (*RDS) ModifyCustomDBEngineVersionWithContext added in v1.41.10

func (c *RDS) ModifyCustomDBEngineVersionWithContext(ctx aws.Context, input *ModifyCustomDBEngineVersionInput, opts ...request.Option) (*ModifyCustomDBEngineVersionOutput, error)

ModifyCustomDBEngineVersionWithContext is the same as ModifyCustomDBEngineVersion with the addition of the ability to pass a context and additional request options.

See ModifyCustomDBEngineVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ModifyDBCluster added in v0.7.1

func (c *RDS) ModifyDBCluster(input *ModifyDBClusterInput) (*ModifyDBClusterOutput, error)

ModifyDBCluster API operation for Amazon Relational Database Service.

Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ModifyDBCluster for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" The request would result in the user exceeding the allowed amount of storage available across all DB instances.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing DB subnet group.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

  • ErrCodeInvalidDBSubnetGroupStateFault "InvalidDBSubnetGroupStateFault" The DB subnet group cannot be deleted because it's in use.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

  • ErrCodeDBClusterParameterGroupNotFoundFault "DBClusterParameterGroupNotFound" DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.

  • ErrCodeInvalidDBSecurityGroupStateFault "InvalidDBSecurityGroupState" The state of the DB security group doesn't allow deletion.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

  • ErrCodeDBClusterAlreadyExistsFault "DBClusterAlreadyExistsFault" The user already has a DB cluster with the given identifier.

  • ErrCodeDomainNotFoundFault "DomainNotFoundFault" Domain doesn't refer to an existing Active Directory domain.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBCluster

Example (Shared00)

To change DB cluster settings This example changes the specified settings for the specified DB cluster.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.ModifyDBClusterInput{
		ApplyImmediately:           aws.Bool(true),
		DBClusterIdentifier:        aws.String("mydbcluster"),
		MasterUserPassword:         aws.String("mynewpassword"),
		NewDBClusterIdentifier:     aws.String("mynewdbcluster"),
		PreferredBackupWindow:      aws.String("04:00-04:30"),
		PreferredMaintenanceWindow: aws.String("Tue:05:00-Tue:05:30"),
	}

	result, err := svc.ModifyDBCluster(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBClusterNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidDBClusterStateFault:
				fmt.Println(rds.ErrCodeInvalidDBClusterStateFault, aerr.Error())
			case rds.ErrCodeStorageQuotaExceededFault:
				fmt.Println(rds.ErrCodeStorageQuotaExceededFault, aerr.Error())
			case rds.ErrCodeDBSubnetGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSubnetGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidVPCNetworkStateFault:
				fmt.Println(rds.ErrCodeInvalidVPCNetworkStateFault, aerr.Error())
			case rds.ErrCodeInvalidDBSubnetGroupStateFault:
				fmt.Println(rds.ErrCodeInvalidDBSubnetGroupStateFault, aerr.Error())
			case rds.ErrCodeInvalidSubnet:
				fmt.Println(rds.ErrCodeInvalidSubnet, aerr.Error())
			case rds.ErrCodeDBClusterParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterParameterGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidDBSecurityGroupStateFault:
				fmt.Println(rds.ErrCodeInvalidDBSecurityGroupStateFault, aerr.Error())
			case rds.ErrCodeInvalidDBInstanceStateFault:
				fmt.Println(rds.ErrCodeInvalidDBInstanceStateFault, aerr.Error())
			case rds.ErrCodeDBClusterAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBClusterAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeDomainNotFoundFault:
				fmt.Println(rds.ErrCodeDomainNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) ModifyDBClusterEndpoint added in v1.15.74

func (c *RDS) ModifyDBClusterEndpoint(input *ModifyDBClusterEndpointInput) (*ModifyDBClusterEndpointOutput, error)

ModifyDBClusterEndpoint API operation for Amazon Relational Database Service.

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ModifyDBClusterEndpoint for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeInvalidDBClusterEndpointStateFault "InvalidDBClusterEndpointStateFault" The requested operation can't be performed on the endpoint while the endpoint is in this state.

  • ErrCodeDBClusterEndpointNotFoundFault "DBClusterEndpointNotFoundFault" The specified custom endpoint doesn't exist.

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBClusterEndpoint

func (*RDS) ModifyDBClusterEndpointRequest added in v1.15.74

func (c *RDS) ModifyDBClusterEndpointRequest(input *ModifyDBClusterEndpointInput) (req *request.Request, output *ModifyDBClusterEndpointOutput)

ModifyDBClusterEndpointRequest generates a "aws/request.Request" representing the client's request for the ModifyDBClusterEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyDBClusterEndpoint for more information on using the ModifyDBClusterEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyDBClusterEndpointRequest method.
req, resp := client.ModifyDBClusterEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBClusterEndpoint

func (*RDS) ModifyDBClusterEndpointWithContext added in v1.15.74

func (c *RDS) ModifyDBClusterEndpointWithContext(ctx aws.Context, input *ModifyDBClusterEndpointInput, opts ...request.Option) (*ModifyDBClusterEndpointOutput, error)

ModifyDBClusterEndpointWithContext is the same as ModifyDBClusterEndpoint with the addition of the ability to pass a context and additional request options.

See ModifyDBClusterEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ModifyDBClusterParameterGroup added in v0.7.1

func (c *RDS) ModifyDBClusterParameterGroup(input *ModifyDBClusterParameterGroupInput) (*DBClusterParameterGroupNameMessage, error)

ModifyDBClusterParameterGroup API operation for Amazon Relational Database Service.

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console (https://console.aws.amazon.com/rds/) or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.

If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ModifyDBClusterParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing DB parameter group.

  • ErrCodeInvalidDBParameterGroupStateFault "InvalidDBParameterGroupState" The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBClusterParameterGroup

Example (Shared00)

To change DB cluster parameter group settings This example immediately changes the specified setting for the specified DB cluster parameter group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.ModifyDBClusterParameterGroupInput{
		DBClusterParameterGroupName: aws.String("mydbclusterparametergroup"),
		Parameters: []*rds.Parameter{
			{
				ApplyMethod:    aws.String("immediate"),
				ParameterName:  aws.String("time_zone"),
				ParameterValue: aws.String("America/Phoenix"),
			},
		},
	}

	result, err := svc.ModifyDBClusterParameterGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBParameterGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidDBParameterGroupStateFault:
				fmt.Println(rds.ErrCodeInvalidDBParameterGroupStateFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) ModifyDBClusterParameterGroupRequest added in v0.7.1

func (c *RDS) ModifyDBClusterParameterGroupRequest(input *ModifyDBClusterParameterGroupInput) (req *request.Request, output *DBClusterParameterGroupNameMessage)

ModifyDBClusterParameterGroupRequest generates a "aws/request.Request" representing the client's request for the ModifyDBClusterParameterGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyDBClusterParameterGroup for more information on using the ModifyDBClusterParameterGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyDBClusterParameterGroupRequest method.
req, resp := client.ModifyDBClusterParameterGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBClusterParameterGroup

func (*RDS) ModifyDBClusterParameterGroupWithContext added in v1.8.0

func (c *RDS) ModifyDBClusterParameterGroupWithContext(ctx aws.Context, input *ModifyDBClusterParameterGroupInput, opts ...request.Option) (*DBClusterParameterGroupNameMessage, error)

ModifyDBClusterParameterGroupWithContext is the same as ModifyDBClusterParameterGroup with the addition of the ability to pass a context and additional request options.

See ModifyDBClusterParameterGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ModifyDBClusterRequest added in v0.7.1

func (c *RDS) ModifyDBClusterRequest(input *ModifyDBClusterInput) (req *request.Request, output *ModifyDBClusterOutput)

ModifyDBClusterRequest generates a "aws/request.Request" representing the client's request for the ModifyDBCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyDBCluster for more information on using the ModifyDBCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyDBClusterRequest method.
req, resp := client.ModifyDBClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBCluster

func (*RDS) ModifyDBClusterSnapshotAttribute added in v1.1.30

func (c *RDS) ModifyDBClusterSnapshotAttribute(input *ModifyDBClusterSnapshotAttributeInput) (*ModifyDBClusterSnapshotAttributeOutput, error)

ModifyDBClusterSnapshotAttribute API operation for Amazon Relational Database Service.

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts.

Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts.

If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ModifyDBClusterSnapshotAttribute for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterSnapshotNotFoundFault "DBClusterSnapshotNotFoundFault" DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

  • ErrCodeInvalidDBClusterSnapshotStateFault "InvalidDBClusterSnapshotStateFault" The supplied value isn't a valid DB cluster snapshot state.

  • ErrCodeSharedSnapshotQuotaExceededFault "SharedSnapshotQuotaExceeded" You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBClusterSnapshotAttribute

Example (Shared00)

To add or remove access to a manual DB cluster snapshot The following example gives two AWS accounts access to a manual DB cluster snapshot and ensures that the DB cluster snapshot is private by removing the value "all".

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.ModifyDBClusterSnapshotAttributeInput{
		AttributeName:               aws.String("restore"),
		DBClusterSnapshotIdentifier: aws.String("manual-cluster-snapshot1"),
		ValuesToAdd: []*string{
			aws.String("123451234512"),
			aws.String("123456789012"),
		},
		ValuesToRemove: []*string{
			aws.String("all"),
		},
	}

	result, err := svc.ModifyDBClusterSnapshotAttribute(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBClusterSnapshotNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterSnapshotNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidDBClusterSnapshotStateFault:
				fmt.Println(rds.ErrCodeInvalidDBClusterSnapshotStateFault, aerr.Error())
			case rds.ErrCodeSharedSnapshotQuotaExceededFault:
				fmt.Println(rds.ErrCodeSharedSnapshotQuotaExceededFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) ModifyDBClusterSnapshotAttributeRequest added in v1.1.30

func (c *RDS) ModifyDBClusterSnapshotAttributeRequest(input *ModifyDBClusterSnapshotAttributeInput) (req *request.Request, output *ModifyDBClusterSnapshotAttributeOutput)

ModifyDBClusterSnapshotAttributeRequest generates a "aws/request.Request" representing the client's request for the ModifyDBClusterSnapshotAttribute operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyDBClusterSnapshotAttribute for more information on using the ModifyDBClusterSnapshotAttribute API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyDBClusterSnapshotAttributeRequest method.
req, resp := client.ModifyDBClusterSnapshotAttributeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBClusterSnapshotAttribute

func (*RDS) ModifyDBClusterSnapshotAttributeWithContext added in v1.8.0

func (c *RDS) ModifyDBClusterSnapshotAttributeWithContext(ctx aws.Context, input *ModifyDBClusterSnapshotAttributeInput, opts ...request.Option) (*ModifyDBClusterSnapshotAttributeOutput, error)

ModifyDBClusterSnapshotAttributeWithContext is the same as ModifyDBClusterSnapshotAttribute with the addition of the ability to pass a context and additional request options.

See ModifyDBClusterSnapshotAttribute for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ModifyDBClusterWithContext added in v1.8.0

func (c *RDS) ModifyDBClusterWithContext(ctx aws.Context, input *ModifyDBClusterInput, opts ...request.Option) (*ModifyDBClusterOutput, error)

ModifyDBClusterWithContext is the same as ModifyDBCluster with the addition of the ability to pass a context and additional request options.

See ModifyDBCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ModifyDBInstance

func (c *RDS) ModifyDBInstance(input *ModifyDBInstanceInput) (*ModifyDBInstanceOutput, error)

ModifyDBInstance API operation for Amazon Relational Database Service.

Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ModifyDBInstance for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

  • ErrCodeInvalidDBSecurityGroupStateFault "InvalidDBSecurityGroupState" The state of the DB security group doesn't allow deletion.

  • ErrCodeDBInstanceAlreadyExistsFault "DBInstanceAlreadyExists" The user already has a DB instance with the given identifier.

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeDBSecurityGroupNotFoundFault "DBSecurityGroupNotFound" DBSecurityGroupName doesn't refer to an existing DB security group.

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing DB parameter group.

  • ErrCodeInsufficientDBInstanceCapacityFault "InsufficientDBInstanceCapacity" The specified DB instance class isn't available in the specified Availability Zone.

  • ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" The request would result in the user exceeding the allowed amount of storage available across all DB instances.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

  • ErrCodeProvisionedIopsNotAvailableInAZFault "ProvisionedIopsNotAvailableInAZFault" Provisioned IOPS not available in the specified Availability Zone.

  • ErrCodeOptionGroupNotFoundFault "OptionGroupNotFoundFault" The specified option group could not be found.

  • ErrCodeDBUpgradeDependencyFailureFault "DBUpgradeDependencyFailure" The DB upgrade failed because a resource the DB depends on can't be modified.

  • ErrCodeStorageTypeNotSupportedFault "StorageTypeNotSupported" Storage of the StorageType specified can't be associated with the DB instance.

  • ErrCodeAuthorizationNotFoundFault "AuthorizationNotFound" The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.

    Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

  • ErrCodeCertificateNotFoundFault "CertificateNotFound" CertificateIdentifier doesn't refer to an existing certificate.

  • ErrCodeDomainNotFoundFault "DomainNotFoundFault" Domain doesn't refer to an existing Active Directory domain.

  • ErrCodeBackupPolicyNotFoundFault "BackupPolicyNotFoundFault"

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred accessing an Amazon Web Services KMS key.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeNetworkTypeNotSupported "NetworkTypeNotSupported" The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBInstance

Example (Shared00)

To change DB instance settings This example immediately changes the specified settings for the specified DB instance.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.ModifyDBInstanceInput{
		AllocatedStorage:           aws.Int64(10),
		ApplyImmediately:           aws.Bool(true),
		BackupRetentionPeriod:      aws.Int64(1),
		DBInstanceClass:            aws.String("db.t2.small"),
		DBInstanceIdentifier:       aws.String("mymysqlinstance"),
		MasterUserPassword:         aws.String("mynewpassword"),
		PreferredBackupWindow:      aws.String("04:00-04:30"),
		PreferredMaintenanceWindow: aws.String("Tue:05:00-Tue:05:30"),
	}

	result, err := svc.ModifyDBInstance(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeInvalidDBInstanceStateFault:
				fmt.Println(rds.ErrCodeInvalidDBInstanceStateFault, aerr.Error())
			case rds.ErrCodeInvalidDBSecurityGroupStateFault:
				fmt.Println(rds.ErrCodeInvalidDBSecurityGroupStateFault, aerr.Error())
			case rds.ErrCodeDBInstanceAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBInstanceAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeDBInstanceNotFoundFault:
				fmt.Println(rds.ErrCodeDBInstanceNotFoundFault, aerr.Error())
			case rds.ErrCodeDBSecurityGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSecurityGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeDBParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBParameterGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeInsufficientDBInstanceCapacityFault:
				fmt.Println(rds.ErrCodeInsufficientDBInstanceCapacityFault, aerr.Error())
			case rds.ErrCodeStorageQuotaExceededFault:
				fmt.Println(rds.ErrCodeStorageQuotaExceededFault, aerr.Error())
			case rds.ErrCodeInvalidVPCNetworkStateFault:
				fmt.Println(rds.ErrCodeInvalidVPCNetworkStateFault, aerr.Error())
			case rds.ErrCodeProvisionedIopsNotAvailableInAZFault:
				fmt.Println(rds.ErrCodeProvisionedIopsNotAvailableInAZFault, aerr.Error())
			case rds.ErrCodeOptionGroupNotFoundFault:
				fmt.Println(rds.ErrCodeOptionGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeDBUpgradeDependencyFailureFault:
				fmt.Println(rds.ErrCodeDBUpgradeDependencyFailureFault, aerr.Error())
			case rds.ErrCodeStorageTypeNotSupportedFault:
				fmt.Println(rds.ErrCodeStorageTypeNotSupportedFault, aerr.Error())
			case rds.ErrCodeAuthorizationNotFoundFault:
				fmt.Println(rds.ErrCodeAuthorizationNotFoundFault, aerr.Error())
			case rds.ErrCodeCertificateNotFoundFault:
				fmt.Println(rds.ErrCodeCertificateNotFoundFault, aerr.Error())
			case rds.ErrCodeDomainNotFoundFault:
				fmt.Println(rds.ErrCodeDomainNotFoundFault, aerr.Error())
			case rds.ErrCodeBackupPolicyNotFoundFault:
				fmt.Println(rds.ErrCodeBackupPolicyNotFoundFault, aerr.Error())
			case rds.ErrCodeKMSKeyNotAccessibleFault:
				fmt.Println(rds.ErrCodeKMSKeyNotAccessibleFault, aerr.Error())
			case rds.ErrCodeInvalidDBClusterStateFault:
				fmt.Println(rds.ErrCodeInvalidDBClusterStateFault, aerr.Error())
			case rds.ErrCodeNetworkTypeNotSupported:
				fmt.Println(rds.ErrCodeNetworkTypeNotSupported, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) ModifyDBInstanceRequest

func (c *RDS) ModifyDBInstanceRequest(input *ModifyDBInstanceInput) (req *request.Request, output *ModifyDBInstanceOutput)

ModifyDBInstanceRequest generates a "aws/request.Request" representing the client's request for the ModifyDBInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyDBInstance for more information on using the ModifyDBInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyDBInstanceRequest method.
req, resp := client.ModifyDBInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBInstance

func (*RDS) ModifyDBInstanceWithContext added in v1.8.0

func (c *RDS) ModifyDBInstanceWithContext(ctx aws.Context, input *ModifyDBInstanceInput, opts ...request.Option) (*ModifyDBInstanceOutput, error)

ModifyDBInstanceWithContext is the same as ModifyDBInstance with the addition of the ability to pass a context and additional request options.

See ModifyDBInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ModifyDBParameterGroup

func (c *RDS) ModifyDBParameterGroup(input *ModifyDBParameterGroupInput) (*DBParameterGroupNameMessage, error)

ModifyDBParameterGroup API operation for Amazon Relational Database Service.

Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console (https://console.aws.amazon.com/rds/) or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ModifyDBParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing DB parameter group.

  • ErrCodeInvalidDBParameterGroupStateFault "InvalidDBParameterGroupState" The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBParameterGroup

Example (Shared00)

To change DB parameter group settings This example immediately changes the specified setting for the specified DB parameter group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.ModifyDBParameterGroupInput{
		DBParameterGroupName: aws.String("mymysqlparametergroup"),
		Parameters: []*rds.Parameter{
			{
				ApplyMethod:    aws.String("immediate"),
				ParameterName:  aws.String("time_zone"),
				ParameterValue: aws.String("America/Phoenix"),
			},
		},
	}

	result, err := svc.ModifyDBParameterGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBParameterGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidDBParameterGroupStateFault:
				fmt.Println(rds.ErrCodeInvalidDBParameterGroupStateFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) ModifyDBParameterGroupRequest

func (c *RDS) ModifyDBParameterGroupRequest(input *ModifyDBParameterGroupInput) (req *request.Request, output *DBParameterGroupNameMessage)

ModifyDBParameterGroupRequest generates a "aws/request.Request" representing the client's request for the ModifyDBParameterGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyDBParameterGroup for more information on using the ModifyDBParameterGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyDBParameterGroupRequest method.
req, resp := client.ModifyDBParameterGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBParameterGroup

func (*RDS) ModifyDBParameterGroupWithContext added in v1.8.0

func (c *RDS) ModifyDBParameterGroupWithContext(ctx aws.Context, input *ModifyDBParameterGroupInput, opts ...request.Option) (*DBParameterGroupNameMessage, error)

ModifyDBParameterGroupWithContext is the same as ModifyDBParameterGroup with the addition of the ability to pass a context and additional request options.

See ModifyDBParameterGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ModifyDBProxy added in v1.25.47

func (c *RDS) ModifyDBProxy(input *ModifyDBProxyInput) (*ModifyDBProxyOutput, error)

ModifyDBProxy API operation for Amazon Relational Database Service.

Changes the settings for an existing DB proxy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ModifyDBProxy for usage and error information.

Returned Error Codes:

  • ErrCodeDBProxyNotFoundFault "DBProxyNotFoundFault" The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeDBProxyAlreadyExistsFault "DBProxyAlreadyExistsFault" The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeInvalidDBProxyStateFault "InvalidDBProxyStateFault" The requested operation can't be performed while the proxy is in this state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBProxy

func (*RDS) ModifyDBProxyEndpoint added in v1.37.27

func (c *RDS) ModifyDBProxyEndpoint(input *ModifyDBProxyEndpointInput) (*ModifyDBProxyEndpointOutput, error)

ModifyDBProxyEndpoint API operation for Amazon Relational Database Service.

Changes the settings for an existing DB proxy endpoint.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ModifyDBProxyEndpoint for usage and error information.

Returned Error Codes:

  • ErrCodeDBProxyEndpointNotFoundFault "DBProxyEndpointNotFoundFault" The DB proxy endpoint doesn't exist.

  • ErrCodeDBProxyEndpointAlreadyExistsFault "DBProxyEndpointAlreadyExistsFault" The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeInvalidDBProxyEndpointStateFault "InvalidDBProxyEndpointStateFault" You can't perform this operation while the DB proxy endpoint is in a particular state.

  • ErrCodeInvalidDBProxyStateFault "InvalidDBProxyStateFault" The requested operation can't be performed while the proxy is in this state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBProxyEndpoint

func (*RDS) ModifyDBProxyEndpointRequest added in v1.37.27

func (c *RDS) ModifyDBProxyEndpointRequest(input *ModifyDBProxyEndpointInput) (req *request.Request, output *ModifyDBProxyEndpointOutput)

ModifyDBProxyEndpointRequest generates a "aws/request.Request" representing the client's request for the ModifyDBProxyEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyDBProxyEndpoint for more information on using the ModifyDBProxyEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyDBProxyEndpointRequest method.
req, resp := client.ModifyDBProxyEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBProxyEndpoint

func (*RDS) ModifyDBProxyEndpointWithContext added in v1.37.27

func (c *RDS) ModifyDBProxyEndpointWithContext(ctx aws.Context, input *ModifyDBProxyEndpointInput, opts ...request.Option) (*ModifyDBProxyEndpointOutput, error)

ModifyDBProxyEndpointWithContext is the same as ModifyDBProxyEndpoint with the addition of the ability to pass a context and additional request options.

See ModifyDBProxyEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ModifyDBProxyRequest added in v1.25.47

func (c *RDS) ModifyDBProxyRequest(input *ModifyDBProxyInput) (req *request.Request, output *ModifyDBProxyOutput)

ModifyDBProxyRequest generates a "aws/request.Request" representing the client's request for the ModifyDBProxy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyDBProxy for more information on using the ModifyDBProxy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyDBProxyRequest method.
req, resp := client.ModifyDBProxyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBProxy

func (*RDS) ModifyDBProxyTargetGroup added in v1.25.47

func (c *RDS) ModifyDBProxyTargetGroup(input *ModifyDBProxyTargetGroupInput) (*ModifyDBProxyTargetGroupOutput, error)

ModifyDBProxyTargetGroup API operation for Amazon Relational Database Service.

Modifies the properties of a DBProxyTargetGroup.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ModifyDBProxyTargetGroup for usage and error information.

Returned Error Codes:

  • ErrCodeDBProxyNotFoundFault "DBProxyNotFoundFault" The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeDBProxyTargetGroupNotFoundFault "DBProxyTargetGroupNotFoundFault" The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeInvalidDBProxyStateFault "InvalidDBProxyStateFault" The requested operation can't be performed while the proxy is in this state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBProxyTargetGroup

func (*RDS) ModifyDBProxyTargetGroupRequest added in v1.25.47

func (c *RDS) ModifyDBProxyTargetGroupRequest(input *ModifyDBProxyTargetGroupInput) (req *request.Request, output *ModifyDBProxyTargetGroupOutput)

ModifyDBProxyTargetGroupRequest generates a "aws/request.Request" representing the client's request for the ModifyDBProxyTargetGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyDBProxyTargetGroup for more information on using the ModifyDBProxyTargetGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyDBProxyTargetGroupRequest method.
req, resp := client.ModifyDBProxyTargetGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBProxyTargetGroup

func (*RDS) ModifyDBProxyTargetGroupWithContext added in v1.25.47

func (c *RDS) ModifyDBProxyTargetGroupWithContext(ctx aws.Context, input *ModifyDBProxyTargetGroupInput, opts ...request.Option) (*ModifyDBProxyTargetGroupOutput, error)

ModifyDBProxyTargetGroupWithContext is the same as ModifyDBProxyTargetGroup with the addition of the ability to pass a context and additional request options.

See ModifyDBProxyTargetGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ModifyDBProxyWithContext added in v1.25.47

func (c *RDS) ModifyDBProxyWithContext(ctx aws.Context, input *ModifyDBProxyInput, opts ...request.Option) (*ModifyDBProxyOutput, error)

ModifyDBProxyWithContext is the same as ModifyDBProxy with the addition of the ability to pass a context and additional request options.

See ModifyDBProxy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ModifyDBSnapshot added in v1.6.18

func (c *RDS) ModifyDBSnapshot(input *ModifyDBSnapshotInput) (*ModifyDBSnapshotOutput, error)

ModifyDBSnapshot API operation for Amazon Relational Database Service.

Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.

Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command doesn't apply to RDS Custom.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ModifyDBSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound" DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBSnapshot

func (*RDS) ModifyDBSnapshotAttribute added in v0.10.4

func (c *RDS) ModifyDBSnapshotAttribute(input *ModifyDBSnapshotAttributeInput) (*ModifyDBSnapshotAttributeOutput, error)

ModifyDBSnapshotAttribute API operation for Amazon Relational Database Service.

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

To share a manual DB snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts.

Don't add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts.

If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ModifyDBSnapshotAttribute for usage and error information.

Returned Error Codes:

  • ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound" DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

  • ErrCodeInvalidDBSnapshotStateFault "InvalidDBSnapshotState" The state of the DB snapshot doesn't allow deletion.

  • ErrCodeSharedSnapshotQuotaExceededFault "SharedSnapshotQuotaExceeded" You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBSnapshotAttribute

Example (Shared00)

To change DB snapshot attributes This example adds the specified attribute for the specified DB snapshot.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.ModifyDBSnapshotAttributeInput{
		AttributeName:        aws.String("restore"),
		DBSnapshotIdentifier: aws.String("mydbsnapshot"),
		ValuesToAdd: []*string{
			aws.String("all"),
		},
	}

	result, err := svc.ModifyDBSnapshotAttribute(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBSnapshotNotFoundFault:
				fmt.Println(rds.ErrCodeDBSnapshotNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidDBSnapshotStateFault:
				fmt.Println(rds.ErrCodeInvalidDBSnapshotStateFault, aerr.Error())
			case rds.ErrCodeSharedSnapshotQuotaExceededFault:
				fmt.Println(rds.ErrCodeSharedSnapshotQuotaExceededFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) ModifyDBSnapshotAttributeRequest added in v0.10.4

func (c *RDS) ModifyDBSnapshotAttributeRequest(input *ModifyDBSnapshotAttributeInput) (req *request.Request, output *ModifyDBSnapshotAttributeOutput)

ModifyDBSnapshotAttributeRequest generates a "aws/request.Request" representing the client's request for the ModifyDBSnapshotAttribute operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyDBSnapshotAttribute for more information on using the ModifyDBSnapshotAttribute API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyDBSnapshotAttributeRequest method.
req, resp := client.ModifyDBSnapshotAttributeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBSnapshotAttribute

func (*RDS) ModifyDBSnapshotAttributeWithContext added in v1.8.0

func (c *RDS) ModifyDBSnapshotAttributeWithContext(ctx aws.Context, input *ModifyDBSnapshotAttributeInput, opts ...request.Option) (*ModifyDBSnapshotAttributeOutput, error)

ModifyDBSnapshotAttributeWithContext is the same as ModifyDBSnapshotAttribute with the addition of the ability to pass a context and additional request options.

See ModifyDBSnapshotAttribute for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ModifyDBSnapshotRequest added in v1.6.18

func (c *RDS) ModifyDBSnapshotRequest(input *ModifyDBSnapshotInput) (req *request.Request, output *ModifyDBSnapshotOutput)

ModifyDBSnapshotRequest generates a "aws/request.Request" representing the client's request for the ModifyDBSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyDBSnapshot for more information on using the ModifyDBSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyDBSnapshotRequest method.
req, resp := client.ModifyDBSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBSnapshot

func (*RDS) ModifyDBSnapshotWithContext added in v1.8.0

func (c *RDS) ModifyDBSnapshotWithContext(ctx aws.Context, input *ModifyDBSnapshotInput, opts ...request.Option) (*ModifyDBSnapshotOutput, error)

ModifyDBSnapshotWithContext is the same as ModifyDBSnapshot with the addition of the ability to pass a context and additional request options.

See ModifyDBSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ModifyDBSubnetGroup

func (c *RDS) ModifyDBSubnetGroup(input *ModifyDBSubnetGroupInput) (*ModifyDBSubnetGroupOutput, error)

ModifyDBSubnetGroup API operation for Amazon Relational Database Service.

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ModifyDBSubnetGroup for usage and error information.

Returned Error Codes:

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing DB subnet group.

  • ErrCodeDBSubnetQuotaExceededFault "DBSubnetQuotaExceededFault" The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.

  • ErrCodeSubnetAlreadyInUse "SubnetAlreadyInUse" The DB subnet is already in use in the Availability Zone.

  • ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs "DBSubnetGroupDoesNotCoverEnoughAZs" Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBSubnetGroup

Example (Shared00)

To change DB subnet group settings This example changes the specified setting for the specified DB subnet group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.ModifyDBSubnetGroupInput{
		DBSubnetGroupName: aws.String("mydbsubnetgroup"),
		SubnetIds: []*string{
			aws.String("subnet-70e1975a"),
			aws.String("subnet-747a5c49"),
		},
	}

	result, err := svc.ModifyDBSubnetGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBSubnetGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSubnetGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeDBSubnetQuotaExceededFault:
				fmt.Println(rds.ErrCodeDBSubnetQuotaExceededFault, aerr.Error())
			case rds.ErrCodeSubnetAlreadyInUse:
				fmt.Println(rds.ErrCodeSubnetAlreadyInUse, aerr.Error())
			case rds.ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs:
				fmt.Println(rds.ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs, aerr.Error())
			case rds.ErrCodeInvalidSubnet:
				fmt.Println(rds.ErrCodeInvalidSubnet, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) ModifyDBSubnetGroupRequest

func (c *RDS) ModifyDBSubnetGroupRequest(input *ModifyDBSubnetGroupInput) (req *request.Request, output *ModifyDBSubnetGroupOutput)

ModifyDBSubnetGroupRequest generates a "aws/request.Request" representing the client's request for the ModifyDBSubnetGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyDBSubnetGroup for more information on using the ModifyDBSubnetGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyDBSubnetGroupRequest method.
req, resp := client.ModifyDBSubnetGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBSubnetGroup

func (*RDS) ModifyDBSubnetGroupWithContext added in v1.8.0

func (c *RDS) ModifyDBSubnetGroupWithContext(ctx aws.Context, input *ModifyDBSubnetGroupInput, opts ...request.Option) (*ModifyDBSubnetGroupOutput, error)

ModifyDBSubnetGroupWithContext is the same as ModifyDBSubnetGroup with the addition of the ability to pass a context and additional request options.

See ModifyDBSubnetGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ModifyEventSubscription

func (c *RDS) ModifyEventSubscription(input *ModifyEventSubscriptionInput) (*ModifyEventSubscriptionOutput, error)

ModifyEventSubscription API operation for Amazon Relational Database Service.

Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given source type (SourceType) in Events (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ModifyEventSubscription for usage and error information.

Returned Error Codes:

  • ErrCodeEventSubscriptionQuotaExceededFault "EventSubscriptionQuotaExceeded" You have reached the maximum number of event subscriptions.

  • ErrCodeSubscriptionNotFoundFault "SubscriptionNotFound" The subscription name does not exist.

  • ErrCodeSNSInvalidTopicFault "SNSInvalidTopic" SNS has responded that there is a problem with the SNS topic specified.

  • ErrCodeSNSNoAuthorizationFault "SNSNoAuthorization" You do not have permission to publish to the SNS topic ARN.

  • ErrCodeSNSTopicArnNotFoundFault "SNSTopicArnNotFound" The SNS topic ARN does not exist.

  • ErrCodeSubscriptionCategoryNotFoundFault "SubscriptionCategoryNotFound" The supplied category does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyEventSubscription

Example (Shared00)

To change event notification subscription settings This example changes the specified setting for the specified event notification subscription.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.ModifyEventSubscriptionInput{
		Enabled: aws.Bool(true),
		EventCategories: []*string{
			aws.String("deletion"),
			aws.String("low storage"),
		},
		SourceType:       aws.String("db-instance"),
		SubscriptionName: aws.String("mymysqleventsubscription"),
	}

	result, err := svc.ModifyEventSubscription(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeEventSubscriptionQuotaExceededFault:
				fmt.Println(rds.ErrCodeEventSubscriptionQuotaExceededFault, aerr.Error())
			case rds.ErrCodeSubscriptionNotFoundFault:
				fmt.Println(rds.ErrCodeSubscriptionNotFoundFault, aerr.Error())
			case rds.ErrCodeSNSInvalidTopicFault:
				fmt.Println(rds.ErrCodeSNSInvalidTopicFault, aerr.Error())
			case rds.ErrCodeSNSNoAuthorizationFault:
				fmt.Println(rds.ErrCodeSNSNoAuthorizationFault, aerr.Error())
			case rds.ErrCodeSNSTopicArnNotFoundFault:
				fmt.Println(rds.ErrCodeSNSTopicArnNotFoundFault, aerr.Error())
			case rds.ErrCodeSubscriptionCategoryNotFoundFault:
				fmt.Println(rds.ErrCodeSubscriptionCategoryNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) ModifyEventSubscriptionRequest

func (c *RDS) ModifyEventSubscriptionRequest(input *ModifyEventSubscriptionInput) (req *request.Request, output *ModifyEventSubscriptionOutput)

ModifyEventSubscriptionRequest generates a "aws/request.Request" representing the client's request for the ModifyEventSubscription operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyEventSubscription for more information on using the ModifyEventSubscription API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyEventSubscriptionRequest method.
req, resp := client.ModifyEventSubscriptionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyEventSubscription

func (*RDS) ModifyEventSubscriptionWithContext added in v1.8.0

func (c *RDS) ModifyEventSubscriptionWithContext(ctx aws.Context, input *ModifyEventSubscriptionInput, opts ...request.Option) (*ModifyEventSubscriptionOutput, error)

ModifyEventSubscriptionWithContext is the same as ModifyEventSubscription with the addition of the ability to pass a context and additional request options.

See ModifyEventSubscription for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ModifyGlobalCluster added in v1.15.85

func (c *RDS) ModifyGlobalCluster(input *ModifyGlobalClusterInput) (*ModifyGlobalClusterOutput, error)

ModifyGlobalCluster API operation for Amazon Relational Database Service.

Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ModifyGlobalCluster for usage and error information.

Returned Error Codes:

  • ErrCodeGlobalClusterNotFoundFault "GlobalClusterNotFoundFault" The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

  • ErrCodeInvalidGlobalClusterStateFault "InvalidGlobalClusterStateFault" The global cluster is in an invalid state and can't perform the requested operation.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyGlobalCluster

func (*RDS) ModifyGlobalClusterRequest added in v1.15.85

func (c *RDS) ModifyGlobalClusterRequest(input *ModifyGlobalClusterInput) (req *request.Request, output *ModifyGlobalClusterOutput)

ModifyGlobalClusterRequest generates a "aws/request.Request" representing the client's request for the ModifyGlobalCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyGlobalCluster for more information on using the ModifyGlobalCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyGlobalClusterRequest method.
req, resp := client.ModifyGlobalClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyGlobalCluster

func (*RDS) ModifyGlobalClusterWithContext added in v1.15.85

func (c *RDS) ModifyGlobalClusterWithContext(ctx aws.Context, input *ModifyGlobalClusterInput, opts ...request.Option) (*ModifyGlobalClusterOutput, error)

ModifyGlobalClusterWithContext is the same as ModifyGlobalCluster with the addition of the ability to pass a context and additional request options.

See ModifyGlobalCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ModifyOptionGroup

func (c *RDS) ModifyOptionGroup(input *ModifyOptionGroupInput) (*ModifyOptionGroupOutput, error)

ModifyOptionGroup API operation for Amazon Relational Database Service.

Modifies an existing option group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ModifyOptionGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidOptionGroupStateFault "InvalidOptionGroupStateFault" The option group isn't in the available state.

  • ErrCodeOptionGroupNotFoundFault "OptionGroupNotFoundFault" The specified option group could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyOptionGroup

Example (Shared00)

To modify an option group The following example adds an option to an option group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.ModifyOptionGroupInput{
		ApplyImmediately: aws.Bool(true),
		OptionGroupName:  aws.String("myawsuser-og02"),
		OptionsToInclude: []*rds.OptionConfiguration{
			{
				DBSecurityGroupMemberships: []*string{
					aws.String("default"),
				},
				OptionName: aws.String("MEMCACHED"),
			},
		},
	}

	result, err := svc.ModifyOptionGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeInvalidOptionGroupStateFault:
				fmt.Println(rds.ErrCodeInvalidOptionGroupStateFault, aerr.Error())
			case rds.ErrCodeOptionGroupNotFoundFault:
				fmt.Println(rds.ErrCodeOptionGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) ModifyOptionGroupRequest

func (c *RDS) ModifyOptionGroupRequest(input *ModifyOptionGroupInput) (req *request.Request, output *ModifyOptionGroupOutput)

ModifyOptionGroupRequest generates a "aws/request.Request" representing the client's request for the ModifyOptionGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyOptionGroup for more information on using the ModifyOptionGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyOptionGroupRequest method.
req, resp := client.ModifyOptionGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyOptionGroup

func (*RDS) ModifyOptionGroupWithContext added in v1.8.0

func (c *RDS) ModifyOptionGroupWithContext(ctx aws.Context, input *ModifyOptionGroupInput, opts ...request.Option) (*ModifyOptionGroupOutput, error)

ModifyOptionGroupWithContext is the same as ModifyOptionGroup with the addition of the ability to pass a context and additional request options.

See ModifyOptionGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) PromoteReadReplica

func (c *RDS) PromoteReadReplica(input *PromoteReadReplicaInput) (*PromoteReadReplicaOutput, error)

PromoteReadReplica API operation for Amazon Relational Database Service.

Promotes a read replica DB instance to a standalone DB instance.

  • Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion.

  • This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation PromoteReadReplica for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PromoteReadReplica

Example (Shared00)

To promote a read replica This example promotes the specified read replica and sets its backup retention period and preferred backup window.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.PromoteReadReplicaInput{
		BackupRetentionPeriod: aws.Int64(1),
		DBInstanceIdentifier:  aws.String("mydbreadreplica"),
		PreferredBackupWindow: aws.String("03:30-04:00"),
	}

	result, err := svc.PromoteReadReplica(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeInvalidDBInstanceStateFault:
				fmt.Println(rds.ErrCodeInvalidDBInstanceStateFault, aerr.Error())
			case rds.ErrCodeDBInstanceNotFoundFault:
				fmt.Println(rds.ErrCodeDBInstanceNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) PromoteReadReplicaDBCluster added in v1.1.35

func (c *RDS) PromoteReadReplicaDBCluster(input *PromoteReadReplicaDBClusterInput) (*PromoteReadReplicaDBClusterOutput, error)

PromoteReadReplicaDBCluster API operation for Amazon Relational Database Service.

Promotes a read replica DB cluster to a standalone DB cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation PromoteReadReplicaDBCluster for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PromoteReadReplicaDBCluster

func (*RDS) PromoteReadReplicaDBClusterRequest added in v1.1.35

func (c *RDS) PromoteReadReplicaDBClusterRequest(input *PromoteReadReplicaDBClusterInput) (req *request.Request, output *PromoteReadReplicaDBClusterOutput)

PromoteReadReplicaDBClusterRequest generates a "aws/request.Request" representing the client's request for the PromoteReadReplicaDBCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PromoteReadReplicaDBCluster for more information on using the PromoteReadReplicaDBCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PromoteReadReplicaDBClusterRequest method.
req, resp := client.PromoteReadReplicaDBClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PromoteReadReplicaDBCluster

func (*RDS) PromoteReadReplicaDBClusterWithContext added in v1.8.0

func (c *RDS) PromoteReadReplicaDBClusterWithContext(ctx aws.Context, input *PromoteReadReplicaDBClusterInput, opts ...request.Option) (*PromoteReadReplicaDBClusterOutput, error)

PromoteReadReplicaDBClusterWithContext is the same as PromoteReadReplicaDBCluster with the addition of the ability to pass a context and additional request options.

See PromoteReadReplicaDBCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) PromoteReadReplicaRequest

func (c *RDS) PromoteReadReplicaRequest(input *PromoteReadReplicaInput) (req *request.Request, output *PromoteReadReplicaOutput)

PromoteReadReplicaRequest generates a "aws/request.Request" representing the client's request for the PromoteReadReplica operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PromoteReadReplica for more information on using the PromoteReadReplica API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PromoteReadReplicaRequest method.
req, resp := client.PromoteReadReplicaRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PromoteReadReplica

func (*RDS) PromoteReadReplicaWithContext added in v1.8.0

func (c *RDS) PromoteReadReplicaWithContext(ctx aws.Context, input *PromoteReadReplicaInput, opts ...request.Option) (*PromoteReadReplicaOutput, error)

PromoteReadReplicaWithContext is the same as PromoteReadReplica with the addition of the ability to pass a context and additional request options.

See PromoteReadReplica for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) PurchaseReservedDBInstancesOffering

func (c *RDS) PurchaseReservedDBInstancesOffering(input *PurchaseReservedDBInstancesOfferingInput) (*PurchaseReservedDBInstancesOfferingOutput, error)

PurchaseReservedDBInstancesOffering API operation for Amazon Relational Database Service.

Purchases a reserved DB instance offering.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation PurchaseReservedDBInstancesOffering for usage and error information.

Returned Error Codes:

  • ErrCodeReservedDBInstancesOfferingNotFoundFault "ReservedDBInstancesOfferingNotFound" Specified offering does not exist.

  • ErrCodeReservedDBInstanceAlreadyExistsFault "ReservedDBInstanceAlreadyExists" User already has a reservation with the given identifier.

  • ErrCodeReservedDBInstanceQuotaExceededFault "ReservedDBInstanceQuotaExceeded" Request would exceed the user's DB Instance quota.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PurchaseReservedDBInstancesOffering

Example (Shared00)

To purchase a reserved DB instance offering This example purchases a reserved DB instance offering that matches the specified settings.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.PurchaseReservedDBInstancesOfferingInput{
		ReservedDBInstanceId:          aws.String("myreservationid"),
		ReservedDBInstancesOfferingId: aws.String("fb29428a-646d-4390-850e-5fe89926e727"),
	}

	result, err := svc.PurchaseReservedDBInstancesOffering(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeReservedDBInstancesOfferingNotFoundFault:
				fmt.Println(rds.ErrCodeReservedDBInstancesOfferingNotFoundFault, aerr.Error())
			case rds.ErrCodeReservedDBInstanceAlreadyExistsFault:
				fmt.Println(rds.ErrCodeReservedDBInstanceAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeReservedDBInstanceQuotaExceededFault:
				fmt.Println(rds.ErrCodeReservedDBInstanceQuotaExceededFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) PurchaseReservedDBInstancesOfferingRequest

func (c *RDS) PurchaseReservedDBInstancesOfferingRequest(input *PurchaseReservedDBInstancesOfferingInput) (req *request.Request, output *PurchaseReservedDBInstancesOfferingOutput)

PurchaseReservedDBInstancesOfferingRequest generates a "aws/request.Request" representing the client's request for the PurchaseReservedDBInstancesOffering operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PurchaseReservedDBInstancesOffering for more information on using the PurchaseReservedDBInstancesOffering API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PurchaseReservedDBInstancesOfferingRequest method.
req, resp := client.PurchaseReservedDBInstancesOfferingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PurchaseReservedDBInstancesOffering

func (*RDS) PurchaseReservedDBInstancesOfferingWithContext added in v1.8.0

func (c *RDS) PurchaseReservedDBInstancesOfferingWithContext(ctx aws.Context, input *PurchaseReservedDBInstancesOfferingInput, opts ...request.Option) (*PurchaseReservedDBInstancesOfferingOutput, error)

PurchaseReservedDBInstancesOfferingWithContext is the same as PurchaseReservedDBInstancesOffering with the addition of the ability to pass a context and additional request options.

See PurchaseReservedDBInstancesOffering for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) RebootDBCluster added in v1.42.11

func (c *RDS) RebootDBCluster(input *RebootDBClusterInput) (*RebootDBClusterOutput, error)

RebootDBCluster API operation for Amazon Relational Database Service.

You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.

Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.

Use this operation only for a non-Aurora Multi-AZ DB cluster.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation RebootDBCluster for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBCluster

func (*RDS) RebootDBClusterRequest added in v1.42.11

func (c *RDS) RebootDBClusterRequest(input *RebootDBClusterInput) (req *request.Request, output *RebootDBClusterOutput)

RebootDBClusterRequest generates a "aws/request.Request" representing the client's request for the RebootDBCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RebootDBCluster for more information on using the RebootDBCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RebootDBClusterRequest method.
req, resp := client.RebootDBClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBCluster

func (*RDS) RebootDBClusterWithContext added in v1.42.11

func (c *RDS) RebootDBClusterWithContext(ctx aws.Context, input *RebootDBClusterInput, opts ...request.Option) (*RebootDBClusterOutput, error)

RebootDBClusterWithContext is the same as RebootDBCluster with the addition of the ability to pass a context and additional request options.

See RebootDBCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) RebootDBInstance

func (c *RDS) RebootDBInstance(input *RebootDBInstanceInput) (*RebootDBInstanceOutput, error)

RebootDBInstance API operation for Amazon Relational Database Service.

You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

For more information about rebooting, see Rebooting a DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_RebootInstance.html) in the Amazon RDS User Guide.

This command doesn't apply to RDS Custom.

If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation RebootDBInstance for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBInstance

Example (Shared00)

To reboot a DB instance This example reboots the specified DB instance without forcing a failover.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.RebootDBInstanceInput{
		DBInstanceIdentifier: aws.String("mymysqlinstance"),
		ForceFailover:        aws.Bool(false),
	}

	result, err := svc.RebootDBInstance(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeInvalidDBInstanceStateFault:
				fmt.Println(rds.ErrCodeInvalidDBInstanceStateFault, aerr.Error())
			case rds.ErrCodeDBInstanceNotFoundFault:
				fmt.Println(rds.ErrCodeDBInstanceNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) RebootDBInstanceRequest

func (c *RDS) RebootDBInstanceRequest(input *RebootDBInstanceInput) (req *request.Request, output *RebootDBInstanceOutput)

RebootDBInstanceRequest generates a "aws/request.Request" representing the client's request for the RebootDBInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RebootDBInstance for more information on using the RebootDBInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RebootDBInstanceRequest method.
req, resp := client.RebootDBInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBInstance

func (*RDS) RebootDBInstanceWithContext added in v1.8.0

func (c *RDS) RebootDBInstanceWithContext(ctx aws.Context, input *RebootDBInstanceInput, opts ...request.Option) (*RebootDBInstanceOutput, error)

RebootDBInstanceWithContext is the same as RebootDBInstance with the addition of the ability to pass a context and additional request options.

See RebootDBInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) RegisterDBProxyTargets added in v1.25.47

func (c *RDS) RegisterDBProxyTargets(input *RegisterDBProxyTargetsInput) (*RegisterDBProxyTargetsOutput, error)

RegisterDBProxyTargets API operation for Amazon Relational Database Service.

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation RegisterDBProxyTargets for usage and error information.

Returned Error Codes:

  • ErrCodeDBProxyNotFoundFault "DBProxyNotFoundFault" The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeDBProxyTargetGroupNotFoundFault "DBProxyTargetGroupNotFoundFault" The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeDBProxyTargetAlreadyRegisteredFault "DBProxyTargetAlreadyRegisteredFault" The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeInvalidDBProxyStateFault "InvalidDBProxyStateFault" The requested operation can't be performed while the proxy is in this state.

  • ErrCodeInsufficientAvailableIPsInSubnetFault "InsufficientAvailableIPsInSubnetFault" The requested operation can't be performed because there aren't enough available IP addresses in the proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required from the subnets.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RegisterDBProxyTargets

func (*RDS) RegisterDBProxyTargetsRequest added in v1.25.47

func (c *RDS) RegisterDBProxyTargetsRequest(input *RegisterDBProxyTargetsInput) (req *request.Request, output *RegisterDBProxyTargetsOutput)

RegisterDBProxyTargetsRequest generates a "aws/request.Request" representing the client's request for the RegisterDBProxyTargets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterDBProxyTargets for more information on using the RegisterDBProxyTargets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RegisterDBProxyTargetsRequest method.
req, resp := client.RegisterDBProxyTargetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RegisterDBProxyTargets

func (*RDS) RegisterDBProxyTargetsWithContext added in v1.25.47

func (c *RDS) RegisterDBProxyTargetsWithContext(ctx aws.Context, input *RegisterDBProxyTargetsInput, opts ...request.Option) (*RegisterDBProxyTargetsOutput, error)

RegisterDBProxyTargetsWithContext is the same as RegisterDBProxyTargets with the addition of the ability to pass a context and additional request options.

See RegisterDBProxyTargets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) RemoveFromGlobalCluster added in v1.15.85

func (c *RDS) RemoveFromGlobalCluster(input *RemoveFromGlobalClusterInput) (*RemoveFromGlobalClusterOutput, error)

RemoveFromGlobalCluster API operation for Amazon Relational Database Service.

Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region.

This action only applies to Aurora DB clusters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation RemoveFromGlobalCluster for usage and error information.

Returned Error Codes:

  • ErrCodeGlobalClusterNotFoundFault "GlobalClusterNotFoundFault" The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

  • ErrCodeInvalidGlobalClusterStateFault "InvalidGlobalClusterStateFault" The global cluster is in an invalid state and can't perform the requested operation.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RemoveFromGlobalCluster

func (*RDS) RemoveFromGlobalClusterRequest added in v1.15.85

func (c *RDS) RemoveFromGlobalClusterRequest(input *RemoveFromGlobalClusterInput) (req *request.Request, output *RemoveFromGlobalClusterOutput)

RemoveFromGlobalClusterRequest generates a "aws/request.Request" representing the client's request for the RemoveFromGlobalCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveFromGlobalCluster for more information on using the RemoveFromGlobalCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RemoveFromGlobalClusterRequest method.
req, resp := client.RemoveFromGlobalClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RemoveFromGlobalCluster

func (*RDS) RemoveFromGlobalClusterWithContext added in v1.15.85

func (c *RDS) RemoveFromGlobalClusterWithContext(ctx aws.Context, input *RemoveFromGlobalClusterInput, opts ...request.Option) (*RemoveFromGlobalClusterOutput, error)

RemoveFromGlobalClusterWithContext is the same as RemoveFromGlobalCluster with the addition of the ability to pass a context and additional request options.

See RemoveFromGlobalCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) RemoveRoleFromDBCluster added in v1.4.19

func (c *RDS) RemoveRoleFromDBCluster(input *RemoveRoleFromDBClusterInput) (*RemoveRoleFromDBClusterOutput, error)

RemoveRoleFromDBCluster API operation for Amazon Relational Database Service.

Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation RemoveRoleFromDBCluster for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeDBClusterRoleNotFoundFault "DBClusterRoleNotFound" The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RemoveRoleFromDBCluster

func (*RDS) RemoveRoleFromDBClusterRequest added in v1.4.19

func (c *RDS) RemoveRoleFromDBClusterRequest(input *RemoveRoleFromDBClusterInput) (req *request.Request, output *RemoveRoleFromDBClusterOutput)

RemoveRoleFromDBClusterRequest generates a "aws/request.Request" representing the client's request for the RemoveRoleFromDBCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveRoleFromDBCluster for more information on using the RemoveRoleFromDBCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RemoveRoleFromDBClusterRequest method.
req, resp := client.RemoveRoleFromDBClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RemoveRoleFromDBCluster

func (*RDS) RemoveRoleFromDBClusterWithContext added in v1.8.0

func (c *RDS) RemoveRoleFromDBClusterWithContext(ctx aws.Context, input *RemoveRoleFromDBClusterInput, opts ...request.Option) (*RemoveRoleFromDBClusterOutput, error)

RemoveRoleFromDBClusterWithContext is the same as RemoveRoleFromDBCluster with the addition of the ability to pass a context and additional request options.

See RemoveRoleFromDBCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) RemoveRoleFromDBInstance added in v1.16.25

func (c *RDS) RemoveRoleFromDBInstance(input *RemoveRoleFromDBInstanceInput) (*RemoveRoleFromDBInstanceOutput, error)

RemoveRoleFromDBInstance API operation for Amazon Relational Database Service.

Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation RemoveRoleFromDBInstance for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeDBInstanceRoleNotFoundFault "DBInstanceRoleNotFound" The specified RoleArn value doesn't match the specified feature for the DB instance.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RemoveRoleFromDBInstance

func (*RDS) RemoveRoleFromDBInstanceRequest added in v1.16.25

func (c *RDS) RemoveRoleFromDBInstanceRequest(input *RemoveRoleFromDBInstanceInput) (req *request.Request, output *RemoveRoleFromDBInstanceOutput)

RemoveRoleFromDBInstanceRequest generates a "aws/request.Request" representing the client's request for the RemoveRoleFromDBInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveRoleFromDBInstance for more information on using the RemoveRoleFromDBInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RemoveRoleFromDBInstanceRequest method.
req, resp := client.RemoveRoleFromDBInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RemoveRoleFromDBInstance

func (*RDS) RemoveRoleFromDBInstanceWithContext added in v1.16.25

func (c *RDS) RemoveRoleFromDBInstanceWithContext(ctx aws.Context, input *RemoveRoleFromDBInstanceInput, opts ...request.Option) (*RemoveRoleFromDBInstanceOutput, error)

RemoveRoleFromDBInstanceWithContext is the same as RemoveRoleFromDBInstance with the addition of the ability to pass a context and additional request options.

See RemoveRoleFromDBInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) RemoveSourceIdentifierFromSubscription

func (c *RDS) RemoveSourceIdentifierFromSubscription(input *RemoveSourceIdentifierFromSubscriptionInput) (*RemoveSourceIdentifierFromSubscriptionOutput, error)

RemoveSourceIdentifierFromSubscription API operation for Amazon Relational Database Service.

Removes a source identifier from an existing RDS event notification subscription.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation RemoveSourceIdentifierFromSubscription for usage and error information.

Returned Error Codes:

  • ErrCodeSubscriptionNotFoundFault "SubscriptionNotFound" The subscription name does not exist.

  • ErrCodeSourceNotFoundFault "SourceNotFound" The requested source could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RemoveSourceIdentifierFromSubscription

Example (Shared00)

To remove a source identifier from a DB event subscription This example removes the specified source identifier from the specified DB event subscription.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.RemoveSourceIdentifierFromSubscriptionInput{
		SourceIdentifier: aws.String("mymysqlinstance"),
		SubscriptionName: aws.String("myeventsubscription"),
	}

	result, err := svc.RemoveSourceIdentifierFromSubscription(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeSubscriptionNotFoundFault:
				fmt.Println(rds.ErrCodeSubscriptionNotFoundFault, aerr.Error())
			case rds.ErrCodeSourceNotFoundFault:
				fmt.Println(rds.ErrCodeSourceNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) RemoveSourceIdentifierFromSubscriptionRequest

func (c *RDS) RemoveSourceIdentifierFromSubscriptionRequest(input *RemoveSourceIdentifierFromSubscriptionInput) (req *request.Request, output *RemoveSourceIdentifierFromSubscriptionOutput)

RemoveSourceIdentifierFromSubscriptionRequest generates a "aws/request.Request" representing the client's request for the RemoveSourceIdentifierFromSubscription operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveSourceIdentifierFromSubscription for more information on using the RemoveSourceIdentifierFromSubscription API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RemoveSourceIdentifierFromSubscriptionRequest method.
req, resp := client.RemoveSourceIdentifierFromSubscriptionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RemoveSourceIdentifierFromSubscription

func (*RDS) RemoveSourceIdentifierFromSubscriptionWithContext added in v1.8.0

func (c *RDS) RemoveSourceIdentifierFromSubscriptionWithContext(ctx aws.Context, input *RemoveSourceIdentifierFromSubscriptionInput, opts ...request.Option) (*RemoveSourceIdentifierFromSubscriptionOutput, error)

RemoveSourceIdentifierFromSubscriptionWithContext is the same as RemoveSourceIdentifierFromSubscription with the addition of the ability to pass a context and additional request options.

See RemoveSourceIdentifierFromSubscription for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) RemoveTagsFromResource

func (c *RDS) RemoveTagsFromResource(input *RemoveTagsFromResourceInput) (*RemoveTagsFromResourceOutput, error)

RemoveTagsFromResource API operation for Amazon Relational Database Service.

Removes metadata tags from an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation RemoveTagsFromResource for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound" DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeDBProxyNotFoundFault "DBProxyNotFoundFault" The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • ErrCodeDBProxyTargetGroupNotFoundFault "DBProxyTargetGroupNotFoundFault" The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RemoveTagsFromResource

Example (Shared00)

To remove tags from a resource This example removes the specified tag associated with the specified DB option group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.RemoveTagsFromResourceInput{
		ResourceName: aws.String("arn:aws:rds:us-east-1:992648334831:og:mydboptiongroup"),
		TagKeys: []*string{
			aws.String("MyKey"),
		},
	}

	result, err := svc.RemoveTagsFromResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBInstanceNotFoundFault:
				fmt.Println(rds.ErrCodeDBInstanceNotFoundFault, aerr.Error())
			case rds.ErrCodeDBSnapshotNotFoundFault:
				fmt.Println(rds.ErrCodeDBSnapshotNotFoundFault, aerr.Error())
			case rds.ErrCodeDBClusterNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterNotFoundFault, aerr.Error())
			case rds.ErrCodeDBProxyNotFoundFault:
				fmt.Println(rds.ErrCodeDBProxyNotFoundFault, aerr.Error())
			case rds.ErrCodeDBProxyTargetGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBProxyTargetGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) RemoveTagsFromResourceRequest

func (c *RDS) RemoveTagsFromResourceRequest(input *RemoveTagsFromResourceInput) (req *request.Request, output *RemoveTagsFromResourceOutput)

RemoveTagsFromResourceRequest generates a "aws/request.Request" representing the client's request for the RemoveTagsFromResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveTagsFromResource for more information on using the RemoveTagsFromResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RemoveTagsFromResourceRequest method.
req, resp := client.RemoveTagsFromResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RemoveTagsFromResource

func (*RDS) RemoveTagsFromResourceWithContext added in v1.8.0

func (c *RDS) RemoveTagsFromResourceWithContext(ctx aws.Context, input *RemoveTagsFromResourceInput, opts ...request.Option) (*RemoveTagsFromResourceOutput, error)

RemoveTagsFromResourceWithContext is the same as RemoveTagsFromResource with the addition of the ability to pass a context and additional request options.

See RemoveTagsFromResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ResetDBClusterParameterGroup added in v0.7.1

func (c *RDS) ResetDBClusterParameterGroup(input *ResetDBClusterParameterGroupInput) (*DBClusterParameterGroupNameMessage, error)

ResetDBClusterParameterGroup API operation for Amazon Relational Database Service.

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ResetDBClusterParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBParameterGroupStateFault "InvalidDBParameterGroupState" The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing DB parameter group.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ResetDBClusterParameterGroup

Example (Shared00)

To reset the values of a DB cluster parameter group This example resets all parameters for the specified DB cluster parameter group to their default values.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.ResetDBClusterParameterGroupInput{
		DBClusterParameterGroupName: aws.String("mydbclusterparametergroup"),
		ResetAllParameters:          aws.Bool(true),
	}

	result, err := svc.ResetDBClusterParameterGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeInvalidDBParameterGroupStateFault:
				fmt.Println(rds.ErrCodeInvalidDBParameterGroupStateFault, aerr.Error())
			case rds.ErrCodeDBParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBParameterGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) ResetDBClusterParameterGroupRequest added in v0.7.1

func (c *RDS) ResetDBClusterParameterGroupRequest(input *ResetDBClusterParameterGroupInput) (req *request.Request, output *DBClusterParameterGroupNameMessage)

ResetDBClusterParameterGroupRequest generates a "aws/request.Request" representing the client's request for the ResetDBClusterParameterGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ResetDBClusterParameterGroup for more information on using the ResetDBClusterParameterGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ResetDBClusterParameterGroupRequest method.
req, resp := client.ResetDBClusterParameterGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ResetDBClusterParameterGroup

func (*RDS) ResetDBClusterParameterGroupWithContext added in v1.8.0

func (c *RDS) ResetDBClusterParameterGroupWithContext(ctx aws.Context, input *ResetDBClusterParameterGroupInput, opts ...request.Option) (*DBClusterParameterGroupNameMessage, error)

ResetDBClusterParameterGroupWithContext is the same as ResetDBClusterParameterGroup with the addition of the ability to pass a context and additional request options.

See ResetDBClusterParameterGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) ResetDBParameterGroup

func (c *RDS) ResetDBParameterGroup(input *ResetDBParameterGroupInput) (*DBParameterGroupNameMessage, error)

ResetDBParameterGroup API operation for Amazon Relational Database Service.

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation ResetDBParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBParameterGroupStateFault "InvalidDBParameterGroupState" The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing DB parameter group.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ResetDBParameterGroup

Example (Shared00)

To reset the values of a DB parameter group This example resets all parameters for the specified DB parameter group to their default values.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.ResetDBParameterGroupInput{
		DBParameterGroupName: aws.String("mydbparametergroup"),
		ResetAllParameters:   aws.Bool(true),
	}

	result, err := svc.ResetDBParameterGroup(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeInvalidDBParameterGroupStateFault:
				fmt.Println(rds.ErrCodeInvalidDBParameterGroupStateFault, aerr.Error())
			case rds.ErrCodeDBParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBParameterGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) ResetDBParameterGroupRequest

func (c *RDS) ResetDBParameterGroupRequest(input *ResetDBParameterGroupInput) (req *request.Request, output *DBParameterGroupNameMessage)

ResetDBParameterGroupRequest generates a "aws/request.Request" representing the client's request for the ResetDBParameterGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ResetDBParameterGroup for more information on using the ResetDBParameterGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ResetDBParameterGroupRequest method.
req, resp := client.ResetDBParameterGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ResetDBParameterGroup

func (*RDS) ResetDBParameterGroupWithContext added in v1.8.0

func (c *RDS) ResetDBParameterGroupWithContext(ctx aws.Context, input *ResetDBParameterGroupInput, opts ...request.Option) (*DBParameterGroupNameMessage, error)

ResetDBParameterGroupWithContext is the same as ResetDBParameterGroup with the addition of the ability to pass a context and additional request options.

See ResetDBParameterGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) RestoreDBClusterFromS3 added in v1.3.1

func (c *RDS) RestoreDBClusterFromS3(input *RestoreDBClusterFromS3Input) (*RestoreDBClusterFromS3Output, error)

RestoreDBClusterFromS3 API operation for Amazon Relational Database Service.

Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.ExtMySQL.html#AuroraMySQL.Migrating.ExtMySQL.S3) in the Amazon Aurora User Guide.

This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 action has completed and the DB cluster is available.

For more information on Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters. The source DB engine must be MySQL.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation RestoreDBClusterFromS3 for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterAlreadyExistsFault "DBClusterAlreadyExistsFault" The user already has a DB cluster with the given identifier.

  • ErrCodeDBClusterQuotaExceededFault "DBClusterQuotaExceededFault" The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

  • ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" The request would result in the user exceeding the allowed amount of storage available across all DB instances.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing DB subnet group.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeInvalidDBSubnetGroupStateFault "InvalidDBSubnetGroupStateFault" The DB subnet group cannot be deleted because it's in use.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

  • ErrCodeInvalidS3BucketFault "InvalidS3BucketFault" The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.

  • ErrCodeDBClusterParameterGroupNotFoundFault "DBClusterParameterGroupNotFound" DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred accessing an Amazon Web Services KMS key.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeDomainNotFoundFault "DomainNotFoundFault" Domain doesn't refer to an existing Active Directory domain.

  • ErrCodeInsufficientStorageClusterCapacityFault "InsufficientStorageClusterCapacity" There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromS3

func (*RDS) RestoreDBClusterFromS3Request added in v1.3.1

func (c *RDS) RestoreDBClusterFromS3Request(input *RestoreDBClusterFromS3Input) (req *request.Request, output *RestoreDBClusterFromS3Output)

RestoreDBClusterFromS3Request generates a "aws/request.Request" representing the client's request for the RestoreDBClusterFromS3 operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RestoreDBClusterFromS3 for more information on using the RestoreDBClusterFromS3 API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RestoreDBClusterFromS3Request method.
req, resp := client.RestoreDBClusterFromS3Request(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromS3

func (*RDS) RestoreDBClusterFromS3WithContext added in v1.8.0

func (c *RDS) RestoreDBClusterFromS3WithContext(ctx aws.Context, input *RestoreDBClusterFromS3Input, opts ...request.Option) (*RestoreDBClusterFromS3Output, error)

RestoreDBClusterFromS3WithContext is the same as RestoreDBClusterFromS3 with the addition of the ability to pass a context and additional request options.

See RestoreDBClusterFromS3 for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) RestoreDBClusterFromSnapshot added in v0.7.1

func (c *RDS) RestoreDBClusterFromSnapshot(input *RestoreDBClusterFromSnapshotInput) (*RestoreDBClusterFromSnapshotOutput, error)

RestoreDBClusterFromSnapshot API operation for Amazon Relational Database Service.

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.

This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot action has completed and the DB cluster is available.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation RestoreDBClusterFromSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterAlreadyExistsFault "DBClusterAlreadyExistsFault" The user already has a DB cluster with the given identifier.

  • ErrCodeDBClusterQuotaExceededFault "DBClusterQuotaExceededFault" The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

  • ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" The request would result in the user exceeding the allowed amount of storage available across all DB instances.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing DB subnet group.

  • ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound" DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

  • ErrCodeDBClusterSnapshotNotFoundFault "DBClusterSnapshotNotFoundFault" DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

  • ErrCodeInsufficientDBClusterCapacityFault "InsufficientDBClusterCapacityFault" The DB cluster doesn't have enough capacity for the current operation.

  • ErrCodeInsufficientStorageClusterCapacityFault "InsufficientStorageClusterCapacity" There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

  • ErrCodeInvalidDBSnapshotStateFault "InvalidDBSnapshotState" The state of the DB snapshot doesn't allow deletion.

  • ErrCodeInvalidDBClusterSnapshotStateFault "InvalidDBClusterSnapshotStateFault" The supplied value isn't a valid DB cluster snapshot state.

  • ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" The request would result in the user exceeding the allowed amount of storage available across all DB instances.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

  • ErrCodeInvalidRestoreFault "InvalidRestoreFault" Cannot restore from VPC backup to non-VPC DB instance.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing DB subnet group.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

  • ErrCodeOptionGroupNotFoundFault "OptionGroupNotFoundFault" The specified option group could not be found.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred accessing an Amazon Web Services KMS key.

  • ErrCodeDomainNotFoundFault "DomainNotFoundFault" Domain doesn't refer to an existing Active Directory domain.

  • ErrCodeDBClusterParameterGroupNotFoundFault "DBClusterParameterGroupNotFound" DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromSnapshot

Example (Shared00)

To restore an Amazon Aurora DB cluster from a DB cluster snapshot The following example restores an Amazon Aurora DB cluster from a DB cluster snapshot.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.RestoreDBClusterFromSnapshotInput{
		DBClusterIdentifier: aws.String("restored-cluster1"),
		Engine:              aws.String("aurora"),
		SnapshotIdentifier:  aws.String("sample-cluster-snapshot1"),
	}

	result, err := svc.RestoreDBClusterFromSnapshot(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBClusterAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBClusterAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeDBClusterQuotaExceededFault:
				fmt.Println(rds.ErrCodeDBClusterQuotaExceededFault, aerr.Error())
			case rds.ErrCodeStorageQuotaExceededFault:
				fmt.Println(rds.ErrCodeStorageQuotaExceededFault, aerr.Error())
			case rds.ErrCodeDBSubnetGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSubnetGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeDBSnapshotNotFoundFault:
				fmt.Println(rds.ErrCodeDBSnapshotNotFoundFault, aerr.Error())
			case rds.ErrCodeDBClusterSnapshotNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterSnapshotNotFoundFault, aerr.Error())
			case rds.ErrCodeInsufficientDBClusterCapacityFault:
				fmt.Println(rds.ErrCodeInsufficientDBClusterCapacityFault, aerr.Error())
			case rds.ErrCodeInsufficientStorageClusterCapacityFault:
				fmt.Println(rds.ErrCodeInsufficientStorageClusterCapacityFault, aerr.Error())
			case rds.ErrCodeInvalidDBSnapshotStateFault:
				fmt.Println(rds.ErrCodeInvalidDBSnapshotStateFault, aerr.Error())
			case rds.ErrCodeInvalidDBClusterSnapshotStateFault:
				fmt.Println(rds.ErrCodeInvalidDBClusterSnapshotStateFault, aerr.Error())
			case rds.ErrCodeInvalidVPCNetworkStateFault:
				fmt.Println(rds.ErrCodeInvalidVPCNetworkStateFault, aerr.Error())
			case rds.ErrCodeInvalidRestoreFault:
				fmt.Println(rds.ErrCodeInvalidRestoreFault, aerr.Error())
			case rds.ErrCodeInvalidSubnet:
				fmt.Println(rds.ErrCodeInvalidSubnet, aerr.Error())
			case rds.ErrCodeOptionGroupNotFoundFault:
				fmt.Println(rds.ErrCodeOptionGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeKMSKeyNotAccessibleFault:
				fmt.Println(rds.ErrCodeKMSKeyNotAccessibleFault, aerr.Error())
			case rds.ErrCodeDomainNotFoundFault:
				fmt.Println(rds.ErrCodeDomainNotFoundFault, aerr.Error())
			case rds.ErrCodeDBClusterParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterParameterGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) RestoreDBClusterFromSnapshotRequest added in v0.7.1

func (c *RDS) RestoreDBClusterFromSnapshotRequest(input *RestoreDBClusterFromSnapshotInput) (req *request.Request, output *RestoreDBClusterFromSnapshotOutput)

RestoreDBClusterFromSnapshotRequest generates a "aws/request.Request" representing the client's request for the RestoreDBClusterFromSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RestoreDBClusterFromSnapshot for more information on using the RestoreDBClusterFromSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RestoreDBClusterFromSnapshotRequest method.
req, resp := client.RestoreDBClusterFromSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromSnapshot

func (*RDS) RestoreDBClusterFromSnapshotWithContext added in v1.8.0

func (c *RDS) RestoreDBClusterFromSnapshotWithContext(ctx aws.Context, input *RestoreDBClusterFromSnapshotInput, opts ...request.Option) (*RestoreDBClusterFromSnapshotOutput, error)

RestoreDBClusterFromSnapshotWithContext is the same as RestoreDBClusterFromSnapshot with the addition of the ability to pass a context and additional request options.

See RestoreDBClusterFromSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) RestoreDBClusterToPointInTime added in v0.7.1

func (c *RDS) RestoreDBClusterToPointInTime(input *RestoreDBClusterToPointInTimeInput) (*RestoreDBClusterToPointInTimeOutput, error)

RestoreDBClusterToPointInTime API operation for Amazon Relational Database Service.

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

For Aurora, this action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation RestoreDBClusterToPointInTime for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterAlreadyExistsFault "DBClusterAlreadyExistsFault" The user already has a DB cluster with the given identifier.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeDBClusterQuotaExceededFault "DBClusterQuotaExceededFault" The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

  • ErrCodeDBClusterSnapshotNotFoundFault "DBClusterSnapshotNotFoundFault" DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing DB subnet group.

  • ErrCodeInsufficientDBClusterCapacityFault "InsufficientDBClusterCapacityFault" The DB cluster doesn't have enough capacity for the current operation.

  • ErrCodeInsufficientStorageClusterCapacityFault "InsufficientStorageClusterCapacity" There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

  • ErrCodeInvalidDBClusterSnapshotStateFault "InvalidDBClusterSnapshotStateFault" The supplied value isn't a valid DB cluster snapshot state.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeInvalidDBSnapshotStateFault "InvalidDBSnapshotState" The state of the DB snapshot doesn't allow deletion.

  • ErrCodeInvalidRestoreFault "InvalidRestoreFault" Cannot restore from VPC backup to non-VPC DB instance.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred accessing an Amazon Web Services KMS key.

  • ErrCodeOptionGroupNotFoundFault "OptionGroupNotFoundFault" The specified option group could not be found.

  • ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" The request would result in the user exceeding the allowed amount of storage available across all DB instances.

  • ErrCodeDomainNotFoundFault "DomainNotFoundFault" Domain doesn't refer to an existing Active Directory domain.

  • ErrCodeDBClusterParameterGroupNotFoundFault "DBClusterParameterGroupNotFound" DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterToPointInTime

Example (Shared00)

To restore a DB cluster to a point in time. The following example restores a DB cluster to a new DB cluster at a point in time from the source DB cluster.

package main

import (
	"fmt"
	"time"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func parseTime(layout, value string) *time.Time {
	t, err := time.Parse(layout, value)
	if err != nil {
		panic(err)
	}
	return &t
}

func main() {
	svc := rds.New(session.New())
	input := &rds.RestoreDBClusterToPointInTimeInput{
		DBClusterIdentifier:       aws.String("sample-restored-cluster1"),
		RestoreToTime:             parseTime("2006-01-02T15:04:05.999999999Z", "2016-09-13T18:45:00Z"),
		SourceDBClusterIdentifier: aws.String("sample-cluster1"),
	}

	result, err := svc.RestoreDBClusterToPointInTime(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBClusterAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBClusterAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeDBClusterNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterNotFoundFault, aerr.Error())
			case rds.ErrCodeDBClusterQuotaExceededFault:
				fmt.Println(rds.ErrCodeDBClusterQuotaExceededFault, aerr.Error())
			case rds.ErrCodeDBClusterSnapshotNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterSnapshotNotFoundFault, aerr.Error())
			case rds.ErrCodeDBSubnetGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSubnetGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeInsufficientDBClusterCapacityFault:
				fmt.Println(rds.ErrCodeInsufficientDBClusterCapacityFault, aerr.Error())
			case rds.ErrCodeInsufficientStorageClusterCapacityFault:
				fmt.Println(rds.ErrCodeInsufficientStorageClusterCapacityFault, aerr.Error())
			case rds.ErrCodeInvalidDBClusterSnapshotStateFault:
				fmt.Println(rds.ErrCodeInvalidDBClusterSnapshotStateFault, aerr.Error())
			case rds.ErrCodeInvalidDBClusterStateFault:
				fmt.Println(rds.ErrCodeInvalidDBClusterStateFault, aerr.Error())
			case rds.ErrCodeInvalidDBSnapshotStateFault:
				fmt.Println(rds.ErrCodeInvalidDBSnapshotStateFault, aerr.Error())
			case rds.ErrCodeInvalidRestoreFault:
				fmt.Println(rds.ErrCodeInvalidRestoreFault, aerr.Error())
			case rds.ErrCodeInvalidSubnet:
				fmt.Println(rds.ErrCodeInvalidSubnet, aerr.Error())
			case rds.ErrCodeInvalidVPCNetworkStateFault:
				fmt.Println(rds.ErrCodeInvalidVPCNetworkStateFault, aerr.Error())
			case rds.ErrCodeKMSKeyNotAccessibleFault:
				fmt.Println(rds.ErrCodeKMSKeyNotAccessibleFault, aerr.Error())
			case rds.ErrCodeOptionGroupNotFoundFault:
				fmt.Println(rds.ErrCodeOptionGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeStorageQuotaExceededFault:
				fmt.Println(rds.ErrCodeStorageQuotaExceededFault, aerr.Error())
			case rds.ErrCodeDomainNotFoundFault:
				fmt.Println(rds.ErrCodeDomainNotFoundFault, aerr.Error())
			case rds.ErrCodeDBClusterParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBClusterParameterGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) RestoreDBClusterToPointInTimeRequest added in v0.7.1

func (c *RDS) RestoreDBClusterToPointInTimeRequest(input *RestoreDBClusterToPointInTimeInput) (req *request.Request, output *RestoreDBClusterToPointInTimeOutput)

RestoreDBClusterToPointInTimeRequest generates a "aws/request.Request" representing the client's request for the RestoreDBClusterToPointInTime operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RestoreDBClusterToPointInTime for more information on using the RestoreDBClusterToPointInTime API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RestoreDBClusterToPointInTimeRequest method.
req, resp := client.RestoreDBClusterToPointInTimeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterToPointInTime

func (*RDS) RestoreDBClusterToPointInTimeWithContext added in v1.8.0

func (c *RDS) RestoreDBClusterToPointInTimeWithContext(ctx aws.Context, input *RestoreDBClusterToPointInTimeInput, opts ...request.Option) (*RestoreDBClusterToPointInTimeOutput, error)

RestoreDBClusterToPointInTimeWithContext is the same as RestoreDBClusterToPointInTime with the addition of the ability to pass a context and additional request options.

See RestoreDBClusterToPointInTime for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) RestoreDBInstanceFromDBSnapshot

func (c *RDS) RestoreDBInstanceFromDBSnapshot(input *RestoreDBInstanceFromDBSnapshotInput) (*RestoreDBInstanceFromDBSnapshotOutput, error)

RestoreDBInstanceFromDBSnapshot API operation for Amazon Relational Database Service.

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original DB instance with the DB instance created from the snapshot.

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation RestoreDBInstanceFromDBSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceAlreadyExistsFault "DBInstanceAlreadyExists" The user already has a DB instance with the given identifier.

  • ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound" DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

  • ErrCodeInstanceQuotaExceededFault "InstanceQuotaExceeded" The request would result in the user exceeding the allowed number of DB instances.

  • ErrCodeInsufficientDBInstanceCapacityFault "InsufficientDBInstanceCapacity" The specified DB instance class isn't available in the specified Availability Zone.

  • ErrCodeInvalidDBSnapshotStateFault "InvalidDBSnapshotState" The state of the DB snapshot doesn't allow deletion.

  • ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" The request would result in the user exceeding the allowed amount of storage available across all DB instances.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

  • ErrCodeInvalidRestoreFault "InvalidRestoreFault" Cannot restore from VPC backup to non-VPC DB instance.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing DB subnet group.

  • ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs "DBSubnetGroupDoesNotCoverEnoughAZs" Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

  • ErrCodeProvisionedIopsNotAvailableInAZFault "ProvisionedIopsNotAvailableInAZFault" Provisioned IOPS not available in the specified Availability Zone.

  • ErrCodeOptionGroupNotFoundFault "OptionGroupNotFoundFault" The specified option group could not be found.

  • ErrCodeStorageTypeNotSupportedFault "StorageTypeNotSupported" Storage of the StorageType specified can't be associated with the DB instance.

  • ErrCodeAuthorizationNotFoundFault "AuthorizationNotFound" The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.

    Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred accessing an Amazon Web Services KMS key.

  • ErrCodeDBSecurityGroupNotFoundFault "DBSecurityGroupNotFound" DBSecurityGroupName doesn't refer to an existing DB security group.

  • ErrCodeDomainNotFoundFault "DomainNotFoundFault" Domain doesn't refer to an existing Active Directory domain.

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing DB parameter group.

  • ErrCodeBackupPolicyNotFoundFault "BackupPolicyNotFoundFault"

  • ErrCodeNetworkTypeNotSupported "NetworkTypeNotSupported" The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromDBSnapshot

Example (Shared00)

To restore a DB instance from a DB snapshot. The following example restores a DB instance from a DB snapshot.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.RestoreDBInstanceFromDBSnapshotInput{
		DBInstanceIdentifier: aws.String("mysqldb-restored"),
		DBSnapshotIdentifier: aws.String("rds:mysqldb-2014-04-22-08-15"),
	}

	result, err := svc.RestoreDBInstanceFromDBSnapshot(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBInstanceAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBInstanceAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeDBSnapshotNotFoundFault:
				fmt.Println(rds.ErrCodeDBSnapshotNotFoundFault, aerr.Error())
			case rds.ErrCodeInstanceQuotaExceededFault:
				fmt.Println(rds.ErrCodeInstanceQuotaExceededFault, aerr.Error())
			case rds.ErrCodeInsufficientDBInstanceCapacityFault:
				fmt.Println(rds.ErrCodeInsufficientDBInstanceCapacityFault, aerr.Error())
			case rds.ErrCodeInvalidDBSnapshotStateFault:
				fmt.Println(rds.ErrCodeInvalidDBSnapshotStateFault, aerr.Error())
			case rds.ErrCodeStorageQuotaExceededFault:
				fmt.Println(rds.ErrCodeStorageQuotaExceededFault, aerr.Error())
			case rds.ErrCodeInvalidVPCNetworkStateFault:
				fmt.Println(rds.ErrCodeInvalidVPCNetworkStateFault, aerr.Error())
			case rds.ErrCodeInvalidRestoreFault:
				fmt.Println(rds.ErrCodeInvalidRestoreFault, aerr.Error())
			case rds.ErrCodeDBSubnetGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSubnetGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs:
				fmt.Println(rds.ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs, aerr.Error())
			case rds.ErrCodeInvalidSubnet:
				fmt.Println(rds.ErrCodeInvalidSubnet, aerr.Error())
			case rds.ErrCodeProvisionedIopsNotAvailableInAZFault:
				fmt.Println(rds.ErrCodeProvisionedIopsNotAvailableInAZFault, aerr.Error())
			case rds.ErrCodeOptionGroupNotFoundFault:
				fmt.Println(rds.ErrCodeOptionGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeStorageTypeNotSupportedFault:
				fmt.Println(rds.ErrCodeStorageTypeNotSupportedFault, aerr.Error())
			case rds.ErrCodeAuthorizationNotFoundFault:
				fmt.Println(rds.ErrCodeAuthorizationNotFoundFault, aerr.Error())
			case rds.ErrCodeKMSKeyNotAccessibleFault:
				fmt.Println(rds.ErrCodeKMSKeyNotAccessibleFault, aerr.Error())
			case rds.ErrCodeDBSecurityGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSecurityGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeDomainNotFoundFault:
				fmt.Println(rds.ErrCodeDomainNotFoundFault, aerr.Error())
			case rds.ErrCodeDBParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBParameterGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeBackupPolicyNotFoundFault:
				fmt.Println(rds.ErrCodeBackupPolicyNotFoundFault, aerr.Error())
			case rds.ErrCodeNetworkTypeNotSupported:
				fmt.Println(rds.ErrCodeNetworkTypeNotSupported, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) RestoreDBInstanceFromDBSnapshotRequest

func (c *RDS) RestoreDBInstanceFromDBSnapshotRequest(input *RestoreDBInstanceFromDBSnapshotInput) (req *request.Request, output *RestoreDBInstanceFromDBSnapshotOutput)

RestoreDBInstanceFromDBSnapshotRequest generates a "aws/request.Request" representing the client's request for the RestoreDBInstanceFromDBSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RestoreDBInstanceFromDBSnapshot for more information on using the RestoreDBInstanceFromDBSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RestoreDBInstanceFromDBSnapshotRequest method.
req, resp := client.RestoreDBInstanceFromDBSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromDBSnapshot

func (*RDS) RestoreDBInstanceFromDBSnapshotWithContext added in v1.8.0

func (c *RDS) RestoreDBInstanceFromDBSnapshotWithContext(ctx aws.Context, input *RestoreDBInstanceFromDBSnapshotInput, opts ...request.Option) (*RestoreDBInstanceFromDBSnapshotOutput, error)

RestoreDBInstanceFromDBSnapshotWithContext is the same as RestoreDBInstanceFromDBSnapshot with the addition of the ability to pass a context and additional request options.

See RestoreDBInstanceFromDBSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) RestoreDBInstanceFromS3 added in v1.12.30

func (c *RDS) RestoreDBInstanceFromS3(input *RestoreDBInstanceFromS3Input) (*RestoreDBInstanceFromS3Output, error)

RestoreDBInstanceFromS3 API operation for Amazon Relational Database Service.

Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html) in the Amazon RDS User Guide.

This command doesn't apply to RDS Custom.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation RestoreDBInstanceFromS3 for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceAlreadyExistsFault "DBInstanceAlreadyExists" The user already has a DB instance with the given identifier.

  • ErrCodeInsufficientDBInstanceCapacityFault "InsufficientDBInstanceCapacity" The specified DB instance class isn't available in the specified Availability Zone.

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing DB parameter group.

  • ErrCodeDBSecurityGroupNotFoundFault "DBSecurityGroupNotFound" DBSecurityGroupName doesn't refer to an existing DB security group.

  • ErrCodeInstanceQuotaExceededFault "InstanceQuotaExceeded" The request would result in the user exceeding the allowed number of DB instances.

  • ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" The request would result in the user exceeding the allowed amount of storage available across all DB instances.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing DB subnet group.

  • ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs "DBSubnetGroupDoesNotCoverEnoughAZs" Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

  • ErrCodeInvalidS3BucketFault "InvalidS3BucketFault" The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.

  • ErrCodeProvisionedIopsNotAvailableInAZFault "ProvisionedIopsNotAvailableInAZFault" Provisioned IOPS not available in the specified Availability Zone.

  • ErrCodeOptionGroupNotFoundFault "OptionGroupNotFoundFault" The specified option group could not be found.

  • ErrCodeStorageTypeNotSupportedFault "StorageTypeNotSupported" Storage of the StorageType specified can't be associated with the DB instance.

  • ErrCodeAuthorizationNotFoundFault "AuthorizationNotFound" The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.

    Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred accessing an Amazon Web Services KMS key.

  • ErrCodeBackupPolicyNotFoundFault "BackupPolicyNotFoundFault"

  • ErrCodeNetworkTypeNotSupported "NetworkTypeNotSupported" The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromS3

func (*RDS) RestoreDBInstanceFromS3Request added in v1.12.30

func (c *RDS) RestoreDBInstanceFromS3Request(input *RestoreDBInstanceFromS3Input) (req *request.Request, output *RestoreDBInstanceFromS3Output)

RestoreDBInstanceFromS3Request generates a "aws/request.Request" representing the client's request for the RestoreDBInstanceFromS3 operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RestoreDBInstanceFromS3 for more information on using the RestoreDBInstanceFromS3 API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RestoreDBInstanceFromS3Request method.
req, resp := client.RestoreDBInstanceFromS3Request(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromS3

func (*RDS) RestoreDBInstanceFromS3WithContext added in v1.12.30

func (c *RDS) RestoreDBInstanceFromS3WithContext(ctx aws.Context, input *RestoreDBInstanceFromS3Input, opts ...request.Option) (*RestoreDBInstanceFromS3Output, error)

RestoreDBInstanceFromS3WithContext is the same as RestoreDBInstanceFromS3 with the addition of the ability to pass a context and additional request options.

See RestoreDBInstanceFromS3 for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) RestoreDBInstanceToPointInTime

func (c *RDS) RestoreDBInstanceToPointInTime(input *RestoreDBInstanceToPointInTimeInput) (*RestoreDBInstanceToPointInTimeOutput, error)

RestoreDBInstanceToPointInTime API operation for Amazon Relational Database Service.

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation RestoreDBInstanceToPointInTime for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceAlreadyExistsFault "DBInstanceAlreadyExists" The user already has a DB instance with the given identifier.

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeInstanceQuotaExceededFault "InstanceQuotaExceeded" The request would result in the user exceeding the allowed number of DB instances.

  • ErrCodeInsufficientDBInstanceCapacityFault "InsufficientDBInstanceCapacity" The specified DB instance class isn't available in the specified Availability Zone.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

  • ErrCodePointInTimeRestoreNotEnabledFault "PointInTimeRestoreNotEnabled" SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

  • ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" The request would result in the user exceeding the allowed amount of storage available across all DB instances.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

  • ErrCodeInvalidRestoreFault "InvalidRestoreFault" Cannot restore from VPC backup to non-VPC DB instance.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing DB subnet group.

  • ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs "DBSubnetGroupDoesNotCoverEnoughAZs" Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

  • ErrCodeProvisionedIopsNotAvailableInAZFault "ProvisionedIopsNotAvailableInAZFault" Provisioned IOPS not available in the specified Availability Zone.

  • ErrCodeOptionGroupNotFoundFault "OptionGroupNotFoundFault" The specified option group could not be found.

  • ErrCodeStorageTypeNotSupportedFault "StorageTypeNotSupported" Storage of the StorageType specified can't be associated with the DB instance.

  • ErrCodeAuthorizationNotFoundFault "AuthorizationNotFound" The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.

    Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred accessing an Amazon Web Services KMS key.

  • ErrCodeDBSecurityGroupNotFoundFault "DBSecurityGroupNotFound" DBSecurityGroupName doesn't refer to an existing DB security group.

  • ErrCodeDomainNotFoundFault "DomainNotFoundFault" Domain doesn't refer to an existing Active Directory domain.

  • ErrCodeBackupPolicyNotFoundFault "BackupPolicyNotFoundFault"

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing DB parameter group.

  • ErrCodeDBInstanceAutomatedBackupNotFoundFault "DBInstanceAutomatedBackupNotFound" No automated backup for this DB instance was found.

  • ErrCodeNetworkTypeNotSupported "NetworkTypeNotSupported" The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceToPointInTime

Example (Shared00)

To restore a DB instance to a point in time. The following example restores a DB instance to a new DB instance at a point in time from the source DB instance.

package main

import (
	"fmt"
	"time"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func parseTime(layout, value string) *time.Time {
	t, err := time.Parse(layout, value)
	if err != nil {
		panic(err)
	}
	return &t
}

func main() {
	svc := rds.New(session.New())
	input := &rds.RestoreDBInstanceToPointInTimeInput{
		RestoreTime:                parseTime("2006-01-02T15:04:05.999999999Z", "2016-09-13T18:45:00Z"),
		SourceDBInstanceIdentifier: aws.String("mysql-sample"),
		TargetDBInstanceIdentifier: aws.String("mysql-sample-restored"),
	}

	result, err := svc.RestoreDBInstanceToPointInTime(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBInstanceAlreadyExistsFault:
				fmt.Println(rds.ErrCodeDBInstanceAlreadyExistsFault, aerr.Error())
			case rds.ErrCodeDBInstanceNotFoundFault:
				fmt.Println(rds.ErrCodeDBInstanceNotFoundFault, aerr.Error())
			case rds.ErrCodeInstanceQuotaExceededFault:
				fmt.Println(rds.ErrCodeInstanceQuotaExceededFault, aerr.Error())
			case rds.ErrCodeInsufficientDBInstanceCapacityFault:
				fmt.Println(rds.ErrCodeInsufficientDBInstanceCapacityFault, aerr.Error())
			case rds.ErrCodeInvalidDBInstanceStateFault:
				fmt.Println(rds.ErrCodeInvalidDBInstanceStateFault, aerr.Error())
			case rds.ErrCodePointInTimeRestoreNotEnabledFault:
				fmt.Println(rds.ErrCodePointInTimeRestoreNotEnabledFault, aerr.Error())
			case rds.ErrCodeStorageQuotaExceededFault:
				fmt.Println(rds.ErrCodeStorageQuotaExceededFault, aerr.Error())
			case rds.ErrCodeInvalidVPCNetworkStateFault:
				fmt.Println(rds.ErrCodeInvalidVPCNetworkStateFault, aerr.Error())
			case rds.ErrCodeInvalidRestoreFault:
				fmt.Println(rds.ErrCodeInvalidRestoreFault, aerr.Error())
			case rds.ErrCodeDBSubnetGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSubnetGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs:
				fmt.Println(rds.ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs, aerr.Error())
			case rds.ErrCodeInvalidSubnet:
				fmt.Println(rds.ErrCodeInvalidSubnet, aerr.Error())
			case rds.ErrCodeProvisionedIopsNotAvailableInAZFault:
				fmt.Println(rds.ErrCodeProvisionedIopsNotAvailableInAZFault, aerr.Error())
			case rds.ErrCodeOptionGroupNotFoundFault:
				fmt.Println(rds.ErrCodeOptionGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeStorageTypeNotSupportedFault:
				fmt.Println(rds.ErrCodeStorageTypeNotSupportedFault, aerr.Error())
			case rds.ErrCodeAuthorizationNotFoundFault:
				fmt.Println(rds.ErrCodeAuthorizationNotFoundFault, aerr.Error())
			case rds.ErrCodeKMSKeyNotAccessibleFault:
				fmt.Println(rds.ErrCodeKMSKeyNotAccessibleFault, aerr.Error())
			case rds.ErrCodeDBSecurityGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSecurityGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeDomainNotFoundFault:
				fmt.Println(rds.ErrCodeDomainNotFoundFault, aerr.Error())
			case rds.ErrCodeBackupPolicyNotFoundFault:
				fmt.Println(rds.ErrCodeBackupPolicyNotFoundFault, aerr.Error())
			case rds.ErrCodeDBParameterGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBParameterGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeDBInstanceAutomatedBackupNotFoundFault:
				fmt.Println(rds.ErrCodeDBInstanceAutomatedBackupNotFoundFault, aerr.Error())
			case rds.ErrCodeNetworkTypeNotSupported:
				fmt.Println(rds.ErrCodeNetworkTypeNotSupported, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) RestoreDBInstanceToPointInTimeRequest

func (c *RDS) RestoreDBInstanceToPointInTimeRequest(input *RestoreDBInstanceToPointInTimeInput) (req *request.Request, output *RestoreDBInstanceToPointInTimeOutput)

RestoreDBInstanceToPointInTimeRequest generates a "aws/request.Request" representing the client's request for the RestoreDBInstanceToPointInTime operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RestoreDBInstanceToPointInTime for more information on using the RestoreDBInstanceToPointInTime API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RestoreDBInstanceToPointInTimeRequest method.
req, resp := client.RestoreDBInstanceToPointInTimeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceToPointInTime

func (*RDS) RestoreDBInstanceToPointInTimeWithContext added in v1.8.0

func (c *RDS) RestoreDBInstanceToPointInTimeWithContext(ctx aws.Context, input *RestoreDBInstanceToPointInTimeInput, opts ...request.Option) (*RestoreDBInstanceToPointInTimeOutput, error)

RestoreDBInstanceToPointInTimeWithContext is the same as RestoreDBInstanceToPointInTime with the addition of the ability to pass a context and additional request options.

See RestoreDBInstanceToPointInTime for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) RevokeDBSecurityGroupIngress

func (c *RDS) RevokeDBSecurityGroupIngress(input *RevokeDBSecurityGroupIngressInput) (*RevokeDBSecurityGroupIngressOutput, error)

RevokeDBSecurityGroupIngress API operation for Amazon Relational Database Service.

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare (http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/), and Moving a DB instance not in a VPC into a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation RevokeDBSecurityGroupIngress for usage and error information.

Returned Error Codes:

  • ErrCodeDBSecurityGroupNotFoundFault "DBSecurityGroupNotFound" DBSecurityGroupName doesn't refer to an existing DB security group.

  • ErrCodeAuthorizationNotFoundFault "AuthorizationNotFound" The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.

    Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

  • ErrCodeInvalidDBSecurityGroupStateFault "InvalidDBSecurityGroupState" The state of the DB security group doesn't allow deletion.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RevokeDBSecurityGroupIngress

Example (Shared00)

To revoke ingress for a DB security group This example revokes ingress for the specified CIDR block associated with the specified DB security group.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/rds"
)

func main() {
	svc := rds.New(session.New())
	input := &rds.RevokeDBSecurityGroupIngressInput{
		CIDRIP:              aws.String("203.0.113.5/32"),
		DBSecurityGroupName: aws.String("mydbsecuritygroup"),
	}

	result, err := svc.RevokeDBSecurityGroupIngress(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case rds.ErrCodeDBSecurityGroupNotFoundFault:
				fmt.Println(rds.ErrCodeDBSecurityGroupNotFoundFault, aerr.Error())
			case rds.ErrCodeAuthorizationNotFoundFault:
				fmt.Println(rds.ErrCodeAuthorizationNotFoundFault, aerr.Error())
			case rds.ErrCodeInvalidDBSecurityGroupStateFault:
				fmt.Println(rds.ErrCodeInvalidDBSecurityGroupStateFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*RDS) RevokeDBSecurityGroupIngressRequest

func (c *RDS) RevokeDBSecurityGroupIngressRequest(input *RevokeDBSecurityGroupIngressInput) (req *request.Request, output *RevokeDBSecurityGroupIngressOutput)

RevokeDBSecurityGroupIngressRequest generates a "aws/request.Request" representing the client's request for the RevokeDBSecurityGroupIngress operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RevokeDBSecurityGroupIngress for more information on using the RevokeDBSecurityGroupIngress API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RevokeDBSecurityGroupIngressRequest method.
req, resp := client.RevokeDBSecurityGroupIngressRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RevokeDBSecurityGroupIngress

func (*RDS) RevokeDBSecurityGroupIngressWithContext added in v1.8.0

func (c *RDS) RevokeDBSecurityGroupIngressWithContext(ctx aws.Context, input *RevokeDBSecurityGroupIngressInput, opts ...request.Option) (*RevokeDBSecurityGroupIngressOutput, error)

RevokeDBSecurityGroupIngressWithContext is the same as RevokeDBSecurityGroupIngress with the addition of the ability to pass a context and additional request options.

See RevokeDBSecurityGroupIngress for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) StartActivityStream added in v1.19.41

func (c *RDS) StartActivityStream(input *StartActivityStreamInput) (*StartActivityStreamOutput, error)

StartActivityStream API operation for Amazon Relational Database Service.

Starts a database activity stream to monitor activity on the database. For more information, see Database Activity Streams (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html) in the Amazon Aurora User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation StartActivityStream for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeResourceNotFoundFault "ResourceNotFoundFault" The specified resource ID was not found.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred accessing an Amazon Web Services KMS key.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartActivityStream

func (*RDS) StartActivityStreamRequest added in v1.19.41

func (c *RDS) StartActivityStreamRequest(input *StartActivityStreamInput) (req *request.Request, output *StartActivityStreamOutput)

StartActivityStreamRequest generates a "aws/request.Request" representing the client's request for the StartActivityStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartActivityStream for more information on using the StartActivityStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartActivityStreamRequest method.
req, resp := client.StartActivityStreamRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartActivityStream

func (*RDS) StartActivityStreamWithContext added in v1.19.41

func (c *RDS) StartActivityStreamWithContext(ctx aws.Context, input *StartActivityStreamInput, opts ...request.Option) (*StartActivityStreamOutput, error)

StartActivityStreamWithContext is the same as StartActivityStream with the addition of the ability to pass a context and additional request options.

See StartActivityStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) StartDBCluster added in v1.15.39

func (c *RDS) StartDBCluster(input *StartDBClusterInput) (*StartDBClusterOutput, error)

StartDBCluster API operation for Amazon Relational Database Service.

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster action.

For more information, see Stopping and Starting an Aurora Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html) in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation StartDBCluster for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBCluster

func (*RDS) StartDBClusterRequest added in v1.15.39

func (c *RDS) StartDBClusterRequest(input *StartDBClusterInput) (req *request.Request, output *StartDBClusterOutput)

StartDBClusterRequest generates a "aws/request.Request" representing the client's request for the StartDBCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartDBCluster for more information on using the StartDBCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartDBClusterRequest method.
req, resp := client.StartDBClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBCluster

func (*RDS) StartDBClusterWithContext added in v1.15.39

func (c *RDS) StartDBClusterWithContext(ctx aws.Context, input *StartDBClusterInput, opts ...request.Option) (*StartDBClusterOutput, error)

StartDBClusterWithContext is the same as StartDBCluster with the addition of the ability to pass a context and additional request options.

See StartDBCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) StartDBInstance added in v1.8.32

func (c *RDS) StartDBInstance(input *StartDBInstanceInput) (*StartDBInstanceOutput, error)

StartDBInstance API operation for Amazon Relational Database Service.

Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.

For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StartInstance.html) in the Amazon RDS User Guide.

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation StartDBInstance for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

  • ErrCodeInsufficientDBInstanceCapacityFault "InsufficientDBInstanceCapacity" The specified DB instance class isn't available in the specified Availability Zone.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing DB subnet group.

  • ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs "DBSubnetGroupDoesNotCoverEnoughAZs" Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeAuthorizationNotFoundFault "AuthorizationNotFound" The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.

    Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred accessing an Amazon Web Services KMS key.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBInstance

func (*RDS) StartDBInstanceAutomatedBackupsReplication added in v1.36.2

func (c *RDS) StartDBInstanceAutomatedBackupsReplication(input *StartDBInstanceAutomatedBackupsReplicationInput) (*StartDBInstanceAutomatedBackupsReplicationOutput, error)

StartDBInstanceAutomatedBackupsReplication API operation for Amazon Relational Database Service.

Enables replication of automated backups to a different Amazon Web Services Region.

This command doesn't apply to RDS Custom.

For more information, see Replicating Automated Backups to Another Amazon Web Services Region (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation StartDBInstanceAutomatedBackupsReplication for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred accessing an Amazon Web Services KMS key.

  • ErrCodeDBInstanceAutomatedBackupQuotaExceededFault "DBInstanceAutomatedBackupQuotaExceeded" The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB Instance quota.

  • ErrCodeStorageTypeNotSupportedFault "StorageTypeNotSupported" Storage of the StorageType specified can't be associated with the DB instance.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBInstanceAutomatedBackupsReplication

func (*RDS) StartDBInstanceAutomatedBackupsReplicationRequest added in v1.36.2

func (c *RDS) StartDBInstanceAutomatedBackupsReplicationRequest(input *StartDBInstanceAutomatedBackupsReplicationInput) (req *request.Request, output *StartDBInstanceAutomatedBackupsReplicationOutput)

StartDBInstanceAutomatedBackupsReplicationRequest generates a "aws/request.Request" representing the client's request for the StartDBInstanceAutomatedBackupsReplication operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartDBInstanceAutomatedBackupsReplication for more information on using the StartDBInstanceAutomatedBackupsReplication API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartDBInstanceAutomatedBackupsReplicationRequest method.
req, resp := client.StartDBInstanceAutomatedBackupsReplicationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBInstanceAutomatedBackupsReplication

func (*RDS) StartDBInstanceAutomatedBackupsReplicationWithContext added in v1.36.2

func (c *RDS) StartDBInstanceAutomatedBackupsReplicationWithContext(ctx aws.Context, input *StartDBInstanceAutomatedBackupsReplicationInput, opts ...request.Option) (*StartDBInstanceAutomatedBackupsReplicationOutput, error)

StartDBInstanceAutomatedBackupsReplicationWithContext is the same as StartDBInstanceAutomatedBackupsReplication with the addition of the ability to pass a context and additional request options.

See StartDBInstanceAutomatedBackupsReplication for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) StartDBInstanceRequest added in v1.8.32

func (c *RDS) StartDBInstanceRequest(input *StartDBInstanceInput) (req *request.Request, output *StartDBInstanceOutput)

StartDBInstanceRequest generates a "aws/request.Request" representing the client's request for the StartDBInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartDBInstance for more information on using the StartDBInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartDBInstanceRequest method.
req, resp := client.StartDBInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBInstance

func (*RDS) StartDBInstanceWithContext added in v1.8.32

func (c *RDS) StartDBInstanceWithContext(ctx aws.Context, input *StartDBInstanceInput, opts ...request.Option) (*StartDBInstanceOutput, error)

StartDBInstanceWithContext is the same as StartDBInstance with the addition of the ability to pass a context and additional request options.

See StartDBInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) StartExportTask added in v1.28.8

func (c *RDS) StartExportTask(input *StartExportTaskInput) (*StartExportTaskOutput, error)

StartExportTask API operation for Amazon Relational Database Service.

Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.

This command doesn't apply to RDS Custom.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation StartExportTask for usage and error information.

Returned Error Codes:

  • ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound" DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

  • ErrCodeDBClusterSnapshotNotFoundFault "DBClusterSnapshotNotFoundFault" DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

  • ErrCodeExportTaskAlreadyExistsFault "ExportTaskAlreadyExists" You can't start an export task that's already running.

  • ErrCodeInvalidS3BucketFault "InvalidS3BucketFault" The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.

  • ErrCodeIamRoleNotFoundFault "IamRoleNotFound" The IAM role is missing for exporting to an Amazon S3 bucket.

  • ErrCodeIamRoleMissingPermissionsFault "IamRoleMissingPermissions" The IAM role requires additional permissions to export to an Amazon S3 bucket.

  • ErrCodeInvalidExportOnlyFault "InvalidExportOnly" The export is invalid for exporting to an Amazon S3 bucket.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred accessing an Amazon Web Services KMS key.

  • ErrCodeInvalidExportSourceStateFault "InvalidExportSourceState" The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartExportTask

func (*RDS) StartExportTaskRequest added in v1.28.8

func (c *RDS) StartExportTaskRequest(input *StartExportTaskInput) (req *request.Request, output *StartExportTaskOutput)

StartExportTaskRequest generates a "aws/request.Request" representing the client's request for the StartExportTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartExportTask for more information on using the StartExportTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartExportTaskRequest method.
req, resp := client.StartExportTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartExportTask

func (*RDS) StartExportTaskWithContext added in v1.28.8

func (c *RDS) StartExportTaskWithContext(ctx aws.Context, input *StartExportTaskInput, opts ...request.Option) (*StartExportTaskOutput, error)

StartExportTaskWithContext is the same as StartExportTask with the addition of the ability to pass a context and additional request options.

See StartExportTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) StopActivityStream added in v1.19.41

func (c *RDS) StopActivityStream(input *StopActivityStreamInput) (*StopActivityStreamOutput, error)

StopActivityStream API operation for Amazon Relational Database Service.

Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream action.

For more information, see Database Activity Streams (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html) in the Amazon Aurora User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation StopActivityStream for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeResourceNotFoundFault "ResourceNotFoundFault" The specified resource ID was not found.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopActivityStream

func (*RDS) StopActivityStreamRequest added in v1.19.41

func (c *RDS) StopActivityStreamRequest(input *StopActivityStreamInput) (req *request.Request, output *StopActivityStreamOutput)

StopActivityStreamRequest generates a "aws/request.Request" representing the client's request for the StopActivityStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopActivityStream for more information on using the StopActivityStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopActivityStreamRequest method.
req, resp := client.StopActivityStreamRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopActivityStream

func (*RDS) StopActivityStreamWithContext added in v1.19.41

func (c *RDS) StopActivityStreamWithContext(ctx aws.Context, input *StopActivityStreamInput, opts ...request.Option) (*StopActivityStreamOutput, error)

StopActivityStreamWithContext is the same as StopActivityStream with the addition of the ability to pass a context and additional request options.

See StopActivityStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) StopDBCluster added in v1.15.39

func (c *RDS) StopDBCluster(input *StopDBClusterInput) (*StopDBClusterOutput, error)

StopDBCluster API operation for Amazon Relational Database Service.

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping and Starting an Aurora Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html) in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation StopDBCluster for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing DB cluster.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBCluster

func (*RDS) StopDBClusterRequest added in v1.15.39

func (c *RDS) StopDBClusterRequest(input *StopDBClusterInput) (req *request.Request, output *StopDBClusterOutput)

StopDBClusterRequest generates a "aws/request.Request" representing the client's request for the StopDBCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopDBCluster for more information on using the StopDBCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopDBClusterRequest method.
req, resp := client.StopDBClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBCluster

func (*RDS) StopDBClusterWithContext added in v1.15.39

func (c *RDS) StopDBClusterWithContext(ctx aws.Context, input *StopDBClusterInput, opts ...request.Option) (*StopDBClusterOutput, error)

StopDBClusterWithContext is the same as StopDBCluster with the addition of the ability to pass a context and additional request options.

See StopDBCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) StopDBInstance added in v1.8.32

func (c *RDS) StopDBInstance(input *StopDBInstanceInput) (*StopDBInstanceOutput, error)

StopDBInstance API operation for Amazon Relational Database Service.

Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping an Amazon RDS DB Instance Temporarily (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StopInstance.html) in the Amazon RDS User Guide.

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation StopDBInstance for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

  • ErrCodeDBSnapshotAlreadyExistsFault "DBSnapshotAlreadyExists" DBSnapshotIdentifier is already used by an existing snapshot.

  • ErrCodeSnapshotQuotaExceededFault "SnapshotQuotaExceeded" The request would result in the user exceeding the allowed number of DB snapshots.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The requested operation can't be performed while the cluster is in this state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBInstance

func (*RDS) StopDBInstanceAutomatedBackupsReplication added in v1.36.2

func (c *RDS) StopDBInstanceAutomatedBackupsReplication(input *StopDBInstanceAutomatedBackupsReplicationInput) (*StopDBInstanceAutomatedBackupsReplicationOutput, error)

StopDBInstanceAutomatedBackupsReplication API operation for Amazon Relational Database Service.

Stops automated backup replication for a DB instance.

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.

For more information, see Replicating Automated Backups to Another Amazon Web Services Region (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the Amazon RDS User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation StopDBInstanceAutomatedBackupsReplication for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBInstanceAutomatedBackupsReplication

func (*RDS) StopDBInstanceAutomatedBackupsReplicationRequest added in v1.36.2

func (c *RDS) StopDBInstanceAutomatedBackupsReplicationRequest(input *StopDBInstanceAutomatedBackupsReplicationInput) (req *request.Request, output *StopDBInstanceAutomatedBackupsReplicationOutput)

StopDBInstanceAutomatedBackupsReplicationRequest generates a "aws/request.Request" representing the client's request for the StopDBInstanceAutomatedBackupsReplication operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopDBInstanceAutomatedBackupsReplication for more information on using the StopDBInstanceAutomatedBackupsReplication API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopDBInstanceAutomatedBackupsReplicationRequest method.
req, resp := client.StopDBInstanceAutomatedBackupsReplicationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBInstanceAutomatedBackupsReplication

func (*RDS) StopDBInstanceAutomatedBackupsReplicationWithContext added in v1.36.2

func (c *RDS) StopDBInstanceAutomatedBackupsReplicationWithContext(ctx aws.Context, input *StopDBInstanceAutomatedBackupsReplicationInput, opts ...request.Option) (*StopDBInstanceAutomatedBackupsReplicationOutput, error)

StopDBInstanceAutomatedBackupsReplicationWithContext is the same as StopDBInstanceAutomatedBackupsReplication with the addition of the ability to pass a context and additional request options.

See StopDBInstanceAutomatedBackupsReplication for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) StopDBInstanceRequest added in v1.8.32

func (c *RDS) StopDBInstanceRequest(input *StopDBInstanceInput) (req *request.Request, output *StopDBInstanceOutput)

StopDBInstanceRequest generates a "aws/request.Request" representing the client's request for the StopDBInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopDBInstance for more information on using the StopDBInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopDBInstanceRequest method.
req, resp := client.StopDBInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBInstance

func (*RDS) StopDBInstanceWithContext added in v1.8.32

func (c *RDS) StopDBInstanceWithContext(ctx aws.Context, input *StopDBInstanceInput, opts ...request.Option) (*StopDBInstanceOutput, error)

StopDBInstanceWithContext is the same as StopDBInstance with the addition of the ability to pass a context and additional request options.

See StopDBInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) SwitchoverReadReplica added in v1.44.83

func (c *RDS) SwitchoverReadReplica(input *SwitchoverReadReplicaInput) (*SwitchoverReadReplicaOutput, error)

SwitchoverReadReplica API operation for Amazon Relational Database Service.

Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database. Issue this command in the Region that hosts the current standby database.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Relational Database Service's API operation SwitchoverReadReplica for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing DB instance.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The DB instance isn't in a valid state.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/SwitchoverReadReplica

func (*RDS) SwitchoverReadReplicaRequest added in v1.44.83

func (c *RDS) SwitchoverReadReplicaRequest(input *SwitchoverReadReplicaInput) (req *request.Request, output *SwitchoverReadReplicaOutput)

SwitchoverReadReplicaRequest generates a "aws/request.Request" representing the client's request for the SwitchoverReadReplica operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SwitchoverReadReplica for more information on using the SwitchoverReadReplica API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SwitchoverReadReplicaRequest method.
req, resp := client.SwitchoverReadReplicaRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/SwitchoverReadReplica

func (*RDS) SwitchoverReadReplicaWithContext added in v1.44.83

func (c *RDS) SwitchoverReadReplicaWithContext(ctx aws.Context, input *SwitchoverReadReplicaInput, opts ...request.Option) (*SwitchoverReadReplicaOutput, error)

SwitchoverReadReplicaWithContext is the same as SwitchoverReadReplica with the addition of the ability to pass a context and additional request options.

See SwitchoverReadReplica for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) WaitUntilDBClusterAvailable added in v1.44.48

func (c *RDS) WaitUntilDBClusterAvailable(input *DescribeDBClustersInput) error

WaitUntilDBClusterAvailable uses the Amazon RDS API operation DescribeDBClusters to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*RDS) WaitUntilDBClusterAvailableWithContext added in v1.44.48

func (c *RDS) WaitUntilDBClusterAvailableWithContext(ctx aws.Context, input *DescribeDBClustersInput, opts ...request.WaiterOption) error

WaitUntilDBClusterAvailableWithContext is an extended version of WaitUntilDBClusterAvailable. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) WaitUntilDBClusterDeleted added in v1.44.48

func (c *RDS) WaitUntilDBClusterDeleted(input *DescribeDBClustersInput) error

WaitUntilDBClusterDeleted uses the Amazon RDS API operation DescribeDBClusters to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*RDS) WaitUntilDBClusterDeletedWithContext added in v1.44.48

func (c *RDS) WaitUntilDBClusterDeletedWithContext(ctx aws.Context, input *DescribeDBClustersInput, opts ...request.WaiterOption) error

WaitUntilDBClusterDeletedWithContext is an extended version of WaitUntilDBClusterDeleted. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) WaitUntilDBClusterSnapshotAvailable added in v1.25.2

func (c *RDS) WaitUntilDBClusterSnapshotAvailable(input *DescribeDBClusterSnapshotsInput) error

WaitUntilDBClusterSnapshotAvailable uses the Amazon RDS API operation DescribeDBClusterSnapshots to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*RDS) WaitUntilDBClusterSnapshotAvailableWithContext added in v1.25.2

func (c *RDS) WaitUntilDBClusterSnapshotAvailableWithContext(ctx aws.Context, input *DescribeDBClusterSnapshotsInput, opts ...request.WaiterOption) error

WaitUntilDBClusterSnapshotAvailableWithContext is an extended version of WaitUntilDBClusterSnapshotAvailable. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) WaitUntilDBClusterSnapshotDeleted added in v1.25.2

func (c *RDS) WaitUntilDBClusterSnapshotDeleted(input *DescribeDBClusterSnapshotsInput) error

WaitUntilDBClusterSnapshotDeleted uses the Amazon RDS API operation DescribeDBClusterSnapshots to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*RDS) WaitUntilDBClusterSnapshotDeletedWithContext added in v1.25.2

func (c *RDS) WaitUntilDBClusterSnapshotDeletedWithContext(ctx aws.Context, input *DescribeDBClusterSnapshotsInput, opts ...request.WaiterOption) error

WaitUntilDBClusterSnapshotDeletedWithContext is an extended version of WaitUntilDBClusterSnapshotDeleted. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) WaitUntilDBInstanceAvailable added in v0.10.3

func (c *RDS) WaitUntilDBInstanceAvailable(input *DescribeDBInstancesInput) error

WaitUntilDBInstanceAvailable uses the Amazon RDS API operation DescribeDBInstances to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*RDS) WaitUntilDBInstanceAvailableWithContext added in v1.8.0

func (c *RDS) WaitUntilDBInstanceAvailableWithContext(ctx aws.Context, input *DescribeDBInstancesInput, opts ...request.WaiterOption) error

WaitUntilDBInstanceAvailableWithContext is an extended version of WaitUntilDBInstanceAvailable. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) WaitUntilDBInstanceDeleted added in v0.10.3

func (c *RDS) WaitUntilDBInstanceDeleted(input *DescribeDBInstancesInput) error

WaitUntilDBInstanceDeleted uses the Amazon RDS API operation DescribeDBInstances to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*RDS) WaitUntilDBInstanceDeletedWithContext added in v1.8.0

func (c *RDS) WaitUntilDBInstanceDeletedWithContext(ctx aws.Context, input *DescribeDBInstancesInput, opts ...request.WaiterOption) error

WaitUntilDBInstanceDeletedWithContext is an extended version of WaitUntilDBInstanceDeleted. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) WaitUntilDBSnapshotAvailable added in v1.12.11

func (c *RDS) WaitUntilDBSnapshotAvailable(input *DescribeDBSnapshotsInput) error

WaitUntilDBSnapshotAvailable uses the Amazon RDS API operation DescribeDBSnapshots to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*RDS) WaitUntilDBSnapshotAvailableWithContext added in v1.12.11

func (c *RDS) WaitUntilDBSnapshotAvailableWithContext(ctx aws.Context, input *DescribeDBSnapshotsInput, opts ...request.WaiterOption) error

WaitUntilDBSnapshotAvailableWithContext is an extended version of WaitUntilDBSnapshotAvailable. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RDS) WaitUntilDBSnapshotDeleted added in v1.12.11

func (c *RDS) WaitUntilDBSnapshotDeleted(input *DescribeDBSnapshotsInput) error

WaitUntilDBSnapshotDeleted uses the Amazon RDS API operation DescribeDBSnapshots to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*RDS) WaitUntilDBSnapshotDeletedWithContext added in v1.12.11

func (c *RDS) WaitUntilDBSnapshotDeletedWithContext(ctx aws.Context, input *DescribeDBSnapshotsInput, opts ...request.WaiterOption) error

WaitUntilDBSnapshotDeletedWithContext is an extended version of WaitUntilDBSnapshotDeleted. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type Range added in v1.12.10

type Range struct {

	// The minimum value in the range.
	From *int64 `type:"integer"`

	// The step value for the range. For example, if you have a range of 5,000 to
	// 10,000, with a step value of 1,000, the valid values start at 5,000 and step
	// up by 1,000. Even though 7,500 is within the range, it isn't a valid value
	// for the range. The valid values are 5,000, 6,000, 7,000, 8,000...
	Step *int64 `type:"integer"`

	// The maximum value in the range.
	To *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A range of integer values.

func (Range) GoString added in v1.12.10

func (s Range) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Range) SetFrom added in v1.12.10

func (s *Range) SetFrom(v int64) *Range

SetFrom sets the From field's value.

func (*Range) SetStep added in v1.12.10

func (s *Range) SetStep(v int64) *Range

SetStep sets the Step field's value.

func (*Range) SetTo added in v1.12.10

func (s *Range) SetTo(v int64) *Range

SetTo sets the To field's value.

func (Range) String added in v1.12.10

func (s Range) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RebootDBClusterInput added in v1.42.11

type RebootDBClusterInput struct {

	// The DB cluster identifier. This parameter is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBCluster.
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RebootDBClusterInput) GoString added in v1.42.11

func (s RebootDBClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebootDBClusterInput) SetDBClusterIdentifier added in v1.42.11

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (RebootDBClusterInput) String added in v1.42.11

func (s RebootDBClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebootDBClusterInput) Validate added in v1.42.11

func (s *RebootDBClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RebootDBClusterOutput added in v1.42.11

type RebootDBClusterOutput struct {

	// Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
	//
	// For an Amazon Aurora DB cluster, this data type is used as a response element
	// in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot,
	// RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
	//
	// For a Multi-AZ DB cluster, this data type is used as a response element in
	// the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
	//
	// For more information on Amazon Aurora DB clusters, see What is Amazon Aurora?
	// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)
	// in the Amazon Aurora User Guide.
	//
	// For more information on Multi-AZ DB clusters, see Multi-AZ deployments with
	// two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
	// in the Amazon RDS User Guide.
	DBCluster *DBCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (RebootDBClusterOutput) GoString added in v1.42.11

func (s RebootDBClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebootDBClusterOutput) SetDBCluster added in v1.42.11

SetDBCluster sets the DBCluster field's value.

func (RebootDBClusterOutput) String added in v1.42.11

func (s RebootDBClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RebootDBInstanceInput

type RebootDBInstanceInput struct {

	// The DB instance identifier. This parameter is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBInstance.
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`

	// A value that indicates whether the reboot is conducted through a Multi-AZ
	// failover.
	//
	// Constraint: You can't enable force failover if the instance isn't configured
	// for Multi-AZ.
	ForceFailover *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (RebootDBInstanceInput) GoString added in v0.6.5

func (s RebootDBInstanceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebootDBInstanceInput) SetDBInstanceIdentifier added in v1.5.0

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*RebootDBInstanceInput) SetForceFailover added in v1.5.0

func (s *RebootDBInstanceInput) SetForceFailover(v bool) *RebootDBInstanceInput

SetForceFailover sets the ForceFailover field's value.

func (RebootDBInstanceInput) String added in v0.6.5

func (s RebootDBInstanceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebootDBInstanceInput) Validate added in v1.1.21

func (s *RebootDBInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RebootDBInstanceOutput

type RebootDBInstanceOutput struct {

	// Contains the details of an Amazon RDS DB instance.
	//
	// This data type is used as a response element in the operations CreateDBInstance,
	// CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance,
	// PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,
	// RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
	DBInstance *DBInstance `type:"structure"`
	// contains filtered or unexported fields
}

func (RebootDBInstanceOutput) GoString added in v0.6.5

func (s RebootDBInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebootDBInstanceOutput) SetDBInstance added in v1.5.0

SetDBInstance sets the DBInstance field's value.

func (RebootDBInstanceOutput) String added in v0.6.5

func (s RebootDBInstanceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RecurringCharge

type RecurringCharge struct {

	// The amount of the recurring charge.
	RecurringChargeAmount *float64 `type:"double"`

	// The frequency of the recurring charge.
	RecurringChargeFrequency *string `type:"string"`
	// contains filtered or unexported fields
}

This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

func (RecurringCharge) GoString added in v0.6.5

func (s RecurringCharge) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecurringCharge) SetRecurringChargeAmount added in v1.5.0

func (s *RecurringCharge) SetRecurringChargeAmount(v float64) *RecurringCharge

SetRecurringChargeAmount sets the RecurringChargeAmount field's value.

func (*RecurringCharge) SetRecurringChargeFrequency added in v1.5.0

func (s *RecurringCharge) SetRecurringChargeFrequency(v string) *RecurringCharge

SetRecurringChargeFrequency sets the RecurringChargeFrequency field's value.

func (RecurringCharge) String added in v0.6.5

func (s RecurringCharge) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RegisterDBProxyTargetsInput added in v1.25.47

type RegisterDBProxyTargetsInput struct {

	// One or more DB cluster identifiers.
	DBClusterIdentifiers []*string `type:"list"`

	// One or more DB instance identifiers.
	DBInstanceIdentifiers []*string `type:"list"`

	// The identifier of the DBProxy that is associated with the DBProxyTargetGroup.
	//
	// DBProxyName is a required field
	DBProxyName *string `type:"string" required:"true"`

	// The identifier of the DBProxyTargetGroup.
	TargetGroupName *string `type:"string"`
	// contains filtered or unexported fields
}

func (RegisterDBProxyTargetsInput) GoString added in v1.25.47

func (s RegisterDBProxyTargetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterDBProxyTargetsInput) SetDBClusterIdentifiers added in v1.25.47

func (s *RegisterDBProxyTargetsInput) SetDBClusterIdentifiers(v []*string) *RegisterDBProxyTargetsInput

SetDBClusterIdentifiers sets the DBClusterIdentifiers field's value.

func (*RegisterDBProxyTargetsInput) SetDBInstanceIdentifiers added in v1.25.47

func (s *RegisterDBProxyTargetsInput) SetDBInstanceIdentifiers(v []*string) *RegisterDBProxyTargetsInput

SetDBInstanceIdentifiers sets the DBInstanceIdentifiers field's value.

func (*RegisterDBProxyTargetsInput) SetDBProxyName added in v1.25.47

SetDBProxyName sets the DBProxyName field's value.

func (*RegisterDBProxyTargetsInput) SetTargetGroupName added in v1.25.47

SetTargetGroupName sets the TargetGroupName field's value.

func (RegisterDBProxyTargetsInput) String added in v1.25.47

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterDBProxyTargetsInput) Validate added in v1.25.47

func (s *RegisterDBProxyTargetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterDBProxyTargetsOutput added in v1.25.47

type RegisterDBProxyTargetsOutput struct {

	// One or more DBProxyTarget objects that are created when you register targets
	// with a target group.
	DBProxyTargets []*DBProxyTarget `type:"list"`
	// contains filtered or unexported fields
}

func (RegisterDBProxyTargetsOutput) GoString added in v1.25.47

func (s RegisterDBProxyTargetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterDBProxyTargetsOutput) SetDBProxyTargets added in v1.25.47

SetDBProxyTargets sets the DBProxyTargets field's value.

func (RegisterDBProxyTargetsOutput) String added in v1.25.47

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RemoveFromGlobalClusterInput added in v1.15.85

type RemoveFromGlobalClusterInput struct {

	// The Amazon Resource Name (ARN) identifying the cluster that was detached
	// from the Aurora global database cluster.
	DbClusterIdentifier *string `type:"string"`

	// The cluster identifier to detach from the Aurora global database cluster.
	GlobalClusterIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

func (RemoveFromGlobalClusterInput) GoString added in v1.15.85

func (s RemoveFromGlobalClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveFromGlobalClusterInput) SetDbClusterIdentifier added in v1.15.85

SetDbClusterIdentifier sets the DbClusterIdentifier field's value.

func (*RemoveFromGlobalClusterInput) SetGlobalClusterIdentifier added in v1.15.85

func (s *RemoveFromGlobalClusterInput) SetGlobalClusterIdentifier(v string) *RemoveFromGlobalClusterInput

SetGlobalClusterIdentifier sets the GlobalClusterIdentifier field's value.

func (RemoveFromGlobalClusterInput) String added in v1.15.85

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RemoveFromGlobalClusterOutput added in v1.15.85

type RemoveFromGlobalClusterOutput struct {

	// A data type representing an Aurora global database.
	GlobalCluster *GlobalCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (RemoveFromGlobalClusterOutput) GoString added in v1.15.85

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveFromGlobalClusterOutput) SetGlobalCluster added in v1.15.85

SetGlobalCluster sets the GlobalCluster field's value.

func (RemoveFromGlobalClusterOutput) String added in v1.15.85

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RemoveRoleFromDBClusterInput added in v1.4.19

type RemoveRoleFromDBClusterInput struct {

	// The name of the DB cluster to disassociate the IAM role from.
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The name of the feature for the DB cluster that the IAM role is to be disassociated
	// from. For information about supported feature names, see DBEngineVersion.
	FeatureName *string `type:"string"`

	// The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora
	// DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveRoleFromDBClusterInput) GoString added in v1.4.19

func (s RemoveRoleFromDBClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveRoleFromDBClusterInput) SetDBClusterIdentifier added in v1.5.0

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*RemoveRoleFromDBClusterInput) SetFeatureName added in v1.19.16

SetFeatureName sets the FeatureName field's value.

func (*RemoveRoleFromDBClusterInput) SetRoleArn added in v1.5.0

SetRoleArn sets the RoleArn field's value.

func (RemoveRoleFromDBClusterInput) String added in v1.4.19

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveRoleFromDBClusterInput) Validate added in v1.4.19

func (s *RemoveRoleFromDBClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveRoleFromDBClusterOutput added in v1.4.19

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

func (RemoveRoleFromDBClusterOutput) GoString added in v1.4.19

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (RemoveRoleFromDBClusterOutput) String added in v1.4.19

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RemoveRoleFromDBInstanceInput added in v1.16.25

type RemoveRoleFromDBInstanceInput struct {

	// The name of the DB instance to disassociate the IAM role from.
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`

	// The name of the feature for the DB instance that the IAM role is to be disassociated
	// from. For information about supported feature names, see DBEngineVersion.
	//
	// FeatureName is a required field
	FeatureName *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB
	// instance, for example, arn:aws:iam::123456789012:role/AccessRole.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveRoleFromDBInstanceInput) GoString added in v1.16.25

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveRoleFromDBInstanceInput) SetDBInstanceIdentifier added in v1.16.25

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*RemoveRoleFromDBInstanceInput) SetFeatureName added in v1.16.25

SetFeatureName sets the FeatureName field's value.

func (*RemoveRoleFromDBInstanceInput) SetRoleArn added in v1.16.25

SetRoleArn sets the RoleArn field's value.

func (RemoveRoleFromDBInstanceInput) String added in v1.16.25

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveRoleFromDBInstanceInput) Validate added in v1.16.25

func (s *RemoveRoleFromDBInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveRoleFromDBInstanceOutput added in v1.16.25

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

func (RemoveRoleFromDBInstanceOutput) GoString added in v1.16.25

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (RemoveRoleFromDBInstanceOutput) String added in v1.16.25

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RemoveSourceIdentifierFromSubscriptionInput

type RemoveSourceIdentifierFromSubscriptionInput struct {

	// The source identifier to be removed from the subscription, such as the DB
	// instance identifier for a DB instance or the name of a security group.
	//
	// SourceIdentifier is a required field
	SourceIdentifier *string `type:"string" required:"true"`

	// The name of the RDS event notification subscription you want to remove a
	// source identifier from.
	//
	// SubscriptionName is a required field
	SubscriptionName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveSourceIdentifierFromSubscriptionInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveSourceIdentifierFromSubscriptionInput) SetSourceIdentifier added in v1.5.0

SetSourceIdentifier sets the SourceIdentifier field's value.

func (*RemoveSourceIdentifierFromSubscriptionInput) SetSubscriptionName added in v1.5.0

SetSubscriptionName sets the SubscriptionName field's value.

func (RemoveSourceIdentifierFromSubscriptionInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveSourceIdentifierFromSubscriptionInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type RemoveSourceIdentifierFromSubscriptionOutput

type RemoveSourceIdentifierFromSubscriptionOutput struct {

	// Contains the results of a successful invocation of the DescribeEventSubscriptions
	// action.
	EventSubscription *EventSubscription `type:"structure"`
	// contains filtered or unexported fields
}

func (RemoveSourceIdentifierFromSubscriptionOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveSourceIdentifierFromSubscriptionOutput) SetEventSubscription added in v1.5.0

SetEventSubscription sets the EventSubscription field's value.

func (RemoveSourceIdentifierFromSubscriptionOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RemoveTagsFromResourceInput

type RemoveTagsFromResourceInput struct {

	// The Amazon RDS resource that the tags are removed from. This value is an
	// Amazon Resource Name (ARN). For information about creating an ARN, see Constructing
	// an ARN for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing)
	// in the Amazon RDS User Guide.
	//
	// ResourceName is a required field
	ResourceName *string `type:"string" required:"true"`

	// The tag key (name) of the tag to be removed.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveTagsFromResourceInput) GoString added in v0.6.5

func (s RemoveTagsFromResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveTagsFromResourceInput) SetResourceName added in v1.5.0

SetResourceName sets the ResourceName field's value.

func (*RemoveTagsFromResourceInput) SetTagKeys added in v1.5.0

SetTagKeys sets the TagKeys field's value.

func (RemoveTagsFromResourceInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveTagsFromResourceInput) Validate added in v1.1.21

func (s *RemoveTagsFromResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveTagsFromResourceOutput

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

func (RemoveTagsFromResourceOutput) GoString added in v0.6.5

func (s RemoveTagsFromResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (RemoveTagsFromResourceOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ReservedDBInstance

type ReservedDBInstance struct {

	// The currency code for the reserved DB instance.
	CurrencyCode *string `type:"string"`

	// The DB instance class for the reserved DB instance.
	DBInstanceClass *string `type:"string"`

	// The number of reserved DB instances.
	DBInstanceCount *int64 `type:"integer"`

	// The duration of the reservation in seconds.
	Duration *int64 `type:"integer"`

	// The fixed price charged for this reserved DB instance.
	FixedPrice *float64 `type:"double"`

	// The unique identifier for the lease associated with the reserved DB instance.
	//
	// Amazon Web Services Support might request the lease ID for an issue related
	// to a reserved DB instance.
	LeaseId *string `type:"string"`

	// Indicates if the reservation applies to Multi-AZ deployments.
	MultiAZ *bool `type:"boolean"`

	// The offering type of this reserved DB instance.
	OfferingType *string `type:"string"`

	// The description of the reserved DB instance.
	ProductDescription *string `type:"string"`

	// The recurring price charged to run this reserved DB instance.
	RecurringCharges []*RecurringCharge `locationNameList:"RecurringCharge" type:"list"`

	// The Amazon Resource Name (ARN) for the reserved DB instance.
	ReservedDBInstanceArn *string `type:"string"`

	// The unique identifier for the reservation.
	ReservedDBInstanceId *string `type:"string"`

	// The offering identifier.
	ReservedDBInstancesOfferingId *string `type:"string"`

	// The time the reservation started.
	StartTime *time.Time `type:"timestamp"`

	// The state of the reserved DB instance.
	State *string `type:"string"`

	// The hourly price charged for this reserved DB instance.
	UsagePrice *float64 `type:"double"`
	// contains filtered or unexported fields
}

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

func (ReservedDBInstance) GoString added in v0.6.5

func (s ReservedDBInstance) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReservedDBInstance) SetCurrencyCode added in v1.5.0

func (s *ReservedDBInstance) SetCurrencyCode(v string) *ReservedDBInstance

SetCurrencyCode sets the CurrencyCode field's value.

func (*ReservedDBInstance) SetDBInstanceClass added in v1.5.0

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

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*ReservedDBInstance) SetDBInstanceCount added in v1.5.0

func (s *ReservedDBInstance) SetDBInstanceCount(v int64) *ReservedDBInstance

SetDBInstanceCount sets the DBInstanceCount field's value.

func (*ReservedDBInstance) SetDuration added in v1.5.0

func (s *ReservedDBInstance) SetDuration(v int64) *ReservedDBInstance

SetDuration sets the Duration field's value.

func (*ReservedDBInstance) SetFixedPrice added in v1.5.0

func (s *ReservedDBInstance) SetFixedPrice(v float64) *ReservedDBInstance

SetFixedPrice sets the FixedPrice field's value.

func (*ReservedDBInstance) SetLeaseId added in v1.24.3

func (s *ReservedDBInstance) SetLeaseId(v string) *ReservedDBInstance

SetLeaseId sets the LeaseId field's value.

func (*ReservedDBInstance) SetMultiAZ added in v1.5.0

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

SetMultiAZ sets the MultiAZ field's value.

func (*ReservedDBInstance) SetOfferingType added in v1.5.0

func (s *ReservedDBInstance) SetOfferingType(v string) *ReservedDBInstance

SetOfferingType sets the OfferingType field's value.

func (*ReservedDBInstance) SetProductDescription added in v1.5.0

func (s *ReservedDBInstance) SetProductDescription(v string) *ReservedDBInstance

SetProductDescription sets the ProductDescription field's value.

func (*ReservedDBInstance) SetRecurringCharges added in v1.5.0

func (s *ReservedDBInstance) SetRecurringCharges(v []*RecurringCharge) *ReservedDBInstance

SetRecurringCharges sets the RecurringCharges field's value.

func (*ReservedDBInstance) SetReservedDBInstanceArn added in v1.5.0

func (s *ReservedDBInstance) SetReservedDBInstanceArn(v string) *ReservedDBInstance

SetReservedDBInstanceArn sets the ReservedDBInstanceArn field's value.

func (*ReservedDBInstance) SetReservedDBInstanceId added in v1.5.0

func (s *ReservedDBInstance) SetReservedDBInstanceId(v string) *ReservedDBInstance

SetReservedDBInstanceId sets the ReservedDBInstanceId field's value.

func (*ReservedDBInstance) SetReservedDBInstancesOfferingId added in v1.5.0

func (s *ReservedDBInstance) SetReservedDBInstancesOfferingId(v string) *ReservedDBInstance

SetReservedDBInstancesOfferingId sets the ReservedDBInstancesOfferingId field's value.

func (*ReservedDBInstance) SetStartTime added in v1.5.0

func (s *ReservedDBInstance) SetStartTime(v time.Time) *ReservedDBInstance

SetStartTime sets the StartTime field's value.

func (*ReservedDBInstance) SetState added in v1.5.0

SetState sets the State field's value.

func (*ReservedDBInstance) SetUsagePrice added in v1.5.0

func (s *ReservedDBInstance) SetUsagePrice(v float64) *ReservedDBInstance

SetUsagePrice sets the UsagePrice field's value.

func (ReservedDBInstance) String added in v0.6.5

func (s ReservedDBInstance) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ReservedDBInstancesOffering

type ReservedDBInstancesOffering struct {

	// The currency code for the reserved DB instance offering.
	CurrencyCode *string `type:"string"`

	// The DB instance class for the reserved DB instance.
	DBInstanceClass *string `type:"string"`

	// The duration of the offering in seconds.
	Duration *int64 `type:"integer"`

	// The fixed price charged for this offering.
	FixedPrice *float64 `type:"double"`

	// Indicates if the offering applies to Multi-AZ deployments.
	MultiAZ *bool `type:"boolean"`

	// The offering type.
	OfferingType *string `type:"string"`

	// The database engine used by the offering.
	ProductDescription *string `type:"string"`

	// The recurring price charged to run this reserved DB instance.
	RecurringCharges []*RecurringCharge `locationNameList:"RecurringCharge" type:"list"`

	// The offering identifier.
	ReservedDBInstancesOfferingId *string `type:"string"`

	// The hourly price charged for this offering.
	UsagePrice *float64 `type:"double"`
	// contains filtered or unexported fields
}

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

func (ReservedDBInstancesOffering) GoString added in v0.6.5

func (s ReservedDBInstancesOffering) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReservedDBInstancesOffering) SetCurrencyCode added in v1.5.0

SetCurrencyCode sets the CurrencyCode field's value.

func (*ReservedDBInstancesOffering) SetDBInstanceClass added in v1.5.0

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*ReservedDBInstancesOffering) SetDuration added in v1.5.0

SetDuration sets the Duration field's value.

func (*ReservedDBInstancesOffering) SetFixedPrice added in v1.5.0

SetFixedPrice sets the FixedPrice field's value.

func (*ReservedDBInstancesOffering) SetMultiAZ added in v1.5.0

SetMultiAZ sets the MultiAZ field's value.

func (*ReservedDBInstancesOffering) SetOfferingType added in v1.5.0

SetOfferingType sets the OfferingType field's value.

func (*ReservedDBInstancesOffering) SetProductDescription added in v1.5.0

func (s *ReservedDBInstancesOffering) SetProductDescription(v string) *ReservedDBInstancesOffering

SetProductDescription sets the ProductDescription field's value.

func (*ReservedDBInstancesOffering) SetRecurringCharges added in v1.5.0

SetRecurringCharges sets the RecurringCharges field's value.

func (*ReservedDBInstancesOffering) SetReservedDBInstancesOfferingId added in v1.5.0

func (s *ReservedDBInstancesOffering) SetReservedDBInstancesOfferingId(v string) *ReservedDBInstancesOffering

SetReservedDBInstancesOfferingId sets the ReservedDBInstancesOfferingId field's value.

func (*ReservedDBInstancesOffering) SetUsagePrice added in v1.5.0

SetUsagePrice sets the UsagePrice field's value.

func (ReservedDBInstancesOffering) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResetDBClusterParameterGroupInput added in v0.7.1

type ResetDBClusterParameterGroupInput struct {

	// The name of the DB cluster parameter group to reset.
	//
	// DBClusterParameterGroupName is a required field
	DBClusterParameterGroupName *string `type:"string" required:"true"`

	// A list of parameter names in the DB cluster parameter group to reset to the
	// default values. You can't use this parameter if the ResetAllParameters parameter
	// is enabled.
	Parameters []*Parameter `locationNameList:"Parameter" type:"list"`

	// A value that indicates whether to reset all parameters in the DB cluster
	// parameter group to their default values. You can't use this parameter if
	// there is a list of parameter names specified for the Parameters parameter.
	ResetAllParameters *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (ResetDBClusterParameterGroupInput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResetDBClusterParameterGroupInput) SetDBClusterParameterGroupName added in v1.5.0

func (s *ResetDBClusterParameterGroupInput) SetDBClusterParameterGroupName(v string) *ResetDBClusterParameterGroupInput

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*ResetDBClusterParameterGroupInput) SetParameters added in v1.5.0

SetParameters sets the Parameters field's value.

func (*ResetDBClusterParameterGroupInput) SetResetAllParameters added in v1.5.0

SetResetAllParameters sets the ResetAllParameters field's value.

func (ResetDBClusterParameterGroupInput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResetDBClusterParameterGroupInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type ResetDBParameterGroupInput

type ResetDBParameterGroupInput struct {

	// The name of the DB parameter group.
	//
	// Constraints:
	//
	//    * Must match the name of an existing DBParameterGroup.
	//
	// DBParameterGroupName is a required field
	DBParameterGroupName *string `type:"string" required:"true"`

	// To reset the entire DB parameter group, specify the DBParameterGroup name
	// and ResetAllParameters parameters. To reset specific parameters, provide
	// a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters
	// can be modified in a single request.
	//
	// MySQL
	//
	// Valid Values (for Apply method): immediate | pending-reboot
	//
	// You can use the immediate value with dynamic parameters only. You can use
	// the pending-reboot value for both dynamic and static parameters, and changes
	// are applied when DB instance reboots.
	//
	// MariaDB
	//
	// Valid Values (for Apply method): immediate | pending-reboot
	//
	// You can use the immediate value with dynamic parameters only. You can use
	// the pending-reboot value for both dynamic and static parameters, and changes
	// are applied when DB instance reboots.
	//
	// Oracle
	//
	// Valid Values (for Apply method): pending-reboot
	Parameters []*Parameter `locationNameList:"Parameter" type:"list"`

	// A value that indicates whether to reset all parameters in the DB parameter
	// group to default values. By default, all parameters in the DB parameter group
	// are reset to default values.
	ResetAllParameters *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (ResetDBParameterGroupInput) GoString added in v0.6.5

func (s ResetDBParameterGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResetDBParameterGroupInput) SetDBParameterGroupName added in v1.5.0

func (s *ResetDBParameterGroupInput) SetDBParameterGroupName(v string) *ResetDBParameterGroupInput

SetDBParameterGroupName sets the DBParameterGroupName field's value.

func (*ResetDBParameterGroupInput) SetParameters added in v1.5.0

SetParameters sets the Parameters field's value.

func (*ResetDBParameterGroupInput) SetResetAllParameters added in v1.5.0

func (s *ResetDBParameterGroupInput) SetResetAllParameters(v bool) *ResetDBParameterGroupInput

SetResetAllParameters sets the ResetAllParameters field's value.

func (ResetDBParameterGroupInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResetDBParameterGroupInput) Validate added in v1.1.21

func (s *ResetDBParameterGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourcePendingMaintenanceActions

type ResourcePendingMaintenanceActions struct {

	// A list that provides details about the pending maintenance actions for the
	// resource.
	PendingMaintenanceActionDetails []*PendingMaintenanceAction `locationNameList:"PendingMaintenanceAction" type:"list"`

	// The ARN of the resource that has pending maintenance actions.
	ResourceIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the pending maintenance actions for a resource.

func (ResourcePendingMaintenanceActions) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourcePendingMaintenanceActions) SetPendingMaintenanceActionDetails added in v1.5.0

SetPendingMaintenanceActionDetails sets the PendingMaintenanceActionDetails field's value.

func (*ResourcePendingMaintenanceActions) SetResourceIdentifier added in v1.5.0

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (ResourcePendingMaintenanceActions) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RestoreDBClusterFromS3Input added in v1.3.1

type RestoreDBClusterFromS3Input struct {

	// A list of Availability Zones (AZs) where instances in the restored DB cluster
	// can be created.
	AvailabilityZones []*string `locationNameList:"AvailabilityZone" type:"list"`

	// The target backtrack window, in seconds. To disable backtracking, set this
	// value to 0.
	//
	// Currently, Backtrack is only supported for Aurora MySQL DB clusters.
	//
	// Default: 0
	//
	// Constraints:
	//
	//    * If specified, this value must be set to a number from 0 to 259,200 (72
	//    hours).
	BacktrackWindow *int64 `type:"long"`

	// The number of days for which automated backups of the restored DB cluster
	// are retained. You must specify a minimum value of 1.
	//
	// Default: 1
	//
	// Constraints:
	//
	//    * Must be a value from 1 to 35
	BackupRetentionPeriod *int64 `type:"integer"`

	// A value that indicates that the restored DB cluster should be associated
	// with the specified CharacterSet.
	CharacterSetName *string `type:"string"`

	// A value that indicates whether to copy all tags from the restored DB cluster
	// to snapshots of the restored DB cluster. The default is not to copy them.
	CopyTagsToSnapshot *bool `type:"boolean"`

	// The name of the DB cluster to create from the source data in the Amazon S3
	// bucket. This parameter isn't case-sensitive.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 letters, numbers, or hyphens.
	//
	//    * First character must be a letter.
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens.
	//
	// Example: my-cluster1
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The name of the DB cluster parameter group to associate with the restored
	// DB cluster. If this argument is omitted, default.aurora5.6 is used.
	//
	// Constraints:
	//
	//    * If supplied, must match the name of an existing DBClusterParameterGroup.
	DBClusterParameterGroupName *string `type:"string"`

	// A DB subnet group to associate with the restored DB cluster.
	//
	// Constraints: If supplied, must match the name of an existing DBSubnetGroup.
	//
	// Example: mydbsubnetgroup
	DBSubnetGroupName *string `type:"string"`

	// The database name for the restored DB cluster.
	DatabaseName *string `type:"string"`

	// A value that indicates whether the DB cluster has deletion protection enabled.
	// The database can't be deleted when deletion protection is enabled. By default,
	// deletion protection isn't enabled.
	DeletionProtection *bool `type:"boolean"`

	// Specify the Active Directory directory ID to restore the DB cluster in. The
	// domain must be created prior to this operation.
	//
	// For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication
	// to authenticate users that connect to the DB cluster. For more information,
	// see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html)
	// in the Amazon Aurora User Guide.
	Domain *string `type:"string"`

	// Specify the name of the IAM role to be used when making API calls to the
	// Directory Service.
	DomainIAMRoleName *string `type:"string"`

	// The list of logs that the restored DB cluster is to export to CloudWatch
	// Logs. The values in the list depend on the DB engine being used.
	//
	// Aurora MySQL
	//
	// Possible values are audit, error, general, and slowquery.
	//
	// Aurora PostgreSQL
	//
	// Possible value is postgresql.
	//
	// For more information about exporting CloudWatch Logs for Amazon Aurora, see
	// Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
	// in the Amazon Aurora User Guide.
	EnableCloudwatchLogsExports []*string `type:"list"`

	// A value that indicates whether to enable mapping of Amazon Web Services Identity
	// and Access Management (IAM) accounts to database accounts. By default, mapping
	// isn't enabled.
	//
	// For more information, see IAM Database Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html)
	// in the Amazon Aurora User Guide.
	EnableIAMDatabaseAuthentication *bool `type:"boolean"`

	// The name of the database engine to be used for this DB cluster.
	//
	// Valid Values: aurora (for MySQL 5.6-compatible Aurora) and aurora-mysql (for
	// MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
	//
	// Engine is a required field
	Engine *string `type:"string" required:"true"`

	// The version number of the database engine to use.
	//
	// To list all of the available engine versions for aurora (for MySQL 5.6-compatible
	// Aurora), use the following command:
	//
	// aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
	//
	// To list all of the available engine versions for aurora-mysql (for MySQL
	// 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:
	//
	// aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
	//
	// Aurora MySQL
	//
	// Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.mysql_aurora.2.07.1, 8.0.mysql_aurora.3.02.0
	EngineVersion *string `type:"string"`

	// The Amazon Web Services KMS key identifier for an encrypted DB cluster.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key. To use a KMS key in a different Amazon
	// Web Services account, specify the key ARN or alias ARN.
	//
	// If the StorageEncrypted parameter is enabled, and you do not specify a value
	// for the KmsKeyId parameter, then Amazon RDS will use your default KMS key.
	// There is a default KMS key for your Amazon Web Services account. Your Amazon
	// Web Services account has a different default KMS key for each Amazon Web
	// Services Region.
	KmsKeyId *string `type:"string"`

	// The password for the master database user. This password can contain any
	// printable ASCII character except "/", """, or "@".
	//
	// Constraints: Must contain from 8 to 41 characters.
	//
	// MasterUserPassword is a required field
	MasterUserPassword *string `type:"string" required:"true"`

	// The name of the master user for the restored DB cluster.
	//
	// Constraints:
	//
	//    * Must be 1 to 16 letters or numbers.
	//
	//    * First character must be a letter.
	//
	//    * Can't be a reserved word for the chosen database engine.
	//
	// MasterUsername is a required field
	MasterUsername *string `type:"string" required:"true"`

	// The network type of the DB cluster.
	//
	// Valid values:
	//
	//    * IPV4
	//
	//    * DUAL
	//
	// The network type is determined by the DBSubnetGroup specified for the DB
	// cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and
	// the IPv6 protocols (DUAL).
	//
	// For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
	// in the Amazon Aurora User Guide.
	NetworkType *string `type:"string"`

	// A value that indicates that the restored DB cluster should be associated
	// with the specified option group.
	//
	// Permanent options can't be removed from an option group. An option group
	// can't be removed from a DB cluster once it is associated with a DB cluster.
	OptionGroupName *string `type:"string"`

	// The port number on which the instances in the restored DB cluster accept
	// connections.
	//
	// Default: 3306
	Port *int64 `type:"integer"`

	// The daily time range during which automated backups are created if automated
	// backups are enabled using the BackupRetentionPeriod parameter.
	//
	// The default is a 30-minute window selected at random from an 8-hour block
	// of time for each Amazon Web Services Region. To view the time blocks available,
	// see Backup window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow)
	// in the Amazon Aurora User Guide.
	//
	// Constraints:
	//
	//    * Must be in the format hh24:mi-hh24:mi.
	//
	//    * Must be in Universal Coordinated Time (UTC).
	//
	//    * Must not conflict with the preferred maintenance window.
	//
	//    * Must be at least 30 minutes.
	PreferredBackupWindow *string `type:"string"`

	// The weekly time range during which system maintenance can occur, in Universal
	// Coordinated Time (UTC).
	//
	// Format: ddd:hh24:mi-ddd:hh24:mi
	//
	// The default is a 30-minute window selected at random from an 8-hour block
	// of time for each Amazon Web Services Region, occurring on a random day of
	// the week. To see the time blocks available, see Adjusting the Preferred Maintenance
	// Window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora)
	// in the Amazon Aurora User Guide.
	//
	// Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
	//
	// Constraints: Minimum 30-minute window.
	PreferredMaintenanceWindow *string `type:"string"`

	// The name of the Amazon S3 bucket that contains the data used to create the
	// Amazon Aurora DB cluster.
	//
	// S3BucketName is a required field
	S3BucketName *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access
	// Management (IAM) role that authorizes Amazon RDS to access the Amazon S3
	// bucket on your behalf.
	//
	// S3IngestionRoleArn is a required field
	S3IngestionRoleArn *string `type:"string" required:"true"`

	// The prefix for all of the file names that contain the data used to create
	// the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value,
	// then the Amazon Aurora DB cluster is created by using all of the files in
	// the Amazon S3 bucket.
	S3Prefix *string `type:"string"`

	// Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
	//
	// For more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html)
	// in the Amazon Aurora User Guide.
	ServerlessV2ScalingConfiguration *ServerlessV2ScalingConfiguration `type:"structure"`

	// The identifier for the database engine that was backed up to create the files
	// stored in the Amazon S3 bucket.
	//
	// Valid values: mysql
	//
	// SourceEngine is a required field
	SourceEngine *string `type:"string" required:"true"`

	// The version of the database that the backup files were created from.
	//
	// MySQL versions 5.5, 5.6, and 5.7 are supported.
	//
	// Example: 5.6.40, 5.7.28
	//
	// SourceEngineVersion is a required field
	SourceEngineVersion *string `type:"string" required:"true"`

	// A value that indicates whether the restored DB cluster is encrypted.
	StorageEncrypted *bool `type:"boolean"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// A list of EC2 VPC security groups to associate with the restored DB cluster.
	VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"`
	// contains filtered or unexported fields
}

func (RestoreDBClusterFromS3Input) GoString added in v1.3.1

func (s RestoreDBClusterFromS3Input) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDBClusterFromS3Input) SetAvailabilityZones added in v1.5.0

func (s *RestoreDBClusterFromS3Input) SetAvailabilityZones(v []*string) *RestoreDBClusterFromS3Input

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*RestoreDBClusterFromS3Input) SetBacktrackWindow added in v1.13.45

SetBacktrackWindow sets the BacktrackWindow field's value.

func (*RestoreDBClusterFromS3Input) SetBackupRetentionPeriod added in v1.5.0

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*RestoreDBClusterFromS3Input) SetCharacterSetName added in v1.5.0

SetCharacterSetName sets the CharacterSetName field's value.

func (*RestoreDBClusterFromS3Input) SetCopyTagsToSnapshot added in v1.17.13

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

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*RestoreDBClusterFromS3Input) SetDBClusterIdentifier added in v1.5.0

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*RestoreDBClusterFromS3Input) SetDBClusterParameterGroupName added in v1.5.0

func (s *RestoreDBClusterFromS3Input) SetDBClusterParameterGroupName(v string) *RestoreDBClusterFromS3Input

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*RestoreDBClusterFromS3Input) SetDBSubnetGroupName added in v1.5.0

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*RestoreDBClusterFromS3Input) SetDatabaseName added in v1.5.0

SetDatabaseName sets the DatabaseName field's value.

func (*RestoreDBClusterFromS3Input) SetDeletionProtection added in v1.15.43

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

SetDeletionProtection sets the DeletionProtection field's value.

func (*RestoreDBClusterFromS3Input) SetDomain added in v1.29.5

SetDomain sets the Domain field's value.

func (*RestoreDBClusterFromS3Input) SetDomainIAMRoleName added in v1.29.5

SetDomainIAMRoleName sets the DomainIAMRoleName field's value.

func (*RestoreDBClusterFromS3Input) SetEnableCloudwatchLogsExports added in v1.13.55

func (s *RestoreDBClusterFromS3Input) SetEnableCloudwatchLogsExports(v []*string) *RestoreDBClusterFromS3Input

SetEnableCloudwatchLogsExports sets the EnableCloudwatchLogsExports field's value.

func (*RestoreDBClusterFromS3Input) SetEnableIAMDatabaseAuthentication added in v1.8.17

func (s *RestoreDBClusterFromS3Input) SetEnableIAMDatabaseAuthentication(v bool) *RestoreDBClusterFromS3Input

SetEnableIAMDatabaseAuthentication sets the EnableIAMDatabaseAuthentication field's value.

func (*RestoreDBClusterFromS3Input) SetEngine added in v1.5.0

SetEngine sets the Engine field's value.

func (*RestoreDBClusterFromS3Input) SetEngineVersion added in v1.5.0

SetEngineVersion sets the EngineVersion field's value.

func (*RestoreDBClusterFromS3Input) SetKmsKeyId added in v1.5.0

SetKmsKeyId sets the KmsKeyId field's value.

func (*RestoreDBClusterFromS3Input) SetMasterUserPassword added in v1.5.0

func (s *RestoreDBClusterFromS3Input) SetMasterUserPassword(v string) *RestoreDBClusterFromS3Input

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*RestoreDBClusterFromS3Input) SetMasterUsername added in v1.5.0

SetMasterUsername sets the MasterUsername field's value.

func (*RestoreDBClusterFromS3Input) SetNetworkType added in v1.44.79

SetNetworkType sets the NetworkType field's value.

func (*RestoreDBClusterFromS3Input) SetOptionGroupName added in v1.5.0

SetOptionGroupName sets the OptionGroupName field's value.

func (*RestoreDBClusterFromS3Input) SetPort added in v1.5.0

SetPort sets the Port field's value.

func (*RestoreDBClusterFromS3Input) SetPreferredBackupWindow added in v1.5.0

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*RestoreDBClusterFromS3Input) SetPreferredMaintenanceWindow added in v1.5.0

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*RestoreDBClusterFromS3Input) SetS3BucketName added in v1.5.0

SetS3BucketName sets the S3BucketName field's value.

func (*RestoreDBClusterFromS3Input) SetS3IngestionRoleArn added in v1.5.0

func (s *RestoreDBClusterFromS3Input) SetS3IngestionRoleArn(v string) *RestoreDBClusterFromS3Input

SetS3IngestionRoleArn sets the S3IngestionRoleArn field's value.

func (*RestoreDBClusterFromS3Input) SetS3Prefix added in v1.5.0

SetS3Prefix sets the S3Prefix field's value.

func (*RestoreDBClusterFromS3Input) SetServerlessV2ScalingConfiguration added in v1.43.43

SetServerlessV2ScalingConfiguration sets the ServerlessV2ScalingConfiguration field's value.

func (*RestoreDBClusterFromS3Input) SetSourceEngine added in v1.5.0

SetSourceEngine sets the SourceEngine field's value.

func (*RestoreDBClusterFromS3Input) SetSourceEngineVersion added in v1.5.0

func (s *RestoreDBClusterFromS3Input) SetSourceEngineVersion(v string) *RestoreDBClusterFromS3Input

SetSourceEngineVersion sets the SourceEngineVersion field's value.

func (*RestoreDBClusterFromS3Input) SetStorageEncrypted added in v1.5.0

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*RestoreDBClusterFromS3Input) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (*RestoreDBClusterFromS3Input) SetVpcSecurityGroupIds added in v1.5.0

func (s *RestoreDBClusterFromS3Input) SetVpcSecurityGroupIds(v []*string) *RestoreDBClusterFromS3Input

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (RestoreDBClusterFromS3Input) String added in v1.3.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDBClusterFromS3Input) Validate added in v1.3.1

func (s *RestoreDBClusterFromS3Input) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RestoreDBClusterFromS3Output added in v1.3.1

type RestoreDBClusterFromS3Output struct {

	// Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
	//
	// For an Amazon Aurora DB cluster, this data type is used as a response element
	// in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot,
	// RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
	//
	// For a Multi-AZ DB cluster, this data type is used as a response element in
	// the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
	//
	// For more information on Amazon Aurora DB clusters, see What is Amazon Aurora?
	// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)
	// in the Amazon Aurora User Guide.
	//
	// For more information on Multi-AZ DB clusters, see Multi-AZ deployments with
	// two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
	// in the Amazon RDS User Guide.
	DBCluster *DBCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (RestoreDBClusterFromS3Output) GoString added in v1.3.1

func (s RestoreDBClusterFromS3Output) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDBClusterFromS3Output) SetDBCluster added in v1.5.0

SetDBCluster sets the DBCluster field's value.

func (RestoreDBClusterFromS3Output) String added in v1.3.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RestoreDBClusterFromSnapshotInput added in v0.7.1

type RestoreDBClusterFromSnapshotInput struct {

	// Provides the list of Availability Zones (AZs) where instances in the restored
	// DB cluster can be created.
	//
	// Valid for: Aurora DB clusters only
	AvailabilityZones []*string `locationNameList:"AvailabilityZone" type:"list"`

	// The target backtrack window, in seconds. To disable backtracking, set this
	// value to 0.
	//
	// Currently, Backtrack is only supported for Aurora MySQL DB clusters.
	//
	// Default: 0
	//
	// Constraints:
	//
	//    * If specified, this value must be set to a number from 0 to 259,200 (72
	//    hours).
	//
	// Valid for: Aurora DB clusters only
	BacktrackWindow *int64 `type:"long"`

	// A value that indicates whether to copy all tags from the restored DB cluster
	// to snapshots of the restored DB cluster. The default is not to copy them.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	CopyTagsToSnapshot *bool `type:"boolean"`

	// The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.
	// This parameter isn't case-sensitive.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 letters, numbers, or hyphens
	//
	//    * First character must be a letter
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens
	//
	// Example: my-snapshot-id
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The compute and memory capacity of the each DB instance in the Multi-AZ DB
	// cluster, for example db.m6g.xlarge. Not all DB instance classes are available
	// in all Amazon Web Services Regions, or for all database engines.
	//
	// For the full list of DB instance classes, and availability for your engine,
	// see DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)
	// in the Amazon RDS User Guide.
	//
	// Valid for: Multi-AZ DB clusters only
	DBClusterInstanceClass *string `type:"string"`

	// The name of the DB cluster parameter group to associate with this DB cluster.
	// If this argument is omitted, the default DB cluster parameter group for the
	// specified engine is used.
	//
	// Constraints:
	//
	//    * If supplied, must match the name of an existing default DB cluster parameter
	//    group.
	//
	//    * Must be 1 to 255 letters, numbers, or hyphens.
	//
	//    * First character must be a letter.
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	DBClusterParameterGroupName *string `type:"string"`

	// The name of the DB subnet group to use for the new DB cluster.
	//
	// Constraints: If supplied, must match the name of an existing DB subnet group.
	//
	// Example: mydbsubnetgroup
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	DBSubnetGroupName *string `type:"string"`

	// The database name for the restored DB cluster.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	DatabaseName *string `type:"string"`

	// A value that indicates whether the DB cluster has deletion protection enabled.
	// The database can't be deleted when deletion protection is enabled. By default,
	// deletion protection isn't enabled.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	DeletionProtection *bool `type:"boolean"`

	// Specify the Active Directory directory ID to restore the DB cluster in. The
	// domain must be created prior to this operation. Currently, only MySQL, Microsoft
	// SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active
	// Directory Domain.
	//
	// For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html)
	// in the Amazon RDS User Guide.
	//
	// Valid for: Aurora DB clusters only
	Domain *string `type:"string"`

	// Specify the name of the IAM role to be used when making API calls to the
	// Directory Service.
	//
	// Valid for: Aurora DB clusters only
	DomainIAMRoleName *string `type:"string"`

	// The list of logs that the restored DB cluster is to export to Amazon CloudWatch
	// Logs. The values in the list depend on the DB engine being used.
	//
	// RDS for MySQL
	//
	// Possible values are error, general, and slowquery.
	//
	// RDS for PostgreSQL
	//
	// Possible values are postgresql and upgrade.
	//
	// Aurora MySQL
	//
	// Possible values are audit, error, general, and slowquery.
	//
	// Aurora PostgreSQL
	//
	// Possible value is postgresql.
	//
	// For more information about exporting CloudWatch Logs for Amazon RDS, see
	// Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
	// in the Amazon RDS User Guide.
	//
	// For more information about exporting CloudWatch Logs for Amazon Aurora, see
	// Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
	// in the Amazon Aurora User Guide.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	EnableCloudwatchLogsExports []*string `type:"list"`

	// A value that indicates whether to enable mapping of Amazon Web Services Identity
	// and Access Management (IAM) accounts to database accounts. By default, mapping
	// isn't enabled.
	//
	// For more information, see IAM Database Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html)
	// in the Amazon Aurora User Guide.
	//
	// Valid for: Aurora DB clusters only
	EnableIAMDatabaseAuthentication *bool `type:"boolean"`

	// The database engine to use for the new DB cluster.
	//
	// Default: The same as source
	//
	// Constraint: Must be compatible with the engine of the source
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	//
	// Engine is a required field
	Engine *string `type:"string" required:"true"`

	// The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery,
	// global, or multimaster.
	//
	// For more information, see CreateDBCluster (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html).
	//
	// Valid for: Aurora DB clusters only
	EngineMode *string `type:"string"`

	// The version of the database engine to use for the new DB cluster.
	//
	// To list all of the available engine versions for MySQL 5.6-compatible Aurora,
	// use the following command:
	//
	// aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
	//
	// To list all of the available engine versions for MySQL 5.7-compatible and
	// MySQL 8.0-compatible Aurora, use the following command:
	//
	// aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
	//
	// To list all of the available engine versions for Aurora PostgreSQL, use the
	// following command:
	//
	// aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
	//
	// To list all of the available engine versions for RDS for MySQL, use the following
	// command:
	//
	// aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
	//
	// To list all of the available engine versions for RDS for PostgreSQL, use
	// the following command:
	//
	// aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
	//
	// Aurora MySQL
	//
	// See MySQL on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html)
	// in the Amazon Aurora User Guide.
	//
	// Aurora PostgreSQL
	//
	// See Amazon Aurora PostgreSQL releases and engine versions (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html)
	// in the Amazon Aurora User Guide.
	//
	// MySQL
	//
	// See MySQL on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)
	// in the Amazon RDS User Guide.
	//
	// PostgreSQL
	//
	// See Amazon RDS for PostgreSQL versions and extensions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts)
	// in the Amazon RDS User Guide.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	EngineVersion *string `type:"string"`

	// The amount of Provisioned IOPS (input/output operations per second) to be
	// initially allocated for each DB instance in the Multi-AZ DB cluster.
	//
	// For information about valid Iops values, see Amazon RDS Provisioned IOPS
	// Storage to Improve Performance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS)
	// in the Amazon RDS User Guide.
	//
	// Constraints: Must be a multiple between .5 and 50 of the storage amount for
	// the DB instance.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	Iops *int64 `type:"integer"`

	// The Amazon Web Services KMS key identifier to use when restoring an encrypted
	// DB cluster from a DB snapshot or DB cluster snapshot.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key. To use a KMS key in a different Amazon
	// Web Services account, specify the key ARN or alias ARN.
	//
	// When you don't specify a value for the KmsKeyId parameter, then the following
	// occurs:
	//
	//    * If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted,
	//    then the restored DB cluster is encrypted using the KMS key that was used
	//    to encrypt the DB snapshot or DB cluster snapshot.
	//
	//    * If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't
	//    encrypted, then the restored DB cluster isn't encrypted.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	KmsKeyId *string `type:"string"`

	// The network type of the DB cluster.
	//
	// Valid values:
	//
	//    * IPV4
	//
	//    * DUAL
	//
	// The network type is determined by the DBSubnetGroup specified for the DB
	// cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and
	// the IPv6 protocols (DUAL).
	//
	// For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
	// in the Amazon Aurora User Guide.
	//
	// Valid for: Aurora DB clusters only
	NetworkType *string `type:"string"`

	// The name of the option group to use for the restored DB cluster.
	//
	// DB clusters are associated with a default option group that can't be modified.
	OptionGroupName *string `type:"string"`

	// The port number on which the new DB cluster accepts connections.
	//
	// Constraints: This value must be 1150-65535
	//
	// Default: The same port as the original DB cluster.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	Port *int64 `type:"integer"`

	// A value that indicates whether the DB cluster is publicly accessible.
	//
	// When the DB cluster is publicly accessible, its Domain Name System (DNS)
	// endpoint resolves to the private IP address from within the DB cluster's
	// virtual private cloud (VPC). It resolves to the public IP address from outside
	// of the DB cluster's VPC. Access to the DB cluster is ultimately controlled
	// by the security group it uses. That public access is not permitted if the
	// security group assigned to the DB cluster doesn't permit it.
	//
	// When the DB cluster isn't publicly accessible, it is an internal DB cluster
	// with a DNS name that resolves to a private IP address.
	//
	// Default: The default behavior varies depending on whether DBSubnetGroupName
	// is specified.
	//
	// If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified,
	// the following applies:
	//
	//    * If the default VPC in the target Region doesn’t have an internet gateway
	//    attached to it, the DB cluster is private.
	//
	//    * If the default VPC in the target Region has an internet gateway attached
	//    to it, the DB cluster is public.
	//
	// If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified,
	// the following applies:
	//
	//    * If the subnets are part of a VPC that doesn’t have an internet gateway
	//    attached to it, the DB cluster is private.
	//
	//    * If the subnets are part of a VPC that has an internet gateway attached
	//    to it, the DB cluster is public.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	PubliclyAccessible *bool `type:"boolean"`

	// For DB clusters in serverless DB engine mode, the scaling properties of the
	// DB cluster.
	//
	// Valid for: Aurora DB clusters only
	ScalingConfiguration *ScalingConfiguration `type:"structure"`

	// Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
	//
	// For more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html)
	// in the Amazon Aurora User Guide.
	ServerlessV2ScalingConfiguration *ServerlessV2ScalingConfiguration `type:"structure"`

	// The identifier for the DB snapshot or DB cluster snapshot to restore from.
	//
	// You can use either the name or the Amazon Resource Name (ARN) to specify
	// a DB cluster snapshot. However, you can use only the ARN to specify a DB
	// snapshot.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing Snapshot.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	//
	// SnapshotIdentifier is a required field
	SnapshotIdentifier *string `type:"string" required:"true"`

	// Specifies the storage type to be associated with the each DB instance in
	// the Multi-AZ DB cluster.
	//
	// Valid values: io1
	//
	// When specified, a value for the Iops parameter is required.
	//
	// Default: io1
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	StorageType *string `type:"string"`

	// The tags to be assigned to the restored DB cluster.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// A list of VPC security groups that the new DB cluster will belong to.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"`
	// contains filtered or unexported fields
}

func (RestoreDBClusterFromSnapshotInput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDBClusterFromSnapshotInput) SetAvailabilityZones added in v1.5.0

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*RestoreDBClusterFromSnapshotInput) SetBacktrackWindow added in v1.13.45

SetBacktrackWindow sets the BacktrackWindow field's value.

func (*RestoreDBClusterFromSnapshotInput) SetCopyTagsToSnapshot added in v1.17.13

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*RestoreDBClusterFromSnapshotInput) SetDBClusterIdentifier added in v1.5.0

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*RestoreDBClusterFromSnapshotInput) SetDBClusterInstanceClass added in v1.42.11

SetDBClusterInstanceClass sets the DBClusterInstanceClass field's value.

func (*RestoreDBClusterFromSnapshotInput) SetDBClusterParameterGroupName added in v1.15.55

func (s *RestoreDBClusterFromSnapshotInput) SetDBClusterParameterGroupName(v string) *RestoreDBClusterFromSnapshotInput

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*RestoreDBClusterFromSnapshotInput) SetDBSubnetGroupName added in v1.5.0

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*RestoreDBClusterFromSnapshotInput) SetDatabaseName added in v1.5.0

SetDatabaseName sets the DatabaseName field's value.

func (*RestoreDBClusterFromSnapshotInput) SetDeletionProtection added in v1.15.43

SetDeletionProtection sets the DeletionProtection field's value.

func (*RestoreDBClusterFromSnapshotInput) SetDomain added in v1.29.5

SetDomain sets the Domain field's value.

func (*RestoreDBClusterFromSnapshotInput) SetDomainIAMRoleName added in v1.29.5

SetDomainIAMRoleName sets the DomainIAMRoleName field's value.

func (*RestoreDBClusterFromSnapshotInput) SetEnableCloudwatchLogsExports added in v1.13.55

func (s *RestoreDBClusterFromSnapshotInput) SetEnableCloudwatchLogsExports(v []*string) *RestoreDBClusterFromSnapshotInput

SetEnableCloudwatchLogsExports sets the EnableCloudwatchLogsExports field's value.

func (*RestoreDBClusterFromSnapshotInput) SetEnableIAMDatabaseAuthentication added in v1.8.17

func (s *RestoreDBClusterFromSnapshotInput) SetEnableIAMDatabaseAuthentication(v bool) *RestoreDBClusterFromSnapshotInput

SetEnableIAMDatabaseAuthentication sets the EnableIAMDatabaseAuthentication field's value.

func (*RestoreDBClusterFromSnapshotInput) SetEngine added in v1.5.0

SetEngine sets the Engine field's value.

func (*RestoreDBClusterFromSnapshotInput) SetEngineMode added in v1.15.9

SetEngineMode sets the EngineMode field's value.

func (*RestoreDBClusterFromSnapshotInput) SetEngineVersion added in v1.5.0

SetEngineVersion sets the EngineVersion field's value.

func (*RestoreDBClusterFromSnapshotInput) SetIops added in v1.42.11

SetIops sets the Iops field's value.

func (*RestoreDBClusterFromSnapshotInput) SetKmsKeyId added in v1.5.0

SetKmsKeyId sets the KmsKeyId field's value.

func (*RestoreDBClusterFromSnapshotInput) SetNetworkType added in v1.44.79

SetNetworkType sets the NetworkType field's value.

func (*RestoreDBClusterFromSnapshotInput) SetOptionGroupName added in v1.5.0

SetOptionGroupName sets the OptionGroupName field's value.

func (*RestoreDBClusterFromSnapshotInput) SetPort added in v1.5.0

SetPort sets the Port field's value.

func (*RestoreDBClusterFromSnapshotInput) SetPubliclyAccessible added in v1.42.11

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*RestoreDBClusterFromSnapshotInput) SetScalingConfiguration added in v1.15.9

SetScalingConfiguration sets the ScalingConfiguration field's value.

func (*RestoreDBClusterFromSnapshotInput) SetServerlessV2ScalingConfiguration added in v1.43.43

SetServerlessV2ScalingConfiguration sets the ServerlessV2ScalingConfiguration field's value.

func (*RestoreDBClusterFromSnapshotInput) SetSnapshotIdentifier added in v1.5.0

SetSnapshotIdentifier sets the SnapshotIdentifier field's value.

func (*RestoreDBClusterFromSnapshotInput) SetStorageType added in v1.42.11

SetStorageType sets the StorageType field's value.

func (*RestoreDBClusterFromSnapshotInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (*RestoreDBClusterFromSnapshotInput) SetVpcSecurityGroupIds added in v1.5.0

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (RestoreDBClusterFromSnapshotInput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDBClusterFromSnapshotInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type RestoreDBClusterFromSnapshotOutput added in v0.7.1

type RestoreDBClusterFromSnapshotOutput struct {

	// Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
	//
	// For an Amazon Aurora DB cluster, this data type is used as a response element
	// in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot,
	// RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
	//
	// For a Multi-AZ DB cluster, this data type is used as a response element in
	// the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
	//
	// For more information on Amazon Aurora DB clusters, see What is Amazon Aurora?
	// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)
	// in the Amazon Aurora User Guide.
	//
	// For more information on Multi-AZ DB clusters, see Multi-AZ deployments with
	// two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
	// in the Amazon RDS User Guide.
	DBCluster *DBCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (RestoreDBClusterFromSnapshotOutput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDBClusterFromSnapshotOutput) SetDBCluster added in v1.5.0

SetDBCluster sets the DBCluster field's value.

func (RestoreDBClusterFromSnapshotOutput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RestoreDBClusterToPointInTimeInput added in v0.7.1

type RestoreDBClusterToPointInTimeInput struct {

	// The target backtrack window, in seconds. To disable backtracking, set this
	// value to 0.
	//
	// Default: 0
	//
	// Constraints:
	//
	//    * If specified, this value must be set to a number from 0 to 259,200 (72
	//    hours).
	//
	// Valid for: Aurora MySQL DB clusters only
	BacktrackWindow *int64 `type:"long"`

	// A value that indicates whether to copy all tags from the restored DB cluster
	// to snapshots of the restored DB cluster. The default is not to copy them.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	CopyTagsToSnapshot *bool `type:"boolean"`

	// The name of the new DB cluster to be created.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 letters, numbers, or hyphens
	//
	//    * First character must be a letter
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The compute and memory capacity of the each DB instance in the Multi-AZ DB
	// cluster, for example db.m6g.xlarge. Not all DB instance classes are available
	// in all Amazon Web Services Regions, or for all database engines.
	//
	// For the full list of DB instance classes, and availability for your engine,
	// see DB instance class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)
	// in the Amazon RDS User Guide.
	//
	// Valid for: Multi-AZ DB clusters only
	DBClusterInstanceClass *string `type:"string"`

	// The name of the DB cluster parameter group to associate with this DB cluster.
	// If this argument is omitted, the default DB cluster parameter group for the
	// specified engine is used.
	//
	// Constraints:
	//
	//    * If supplied, must match the name of an existing DB cluster parameter
	//    group.
	//
	//    * Must be 1 to 255 letters, numbers, or hyphens.
	//
	//    * First character must be a letter.
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	DBClusterParameterGroupName *string `type:"string"`

	// The DB subnet group name to use for the new DB cluster.
	//
	// Constraints: If supplied, must match the name of an existing DBSubnetGroup.
	//
	// Example: mydbsubnetgroup
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	DBSubnetGroupName *string `type:"string"`

	// A value that indicates whether the DB cluster has deletion protection enabled.
	// The database can't be deleted when deletion protection is enabled. By default,
	// deletion protection isn't enabled.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	DeletionProtection *bool `type:"boolean"`

	// Specify the Active Directory directory ID to restore the DB cluster in. The
	// domain must be created prior to this operation.
	//
	// For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication
	// to authenticate users that connect to the DB cluster. For more information,
	// see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html)
	// in the Amazon Aurora User Guide.
	//
	// Valid for: Aurora DB clusters only
	Domain *string `type:"string"`

	// Specify the name of the IAM role to be used when making API calls to the
	// Directory Service.
	//
	// Valid for: Aurora DB clusters only
	DomainIAMRoleName *string `type:"string"`

	// The list of logs that the restored DB cluster is to export to CloudWatch
	// Logs. The values in the list depend on the DB engine being used.
	//
	// RDS for MySQL
	//
	// Possible values are error, general, and slowquery.
	//
	// RDS for PostgreSQL
	//
	// Possible values are postgresql and upgrade.
	//
	// Aurora MySQL
	//
	// Possible values are audit, error, general, and slowquery.
	//
	// Aurora PostgreSQL
	//
	// Possible value is postgresql.
	//
	// For more information about exporting CloudWatch Logs for Amazon RDS, see
	// Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
	// in the Amazon RDS User Guide.
	//
	// For more information about exporting CloudWatch Logs for Amazon Aurora, see
	// Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
	// in the Amazon Aurora User Guide.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	EnableCloudwatchLogsExports []*string `type:"list"`

	// A value that indicates whether to enable mapping of Amazon Web Services Identity
	// and Access Management (IAM) accounts to database accounts. By default, mapping
	// isn't enabled.
	//
	// For more information, see IAM Database Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html)
	// in the Amazon Aurora User Guide.
	//
	// Valid for: Aurora DB clusters only
	EnableIAMDatabaseAuthentication *bool `type:"boolean"`

	// The engine mode of the new cluster. Specify provisioned or serverless, depending
	// on the type of the cluster you are creating. You can create an Aurora Serverless
	// v1 clone from a provisioned cluster, or a provisioned clone from an Aurora
	// Serverless v1 cluster. To create a clone that is an Aurora Serverless v1
	// cluster, the original cluster must be an Aurora Serverless v1 cluster or
	// an encrypted provisioned cluster.
	//
	// Valid for: Aurora DB clusters only
	EngineMode *string `type:"string"`

	// The amount of Provisioned IOPS (input/output operations per second) to be
	// initially allocated for each DB instance in the Multi-AZ DB cluster.
	//
	// For information about valid Iops values, see Amazon RDS Provisioned IOPS
	// storage to improve performance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS)
	// in the Amazon RDS User Guide.
	//
	// Constraints: Must be a multiple between .5 and 50 of the storage amount for
	// the DB instance.
	//
	// Valid for: Multi-AZ DB clusters only
	Iops *int64 `type:"integer"`

	// The Amazon Web Services KMS key identifier to use when restoring an encrypted
	// DB cluster from an encrypted DB cluster.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key. To use a KMS key in a different Amazon
	// Web Services account, specify the key ARN or alias ARN.
	//
	// You can restore to a new DB cluster and encrypt the new DB cluster with a
	// KMS key that is different from the KMS key used to encrypt the source DB
	// cluster. The new DB cluster is encrypted with the KMS key identified by the
	// KmsKeyId parameter.
	//
	// If you don't specify a value for the KmsKeyId parameter, then the following
	// occurs:
	//
	//    * If the DB cluster is encrypted, then the restored DB cluster is encrypted
	//    using the KMS key that was used to encrypt the source DB cluster.
	//
	//    * If the DB cluster isn't encrypted, then the restored DB cluster isn't
	//    encrypted.
	//
	// If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then
	// the restore request is rejected.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	KmsKeyId *string `type:"string"`

	// The network type of the DB cluster.
	//
	// Valid values:
	//
	//    * IPV4
	//
	//    * DUAL
	//
	// The network type is determined by the DBSubnetGroup specified for the DB
	// cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and
	// the IPv6 protocols (DUAL).
	//
	// For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
	// in the Amazon Aurora User Guide.
	//
	// Valid for: Aurora DB clusters only
	NetworkType *string `type:"string"`

	// The name of the option group for the new DB cluster.
	//
	// DB clusters are associated with a default option group that can't be modified.
	OptionGroupName *string `type:"string"`

	// The port number on which the new DB cluster accepts connections.
	//
	// Constraints: A value from 1150-65535.
	//
	// Default: The default port for the engine.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	Port *int64 `type:"integer"`

	// A value that indicates whether the DB cluster is publicly accessible.
	//
	// When the DB cluster is publicly accessible, its Domain Name System (DNS)
	// endpoint resolves to the private IP address from within the DB cluster's
	// virtual private cloud (VPC). It resolves to the public IP address from outside
	// of the DB cluster's VPC. Access to the DB cluster is ultimately controlled
	// by the security group it uses. That public access is not permitted if the
	// security group assigned to the DB cluster doesn't permit it.
	//
	// When the DB cluster isn't publicly accessible, it is an internal DB cluster
	// with a DNS name that resolves to a private IP address.
	//
	// Default: The default behavior varies depending on whether DBSubnetGroupName
	// is specified.
	//
	// If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified,
	// the following applies:
	//
	//    * If the default VPC in the target Region doesn’t have an internet gateway
	//    attached to it, the DB cluster is private.
	//
	//    * If the default VPC in the target Region has an internet gateway attached
	//    to it, the DB cluster is public.
	//
	// If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified,
	// the following applies:
	//
	//    * If the subnets are part of a VPC that doesn’t have an internet gateway
	//    attached to it, the DB cluster is private.
	//
	//    * If the subnets are part of a VPC that has an internet gateway attached
	//    to it, the DB cluster is public.
	//
	// Valid for: Multi-AZ DB clusters only
	PubliclyAccessible *bool `type:"boolean"`

	// The date and time to restore the DB cluster to.
	//
	// Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
	//
	// Constraints:
	//
	//    * Must be before the latest restorable time for the DB instance
	//
	//    * Must be specified if UseLatestRestorableTime parameter isn't provided
	//
	//    * Can't be specified if the UseLatestRestorableTime parameter is enabled
	//
	//    * Can't be specified if the RestoreType parameter is copy-on-write
	//
	// Example: 2015-03-07T23:45:00Z
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	RestoreToTime *time.Time `type:"timestamp"`

	// The type of restore to be performed. You can specify one of the following
	// values:
	//
	//    * full-copy - The new DB cluster is restored as a full copy of the source
	//    DB cluster.
	//
	//    * copy-on-write - The new DB cluster is restored as a clone of the source
	//    DB cluster.
	//
	// Constraints: You can't specify copy-on-write if the engine version of the
	// source DB cluster is earlier than 1.11.
	//
	// If you don't specify a RestoreType value, then the new DB cluster is restored
	// as a full copy of the source DB cluster.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	RestoreType *string `type:"string"`

	// For DB clusters in serverless DB engine mode, the scaling properties of the
	// DB cluster.
	//
	// Valid for: Aurora DB clusters only
	ScalingConfiguration *ScalingConfiguration `type:"structure"`

	// Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
	//
	// For more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html)
	// in the Amazon Aurora User Guide.
	ServerlessV2ScalingConfiguration *ServerlessV2ScalingConfiguration `type:"structure"`

	// The identifier of the source DB cluster from which to restore.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBCluster.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	//
	// SourceDBClusterIdentifier is a required field
	SourceDBClusterIdentifier *string `type:"string" required:"true"`

	// Specifies the storage type to be associated with the each DB instance in
	// the Multi-AZ DB cluster.
	//
	// Valid values: io1
	//
	// When specified, a value for the Iops parameter is required.
	//
	// Default: io1
	//
	// Valid for: Multi-AZ DB clusters only
	StorageType *string `type:"string"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// A value that indicates whether to restore the DB cluster to the latest restorable
	// backup time. By default, the DB cluster isn't restored to the latest restorable
	// backup time.
	//
	// Constraints: Can't be specified if RestoreToTime parameter is provided.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	UseLatestRestorableTime *bool `type:"boolean"`

	// A list of VPC security groups that the new DB cluster belongs to.
	//
	// Valid for: Aurora DB clusters and Multi-AZ DB clusters
	VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"`
	// contains filtered or unexported fields
}

func (RestoreDBClusterToPointInTimeInput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDBClusterToPointInTimeInput) SetBacktrackWindow added in v1.13.45

SetBacktrackWindow sets the BacktrackWindow field's value.

func (*RestoreDBClusterToPointInTimeInput) SetCopyTagsToSnapshot added in v1.17.13

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*RestoreDBClusterToPointInTimeInput) SetDBClusterIdentifier added in v1.5.0

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*RestoreDBClusterToPointInTimeInput) SetDBClusterInstanceClass added in v1.42.11

SetDBClusterInstanceClass sets the DBClusterInstanceClass field's value.

func (*RestoreDBClusterToPointInTimeInput) SetDBClusterParameterGroupName added in v1.15.55

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*RestoreDBClusterToPointInTimeInput) SetDBSubnetGroupName added in v1.5.0

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*RestoreDBClusterToPointInTimeInput) SetDeletionProtection added in v1.15.43

SetDeletionProtection sets the DeletionProtection field's value.

func (*RestoreDBClusterToPointInTimeInput) SetDomain added in v1.29.5

SetDomain sets the Domain field's value.

func (*RestoreDBClusterToPointInTimeInput) SetDomainIAMRoleName added in v1.29.5

SetDomainIAMRoleName sets the DomainIAMRoleName field's value.

func (*RestoreDBClusterToPointInTimeInput) SetEnableCloudwatchLogsExports added in v1.13.55

func (s *RestoreDBClusterToPointInTimeInput) SetEnableCloudwatchLogsExports(v []*string) *RestoreDBClusterToPointInTimeInput

SetEnableCloudwatchLogsExports sets the EnableCloudwatchLogsExports field's value.

func (*RestoreDBClusterToPointInTimeInput) SetEnableIAMDatabaseAuthentication added in v1.8.17

func (s *RestoreDBClusterToPointInTimeInput) SetEnableIAMDatabaseAuthentication(v bool) *RestoreDBClusterToPointInTimeInput

SetEnableIAMDatabaseAuthentication sets the EnableIAMDatabaseAuthentication field's value.

func (*RestoreDBClusterToPointInTimeInput) SetEngineMode added in v1.38.63

SetEngineMode sets the EngineMode field's value.

func (*RestoreDBClusterToPointInTimeInput) SetIops added in v1.42.11

SetIops sets the Iops field's value.

func (*RestoreDBClusterToPointInTimeInput) SetKmsKeyId added in v1.5.0

SetKmsKeyId sets the KmsKeyId field's value.

func (*RestoreDBClusterToPointInTimeInput) SetNetworkType added in v1.44.79

SetNetworkType sets the NetworkType field's value.

func (*RestoreDBClusterToPointInTimeInput) SetOptionGroupName added in v1.5.0

SetOptionGroupName sets the OptionGroupName field's value.

func (*RestoreDBClusterToPointInTimeInput) SetPort added in v1.5.0

SetPort sets the Port field's value.

func (*RestoreDBClusterToPointInTimeInput) SetPubliclyAccessible added in v1.42.11

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*RestoreDBClusterToPointInTimeInput) SetRestoreToTime added in v1.5.0

SetRestoreToTime sets the RestoreToTime field's value.

func (*RestoreDBClusterToPointInTimeInput) SetRestoreType added in v1.8.40

SetRestoreType sets the RestoreType field's value.

func (*RestoreDBClusterToPointInTimeInput) SetScalingConfiguration added in v1.38.63

SetScalingConfiguration sets the ScalingConfiguration field's value.

func (*RestoreDBClusterToPointInTimeInput) SetServerlessV2ScalingConfiguration added in v1.43.43

SetServerlessV2ScalingConfiguration sets the ServerlessV2ScalingConfiguration field's value.

func (*RestoreDBClusterToPointInTimeInput) SetSourceDBClusterIdentifier added in v1.5.0

SetSourceDBClusterIdentifier sets the SourceDBClusterIdentifier field's value.

func (*RestoreDBClusterToPointInTimeInput) SetStorageType added in v1.42.11

SetStorageType sets the StorageType field's value.

func (*RestoreDBClusterToPointInTimeInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (*RestoreDBClusterToPointInTimeInput) SetUseLatestRestorableTime added in v1.5.0

SetUseLatestRestorableTime sets the UseLatestRestorableTime field's value.

func (*RestoreDBClusterToPointInTimeInput) SetVpcSecurityGroupIds added in v1.5.0

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (RestoreDBClusterToPointInTimeInput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDBClusterToPointInTimeInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type RestoreDBClusterToPointInTimeOutput added in v0.7.1

type RestoreDBClusterToPointInTimeOutput struct {

	// Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
	//
	// For an Amazon Aurora DB cluster, this data type is used as a response element
	// in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot,
	// RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
	//
	// For a Multi-AZ DB cluster, this data type is used as a response element in
	// the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
	//
	// For more information on Amazon Aurora DB clusters, see What is Amazon Aurora?
	// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)
	// in the Amazon Aurora User Guide.
	//
	// For more information on Multi-AZ DB clusters, see Multi-AZ deployments with
	// two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
	// in the Amazon RDS User Guide.
	DBCluster *DBCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (RestoreDBClusterToPointInTimeOutput) GoString added in v0.7.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDBClusterToPointInTimeOutput) SetDBCluster added in v1.5.0

SetDBCluster sets the DBCluster field's value.

func (RestoreDBClusterToPointInTimeOutput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RestoreDBInstanceFromDBSnapshotInput

type RestoreDBInstanceFromDBSnapshotInput struct {

	// A value that indicates whether minor version upgrades are applied automatically
	// to the DB instance during the maintenance window.
	//
	// If you restore an RDS Custom DB instance, you must disable this parameter.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// The Availability Zone (AZ) where the DB instance will be created.
	//
	// Default: A random, system-chosen Availability Zone.
	//
	// Constraint: You can't specify the AvailabilityZone parameter if the DB instance
	// is a Multi-AZ deployment.
	//
	// Example: us-east-1a
	AvailabilityZone *string `type:"string"`

	// Specifies where automated backups and manual snapshots are stored for the
	// restored DB instance.
	//
	// Possible values are outposts (Amazon Web Services Outposts) and region (Amazon
	// Web Services Region). The default is region.
	//
	// For more information, see Working with Amazon RDS on Amazon Web Services
	// Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)
	// in the Amazon RDS User Guide.
	BackupTarget *string `type:"string"`

	// A value that indicates whether to copy all tags from the restored DB instance
	// to snapshots of the DB instance.
	//
	// In most cases, tags aren't copied by default. However, when you restore a
	// DB instance from a DB snapshot, RDS checks whether you specify new tags.
	// If yes, the new tags are added to the restored DB instance. If there are
	// no new tags, RDS looks for the tags from the source DB instance for the DB
	// snapshot, and then adds those tags to the restored DB instance.
	//
	// For more information, see Copying tags to DB instance snapshots (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.CopyTags)
	// in the Amazon RDS User Guide.
	CopyTagsToSnapshot *bool `type:"boolean"`

	// The instance profile associated with the underlying Amazon EC2 instance of
	// an RDS Custom DB instance. The instance profile must meet the following requirements:
	//
	//    * The profile must exist in your account.
	//
	//    * The profile must have an IAM role that Amazon EC2 has permissions to
	//    assume.
	//
	//    * The instance profile name and the associated IAM role name must start
	//    with the prefix AWSRDSCustom.
	//
	// For the list of permissions required for the IAM role, see Configure IAM
	// and your VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc)
	// in the Amazon RDS User Guide.
	//
	// This setting is required for RDS Custom.
	CustomIamInstanceProfile *string `type:"string"`

	// The compute and memory capacity of the Amazon RDS DB instance, for example
	// db.m4.large. Not all DB instance classes are available in all Amazon Web
	// Services Regions, or for all database engines. For the full list of DB instance
	// classes, and availability for your engine, see DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)
	// in the Amazon RDS User Guide.
	//
	// Default: The same DBInstanceClass as the original DB instance.
	DBInstanceClass *string `type:"string"`

	// Name of the DB instance to create from the DB snapshot. This parameter isn't
	// case-sensitive.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 numbers, letters, or hyphens
	//
	//    * First character must be a letter
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens
	//
	// Example: my-snapshot-id
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`

	// The database name for the restored DB instance.
	//
	// This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.
	// It also doesn't apply to RDS Custom DB instances.
	DBName *string `type:"string"`

	// The name of the DB parameter group to associate with this DB instance.
	//
	// If you don't specify a value for DBParameterGroupName, then RDS uses the
	// default DBParameterGroup for the specified DB engine.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Constraints:
	//
	//    * If supplied, must match the name of an existing DBParameterGroup.
	//
	//    * Must be 1 to 255 letters, numbers, or hyphens.
	//
	//    * First character must be a letter.
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens.
	DBParameterGroupName *string `type:"string"`

	// The identifier for the DB snapshot to restore from.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBSnapshot.
	//
	//    * If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier
	//    must be the ARN of the shared DB snapshot.
	//
	// DBSnapshotIdentifier is a required field
	DBSnapshotIdentifier *string `type:"string" required:"true"`

	// The DB subnet group name to use for the new instance.
	//
	// Constraints: If supplied, must match the name of an existing DBSubnetGroup.
	//
	// Example: mydbsubnetgroup
	DBSubnetGroupName *string `type:"string"`

	// A value that indicates whether the DB instance has deletion protection enabled.
	// The database can't be deleted when deletion protection is enabled. By default,
	// deletion protection isn't enabled. For more information, see Deleting a DB
	// Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
	DeletionProtection *bool `type:"boolean"`

	// Specify the Active Directory directory ID to restore the DB instance in.
	// The domain/ must be created prior to this operation. Currently, you can create
	// only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in
	// an Active Directory Domain.
	//
	// For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html)
	// in the Amazon RDS User Guide.
	//
	// This setting doesn't apply to RDS Custom.
	Domain *string `type:"string"`

	// Specify the name of the IAM role to be used when making API calls to the
	// Directory Service.
	//
	// This setting doesn't apply to RDS Custom.
	DomainIAMRoleName *string `type:"string"`

	// The list of logs that the restored DB instance is to export to CloudWatch
	// Logs. The values in the list depend on the DB engine being used. For more
	// information, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
	// in the Amazon RDS User Guide.
	//
	// This setting doesn't apply to RDS Custom.
	EnableCloudwatchLogsExports []*string `type:"list"`

	// A value that indicates whether to enable a customer-owned IP address (CoIP)
	// for an RDS on Outposts DB instance.
	//
	// A CoIP provides local or external connectivity to resources in your Outpost
	// subnets through your on-premises network. For some use cases, a CoIP can
	// provide lower latency for connections to the DB instance from outside of
	// its virtual private cloud (VPC) on your local network.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// For more information about RDS on Outposts, see Working with Amazon RDS on
	// Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)
	// in the Amazon RDS User Guide.
	//
	// For more information about CoIPs, see Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing)
	// in the Amazon Web Services Outposts User Guide.
	EnableCustomerOwnedIp *bool `type:"boolean"`

	// A value that indicates whether to enable mapping of Amazon Web Services Identity
	// and Access Management (IAM) accounts to database accounts. By default, mapping
	// is disabled.
	//
	// For more information about IAM database authentication, see IAM Database
	// Authentication for MySQL and PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html)
	// in the Amazon RDS User Guide.
	//
	// This setting doesn't apply to RDS Custom.
	EnableIAMDatabaseAuthentication *bool `type:"boolean"`

	// The database engine to use for the new instance.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Default: The same as source
	//
	// Constraint: Must be compatible with the engine of the source. For example,
	// you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
	//
	// Valid Values:
	//
	//    * mariadb
	//
	//    * mysql
	//
	//    * oracle-ee
	//
	//    * oracle-ee-cdb
	//
	//    * oracle-se2
	//
	//    * oracle-se2-cdb
	//
	//    * postgres
	//
	//    * sqlserver-ee
	//
	//    * sqlserver-se
	//
	//    * sqlserver-ex
	//
	//    * sqlserver-web
	Engine *string `type:"string"`

	// Specifies the amount of provisioned IOPS for the DB instance, expressed in
	// I/O operations per second. If this parameter isn't specified, the IOPS value
	// is taken from the backup. If this parameter is set to 0, the new instance
	// is converted to a non-PIOPS instance. The conversion takes additional time,
	// though your DB instance is available for connections before the conversion
	// starts.
	//
	// The provisioned IOPS value must follow the requirements for your database
	// engine. For more information, see Amazon RDS Provisioned IOPS Storage to
	// Improve Performance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS)
	// in the Amazon RDS User Guide.
	//
	// Constraints: Must be an integer greater than 1000.
	Iops *int64 `type:"integer"`

	// License model information for the restored DB instance.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Default: Same as source.
	//
	// Valid values: license-included | bring-your-own-license | general-public-license
	LicenseModel *string `type:"string"`

	// A value that indicates whether the DB instance is a Multi-AZ deployment.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Constraint: You can't specify the AvailabilityZone parameter if the DB instance
	// is a Multi-AZ deployment.
	MultiAZ *bool `type:"boolean"`

	// The network type of the DB instance.
	//
	// Valid values:
	//
	//    * IPV4
	//
	//    * DUAL
	//
	// The network type is determined by the DBSubnetGroup specified for the DB
	// instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4
	// and the IPv6 protocols (DUAL).
	//
	// For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
	// in the Amazon RDS User Guide.
	NetworkType *string `type:"string"`

	// The name of the option group to be used for the restored DB instance.
	//
	// Permanent options, such as the TDE option for Oracle Advanced Security TDE,
	// can't be removed from an option group, and that option group can't be removed
	// from a DB instance after it is associated with a DB instance.
	//
	// This setting doesn't apply to RDS Custom.
	OptionGroupName *string `type:"string"`

	// The port number on which the database accepts connections.
	//
	// Default: The same port as the original DB instance
	//
	// Constraints: Value must be 1150-65535
	Port *int64 `type:"integer"`

	// The number of CPU cores and the number of threads per core for the DB instance
	// class of the DB instance.
	//
	// This setting doesn't apply to RDS Custom.
	ProcessorFeatures []*ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"`

	// A value that indicates whether the DB instance is publicly accessible.
	//
	// When the DB instance is publicly accessible, its Domain Name System (DNS)
	// endpoint resolves to the private IP address from within the DB instance's
	// virtual private cloud (VPC). It resolves to the public IP address from outside
	// of the DB instance's VPC. Access to the DB instance is ultimately controlled
	// by the security group it uses. That public access is not permitted if the
	// security group assigned to the DB instance doesn't permit it.
	//
	// When the DB instance isn't publicly accessible, it is an internal DB instance
	// with a DNS name that resolves to a private IP address.
	//
	// For more information, see CreateDBInstance.
	PubliclyAccessible *bool `type:"boolean"`

	// Specifies the storage type to be associated with the DB instance.
	//
	// Valid values: standard | gp2 | io1
	//
	// If you specify io1, you must also include a value for the Iops parameter.
	//
	// Default: io1 if the Iops parameter is specified, otherwise gp2
	StorageType *string `type:"string"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// The ARN from the key store with which to associate the instance for TDE encryption.
	//
	// This setting doesn't apply to RDS Custom.
	TdeCredentialArn *string `type:"string"`

	// The password for the given ARN from the key store in order to access the
	// device.
	//
	// This setting doesn't apply to RDS Custom.
	TdeCredentialPassword *string `type:"string"`

	// A value that indicates whether the DB instance class of the DB instance uses
	// its default processor features.
	//
	// This setting doesn't apply to RDS Custom.
	UseDefaultProcessorFeatures *bool `type:"boolean"`

	// A list of EC2 VPC security groups to associate with this DB instance.
	//
	// Default: The default EC2 VPC security group for the DB subnet group's VPC.
	VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"`
	// contains filtered or unexported fields
}

func (RestoreDBInstanceFromDBSnapshotInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDBInstanceFromDBSnapshotInput) SetAutoMinorVersionUpgrade added in v1.5.0

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetAvailabilityZone added in v1.5.0

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetBackupTarget added in v1.42.10

SetBackupTarget sets the BackupTarget field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetCopyTagsToSnapshot added in v1.5.0

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetCustomIamInstanceProfile added in v1.41.10

SetCustomIamInstanceProfile sets the CustomIamInstanceProfile field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetDBInstanceClass added in v1.5.0

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetDBInstanceIdentifier added in v1.5.0

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetDBName added in v1.5.0

SetDBName sets the DBName field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetDBParameterGroupName added in v1.15.55

SetDBParameterGroupName sets the DBParameterGroupName field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetDBSnapshotIdentifier added in v1.5.0

SetDBSnapshotIdentifier sets the DBSnapshotIdentifier field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetDBSubnetGroupName added in v1.5.0

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetDeletionProtection added in v1.15.43

SetDeletionProtection sets the DeletionProtection field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetDomainIAMRoleName added in v1.5.0

SetDomainIAMRoleName sets the DomainIAMRoleName field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetEnableCloudwatchLogsExports added in v1.12.63

func (s *RestoreDBInstanceFromDBSnapshotInput) SetEnableCloudwatchLogsExports(v []*string) *RestoreDBInstanceFromDBSnapshotInput

SetEnableCloudwatchLogsExports sets the EnableCloudwatchLogsExports field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetEnableCustomerOwnedIp added in v1.36.14

SetEnableCustomerOwnedIp sets the EnableCustomerOwnedIp field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetEnableIAMDatabaseAuthentication added in v1.8.17

func (s *RestoreDBInstanceFromDBSnapshotInput) SetEnableIAMDatabaseAuthentication(v bool) *RestoreDBInstanceFromDBSnapshotInput

SetEnableIAMDatabaseAuthentication sets the EnableIAMDatabaseAuthentication field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetEngine added in v1.5.0

SetEngine sets the Engine field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetIops added in v1.5.0

SetIops sets the Iops field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetLicenseModel added in v1.5.0

SetLicenseModel sets the LicenseModel field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetMultiAZ added in v1.5.0

SetMultiAZ sets the MultiAZ field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetNetworkType added in v1.44.4

SetNetworkType sets the NetworkType field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetOptionGroupName added in v1.5.0

SetOptionGroupName sets the OptionGroupName field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetPort added in v1.5.0

SetPort sets the Port field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetProcessorFeatures added in v1.14.1

SetProcessorFeatures sets the ProcessorFeatures field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetPubliclyAccessible added in v1.5.0

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetStorageType added in v1.5.0

SetStorageType sets the StorageType field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetTdeCredentialArn added in v1.5.0

SetTdeCredentialArn sets the TdeCredentialArn field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetTdeCredentialPassword added in v1.5.0

SetTdeCredentialPassword sets the TdeCredentialPassword field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetUseDefaultProcessorFeatures added in v1.14.1

SetUseDefaultProcessorFeatures sets the UseDefaultProcessorFeatures field's value.

func (*RestoreDBInstanceFromDBSnapshotInput) SetVpcSecurityGroupIds added in v1.15.79

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (RestoreDBInstanceFromDBSnapshotInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDBInstanceFromDBSnapshotInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type RestoreDBInstanceFromDBSnapshotOutput

type RestoreDBInstanceFromDBSnapshotOutput struct {

	// Contains the details of an Amazon RDS DB instance.
	//
	// This data type is used as a response element in the operations CreateDBInstance,
	// CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance,
	// PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,
	// RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
	DBInstance *DBInstance `type:"structure"`
	// contains filtered or unexported fields
}

func (RestoreDBInstanceFromDBSnapshotOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDBInstanceFromDBSnapshotOutput) SetDBInstance added in v1.5.0

SetDBInstance sets the DBInstance field's value.

func (RestoreDBInstanceFromDBSnapshotOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RestoreDBInstanceFromS3Input added in v1.12.30

type RestoreDBInstanceFromS3Input struct {

	// The amount of storage (in gigabytes) to allocate initially for the DB instance.
	// Follow the allocation rules specified in CreateDBInstance.
	//
	// Be sure to allocate enough memory for your new DB instance so that the restore
	// operation can succeed. You can also allocate additional memory for future
	// growth.
	AllocatedStorage *int64 `type:"integer"`

	// A value that indicates whether minor engine upgrades are applied automatically
	// to the DB instance during the maintenance window. By default, minor engine
	// upgrades are not applied automatically.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// The Availability Zone that the DB instance is created in. For information
	// about Amazon Web Services Regions and Availability Zones, see Regions and
	// Availability Zones (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)
	// in the Amazon RDS User Guide.
	//
	// Default: A random, system-chosen Availability Zone in the endpoint's Amazon
	// Web Services Region.
	//
	// Example: us-east-1d
	//
	// Constraint: The AvailabilityZone parameter can't be specified if the DB instance
	// is a Multi-AZ deployment. The specified Availability Zone must be in the
	// same Amazon Web Services Region as the current endpoint.
	AvailabilityZone *string `type:"string"`

	// The number of days for which automated backups are retained. Setting this
	// parameter to a positive number enables backups. For more information, see
	// CreateDBInstance.
	BackupRetentionPeriod *int64 `type:"integer"`

	// A value that indicates whether to copy all tags from the DB instance to snapshots
	// of the DB instance. By default, tags are not copied.
	CopyTagsToSnapshot *bool `type:"boolean"`

	// The compute and memory capacity of the DB instance, for example db.m4.large.
	// Not all DB instance classes are available in all Amazon Web Services Regions,
	// or for all database engines. For the full list of DB instance classes, and
	// availability for your engine, see DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)
	// in the Amazon RDS User Guide.
	//
	// Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.
	//
	// DBInstanceClass is a required field
	DBInstanceClass *string `type:"string" required:"true"`

	// The DB instance identifier. This parameter is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 letters, numbers, or hyphens.
	//
	//    * First character must be a letter.
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens.
	//
	// Example: mydbinstance
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`

	// The name of the database to create when the DB instance is created. Follow
	// the naming rules specified in CreateDBInstance.
	DBName *string `type:"string"`

	// The name of the DB parameter group to associate with this DB instance.
	//
	// If you do not specify a value for DBParameterGroupName, then the default
	// DBParameterGroup for the specified DB engine is used.
	DBParameterGroupName *string `type:"string"`

	// A list of DB security groups to associate with this DB instance.
	//
	// Default: The default DB security group for the database engine.
	DBSecurityGroups []*string `locationNameList:"DBSecurityGroupName" type:"list"`

	// A DB subnet group to associate with this DB instance.
	//
	// Constraints: If supplied, must match the name of an existing DBSubnetGroup.
	//
	// Example: mydbsubnetgroup
	DBSubnetGroupName *string `type:"string"`

	// A value that indicates whether the DB instance has deletion protection enabled.
	// The database can't be deleted when deletion protection is enabled. By default,
	// deletion protection isn't enabled. For more information, see Deleting a DB
	// Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
	DeletionProtection *bool `type:"boolean"`

	// The list of logs that the restored DB instance is to export to CloudWatch
	// Logs. The values in the list depend on the DB engine being used. For more
	// information, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
	// in the Amazon RDS User Guide.
	EnableCloudwatchLogsExports []*string `type:"list"`

	// A value that indicates whether to enable mapping of Amazon Web Services Identity
	// and Access Management (IAM) accounts to database accounts. By default, mapping
	// isn't enabled.
	//
	// For more information about IAM database authentication, see IAM Database
	// Authentication for MySQL and PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html)
	// in the Amazon RDS User Guide.
	EnableIAMDatabaseAuthentication *bool `type:"boolean"`

	// A value that indicates whether to enable Performance Insights for the DB
	// instance.
	//
	// For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)
	// in the Amazon RDS User Guide.
	EnablePerformanceInsights *bool `type:"boolean"`

	// The name of the database engine to be used for this instance.
	//
	// Valid Values: mysql
	//
	// Engine is a required field
	Engine *string `type:"string" required:"true"`

	// The version number of the database engine to use. Choose the latest minor
	// version of your database engine. For information about engine versions, see
	// CreateDBInstance, or call DescribeDBEngineVersions.
	EngineVersion *string `type:"string"`

	// The amount of Provisioned IOPS (input/output operations per second) to allocate
	// initially for the DB instance. For information about valid Iops values, see
	// Amazon RDS Provisioned IOPS Storage to Improve Performance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS)
	// in the Amazon RDS User Guide.
	Iops *int64 `type:"integer"`

	// The Amazon Web Services KMS key identifier for an encrypted DB instance.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key. To use a KMS key in a different Amazon
	// Web Services account, specify the key ARN or alias ARN.
	//
	// If the StorageEncrypted parameter is enabled, and you do not specify a value
	// for the KmsKeyId parameter, then Amazon RDS will use your default KMS key.
	// There is a default KMS key for your Amazon Web Services account. Your Amazon
	// Web Services account has a different default KMS key for each Amazon Web
	// Services Region.
	KmsKeyId *string `type:"string"`

	// The license model for this DB instance. Use general-public-license.
	LicenseModel *string `type:"string"`

	// The password for the master user. The password can include any printable
	// ASCII character except "/", """, or "@".
	//
	// Constraints: Must contain from 8 to 41 characters.
	MasterUserPassword *string `type:"string"`

	// The name for the master user.
	//
	// Constraints:
	//
	//    * Must be 1 to 16 letters or numbers.
	//
	//    * First character must be a letter.
	//
	//    * Can't be a reserved word for the chosen database engine.
	MasterUsername *string `type:"string"`

	// The upper limit in gibibytes (GiB) to which Amazon RDS can automatically
	// scale the storage of the DB instance.
	//
	// For more information about this setting, including limitations that apply
	// to it, see Managing capacity automatically with Amazon RDS storage autoscaling
	// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling)
	// in the Amazon RDS User Guide.
	MaxAllocatedStorage *int64 `type:"integer"`

	// The interval, in seconds, between points when Enhanced Monitoring metrics
	// are collected for the DB instance. To disable collecting Enhanced Monitoring
	// metrics, specify 0.
	//
	// If MonitoringRoleArn is specified, then you must also set MonitoringInterval
	// to a value other than 0.
	//
	// Valid Values: 0, 1, 5, 10, 15, 30, 60
	//
	// Default: 0
	MonitoringInterval *int64 `type:"integer"`

	// The ARN for the IAM role that permits RDS to send enhanced monitoring metrics
	// to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.
	// For information on creating a monitoring role, see Setting Up and Enabling
	// Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling)
	// in the Amazon RDS User Guide.
	//
	// If MonitoringInterval is set to a value other than 0, then you must supply
	// a MonitoringRoleArn value.
	MonitoringRoleArn *string `type:"string"`

	// A value that indicates whether the DB instance is a Multi-AZ deployment.
	// If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone
	// parameter.
	MultiAZ *bool `type:"boolean"`

	// The network type of the DB instance.
	//
	// Valid values:
	//
	//    * IPV4
	//
	//    * DUAL
	//
	// The network type is determined by the DBSubnetGroup specified for the DB
	// instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4
	// and the IPv6 protocols (DUAL).
	//
	// For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
	// in the Amazon RDS User Guide.
	NetworkType *string `type:"string"`

	// The name of the option group to associate with this DB instance. If this
	// argument is omitted, the default option group for the specified engine is
	// used.
	OptionGroupName *string `type:"string"`

	// The Amazon Web Services KMS key identifier for encryption of Performance
	// Insights data.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key.
	//
	// If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon
	// RDS uses your default KMS key. There is a default KMS key for your Amazon
	// Web Services account. Your Amazon Web Services account has a different default
	// KMS key for each Amazon Web Services Region.
	PerformanceInsightsKMSKeyId *string `type:"string"`

	// The number of days to retain Performance Insights data. The default is 7
	// days. The following values are valid:
	//
	//    * 7
	//
	//    * month * 31, where month is a number of months from 1-23
	//
	//    * 731
	//
	// For example, the following values are valid:
	//
	//    * 93 (3 months * 31)
	//
	//    * 341 (11 months * 31)
	//
	//    * 589 (19 months * 31)
	//
	//    * 731
	//
	// If you specify a retention period such as 94, which isn't a valid value,
	// RDS issues an error.
	PerformanceInsightsRetentionPeriod *int64 `type:"integer"`

	// The port number on which the database accepts connections.
	//
	// Type: Integer
	//
	// Valid Values: 1150-65535
	//
	// Default: 3306
	Port *int64 `type:"integer"`

	// The time range each day during which automated backups are created if automated
	// backups are enabled. For more information, see Backup window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow)
	// in the Amazon RDS User Guide.
	//
	// Constraints:
	//
	//    * Must be in the format hh24:mi-hh24:mi.
	//
	//    * Must be in Universal Coordinated Time (UTC).
	//
	//    * Must not conflict with the preferred maintenance window.
	//
	//    * Must be at least 30 minutes.
	PreferredBackupWindow *string `type:"string"`

	// The time range each week during which system maintenance can occur, in Universal
	// Coordinated Time (UTC). For more information, see Amazon RDS Maintenance
	// Window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance)
	// in the Amazon RDS User Guide.
	//
	// Constraints:
	//
	//    * Must be in the format ddd:hh24:mi-ddd:hh24:mi.
	//
	//    * Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
	//
	//    * Must be in Universal Coordinated Time (UTC).
	//
	//    * Must not conflict with the preferred backup window.
	//
	//    * Must be at least 30 minutes.
	PreferredMaintenanceWindow *string `type:"string"`

	// The number of CPU cores and the number of threads per core for the DB instance
	// class of the DB instance.
	ProcessorFeatures []*ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"`

	// A value that indicates whether the DB instance is publicly accessible.
	//
	// When the DB instance is publicly accessible, its Domain Name System (DNS)
	// endpoint resolves to the private IP address from within the DB instance's
	// virtual private cloud (VPC). It resolves to the public IP address from outside
	// of the DB instance's VPC. Access to the DB instance is ultimately controlled
	// by the security group it uses. That public access is not permitted if the
	// security group assigned to the DB instance doesn't permit it.
	//
	// When the DB instance isn't publicly accessible, it is an internal DB instance
	// with a DNS name that resolves to a private IP address.
	//
	// For more information, see CreateDBInstance.
	PubliclyAccessible *bool `type:"boolean"`

	// The name of your Amazon S3 bucket that contains your database backup file.
	//
	// S3BucketName is a required field
	S3BucketName *string `type:"string" required:"true"`

	// An Amazon Web Services Identity and Access Management (IAM) role to allow
	// Amazon RDS to access your Amazon S3 bucket.
	//
	// S3IngestionRoleArn is a required field
	S3IngestionRoleArn *string `type:"string" required:"true"`

	// The prefix of your Amazon S3 bucket.
	S3Prefix *string `type:"string"`

	// The name of the engine of your source database.
	//
	// Valid Values: mysql
	//
	// SourceEngine is a required field
	SourceEngine *string `type:"string" required:"true"`

	// The version of the database that the backup files were created from.
	//
	// MySQL versions 5.6 and 5.7 are supported.
	//
	// Example: 5.6.40
	//
	// SourceEngineVersion is a required field
	SourceEngineVersion *string `type:"string" required:"true"`

	// A value that indicates whether the new DB instance is encrypted or not.
	StorageEncrypted *bool `type:"boolean"`

	// Specifies the storage type to be associated with the DB instance.
	//
	// Valid values: standard | gp2 | io1
	//
	// If you specify io1, you must also include a value for the Iops parameter.
	//
	// Default: io1 if the Iops parameter is specified; otherwise gp2
	StorageType *string `type:"string"`

	// A list of tags to associate with this DB instance. For more information,
	// see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// A value that indicates whether the DB instance class of the DB instance uses
	// its default processor features.
	UseDefaultProcessorFeatures *bool `type:"boolean"`

	// A list of VPC security groups to associate with this DB instance.
	VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"`
	// contains filtered or unexported fields
}

func (RestoreDBInstanceFromS3Input) GoString added in v1.12.30

func (s RestoreDBInstanceFromS3Input) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDBInstanceFromS3Input) SetAllocatedStorage added in v1.12.30

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*RestoreDBInstanceFromS3Input) SetAutoMinorVersionUpgrade added in v1.12.30

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*RestoreDBInstanceFromS3Input) SetAvailabilityZone added in v1.12.30

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*RestoreDBInstanceFromS3Input) SetBackupRetentionPeriod added in v1.12.30

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*RestoreDBInstanceFromS3Input) SetCopyTagsToSnapshot added in v1.12.30

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

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*RestoreDBInstanceFromS3Input) SetDBInstanceClass added in v1.12.30

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*RestoreDBInstanceFromS3Input) SetDBInstanceIdentifier added in v1.12.30

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*RestoreDBInstanceFromS3Input) SetDBName added in v1.12.30

SetDBName sets the DBName field's value.

func (*RestoreDBInstanceFromS3Input) SetDBParameterGroupName added in v1.12.30

func (s *RestoreDBInstanceFromS3Input) SetDBParameterGroupName(v string) *RestoreDBInstanceFromS3Input

SetDBParameterGroupName sets the DBParameterGroupName field's value.

func (*RestoreDBInstanceFromS3Input) SetDBSecurityGroups added in v1.12.30

SetDBSecurityGroups sets the DBSecurityGroups field's value.

func (*RestoreDBInstanceFromS3Input) SetDBSubnetGroupName added in v1.12.30

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*RestoreDBInstanceFromS3Input) SetDeletionProtection added in v1.15.43

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

SetDeletionProtection sets the DeletionProtection field's value.

func (*RestoreDBInstanceFromS3Input) SetEnableCloudwatchLogsExports added in v1.12.63

func (s *RestoreDBInstanceFromS3Input) SetEnableCloudwatchLogsExports(v []*string) *RestoreDBInstanceFromS3Input

SetEnableCloudwatchLogsExports sets the EnableCloudwatchLogsExports field's value.

func (*RestoreDBInstanceFromS3Input) SetEnableIAMDatabaseAuthentication added in v1.12.30

func (s *RestoreDBInstanceFromS3Input) SetEnableIAMDatabaseAuthentication(v bool) *RestoreDBInstanceFromS3Input

SetEnableIAMDatabaseAuthentication sets the EnableIAMDatabaseAuthentication field's value.

func (*RestoreDBInstanceFromS3Input) SetEnablePerformanceInsights added in v1.12.30

func (s *RestoreDBInstanceFromS3Input) SetEnablePerformanceInsights(v bool) *RestoreDBInstanceFromS3Input

SetEnablePerformanceInsights sets the EnablePerformanceInsights field's value.

func (*RestoreDBInstanceFromS3Input) SetEngine added in v1.12.30

SetEngine sets the Engine field's value.

func (*RestoreDBInstanceFromS3Input) SetEngineVersion added in v1.12.30

SetEngineVersion sets the EngineVersion field's value.

func (*RestoreDBInstanceFromS3Input) SetIops added in v1.12.30

SetIops sets the Iops field's value.

func (*RestoreDBInstanceFromS3Input) SetKmsKeyId added in v1.12.30

SetKmsKeyId sets the KmsKeyId field's value.

func (*RestoreDBInstanceFromS3Input) SetLicenseModel added in v1.12.30

SetLicenseModel sets the LicenseModel field's value.

func (*RestoreDBInstanceFromS3Input) SetMasterUserPassword added in v1.12.30

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*RestoreDBInstanceFromS3Input) SetMasterUsername added in v1.12.30

SetMasterUsername sets the MasterUsername field's value.

func (*RestoreDBInstanceFromS3Input) SetMaxAllocatedStorage added in v1.35.6

func (s *RestoreDBInstanceFromS3Input) SetMaxAllocatedStorage(v int64) *RestoreDBInstanceFromS3Input

SetMaxAllocatedStorage sets the MaxAllocatedStorage field's value.

func (*RestoreDBInstanceFromS3Input) SetMonitoringInterval added in v1.12.30

SetMonitoringInterval sets the MonitoringInterval field's value.

func (*RestoreDBInstanceFromS3Input) SetMonitoringRoleArn added in v1.12.30

SetMonitoringRoleArn sets the MonitoringRoleArn field's value.

func (*RestoreDBInstanceFromS3Input) SetMultiAZ added in v1.12.30

SetMultiAZ sets the MultiAZ field's value.

func (*RestoreDBInstanceFromS3Input) SetNetworkType added in v1.44.4

SetNetworkType sets the NetworkType field's value.

func (*RestoreDBInstanceFromS3Input) SetOptionGroupName added in v1.12.30

SetOptionGroupName sets the OptionGroupName field's value.

func (*RestoreDBInstanceFromS3Input) SetPerformanceInsightsKMSKeyId added in v1.12.30

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

SetPerformanceInsightsKMSKeyId sets the PerformanceInsightsKMSKeyId field's value.

func (*RestoreDBInstanceFromS3Input) SetPerformanceInsightsRetentionPeriod added in v1.14.10

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

SetPerformanceInsightsRetentionPeriod sets the PerformanceInsightsRetentionPeriod field's value.

func (*RestoreDBInstanceFromS3Input) SetPort added in v1.12.30

SetPort sets the Port field's value.

func (*RestoreDBInstanceFromS3Input) SetPreferredBackupWindow added in v1.12.30

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*RestoreDBInstanceFromS3Input) SetPreferredMaintenanceWindow added in v1.12.30

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*RestoreDBInstanceFromS3Input) SetProcessorFeatures added in v1.14.1

SetProcessorFeatures sets the ProcessorFeatures field's value.

func (*RestoreDBInstanceFromS3Input) SetPubliclyAccessible added in v1.12.30

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

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*RestoreDBInstanceFromS3Input) SetS3BucketName added in v1.12.30

SetS3BucketName sets the S3BucketName field's value.

func (*RestoreDBInstanceFromS3Input) SetS3IngestionRoleArn added in v1.12.30

SetS3IngestionRoleArn sets the S3IngestionRoleArn field's value.

func (*RestoreDBInstanceFromS3Input) SetS3Prefix added in v1.12.30

SetS3Prefix sets the S3Prefix field's value.

func (*RestoreDBInstanceFromS3Input) SetSourceEngine added in v1.12.30

SetSourceEngine sets the SourceEngine field's value.

func (*RestoreDBInstanceFromS3Input) SetSourceEngineVersion added in v1.12.30

SetSourceEngineVersion sets the SourceEngineVersion field's value.

func (*RestoreDBInstanceFromS3Input) SetStorageEncrypted added in v1.12.30

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*RestoreDBInstanceFromS3Input) SetStorageType added in v1.12.30

SetStorageType sets the StorageType field's value.

func (*RestoreDBInstanceFromS3Input) SetTags added in v1.12.30

SetTags sets the Tags field's value.

func (*RestoreDBInstanceFromS3Input) SetUseDefaultProcessorFeatures added in v1.14.1

func (s *RestoreDBInstanceFromS3Input) SetUseDefaultProcessorFeatures(v bool) *RestoreDBInstanceFromS3Input

SetUseDefaultProcessorFeatures sets the UseDefaultProcessorFeatures field's value.

func (*RestoreDBInstanceFromS3Input) SetVpcSecurityGroupIds added in v1.12.30

func (s *RestoreDBInstanceFromS3Input) SetVpcSecurityGroupIds(v []*string) *RestoreDBInstanceFromS3Input

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (RestoreDBInstanceFromS3Input) String added in v1.12.30

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDBInstanceFromS3Input) Validate added in v1.12.30

func (s *RestoreDBInstanceFromS3Input) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RestoreDBInstanceFromS3Output added in v1.12.30

type RestoreDBInstanceFromS3Output struct {

	// Contains the details of an Amazon RDS DB instance.
	//
	// This data type is used as a response element in the operations CreateDBInstance,
	// CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance,
	// PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,
	// RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
	DBInstance *DBInstance `type:"structure"`
	// contains filtered or unexported fields
}

func (RestoreDBInstanceFromS3Output) GoString added in v1.12.30

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDBInstanceFromS3Output) SetDBInstance added in v1.12.30

SetDBInstance sets the DBInstance field's value.

func (RestoreDBInstanceFromS3Output) String added in v1.12.30

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RestoreDBInstanceToPointInTimeInput

type RestoreDBInstanceToPointInTimeInput struct {

	// A value that indicates whether minor version upgrades are applied automatically
	// to the DB instance during the maintenance window.
	//
	// This setting doesn't apply to RDS Custom.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// The Availability Zone (AZ) where the DB instance will be created.
	//
	// Default: A random, system-chosen Availability Zone.
	//
	// Constraint: You can't specify the AvailabilityZone parameter if the DB instance
	// is a Multi-AZ deployment.
	//
	// Example: us-east-1a
	AvailabilityZone *string `type:"string"`

	// Specifies where automated backups and manual snapshots are stored for the
	// restored DB instance.
	//
	// Possible values are outposts (Amazon Web Services Outposts) and region (Amazon
	// Web Services Region). The default is region.
	//
	// For more information, see Working with Amazon RDS on Amazon Web Services
	// Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)
	// in the Amazon RDS User Guide.
	BackupTarget *string `type:"string"`

	// A value that indicates whether to copy all tags from the restored DB instance
	// to snapshots of the DB instance. By default, tags are not copied.
	CopyTagsToSnapshot *bool `type:"boolean"`

	// The instance profile associated with the underlying Amazon EC2 instance of
	// an RDS Custom DB instance. The instance profile must meet the following requirements:
	//
	//    * The profile must exist in your account.
	//
	//    * The profile must have an IAM role that Amazon EC2 has permissions to
	//    assume.
	//
	//    * The instance profile name and the associated IAM role name must start
	//    with the prefix AWSRDSCustom.
	//
	// For the list of permissions required for the IAM role, see Configure IAM
	// and your VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc)
	// in the Amazon RDS User Guide.
	//
	// This setting is required for RDS Custom.
	CustomIamInstanceProfile *string `type:"string"`

	// The compute and memory capacity of the Amazon RDS DB instance, for example
	// db.m4.large. Not all DB instance classes are available in all Amazon Web
	// Services Regions, or for all database engines. For the full list of DB instance
	// classes, and availability for your engine, see DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)
	// in the Amazon RDS User Guide.
	//
	// Default: The same DBInstanceClass as the original DB instance.
	DBInstanceClass *string `type:"string"`

	// The database name for the restored DB instance.
	//
	// This parameter isn't supported for the MySQL or MariaDB engines. It also
	// doesn't apply to RDS Custom.
	DBName *string `type:"string"`

	// The name of the DB parameter group to associate with this DB instance.
	//
	// If you do not specify a value for DBParameterGroupName, then the default
	// DBParameterGroup for the specified DB engine is used.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Constraints:
	//
	//    * If supplied, must match the name of an existing DBParameterGroup.
	//
	//    * Must be 1 to 255 letters, numbers, or hyphens.
	//
	//    * First character must be a letter.
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens.
	DBParameterGroupName *string `type:"string"`

	// The DB subnet group name to use for the new instance.
	//
	// Constraints: If supplied, must match the name of an existing DBSubnetGroup.
	//
	// Example: mydbsubnetgroup
	DBSubnetGroupName *string `type:"string"`

	// A value that indicates whether the DB instance has deletion protection enabled.
	// The database can't be deleted when deletion protection is enabled. By default,
	// deletion protection isn't enabled. For more information, see Deleting a DB
	// Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
	DeletionProtection *bool `type:"boolean"`

	// Specify the Active Directory directory ID to restore the DB instance in.
	// Create the domain before running this command. Currently, you can create
	// only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances
	// in an Active Directory Domain.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html)
	// in the Amazon RDS User Guide.
	Domain *string `type:"string"`

	// Specify the name of the IAM role to be used when making API calls to the
	// Directory Service.
	//
	// This setting doesn't apply to RDS Custom.
	DomainIAMRoleName *string `type:"string"`

	// The list of logs that the restored DB instance is to export to CloudWatch
	// Logs. The values in the list depend on the DB engine being used. For more
	// information, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
	// in the Amazon RDS User Guide.
	//
	// This setting doesn't apply to RDS Custom.
	EnableCloudwatchLogsExports []*string `type:"list"`

	// A value that indicates whether to enable a customer-owned IP address (CoIP)
	// for an RDS on Outposts DB instance.
	//
	// A CoIP provides local or external connectivity to resources in your Outpost
	// subnets through your on-premises network. For some use cases, a CoIP can
	// provide lower latency for connections to the DB instance from outside of
	// its virtual private cloud (VPC) on your local network.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// For more information about RDS on Outposts, see Working with Amazon RDS on
	// Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)
	// in the Amazon RDS User Guide.
	//
	// For more information about CoIPs, see Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing)
	// in the Amazon Web Services Outposts User Guide.
	EnableCustomerOwnedIp *bool `type:"boolean"`

	// A value that indicates whether to enable mapping of Amazon Web Services Identity
	// and Access Management (IAM) accounts to database accounts. By default, mapping
	// isn't enabled.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// For more information about IAM database authentication, see IAM Database
	// Authentication for MySQL and PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html)
	// in the Amazon RDS User Guide.
	EnableIAMDatabaseAuthentication *bool `type:"boolean"`

	// The database engine to use for the new instance.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Default: The same as source
	//
	// Constraint: Must be compatible with the engine of the source
	//
	// Valid Values:
	//
	//    * mariadb
	//
	//    * mysql
	//
	//    * oracle-ee
	//
	//    * oracle-ee-cdb
	//
	//    * oracle-se2
	//
	//    * oracle-se2-cdb
	//
	//    * postgres
	//
	//    * sqlserver-ee
	//
	//    * sqlserver-se
	//
	//    * sqlserver-ex
	//
	//    * sqlserver-web
	Engine *string `type:"string"`

	// The amount of Provisioned IOPS (input/output operations per second) to be
	// initially allocated for the DB instance.
	//
	// Constraints: Must be an integer greater than 1000.
	//
	// SQL Server
	//
	// Setting the IOPS value for the SQL Server database engine isn't supported.
	Iops *int64 `type:"integer"`

	// License model information for the restored DB instance.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Default: Same as source.
	//
	// Valid values: license-included | bring-your-own-license | general-public-license
	LicenseModel *string `type:"string"`

	// The upper limit in gibibytes (GiB) to which Amazon RDS can automatically
	// scale the storage of the DB instance.
	//
	// For more information about this setting, including limitations that apply
	// to it, see Managing capacity automatically with Amazon RDS storage autoscaling
	// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling)
	// in the Amazon RDS User Guide.
	//
	// This setting doesn't apply to RDS Custom.
	MaxAllocatedStorage *int64 `type:"integer"`

	// A value that indicates whether the DB instance is a Multi-AZ deployment.
	//
	// This setting doesn't apply to RDS Custom.
	//
	// Constraint: You can't specify the AvailabilityZone parameter if the DB instance
	// is a Multi-AZ deployment.
	MultiAZ *bool `type:"boolean"`

	// The network type of the DB instance.
	//
	// Valid values:
	//
	//    * IPV4
	//
	//    * DUAL
	//
	// The network type is determined by the DBSubnetGroup specified for the DB
	// instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4
	// and the IPv6 protocols (DUAL).
	//
	// For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
	// in the Amazon RDS User Guide.
	NetworkType *string `type:"string"`

	// The name of the option group to be used for the restored DB instance.
	//
	// Permanent options, such as the TDE option for Oracle Advanced Security TDE,
	// can't be removed from an option group, and that option group can't be removed
	// from a DB instance after it is associated with a DB instance
	//
	// This setting doesn't apply to RDS Custom.
	OptionGroupName *string `type:"string"`

	// The port number on which the database accepts connections.
	//
	// Constraints: Value must be 1150-65535
	//
	// Default: The same port as the original DB instance.
	Port *int64 `type:"integer"`

	// The number of CPU cores and the number of threads per core for the DB instance
	// class of the DB instance.
	//
	// This setting doesn't apply to RDS Custom.
	ProcessorFeatures []*ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"`

	// A value that indicates whether the DB instance is publicly accessible.
	//
	// When the DB cluster is publicly accessible, its Domain Name System (DNS)
	// endpoint resolves to the private IP address from within the DB cluster's
	// virtual private cloud (VPC). It resolves to the public IP address from outside
	// of the DB cluster's VPC. Access to the DB cluster is ultimately controlled
	// by the security group it uses. That public access isn't permitted if the
	// security group assigned to the DB cluster doesn't permit it.
	//
	// When the DB instance isn't publicly accessible, it is an internal DB instance
	// with a DNS name that resolves to a private IP address.
	//
	// For more information, see CreateDBInstance.
	PubliclyAccessible *bool `type:"boolean"`

	// The date and time to restore from.
	//
	// Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
	//
	// Constraints:
	//
	//    * Must be before the latest restorable time for the DB instance
	//
	//    * Can't be specified if the UseLatestRestorableTime parameter is enabled
	//
	// Example: 2009-09-07T23:45:00Z
	RestoreTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of the replicated automated backups from which
	// to restore, for example, arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
	//
	// This setting doesn't apply to RDS Custom.
	SourceDBInstanceAutomatedBackupsArn *string `type:"string"`

	// The identifier of the source DB instance from which to restore.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DB instance.
	SourceDBInstanceIdentifier *string `type:"string"`

	// The resource ID of the source DB instance from which to restore.
	SourceDbiResourceId *string `type:"string"`

	// Specifies the storage type to be associated with the DB instance.
	//
	// Valid values: standard | gp2 | io1
	//
	// If you specify io1, you must also include a value for the Iops parameter.
	//
	// Default: io1 if the Iops parameter is specified, otherwise gp2
	StorageType *string `type:"string"`

	// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
	// in the Amazon RDS User Guide.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// The name of the new DB instance to be created.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 letters, numbers, or hyphens
	//
	//    * First character must be a letter
	//
	//    * Can't end with a hyphen or contain two consecutive hyphens
	//
	// TargetDBInstanceIdentifier is a required field
	TargetDBInstanceIdentifier *string `type:"string" required:"true"`

	// The ARN from the key store with which to associate the instance for TDE encryption.
	//
	// This setting doesn't apply to RDS Custom.
	TdeCredentialArn *string `type:"string"`

	// The password for the given ARN from the key store in order to access the
	// device.
	//
	// This setting doesn't apply to RDS Custom.
	TdeCredentialPassword *string `type:"string"`

	// A value that indicates whether the DB instance class of the DB instance uses
	// its default processor features.
	//
	// This setting doesn't apply to RDS Custom.
	UseDefaultProcessorFeatures *bool `type:"boolean"`

	// A value that indicates whether the DB instance is restored from the latest
	// backup time. By default, the DB instance isn't restored from the latest backup
	// time.
	//
	// Constraints: Can't be specified if the RestoreTime parameter is provided.
	UseLatestRestorableTime *bool `type:"boolean"`

	// A list of EC2 VPC security groups to associate with this DB instance.
	//
	// Default: The default EC2 VPC security group for the DB subnet group's VPC.
	VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"`
	// contains filtered or unexported fields
}

func (RestoreDBInstanceToPointInTimeInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDBInstanceToPointInTimeInput) SetAutoMinorVersionUpgrade added in v1.5.0

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetAvailabilityZone added in v1.5.0

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetBackupTarget added in v1.42.10

SetBackupTarget sets the BackupTarget field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetCopyTagsToSnapshot added in v1.5.0

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetCustomIamInstanceProfile added in v1.41.10

SetCustomIamInstanceProfile sets the CustomIamInstanceProfile field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetDBInstanceClass added in v1.5.0

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetDBName added in v1.5.0

SetDBName sets the DBName field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetDBParameterGroupName added in v1.15.55

SetDBParameterGroupName sets the DBParameterGroupName field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetDBSubnetGroupName added in v1.5.0

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetDeletionProtection added in v1.15.43

SetDeletionProtection sets the DeletionProtection field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetDomainIAMRoleName added in v1.5.0

SetDomainIAMRoleName sets the DomainIAMRoleName field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetEnableCloudwatchLogsExports added in v1.12.63

func (s *RestoreDBInstanceToPointInTimeInput) SetEnableCloudwatchLogsExports(v []*string) *RestoreDBInstanceToPointInTimeInput

SetEnableCloudwatchLogsExports sets the EnableCloudwatchLogsExports field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetEnableCustomerOwnedIp added in v1.36.14

SetEnableCustomerOwnedIp sets the EnableCustomerOwnedIp field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetEnableIAMDatabaseAuthentication added in v1.8.17

func (s *RestoreDBInstanceToPointInTimeInput) SetEnableIAMDatabaseAuthentication(v bool) *RestoreDBInstanceToPointInTimeInput

SetEnableIAMDatabaseAuthentication sets the EnableIAMDatabaseAuthentication field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetEngine added in v1.5.0

SetEngine sets the Engine field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetIops added in v1.5.0

SetIops sets the Iops field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetLicenseModel added in v1.5.0

SetLicenseModel sets the LicenseModel field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetMaxAllocatedStorage added in v1.35.6

SetMaxAllocatedStorage sets the MaxAllocatedStorage field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetMultiAZ added in v1.5.0

SetMultiAZ sets the MultiAZ field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetNetworkType added in v1.44.4

SetNetworkType sets the NetworkType field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetOptionGroupName added in v1.5.0

SetOptionGroupName sets the OptionGroupName field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetPort added in v1.5.0

SetPort sets the Port field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetProcessorFeatures added in v1.14.1

SetProcessorFeatures sets the ProcessorFeatures field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetPubliclyAccessible added in v1.5.0

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetRestoreTime added in v1.5.0

SetRestoreTime sets the RestoreTime field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetSourceDBInstanceAutomatedBackupsArn added in v1.36.2

func (s *RestoreDBInstanceToPointInTimeInput) SetSourceDBInstanceAutomatedBackupsArn(v string) *RestoreDBInstanceToPointInTimeInput

SetSourceDBInstanceAutomatedBackupsArn sets the SourceDBInstanceAutomatedBackupsArn field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetSourceDBInstanceIdentifier added in v1.5.0

SetSourceDBInstanceIdentifier sets the SourceDBInstanceIdentifier field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetSourceDbiResourceId added in v1.15.77

SetSourceDbiResourceId sets the SourceDbiResourceId field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetStorageType added in v1.5.0

SetStorageType sets the StorageType field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetTargetDBInstanceIdentifier added in v1.5.0

SetTargetDBInstanceIdentifier sets the TargetDBInstanceIdentifier field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetTdeCredentialArn added in v1.5.0

SetTdeCredentialArn sets the TdeCredentialArn field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetTdeCredentialPassword added in v1.5.0

SetTdeCredentialPassword sets the TdeCredentialPassword field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetUseDefaultProcessorFeatures added in v1.14.1

SetUseDefaultProcessorFeatures sets the UseDefaultProcessorFeatures field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetUseLatestRestorableTime added in v1.5.0

SetUseLatestRestorableTime sets the UseLatestRestorableTime field's value.

func (*RestoreDBInstanceToPointInTimeInput) SetVpcSecurityGroupIds added in v1.15.79

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (RestoreDBInstanceToPointInTimeInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDBInstanceToPointInTimeInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type RestoreDBInstanceToPointInTimeOutput

type RestoreDBInstanceToPointInTimeOutput struct {

	// Contains the details of an Amazon RDS DB instance.
	//
	// This data type is used as a response element in the operations CreateDBInstance,
	// CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance,
	// PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,
	// RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
	DBInstance *DBInstance `type:"structure"`
	// contains filtered or unexported fields
}

func (RestoreDBInstanceToPointInTimeOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreDBInstanceToPointInTimeOutput) SetDBInstance added in v1.5.0

SetDBInstance sets the DBInstance field's value.

func (RestoreDBInstanceToPointInTimeOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RestoreWindow added in v1.15.77

type RestoreWindow struct {

	// The earliest time you can restore an instance to.
	EarliestTime *time.Time `type:"timestamp"`

	// The latest time you can restore an instance to.
	LatestTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Earliest and latest time an instance can be restored to:

func (RestoreWindow) GoString added in v1.15.77

func (s RestoreWindow) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreWindow) SetEarliestTime added in v1.15.77

func (s *RestoreWindow) SetEarliestTime(v time.Time) *RestoreWindow

SetEarliestTime sets the EarliestTime field's value.

func (*RestoreWindow) SetLatestTime added in v1.15.77

func (s *RestoreWindow) SetLatestTime(v time.Time) *RestoreWindow

SetLatestTime sets the LatestTime field's value.

func (RestoreWindow) String added in v1.15.77

func (s RestoreWindow) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RevokeDBSecurityGroupIngressInput

type RevokeDBSecurityGroupIngressInput struct {

	// The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP
	// is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId
	// can't be provided.
	CIDRIP *string `type:"string"`

	// The name of the DB security group to revoke ingress from.
	//
	// DBSecurityGroupName is a required field
	DBSecurityGroupName *string `type:"string" required:"true"`

	// The id of the EC2 security group to revoke access from. For VPC DB security
	// groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId
	// and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
	EC2SecurityGroupId *string `type:"string"`

	// The name of the EC2 security group to revoke access from. For VPC DB security
	// groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId
	// and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
	EC2SecurityGroupName *string `type:"string"`

	// The Amazon Web Services account number of the owner of the EC2 security group
	// specified in the EC2SecurityGroupName parameter. The Amazon Web Services
	// access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId
	// must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName
	// or EC2SecurityGroupId must be provided.
	EC2SecurityGroupOwnerId *string `type:"string"`
	// contains filtered or unexported fields
}

func (RevokeDBSecurityGroupIngressInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RevokeDBSecurityGroupIngressInput) SetCIDRIP added in v1.5.0

SetCIDRIP sets the CIDRIP field's value.

func (*RevokeDBSecurityGroupIngressInput) SetDBSecurityGroupName added in v1.5.0

SetDBSecurityGroupName sets the DBSecurityGroupName field's value.

func (*RevokeDBSecurityGroupIngressInput) SetEC2SecurityGroupId added in v1.5.0

SetEC2SecurityGroupId sets the EC2SecurityGroupId field's value.

func (*RevokeDBSecurityGroupIngressInput) SetEC2SecurityGroupName added in v1.5.0

SetEC2SecurityGroupName sets the EC2SecurityGroupName field's value.

func (*RevokeDBSecurityGroupIngressInput) SetEC2SecurityGroupOwnerId added in v1.5.0

SetEC2SecurityGroupOwnerId sets the EC2SecurityGroupOwnerId field's value.

func (RevokeDBSecurityGroupIngressInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RevokeDBSecurityGroupIngressInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type RevokeDBSecurityGroupIngressOutput

type RevokeDBSecurityGroupIngressOutput struct {

	// Contains the details for an Amazon RDS DB security group.
	//
	// This data type is used as a response element in the DescribeDBSecurityGroups
	// action.
	DBSecurityGroup *DBSecurityGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (RevokeDBSecurityGroupIngressOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RevokeDBSecurityGroupIngressOutput) SetDBSecurityGroup added in v1.5.0

SetDBSecurityGroup sets the DBSecurityGroup field's value.

func (RevokeDBSecurityGroupIngressOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ScalingConfiguration added in v1.15.9

type ScalingConfiguration struct {

	// A value that indicates whether to allow or disallow automatic pause for an
	// Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused
	// only when it's idle (it has no connections).
	//
	// If a DB cluster is paused for more than seven days, the DB cluster might
	// be backed up with a snapshot. In this case, the DB cluster is restored when
	// there is a request to connect to it.
	AutoPause *bool `type:"boolean"`

	// The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
	//
	// For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128,
	// and 256.
	//
	// For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192,
	// and 384.
	//
	// The maximum capacity must be greater than or equal to the minimum capacity.
	MaxCapacity *int64 `type:"integer"`

	// The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
	//
	// For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128,
	// and 256.
	//
	// For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192,
	// and 384.
	//
	// The minimum capacity must be less than or equal to the maximum capacity.
	MinCapacity *int64 `type:"integer"`

	// The amount of time, in seconds, that Aurora Serverless v1 tries to find a
	// scaling point to perform seamless scaling before enforcing the timeout action.
	// The default is 300.
	//
	// Specify a value between 60 and 600 seconds.
	SecondsBeforeTimeout *int64 `type:"integer"`

	// The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
	//
	// Specify a value between 300 and 86,400 seconds.
	SecondsUntilAutoPause *int64 `type:"integer"`

	// The action to take when the timeout is reached, either ForceApplyCapacityChange
	// or RollbackCapacityChange.
	//
	// ForceApplyCapacityChange sets the capacity to the specified value as soon
	// as possible.
	//
	// RollbackCapacityChange, the default, ignores the capacity change if a scaling
	// point isn't found in the timeout period.
	//
	// If you specify ForceApplyCapacityChange, connections that prevent Aurora
	// Serverless v1 from finding a scaling point might be dropped.
	//
	// For more information, see Autoscaling for Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling)
	// in the Amazon Aurora User Guide.
	TimeoutAction *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the scaling configuration of an Aurora Serverless v1 DB cluster.

For more information, see Using Amazon Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) in the Amazon Aurora User Guide.

func (ScalingConfiguration) GoString added in v1.15.9

func (s ScalingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScalingConfiguration) SetAutoPause added in v1.15.9

func (s *ScalingConfiguration) SetAutoPause(v bool) *ScalingConfiguration

SetAutoPause sets the AutoPause field's value.

func (*ScalingConfiguration) SetMaxCapacity added in v1.15.9

func (s *ScalingConfiguration) SetMaxCapacity(v int64) *ScalingConfiguration

SetMaxCapacity sets the MaxCapacity field's value.

func (*ScalingConfiguration) SetMinCapacity added in v1.15.9

func (s *ScalingConfiguration) SetMinCapacity(v int64) *ScalingConfiguration

SetMinCapacity sets the MinCapacity field's value.

func (*ScalingConfiguration) SetSecondsBeforeTimeout added in v1.40.41

func (s *ScalingConfiguration) SetSecondsBeforeTimeout(v int64) *ScalingConfiguration

SetSecondsBeforeTimeout sets the SecondsBeforeTimeout field's value.

func (*ScalingConfiguration) SetSecondsUntilAutoPause added in v1.15.9

func (s *ScalingConfiguration) SetSecondsUntilAutoPause(v int64) *ScalingConfiguration

SetSecondsUntilAutoPause sets the SecondsUntilAutoPause field's value.

func (*ScalingConfiguration) SetTimeoutAction added in v1.19.14

func (s *ScalingConfiguration) SetTimeoutAction(v string) *ScalingConfiguration

SetTimeoutAction sets the TimeoutAction field's value.

func (ScalingConfiguration) String added in v1.15.9

func (s ScalingConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ScalingConfigurationInfo added in v1.15.9

type ScalingConfigurationInfo struct {

	// A value that indicates whether automatic pause is allowed for the Aurora
	// DB cluster in serverless DB engine mode.
	//
	// When the value is set to false for an Aurora Serverless v1 DB cluster, the
	// DB cluster automatically resumes.
	AutoPause *bool `type:"boolean"`

	// The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
	MaxCapacity *int64 `type:"integer"`

	// The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
	MinCapacity *int64 `type:"integer"`

	// The number of seconds before scaling times out. What happens when an attempted
	// scaling action times out is determined by the TimeoutAction setting.
	SecondsBeforeTimeout *int64 `type:"integer"`

	// The remaining amount of time, in seconds, before the Aurora DB cluster in
	// serverless mode is paused. A DB cluster can be paused only when it's idle
	// (it has no connections).
	SecondsUntilAutoPause *int64 `type:"integer"`

	// The action that occurs when Aurora times out while attempting to change the
	// capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange
	// or RollbackCapacityChange.
	//
	// ForceApplyCapacityChange, the default, sets the capacity to the specified
	// value as soon as possible.
	//
	// RollbackCapacityChange ignores the capacity change if a scaling point isn't
	// found in the timeout period.
	TimeoutAction *string `type:"string"`
	// contains filtered or unexported fields
}

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

For more information, see Using Amazon Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) in the Amazon Aurora User Guide.

func (ScalingConfigurationInfo) GoString added in v1.15.9

func (s ScalingConfigurationInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScalingConfigurationInfo) SetAutoPause added in v1.15.9

SetAutoPause sets the AutoPause field's value.

func (*ScalingConfigurationInfo) SetMaxCapacity added in v1.15.9

SetMaxCapacity sets the MaxCapacity field's value.

func (*ScalingConfigurationInfo) SetMinCapacity added in v1.15.9

SetMinCapacity sets the MinCapacity field's value.

func (*ScalingConfigurationInfo) SetSecondsBeforeTimeout added in v1.40.41

func (s *ScalingConfigurationInfo) SetSecondsBeforeTimeout(v int64) *ScalingConfigurationInfo

SetSecondsBeforeTimeout sets the SecondsBeforeTimeout field's value.

func (*ScalingConfigurationInfo) SetSecondsUntilAutoPause added in v1.15.9

func (s *ScalingConfigurationInfo) SetSecondsUntilAutoPause(v int64) *ScalingConfigurationInfo

SetSecondsUntilAutoPause sets the SecondsUntilAutoPause field's value.

func (*ScalingConfigurationInfo) SetTimeoutAction added in v1.19.14

SetTimeoutAction sets the TimeoutAction field's value.

func (ScalingConfigurationInfo) String added in v1.15.9

func (s ScalingConfigurationInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServerlessV2ScalingConfiguration added in v1.43.43

type ServerlessV2ScalingConfiguration struct {

	// The maximum number of Aurora capacity units (ACUs) for a DB instance in an
	// Aurora Serverless v2 cluster. You can specify ACU values in half-step increments,
	// such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
	MaxCapacity *float64 `type:"double"`

	// The minimum number of Aurora capacity units (ACUs) for a DB instance in an
	// Aurora Serverless v2 cluster. You can specify ACU values in half-step increments,
	// such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
	MinCapacity *float64 `type:"double"`
	// contains filtered or unexported fields
}

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

For more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) in the Amazon Aurora User Guide.

func (ServerlessV2ScalingConfiguration) GoString added in v1.43.43

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServerlessV2ScalingConfiguration) SetMaxCapacity added in v1.43.43

SetMaxCapacity sets the MaxCapacity field's value.

func (*ServerlessV2ScalingConfiguration) SetMinCapacity added in v1.43.43

SetMinCapacity sets the MinCapacity field's value.

func (ServerlessV2ScalingConfiguration) String added in v1.43.43

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServerlessV2ScalingConfigurationInfo added in v1.43.43

type ServerlessV2ScalingConfigurationInfo struct {

	// The maximum number of Aurora capacity units (ACUs) for a DB instance in an
	// Aurora Serverless v2 cluster. You can specify ACU values in half-step increments,
	// such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
	MaxCapacity *float64 `type:"double"`

	// The minimum number of Aurora capacity units (ACUs) for a DB instance in an
	// Aurora Serverless v2 cluster. You can specify ACU values in half-step increments,
	// such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
	MinCapacity *float64 `type:"double"`
	// contains filtered or unexported fields
}

Shows the scaling configuration for an Aurora Serverless v2 DB cluster.

For more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) in the Amazon Aurora User Guide.

func (ServerlessV2ScalingConfigurationInfo) GoString added in v1.43.43

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServerlessV2ScalingConfigurationInfo) SetMaxCapacity added in v1.43.43

SetMaxCapacity sets the MaxCapacity field's value.

func (*ServerlessV2ScalingConfigurationInfo) SetMinCapacity added in v1.43.43

SetMinCapacity sets the MinCapacity field's value.

func (ServerlessV2ScalingConfigurationInfo) String added in v1.43.43

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SourceRegion added in v1.4.7

type SourceRegion struct {

	// The endpoint for the source Amazon Web Services Region endpoint.
	Endpoint *string `type:"string"`

	// The name of the source Amazon Web Services Region.
	RegionName *string `type:"string"`

	// The status of the source Amazon Web Services Region.
	Status *string `type:"string"`

	// Whether the source Amazon Web Services Region supports replicating automated
	// backups to the current Amazon Web Services Region.
	SupportsDBInstanceAutomatedBackupsReplication *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions action.

func (SourceRegion) GoString added in v1.4.7

func (s SourceRegion) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SourceRegion) SetEndpoint added in v1.5.0

func (s *SourceRegion) SetEndpoint(v string) *SourceRegion

SetEndpoint sets the Endpoint field's value.

func (*SourceRegion) SetRegionName added in v1.5.0

func (s *SourceRegion) SetRegionName(v string) *SourceRegion

SetRegionName sets the RegionName field's value.

func (*SourceRegion) SetStatus added in v1.5.0

func (s *SourceRegion) SetStatus(v string) *SourceRegion

SetStatus sets the Status field's value.

func (*SourceRegion) SetSupportsDBInstanceAutomatedBackupsReplication added in v1.36.2

func (s *SourceRegion) SetSupportsDBInstanceAutomatedBackupsReplication(v bool) *SourceRegion

SetSupportsDBInstanceAutomatedBackupsReplication sets the SupportsDBInstanceAutomatedBackupsReplication field's value.

func (SourceRegion) String added in v1.4.7

func (s SourceRegion) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartActivityStreamInput added in v1.19.41

type StartActivityStreamInput struct {

	// Specifies whether or not the database activity stream is to start as soon
	// as possible, regardless of the maintenance window for the database.
	ApplyImmediately *bool `type:"boolean"`

	// Specifies whether the database activity stream includes engine-native audit
	// fields. This option only applies to an Oracle DB instance. By default, no
	// engine-native audit fields are included.
	EngineNativeAuditFieldsIncluded *bool `type:"boolean"`

	// The Amazon Web Services KMS key identifier for encrypting messages in the
	// database activity stream. The Amazon Web Services KMS key identifier is the
	// key ARN, key ID, alias ARN, or alias name for the KMS key.
	//
	// KmsKeyId is a required field
	KmsKeyId *string `type:"string" required:"true"`

	// Specifies the mode of the database activity stream. Database events such
	// as a change or access generate an activity stream event. The database session
	// can handle these events either synchronously or asynchronously.
	//
	// Mode is a required field
	Mode *string `type:"string" required:"true" enum:"ActivityStreamMode"`

	// The Amazon Resource Name (ARN) of the DB cluster, for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartActivityStreamInput) GoString added in v1.19.41

func (s StartActivityStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartActivityStreamInput) SetApplyImmediately added in v1.19.41

func (s *StartActivityStreamInput) SetApplyImmediately(v bool) *StartActivityStreamInput

SetApplyImmediately sets the ApplyImmediately field's value.

func (*StartActivityStreamInput) SetEngineNativeAuditFieldsIncluded added in v1.38.64

func (s *StartActivityStreamInput) SetEngineNativeAuditFieldsIncluded(v bool) *StartActivityStreamInput

SetEngineNativeAuditFieldsIncluded sets the EngineNativeAuditFieldsIncluded field's value.

func (*StartActivityStreamInput) SetKmsKeyId added in v1.19.41

SetKmsKeyId sets the KmsKeyId field's value.

func (*StartActivityStreamInput) SetMode added in v1.19.41

SetMode sets the Mode field's value.

func (*StartActivityStreamInput) SetResourceArn added in v1.19.41

SetResourceArn sets the ResourceArn field's value.

func (StartActivityStreamInput) String added in v1.19.41

func (s StartActivityStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartActivityStreamInput) Validate added in v1.19.41

func (s *StartActivityStreamInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartActivityStreamOutput added in v1.19.41

type StartActivityStreamOutput struct {

	// Indicates whether or not the database activity stream will start as soon
	// as possible, regardless of the maintenance window for the database.
	ApplyImmediately *bool `type:"boolean"`

	// Indicates whether engine-native audit fields are included in the database
	// activity stream.
	EngineNativeAuditFieldsIncluded *bool `type:"boolean"`

	// The name of the Amazon Kinesis data stream to be used for the database activity
	// stream.
	KinesisStreamName *string `type:"string"`

	// The Amazon Web Services KMS key identifier for encryption of messages in
	// the database activity stream.
	KmsKeyId *string `type:"string"`

	// The mode of the database activity stream.
	Mode *string `type:"string" enum:"ActivityStreamMode"`

	// The status of the database activity stream.
	Status *string `type:"string" enum:"ActivityStreamStatus"`
	// contains filtered or unexported fields
}

func (StartActivityStreamOutput) GoString added in v1.19.41

func (s StartActivityStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartActivityStreamOutput) SetApplyImmediately added in v1.19.41

func (s *StartActivityStreamOutput) SetApplyImmediately(v bool) *StartActivityStreamOutput

SetApplyImmediately sets the ApplyImmediately field's value.

func (*StartActivityStreamOutput) SetEngineNativeAuditFieldsIncluded added in v1.38.64

func (s *StartActivityStreamOutput) SetEngineNativeAuditFieldsIncluded(v bool) *StartActivityStreamOutput

SetEngineNativeAuditFieldsIncluded sets the EngineNativeAuditFieldsIncluded field's value.

func (*StartActivityStreamOutput) SetKinesisStreamName added in v1.19.41

func (s *StartActivityStreamOutput) SetKinesisStreamName(v string) *StartActivityStreamOutput

SetKinesisStreamName sets the KinesisStreamName field's value.

func (*StartActivityStreamOutput) SetKmsKeyId added in v1.19.41

SetKmsKeyId sets the KmsKeyId field's value.

func (*StartActivityStreamOutput) SetMode added in v1.19.41

SetMode sets the Mode field's value.

func (*StartActivityStreamOutput) SetStatus added in v1.19.41

SetStatus sets the Status field's value.

func (StartActivityStreamOutput) String added in v1.19.41

func (s StartActivityStreamOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartDBClusterInput added in v1.15.39

type StartDBClusterInput struct {

	// The DB cluster identifier of the Amazon Aurora DB cluster to be started.
	// This parameter is stored as a lowercase string.
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartDBClusterInput) GoString added in v1.15.39

func (s StartDBClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDBClusterInput) SetDBClusterIdentifier added in v1.15.39

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (StartDBClusterInput) String added in v1.15.39

func (s StartDBClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDBClusterInput) Validate added in v1.15.39

func (s *StartDBClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartDBClusterOutput added in v1.15.39

type StartDBClusterOutput struct {

	// Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
	//
	// For an Amazon Aurora DB cluster, this data type is used as a response element
	// in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot,
	// RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
	//
	// For a Multi-AZ DB cluster, this data type is used as a response element in
	// the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
	//
	// For more information on Amazon Aurora DB clusters, see What is Amazon Aurora?
	// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)
	// in the Amazon Aurora User Guide.
	//
	// For more information on Multi-AZ DB clusters, see Multi-AZ deployments with
	// two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
	// in the Amazon RDS User Guide.
	DBCluster *DBCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (StartDBClusterOutput) GoString added in v1.15.39

func (s StartDBClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDBClusterOutput) SetDBCluster added in v1.15.39

SetDBCluster sets the DBCluster field's value.

func (StartDBClusterOutput) String added in v1.15.39

func (s StartDBClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartDBInstanceAutomatedBackupsReplicationInput added in v1.36.2

type StartDBInstanceAutomatedBackupsReplicationInput struct {

	// The retention period for the replicated automated backups.
	BackupRetentionPeriod *int64 `type:"integer"`

	// DestinationRegion is used for presigning the request to a given region.
	DestinationRegion *string `type:"string"`

	// The Amazon Web Services KMS key identifier for encryption of the replicated
	// automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the
	// KMS encryption key in the destination Amazon Web Services Region, for example,
	// arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.
	KmsKeyId *string `type:"string"`

	// In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature
	// Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication
	// operation to call in the Amazon Web Services Region of the source DB instance.
	// The presigned URL must be a valid request for the StartDBInstanceAutomatedBackupsReplication
	// API operation that can run in the Amazon Web Services Region that contains
	// the source DB instance.
	//
	// This setting applies only to Amazon Web Services GovCloud (US) Regions. It's
	// ignored in other Amazon Web Services Regions.
	//
	// To learn how to generate a Signature Version 4 signed request, see Authenticating
	// Requests: Using Query Parameters (Amazon Web Services Signature Version 4)
	// (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html)
	// and Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).
	//
	// If you are using an Amazon Web Services SDK tool or the CLI, you can specify
	// SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl
	// manually. Specifying SourceRegion autogenerates a presigned URL that is a
	// valid request for the operation that can run in the source Amazon Web Services
	// Region.
	PreSignedUrl *string `type:"string"`

	// The Amazon Resource Name (ARN) of the source DB instance for the replicated
	// automated backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.
	//
	// SourceDBInstanceArn is a required field
	SourceDBInstanceArn *string `type:"string" required:"true"`

	// SourceRegion is the source region where the resource exists. This is not
	// sent over the wire and is only used for presigning. This value should always
	// have the same region as the source ARN.
	SourceRegion *string `type:"string" ignore:"true"`
	// contains filtered or unexported fields
}

func (StartDBInstanceAutomatedBackupsReplicationInput) GoString added in v1.36.2

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDBInstanceAutomatedBackupsReplicationInput) SetBackupRetentionPeriod added in v1.36.2

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*StartDBInstanceAutomatedBackupsReplicationInput) SetDestinationRegion added in v1.36.2

SetDestinationRegion sets the DestinationRegion field's value.

func (*StartDBInstanceAutomatedBackupsReplicationInput) SetKmsKeyId added in v1.36.2

SetKmsKeyId sets the KmsKeyId field's value.

func (*StartDBInstanceAutomatedBackupsReplicationInput) SetPreSignedUrl added in v1.36.2

SetPreSignedUrl sets the PreSignedUrl field's value.

func (*StartDBInstanceAutomatedBackupsReplicationInput) SetSourceDBInstanceArn added in v1.36.2

SetSourceDBInstanceArn sets the SourceDBInstanceArn field's value.

func (*StartDBInstanceAutomatedBackupsReplicationInput) SetSourceRegion added in v1.36.2

SetSourceRegion sets the SourceRegion field's value.

func (StartDBInstanceAutomatedBackupsReplicationInput) String added in v1.36.2

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDBInstanceAutomatedBackupsReplicationInput) Validate added in v1.36.2

Validate inspects the fields of the type to determine if they are valid.

type StartDBInstanceAutomatedBackupsReplicationOutput added in v1.36.2

type StartDBInstanceAutomatedBackupsReplicationOutput struct {

	// An automated backup of a DB instance. It consists of system backups, transaction
	// logs, and the database instance properties that existed at the time you deleted
	// the source instance.
	DBInstanceAutomatedBackup *DBInstanceAutomatedBackup `type:"structure"`
	// contains filtered or unexported fields
}

func (StartDBInstanceAutomatedBackupsReplicationOutput) GoString added in v1.36.2

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDBInstanceAutomatedBackupsReplicationOutput) SetDBInstanceAutomatedBackup added in v1.36.2

SetDBInstanceAutomatedBackup sets the DBInstanceAutomatedBackup field's value.

func (StartDBInstanceAutomatedBackupsReplicationOutput) String added in v1.36.2

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartDBInstanceInput added in v1.8.32

type StartDBInstanceInput struct {

	// The user-supplied instance identifier.
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartDBInstanceInput) GoString added in v1.8.32

func (s StartDBInstanceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDBInstanceInput) SetDBInstanceIdentifier added in v1.8.32

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (StartDBInstanceInput) String added in v1.8.32

func (s StartDBInstanceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDBInstanceInput) Validate added in v1.8.32

func (s *StartDBInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartDBInstanceOutput added in v1.8.32

type StartDBInstanceOutput struct {

	// Contains the details of an Amazon RDS DB instance.
	//
	// This data type is used as a response element in the operations CreateDBInstance,
	// CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance,
	// PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,
	// RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
	DBInstance *DBInstance `type:"structure"`
	// contains filtered or unexported fields
}

func (StartDBInstanceOutput) GoString added in v1.8.32

func (s StartDBInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDBInstanceOutput) SetDBInstance added in v1.8.32

SetDBInstance sets the DBInstance field's value.

func (StartDBInstanceOutput) String added in v1.8.32

func (s StartDBInstanceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartExportTaskInput added in v1.28.8

type StartExportTaskInput struct {

	// The data to be exported from the snapshot. If this parameter is not provided,
	// all the snapshot data is exported. Valid values are the following:
	//
	//    * database - Export all the data from a specified database.
	//
	//    * database.table table-name - Export a table of the snapshot. This format
	//    is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
	//
	//    * database.schema schema-name - Export a database schema of the snapshot.
	//    This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
	//
	//    * database.schema.table table-name - Export a table of the database schema.
	//    This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
	ExportOnly []*string `type:"list"`

	// A unique identifier for the snapshot export task. This ID isn't an identifier
	// for the Amazon S3 bucket where the snapshot is to be exported to.
	//
	// ExportTaskIdentifier is a required field
	ExportTaskIdentifier *string `type:"string" required:"true"`

	// The name of the IAM role to use for writing to the Amazon S3 bucket when
	// exporting a snapshot.
	//
	// IamRoleArn is a required field
	IamRoleArn *string `type:"string" required:"true"`

	// The ID of the Amazon Web Services KMS key to use to encrypt the snapshot
	// exported to Amazon S3. The Amazon Web Services KMS key identifier is the
	// key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of
	// this operation must be authorized to execute the following operations. These
	// can be set in the Amazon Web Services KMS key policy:
	//
	//    * GrantOperation.Encrypt
	//
	//    * GrantOperation.Decrypt
	//
	//    * GrantOperation.GenerateDataKey
	//
	//    * GrantOperation.GenerateDataKeyWithoutPlaintext
	//
	//    * GrantOperation.ReEncryptFrom
	//
	//    * GrantOperation.ReEncryptTo
	//
	//    * GrantOperation.CreateGrant
	//
	//    * GrantOperation.DescribeKey
	//
	//    * GrantOperation.RetireGrant
	//
	// KmsKeyId is a required field
	KmsKeyId *string `type:"string" required:"true"`

	// The name of the Amazon S3 bucket to export the snapshot to.
	//
	// S3BucketName is a required field
	S3BucketName *string `type:"string" required:"true"`

	// The Amazon S3 bucket prefix to use as the file name and path of the exported
	// snapshot.
	S3Prefix *string `type:"string"`

	// The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.
	//
	// SourceArn is a required field
	SourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartExportTaskInput) GoString added in v1.28.8

func (s StartExportTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartExportTaskInput) SetExportOnly added in v1.28.8

func (s *StartExportTaskInput) SetExportOnly(v []*string) *StartExportTaskInput

SetExportOnly sets the ExportOnly field's value.

func (*StartExportTaskInput) SetExportTaskIdentifier added in v1.28.8

func (s *StartExportTaskInput) SetExportTaskIdentifier(v string) *StartExportTaskInput

SetExportTaskIdentifier sets the ExportTaskIdentifier field's value.

func (*StartExportTaskInput) SetIamRoleArn added in v1.28.8

func (s *StartExportTaskInput) SetIamRoleArn(v string) *StartExportTaskInput

SetIamRoleArn sets the IamRoleArn field's value.

func (*StartExportTaskInput) SetKmsKeyId added in v1.28.8

SetKmsKeyId sets the KmsKeyId field's value.

func (*StartExportTaskInput) SetS3BucketName added in v1.28.8

func (s *StartExportTaskInput) SetS3BucketName(v string) *StartExportTaskInput

SetS3BucketName sets the S3BucketName field's value.

func (*StartExportTaskInput) SetS3Prefix added in v1.28.8

SetS3Prefix sets the S3Prefix field's value.

func (*StartExportTaskInput) SetSourceArn added in v1.28.8

func (s *StartExportTaskInput) SetSourceArn(v string) *StartExportTaskInput

SetSourceArn sets the SourceArn field's value.

func (StartExportTaskInput) String added in v1.28.8

func (s StartExportTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartExportTaskInput) Validate added in v1.28.8

func (s *StartExportTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartExportTaskOutput added in v1.28.8

type StartExportTaskOutput struct {

	// The data exported from the snapshot. Valid values are the following:
	//
	//    * database - Export all the data from a specified database.
	//
	//    * database.table table-name - Export a table of the snapshot. This format
	//    is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
	//
	//    * database.schema schema-name - Export a database schema of the snapshot.
	//    This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
	//
	//    * database.schema.table table-name - Export a table of the database schema.
	//    This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
	ExportOnly []*string `type:"list"`

	// A unique identifier for the snapshot export task. This ID isn't an identifier
	// for the Amazon S3 bucket where the snapshot is exported to.
	ExportTaskIdentifier *string `type:"string"`

	// The reason the export failed, if it failed.
	FailureCause *string `type:"string"`

	// The name of the IAM role that is used to write to Amazon S3 when exporting
	// a snapshot.
	IamRoleArn *string `type:"string"`

	// The key identifier of the Amazon Web Services KMS key that is used to encrypt
	// the snapshot when it's exported to Amazon S3. The KMS key identifier is its
	// key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot
	// export must have encryption and decryption permissions to use this KMS key.
	KmsKeyId *string `type:"string"`

	// The progress of the snapshot export task as a percentage.
	PercentProgress *int64 `type:"integer"`

	// The Amazon S3 bucket that the snapshot is exported to.
	S3Bucket *string `type:"string"`

	// The Amazon S3 bucket prefix that is the file name and path of the exported
	// snapshot.
	S3Prefix *string `type:"string"`

	// The time that the snapshot was created.
	SnapshotTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
	SourceArn *string `type:"string"`

	// The progress status of the export task.
	Status *string `type:"string"`

	// The time that the snapshot export task completed.
	TaskEndTime *time.Time `type:"timestamp"`

	// The time that the snapshot export task started.
	TaskStartTime *time.Time `type:"timestamp"`

	// The total amount of data exported, in gigabytes.
	TotalExtractedDataInGB *int64 `type:"integer"`

	// A warning about the snapshot export task.
	WarningMessage *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the details of a snapshot export to Amazon S3.

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

func (StartExportTaskOutput) GoString added in v1.28.8

func (s StartExportTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartExportTaskOutput) SetExportOnly added in v1.28.8

func (s *StartExportTaskOutput) SetExportOnly(v []*string) *StartExportTaskOutput

SetExportOnly sets the ExportOnly field's value.

func (*StartExportTaskOutput) SetExportTaskIdentifier added in v1.28.8

func (s *StartExportTaskOutput) SetExportTaskIdentifier(v string) *StartExportTaskOutput

SetExportTaskIdentifier sets the ExportTaskIdentifier field's value.

func (*StartExportTaskOutput) SetFailureCause added in v1.28.8

func (s *StartExportTaskOutput) SetFailureCause(v string) *StartExportTaskOutput

SetFailureCause sets the FailureCause field's value.

func (*StartExportTaskOutput) SetIamRoleArn added in v1.28.8

func (s *StartExportTaskOutput) SetIamRoleArn(v string) *StartExportTaskOutput

SetIamRoleArn sets the IamRoleArn field's value.

func (*StartExportTaskOutput) SetKmsKeyId added in v1.28.8

SetKmsKeyId sets the KmsKeyId field's value.

func (*StartExportTaskOutput) SetPercentProgress added in v1.28.8

func (s *StartExportTaskOutput) SetPercentProgress(v int64) *StartExportTaskOutput

SetPercentProgress sets the PercentProgress field's value.

func (*StartExportTaskOutput) SetS3Bucket added in v1.28.8

SetS3Bucket sets the S3Bucket field's value.

func (*StartExportTaskOutput) SetS3Prefix added in v1.28.8

SetS3Prefix sets the S3Prefix field's value.

func (*StartExportTaskOutput) SetSnapshotTime added in v1.28.8

func (s *StartExportTaskOutput) SetSnapshotTime(v time.Time) *StartExportTaskOutput

SetSnapshotTime sets the SnapshotTime field's value.

func (*StartExportTaskOutput) SetSourceArn added in v1.28.8

SetSourceArn sets the SourceArn field's value.

func (*StartExportTaskOutput) SetStatus added in v1.28.8

SetStatus sets the Status field's value.

func (*StartExportTaskOutput) SetTaskEndTime added in v1.28.8

func (s *StartExportTaskOutput) SetTaskEndTime(v time.Time) *StartExportTaskOutput

SetTaskEndTime sets the TaskEndTime field's value.

func (*StartExportTaskOutput) SetTaskStartTime added in v1.28.8

func (s *StartExportTaskOutput) SetTaskStartTime(v time.Time) *StartExportTaskOutput

SetTaskStartTime sets the TaskStartTime field's value.

func (*StartExportTaskOutput) SetTotalExtractedDataInGB added in v1.28.8

func (s *StartExportTaskOutput) SetTotalExtractedDataInGB(v int64) *StartExportTaskOutput

SetTotalExtractedDataInGB sets the TotalExtractedDataInGB field's value.

func (*StartExportTaskOutput) SetWarningMessage added in v1.28.8

func (s *StartExportTaskOutput) SetWarningMessage(v string) *StartExportTaskOutput

SetWarningMessage sets the WarningMessage field's value.

func (StartExportTaskOutput) String added in v1.28.8

func (s StartExportTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopActivityStreamInput added in v1.19.41

type StopActivityStreamInput struct {

	// Specifies whether or not the database activity stream is to stop as soon
	// as possible, regardless of the maintenance window for the database.
	ApplyImmediately *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the DB cluster for the database activity
	// stream. For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopActivityStreamInput) GoString added in v1.19.41

func (s StopActivityStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopActivityStreamInput) SetApplyImmediately added in v1.19.41

func (s *StopActivityStreamInput) SetApplyImmediately(v bool) *StopActivityStreamInput

SetApplyImmediately sets the ApplyImmediately field's value.

func (*StopActivityStreamInput) SetResourceArn added in v1.19.41

SetResourceArn sets the ResourceArn field's value.

func (StopActivityStreamInput) String added in v1.19.41

func (s StopActivityStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopActivityStreamInput) Validate added in v1.19.41

func (s *StopActivityStreamInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopActivityStreamOutput added in v1.19.41

type StopActivityStreamOutput struct {

	// The name of the Amazon Kinesis data stream used for the database activity
	// stream.
	KinesisStreamName *string `type:"string"`

	// The Amazon Web Services KMS key identifier used for encrypting messages in
	// the database activity stream.
	//
	// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
	// ARN, or alias name for the KMS key.
	KmsKeyId *string `type:"string"`

	// The status of the database activity stream.
	Status *string `type:"string" enum:"ActivityStreamStatus"`
	// contains filtered or unexported fields
}

func (StopActivityStreamOutput) GoString added in v1.19.41

func (s StopActivityStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopActivityStreamOutput) SetKinesisStreamName added in v1.19.41

func (s *StopActivityStreamOutput) SetKinesisStreamName(v string) *StopActivityStreamOutput

SetKinesisStreamName sets the KinesisStreamName field's value.

func (*StopActivityStreamOutput) SetKmsKeyId added in v1.19.41

SetKmsKeyId sets the KmsKeyId field's value.

func (*StopActivityStreamOutput) SetStatus added in v1.19.41

SetStatus sets the Status field's value.

func (StopActivityStreamOutput) String added in v1.19.41

func (s StopActivityStreamOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopDBClusterInput added in v1.15.39

type StopDBClusterInput struct {

	// The DB cluster identifier of the Amazon Aurora DB cluster to be stopped.
	// This parameter is stored as a lowercase string.
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopDBClusterInput) GoString added in v1.15.39

func (s StopDBClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopDBClusterInput) SetDBClusterIdentifier added in v1.15.39

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (StopDBClusterInput) String added in v1.15.39

func (s StopDBClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopDBClusterInput) Validate added in v1.15.39

func (s *StopDBClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopDBClusterOutput added in v1.15.39

type StopDBClusterOutput struct {

	// Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
	//
	// For an Amazon Aurora DB cluster, this data type is used as a response element
	// in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot,
	// RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
	//
	// For a Multi-AZ DB cluster, this data type is used as a response element in
	// the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
	// ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
	//
	// For more information on Amazon Aurora DB clusters, see What is Amazon Aurora?
	// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)
	// in the Amazon Aurora User Guide.
	//
	// For more information on Multi-AZ DB clusters, see Multi-AZ deployments with
	// two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
	// in the Amazon RDS User Guide.
	DBCluster *DBCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (StopDBClusterOutput) GoString added in v1.15.39

func (s StopDBClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopDBClusterOutput) SetDBCluster added in v1.15.39

func (s *StopDBClusterOutput) SetDBCluster(v *DBCluster) *StopDBClusterOutput

SetDBCluster sets the DBCluster field's value.

func (StopDBClusterOutput) String added in v1.15.39

func (s StopDBClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopDBInstanceAutomatedBackupsReplicationInput added in v1.36.2

type StopDBInstanceAutomatedBackupsReplicationInput struct {

	// The Amazon Resource Name (ARN) of the source DB instance for which to stop
	// replicating automated backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.
	//
	// SourceDBInstanceArn is a required field
	SourceDBInstanceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopDBInstanceAutomatedBackupsReplicationInput) GoString added in v1.36.2

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopDBInstanceAutomatedBackupsReplicationInput) SetSourceDBInstanceArn added in v1.36.2

SetSourceDBInstanceArn sets the SourceDBInstanceArn field's value.

func (StopDBInstanceAutomatedBackupsReplicationInput) String added in v1.36.2

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopDBInstanceAutomatedBackupsReplicationInput) Validate added in v1.36.2

Validate inspects the fields of the type to determine if they are valid.

type StopDBInstanceAutomatedBackupsReplicationOutput added in v1.36.2

type StopDBInstanceAutomatedBackupsReplicationOutput struct {

	// An automated backup of a DB instance. It consists of system backups, transaction
	// logs, and the database instance properties that existed at the time you deleted
	// the source instance.
	DBInstanceAutomatedBackup *DBInstanceAutomatedBackup `type:"structure"`
	// contains filtered or unexported fields
}

func (StopDBInstanceAutomatedBackupsReplicationOutput) GoString added in v1.36.2

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopDBInstanceAutomatedBackupsReplicationOutput) SetDBInstanceAutomatedBackup added in v1.36.2

SetDBInstanceAutomatedBackup sets the DBInstanceAutomatedBackup field's value.

func (StopDBInstanceAutomatedBackupsReplicationOutput) String added in v1.36.2

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopDBInstanceInput added in v1.8.32

type StopDBInstanceInput struct {

	// The user-supplied instance identifier.
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`

	// The user-supplied instance identifier of the DB Snapshot created immediately
	// before the DB instance is stopped.
	DBSnapshotIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

func (StopDBInstanceInput) GoString added in v1.8.32

func (s StopDBInstanceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopDBInstanceInput) SetDBInstanceIdentifier added in v1.8.32

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*StopDBInstanceInput) SetDBSnapshotIdentifier added in v1.8.32

func (s *StopDBInstanceInput) SetDBSnapshotIdentifier(v string) *StopDBInstanceInput

SetDBSnapshotIdentifier sets the DBSnapshotIdentifier field's value.

func (StopDBInstanceInput) String added in v1.8.32

func (s StopDBInstanceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopDBInstanceInput) Validate added in v1.8.32

func (s *StopDBInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopDBInstanceOutput added in v1.8.32

type StopDBInstanceOutput struct {

	// Contains the details of an Amazon RDS DB instance.
	//
	// This data type is used as a response element in the operations CreateDBInstance,
	// CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance,
	// PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,
	// RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
	DBInstance *DBInstance `type:"structure"`
	// contains filtered or unexported fields
}

func (StopDBInstanceOutput) GoString added in v1.8.32

func (s StopDBInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopDBInstanceOutput) SetDBInstance added in v1.8.32

SetDBInstance sets the DBInstance field's value.

func (StopDBInstanceOutput) String added in v1.8.32

func (s StopDBInstanceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Subnet

type Subnet struct {

	// Contains Availability Zone information.
	//
	// This data type is used as an element in the OrderableDBInstanceOption data
	// type.
	SubnetAvailabilityZone *AvailabilityZone `type:"structure"`

	// The identifier of the subnet.
	SubnetIdentifier *string `type:"string"`

	// If the subnet is associated with an Outpost, this value specifies the Outpost.
	//
	// For more information about RDS on Outposts, see Amazon RDS on Amazon Web
	// Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)
	// in the Amazon RDS User Guide.
	SubnetOutpost *Outpost `type:"structure"`

	// The status of the subnet.
	SubnetStatus *string `type:"string"`
	// contains filtered or unexported fields
}

This data type is used as a response element for the DescribeDBSubnetGroups operation.

func (Subnet) GoString added in v0.6.5

func (s Subnet) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Subnet) SetSubnetAvailabilityZone added in v1.5.0

func (s *Subnet) SetSubnetAvailabilityZone(v *AvailabilityZone) *Subnet

SetSubnetAvailabilityZone sets the SubnetAvailabilityZone field's value.

func (*Subnet) SetSubnetIdentifier added in v1.5.0

func (s *Subnet) SetSubnetIdentifier(v string) *Subnet

SetSubnetIdentifier sets the SubnetIdentifier field's value.

func (*Subnet) SetSubnetOutpost added in v1.33.2

func (s *Subnet) SetSubnetOutpost(v *Outpost) *Subnet

SetSubnetOutpost sets the SubnetOutpost field's value.

func (*Subnet) SetSubnetStatus added in v1.5.0

func (s *Subnet) SetSubnetStatus(v string) *Subnet

SetSubnetStatus sets the SubnetStatus field's value.

func (Subnet) String added in v0.6.5

func (s Subnet) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SwitchoverReadReplicaInput added in v1.44.83

type SwitchoverReadReplicaInput struct {

	// The DB instance identifier of the current standby database. This value is
	// stored as a lowercase string.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing Oracle read replica DB instance.
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SwitchoverReadReplicaInput) GoString added in v1.44.83

func (s SwitchoverReadReplicaInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SwitchoverReadReplicaInput) SetDBInstanceIdentifier added in v1.44.83

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (SwitchoverReadReplicaInput) String added in v1.44.83

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SwitchoverReadReplicaInput) Validate added in v1.44.83

func (s *SwitchoverReadReplicaInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SwitchoverReadReplicaOutput added in v1.44.83

type SwitchoverReadReplicaOutput struct {

	// Contains the details of an Amazon RDS DB instance.
	//
	// This data type is used as a response element in the operations CreateDBInstance,
	// CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance,
	// PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,
	// RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
	DBInstance *DBInstance `type:"structure"`
	// contains filtered or unexported fields
}

func (SwitchoverReadReplicaOutput) GoString added in v1.44.83

func (s SwitchoverReadReplicaOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SwitchoverReadReplicaOutput) SetDBInstance added in v1.44.83

SetDBInstance sets the DBInstance field's value.

func (SwitchoverReadReplicaOutput) String added in v1.44.83

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag

type Tag struct {

	// A key is the required name of the tag. The string value can be from 1 to
	// 128 Unicode characters in length and can't be prefixed with aws: or rds:.
	// The string can only contain only the set of Unicode letters, digits, white-space,
	// '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").
	Key *string `type:"string"`

	// A value is the optional value of the tag. The string value can be from 1
	// to 256 Unicode characters in length and can't be prefixed with aws: or rds:.
	// The string can only contain only the set of Unicode letters, digits, white-space,
	// '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

func (Tag) GoString added in v0.6.5

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey added in v1.5.0

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.5.0

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v0.6.5

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TargetHealth added in v1.30.8

type TargetHealth struct {

	// A description of the health of the RDS Proxy target. If the State is AVAILABLE,
	// a description is not included.
	Description *string `type:"string"`

	// The reason for the current health State of the RDS Proxy target.
	Reason *string `type:"string" enum:"TargetHealthReason"`

	// The current state of the connection health lifecycle for the RDS Proxy target.
	// The following is a typical lifecycle example for the states of an RDS Proxy
	// target:
	//
	// registering > unavailable > available > unavailable > available
	State *string `type:"string" enum:"TargetState"`
	// contains filtered or unexported fields
}

Information about the connection health of an RDS Proxy target.

func (TargetHealth) GoString added in v1.30.8

func (s TargetHealth) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetHealth) SetDescription added in v1.30.8

func (s *TargetHealth) SetDescription(v string) *TargetHealth

SetDescription sets the Description field's value.

func (*TargetHealth) SetReason added in v1.30.8

func (s *TargetHealth) SetReason(v string) *TargetHealth

SetReason sets the Reason field's value.

func (*TargetHealth) SetState added in v1.30.8

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

SetState sets the State field's value.

func (TargetHealth) String added in v1.30.8

func (s TargetHealth) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Timezone added in v1.4.11

type Timezone struct {

	// The name of the time zone.
	TimezoneName *string `type:"string"`
	// contains filtered or unexported fields
}

A time zone associated with a DBInstance or a DBSnapshot. This data type is an element in the response to the DescribeDBInstances, the DescribeDBSnapshots, and the DescribeDBEngineVersions actions.

func (Timezone) GoString added in v1.4.11

func (s Timezone) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Timezone) SetTimezoneName added in v1.5.0

func (s *Timezone) SetTimezoneName(v string) *Timezone

SetTimezoneName sets the TimezoneName field's value.

func (Timezone) String added in v1.4.11

func (s Timezone) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpgradeTarget added in v0.9.11

type UpgradeTarget struct {

	// A value that indicates whether the target version is applied to any source
	// DB instances that have AutoMinorVersionUpgrade set to true.
	AutoUpgrade *bool `type:"boolean"`

	// The version of the database engine that a DB instance can be upgraded to.
	Description *string `type:"string"`

	// The name of the upgrade target database engine.
	Engine *string `type:"string"`

	// The version number of the upgrade target database engine.
	EngineVersion *string `type:"string"`

	// A value that indicates whether upgrading to the target version requires upgrading
	// the major version of the database engine.
	IsMajorVersionUpgrade *bool `type:"boolean"`

	// A list of the supported DB engine modes for the target engine version.
	SupportedEngineModes []*string `type:"list"`

	// A value that indicates whether you can use Babelfish for Aurora PostgreSQL
	// with the target engine version.
	SupportsBabelfish *bool `type:"boolean"`

	// A value that indicates whether you can use Aurora global databases with the
	// target engine version.
	SupportsGlobalDatabases *bool `type:"boolean"`

	// A value that indicates whether you can use Aurora parallel query with the
	// target engine version.
	SupportsParallelQuery *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The version of the database engine that a DB instance can be upgraded to.

func (UpgradeTarget) GoString added in v0.9.11

func (s UpgradeTarget) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpgradeTarget) SetAutoUpgrade added in v1.5.0

func (s *UpgradeTarget) SetAutoUpgrade(v bool) *UpgradeTarget

SetAutoUpgrade sets the AutoUpgrade field's value.

func (*UpgradeTarget) SetDescription added in v1.5.0

func (s *UpgradeTarget) SetDescription(v string) *UpgradeTarget

SetDescription sets the Description field's value.

func (*UpgradeTarget) SetEngine added in v1.5.0

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

SetEngine sets the Engine field's value.

func (*UpgradeTarget) SetEngineVersion added in v1.5.0

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

SetEngineVersion sets the EngineVersion field's value.

func (*UpgradeTarget) SetIsMajorVersionUpgrade added in v1.5.0

func (s *UpgradeTarget) SetIsMajorVersionUpgrade(v bool) *UpgradeTarget

SetIsMajorVersionUpgrade sets the IsMajorVersionUpgrade field's value.

func (*UpgradeTarget) SetSupportedEngineModes added in v1.37.10

func (s *UpgradeTarget) SetSupportedEngineModes(v []*string) *UpgradeTarget

SetSupportedEngineModes sets the SupportedEngineModes field's value.

func (*UpgradeTarget) SetSupportsBabelfish added in v1.42.53

func (s *UpgradeTarget) SetSupportsBabelfish(v bool) *UpgradeTarget

SetSupportsBabelfish sets the SupportsBabelfish field's value.

func (*UpgradeTarget) SetSupportsGlobalDatabases added in v1.37.10

func (s *UpgradeTarget) SetSupportsGlobalDatabases(v bool) *UpgradeTarget

SetSupportsGlobalDatabases sets the SupportsGlobalDatabases field's value.

func (*UpgradeTarget) SetSupportsParallelQuery added in v1.37.10

func (s *UpgradeTarget) SetSupportsParallelQuery(v bool) *UpgradeTarget

SetSupportsParallelQuery sets the SupportsParallelQuery field's value.

func (UpgradeTarget) String added in v0.9.11

func (s UpgradeTarget) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UserAuthConfig added in v1.25.47

type UserAuthConfig struct {

	// The type of authentication that the proxy uses for connections from the proxy
	// to the underlying database.
	AuthScheme *string `type:"string" enum:"AuthScheme"`

	// A user-specified description about the authentication used by a proxy to
	// log in as a specific database user.
	Description *string `type:"string"`

	// Whether to require or disallow Amazon Web Services Identity and Access Management
	// (IAM) authentication for connections to the proxy.
	IAMAuth *string `type:"string" enum:"IAMAuthMode"`

	// The Amazon Resource Name (ARN) representing the secret that the proxy uses
	// to authenticate to the RDS DB instance or Aurora DB cluster. These secrets
	// are stored within Amazon Secrets Manager.
	SecretArn *string `type:"string"`

	// The name of the database user to which the proxy connects.
	UserName *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the details of authentication used by a proxy to log in as a specific database user.

func (UserAuthConfig) GoString added in v1.25.47

func (s UserAuthConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserAuthConfig) SetAuthScheme added in v1.25.47

func (s *UserAuthConfig) SetAuthScheme(v string) *UserAuthConfig

SetAuthScheme sets the AuthScheme field's value.

func (*UserAuthConfig) SetDescription added in v1.25.47

func (s *UserAuthConfig) SetDescription(v string) *UserAuthConfig

SetDescription sets the Description field's value.

func (*UserAuthConfig) SetIAMAuth added in v1.25.47

func (s *UserAuthConfig) SetIAMAuth(v string) *UserAuthConfig

SetIAMAuth sets the IAMAuth field's value.

func (*UserAuthConfig) SetSecretArn added in v1.25.47

func (s *UserAuthConfig) SetSecretArn(v string) *UserAuthConfig

SetSecretArn sets the SecretArn field's value.

func (*UserAuthConfig) SetUserName added in v1.25.47

func (s *UserAuthConfig) SetUserName(v string) *UserAuthConfig

SetUserName sets the UserName field's value.

func (UserAuthConfig) String added in v1.25.47

func (s UserAuthConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UserAuthConfigInfo added in v1.25.47

type UserAuthConfigInfo struct {

	// The type of authentication that the proxy uses for connections from the proxy
	// to the underlying database.
	AuthScheme *string `type:"string" enum:"AuthScheme"`

	// A user-specified description about the authentication used by a proxy to
	// log in as a specific database user.
	Description *string `type:"string"`

	// Whether to require or disallow Amazon Web Services Identity and Access Management
	// (IAM) authentication for connections to the proxy.
	IAMAuth *string `type:"string" enum:"IAMAuthMode"`

	// The Amazon Resource Name (ARN) representing the secret that the proxy uses
	// to authenticate to the RDS DB instance or Aurora DB cluster. These secrets
	// are stored within Amazon Secrets Manager.
	SecretArn *string `type:"string"`

	// The name of the database user to which the proxy connects.
	UserName *string `type:"string"`
	// contains filtered or unexported fields
}

Returns the details of authentication used by a proxy to log in as a specific database user.

func (UserAuthConfigInfo) GoString added in v1.25.47

func (s UserAuthConfigInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserAuthConfigInfo) SetAuthScheme added in v1.25.47

func (s *UserAuthConfigInfo) SetAuthScheme(v string) *UserAuthConfigInfo

SetAuthScheme sets the AuthScheme field's value.

func (*UserAuthConfigInfo) SetDescription added in v1.25.47

func (s *UserAuthConfigInfo) SetDescription(v string) *UserAuthConfigInfo

SetDescription sets the Description field's value.

func (*UserAuthConfigInfo) SetIAMAuth added in v1.25.47

func (s *UserAuthConfigInfo) SetIAMAuth(v string) *UserAuthConfigInfo

SetIAMAuth sets the IAMAuth field's value.

func (*UserAuthConfigInfo) SetSecretArn added in v1.25.47

func (s *UserAuthConfigInfo) SetSecretArn(v string) *UserAuthConfigInfo

SetSecretArn sets the SecretArn field's value.

func (*UserAuthConfigInfo) SetUserName added in v1.25.47

func (s *UserAuthConfigInfo) SetUserName(v string) *UserAuthConfigInfo

SetUserName sets the UserName field's value.

func (UserAuthConfigInfo) String added in v1.25.47

func (s UserAuthConfigInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidDBInstanceModificationsMessage added in v1.12.10

type ValidDBInstanceModificationsMessage struct {

	// Valid storage options for your DB instance.
	Storage []*ValidStorageOptions `locationNameList:"ValidStorageOptions" type:"list"`

	// Valid processor features for your DB instance.
	ValidProcessorFeatures []*AvailableProcessorFeature `locationNameList:"AvailableProcessorFeature" type:"list"`
	// contains filtered or unexported fields
}

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.

func (ValidDBInstanceModificationsMessage) GoString added in v1.12.10

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidDBInstanceModificationsMessage) SetStorage added in v1.12.10

SetStorage sets the Storage field's value.

func (*ValidDBInstanceModificationsMessage) SetValidProcessorFeatures added in v1.14.1

SetValidProcessorFeatures sets the ValidProcessorFeatures field's value.

func (ValidDBInstanceModificationsMessage) String added in v1.12.10

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidStorageOptions added in v1.12.10

type ValidStorageOptions struct {

	// The valid range of Provisioned IOPS to gibibytes of storage multiplier. For
	// example, 3-10, which means that provisioned IOPS can be between 3 and 10
	// times storage.
	IopsToStorageRatio []*DoubleRange `locationNameList:"DoubleRange" type:"list"`

	// The valid range of provisioned IOPS. For example, 1000-20000.
	ProvisionedIops []*Range `locationNameList:"Range" type:"list"`

	// The valid range of storage in gibibytes (GiB). For example, 100 to 16384.
	StorageSize []*Range `locationNameList:"Range" type:"list"`

	// The valid storage types for your DB instance. For example, gp2, io1.
	StorageType *string `type:"string"`

	// Whether or not Amazon RDS can automatically scale storage for DB instances
	// that use the new instance class.
	SupportsStorageAutoscaling *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action.

func (ValidStorageOptions) GoString added in v1.12.10

func (s ValidStorageOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidStorageOptions) SetIopsToStorageRatio added in v1.12.10

func (s *ValidStorageOptions) SetIopsToStorageRatio(v []*DoubleRange) *ValidStorageOptions

SetIopsToStorageRatio sets the IopsToStorageRatio field's value.

func (*ValidStorageOptions) SetProvisionedIops added in v1.12.10

func (s *ValidStorageOptions) SetProvisionedIops(v []*Range) *ValidStorageOptions

SetProvisionedIops sets the ProvisionedIops field's value.

func (*ValidStorageOptions) SetStorageSize added in v1.12.10

func (s *ValidStorageOptions) SetStorageSize(v []*Range) *ValidStorageOptions

SetStorageSize sets the StorageSize field's value.

func (*ValidStorageOptions) SetStorageType added in v1.12.10

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

SetStorageType sets the StorageType field's value.

func (*ValidStorageOptions) SetSupportsStorageAutoscaling added in v1.20.5

func (s *ValidStorageOptions) SetSupportsStorageAutoscaling(v bool) *ValidStorageOptions

SetSupportsStorageAutoscaling sets the SupportsStorageAutoscaling field's value.

func (ValidStorageOptions) String added in v1.12.10

func (s ValidStorageOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VpcSecurityGroupMembership added in v0.9.5

type VpcSecurityGroupMembership struct {

	// The membership status of the VPC security group.
	//
	// Currently, the only valid status is active.
	Status *string `type:"string"`

	// The name of the VPC security group.
	VpcSecurityGroupId *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (VpcSecurityGroupMembership) GoString added in v0.9.5

func (s VpcSecurityGroupMembership) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VpcSecurityGroupMembership) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (*VpcSecurityGroupMembership) SetVpcSecurityGroupId added in v1.5.0

func (s *VpcSecurityGroupMembership) SetVpcSecurityGroupId(v string) *VpcSecurityGroupMembership

SetVpcSecurityGroupId sets the VpcSecurityGroupId field's value.

func (VpcSecurityGroupMembership) String added in v0.9.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package rdsiface provides an interface to enable mocking the Amazon Relational Database Service service client for testing your code.
Package rdsiface provides an interface to enable mocking the Amazon Relational Database Service service client for testing your code.
Package rdsutils is used to generate authentication tokens used to connect to a givent Amazon Relational Database Service (RDS) database.
Package rdsutils is used to generate authentication tokens used to connect to a givent Amazon Relational Database Service (RDS) database.

Jump to

Keyboard shortcuts

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