Documentation ¶
Overview ¶
Package rds provides the API client, operations, and parameter types for Amazon Relational Database Service.
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, Db2, 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
For the alphabetical list of API actions, see API Actions.
For the alphabetical list of data types, see Data Types.
For a list of common query parameters, see Common Parameters.
For descriptions of the error codes, see Common Errors.
Amazon RDS User Guide
For a summary of the Amazon RDS interfaces, see Available RDS Interfaces.
For more information about how to use the Query API, see Using the Query API.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithPresignClientFromClientOptions(optFns ...func(*Options)) func(*PresignOptions)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AddRoleToDBClusterInput
- type AddRoleToDBClusterOutput
- type AddRoleToDBInstanceInput
- type AddRoleToDBInstanceOutput
- type AddSourceIdentifierToSubscriptionInput
- type AddSourceIdentifierToSubscriptionOutput
- type AddTagsToResourceInput
- type AddTagsToResourceOutput
- type ApplyPendingMaintenanceActionInput
- type ApplyPendingMaintenanceActionOutput
- type AuthResolverParameters
- type AuthSchemeResolver
- type AuthorizeDBSecurityGroupIngressInput
- type AuthorizeDBSecurityGroupIngressOutput
- type BacktrackDBClusterInput
- type BacktrackDBClusterOutput
- type CancelExportTaskInput
- type CancelExportTaskOutput
- type Client
- func (c *Client) AddRoleToDBCluster(ctx context.Context, params *AddRoleToDBClusterInput, optFns ...func(*Options)) (*AddRoleToDBClusterOutput, error)
- func (c *Client) AddRoleToDBInstance(ctx context.Context, params *AddRoleToDBInstanceInput, ...) (*AddRoleToDBInstanceOutput, error)
- func (c *Client) AddSourceIdentifierToSubscription(ctx context.Context, params *AddSourceIdentifierToSubscriptionInput, ...) (*AddSourceIdentifierToSubscriptionOutput, error)
- func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourceInput, optFns ...func(*Options)) (*AddTagsToResourceOutput, error)
- func (c *Client) ApplyPendingMaintenanceAction(ctx context.Context, params *ApplyPendingMaintenanceActionInput, ...) (*ApplyPendingMaintenanceActionOutput, error)
- func (c *Client) AuthorizeDBSecurityGroupIngress(ctx context.Context, params *AuthorizeDBSecurityGroupIngressInput, ...) (*AuthorizeDBSecurityGroupIngressOutput, error)
- func (c *Client) BacktrackDBCluster(ctx context.Context, params *BacktrackDBClusterInput, optFns ...func(*Options)) (*BacktrackDBClusterOutput, error)
- func (c *Client) CancelExportTask(ctx context.Context, params *CancelExportTaskInput, optFns ...func(*Options)) (*CancelExportTaskOutput, error)
- func (c *Client) CopyDBClusterParameterGroup(ctx context.Context, params *CopyDBClusterParameterGroupInput, ...) (*CopyDBClusterParameterGroupOutput, error)
- func (c *Client) CopyDBClusterSnapshot(ctx context.Context, params *CopyDBClusterSnapshotInput, ...) (*CopyDBClusterSnapshotOutput, error)
- func (c *Client) CopyDBParameterGroup(ctx context.Context, params *CopyDBParameterGroupInput, ...) (*CopyDBParameterGroupOutput, error)
- func (c *Client) CopyDBSnapshot(ctx context.Context, params *CopyDBSnapshotInput, optFns ...func(*Options)) (*CopyDBSnapshotOutput, error)
- func (c *Client) CopyOptionGroup(ctx context.Context, params *CopyOptionGroupInput, optFns ...func(*Options)) (*CopyOptionGroupOutput, error)
- func (c *Client) CreateBlueGreenDeployment(ctx context.Context, params *CreateBlueGreenDeploymentInput, ...) (*CreateBlueGreenDeploymentOutput, error)
- func (c *Client) CreateCustomDBEngineVersion(ctx context.Context, params *CreateCustomDBEngineVersionInput, ...) (*CreateCustomDBEngineVersionOutput, error)
- func (c *Client) CreateDBCluster(ctx context.Context, params *CreateDBClusterInput, optFns ...func(*Options)) (*CreateDBClusterOutput, error)
- func (c *Client) CreateDBClusterEndpoint(ctx context.Context, params *CreateDBClusterEndpointInput, ...) (*CreateDBClusterEndpointOutput, error)
- func (c *Client) CreateDBClusterParameterGroup(ctx context.Context, params *CreateDBClusterParameterGroupInput, ...) (*CreateDBClusterParameterGroupOutput, error)
- func (c *Client) CreateDBClusterSnapshot(ctx context.Context, params *CreateDBClusterSnapshotInput, ...) (*CreateDBClusterSnapshotOutput, error)
- func (c *Client) CreateDBInstance(ctx context.Context, params *CreateDBInstanceInput, optFns ...func(*Options)) (*CreateDBInstanceOutput, error)
- func (c *Client) CreateDBInstanceReadReplica(ctx context.Context, params *CreateDBInstanceReadReplicaInput, ...) (*CreateDBInstanceReadReplicaOutput, error)
- func (c *Client) CreateDBParameterGroup(ctx context.Context, params *CreateDBParameterGroupInput, ...) (*CreateDBParameterGroupOutput, error)
- func (c *Client) CreateDBProxy(ctx context.Context, params *CreateDBProxyInput, optFns ...func(*Options)) (*CreateDBProxyOutput, error)
- func (c *Client) CreateDBProxyEndpoint(ctx context.Context, params *CreateDBProxyEndpointInput, ...) (*CreateDBProxyEndpointOutput, error)
- func (c *Client) CreateDBSecurityGroup(ctx context.Context, params *CreateDBSecurityGroupInput, ...) (*CreateDBSecurityGroupOutput, error)
- func (c *Client) CreateDBShardGroup(ctx context.Context, params *CreateDBShardGroupInput, optFns ...func(*Options)) (*CreateDBShardGroupOutput, error)
- func (c *Client) CreateDBSnapshot(ctx context.Context, params *CreateDBSnapshotInput, optFns ...func(*Options)) (*CreateDBSnapshotOutput, error)
- func (c *Client) CreateDBSubnetGroup(ctx context.Context, params *CreateDBSubnetGroupInput, ...) (*CreateDBSubnetGroupOutput, error)
- func (c *Client) CreateEventSubscription(ctx context.Context, params *CreateEventSubscriptionInput, ...) (*CreateEventSubscriptionOutput, error)
- func (c *Client) CreateGlobalCluster(ctx context.Context, params *CreateGlobalClusterInput, ...) (*CreateGlobalClusterOutput, error)
- func (c *Client) CreateIntegration(ctx context.Context, params *CreateIntegrationInput, optFns ...func(*Options)) (*CreateIntegrationOutput, error)
- func (c *Client) CreateOptionGroup(ctx context.Context, params *CreateOptionGroupInput, optFns ...func(*Options)) (*CreateOptionGroupOutput, error)
- func (c *Client) CreateTenantDatabase(ctx context.Context, params *CreateTenantDatabaseInput, ...) (*CreateTenantDatabaseOutput, error)
- func (c *Client) DeleteBlueGreenDeployment(ctx context.Context, params *DeleteBlueGreenDeploymentInput, ...) (*DeleteBlueGreenDeploymentOutput, error)
- func (c *Client) DeleteCustomDBEngineVersion(ctx context.Context, params *DeleteCustomDBEngineVersionInput, ...) (*DeleteCustomDBEngineVersionOutput, error)
- func (c *Client) DeleteDBCluster(ctx context.Context, params *DeleteDBClusterInput, optFns ...func(*Options)) (*DeleteDBClusterOutput, error)
- func (c *Client) DeleteDBClusterAutomatedBackup(ctx context.Context, params *DeleteDBClusterAutomatedBackupInput, ...) (*DeleteDBClusterAutomatedBackupOutput, error)
- func (c *Client) DeleteDBClusterEndpoint(ctx context.Context, params *DeleteDBClusterEndpointInput, ...) (*DeleteDBClusterEndpointOutput, error)
- func (c *Client) DeleteDBClusterParameterGroup(ctx context.Context, params *DeleteDBClusterParameterGroupInput, ...) (*DeleteDBClusterParameterGroupOutput, error)
- func (c *Client) DeleteDBClusterSnapshot(ctx context.Context, params *DeleteDBClusterSnapshotInput, ...) (*DeleteDBClusterSnapshotOutput, error)
- func (c *Client) DeleteDBInstance(ctx context.Context, params *DeleteDBInstanceInput, optFns ...func(*Options)) (*DeleteDBInstanceOutput, error)
- func (c *Client) DeleteDBInstanceAutomatedBackup(ctx context.Context, params *DeleteDBInstanceAutomatedBackupInput, ...) (*DeleteDBInstanceAutomatedBackupOutput, error)
- func (c *Client) DeleteDBParameterGroup(ctx context.Context, params *DeleteDBParameterGroupInput, ...) (*DeleteDBParameterGroupOutput, error)
- func (c *Client) DeleteDBProxy(ctx context.Context, params *DeleteDBProxyInput, optFns ...func(*Options)) (*DeleteDBProxyOutput, error)
- func (c *Client) DeleteDBProxyEndpoint(ctx context.Context, params *DeleteDBProxyEndpointInput, ...) (*DeleteDBProxyEndpointOutput, error)
- func (c *Client) DeleteDBSecurityGroup(ctx context.Context, params *DeleteDBSecurityGroupInput, ...) (*DeleteDBSecurityGroupOutput, error)
- func (c *Client) DeleteDBShardGroup(ctx context.Context, params *DeleteDBShardGroupInput, optFns ...func(*Options)) (*DeleteDBShardGroupOutput, error)
- func (c *Client) DeleteDBSnapshot(ctx context.Context, params *DeleteDBSnapshotInput, optFns ...func(*Options)) (*DeleteDBSnapshotOutput, error)
- func (c *Client) DeleteDBSubnetGroup(ctx context.Context, params *DeleteDBSubnetGroupInput, ...) (*DeleteDBSubnetGroupOutput, error)
- func (c *Client) DeleteEventSubscription(ctx context.Context, params *DeleteEventSubscriptionInput, ...) (*DeleteEventSubscriptionOutput, error)
- func (c *Client) DeleteGlobalCluster(ctx context.Context, params *DeleteGlobalClusterInput, ...) (*DeleteGlobalClusterOutput, error)
- func (c *Client) DeleteIntegration(ctx context.Context, params *DeleteIntegrationInput, optFns ...func(*Options)) (*DeleteIntegrationOutput, error)
- func (c *Client) DeleteOptionGroup(ctx context.Context, params *DeleteOptionGroupInput, optFns ...func(*Options)) (*DeleteOptionGroupOutput, error)
- func (c *Client) DeleteTenantDatabase(ctx context.Context, params *DeleteTenantDatabaseInput, ...) (*DeleteTenantDatabaseOutput, error)
- func (c *Client) DeregisterDBProxyTargets(ctx context.Context, params *DeregisterDBProxyTargetsInput, ...) (*DeregisterDBProxyTargetsOutput, error)
- func (c *Client) DescribeAccountAttributes(ctx context.Context, params *DescribeAccountAttributesInput, ...) (*DescribeAccountAttributesOutput, error)
- func (c *Client) DescribeBlueGreenDeployments(ctx context.Context, params *DescribeBlueGreenDeploymentsInput, ...) (*DescribeBlueGreenDeploymentsOutput, error)
- func (c *Client) DescribeCertificates(ctx context.Context, params *DescribeCertificatesInput, ...) (*DescribeCertificatesOutput, error)
- func (c *Client) DescribeDBClusterAutomatedBackups(ctx context.Context, params *DescribeDBClusterAutomatedBackupsInput, ...) (*DescribeDBClusterAutomatedBackupsOutput, error)
- func (c *Client) DescribeDBClusterBacktracks(ctx context.Context, params *DescribeDBClusterBacktracksInput, ...) (*DescribeDBClusterBacktracksOutput, error)
- func (c *Client) DescribeDBClusterEndpoints(ctx context.Context, params *DescribeDBClusterEndpointsInput, ...) (*DescribeDBClusterEndpointsOutput, error)
- func (c *Client) DescribeDBClusterParameterGroups(ctx context.Context, params *DescribeDBClusterParameterGroupsInput, ...) (*DescribeDBClusterParameterGroupsOutput, error)
- func (c *Client) DescribeDBClusterParameters(ctx context.Context, params *DescribeDBClusterParametersInput, ...) (*DescribeDBClusterParametersOutput, error)
- func (c *Client) DescribeDBClusterSnapshotAttributes(ctx context.Context, params *DescribeDBClusterSnapshotAttributesInput, ...) (*DescribeDBClusterSnapshotAttributesOutput, error)
- func (c *Client) DescribeDBClusterSnapshots(ctx context.Context, params *DescribeDBClusterSnapshotsInput, ...) (*DescribeDBClusterSnapshotsOutput, error)
- func (c *Client) DescribeDBClusters(ctx context.Context, params *DescribeDBClustersInput, optFns ...func(*Options)) (*DescribeDBClustersOutput, error)
- func (c *Client) DescribeDBEngineVersions(ctx context.Context, params *DescribeDBEngineVersionsInput, ...) (*DescribeDBEngineVersionsOutput, error)
- func (c *Client) DescribeDBInstanceAutomatedBackups(ctx context.Context, params *DescribeDBInstanceAutomatedBackupsInput, ...) (*DescribeDBInstanceAutomatedBackupsOutput, error)
- func (c *Client) DescribeDBInstances(ctx context.Context, params *DescribeDBInstancesInput, ...) (*DescribeDBInstancesOutput, error)
- func (c *Client) DescribeDBLogFiles(ctx context.Context, params *DescribeDBLogFilesInput, optFns ...func(*Options)) (*DescribeDBLogFilesOutput, error)
- func (c *Client) DescribeDBParameterGroups(ctx context.Context, params *DescribeDBParameterGroupsInput, ...) (*DescribeDBParameterGroupsOutput, error)
- func (c *Client) DescribeDBParameters(ctx context.Context, params *DescribeDBParametersInput, ...) (*DescribeDBParametersOutput, error)
- func (c *Client) DescribeDBProxies(ctx context.Context, params *DescribeDBProxiesInput, optFns ...func(*Options)) (*DescribeDBProxiesOutput, error)
- func (c *Client) DescribeDBProxyEndpoints(ctx context.Context, params *DescribeDBProxyEndpointsInput, ...) (*DescribeDBProxyEndpointsOutput, error)
- func (c *Client) DescribeDBProxyTargetGroups(ctx context.Context, params *DescribeDBProxyTargetGroupsInput, ...) (*DescribeDBProxyTargetGroupsOutput, error)
- func (c *Client) DescribeDBProxyTargets(ctx context.Context, params *DescribeDBProxyTargetsInput, ...) (*DescribeDBProxyTargetsOutput, error)
- func (c *Client) DescribeDBRecommendations(ctx context.Context, params *DescribeDBRecommendationsInput, ...) (*DescribeDBRecommendationsOutput, error)
- func (c *Client) DescribeDBSecurityGroups(ctx context.Context, params *DescribeDBSecurityGroupsInput, ...) (*DescribeDBSecurityGroupsOutput, error)
- func (c *Client) DescribeDBShardGroups(ctx context.Context, params *DescribeDBShardGroupsInput, ...) (*DescribeDBShardGroupsOutput, error)
- func (c *Client) DescribeDBSnapshotAttributes(ctx context.Context, params *DescribeDBSnapshotAttributesInput, ...) (*DescribeDBSnapshotAttributesOutput, error)
- func (c *Client) DescribeDBSnapshotTenantDatabases(ctx context.Context, params *DescribeDBSnapshotTenantDatabasesInput, ...) (*DescribeDBSnapshotTenantDatabasesOutput, error)
- func (c *Client) DescribeDBSnapshots(ctx context.Context, params *DescribeDBSnapshotsInput, ...) (*DescribeDBSnapshotsOutput, error)
- func (c *Client) DescribeDBSubnetGroups(ctx context.Context, params *DescribeDBSubnetGroupsInput, ...) (*DescribeDBSubnetGroupsOutput, error)
- func (c *Client) DescribeEngineDefaultClusterParameters(ctx context.Context, params *DescribeEngineDefaultClusterParametersInput, ...) (*DescribeEngineDefaultClusterParametersOutput, error)
- func (c *Client) DescribeEngineDefaultParameters(ctx context.Context, params *DescribeEngineDefaultParametersInput, ...) (*DescribeEngineDefaultParametersOutput, error)
- func (c *Client) DescribeEventCategories(ctx context.Context, params *DescribeEventCategoriesInput, ...) (*DescribeEventCategoriesOutput, error)
- func (c *Client) DescribeEventSubscriptions(ctx context.Context, params *DescribeEventSubscriptionsInput, ...) (*DescribeEventSubscriptionsOutput, error)
- func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput, optFns ...func(*Options)) (*DescribeEventsOutput, error)
- func (c *Client) DescribeExportTasks(ctx context.Context, params *DescribeExportTasksInput, ...) (*DescribeExportTasksOutput, error)
- func (c *Client) DescribeGlobalClusters(ctx context.Context, params *DescribeGlobalClustersInput, ...) (*DescribeGlobalClustersOutput, error)
- func (c *Client) DescribeIntegrations(ctx context.Context, params *DescribeIntegrationsInput, ...) (*DescribeIntegrationsOutput, error)
- func (c *Client) DescribeOptionGroupOptions(ctx context.Context, params *DescribeOptionGroupOptionsInput, ...) (*DescribeOptionGroupOptionsOutput, error)
- func (c *Client) DescribeOptionGroups(ctx context.Context, params *DescribeOptionGroupsInput, ...) (*DescribeOptionGroupsOutput, error)
- func (c *Client) DescribeOrderableDBInstanceOptions(ctx context.Context, params *DescribeOrderableDBInstanceOptionsInput, ...) (*DescribeOrderableDBInstanceOptionsOutput, error)
- func (c *Client) DescribePendingMaintenanceActions(ctx context.Context, params *DescribePendingMaintenanceActionsInput, ...) (*DescribePendingMaintenanceActionsOutput, error)
- func (c *Client) DescribeReservedDBInstances(ctx context.Context, params *DescribeReservedDBInstancesInput, ...) (*DescribeReservedDBInstancesOutput, error)
- func (c *Client) DescribeReservedDBInstancesOfferings(ctx context.Context, params *DescribeReservedDBInstancesOfferingsInput, ...) (*DescribeReservedDBInstancesOfferingsOutput, error)
- func (c *Client) DescribeSourceRegions(ctx context.Context, params *DescribeSourceRegionsInput, ...) (*DescribeSourceRegionsOutput, error)
- func (c *Client) DescribeTenantDatabases(ctx context.Context, params *DescribeTenantDatabasesInput, ...) (*DescribeTenantDatabasesOutput, error)
- func (c *Client) DescribeValidDBInstanceModifications(ctx context.Context, params *DescribeValidDBInstanceModificationsInput, ...) (*DescribeValidDBInstanceModificationsOutput, error)
- func (c *Client) DisableHttpEndpoint(ctx context.Context, params *DisableHttpEndpointInput, ...) (*DisableHttpEndpointOutput, error)
- func (c *Client) DownloadDBLogFilePortion(ctx context.Context, params *DownloadDBLogFilePortionInput, ...) (*DownloadDBLogFilePortionOutput, error)
- func (c *Client) EnableHttpEndpoint(ctx context.Context, params *EnableHttpEndpointInput, optFns ...func(*Options)) (*EnableHttpEndpointOutput, error)
- func (c *Client) FailoverDBCluster(ctx context.Context, params *FailoverDBClusterInput, optFns ...func(*Options)) (*FailoverDBClusterOutput, error)
- func (c *Client) FailoverGlobalCluster(ctx context.Context, params *FailoverGlobalClusterInput, ...) (*FailoverGlobalClusterOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) ModifyActivityStream(ctx context.Context, params *ModifyActivityStreamInput, ...) (*ModifyActivityStreamOutput, error)
- func (c *Client) ModifyCertificates(ctx context.Context, params *ModifyCertificatesInput, optFns ...func(*Options)) (*ModifyCertificatesOutput, error)
- func (c *Client) ModifyCurrentDBClusterCapacity(ctx context.Context, params *ModifyCurrentDBClusterCapacityInput, ...) (*ModifyCurrentDBClusterCapacityOutput, error)
- func (c *Client) ModifyCustomDBEngineVersion(ctx context.Context, params *ModifyCustomDBEngineVersionInput, ...) (*ModifyCustomDBEngineVersionOutput, error)
- func (c *Client) ModifyDBCluster(ctx context.Context, params *ModifyDBClusterInput, optFns ...func(*Options)) (*ModifyDBClusterOutput, error)
- func (c *Client) ModifyDBClusterEndpoint(ctx context.Context, params *ModifyDBClusterEndpointInput, ...) (*ModifyDBClusterEndpointOutput, error)
- func (c *Client) ModifyDBClusterParameterGroup(ctx context.Context, params *ModifyDBClusterParameterGroupInput, ...) (*ModifyDBClusterParameterGroupOutput, error)
- func (c *Client) ModifyDBClusterSnapshotAttribute(ctx context.Context, params *ModifyDBClusterSnapshotAttributeInput, ...) (*ModifyDBClusterSnapshotAttributeOutput, error)
- func (c *Client) ModifyDBInstance(ctx context.Context, params *ModifyDBInstanceInput, optFns ...func(*Options)) (*ModifyDBInstanceOutput, error)
- func (c *Client) ModifyDBParameterGroup(ctx context.Context, params *ModifyDBParameterGroupInput, ...) (*ModifyDBParameterGroupOutput, error)
- func (c *Client) ModifyDBProxy(ctx context.Context, params *ModifyDBProxyInput, optFns ...func(*Options)) (*ModifyDBProxyOutput, error)
- func (c *Client) ModifyDBProxyEndpoint(ctx context.Context, params *ModifyDBProxyEndpointInput, ...) (*ModifyDBProxyEndpointOutput, error)
- func (c *Client) ModifyDBProxyTargetGroup(ctx context.Context, params *ModifyDBProxyTargetGroupInput, ...) (*ModifyDBProxyTargetGroupOutput, error)
- func (c *Client) ModifyDBRecommendation(ctx context.Context, params *ModifyDBRecommendationInput, ...) (*ModifyDBRecommendationOutput, error)
- func (c *Client) ModifyDBShardGroup(ctx context.Context, params *ModifyDBShardGroupInput, optFns ...func(*Options)) (*ModifyDBShardGroupOutput, error)
- func (c *Client) ModifyDBSnapshot(ctx context.Context, params *ModifyDBSnapshotInput, optFns ...func(*Options)) (*ModifyDBSnapshotOutput, error)
- func (c *Client) ModifyDBSnapshotAttribute(ctx context.Context, params *ModifyDBSnapshotAttributeInput, ...) (*ModifyDBSnapshotAttributeOutput, error)
- func (c *Client) ModifyDBSubnetGroup(ctx context.Context, params *ModifyDBSubnetGroupInput, ...) (*ModifyDBSubnetGroupOutput, error)
- func (c *Client) ModifyEventSubscription(ctx context.Context, params *ModifyEventSubscriptionInput, ...) (*ModifyEventSubscriptionOutput, error)
- func (c *Client) ModifyGlobalCluster(ctx context.Context, params *ModifyGlobalClusterInput, ...) (*ModifyGlobalClusterOutput, error)
- func (c *Client) ModifyIntegration(ctx context.Context, params *ModifyIntegrationInput, optFns ...func(*Options)) (*ModifyIntegrationOutput, error)
- func (c *Client) ModifyOptionGroup(ctx context.Context, params *ModifyOptionGroupInput, optFns ...func(*Options)) (*ModifyOptionGroupOutput, error)
- func (c *Client) ModifyTenantDatabase(ctx context.Context, params *ModifyTenantDatabaseInput, ...) (*ModifyTenantDatabaseOutput, error)
- func (c *Client) Options() Options
- func (c *Client) PromoteReadReplica(ctx context.Context, params *PromoteReadReplicaInput, optFns ...func(*Options)) (*PromoteReadReplicaOutput, error)
- func (c *Client) PromoteReadReplicaDBCluster(ctx context.Context, params *PromoteReadReplicaDBClusterInput, ...) (*PromoteReadReplicaDBClusterOutput, error)
- func (c *Client) PurchaseReservedDBInstancesOffering(ctx context.Context, params *PurchaseReservedDBInstancesOfferingInput, ...) (*PurchaseReservedDBInstancesOfferingOutput, error)
- func (c *Client) RebootDBCluster(ctx context.Context, params *RebootDBClusterInput, optFns ...func(*Options)) (*RebootDBClusterOutput, error)
- func (c *Client) RebootDBInstance(ctx context.Context, params *RebootDBInstanceInput, optFns ...func(*Options)) (*RebootDBInstanceOutput, error)
- func (c *Client) RebootDBShardGroup(ctx context.Context, params *RebootDBShardGroupInput, optFns ...func(*Options)) (*RebootDBShardGroupOutput, error)
- func (c *Client) RegisterDBProxyTargets(ctx context.Context, params *RegisterDBProxyTargetsInput, ...) (*RegisterDBProxyTargetsOutput, error)
- func (c *Client) RemoveFromGlobalCluster(ctx context.Context, params *RemoveFromGlobalClusterInput, ...) (*RemoveFromGlobalClusterOutput, error)
- func (c *Client) RemoveRoleFromDBCluster(ctx context.Context, params *RemoveRoleFromDBClusterInput, ...) (*RemoveRoleFromDBClusterOutput, error)
- func (c *Client) RemoveRoleFromDBInstance(ctx context.Context, params *RemoveRoleFromDBInstanceInput, ...) (*RemoveRoleFromDBInstanceOutput, error)
- func (c *Client) RemoveSourceIdentifierFromSubscription(ctx context.Context, params *RemoveSourceIdentifierFromSubscriptionInput, ...) (*RemoveSourceIdentifierFromSubscriptionOutput, error)
- func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsFromResourceInput, ...) (*RemoveTagsFromResourceOutput, error)
- func (c *Client) ResetDBClusterParameterGroup(ctx context.Context, params *ResetDBClusterParameterGroupInput, ...) (*ResetDBClusterParameterGroupOutput, error)
- func (c *Client) ResetDBParameterGroup(ctx context.Context, params *ResetDBParameterGroupInput, ...) (*ResetDBParameterGroupOutput, error)
- func (c *Client) RestoreDBClusterFromS3(ctx context.Context, params *RestoreDBClusterFromS3Input, ...) (*RestoreDBClusterFromS3Output, error)
- func (c *Client) RestoreDBClusterFromSnapshot(ctx context.Context, params *RestoreDBClusterFromSnapshotInput, ...) (*RestoreDBClusterFromSnapshotOutput, error)
- func (c *Client) RestoreDBClusterToPointInTime(ctx context.Context, params *RestoreDBClusterToPointInTimeInput, ...) (*RestoreDBClusterToPointInTimeOutput, error)
- func (c *Client) RestoreDBInstanceFromDBSnapshot(ctx context.Context, params *RestoreDBInstanceFromDBSnapshotInput, ...) (*RestoreDBInstanceFromDBSnapshotOutput, error)
- func (c *Client) RestoreDBInstanceFromS3(ctx context.Context, params *RestoreDBInstanceFromS3Input, ...) (*RestoreDBInstanceFromS3Output, error)
- func (c *Client) RestoreDBInstanceToPointInTime(ctx context.Context, params *RestoreDBInstanceToPointInTimeInput, ...) (*RestoreDBInstanceToPointInTimeOutput, error)
- func (c *Client) RevokeDBSecurityGroupIngress(ctx context.Context, params *RevokeDBSecurityGroupIngressInput, ...) (*RevokeDBSecurityGroupIngressOutput, error)
- func (c *Client) StartActivityStream(ctx context.Context, params *StartActivityStreamInput, ...) (*StartActivityStreamOutput, error)
- func (c *Client) StartDBCluster(ctx context.Context, params *StartDBClusterInput, optFns ...func(*Options)) (*StartDBClusterOutput, error)
- func (c *Client) StartDBInstance(ctx context.Context, params *StartDBInstanceInput, optFns ...func(*Options)) (*StartDBInstanceOutput, error)
- func (c *Client) StartDBInstanceAutomatedBackupsReplication(ctx context.Context, params *StartDBInstanceAutomatedBackupsReplicationInput, ...) (*StartDBInstanceAutomatedBackupsReplicationOutput, error)
- func (c *Client) StartExportTask(ctx context.Context, params *StartExportTaskInput, optFns ...func(*Options)) (*StartExportTaskOutput, error)
- func (c *Client) StopActivityStream(ctx context.Context, params *StopActivityStreamInput, optFns ...func(*Options)) (*StopActivityStreamOutput, error)
- func (c *Client) StopDBCluster(ctx context.Context, params *StopDBClusterInput, optFns ...func(*Options)) (*StopDBClusterOutput, error)
- func (c *Client) StopDBInstance(ctx context.Context, params *StopDBInstanceInput, optFns ...func(*Options)) (*StopDBInstanceOutput, error)
- func (c *Client) StopDBInstanceAutomatedBackupsReplication(ctx context.Context, params *StopDBInstanceAutomatedBackupsReplicationInput, ...) (*StopDBInstanceAutomatedBackupsReplicationOutput, error)
- func (c *Client) SwitchoverBlueGreenDeployment(ctx context.Context, params *SwitchoverBlueGreenDeploymentInput, ...) (*SwitchoverBlueGreenDeploymentOutput, error)
- func (c *Client) SwitchoverGlobalCluster(ctx context.Context, params *SwitchoverGlobalClusterInput, ...) (*SwitchoverGlobalClusterOutput, error)
- func (c *Client) SwitchoverReadReplica(ctx context.Context, params *SwitchoverReadReplicaInput, ...) (*SwitchoverReadReplicaOutput, error)
- type CopyDBClusterParameterGroupInput
- type CopyDBClusterParameterGroupOutput
- type CopyDBClusterSnapshotInput
- type CopyDBClusterSnapshotOutput
- type CopyDBParameterGroupInput
- type CopyDBParameterGroupOutput
- type CopyDBSnapshotInput
- type CopyDBSnapshotOutput
- type CopyOptionGroupInput
- type CopyOptionGroupOutput
- type CreateBlueGreenDeploymentInput
- type CreateBlueGreenDeploymentOutput
- type CreateCustomDBEngineVersionInput
- type CreateCustomDBEngineVersionOutput
- type CreateDBClusterEndpointInput
- type CreateDBClusterEndpointOutput
- type CreateDBClusterInput
- type CreateDBClusterOutput
- type CreateDBClusterParameterGroupInput
- type CreateDBClusterParameterGroupOutput
- type CreateDBClusterSnapshotInput
- type CreateDBClusterSnapshotOutput
- type CreateDBInstanceInput
- type CreateDBInstanceOutput
- type CreateDBInstanceReadReplicaInput
- type CreateDBInstanceReadReplicaOutput
- type CreateDBParameterGroupInput
- type CreateDBParameterGroupOutput
- type CreateDBProxyEndpointInput
- type CreateDBProxyEndpointOutput
- type CreateDBProxyInput
- type CreateDBProxyOutput
- type CreateDBSecurityGroupInput
- type CreateDBSecurityGroupOutput
- type CreateDBShardGroupInput
- type CreateDBShardGroupOutput
- type CreateDBSnapshotInput
- type CreateDBSnapshotOutput
- type CreateDBSubnetGroupInput
- type CreateDBSubnetGroupOutput
- type CreateEventSubscriptionInput
- type CreateEventSubscriptionOutput
- type CreateGlobalClusterInput
- type CreateGlobalClusterOutput
- type CreateIntegrationInput
- type CreateIntegrationOutput
- type CreateOptionGroupInput
- type CreateOptionGroupOutput
- type CreateTenantDatabaseInput
- type CreateTenantDatabaseOutput
- type DBClusterAvailableWaiter
- type DBClusterAvailableWaiterOptions
- type DBClusterDeletedWaiter
- type DBClusterDeletedWaiterOptions
- type DBClusterSnapshotAvailableWaiter
- type DBClusterSnapshotAvailableWaiterOptions
- type DBClusterSnapshotDeletedWaiter
- type DBClusterSnapshotDeletedWaiterOptions
- type DBInstanceAvailableWaiter
- type DBInstanceAvailableWaiterOptions
- type DBInstanceDeletedWaiter
- type DBInstanceDeletedWaiterOptions
- type DBSnapshotAvailableWaiter
- type DBSnapshotAvailableWaiterOptions
- type DBSnapshotDeletedWaiter
- type DBSnapshotDeletedWaiterOptions
- type DeleteBlueGreenDeploymentInput
- type DeleteBlueGreenDeploymentOutput
- type DeleteCustomDBEngineVersionInput
- type DeleteCustomDBEngineVersionOutput
- type DeleteDBClusterAutomatedBackupInput
- type DeleteDBClusterAutomatedBackupOutput
- type DeleteDBClusterEndpointInput
- type DeleteDBClusterEndpointOutput
- type DeleteDBClusterInput
- type DeleteDBClusterOutput
- type DeleteDBClusterParameterGroupInput
- type DeleteDBClusterParameterGroupOutput
- type DeleteDBClusterSnapshotInput
- type DeleteDBClusterSnapshotOutput
- type DeleteDBInstanceAutomatedBackupInput
- type DeleteDBInstanceAutomatedBackupOutput
- type DeleteDBInstanceInput
- type DeleteDBInstanceOutput
- type DeleteDBParameterGroupInput
- type DeleteDBParameterGroupOutput
- type DeleteDBProxyEndpointInput
- type DeleteDBProxyEndpointOutput
- type DeleteDBProxyInput
- type DeleteDBProxyOutput
- type DeleteDBSecurityGroupInput
- type DeleteDBSecurityGroupOutput
- type DeleteDBShardGroupInput
- type DeleteDBShardGroupOutput
- type DeleteDBSnapshotInput
- type DeleteDBSnapshotOutput
- type DeleteDBSubnetGroupInput
- type DeleteDBSubnetGroupOutput
- type DeleteEventSubscriptionInput
- type DeleteEventSubscriptionOutput
- type DeleteGlobalClusterInput
- type DeleteGlobalClusterOutput
- type DeleteIntegrationInput
- type DeleteIntegrationOutput
- type DeleteOptionGroupInput
- type DeleteOptionGroupOutput
- type DeleteTenantDatabaseInput
- type DeleteTenantDatabaseOutput
- type DeregisterDBProxyTargetsInput
- type DeregisterDBProxyTargetsOutput
- type DescribeAccountAttributesInput
- type DescribeAccountAttributesOutput
- type DescribeBlueGreenDeploymentsAPIClient
- type DescribeBlueGreenDeploymentsInput
- type DescribeBlueGreenDeploymentsOutput
- type DescribeBlueGreenDeploymentsPaginator
- type DescribeBlueGreenDeploymentsPaginatorOptions
- type DescribeCertificatesAPIClient
- type DescribeCertificatesInput
- type DescribeCertificatesOutput
- type DescribeCertificatesPaginator
- type DescribeCertificatesPaginatorOptions
- type DescribeDBClusterAutomatedBackupsAPIClient
- type DescribeDBClusterAutomatedBackupsInput
- type DescribeDBClusterAutomatedBackupsOutput
- type DescribeDBClusterAutomatedBackupsPaginator
- type DescribeDBClusterAutomatedBackupsPaginatorOptions
- type DescribeDBClusterBacktracksAPIClient
- type DescribeDBClusterBacktracksInput
- type DescribeDBClusterBacktracksOutput
- type DescribeDBClusterBacktracksPaginator
- type DescribeDBClusterBacktracksPaginatorOptions
- type DescribeDBClusterEndpointsAPIClient
- type DescribeDBClusterEndpointsInput
- type DescribeDBClusterEndpointsOutput
- type DescribeDBClusterEndpointsPaginator
- type DescribeDBClusterEndpointsPaginatorOptions
- type DescribeDBClusterParameterGroupsAPIClient
- type DescribeDBClusterParameterGroupsInput
- type DescribeDBClusterParameterGroupsOutput
- type DescribeDBClusterParameterGroupsPaginator
- type DescribeDBClusterParameterGroupsPaginatorOptions
- type DescribeDBClusterParametersAPIClient
- type DescribeDBClusterParametersInput
- type DescribeDBClusterParametersOutput
- type DescribeDBClusterParametersPaginator
- type DescribeDBClusterParametersPaginatorOptions
- type DescribeDBClusterSnapshotAttributesInput
- type DescribeDBClusterSnapshotAttributesOutput
- type DescribeDBClusterSnapshotsAPIClient
- type DescribeDBClusterSnapshotsInput
- type DescribeDBClusterSnapshotsOutput
- type DescribeDBClusterSnapshotsPaginator
- type DescribeDBClusterSnapshotsPaginatorOptions
- type DescribeDBClustersAPIClient
- type DescribeDBClustersInput
- type DescribeDBClustersOutput
- type DescribeDBClustersPaginator
- type DescribeDBClustersPaginatorOptions
- type DescribeDBEngineVersionsAPIClient
- type DescribeDBEngineVersionsInput
- type DescribeDBEngineVersionsOutput
- type DescribeDBEngineVersionsPaginator
- type DescribeDBEngineVersionsPaginatorOptions
- type DescribeDBInstanceAutomatedBackupsAPIClient
- type DescribeDBInstanceAutomatedBackupsInput
- type DescribeDBInstanceAutomatedBackupsOutput
- type DescribeDBInstanceAutomatedBackupsPaginator
- type DescribeDBInstanceAutomatedBackupsPaginatorOptions
- type DescribeDBInstancesAPIClient
- type DescribeDBInstancesInput
- type DescribeDBInstancesOutput
- type DescribeDBInstancesPaginator
- type DescribeDBInstancesPaginatorOptions
- type DescribeDBLogFilesAPIClient
- type DescribeDBLogFilesInput
- type DescribeDBLogFilesOutput
- type DescribeDBLogFilesPaginator
- type DescribeDBLogFilesPaginatorOptions
- type DescribeDBParameterGroupsAPIClient
- type DescribeDBParameterGroupsInput
- type DescribeDBParameterGroupsOutput
- type DescribeDBParameterGroupsPaginator
- type DescribeDBParameterGroupsPaginatorOptions
- type DescribeDBParametersAPIClient
- type DescribeDBParametersInput
- type DescribeDBParametersOutput
- type DescribeDBParametersPaginator
- type DescribeDBParametersPaginatorOptions
- type DescribeDBProxiesAPIClient
- type DescribeDBProxiesInput
- type DescribeDBProxiesOutput
- type DescribeDBProxiesPaginator
- type DescribeDBProxiesPaginatorOptions
- type DescribeDBProxyEndpointsAPIClient
- type DescribeDBProxyEndpointsInput
- type DescribeDBProxyEndpointsOutput
- type DescribeDBProxyEndpointsPaginator
- type DescribeDBProxyEndpointsPaginatorOptions
- type DescribeDBProxyTargetGroupsAPIClient
- type DescribeDBProxyTargetGroupsInput
- type DescribeDBProxyTargetGroupsOutput
- type DescribeDBProxyTargetGroupsPaginator
- type DescribeDBProxyTargetGroupsPaginatorOptions
- type DescribeDBProxyTargetsAPIClient
- type DescribeDBProxyTargetsInput
- type DescribeDBProxyTargetsOutput
- type DescribeDBProxyTargetsPaginator
- type DescribeDBProxyTargetsPaginatorOptions
- type DescribeDBRecommendationsAPIClient
- type DescribeDBRecommendationsInput
- type DescribeDBRecommendationsOutput
- type DescribeDBRecommendationsPaginator
- type DescribeDBRecommendationsPaginatorOptions
- type DescribeDBSecurityGroupsAPIClient
- type DescribeDBSecurityGroupsInput
- type DescribeDBSecurityGroupsOutput
- type DescribeDBSecurityGroupsPaginator
- type DescribeDBSecurityGroupsPaginatorOptions
- type DescribeDBShardGroupsInput
- type DescribeDBShardGroupsOutput
- type DescribeDBSnapshotAttributesInput
- type DescribeDBSnapshotAttributesOutput
- type DescribeDBSnapshotTenantDatabasesAPIClient
- type DescribeDBSnapshotTenantDatabasesInput
- type DescribeDBSnapshotTenantDatabasesOutput
- type DescribeDBSnapshotTenantDatabasesPaginator
- type DescribeDBSnapshotTenantDatabasesPaginatorOptions
- type DescribeDBSnapshotsAPIClient
- type DescribeDBSnapshotsInput
- type DescribeDBSnapshotsOutput
- type DescribeDBSnapshotsPaginator
- type DescribeDBSnapshotsPaginatorOptions
- type DescribeDBSubnetGroupsAPIClient
- type DescribeDBSubnetGroupsInput
- type DescribeDBSubnetGroupsOutput
- type DescribeDBSubnetGroupsPaginator
- type DescribeDBSubnetGroupsPaginatorOptions
- type DescribeEngineDefaultClusterParametersInput
- type DescribeEngineDefaultClusterParametersOutput
- type DescribeEngineDefaultParametersAPIClient
- type DescribeEngineDefaultParametersInput
- type DescribeEngineDefaultParametersOutput
- type DescribeEngineDefaultParametersPaginator
- type DescribeEngineDefaultParametersPaginatorOptions
- type DescribeEventCategoriesInput
- type DescribeEventCategoriesOutput
- type DescribeEventSubscriptionsAPIClient
- type DescribeEventSubscriptionsInput
- type DescribeEventSubscriptionsOutput
- type DescribeEventSubscriptionsPaginator
- type DescribeEventSubscriptionsPaginatorOptions
- type DescribeEventsAPIClient
- type DescribeEventsInput
- type DescribeEventsOutput
- type DescribeEventsPaginator
- type DescribeEventsPaginatorOptions
- type DescribeExportTasksAPIClient
- type DescribeExportTasksInput
- type DescribeExportTasksOutput
- type DescribeExportTasksPaginator
- type DescribeExportTasksPaginatorOptions
- type DescribeGlobalClustersAPIClient
- type DescribeGlobalClustersInput
- type DescribeGlobalClustersOutput
- type DescribeGlobalClustersPaginator
- type DescribeGlobalClustersPaginatorOptions
- type DescribeIntegrationsAPIClient
- type DescribeIntegrationsInput
- type DescribeIntegrationsOutput
- type DescribeIntegrationsPaginator
- type DescribeIntegrationsPaginatorOptions
- type DescribeOptionGroupOptionsAPIClient
- type DescribeOptionGroupOptionsInput
- type DescribeOptionGroupOptionsOutput
- type DescribeOptionGroupOptionsPaginator
- type DescribeOptionGroupOptionsPaginatorOptions
- type DescribeOptionGroupsAPIClient
- type DescribeOptionGroupsInput
- type DescribeOptionGroupsOutput
- type DescribeOptionGroupsPaginator
- type DescribeOptionGroupsPaginatorOptions
- type DescribeOrderableDBInstanceOptionsAPIClient
- type DescribeOrderableDBInstanceOptionsInput
- type DescribeOrderableDBInstanceOptionsOutput
- type DescribeOrderableDBInstanceOptionsPaginator
- type DescribeOrderableDBInstanceOptionsPaginatorOptions
- type DescribePendingMaintenanceActionsAPIClient
- type DescribePendingMaintenanceActionsInput
- type DescribePendingMaintenanceActionsOutput
- type DescribePendingMaintenanceActionsPaginator
- type DescribePendingMaintenanceActionsPaginatorOptions
- type DescribeReservedDBInstancesAPIClient
- type DescribeReservedDBInstancesInput
- type DescribeReservedDBInstancesOfferingsAPIClient
- type DescribeReservedDBInstancesOfferingsInput
- type DescribeReservedDBInstancesOfferingsOutput
- type DescribeReservedDBInstancesOfferingsPaginator
- type DescribeReservedDBInstancesOfferingsPaginatorOptions
- type DescribeReservedDBInstancesOutput
- type DescribeReservedDBInstancesPaginator
- type DescribeReservedDBInstancesPaginatorOptions
- type DescribeSourceRegionsAPIClient
- type DescribeSourceRegionsInput
- type DescribeSourceRegionsOutput
- type DescribeSourceRegionsPaginator
- type DescribeSourceRegionsPaginatorOptions
- type DescribeTenantDatabasesAPIClient
- type DescribeTenantDatabasesInput
- type DescribeTenantDatabasesOutput
- type DescribeTenantDatabasesPaginator
- type DescribeTenantDatabasesPaginatorOptions
- type DescribeValidDBInstanceModificationsInput
- type DescribeValidDBInstanceModificationsOutput
- type DisableHttpEndpointInput
- type DisableHttpEndpointOutput
- type DownloadDBLogFilePortionAPIClient
- type DownloadDBLogFilePortionInput
- type DownloadDBLogFilePortionOutput
- type DownloadDBLogFilePortionPaginator
- type DownloadDBLogFilePortionPaginatorOptions
- type EnableHttpEndpointInput
- type EnableHttpEndpointOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type FailoverDBClusterInput
- type FailoverDBClusterOutput
- type FailoverGlobalClusterInput
- type FailoverGlobalClusterOutput
- type HTTPClient
- type HTTPPresignerV4
- type HTTPSignerV4
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ModifyActivityStreamInput
- type ModifyActivityStreamOutput
- type ModifyCertificatesInput
- type ModifyCertificatesOutput
- type ModifyCurrentDBClusterCapacityInput
- type ModifyCurrentDBClusterCapacityOutput
- type ModifyCustomDBEngineVersionInput
- type ModifyCustomDBEngineVersionOutput
- type ModifyDBClusterEndpointInput
- type ModifyDBClusterEndpointOutput
- type ModifyDBClusterInput
- type ModifyDBClusterOutput
- type ModifyDBClusterParameterGroupInput
- type ModifyDBClusterParameterGroupOutput
- type ModifyDBClusterSnapshotAttributeInput
- type ModifyDBClusterSnapshotAttributeOutput
- type ModifyDBInstanceInput
- type ModifyDBInstanceOutput
- type ModifyDBParameterGroupInput
- type ModifyDBParameterGroupOutput
- type ModifyDBProxyEndpointInput
- type ModifyDBProxyEndpointOutput
- type ModifyDBProxyInput
- type ModifyDBProxyOutput
- type ModifyDBProxyTargetGroupInput
- type ModifyDBProxyTargetGroupOutput
- type ModifyDBRecommendationInput
- type ModifyDBRecommendationOutput
- type ModifyDBShardGroupInput
- type ModifyDBShardGroupOutput
- type ModifyDBSnapshotAttributeInput
- type ModifyDBSnapshotAttributeOutput
- type ModifyDBSnapshotInput
- type ModifyDBSnapshotOutput
- type ModifyDBSubnetGroupInput
- type ModifyDBSubnetGroupOutput
- type ModifyEventSubscriptionInput
- type ModifyEventSubscriptionOutput
- type ModifyGlobalClusterInput
- type ModifyGlobalClusterOutput
- type ModifyIntegrationInput
- type ModifyIntegrationOutput
- type ModifyOptionGroupInput
- type ModifyOptionGroupOutput
- type ModifyTenantDatabaseInput
- type ModifyTenantDatabaseOutput
- type Options
- type PresignClient
- func (c *PresignClient) PresignCopyDBClusterSnapshot(ctx context.Context, params *CopyDBClusterSnapshotInput, ...) (*v4.PresignedHTTPRequest, error)
- func (c *PresignClient) PresignCopyDBSnapshot(ctx context.Context, params *CopyDBSnapshotInput, ...) (*v4.PresignedHTTPRequest, error)
- func (c *PresignClient) PresignCreateDBCluster(ctx context.Context, params *CreateDBClusterInput, ...) (*v4.PresignedHTTPRequest, error)
- func (c *PresignClient) PresignCreateDBInstanceReadReplica(ctx context.Context, params *CreateDBInstanceReadReplicaInput, ...) (*v4.PresignedHTTPRequest, error)
- type PresignOptions
- type PromoteReadReplicaDBClusterInput
- type PromoteReadReplicaDBClusterOutput
- type PromoteReadReplicaInput
- type PromoteReadReplicaOutput
- type PurchaseReservedDBInstancesOfferingInput
- type PurchaseReservedDBInstancesOfferingOutput
- type RebootDBClusterInput
- type RebootDBClusterOutput
- type RebootDBInstanceInput
- type RebootDBInstanceOutput
- type RebootDBShardGroupInput
- type RebootDBShardGroupOutput
- type RegisterDBProxyTargetsInput
- type RegisterDBProxyTargetsOutput
- type RemoveFromGlobalClusterInput
- type RemoveFromGlobalClusterOutput
- type RemoveRoleFromDBClusterInput
- type RemoveRoleFromDBClusterOutput
- type RemoveRoleFromDBInstanceInput
- type RemoveRoleFromDBInstanceOutput
- type RemoveSourceIdentifierFromSubscriptionInput
- type RemoveSourceIdentifierFromSubscriptionOutput
- type RemoveTagsFromResourceInput
- type RemoveTagsFromResourceOutput
- type ResetDBClusterParameterGroupInput
- type ResetDBClusterParameterGroupOutput
- type ResetDBParameterGroupInput
- type ResetDBParameterGroupOutput
- type ResolveEndpoint
- type RestoreDBClusterFromS3Input
- type RestoreDBClusterFromS3Output
- type RestoreDBClusterFromSnapshotInput
- type RestoreDBClusterFromSnapshotOutput
- type RestoreDBClusterToPointInTimeInput
- type RestoreDBClusterToPointInTimeOutput
- type RestoreDBInstanceFromDBSnapshotInput
- type RestoreDBInstanceFromDBSnapshotOutput
- type RestoreDBInstanceFromS3Input
- type RestoreDBInstanceFromS3Output
- type RestoreDBInstanceToPointInTimeInput
- type RestoreDBInstanceToPointInTimeOutput
- type RevokeDBSecurityGroupIngressInput
- type RevokeDBSecurityGroupIngressOutput
- type StartActivityStreamInput
- type StartActivityStreamOutput
- type StartDBClusterInput
- type StartDBClusterOutput
- type StartDBInstanceAutomatedBackupsReplicationInput
- type StartDBInstanceAutomatedBackupsReplicationOutput
- type StartDBInstanceInput
- type StartDBInstanceOutput
- type StartExportTaskInput
- type StartExportTaskOutput
- type StopActivityStreamInput
- type StopActivityStreamOutput
- type StopDBClusterInput
- type StopDBClusterOutput
- type StopDBInstanceAutomatedBackupsReplicationInput
- type StopDBInstanceAutomatedBackupsReplicationOutput
- type StopDBInstanceInput
- type StopDBInstanceOutput
- type SwitchoverBlueGreenDeploymentInput
- type SwitchoverBlueGreenDeploymentOutput
- type SwitchoverGlobalClusterInput
- type SwitchoverGlobalClusterOutput
- type SwitchoverReadReplicaInput
- type SwitchoverReadReplicaOutput
- type TenantDatabaseAvailableWaiter
- type TenantDatabaseAvailableWaiterOptions
- type TenantDatabaseDeletedWaiter
- type TenantDatabaseDeletedWaiterOptions
Constants ¶
const ServiceAPIVersion = "2014-10-31"
const ServiceID = "RDS"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶ added in v1.0.0
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.
To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶ added in v1.49.0
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithPresignClientFromClientOptions ¶ added in v0.30.0
func WithPresignClientFromClientOptions(optFns ...func(*Options)) func(*PresignOptions)
WithPresignClientFromClientOptions is a helper utility to retrieve a function that takes PresignOption as input
func WithSigV4SigningName ¶ added in v1.62.4
WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.
func WithSigV4SigningRegion ¶ added in v1.62.4
WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.
Types ¶
type AddRoleToDBClusterInput ¶
type AddRoleToDBClusterInput struct { // The name of the DB cluster to associate the IAM role with. // // This member is required. DBClusterIdentifier *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 . // // This member is required. RoleArn *string // 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 // contains filtered or unexported fields }
type AddRoleToDBClusterOutput ¶
type AddRoleToDBClusterOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AddRoleToDBInstanceInput ¶
type AddRoleToDBInstanceInput struct { // The name of the DB instance to associate the IAM role with. // // This member is required. DBInstanceIdentifier *string // 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. // // This member is required. FeatureName *string // The Amazon Resource Name (ARN) of the IAM role to associate with the DB // instance, for example arn:aws:iam::123456789012:role/AccessRole . // // This member is required. RoleArn *string // contains filtered or unexported fields }
type AddRoleToDBInstanceOutput ¶
type AddRoleToDBInstanceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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. // // This member is required. SourceIdentifier *string // The name of the RDS event notification subscription you want to add a source // identifier to. // // This member is required. SubscriptionName *string // contains filtered or unexported fields }
type AddSourceIdentifierToSubscriptionOutput ¶
type AddSourceIdentifierToSubscriptionOutput struct { // Contains the results of a successful invocation of the // DescribeEventSubscriptions action. EventSubscription *types.EventSubscription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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)]. // // [Constructing an RDS Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing // // This member is required. ResourceName *string // The tags to be assigned to the Amazon RDS resource. // // This member is required. Tags []types.Tag // contains filtered or unexported fields }
type AddTagsToResourceOutput ¶
type AddTagsToResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ApplyPendingMaintenanceActionInput ¶
type ApplyPendingMaintenanceActionInput struct { // The pending maintenance action to apply to this resource. // // Valid Values: // // - ca-certificate-rotation // // - db-upgrade // // - hardware-maintenance // // - os-upgrade // // - system-update // // For more information about these actions, see [Maintenance actions for Amazon Aurora] or [Maintenance actions for Amazon RDS]. // // [Maintenance actions for Amazon RDS]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#maintenance-actions-rds // [Maintenance actions for Amazon Aurora]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#maintenance-actions-aurora // // This member is required. ApplyAction *string // 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. // // This member is required. OptInType *string // 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)]. // // [Constructing an RDS Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing // // This member is required. ResourceIdentifier *string // contains filtered or unexported fields }
type ApplyPendingMaintenanceActionOutput ¶
type ApplyPendingMaintenanceActionOutput struct { // Describes the pending maintenance actions for a resource. ResourcePendingMaintenanceActions *types.ResourcePendingMaintenanceActions // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AuthResolverParameters ¶ added in v1.62.4
type AuthResolverParameters struct { // The name of the operation being invoked. Operation string // The region in which the operation is being invoked. Region string }
AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.
type AuthSchemeResolver ¶ added in v1.62.4
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type AuthorizeDBSecurityGroupIngressInput ¶
type AuthorizeDBSecurityGroupIngressInput struct { // The name of the DB security group to add authorization to. // // This member is required. DBSecurityGroupName *string // The IP range to authorize. CIDRIP *string // 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 // 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 // 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 // contains filtered or unexported fields }
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 *types.DBSecurityGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type BacktrackDBClusterInput ¶
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.] // // 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 // // [ISO8601 Wikipedia page.]: http://en.wikipedia.org/wiki/ISO_8601 // // This member is required. BacktrackTo *time.Time // 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 // // This member is required. DBClusterIdentifier *string // Specifies whether to force the DB cluster to backtrack when binary logging is // enabled. Otherwise, an error occurs when binary logging is enabled. Force *bool // 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 // contains filtered or unexported fields }
type BacktrackDBClusterOutput ¶
type BacktrackDBClusterOutput struct { // Contains the backtrack identifier. BacktrackIdentifier *string // The timestamp of the time at which the backtrack was requested. BacktrackRequestCreationTime *time.Time // The timestamp of the time to which the DB cluster was backtracked. BacktrackTo *time.Time // The timestamp of the time from which the DB cluster was backtracked. BacktrackedFrom *time.Time // Contains a user-supplied DB cluster identifier. This identifier is the unique // key that identifies a DB cluster. DBClusterIdentifier *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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
This data type is used as a response element in the DescribeDBClusterBacktracks action.
type CancelExportTaskInput ¶
type CancelExportTaskInput struct { // The identifier of the snapshot or cluster export task to cancel. // // This member is required. ExportTaskIdentifier *string // contains filtered or unexported fields }
type CancelExportTaskOutput ¶
type CancelExportTaskOutput struct { // The data exported from the snapshot or cluster. // // Valid Values: // // - database - Export all the data from a specified database. // // - database.table table-name - Export a table of the snapshot or cluster. 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 or // cluster. 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 // A unique identifier for the snapshot or cluster export task. This ID isn't an // identifier for the Amazon S3 bucket where the data is exported. ExportTaskIdentifier *string // The reason the export failed, if it failed. FailureCause *string // The name of the IAM role that is used to write to Amazon S3 when exporting a // snapshot or cluster. IamRoleArn *string // The key identifier of the Amazon Web Services KMS key that is used to encrypt // the data 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 export must have // encryption and decryption permissions to use this KMS key. KmsKeyId *string // The progress of the snapshot or cluster export task as a percentage. PercentProgress *int32 // The Amazon S3 bucket where the snapshot or cluster is exported to. S3Bucket *string // The Amazon S3 bucket prefix that is the file name and path of the exported data. S3Prefix *string // The time when the snapshot was created. SnapshotTime *time.Time // The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. SourceArn *string // The type of source for the export. SourceType types.ExportSourceType // The progress status of the export task. The status can be one of the following: // // - CANCELED // // - CANCELING // // - COMPLETE // // - FAILED // // - IN_PROGRESS // // - STARTING Status *string // The time when the snapshot or cluster export task ended. TaskEndTime *time.Time // The time when the snapshot or cluster export task started. TaskStartTime *time.Time // The total amount of data exported, in gigabytes. TotalExtractedDataInGB *int32 // A warning about the snapshot or cluster export task. WarningMessage *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the details of a snapshot or cluster export to Amazon S3.
This data type is used as a response element in the DescribeExportTasks operation.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon Relational Database Service.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AddRoleToDBCluster ¶
func (c *Client) AddRoleToDBCluster(ctx context.Context, params *AddRoleToDBClusterInput, optFns ...func(*Options)) (*AddRoleToDBClusterOutput, error)
Associates an Identity and Access Management (IAM) role with a DB cluster.
func (*Client) AddRoleToDBInstance ¶
func (c *Client) AddRoleToDBInstance(ctx context.Context, params *AddRoleToDBInstanceInput, optFns ...func(*Options)) (*AddRoleToDBInstanceOutput, error)
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.
func (*Client) AddSourceIdentifierToSubscription ¶
func (c *Client) AddSourceIdentifierToSubscription(ctx context.Context, params *AddSourceIdentifierToSubscriptionInput, optFns ...func(*Options)) (*AddSourceIdentifierToSubscriptionOutput, error)
Adds a source identifier to an existing RDS event notification subscription.
func (*Client) AddTagsToResource ¶
func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourceInput, optFns ...func(*Options)) (*AddTagsToResourceOutput, error)
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 your relational database resources, see Tagging Amazon RDS Resources or Tagging Amazon Aurora and Amazon RDS Resources.
func (*Client) ApplyPendingMaintenanceAction ¶
func (c *Client) ApplyPendingMaintenanceAction(ctx context.Context, params *ApplyPendingMaintenanceActionInput, optFns ...func(*Options)) (*ApplyPendingMaintenanceActionOutput, error)
Applies a pending maintenance action to a resource (for example, to a DB instance).
func (*Client) AuthorizeDBSecurityGroupIngress ¶
func (c *Client) AuthorizeDBSecurityGroupIngress(ctx context.Context, params *AuthorizeDBSecurityGroupIngressInput, optFns ...func(*Options)) (*AuthorizeDBSecurityGroupIngressOutput, error)
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.
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 VPCin the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
func (*Client) BacktrackDBCluster ¶
func (c *Client) BacktrackDBCluster(ctx context.Context, params *BacktrackDBClusterInput, optFns ...func(*Options)) (*BacktrackDBClusterOutput, error)
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 in the Amazon Aurora User Guide.
This action applies only to Aurora MySQL DB clusters.
func (*Client) CancelExportTask ¶
func (c *Client) CancelExportTask(ctx context.Context, params *CancelExportTaskInput, optFns ...func(*Options)) (*CancelExportTaskOutput, error)
Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.
func (*Client) CopyDBClusterParameterGroup ¶
func (c *Client) CopyDBClusterParameterGroup(ctx context.Context, params *CopyDBClusterParameterGroupInput, optFns ...func(*Options)) (*CopyDBClusterParameterGroupOutput, error)
Copies the specified DB cluster parameter group.
You can't copy a default DB cluster parameter group. Instead, create a new custom DB cluster parameter group, which copies the default parameters and values for the specified DB cluster parameter group family.
func (*Client) CopyDBClusterSnapshot ¶
func (c *Client) CopyDBClusterSnapshot(ctx context.Context, params *CopyDBClusterSnapshotInput, optFns ...func(*Options)) (*CopyDBClusterSnapshotOutput, error)
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 Snapshotin the Amazon Aurora User Guide.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
func (*Client) CopyDBParameterGroup ¶
func (c *Client) CopyDBParameterGroup(ctx context.Context, params *CopyDBParameterGroupInput, optFns ...func(*Options)) (*CopyDBParameterGroupOutput, error)
Copies the specified DB parameter group.
You can't copy a default DB parameter group. Instead, create a new custom DB parameter group, which copies the default parameters and values for the specified DB parameter group family.
func (*Client) CopyDBSnapshot ¶
func (c *Client) CopyDBSnapshot(ctx context.Context, params *CopyDBSnapshotInput, optFns ...func(*Options)) (*CopyDBSnapshotOutput, error)
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 in the Amazon RDS User Guide.
func (*Client) CopyOptionGroup ¶
func (c *Client) CopyOptionGroup(ctx context.Context, params *CopyOptionGroupInput, optFns ...func(*Options)) (*CopyOptionGroupOutput, error)
Copies the specified option group.
func (*Client) CreateBlueGreenDeployment ¶ added in v1.31.0
func (c *Client) CreateBlueGreenDeployment(ctx context.Context, params *CreateBlueGreenDeploymentInput, optFns ...func(*Options)) (*CreateBlueGreenDeploymentOutput, error)
Creates a blue/green deployment.
A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment, and it stays in sync with the current production environment.
You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
func (*Client) CreateCustomDBEngineVersion ¶ added in v1.11.0
func (c *Client) CreateCustomDBEngineVersion(ctx context.Context, params *CreateCustomDBEngineVersionInput, optFns ...func(*Options)) (*CreateCustomDBEngineVersionOutput, error)
Creates a custom DB engine version (CEV).
func (*Client) CreateDBCluster ¶
func (c *Client) CreateDBCluster(ctx context.Context, params *CreateDBClusterInput, optFns ...func(*Options)) (*CreateDBClusterOutput, error)
Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.
You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
You can also use the ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see Multi-AZ DB cluster deploymentsin the Amazon RDS User Guide.
func (*Client) CreateDBClusterEndpoint ¶
func (c *Client) CreateDBClusterEndpoint(ctx context.Context, params *CreateDBClusterEndpointInput, optFns ...func(*Options)) (*CreateDBClusterEndpointOutput, error)
Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
This action applies only to Aurora DB clusters.
func (*Client) CreateDBClusterParameterGroup ¶
func (c *Client) CreateDBClusterParameterGroup(ctx context.Context, params *CreateDBClusterParameterGroupInput, optFns ...func(*Options)) (*CreateDBClusterParameterGroupOutput, error)
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 consoleor 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? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
func (*Client) CreateDBClusterSnapshot ¶
func (c *Client) CreateDBClusterSnapshot(ctx context.Context, params *CreateDBClusterSnapshotInput, optFns ...func(*Options)) (*CreateDBClusterSnapshotOutput, error)
Creates a snapshot of a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
func (*Client) CreateDBInstance ¶
func (c *Client) CreateDBInstance(ctx context.Context, params *CreateDBInstanceInput, optFns ...func(*Options)) (*CreateDBInstanceOutput, error)
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 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 in the Amazon Aurora User Guide.
func (*Client) CreateDBInstanceReadReplica ¶
func (c *Client) CreateDBInstanceReadReplica(ctx context.Context, params *CreateDBInstanceReadReplicaInput, optFns ...func(*Options)) (*CreateDBInstanceReadReplicaOutput, error)
Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working with read replicasand Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.
Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the CreateDBInstance operation.
All read replica DB instances are created with backups disabled. All other attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified.
Your source DB instance or cluster must have backup retention enabled.
func (*Client) CreateDBParameterGroup ¶
func (c *Client) CreateDBParameterGroup(ctx context.Context, params *CreateDBParameterGroupInput, optFns ...func(*Options)) (*CreateDBParameterGroupOutput, error)
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 consoleor the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
func (*Client) CreateDBProxy ¶
func (c *Client) CreateDBProxy(ctx context.Context, params *CreateDBProxyInput, optFns ...func(*Options)) (*CreateDBProxyOutput, error)
Creates a new DB proxy.
func (*Client) CreateDBProxyEndpoint ¶ added in v1.2.0
func (c *Client) CreateDBProxyEndpoint(ctx context.Context, params *CreateDBProxyEndpointInput, optFns ...func(*Options)) (*CreateDBProxyEndpointOutput, error)
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.
func (*Client) CreateDBSecurityGroup ¶
func (c *Client) CreateDBSecurityGroup(ctx context.Context, params *CreateDBSecurityGroupInput, optFns ...func(*Options)) (*CreateDBSecurityGroupOutput, error)
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 VPCin the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
func (*Client) CreateDBShardGroup ¶ added in v1.68.0
func (c *Client) CreateDBShardGroup(ctx context.Context, params *CreateDBShardGroupInput, optFns ...func(*Options)) (*CreateDBShardGroupOutput, error)
Creates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
func (*Client) CreateDBSnapshot ¶
func (c *Client) CreateDBSnapshot(ctx context.Context, params *CreateDBSnapshotInput, optFns ...func(*Options)) (*CreateDBSnapshotOutput, error)
Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state.
func (*Client) CreateDBSubnetGroup ¶
func (c *Client) CreateDBSubnetGroup(ctx context.Context, params *CreateDBSubnetGroupInput, optFns ...func(*Options)) (*CreateDBSubnetGroupOutput, error)
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.
func (*Client) CreateEventSubscription ¶
func (c *Client) CreateEventSubscription(ctx context.Context, params *CreateEventSubscriptionInput, optFns ...func(*Options)) (*CreateEventSubscriptionOutput, error)
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 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 in the Amazon Aurora User Guide.
func (*Client) CreateGlobalCluster ¶
func (c *Client) CreateGlobalCluster(ctx context.Context, params *CreateGlobalClusterInput, optFns ...func(*Options)) (*CreateGlobalClusterOutput, error)
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 create the primary and secondary DB clusters in the global database. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.
This operation applies only to Aurora DB clusters.
func (*Client) CreateIntegration ¶ added in v1.59.0
func (c *Client) CreateIntegration(ctx context.Context, params *CreateIntegrationInput, optFns ...func(*Options)) (*CreateIntegrationOutput, error)
Creates a zero-ETL integration with Amazon Redshift.
func (*Client) CreateOptionGroup ¶
func (c *Client) CreateOptionGroup(ctx context.Context, params *CreateOptionGroupInput, optFns ...func(*Options)) (*CreateOptionGroupOutput, error)
Creates a new option group. You can create up to 20 option groups.
This command doesn't apply to RDS Custom.
func (*Client) CreateTenantDatabase ¶ added in v1.62.0
func (c *Client) CreateTenantDatabase(ctx context.Context, params *CreateTenantDatabaseInput, optFns ...func(*Options)) (*CreateTenantDatabaseOutput, error)
Creates a tenant database in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle container database (CDB) instances are supported.
func (*Client) DeleteBlueGreenDeployment ¶ added in v1.31.0
func (c *Client) DeleteBlueGreenDeployment(ctx context.Context, params *DeleteBlueGreenDeploymentInput, optFns ...func(*Options)) (*DeleteBlueGreenDeploymentOutput, error)
Deletes a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
func (*Client) DeleteCustomDBEngineVersion ¶ added in v1.11.0
func (c *Client) DeleteCustomDBEngineVersion(ctx context.Context, params *DeleteCustomDBEngineVersionInput, optFns ...func(*Options)) (*DeleteCustomDBEngineVersionOutput, error)
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 in the Amazon RDS User Guide.
func (*Client) DeleteDBCluster ¶
func (c *Client) DeleteDBCluster(ctx context.Context, params *DeleteDBClusterInput, optFns ...func(*Options)) (*DeleteDBClusterOutput, error)
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.
If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas are promoted to standalone instances.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
func (*Client) DeleteDBClusterAutomatedBackup ¶ added in v1.50.0
func (c *Client) DeleteDBClusterAutomatedBackup(ctx context.Context, params *DeleteDBClusterAutomatedBackupInput, optFns ...func(*Options)) (*DeleteDBClusterAutomatedBackupOutput, error)
Deletes automated backups using the DbClusterResourceId value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups.
func (*Client) DeleteDBClusterEndpoint ¶
func (c *Client) DeleteDBClusterEndpoint(ctx context.Context, params *DeleteDBClusterEndpointInput, optFns ...func(*Options)) (*DeleteDBClusterEndpointOutput, error)
Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
func (*Client) DeleteDBClusterParameterGroup ¶
func (c *Client) DeleteDBClusterParameterGroup(ctx context.Context, params *DeleteDBClusterParameterGroupInput, optFns ...func(*Options)) (*DeleteDBClusterParameterGroupOutput, error)
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? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
func (*Client) DeleteDBClusterSnapshot ¶
func (c *Client) DeleteDBClusterSnapshot(ctx context.Context, params *DeleteDBClusterSnapshotInput, optFns ...func(*Options)) (*DeleteDBClusterSnapshotOutput, error)
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? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
func (*Client) DeleteDBInstance ¶
func (c *Client) DeleteDBInstance(ctx context.Context, params *DeleteDBInstanceInput, optFns ...func(*Options)) (*DeleteDBInstanceOutput, error)
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. However, manual DB snapshots of the DB instance aren't deleted.
If you request a final DB snapshot, the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. This operation can't be canceled or reverted after it begins. To monitor the status of this operation, use DescribeDBInstance .
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 use the PromoteReadReplicaDBCluster operation to promote the DB cluster so that it's no longer a read replica. After the promotion completes, use the DeleteDBInstance operation to delete the final instance in the DB cluster.
For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don't terminate or delete these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.
func (*Client) DeleteDBInstanceAutomatedBackup ¶
func (c *Client) DeleteDBInstanceAutomatedBackup(ctx context.Context, params *DeleteDBInstanceAutomatedBackupInput, optFns ...func(*Options)) (*DeleteDBInstanceAutomatedBackupOutput, error)
Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.
func (*Client) DeleteDBParameterGroup ¶
func (c *Client) DeleteDBParameterGroup(ctx context.Context, params *DeleteDBParameterGroupInput, optFns ...func(*Options)) (*DeleteDBParameterGroupOutput, error)
Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
func (*Client) DeleteDBProxy ¶
func (c *Client) DeleteDBProxy(ctx context.Context, params *DeleteDBProxyInput, optFns ...func(*Options)) (*DeleteDBProxyOutput, error)
Deletes an existing DB proxy.
func (*Client) DeleteDBProxyEndpoint ¶ added in v1.2.0
func (c *Client) DeleteDBProxyEndpoint(ctx context.Context, params *DeleteDBProxyEndpointInput, optFns ...func(*Options)) (*DeleteDBProxyEndpointOutput, error)
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.
func (*Client) DeleteDBSecurityGroup ¶
func (c *Client) DeleteDBSecurityGroup(ctx context.Context, params *DeleteDBSecurityGroupInput, optFns ...func(*Options)) (*DeleteDBSecurityGroupOutput, error)
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 VPCin the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
func (*Client) DeleteDBShardGroup ¶ added in v1.68.0
func (c *Client) DeleteDBShardGroup(ctx context.Context, params *DeleteDBShardGroupInput, optFns ...func(*Options)) (*DeleteDBShardGroupOutput, error)
Deletes an Aurora Limitless Database DB shard group.
func (*Client) DeleteDBSnapshot ¶
func (c *Client) DeleteDBSnapshot(ctx context.Context, params *DeleteDBSnapshotInput, optFns ...func(*Options)) (*DeleteDBSnapshotOutput, error)
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.
func (*Client) DeleteDBSubnetGroup ¶
func (c *Client) DeleteDBSubnetGroup(ctx context.Context, params *DeleteDBSubnetGroupInput, optFns ...func(*Options)) (*DeleteDBSubnetGroupOutput, error)
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
func (*Client) DeleteEventSubscription ¶
func (c *Client) DeleteEventSubscription(ctx context.Context, params *DeleteEventSubscriptionInput, optFns ...func(*Options)) (*DeleteEventSubscriptionOutput, error)
Deletes an RDS event notification subscription.
func (*Client) DeleteGlobalCluster ¶
func (c *Client) DeleteGlobalCluster(ctx context.Context, params *DeleteGlobalClusterInput, optFns ...func(*Options)) (*DeleteGlobalClusterOutput, error)
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.
func (*Client) DeleteIntegration ¶ added in v1.59.0
func (c *Client) DeleteIntegration(ctx context.Context, params *DeleteIntegrationInput, optFns ...func(*Options)) (*DeleteIntegrationOutput, error)
Deletes a zero-ETL integration with Amazon Redshift.
func (*Client) DeleteOptionGroup ¶
func (c *Client) DeleteOptionGroup(ctx context.Context, params *DeleteOptionGroupInput, optFns ...func(*Options)) (*DeleteOptionGroupOutput, error)
Deletes an existing option group.
func (*Client) DeleteTenantDatabase ¶ added in v1.62.0
func (c *Client) DeleteTenantDatabase(ctx context.Context, params *DeleteTenantDatabaseInput, optFns ...func(*Options)) (*DeleteTenantDatabaseOutput, error)
Deletes a tenant database from your DB instance. This command only applies to RDS for Oracle container database (CDB) instances.
You can't delete a tenant database when it is the only tenant in the DB instance.
func (*Client) DeregisterDBProxyTargets ¶
func (c *Client) DeregisterDBProxyTargets(ctx context.Context, params *DeregisterDBProxyTargetsInput, optFns ...func(*Options)) (*DeregisterDBProxyTargetsOutput, error)
Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup .
func (*Client) DescribeAccountAttributes ¶
func (c *Client) DescribeAccountAttributes(ctx context.Context, params *DescribeAccountAttributesInput, optFns ...func(*Options)) (*DescribeAccountAttributesOutput, error)
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.
func (*Client) DescribeBlueGreenDeployments ¶ added in v1.31.0
func (c *Client) DescribeBlueGreenDeployments(ctx context.Context, params *DescribeBlueGreenDeploymentsInput, optFns ...func(*Options)) (*DescribeBlueGreenDeploymentsOutput, error)
Describes one or more blue/green deployments.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
func (*Client) DescribeCertificates ¶
func (c *Client) DescribeCertificates(ctx context.Context, params *DescribeCertificatesInput, optFns ...func(*Options)) (*DescribeCertificatesOutput, error)
Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
func (*Client) DescribeDBClusterAutomatedBackups ¶ added in v1.50.0
func (c *Client) DescribeDBClusterAutomatedBackups(ctx context.Context, params *DescribeDBClusterAutomatedBackupsInput, optFns ...func(*Options)) (*DescribeDBClusterAutomatedBackupsOutput, error)
Displays backups for both current and deleted DB clusters. For example, use this operation to find details about automated backups for previously deleted clusters. Current clusters are returned for both the DescribeDBClusterAutomatedBackups and DescribeDBClusters operations.
All parameters are optional.
func (*Client) DescribeDBClusterBacktracks ¶
func (c *Client) DescribeDBClusterBacktracks(ctx context.Context, params *DescribeDBClusterBacktracksInput, optFns ...func(*Options)) (*DescribeDBClusterBacktracksOutput, error)
Returns information about backtracks for a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora MySQL DB clusters.
func (*Client) DescribeDBClusterEndpoints ¶
func (c *Client) DescribeDBClusterEndpoints(ctx context.Context, params *DescribeDBClusterEndpointsInput, optFns ...func(*Options)) (*DescribeDBClusterEndpointsOutput, error)
Returns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
func (*Client) DescribeDBClusterParameterGroups ¶
func (c *Client) DescribeDBClusterParameterGroups(ctx context.Context, params *DescribeDBClusterParameterGroupsInput, optFns ...func(*Options)) (*DescribeDBClusterParameterGroupsOutput, error)
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? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
func (*Client) DescribeDBClusterParameters ¶
func (c *Client) DescribeDBClusterParameters(ctx context.Context, params *DescribeDBClusterParametersInput, optFns ...func(*Options)) (*DescribeDBClusterParametersOutput, error)
Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
func (*Client) DescribeDBClusterSnapshotAttributes ¶
func (c *Client) DescribeDBClusterSnapshotAttributes(ctx context.Context, params *DescribeDBClusterSnapshotAttributesInput, optFns ...func(*Options)) (*DescribeDBClusterSnapshotAttributesOutput, error)
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.
func (*Client) DescribeDBClusterSnapshots ¶
func (c *Client) DescribeDBClusterSnapshots(ctx context.Context, params *DescribeDBClusterSnapshotsInput, optFns ...func(*Options)) (*DescribeDBClusterSnapshotsOutput, error)
Returns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
func (*Client) DescribeDBClusters ¶
func (c *Client) DescribeDBClusters(ctx context.Context, params *DescribeDBClustersInput, optFns ...func(*Options)) (*DescribeDBClustersOutput, error)
Describes existing 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? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
func (*Client) DescribeDBEngineVersions ¶
func (c *Client) DescribeDBEngineVersions(ctx context.Context, params *DescribeDBEngineVersionsInput, optFns ...func(*Options)) (*DescribeDBEngineVersionsOutput, error)
Describes the properties of specific versions of DB engines.
func (*Client) DescribeDBInstanceAutomatedBackups ¶
func (c *Client) DescribeDBInstanceAutomatedBackups(ctx context.Context, params *DescribeDBInstanceAutomatedBackupsInput, optFns ...func(*Options)) (*DescribeDBInstanceAutomatedBackupsOutput, error)
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.
func (*Client) DescribeDBInstances ¶
func (c *Client) DescribeDBInstances(ctx context.Context, params *DescribeDBInstancesInput, optFns ...func(*Options)) (*DescribeDBInstancesOutput, error)
Describes provisioned RDS instances. This API supports pagination.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
func (*Client) DescribeDBLogFiles ¶
func (c *Client) DescribeDBLogFiles(ctx context.Context, params *DescribeDBLogFilesInput, optFns ...func(*Options)) (*DescribeDBLogFilesOutput, error)
Returns a list of DB log files for the DB instance.
This command doesn't apply to RDS Custom.
func (*Client) DescribeDBParameterGroups ¶
func (c *Client) DescribeDBParameterGroups(ctx context.Context, params *DescribeDBParameterGroupsInput, optFns ...func(*Options)) (*DescribeDBParameterGroupsOutput, error)
Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
func (*Client) DescribeDBParameters ¶
func (c *Client) DescribeDBParameters(ctx context.Context, params *DescribeDBParametersInput, optFns ...func(*Options)) (*DescribeDBParametersOutput, error)
Returns the detailed parameter list for a particular DB parameter group.
func (*Client) DescribeDBProxies ¶
func (c *Client) DescribeDBProxies(ctx context.Context, params *DescribeDBProxiesInput, optFns ...func(*Options)) (*DescribeDBProxiesOutput, error)
Returns information about DB proxies.
func (*Client) DescribeDBProxyEndpoints ¶ added in v1.2.0
func (c *Client) DescribeDBProxyEndpoints(ctx context.Context, params *DescribeDBProxyEndpointsInput, optFns ...func(*Options)) (*DescribeDBProxyEndpointsOutput, error)
Returns information about DB proxy endpoints.
func (*Client) DescribeDBProxyTargetGroups ¶
func (c *Client) DescribeDBProxyTargetGroups(ctx context.Context, params *DescribeDBProxyTargetGroupsInput, optFns ...func(*Options)) (*DescribeDBProxyTargetGroupsOutput, error)
Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.
func (*Client) DescribeDBProxyTargets ¶
func (c *Client) DescribeDBProxyTargets(ctx context.Context, params *DescribeDBProxyTargetsInput, optFns ...func(*Options)) (*DescribeDBProxyTargetsOutput, error)
Returns information about DBProxyTarget objects. This API supports pagination.
func (*Client) DescribeDBRecommendations ¶ added in v1.65.0
func (c *Client) DescribeDBRecommendations(ctx context.Context, params *DescribeDBRecommendationsInput, optFns ...func(*Options)) (*DescribeDBRecommendationsOutput, error)
Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.
func (*Client) DescribeDBSecurityGroups ¶
func (c *Client) DescribeDBSecurityGroups(ctx context.Context, params *DescribeDBSecurityGroupsInput, optFns ...func(*Options)) (*DescribeDBSecurityGroupsOutput, error)
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 VPCin the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
func (*Client) DescribeDBShardGroups ¶ added in v1.68.0
func (c *Client) DescribeDBShardGroups(ctx context.Context, params *DescribeDBShardGroupsInput, optFns ...func(*Options)) (*DescribeDBShardGroupsOutput, error)
Describes existing Aurora Limitless Database DB shard groups.
func (*Client) DescribeDBSnapshotAttributes ¶
func (c *Client) DescribeDBSnapshotAttributes(ctx context.Context, params *DescribeDBSnapshotAttributesInput, optFns ...func(*Options)) (*DescribeDBSnapshotAttributesOutput, error)
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.
func (*Client) DescribeDBSnapshotTenantDatabases ¶ added in v1.62.0
func (c *Client) DescribeDBSnapshotTenantDatabases(ctx context.Context, params *DescribeDBSnapshotTenantDatabasesInput, optFns ...func(*Options)) (*DescribeDBSnapshotTenantDatabasesOutput, error)
Describes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi-tenant configuration.
You can use this command to inspect the tenant databases within a snapshot before restoring it. You can't directly interact with the tenant databases in a DB snapshot. If you restore a snapshot that was taken from DB instance using the multi-tenant configuration, you restore all its tenant databases.
func (*Client) DescribeDBSnapshots ¶
func (c *Client) DescribeDBSnapshots(ctx context.Context, params *DescribeDBSnapshotsInput, optFns ...func(*Options)) (*DescribeDBSnapshotsOutput, error)
Returns information about DB snapshots. This API action supports pagination.
func (*Client) DescribeDBSubnetGroups ¶
func (c *Client) DescribeDBSubnetGroups(ctx context.Context, params *DescribeDBSubnetGroupsInput, optFns ...func(*Options)) (*DescribeDBSubnetGroupsOutput, error)
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.
func (*Client) DescribeEngineDefaultClusterParameters ¶
func (c *Client) DescribeEngineDefaultClusterParameters(ctx context.Context, params *DescribeEngineDefaultClusterParametersInput, optFns ...func(*Options)) (*DescribeEngineDefaultClusterParametersOutput, error)
Returns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
func (*Client) DescribeEngineDefaultParameters ¶
func (c *Client) DescribeEngineDefaultParameters(ctx context.Context, params *DescribeEngineDefaultParametersInput, optFns ...func(*Options)) (*DescribeEngineDefaultParametersOutput, error)
Returns the default engine and system parameter information for the specified database engine.
func (*Client) DescribeEventCategories ¶
func (c *Client) DescribeEventCategories(ctx context.Context, params *DescribeEventCategoriesInput, optFns ...func(*Options)) (*DescribeEventCategoriesOutput, error)
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 Guideor the Amazon Aurora User Guide.
func (*Client) DescribeEventSubscriptions ¶
func (c *Client) DescribeEventSubscriptions(ctx context.Context, params *DescribeEventSubscriptionsInput, optFns ...func(*Options)) (*DescribeEventSubscriptionsOutput, error)
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.
func (*Client) DescribeEvents ¶
func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput, optFns ...func(*Options)) (*DescribeEventsOutput, error)
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 in the Amazon RDS User Guide and Monitoring Amazon Aurora eventsin the Amazon Aurora User Guide.
By default, RDS returns events that were generated in the past hour.
func (*Client) DescribeExportTasks ¶
func (c *Client) DescribeExportTasks(ctx context.Context, params *DescribeExportTasksInput, optFns ...func(*Options)) (*DescribeExportTasksOutput, error)
Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination.
func (*Client) DescribeGlobalClusters ¶
func (c *Client) DescribeGlobalClusters(ctx context.Context, params *DescribeGlobalClustersInput, optFns ...func(*Options)) (*DescribeGlobalClustersOutput, error)
Returns information about Aurora global database clusters. This API supports pagination.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
func (*Client) DescribeIntegrations ¶ added in v1.59.0
func (c *Client) DescribeIntegrations(ctx context.Context, params *DescribeIntegrationsInput, optFns ...func(*Options)) (*DescribeIntegrationsOutput, error)
Describe one or more zero-ETL integrations with Amazon Redshift.
func (*Client) DescribeOptionGroupOptions ¶
func (c *Client) DescribeOptionGroupOptions(ctx context.Context, params *DescribeOptionGroupOptionsInput, optFns ...func(*Options)) (*DescribeOptionGroupOptionsOutput, error)
Describes all available options for the specified engine.
func (*Client) DescribeOptionGroups ¶
func (c *Client) DescribeOptionGroups(ctx context.Context, params *DescribeOptionGroupsInput, optFns ...func(*Options)) (*DescribeOptionGroupsOutput, error)
Describes the available option groups.
func (*Client) DescribeOrderableDBInstanceOptions ¶
func (c *Client) DescribeOrderableDBInstanceOptions(ctx context.Context, params *DescribeOrderableDBInstanceOptionsInput, optFns ...func(*Options)) (*DescribeOrderableDBInstanceOptionsOutput, error)
Describes the orderable DB instance options for a specified DB engine.
func (*Client) DescribePendingMaintenanceActions ¶
func (c *Client) DescribePendingMaintenanceActions(ctx context.Context, params *DescribePendingMaintenanceActionsInput, optFns ...func(*Options)) (*DescribePendingMaintenanceActionsOutput, error)
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
This API follows an eventual consistency model. This means that the result of the DescribePendingMaintenanceActions command might not be immediately visible to all subsequent RDS commands. Keep this in mind when you use DescribePendingMaintenanceActions immediately after using a previous API command such as ApplyPendingMaintenanceActions .
func (*Client) DescribeReservedDBInstances ¶
func (c *Client) DescribeReservedDBInstances(ctx context.Context, params *DescribeReservedDBInstancesInput, optFns ...func(*Options)) (*DescribeReservedDBInstancesOutput, error)
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
func (*Client) DescribeReservedDBInstancesOfferings ¶
func (c *Client) DescribeReservedDBInstancesOfferings(ctx context.Context, params *DescribeReservedDBInstancesOfferingsInput, optFns ...func(*Options)) (*DescribeReservedDBInstancesOfferingsOutput, error)
Lists available reserved DB instance offerings.
func (*Client) DescribeSourceRegions ¶
func (c *Client) DescribeSourceRegions(ctx context.Context, params *DescribeSourceRegionsInput, optFns ...func(*Options)) (*DescribeSourceRegionsOutput, error)
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.
Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination.
To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation DescribeRegions . For more information, see DescribeRegions in the Amazon EC2 API Reference.
func (*Client) DescribeTenantDatabases ¶ added in v1.62.0
func (c *Client) DescribeTenantDatabases(ctx context.Context, params *DescribeTenantDatabasesInput, optFns ...func(*Options)) (*DescribeTenantDatabasesOutput, error)
Describes the tenant databases in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle CDB instances are supported.
func (*Client) DescribeValidDBInstanceModifications ¶
func (c *Client) DescribeValidDBInstanceModifications(ctx context.Context, params *DescribeValidDBInstanceModificationsInput, optFns ...func(*Options)) (*DescribeValidDBInstanceModificationsOutput, error)
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.
func (*Client) DisableHttpEndpoint ¶ added in v1.66.0
func (c *Client) DisableHttpEndpoint(ctx context.Context, params *DisableHttpEndpointInput, optFns ...func(*Options)) (*DisableHttpEndpointOutput, error)
Disables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables RDS Data API.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This operation applies only to Aurora Serverless v2 and provisioned DB clusters. To disable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint parameter of the ModifyDBCluster operation.
func (*Client) DownloadDBLogFilePortion ¶
func (c *Client) DownloadDBLogFilePortion(ctx context.Context, params *DownloadDBLogFilePortionInput, optFns ...func(*Options)) (*DownloadDBLogFilePortionOutput, error)
Downloads all or a portion of the specified log file, up to 1 MB in size.
This command doesn't apply to RDS Custom.
func (*Client) EnableHttpEndpoint ¶ added in v1.66.0
func (c *Client) EnableHttpEndpoint(ctx context.Context, params *EnableHttpEndpointInput, optFns ...func(*Options)) (*EnableHttpEndpointOutput, error)
Enables the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
When enabled, this endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This operation applies only to Aurora Serverless v2 and provisioned DB clusters. To enable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint parameter of the ModifyDBCluster operation.
func (*Client) FailoverDBCluster ¶
func (c *Client) FailoverDBCluster(ctx context.Context, params *FailoverDBClusterInput, optFns ...func(*Options)) (*FailoverDBClusterOutput, error)
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, after RDS terminates the primary DB instance, the internal monitoring system detects that the primary DB instance is unhealthy and promotes a readable standby (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). Failover times are typically less than 35 seconds.
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? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
func (*Client) FailoverGlobalCluster ¶ added in v1.2.0
func (c *Client) FailoverGlobalCluster(ctx context.Context, params *FailoverGlobalClusterInput, optFns ...func(*Options)) (*FailoverGlobalClusterOutput, error)
Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database. Switchover operations were previously called "managed planned failovers."
Although this operation can be used either to fail over or to switch over a global database cluster, its intended use is for global database failover. To switch over a global database cluster, we recommend that you use the SwitchoverGlobalClusteroperation instead.
How you use this operation depends on whether you are failing over or switching over your global database cluster:
Failing over - Specify the AllowDataLoss parameter and don't specify the Switchover parameter.
Switching over - Specify the Switchover parameter or omit it, but don't specify the AllowDataLoss parameter.
About failing over and switching over ¶
While failing over and switching over a global database cluster both change the primary DB cluster, you use these operations for different reasons:
- Failing over - Use this operation to respond to an unplanned event, such as a Regional disaster in the primary Region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.
For more information about failing over an Amazon Aurora global database, see Performing managed failovers for Aurora global databases
in the Amazon Aurora User Guide. - Switching over - Use this operation on a healthy global database cluster for planned events, such as Regional rotation or to fail back to the original primary DB cluster after a failover operation. With this operation, there is no data loss.
For more information about switching over an Amazon Aurora global database, see Performing switchovers for Aurora global databases
in the Amazon Aurora User Guide.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS Resourcesin the Amazon Aurora User Guide.
func (*Client) ModifyActivityStream ¶ added in v1.23.0
func (c *Client) ModifyActivityStream(ctx context.Context, params *ModifyActivityStreamInput, optFns ...func(*Options)) (*ModifyActivityStreamOutput, error)
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 streamin the Amazon RDS User Guide.
This operation is supported for RDS for Oracle and Microsoft SQL Server.
func (*Client) ModifyCertificates ¶
func (c *Client) ModifyCertificates(ctx context.Context, params *ModifyCertificatesInput, optFns ...func(*Options)) (*ModifyCertificatesOutput, error)
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 Certificatein the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificatein the Amazon Aurora User Guide.
func (*Client) ModifyCurrentDBClusterCapacity ¶
func (c *Client) ModifyCurrentDBClusterCapacity(ctx context.Context, params *ModifyCurrentDBClusterCapacityInput, optFns ...func(*Options)) (*ModifyCurrentDBClusterCapacityOutput, error)
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 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 v1in the Amazon Aurora User Guide.
This operation only applies to Aurora Serverless v1 DB clusters.
func (*Client) ModifyCustomDBEngineVersion ¶ added in v1.11.0
func (c *Client) ModifyCustomDBEngineVersion(ctx context.Context, params *ModifyCustomDBEngineVersionInput, optFns ...func(*Options)) (*ModifyCustomDBEngineVersionOutput, error)
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 in the Amazon RDS User Guide.
func (*Client) ModifyDBCluster ¶
func (c *Client) ModifyDBCluster(ctx context.Context, params *ModifyDBClusterInput, optFns ...func(*Options)) (*ModifyDBClusterOutput, error)
Modifies the settings of 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? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
func (*Client) ModifyDBClusterEndpoint ¶
func (c *Client) ModifyDBClusterEndpoint(ctx context.Context, params *ModifyDBClusterEndpointInput, optFns ...func(*Options)) (*ModifyDBClusterEndpointOutput, error)
Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
This operation only applies to Aurora DB clusters.
func (*Client) ModifyDBClusterParameterGroup ¶
func (c *Client) ModifyDBClusterParameterGroup(ctx context.Context, params *ModifyDBClusterParameterGroupInput, optFns ...func(*Options)) (*ModifyDBClusterParameterGroupOutput, error)
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 operation 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 consoleor 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? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
func (*Client) ModifyDBClusterSnapshotAttribute ¶
func (c *Client) ModifyDBClusterSnapshotAttribute(ctx context.Context, params *ModifyDBClusterSnapshotAttributeInput, optFns ...func(*Options)) (*ModifyDBClusterSnapshotAttributeOutput, error)
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 DescribeDBClusterSnapshotAttributesAPI operation. The accounts are returned as values for the restore attribute.
func (*Client) ModifyDBInstance ¶
func (c *Client) ModifyDBInstance(ctx context.Context, params *ModifyDBInstanceInput, optFns ...func(*Options)) (*ModifyDBInstanceOutput, error)
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 .
func (*Client) ModifyDBParameterGroup ¶
func (c *Client) ModifyDBParameterGroup(ctx context.Context, params *ModifyDBParameterGroupInput, optFns ...func(*Options)) (*ModifyDBParameterGroupOutput, error)
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 operation 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 consoleor the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
func (*Client) ModifyDBProxy ¶
func (c *Client) ModifyDBProxy(ctx context.Context, params *ModifyDBProxyInput, optFns ...func(*Options)) (*ModifyDBProxyOutput, error)
Changes the settings for an existing DB proxy.
func (*Client) ModifyDBProxyEndpoint ¶ added in v1.2.0
func (c *Client) ModifyDBProxyEndpoint(ctx context.Context, params *ModifyDBProxyEndpointInput, optFns ...func(*Options)) (*ModifyDBProxyEndpointOutput, error)
Changes the settings for an existing DB proxy endpoint.
func (*Client) ModifyDBProxyTargetGroup ¶
func (c *Client) ModifyDBProxyTargetGroup(ctx context.Context, params *ModifyDBProxyTargetGroupInput, optFns ...func(*Options)) (*ModifyDBProxyTargetGroupOutput, error)
Modifies the properties of a DBProxyTargetGroup .
func (*Client) ModifyDBRecommendation ¶ added in v1.65.0
func (c *Client) ModifyDBRecommendation(ctx context.Context, params *ModifyDBRecommendationInput, optFns ...func(*Options)) (*ModifyDBRecommendationOutput, error)
Updates the recommendation status and recommended action status for the specified recommendation.
func (*Client) ModifyDBShardGroup ¶ added in v1.68.0
func (c *Client) ModifyDBShardGroup(ctx context.Context, params *ModifyDBShardGroupInput, optFns ...func(*Options)) (*ModifyDBShardGroupOutput, error)
Modifies the settings of an Aurora Limitless Database DB shard group. You can change one or more settings by specifying these parameters and the new values in the request.
func (*Client) ModifyDBSnapshot ¶
func (c *Client) ModifyDBSnapshot(ctx context.Context, params *ModifyDBSnapshotInput, optFns ...func(*Options)) (*ModifyDBSnapshotOutput, error)
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 operation doesn't apply to RDS Custom or RDS for Db2.
func (*Client) ModifyDBSnapshotAttribute ¶
func (c *Client) ModifyDBSnapshotAttribute(ctx context.Context, params *ModifyDBSnapshotAttributeInput, optFns ...func(*Options)) (*ModifyDBSnapshotAttributeOutput, error)
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.
func (*Client) ModifyDBSubnetGroup ¶
func (c *Client) ModifyDBSubnetGroup(ctx context.Context, params *ModifyDBSubnetGroupInput, optFns ...func(*Options)) (*ModifyDBSubnetGroupOutput, error)
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.
func (*Client) ModifyEventSubscription ¶
func (c *Client) ModifyEventSubscription(ctx context.Context, params *ModifyEventSubscriptionInput, optFns ...func(*Options)) (*ModifyEventSubscriptionOutput, error)
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 Eventsin the Amazon RDS User Guide or by using the DescribeEventCategories operation.
func (*Client) ModifyGlobalCluster ¶
func (c *Client) ModifyGlobalCluster(ctx context.Context, params *ModifyGlobalClusterInput, optFns ...func(*Options)) (*ModifyGlobalClusterOutput, error)
Modifies a setting for an Amazon Aurora global database 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?in the Amazon Aurora User Guide.
This operation only applies to Aurora global database clusters.
func (*Client) ModifyIntegration ¶ added in v1.76.0
func (c *Client) ModifyIntegration(ctx context.Context, params *ModifyIntegrationInput, optFns ...func(*Options)) (*ModifyIntegrationOutput, error)
Modifies a zero-ETL integration with Amazon Redshift.
Currently, you can only modify integrations that have Aurora MySQL source DB clusters. Integrations with Aurora PostgreSQL and RDS sources currently don't support modifying the integration.
func (*Client) ModifyOptionGroup ¶
func (c *Client) ModifyOptionGroup(ctx context.Context, params *ModifyOptionGroupInput, optFns ...func(*Options)) (*ModifyOptionGroupOutput, error)
Modifies an existing option group.
func (*Client) ModifyTenantDatabase ¶ added in v1.62.0
func (c *Client) ModifyTenantDatabase(ctx context.Context, params *ModifyTenantDatabaseInput, optFns ...func(*Options)) (*ModifyTenantDatabaseOutput, error)
Modifies an existing tenant database in a DB instance. You can change the tenant database name or the master user password. This operation is supported only for RDS for Oracle CDB instances using the multi-tenant configuration.
func (*Client) Options ¶ added in v1.64.0
Options returns a copy of the client configuration.
Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.
func (*Client) PromoteReadReplica ¶
func (c *Client) PromoteReadReplica(ctx context.Context, params *PromoteReadReplicaInput, optFns ...func(*Options)) (*PromoteReadReplicaOutput, error)
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.
func (*Client) PromoteReadReplicaDBCluster ¶
func (c *Client) PromoteReadReplicaDBCluster(ctx context.Context, params *PromoteReadReplicaDBClusterInput, optFns ...func(*Options)) (*PromoteReadReplicaDBClusterOutput, error)
Promotes a read replica DB cluster to a standalone DB cluster.
func (*Client) PurchaseReservedDBInstancesOffering ¶
func (c *Client) PurchaseReservedDBInstancesOffering(ctx context.Context, params *PurchaseReservedDBInstancesOfferingInput, optFns ...func(*Options)) (*PurchaseReservedDBInstancesOfferingOutput, error)
Purchases a reserved DB instance offering.
func (*Client) RebootDBCluster ¶ added in v1.13.0
func (c *Client) RebootDBCluster(ctx context.Context, params *RebootDBClusterInput, optFns ...func(*Options)) (*RebootDBClusterOutput, error)
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 DB cluster deployments in the Amazon RDS User Guide.
func (*Client) RebootDBInstance ¶
func (c *Client) RebootDBInstance(ctx context.Context, params *RebootDBInstanceInput, optFns ...func(*Options)) (*RebootDBInstanceOutput, error)
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 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.
func (*Client) RebootDBShardGroup ¶ added in v1.68.0
func (c *Client) RebootDBShardGroup(ctx context.Context, params *RebootDBShardGroupInput, optFns ...func(*Options)) (*RebootDBShardGroupOutput, error)
You might need to reboot your DB shard group, usually for maintenance reasons. For example, if you make certain modifications, reboot the DB shard group for the changes to take effect.
This operation applies only to Aurora Limitless Database DBb shard groups.
func (*Client) RegisterDBProxyTargets ¶
func (c *Client) RegisterDBProxyTargets(ctx context.Context, params *RegisterDBProxyTargetsInput, optFns ...func(*Options)) (*RegisterDBProxyTargetsOutput, error)
Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup .
func (*Client) RemoveFromGlobalCluster ¶
func (c *Client) RemoveFromGlobalCluster(ctx context.Context, params *RemoveFromGlobalClusterInput, optFns ...func(*Options)) (*RemoveFromGlobalClusterOutput, error)
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 operation only applies to Aurora DB clusters.
func (*Client) RemoveRoleFromDBCluster ¶
func (c *Client) RemoveRoleFromDBCluster(ctx context.Context, params *RemoveRoleFromDBClusterInput, optFns ...func(*Options)) (*RemoveRoleFromDBClusterOutput, error)
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? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
func (*Client) RemoveRoleFromDBInstance ¶
func (c *Client) RemoveRoleFromDBInstance(ctx context.Context, params *RemoveRoleFromDBInstanceInput, optFns ...func(*Options)) (*RemoveRoleFromDBInstanceOutput, error)
Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.
func (*Client) RemoveSourceIdentifierFromSubscription ¶
func (c *Client) RemoveSourceIdentifierFromSubscription(ctx context.Context, params *RemoveSourceIdentifierFromSubscriptionInput, optFns ...func(*Options)) (*RemoveSourceIdentifierFromSubscriptionOutput, error)
Removes a source identifier from an existing RDS event notification subscription.
func (*Client) RemoveTagsFromResource ¶
func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsFromResourceInput, optFns ...func(*Options)) (*RemoveTagsFromResourceOutput, error)
Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS Resourcesin the Amazon Aurora User Guide.
func (*Client) ResetDBClusterParameterGroup ¶
func (c *Client) ResetDBClusterParameterGroup(ctx context.Context, params *ResetDBClusterParameterGroupInput, optFns ...func(*Options)) (*ResetDBClusterParameterGroupOutput, error)
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? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
func (*Client) ResetDBParameterGroup ¶
func (c *Client) ResetDBParameterGroup(ctx context.Context, params *ResetDBParameterGroupInput, optFns ...func(*Options)) (*ResetDBParameterGroupOutput, error)
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.
func (*Client) RestoreDBClusterFromS3 ¶
func (c *Client) RestoreDBClusterFromS3(ctx context.Context, params *RestoreDBClusterFromS3Input, optFns ...func(*Options)) (*RestoreDBClusterFromS3Output, error)
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 Bucketin the Amazon Aurora User Guide.
This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation 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 operation has completed and the DB cluster is available.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters. The source DB engine must be MySQL.
func (*Client) RestoreDBClusterFromSnapshot ¶
func (c *Client) RestoreDBClusterFromSnapshot(ctx context.Context, params *RestoreDBClusterFromSnapshotInput, optFns ...func(*Options)) (*RestoreDBClusterFromSnapshotOutput, error)
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 operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation 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 operation has completed and the DB cluster is available.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
func (*Client) RestoreDBClusterToPointInTime ¶
func (c *Client) RestoreDBClusterToPointInTime(ctx context.Context, params *RestoreDBClusterToPointInTimeInput, optFns ...func(*Options)) (*RestoreDBClusterToPointInTimeOutput, error)
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 operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation 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 operation has completed and the DB cluster is available.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
func (*Client) RestoreDBInstanceFromDBSnapshot ¶
func (c *Client) RestoreDBInstanceFromDBSnapshot(ctx context.Context, params *RestoreDBInstanceFromDBSnapshotInput, optFns ...func(*Options)) (*RestoreDBInstanceFromDBSnapshotOutput, error)
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 operation. 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 operation. 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.
To restore from a DB snapshot with an unsupported engine version, you must first upgrade the engine version of the snapshot. For more information about upgrading a RDS for MySQL DB snapshot engine version, see Upgrading a MySQL DB snapshot engine version. For more information about upgrading a RDS for PostgreSQL DB snapshot engine version, Upgrading a PostgreSQL DB snapshot engine version.
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot .
func (*Client) RestoreDBInstanceFromS3 ¶
func (c *Client) RestoreDBInstanceFromS3(ctx context.Context, params *RestoreDBInstanceFromS3Input, optFns ...func(*Options)) (*RestoreDBInstanceFromS3Output, error)
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 Instancein the Amazon RDS User Guide.
This operation doesn't apply to RDS Custom.
func (*Client) RestoreDBInstanceToPointInTime ¶
func (c *Client) RestoreDBInstanceToPointInTime(ctx context.Context, params *RestoreDBInstanceToPointInTimeInput, optFns ...func(*Options)) (*RestoreDBInstanceToPointInTimeOutput, error)
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 operation doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime .
func (*Client) RevokeDBSecurityGroupIngress ¶
func (c *Client) RevokeDBSecurityGroupIngress(ctx context.Context, params *RevokeDBSecurityGroupIngressInput, optFns ...func(*Options)) (*RevokeDBSecurityGroupIngressOutput, error)
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 VPCin the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
func (*Client) StartActivityStream ¶
func (c *Client) StartActivityStream(ctx context.Context, params *StartActivityStreamInput, optFns ...func(*Options)) (*StartActivityStreamOutput, error)
Starts a database activity stream to monitor activity on the database. For more information, see Monitoring Amazon Aurora with Database Activity Streamsin the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.
func (*Client) StartDBCluster ¶
func (c *Client) StartDBCluster(ctx context.Context, params *StartDBClusterInput, optFns ...func(*Options)) (*StartDBClusterOutput, error)
Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster operation.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters.
func (*Client) StartDBInstance ¶
func (c *Client) StartDBInstance(ctx context.Context, params *StartDBInstanceInput, optFns ...func(*Options)) (*StartDBInstanceOutput, error)
Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance operation.
For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped 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.
func (*Client) StartDBInstanceAutomatedBackupsReplication ¶ added in v0.31.0
func (c *Client) StartDBInstanceAutomatedBackupsReplication(ctx context.Context, params *StartDBInstanceAutomatedBackupsReplicationInput, optFns ...func(*Options)) (*StartDBInstanceAutomatedBackupsReplicationOutput, error)
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 in the Amazon RDS User Guide.
func (*Client) StartExportTask ¶
func (c *Client) StartExportTask(ctx context.Context, params *StartExportTaskInput, optFns ...func(*Options)) (*StartExportTaskOutput, error)
Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 bucket.
You can't export snapshot data from Db2 or RDS Custom DB instances.
For more information on exporting DB snapshot data, see Exporting DB snapshot data to Amazon S3 in the Amazon RDS User Guide or Exporting DB cluster snapshot data to Amazon S3in the Amazon Aurora User Guide.
For more information on exporting DB cluster data, see Exporting DB cluster data to Amazon S3 in the Amazon Aurora User Guide.
func (*Client) StopActivityStream ¶
func (c *Client) StopActivityStream(ctx context.Context, params *StopActivityStreamInput, optFns ...func(*Options)) (*StopActivityStreamOutput, error)
Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream operation.
For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.
func (*Client) StopDBCluster ¶
func (c *Client) StopDBCluster(ctx context.Context, params *StopDBClusterInput, optFns ...func(*Options)) (*StopDBClusterOutput, error)
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 in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters.
func (*Client) StopDBInstance ¶
func (c *Client) StopDBInstance(ctx context.Context, params *StopDBInstanceInput, optFns ...func(*Options)) (*StopDBInstanceOutput, error)
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 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.
func (*Client) StopDBInstanceAutomatedBackupsReplication ¶ added in v0.31.0
func (c *Client) StopDBInstanceAutomatedBackupsReplication(ctx context.Context, params *StopDBInstanceAutomatedBackupsReplicationInput, optFns ...func(*Options)) (*StopDBInstanceAutomatedBackupsReplicationOutput, error)
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 in the Amazon RDS User Guide.
func (*Client) SwitchoverBlueGreenDeployment ¶ added in v1.31.0
func (c *Client) SwitchoverBlueGreenDeployment(ctx context.Context, params *SwitchoverBlueGreenDeploymentInput, optFns ...func(*Options)) (*SwitchoverBlueGreenDeploymentOutput, error)
Switches over a blue/green deployment.
Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
func (*Client) SwitchoverGlobalCluster ¶ added in v1.51.0
func (c *Client) SwitchoverGlobalCluster(ctx context.Context, params *SwitchoverGlobalClusterInput, optFns ...func(*Options)) (*SwitchoverGlobalClusterOutput, error)
Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called "managed planned failovers."
Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary (read-only) cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the Aurora global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. For more information about switching over an Aurora global database, see Performing switchovers for Amazon Aurora global databasesin the Amazon Aurora User Guide.
This operation is intended for controlled environments, for operations such as "regional rotation" or to fall back to the original primary after a global database failover.
func (*Client) SwitchoverReadReplica ¶ added in v1.25.0
func (c *Client) SwitchoverReadReplica(ctx context.Context, params *SwitchoverReadReplicaInput, optFns ...func(*Options)) (*SwitchoverReadReplicaOutput, error)
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.
type CopyDBClusterParameterGroupInput ¶
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]in the Amazon // Aurora User Guide. // // Constraints: // // - Must specify a valid DB cluster parameter group. // // [Constructing an ARN for Amazon RDS]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing // // This member is required. SourceDBClusterParameterGroupIdentifier *string // A description for the copied DB cluster parameter group. // // This member is required. TargetDBClusterParameterGroupDescription *string // 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 // // This member is required. TargetDBClusterParameterGroupIdentifier *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // contains filtered or unexported fields }
type CopyDBClusterParameterGroupOutput ¶
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 *types.DBClusterParameterGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CopyDBClusterSnapshotInput ¶
type CopyDBClusterSnapshotInput struct { // 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] // in the Amazon Aurora User Guide. // // Example: my-cluster-snapshot1 // // [Copying Snapshots Across Amazon Web Services Regions]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html#USER_CopySnapshot.AcrossRegions // // This member is required. SourceDBClusterSnapshotIdentifier *string // 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 // // This member is required. TargetDBClusterSnapshotIdentifier *string // Specifies 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 // 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 // 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)] and [Signature Version 4 Signing Process]. // // 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. // // [Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html // [Signature Version 4 Signing Process]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html PreSignedUrl *string // The AWS region the resource is in. The presigned URL will be created with this // region, if the PresignURL member is empty set. SourceRegion *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // contains filtered or unexported fields }
type CopyDBClusterSnapshotOutput ¶
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 *types.DBClusterSnapshot // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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]in the Amazon RDS User Guide. // // Constraints: // // - Must specify a valid DB parameter group. // // [Constructing an ARN for Amazon RDS]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing // // This member is required. SourceDBParameterGroupIdentifier *string // A description for the copied DB parameter group. // // This member is required. TargetDBParameterGroupDescription *string // 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 // // This member is required. TargetDBParameterGroupIdentifier *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // contains filtered or unexported fields }
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 *types.DBParameterGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CopyDBSnapshotInput ¶
type CopyDBSnapshotInput struct { // 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 // // This member is required. SourceDBSnapshotIdentifier *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 // // This member is required. TargetDBSnapshotIdentifier *string // Specifies whether to copy the DB option group associated with the source DB // snapshot to the target Amazon Web Services account and associate with the target // DB snapshot. The associated option group can be copied only with cross-account // snapshot copy calls. CopyOptionGroup *bool // Specifies whether to copy all tags from the source DB snapshot to the target DB // snapshot. By default, tags aren't copied. CopyTags *bool // 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 // 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]in the Amazon RDS User Guide. // // [Option group considerations]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options OptionGroupName *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)] and [Signature Version 4 Signing Process]. // // 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. // // [Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html // [Signature Version 4 Signing Process]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html PreSignedUrl *string // The AWS region the resource is in. The presigned URL will be created with this // region, if the PresignURL member is empty set. SourceRegion *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // The external custom Availability Zone (CAZ) identifier for the target CAZ. // // Example: rds-caz-aiqhTgQv . TargetCustomAvailabilityZone *string // contains filtered or unexported fields }
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 *types.DBSnapshot // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CopyOptionGroupInput ¶
type CopyOptionGroupInput struct { // The identifier for the source option group. // // Constraints: // // - Must specify a valid option group. // // This member is required. SourceOptionGroupIdentifier *string // The description for the copied option group. // // This member is required. TargetOptionGroupDescription *string // 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 // // This member is required. TargetOptionGroupIdentifier *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // contains filtered or unexported fields }
type CopyOptionGroupOutput ¶
type CopyOptionGroupOutput struct { // OptionGroup *types.OptionGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateBlueGreenDeploymentInput ¶ added in v1.31.0
type CreateBlueGreenDeploymentInput struct { // The name of the blue/green deployment. // // Constraints: // // - Can't be the same as an existing blue/green deployment name in the same // account and Amazon Web Services Region. // // This member is required. BlueGreenDeploymentName *string // The Amazon Resource Name (ARN) of the source production database. // // Specify the database that you want to clone. The blue/green deployment creates // this database in the green environment. You can make updates to the database in // the green environment, such as an engine version upgrade. When you are ready, // you can switch the database in the green environment to be the production // database. // // This member is required. Source *string // Tags to assign to the blue/green deployment. Tags []types.Tag // The amount of storage in gibibytes (GiB) to allocate for the green DB instance. // You can choose to increase or decrease the allocated storage on the green DB // instance. // // This setting doesn't apply to Amazon Aurora blue/green deployments. TargetAllocatedStorage *int32 // The DB cluster parameter group associated with the Aurora DB cluster in the // green environment. // // To test parameter changes, specify a DB cluster parameter group that is // different from the one associated with the source DB cluster. TargetDBClusterParameterGroupName *string // Specify the DB instance class for the databases in the green environment. // // This parameter only applies to RDS DB instances, because DB instances within an // Aurora DB cluster can have multiple different instance classes. If you're // creating a blue/green deployment from an Aurora DB cluster, don't specify this // parameter. After the green environment is created, you can individually modify // the instance classes of the DB instances within the green DB cluster. TargetDBInstanceClass *string // The DB parameter group associated with the DB instance in the green environment. // // To test parameter changes, specify a DB parameter group that is different from // the one associated with the source DB instance. TargetDBParameterGroupName *string // The engine version of the database in the green environment. // // Specify the engine version to upgrade to in the green environment. TargetEngineVersion *string // The amount of Provisioned IOPS (input/output operations per second) to allocate // for the green DB instance. For information about valid IOPS values, see [Amazon RDS DB instance storage]in the // Amazon RDS User Guide. // // This setting doesn't apply to Amazon Aurora blue/green deployments. // // [Amazon RDS DB instance storage]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html TargetIops *int32 // The storage throughput value for the green DB instance. // // This setting applies only to the gp3 storage type. // // This setting doesn't apply to Amazon Aurora blue/green deployments. TargetStorageThroughput *int32 // The storage type to associate with the green DB instance. // // Valid Values: gp2 | gp3 | io1 | io2 // // This setting doesn't apply to Amazon Aurora blue/green deployments. TargetStorageType *string // Whether to upgrade the storage file system configuration on the green database. // This option migrates the green DB instance from the older 32-bit file system to // the preferred configuration. For more information, see [Upgrading the storage file system for a DB instance]. // // [Upgrading the storage file system for a DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.UpgradeFileSystem UpgradeTargetStorageConfig *bool // contains filtered or unexported fields }
type CreateBlueGreenDeploymentOutput ¶ added in v1.31.0
type CreateBlueGreenDeploymentOutput struct { // Details about a blue/green deployment. // // For more information, see [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon RDS User Guide and [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon // Aurora User Guide. // // [Using Amazon RDS Blue/Green Deployments for database updates]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html BlueGreenDeployment *types.BlueGreenDeployment // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateCustomDBEngineVersionInput ¶ added in v1.11.0
type CreateCustomDBEngineVersionInput struct { // The database engine. RDS Custom for Oracle supports the following values: // // - custom-oracle-ee // // - custom-oracle-ee-cdb // // - custom-oracle-se2 // // - custom-oracle-se2-cdb // // This member is required. Engine *string // The name of your CEV. The name format is 19.customized_string. For example, a // valid CEV 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. // // This member is required. EngineVersion *string // 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 *string // 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 // An optional description of your CEV. Description *string // The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI // ID is required to create a CEV. For RDS Custom for Oracle, the default is the // most recent AMI available, but you can specify an AMI ID that was used in a // different Oracle CEV. Find the AMIs used by your CEVs by calling the [DescribeDBEngineVersions]operation. // // [DescribeDBEngineVersions]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBEngineVersions.html ImageId *string // 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] // 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. // // [Creating a symmetric encryption KMS key]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk KMSKeyId *string // 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] in the Amazon RDS User Guide. // // [Creating the CEV manifest]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest Manifest *string // The ARN of a CEV to use as a source for creating a new CEV. You can specify a // different Amazon Machine Imagine (AMI) by using either Source or // UseAwsProvidedLatestImage . You can't specify a different JSON manifest when you // specify SourceCustomDbEngineVersionIdentifier . SourceCustomDbEngineVersionIdentifier *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // Specifies whether to use the latest service-provided Amazon Machine Image (AMI) // for the CEV. If you specify UseAwsProvidedLatestImage , you can't also specify // ImageId . UseAwsProvidedLatestImage *bool // contains filtered or unexported fields }
type CreateCustomDBEngineVersionOutput ¶ added in v1.11.0
type CreateCustomDBEngineVersionOutput struct { // The creation time of the DB engine version. CreateTime *time.Time // JSON string that lists the installation files and parameters that RDS Custom // uses to create a custom engine version (CEV). RDS Custom applies the patches in // the order in which they're listed in the manifest. You can set the Oracle home, // Oracle base, and UNIX/Linux user and group using the installation parameters. // For more information, see [JSON fields in the CEV manifest]in the Amazon RDS User Guide. // // [JSON fields in the CEV manifest]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields CustomDBEngineVersionManifest *string // The description of the database engine. DBEngineDescription *string // A value that indicates the source media provider of the AMI based on the usage // operation. Applicable for RDS Custom for SQL Server. DBEngineMediaType *string // The ARN of the custom engine version. DBEngineVersionArn *string // The description of the database engine version. DBEngineVersionDescription *string // The name of the DB parameter group family for the database engine. DBParameterGroupFamily *string // The name of the Amazon S3 bucket that contains your database installation files. DatabaseInstallationFilesS3BucketName *string // The Amazon S3 directory that contains the database installation files. If not // specified, then no prefix is assumed. DatabaseInstallationFilesS3Prefix *string // The default character set for new instances of this engine version, if the // CharacterSetName parameter of the CreateDBInstance API isn't specified. DefaultCharacterSet *types.CharacterSet // The name of the database engine. Engine *string // The version number of the database engine. EngineVersion *string // The types of logs that the database engine has available for export to // CloudWatch Logs. ExportableLogTypes []string // The EC2 image Image *types.CustomDBEngineVersionAMI // 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 // The major engine version of the CEV. MajorEngineVersion *string // Specifies any Aurora Serverless v2 properties or limits that differ between // Aurora engine versions. You can test the values of this attribute when deciding // which Aurora version to use in a new or upgraded DB cluster. You can also // retrieve the version of an existing DB cluster and check whether that version // supports certain Aurora Serverless v2 features before you attempt to use those // features. ServerlessV2FeaturesSupport *types.ServerlessV2FeaturesSupport // The status of the DB engine version, either available or deprecated . Status *string // A list of the supported CA certificate identifiers. // // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon // Aurora User Guide. // // [Using SSL/TLS to encrypt a connection to a DB cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html // [Using SSL/TLS to encrypt a connection to a DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html SupportedCACertificateIdentifiers []string // A list of the character sets supported by this engine for the CharacterSetName // parameter of the CreateDBInstance operation. SupportedCharacterSets []types.CharacterSet // A list of the supported DB engine modes. SupportedEngineModes []string // 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-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 // A list of the character sets supported by the Oracle DB engine for the // NcharCharacterSetName parameter of the CreateDBInstance operation. SupportedNcharCharacterSets []types.CharacterSet // A list of the time zones supported by this engine for the Timezone parameter of // the CreateDBInstance action. SupportedTimezones []types.Timezone // Indicates whether the engine version supports Babelfish for Aurora PostgreSQL. SupportsBabelfish *bool // Indicates whether the engine version supports rotating the server certificate // without rebooting the DB instance. SupportsCertificateRotationWithoutRestart *bool // Indicates whether you can use Aurora global databases with a specific DB engine // version. SupportsGlobalDatabases *bool // Indicates whether the DB engine version supports zero-ETL integrations with // Amazon Redshift. SupportsIntegrations *bool // Indicates whether the DB engine version supports Aurora Limitless Database. SupportsLimitlessDatabase *bool // Indicates whether the DB engine version supports forwarding write operations // from reader DB instances to the writer DB instance in the DB cluster. By // default, write operations aren't allowed on reader DB instances. // // Valid for: Aurora DB clusters only SupportsLocalWriteForwarding *bool // Indicates whether the engine version supports exporting the log types specified // by ExportableLogTypes to CloudWatch Logs. SupportsLogExportsToCloudwatchLogs *bool // Indicates whether you can use Aurora parallel query with a specific DB engine // version. SupportsParallelQuery *bool // Indicates whether the database engine version supports read replicas. SupportsReadReplica *bool // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html TagList []types.Tag // A list of engine versions that this database engine version can be upgraded to. ValidUpgradeTarget []types.UpgradeTarget // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
This data type is used as a response element in the action DescribeDBEngineVersions .
type CreateDBClusterEndpointInput ¶
type CreateDBClusterEndpointInput struct { // The identifier to use for the new endpoint. This parameter is stored as a // lowercase string. // // This member is required. DBClusterEndpointIdentifier *string // The DB cluster identifier of the DB cluster associated with the endpoint. This // parameter is stored as a lowercase string. // // This member is required. DBClusterIdentifier *string // The type of the endpoint, one of: READER , WRITER , ANY . // // This member is required. EndpointType *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. This // parameter is relevant only if the list of static members is empty. ExcludedMembers []string // List of DB instance identifiers that are part of the custom endpoint group. StaticMembers []string // The tags to be assigned to the Amazon RDS resource. Tags []types.Tag // contains filtered or unexported fields }
type CreateDBClusterEndpointOutput ¶
type CreateDBClusterEndpointOutput struct { // The type associated with a custom endpoint. One of: READER , WRITER , ANY . CustomEndpointType *string // The Amazon Resource Name (ARN) for the endpoint. DBClusterEndpointArn *string // The identifier associated with the endpoint. This parameter is stored as a // lowercase string. DBClusterEndpointIdentifier *string // A unique system-generated identifier for an endpoint. It remains the same for // the whole life of the endpoint. DBClusterEndpointResourceIdentifier *string // The DB cluster identifier of the DB cluster associated with the endpoint. This // parameter is stored as a lowercase string. DBClusterIdentifier *string // The DNS address of the endpoint. Endpoint *string // The type of the endpoint. One of: READER , WRITER , CUSTOM . EndpointType *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 // List of DB instance identifiers that are part of the custom endpoint group. StaticMembers []string // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // 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 .
type CreateDBClusterInput ¶
type CreateDBClusterInput struct { // The identifier for this DB cluster. This parameter is stored as a lowercase // string. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Constraints: // // - Must contain from 1 to 63 (for Aurora DB clusters) or 1 to 52 (for Multi-AZ // DB clusters) letters, numbers, or hyphens. // // - First character must be a letter. // // - Can't end with a hyphen or contain two consecutive hyphens. // // Example: my-cluster1 // // This member is required. DBClusterIdentifier *string // The database engine to use for this DB cluster. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Valid Values: // // - aurora-mysql // // - aurora-postgresql // // - mysql // // - postgres // // - neptune - For information about using Amazon Neptune, see the [Amazon Neptune User Guide]. // // [Amazon Neptune User Guide]: https://docs.aws.amazon.com/neptune/latest/userguide/intro.html // // This member is required. Engine *string // The amount of storage in gibibytes (GiB) to allocate to each DB instance in the // Multi-AZ DB cluster. // // Valid for Cluster Type: Multi-AZ DB clusters only // // This setting is required to create a Multi-AZ DB cluster. AllocatedStorage *int32 // Specifies 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 Cluster Type: Aurora DB clusters and Multi-AZ DB cluster AutoMinorVersionUpgrade *bool // A list of Availability Zones (AZs) where you specifically want to create DB // instances in the DB cluster. // // For information on AZs, see [Availability Zones] in the Amazon Aurora User Guide. // // Valid for Cluster Type: Aurora DB clusters only // // Constraints: // // - Can't specify more than three AZs. // // [Availability Zones]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Concepts.RegionsAndAvailabilityZones.AvailabilityZones AvailabilityZones []string // The target backtrack window, in seconds. To disable backtracking, set this // value to 0 . // // Valid for Cluster Type: Aurora MySQL DB clusters only // // Default: 0 // // Constraints: // // - If specified, this value must be set to a number from 0 to 259,200 (72 // hours). BacktrackWindow *int64 // The number of days for which automated backups are retained. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Default: 1 // // Constraints: // // - Must be a value from 1 to 35. BackupRetentionPeriod *int32 // The CA certificate identifier to use for the DB cluster's server certificate. // // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide. // // Valid for Cluster Type: Multi-AZ DB clusters // // [Using SSL/TLS to encrypt a connection to a DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html CACertificateIdentifier *string // The name of the character set ( CharacterSet ) to associate the DB cluster with. // // Valid for Cluster Type: Aurora DB clusters only CharacterSetName *string // Specifies the scalability mode of the Aurora DB cluster. When set to limitless , // the cluster operates as an Aurora Limitless Database. When set to standard (the // default), the cluster uses normal DB instance creation. // // Valid for: Aurora DB clusters only // // You can't modify this setting after you create the DB cluster. ClusterScalabilityType types.ClusterScalabilityType // Specifies whether to copy all tags from the DB cluster to snapshots of the DB // cluster. The default is not to copy them. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters CopyTagsToSnapshot *bool // The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, // for example db.m6gd.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] // in the Amazon RDS User Guide. // // This setting is required to create a Multi-AZ DB cluster. // // Valid for Cluster Type: Multi-AZ DB clusters only // // [DB instance class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html DBClusterInstanceClass *string // The name of the DB cluster parameter group to associate with this DB cluster. // If you don't specify a value, then the default DB cluster parameter group for // the specified DB engine and version is used. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Constraints: // // - If supplied, must match the name of an existing DB cluster parameter group. DBClusterParameterGroupName *string // A DB subnet group to associate with this DB cluster. // // This setting is required to create a Multi-AZ DB cluster. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Constraints: // // - Must match the name of an existing DB subnet group. // // Example: mydbsubnetgroup DBSubnetGroupName *string // Reserved for future use. DBSystemId *string // The mode of Database Insights to enable for the DB cluster. // // If you set this value to advanced , you must also set the // PerformanceInsightsEnabled parameter to true and the // PerformanceInsightsRetentionPeriod parameter to 465. // // Valid for Cluster Type: Aurora DB clusters only DatabaseInsightsMode types.DatabaseInsightsMode // The name for your database of up to 64 alphanumeric characters. A database // named postgres is always created. If this parameter is specified, an additional // database with this name is created. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters DatabaseName *string // Specifies 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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters DeletionProtection *bool // 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] in the Amazon Aurora User Guide. // // Valid for Cluster Type: Aurora DB clusters only // // [Kerberos authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html Domain *string // The name of the IAM role to use when making API calls to the Directory Service. // // Valid for Cluster Type: Aurora DB clusters only DomainIAMRoleName *string // The list of log types that need to be enabled for exporting to CloudWatch Logs. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // The following values are valid for each DB engine: // // - Aurora MySQL - audit | error | general | slowquery // // - Aurora PostgreSQL - postgresql // // - RDS for MySQL - error | general | slowquery // // - RDS for PostgreSQL - postgresql | upgrade // // For more information about exporting CloudWatch Logs for Amazon RDS, see [Publishing Database Logs to Amazon CloudWatch Logs] in // the Amazon RDS User Guide. // // For more information about exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs] in // the Amazon Aurora User Guide. // // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch EnableCloudwatchLogsExports []string // Specifies whether to enable this DB cluster to forward write operations to the // primary cluster of a global cluster (Aurora global database). 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 a global cluster API // operation, but it does nothing until then. // // Valid for Cluster Type: Aurora DB clusters only EnableGlobalWriteForwarding *bool // Specifies whether to enable the HTTP endpoint for the DB cluster. By default, // the HTTP endpoint isn't enabled. // // When enabled, the HTTP endpoint provides a connectionless web service API (RDS // Data API) for running SQL queries on the DB cluster. You can also query your // database from inside the RDS console with the RDS query editor. // // RDS Data API is supported with the following DB clusters: // // - Aurora PostgreSQL Serverless v2 and provisioned // // - Aurora PostgreSQL and Aurora MySQL Serverless v1 // // For more information, see [Using RDS Data API] in the Amazon Aurora User Guide. // // Valid for Cluster Type: Aurora DB clusters only // // [Using RDS Data API]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html EnableHttpEndpoint *bool // Specifies 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] in the Amazon Aurora User Guide or [IAM database authentication for MariaDB, MySQL, and PostgreSQL] in the Amazon // RDS User Guide. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // [IAM Database Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html // [IAM database authentication for MariaDB, MySQL, and PostgreSQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool // Specifies whether to enable Aurora Limitless Database. You must enable Aurora // Limitless Database to create a DB shard group. // // Valid for: Aurora DB clusters only // // This setting is no longer used. Instead use the ClusterScalabilityType setting. EnableLimitlessDatabase *bool // Specifies whether read replicas can forward write operations to the writer DB // instance in the DB cluster. By default, write operations aren't allowed on // reader DB instances. // // Valid for: Aurora DB clusters only EnableLocalWriteForwarding *bool // Specifies whether to turn on Performance Insights for the DB cluster. // // For more information, see [Using Amazon Performance Insights] in the Amazon RDS User Guide. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // [Using Amazon Performance Insights]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html EnablePerformanceInsights *bool // The life cycle type for this DB cluster. // // By default, this value is set to open-source-rds-extended-support , which // enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard // support, you can avoid charges for Extended Support by setting the value to // open-source-rds-extended-support-disabled . In this case, creating the DB // cluster will fail if the DB major version is past its end of standard support // date. // // You can use this setting to enroll your DB cluster into Amazon RDS Extended // Support. With RDS Extended Support, you can run the selected major engine // version on your DB cluster past the end of standard support for that engine // version. For more information, see the following sections: // // - Amazon Aurora - [Using Amazon RDS Extended Support]in the Amazon Aurora User Guide // // - Amazon RDS - [Using Amazon RDS Extended Support]in the Amazon RDS User Guide // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Valid Values: open-source-rds-extended-support | // open-source-rds-extended-support-disabled // // Default: open-source-rds-extended-support // // [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html EngineLifecycleSupport *string // The DB engine mode of the DB cluster, either provisioned or serverless . // // The serverless engine mode only applies for Aurora Serverless v1 DB clusters. // Aurora Serverless v2 DB clusters use the provisioned engine mode. // // For information about limitations and requirements for Serverless DB clusters, // see the following sections in the Amazon Aurora User Guide: // // [Limitations of Aurora Serverless v1] // // [Requirements for Aurora Serverless v2] // // Valid for Cluster Type: Aurora DB clusters only // // [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 EngineMode *string // The version number of the database engine to use. // // To list all of the available engine versions for Aurora MySQL version 2 // (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following // command: // // aws rds describe-db-engine-versions --engine aurora-mysql --query // "DBEngineVersions[].EngineVersion" // // You can supply either 5.7 or 8.0 to use the default engine version for Aurora // MySQL version 2 or version 3, respectively. // // 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" // // For information about a specific engine, see the following topics: // // - Aurora MySQL - see [Database engine updates for Amazon Aurora MySQL]in the Amazon Aurora User Guide. // // - Aurora PostgreSQL - see [Amazon Aurora PostgreSQL releases and engine versions]in the Amazon Aurora User Guide. // // - RDS for MySQL - see [Amazon RDS for MySQL]in the Amazon RDS User Guide. // // - RDS for PostgreSQL - see [Amazon RDS for PostgreSQL]in the Amazon RDS User Guide. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // [Database engine updates for Amazon Aurora MySQL]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html // [Amazon RDS for PostgreSQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts // [Amazon RDS for MySQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt // [Amazon Aurora PostgreSQL releases and engine versions]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html EngineVersion *string // The global cluster ID of an Aurora cluster that becomes the primary cluster in // the new global database cluster. // // Valid for Cluster Type: Aurora DB clusters only GlobalClusterIdentifier *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 [Provisioned IOPS storage] in the Amazon RDS User Guide. // // This setting is required to create a Multi-AZ DB cluster. // // Valid for Cluster Type: Multi-AZ DB clusters only // // Constraints: // // - Must be a multiple between .5 and 50 of the storage amount for the DB // cluster. // // [Provisioned IOPS storage]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS Iops *int32 // 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 uses the KMS key used to encrypt the source. Otherwise, Amazon RDS uses your // default KMS key. // // - If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier // isn't specified, 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. // // If you create a read replica of an encrypted DB cluster in another Amazon Web // Services Region, make sure to 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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters KmsKeyId *string // Specifies whether to manage the master user password with Amazon Web Services // Secrets Manager. // // For more information, see [Password management with Amazon Web Services Secrets Manager] in the Amazon RDS User Guide and [Password management with Amazon Web Services Secrets Manager] in the Amazon // Aurora User Guide. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Constraints: // // - Can't manage the master user password with Amazon Web Services Secrets // Manager if MasterUserPassword is specified. // // [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html ManageMasterUserPassword *bool // The password for the master database user. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Constraints: // // - Must contain from 8 to 41 characters. // // - Can contain any printable ASCII character except "/", """, or "@". // // - Can't be specified if ManageMasterUserPassword is turned on. MasterUserPassword *string // The Amazon Web Services KMS key identifier to encrypt a secret that is // automatically generated and managed in Amazon Web Services Secrets Manager. // // This setting is valid only if the master user password is managed by RDS in // Amazon Web Services Secrets Manager for the 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 you don't specify MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS // key is used to encrypt the secret. If the secret is in a different Amazon Web // Services account, then you can't use the aws/secretsmanager KMS key to encrypt // the secret, and you must use a customer managed 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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters MasterUserSecretKmsKeyId *string // The name of the master user for the DB cluster. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // 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 // 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 . // // If MonitoringRoleArn is specified, also set MonitoringInterval to a value other // than 0 . // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 // // Default: 0 MonitoringInterval *int32 // 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]in the Amazon RDS User Guide. // // If MonitoringInterval is set to a value other than 0 , supply a // MonitoringRoleArn value. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // [Setting up and enabling Enhanced Monitoring]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling MonitoringRoleArn *string // The network type of the DB cluster. // // 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] in the Amazon Aurora User Guide. // // Valid for Cluster Type: Aurora DB clusters only // // Valid Values: IPV4 | DUAL // // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *string // The option group to associate the DB cluster with. // // DB clusters are associated with a default option group that can't be modified. OptionGroupName *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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters PerformanceInsightsKMSKeyId *string // The number of days to retain Performance Insights data. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Valid Values: // // - 7 // // - month * 31, where month is a number of months from 1-23. Examples: 93 (3 // months * 31), 341 (11 months * 31), 589 (19 months * 31) // // - 731 // // Default: 7 days // // If you specify a retention period that isn't valid, such as 94 , Amazon RDS // issues an error. PerformanceInsightsRetentionPeriod *int32 // The port number on which the instances in the DB cluster accept connections. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Valid Values: 1150-65535 // // Default: // // - RDS for MySQL and Aurora MySQL - 3306 // // - RDS for PostgreSQL and Aurora PostgreSQL - 5432 Port *int32 // 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)] and [Signature Version 4 Signing Process]. // // 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 Cluster Type: Aurora DB clusters only // // [Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html // [Signature Version 4 Signing Process]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html PreSignedUrl *string // The daily time range during which automated backups are created if automated // backups are enabled using the BackupRetentionPeriod parameter. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // 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]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. // // [Backup window]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow PreferredBackupWindow *string // The weekly time range during which system maintenance can occur. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // 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]in the Amazon Aurora User Guide. // // Constraints: // // - Must be in the format ddd:hh24:mi-ddd:hh24:mi . // // - Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun . // // - Must be in Universal Coordinated Time (UTC). // // - Must be at least 30 minutes. // // [Adjusting the Preferred DB Cluster Maintenance Window]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora PreferredMaintenanceWindow *string // Specifies whether the DB cluster is publicly accessible. // // When the DB cluster is publicly accessible and you connect from outside of the // DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint // resolves to the public IP address. When you connect from within the same VPC as // the DB cluster, the endpoint resolves to the private IP address. 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. // // Valid for Cluster Type: Multi-AZ DB clusters only // // 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. PubliclyAccessible *bool // Reserved for future use. RdsCustomClusterConfiguration *types.RdsCustomClusterConfiguration // 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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters ReplicationSourceIdentifier *string // For DB clusters in serverless DB engine mode, the scaling properties of the DB // cluster. // // Valid for Cluster Type: Aurora DB clusters only ScalingConfiguration *types.ScalingConfiguration // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. // // For more information, see [Using Amazon Aurora Serverless v2] in the Amazon Aurora User Guide. // // [Using Amazon Aurora Serverless v2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration // The AWS region the resource is in. The presigned URL will be created with this // region, if the PresignURL member is empty set. SourceRegion *string // Specifies whether the DB cluster is encrypted. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters StorageEncrypted *bool // The storage type to associate with the DB cluster. // // For information on storage types for Aurora DB clusters, see [Storage configurations for Amazon Aurora DB clusters]. For information // on storage types for Multi-AZ DB clusters, see [Settings for creating Multi-AZ DB clusters]. // // This setting is required to create a Multi-AZ DB cluster. // // When specified for a Multi-AZ DB cluster, a value for the Iops parameter is // required. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Valid Values: // // - Aurora DB clusters - aurora | aurora-iopt1 // // - Multi-AZ DB clusters - io1 | io2 | gp3 // // Default: // // - Aurora DB clusters - aurora // // - Multi-AZ DB clusters - io1 // // When you create an Aurora DB cluster with the storage type set to aurora-iopt1 , // the storage type is returned in the response. The storage type isn't returned // when you set it to aurora . // // [Storage configurations for Amazon Aurora DB clusters]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type // [Settings for creating Multi-AZ DB clusters]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings StorageType *string // Tags to assign to the DB cluster. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Tags []types.Tag // A list of EC2 VPC security groups to associate with this DB cluster. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters VpcSecurityGroupIds []string // contains filtered or unexported fields }
type CreateDBClusterOutput ¶
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?] in the Amazon Aurora // User Guide. // // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User // Guide. // // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateDBClusterParameterGroupInput ¶
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. // // This member is required. DBClusterParameterGroupName *string // 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: aurora-mysql5.7 , aurora-mysql8.0 // // Aurora PostgreSQL // // Example: aurora-postgresql14 // // RDS for MySQL // // Example: mysql8.0 // // RDS for PostgreSQL // // Example: postgres13 // // 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 // // 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-mysql // // - aurora-postgresql // // - mysql // // - postgres // // This member is required. DBParameterGroupFamily *string // The description for the DB cluster parameter group. // // This member is required. Description *string // Tags to assign to the DB cluster parameter group. Tags []types.Tag // contains filtered or unexported fields }
type CreateDBClusterParameterGroupOutput ¶
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 *types.DBClusterParameterGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateDBClusterSnapshotInput ¶
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 // // This member is required. DBClusterIdentifier *string // 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 // // This member is required. DBClusterSnapshotIdentifier *string // The tags to be assigned to the DB cluster snapshot. Tags []types.Tag // contains filtered or unexported fields }
type CreateDBClusterSnapshotOutput ¶
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 *types.DBClusterSnapshot // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateDBInstanceInput ¶
type CreateDBInstanceInput struct { // 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]in the Amazon RDS User Guide or [Aurora DB instance classes] in the // Amazon Aurora User Guide. // // [Aurora DB instance classes]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html // [DB instance classes]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html // // This member is required. DBInstanceClass *string // The identifier for this DB instance. 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 // // This member is required. DBInstanceIdentifier *string // The database engine to use for this DB instance. // // Not every database engine is available in every Amazon Web Services Region. // // Valid Values: // // - aurora-mysql (for Aurora MySQL DB instances) // // - aurora-postgresql (for Aurora PostgreSQL DB instances) // // - custom-oracle-ee (for RDS Custom for Oracle DB instances) // // - custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances) // // - custom-oracle-se2 (for RDS Custom for Oracle DB instances) // // - custom-oracle-se2-cdb (for RDS Custom for Oracle DB instances) // // - custom-sqlserver-ee (for RDS Custom for SQL Server DB instances) // // - custom-sqlserver-se (for RDS Custom for SQL Server DB instances) // // - custom-sqlserver-web (for RDS Custom for SQL Server DB instances) // // - custom-sqlserver-dev (for RDS Custom for SQL Server DB instances) // // - db2-ae // // - db2-se // // - mariadb // // - mysql // // - oracle-ee // // - oracle-ee-cdb // // - oracle-se2 // // - oracle-se2-cdb // // - postgres // // - sqlserver-ee // // - sqlserver-se // // - sqlserver-ex // // - sqlserver-web // // This member is required. Engine *string // The amount of storage in gibibytes (GiB) to allocate for the DB instance. // // This setting doesn't apply to Amazon Aurora DB instances. 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, gp3): Must be an integer from 40 to // 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server. // // - Provisioned IOPS storage (io1, io2): Must be an integer from 40 to 65536 // for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server. // // RDS for Db2 Constraints to the amount of storage for each storage type are the // following: // // - General Purpose (SSD) storage (gp3): Must be an integer from 20 to 65536. // // - Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536. // // RDS for MariaDB Constraints to the amount of storage for each storage type are // the following: // // - General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to // 65536. // // - Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536. // // - Magnetic storage (standard): Must be an integer from 5 to 3072. // // RDS for MySQL Constraints to the amount of storage for each storage type are // the following: // // - General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to // 65536. // // - Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536. // // - Magnetic storage (standard): Must be an integer from 5 to 3072. // // RDS for Oracle Constraints to the amount of storage for each storage type are // the following: // // - General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to // 65536. // // - Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536. // // - Magnetic storage (standard): Must be an integer from 10 to 3072. // // RDS for PostgreSQL Constraints to the amount of storage for each storage type // are the following: // // - General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to // 65536. // // - Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536. // // - Magnetic storage (standard): Must be an integer from 5 to 3072. // // RDS for SQL Server Constraints to the amount of storage for each storage type // are the following: // // - General Purpose (SSD) storage (gp2, gp3): // // - 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, io2): // // - 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 *int32 // Specifies 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 // 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]. // // For 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. // // Constraints: // // - 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. // // Example: us-east-1d // // [Regions and Availability Zones]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html AvailabilityZone *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. // // This setting doesn't apply to Amazon Aurora DB instances. 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 *int32 // The location for storing automated backups and manual snapshots. // // Valid Values: // // - outposts (Amazon Web Services Outposts) // // - region (Amazon Web Services Region) // // Default: region // // For more information, see [Working with Amazon RDS on Amazon Web Services Outposts] in the Amazon RDS User Guide. // // [Working with Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html BackupTarget *string // The CA certificate identifier to use for the DB instance's server certificate. // // This setting doesn't apply to RDS Custom DB instances. // // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon // Aurora User Guide. // // [Using SSL/TLS to encrypt a connection to a DB cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html // [Using SSL/TLS to encrypt a connection to a DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html CACertificateIdentifier *string // For supported engines, the character set ( CharacterSet ) to associate the DB // instance with. // // This setting doesn't apply to the following DB instances: // // - Amazon Aurora - The character set is managed by the DB cluster. For more // information, see CreateDBCluster . // // - RDS Custom - However, if you need to change the character set, you can // change it on the database itself. CharacterSetName *string // Specifies whether to copy tags from the DB instance to snapshots of the DB // instance. By default, tags are not copied. // // This setting doesn't apply to Amazon Aurora DB instances. 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 // The instance profile associated with the underlying Amazon EC2 instance of an // RDS Custom DB instance. // // This setting is required for RDS Custom. // // Constraints: // // - 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] in the Amazon RDS // User Guide. // // [Configure IAM and your VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc CustomIamInstanceProfile *string // The identifier of the DB cluster that this DB instance will belong to. // // This setting doesn't apply to RDS Custom DB instances. DBClusterIdentifier *string // The meaning of this parameter differs according to the database engine you use. // // 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: // // - Must contain 1 to 64 alphanumeric characters. // // - Must begin with a letter. Subsequent characters can be letters, // underscores, or digits (0-9). // // - 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. A database named // postgres is always created. If this parameter is specified, an additional // database with this name is created. // // Constraints: // // - It must contain 1 to 63 alphanumeric characters. // // - Must begin with a letter. Subsequent characters can be letters, // underscores, or digits (0 to 9). // // - Can't be a word reserved by the database engine. // // 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 for // non-CDBs and RDSCDB for CDBs. // // Default: ORCL // // Constraints: // // - Must contain 1 to 8 alphanumeric characters. // // - Must contain a letter. // // - Can't be a word reserved by the database engine. // // Amazon RDS Custom for SQL Server Not applicable. Must be null. // // RDS for Db2 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. In // some cases, we recommend that you don't add a database name. For more // information, see [Additional considerations]in the Amazon RDS User Guide. // // 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. // // RDS for 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. // // RDS for 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. // // RDS for Oracle The Oracle System ID (SID) of the created DB instance. If you // don't specify a value, the default value is ORCL . You can't specify the string // null , or any other reserved word, for DBName . // // Default: ORCL // // Constraints: // // - Can't be longer than 8 characters. // // RDS for PostgreSQL The name of the database to create when the DB instance is // created. A database named postgres is always created. If this parameter is // specified, an additional database with this name is created. // // 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. // // RDS for SQL Server Not applicable. Must be null. // // [Additional considerations]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-db-instance-prereqs.html#db2-prereqs-additional-considerations DBName *string // The name of the DB parameter group to associate with this DB instance. If you // don't specify a value, then Amazon RDS uses the default DB parameter group for // the specified DB engine and version. // // This setting doesn't apply to RDS Custom DB instances. // // Constraints: // // - Must be 1 to 255 letters, numbers, or hyphens. // // - The first character must be a letter. // // - Can't end with a hyphen or contain two consecutive hyphens. DBParameterGroupName *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 // A DB subnet group to associate with this DB instance. // // Constraints: // // - Must match the name of an existing DB subnet group. // // Example: mydbsubnetgroup DBSubnetGroupName *string // The Oracle system identifier (SID), which is the name of the Oracle database // instance that manages your database files. In this context, the term "Oracle // database instance" refers exclusively to the system global area (SGA) and Oracle // background processes. If you don't specify a SID, the value defaults to RDSCDB . // The Oracle SID is also the name of your CDB. DBSystemId *string // The mode of Database Insights to enable for the DB instance. // // This setting only applies to Amazon Aurora DB instances. // // Currently, this value is inherited from the DB cluster and can't be changed. DatabaseInsightsMode types.DatabaseInsightsMode // Indicates whether the DB instance has a dedicated log volume (DLV) enabled. DedicatedLogVolume *bool // Specifies 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]. // // This setting doesn't apply to Amazon Aurora DB instances. 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. // // [Deleting a DB Instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html DeletionProtection *bool // The Active Directory directory ID to create the DB instance in. Currently, you // can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB // instances in an Active Directory Domain. // // For more information, see [Kerberos Authentication] in the Amazon RDS User Guide. // // This setting doesn't apply to the following DB instances: // // - Amazon Aurora (The domain is managed by the DB cluster.) // // - RDS Custom // // [Kerberos Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html Domain *string // The ARN for the Secrets Manager secret with the credentials for the user // joining the domain. // // Example: // arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456 DomainAuthSecretArn *string // The IPv4 DNS IP addresses of your primary and secondary Active Directory domain // controllers. // // Constraints: // // - Two IP addresses must be provided. If there isn't a secondary domain // controller, use the IP address of the primary domain controller for both entries // in the list. // // Example: 123.124.125.126,234.235.236.237 DomainDnsIps []string // The fully qualified domain name (FQDN) of an Active Directory domain. // // Constraints: // // - Can't be longer than 64 characters. // // Example: mymanagedADtest.mymanagedAD.mydomain DomainFqdn *string // The name of the IAM role to use when making API calls to the Directory Service. // // This setting doesn't apply to the following DB instances: // // - Amazon Aurora (The domain is managed by the DB cluster.) // // - RDS Custom DomainIAMRoleName *string // The Active Directory organizational unit for your DB instance to join. // // Constraints: // // - Must be in the distinguished name format. // // - Can't be longer than 64 characters. // // Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain DomainOu *string // The list of log types to enable for exporting to CloudWatch Logs. For more // information, see [Publishing Database Logs to Amazon CloudWatch Logs]in the Amazon RDS User Guide. // // This setting doesn't apply to the following DB instances: // // - Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.) // // - RDS Custom // // The following values are valid for each DB engine: // // - RDS for Db2 - diag.log | notify.log // // - RDS for MariaDB - audit | error | general | slowquery // // - RDS for Microsoft SQL Server - agent | error // // - RDS for MySQL - audit | error | general | slowquery // // - RDS for Oracle - alert | audit | listener | trace | oemagent // // - RDS for PostgreSQL - postgresql | upgrade // // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch EnableCloudwatchLogsExports []string // Specifies 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] in the Amazon RDS User Guide. // // For more information about CoIPs, see [Customer-owned IP addresses] in the Amazon Web Services Outposts User // Guide. // // [Working with Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html // [Customer-owned IP addresses]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing EnableCustomerOwnedIp *bool // Specifies 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] in the Amazon RDS User Guide. // // This setting doesn't apply to the following DB instances: // // - Amazon Aurora (Mapping Amazon Web Services IAM accounts to database // accounts is managed by the DB cluster.) // // - RDS Custom // // [IAM Database Authentication for MySQL and PostgreSQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool // Specifies whether to enable Performance Insights for the DB instance. For more // information, see [Using Amazon Performance Insights]in the Amazon RDS User Guide. // // This setting doesn't apply to RDS Custom DB instances. // // [Using Amazon Performance Insights]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html EnablePerformanceInsights *bool // The life cycle type for this DB instance. // // By default, this value is set to open-source-rds-extended-support , which // enrolls your DB instance into Amazon RDS Extended Support. At the end of // standard support, you can avoid charges for Extended Support by setting the // value to open-source-rds-extended-support-disabled . In this case, creating the // DB instance will fail if the DB major version is past its end of standard // support date. // // This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon // Aurora DB instances, the life cycle type is managed by the DB cluster. // // You can use this setting to enroll your DB instance into Amazon RDS Extended // Support. With RDS Extended Support, you can run the selected major engine // version on your DB instance past the end of standard support for that engine // version. For more information, see [Using Amazon RDS Extended Support]in the Amazon RDS User Guide. // // Valid Values: open-source-rds-extended-support | // open-source-rds-extended-support-disabled // // Default: open-source-rds-extended-support // // [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html EngineLifecycleSupport *string // The version number of the database engine to use. // // This setting doesn't apply to Amazon Aurora DB instances. The version number of // the database engine the DB instance uses is managed by the DB cluster. // // 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 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. A valid CEV name is // 19.my_cev1 . For more information, see [Creating an RDS Custom for Oracle DB instance] in the Amazon RDS User Guide. // // Amazon RDS Custom for SQL Server See [RDS Custom for SQL Server general requirements] in the Amazon RDS User Guide. // // RDS for Db2 For information, see [Db2 on Amazon RDS versions] in the Amazon RDS User Guide. // // RDS for MariaDB For information, see [MariaDB on Amazon RDS versions] in the Amazon RDS User Guide. // // RDS for Microsoft SQL Server For information, see [Microsoft SQL Server versions on Amazon RDS] in the Amazon RDS User Guide. // // RDS for MySQL For information, see [MySQL on Amazon RDS versions] in the Amazon RDS User Guide. // // RDS for Oracle For information, see [Oracle Database Engine release notes] in the Amazon RDS User Guide. // // RDS for PostgreSQL For information, see [Amazon RDS for PostgreSQL versions and extensions] in the Amazon RDS User Guide. // // [RDS Custom for SQL Server general requirements]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html // [MariaDB on Amazon RDS versions]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt // [Amazon RDS for PostgreSQL versions and extensions]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts // [Oracle Database Engine release notes]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html // [Creating an RDS Custom for Oracle DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create // [Db2 on Amazon RDS versions]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt // [Microsoft SQL Server versions on Amazon RDS]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport // [MySQL on Amazon RDS versions]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt EngineVersion *string // The amount of Provisioned IOPS (input/output operations per second) to // initially allocate for the DB instance. For information about valid IOPS values, // see [Amazon RDS DB instance storage]in the Amazon RDS User Guide. // // This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by // the DB cluster. // // Constraints: // // - For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a // multiple between .5 and 50 of the storage amount for the DB instance. // // - For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage // amount for the DB instance. // // [Amazon RDS DB instance storage]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html Iops *int32 // 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. // // This setting doesn't apply to Amazon Aurora DB instances. 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. // // For Amazon RDS Custom, a KMS key is required for DB 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 // The license model information for this DB instance. // // License models for RDS for Db2 require additional configuration. The Bring Your // Own License (BYOL) model requires a custom parameter group and an Amazon Web // Services License Manager self-managed license. The Db2 license through Amazon // Web Services Marketplace model requires an Amazon Web Services Marketplace // subscription. For more information, see [Amazon RDS for Db2 licensing options]in the Amazon RDS User Guide. // // The default for RDS for Db2 is bring-your-own-license . // // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. // // Valid Values: // // - RDS for Db2 - bring-your-own-license | marketplace-license // // - RDS for MariaDB - general-public-license // // - RDS for Microsoft SQL Server - license-included // // - RDS for MySQL - general-public-license // // - RDS for Oracle - bring-your-own-license | license-included // // - RDS for PostgreSQL - postgresql-license // // [Amazon RDS for Db2 licensing options]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html LicenseModel *string // Specifies whether to manage the master user password with Amazon Web Services // Secrets Manager. // // For more information, see [Password management with Amazon Web Services Secrets Manager] in the Amazon RDS User Guide. // // Constraints: // // - Can't manage the master user password with Amazon Web Services Secrets // Manager if MasterUserPassword is specified. // // [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html ManageMasterUserPassword *bool // The password for the master user. // // This setting doesn't apply to Amazon Aurora DB instances. The password for the // master user is managed by the DB cluster. // // Constraints: // // - Can't be specified if ManageMasterUserPassword is turned on. // // - Can include any printable ASCII character except "/", """, or "@". For RDS // for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) // character. // // Length Constraints: // // - RDS for Db2 - Must contain from 8 to 255 characters. // // - RDS for MariaDB - Must contain from 8 to 41 characters. // // - RDS for Microsoft SQL Server - Must contain from 8 to 128 characters. // // - RDS for MySQL - Must contain from 8 to 41 characters. // // - RDS for Oracle - Must contain from 8 to 30 characters. // // - RDS for PostgreSQL - Must contain from 8 to 128 characters. MasterUserPassword *string // The Amazon Web Services KMS key identifier to encrypt a secret that is // automatically generated and managed in Amazon Web Services Secrets Manager. // // This setting is valid only if the master user password is managed by RDS in // Amazon Web Services Secrets Manager for the 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 you don't specify MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS // key is used to encrypt the secret. If the secret is in a different Amazon Web // Services account, then you can't use the aws/secretsmanager KMS key to encrypt // the secret, and you must use a customer managed 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. MasterUserSecretKmsKeyId *string // The name for the master user. // // This setting doesn't apply to Amazon Aurora DB instances. The name for the // master user is managed by the DB cluster. // // This setting is required for RDS DB instances. // // Constraints: // // - 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 // 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]in the Amazon RDS User Guide. // // This setting doesn't apply to the following DB instances: // // - Amazon Aurora (Storage is managed by the DB cluster.) // // - RDS Custom // // [Managing capacity automatically with Amazon RDS storage autoscaling]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling MaxAllocatedStorage *int32 // 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 . // // If MonitoringRoleArn is specified, then you must set MonitoringInterval to a // value other than 0 . // // This setting doesn't apply to RDS Custom DB instances. // // Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 // // Default: 0 MonitoringInterval *int32 // 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]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 DB instances. // // [Setting Up and Enabling Enhanced Monitoring]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling MonitoringRoleArn *string // Specifies 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 the following DB instances: // // - Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB // cluster.) // // - RDS Custom MultiAZ *bool // Specifies whether to use the multi-tenant configuration or the single-tenant // configuration (default). This parameter only applies to RDS for Oracle container // database (CDB) engines. // // Note the following restrictions: // // - The DB engine that you specify in the request must support the multi-tenant // configuration. If you attempt to enable the multi-tenant configuration on a DB // engine that doesn't support it, the request fails. // // - If you specify the multi-tenant configuration when you create your DB // instance, you can't later modify this DB instance to use the single-tenant // configuration. MultiTenant *bool // The name of the NCHAR character set for the Oracle DB instance. // // This setting doesn't apply to RDS Custom DB instances. NcharCharacterSetName *string // The network type of the DB instance. // // 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] in the Amazon RDS User Guide. // // Valid Values: IPV4 | DUAL // // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *string // The option group to associate the DB instance with. // // 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 Amazon Aurora or RDS Custom DB instances. OptionGroupName *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. // // This setting doesn't apply to RDS Custom DB instances. PerformanceInsightsKMSKeyId *string // The number of days to retain Performance Insights data. // // This setting doesn't apply to RDS Custom DB instances. // // Valid Values: // // - 7 // // - month * 31, where month is a number of months from 1-23. Examples: 93 (3 // months * 31), 341 (11 months * 31), 589 (19 months * 31) // // - 731 // // Default: 7 days // // If you specify a retention period that isn't valid, such as 94 , Amazon RDS // returns an error. PerformanceInsightsRetentionPeriod *int32 // The port number on which the database accepts connections. // // This setting doesn't apply to Aurora DB instances. The port number is managed // by the cluster. // // Valid Values: 1150-65535 // // Default: // // - RDS for Db2 - 50000 // // - RDS for MariaDB - 3306 // // - RDS for Microsoft SQL Server - 1433 // // - RDS for MySQL - 3306 // // - RDS for Oracle - 1521 // // - RDS for PostgreSQL - 5432 // // Constraints: // // - For RDS for Microsoft SQL Server, the value can't be 1234 , 1434 , 3260 , // 3343 , 3389 , 47001 , or 49152-49156 . Port *int32 // 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]in the Amazon RDS User // Guide. // // This setting doesn't apply to Amazon Aurora DB instances. 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. // // [Backup window]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow PreferredBackupWindow *string // The time range each week during which system maintenance can occur. For more // information, see [Amazon RDS Maintenance Window]in the Amazon RDS User Guide. // // 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. // // Constraints: // // - Must be in the format ddd:hh24:mi-ddd:hh24:mi . // // - The day values must be 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. // // [Amazon RDS Maintenance Window]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance PreferredMaintenanceWindow *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 Amazon Aurora or RDS Custom DB instances. ProcessorFeatures []types.ProcessorFeature // The order of priority 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]in the Amazon Aurora User Guide. // // This setting doesn't apply to RDS Custom DB instances. // // Default: 1 // // Valid Values: 0 - 15 // // [Fault Tolerance for an Aurora DB Cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance PromotionTier *int32 // Specifies whether the DB instance is publicly accessible. // // When the DB instance is publicly accessible and you connect from outside of the // DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint // resolves to the public IP address. When you connect from within the same VPC as // the DB instance, the endpoint resolves to the private IP address. 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 // Specifes whether the DB instance is encrypted. By default, it isn't encrypted. // // For RDS Custom DB instances, either enable this setting or leave it unset. // Otherwise, Amazon RDS reports an error. // // This setting doesn't apply to Amazon Aurora DB instances. The encryption for DB // instances is managed by the DB cluster. StorageEncrypted *bool // The storage throughput value for the DB instance. // // This setting applies only to the gp3 storage type. // // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. StorageThroughput *int32 // The storage type to associate with the DB instance. // // If you specify io1 , io2 , or gp3 , you must also include a value for the Iops // parameter. // // This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by // the DB cluster. // // Valid Values: gp2 | gp3 | io1 | io2 | standard // // Default: io1 , if the Iops parameter is specified. Otherwise, gp2 . StorageType *string // Tags to assign to the DB instance. Tags []types.Tag // The ARN from the key store with which to associate the instance for TDE // encryption. // // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. TdeCredentialArn *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 DB instances. TdeCredentialPassword *string // The time zone of the DB instance. The time zone parameter is currently // supported only by [RDS for Db2]and [RDS for SQL Server]. // // [RDS for Db2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone // [RDS for SQL Server]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone Timezone *string // A list of Amazon EC2 VPC security groups to associate with this DB instance. // // This setting doesn't apply to Amazon Aurora DB instances. 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 // contains filtered or unexported fields }
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 *types.DBInstance // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateDBInstanceReadReplicaInput ¶
type CreateDBInstanceReadReplicaInput struct { // 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. // // This member is required. DBInstanceIdentifier *string // The amount of storage (in gibibytes) to allocate initially for the read // replica. Follow the allocation rules specified in CreateDBInstance . // // This setting isn't valid for RDS for SQL Server. // // Be sure to allocate enough storage for your read replica so that the create // operation can succeed. You can also allocate additional storage for future // growth. AllocatedStorage *int32 // Specifies whether to automatically apply minor engine upgrades to the read // replica during the maintenance window. // // This setting doesn't apply to RDS Custom DB instances. // // Default: Inherits the value from the source DB instance. AutoMinorVersionUpgrade *bool // 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 // The CA certificate identifier to use for the read replica's server certificate. // // This setting doesn't apply to RDS Custom DB instances. // // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon // Aurora User Guide. // // [Using SSL/TLS to encrypt a connection to a DB cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html // [Using SSL/TLS to encrypt a connection to a DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html CACertificateIdentifier *string // Specifies whether to copy all tags from the read replica to snapshots of the // read replica. By default, tags aren't copied. CopyTagsToSnapshot *bool // 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] in the Amazon RDS // User Guide. // // This setting is required for RDS Custom DB instances. // // [Configure IAM and your VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc CustomIamInstanceProfile *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]in the Amazon RDS User Guide. // // Default: Inherits the value from the source DB instance. // // [DB Instance Class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html DBInstanceClass *string // The name of the DB parameter group to associate with this read replica DB // instance. // // For Single-AZ or Multi-AZ DB instance read replica instances, if you don't // specify a value for DBParameterGroupName , then Amazon RDS uses the // DBParameterGroup of the source DB instance for a same Region read replica, or // the default DBParameterGroup for the specified DB engine for a cross-Region // read replica. // // For Multi-AZ DB cluster same Region read replica instances, if you don't // specify a value for DBParameterGroupName , then Amazon RDS uses the default // DBParameterGroup . // // Specifying a parameter group for this operation is only supported for MySQL DB // instances for cross-Region read replicas, for Multi-AZ DB cluster read replica // instances, and for Oracle DB instances. It isn't supported for MySQL DB // instances for same Region read replicas or 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 // 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: // // - If supplied, must match the name of an existing DB subnet group. // // - 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 // The mode of Database Insights to enable for the read replica. // // Currently, this setting is not supported. DatabaseInsightsMode types.DatabaseInsightsMode // Indicates whether the DB instance has a dedicated log volume (DLV) enabled. DedicatedLogVolume *bool // Specifies whether to enable deletion protection for the DB instance. 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]. // // [Deleting a DB Instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html DeletionProtection *bool // 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] in the Amazon RDS User Guide. // // This setting doesn't apply to RDS Custom DB instances. // // [Kerberos Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html Domain *string // The ARN for the Secrets Manager secret with the credentials for the user // joining the domain. // // Example: // arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456 DomainAuthSecretArn *string // The IPv4 DNS IP addresses of your primary and secondary Active Directory domain // controllers. // // Constraints: // // - Two IP addresses must be provided. If there isn't a secondary domain // controller, use the IP address of the primary domain controller for both entries // in the list. // // Example: 123.124.125.126,234.235.236.237 DomainDnsIps []string // The fully qualified domain name (FQDN) of an Active Directory domain. // // Constraints: // // - Can't be longer than 64 characters. // // Example: mymanagedADtest.mymanagedAD.mydomain DomainFqdn *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 DB instances. DomainIAMRoleName *string // The Active Directory organizational unit for your DB instance to join. // // Constraints: // // - Must be in the distinguished name format. // // - Can't be longer than 64 characters. // // Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain DomainOu *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]in the Amazon RDS User Guide. // // This setting doesn't apply to RDS Custom DB instances. // // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch EnableCloudwatchLogsExports []string // Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on // Outposts read replica. // // 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 read replica 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] in the Amazon RDS User Guide. // // For more information about CoIPs, see [Customer-owned IP addresses] in the Amazon Web Services Outposts User // Guide. // // [Working with Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html // [Customer-owned IP addresses]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing EnableCustomerOwnedIp *bool // Specifies 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] in the Amazon RDS // User Guide. // // This setting doesn't apply to RDS Custom DB instances. // // [IAM Database Authentication for MySQL and PostgreSQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool // Specifies whether to enable Performance Insights for the read replica. // // For more information, see [Using Amazon Performance Insights] in the Amazon RDS User Guide. // // This setting doesn't apply to RDS Custom DB instances. // // [Using Amazon Performance Insights]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html EnablePerformanceInsights *bool // The amount of Provisioned IOPS (input/output operations per second) to // initially allocate for the DB instance. Iops *int32 // 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 or Multi-AZ DB cluster, don't 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 or cluster. // // 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 or // Multi-AZ DB cluster. // // This setting doesn't apply to RDS Custom, which uses the same KMS key as the // primary replica. KmsKeyId *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]in the Amazon RDS User Guide. // // [Managing capacity automatically with Amazon RDS storage autoscaling]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling MaxAllocatedStorage *int32 // The interval, in seconds, between points when Enhanced Monitoring metrics are // collected for the read replica. 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 DB instances. // // Valid Values: 0, 1, 5, 10, 15, 30, 60 // // Default: 0 MonitoringInterval *int32 // 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]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 DB instances. // // [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 MonitoringRoleArn *string // Specifies 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 is a Multi-AZ DB instance or a Multi-AZ DB cluster. // // This setting doesn't apply to RDS Custom DB instances. MultiAZ *bool // 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] in the Amazon RDS User Guide. // // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *string // The option group to associate the DB instance with. If not specified, RDS uses // the option group associated with the source DB instance or cluster. // // For SQL Server, you must use the option group associated with the source. // // This setting doesn't apply to RDS Custom DB instances. OptionGroupName *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 DB instances. PerformanceInsightsKMSKeyId *string // The number of days to retain Performance Insights data. // // This setting doesn't apply to RDS Custom DB instances. // // Valid Values: // // - 7 // // - month * 31, where month is a number of months from 1-23. Examples: 93 (3 // months * 31), 341 (11 months * 31), 589 (19 months * 31) // // - 731 // // Default: 7 days // // If you specify a retention period that isn't valid, such as 94 , Amazon RDS // returns an error. PerformanceInsightsRetentionPeriod *int32 // The port number that the DB instance uses for connections. // // Valid Values: 1150-65535 // // Default: Inherits the value from the source DB instance. Port *int32 // 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. // // This setting applies only when replicating from a source DB instance. Source DB // clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China // 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)] and [Signature Version 4 Signing Process]. // // 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. // // This setting doesn't apply to RDS Custom DB instances. // // [Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html // [Signature Version 4 Signing Process]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html PreSignedUrl *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 DB instances. ProcessorFeatures []types.ProcessorFeature // Specifies 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 // 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]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. // // [Working with Oracle Read Replicas for Amazon RDS]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html ReplicaMode types.ReplicaMode // The identifier of the Multi-AZ DB cluster that will act as the source for the // read replica. Each DB cluster can have up to 15 read replicas. // // Constraints: // // - Must be the identifier of an existing Multi-AZ DB cluster. // // - Can't be specified if the SourceDBInstanceIdentifier parameter is also // specified. // // - The specified DB cluster must have automatic backups enabled, that is, its // backup retention period must be greater than 0. // // - The source DB cluster must be in the same Amazon Web Services Region as the // read replica. Cross-Region replication isn't supported. SourceDBClusterIdentifier *string // The identifier of the DB instance that will act as the source for the read // replica. Each DB instance can have up to 15 read replicas, with the exception of // Oracle and SQL Server, which can have up to five. // // Constraints: // // - Must be the identifier of an existing Db2, MariaDB, MySQL, Oracle, // PostgreSQL, or SQL Server DB instance. // // - Can't be specified if the SourceDBClusterIdentifier parameter is also // specified. // // - For the limitations of Oracle read replicas, see [Version and licensing considerations for RDS for Oracle replicas]in the Amazon RDS User // Guide. // // - For the limitations of SQL Server read replicas, see [Read replica limitations with SQL Server]in the Amazon RDS User // Guide. // // - 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] // in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, // which don't support cross-Region replicas. // // [Constructing an ARN for Amazon RDS]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing // [Read replica limitations with SQL Server]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.html#SQLServer.ReadReplicas.Limitations // [Version and licensing considerations for RDS for Oracle replicas]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.limitations.html#oracle-read-replicas.limitations.versions-and-licenses SourceDBInstanceIdentifier *string // The AWS region the resource is in. The presigned URL will be created with this // region, if the PresignURL member is empty set. SourceRegion *string // Specifies the storage throughput value for the read replica. // // This setting doesn't apply to RDS Custom or Amazon Aurora DB instances. StorageThroughput *int32 // The storage type to associate with the read replica. // // If you specify io1 , io2 , or gp3 , you must also include a value for the Iops // parameter. // // Valid Values: gp2 | gp3 | io1 | io2 | standard // // Default: io1 if the Iops parameter is specified. Otherwise, gp2 . StorageType *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // Whether to upgrade the storage file system configuration on the read replica. // This option migrates the read replica from the old storage file system layout to // the preferred layout. UpgradeStorageConfig *bool // Specifies whether the DB instance class of the DB instance uses its default // processor features. // // This setting doesn't apply to RDS Custom DB instances. UseDefaultProcessorFeatures *bool // A list of Amazon EC2 VPC security groups to associate with the read replica. // // This setting doesn't apply to RDS Custom DB instances. // // Default: The default EC2 VPC security group for the DB subnet group's VPC. VpcSecurityGroupIds []string // contains filtered or unexported fields }
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 *types.DBInstance // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // // 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-mysql // // - aurora-postgresql // // - db2-ae // // - db2-se // // - mysql // // - oracle-ee // // - oracle-ee-cdb // // - oracle-se2 // // - oracle-se2-cdb // // - postgres // // - sqlserver-ee // // - sqlserver-se // // - sqlserver-ex // // - sqlserver-web // // This member is required. DBParameterGroupFamily *string // 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. // // This member is required. DBParameterGroupName *string // The description for the DB parameter group. // // This member is required. Description *string // Tags to assign to the DB parameter group. Tags []types.Tag // contains filtered or unexported fields }
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 *types.DBParameterGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateDBProxyEndpointInput ¶ added in v1.2.0
type CreateDBProxyEndpointInput struct { // The name of the DB proxy endpoint to create. // // This member is required. DBProxyEndpointName *string // The name of the DB proxy associated with the DB proxy endpoint that you create. // // This member is required. DBProxyName *string // 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. // // This member is required. VpcSubnetIds []string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // The role of the DB proxy endpoint. The role determines whether the endpoint can // be used for read/write or only read operations. The default is READ_WRITE . The // only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE . TargetRole types.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 // contains filtered or unexported fields }
type CreateDBProxyEndpointOutput ¶ added in v1.2.0
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 *types.DBProxyEndpoint // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateDBProxyInput ¶
type CreateDBProxyInput struct { // The authorization mechanism that the proxy uses. // // This member is required. Auth []types.UserAuthConfig // 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. // // This member is required. DBProxyName *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. For Aurora MySQL, RDS for MariaDB, and RDS for // MySQL databases, specify MYSQL . For Aurora PostgreSQL and RDS for PostgreSQL // databases, specify POSTGRESQL . For RDS for Microsoft SQL Server, specify // SQLSERVER . // // This member is required. EngineFamily types.EngineFamily // The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access // secrets in Amazon Web Services Secrets Manager. // // This member is required. RoleArn *string // One or more VPC subnet IDs to associate with the new proxy. // // This member is required. VpcSubnetIds []string // Specifies 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 // 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 *int32 // 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 // An optional set of key-value pairs to associate arbitrary data of your choosing // with the proxy. Tags []types.Tag // One or more VPC security group IDs to associate with the new proxy. VpcSecurityGroupIds []string // contains filtered or unexported fields }
type CreateDBProxyOutput ¶
type CreateDBProxyOutput struct { // The DBProxy structure corresponding to the new proxy. DBProxy *types.DBProxy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateDBSecurityGroupInput ¶
type CreateDBSecurityGroupInput struct { // The description for the DB security group. // // This member is required. DBSecurityGroupDescription *string // 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 // // This member is required. DBSecurityGroupName *string // Tags to assign to the DB security group. Tags []types.Tag // contains filtered or unexported fields }
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 *types.DBSecurityGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateDBShardGroupInput ¶ added in v1.68.0
type CreateDBShardGroupInput struct { // The name of the primary DB cluster for the DB shard group. // // This member is required. DBClusterIdentifier *string // The name of the DB shard group. // // This member is required. DBShardGroupIdentifier *string // The maximum capacity of the DB shard group in Aurora capacity units (ACUs). // // This member is required. MaxACU *float64 // Specifies whether to create standby DB shard groups for the DB shard group. // Valid values are the following: // // - 0 - Creates a DB shard group without a standby DB shard group. This is the // default value. // // - 1 - Creates a DB shard group with a standby DB shard group in a different // Availability Zone (AZ). // // - 2 - Creates a DB shard group with two standby DB shard groups in two // different AZs. ComputeRedundancy *int32 // The minimum capacity of the DB shard group in Aurora capacity units (ACUs). MinACU *float64 // Specifies whether the DB shard group is publicly accessible. // // When the DB shard group is publicly accessible, its Domain Name System (DNS) // endpoint resolves to the private IP address from within the DB shard group's // virtual private cloud (VPC). It resolves to the public IP address from outside // of the DB shard group's VPC. Access to the DB shard group is ultimately // controlled by the security group it uses. That public access is not permitted if // the security group assigned to the DB shard group doesn't permit it. // // When the DB shard group isn't publicly accessible, it is an internal DB shard // group 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 shard group is private. // // - If the default VPC in the target Region has an internet gateway attached to // it, the DB shard group 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 shard group is private. // // - If the subnets are part of a VPC that has an internet gateway attached to // it, the DB shard group is public. PubliclyAccessible *bool // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // contains filtered or unexported fields }
type CreateDBShardGroupOutput ¶ added in v1.68.0
type CreateDBShardGroupOutput struct { // Specifies whether to create standby DB shard groups for the DB shard group. // Valid values are the following: // // - 0 - Creates a DB shard group without a standby DB shard group. This is the // default value. // // - 1 - Creates a DB shard group with a standby DB shard group in a different // Availability Zone (AZ). // // - 2 - Creates a DB shard group with two standby DB shard groups in two // different AZs. ComputeRedundancy *int32 // The name of the primary DB cluster for the DB shard group. DBClusterIdentifier *string // The Amazon Resource Name (ARN) for the DB shard group. DBShardGroupArn *string // The name of the DB shard group. DBShardGroupIdentifier *string // The Amazon Web Services Region-unique, immutable identifier for the DB shard // group. DBShardGroupResourceId *string // The connection endpoint for the DB shard group. Endpoint *string // The maximum capacity of the DB shard group in Aurora capacity units (ACUs). MaxACU *float64 // The minimum capacity of the DB shard group in Aurora capacity units (ACUs). MinACU *float64 // Indicates whether the DB shard group is publicly accessible. // // When the DB shard group is publicly accessible, its Domain Name System (DNS) // endpoint resolves to the private IP address from within the DB shard group's // virtual private cloud (VPC). It resolves to the public IP address from outside // of the DB shard group's VPC. Access to the DB shard group is ultimately // controlled by the security group it uses. That public access isn't permitted if // the security group assigned to the DB shard group doesn't permit it. // // When the DB shard group isn't publicly accessible, it is an internal DB shard // group with a DNS name that resolves to a private IP address. // // For more information, see CreateDBShardGroup. // // This setting is only for Aurora Limitless Database. PubliclyAccessible *bool // The status of the DB shard group. Status *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html TagList []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the details for an Amazon RDS DB shard group.
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. // // This member is required. DBInstanceIdentifier *string // 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 // // This member is required. DBSnapshotIdentifier *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // contains filtered or unexported fields }
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 *types.DBSnapshot // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateDBSubnetGroupInput ¶
type CreateDBSubnetGroupInput struct { // The description for the DB subnet group. // // This member is required. DBSubnetGroupDescription *string // 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 // // This member is required. DBSubnetGroupName *string // The EC2 Subnet IDs for the DB subnet group. // // This member is required. SubnetIds []string // Tags to assign to the DB subnet group. Tags []types.Tag // contains filtered or unexported fields }
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 *types.DBSubnetGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateEventSubscriptionInput ¶
type CreateEventSubscriptionInput struct { // The Amazon Resource Name (ARN) of the SNS topic created for event notification. // SNS automatically creates the ARN when you create a topic and subscribe to it. // // RDS doesn't support FIFO (first in, first out) topics. For more information, // see [Message ordering and deduplication (FIFO topics)]in the Amazon Simple Notification Service Developer Guide. // // [Message ordering and deduplication (FIFO topics)]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html // // This member is required. SnsTopicArn *string // The name of the subscription. // // Constraints: The name must be less than 255 characters. // // This member is required. SubscriptionName *string // Specifies whether to activate the subscription. If the event notification // subscription isn't activated, the subscription is created but not active. Enabled *bool // 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]or // the [Amazon Aurora User Guide]. You can also see this list by using the DescribeEventCategories operation. // // [Amazon RDS User Guide]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html // [Amazon Aurora User Guide]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html EventCategories []string // 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 // 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 | zero-etl | // custom-engine-version | blue-green-deployment SourceType *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // contains filtered or unexported fields }
type CreateEventSubscriptionOutput ¶
type CreateEventSubscriptionOutput struct { // Contains the results of a successful invocation of the // DescribeEventSubscriptions action. EventSubscription *types.EventSubscription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateGlobalClusterInput ¶
type CreateGlobalClusterInput struct { // The name for your database of up to 64 alphanumeric characters. If you don't // specify a name, Amazon Aurora doesn't create a database in the global database // cluster. // // Constraints: // // - Can't be specified if SourceDBClusterIdentifier is specified. In this case, // Amazon Aurora uses the database name from the source DB cluster. DatabaseName *string // Specifies whether to enable deletion protection for the new global database // cluster. The global database can't be deleted when deletion protection is // enabled. DeletionProtection *bool // The database engine to use for this global database cluster. // // Valid Values: aurora-mysql | aurora-postgresql // // Constraints: // // - Can't be specified if SourceDBClusterIdentifier is specified. In this case, // Amazon Aurora uses the engine of the source DB cluster. Engine *string // The life cycle type for this global database cluster. // // By default, this value is set to open-source-rds-extended-support , which // enrolls your global cluster into Amazon RDS Extended Support. At the end of // standard support, you can avoid charges for Extended Support by setting the // value to open-source-rds-extended-support-disabled . In this case, creating the // global cluster will fail if the DB major version is past its end of standard // support date. // // This setting only applies to Aurora PostgreSQL-based global databases. // // You can use this setting to enroll your global cluster into Amazon RDS Extended // Support. With RDS Extended Support, you can run the selected major engine // version on your global cluster past the end of standard support for that engine // version. For more information, see [Using Amazon RDS Extended Support]in the Amazon Aurora User Guide. // // Valid Values: open-source-rds-extended-support | // open-source-rds-extended-support-disabled // // Default: open-source-rds-extended-support // // [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html EngineLifecycleSupport *string // The engine version to use for this global database cluster. // // Constraints: // // - Can't be specified if SourceDBClusterIdentifier is specified. In this case, // Amazon Aurora uses the engine version of the source DB cluster. EngineVersion *string // The cluster identifier for this global database cluster. This parameter is // stored as a lowercase string. GlobalClusterIdentifier *string // The Amazon Resource Name (ARN) to use as the primary cluster of the global // database. // // If you provide a value for this parameter, don't specify values for the // following settings because Amazon Aurora uses the values from the specified // source DB cluster: // // - DatabaseName // // - Engine // // - EngineVersion // // - StorageEncrypted SourceDBClusterIdentifier *string // Specifies whether to enable storage encryption for the new global database // cluster. // // Constraints: // // - Can't be specified if SourceDBClusterIdentifier is specified. In this case, // Amazon Aurora uses the setting from the source DB cluster. StorageEncrypted *bool // Tags to assign to the global cluster. Tags []types.Tag // contains filtered or unexported fields }
type CreateGlobalClusterOutput ¶
type CreateGlobalClusterOutput struct { // A data type representing an Aurora global database. GlobalCluster *types.GlobalCluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateIntegrationInput ¶ added in v1.59.0
type CreateIntegrationInput struct { // The name of the integration. // // This member is required. IntegrationName *string // The Amazon Resource Name (ARN) of the database to use as the source for // replication. // // This member is required. SourceArn *string // The ARN of the Redshift data warehouse to use as the target for replication. // // This member is required. TargetArn *string // An optional set of non-secret key–value pairs that contains additional // contextual information about the data. For more information, see [Encryption context]in the Amazon // Web Services Key Management Service Developer Guide. // // You can only include this parameter if you specify the KMSKeyId parameter. // // [Encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context AdditionalEncryptionContext map[string]string // Data filtering options for the integration. For more information, see [Data filtering for Aurora zero-ETL integrations with Amazon Redshift]. // // Valid for: Integrations with Aurora MySQL source DB clusters only // // [Data filtering for Aurora zero-ETL integrations with Amazon Redshift]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/zero-etl.filtering.html DataFilter *string // A description of the integration. Description *string // The Amazon Web Services Key Management System (Amazon Web Services KMS) key // identifier for the key to use to encrypt the integration. If you don't specify // an encryption key, RDS uses a default Amazon Web Services owned key. KMSKeyId *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // contains filtered or unexported fields }
type CreateIntegrationOutput ¶ added in v1.59.0
type CreateIntegrationOutput struct { // The encryption context for the integration. For more information, see [Encryption context] in the // Amazon Web Services Key Management Service Developer Guide. // // [Encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context AdditionalEncryptionContext map[string]string // The time when the integration was created, in Universal Coordinated Time (UTC). CreateTime *time.Time // Data filters for the integration. These filters determine which tables from the // source database are sent to the target Amazon Redshift data warehouse. DataFilter *string // A description of the integration. Description *string // Any errors associated with the integration. Errors []types.IntegrationError // The ARN of the integration. IntegrationArn *string // The name of the integration. IntegrationName *string // The Amazon Web Services Key Management System (Amazon Web Services KMS) key // identifier for the key used to to encrypt the integration. KMSKeyId *string // The Amazon Resource Name (ARN) of the database used as the source for // replication. SourceArn *string // The current status of the integration. Status types.IntegrationStatus // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // The ARN of the Redshift data warehouse used as the target for replication. TargetArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
A zero-ETL integration with Amazon Redshift.
type CreateOptionGroupInput ¶
type CreateOptionGroupInput struct { // The name of the engine to associate this option group with. // // Valid Values: // // - db2-ae // // - db2-se // // - mariadb // // - mysql // // - oracle-ee // // - oracle-ee-cdb // // - oracle-se2 // // - oracle-se2-cdb // // - postgres // // - sqlserver-ee // // - sqlserver-se // // - sqlserver-ex // // - sqlserver-web // // This member is required. EngineName *string // Specifies the major version of the engine that this option group should be // associated with. // // This member is required. MajorEngineVersion *string // The description of the option group. // // This member is required. OptionGroupDescription *string // 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 // // This member is required. OptionGroupName *string // Tags to assign to the option group. Tags []types.Tag // contains filtered or unexported fields }
type CreateOptionGroupOutput ¶
type CreateOptionGroupOutput struct { // OptionGroup *types.OptionGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateTenantDatabaseInput ¶ added in v1.62.0
type CreateTenantDatabaseInput struct { // The user-supplied DB instance identifier. RDS creates your tenant database in // this DB instance. This parameter isn't case-sensitive. // // This member is required. DBInstanceIdentifier *string // The password for the master user in your tenant database. // // Constraints: // // - Must be 8 to 30 characters. // // - Can include any printable ASCII character except forward slash ( / ), double // quote ( " ), at symbol ( @ ), ampersand ( & ), or single quote ( ' ). // // This member is required. MasterUserPassword *string // The name for the master user account in your tenant database. RDS creates this // user account in the tenant database and grants privileges to the master user. // This parameter is case-sensitive. // // Constraints: // // - 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. // // This member is required. MasterUsername *string // The user-supplied name of the tenant database that you want to create in your // DB instance. This parameter has the same constraints as DBName in // CreateDBInstance . // // This member is required. TenantDBName *string // The character set for your tenant database. If you don't specify a value, the // character set name defaults to AL32UTF8 . CharacterSetName *string // The NCHAR value for the tenant database. NcharCharacterSetName *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // contains filtered or unexported fields }
type CreateTenantDatabaseOutput ¶ added in v1.62.0
type CreateTenantDatabaseOutput struct { // A tenant database in the DB instance. This data type is an element in the // response to the DescribeTenantDatabases action. TenantDatabase *types.TenantDatabase // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DBClusterAvailableWaiter ¶ added in v1.22.0
type DBClusterAvailableWaiter struct {
// contains filtered or unexported fields
}
DBClusterAvailableWaiter defines the waiters for DBClusterAvailable
func NewDBClusterAvailableWaiter ¶ added in v1.22.0
func NewDBClusterAvailableWaiter(client DescribeDBClustersAPIClient, optFns ...func(*DBClusterAvailableWaiterOptions)) *DBClusterAvailableWaiter
NewDBClusterAvailableWaiter constructs a DBClusterAvailableWaiter.
func (*DBClusterAvailableWaiter) Wait ¶ added in v1.22.0
func (w *DBClusterAvailableWaiter) Wait(ctx context.Context, params *DescribeDBClustersInput, maxWaitDur time.Duration, optFns ...func(*DBClusterAvailableWaiterOptions)) error
Wait calls the waiter function for DBClusterAvailable waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*DBClusterAvailableWaiter) WaitForOutput ¶ added in v1.22.0
func (w *DBClusterAvailableWaiter) WaitForOutput(ctx context.Context, params *DescribeDBClustersInput, maxWaitDur time.Duration, optFns ...func(*DBClusterAvailableWaiterOptions)) (*DescribeDBClustersOutput, error)
WaitForOutput calls the waiter function for DBClusterAvailable waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type DBClusterAvailableWaiterOptions ¶ added in v1.22.0
type DBClusterAvailableWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. // // Passing options here is functionally equivalent to passing values to this // config's ClientOptions field that extend the inner client's APIOptions directly. APIOptions []func(*middleware.Stack) error // Functional options to be passed to all operations invoked by this client. // // Function values that modify the inner APIOptions are applied after the waiter // config's own APIOptions modifiers. ClientOptions []func(*Options) // MinDelay is the minimum amount of time to delay between retries. If unset, // DBClusterAvailableWaiter will use default minimum delay of 30 seconds. Note that // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or // set to zero, DBClusterAvailableWaiter will use default max delay of 120 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. // // By default service-modeled logic will populate this option. This option can // thus be used to define a custom waiter state with fall-back to service-modeled // waiter state mutators.The function returns an error in case of a failure state. // In case of retry state, this function returns a bool value of true and nil // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBClustersInput, *DescribeDBClustersOutput, error) (bool, error) }
DBClusterAvailableWaiterOptions are waiter options for DBClusterAvailableWaiter
type DBClusterDeletedWaiter ¶ added in v1.22.0
type DBClusterDeletedWaiter struct {
// contains filtered or unexported fields
}
DBClusterDeletedWaiter defines the waiters for DBClusterDeleted
func NewDBClusterDeletedWaiter ¶ added in v1.22.0
func NewDBClusterDeletedWaiter(client DescribeDBClustersAPIClient, optFns ...func(*DBClusterDeletedWaiterOptions)) *DBClusterDeletedWaiter
NewDBClusterDeletedWaiter constructs a DBClusterDeletedWaiter.
func (*DBClusterDeletedWaiter) Wait ¶ added in v1.22.0
func (w *DBClusterDeletedWaiter) Wait(ctx context.Context, params *DescribeDBClustersInput, maxWaitDur time.Duration, optFns ...func(*DBClusterDeletedWaiterOptions)) error
Wait calls the waiter function for DBClusterDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*DBClusterDeletedWaiter) WaitForOutput ¶ added in v1.22.0
func (w *DBClusterDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeDBClustersInput, maxWaitDur time.Duration, optFns ...func(*DBClusterDeletedWaiterOptions)) (*DescribeDBClustersOutput, error)
WaitForOutput calls the waiter function for DBClusterDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type DBClusterDeletedWaiterOptions ¶ added in v1.22.0
type DBClusterDeletedWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. // // Passing options here is functionally equivalent to passing values to this // config's ClientOptions field that extend the inner client's APIOptions directly. APIOptions []func(*middleware.Stack) error // Functional options to be passed to all operations invoked by this client. // // Function values that modify the inner APIOptions are applied after the waiter // config's own APIOptions modifiers. ClientOptions []func(*Options) // MinDelay is the minimum amount of time to delay between retries. If unset, // DBClusterDeletedWaiter will use default minimum delay of 30 seconds. Note that // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or // set to zero, DBClusterDeletedWaiter will use default max delay of 120 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. // // By default service-modeled logic will populate this option. This option can // thus be used to define a custom waiter state with fall-back to service-modeled // waiter state mutators.The function returns an error in case of a failure state. // In case of retry state, this function returns a bool value of true and nil // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBClustersInput, *DescribeDBClustersOutput, error) (bool, error) }
DBClusterDeletedWaiterOptions are waiter options for DBClusterDeletedWaiter
type DBClusterSnapshotAvailableWaiter ¶ added in v0.31.0
type DBClusterSnapshotAvailableWaiter struct {
// contains filtered or unexported fields
}
DBClusterSnapshotAvailableWaiter defines the waiters for DBClusterSnapshotAvailable
func NewDBClusterSnapshotAvailableWaiter ¶ added in v0.31.0
func NewDBClusterSnapshotAvailableWaiter(client DescribeDBClusterSnapshotsAPIClient, optFns ...func(*DBClusterSnapshotAvailableWaiterOptions)) *DBClusterSnapshotAvailableWaiter
NewDBClusterSnapshotAvailableWaiter constructs a DBClusterSnapshotAvailableWaiter.
func (*DBClusterSnapshotAvailableWaiter) Wait ¶ added in v0.31.0
func (w *DBClusterSnapshotAvailableWaiter) Wait(ctx context.Context, params *DescribeDBClusterSnapshotsInput, maxWaitDur time.Duration, optFns ...func(*DBClusterSnapshotAvailableWaiterOptions)) error
Wait calls the waiter function for DBClusterSnapshotAvailable waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*DBClusterSnapshotAvailableWaiter) WaitForOutput ¶ added in v1.12.0
func (w *DBClusterSnapshotAvailableWaiter) WaitForOutput(ctx context.Context, params *DescribeDBClusterSnapshotsInput, maxWaitDur time.Duration, optFns ...func(*DBClusterSnapshotAvailableWaiterOptions)) (*DescribeDBClusterSnapshotsOutput, error)
WaitForOutput calls the waiter function for DBClusterSnapshotAvailable waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type DBClusterSnapshotAvailableWaiterOptions ¶ added in v0.31.0
type DBClusterSnapshotAvailableWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. // // Passing options here is functionally equivalent to passing values to this // config's ClientOptions field that extend the inner client's APIOptions directly. APIOptions []func(*middleware.Stack) error // Functional options to be passed to all operations invoked by this client. // // Function values that modify the inner APIOptions are applied after the waiter // config's own APIOptions modifiers. ClientOptions []func(*Options) // MinDelay is the minimum amount of time to delay between retries. If unset, // DBClusterSnapshotAvailableWaiter will use default minimum delay of 30 seconds. // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or // set to zero, DBClusterSnapshotAvailableWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. // // By default service-modeled logic will populate this option. This option can // thus be used to define a custom waiter state with fall-back to service-modeled // waiter state mutators.The function returns an error in case of a failure state. // In case of retry state, this function returns a bool value of true and nil // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBClusterSnapshotsInput, *DescribeDBClusterSnapshotsOutput, error) (bool, error) }
DBClusterSnapshotAvailableWaiterOptions are waiter options for DBClusterSnapshotAvailableWaiter
type DBClusterSnapshotDeletedWaiter ¶ added in v0.31.0
type DBClusterSnapshotDeletedWaiter struct {
// contains filtered or unexported fields
}
DBClusterSnapshotDeletedWaiter defines the waiters for DBClusterSnapshotDeleted
func NewDBClusterSnapshotDeletedWaiter ¶ added in v0.31.0
func NewDBClusterSnapshotDeletedWaiter(client DescribeDBClusterSnapshotsAPIClient, optFns ...func(*DBClusterSnapshotDeletedWaiterOptions)) *DBClusterSnapshotDeletedWaiter
NewDBClusterSnapshotDeletedWaiter constructs a DBClusterSnapshotDeletedWaiter.
func (*DBClusterSnapshotDeletedWaiter) Wait ¶ added in v0.31.0
func (w *DBClusterSnapshotDeletedWaiter) Wait(ctx context.Context, params *DescribeDBClusterSnapshotsInput, maxWaitDur time.Duration, optFns ...func(*DBClusterSnapshotDeletedWaiterOptions)) error
Wait calls the waiter function for DBClusterSnapshotDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*DBClusterSnapshotDeletedWaiter) WaitForOutput ¶ added in v1.12.0
func (w *DBClusterSnapshotDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeDBClusterSnapshotsInput, maxWaitDur time.Duration, optFns ...func(*DBClusterSnapshotDeletedWaiterOptions)) (*DescribeDBClusterSnapshotsOutput, error)
WaitForOutput calls the waiter function for DBClusterSnapshotDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type DBClusterSnapshotDeletedWaiterOptions ¶ added in v0.31.0
type DBClusterSnapshotDeletedWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. // // Passing options here is functionally equivalent to passing values to this // config's ClientOptions field that extend the inner client's APIOptions directly. APIOptions []func(*middleware.Stack) error // Functional options to be passed to all operations invoked by this client. // // Function values that modify the inner APIOptions are applied after the waiter // config's own APIOptions modifiers. ClientOptions []func(*Options) // MinDelay is the minimum amount of time to delay between retries. If unset, // DBClusterSnapshotDeletedWaiter will use default minimum delay of 30 seconds. // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or // set to zero, DBClusterSnapshotDeletedWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. // // By default service-modeled logic will populate this option. This option can // thus be used to define a custom waiter state with fall-back to service-modeled // waiter state mutators.The function returns an error in case of a failure state. // In case of retry state, this function returns a bool value of true and nil // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBClusterSnapshotsInput, *DescribeDBClusterSnapshotsOutput, error) (bool, error) }
DBClusterSnapshotDeletedWaiterOptions are waiter options for DBClusterSnapshotDeletedWaiter
type DBInstanceAvailableWaiter ¶ added in v0.31.0
type DBInstanceAvailableWaiter struct {
// contains filtered or unexported fields
}
DBInstanceAvailableWaiter defines the waiters for DBInstanceAvailable
func NewDBInstanceAvailableWaiter ¶ added in v0.31.0
func NewDBInstanceAvailableWaiter(client DescribeDBInstancesAPIClient, optFns ...func(*DBInstanceAvailableWaiterOptions)) *DBInstanceAvailableWaiter
NewDBInstanceAvailableWaiter constructs a DBInstanceAvailableWaiter.
func (*DBInstanceAvailableWaiter) Wait ¶ added in v0.31.0
func (w *DBInstanceAvailableWaiter) Wait(ctx context.Context, params *DescribeDBInstancesInput, maxWaitDur time.Duration, optFns ...func(*DBInstanceAvailableWaiterOptions)) error
Wait calls the waiter function for DBInstanceAvailable waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*DBInstanceAvailableWaiter) WaitForOutput ¶ added in v1.12.0
func (w *DBInstanceAvailableWaiter) WaitForOutput(ctx context.Context, params *DescribeDBInstancesInput, maxWaitDur time.Duration, optFns ...func(*DBInstanceAvailableWaiterOptions)) (*DescribeDBInstancesOutput, error)
WaitForOutput calls the waiter function for DBInstanceAvailable waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type DBInstanceAvailableWaiterOptions ¶ added in v0.31.0
type DBInstanceAvailableWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. // // Passing options here is functionally equivalent to passing values to this // config's ClientOptions field that extend the inner client's APIOptions directly. APIOptions []func(*middleware.Stack) error // Functional options to be passed to all operations invoked by this client. // // Function values that modify the inner APIOptions are applied after the waiter // config's own APIOptions modifiers. ClientOptions []func(*Options) // MinDelay is the minimum amount of time to delay between retries. If unset, // DBInstanceAvailableWaiter will use default minimum delay of 30 seconds. Note // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or // set to zero, DBInstanceAvailableWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. // // By default service-modeled logic will populate this option. This option can // thus be used to define a custom waiter state with fall-back to service-modeled // waiter state mutators.The function returns an error in case of a failure state. // In case of retry state, this function returns a bool value of true and nil // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBInstancesInput, *DescribeDBInstancesOutput, error) (bool, error) }
DBInstanceAvailableWaiterOptions are waiter options for DBInstanceAvailableWaiter
type DBInstanceDeletedWaiter ¶ added in v1.7.0
type DBInstanceDeletedWaiter struct {
// contains filtered or unexported fields
}
DBInstanceDeletedWaiter defines the waiters for DBInstanceDeleted
func NewDBInstanceDeletedWaiter ¶ added in v1.7.0
func NewDBInstanceDeletedWaiter(client DescribeDBInstancesAPIClient, optFns ...func(*DBInstanceDeletedWaiterOptions)) *DBInstanceDeletedWaiter
NewDBInstanceDeletedWaiter constructs a DBInstanceDeletedWaiter.
func (*DBInstanceDeletedWaiter) Wait ¶ added in v1.7.0
func (w *DBInstanceDeletedWaiter) Wait(ctx context.Context, params *DescribeDBInstancesInput, maxWaitDur time.Duration, optFns ...func(*DBInstanceDeletedWaiterOptions)) error
Wait calls the waiter function for DBInstanceDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*DBInstanceDeletedWaiter) WaitForOutput ¶ added in v1.12.0
func (w *DBInstanceDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeDBInstancesInput, maxWaitDur time.Duration, optFns ...func(*DBInstanceDeletedWaiterOptions)) (*DescribeDBInstancesOutput, error)
WaitForOutput calls the waiter function for DBInstanceDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type DBInstanceDeletedWaiterOptions ¶ added in v1.7.0
type DBInstanceDeletedWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. // // Passing options here is functionally equivalent to passing values to this // config's ClientOptions field that extend the inner client's APIOptions directly. APIOptions []func(*middleware.Stack) error // Functional options to be passed to all operations invoked by this client. // // Function values that modify the inner APIOptions are applied after the waiter // config's own APIOptions modifiers. ClientOptions []func(*Options) // MinDelay is the minimum amount of time to delay between retries. If unset, // DBInstanceDeletedWaiter will use default minimum delay of 30 seconds. Note that // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or // set to zero, DBInstanceDeletedWaiter will use default max delay of 120 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. // // By default service-modeled logic will populate this option. This option can // thus be used to define a custom waiter state with fall-back to service-modeled // waiter state mutators.The function returns an error in case of a failure state. // In case of retry state, this function returns a bool value of true and nil // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBInstancesInput, *DescribeDBInstancesOutput, error) (bool, error) }
DBInstanceDeletedWaiterOptions are waiter options for DBInstanceDeletedWaiter
type DBSnapshotAvailableWaiter ¶ added in v0.31.0
type DBSnapshotAvailableWaiter struct {
// contains filtered or unexported fields
}
DBSnapshotAvailableWaiter defines the waiters for DBSnapshotAvailable
func NewDBSnapshotAvailableWaiter ¶ added in v0.31.0
func NewDBSnapshotAvailableWaiter(client DescribeDBSnapshotsAPIClient, optFns ...func(*DBSnapshotAvailableWaiterOptions)) *DBSnapshotAvailableWaiter
NewDBSnapshotAvailableWaiter constructs a DBSnapshotAvailableWaiter.
func (*DBSnapshotAvailableWaiter) Wait ¶ added in v0.31.0
func (w *DBSnapshotAvailableWaiter) Wait(ctx context.Context, params *DescribeDBSnapshotsInput, maxWaitDur time.Duration, optFns ...func(*DBSnapshotAvailableWaiterOptions)) error
Wait calls the waiter function for DBSnapshotAvailable waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*DBSnapshotAvailableWaiter) WaitForOutput ¶ added in v1.12.0
func (w *DBSnapshotAvailableWaiter) WaitForOutput(ctx context.Context, params *DescribeDBSnapshotsInput, maxWaitDur time.Duration, optFns ...func(*DBSnapshotAvailableWaiterOptions)) (*DescribeDBSnapshotsOutput, error)
WaitForOutput calls the waiter function for DBSnapshotAvailable waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type DBSnapshotAvailableWaiterOptions ¶ added in v0.31.0
type DBSnapshotAvailableWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. // // Passing options here is functionally equivalent to passing values to this // config's ClientOptions field that extend the inner client's APIOptions directly. APIOptions []func(*middleware.Stack) error // Functional options to be passed to all operations invoked by this client. // // Function values that modify the inner APIOptions are applied after the waiter // config's own APIOptions modifiers. ClientOptions []func(*Options) // MinDelay is the minimum amount of time to delay between retries. If unset, // DBSnapshotAvailableWaiter will use default minimum delay of 30 seconds. Note // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or // set to zero, DBSnapshotAvailableWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. // // By default service-modeled logic will populate this option. This option can // thus be used to define a custom waiter state with fall-back to service-modeled // waiter state mutators.The function returns an error in case of a failure state. // In case of retry state, this function returns a bool value of true and nil // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBSnapshotsInput, *DescribeDBSnapshotsOutput, error) (bool, error) }
DBSnapshotAvailableWaiterOptions are waiter options for DBSnapshotAvailableWaiter
type DBSnapshotDeletedWaiter ¶ added in v1.7.0
type DBSnapshotDeletedWaiter struct {
// contains filtered or unexported fields
}
DBSnapshotDeletedWaiter defines the waiters for DBSnapshotDeleted
func NewDBSnapshotDeletedWaiter ¶ added in v1.7.0
func NewDBSnapshotDeletedWaiter(client DescribeDBSnapshotsAPIClient, optFns ...func(*DBSnapshotDeletedWaiterOptions)) *DBSnapshotDeletedWaiter
NewDBSnapshotDeletedWaiter constructs a DBSnapshotDeletedWaiter.
func (*DBSnapshotDeletedWaiter) Wait ¶ added in v1.7.0
func (w *DBSnapshotDeletedWaiter) Wait(ctx context.Context, params *DescribeDBSnapshotsInput, maxWaitDur time.Duration, optFns ...func(*DBSnapshotDeletedWaiterOptions)) error
Wait calls the waiter function for DBSnapshotDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*DBSnapshotDeletedWaiter) WaitForOutput ¶ added in v1.12.0
func (w *DBSnapshotDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeDBSnapshotsInput, maxWaitDur time.Duration, optFns ...func(*DBSnapshotDeletedWaiterOptions)) (*DescribeDBSnapshotsOutput, error)
WaitForOutput calls the waiter function for DBSnapshotDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type DBSnapshotDeletedWaiterOptions ¶ added in v1.7.0
type DBSnapshotDeletedWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. // // Passing options here is functionally equivalent to passing values to this // config's ClientOptions field that extend the inner client's APIOptions directly. APIOptions []func(*middleware.Stack) error // Functional options to be passed to all operations invoked by this client. // // Function values that modify the inner APIOptions are applied after the waiter // config's own APIOptions modifiers. ClientOptions []func(*Options) // MinDelay is the minimum amount of time to delay between retries. If unset, // DBSnapshotDeletedWaiter will use default minimum delay of 30 seconds. Note that // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or // set to zero, DBSnapshotDeletedWaiter will use default max delay of 120 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. // // By default service-modeled logic will populate this option. This option can // thus be used to define a custom waiter state with fall-back to service-modeled // waiter state mutators.The function returns an error in case of a failure state. // In case of retry state, this function returns a bool value of true and nil // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBSnapshotsInput, *DescribeDBSnapshotsOutput, error) (bool, error) }
DBSnapshotDeletedWaiterOptions are waiter options for DBSnapshotDeletedWaiter
type DeleteBlueGreenDeploymentInput ¶ added in v1.31.0
type DeleteBlueGreenDeploymentInput struct { // The unique identifier of the blue/green deployment to delete. This parameter // isn't case-sensitive. // // Constraints: // // - Must match an existing blue/green deployment identifier. // // This member is required. BlueGreenDeploymentIdentifier *string // Specifies whether to delete the resources in the green environment. You can't // specify this option if the blue/green deployment [status]is SWITCHOVER_COMPLETED . // // [status]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_BlueGreenDeployment.html DeleteTarget *bool // contains filtered or unexported fields }
type DeleteBlueGreenDeploymentOutput ¶ added in v1.31.0
type DeleteBlueGreenDeploymentOutput struct { // Details about a blue/green deployment. // // For more information, see [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon RDS User Guide and [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon // Aurora User Guide. // // [Using Amazon RDS Blue/Green Deployments for database updates]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html BlueGreenDeployment *types.BlueGreenDeployment // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteCustomDBEngineVersionInput ¶ added in v1.11.0
type DeleteCustomDBEngineVersionInput struct { // The database engine. RDS Custom for Oracle supports the following values: // // - custom-oracle-ee // // - custom-oracle-ee-cdb // // - custom-oracle-se2 // // - custom-oracle-se2-cdb // // This member is required. Engine *string // 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. // // This member is required. EngineVersion *string // contains filtered or unexported fields }
type DeleteCustomDBEngineVersionOutput ¶ added in v1.11.0
type DeleteCustomDBEngineVersionOutput struct { // The creation time of the DB engine version. CreateTime *time.Time // JSON string that lists the installation files and parameters that RDS Custom // uses to create a custom engine version (CEV). RDS Custom applies the patches in // the order in which they're listed in the manifest. You can set the Oracle home, // Oracle base, and UNIX/Linux user and group using the installation parameters. // For more information, see [JSON fields in the CEV manifest]in the Amazon RDS User Guide. // // [JSON fields in the CEV manifest]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields CustomDBEngineVersionManifest *string // The description of the database engine. DBEngineDescription *string // A value that indicates the source media provider of the AMI based on the usage // operation. Applicable for RDS Custom for SQL Server. DBEngineMediaType *string // The ARN of the custom engine version. DBEngineVersionArn *string // The description of the database engine version. DBEngineVersionDescription *string // The name of the DB parameter group family for the database engine. DBParameterGroupFamily *string // The name of the Amazon S3 bucket that contains your database installation files. DatabaseInstallationFilesS3BucketName *string // The Amazon S3 directory that contains the database installation files. If not // specified, then no prefix is assumed. DatabaseInstallationFilesS3Prefix *string // The default character set for new instances of this engine version, if the // CharacterSetName parameter of the CreateDBInstance API isn't specified. DefaultCharacterSet *types.CharacterSet // The name of the database engine. Engine *string // The version number of the database engine. EngineVersion *string // The types of logs that the database engine has available for export to // CloudWatch Logs. ExportableLogTypes []string // The EC2 image Image *types.CustomDBEngineVersionAMI // 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 // The major engine version of the CEV. MajorEngineVersion *string // Specifies any Aurora Serverless v2 properties or limits that differ between // Aurora engine versions. You can test the values of this attribute when deciding // which Aurora version to use in a new or upgraded DB cluster. You can also // retrieve the version of an existing DB cluster and check whether that version // supports certain Aurora Serverless v2 features before you attempt to use those // features. ServerlessV2FeaturesSupport *types.ServerlessV2FeaturesSupport // The status of the DB engine version, either available or deprecated . Status *string // A list of the supported CA certificate identifiers. // // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon // Aurora User Guide. // // [Using SSL/TLS to encrypt a connection to a DB cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html // [Using SSL/TLS to encrypt a connection to a DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html SupportedCACertificateIdentifiers []string // A list of the character sets supported by this engine for the CharacterSetName // parameter of the CreateDBInstance operation. SupportedCharacterSets []types.CharacterSet // A list of the supported DB engine modes. SupportedEngineModes []string // 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-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 // A list of the character sets supported by the Oracle DB engine for the // NcharCharacterSetName parameter of the CreateDBInstance operation. SupportedNcharCharacterSets []types.CharacterSet // A list of the time zones supported by this engine for the Timezone parameter of // the CreateDBInstance action. SupportedTimezones []types.Timezone // Indicates whether the engine version supports Babelfish for Aurora PostgreSQL. SupportsBabelfish *bool // Indicates whether the engine version supports rotating the server certificate // without rebooting the DB instance. SupportsCertificateRotationWithoutRestart *bool // Indicates whether you can use Aurora global databases with a specific DB engine // version. SupportsGlobalDatabases *bool // Indicates whether the DB engine version supports zero-ETL integrations with // Amazon Redshift. SupportsIntegrations *bool // Indicates whether the DB engine version supports Aurora Limitless Database. SupportsLimitlessDatabase *bool // Indicates whether the DB engine version supports forwarding write operations // from reader DB instances to the writer DB instance in the DB cluster. By // default, write operations aren't allowed on reader DB instances. // // Valid for: Aurora DB clusters only SupportsLocalWriteForwarding *bool // Indicates whether the engine version supports exporting the log types specified // by ExportableLogTypes to CloudWatch Logs. SupportsLogExportsToCloudwatchLogs *bool // Indicates whether you can use Aurora parallel query with a specific DB engine // version. SupportsParallelQuery *bool // Indicates whether the database engine version supports read replicas. SupportsReadReplica *bool // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html TagList []types.Tag // A list of engine versions that this database engine version can be upgraded to. ValidUpgradeTarget []types.UpgradeTarget // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
This data type is used as a response element in the action DescribeDBEngineVersions .
type DeleteDBClusterAutomatedBackupInput ¶ added in v1.50.0
type DeleteDBClusterAutomatedBackupInput struct { // The identifier for the source DB cluster, which can't be changed and which is // unique to an Amazon Web Services Region. // // This member is required. DbClusterResourceId *string // contains filtered or unexported fields }
type DeleteDBClusterAutomatedBackupOutput ¶ added in v1.50.0
type DeleteDBClusterAutomatedBackupOutput struct { // An automated backup of a DB cluster. It consists of system backups, transaction // logs, and the database cluster properties that existed at the time you deleted // the source cluster. DBClusterAutomatedBackup *types.DBClusterAutomatedBackup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteDBClusterEndpointInput ¶
type DeleteDBClusterEndpointInput struct { // The identifier associated with the custom endpoint. This parameter is stored as // a lowercase string. // // This member is required. DBClusterEndpointIdentifier *string // contains filtered or unexported fields }
type DeleteDBClusterEndpointOutput ¶
type DeleteDBClusterEndpointOutput struct { // The type associated with a custom endpoint. One of: READER , WRITER , ANY . CustomEndpointType *string // The Amazon Resource Name (ARN) for the endpoint. DBClusterEndpointArn *string // The identifier associated with the endpoint. This parameter is stored as a // lowercase string. DBClusterEndpointIdentifier *string // A unique system-generated identifier for an endpoint. It remains the same for // the whole life of the endpoint. DBClusterEndpointResourceIdentifier *string // The DB cluster identifier of the DB cluster associated with the endpoint. This // parameter is stored as a lowercase string. DBClusterIdentifier *string // The DNS address of the endpoint. Endpoint *string // The type of the endpoint. One of: READER , WRITER , CUSTOM . EndpointType *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 // List of DB instance identifiers that are part of the custom endpoint group. StaticMembers []string // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // 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 .
type DeleteDBClusterInput ¶
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. // // This member is required. DBClusterIdentifier *string // Specifies whether to remove automated backups immediately after the DB cluster // is deleted. This parameter isn't case-sensitive. The default is to remove // automated backups immediately after the DB cluster is deleted. DeleteAutomatedBackups *bool // The DB cluster snapshot identifier of the new DB cluster snapshot created when // SkipFinalSnapshot is disabled. // // If you specify this parameter and also skip the creation of a final DB cluster // snapshot with the SkipFinalShapshot parameter, the request 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 // Specifies whether to skip the creation of a final DB cluster snapshot before // RDS deletes the DB cluster. If you set this value to true , RDS doesn't create a // final DB cluster snapshot. If you set this value to false or don't specify it, // RDS creates a DB cluster snapshot before it deletes the DB cluster. By default, // this parameter is disabled, so RDS creates a final DB cluster snapshot. // // If SkipFinalSnapshot is disabled, you must specify a value for the // FinalDBSnapshotIdentifier parameter. SkipFinalSnapshot *bool // contains filtered or unexported fields }
type DeleteDBClusterOutput ¶
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?] in the Amazon Aurora // User Guide. // // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User // Guide. // // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteDBClusterParameterGroupInput ¶
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. // // This member is required. DBClusterParameterGroupName *string // contains filtered or unexported fields }
type DeleteDBClusterParameterGroupOutput ¶
type DeleteDBClusterParameterGroupOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteDBClusterSnapshotInput ¶
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. // // This member is required. DBClusterSnapshotIdentifier *string // contains filtered or unexported fields }
type DeleteDBClusterSnapshotOutput ¶
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 *types.DBClusterSnapshot // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteDBInstanceAutomatedBackupInput ¶
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 // The identifier for the source DB instance, which can't be changed and which is // unique to an Amazon Web Services Region. DbiResourceId *string // contains filtered or unexported fields }
Parameter input for the DeleteDBInstanceAutomatedBackup operation.
type DeleteDBInstanceAutomatedBackupOutput ¶
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 *types.DBInstanceAutomatedBackup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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. // // This member is required. DBInstanceIdentifier *string // Specifies 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 // 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 // Specifies 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 // contains filtered or unexported fields }
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 *types.DBInstance // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // // This member is required. DBParameterGroupName *string // contains filtered or unexported fields }
type DeleteDBParameterGroupOutput ¶
type DeleteDBParameterGroupOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteDBProxyEndpointInput ¶ added in v1.2.0
type DeleteDBProxyEndpointInput struct { // The name of the DB proxy endpoint to delete. // // This member is required. DBProxyEndpointName *string // contains filtered or unexported fields }
type DeleteDBProxyEndpointOutput ¶ added in v1.2.0
type DeleteDBProxyEndpointOutput struct { // The data structure representing the details of the DB proxy endpoint that you // delete. DBProxyEndpoint *types.DBProxyEndpoint // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteDBProxyInput ¶
type DeleteDBProxyInput struct { // The name of the DB proxy to delete. // // This member is required. DBProxyName *string // contains filtered or unexported fields }
type DeleteDBProxyOutput ¶
type DeleteDBProxyOutput struct { // The data structure representing the details of the DB proxy that you delete. DBProxy *types.DBProxy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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" // // This member is required. DBSecurityGroupName *string // contains filtered or unexported fields }
type DeleteDBSecurityGroupOutput ¶
type DeleteDBSecurityGroupOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteDBShardGroupInput ¶ added in v1.68.0
type DeleteDBShardGroupInput struct { // The name of the DB shard group to delete. // // This member is required. DBShardGroupIdentifier *string // contains filtered or unexported fields }
type DeleteDBShardGroupOutput ¶ added in v1.68.0
type DeleteDBShardGroupOutput struct { // Specifies whether to create standby DB shard groups for the DB shard group. // Valid values are the following: // // - 0 - Creates a DB shard group without a standby DB shard group. This is the // default value. // // - 1 - Creates a DB shard group with a standby DB shard group in a different // Availability Zone (AZ). // // - 2 - Creates a DB shard group with two standby DB shard groups in two // different AZs. ComputeRedundancy *int32 // The name of the primary DB cluster for the DB shard group. DBClusterIdentifier *string // The Amazon Resource Name (ARN) for the DB shard group. DBShardGroupArn *string // The name of the DB shard group. DBShardGroupIdentifier *string // The Amazon Web Services Region-unique, immutable identifier for the DB shard // group. DBShardGroupResourceId *string // The connection endpoint for the DB shard group. Endpoint *string // The maximum capacity of the DB shard group in Aurora capacity units (ACUs). MaxACU *float64 // The minimum capacity of the DB shard group in Aurora capacity units (ACUs). MinACU *float64 // Indicates whether the DB shard group is publicly accessible. // // When the DB shard group is publicly accessible, its Domain Name System (DNS) // endpoint resolves to the private IP address from within the DB shard group's // virtual private cloud (VPC). It resolves to the public IP address from outside // of the DB shard group's VPC. Access to the DB shard group is ultimately // controlled by the security group it uses. That public access isn't permitted if // the security group assigned to the DB shard group doesn't permit it. // // When the DB shard group isn't publicly accessible, it is an internal DB shard // group with a DNS name that resolves to a private IP address. // // For more information, see CreateDBShardGroup. // // This setting is only for Aurora Limitless Database. PubliclyAccessible *bool // The status of the DB shard group. Status *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html TagList []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the details for an Amazon RDS DB shard group.
type DeleteDBSnapshotInput ¶
type DeleteDBSnapshotInput struct { // The DB snapshot identifier. // // Constraints: Must be the name of an existing DB snapshot in the available state. // // This member is required. DBSnapshotIdentifier *string // contains filtered or unexported fields }
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 *types.DBSnapshot // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // // This member is required. DBSubnetGroupName *string // contains filtered or unexported fields }
type DeleteDBSubnetGroupOutput ¶
type DeleteDBSubnetGroupOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteEventSubscriptionInput ¶
type DeleteEventSubscriptionInput struct { // The name of the RDS event notification subscription you want to delete. // // This member is required. SubscriptionName *string // contains filtered or unexported fields }
type DeleteEventSubscriptionOutput ¶
type DeleteEventSubscriptionOutput struct { // Contains the results of a successful invocation of the // DescribeEventSubscriptions action. EventSubscription *types.EventSubscription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteGlobalClusterInput ¶
type DeleteGlobalClusterInput struct { // The cluster identifier of the global database cluster being deleted. // // This member is required. GlobalClusterIdentifier *string // contains filtered or unexported fields }
type DeleteGlobalClusterOutput ¶
type DeleteGlobalClusterOutput struct { // A data type representing an Aurora global database. GlobalCluster *types.GlobalCluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteIntegrationInput ¶ added in v1.59.0
type DeleteIntegrationInput struct { // The unique identifier of the integration. // // This member is required. IntegrationIdentifier *string // contains filtered or unexported fields }
type DeleteIntegrationOutput ¶ added in v1.59.0
type DeleteIntegrationOutput struct { // The encryption context for the integration. For more information, see [Encryption context] in the // Amazon Web Services Key Management Service Developer Guide. // // [Encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context AdditionalEncryptionContext map[string]string // The time when the integration was created, in Universal Coordinated Time (UTC). CreateTime *time.Time // Data filters for the integration. These filters determine which tables from the // source database are sent to the target Amazon Redshift data warehouse. DataFilter *string // A description of the integration. Description *string // Any errors associated with the integration. Errors []types.IntegrationError // The ARN of the integration. IntegrationArn *string // The name of the integration. IntegrationName *string // The Amazon Web Services Key Management System (Amazon Web Services KMS) key // identifier for the key used to to encrypt the integration. KMSKeyId *string // The Amazon Resource Name (ARN) of the database used as the source for // replication. SourceArn *string // The current status of the integration. Status types.IntegrationStatus // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // The ARN of the Redshift data warehouse used as the target for replication. TargetArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
A zero-ETL integration with Amazon Redshift.
type DeleteOptionGroupInput ¶
type DeleteOptionGroupInput struct { // The name of the option group to be deleted. // // You can't delete default option groups. // // This member is required. OptionGroupName *string // contains filtered or unexported fields }
type DeleteOptionGroupOutput ¶
type DeleteOptionGroupOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteTenantDatabaseInput ¶ added in v1.62.0
type DeleteTenantDatabaseInput struct { // The user-supplied identifier for the DB instance that contains the tenant // database that you want to delete. // // This member is required. DBInstanceIdentifier *string // The user-supplied name of the tenant database that you want to remove from your // DB instance. Amazon RDS deletes the tenant database with this name. This // parameter isn’t case-sensitive. // // This member is required. TenantDBName *string // 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. FinalDBSnapshotIdentifier *string // Specifies whether to skip the creation of a final DB snapshot before removing // the tenant database from your DB 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 it deletes the tenant database. By default, RDS doesn't skip // the final snapshot. If you don't enable this parameter, you must specify the // FinalDBSnapshotIdentifier parameter. SkipFinalSnapshot *bool // contains filtered or unexported fields }
type DeleteTenantDatabaseOutput ¶ added in v1.62.0
type DeleteTenantDatabaseOutput struct { // A tenant database in the DB instance. This data type is an element in the // response to the DescribeTenantDatabases action. TenantDatabase *types.TenantDatabase // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeregisterDBProxyTargetsInput ¶
type DeregisterDBProxyTargetsInput struct { // The identifier of the DBProxy that is associated with the DBProxyTargetGroup . // // This member is required. DBProxyName *string // One or more DB cluster identifiers. DBClusterIdentifiers []string // One or more DB instance identifiers. DBInstanceIdentifiers []string // The identifier of the DBProxyTargetGroup . TargetGroupName *string // contains filtered or unexported fields }
type DeregisterDBProxyTargetsOutput ¶
type DeregisterDBProxyTargetsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeAccountAttributesInput ¶
type DescribeAccountAttributesInput struct {
// contains filtered or unexported fields
}
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 []types.AccountQuota // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Data returned by the DescribeAccountAttributes action.
type DescribeBlueGreenDeploymentsAPIClient ¶ added in v1.31.0
type DescribeBlueGreenDeploymentsAPIClient interface {
DescribeBlueGreenDeployments(context.Context, *DescribeBlueGreenDeploymentsInput, ...func(*Options)) (*DescribeBlueGreenDeploymentsOutput, error)
}
DescribeBlueGreenDeploymentsAPIClient is a client that implements the DescribeBlueGreenDeployments operation.
type DescribeBlueGreenDeploymentsInput ¶ added in v1.31.0
type DescribeBlueGreenDeploymentsInput struct { // The blue/green deployment identifier. If you specify this parameter, the // response only includes information about the specific blue/green deployment. // This parameter isn't case-sensitive. // // Constraints: // // - Must match an existing blue/green deployment identifier. BlueGreenDeploymentIdentifier *string // A filter that specifies one or more blue/green deployments to describe. // // Valid Values: // // - blue-green-deployment-identifier - Accepts system-generated identifiers for // blue/green deployments. The results list only includes information about the // blue/green deployments with the specified identifiers. // // - blue-green-deployment-name - Accepts user-supplied names for blue/green // deployments. The results list only includes information about the blue/green // deployments with the specified names. // // - source - Accepts source databases for a blue/green deployment. The results // list only includes information about the blue/green deployments with the // specified source databases. // // - target - Accepts target databases for a blue/green deployment. The results // list only includes information about the blue/green deployments with the // specified target databases. Filters []types.Filter // An optional pagination token provided by a previous DescribeBlueGreenDeployments // request. If you specify this parameter, the response only includes records // beyond the marker, up to the value specified by MaxRecords . Marker *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: // // - Must be a minimum of 20. // // - Can't exceed 100. MaxRecords *int32 // contains filtered or unexported fields }
type DescribeBlueGreenDeploymentsOutput ¶ added in v1.31.0
type DescribeBlueGreenDeploymentsOutput struct { // A list of blue/green deployments in the current account and Amazon Web Services // Region. BlueGreenDeployments []types.BlueGreenDeployment // A pagination token that can be used in a later DescribeBlueGreenDeployments // request. Marker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeBlueGreenDeploymentsPaginator ¶ added in v1.31.0
type DescribeBlueGreenDeploymentsPaginator struct {
// contains filtered or unexported fields
}
DescribeBlueGreenDeploymentsPaginator is a paginator for DescribeBlueGreenDeployments
func NewDescribeBlueGreenDeploymentsPaginator ¶ added in v1.31.0
func NewDescribeBlueGreenDeploymentsPaginator(client DescribeBlueGreenDeploymentsAPIClient, params *DescribeBlueGreenDeploymentsInput, optFns ...func(*DescribeBlueGreenDeploymentsPaginatorOptions)) *DescribeBlueGreenDeploymentsPaginator
NewDescribeBlueGreenDeploymentsPaginator returns a new DescribeBlueGreenDeploymentsPaginator
func (*DescribeBlueGreenDeploymentsPaginator) HasMorePages ¶ added in v1.31.0
func (p *DescribeBlueGreenDeploymentsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeBlueGreenDeploymentsPaginator) NextPage ¶ added in v1.31.0
func (p *DescribeBlueGreenDeploymentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeBlueGreenDeploymentsOutput, error)
NextPage retrieves the next DescribeBlueGreenDeployments page.
type DescribeBlueGreenDeploymentsPaginatorOptions ¶ added in v1.31.0
type DescribeBlueGreenDeploymentsPaginatorOptions struct { // 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: // // - Must be a minimum of 20. // // - Can't exceed 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeBlueGreenDeploymentsPaginatorOptions is the paginator options for DescribeBlueGreenDeployments
type DescribeCertificatesAPIClient ¶ added in v0.30.0
type DescribeCertificatesAPIClient interface {
DescribeCertificates(context.Context, *DescribeCertificatesInput, ...func(*Options)) (*DescribeCertificatesOutput, error)
}
DescribeCertificatesAPIClient is a client that implements the DescribeCertificates operation.
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 // This parameter isn't currently supported. Filters []types.Filter // 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 // 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 *int32 // contains filtered or unexported fields }
type DescribeCertificatesOutput ¶
type DescribeCertificatesOutput struct { // The list of Certificate objects for the Amazon Web Services account. Certificates []types.Certificate // The default root CA for new databases created by your Amazon Web Services // account. This is either the root CA override set on your Amazon Web Services // account or the system default CA for the Region if no override exists. To // override the default CA, use the ModifyCertificates operation. DefaultCertificateForNewLaunches *string // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Data returned by the DescribeCertificates action.
type DescribeCertificatesPaginator ¶ added in v0.30.0
type DescribeCertificatesPaginator struct {
// contains filtered or unexported fields
}
DescribeCertificatesPaginator is a paginator for DescribeCertificates
func NewDescribeCertificatesPaginator ¶ added in v0.30.0
func NewDescribeCertificatesPaginator(client DescribeCertificatesAPIClient, params *DescribeCertificatesInput, optFns ...func(*DescribeCertificatesPaginatorOptions)) *DescribeCertificatesPaginator
NewDescribeCertificatesPaginator returns a new DescribeCertificatesPaginator
func (*DescribeCertificatesPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeCertificatesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeCertificatesPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeCertificatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeCertificatesOutput, error)
NextPage retrieves the next DescribeCertificates page.
type DescribeCertificatesPaginatorOptions ¶ added in v0.30.0
type DescribeCertificatesPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeCertificatesPaginatorOptions is the paginator options for DescribeCertificates
type DescribeDBClusterAutomatedBackupsAPIClient ¶ added in v1.53.0
type DescribeDBClusterAutomatedBackupsAPIClient interface {
DescribeDBClusterAutomatedBackups(context.Context, *DescribeDBClusterAutomatedBackupsInput, ...func(*Options)) (*DescribeDBClusterAutomatedBackupsOutput, error)
}
DescribeDBClusterAutomatedBackupsAPIClient is a client that implements the DescribeDBClusterAutomatedBackups operation.
type DescribeDBClusterAutomatedBackupsInput ¶ added in v1.50.0
type DescribeDBClusterAutomatedBackupsInput struct { // (Optional) The user-supplied DB cluster identifier. If this parameter is // specified, it must match the identifier of an existing DB cluster. It returns // information from the specific DB cluster's automated backup. This parameter // isn't case-sensitive. DBClusterIdentifier *string // The resource ID of the DB cluster that is the source of the automated backup. // This parameter isn't case-sensitive. DbClusterResourceId *string // A filter that specifies which resources to return based on status. // // Supported filters are the following: // // - status // // - retained - Automated backups for deleted clusters and after backup // replication is stopped. // // - db-cluster-id - Accepts DB cluster identifiers and Amazon Resource Names // (ARNs). The results list includes only information about the DB cluster // automated backups identified by these ARNs. // // - db-cluster-resource-id - Accepts DB resource identifiers and Amazon Resource // Names (ARNs). The results list includes only information about the DB cluster // resources identified by these ARNs. // // Returns all resources by default. The status for each resource is specified in // the response. Filters []types.Filter // 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 // 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 *int32 // contains filtered or unexported fields }
type DescribeDBClusterAutomatedBackupsOutput ¶ added in v1.50.0
type DescribeDBClusterAutomatedBackupsOutput struct { // A list of DBClusterAutomatedBackup backups. DBClusterAutomatedBackups []types.DBClusterAutomatedBackup // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeDBClusterAutomatedBackupsPaginator ¶ added in v1.53.0
type DescribeDBClusterAutomatedBackupsPaginator struct {
// contains filtered or unexported fields
}
DescribeDBClusterAutomatedBackupsPaginator is a paginator for DescribeDBClusterAutomatedBackups
func NewDescribeDBClusterAutomatedBackupsPaginator ¶ added in v1.53.0
func NewDescribeDBClusterAutomatedBackupsPaginator(client DescribeDBClusterAutomatedBackupsAPIClient, params *DescribeDBClusterAutomatedBackupsInput, optFns ...func(*DescribeDBClusterAutomatedBackupsPaginatorOptions)) *DescribeDBClusterAutomatedBackupsPaginator
NewDescribeDBClusterAutomatedBackupsPaginator returns a new DescribeDBClusterAutomatedBackupsPaginator
func (*DescribeDBClusterAutomatedBackupsPaginator) HasMorePages ¶ added in v1.53.0
func (p *DescribeDBClusterAutomatedBackupsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBClusterAutomatedBackupsPaginator) NextPage ¶ added in v1.53.0
func (p *DescribeDBClusterAutomatedBackupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBClusterAutomatedBackupsOutput, error)
NextPage retrieves the next DescribeDBClusterAutomatedBackups page.
type DescribeDBClusterAutomatedBackupsPaginatorOptions ¶ added in v1.53.0
type DescribeDBClusterAutomatedBackupsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBClusterAutomatedBackupsPaginatorOptions is the paginator options for DescribeDBClusterAutomatedBackups
type DescribeDBClusterBacktracksAPIClient ¶ added in v0.30.0
type DescribeDBClusterBacktracksAPIClient interface {
DescribeDBClusterBacktracks(context.Context, *DescribeDBClusterBacktracksInput, ...func(*Options)) (*DescribeDBClusterBacktracksOutput, error)
}
DescribeDBClusterBacktracksAPIClient is a client that implements the DescribeDBClusterBacktracks operation.
type DescribeDBClusterBacktracksInput ¶
type DescribeDBClusterBacktracksInput struct { // 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 // // This member is required. DBClusterIdentifier *string // 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 [Universally unique identifier]. // // Example: 123e4567-e89b-12d3-a456-426655440000 // // [Universally unique identifier]: https://en.wikipedia.org/wiki/Universally_unique_identifier BacktrackIdentifier *string // 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 []types.Filter // 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 // 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 *int32 // contains filtered or unexported fields }
type DescribeDBClusterBacktracksOutput ¶
type DescribeDBClusterBacktracksOutput struct { // Contains a list of backtracks for the user. DBClusterBacktracks []types.DBClusterBacktrack // A pagination token that can be used in a later DescribeDBClusterBacktracks // request. Marker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.
type DescribeDBClusterBacktracksPaginator ¶ added in v0.30.0
type DescribeDBClusterBacktracksPaginator struct {
// contains filtered or unexported fields
}
DescribeDBClusterBacktracksPaginator is a paginator for DescribeDBClusterBacktracks
func NewDescribeDBClusterBacktracksPaginator ¶ added in v0.30.0
func NewDescribeDBClusterBacktracksPaginator(client DescribeDBClusterBacktracksAPIClient, params *DescribeDBClusterBacktracksInput, optFns ...func(*DescribeDBClusterBacktracksPaginatorOptions)) *DescribeDBClusterBacktracksPaginator
NewDescribeDBClusterBacktracksPaginator returns a new DescribeDBClusterBacktracksPaginator
func (*DescribeDBClusterBacktracksPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeDBClusterBacktracksPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBClusterBacktracksPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeDBClusterBacktracksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBClusterBacktracksOutput, error)
NextPage retrieves the next DescribeDBClusterBacktracks page.
type DescribeDBClusterBacktracksPaginatorOptions ¶ added in v0.30.0
type DescribeDBClusterBacktracksPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBClusterBacktracksPaginatorOptions is the paginator options for DescribeDBClusterBacktracks
type DescribeDBClusterEndpointsAPIClient ¶ added in v0.30.0
type DescribeDBClusterEndpointsAPIClient interface {
DescribeDBClusterEndpoints(context.Context, *DescribeDBClusterEndpointsInput, ...func(*Options)) (*DescribeDBClusterEndpointsOutput, error)
}
DescribeDBClusterEndpointsAPIClient is a client that implements the DescribeDBClusterEndpoints operation.
type DescribeDBClusterEndpointsInput ¶
type DescribeDBClusterEndpointsInput struct { // The identifier of the endpoint to describe. This parameter is stored as a // lowercase string. DBClusterEndpointIdentifier *string // The DB cluster identifier of the DB cluster associated with the endpoint. This // parameter is stored as a lowercase string. DBClusterIdentifier *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 []types.Filter // 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 // 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 *int32 // contains filtered or unexported fields }
type DescribeDBClusterEndpointsOutput ¶
type DescribeDBClusterEndpointsOutput struct { // Contains the details of the endpoints associated with the cluster and matching // any filter conditions. DBClusterEndpoints []types.DBClusterEndpoint // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeDBClusterEndpointsPaginator ¶ added in v0.30.0
type DescribeDBClusterEndpointsPaginator struct {
// contains filtered or unexported fields
}
DescribeDBClusterEndpointsPaginator is a paginator for DescribeDBClusterEndpoints
func NewDescribeDBClusterEndpointsPaginator ¶ added in v0.30.0
func NewDescribeDBClusterEndpointsPaginator(client DescribeDBClusterEndpointsAPIClient, params *DescribeDBClusterEndpointsInput, optFns ...func(*DescribeDBClusterEndpointsPaginatorOptions)) *DescribeDBClusterEndpointsPaginator
NewDescribeDBClusterEndpointsPaginator returns a new DescribeDBClusterEndpointsPaginator
func (*DescribeDBClusterEndpointsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeDBClusterEndpointsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBClusterEndpointsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeDBClusterEndpointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBClusterEndpointsOutput, error)
NextPage retrieves the next DescribeDBClusterEndpoints page.
type DescribeDBClusterEndpointsPaginatorOptions ¶ added in v0.30.0
type DescribeDBClusterEndpointsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBClusterEndpointsPaginatorOptions is the paginator options for DescribeDBClusterEndpoints
type DescribeDBClusterParameterGroupsAPIClient ¶ added in v0.30.0
type DescribeDBClusterParameterGroupsAPIClient interface {
DescribeDBClusterParameterGroups(context.Context, *DescribeDBClusterParameterGroupsInput, ...func(*Options)) (*DescribeDBClusterParameterGroupsOutput, error)
}
DescribeDBClusterParameterGroupsAPIClient is a client that implements the DescribeDBClusterParameterGroups operation.
type DescribeDBClusterParameterGroupsInput ¶
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 // This parameter isn't currently supported. Filters []types.Filter // 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 // 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 *int32 // contains filtered or unexported fields }
type DescribeDBClusterParameterGroupsOutput ¶
type DescribeDBClusterParameterGroupsOutput struct { // A list of DB cluster parameter groups. DBClusterParameterGroups []types.DBClusterParameterGroup // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeDBClusterParameterGroupsPaginator ¶ added in v0.30.0
type DescribeDBClusterParameterGroupsPaginator struct {
// contains filtered or unexported fields
}
DescribeDBClusterParameterGroupsPaginator is a paginator for DescribeDBClusterParameterGroups
func NewDescribeDBClusterParameterGroupsPaginator ¶ added in v0.30.0
func NewDescribeDBClusterParameterGroupsPaginator(client DescribeDBClusterParameterGroupsAPIClient, params *DescribeDBClusterParameterGroupsInput, optFns ...func(*DescribeDBClusterParameterGroupsPaginatorOptions)) *DescribeDBClusterParameterGroupsPaginator
NewDescribeDBClusterParameterGroupsPaginator returns a new DescribeDBClusterParameterGroupsPaginator
func (*DescribeDBClusterParameterGroupsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeDBClusterParameterGroupsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBClusterParameterGroupsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeDBClusterParameterGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBClusterParameterGroupsOutput, error)
NextPage retrieves the next DescribeDBClusterParameterGroups page.
type DescribeDBClusterParameterGroupsPaginatorOptions ¶ added in v0.30.0
type DescribeDBClusterParameterGroupsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBClusterParameterGroupsPaginatorOptions is the paginator options for DescribeDBClusterParameterGroups
type DescribeDBClusterParametersAPIClient ¶ added in v0.30.0
type DescribeDBClusterParametersAPIClient interface {
DescribeDBClusterParameters(context.Context, *DescribeDBClusterParametersInput, ...func(*Options)) (*DescribeDBClusterParametersOutput, error)
}
DescribeDBClusterParametersAPIClient is a client that implements the DescribeDBClusterParameters operation.
type DescribeDBClusterParametersInput ¶
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. // // This member is required. DBClusterParameterGroupName *string // A filter that specifies one or more DB cluster parameters to describe. // // The only supported filter is parameter-name . The results list only includes // information about the DB cluster parameters with these names. Filters []types.Filter // 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 // 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 *int32 // A specific source to return parameters for. // // Valid Values: // // - engine-default // // - system // // - user Source *string // contains filtered or unexported fields }
type DescribeDBClusterParametersOutput ¶
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 // Provides a list of parameters for the DB cluster parameter group. Parameters []types.Parameter // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.
type DescribeDBClusterParametersPaginator ¶ added in v0.30.0
type DescribeDBClusterParametersPaginator struct {
// contains filtered or unexported fields
}
DescribeDBClusterParametersPaginator is a paginator for DescribeDBClusterParameters
func NewDescribeDBClusterParametersPaginator ¶ added in v0.30.0
func NewDescribeDBClusterParametersPaginator(client DescribeDBClusterParametersAPIClient, params *DescribeDBClusterParametersInput, optFns ...func(*DescribeDBClusterParametersPaginatorOptions)) *DescribeDBClusterParametersPaginator
NewDescribeDBClusterParametersPaginator returns a new DescribeDBClusterParametersPaginator
func (*DescribeDBClusterParametersPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeDBClusterParametersPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBClusterParametersPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeDBClusterParametersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBClusterParametersOutput, error)
NextPage retrieves the next DescribeDBClusterParameters page.
type DescribeDBClusterParametersPaginatorOptions ¶ added in v0.30.0
type DescribeDBClusterParametersPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBClusterParametersPaginatorOptions is the paginator options for DescribeDBClusterParameters
type DescribeDBClusterSnapshotAttributesInput ¶
type DescribeDBClusterSnapshotAttributesInput struct { // The identifier for the DB cluster snapshot to describe the attributes for. // // This member is required. DBClusterSnapshotIdentifier *string // contains filtered or unexported fields }
type DescribeDBClusterSnapshotAttributesOutput ¶
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 *types.DBClusterSnapshotAttributesResult // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeDBClusterSnapshotsAPIClient ¶ added in v0.30.0
type DescribeDBClusterSnapshotsAPIClient interface {
DescribeDBClusterSnapshots(context.Context, *DescribeDBClusterSnapshotsInput, ...func(*Options)) (*DescribeDBClusterSnapshotsOutput, error)
}
DescribeDBClusterSnapshotsAPIClient is a client that implements the DescribeDBClusterSnapshots operation.
type DescribeDBClusterSnapshotsInput ¶
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 // 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 // A specific DB cluster resource ID to describe. DbClusterResourceId *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 []types.Filter // Specifies 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 // 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 // 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 // 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 *int32 // 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 // contains filtered or unexported fields }
type DescribeDBClusterSnapshotsOutput ¶
type DescribeDBClusterSnapshotsOutput struct { // Provides a list of DB cluster snapshots for the user. DBClusterSnapshots []types.DBClusterSnapshot // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // 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.
type DescribeDBClusterSnapshotsPaginator ¶ added in v0.30.0
type DescribeDBClusterSnapshotsPaginator struct {
// contains filtered or unexported fields
}
DescribeDBClusterSnapshotsPaginator is a paginator for DescribeDBClusterSnapshots
func NewDescribeDBClusterSnapshotsPaginator ¶ added in v0.30.0
func NewDescribeDBClusterSnapshotsPaginator(client DescribeDBClusterSnapshotsAPIClient, params *DescribeDBClusterSnapshotsInput, optFns ...func(*DescribeDBClusterSnapshotsPaginatorOptions)) *DescribeDBClusterSnapshotsPaginator
NewDescribeDBClusterSnapshotsPaginator returns a new DescribeDBClusterSnapshotsPaginator
func (*DescribeDBClusterSnapshotsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeDBClusterSnapshotsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBClusterSnapshotsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeDBClusterSnapshotsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBClusterSnapshotsOutput, error)
NextPage retrieves the next DescribeDBClusterSnapshots page.
type DescribeDBClusterSnapshotsPaginatorOptions ¶ added in v0.30.0
type DescribeDBClusterSnapshotsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBClusterSnapshotsPaginatorOptions is the paginator options for DescribeDBClusterSnapshots
type DescribeDBClustersAPIClient ¶ added in v0.30.0
type DescribeDBClustersAPIClient interface {
DescribeDBClusters(context.Context, *DescribeDBClustersInput, ...func(*Options)) (*DescribeDBClustersOutput, error)
}
DescribeDBClustersAPIClient is a client that implements the DescribeDBClusters operation.
type DescribeDBClustersInput ¶
type DescribeDBClustersInput struct { // The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of // the DB cluster. If this parameter is specified, information for only the // specific DB cluster is returned. This parameter isn't case-sensitive. // // Constraints: // // - If supplied, must match an existing DB cluster identifier. DBClusterIdentifier *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. // // - db-cluster-resource-id - Accepts DB cluster resource identifiers. The // results list will only include information about the DB clusters identified by // these DB cluster resource identifiers. // // - 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 []types.Filter // other Amazon Web Services accounts. IncludeShared *bool // 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 // 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 *int32 // contains filtered or unexported fields }
type DescribeDBClustersOutput ¶
type DescribeDBClustersOutput struct { // Contains a list of DB clusters for the user. DBClusters []types.DBCluster // A pagination token that can be used in a later DescribeDBClusters request. Marker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the result of a successful invocation of the DescribeDBClusters action.
type DescribeDBClustersPaginator ¶ added in v0.30.0
type DescribeDBClustersPaginator struct {
// contains filtered or unexported fields
}
DescribeDBClustersPaginator is a paginator for DescribeDBClusters
func NewDescribeDBClustersPaginator ¶ added in v0.30.0
func NewDescribeDBClustersPaginator(client DescribeDBClustersAPIClient, params *DescribeDBClustersInput, optFns ...func(*DescribeDBClustersPaginatorOptions)) *DescribeDBClustersPaginator
NewDescribeDBClustersPaginator returns a new DescribeDBClustersPaginator
func (*DescribeDBClustersPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeDBClustersPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBClustersPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeDBClustersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBClustersOutput, error)
NextPage retrieves the next DescribeDBClusters page.
type DescribeDBClustersPaginatorOptions ¶ added in v0.30.0
type DescribeDBClustersPaginatorOptions struct { // 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 Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBClustersPaginatorOptions is the paginator options for DescribeDBClusters
type DescribeDBEngineVersionsAPIClient ¶ added in v0.30.0
type DescribeDBEngineVersionsAPIClient interface {
DescribeDBEngineVersions(context.Context, *DescribeDBEngineVersionsInput, ...func(*Options)) (*DescribeDBEngineVersionsOutput, error)
}
DescribeDBEngineVersionsAPIClient is a client that implements the DescribeDBEngineVersions operation.
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 DB parameter group family. DBParameterGroupFamily *string // Specifies whether to return only the default version of the specified engine or // the engine and major version combination. DefaultOnly *bool // The database engine to return version details for. // // Valid Values: // // - aurora-mysql // // - aurora-postgresql // // - custom-oracle-ee // // - custom-oracle-ee-cdb // // - custom-oracle-se2 // // - custom-oracle-se2-cdb // // - db2-ae // // - db2-se // // - mariadb // // - mysql // // - oracle-ee // // - oracle-ee-cdb // // - oracle-se2 // // - oracle-se2-cdb // // - postgres // // - sqlserver-ee // // - sqlserver-se // // - sqlserver-ex // // - sqlserver-web Engine *string // A specific database engine version to return details for. // // Example: 5.1.49 EngineVersion *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 []types.Filter // Specifies whether to also list the engine versions that aren't available. The // default is to list only available engine versions. IncludeAll *bool // Specifies 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 // enable this parameter, RDS Custom returns no results. ListSupportedCharacterSets *bool // Specifies 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 enable // this parameter, RDS Custom returns no results. ListSupportedTimezones *bool // 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 // 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 *int32 // contains filtered or unexported fields }
type DescribeDBEngineVersionsOutput ¶
type DescribeDBEngineVersionsOutput struct { // A list of DBEngineVersion elements. DBEngineVersions []types.DBEngineVersion // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the result of a successful invocation of the DescribeDBEngineVersions action.
type DescribeDBEngineVersionsPaginator ¶ added in v0.30.0
type DescribeDBEngineVersionsPaginator struct {
// contains filtered or unexported fields
}
DescribeDBEngineVersionsPaginator is a paginator for DescribeDBEngineVersions
func NewDescribeDBEngineVersionsPaginator ¶ added in v0.30.0
func NewDescribeDBEngineVersionsPaginator(client DescribeDBEngineVersionsAPIClient, params *DescribeDBEngineVersionsInput, optFns ...func(*DescribeDBEngineVersionsPaginatorOptions)) *DescribeDBEngineVersionsPaginator
NewDescribeDBEngineVersionsPaginator returns a new DescribeDBEngineVersionsPaginator
func (*DescribeDBEngineVersionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeDBEngineVersionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBEngineVersionsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeDBEngineVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBEngineVersionsOutput, error)
NextPage retrieves the next DescribeDBEngineVersions page.
type DescribeDBEngineVersionsPaginatorOptions ¶ added in v0.30.0
type DescribeDBEngineVersionsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBEngineVersionsPaginatorOptions is the paginator options for DescribeDBEngineVersions
type DescribeDBInstanceAutomatedBackupsAPIClient ¶ added in v0.30.0
type DescribeDBInstanceAutomatedBackupsAPIClient interface {
DescribeDBInstanceAutomatedBackups(context.Context, *DescribeDBInstanceAutomatedBackupsInput, ...func(*Options)) (*DescribeDBInstanceAutomatedBackupsOutput, error)
}
DescribeDBInstanceAutomatedBackupsAPIClient is a client that implements the DescribeDBInstanceAutomatedBackups operation.
type DescribeDBInstanceAutomatedBackupsInput ¶
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 // (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's automated backup. This parameter // isn't case-sensitive. DBInstanceIdentifier *string // The resource ID of the DB instance that is the source of the automated backup. // This parameter isn't case-sensitive. DbiResourceId *string // A filter that specifies which resources to return based on status. // // Supported filters are the following: // // - status // // - active - Automated backups for current instances. // // - creating - Automated backups that are waiting for the first automated // snapshot to be available. // // - retained - Automated backups for deleted instances and after backup // replication is stopped. // // - 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 []types.Filter // 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 // 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 *int32 // contains filtered or unexported fields }
Parameter input for DescribeDBInstanceAutomatedBackups.
type DescribeDBInstanceAutomatedBackupsOutput ¶
type DescribeDBInstanceAutomatedBackupsOutput struct { // A list of DBInstanceAutomatedBackup instances. DBInstanceAutomatedBackups []types.DBInstanceAutomatedBackup // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.
type DescribeDBInstanceAutomatedBackupsPaginator ¶ added in v0.30.0
type DescribeDBInstanceAutomatedBackupsPaginator struct {
// contains filtered or unexported fields
}
DescribeDBInstanceAutomatedBackupsPaginator is a paginator for DescribeDBInstanceAutomatedBackups
func NewDescribeDBInstanceAutomatedBackupsPaginator ¶ added in v0.30.0
func NewDescribeDBInstanceAutomatedBackupsPaginator(client DescribeDBInstanceAutomatedBackupsAPIClient, params *DescribeDBInstanceAutomatedBackupsInput, optFns ...func(*DescribeDBInstanceAutomatedBackupsPaginatorOptions)) *DescribeDBInstanceAutomatedBackupsPaginator
NewDescribeDBInstanceAutomatedBackupsPaginator returns a new DescribeDBInstanceAutomatedBackupsPaginator
func (*DescribeDBInstanceAutomatedBackupsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeDBInstanceAutomatedBackupsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBInstanceAutomatedBackupsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeDBInstanceAutomatedBackupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBInstanceAutomatedBackupsOutput, error)
NextPage retrieves the next DescribeDBInstanceAutomatedBackups page.
type DescribeDBInstanceAutomatedBackupsPaginatorOptions ¶ added in v0.30.0
type DescribeDBInstanceAutomatedBackupsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBInstanceAutomatedBackupsPaginatorOptions is the paginator options for DescribeDBInstanceAutomatedBackups
type DescribeDBInstancesAPIClient ¶ added in v0.30.0
type DescribeDBInstancesAPIClient interface {
DescribeDBInstances(context.Context, *DescribeDBInstancesInput, ...func(*Options)) (*DescribeDBInstancesOutput, error)
}
DescribeDBInstancesAPIClient is a client that implements the DescribeDBInstances operation.
type DescribeDBInstancesInput ¶
type DescribeDBInstancesInput struct { // The user-supplied instance identifier or the Amazon Resource Name (ARN) of the // DB instance. 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 DB instance. DBInstanceIdentifier *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 // only includes 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 []types.Filter // 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 // 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 *int32 // contains filtered or unexported fields }
type DescribeDBInstancesOutput ¶
type DescribeDBInstancesOutput struct { // A list of DBInstance instances. DBInstances []types.DBInstance // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the result of a successful invocation of the DescribeDBInstances action.
type DescribeDBInstancesPaginator ¶ added in v0.30.0
type DescribeDBInstancesPaginator struct {
// contains filtered or unexported fields
}
DescribeDBInstancesPaginator is a paginator for DescribeDBInstances
func NewDescribeDBInstancesPaginator ¶ added in v0.30.0
func NewDescribeDBInstancesPaginator(client DescribeDBInstancesAPIClient, params *DescribeDBInstancesInput, optFns ...func(*DescribeDBInstancesPaginatorOptions)) *DescribeDBInstancesPaginator
NewDescribeDBInstancesPaginator returns a new DescribeDBInstancesPaginator
func (*DescribeDBInstancesPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeDBInstancesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBInstancesPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeDBInstancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBInstancesOutput, error)
NextPage retrieves the next DescribeDBInstances page.
type DescribeDBInstancesPaginatorOptions ¶ added in v0.30.0
type DescribeDBInstancesPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBInstancesPaginatorOptions is the paginator options for DescribeDBInstances
type DescribeDBLogFilesAPIClient ¶ added in v0.30.0
type DescribeDBLogFilesAPIClient interface {
DescribeDBLogFiles(context.Context, *DescribeDBLogFilesInput, ...func(*Options)) (*DescribeDBLogFilesOutput, error)
}
DescribeDBLogFilesAPIClient is a client that implements the DescribeDBLogFiles operation.
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. // // This member is required. DBInstanceIdentifier *string // Filters the available log files for files written since the specified date, in // POSIX timestamp format with milliseconds. FileLastWritten *int64 // Filters the available log files for files larger than the specified size. FileSize *int64 // Filters the available log files for log file names that contain the specified // string. FilenameContains *string // This parameter isn't currently supported. Filters []types.Filter // 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 // 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 *int32 // contains filtered or unexported fields }
type DescribeDBLogFilesOutput ¶
type DescribeDBLogFilesOutput struct { // The DB log files returned. DescribeDBLogFiles []types.DescribeDBLogFilesDetails // A pagination token that can be used in a later DescribeDBLogFiles request. Marker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
The response from a call to DescribeDBLogFiles .
type DescribeDBLogFilesPaginator ¶ added in v0.30.0
type DescribeDBLogFilesPaginator struct {
// contains filtered or unexported fields
}
DescribeDBLogFilesPaginator is a paginator for DescribeDBLogFiles
func NewDescribeDBLogFilesPaginator ¶ added in v0.30.0
func NewDescribeDBLogFilesPaginator(client DescribeDBLogFilesAPIClient, params *DescribeDBLogFilesInput, optFns ...func(*DescribeDBLogFilesPaginatorOptions)) *DescribeDBLogFilesPaginator
NewDescribeDBLogFilesPaginator returns a new DescribeDBLogFilesPaginator
func (*DescribeDBLogFilesPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeDBLogFilesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBLogFilesPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeDBLogFilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBLogFilesOutput, error)
NextPage retrieves the next DescribeDBLogFiles page.
type DescribeDBLogFilesPaginatorOptions ¶ added in v0.30.0
type DescribeDBLogFilesPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBLogFilesPaginatorOptions is the paginator options for DescribeDBLogFiles
type DescribeDBParameterGroupsAPIClient ¶ added in v0.30.0
type DescribeDBParameterGroupsAPIClient interface {
DescribeDBParameterGroups(context.Context, *DescribeDBParameterGroupsInput, ...func(*Options)) (*DescribeDBParameterGroupsOutput, error)
}
DescribeDBParameterGroupsAPIClient is a client that implements the DescribeDBParameterGroups operation.
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 // This parameter isn't currently supported. Filters []types.Filter // 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 // 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 *int32 // contains filtered or unexported fields }
type DescribeDBParameterGroupsOutput ¶
type DescribeDBParameterGroupsOutput struct { // A list of DBParameterGroup instances. DBParameterGroups []types.DBParameterGroup // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the result of a successful invocation of the DescribeDBParameterGroups action.
type DescribeDBParameterGroupsPaginator ¶ added in v0.30.0
type DescribeDBParameterGroupsPaginator struct {
// contains filtered or unexported fields
}
DescribeDBParameterGroupsPaginator is a paginator for DescribeDBParameterGroups
func NewDescribeDBParameterGroupsPaginator ¶ added in v0.30.0
func NewDescribeDBParameterGroupsPaginator(client DescribeDBParameterGroupsAPIClient, params *DescribeDBParameterGroupsInput, optFns ...func(*DescribeDBParameterGroupsPaginatorOptions)) *DescribeDBParameterGroupsPaginator
NewDescribeDBParameterGroupsPaginator returns a new DescribeDBParameterGroupsPaginator
func (*DescribeDBParameterGroupsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeDBParameterGroupsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBParameterGroupsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeDBParameterGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBParameterGroupsOutput, error)
NextPage retrieves the next DescribeDBParameterGroups page.
type DescribeDBParameterGroupsPaginatorOptions ¶ added in v0.30.0
type DescribeDBParameterGroupsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBParameterGroupsPaginatorOptions is the paginator options for DescribeDBParameterGroups
type DescribeDBParametersAPIClient ¶ added in v0.30.0
type DescribeDBParametersAPIClient interface {
DescribeDBParameters(context.Context, *DescribeDBParametersInput, ...func(*Options)) (*DescribeDBParametersOutput, error)
}
DescribeDBParametersAPIClient is a client that implements the DescribeDBParameters operation.
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. // // This member is required. DBParameterGroupName *string // A filter that specifies one or more DB parameters to describe. // // The only supported filter is parameter-name . The results list only includes // information about the DB parameters with these names. Filters []types.Filter // 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 // 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 *int32 // The parameter types to return. // // Default: All parameter types returned // // Valid Values: user | system | engine-default Source *string // contains filtered or unexported fields }
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 // A list of Parameter values. Parameters []types.Parameter // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the result of a successful invocation of the DescribeDBParameters action.
type DescribeDBParametersPaginator ¶ added in v0.30.0
type DescribeDBParametersPaginator struct {
// contains filtered or unexported fields
}
DescribeDBParametersPaginator is a paginator for DescribeDBParameters
func NewDescribeDBParametersPaginator ¶ added in v0.30.0
func NewDescribeDBParametersPaginator(client DescribeDBParametersAPIClient, params *DescribeDBParametersInput, optFns ...func(*DescribeDBParametersPaginatorOptions)) *DescribeDBParametersPaginator
NewDescribeDBParametersPaginator returns a new DescribeDBParametersPaginator
func (*DescribeDBParametersPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeDBParametersPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBParametersPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeDBParametersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBParametersOutput, error)
NextPage retrieves the next DescribeDBParameters page.
type DescribeDBParametersPaginatorOptions ¶ added in v0.30.0
type DescribeDBParametersPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBParametersPaginatorOptions is the paginator options for DescribeDBParameters
type DescribeDBProxiesAPIClient ¶ added in v0.30.0
type DescribeDBProxiesAPIClient interface {
DescribeDBProxies(context.Context, *DescribeDBProxiesInput, ...func(*Options)) (*DescribeDBProxiesOutput, error)
}
DescribeDBProxiesAPIClient is a client that implements the DescribeDBProxies operation.
type DescribeDBProxiesInput ¶
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 // This parameter is not currently supported. Filters []types.Filter // 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 // 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 *int32 // contains filtered or unexported fields }
type DescribeDBProxiesOutput ¶
type DescribeDBProxiesOutput struct { // A return value representing an arbitrary number of DBProxy data structures. DBProxies []types.DBProxy // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeDBProxiesPaginator ¶ added in v0.30.0
type DescribeDBProxiesPaginator struct {
// contains filtered or unexported fields
}
DescribeDBProxiesPaginator is a paginator for DescribeDBProxies
func NewDescribeDBProxiesPaginator ¶ added in v0.30.0
func NewDescribeDBProxiesPaginator(client DescribeDBProxiesAPIClient, params *DescribeDBProxiesInput, optFns ...func(*DescribeDBProxiesPaginatorOptions)) *DescribeDBProxiesPaginator
NewDescribeDBProxiesPaginator returns a new DescribeDBProxiesPaginator
func (*DescribeDBProxiesPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeDBProxiesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBProxiesPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeDBProxiesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBProxiesOutput, error)
NextPage retrieves the next DescribeDBProxies page.
type DescribeDBProxiesPaginatorOptions ¶ added in v0.30.0
type DescribeDBProxiesPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBProxiesPaginatorOptions is the paginator options for DescribeDBProxies
type DescribeDBProxyEndpointsAPIClient ¶ added in v1.2.0
type DescribeDBProxyEndpointsAPIClient interface {
DescribeDBProxyEndpoints(context.Context, *DescribeDBProxyEndpointsInput, ...func(*Options)) (*DescribeDBProxyEndpointsOutput, error)
}
DescribeDBProxyEndpointsAPIClient is a client that implements the DescribeDBProxyEndpoints operation.
type DescribeDBProxyEndpointsInput ¶ added in v1.2.0
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 // 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 // This parameter is not currently supported. Filters []types.Filter // 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 // 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 *int32 // contains filtered or unexported fields }
type DescribeDBProxyEndpointsOutput ¶ added in v1.2.0
type DescribeDBProxyEndpointsOutput struct { // The list of ProxyEndpoint objects returned by the API operation. DBProxyEndpoints []types.DBProxyEndpoint // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeDBProxyEndpointsPaginator ¶ added in v1.2.0
type DescribeDBProxyEndpointsPaginator struct {
// contains filtered or unexported fields
}
DescribeDBProxyEndpointsPaginator is a paginator for DescribeDBProxyEndpoints
func NewDescribeDBProxyEndpointsPaginator ¶ added in v1.2.0
func NewDescribeDBProxyEndpointsPaginator(client DescribeDBProxyEndpointsAPIClient, params *DescribeDBProxyEndpointsInput, optFns ...func(*DescribeDBProxyEndpointsPaginatorOptions)) *DescribeDBProxyEndpointsPaginator
NewDescribeDBProxyEndpointsPaginator returns a new DescribeDBProxyEndpointsPaginator
func (*DescribeDBProxyEndpointsPaginator) HasMorePages ¶ added in v1.2.0
func (p *DescribeDBProxyEndpointsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBProxyEndpointsPaginator) NextPage ¶ added in v1.2.0
func (p *DescribeDBProxyEndpointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBProxyEndpointsOutput, error)
NextPage retrieves the next DescribeDBProxyEndpoints page.
type DescribeDBProxyEndpointsPaginatorOptions ¶ added in v1.2.0
type DescribeDBProxyEndpointsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBProxyEndpointsPaginatorOptions is the paginator options for DescribeDBProxyEndpoints
type DescribeDBProxyTargetGroupsAPIClient ¶ added in v0.30.0
type DescribeDBProxyTargetGroupsAPIClient interface {
DescribeDBProxyTargetGroups(context.Context, *DescribeDBProxyTargetGroupsInput, ...func(*Options)) (*DescribeDBProxyTargetGroupsOutput, error)
}
DescribeDBProxyTargetGroupsAPIClient is a client that implements the DescribeDBProxyTargetGroups operation.
type DescribeDBProxyTargetGroupsInput ¶
type DescribeDBProxyTargetGroupsInput struct { // The identifier of the DBProxy associated with the target group. // // This member is required. DBProxyName *string // This parameter is not currently supported. Filters []types.Filter // 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 // 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 *int32 // The identifier of the DBProxyTargetGroup to describe. TargetGroupName *string // contains filtered or unexported fields }
type DescribeDBProxyTargetGroupsOutput ¶
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 // An arbitrary number of DBProxyTargetGroup objects, containing details of the // corresponding target groups. TargetGroups []types.DBProxyTargetGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeDBProxyTargetGroupsPaginator ¶ added in v0.30.0
type DescribeDBProxyTargetGroupsPaginator struct {
// contains filtered or unexported fields
}
DescribeDBProxyTargetGroupsPaginator is a paginator for DescribeDBProxyTargetGroups
func NewDescribeDBProxyTargetGroupsPaginator ¶ added in v0.30.0
func NewDescribeDBProxyTargetGroupsPaginator(client DescribeDBProxyTargetGroupsAPIClient, params *DescribeDBProxyTargetGroupsInput, optFns ...func(*DescribeDBProxyTargetGroupsPaginatorOptions)) *DescribeDBProxyTargetGroupsPaginator
NewDescribeDBProxyTargetGroupsPaginator returns a new DescribeDBProxyTargetGroupsPaginator
func (*DescribeDBProxyTargetGroupsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeDBProxyTargetGroupsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBProxyTargetGroupsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeDBProxyTargetGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBProxyTargetGroupsOutput, error)
NextPage retrieves the next DescribeDBProxyTargetGroups page.
type DescribeDBProxyTargetGroupsPaginatorOptions ¶ added in v0.30.0
type DescribeDBProxyTargetGroupsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBProxyTargetGroupsPaginatorOptions is the paginator options for DescribeDBProxyTargetGroups
type DescribeDBProxyTargetsAPIClient ¶ added in v0.30.0
type DescribeDBProxyTargetsAPIClient interface {
DescribeDBProxyTargets(context.Context, *DescribeDBProxyTargetsInput, ...func(*Options)) (*DescribeDBProxyTargetsOutput, error)
}
DescribeDBProxyTargetsAPIClient is a client that implements the DescribeDBProxyTargets operation.
type DescribeDBProxyTargetsInput ¶
type DescribeDBProxyTargetsInput struct { // The identifier of the DBProxyTarget to describe. // // This member is required. DBProxyName *string // This parameter is not currently supported. Filters []types.Filter // 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 // 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 *int32 // The identifier of the DBProxyTargetGroup to describe. TargetGroupName *string // contains filtered or unexported fields }
type DescribeDBProxyTargetsOutput ¶
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 // An arbitrary number of DBProxyTarget objects, containing details of the // corresponding targets. Targets []types.DBProxyTarget // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeDBProxyTargetsPaginator ¶ added in v0.30.0
type DescribeDBProxyTargetsPaginator struct {
// contains filtered or unexported fields
}
DescribeDBProxyTargetsPaginator is a paginator for DescribeDBProxyTargets
func NewDescribeDBProxyTargetsPaginator ¶ added in v0.30.0
func NewDescribeDBProxyTargetsPaginator(client DescribeDBProxyTargetsAPIClient, params *DescribeDBProxyTargetsInput, optFns ...func(*DescribeDBProxyTargetsPaginatorOptions)) *DescribeDBProxyTargetsPaginator
NewDescribeDBProxyTargetsPaginator returns a new DescribeDBProxyTargetsPaginator
func (*DescribeDBProxyTargetsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeDBProxyTargetsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBProxyTargetsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeDBProxyTargetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBProxyTargetsOutput, error)
NextPage retrieves the next DescribeDBProxyTargets page.
type DescribeDBProxyTargetsPaginatorOptions ¶ added in v0.30.0
type DescribeDBProxyTargetsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBProxyTargetsPaginatorOptions is the paginator options for DescribeDBProxyTargets
type DescribeDBRecommendationsAPIClient ¶ added in v1.65.0
type DescribeDBRecommendationsAPIClient interface {
DescribeDBRecommendations(context.Context, *DescribeDBRecommendationsInput, ...func(*Options)) (*DescribeDBRecommendationsOutput, error)
}
DescribeDBRecommendationsAPIClient is a client that implements the DescribeDBRecommendations operation.
type DescribeDBRecommendationsInput ¶ added in v1.65.0
type DescribeDBRecommendationsInput struct { // A filter that specifies one or more recommendations to describe. // // Supported Filters: // // - recommendation-id - Accepts a list of recommendation identifiers. The // results list only includes the recommendations whose identifier is one of the // specified filter values. // // - status - Accepts a list of recommendation statuses. // // Valid values: // // - active - The recommendations which are ready for you to apply. // // - pending - The applied or scheduled recommendations which are in progress. // // - resolved - The recommendations which are completed. // // - dismissed - The recommendations that you dismissed. // // The results list only includes the recommendations whose status is one of the // specified filter values. // // - severity - Accepts a list of recommendation severities. The results list // only includes the recommendations whose severity is one of the specified filter // values. // // Valid values: // // - high // // - medium // // - low // // - informational // // - type-id - Accepts a list of recommendation type identifiers. The results // list only includes the recommendations whose type is one of the specified filter // values. // // - dbi-resource-id - Accepts a list of database resource identifiers. The // results list only includes the recommendations that generated for the specified // databases. // // - cluster-resource-id - Accepts a list of cluster resource identifiers. The // results list only includes the recommendations that generated for the specified // clusters. // // - pg-arn - Accepts a list of parameter group ARNs. The results list only // includes the recommendations that generated for the specified parameter groups. // // - cluster-pg-arn - Accepts a list of cluster parameter group ARNs. The results // list only includes the recommendations that generated for the specified cluster // parameter groups. Filters []types.Filter // A filter to include only the recommendations that were updated after this // specified time. LastUpdatedAfter *time.Time // A filter to include only the recommendations that were updated before this // specified time. LastUpdatedBefore *time.Time // The language that you choose to return the list of recommendations. // // Valid values: // // - en // // - en_UK // // - de // // - es // // - fr // // - id // // - it // // - ja // // - ko // // - pt_BR // // - zh_TW // // - zh_CN Locale *string // An optional pagination token provided by a previous DescribeDBRecommendations // request. If this parameter is specified, the response includes only records // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of recommendations 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 *int32 // contains filtered or unexported fields }
type DescribeDBRecommendationsOutput ¶ added in v1.65.0
type DescribeDBRecommendationsOutput struct { // A list of recommendations which is returned from DescribeDBRecommendations API // request. DBRecommendations []types.DBRecommendation // An optional pagination token provided by a previous DBRecommendationsMessage // request. This token can be used later in a DescribeDBRecomendations request. Marker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeDBRecommendationsPaginator ¶ added in v1.65.0
type DescribeDBRecommendationsPaginator struct {
// contains filtered or unexported fields
}
DescribeDBRecommendationsPaginator is a paginator for DescribeDBRecommendations
func NewDescribeDBRecommendationsPaginator ¶ added in v1.65.0
func NewDescribeDBRecommendationsPaginator(client DescribeDBRecommendationsAPIClient, params *DescribeDBRecommendationsInput, optFns ...func(*DescribeDBRecommendationsPaginatorOptions)) *DescribeDBRecommendationsPaginator
NewDescribeDBRecommendationsPaginator returns a new DescribeDBRecommendationsPaginator
func (*DescribeDBRecommendationsPaginator) HasMorePages ¶ added in v1.65.0
func (p *DescribeDBRecommendationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBRecommendationsPaginator) NextPage ¶ added in v1.65.0
func (p *DescribeDBRecommendationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBRecommendationsOutput, error)
NextPage retrieves the next DescribeDBRecommendations page.
type DescribeDBRecommendationsPaginatorOptions ¶ added in v1.65.0
type DescribeDBRecommendationsPaginatorOptions struct { // The maximum number of recommendations 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBRecommendationsPaginatorOptions is the paginator options for DescribeDBRecommendations
type DescribeDBSecurityGroupsAPIClient ¶ added in v0.30.0
type DescribeDBSecurityGroupsAPIClient interface {
DescribeDBSecurityGroups(context.Context, *DescribeDBSecurityGroupsInput, ...func(*Options)) (*DescribeDBSecurityGroupsOutput, error)
}
DescribeDBSecurityGroupsAPIClient is a client that implements the DescribeDBSecurityGroups operation.
type DescribeDBSecurityGroupsInput ¶
type DescribeDBSecurityGroupsInput struct { // The name of the DB security group to return details for. DBSecurityGroupName *string // This parameter isn't currently supported. Filters []types.Filter // 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 // 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 *int32 // contains filtered or unexported fields }
type DescribeDBSecurityGroupsOutput ¶
type DescribeDBSecurityGroupsOutput struct { // A list of DBSecurityGroup instances. DBSecurityGroups []types.DBSecurityGroup // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
type DescribeDBSecurityGroupsPaginator ¶ added in v0.30.0
type DescribeDBSecurityGroupsPaginator struct {
// contains filtered or unexported fields
}
DescribeDBSecurityGroupsPaginator is a paginator for DescribeDBSecurityGroups
func NewDescribeDBSecurityGroupsPaginator ¶ added in v0.30.0
func NewDescribeDBSecurityGroupsPaginator(client DescribeDBSecurityGroupsAPIClient, params *DescribeDBSecurityGroupsInput, optFns ...func(*DescribeDBSecurityGroupsPaginatorOptions)) *DescribeDBSecurityGroupsPaginator
NewDescribeDBSecurityGroupsPaginator returns a new DescribeDBSecurityGroupsPaginator
func (*DescribeDBSecurityGroupsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeDBSecurityGroupsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBSecurityGroupsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeDBSecurityGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBSecurityGroupsOutput, error)
NextPage retrieves the next DescribeDBSecurityGroups page.
type DescribeDBSecurityGroupsPaginatorOptions ¶ added in v0.30.0
type DescribeDBSecurityGroupsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBSecurityGroupsPaginatorOptions is the paginator options for DescribeDBSecurityGroups
type DescribeDBShardGroupsInput ¶ added in v1.68.0
type DescribeDBShardGroupsInput struct { // The user-supplied DB shard group identifier. If this parameter is specified, // information for only the specific DB shard group is returned. This parameter // isn't case-sensitive. // // Constraints: // // - If supplied, must match an existing DB shard group identifier. DBShardGroupIdentifier *string // A filter that specifies one or more DB shard groups to describe. Filters []types.Filter // An optional pagination token provided by a previous DescribeDBShardGroups // request. If this parameter is specified, the response includes only records // beyond the marker, up to the value specified by MaxRecords . Marker *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 *int32 // contains filtered or unexported fields }
type DescribeDBShardGroupsOutput ¶ added in v1.68.0
type DescribeDBShardGroupsOutput struct { // Contains a list of DB shard groups for the user. DBShardGroups []types.DBShardGroup // A pagination token that can be used in a later DescribeDBClusters request. Marker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeDBSnapshotAttributesInput ¶
type DescribeDBSnapshotAttributesInput struct { // The identifier for the DB snapshot to describe the attributes for. // // This member is required. DBSnapshotIdentifier *string // contains filtered or unexported fields }
type DescribeDBSnapshotAttributesOutput ¶
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 *types.DBSnapshotAttributesResult // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeDBSnapshotTenantDatabasesAPIClient ¶ added in v1.62.0
type DescribeDBSnapshotTenantDatabasesAPIClient interface {
DescribeDBSnapshotTenantDatabases(context.Context, *DescribeDBSnapshotTenantDatabasesInput, ...func(*Options)) (*DescribeDBSnapshotTenantDatabasesOutput, error)
}
DescribeDBSnapshotTenantDatabasesAPIClient is a client that implements the DescribeDBSnapshotTenantDatabases operation.
type DescribeDBSnapshotTenantDatabasesInput ¶ added in v1.62.0
type DescribeDBSnapshotTenantDatabasesInput struct { // The ID of the DB instance used to create the DB snapshots. This parameter isn't // case-sensitive. // // Constraints: // // - If supplied, must match the identifier of an existing DBInstance . DBInstanceIdentifier *string // The ID of a DB snapshot that contains the tenant databases to describe. This // value is stored as a lowercase string. // // Constraints: // // - If you specify this parameter, the value must match the ID of an existing // DB snapshot. // // - If you specify an automatic snapshot, you must also specify SnapshotType . DBSnapshotIdentifier *string // A specific DB resource identifier to describe. DbiResourceId *string // A filter that specifies one or more tenant databases to describe. // // Supported filters: // // - tenant-db-name - Tenant database names. The results list only includes // information about the tenant databases that match these tenant DB names. // // - tenant-database-resource-id - Tenant database resource identifiers. The // results list only includes information about the tenant databases contained // within the DB snapshots. // // - dbi-resource-id - DB instance resource identifiers. The results list only // includes information about snapshots containing tenant databases contained // within the DB instances identified by these resource identifiers. // // - db-instance-id - Accepts DB instance identifiers and DB instance Amazon // Resource Names (ARNs). // // - db-snapshot-id - Accepts DB snapshot identifiers. // // - snapshot-type - Accepts types of DB snapshots. Filters []types.Filter // An optional pagination token provided by a previous // DescribeDBSnapshotTenantDatabases request. If this parameter is specified, the // response includes only records beyond the marker, up to the value specified by // MaxRecords . Marker *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 *int32 // The type of DB snapshots to be returned. You can specify one of the following // values: // // - automated – All DB snapshots that have been automatically taken by Amazon // RDS for my Amazon Web Services account. // // - manual – All DB snapshots that have been taken by my Amazon Web Services // account. // // - shared – All manual DB snapshots that have been shared to my Amazon Web // Services account. // // - public – All DB snapshots that have been marked as public. // // - awsbackup – All DB snapshots managed by the Amazon Web Services Backup // service. SnapshotType *string // contains filtered or unexported fields }
type DescribeDBSnapshotTenantDatabasesOutput ¶ added in v1.62.0
type DescribeDBSnapshotTenantDatabasesOutput struct { // A list of DB snapshot tenant databases. DBSnapshotTenantDatabases []types.DBSnapshotTenantDatabase // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeDBSnapshotTenantDatabasesPaginator ¶ added in v1.62.0
type DescribeDBSnapshotTenantDatabasesPaginator struct {
// contains filtered or unexported fields
}
DescribeDBSnapshotTenantDatabasesPaginator is a paginator for DescribeDBSnapshotTenantDatabases
func NewDescribeDBSnapshotTenantDatabasesPaginator ¶ added in v1.62.0
func NewDescribeDBSnapshotTenantDatabasesPaginator(client DescribeDBSnapshotTenantDatabasesAPIClient, params *DescribeDBSnapshotTenantDatabasesInput, optFns ...func(*DescribeDBSnapshotTenantDatabasesPaginatorOptions)) *DescribeDBSnapshotTenantDatabasesPaginator
NewDescribeDBSnapshotTenantDatabasesPaginator returns a new DescribeDBSnapshotTenantDatabasesPaginator
func (*DescribeDBSnapshotTenantDatabasesPaginator) HasMorePages ¶ added in v1.62.0
func (p *DescribeDBSnapshotTenantDatabasesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBSnapshotTenantDatabasesPaginator) NextPage ¶ added in v1.62.0
func (p *DescribeDBSnapshotTenantDatabasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBSnapshotTenantDatabasesOutput, error)
NextPage retrieves the next DescribeDBSnapshotTenantDatabases page.
type DescribeDBSnapshotTenantDatabasesPaginatorOptions ¶ added in v1.62.0
type DescribeDBSnapshotTenantDatabasesPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBSnapshotTenantDatabasesPaginatorOptions is the paginator options for DescribeDBSnapshotTenantDatabases
type DescribeDBSnapshotsAPIClient ¶ added in v0.30.0
type DescribeDBSnapshotsAPIClient interface {
DescribeDBSnapshots(context.Context, *DescribeDBSnapshotsInput, ...func(*Options)) (*DescribeDBSnapshotsOutput, error)
}
DescribeDBSnapshotsAPIClient is a client that implements the DescribeDBSnapshots operation.
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 // 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 // A specific DB resource ID to describe. DbiResourceId *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 []types.Filter // Specifies 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 // 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 // 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 // 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 *int32 // 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.] // // 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 . // // [Amazon Web Services Backup Developer Guide.]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html SnapshotType *string // contains filtered or unexported fields }
type DescribeDBSnapshotsOutput ¶
type DescribeDBSnapshotsOutput struct { // A list of DBSnapshot instances. DBSnapshots []types.DBSnapshot // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the result of a successful invocation of the DescribeDBSnapshots action.
type DescribeDBSnapshotsPaginator ¶ added in v0.30.0
type DescribeDBSnapshotsPaginator struct {
// contains filtered or unexported fields
}
DescribeDBSnapshotsPaginator is a paginator for DescribeDBSnapshots
func NewDescribeDBSnapshotsPaginator ¶ added in v0.30.0
func NewDescribeDBSnapshotsPaginator(client DescribeDBSnapshotsAPIClient, params *DescribeDBSnapshotsInput, optFns ...func(*DescribeDBSnapshotsPaginatorOptions)) *DescribeDBSnapshotsPaginator
NewDescribeDBSnapshotsPaginator returns a new DescribeDBSnapshotsPaginator
func (*DescribeDBSnapshotsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeDBSnapshotsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBSnapshotsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeDBSnapshotsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBSnapshotsOutput, error)
NextPage retrieves the next DescribeDBSnapshots page.
type DescribeDBSnapshotsPaginatorOptions ¶ added in v0.30.0
type DescribeDBSnapshotsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBSnapshotsPaginatorOptions is the paginator options for DescribeDBSnapshots
type DescribeDBSubnetGroupsAPIClient ¶ added in v0.30.0
type DescribeDBSubnetGroupsAPIClient interface {
DescribeDBSubnetGroups(context.Context, *DescribeDBSubnetGroupsInput, ...func(*Options)) (*DescribeDBSubnetGroupsOutput, error)
}
DescribeDBSubnetGroupsAPIClient is a client that implements the DescribeDBSubnetGroups operation.
type DescribeDBSubnetGroupsInput ¶
type DescribeDBSubnetGroupsInput struct { // The name of the DB subnet group to return details for. DBSubnetGroupName *string // This parameter isn't currently supported. Filters []types.Filter // 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 // 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 *int32 // contains filtered or unexported fields }
type DescribeDBSubnetGroupsOutput ¶
type DescribeDBSubnetGroupsOutput struct { // A list of DBSubnetGroup instances. DBSubnetGroups []types.DBSubnetGroup // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the result of a successful invocation of the DescribeDBSubnetGroups action.
type DescribeDBSubnetGroupsPaginator ¶ added in v0.30.0
type DescribeDBSubnetGroupsPaginator struct {
// contains filtered or unexported fields
}
DescribeDBSubnetGroupsPaginator is a paginator for DescribeDBSubnetGroups
func NewDescribeDBSubnetGroupsPaginator ¶ added in v0.30.0
func NewDescribeDBSubnetGroupsPaginator(client DescribeDBSubnetGroupsAPIClient, params *DescribeDBSubnetGroupsInput, optFns ...func(*DescribeDBSubnetGroupsPaginatorOptions)) *DescribeDBSubnetGroupsPaginator
NewDescribeDBSubnetGroupsPaginator returns a new DescribeDBSubnetGroupsPaginator
func (*DescribeDBSubnetGroupsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeDBSubnetGroupsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeDBSubnetGroupsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeDBSubnetGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBSubnetGroupsOutput, error)
NextPage retrieves the next DescribeDBSubnetGroups page.
type DescribeDBSubnetGroupsPaginatorOptions ¶ added in v0.30.0
type DescribeDBSubnetGroupsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeDBSubnetGroupsPaginatorOptions is the paginator options for DescribeDBSubnetGroups
type DescribeEngineDefaultClusterParametersInput ¶
type DescribeEngineDefaultClusterParametersInput struct { // The name of the DB cluster parameter group family to return engine parameter // information for. // // This member is required. DBParameterGroupFamily *string // This parameter isn't currently supported. Filters []types.Filter // 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 // 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 *int32 // contains filtered or unexported fields }
type DescribeEngineDefaultClusterParametersOutput ¶
type DescribeEngineDefaultClusterParametersOutput struct { // Contains the result of a successful invocation of the // DescribeEngineDefaultParameters action. EngineDefaults *types.EngineDefaults // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeEngineDefaultParametersAPIClient ¶ added in v0.30.0
type DescribeEngineDefaultParametersAPIClient interface {
DescribeEngineDefaultParameters(context.Context, *DescribeEngineDefaultParametersInput, ...func(*Options)) (*DescribeEngineDefaultParametersOutput, error)
}
DescribeEngineDefaultParametersAPIClient is a client that implements the DescribeEngineDefaultParameters operation.
type DescribeEngineDefaultParametersInput ¶
type DescribeEngineDefaultParametersInput struct { // The name of the DB parameter group family. // // Valid Values: // // - aurora-mysql5.7 // // - aurora-mysql8.0 // // - aurora-postgresql10 // // - aurora-postgresql11 // // - aurora-postgresql12 // // - aurora-postgresql13 // // - aurora-postgresql14 // // - custom-oracle-ee-19 // // - custom-oracle-ee-cdb-19 // // - db2-ae // // - db2-se // // - mariadb10.2 // // - mariadb10.3 // // - mariadb10.4 // // - mariadb10.5 // // - mariadb10.6 // // - mysql5.7 // // - mysql8.0 // // - oracle-ee-19 // // - oracle-ee-cdb-19 // // - oracle-ee-cdb-21 // // - oracle-se2-19 // // - oracle-se2-cdb-19 // // - oracle-se2-cdb-21 // // - 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 // // This member is required. DBParameterGroupFamily *string // A filter that specifies one or more parameters to describe. // // The only supported filter is parameter-name . The results list only includes // information about the parameters with these names. Filters []types.Filter // 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 // 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 *int32 // contains filtered or unexported fields }
type DescribeEngineDefaultParametersOutput ¶
type DescribeEngineDefaultParametersOutput struct { // Contains the result of a successful invocation of the // DescribeEngineDefaultParameters action. EngineDefaults *types.EngineDefaults // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeEngineDefaultParametersPaginator ¶ added in v0.30.0
type DescribeEngineDefaultParametersPaginator struct {
// contains filtered or unexported fields
}
DescribeEngineDefaultParametersPaginator is a paginator for DescribeEngineDefaultParameters
func NewDescribeEngineDefaultParametersPaginator ¶ added in v0.30.0
func NewDescribeEngineDefaultParametersPaginator(client DescribeEngineDefaultParametersAPIClient, params *DescribeEngineDefaultParametersInput, optFns ...func(*DescribeEngineDefaultParametersPaginatorOptions)) *DescribeEngineDefaultParametersPaginator
NewDescribeEngineDefaultParametersPaginator returns a new DescribeEngineDefaultParametersPaginator
func (*DescribeEngineDefaultParametersPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeEngineDefaultParametersPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeEngineDefaultParametersPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeEngineDefaultParametersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeEngineDefaultParametersOutput, error)
NextPage retrieves the next DescribeEngineDefaultParameters page.
type DescribeEngineDefaultParametersPaginatorOptions ¶ added in v0.30.0
type DescribeEngineDefaultParametersPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeEngineDefaultParametersPaginatorOptions is the paginator options for DescribeEngineDefaultParameters
type DescribeEventCategoriesInput ¶
type DescribeEventCategoriesInput struct { // This parameter isn't currently supported. Filters []types.Filter // 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 // contains filtered or unexported fields }
type DescribeEventCategoriesOutput ¶
type DescribeEventCategoriesOutput struct { // A list of EventCategoriesMap data types. EventCategoriesMapList []types.EventCategoriesMap // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Data returned from the DescribeEventCategories operation.
type DescribeEventSubscriptionsAPIClient ¶ added in v0.30.0
type DescribeEventSubscriptionsAPIClient interface {
DescribeEventSubscriptions(context.Context, *DescribeEventSubscriptionsInput, ...func(*Options)) (*DescribeEventSubscriptionsOutput, error)
}
DescribeEventSubscriptionsAPIClient is a client that implements the DescribeEventSubscriptions operation.
type DescribeEventSubscriptionsInput ¶
type DescribeEventSubscriptionsInput struct { // This parameter isn't currently supported. Filters []types.Filter // 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 // 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 *int32 // The name of the RDS event notification subscription you want to describe. SubscriptionName *string // contains filtered or unexported fields }
type DescribeEventSubscriptionsOutput ¶
type DescribeEventSubscriptionsOutput struct { // A list of EventSubscriptions data types. EventSubscriptionsList []types.EventSubscription // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Data returned by the DescribeEventSubscriptions action.
type DescribeEventSubscriptionsPaginator ¶ added in v0.30.0
type DescribeEventSubscriptionsPaginator struct {
// contains filtered or unexported fields
}
DescribeEventSubscriptionsPaginator is a paginator for DescribeEventSubscriptions
func NewDescribeEventSubscriptionsPaginator ¶ added in v0.30.0
func NewDescribeEventSubscriptionsPaginator(client DescribeEventSubscriptionsAPIClient, params *DescribeEventSubscriptionsInput, optFns ...func(*DescribeEventSubscriptionsPaginatorOptions)) *DescribeEventSubscriptionsPaginator
NewDescribeEventSubscriptionsPaginator returns a new DescribeEventSubscriptionsPaginator
func (*DescribeEventSubscriptionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeEventSubscriptionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeEventSubscriptionsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeEventSubscriptionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeEventSubscriptionsOutput, error)
NextPage retrieves the next DescribeEventSubscriptions page.
type DescribeEventSubscriptionsPaginatorOptions ¶ added in v0.30.0
type DescribeEventSubscriptionsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeEventSubscriptionsPaginatorOptions is the paginator options for DescribeEventSubscriptions
type DescribeEventsAPIClient ¶ added in v0.30.0
type DescribeEventsAPIClient interface {
DescribeEvents(context.Context, *DescribeEventsInput, ...func(*Options)) (*DescribeEventsOutput, error)
}
DescribeEventsAPIClient is a client that implements the DescribeEvents operation.
type DescribeEventsInput ¶
type DescribeEventsInput struct { // The number of minutes to retrieve events for. // // Default: 60 Duration *int32 // 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.] // // Example: 2009-07-08T18:00Z // // [ISO8601 Wikipedia page.]: http://en.wikipedia.org/wiki/ISO_8601 EndTime *time.Time // A list of event categories that trigger notifications for a event notification // subscription. EventCategories []string // This parameter isn't currently supported. Filters []types.Filter // 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 // 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 *int32 // 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 // The event source to retrieve events for. If no value is specified, all events // are returned. SourceType types.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.] // // Example: 2009-07-08T18:00Z // // [ISO8601 Wikipedia page.]: http://en.wikipedia.org/wiki/ISO_8601 StartTime *time.Time // contains filtered or unexported fields }
type DescribeEventsOutput ¶
type DescribeEventsOutput struct { // A list of Event instances. Events []types.Event // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the result of a successful invocation of the DescribeEvents action.
type DescribeEventsPaginator ¶ added in v0.30.0
type DescribeEventsPaginator struct {
// contains filtered or unexported fields
}
DescribeEventsPaginator is a paginator for DescribeEvents
func NewDescribeEventsPaginator ¶ added in v0.30.0
func NewDescribeEventsPaginator(client DescribeEventsAPIClient, params *DescribeEventsInput, optFns ...func(*DescribeEventsPaginatorOptions)) *DescribeEventsPaginator
NewDescribeEventsPaginator returns a new DescribeEventsPaginator
func (*DescribeEventsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeEventsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeEventsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeEventsOutput, error)
NextPage retrieves the next DescribeEvents page.
type DescribeEventsPaginatorOptions ¶ added in v0.30.0
type DescribeEventsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeEventsPaginatorOptions is the paginator options for DescribeEvents
type DescribeExportTasksAPIClient ¶ added in v0.30.0
type DescribeExportTasksAPIClient interface {
DescribeExportTasks(context.Context, *DescribeExportTasksInput, ...func(*Options)) (*DescribeExportTasksOutput, error)
}
DescribeExportTasksAPIClient is a client that implements the DescribeExportTasks operation.
type DescribeExportTasksInput ¶
type DescribeExportTasksInput struct { // The identifier of the snapshot or cluster export task to be described. ExportTaskIdentifier *string // Filters specify one or more snapshot or cluster 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 or cluster export // task. // // - s3-bucket - The Amazon S3 bucket the data is exported to. // // - source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster // 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 []types.Filter // 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 // 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 *int32 // The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. SourceArn *string // The type of source for the export. SourceType types.ExportSourceType // contains filtered or unexported fields }
type DescribeExportTasksOutput ¶
type DescribeExportTasksOutput struct { // Information about an export of a snapshot or cluster to Amazon S3. ExportTasks []types.ExportTask // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeExportTasksPaginator ¶ added in v0.30.0
type DescribeExportTasksPaginator struct {
// contains filtered or unexported fields
}
DescribeExportTasksPaginator is a paginator for DescribeExportTasks
func NewDescribeExportTasksPaginator ¶ added in v0.30.0
func NewDescribeExportTasksPaginator(client DescribeExportTasksAPIClient, params *DescribeExportTasksInput, optFns ...func(*DescribeExportTasksPaginatorOptions)) *DescribeExportTasksPaginator
NewDescribeExportTasksPaginator returns a new DescribeExportTasksPaginator
func (*DescribeExportTasksPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeExportTasksPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeExportTasksPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeExportTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeExportTasksOutput, error)
NextPage retrieves the next DescribeExportTasks page.
type DescribeExportTasksPaginatorOptions ¶ added in v0.30.0
type DescribeExportTasksPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeExportTasksPaginatorOptions is the paginator options for DescribeExportTasks
type DescribeGlobalClustersAPIClient ¶ added in v0.30.0
type DescribeGlobalClustersAPIClient interface {
DescribeGlobalClusters(context.Context, *DescribeGlobalClustersInput, ...func(*Options)) (*DescribeGlobalClustersOutput, error)
}
DescribeGlobalClustersAPIClient is a client that implements the DescribeGlobalClusters operation.
type DescribeGlobalClustersInput ¶
type DescribeGlobalClustersInput struct { // A filter that specifies one or more global database clusters to describe. This // parameter is case-sensitive. // // Currently, the only supported filter is region . // // If used, the request returns information about any global cluster with at least // one member (primary or secondary) in the specified Amazon Web Services Regions. Filters []types.Filter // 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 // 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 // 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 *int32 // contains filtered or unexported fields }
type DescribeGlobalClustersOutput ¶
type DescribeGlobalClustersOutput struct { // The list of global clusters returned by this request. GlobalClusters []types.GlobalCluster // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeGlobalClustersPaginator ¶ added in v0.30.0
type DescribeGlobalClustersPaginator struct {
// contains filtered or unexported fields
}
DescribeGlobalClustersPaginator is a paginator for DescribeGlobalClusters
func NewDescribeGlobalClustersPaginator ¶ added in v0.30.0
func NewDescribeGlobalClustersPaginator(client DescribeGlobalClustersAPIClient, params *DescribeGlobalClustersInput, optFns ...func(*DescribeGlobalClustersPaginatorOptions)) *DescribeGlobalClustersPaginator
NewDescribeGlobalClustersPaginator returns a new DescribeGlobalClustersPaginator
func (*DescribeGlobalClustersPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeGlobalClustersPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeGlobalClustersPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeGlobalClustersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeGlobalClustersOutput, error)
NextPage retrieves the next DescribeGlobalClusters page.
type DescribeGlobalClustersPaginatorOptions ¶ added in v0.30.0
type DescribeGlobalClustersPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeGlobalClustersPaginatorOptions is the paginator options for DescribeGlobalClusters
type DescribeIntegrationsAPIClient ¶ added in v1.59.0
type DescribeIntegrationsAPIClient interface {
DescribeIntegrations(context.Context, *DescribeIntegrationsInput, ...func(*Options)) (*DescribeIntegrationsOutput, error)
}
DescribeIntegrationsAPIClient is a client that implements the DescribeIntegrations operation.
type DescribeIntegrationsInput ¶ added in v1.59.0
type DescribeIntegrationsInput struct { // A filter that specifies one or more resources to return. Filters []types.Filter // The unique identifier of the integration. IntegrationIdentifier *string // An optional pagination token provided by a previous DescribeIntegrations // request. If this parameter is specified, the response includes only records // beyond the marker, up to the value specified by MaxRecords . Marker *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 *int32 // contains filtered or unexported fields }
type DescribeIntegrationsOutput ¶ added in v1.59.0
type DescribeIntegrationsOutput struct { // A list of integrations. Integrations []types.Integration // A pagination token that can be used in a later DescribeIntegrations request. Marker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeIntegrationsPaginator ¶ added in v1.59.0
type DescribeIntegrationsPaginator struct {
// contains filtered or unexported fields
}
DescribeIntegrationsPaginator is a paginator for DescribeIntegrations
func NewDescribeIntegrationsPaginator ¶ added in v1.59.0
func NewDescribeIntegrationsPaginator(client DescribeIntegrationsAPIClient, params *DescribeIntegrationsInput, optFns ...func(*DescribeIntegrationsPaginatorOptions)) *DescribeIntegrationsPaginator
NewDescribeIntegrationsPaginator returns a new DescribeIntegrationsPaginator
func (*DescribeIntegrationsPaginator) HasMorePages ¶ added in v1.59.0
func (p *DescribeIntegrationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeIntegrationsPaginator) NextPage ¶ added in v1.59.0
func (p *DescribeIntegrationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeIntegrationsOutput, error)
NextPage retrieves the next DescribeIntegrations page.
type DescribeIntegrationsPaginatorOptions ¶ added in v1.59.0
type DescribeIntegrationsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeIntegrationsPaginatorOptions is the paginator options for DescribeIntegrations
type DescribeOptionGroupOptionsAPIClient ¶ added in v0.30.0
type DescribeOptionGroupOptionsAPIClient interface {
DescribeOptionGroupOptions(context.Context, *DescribeOptionGroupOptionsInput, ...func(*Options)) (*DescribeOptionGroupOptionsOutput, error)
}
DescribeOptionGroupOptionsAPIClient is a client that implements the DescribeOptionGroupOptions operation.
type DescribeOptionGroupOptionsInput ¶
type DescribeOptionGroupOptionsInput struct { // The name of the engine to describe options for. // // Valid Values: // // - db2-ae // // - db2-se // // - mariadb // // - mysql // // - oracle-ee // // - oracle-ee-cdb // // - oracle-se2 // // - oracle-se2-cdb // // - postgres // // - sqlserver-ee // // - sqlserver-se // // - sqlserver-ex // // - sqlserver-web // // This member is required. EngineName *string // This parameter isn't currently supported. Filters []types.Filter // If specified, filters the results to include only options for the specified // major engine version. MajorEngineVersion *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 // 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 *int32 // contains filtered or unexported fields }
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 // List of available option group options. OptionGroupOptions []types.OptionGroupOption // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeOptionGroupOptionsPaginator ¶ added in v0.30.0
type DescribeOptionGroupOptionsPaginator struct {
// contains filtered or unexported fields
}
DescribeOptionGroupOptionsPaginator is a paginator for DescribeOptionGroupOptions
func NewDescribeOptionGroupOptionsPaginator ¶ added in v0.30.0
func NewDescribeOptionGroupOptionsPaginator(client DescribeOptionGroupOptionsAPIClient, params *DescribeOptionGroupOptionsInput, optFns ...func(*DescribeOptionGroupOptionsPaginatorOptions)) *DescribeOptionGroupOptionsPaginator
NewDescribeOptionGroupOptionsPaginator returns a new DescribeOptionGroupOptionsPaginator
func (*DescribeOptionGroupOptionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeOptionGroupOptionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeOptionGroupOptionsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeOptionGroupOptionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeOptionGroupOptionsOutput, error)
NextPage retrieves the next DescribeOptionGroupOptions page.
type DescribeOptionGroupOptionsPaginatorOptions ¶ added in v0.30.0
type DescribeOptionGroupOptionsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeOptionGroupOptionsPaginatorOptions is the paginator options for DescribeOptionGroupOptions
type DescribeOptionGroupsAPIClient ¶ added in v0.30.0
type DescribeOptionGroupsAPIClient interface {
DescribeOptionGroups(context.Context, *DescribeOptionGroupsInput, ...func(*Options)) (*DescribeOptionGroupsOutput, error)
}
DescribeOptionGroupsAPIClient is a client that implements the DescribeOptionGroups operation.
type DescribeOptionGroupsInput ¶
type DescribeOptionGroupsInput struct { // A filter to only include option groups associated with this database engine. // // Valid Values: // // - db2-ae // // - db2-se // // - mariadb // // - mysql // // - oracle-ee // // - oracle-ee-cdb // // - oracle-se2 // // - oracle-se2-cdb // // - postgres // // - sqlserver-ee // // - sqlserver-se // // - sqlserver-ex // // - sqlserver-web EngineName *string // This parameter isn't currently supported. Filters []types.Filter // 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 // 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 // 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 *int32 // The name of the option group to describe. Can't be supplied together with // EngineName or MajorEngineVersion. OptionGroupName *string // contains filtered or unexported fields }
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 // List of option groups. OptionGroupsList []types.OptionGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
List of option groups.
type DescribeOptionGroupsPaginator ¶ added in v0.30.0
type DescribeOptionGroupsPaginator struct {
// contains filtered or unexported fields
}
DescribeOptionGroupsPaginator is a paginator for DescribeOptionGroups
func NewDescribeOptionGroupsPaginator ¶ added in v0.30.0
func NewDescribeOptionGroupsPaginator(client DescribeOptionGroupsAPIClient, params *DescribeOptionGroupsInput, optFns ...func(*DescribeOptionGroupsPaginatorOptions)) *DescribeOptionGroupsPaginator
NewDescribeOptionGroupsPaginator returns a new DescribeOptionGroupsPaginator
func (*DescribeOptionGroupsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeOptionGroupsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeOptionGroupsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeOptionGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeOptionGroupsOutput, error)
NextPage retrieves the next DescribeOptionGroups page.
type DescribeOptionGroupsPaginatorOptions ¶ added in v0.30.0
type DescribeOptionGroupsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeOptionGroupsPaginatorOptions is the paginator options for DescribeOptionGroups
type DescribeOrderableDBInstanceOptionsAPIClient ¶ added in v0.30.0
type DescribeOrderableDBInstanceOptionsAPIClient interface {
DescribeOrderableDBInstanceOptions(context.Context, *DescribeOrderableDBInstanceOptionsInput, ...func(*Options)) (*DescribeOrderableDBInstanceOptionsOutput, error)
}
DescribeOrderableDBInstanceOptionsAPIClient is a client that implements the DescribeOrderableDBInstanceOptions operation.
type DescribeOrderableDBInstanceOptionsInput ¶
type DescribeOrderableDBInstanceOptionsInput struct { // The name of the database engine to describe DB instance options for. // // Valid Values: // // - aurora-mysql // // - aurora-postgresql // // - custom-oracle-ee // // - custom-oracle-ee-cdb // // - custom-oracle-se2 // // - custom-oracle-se2-cdb // // - db2-ae // // - db2-se // // - mariadb // // - mysql // // - oracle-ee // // - oracle-ee-cdb // // - oracle-se2 // // - oracle-se2-cdb // // - postgres // // - sqlserver-ee // // - sqlserver-se // // - sqlserver-ex // // - sqlserver-web // // This member is required. Engine *string // The Availability Zone group associated with a Local Zone. Specify this // parameter to retrieve available options for the Local Zones in the group. // // Omit this parameter to show the available options in the specified Amazon Web // Services Region. // // This setting doesn't apply to RDS Custom DB instances. AvailabilityZoneGroup *string // A filter to include only the available options for the specified DB instance // class. DBInstanceClass *string // A filter to include only the available options for the specified engine version. EngineVersion *string // This parameter isn't currently supported. Filters []types.Filter // A filter to include only the available options for the specified license model. // // RDS Custom supports only the BYOL licensing model. LicenseModel *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 // 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 1000. MaxRecords *int32 // Specifies 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 // contains filtered or unexported fields }
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 // An OrderableDBInstanceOption structure containing information about orderable // options for the DB instance. OrderableDBInstanceOptions []types.OrderableDBInstanceOption // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
type DescribeOrderableDBInstanceOptionsPaginator ¶ added in v0.30.0
type DescribeOrderableDBInstanceOptionsPaginator struct {
// contains filtered or unexported fields
}
DescribeOrderableDBInstanceOptionsPaginator is a paginator for DescribeOrderableDBInstanceOptions
func NewDescribeOrderableDBInstanceOptionsPaginator ¶ added in v0.30.0
func NewDescribeOrderableDBInstanceOptionsPaginator(client DescribeOrderableDBInstanceOptionsAPIClient, params *DescribeOrderableDBInstanceOptionsInput, optFns ...func(*DescribeOrderableDBInstanceOptionsPaginatorOptions)) *DescribeOrderableDBInstanceOptionsPaginator
NewDescribeOrderableDBInstanceOptionsPaginator returns a new DescribeOrderableDBInstanceOptionsPaginator
func (*DescribeOrderableDBInstanceOptionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeOrderableDBInstanceOptionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeOrderableDBInstanceOptionsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeOrderableDBInstanceOptionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeOrderableDBInstanceOptionsOutput, error)
NextPage retrieves the next DescribeOrderableDBInstanceOptions page.
type DescribeOrderableDBInstanceOptionsPaginatorOptions ¶ added in v0.30.0
type DescribeOrderableDBInstanceOptionsPaginatorOptions struct { // 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 1000. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeOrderableDBInstanceOptionsPaginatorOptions is the paginator options for DescribeOrderableDBInstanceOptions
type DescribePendingMaintenanceActionsAPIClient ¶ added in v0.30.0
type DescribePendingMaintenanceActionsAPIClient interface {
DescribePendingMaintenanceActions(context.Context, *DescribePendingMaintenanceActionsInput, ...func(*Options)) (*DescribePendingMaintenanceActionsOutput, error)
}
DescribePendingMaintenanceActionsAPIClient is a client that implements the DescribePendingMaintenanceActions operation.
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 []types.Filter // 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 // 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 *int32 // The ARN of a resource to return pending maintenance actions for. ResourceIdentifier *string // contains filtered or unexported fields }
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 // A list of the pending maintenance actions for the resource. PendingMaintenanceActions []types.ResourcePendingMaintenanceActions // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Data returned from the DescribePendingMaintenanceActions action.
type DescribePendingMaintenanceActionsPaginator ¶ added in v0.30.0
type DescribePendingMaintenanceActionsPaginator struct {
// contains filtered or unexported fields
}
DescribePendingMaintenanceActionsPaginator is a paginator for DescribePendingMaintenanceActions
func NewDescribePendingMaintenanceActionsPaginator ¶ added in v0.30.0
func NewDescribePendingMaintenanceActionsPaginator(client DescribePendingMaintenanceActionsAPIClient, params *DescribePendingMaintenanceActionsInput, optFns ...func(*DescribePendingMaintenanceActionsPaginatorOptions)) *DescribePendingMaintenanceActionsPaginator
NewDescribePendingMaintenanceActionsPaginator returns a new DescribePendingMaintenanceActionsPaginator
func (*DescribePendingMaintenanceActionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribePendingMaintenanceActionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribePendingMaintenanceActionsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribePendingMaintenanceActionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribePendingMaintenanceActionsOutput, error)
NextPage retrieves the next DescribePendingMaintenanceActions page.
type DescribePendingMaintenanceActionsPaginatorOptions ¶ added in v0.30.0
type DescribePendingMaintenanceActionsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribePendingMaintenanceActionsPaginatorOptions is the paginator options for DescribePendingMaintenanceActions
type DescribeReservedDBInstancesAPIClient ¶ added in v0.30.0
type DescribeReservedDBInstancesAPIClient interface {
DescribeReservedDBInstances(context.Context, *DescribeReservedDBInstancesInput, ...func(*Options)) (*DescribeReservedDBInstancesOutput, error)
}
DescribeReservedDBInstancesAPIClient is a client that implements the DescribeReservedDBInstances operation.
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 // 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 // This parameter isn't currently supported. Filters []types.Filter // 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 // 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 // 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 *int32 // Specifies whether to show only those reservations that support Multi-AZ. MultiAZ *bool // 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 // The product description filter value. Specify this parameter to show only those // reservations matching the specified product description. ProductDescription *string // The reserved DB instance identifier filter value. Specify this parameter to // show only the reservation that matches the specified reservation ID. ReservedDBInstanceId *string // The offering identifier filter value. Specify this parameter to show only // purchased reservations matching the specified offering identifier. ReservedDBInstancesOfferingId *string // contains filtered or unexported fields }
type DescribeReservedDBInstancesOfferingsAPIClient ¶ added in v0.30.0
type DescribeReservedDBInstancesOfferingsAPIClient interface {
DescribeReservedDBInstancesOfferings(context.Context, *DescribeReservedDBInstancesOfferingsInput, ...func(*Options)) (*DescribeReservedDBInstancesOfferingsOutput, error)
}
DescribeReservedDBInstancesOfferingsAPIClient is a client that implements the DescribeReservedDBInstancesOfferings operation.
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 // 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 // This parameter isn't currently supported. Filters []types.Filter // 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 // 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 *int32 // Specifies whether to show only those reservations that support Multi-AZ. MultiAZ *bool // 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 // 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 // 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 // contains filtered or unexported fields }
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 // A list of reserved DB instance offerings. ReservedDBInstancesOfferings []types.ReservedDBInstancesOffering // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
type DescribeReservedDBInstancesOfferingsPaginator ¶ added in v0.30.0
type DescribeReservedDBInstancesOfferingsPaginator struct {
// contains filtered or unexported fields
}
DescribeReservedDBInstancesOfferingsPaginator is a paginator for DescribeReservedDBInstancesOfferings
func NewDescribeReservedDBInstancesOfferingsPaginator ¶ added in v0.30.0
func NewDescribeReservedDBInstancesOfferingsPaginator(client DescribeReservedDBInstancesOfferingsAPIClient, params *DescribeReservedDBInstancesOfferingsInput, optFns ...func(*DescribeReservedDBInstancesOfferingsPaginatorOptions)) *DescribeReservedDBInstancesOfferingsPaginator
NewDescribeReservedDBInstancesOfferingsPaginator returns a new DescribeReservedDBInstancesOfferingsPaginator
func (*DescribeReservedDBInstancesOfferingsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeReservedDBInstancesOfferingsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeReservedDBInstancesOfferingsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeReservedDBInstancesOfferingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeReservedDBInstancesOfferingsOutput, error)
NextPage retrieves the next DescribeReservedDBInstancesOfferings page.
type DescribeReservedDBInstancesOfferingsPaginatorOptions ¶ added in v0.30.0
type DescribeReservedDBInstancesOfferingsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeReservedDBInstancesOfferingsPaginatorOptions is the paginator options for DescribeReservedDBInstancesOfferings
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 // A list of reserved DB instances. ReservedDBInstances []types.ReservedDBInstance // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the result of a successful invocation of the DescribeReservedDBInstances action.
type DescribeReservedDBInstancesPaginator ¶ added in v0.30.0
type DescribeReservedDBInstancesPaginator struct {
// contains filtered or unexported fields
}
DescribeReservedDBInstancesPaginator is a paginator for DescribeReservedDBInstances
func NewDescribeReservedDBInstancesPaginator ¶ added in v0.30.0
func NewDescribeReservedDBInstancesPaginator(client DescribeReservedDBInstancesAPIClient, params *DescribeReservedDBInstancesInput, optFns ...func(*DescribeReservedDBInstancesPaginatorOptions)) *DescribeReservedDBInstancesPaginator
NewDescribeReservedDBInstancesPaginator returns a new DescribeReservedDBInstancesPaginator
func (*DescribeReservedDBInstancesPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeReservedDBInstancesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeReservedDBInstancesPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeReservedDBInstancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeReservedDBInstancesOutput, error)
NextPage retrieves the next DescribeReservedDBInstances page.
type DescribeReservedDBInstancesPaginatorOptions ¶ added in v0.30.0
type DescribeReservedDBInstancesPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeReservedDBInstancesPaginatorOptions is the paginator options for DescribeReservedDBInstances
type DescribeSourceRegionsAPIClient ¶ added in v0.30.0
type DescribeSourceRegionsAPIClient interface {
DescribeSourceRegions(context.Context, *DescribeSourceRegionsInput, ...func(*Options)) (*DescribeSourceRegionsOutput, error)
}
DescribeSourceRegionsAPIClient is a client that implements the DescribeSourceRegions operation.
type DescribeSourceRegionsInput ¶
type DescribeSourceRegionsInput struct { // This parameter isn't currently supported. Filters []types.Filter // 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 // 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 *int32 // The source Amazon Web Services Region name. For example, us-east-1 . // // Constraints: // // - Must specify a valid Amazon Web Services Region name. RegionName *string // contains filtered or unexported fields }
type DescribeSourceRegionsOutput ¶
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 // 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 []types.SourceRegion // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the result of a successful invocation of the DescribeSourceRegions action.
type DescribeSourceRegionsPaginator ¶ added in v0.30.0
type DescribeSourceRegionsPaginator struct {
// contains filtered or unexported fields
}
DescribeSourceRegionsPaginator is a paginator for DescribeSourceRegions
func NewDescribeSourceRegionsPaginator ¶ added in v0.30.0
func NewDescribeSourceRegionsPaginator(client DescribeSourceRegionsAPIClient, params *DescribeSourceRegionsInput, optFns ...func(*DescribeSourceRegionsPaginatorOptions)) *DescribeSourceRegionsPaginator
NewDescribeSourceRegionsPaginator returns a new DescribeSourceRegionsPaginator
func (*DescribeSourceRegionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeSourceRegionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeSourceRegionsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeSourceRegionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeSourceRegionsOutput, error)
NextPage retrieves the next DescribeSourceRegions page.
type DescribeSourceRegionsPaginatorOptions ¶ added in v0.30.0
type DescribeSourceRegionsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeSourceRegionsPaginatorOptions is the paginator options for DescribeSourceRegions
type DescribeTenantDatabasesAPIClient ¶ added in v1.62.0
type DescribeTenantDatabasesAPIClient interface {
DescribeTenantDatabases(context.Context, *DescribeTenantDatabasesInput, ...func(*Options)) (*DescribeTenantDatabasesOutput, error)
}
DescribeTenantDatabasesAPIClient is a client that implements the DescribeTenantDatabases operation.
type DescribeTenantDatabasesInput ¶ added in v1.62.0
type DescribeTenantDatabasesInput struct { // The user-supplied DB instance identifier, which must match the identifier of an // existing instance owned by the Amazon Web Services account. This parameter isn't // case-sensitive. DBInstanceIdentifier *string // A filter that specifies one or more database tenants to describe. // // Supported filters: // // - tenant-db-name - Tenant database names. The results list only includes // information about the tenant databases that match these tenant DB names. // // - tenant-database-resource-id - Tenant database resource identifiers. // // - dbi-resource-id - DB instance resource identifiers. The results list only // includes information about the tenants contained within the DB instances // identified by these resource identifiers. Filters []types.Filter // An optional pagination token provided by a previous DescribeTenantDatabases // request. If this parameter is specified, the response includes only records // beyond the marker, up to the value specified by MaxRecords . Marker *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 *int32 // The user-supplied tenant database name, which must match the name of an // existing tenant database on the specified DB instance owned by your Amazon Web // Services account. This parameter isn’t case-sensitive. TenantDBName *string // contains filtered or unexported fields }
type DescribeTenantDatabasesOutput ¶ added in v1.62.0
type DescribeTenantDatabasesOutput struct { // An optional pagination token provided by a previous DescribeTenantDatabases // request. If this parameter is specified, the response includes only records // beyond the marker, up to the value specified by MaxRecords . Marker *string // An array of the tenant databases requested by the DescribeTenantDatabases // operation. TenantDatabases []types.TenantDatabase // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeTenantDatabasesPaginator ¶ added in v1.62.0
type DescribeTenantDatabasesPaginator struct {
// contains filtered or unexported fields
}
DescribeTenantDatabasesPaginator is a paginator for DescribeTenantDatabases
func NewDescribeTenantDatabasesPaginator ¶ added in v1.62.0
func NewDescribeTenantDatabasesPaginator(client DescribeTenantDatabasesAPIClient, params *DescribeTenantDatabasesInput, optFns ...func(*DescribeTenantDatabasesPaginatorOptions)) *DescribeTenantDatabasesPaginator
NewDescribeTenantDatabasesPaginator returns a new DescribeTenantDatabasesPaginator
func (*DescribeTenantDatabasesPaginator) HasMorePages ¶ added in v1.62.0
func (p *DescribeTenantDatabasesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeTenantDatabasesPaginator) NextPage ¶ added in v1.62.0
func (p *DescribeTenantDatabasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeTenantDatabasesOutput, error)
NextPage retrieves the next DescribeTenantDatabases page.
type DescribeTenantDatabasesPaginatorOptions ¶ added in v1.62.0
type DescribeTenantDatabasesPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeTenantDatabasesPaginatorOptions is the paginator options for DescribeTenantDatabases
type DescribeValidDBInstanceModificationsInput ¶
type DescribeValidDBInstanceModificationsInput struct { // The customer identifier or the ARN of your DB instance. // // This member is required. DBInstanceIdentifier *string // contains filtered or unexported fields }
type DescribeValidDBInstanceModificationsOutput ¶
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 *types.ValidDBInstanceModificationsMessage // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisableHttpEndpointInput ¶ added in v1.66.0
type DisableHttpEndpointInput struct { // The Amazon Resource Name (ARN) of the DB cluster. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type DisableHttpEndpointOutput ¶ added in v1.66.0
type DisableHttpEndpointOutput struct { // Indicates whether the HTTP endpoint is enabled or disabled for the DB cluster. HttpEndpointEnabled *bool // The ARN of the DB cluster. ResourceArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DownloadDBLogFilePortionAPIClient ¶ added in v0.30.0
type DownloadDBLogFilePortionAPIClient interface {
DownloadDBLogFilePortion(context.Context, *DownloadDBLogFilePortionInput, ...func(*Options)) (*DownloadDBLogFilePortionOutput, error)
}
DownloadDBLogFilePortionAPIClient is a client that implements the DownloadDBLogFilePortion operation.
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. // // This member is required. DBInstanceIdentifier *string // The name of the log file to be downloaded. // // This member is required. LogFileName *string // 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 // 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 *int32 // contains filtered or unexported fields }
type DownloadDBLogFilePortionOutput ¶
type DownloadDBLogFilePortionOutput struct { // A Boolean value that, if true, indicates there is more data to be downloaded. AdditionalDataPending *bool // Entries from the specified log file. LogFileData *string // A pagination token that can be used in a later DownloadDBLogFilePortion request. Marker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
This data type is used as a response element to DownloadDBLogFilePortion .
type DownloadDBLogFilePortionPaginator ¶ added in v0.30.0
type DownloadDBLogFilePortionPaginator struct {
// contains filtered or unexported fields
}
DownloadDBLogFilePortionPaginator is a paginator for DownloadDBLogFilePortion
func NewDownloadDBLogFilePortionPaginator ¶ added in v0.30.0
func NewDownloadDBLogFilePortionPaginator(client DownloadDBLogFilePortionAPIClient, params *DownloadDBLogFilePortionInput, optFns ...func(*DownloadDBLogFilePortionPaginatorOptions)) *DownloadDBLogFilePortionPaginator
NewDownloadDBLogFilePortionPaginator returns a new DownloadDBLogFilePortionPaginator
func (*DownloadDBLogFilePortionPaginator) HasMorePages ¶ added in v0.30.0
func (p *DownloadDBLogFilePortionPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DownloadDBLogFilePortionPaginator) NextPage ¶ added in v0.30.0
func (p *DownloadDBLogFilePortionPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DownloadDBLogFilePortionOutput, error)
NextPage retrieves the next DownloadDBLogFilePortion page.
type DownloadDBLogFilePortionPaginatorOptions ¶ added in v0.30.0
type DownloadDBLogFilePortionPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DownloadDBLogFilePortionPaginatorOptions is the paginator options for DownloadDBLogFilePortion
type EnableHttpEndpointInput ¶ added in v1.66.0
type EnableHttpEndpointInput struct { // The Amazon Resource Name (ARN) of the DB cluster. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type EnableHttpEndpointOutput ¶ added in v1.66.0
type EnableHttpEndpointOutput struct { // Indicates whether the HTTP endpoint is enabled or disabled for the DB cluster. HttpEndpointEnabled *bool // The ARN of the DB cluster. ResourceArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointParameters ¶ added in v1.49.0
type EndpointParameters struct { // The AWS region used to dispatch the request. // // Parameter is // required. // // AWS::Region Region *string // When true, use the dual-stack endpoint. If the configured endpoint does not // support dual-stack, dispatching the request MAY return an error. // // Defaults to // false if no value is provided. // // AWS::UseDualStack UseDualStack *bool // When true, send this request to the FIPS-compliant regional endpoint. If the // configured endpoint does not have a FIPS compliant endpoint, dispatching the // request will return an error. // // Defaults to false if no value is // provided. // // AWS::UseFIPS UseFIPS *bool // Override the endpoint used to send this request // // Parameter is // required. // // SDK::Endpoint Endpoint *string }
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶ added in v1.49.0
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶ added in v1.49.0
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶ added in v1.1.0
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶ added in v0.29.0
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶ added in v1.49.0
type EndpointResolverV2 interface { // ResolveEndpoint attempts to resolve the endpoint with the provided options, // returning the endpoint if found. Otherwise an error is returned. ResolveEndpoint(ctx context.Context, params EndpointParameters) ( smithyendpoints.Endpoint, error, ) }
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶ added in v1.49.0
func NewDefaultEndpointResolverV2() EndpointResolverV2
type FailoverDBClusterInput ¶
type FailoverDBClusterInput struct { // The identifier of the DB cluster to force a failover for. This parameter isn't // case-sensitive. // // Constraints: // // - Must match the identifier of an existing DB cluster. // // This member is required. DBClusterIdentifier *string // 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 // contains filtered or unexported fields }
type FailoverDBClusterOutput ¶
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?] in the Amazon Aurora // User Guide. // // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User // Guide. // // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type FailoverGlobalClusterInput ¶ added in v1.2.0
type FailoverGlobalClusterInput struct { // The identifier of the global database cluster (Aurora global database) this // operation should apply to. The identifier is the unique key assigned by the user // when the Aurora global database is created. In other words, it's the name of the // Aurora global database. // // Constraints: // // - Must match the identifier of an existing global database cluster. // // This member is required. GlobalClusterIdentifier *string // The identifier of the secondary Aurora DB cluster that you want to promote to // the primary for the global database cluster. Use the Amazon Resource Name (ARN) // for the identifier so that Aurora can locate the cluster in its Amazon Web // Services Region. // // This member is required. TargetDbClusterIdentifier *string // Specifies whether to allow data loss for this global database cluster // operation. Allowing data loss triggers a global failover operation. // // If you don't specify AllowDataLoss , the global database cluster operation // defaults to a switchover. // // Constraints: // // - Can't be specified together with the Switchover parameter. AllowDataLoss *bool // Specifies whether to switch over this global database cluster. // // Constraints: // // - Can't be specified together with the AllowDataLoss parameter. Switchover *bool // contains filtered or unexported fields }
type FailoverGlobalClusterOutput ¶ added in v1.2.0
type FailoverGlobalClusterOutput struct { // A data type representing an Aurora global database. GlobalCluster *types.GlobalCluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type HTTPPresignerV4 ¶ added in v0.30.0
type HTTPPresignerV4 interface { PresignHTTP( ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions), ) (url string, signedHeader http.Header, err error) }
HTTPPresignerV4 represents presigner interface used by presign url client
type HTTPSignerV4 ¶
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // 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]in the Amazon // RDS User Guide. // // [Constructing an ARN for Amazon RDS]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing // // This member is required. ResourceName *string // This parameter isn't currently supported. Filters []types.Filter // contains filtered or unexported fields }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // List of tags returned by the ListTagsForResource operation. TagList []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ModifyActivityStreamInput ¶ added in v1.23.0
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 types.AuditPolicyState // The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB // instance. For example, arn:aws:rds:us-east-1:12345667890:db:my-orcl-db . ResourceArn *string // contains filtered or unexported fields }
type ModifyActivityStreamOutput ¶ added in v1.23.0
type ModifyActivityStreamOutput struct { // Indicates whether engine-native audit fields are included in the database // activity stream. EngineNativeAuditFieldsIncluded *bool // The name of the Amazon Kinesis data stream to be used for the database activity // stream. KinesisStreamName *string // The Amazon Web Services KMS key identifier for encryption of messages in the // database activity stream. KmsKeyId *string // The mode of the database activity stream. Mode types.ActivityStreamMode // The status of the modification to the policy state of the database activity // stream. PolicyStatus types.ActivityStreamPolicyStatus // The status of the modification to the database activity stream. Status types.ActivityStreamStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ModifyCertificatesInput ¶
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 // Specifies whether to remove the override for the default certificate. If the // override is removed, the default certificate is the system default. RemoveCustomerOverride *bool // contains filtered or unexported fields }
type ModifyCertificatesOutput ¶
type ModifyCertificatesOutput struct { // A CA certificate for an Amazon Web Services account. // // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon // Aurora User Guide. // // [Using SSL/TLS to encrypt a connection to a DB cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html // [Using SSL/TLS to encrypt a connection to a DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html Certificate *types.Certificate // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ModifyCurrentDBClusterCapacityInput ¶
type ModifyCurrentDBClusterCapacityInput struct { // 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. // // This member is required. DBClusterIdentifier *string // 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 *int32 // 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 *int32 // 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 // contains filtered or unexported fields }
type ModifyCurrentDBClusterCapacityOutput ¶
type ModifyCurrentDBClusterCapacityOutput struct { // The current capacity of the DB cluster. CurrentCapacity *int32 // A user-supplied DB cluster identifier. This identifier is the unique key that // identifies a DB cluster. DBClusterIdentifier *string // A value that specifies the capacity that the DB cluster scales to next. PendingCapacity *int32 // The number of seconds before a call to ModifyCurrentDBClusterCapacity times out. SecondsBeforeTimeout *int32 // The timeout action of a call to ModifyCurrentDBClusterCapacity , either // ForceApplyCapacityChange or RollbackCapacityChange . TimeoutAction *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ModifyCustomDBEngineVersionInput ¶ added in v1.11.0
type ModifyCustomDBEngineVersionInput struct { // The database engine. RDS Custom for Oracle supports the following values: // // - custom-oracle-ee // // - custom-oracle-ee-cdb // // - custom-oracle-se2 // // - custom-oracle-se2-cdb // // This member is required. Engine *string // 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. // // This member is required. EngineVersion *string // An optional description of your CEV. Description *string // 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 types.CustomEngineVersionStatus // contains filtered or unexported fields }
type ModifyCustomDBEngineVersionOutput ¶ added in v1.11.0
type ModifyCustomDBEngineVersionOutput struct { // The creation time of the DB engine version. CreateTime *time.Time // JSON string that lists the installation files and parameters that RDS Custom // uses to create a custom engine version (CEV). RDS Custom applies the patches in // the order in which they're listed in the manifest. You can set the Oracle home, // Oracle base, and UNIX/Linux user and group using the installation parameters. // For more information, see [JSON fields in the CEV manifest]in the Amazon RDS User Guide. // // [JSON fields in the CEV manifest]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields CustomDBEngineVersionManifest *string // The description of the database engine. DBEngineDescription *string // A value that indicates the source media provider of the AMI based on the usage // operation. Applicable for RDS Custom for SQL Server. DBEngineMediaType *string // The ARN of the custom engine version. DBEngineVersionArn *string // The description of the database engine version. DBEngineVersionDescription *string // The name of the DB parameter group family for the database engine. DBParameterGroupFamily *string // The name of the Amazon S3 bucket that contains your database installation files. DatabaseInstallationFilesS3BucketName *string // The Amazon S3 directory that contains the database installation files. If not // specified, then no prefix is assumed. DatabaseInstallationFilesS3Prefix *string // The default character set for new instances of this engine version, if the // CharacterSetName parameter of the CreateDBInstance API isn't specified. DefaultCharacterSet *types.CharacterSet // The name of the database engine. Engine *string // The version number of the database engine. EngineVersion *string // The types of logs that the database engine has available for export to // CloudWatch Logs. ExportableLogTypes []string // The EC2 image Image *types.CustomDBEngineVersionAMI // 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 // The major engine version of the CEV. MajorEngineVersion *string // Specifies any Aurora Serverless v2 properties or limits that differ between // Aurora engine versions. You can test the values of this attribute when deciding // which Aurora version to use in a new or upgraded DB cluster. You can also // retrieve the version of an existing DB cluster and check whether that version // supports certain Aurora Serverless v2 features before you attempt to use those // features. ServerlessV2FeaturesSupport *types.ServerlessV2FeaturesSupport // The status of the DB engine version, either available or deprecated . Status *string // A list of the supported CA certificate identifiers. // // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon // Aurora User Guide. // // [Using SSL/TLS to encrypt a connection to a DB cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html // [Using SSL/TLS to encrypt a connection to a DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html SupportedCACertificateIdentifiers []string // A list of the character sets supported by this engine for the CharacterSetName // parameter of the CreateDBInstance operation. SupportedCharacterSets []types.CharacterSet // A list of the supported DB engine modes. SupportedEngineModes []string // 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-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 // A list of the character sets supported by the Oracle DB engine for the // NcharCharacterSetName parameter of the CreateDBInstance operation. SupportedNcharCharacterSets []types.CharacterSet // A list of the time zones supported by this engine for the Timezone parameter of // the CreateDBInstance action. SupportedTimezones []types.Timezone // Indicates whether the engine version supports Babelfish for Aurora PostgreSQL. SupportsBabelfish *bool // Indicates whether the engine version supports rotating the server certificate // without rebooting the DB instance. SupportsCertificateRotationWithoutRestart *bool // Indicates whether you can use Aurora global databases with a specific DB engine // version. SupportsGlobalDatabases *bool // Indicates whether the DB engine version supports zero-ETL integrations with // Amazon Redshift. SupportsIntegrations *bool // Indicates whether the DB engine version supports Aurora Limitless Database. SupportsLimitlessDatabase *bool // Indicates whether the DB engine version supports forwarding write operations // from reader DB instances to the writer DB instance in the DB cluster. By // default, write operations aren't allowed on reader DB instances. // // Valid for: Aurora DB clusters only SupportsLocalWriteForwarding *bool // Indicates whether the engine version supports exporting the log types specified // by ExportableLogTypes to CloudWatch Logs. SupportsLogExportsToCloudwatchLogs *bool // Indicates whether you can use Aurora parallel query with a specific DB engine // version. SupportsParallelQuery *bool // Indicates whether the database engine version supports read replicas. SupportsReadReplica *bool // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html TagList []types.Tag // A list of engine versions that this database engine version can be upgraded to. ValidUpgradeTarget []types.UpgradeTarget // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
This data type is used as a response element in the action DescribeDBEngineVersions .
type ModifyDBClusterEndpointInput ¶
type ModifyDBClusterEndpointInput struct { // The identifier of the endpoint to modify. This parameter is stored as a // lowercase string. // // This member is required. DBClusterEndpointIdentifier *string // The type of the endpoint. One of: READER , WRITER , ANY . EndpointType *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 // List of DB instance identifiers that are part of the custom endpoint group. StaticMembers []string // contains filtered or unexported fields }
type ModifyDBClusterEndpointOutput ¶
type ModifyDBClusterEndpointOutput struct { // The type associated with a custom endpoint. One of: READER , WRITER , ANY . CustomEndpointType *string // The Amazon Resource Name (ARN) for the endpoint. DBClusterEndpointArn *string // The identifier associated with the endpoint. This parameter is stored as a // lowercase string. DBClusterEndpointIdentifier *string // A unique system-generated identifier for an endpoint. It remains the same for // the whole life of the endpoint. DBClusterEndpointResourceIdentifier *string // The DB cluster identifier of the DB cluster associated with the endpoint. This // parameter is stored as a lowercase string. DBClusterIdentifier *string // The DNS address of the endpoint. Endpoint *string // The type of the endpoint. One of: READER , WRITER , CUSTOM . EndpointType *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 // List of DB instance identifiers that are part of the custom endpoint group. StaticMembers []string // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // 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 .
type ModifyDBClusterInput ¶
type ModifyDBClusterInput struct { // The DB cluster identifier for the cluster being modified. This parameter isn't // case-sensitive. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Constraints: // // - Must match the identifier of an existing DB cluster. // // This member is required. DBClusterIdentifier *string // The amount of storage in gibibytes (GiB) to allocate to each DB instance in the // Multi-AZ DB cluster. // // Valid for Cluster Type: Multi-AZ DB clusters only AllocatedStorage *int32 // Specifies whether engine mode changes from serverless to provisioned are // allowed. // // Valid for Cluster Type: Aurora Serverless v1 DB clusters only // // Constraints: // // - You must allow engine mode changes when specifying a different value for // the EngineMode parameter from the DB cluster's current engine mode. AllowEngineModeChange *bool // Specifies whether major version upgrades are allowed. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // 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. AllowMajorVersionUpgrade *bool // Specifies whether the modifications in this request 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. // // Most modifications can be applied immediately or during the next scheduled // maintenance window. Some modifications, such as turning on deletion protection // and changing the master password, are applied immediately—regardless of when you // choose to apply them. // // By default, this parameter is disabled. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters ApplyImmediately *bool // Specifies 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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters AutoMinorVersionUpgrade *bool // The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services // Backup. AwsBackupRecoveryPointArn *string // The target backtrack window, in seconds. To disable backtracking, set this // value to 0 . // // Valid for Cluster Type: Aurora MySQL DB clusters only // // Default: 0 // // Constraints: // // - If specified, this value must be set to a number from 0 to 259,200 (72 // hours). BacktrackWindow *int64 // The number of days for which automated backups are retained. Specify a minimum // value of 1 . // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Default: 1 // // Constraints: // // - Must be a value from 1 to 35. BackupRetentionPeriod *int32 // The CA certificate identifier to use for the DB cluster's server certificate. // // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide. // // Valid for Cluster Type: Multi-AZ DB clusters // // [Using SSL/TLS to encrypt a connection to a DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html CACertificateIdentifier *string // The configuration setting for the log types to be enabled for export to // CloudWatch Logs for a specific DB cluster. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // The following values are valid for each DB engine: // // - Aurora MySQL - audit | error | general | slowquery // // - Aurora PostgreSQL - postgresql // // - RDS for MySQL - error | general | slowquery // // - RDS for PostgreSQL - postgresql | upgrade // // For more information about exporting CloudWatch Logs for Amazon RDS, see [Publishing Database Logs to Amazon CloudWatch Logs] in // the Amazon RDS User Guide. // // For more information about exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs] in // the Amazon Aurora User Guide. // // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch CloudwatchLogsExportConfiguration *types.CloudwatchLogsExportConfiguration // Specifies whether to copy all tags from the DB cluster to snapshots of the DB // cluster. The default is not to copy them. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters CopyTagsToSnapshot *bool // The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, // for example db.m6gd.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] // in the Amazon RDS User Guide. // // Valid for Cluster Type: Multi-AZ DB clusters only // // [DB Instance Class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html DBClusterInstanceClass *string // The name of the DB cluster parameter group to use for the DB cluster. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters DBClusterParameterGroupName *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. // // Valid for Cluster Type: Aurora DB clusters only // // 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. DBInstanceParameterGroupName *string // Specifies the mode of Database Insights to enable for the DB cluster. // // If you change the value from standard to advanced , you must set the // PerformanceInsightsEnabled parameter to true and the // PerformanceInsightsRetentionPeriod parameter to 465. // // If you change the value from advanced to standard , you must set the // PerformanceInsightsEnabled parameter to false . // // Valid for Cluster Type: Aurora DB clusters only DatabaseInsightsMode types.DatabaseInsightsMode // Specifies 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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters DeletionProtection *bool // 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] in the Amazon Aurora User Guide. // // Valid for Cluster Type: Aurora DB clusters only // // [Kerberos Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html Domain *string // The name of the IAM role to use when making API calls to the Directory Service. // // Valid for Cluster Type: Aurora DB clusters only DomainIAMRoleName *string // Specifies whether to enable this DB cluster to forward write operations to the // primary cluster of a global cluster (Aurora global database). 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 a global cluster API // operation, but it does nothing until then. // // Valid for Cluster Type: Aurora DB clusters only EnableGlobalWriteForwarding *bool // Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB // cluster. By default, the HTTP endpoint isn't enabled. // // When enabled, the HTTP endpoint provides a connectionless web service API (RDS // Data 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 RDS query // editor. // // For more information, see [Using RDS Data API] in the Amazon Aurora User Guide. // // This parameter applies only to Aurora Serverless v1 DB clusters. To enable or // disable the HTTP endpoint for an Aurora Serverless v2 or provisioned DB cluster, // use the EnableHttpEndpoint and DisableHttpEndpoint operations. // // Valid for Cluster Type: Aurora DB clusters only // // [Using RDS Data API]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html EnableHttpEndpoint *bool // Specifies 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] in the Amazon Aurora User Guide or [IAM database authentication for MariaDB, MySQL, and PostgreSQL] in the Amazon // RDS User Guide. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // [IAM Database Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html // [IAM database authentication for MariaDB, MySQL, and PostgreSQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool // Specifies whether to enable Aurora Limitless Database. You must enable Aurora // Limitless Database to create a DB shard group. // // Valid for: Aurora DB clusters only // // This setting is no longer used. Instead use the ClusterScalabilityType setting // when you create your Aurora Limitless Database DB cluster. EnableLimitlessDatabase *bool // Specifies whether read replicas can forward write operations to the writer DB // instance in the DB cluster. By default, write operations aren't allowed on // reader DB instances. // // Valid for: Aurora DB clusters only EnableLocalWriteForwarding *bool // Specifies whether to turn on Performance Insights for the DB cluster. // // For more information, see [Using Amazon Performance Insights] in the Amazon RDS User Guide. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // [Using Amazon Performance Insights]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html EnablePerformanceInsights *bool // The DB engine mode of the DB cluster, either provisioned or serverless . // // The DB engine mode can be modified only from serverless to provisioned . // // For more information, see [CreateDBCluster]. // // Valid for Cluster Type: Aurora DB clusters only // // [CreateDBCluster]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html EngineMode *string // 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. // // If the cluster that you're modifying has one or more read replicas, all // replicas must be running an engine version that's the same or later than the // version you specify. // // To list all of the available engine versions for Aurora MySQL, 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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters EngineVersion *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] in the Amazon RDS User Guide. // // Valid for Cluster Type: Multi-AZ DB clusters only // // Constraints: // // - Must be a multiple between .5 and 50 of the storage amount for the DB // cluster. // // [Amazon RDS Provisioned IOPS storage]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS Iops *int32 // Specifies whether to manage the master user password with Amazon Web Services // Secrets Manager. // // If the DB cluster doesn't manage the master user password with Amazon Web // Services Secrets Manager, you can turn on this management. In this case, you // can't specify MasterUserPassword . // // If the DB cluster already manages the master user password with Amazon Web // Services Secrets Manager, and you specify that the master user password is not // managed with Amazon Web Services Secrets Manager, then you must specify // MasterUserPassword . In this case, RDS deletes the secret and uses the new // password for the master user specified by MasterUserPassword . // // For more information, see [Password management with Amazon Web Services Secrets Manager] in the Amazon RDS User Guide and [Password management with Amazon Web Services Secrets Manager] in the Amazon // Aurora User Guide. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html ManageMasterUserPassword *bool // The new password for the master database user. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Constraints: // // - Must contain from 8 to 41 characters. // // - Can contain any printable ASCII character except "/", """, or "@". // // - Can't be specified if ManageMasterUserPassword is turned on. MasterUserPassword *string // The Amazon Web Services KMS key identifier to encrypt a secret that is // automatically generated and managed in Amazon Web Services Secrets Manager. // // This setting is valid only if both of the following conditions are met: // // - The DB cluster doesn't manage the master user password in Amazon Web // Services Secrets Manager. // // If the DB cluster already manages the master user password in Amazon Web // Services Secrets Manager, you can't change the KMS key that is used to encrypt // the secret. // // - You are turning on ManageMasterUserPassword to manage the master user // password in Amazon Web Services Secrets Manager. // // If you are turning on ManageMasterUserPassword and don't specify // MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS key is used to // encrypt the secret. If the secret is in a different Amazon Web Services account, // then you can't use the aws/secretsmanager KMS key to encrypt the secret, and // you must use a customer managed KMS key. // // 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. // // 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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters MasterUserSecretKmsKeyId *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 . // // If MonitoringRoleArn is specified, also set MonitoringInterval to a value other // than 0 . // // Valid for Cluster Type: Multi-AZ DB clusters only // // Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 // // Default: 0 MonitoringInterval *int32 // 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]in the Amazon RDS User Guide. // // If MonitoringInterval is set to a value other than 0 , supply a // MonitoringRoleArn value. // // Valid for Cluster Type: Multi-AZ DB clusters only // // [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 MonitoringRoleArn *string // The network type of the DB cluster. // // 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] in the Amazon Aurora User Guide. // // Valid for Cluster Type: Aurora DB clusters only // // Valid Values: IPV4 | DUAL // // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *string // The new DB cluster identifier for the DB cluster when renaming a DB cluster. // This value is stored as a lowercase string. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // 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 NewDBClusterIdentifier *string // The option group to associate the DB cluster with. // // DB clusters are associated with a default option group that can't be modified. OptionGroupName *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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters PerformanceInsightsKMSKeyId *string // The number of days to retain Performance Insights data. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Valid Values: // // - 7 // // - month * 31, where month is a number of months from 1-23. Examples: 93 (3 // months * 31), 341 (11 months * 31), 589 (19 months * 31) // // - 731 // // Default: 7 days // // If you specify a retention period that isn't valid, such as 94 , Amazon RDS // issues an error. PerformanceInsightsRetentionPeriod *int32 // The port number on which the DB cluster accepts connections. // // Valid for Cluster Type: Aurora DB clusters only // // Valid Values: 1150-65535 // // Default: The same port as the original DB cluster. Port *int32 // 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]in the Amazon Aurora User Guide. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // 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. // // [Backup window]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow PreferredBackupWindow *string // The weekly time range during which system maintenance can occur, in Universal // Coordinated Time (UTC). // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // 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]in the Amazon Aurora User Guide. // // Constraints: // // - Must be in the format ddd:hh24:mi-ddd:hh24:mi . // // - Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun . // // - Must be in Universal Coordinated Time (UTC). // // - Must be at least 30 minutes. // // [Adjusting the Preferred DB Cluster Maintenance Window]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora PreferredMaintenanceWindow *string // Specifies whether to rotate the secret managed by Amazon Web Services Secrets // Manager for the master user password. // // This setting is valid only if the master user password is managed by RDS in // Amazon Web Services Secrets Manager for the DB cluster. The secret value // contains the updated password. // // For more information, see [Password management with Amazon Web Services Secrets Manager] in the Amazon RDS User Guide and [Password management with Amazon Web Services Secrets Manager] in the Amazon // Aurora User Guide. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Constraints: // // - You must apply the change immediately when rotating the master user // password. // // [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html RotateMasterUserPassword *bool // The scaling properties of the DB cluster. You can only modify scaling // properties for DB clusters in serverless DB engine mode. // // Valid for Cluster Type: Aurora DB clusters only ScalingConfiguration *types.ScalingConfiguration // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. // // For more information, see [Using Amazon Aurora Serverless v2] in the Amazon Aurora User Guide. // // [Using Amazon Aurora Serverless v2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration // The storage type to associate with the DB cluster. // // For information on storage types for Aurora DB clusters, see [Storage configurations for Amazon Aurora DB clusters]. For information // on storage types for Multi-AZ DB clusters, see [Settings for creating Multi-AZ DB clusters]. // // When specified for a Multi-AZ DB cluster, a value for the Iops parameter is // required. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Valid Values: // // - Aurora DB clusters - aurora | aurora-iopt1 // // - Multi-AZ DB clusters - io1 | io2 | gp3 // // Default: // // - Aurora DB clusters - aurora // // - Multi-AZ DB clusters - io1 // // [Storage configurations for Amazon Aurora DB clusters]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type // [Settings for creating Multi-AZ DB clusters]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings StorageType *string // A list of EC2 VPC security groups to associate with this DB cluster. // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters VpcSecurityGroupIds []string // contains filtered or unexported fields }
type ModifyDBClusterOutput ¶
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?] in the Amazon Aurora // User Guide. // // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User // Guide. // // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ModifyDBClusterParameterGroupInput ¶
type ModifyDBClusterParameterGroupInput struct { // The name of the DB cluster parameter group to modify. // // This member is required. DBClusterParameterGroupName *string // 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. // // This member is required. Parameters []types.Parameter // contains filtered or unexported fields }
type ModifyDBClusterParameterGroupOutput ¶
type ModifyDBClusterParameterGroupOutput 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ModifyDBClusterSnapshotAttributeInput ¶
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. // // This member is required. AttributeName *string // The identifier for the DB cluster snapshot to modify the attributes for. // // This member is required. DBClusterSnapshotIdentifier *string // 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 // 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 // contains filtered or unexported fields }
type ModifyDBClusterSnapshotAttributeOutput ¶
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 *types.DBClusterSnapshotAttributesResult // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ModifyDBInstanceInput ¶
type ModifyDBInstanceInput struct { // The identifier of DB instance to modify. This value is stored as a lowercase // string. // // Constraints: // // - Must match the identifier of an existing DB instance. // // This member is required. DBInstanceIdentifier *string // The new amount of storage in gibibytes (GiB) to allocate for the DB instance. // // For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for // 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 // . // // Constraints: // // - When you increase the allocated storage for a DB instance that uses // Provisioned IOPS ( gp3 , io1 , or io2 storage type), you must also specify the // Iops parameter. You can use the current value for Iops . AllocatedStorage *int32 // Specifies 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 DB instances. // // Constraints: // // - Major version upgrades must be allowed when specifying a value for the // EngineVersion parameter that's a different major version than the DB // instance's current version. AllowMajorVersionUpgrade *bool // Specifies 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]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. // // [Modifying a DB Instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html ApplyImmediately *bool // Specifies 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, Amazon RDS applies the change as // soon as possible and doesn't cause an outage. // // For an RDS Custom DB instance, don't enable this setting. Otherwise, the // operation returns an error. AutoMinorVersionUpgrade *bool // The automation mode of the RDS Custom DB instance. If full , the DB instance // automates monitoring and instance recovery. If all paused , the instance pauses // automation for the duration set by ResumeFullAutomationModeMinutes . AutomationMode types.AutomationMode // The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services // Backup. // // This setting doesn't apply to RDS Custom DB instances. AwsBackupRecoveryPointArn *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. // // This setting doesn't apply to Amazon Aurora DB instances. The retention period // for automated backups is managed by the DB cluster. For more information, see // ModifyDBCluster . // // Default: Uses existing setting // // 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 *int32 // The CA certificate identifier to use for the DB instance's server certificate. // // This setting doesn't apply to RDS Custom DB instances. // // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon // Aurora User Guide. // // [Using SSL/TLS to encrypt a connection to a DB cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html // [Using SSL/TLS to encrypt a connection to a DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html CACertificateIdentifier *string // Specifies 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.]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]in the Amazon Aurora User Guide. // // This setting doesn't apply to RDS Custom DB instances. // // [Rotating Your SSL/TLS Certificate.]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html // [Rotating Your SSL/TLS Certificate]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html CertificateRotationRestart *bool // 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 DB instances. // // The following values are valid for each DB engine: // // - Aurora MySQL - audit | error | general | slowquery // // - Aurora PostgreSQL - postgresql // // - RDS for MySQL - error | general | slowquery // // - RDS for PostgreSQL - postgresql | upgrade // // For more information about exporting CloudWatch Logs for Amazon RDS, see [Publishing Database Logs to Amazon CloudWatch Logs] in // the Amazon RDS User Guide. // // For more information about exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs] in // the Amazon Aurora User Guide. // // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch CloudwatchLogsExportConfiguration *types.CloudwatchLogsExportConfiguration // Specifies whether to copy all tags from the DB instance to snapshots of the DB // instance. By default, tags aren't copied. // // This setting doesn't apply to Amazon Aurora DB instances. 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 // 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 Class]in the Amazon RDS User Guide or [Aurora DB instance classes] in the // Amazon Aurora User Guide. For RDS Custom, see [DB instance class support for RDS Custom for Oracle]and [DB instance class support for RDS Custom for SQL Server]. // // If you modify the DB instance class, an outage occurs during the change. The // change is applied during the next maintenance window, unless you specify // ApplyImmediately in your request. // // Default: Uses existing setting // // Constraints: // // - If you are modifying the DB instance class and upgrading the engine version // at the same time, the currently running engine version must be supported on the // specified DB instance class. Otherwise, the operation returns an error. In this // case, first run the operation to upgrade the engine version, and then run it // again to modify the DB instance class. // // [Aurora DB instance classes]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html // [DB instance class support for RDS Custom for SQL Server]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html#custom-reqs-limits.instancesMS // [DB instance class support for RDS Custom for Oracle]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits.html#custom-reqs-limits.instances // [DB Instance Class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html DBInstanceClass *string // 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 DB instances. // // Default: Uses existing setting // // Constraints: // // - Must be in the same DB parameter group family as the DB instance. DBParameterGroupName *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 DB instances. // // Valid Values: 1150-65535 // // Default: // // - Amazon Aurora - 3306 // // - RDS for Db2 - 50000 // // - RDS for MariaDB - 3306 // // - RDS for Microsoft SQL Server - 1433 // // - RDS for MySQL - 3306 // // - RDS for Oracle - 1521 // // - RDS for PostgreSQL - 5432 // // Constraints: // // - For RDS for Microsoft SQL Server, the value can't be 1234 , 1434 , 3260 , // 3343 , 3389 , 47001 , or 49152-49156 . DBPortNumber *int32 // 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 DB instances. // // Constraints: // // - If supplied, must match existing DB security groups. DBSecurityGroups []string // 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]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 setting doesn't apply to RDS Custom DB instances. // // Constraints: // // - If supplied, must match existing DB subnet group. // // Example: mydbsubnetgroup // // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC DBSubnetGroupName *string // Specifies the mode of Database Insights to enable for the DB instance. // // This setting only applies to Amazon Aurora DB instances. // // Currently, this value is inherited from the DB cluster and can't be changed. DatabaseInsightsMode types.DatabaseInsightsMode // Indicates whether the DB instance has a dedicated log volume (DLV) enabled. DedicatedLogVolume *bool // Specifies 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]. // // This setting doesn't apply to Amazon Aurora DB instances. You can enable or // disable deletion protection for the DB cluster. For more information, see // ModifyDBCluster . DB instances in a DB cluster can be deleted even when deletion // protection is enabled for the DB cluster. // // [Deleting a DB Instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html DeletionProtection *bool // Specifies whether to remove the DB instance from the Active Directory domain. DisableDomain *bool // 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 Db2, MySQL, Microsoft SQL Server, // Oracle, and PostgreSQL DB instances in an Active Directory Domain. // // For more information, see [Kerberos Authentication] in the Amazon RDS User Guide. // // This setting doesn't apply to RDS Custom DB instances. // // [Kerberos Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html Domain *string // The ARN for the Secrets Manager secret with the credentials for the user // joining the domain. // // Example: // arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456 DomainAuthSecretArn *string // The IPv4 DNS IP addresses of your primary and secondary Active Directory domain // controllers. // // Constraints: // // - Two IP addresses must be provided. If there isn't a secondary domain // controller, use the IP address of the primary domain controller for both entries // in the list. // // Example: 123.124.125.126,234.235.236.237 DomainDnsIps []string // The fully qualified domain name (FQDN) of an Active Directory domain. // // Constraints: // // - Can't be longer than 64 characters. // // Example: mymanagedADtest.mymanagedAD.mydomain DomainFqdn *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 DB instances. DomainIAMRoleName *string // The Active Directory organizational unit for your DB instance to join. // // Constraints: // // - Must be in the distinguished name format. // // - Can't be longer than 64 characters. // // Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain DomainOu *string // Specifies 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] in the Amazon RDS User Guide. // // For more information about CoIPs, see [Customer-owned IP addresses] in the Amazon Web Services Outposts User // Guide. // // [Working with Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html // [Customer-owned IP addresses]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing EnableCustomerOwnedIp *bool // Specifies 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] in the Amazon RDS // User Guide. // // This setting doesn't apply to RDS Custom DB instances. // // [IAM Database Authentication for MySQL and PostgreSQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool // Specifies whether to enable Performance Insights for the DB instance. // // For more information, see [Using Amazon Performance Insights] in the Amazon RDS User Guide. // // This setting doesn't apply to RDS Custom DB instances. // // [Using Amazon Performance Insights]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html EnablePerformanceInsights *bool // The target Oracle DB engine when you convert a non-CDB to a CDB. This // intermediate step is necessary to upgrade an Oracle Database 19c non-CDB to an // Oracle Database 21c CDB. // // Note the following requirements: // // - Make sure that you specify oracle-ee-cdb or oracle-se2-cdb . // // - Make sure that your DB engine runs Oracle Database 19c with an April 2021 // or later RU. // // Note the following limitations: // // - You can't convert a CDB to a non-CDB. // // - You can't convert a replica database. // // - You can't convert a non-CDB to a CDB and upgrade the engine version in the // same command. // // - You can't convert the existing custom parameter or option group when it has // options or parameters that are permanent or persistent. In this situation, the // DB instance reverts to the default option and parameter group. To avoid // reverting to the default, specify a new parameter group with // --db-parameter-group-name and a new option group with --option-group-name . Engine *string // 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 updates 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 . // // If the instance that you're modifying is acting as a read replica, the engine // version that you specify must be the same or higher than the version that the // source DB instance or cluster is running. // // In RDS Custom for Oracle, this parameter is supported for read replicas only if // they are in the PATCH_DB_FAILURE lifecycle. // // Constraints: // // - If you are upgrading the engine version and modifying the DB instance class // at the same time, the currently running engine version must be supported on the // specified DB instance class. Otherwise, the operation returns an error. In this // case, first run the operation to upgrade the engine version, and then run it // again to modify the DB instance class. EngineVersion *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 RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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. // // - When you increase the Provisioned IOPS, you must also specify the // AllocatedStorage parameter. You can use the current value for AllocatedStorage // . // // Default: Uses existing setting Iops *int32 // The license model for the DB instance. // // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. // // Valid Values: // // - RDS for Db2 - bring-your-own-license // // - RDS for MariaDB - general-public-license // // - RDS for Microsoft SQL Server - license-included // // - RDS for MySQL - general-public-license // // - RDS for Oracle - bring-your-own-license | license-included // // - RDS for PostgreSQL - postgresql-license LicenseModel *string // Specifies whether to manage the master user password with Amazon Web Services // Secrets Manager. // // If the DB instance doesn't manage the master user password with Amazon Web // Services Secrets Manager, you can turn on this management. In this case, you // can't specify MasterUserPassword . // // If the DB instance already manages the master user password with Amazon Web // Services Secrets Manager, and you specify that the master user password is not // managed with Amazon Web Services Secrets Manager, then you must specify // MasterUserPassword . In this case, Amazon RDS deletes the secret and uses the // new password for the master user specified by MasterUserPassword . // // For more information, see [Password management with Amazon Web Services Secrets Manager] in the Amazon RDS User Guide. // // Constraints: // // - Can't manage the master user password with Amazon Web Services Secrets // Manager if MasterUserPassword is specified. // // [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html ManageMasterUserPassword *bool // The new password for the master user. // // 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. // // Amazon RDS API operations never return the password, so this operation 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. // // This setting doesn't apply to the following DB instances: // // - Amazon Aurora (The password for the master user is managed by the DB // cluster. For more information, see ModifyDBCluster .) // // - RDS Custom // // Default: Uses existing setting // // Constraints: // // - Can't be specified if ManageMasterUserPassword is turned on. // // - Can include any printable ASCII character except "/", """, or "@". For RDS // for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) // character. // // Length Constraints: // // - RDS for Db2 - Must contain from 8 to 255 characters. // // - RDS for MariaDB - Must contain from 8 to 41 characters. // // - RDS for Microsoft SQL Server - Must contain from 8 to 128 characters. // // - RDS for MySQL - Must contain from 8 to 41 characters. // // - RDS for Oracle - Must contain from 8 to 30 characters. // // - RDS for PostgreSQL - Must contain from 8 to 128 characters. MasterUserPassword *string // The Amazon Web Services KMS key identifier to encrypt a secret that is // automatically generated and managed in Amazon Web Services Secrets Manager. // // This setting is valid only if both of the following conditions are met: // // - The DB instance doesn't manage the master user password in Amazon Web // Services Secrets Manager. // // If the DB instance already manages the master user password in Amazon Web // Services Secrets Manager, you can't change the KMS key used to encrypt the // secret. // // - You are turning on ManageMasterUserPassword to manage the master user // password in Amazon Web Services Secrets Manager. // // If you are turning on ManageMasterUserPassword and don't specify // MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS key is used to // encrypt the secret. If the secret is in a different Amazon Web Services account, // then you can't use the aws/secretsmanager KMS key to encrypt the secret, and // you must use a customer managed KMS key. // // 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. // // 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. MasterUserSecretKmsKeyId *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]in the Amazon RDS User Guide. // // This setting doesn't apply to RDS Custom DB instances. // // [Managing capacity automatically with Amazon RDS storage autoscaling]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling MaxAllocatedStorage *int32 // 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 . // // If MonitoringRoleArn is specified, set MonitoringInterval to a value other than // 0 . // // This setting doesn't apply to RDS Custom DB instances. // // Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 // // Default: 0 MonitoringInterval *int32 // 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]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 DB instances. // // [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 MonitoringRoleArn *string // Specifies 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 DB instances. MultiAZ *bool // Specifies whether the to convert your DB instance from the single-tenant // configuration to the multi-tenant configuration. This parameter is supported only // for RDS for Oracle CDB instances. // // During the conversion, RDS creates an initial tenant database and associates // the DB name, master user name, character set, and national character set // metadata with this database. The tags associated with the instance also // propagate to the initial tenant database. You can add more tenant databases to // your DB instance by using the CreateTenantDatabase operation. // // The conversion to the multi-tenant configuration is permanent and irreversible, // so you can't later convert back to the single-tenant configuration. When you // specify this parameter, you must also specify ApplyImmediately . MultiTenant *bool // The network type of the DB instance. // // 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] in the Amazon RDS User Guide. // // Valid Values: IPV4 | DUAL // // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *string // The new 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 ApplyImmediately . This value is stored as a lowercase string. // // This setting doesn't apply to RDS Custom DB instances. // // 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 // The option group to associate the DB instance with. // // 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 DB instances. OptionGroupName *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. // // This setting doesn't apply to RDS Custom DB instances. PerformanceInsightsKMSKeyId *string // The number of days to retain Performance Insights data. // // This setting doesn't apply to RDS Custom DB instances. // // Valid Values: // // - 7 // // - month * 31, where month is a number of months from 1-23. Examples: 93 (3 // months * 31), 341 (11 months * 31), 589 (19 months * 31) // // - 731 // // Default: 7 days // // If you specify a retention period that isn't valid, such as 94 , Amazon RDS // returns an error. PerformanceInsightsRetentionPeriod *int32 // 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]in the Amazon RDS User Guide. // // This setting doesn't apply to Amazon Aurora DB instances. 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 Coordinated Time (UTC). // // - Must not conflict with the preferred maintenance window. // // - Must be at least 30 minutes. // // [Backup window]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow PreferredBackupWindow *string // The weekly time range 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 // causes a reboot of the DB instance. If you change 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] in the Amazon RDS User Guide. // // Default: Uses existing setting // // Constraints: // // - Must be in the format ddd:hh24:mi-ddd:hh24:mi . // // - The day values must be 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. // // [Amazon RDS Maintenance Window]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance PreferredMaintenanceWindow *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 DB instances. ProcessorFeatures []types.ProcessorFeature // The order of priority 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]in the Amazon Aurora User Guide. // // This setting doesn't apply to RDS Custom DB instances. // // Default: 1 // // Valid Values: 0 - 15 // // [Fault Tolerance for an Aurora DB Cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance PromotionTier *int32 // Specifies whether the DB instance is publicly accessible. // // When the DB instance is publicly accessible and you connect from outside of the // DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint // resolves to the public IP address. When you connect from within the same VPC as // the DB instance, the endpoint resolves to the private IP address. Access to the // DB instance is ultimately controlled by the security group it uses. That public // access isn't 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. // // 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 // 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]in the Amazon RDS User // Guide. // // This setting doesn't apply to RDS Custom DB instances. // // [Working with Oracle Read Replicas for Amazon RDS]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html ReplicaMode types.ReplicaMode // The number of minutes to pause the automation. When the time period ends, RDS // Custom resumes full automation. // // Default: 60 // // Constraints: // // - Must be at least 60. // // - Must be no more than 1,440. ResumeFullAutomationModeMinutes *int32 // Specifies whether to rotate the secret managed by Amazon Web Services Secrets // Manager for the master user password. // // This setting is valid only if the master user password is managed by RDS in // Amazon Web Services Secrets Manager for the DB cluster. The secret value // contains the updated password. // // For more information, see [Password management with Amazon Web Services Secrets Manager] in the Amazon RDS User Guide. // // Constraints: // // - You must apply the change immediately when rotating the master user // password. // // [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html RotateMasterUserPassword *bool // The storage throughput value for the DB instance. // // This setting applies only to the gp3 storage type. // // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. StorageThroughput *int32 // The storage type to associate with the DB instance. // // If you specify io1 , io2 , or gp3 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: gp2 | gp3 | io1 | io2 | standard // // Default: io1 , if the Iops parameter is specified. Otherwise, gp2 . StorageType *string // The ARN from the key store with which to associate the instance for TDE // encryption. // // This setting doesn't apply to RDS Custom DB instances. TdeCredentialArn *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 DB instances. TdeCredentialPassword *string // Specifies whether the DB instance class of the DB instance uses its default // processor features. // // This setting doesn't apply to RDS Custom DB instances. UseDefaultProcessorFeatures *bool // A list of Amazon EC2 VPC security groups to associate with this DB instance. // This change is asynchronously applied as soon as possible. // // This setting doesn't apply to the following DB instances: // // - Amazon Aurora (The associated list of EC2 VPC security groups is managed by // the DB cluster. For more information, see ModifyDBCluster .) // // - RDS Custom // // Constraints: // // - If supplied, must match existing VPC security group IDs. VpcSecurityGroupIds []string // contains filtered or unexported fields }
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 *types.DBInstance // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ModifyDBParameterGroupInput ¶
type ModifyDBParameterGroupInput struct { // The name of the DB parameter group. // // Constraints: // // - If supplied, must match the name of an existing DBParameterGroup . // // This member is required. DBParameterGroupName *string // 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] in the Amazon RDS User // Guide. // // [Working with DB parameter groups]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html // // This member is required. Parameters []types.Parameter // contains filtered or unexported fields }
type ModifyDBParameterGroupOutput ¶
type ModifyDBParameterGroupOutput struct { // The name of the DB parameter group. DBParameterGroupName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup operation.
type ModifyDBProxyEndpointInput ¶ added in v1.2.0
type ModifyDBProxyEndpointInput struct { // The name of the DB proxy sociated with the DB proxy endpoint that you want to // modify. // // This member is required. DBProxyEndpointName *string // 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 // 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 // contains filtered or unexported fields }
type ModifyDBProxyEndpointOutput ¶ added in v1.2.0
type ModifyDBProxyEndpointOutput struct { // The DBProxyEndpoint object representing the new settings for the DB proxy // endpoint. DBProxyEndpoint *types.DBProxyEndpoint // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ModifyDBProxyInput ¶
type ModifyDBProxyInput struct { // The identifier for the DBProxy to modify. // // This member is required. DBProxyName *string // The new authentication settings for the DBProxy . Auth []types.UserAuthConfig // 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 // 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 *int32 // 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 // 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 // The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access // secrets in Amazon Web Services Secrets Manager. RoleArn *string // The new list of security groups for the DBProxy . SecurityGroups []string // contains filtered or unexported fields }
type ModifyDBProxyOutput ¶
type ModifyDBProxyOutput struct { // The DBProxy object representing the new settings for the proxy. DBProxy *types.DBProxy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ModifyDBProxyTargetGroupInput ¶
type ModifyDBProxyTargetGroupInput struct { // The name of the proxy. // // This member is required. DBProxyName *string // The name of the target group to modify. // // This member is required. TargetGroupName *string // The settings that determine the size and behavior of the connection pool for // the target group. ConnectionPoolConfig *types.ConnectionPoolConfiguration // 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 // contains filtered or unexported fields }
type ModifyDBProxyTargetGroupOutput ¶
type ModifyDBProxyTargetGroupOutput struct { // The settings of the modified DBProxyTarget . DBProxyTargetGroup *types.DBProxyTargetGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ModifyDBRecommendationInput ¶ added in v1.65.0
type ModifyDBRecommendationInput struct { // The identifier of the recommendation to update. // // This member is required. RecommendationId *string // The language of the modified recommendation. Locale *string // The list of recommended action status to update. You can update multiple // recommended actions at one time. RecommendedActionUpdates []types.RecommendedActionUpdate // The recommendation status to update. // // Valid values: // // - active // // - dismissed Status *string // contains filtered or unexported fields }
type ModifyDBRecommendationOutput ¶ added in v1.65.0
type ModifyDBRecommendationOutput struct { // The recommendation for your DB instances, DB clusters, and DB parameter groups. DBRecommendation *types.DBRecommendation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ModifyDBShardGroupInput ¶ added in v1.68.0
type ModifyDBShardGroupInput struct { // The name of the DB shard group to modify. // // This member is required. DBShardGroupIdentifier *string // Specifies whether to create standby DB shard groups for the DB shard group. // Valid values are the following: // // - 0 - Creates a DB shard group without a standby DB shard group. This is the // default value. // // - 1 - Creates a DB shard group with a standby DB shard group in a different // Availability Zone (AZ). // // - 2 - Creates a DB shard group with two standby DB shard groups in two // different AZs. ComputeRedundancy *int32 // The maximum capacity of the DB shard group in Aurora capacity units (ACUs). MaxACU *float64 // The minimum capacity of the DB shard group in Aurora capacity units (ACUs). MinACU *float64 // contains filtered or unexported fields }
type ModifyDBShardGroupOutput ¶ added in v1.68.0
type ModifyDBShardGroupOutput struct { // Specifies whether to create standby DB shard groups for the DB shard group. // Valid values are the following: // // - 0 - Creates a DB shard group without a standby DB shard group. This is the // default value. // // - 1 - Creates a DB shard group with a standby DB shard group in a different // Availability Zone (AZ). // // - 2 - Creates a DB shard group with two standby DB shard groups in two // different AZs. ComputeRedundancy *int32 // The name of the primary DB cluster for the DB shard group. DBClusterIdentifier *string // The Amazon Resource Name (ARN) for the DB shard group. DBShardGroupArn *string // The name of the DB shard group. DBShardGroupIdentifier *string // The Amazon Web Services Region-unique, immutable identifier for the DB shard // group. DBShardGroupResourceId *string // The connection endpoint for the DB shard group. Endpoint *string // The maximum capacity of the DB shard group in Aurora capacity units (ACUs). MaxACU *float64 // The minimum capacity of the DB shard group in Aurora capacity units (ACUs). MinACU *float64 // Indicates whether the DB shard group is publicly accessible. // // When the DB shard group is publicly accessible, its Domain Name System (DNS) // endpoint resolves to the private IP address from within the DB shard group's // virtual private cloud (VPC). It resolves to the public IP address from outside // of the DB shard group's VPC. Access to the DB shard group is ultimately // controlled by the security group it uses. That public access isn't permitted if // the security group assigned to the DB shard group doesn't permit it. // // When the DB shard group isn't publicly accessible, it is an internal DB shard // group with a DNS name that resolves to a private IP address. // // For more information, see CreateDBShardGroup. // // This setting is only for Aurora Limitless Database. PubliclyAccessible *bool // The status of the DB shard group. Status *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html TagList []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the details for an Amazon RDS DB shard group.
type ModifyDBSnapshotAttributeInput ¶
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. // // This member is required. AttributeName *string // The identifier for the DB snapshot to modify the attributes for. // // This member is required. DBSnapshotIdentifier *string // 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 // 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 // contains filtered or unexported fields }
type ModifyDBSnapshotAttributeOutput ¶
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 *types.DBSnapshotAttributesResult // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ModifyDBSnapshotInput ¶
type ModifyDBSnapshotInput struct { // The identifier of the DB snapshot to modify. // // This member is required. DBSnapshotIdentifier *string // 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 // // For the list of engine versions that are available for upgrading a DB snapshot, // see [Upgrading a MySQL DB snapshot engine version]in the Amazon RDS User Guide. // // Oracle // // - 19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB snapshots) // // - 19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB snapshots) // // - 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 a PostgreSQL DB snapshot engine version]in the Amazon RDS User Guide. // // [Upgrading a PostgreSQL DB snapshot engine version]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBSnapshot.PostgreSQL.html // [Upgrading a MySQL DB snapshot engine version]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/mysql-upgrade-snapshot.html EngineVersion *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]in the Amazon RDS User Guide. // // [Option group considerations]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.OGPG.OG OptionGroupName *string // contains filtered or unexported fields }
type ModifyDBSnapshotOutput ¶
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 *types.DBSnapshot // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ModifyDBSubnetGroupInput ¶
type ModifyDBSubnetGroupInput struct { // 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 // // This member is required. DBSubnetGroupName *string // The EC2 subnet IDs for the DB subnet group. // // This member is required. SubnetIds []string // The description for the DB subnet group. DBSubnetGroupDescription *string // contains filtered or unexported fields }
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 *types.DBSubnetGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ModifyEventSubscriptionInput ¶
type ModifyEventSubscriptionInput struct { // The name of the RDS event notification subscription. // // This member is required. SubscriptionName *string // Specifies whether to activate the subscription. Enabled *bool // 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] // in the Amazon RDS User Guide or by using the DescribeEventCategories operation. // // [Events]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html EventCategories []string // 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 // 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 | zero-etl | // custom-engine-version | blue-green-deployment SourceType *string // contains filtered or unexported fields }
type ModifyEventSubscriptionOutput ¶
type ModifyEventSubscriptionOutput struct { // Contains the results of a successful invocation of the // DescribeEventSubscriptions action. EventSubscription *types.EventSubscription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ModifyGlobalClusterInput ¶
type ModifyGlobalClusterInput struct { // Specifies whether to allow major version upgrades. // // Constraints: Must be enabled if you specify a value for the EngineVersion // parameter that's a different major version than the global 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 // Specifies whether to enable deletion protection for the global database // cluster. The global database cluster can't be deleted when deletion protection // is enabled. DeletionProtection *bool // The version number of the database engine to which you want to upgrade. // // To list all of the available engine versions for aurora-mysql (for MySQL-based // Aurora global databases), 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 (for // PostgreSQL-based Aurora global databases), use the following command: // // aws rds describe-db-engine-versions --engine aurora-postgresql --query // '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]' EngineVersion *string // The cluster identifier for the global cluster to modify. This parameter isn't // case-sensitive. // // Constraints: // // - Must match the identifier of an existing global database cluster. GlobalClusterIdentifier *string // The new cluster identifier for the 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 // contains filtered or unexported fields }
type ModifyGlobalClusterOutput ¶
type ModifyGlobalClusterOutput struct { // A data type representing an Aurora global database. GlobalCluster *types.GlobalCluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ModifyIntegrationInput ¶ added in v1.76.0
type ModifyIntegrationInput struct { // The unique identifier of the integration to modify. // // This member is required. IntegrationIdentifier *string // A new data filter for the integration. For more information, see [Data filtering for Aurora zero-ETL integrations with Amazon Redshift]. // // [Data filtering for Aurora zero-ETL integrations with Amazon Redshift]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Zero_ETL_Filtering.html DataFilter *string // A new description for the integration. Description *string // A new name for the integration. IntegrationName *string // contains filtered or unexported fields }
type ModifyIntegrationOutput ¶ added in v1.76.0
type ModifyIntegrationOutput struct { // The encryption context for the integration. For more information, see [Encryption context] in the // Amazon Web Services Key Management Service Developer Guide. // // [Encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context AdditionalEncryptionContext map[string]string // The time when the integration was created, in Universal Coordinated Time (UTC). CreateTime *time.Time // Data filters for the integration. These filters determine which tables from the // source database are sent to the target Amazon Redshift data warehouse. DataFilter *string // A description of the integration. Description *string // Any errors associated with the integration. Errors []types.IntegrationError // The ARN of the integration. IntegrationArn *string // The name of the integration. IntegrationName *string // The Amazon Web Services Key Management System (Amazon Web Services KMS) key // identifier for the key used to to encrypt the integration. KMSKeyId *string // The Amazon Resource Name (ARN) of the database used as the source for // replication. SourceArn *string // The current status of the integration. Status types.IntegrationStatus // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // The ARN of the Redshift data warehouse used as the target for replication. TargetArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
A zero-ETL integration with Amazon Redshift.
type ModifyOptionGroupInput ¶
type ModifyOptionGroupInput struct { // 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 // // This member is required. OptionGroupName *string // Specifies whether to apply the change immediately or during the next // maintenance window for each instance associated with the option group. ApplyImmediately *bool // 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 []types.OptionConfiguration // Options in this list are removed from the option group. OptionsToRemove []string // contains filtered or unexported fields }
type ModifyOptionGroupOutput ¶
type ModifyOptionGroupOutput struct { // OptionGroup *types.OptionGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ModifyTenantDatabaseInput ¶ added in v1.62.0
type ModifyTenantDatabaseInput struct { // The identifier of the DB instance that contains the tenant database that you // are modifying. This parameter isn't case-sensitive. // // Constraints: // // - Must match the identifier of an existing DB instance. // // This member is required. DBInstanceIdentifier *string // The user-supplied name of the tenant database that you want to modify. This // parameter isn’t case-sensitive. // // Constraints: // // - Must match the identifier of an existing tenant database. // // This member is required. TenantDBName *string // The new password for the master user of the specified tenant database in your // DB instance. // // Amazon RDS operations never return the password, so this action provides a way // to regain access to a tenant database user if the password is lost. This // includes restoring privileges that might have been accidentally revoked. // // Constraints: // // - Can include any printable ASCII character except / , " (double quote), @ , & // (ampersand), and ' (single quote). // // Length constraints: // // - Must contain between 8 and 30 characters. MasterUserPassword *string // The new name of the tenant database when renaming a tenant database. This // parameter isn’t case-sensitive. // // Constraints: // // - Can't be the string null or any other reserved word. // // - Can't be longer than 8 characters. NewTenantDBName *string // contains filtered or unexported fields }
type ModifyTenantDatabaseOutput ¶ added in v1.62.0
type ModifyTenantDatabaseOutput struct { // A tenant database in the DB instance. This data type is an element in the // response to the DescribeTenantDatabases action. TenantDatabase *types.TenantDatabase // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The optional application specific identifier appended to the User-Agent header. AppID string // This endpoint will be given as input to an EndpointResolverV2. It is used for // providing a custom base endpoint that is subject to modifications by the // processing EndpointResolverV2. BaseEndpoint *string // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. // // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and // BaseEndpoint. // // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be // used over the deprecated EndpointResolver. EndpointResolverV2 EndpointResolverV2 // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // The client meter provider. MeterProvider metrics.MeterProvider // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. // // If specified in an operation call's functional options with a value that is // different than the constructed client's Options, the Client's Retryer will be // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. // // When creating a new API Clients this member will only be used if the Retryer // Options member is nil. This value will be ignored if Retryer is not nil. // // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The client tracer provider. TracerProvider tracing.TracerProvider // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // The auth scheme resolver which determines how to authenticate for each // operation. AuthSchemeResolver AuthSchemeResolver // The list of auth schemes supported by the client. AuthSchemes []smithyhttp.AuthScheme // contains filtered or unexported fields }
func (Options) GetIdentityResolver ¶ added in v1.62.4
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
type PresignClient ¶ added in v0.30.0
type PresignClient struct {
// contains filtered or unexported fields
}
PresignClient represents the presign url client
func NewPresignClient ¶ added in v0.30.0
func NewPresignClient(c *Client, optFns ...func(*PresignOptions)) *PresignClient
NewPresignClient generates a presign client using provided API Client and presign options
func (*PresignClient) PresignCopyDBClusterSnapshot ¶ added in v0.30.0
func (c *PresignClient) PresignCopyDBClusterSnapshot(ctx context.Context, params *CopyDBClusterSnapshotInput, optFns ...func(*PresignOptions)) (*v4.PresignedHTTPRequest, error)
PresignCopyDBClusterSnapshot is used to generate a presigned HTTP Request which contains presigned URL, signed headers and HTTP method used.
func (*PresignClient) PresignCopyDBSnapshot ¶ added in v0.30.0
func (c *PresignClient) PresignCopyDBSnapshot(ctx context.Context, params *CopyDBSnapshotInput, optFns ...func(*PresignOptions)) (*v4.PresignedHTTPRequest, error)
PresignCopyDBSnapshot is used to generate a presigned HTTP Request which contains presigned URL, signed headers and HTTP method used.
func (*PresignClient) PresignCreateDBCluster ¶ added in v0.30.0
func (c *PresignClient) PresignCreateDBCluster(ctx context.Context, params *CreateDBClusterInput, optFns ...func(*PresignOptions)) (*v4.PresignedHTTPRequest, error)
PresignCreateDBCluster is used to generate a presigned HTTP Request which contains presigned URL, signed headers and HTTP method used.
func (*PresignClient) PresignCreateDBInstanceReadReplica ¶ added in v0.30.0
func (c *PresignClient) PresignCreateDBInstanceReadReplica(ctx context.Context, params *CreateDBInstanceReadReplicaInput, optFns ...func(*PresignOptions)) (*v4.PresignedHTTPRequest, error)
PresignCreateDBInstanceReadReplica is used to generate a presigned HTTP Request which contains presigned URL, signed headers and HTTP method used.
type PresignOptions ¶ added in v0.30.0
type PresignOptions struct { // ClientOptions are list of functional options to mutate client options used by // the presign client. ClientOptions []func(*Options) // Presigner is the presigner used by the presign url client Presigner HTTPPresignerV4 }
PresignOptions represents the presign client options
type PromoteReadReplicaDBClusterInput ¶
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 // // This member is required. DBClusterIdentifier *string // contains filtered or unexported fields }
type PromoteReadReplicaDBClusterOutput ¶
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?] in the Amazon Aurora // User Guide. // // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User // Guide. // // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PromoteReadReplicaInput ¶
type PromoteReadReplicaInput struct { // 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 // // This member is required. DBInstanceIdentifier *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. // // 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 *int32 // 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] // 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. // // [Adjusting the Preferred Maintenance Window]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html PreferredBackupWindow *string // contains filtered or unexported fields }
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 *types.DBInstance // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PurchaseReservedDBInstancesOfferingInput ¶
type PurchaseReservedDBInstancesOfferingInput struct { // The ID of the Reserved DB instance offering to purchase. // // Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706 // // This member is required. ReservedDBInstancesOfferingId *string // The number of instances to reserve. // // Default: 1 DBInstanceCount *int32 // Customer-specified identifier to track this reservation. // // Example: myreservationID ReservedDBInstanceId *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // contains filtered or unexported fields }
type PurchaseReservedDBInstancesOfferingOutput ¶
type PurchaseReservedDBInstancesOfferingOutput struct { // This data type is used as a response element in the DescribeReservedDBInstances // and PurchaseReservedDBInstancesOffering actions. ReservedDBInstance *types.ReservedDBInstance // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RebootDBClusterInput ¶ added in v1.13.0
type RebootDBClusterInput struct { // The DB cluster identifier. This parameter is stored as a lowercase string. // // Constraints: // // - Must match the identifier of an existing DBCluster. // // This member is required. DBClusterIdentifier *string // contains filtered or unexported fields }
type RebootDBClusterOutput ¶ added in v1.13.0
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?] in the Amazon Aurora // User Guide. // // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User // Guide. // // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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. // // This member is required. DBInstanceIdentifier *string // Specifies 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 // contains filtered or unexported fields }
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 *types.DBInstance // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RebootDBShardGroupInput ¶ added in v1.68.0
type RebootDBShardGroupInput struct { // The name of the DB shard group to reboot. // // This member is required. DBShardGroupIdentifier *string // contains filtered or unexported fields }
type RebootDBShardGroupOutput ¶ added in v1.68.0
type RebootDBShardGroupOutput struct { // Specifies whether to create standby DB shard groups for the DB shard group. // Valid values are the following: // // - 0 - Creates a DB shard group without a standby DB shard group. This is the // default value. // // - 1 - Creates a DB shard group with a standby DB shard group in a different // Availability Zone (AZ). // // - 2 - Creates a DB shard group with two standby DB shard groups in two // different AZs. ComputeRedundancy *int32 // The name of the primary DB cluster for the DB shard group. DBClusterIdentifier *string // The Amazon Resource Name (ARN) for the DB shard group. DBShardGroupArn *string // The name of the DB shard group. DBShardGroupIdentifier *string // The Amazon Web Services Region-unique, immutable identifier for the DB shard // group. DBShardGroupResourceId *string // The connection endpoint for the DB shard group. Endpoint *string // The maximum capacity of the DB shard group in Aurora capacity units (ACUs). MaxACU *float64 // The minimum capacity of the DB shard group in Aurora capacity units (ACUs). MinACU *float64 // Indicates whether the DB shard group is publicly accessible. // // When the DB shard group is publicly accessible, its Domain Name System (DNS) // endpoint resolves to the private IP address from within the DB shard group's // virtual private cloud (VPC). It resolves to the public IP address from outside // of the DB shard group's VPC. Access to the DB shard group is ultimately // controlled by the security group it uses. That public access isn't permitted if // the security group assigned to the DB shard group doesn't permit it. // // When the DB shard group isn't publicly accessible, it is an internal DB shard // group with a DNS name that resolves to a private IP address. // // For more information, see CreateDBShardGroup. // // This setting is only for Aurora Limitless Database. PubliclyAccessible *bool // The status of the DB shard group. Status *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html TagList []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the details for an Amazon RDS DB shard group.
type RegisterDBProxyTargetsInput ¶
type RegisterDBProxyTargetsInput struct { // The identifier of the DBProxy that is associated with the DBProxyTargetGroup . // // This member is required. DBProxyName *string // One or more DB cluster identifiers. DBClusterIdentifiers []string // One or more DB instance identifiers. DBInstanceIdentifiers []string // The identifier of the DBProxyTargetGroup . TargetGroupName *string // contains filtered or unexported fields }
type RegisterDBProxyTargetsOutput ¶
type RegisterDBProxyTargetsOutput struct { // One or more DBProxyTarget objects that are created when you register targets // with a target group. DBProxyTargets []types.DBProxyTarget // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RemoveFromGlobalClusterInput ¶
type RemoveFromGlobalClusterInput struct { // The Amazon Resource Name (ARN) identifying the cluster that was detached from // the Aurora global database cluster. DbClusterIdentifier *string // The cluster identifier to detach from the Aurora global database cluster. GlobalClusterIdentifier *string // contains filtered or unexported fields }
type RemoveFromGlobalClusterOutput ¶
type RemoveFromGlobalClusterOutput struct { // A data type representing an Aurora global database. GlobalCluster *types.GlobalCluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RemoveRoleFromDBClusterInput ¶
type RemoveRoleFromDBClusterInput struct { // The name of the DB cluster to disassociate the IAM role from. // // This member is required. DBClusterIdentifier *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 . // // This member is required. RoleArn *string // 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 // contains filtered or unexported fields }
type RemoveRoleFromDBClusterOutput ¶
type RemoveRoleFromDBClusterOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RemoveRoleFromDBInstanceInput ¶
type RemoveRoleFromDBInstanceInput struct { // The name of the DB instance to disassociate the IAM role from. // // This member is required. DBInstanceIdentifier *string // 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 . // // This member is required. FeatureName *string // The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB // instance, for example, arn:aws:iam::123456789012:role/AccessRole . // // This member is required. RoleArn *string // contains filtered or unexported fields }
type RemoveRoleFromDBInstanceOutput ¶
type RemoveRoleFromDBInstanceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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. // // This member is required. SourceIdentifier *string // The name of the RDS event notification subscription you want to remove a source // identifier from. // // This member is required. SubscriptionName *string // contains filtered or unexported fields }
type RemoveSourceIdentifierFromSubscriptionOutput ¶
type RemoveSourceIdentifierFromSubscriptionOutput struct { // Contains the results of a successful invocation of the // DescribeEventSubscriptions action. EventSubscription *types.EventSubscription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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]in the Amazon // RDS User Guide. // // [Constructing an ARN for Amazon RDS]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing // // This member is required. ResourceName *string // The tag key (name) of the tag to be removed. // // This member is required. TagKeys []string // contains filtered or unexported fields }
type RemoveTagsFromResourceOutput ¶
type RemoveTagsFromResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ResetDBClusterParameterGroupInput ¶
type ResetDBClusterParameterGroupInput struct { // The name of the DB cluster parameter group to reset. // // This member is required. DBClusterParameterGroupName *string // 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 []types.Parameter // Specifies 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 // contains filtered or unexported fields }
type ResetDBClusterParameterGroupOutput ¶
type ResetDBClusterParameterGroupOutput 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ResetDBParameterGroupInput ¶
type ResetDBParameterGroupInput struct { // The name of the DB parameter group. // // Constraints: // // - Must match the name of an existing DBParameterGroup . // // This member is required. DBParameterGroupName *string // 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 []types.Parameter // Specifies 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 // contains filtered or unexported fields }
type ResetDBParameterGroupOutput ¶
type ResetDBParameterGroupOutput struct { // The name of the DB parameter group. DBParameterGroupName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup operation.
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type RestoreDBClusterFromS3Input ¶
type RestoreDBClusterFromS3Input struct { // 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 // // This member is required. DBClusterIdentifier *string // The name of the database engine to be used for this DB cluster. // // Valid Values: aurora-mysql (for Aurora MySQL) // // This member is required. Engine *string // 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. // // This member is required. MasterUsername *string // The name of the Amazon S3 bucket that contains the data used to create the // Amazon Aurora DB cluster. // // This member is required. S3BucketName *string // 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. // // This member is required. S3IngestionRoleArn *string // The identifier for the database engine that was backed up to create the files // stored in the Amazon S3 bucket. // // Valid Values: mysql // // This member is required. SourceEngine *string // The version of the database that the backup files were created from. // // MySQL versions 5.7 and 8.0 are supported. // // Example: 5.7.40 , 8.0.28 // // This member is required. SourceEngineVersion *string // A list of Availability Zones (AZs) where instances in the restored DB cluster // can be created. AvailabilityZones []string // 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 // 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 *int32 // A value that indicates that the restored DB cluster should be associated with // the specified CharacterSet. CharacterSetName *string // Specifies 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 // The name of the DB cluster parameter group to associate with the restored DB // cluster. If this argument is omitted, the default parameter group for the engine // version is used. // // Constraints: // // - If supplied, must match the name of an existing DBClusterParameterGroup. DBClusterParameterGroupName *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 // The database name for the restored DB cluster. DatabaseName *string // Specifies whether to enable deletion protection for the DB cluster. The // database can't be deleted when deletion protection is enabled. By default, // deletion protection isn't enabled. DeletionProtection *bool // 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]in // the Amazon Aurora User Guide. // // [Kerberos Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html Domain *string // Specify the name of the IAM role to be used when making API calls to the // Directory Service. DomainIAMRoleName *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 . // // For more information about exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs] in // the Amazon Aurora User Guide. // // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch EnableCloudwatchLogsExports []string // Specifies 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] in the Amazon Aurora User Guide. // // [IAM Database Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool // The life cycle type for this DB cluster. // // By default, this value is set to open-source-rds-extended-support , which // enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard // support, you can avoid charges for Extended Support by setting the value to // open-source-rds-extended-support-disabled . In this case, RDS automatically // upgrades your restored DB cluster to a higher engine version, if the major // engine version is past its end of standard support date. // // You can use this setting to enroll your DB cluster into Amazon RDS Extended // Support. With RDS Extended Support, you can run the selected major engine // version on your DB cluster past the end of standard support for that engine // version. For more information, see the following sections: // // - Amazon Aurora - [Using Amazon RDS Extended Support]in the Amazon Aurora User Guide // // - Amazon RDS - [Using Amazon RDS Extended Support]in the Amazon RDS User Guide // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Valid Values: open-source-rds-extended-support | // open-source-rds-extended-support-disabled // // Default: open-source-rds-extended-support // // [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html EngineLifecycleSupport *string // The version number of the database engine to use. // // To list all of the available engine versions for aurora-mysql (Aurora MySQL), // use the following command: // // aws rds describe-db-engine-versions --engine aurora-mysql --query // "DBEngineVersions[].EngineVersion" // // Aurora MySQL // // Examples: 5.7.mysql_aurora.2.12.0 , 8.0.mysql_aurora.3.04.0 EngineVersion *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 // Specifies whether to manage the master user password with Amazon Web Services // Secrets Manager. // // For more information, see [Password management with Amazon Web Services Secrets Manager] in the Amazon RDS User Guide and [Password management with Amazon Web Services Secrets Manager] in the Amazon // Aurora User Guide. // // Constraints: // // - Can't manage the master user password with Amazon Web Services Secrets // Manager if MasterUserPassword is specified. // // [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html ManageMasterUserPassword *bool // 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. // // - Can't be specified if ManageMasterUserPassword is turned on. MasterUserPassword *string // The Amazon Web Services KMS key identifier to encrypt a secret that is // automatically generated and managed in Amazon Web Services Secrets Manager. // // This setting is valid only if the master user password is managed by RDS in // Amazon Web Services Secrets Manager for the 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 you don't specify MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS // key is used to encrypt the secret. If the secret is in a different Amazon Web // Services account, then you can't use the aws/secretsmanager KMS key to encrypt // the secret, and you must use a customer managed 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. MasterUserSecretKmsKeyId *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] in the Amazon Aurora User Guide. // // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *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 // The port number on which the instances in the restored DB cluster accept // connections. // // Default: 3306 Port *int32 // 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]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. // // [Backup window]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow PreferredBackupWindow *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]in the Amazon Aurora User Guide. // // Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. // // Constraints: Minimum 30-minute window. // // [Adjusting the Preferred Maintenance Window]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora PreferredMaintenanceWindow *string // 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 // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. // // For more information, see [Using Amazon Aurora Serverless v2] in the Amazon Aurora User Guide. // // [Using Amazon Aurora Serverless v2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration // Specifies whether the restored DB cluster is encrypted. StorageEncrypted *bool // Specifies the storage type to be associated with the DB cluster. // // Valid Values: aurora , aurora-iopt1 // // Default: aurora // // Valid for: Aurora DB clusters only StorageType *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // A list of EC2 VPC security groups to associate with the restored DB cluster. VpcSecurityGroupIds []string // contains filtered or unexported fields }
type RestoreDBClusterFromS3Output ¶
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?] in the Amazon Aurora // User Guide. // // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User // Guide. // // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RestoreDBClusterFromSnapshotInput ¶
type RestoreDBClusterFromSnapshotInput struct { // 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 // // This member is required. DBClusterIdentifier *string // 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 // // This member is required. Engine *string // 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 // // This member is required. SnapshotIdentifier *string // 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 // 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 // Specifies 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 // The compute and memory capacity of the each DB instance in the Multi-AZ DB // cluster, for example db.m6gd.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] // in the Amazon RDS User Guide. // // Valid for: Multi-AZ DB clusters only // // [DB Instance Class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html DBClusterInstanceClass *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 // 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 // The database name for the restored DB cluster. // // Valid for: Aurora DB clusters and Multi-AZ DB clusters DatabaseName *string // Specifies whether to enable deletion protection for the DB cluster. 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 // 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] in the Amazon RDS User Guide. // // Valid for: Aurora DB clusters only // // [Kerberos Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html Domain *string // 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 // 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] in // the Amazon RDS User Guide. // // For more information about exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs] in // the Amazon Aurora User Guide. // // Valid for: Aurora DB clusters and Multi-AZ DB clusters // // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch EnableCloudwatchLogsExports []string // Specifies 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] in the Amazon Aurora User Guide or [IAM database authentication for MariaDB, MySQL, and PostgreSQL] in the Amazon // RDS User Guide. // // Valid for: Aurora DB clusters and Multi-AZ DB clusters // // [IAM Database Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html // [IAM database authentication for MariaDB, MySQL, and PostgreSQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool // Specifies whether to turn on Performance Insights for the DB cluster. EnablePerformanceInsights *bool // The life cycle type for this DB cluster. // // By default, this value is set to open-source-rds-extended-support , which // enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard // support, you can avoid charges for Extended Support by setting the value to // open-source-rds-extended-support-disabled . In this case, RDS automatically // upgrades your restored DB cluster to a higher engine version, if the major // engine version is past its end of standard support date. // // You can use this setting to enroll your DB cluster into Amazon RDS Extended // Support. With RDS Extended Support, you can run the selected major engine // version on your DB cluster past the end of standard support for that engine // version. For more information, see the following sections: // // - Amazon Aurora - [Using Amazon RDS Extended Support]in the Amazon Aurora User Guide // // - Amazon RDS - [Using Amazon RDS Extended Support]in the Amazon RDS User Guide // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Valid Values: open-source-rds-extended-support | // open-source-rds-extended-support-disabled // // Default: open-source-rds-extended-support // // [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html EngineLifecycleSupport *string // The DB engine mode of the DB cluster, either provisioned or serverless . // // For more information, see [CreateDBCluster]. // // Valid for: Aurora DB clusters only // // [CreateDBCluster]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html EngineMode *string // The version of the database engine to use for the new DB cluster. If you don't // specify an engine version, the default version for the database engine in the // Amazon Web Services Region is used. // // To list all of the available engine versions for Aurora MySQL, 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 [Database engine updates for Amazon Aurora MySQL] in the Amazon Aurora User Guide. // // Aurora PostgreSQL // // See [Amazon Aurora PostgreSQL releases and engine versions] in the Amazon Aurora User Guide. // // MySQL // // See [Amazon RDS for MySQL] in the Amazon RDS User Guide. // // PostgreSQL // // See [Amazon RDS for PostgreSQL versions and extensions] in the Amazon RDS User Guide. // // Valid for: Aurora DB clusters and Multi-AZ DB clusters // // [Database engine updates for Amazon Aurora MySQL]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html // [Amazon RDS for PostgreSQL versions and extensions]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts // [Amazon RDS for MySQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt // [Amazon Aurora PostgreSQL releases and engine versions]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html EngineVersion *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] 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 // // [Amazon RDS Provisioned IOPS storage]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS Iops *int32 // 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 // 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 . // // If MonitoringRoleArn is specified, also set MonitoringInterval to a value other // than 0 . // // Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 // // Default: 0 MonitoringInterval *int32 // 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 . // // If MonitoringInterval is set to a value other than 0 , supply a // MonitoringRoleArn value. MonitoringRoleArn *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] in the Amazon Aurora User Guide. // // Valid for: Aurora DB clusters only // // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *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 // 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. PerformanceInsightsKMSKeyId *string // The number of days to retain Performance Insights data. // // Valid Values: // // - 7 // // - month * 31, where month is a number of months from 1-23. Examples: 93 (3 // months * 31), 341 (11 months * 31), 589 (19 months * 31) // // - 731 // // Default: 7 days // // If you specify a retention period that isn't valid, such as 94 , Amazon RDS // issues an error. PerformanceInsightsRetentionPeriod *int32 // 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 *int32 // Specifies 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 // Reserved for future use. RdsCustomClusterConfiguration *types.RdsCustomClusterConfiguration // For DB clusters in serverless DB engine mode, the scaling properties of the DB // cluster. // // Valid for: Aurora DB clusters only ScalingConfiguration *types.ScalingConfiguration // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. // // For more information, see [Using Amazon Aurora Serverless v2] in the Amazon Aurora User Guide. // // [Using Amazon Aurora Serverless v2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration // Specifies the storage type to be associated with the DB cluster. // // When specified for a Multi-AZ DB cluster, a value for the Iops parameter is // required. // // Valid Values: aurora , aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB // clusters) // // Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters) // // Valid for: Aurora DB clusters and Multi-AZ DB clusters StorageType *string // The tags to be assigned to the restored DB cluster. // // Valid for: Aurora DB clusters and Multi-AZ DB clusters Tags []types.Tag // 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 // contains filtered or unexported fields }
type RestoreDBClusterFromSnapshotOutput ¶
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?] in the Amazon Aurora // User Guide. // // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User // Guide. // // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RestoreDBClusterToPointInTimeInput ¶
type RestoreDBClusterToPointInTimeInput struct { // 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 // // This member is required. DBClusterIdentifier *string // 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 // Specifies 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 // The compute and memory capacity of the each DB instance in the Multi-AZ DB // cluster, for example db.m6gd.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] // in the Amazon RDS User Guide. // // Valid for: Multi-AZ DB clusters only // // [DB instance class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html DBClusterInstanceClass *string // The name of the custom DB cluster parameter group to associate with this DB // cluster. // // If the DBClusterParameterGroupName parameter 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 // 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 // Specifies whether to enable deletion protection for the DB cluster. 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 // 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]in // the Amazon Aurora User Guide. // // Valid for: Aurora DB clusters only // // [Kerberos Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html Domain *string // 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 // 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] in // the Amazon RDS User Guide. // // For more information about exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs] in // the Amazon Aurora User Guide. // // Valid for: Aurora DB clusters and Multi-AZ DB clusters // // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch EnableCloudwatchLogsExports []string // Specifies 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] in the Amazon Aurora User Guide or [IAM database authentication for MariaDB, MySQL, and PostgreSQL] in the Amazon // RDS User Guide. // // Valid for: Aurora DB clusters and Multi-AZ DB clusters // // [IAM Database Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html // [IAM database authentication for MariaDB, MySQL, and PostgreSQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool // Specifies whether to turn on Performance Insights for the DB cluster. EnablePerformanceInsights *bool // The life cycle type for this DB cluster. // // By default, this value is set to open-source-rds-extended-support , which // enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard // support, you can avoid charges for Extended Support by setting the value to // open-source-rds-extended-support-disabled . In this case, RDS automatically // upgrades your restored DB cluster to a higher engine version, if the major // engine version is past its end of standard support date. // // You can use this setting to enroll your DB cluster into Amazon RDS Extended // Support. With RDS Extended Support, you can run the selected major engine // version on your DB cluster past the end of standard support for that engine // version. For more information, see the following sections: // // - Amazon Aurora - [Using Amazon RDS Extended Support]in the Amazon Aurora User Guide // // - Amazon RDS - [Using Amazon RDS Extended Support]in the Amazon RDS User Guide // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // // Valid Values: open-source-rds-extended-support | // open-source-rds-extended-support-disabled // // Default: open-source-rds-extended-support // // [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html EngineLifecycleSupport *string // 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 // 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] 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 // // [Amazon RDS Provisioned IOPS storage]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS Iops *int32 // 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 // 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 . // // If MonitoringRoleArn is specified, also set MonitoringInterval to a value other // than 0 . // // Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 // // Default: 0 MonitoringInterval *int32 // 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 . // // If MonitoringInterval is set to a value other than 0 , supply a // MonitoringRoleArn value. MonitoringRoleArn *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] in the Amazon Aurora User Guide. // // Valid for: Aurora DB clusters only // // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *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 // 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. PerformanceInsightsKMSKeyId *string // The number of days to retain Performance Insights data. // // Valid Values: // // - 7 // // - month * 31, where month is a number of months from 1-23. Examples: 93 (3 // months * 31), 341 (11 months * 31), 589 (19 months * 31) // // - 731 // // Default: 7 days // // If you specify a retention period that isn't valid, such as 94 , Amazon RDS // issues an error. PerformanceInsightsRetentionPeriod *int32 // 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 *int32 // Specifies 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 // Reserved for future use. RdsCustomClusterConfiguration *types.RdsCustomClusterConfiguration // 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 // 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. // // 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 // For DB clusters in serverless DB engine mode, the scaling properties of the DB // cluster. // // Valid for: Aurora DB clusters only ScalingConfiguration *types.ScalingConfiguration // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. // // For more information, see [Using Amazon Aurora Serverless v2] in the Amazon Aurora User Guide. // // [Using Amazon Aurora Serverless v2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration // 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 *string // The resource ID of the source DB cluster from which to restore. SourceDbClusterResourceId *string // Specifies the storage type to be associated with the DB cluster. // // When specified for a Multi-AZ DB cluster, a value for the Iops parameter is // required. // // Valid Values: aurora , aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB // clusters) // // Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters) // // Valid for: Aurora DB clusters and Multi-AZ DB clusters StorageType *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // Specifies 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 // 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 // contains filtered or unexported fields }
type RestoreDBClusterToPointInTimeOutput ¶
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?] in the Amazon Aurora // User Guide. // // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User // Guide. // // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RestoreDBInstanceFromDBSnapshotInput ¶
type RestoreDBInstanceFromDBSnapshotInput struct { // The 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 // // This member is required. DBInstanceIdentifier *string // The amount of storage (in gibibytes) to allocate initially for the DB instance. // Follow the allocation rules specified in CreateDBInstance. // // This setting isn't valid for RDS for SQL Server. // // Be sure to allocate enough storage for your new DB instance so that the restore // operation can succeed. You can also allocate additional storage for future // growth. AllocatedStorage *int32 // Specifies whether to automatically apply minor version upgrades to the DB // instance during the maintenance window. // // If you restore an RDS Custom DB instance, you must disable this parameter. AutoMinorVersionUpgrade *bool // 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 // 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] in the Amazon RDS User Guide. // // [Working with Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html BackupTarget *string // The CA certificate identifier to use for the DB instance's server certificate. // // This setting doesn't apply to RDS Custom DB instances. // // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon // Aurora User Guide. // // [Using SSL/TLS to encrypt a connection to a DB cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html // [Using SSL/TLS to encrypt a connection to a DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html CACertificateIdentifier *string // Specifies 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] in the Amazon RDS User Guide. // // [Copying tags to DB instance snapshots]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.CopyTags CopyTagsToSnapshot *bool // 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] in the Amazon RDS // User Guide. // // This setting is required for RDS Custom. // // [Configure IAM and your VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc CustomIamInstanceProfile *string // The identifier for the Multi-AZ DB cluster snapshot to restore from. // // For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] in the Amazon RDS User Guide. // // Constraints: // // - Must match the identifier of an existing Multi-AZ DB cluster snapshot. // // - Can't be specified when DBSnapshotIdentifier is specified. // // - Must be specified when DBSnapshotIdentifier isn't specified. // // - If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the // DBClusterSnapshotIdentifier must be the ARN of the shared snapshot. // // - Can't be the identifier of an Aurora DB cluster snapshot. // // [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html DBClusterSnapshotIdentifier *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]in the Amazon RDS User Guide. // // Default: The same DBInstanceClass as the original DB instance. // // [DB Instance Class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html DBInstanceClass *string // The name of the database for the restored DB instance. // // This parameter only applies to RDS for Oracle and RDS for SQL Server DB // instances. It doesn't apply to the other engines or to RDS Custom DB instances. DBName *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 DB 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. DBParameterGroupName *string // The identifier for the DB snapshot to restore from. // // Constraints: // // - Must match the identifier of an existing DB snapshot. // // - Can't be specified when DBClusterSnapshotIdentifier is specified. // // - Must be specified when DBClusterSnapshotIdentifier isn't specified. // // - If you are restoring from a shared manual DB snapshot, the // DBSnapshotIdentifier must be the ARN of the shared DB snapshot. DBSnapshotIdentifier *string // The name of the DB subnet group to use for the new instance. // // Constraints: // // - If supplied, must match the name of an existing DB subnet group. // // Example: mydbsubnetgroup DBSubnetGroupName *string // Specifies whether to enable a dedicated log volume (DLV) for the DB instance. DedicatedLogVolume *bool // Specifies whether to enable deletion protection for the DB instance. 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]. // // [Deleting a DB Instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html DeletionProtection *bool // 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 Db2, // MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active // Directory Domain. // // For more information, see [Kerberos Authentication] in the Amazon RDS User Guide. // // This setting doesn't apply to RDS Custom. // // [Kerberos Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html Domain *string // The ARN for the Secrets Manager secret with the credentials for the user // joining the domain. // // Constraints: // // - Can't be longer than 64 characters. // // Example: // arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456 DomainAuthSecretArn *string // The IPv4 DNS IP addresses of your primary and secondary Active Directory domain // controllers. // // Constraints: // // - Two IP addresses must be provided. If there isn't a secondary domain // controller, use the IP address of the primary domain controller for both entries // in the list. // // Example: 123.124.125.126,234.235.236.237 DomainDnsIps []string // The fully qualified domain name (FQDN) of an Active Directory domain. // // Constraints: // // - Can't be longer than 64 characters. // // Example: mymanagedADtest.mymanagedAD.mydomain DomainFqdn *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 DB instances. DomainIAMRoleName *string // The Active Directory organizational unit for your DB instance to join. // // Constraints: // // - Must be in the distinguished name format. // // - Can't be longer than 64 characters. // // Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain DomainOu *string // The list of logs for the restored DB instance to export to CloudWatch Logs. The // values in the list depend on the DB engine. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs]in the // Amazon RDS User Guide. // // This setting doesn't apply to RDS Custom. // // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch EnableCloudwatchLogsExports []string // Specifies 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] in the Amazon RDS User Guide. // // For more information about CoIPs, see [Customer-owned IP addresses] in the Amazon Web Services Outposts User // Guide. // // [Working with Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html // [Customer-owned IP addresses]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing EnableCustomerOwnedIp *bool // Specifies 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] in the Amazon RDS // User Guide. // // This setting doesn't apply to RDS Custom. // // [IAM Database Authentication for MySQL and PostgreSQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool // 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: // // - db2-ae // // - db2-se // // - mariadb // // - mysql // // - oracle-ee // // - oracle-ee-cdb // // - oracle-se2 // // - oracle-se2-cdb // // - postgres // // - sqlserver-ee // // - sqlserver-se // // - sqlserver-ex // // - sqlserver-web Engine *string // The life cycle type for this DB instance. // // By default, this value is set to open-source-rds-extended-support , which // enrolls your DB instance into Amazon RDS Extended Support. At the end of // standard support, you can avoid charges for Extended Support by setting the // value to open-source-rds-extended-support-disabled . In this case, RDS // automatically upgrades your restored DB instance to a higher engine version, if // the major engine version is past its end of standard support date. // // You can use this setting to enroll your DB instance into Amazon RDS Extended // Support. With RDS Extended Support, you can run the selected major engine // version on your DB instance past the end of standard support for that engine // version. For more information, see [Using Amazon RDS Extended Support]in the Amazon RDS User Guide. // // This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon // Aurora DB instances, the life cycle type is managed by the DB cluster. // // Valid Values: open-source-rds-extended-support | // open-source-rds-extended-support-disabled // // Default: open-source-rds-extended-support // // [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html EngineLifecycleSupport *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]in the Amazon RDS User Guide. // // Constraints: Must be an integer greater than 1000. // // [Amazon RDS Provisioned IOPS storage]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS Iops *int32 // License model information for the restored DB instance. // // License models for RDS for Db2 require additional configuration. The Bring Your // Own License (BYOL) model requires a custom parameter group and an Amazon Web // Services License Manager self-managed license. The Db2 license through Amazon // Web Services Marketplace model requires an Amazon Web Services Marketplace // subscription. For more information, see [Amazon RDS for Db2 licensing options]in the Amazon RDS User Guide. // // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. // // Valid Values: // // - RDS for Db2 - bring-your-own-license | marketplace-license // // - RDS for MariaDB - general-public-license // // - RDS for Microsoft SQL Server - license-included // // - RDS for MySQL - general-public-license // // - RDS for Oracle - bring-your-own-license | license-included // // - RDS for PostgreSQL - postgresql-license // // Default: Same as the source. // // [Amazon RDS for Db2 licensing options]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html LicenseModel *string // Specifies 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 // 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] in the Amazon RDS User Guide. // // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *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 // 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 *int32 // 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 []types.ProcessorFeature // Specifies 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 // Specifies the storage throughput value for the DB instance. // // This setting doesn't apply to RDS Custom or Amazon Aurora. StorageThroughput *int32 // Specifies the storage type to be associated with the DB instance. // // Valid Values: gp2 | gp3 | io1 | io2 | standard // // If you specify io1 , io2 , or gp3 , you must also include a value for the Iops // parameter. // // Default: io1 if the Iops parameter is specified, otherwise gp2 StorageType *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // 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 // 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 // Specifies whether the DB instance class of the DB instance uses its default // processor features. // // This setting doesn't apply to RDS Custom. UseDefaultProcessorFeatures *bool // 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 // contains filtered or unexported fields }
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 *types.DBInstance // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RestoreDBInstanceFromS3Input ¶
type RestoreDBInstanceFromS3Input struct { // 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]in the Amazon RDS User Guide. // // Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class. // // [DB Instance Class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html // // This member is required. DBInstanceClass *string // 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 // // This member is required. DBInstanceIdentifier *string // The name of the database engine to be used for this instance. // // Valid Values: mysql // // This member is required. Engine *string // The name of your Amazon S3 bucket that contains your database backup file. // // This member is required. S3BucketName *string // An Amazon Web Services Identity and Access Management (IAM) role with a trust // policy and a permissions policy that allows Amazon RDS to access your Amazon S3 // bucket. For information about this role, see [Creating an IAM role manually]in the Amazon RDS User Guide. // // [Creating an IAM role manually]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html#MySQL.Procedural.Importing.Enabling.IAM // // This member is required. S3IngestionRoleArn *string // The name of the engine of your source database. // // Valid Values: mysql // // This member is required. SourceEngine *string // 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 // // This member is required. SourceEngineVersion *string // The amount of storage (in gibibytes) to allocate initially for the DB instance. // Follow the allocation rules specified in CreateDBInstance . // // This setting isn't valid for RDS for SQL Server. // // Be sure to allocate enough storage for your new DB instance so that the restore // operation can succeed. You can also allocate additional storage for future // growth. AllocatedStorage *int32 // Specifies whether to automatically apply minor engine upgrades to the DB // instance during the maintenance window. By default, minor engine upgrades are // not applied automatically. AutoMinorVersionUpgrade *bool // 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]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. // // [Regions and Availability Zones]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html AvailabilityZone *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 *int32 // The CA certificate identifier to use for the DB instance's server certificate. // // This setting doesn't apply to RDS Custom DB instances. // // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon // Aurora User Guide. // // [Using SSL/TLS to encrypt a connection to a DB cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html // [Using SSL/TLS to encrypt a connection to a DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html CACertificateIdentifier *string // Specifies whether to copy all tags from the DB instance to snapshots of the DB // instance. By default, tags are not copied. CopyTagsToSnapshot *bool // The name of the database to create when the DB instance is created. Follow the // naming rules specified in CreateDBInstance . DBName *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 // A list of DB security groups to associate with this DB instance. // // Default: The default DB security group for the database engine. DBSecurityGroups []string // 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 // Specifies the mode of Database Insights to enable for the DB instance. // // This setting only applies to Amazon Aurora DB instances. // // Currently, this value is inherited from the DB cluster and can't be changed. DatabaseInsightsMode types.DatabaseInsightsMode // Specifies whether to enable a dedicated log volume (DLV) for the DB instance. DedicatedLogVolume *bool // Specifies whether to enable deletion protection for the DB instance. 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]. // // [Deleting a DB Instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html DeletionProtection *bool // 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]in the Amazon RDS User Guide. // // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch EnableCloudwatchLogsExports []string // Specifies 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] in the Amazon RDS // User Guide. // // [IAM Database Authentication for MySQL and PostgreSQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool // Specifies whether to enable Performance Insights for the DB instance. // // For more information, see [Using Amazon Performance Insights] in the Amazon RDS User Guide. // // [Using Amazon Performance Insights]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html EnablePerformanceInsights *bool // The life cycle type for this DB instance. // // By default, this value is set to open-source-rds-extended-support , which // enrolls your DB instance into Amazon RDS Extended Support. At the end of // standard support, you can avoid charges for Extended Support by setting the // value to open-source-rds-extended-support-disabled . In this case, RDS // automatically upgrades your restored DB instance to a higher engine version, if // the major engine version is past its end of standard support date. // // You can use this setting to enroll your DB instance into Amazon RDS Extended // Support. With RDS Extended Support, you can run the selected major engine // version on your DB instance past the end of standard support for that engine // version. For more information, see [Using Amazon RDS Extended Support]in the Amazon RDS User Guide. // // This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon // Aurora DB instances, the life cycle type is managed by the DB cluster. // // Valid Values: open-source-rds-extended-support | // open-source-rds-extended-support-disabled // // Default: open-source-rds-extended-support // // [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html EngineLifecycleSupport *string // 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 // 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]in // the Amazon RDS User Guide. // // [Amazon RDS Provisioned IOPS storage]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS Iops *int32 // 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 // The license model for this DB instance. Use general-public-license . LicenseModel *string // Specifies whether to manage the master user password with Amazon Web Services // Secrets Manager. // // For more information, see [Password management with Amazon Web Services Secrets Manager] in the Amazon RDS User Guide. // // Constraints: // // - Can't manage the master user password with Amazon Web Services Secrets // Manager if MasterUserPassword is specified. // // [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html ManageMasterUserPassword *bool // The password for the master user. // // Constraints: // // - Can't be specified if ManageMasterUserPassword is turned on. // // - Can include any printable ASCII character except "/", """, or "@". For RDS // for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) // character. // // Length Constraints: // // - RDS for Db2 - Must contain from 8 to 128 characters. // // - RDS for MariaDB - Must contain from 8 to 41 characters. // // - RDS for Microsoft SQL Server - Must contain from 8 to 128 characters. // // - RDS for MySQL - Must contain from 8 to 41 characters. // // - RDS for Oracle - Must contain from 8 to 30 characters. // // - RDS for PostgreSQL - Must contain from 8 to 128 characters. MasterUserPassword *string // The Amazon Web Services KMS key identifier to encrypt a secret that is // automatically generated and managed in Amazon Web Services Secrets Manager. // // This setting is valid only if the master user password is managed by RDS in // Amazon Web Services Secrets Manager for the 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 you don't specify MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS // key is used to encrypt the secret. If the secret is in a different Amazon Web // Services account, then you can't use the aws/secretsmanager KMS key to encrypt // the secret, and you must use a customer managed 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. MasterUserSecretKmsKeyId *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 // 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]in the Amazon RDS User Guide. // // [Managing capacity automatically with Amazon RDS storage autoscaling]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling MaxAllocatedStorage *int32 // 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 *int32 // 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]in the Amazon RDS User // Guide. // // If MonitoringInterval is set to a value other than 0, then you must supply a // MonitoringRoleArn value. // // [Setting Up and Enabling Enhanced Monitoring]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling MonitoringRoleArn *string // Specifies 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 // 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] in the Amazon RDS User Guide. // // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *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 // 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 // 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 *int32 // The port number on which the database accepts connections. // // Type: Integer // // Valid Values: 1150 - 65535 // // Default: 3306 Port *int32 // The time range each day during which automated backups are created if automated // backups are enabled. For more information, see [Backup window]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. // // [Backup window]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow PreferredBackupWindow *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]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. // // [Amazon RDS Maintenance Window]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance PreferredMaintenanceWindow *string // The number of CPU cores and the number of threads per core for the DB instance // class of the DB instance. ProcessorFeatures []types.ProcessorFeature // Specifies 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 // The prefix of your Amazon S3 bucket. S3Prefix *string // Specifies whether the new DB instance is encrypted or not. StorageEncrypted *bool // Specifies the storage throughput value for the DB instance. // // This setting doesn't apply to RDS Custom or Amazon Aurora. StorageThroughput *int32 // Specifies the storage type to be associated with the DB instance. // // Valid Values: gp2 | gp3 | io1 | io2 | standard // // If you specify io1 , io2 , or gp3 , you must also include a value for the Iops // parameter. // // Default: io1 if the Iops parameter is specified; otherwise gp2 StorageType *string // A list of tags to associate with this DB instance. For more information, see [Tagging Amazon RDS Resources] // in the Amazon RDS User Guide. // // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag // Specifies whether the DB instance class of the DB instance uses its default // processor features. UseDefaultProcessorFeatures *bool // A list of VPC security groups to associate with this DB instance. VpcSecurityGroupIds []string // contains filtered or unexported fields }
type RestoreDBInstanceFromS3Output ¶
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 *types.DBInstance // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RestoreDBInstanceToPointInTimeInput ¶
type RestoreDBInstanceToPointInTimeInput struct { // The name of the new DB instance to create. // // 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. // // This member is required. TargetDBInstanceIdentifier *string // The amount of storage (in gibibytes) to allocate initially for the DB instance. // Follow the allocation rules specified in CreateDBInstance . // // This setting isn't valid for RDS for SQL Server. // // Be sure to allocate enough storage for your new DB instance so that the restore // operation can succeed. You can also allocate additional storage for future // growth. AllocatedStorage *int32 // Specifies 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 // The Availability Zone (AZ) where the DB instance will be created. // // Default: A random, system-chosen Availability Zone. // // Constraints: // // - You can't specify the AvailabilityZone parameter if the DB instance is a // Multi-AZ deployment. // // Example: us-east-1a AvailabilityZone *string // The location for storing automated backups and manual snapshots for the // restored DB instance. // // Valid Values: // // - outposts (Amazon Web Services Outposts) // // - region (Amazon Web Services Region) // // Default: region // // For more information, see [Working with Amazon RDS on Amazon Web Services Outposts] in the Amazon RDS User Guide. // // [Working with Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html BackupTarget *string // The CA certificate identifier to use for the DB instance's server certificate. // // This setting doesn't apply to RDS Custom DB instances. // // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon // Aurora User Guide. // // [Using SSL/TLS to encrypt a connection to a DB cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html // [Using SSL/TLS to encrypt a connection to a DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html CACertificateIdentifier *string // Specifies whether to copy all tags from the restored DB instance to snapshots // of the DB instance. By default, tags are not copied. CopyTagsToSnapshot *bool // 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] in the Amazon RDS // User Guide. // // This setting is required for RDS Custom. // // [Configure IAM and your VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc CustomIamInstanceProfile *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]in the Amazon RDS User Guide. // // Default: The same DB instance class as the original DB instance. // // [DB Instance Class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html DBInstanceClass *string // The database name for the restored DB instance. // // This parameter doesn't apply to the following DB instances: // // - RDS Custom // // - RDS for Db2 // // - RDS for MariaDB // // - RDS for MySQL DBName *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 DB 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. DBParameterGroupName *string // The DB subnet group name to use for the new instance. // // Constraints: // // - If supplied, must match the name of an existing DB subnet group. // // Example: mydbsubnetgroup DBSubnetGroupName *string // Specifies whether to enable a dedicated log volume (DLV) for the DB instance. DedicatedLogVolume *bool // Specifies 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]. // // [Deleting a DB Instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html DeletionProtection *bool // 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] in the Amazon RDS User Guide. // // [Kerberos Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html Domain *string // The ARN for the Secrets Manager secret with the credentials for the user // joining the domain. // // Constraints: // // - Can't be longer than 64 characters. // // Example: // arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456 DomainAuthSecretArn *string // The IPv4 DNS IP addresses of your primary and secondary Active Directory domain // controllers. // // Constraints: // // - Two IP addresses must be provided. If there isn't a secondary domain // controller, use the IP address of the primary domain controller for both entries // in the list. // // Example: 123.124.125.126,234.235.236.237 DomainDnsIps []string // The fully qualified domain name (FQDN) of an Active Directory domain. // // Constraints: // // - Can't be longer than 64 characters. // // Example: mymanagedADtest.mymanagedAD.mydomain DomainFqdn *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 DB instances. DomainIAMRoleName *string // The Active Directory organizational unit for your DB instance to join. // // Constraints: // // - Must be in the distinguished name format. // // - Can't be longer than 64 characters. // // Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain DomainOu *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]in the Amazon RDS User Guide. // // This setting doesn't apply to RDS Custom. // // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch EnableCloudwatchLogsExports []string // Specifies 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] in the Amazon RDS User Guide. // // For more information about CoIPs, see [Customer-owned IP addresses] in the Amazon Web Services Outposts User // Guide. // // [Working with Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html // [Customer-owned IP addresses]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing EnableCustomerOwnedIp *bool // Specifies 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] in the Amazon RDS // User Guide. // // [IAM Database Authentication for MySQL and PostgreSQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool // The database engine to use for the new instance. // // This setting doesn't apply to RDS Custom. // // Valid Values: // // - db2-ae // // - db2-se // // - mariadb // // - mysql // // - oracle-ee // // - oracle-ee-cdb // // - oracle-se2 // // - oracle-se2-cdb // // - postgres // // - sqlserver-ee // // - sqlserver-se // // - sqlserver-ex // // - sqlserver-web // // Default: The same as source // // Constraints: // // - Must be compatible with the engine of the source. Engine *string // The life cycle type for this DB instance. // // By default, this value is set to open-source-rds-extended-support , which // enrolls your DB instance into Amazon RDS Extended Support. At the end of // standard support, you can avoid charges for Extended Support by setting the // value to open-source-rds-extended-support-disabled . In this case, RDS // automatically upgrades your restored DB instance to a higher engine version, if // the major engine version is past its end of standard support date. // // You can use this setting to enroll your DB instance into Amazon RDS Extended // Support. With RDS Extended Support, you can run the selected major engine // version on your DB instance past the end of standard support for that engine // version. For more information, see [Using Amazon RDS Extended Support]in the Amazon RDS User Guide. // // This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon // Aurora DB instances, the life cycle type is managed by the DB cluster. // // Valid Values: open-source-rds-extended-support | // open-source-rds-extended-support-disabled // // Default: open-source-rds-extended-support // // [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html EngineLifecycleSupport *string // The amount of Provisioned IOPS (input/output operations per second) to // initially allocate for the DB instance. // // This setting doesn't apply to SQL Server. // // Constraints: // // - Must be an integer greater than 1000. Iops *int32 // The license model information for the restored DB instance. // // License models for RDS for Db2 require additional configuration. The Bring Your // Own License (BYOL) model requires a custom parameter group and an Amazon Web // Services License Manager self-managed license. The Db2 license through Amazon // Web Services Marketplace model requires an Amazon Web Services Marketplace // subscription. For more information, see [Amazon RDS for Db2 licensing options]in the Amazon RDS User Guide. // // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. // // Valid Values: // // - RDS for Db2 - bring-your-own-license | marketplace-license // // - RDS for MariaDB - general-public-license // // - RDS for Microsoft SQL Server - license-included // // - RDS for MySQL - general-public-license // // - RDS for Oracle - bring-your-own-license | license-included // // - RDS for PostgreSQL - postgresql-license // // Default: Same as the source. // // [Amazon RDS for Db2 licensing options]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html LicenseModel *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]in the Amazon RDS User Guide. // // This setting doesn't apply to RDS Custom. // // [Managing capacity automatically with Amazon RDS storage autoscaling]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling MaxAllocatedStorage *int32 // Secifies whether the DB instance is a Multi-AZ deployment. // // This setting doesn't apply to RDS Custom. // // Constraints: // // - You can't specify the AvailabilityZone parameter if the DB instance is a // Multi-AZ deployment. MultiAZ *bool // The network type of the DB instance. // // 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] in the Amazon RDS User Guide. // // Valid Values: // // - IPV4 // // - DUAL // // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *string // The name of the option group to use 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 // The port number on which the database accepts connections. // // Default: The same port as the original DB instance. // // Constraints: // // - The value must be 1150-65535 . Port *int32 // 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 []types.ProcessorFeature // Specifies 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 // The date and time to restore from. // // Constraints: // // - Must be a time in Universal Coordinated Time (UTC) format. // // - 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 // The Amazon Resource Name (ARN) of the replicated automated backups from which // to restore, for example, // arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE . // // This setting doesn't apply to RDS Custom. SourceDBInstanceAutomatedBackupsArn *string // The identifier of the source DB instance from which to restore. // // Constraints: // // - Must match the identifier of an existing DB instance. SourceDBInstanceIdentifier *string // The resource ID of the source DB instance from which to restore. SourceDbiResourceId *string // The storage throughput value for the DB instance. // // This setting doesn't apply to RDS Custom or Amazon Aurora. StorageThroughput *int32 // The storage type to associate with the DB instance. // // Valid Values: gp2 | gp3 | io1 | io2 | standard // // Default: io1 , if the Iops parameter is specified. Otherwise, gp2 . // // Constraints: // // - If you specify io1 , io2 , or gp3 , you must also include a value for the // Iops parameter. StorageType *string // A list of tags. // // For more information, see [Tagging Amazon RDS resources] in the Amazon RDS User Guide or [Tagging Amazon Aurora and Amazon RDS resources] in the Amazon // Aurora User Guide. // // [Tagging Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html // [Tagging Amazon Aurora and Amazon RDS resources]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html Tags []types.Tag // 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 // 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 // Specifies whether the DB instance class of the DB instance uses its default // processor features. // // This setting doesn't apply to RDS Custom. UseDefaultProcessorFeatures *bool // Specifies 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 // 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 // contains filtered or unexported fields }
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 *types.DBInstance // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RevokeDBSecurityGroupIngressInput ¶
type RevokeDBSecurityGroupIngressInput struct { // The name of the DB security group to revoke ingress from. // // This member is required. DBSecurityGroupName *string // 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 // 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 // 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 // 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 // contains filtered or unexported fields }
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 *types.DBSecurityGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartActivityStreamInput ¶
type StartActivityStreamInput struct { // 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. // // This member is required. KmsKeyId *string // 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. // // This member is required. Mode types.ActivityStreamMode // The Amazon Resource Name (ARN) of the DB cluster, for example, // arn:aws:rds:us-east-1:12345667890:cluster:das-cluster . // // This member is required. ResourceArn *string // 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 // Specifies whether the database activity stream includes engine-native audit // fields. This option applies to an Oracle or Microsoft SQL Server DB instance. By // default, no engine-native audit fields are included. EngineNativeAuditFieldsIncluded *bool // contains filtered or unexported fields }
type StartActivityStreamOutput ¶
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 // Indicates whether engine-native audit fields are included in the database // activity stream. EngineNativeAuditFieldsIncluded *bool // The name of the Amazon Kinesis data stream to be used for the database activity // stream. KinesisStreamName *string // The Amazon Web Services KMS key identifier for encryption of messages in the // database activity stream. KmsKeyId *string // The mode of the database activity stream. Mode types.ActivityStreamMode // The status of the database activity stream. Status types.ActivityStreamStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartDBClusterInput ¶
type StartDBClusterInput struct { // The DB cluster identifier of the Amazon Aurora DB cluster to be started. This // parameter is stored as a lowercase string. // // This member is required. DBClusterIdentifier *string // contains filtered or unexported fields }
type StartDBClusterOutput ¶
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?] in the Amazon Aurora // User Guide. // // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User // Guide. // // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartDBInstanceAutomatedBackupsReplicationInput ¶ added in v0.31.0
type StartDBInstanceAutomatedBackupsReplicationInput struct { // 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 // . // // This member is required. SourceDBInstanceArn *string // The retention period for the replicated automated backups. BackupRetentionPeriod *int32 // 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 // 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)] and [Signature Version 4 Signing Process]. // // 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. // // [Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html // [Signature Version 4 Signing Process]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html PreSignedUrl *string // contains filtered or unexported fields }
type StartDBInstanceAutomatedBackupsReplicationOutput ¶ added in v0.31.0
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 *types.DBInstanceAutomatedBackup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartDBInstanceInput ¶
type StartDBInstanceInput struct { // The user-supplied instance identifier. // // This member is required. DBInstanceIdentifier *string // contains filtered or unexported fields }
type StartDBInstanceOutput ¶
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 *types.DBInstance // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartExportTaskInput ¶
type StartExportTaskInput struct { // A unique identifier for the export task. This ID isn't an identifier for the // Amazon S3 bucket where the data is to be exported. // // This member is required. ExportTaskIdentifier *string // The name of the IAM role to use for writing to the Amazon S3 bucket when // exporting a snapshot or cluster. // // In the IAM policy attached to your IAM role, include the following required // actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 // bucket: // // - s3:PutObject* // // - s3:GetObject* // // - s3:ListBucket // // - s3:DeleteObject* // // - s3:GetBucketLocation // // In the policy, include the resources to identify the S3 bucket and objects in // the bucket. The following list of resources shows the Amazon Resource Name (ARN) // format for accessing S3: // // - arn:aws:s3:::your-s3-bucket // // - arn:aws:s3:::your-s3-bucket/* // // This member is required. IamRoleArn *string // The ID of the Amazon Web Services KMS key to use to encrypt the data 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 run the following operations. These can be set in the Amazon Web // Services KMS key policy: // // - kms:Encrypt // // - kms:Decrypt // // - kms:GenerateDataKey // // - kms:GenerateDataKeyWithoutPlaintext // // - kms:ReEncryptFrom // // - kms:ReEncryptTo // // - kms:CreateGrant // // - kms:DescribeKey // // - kms:RetireGrant // // This member is required. KmsKeyId *string // The name of the Amazon S3 bucket to export the snapshot or cluster data to. // // This member is required. S3BucketName *string // The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon // S3. // // This member is required. SourceArn *string // The data to be exported from the snapshot or cluster. If this parameter isn't // provided, all of the data is exported. // // Valid Values: // // - database - Export all the data from a specified database. // // - database.table table-name - Export a table of the snapshot or cluster. 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 or // cluster. 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 // The Amazon S3 bucket prefix to use as the file name and path of the exported // data. S3Prefix *string // contains filtered or unexported fields }
type StartExportTaskOutput ¶
type StartExportTaskOutput struct { // The data exported from the snapshot or cluster. // // Valid Values: // // - database - Export all the data from a specified database. // // - database.table table-name - Export a table of the snapshot or cluster. 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 or // cluster. 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 // A unique identifier for the snapshot or cluster export task. This ID isn't an // identifier for the Amazon S3 bucket where the data is exported. ExportTaskIdentifier *string // The reason the export failed, if it failed. FailureCause *string // The name of the IAM role that is used to write to Amazon S3 when exporting a // snapshot or cluster. IamRoleArn *string // The key identifier of the Amazon Web Services KMS key that is used to encrypt // the data 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 export must have // encryption and decryption permissions to use this KMS key. KmsKeyId *string // The progress of the snapshot or cluster export task as a percentage. PercentProgress *int32 // The Amazon S3 bucket where the snapshot or cluster is exported to. S3Bucket *string // The Amazon S3 bucket prefix that is the file name and path of the exported data. S3Prefix *string // The time when the snapshot was created. SnapshotTime *time.Time // The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. SourceArn *string // The type of source for the export. SourceType types.ExportSourceType // The progress status of the export task. The status can be one of the following: // // - CANCELED // // - CANCELING // // - COMPLETE // // - FAILED // // - IN_PROGRESS // // - STARTING Status *string // The time when the snapshot or cluster export task ended. TaskEndTime *time.Time // The time when the snapshot or cluster export task started. TaskStartTime *time.Time // The total amount of data exported, in gigabytes. TotalExtractedDataInGB *int32 // A warning about the snapshot or cluster export task. WarningMessage *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the details of a snapshot or cluster export to Amazon S3.
This data type is used as a response element in the DescribeExportTasks operation.
type StopActivityStreamInput ¶
type StopActivityStreamInput struct { // 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 . // // This member is required. ResourceArn *string // 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 // contains filtered or unexported fields }
type StopActivityStreamOutput ¶
type StopActivityStreamOutput struct { // The name of the Amazon Kinesis data stream used for the database activity // stream. KinesisStreamName *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 // The status of the database activity stream. Status types.ActivityStreamStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StopDBClusterInput ¶
type StopDBClusterInput struct { // The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This // parameter is stored as a lowercase string. // // This member is required. DBClusterIdentifier *string // contains filtered or unexported fields }
type StopDBClusterOutput ¶
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?] in the Amazon Aurora // User Guide. // // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User // Guide. // // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StopDBInstanceAutomatedBackupsReplicationInput ¶ added in v0.31.0
type StopDBInstanceAutomatedBackupsReplicationInput struct { // The Amazon Resource Name (ARN) of the source DB instance for which to stop // replicating automate backups, for example, // arn:aws:rds:us-west-2:123456789012:db:mydatabase . // // This member is required. SourceDBInstanceArn *string // contains filtered or unexported fields }
type StopDBInstanceAutomatedBackupsReplicationOutput ¶ added in v0.31.0
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 *types.DBInstanceAutomatedBackup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StopDBInstanceInput ¶
type StopDBInstanceInput struct { // The user-supplied instance identifier. // // This member is required. DBInstanceIdentifier *string // The user-supplied instance identifier of the DB Snapshot created immediately // before the DB instance is stopped. DBSnapshotIdentifier *string // contains filtered or unexported fields }
type StopDBInstanceOutput ¶
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 *types.DBInstance // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type SwitchoverBlueGreenDeploymentInput ¶ added in v1.31.0
type SwitchoverBlueGreenDeploymentInput struct { // The resource ID of the blue/green deployment. // // Constraints: // // - Must match an existing blue/green deployment resource ID. // // This member is required. BlueGreenDeploymentIdentifier *string // The amount of time, in seconds, for the switchover to complete. // // Default: 300 // // If the switchover takes longer than the specified duration, then any changes // are rolled back, and no changes are made to the environments. SwitchoverTimeout *int32 // contains filtered or unexported fields }
type SwitchoverBlueGreenDeploymentOutput ¶ added in v1.31.0
type SwitchoverBlueGreenDeploymentOutput struct { // Details about a blue/green deployment. // // For more information, see [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon RDS User Guide and [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon // Aurora User Guide. // // [Using Amazon RDS Blue/Green Deployments for database updates]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html BlueGreenDeployment *types.BlueGreenDeployment // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type SwitchoverGlobalClusterInput ¶ added in v1.51.0
type SwitchoverGlobalClusterInput struct { // The identifier of the global database cluster to switch over. This parameter // isn't case-sensitive. // // Constraints: // // - Must match the identifier of an existing global database cluster (Aurora // global database). // // This member is required. GlobalClusterIdentifier *string // The identifier of the secondary Aurora DB cluster to promote to the new primary // for the global database cluster. Use the Amazon Resource Name (ARN) for the // identifier so that Aurora can locate the cluster in its Amazon Web Services // Region. // // This member is required. TargetDbClusterIdentifier *string // contains filtered or unexported fields }
type SwitchoverGlobalClusterOutput ¶ added in v1.51.0
type SwitchoverGlobalClusterOutput struct { // A data type representing an Aurora global database. GlobalCluster *types.GlobalCluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type SwitchoverReadReplicaInput ¶ added in v1.25.0
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. // // This member is required. DBInstanceIdentifier *string // contains filtered or unexported fields }
type SwitchoverReadReplicaOutput ¶ added in v1.25.0
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 *types.DBInstance // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type TenantDatabaseAvailableWaiter ¶ added in v1.62.0
type TenantDatabaseAvailableWaiter struct {
// contains filtered or unexported fields
}
TenantDatabaseAvailableWaiter defines the waiters for TenantDatabaseAvailable
func NewTenantDatabaseAvailableWaiter ¶ added in v1.62.0
func NewTenantDatabaseAvailableWaiter(client DescribeTenantDatabasesAPIClient, optFns ...func(*TenantDatabaseAvailableWaiterOptions)) *TenantDatabaseAvailableWaiter
NewTenantDatabaseAvailableWaiter constructs a TenantDatabaseAvailableWaiter.
func (*TenantDatabaseAvailableWaiter) Wait ¶ added in v1.62.0
func (w *TenantDatabaseAvailableWaiter) Wait(ctx context.Context, params *DescribeTenantDatabasesInput, maxWaitDur time.Duration, optFns ...func(*TenantDatabaseAvailableWaiterOptions)) error
Wait calls the waiter function for TenantDatabaseAvailable waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*TenantDatabaseAvailableWaiter) WaitForOutput ¶ added in v1.62.0
func (w *TenantDatabaseAvailableWaiter) WaitForOutput(ctx context.Context, params *DescribeTenantDatabasesInput, maxWaitDur time.Duration, optFns ...func(*TenantDatabaseAvailableWaiterOptions)) (*DescribeTenantDatabasesOutput, error)
WaitForOutput calls the waiter function for TenantDatabaseAvailable waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type TenantDatabaseAvailableWaiterOptions ¶ added in v1.62.0
type TenantDatabaseAvailableWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. // // Passing options here is functionally equivalent to passing values to this // config's ClientOptions field that extend the inner client's APIOptions directly. APIOptions []func(*middleware.Stack) error // Functional options to be passed to all operations invoked by this client. // // Function values that modify the inner APIOptions are applied after the waiter // config's own APIOptions modifiers. ClientOptions []func(*Options) // MinDelay is the minimum amount of time to delay between retries. If unset, // TenantDatabaseAvailableWaiter will use default minimum delay of 30 seconds. Note // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or // set to zero, TenantDatabaseAvailableWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. // // By default service-modeled logic will populate this option. This option can // thus be used to define a custom waiter state with fall-back to service-modeled // waiter state mutators.The function returns an error in case of a failure state. // In case of retry state, this function returns a bool value of true and nil // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeTenantDatabasesInput, *DescribeTenantDatabasesOutput, error) (bool, error) }
TenantDatabaseAvailableWaiterOptions are waiter options for TenantDatabaseAvailableWaiter
type TenantDatabaseDeletedWaiter ¶ added in v1.62.0
type TenantDatabaseDeletedWaiter struct {
// contains filtered or unexported fields
}
TenantDatabaseDeletedWaiter defines the waiters for TenantDatabaseDeleted
func NewTenantDatabaseDeletedWaiter ¶ added in v1.62.0
func NewTenantDatabaseDeletedWaiter(client DescribeTenantDatabasesAPIClient, optFns ...func(*TenantDatabaseDeletedWaiterOptions)) *TenantDatabaseDeletedWaiter
NewTenantDatabaseDeletedWaiter constructs a TenantDatabaseDeletedWaiter.
func (*TenantDatabaseDeletedWaiter) Wait ¶ added in v1.62.0
func (w *TenantDatabaseDeletedWaiter) Wait(ctx context.Context, params *DescribeTenantDatabasesInput, maxWaitDur time.Duration, optFns ...func(*TenantDatabaseDeletedWaiterOptions)) error
Wait calls the waiter function for TenantDatabaseDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*TenantDatabaseDeletedWaiter) WaitForOutput ¶ added in v1.62.0
func (w *TenantDatabaseDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeTenantDatabasesInput, maxWaitDur time.Duration, optFns ...func(*TenantDatabaseDeletedWaiterOptions)) (*DescribeTenantDatabasesOutput, error)
WaitForOutput calls the waiter function for TenantDatabaseDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type TenantDatabaseDeletedWaiterOptions ¶ added in v1.62.0
type TenantDatabaseDeletedWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. // // Passing options here is functionally equivalent to passing values to this // config's ClientOptions field that extend the inner client's APIOptions directly. APIOptions []func(*middleware.Stack) error // Functional options to be passed to all operations invoked by this client. // // Function values that modify the inner APIOptions are applied after the waiter // config's own APIOptions modifiers. ClientOptions []func(*Options) // MinDelay is the minimum amount of time to delay between retries. If unset, // TenantDatabaseDeletedWaiter will use default minimum delay of 30 seconds. Note // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or // set to zero, TenantDatabaseDeletedWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. // // By default service-modeled logic will populate this option. This option can // thus be used to define a custom waiter state with fall-back to service-modeled // waiter state mutators.The function returns an error in case of a failure state. // In case of retry state, this function returns a bool value of true and nil // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeTenantDatabasesInput, *DescribeTenantDatabasesOutput, error) (bool, error) }
TenantDatabaseDeletedWaiterOptions are waiter options for TenantDatabaseDeletedWaiter
Source Files ¶
- api_client.go
- api_op_AddRoleToDBCluster.go
- api_op_AddRoleToDBInstance.go
- api_op_AddSourceIdentifierToSubscription.go
- api_op_AddTagsToResource.go
- api_op_ApplyPendingMaintenanceAction.go
- api_op_AuthorizeDBSecurityGroupIngress.go
- api_op_BacktrackDBCluster.go
- api_op_CancelExportTask.go
- api_op_CopyDBClusterParameterGroup.go
- api_op_CopyDBClusterSnapshot.go
- api_op_CopyDBParameterGroup.go
- api_op_CopyDBSnapshot.go
- api_op_CopyOptionGroup.go
- api_op_CreateBlueGreenDeployment.go
- api_op_CreateCustomDBEngineVersion.go
- api_op_CreateDBCluster.go
- api_op_CreateDBClusterEndpoint.go
- api_op_CreateDBClusterParameterGroup.go
- api_op_CreateDBClusterSnapshot.go
- api_op_CreateDBInstance.go
- api_op_CreateDBInstanceReadReplica.go
- api_op_CreateDBParameterGroup.go
- api_op_CreateDBProxy.go
- api_op_CreateDBProxyEndpoint.go
- api_op_CreateDBSecurityGroup.go
- api_op_CreateDBShardGroup.go
- api_op_CreateDBSnapshot.go
- api_op_CreateDBSubnetGroup.go
- api_op_CreateEventSubscription.go
- api_op_CreateGlobalCluster.go
- api_op_CreateIntegration.go
- api_op_CreateOptionGroup.go
- api_op_CreateTenantDatabase.go
- api_op_DeleteBlueGreenDeployment.go
- api_op_DeleteCustomDBEngineVersion.go
- api_op_DeleteDBCluster.go
- api_op_DeleteDBClusterAutomatedBackup.go
- api_op_DeleteDBClusterEndpoint.go
- api_op_DeleteDBClusterParameterGroup.go
- api_op_DeleteDBClusterSnapshot.go
- api_op_DeleteDBInstance.go
- api_op_DeleteDBInstanceAutomatedBackup.go
- api_op_DeleteDBParameterGroup.go
- api_op_DeleteDBProxy.go
- api_op_DeleteDBProxyEndpoint.go
- api_op_DeleteDBSecurityGroup.go
- api_op_DeleteDBShardGroup.go
- api_op_DeleteDBSnapshot.go
- api_op_DeleteDBSubnetGroup.go
- api_op_DeleteEventSubscription.go
- api_op_DeleteGlobalCluster.go
- api_op_DeleteIntegration.go
- api_op_DeleteOptionGroup.go
- api_op_DeleteTenantDatabase.go
- api_op_DeregisterDBProxyTargets.go
- api_op_DescribeAccountAttributes.go
- api_op_DescribeBlueGreenDeployments.go
- api_op_DescribeCertificates.go
- api_op_DescribeDBClusterAutomatedBackups.go
- api_op_DescribeDBClusterBacktracks.go
- api_op_DescribeDBClusterEndpoints.go
- api_op_DescribeDBClusterParameterGroups.go
- api_op_DescribeDBClusterParameters.go
- api_op_DescribeDBClusterSnapshotAttributes.go
- api_op_DescribeDBClusterSnapshots.go
- api_op_DescribeDBClusters.go
- api_op_DescribeDBEngineVersions.go
- api_op_DescribeDBInstanceAutomatedBackups.go
- api_op_DescribeDBInstances.go
- api_op_DescribeDBLogFiles.go
- api_op_DescribeDBParameterGroups.go
- api_op_DescribeDBParameters.go
- api_op_DescribeDBProxies.go
- api_op_DescribeDBProxyEndpoints.go
- api_op_DescribeDBProxyTargetGroups.go
- api_op_DescribeDBProxyTargets.go
- api_op_DescribeDBRecommendations.go
- api_op_DescribeDBSecurityGroups.go
- api_op_DescribeDBShardGroups.go
- api_op_DescribeDBSnapshotAttributes.go
- api_op_DescribeDBSnapshotTenantDatabases.go
- api_op_DescribeDBSnapshots.go
- api_op_DescribeDBSubnetGroups.go
- api_op_DescribeEngineDefaultClusterParameters.go
- api_op_DescribeEngineDefaultParameters.go
- api_op_DescribeEventCategories.go
- api_op_DescribeEventSubscriptions.go
- api_op_DescribeEvents.go
- api_op_DescribeExportTasks.go
- api_op_DescribeGlobalClusters.go
- api_op_DescribeIntegrations.go
- api_op_DescribeOptionGroupOptions.go
- api_op_DescribeOptionGroups.go
- api_op_DescribeOrderableDBInstanceOptions.go
- api_op_DescribePendingMaintenanceActions.go
- api_op_DescribeReservedDBInstances.go
- api_op_DescribeReservedDBInstancesOfferings.go
- api_op_DescribeSourceRegions.go
- api_op_DescribeTenantDatabases.go
- api_op_DescribeValidDBInstanceModifications.go
- api_op_DisableHttpEndpoint.go
- api_op_DownloadDBLogFilePortion.go
- api_op_EnableHttpEndpoint.go
- api_op_FailoverDBCluster.go
- api_op_FailoverGlobalCluster.go
- api_op_ListTagsForResource.go
- api_op_ModifyActivityStream.go
- api_op_ModifyCertificates.go
- api_op_ModifyCurrentDBClusterCapacity.go
- api_op_ModifyCustomDBEngineVersion.go
- api_op_ModifyDBCluster.go
- api_op_ModifyDBClusterEndpoint.go
- api_op_ModifyDBClusterParameterGroup.go
- api_op_ModifyDBClusterSnapshotAttribute.go
- api_op_ModifyDBInstance.go
- api_op_ModifyDBParameterGroup.go
- api_op_ModifyDBProxy.go
- api_op_ModifyDBProxyEndpoint.go
- api_op_ModifyDBProxyTargetGroup.go
- api_op_ModifyDBRecommendation.go
- api_op_ModifyDBShardGroup.go
- api_op_ModifyDBSnapshot.go
- api_op_ModifyDBSnapshotAttribute.go
- api_op_ModifyDBSubnetGroup.go
- api_op_ModifyEventSubscription.go
- api_op_ModifyGlobalCluster.go
- api_op_ModifyIntegration.go
- api_op_ModifyOptionGroup.go
- api_op_ModifyTenantDatabase.go
- api_op_PromoteReadReplica.go
- api_op_PromoteReadReplicaDBCluster.go
- api_op_PurchaseReservedDBInstancesOffering.go
- api_op_RebootDBCluster.go
- api_op_RebootDBInstance.go
- api_op_RebootDBShardGroup.go
- api_op_RegisterDBProxyTargets.go
- api_op_RemoveFromGlobalCluster.go
- api_op_RemoveRoleFromDBCluster.go
- api_op_RemoveRoleFromDBInstance.go
- api_op_RemoveSourceIdentifierFromSubscription.go
- api_op_RemoveTagsFromResource.go
- api_op_ResetDBClusterParameterGroup.go
- api_op_ResetDBParameterGroup.go
- api_op_RestoreDBClusterFromS3.go
- api_op_RestoreDBClusterFromSnapshot.go
- api_op_RestoreDBClusterToPointInTime.go
- api_op_RestoreDBInstanceFromDBSnapshot.go
- api_op_RestoreDBInstanceFromS3.go
- api_op_RestoreDBInstanceToPointInTime.go
- api_op_RevokeDBSecurityGroupIngress.go
- api_op_StartActivityStream.go
- api_op_StartDBCluster.go
- api_op_StartDBInstance.go
- api_op_StartDBInstanceAutomatedBackupsReplication.go
- api_op_StartExportTask.go
- api_op_StopActivityStream.go
- api_op_StopDBCluster.go
- api_op_StopDBInstance.go
- api_op_StopDBInstanceAutomatedBackupsReplication.go
- api_op_SwitchoverBlueGreenDeployment.go
- api_op_SwitchoverGlobalCluster.go
- api_op_SwitchoverReadReplica.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go