Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Amazonka.RDS
Contents
- Service Configuration
- Errors
- PointInTimeRestoreNotEnabledFault
- InvalidDBParameterGroupStateFault
- ReservedDBInstanceQuotaExceededFault
- SourceNotFoundFault
- CertificateNotFoundFault
- AuthorizationQuotaExceededFault
- DBClusterSnapshotAlreadyExistsFault
- DBParameterGroupAlreadyExistsFault
- DBInstanceRoleQuotaExceededFault
- DBInstanceRoleAlreadyExistsFault
- DBParameterGroupQuotaExceededFault
- BackupPolicyNotFoundFault
- InsufficientDBClusterCapacityFault
- ReservedDBInstanceAlreadyExistsFault
- ProvisionedIopsNotAvailableInAZFault
- DBProxyTargetAlreadyRegisteredFault
- AuthorizationAlreadyExistsFault
- SubscriptionCategoryNotFoundFault
- DBProxyTargetNotFoundFault
- SubscriptionNotFoundFault
- InvalidSubnet
- SharedSnapshotQuotaExceededFault
- DBSubnetQuotaExceededFault
- GlobalClusterAlreadyExistsFault
- OptionGroupNotFoundFault
- DBClusterNotFoundFault
- InvalidDBProxyEndpointStateFault
- DBLogFileNotFoundFault
- DBProxyTargetGroupNotFoundFault
- InvalidS3BucketFault
- DBProxyQuotaExceededFault
- IamRoleNotFoundFault
- DBClusterAlreadyExistsFault
- StorageTypeNotSupportedFault
- DBSecurityGroupQuotaExceededFault
- DBProxyEndpointNotFoundFault
- OptionGroupAlreadyExistsFault
- ExportTaskNotFoundFault
- InsufficientAvailableIPsInSubnetFault
- DBProxyNotFoundFault
- OptionGroupQuotaExceededFault
- DBSecurityGroupAlreadyExistsFault
- SNSTopicArnNotFoundFault
- InvalidDBClusterEndpointStateFault
- InvalidEventSubscriptionStateFault
- InvalidDBInstanceAutomatedBackupStateFault
- KMSKeyNotAccessibleFault
- DBSnapshotNotFoundFault
- DBClusterParameterGroupNotFoundFault
- DBClusterQuotaExceededFault
- InvalidExportOnlyFault
- SnapshotQuotaExceededFault
- InvalidDBClusterCapacityFault
- DBSubnetGroupAlreadyExistsFault
- SNSNoAuthorizationFault
- DBSecurityGroupNotFoundFault
- DBSecurityGroupNotSupportedFault
- InvalidDBProxyStateFault
- DBProxyEndpointQuotaExceededFault
- InstanceQuotaExceededFault
- DBClusterBacktrackNotFoundFault
- DomainNotFoundFault
- DBParameterGroupNotFoundFault
- InvalidDBSubnetGroupFault
- ReservedDBInstancesOfferingNotFoundFault
- InvalidDBSubnetStateFault
- DBClusterSnapshotNotFoundFault
- SNSInvalidTopicFault
- InsufficientDBInstanceCapacityFault
- InvalidDBClusterSnapshotStateFault
- InstallationMediaAlreadyExistsFault
- SubscriptionAlreadyExistFault
- DBClusterRoleAlreadyExistsFault
- IamRoleMissingPermissionsFault
- DBClusterRoleQuotaExceededFault
- InvalidVPCNetworkStateFault
- DBInstanceRoleNotFoundFault
- AuthorizationNotFoundFault
- ReservedDBInstanceNotFoundFault
- DBSubnetGroupQuotaExceededFault
- CustomAvailabilityZoneNotFoundFault
- DBProxyEndpointAlreadyExistsFault
- InvalidGlobalClusterStateFault
- DBSubnetGroupNotAllowedFault
- InvalidExportTaskStateFault
- InvalidExportSourceStateFault
- ExportTaskAlreadyExistsFault
- EventSubscriptionQuotaExceededFault
- InsufficientStorageClusterCapacityFault
- DBClusterEndpointQuotaExceededFault
- InvalidOptionGroupStateFault
- DBInstanceAutomatedBackupQuotaExceededFault
- CustomAvailabilityZoneAlreadyExistsFault
- InvalidDBClusterStateFault
- GlobalClusterNotFoundFault
- DBInstanceAlreadyExistsFault
- InvalidRestoreFault
- InvalidDBSecurityGroupStateFault
- ResourceNotFoundFault
- DBSubnetGroupNotFoundFault
- DBUpgradeDependencyFailureFault
- CustomAvailabilityZoneQuotaExceededFault
- InvalidDBInstanceStateFault
- DBClusterEndpointAlreadyExistsFault
- DBSnapshotAlreadyExistsFault
- DBInstanceNotFoundFault
- StorageQuotaExceededFault
- DBProxyAlreadyExistsFault
- DBInstanceAutomatedBackupNotFoundFault
- InvalidDBSnapshotStateFault
- InvalidDBSubnetGroupStateFault
- GlobalClusterQuotaExceededFault
- DBClusterEndpointNotFoundFault
- InstallationMediaNotFoundFault
- DBSubnetGroupDoesNotCoverEnoughAZs
- SubnetAlreadyInUse
- DBClusterRoleNotFoundFault
- Waiters
- Operations
- StartDBCluster
- DescribeDBClusterParameterGroups (Paginated)
- PromoteReadReplica
- DescribeDBEngineVersions (Paginated)
- StopDBInstance
- ModifyDBClusterEndpoint
- DescribeDBProxyEndpoints (Paginated)
- CopyDBSnapshot
- AddSourceIdentifierToSubscription
- ModifyDBInstance
- ModifyEventSubscription
- ResetDBClusterParameterGroup
- DescribeCustomAvailabilityZones (Paginated)
- RestoreDBClusterFromS3
- DescribeEvents (Paginated)
- DescribeEngineDefaultParameters (Paginated)
- DescribeOptionGroups (Paginated)
- DescribeDBLogFiles (Paginated)
- DescribeDBClusters (Paginated)
- ModifyDBSubnetGroup
- ListTagsForResource
- DeleteOptionGroup
- CreateDBProxyEndpoint
- DeleteDBCluster
- DescribeReservedDBInstances (Paginated)
- CopyDBParameterGroup
- RemoveSourceIdentifierFromSubscription
- DeleteCustomAvailabilityZone
- DescribeDBProxyTargets (Paginated)
- StartDBInstanceAutomatedBackupsReplication
- DescribeEngineDefaultClusterParameters (Paginated)
- DescribeDBSnapshotAttributes
- CreateCustomAvailabilityZone
- BacktrackDBCluster
- DeleteGlobalCluster
- PromoteReadReplicaDBCluster
- RemoveTagsFromResource
- RestoreDBInstanceFromDBSnapshot
- DeleteDBProxy
- CreateEventSubscription
- PurchaseReservedDBInstancesOffering
- CreateDBInstance
- DeleteDBClusterParameterGroup
- DescribeCertificates (Paginated)
- AuthorizeDBSecurityGroupIngress
- RemoveRoleFromDBInstance
- DescribeSourceRegions (Paginated)
- CreateDBClusterEndpoint
- RestoreDBClusterFromSnapshot
- DescribeOrderableDBInstanceOptions (Paginated)
- DeleteDBClusterEndpoint
- CreateDBProxy
- DeleteDBInstanceAutomatedBackup
- CreateDBClusterParameterGroup
- CreateDBSnapshot
- DeleteEventSubscription
- DescribeDBClusterBacktracks (Paginated)
- DescribeDBParameterGroups (Paginated)
- ModifyDBSnapshotAttribute
- DescribeDBInstanceAutomatedBackups (Paginated)
- RemoveFromGlobalCluster
- AddRoleToDBInstance
- DeleteDBClusterSnapshot
- ModifyDBProxyEndpoint
- DescribeValidDBInstanceModifications
- DescribeDBClusterEndpoints (Paginated)
- DescribeOptionGroupOptions (Paginated)
- DescribeEventSubscriptions (Paginated)
- AddTagsToResource
- DescribeDBParameters (Paginated)
- StopActivityStream
- CreateDBClusterSnapshot
- DescribeDBSnapshots (Paginated)
- ModifyDBProxyTargetGroup
- DescribeDBSubnetGroups (Paginated)
- ModifyOptionGroup
- StopDBCluster
- CreateDBParameterGroup
- ModifyDBClusterSnapshotAttribute
- ModifyDBCluster
- CopyDBClusterParameterGroup
- DescribeEventCategories
- DescribeGlobalClusters (Paginated)
- StartDBInstance
- DescribeExportTasks (Paginated)
- CancelExportTask
- ModifyDBClusterParameterGroup
- RestoreDBInstanceToPointInTime
- DescribeDBClusterSnapshotAttributes
- ModifyDBSnapshot
- DescribeDBProxyTargetGroups (Paginated)
- ModifyDBProxy
- DescribePendingMaintenanceActions (Paginated)
- AddRoleToDBCluster
- CopyDBClusterSnapshot
- ImportInstallationMedia
- CreateGlobalCluster
- ResetDBParameterGroup
- FailoverGlobalCluster
- DescribeInstallationMedia (Paginated)
- DeregisterDBProxyTargets
- CreateDBCluster
- RemoveRoleFromDBCluster
- FailoverDBCluster
- RevokeDBSecurityGroupIngress
- ModifyDBParameterGroup
- ApplyPendingMaintenanceAction
- DeleteDBProxyEndpoint
- StopDBInstanceAutomatedBackupsReplication
- CreateOptionGroup
- DescribeAccountAttributes
- DeleteDBSnapshot
- DescribeDBClusterParameters (Paginated)
- DeleteDBSubnetGroup
- CreateDBSecurityGroup
- ModifyCertificates
- DescribeDBClusterSnapshots (Paginated)
- RebootDBInstance
- CreateDBSubnetGroup
- DescribeReservedDBInstancesOfferings (Paginated)
- DeleteDBSecurityGroup
- DeleteDBInstance
- StartActivityStream
- CreateDBInstanceReadReplica
- DeleteDBParameterGroup
- ModifyCurrentDBClusterCapacity
- ModifyGlobalCluster
- RegisterDBProxyTargets
- DescribeDBSecurityGroups (Paginated)
- CopyOptionGroup
- RestoreDBClusterToPointInTime
- DeleteInstallationMedia
- DescribeDBInstances (Paginated)
- RestoreDBInstanceFromS3
- DownloadDBLogFilePortion (Paginated)
- DescribeDBProxies (Paginated)
- StartExportTask
- Types
- ActivityStreamMode
- ActivityStreamStatus
- ApplyMethod
- AuthScheme
- DBProxyEndpointStatus
- DBProxyEndpointTargetRole
- DBProxyStatus
- EngineFamily
- FailoverStatus
- IAMAuthMode
- ReplicaMode
- SourceType
- TargetHealthReason
- TargetRole
- TargetState
- TargetType
- WriteForwardingStatus
- AccountQuota
- AvailabilityZone
- AvailableProcessorFeature
- Certificate
- CharacterSet
- CloudwatchLogsExportConfiguration
- ClusterPendingModifiedValues
- ConnectionPoolConfiguration
- ConnectionPoolConfigurationInfo
- CustomAvailabilityZone
- DBCluster
- DBClusterBacktrack
- DBClusterEndpoint
- DBClusterMember
- DBClusterOptionGroupStatus
- DBClusterParameterGroup
- DBClusterParameterGroupNameMessage
- DBClusterRole
- DBClusterSnapshot
- DBClusterSnapshotAttribute
- DBClusterSnapshotAttributesResult
- DBEngineVersion
- DBInstance
- DBInstanceAutomatedBackup
- DBInstanceAutomatedBackupsReplication
- DBInstanceRole
- DBInstanceStatusInfo
- DBParameterGroup
- DBParameterGroupNameMessage
- DBParameterGroupStatus
- DBProxy
- DBProxyEndpoint
- DBProxyTarget
- DBProxyTargetGroup
- DBSecurityGroup
- DBSecurityGroupMembership
- DBSnapshot
- DBSnapshotAttribute
- DBSnapshotAttributesResult
- DBSubnetGroup
- DescribeDBLogFilesDetails
- DomainMembership
- DoubleRange
- EC2SecurityGroup
- Endpoint
- EngineDefaults
- Event
- EventCategoriesMap
- EventSubscription
- ExportTask
- FailoverState
- Filter
- GlobalCluster
- GlobalClusterMember
- IPRange
- InstallationMedia
- InstallationMediaFailureCause
- MinimumEngineVersionPerAllowedValue
- Option
- OptionConfiguration
- OptionGroup
- OptionGroupMembership
- OptionGroupOption
- OptionGroupOptionSetting
- OptionSetting
- OptionVersion
- OrderableDBInstanceOption
- Outpost
- Parameter
- PendingCloudwatchLogsExports
- PendingMaintenanceAction
- PendingModifiedValues
- ProcessorFeature
- Range
- RecurringCharge
- ReservedDBInstance
- ReservedDBInstancesOffering
- ResourcePendingMaintenanceActions
- RestoreWindow
- ScalingConfiguration
- ScalingConfigurationInfo
- SourceRegion
- Subnet
- Tag
- TargetHealth
- Timezone
- UpgradeTarget
- UserAuthConfig
- UserAuthConfigInfo
- ValidDBInstanceModificationsMessage
- ValidStorageOptions
- VpcSecurityGroupMembership
- VpnDetails
Description
Derived from API version 2014-10-31
of the AWS service descriptions, licensed under Apache 2.0.
Amazon Relational Database Service
Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.
Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.
Amazon RDS API Reference
- 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.
Synopsis
- defaultService :: Service
- _PointInTimeRestoreNotEnabledFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBParameterGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ReservedDBInstanceQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SourceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CertificateNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _AuthorizationQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterSnapshotAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBParameterGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBInstanceRoleQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBInstanceRoleAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBParameterGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _BackupPolicyNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientDBClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ReservedDBInstanceAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ProvisionedIopsNotAvailableInAZFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBProxyTargetAlreadyRegisteredFault :: AsError a => Getting (First ServiceError) a ServiceError
- _AuthorizationAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SubscriptionCategoryNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBProxyTargetNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SubscriptionNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSubnet :: AsError a => Getting (First ServiceError) a ServiceError
- _SharedSnapshotQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSubnetQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _GlobalClusterAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _OptionGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBProxyEndpointStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBLogFileNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBProxyTargetGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidS3BucketFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBProxyQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _IamRoleNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _StorageTypeNotSupportedFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSecurityGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBProxyEndpointNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _OptionGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ExportTaskNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientAvailableIPsInSubnetFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBProxyNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _OptionGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSecurityGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SNSTopicArnNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBClusterEndpointStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidEventSubscriptionStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBInstanceAutomatedBackupStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSKeyNotAccessibleFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSnapshotNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterParameterGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidExportOnlyFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SnapshotQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSubnetGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SNSNoAuthorizationFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSecurityGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSecurityGroupNotSupportedFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBProxyStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBProxyEndpointQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InstanceQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterBacktrackNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DomainNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBParameterGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBSubnetGroupFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ReservedDBInstancesOfferingNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBSubnetStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterSnapshotNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SNSInvalidTopicFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientDBInstanceCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBClusterSnapshotStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InstallationMediaAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SubscriptionAlreadyExistFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterRoleAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _IamRoleMissingPermissionsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterRoleQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidVPCNetworkStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBInstanceRoleNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _AuthorizationNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ReservedDBInstanceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSubnetGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CustomAvailabilityZoneNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBProxyEndpointAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidGlobalClusterStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSubnetGroupNotAllowedFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidExportTaskStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidExportSourceStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ExportTaskAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _EventSubscriptionQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientStorageClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterEndpointQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidOptionGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBInstanceAutomatedBackupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CustomAvailabilityZoneAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBClusterStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _GlobalClusterNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBInstanceAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidRestoreFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBSecurityGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSubnetGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBUpgradeDependencyFailureFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CustomAvailabilityZoneQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBInstanceStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterEndpointAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSnapshotAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBInstanceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _StorageQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBProxyAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBInstanceAutomatedBackupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBSnapshotStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBSubnetGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _GlobalClusterQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterEndpointNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InstallationMediaNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSubnetGroupDoesNotCoverEnoughAZs :: AsError a => Getting (First ServiceError) a ServiceError
- _SubnetAlreadyInUse :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterRoleNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- newDBInstanceAvailable :: Wait DescribeDBInstances
- newDBSnapshotCompleted :: Wait DescribeDBSnapshots
- newDBSnapshotDeleted :: Wait DescribeDBSnapshots
- newDBInstanceDeleted :: Wait DescribeDBInstances
- newDBClusterSnapshotDeleted :: Wait DescribeDBClusterSnapshots
- newDBSnapshotAvailable :: Wait DescribeDBSnapshots
- newDBClusterSnapshotAvailable :: Wait DescribeDBClusterSnapshots
- data StartDBCluster = StartDBCluster' Text
- newStartDBCluster :: Text -> StartDBCluster
- data StartDBClusterResponse = StartDBClusterResponse' (Maybe DBCluster) Int
- newStartDBClusterResponse :: Int -> StartDBClusterResponse
- data DescribeDBClusterParameterGroups = DescribeDBClusterParameterGroups' (Maybe [Filter]) (Maybe Text) (Maybe Int) (Maybe Text)
- newDescribeDBClusterParameterGroups :: DescribeDBClusterParameterGroups
- data DescribeDBClusterParameterGroupsResponse = DescribeDBClusterParameterGroupsResponse' (Maybe Text) (Maybe [DBClusterParameterGroup]) Int
- newDescribeDBClusterParameterGroupsResponse :: Int -> DescribeDBClusterParameterGroupsResponse
- data PromoteReadReplica = PromoteReadReplica' (Maybe Text) (Maybe Int) Text
- newPromoteReadReplica :: Text -> PromoteReadReplica
- data PromoteReadReplicaResponse = PromoteReadReplicaResponse' (Maybe DBInstance) Int
- newPromoteReadReplicaResponse :: Int -> PromoteReadReplicaResponse
- data DescribeDBEngineVersions = DescribeDBEngineVersions' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Int)
- newDescribeDBEngineVersions :: DescribeDBEngineVersions
- data DescribeDBEngineVersionsResponse = DescribeDBEngineVersionsResponse' (Maybe Text) (Maybe [DBEngineVersion]) Int
- newDescribeDBEngineVersionsResponse :: Int -> DescribeDBEngineVersionsResponse
- data StopDBInstance = StopDBInstance' (Maybe Text) Text
- newStopDBInstance :: Text -> StopDBInstance
- data StopDBInstanceResponse = StopDBInstanceResponse' (Maybe DBInstance) Int
- newStopDBInstanceResponse :: Int -> StopDBInstanceResponse
- data ModifyDBClusterEndpoint = ModifyDBClusterEndpoint' (Maybe [Text]) (Maybe Text) (Maybe [Text]) Text
- newModifyDBClusterEndpoint :: Text -> ModifyDBClusterEndpoint
- data DBClusterEndpoint = DBClusterEndpoint' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text])
- newDBClusterEndpoint :: DBClusterEndpoint
- data DescribeDBProxyEndpoints = DescribeDBProxyEndpoints' (Maybe [Filter]) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text)
- newDescribeDBProxyEndpoints :: DescribeDBProxyEndpoints
- data DescribeDBProxyEndpointsResponse = DescribeDBProxyEndpointsResponse' (Maybe [DBProxyEndpoint]) (Maybe Text) Int
- newDescribeDBProxyEndpointsResponse :: Int -> DescribeDBProxyEndpointsResponse
- data CopyDBSnapshot = CopyDBSnapshot' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text
- newCopyDBSnapshot :: Text -> Text -> CopyDBSnapshot
- data CopyDBSnapshotResponse = CopyDBSnapshotResponse' (Maybe DBSnapshot) Int
- newCopyDBSnapshotResponse :: Int -> CopyDBSnapshotResponse
- data AddSourceIdentifierToSubscription = AddSourceIdentifierToSubscription' Text Text
- newAddSourceIdentifierToSubscription :: Text -> Text -> AddSourceIdentifierToSubscription
- data AddSourceIdentifierToSubscriptionResponse = AddSourceIdentifierToSubscriptionResponse' (Maybe EventSubscription) Int
- newAddSourceIdentifierToSubscriptionResponse :: Int -> AddSourceIdentifierToSubscriptionResponse
- data ModifyDBInstance = ModifyDBInstance' (Maybe Text) (Maybe [Text]) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ReplicaMode) (Maybe Int) (Maybe CloudwatchLogsExportConfiguration) (Maybe Bool) (Maybe Text) (Maybe [ProcessorFeature]) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) Text
- newModifyDBInstance :: Text -> ModifyDBInstance
- data ModifyDBInstanceResponse = ModifyDBInstanceResponse' (Maybe DBInstance) Int
- newModifyDBInstanceResponse :: Int -> ModifyDBInstanceResponse
- data ModifyEventSubscription = ModifyEventSubscription' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Text]) Text
- newModifyEventSubscription :: Text -> ModifyEventSubscription
- data ModifyEventSubscriptionResponse = ModifyEventSubscriptionResponse' (Maybe EventSubscription) Int
- newModifyEventSubscriptionResponse :: Int -> ModifyEventSubscriptionResponse
- data ResetDBClusterParameterGroup = ResetDBClusterParameterGroup' (Maybe Bool) (Maybe [Parameter]) Text
- newResetDBClusterParameterGroup :: Text -> ResetDBClusterParameterGroup
- data DBClusterParameterGroupNameMessage = DBClusterParameterGroupNameMessage' (Maybe Text)
- newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage
- data DescribeCustomAvailabilityZones = DescribeCustomAvailabilityZones' (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int)
- newDescribeCustomAvailabilityZones :: DescribeCustomAvailabilityZones
- data DescribeCustomAvailabilityZonesResponse = DescribeCustomAvailabilityZonesResponse' (Maybe [CustomAvailabilityZone]) (Maybe Text) Int
- newDescribeCustomAvailabilityZonesResponse :: Int -> DescribeCustomAvailabilityZonesResponse
- data RestoreDBClusterFromS3 = RestoreDBClusterFromS3' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe [Text]) Text Text Text Text Text Text Text Text
- newRestoreDBClusterFromS3 :: Text -> Text -> Text -> Text -> Text -> Text -> Text -> Text -> RestoreDBClusterFromS3
- data RestoreDBClusterFromS3Response = RestoreDBClusterFromS3Response' (Maybe DBCluster) Int
- newRestoreDBClusterFromS3Response :: Int -> RestoreDBClusterFromS3Response
- data DescribeEvents = DescribeEvents' (Maybe ISO8601) (Maybe SourceType) (Maybe [Filter]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Int) (Maybe ISO8601) (Maybe Int)
- newDescribeEvents :: DescribeEvents
- data DescribeEventsResponse = DescribeEventsResponse' (Maybe [Event]) (Maybe Text) Int
- newDescribeEventsResponse :: Int -> DescribeEventsResponse
- data DescribeEngineDefaultParameters = DescribeEngineDefaultParameters' (Maybe [Filter]) (Maybe Text) (Maybe Int) Text
- newDescribeEngineDefaultParameters :: Text -> DescribeEngineDefaultParameters
- data DescribeEngineDefaultParametersResponse = DescribeEngineDefaultParametersResponse' Int EngineDefaults
- newDescribeEngineDefaultParametersResponse :: Int -> EngineDefaults -> DescribeEngineDefaultParametersResponse
- data DescribeOptionGroups = DescribeOptionGroups' (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text)
- newDescribeOptionGroups :: DescribeOptionGroups
- data DescribeOptionGroupsResponse = DescribeOptionGroupsResponse' (Maybe Text) (Maybe [OptionGroup]) Int
- newDescribeOptionGroupsResponse :: Int -> DescribeOptionGroupsResponse
- data DescribeDBLogFiles = DescribeDBLogFiles' (Maybe Text) (Maybe [Filter]) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe Int) Text
- newDescribeDBLogFiles :: Text -> DescribeDBLogFiles
- data DescribeDBLogFilesResponse = DescribeDBLogFilesResponse' (Maybe [DescribeDBLogFilesDetails]) (Maybe Text) Int
- newDescribeDBLogFilesResponse :: Int -> DescribeDBLogFilesResponse
- data DescribeDBClusters = DescribeDBClusters' (Maybe Text) (Maybe Bool) (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeDBClusters :: DescribeDBClusters
- data DescribeDBClustersResponse = DescribeDBClustersResponse' (Maybe [DBCluster]) (Maybe Text) Int
- newDescribeDBClustersResponse :: Int -> DescribeDBClustersResponse
- data ModifyDBSubnetGroup = ModifyDBSubnetGroup' (Maybe Text) Text [Text]
- newModifyDBSubnetGroup :: Text -> ModifyDBSubnetGroup
- data ModifyDBSubnetGroupResponse = ModifyDBSubnetGroupResponse' (Maybe DBSubnetGroup) Int
- newModifyDBSubnetGroupResponse :: Int -> ModifyDBSubnetGroupResponse
- data ListTagsForResource = ListTagsForResource' (Maybe [Filter]) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data DeleteOptionGroup = DeleteOptionGroup' Text
- newDeleteOptionGroup :: Text -> DeleteOptionGroup
- data DeleteOptionGroupResponse = DeleteOptionGroupResponse' {
- newDeleteOptionGroupResponse :: DeleteOptionGroupResponse
- data CreateDBProxyEndpoint = CreateDBProxyEndpoint' (Maybe DBProxyEndpointTargetRole) (Maybe [Text]) (Maybe [Tag]) Text Text [Text]
- newCreateDBProxyEndpoint :: Text -> Text -> CreateDBProxyEndpoint
- data CreateDBProxyEndpointResponse = CreateDBProxyEndpointResponse' (Maybe DBProxyEndpoint) Int
- newCreateDBProxyEndpointResponse :: Int -> CreateDBProxyEndpointResponse
- data DeleteDBCluster = DeleteDBCluster' (Maybe Text) (Maybe Bool) Text
- newDeleteDBCluster :: Text -> DeleteDBCluster
- data DeleteDBClusterResponse = DeleteDBClusterResponse' (Maybe DBCluster) Int
- newDeleteDBClusterResponse :: Int -> DeleteDBClusterResponse
- data DescribeReservedDBInstances = DescribeReservedDBInstances' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text)
- newDescribeReservedDBInstances :: DescribeReservedDBInstances
- data DescribeReservedDBInstancesResponse = DescribeReservedDBInstancesResponse' (Maybe [ReservedDBInstance]) (Maybe Text) Int
- newDescribeReservedDBInstancesResponse :: Int -> DescribeReservedDBInstancesResponse
- data CopyDBParameterGroup = CopyDBParameterGroup' (Maybe [Tag]) Text Text Text
- newCopyDBParameterGroup :: Text -> Text -> Text -> CopyDBParameterGroup
- data CopyDBParameterGroupResponse = CopyDBParameterGroupResponse' (Maybe DBParameterGroup) Int
- newCopyDBParameterGroupResponse :: Int -> CopyDBParameterGroupResponse
- data RemoveSourceIdentifierFromSubscription = RemoveSourceIdentifierFromSubscription' Text Text
- newRemoveSourceIdentifierFromSubscription :: Text -> Text -> RemoveSourceIdentifierFromSubscription
- data RemoveSourceIdentifierFromSubscriptionResponse = RemoveSourceIdentifierFromSubscriptionResponse' (Maybe EventSubscription) Int
- newRemoveSourceIdentifierFromSubscriptionResponse :: Int -> RemoveSourceIdentifierFromSubscriptionResponse
- data DeleteCustomAvailabilityZone = DeleteCustomAvailabilityZone' Text
- newDeleteCustomAvailabilityZone :: Text -> DeleteCustomAvailabilityZone
- data DeleteCustomAvailabilityZoneResponse = DeleteCustomAvailabilityZoneResponse' (Maybe CustomAvailabilityZone) Int
- newDeleteCustomAvailabilityZoneResponse :: Int -> DeleteCustomAvailabilityZoneResponse
- data DescribeDBProxyTargets = DescribeDBProxyTargets' (Maybe [Filter]) (Maybe Text) (Maybe Natural) (Maybe Text) Text
- newDescribeDBProxyTargets :: Text -> DescribeDBProxyTargets
- data DescribeDBProxyTargetsResponse = DescribeDBProxyTargetsResponse' (Maybe [DBProxyTarget]) (Maybe Text) Int
- newDescribeDBProxyTargetsResponse :: Int -> DescribeDBProxyTargetsResponse
- data StartDBInstanceAutomatedBackupsReplication = StartDBInstanceAutomatedBackupsReplication' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) Text
- newStartDBInstanceAutomatedBackupsReplication :: Text -> StartDBInstanceAutomatedBackupsReplication
- data StartDBInstanceAutomatedBackupsReplicationResponse = StartDBInstanceAutomatedBackupsReplicationResponse' (Maybe DBInstanceAutomatedBackup) Int
- newStartDBInstanceAutomatedBackupsReplicationResponse :: Int -> StartDBInstanceAutomatedBackupsReplicationResponse
- data DescribeEngineDefaultClusterParameters = DescribeEngineDefaultClusterParameters' (Maybe [Filter]) (Maybe Text) (Maybe Int) Text
- newDescribeEngineDefaultClusterParameters :: Text -> DescribeEngineDefaultClusterParameters
- data DescribeEngineDefaultClusterParametersResponse = DescribeEngineDefaultClusterParametersResponse' (Maybe EngineDefaults) Int
- newDescribeEngineDefaultClusterParametersResponse :: Int -> DescribeEngineDefaultClusterParametersResponse
- data DescribeDBSnapshotAttributes = DescribeDBSnapshotAttributes' Text
- newDescribeDBSnapshotAttributes :: Text -> DescribeDBSnapshotAttributes
- data DescribeDBSnapshotAttributesResponse = DescribeDBSnapshotAttributesResponse' (Maybe DBSnapshotAttributesResult) Int
- newDescribeDBSnapshotAttributesResponse :: Int -> DescribeDBSnapshotAttributesResponse
- data CreateCustomAvailabilityZone = CreateCustomAvailabilityZone' (Maybe Text) (Maybe Text) (Maybe Text) Text
- newCreateCustomAvailabilityZone :: Text -> CreateCustomAvailabilityZone
- data CreateCustomAvailabilityZoneResponse = CreateCustomAvailabilityZoneResponse' (Maybe CustomAvailabilityZone) Int
- newCreateCustomAvailabilityZoneResponse :: Int -> CreateCustomAvailabilityZoneResponse
- data BacktrackDBCluster = BacktrackDBCluster' (Maybe Bool) (Maybe Bool) Text ISO8601
- newBacktrackDBCluster :: Text -> UTCTime -> BacktrackDBCluster
- data DBClusterBacktrack = DBClusterBacktrack' (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe ISO8601)
- newDBClusterBacktrack :: DBClusterBacktrack
- data DeleteGlobalCluster = DeleteGlobalCluster' Text
- newDeleteGlobalCluster :: Text -> DeleteGlobalCluster
- data DeleteGlobalClusterResponse = DeleteGlobalClusterResponse' (Maybe GlobalCluster) Int
- newDeleteGlobalClusterResponse :: Int -> DeleteGlobalClusterResponse
- data PromoteReadReplicaDBCluster = PromoteReadReplicaDBCluster' Text
- newPromoteReadReplicaDBCluster :: Text -> PromoteReadReplicaDBCluster
- data PromoteReadReplicaDBClusterResponse = PromoteReadReplicaDBClusterResponse' (Maybe DBCluster) Int
- newPromoteReadReplicaDBClusterResponse :: Int -> PromoteReadReplicaDBClusterResponse
- data RemoveTagsFromResource = RemoveTagsFromResource' Text [Text]
- newRemoveTagsFromResource :: Text -> RemoveTagsFromResource
- data RemoveTagsFromResourceResponse = RemoveTagsFromResourceResponse' {
- newRemoveTagsFromResourceResponse :: RemoveTagsFromResourceResponse
- data RestoreDBInstanceFromDBSnapshot = RestoreDBInstanceFromDBSnapshot' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [ProcessorFeature]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) Text Text
- newRestoreDBInstanceFromDBSnapshot :: Text -> Text -> RestoreDBInstanceFromDBSnapshot
- data RestoreDBInstanceFromDBSnapshotResponse = RestoreDBInstanceFromDBSnapshotResponse' (Maybe DBInstance) Int
- newRestoreDBInstanceFromDBSnapshotResponse :: Int -> RestoreDBInstanceFromDBSnapshotResponse
- data DeleteDBProxy = DeleteDBProxy' Text
- newDeleteDBProxy :: Text -> DeleteDBProxy
- data DeleteDBProxyResponse = DeleteDBProxyResponse' (Maybe DBProxy) Int
- newDeleteDBProxyResponse :: Int -> DeleteDBProxyResponse
- data CreateEventSubscription = CreateEventSubscription' (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe [Tag]) Text Text
- newCreateEventSubscription :: Text -> Text -> CreateEventSubscription
- data CreateEventSubscriptionResponse = CreateEventSubscriptionResponse' (Maybe EventSubscription) Int
- newCreateEventSubscriptionResponse :: Int -> CreateEventSubscriptionResponse
- data PurchaseReservedDBInstancesOffering = PurchaseReservedDBInstancesOffering' (Maybe Int) (Maybe Text) (Maybe [Tag]) Text
- newPurchaseReservedDBInstancesOffering :: Text -> PurchaseReservedDBInstancesOffering
- data PurchaseReservedDBInstancesOfferingResponse = PurchaseReservedDBInstancesOfferingResponse' (Maybe ReservedDBInstance) Int
- newPurchaseReservedDBInstancesOfferingResponse :: Int -> PurchaseReservedDBInstancesOfferingResponse
- data CreateDBInstance = CreateDBInstance' (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe [ProcessorFeature]) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) Text Text Text
- newCreateDBInstance :: Text -> Text -> Text -> CreateDBInstance
- data CreateDBInstanceResponse = CreateDBInstanceResponse' (Maybe DBInstance) Int
- newCreateDBInstanceResponse :: Int -> CreateDBInstanceResponse
- data DeleteDBClusterParameterGroup = DeleteDBClusterParameterGroup' Text
- newDeleteDBClusterParameterGroup :: Text -> DeleteDBClusterParameterGroup
- data DeleteDBClusterParameterGroupResponse = DeleteDBClusterParameterGroupResponse' {
- newDeleteDBClusterParameterGroupResponse :: DeleteDBClusterParameterGroupResponse
- data DescribeCertificates = DescribeCertificates' (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int)
- newDescribeCertificates :: DescribeCertificates
- data DescribeCertificatesResponse = DescribeCertificatesResponse' (Maybe [Certificate]) (Maybe Text) Int
- newDescribeCertificatesResponse :: Int -> DescribeCertificatesResponse
- data AuthorizeDBSecurityGroupIngress = AuthorizeDBSecurityGroupIngress' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newAuthorizeDBSecurityGroupIngress :: Text -> AuthorizeDBSecurityGroupIngress
- data AuthorizeDBSecurityGroupIngressResponse = AuthorizeDBSecurityGroupIngressResponse' (Maybe DBSecurityGroup) Int
- newAuthorizeDBSecurityGroupIngressResponse :: Int -> AuthorizeDBSecurityGroupIngressResponse
- data RemoveRoleFromDBInstance = RemoveRoleFromDBInstance' Text Text Text
- newRemoveRoleFromDBInstance :: Text -> Text -> Text -> RemoveRoleFromDBInstance
- data RemoveRoleFromDBInstanceResponse = RemoveRoleFromDBInstanceResponse' {
- newRemoveRoleFromDBInstanceResponse :: RemoveRoleFromDBInstanceResponse
- data DescribeSourceRegions = DescribeSourceRegions' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeSourceRegions :: DescribeSourceRegions
- data DescribeSourceRegionsResponse = DescribeSourceRegionsResponse' (Maybe Text) (Maybe [SourceRegion]) Int
- newDescribeSourceRegionsResponse :: Int -> DescribeSourceRegionsResponse
- data CreateDBClusterEndpoint = CreateDBClusterEndpoint' (Maybe [Text]) (Maybe [Text]) (Maybe [Tag]) Text Text Text
- newCreateDBClusterEndpoint :: Text -> Text -> Text -> CreateDBClusterEndpoint
- data DBClusterEndpoint = DBClusterEndpoint' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text])
- newDBClusterEndpoint :: DBClusterEndpoint
- data RestoreDBClusterFromSnapshot = RestoreDBClusterFromSnapshot' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ScalingConfiguration) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe [Text]) Text Text Text
- newRestoreDBClusterFromSnapshot :: Text -> Text -> Text -> RestoreDBClusterFromSnapshot
- data RestoreDBClusterFromSnapshotResponse = RestoreDBClusterFromSnapshotResponse' (Maybe DBCluster) Int
- newRestoreDBClusterFromSnapshotResponse :: Int -> RestoreDBClusterFromSnapshotResponse
- data DescribeOrderableDBInstanceOptions = DescribeOrderableDBInstanceOptions' (Maybe Text) (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) Text
- newDescribeOrderableDBInstanceOptions :: Text -> DescribeOrderableDBInstanceOptions
- data DescribeOrderableDBInstanceOptionsResponse = DescribeOrderableDBInstanceOptionsResponse' (Maybe [OrderableDBInstanceOption]) (Maybe Text) Int
- newDescribeOrderableDBInstanceOptionsResponse :: Int -> DescribeOrderableDBInstanceOptionsResponse
- data DeleteDBClusterEndpoint = DeleteDBClusterEndpoint' Text
- newDeleteDBClusterEndpoint :: Text -> DeleteDBClusterEndpoint
- data DBClusterEndpoint = DBClusterEndpoint' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text])
- newDBClusterEndpoint :: DBClusterEndpoint
- data CreateDBProxy = CreateDBProxy' (Maybe Bool) (Maybe Bool) (Maybe Int) (Maybe [Text]) (Maybe [Tag]) Text EngineFamily [UserAuthConfig] Text [Text]
- newCreateDBProxy :: Text -> EngineFamily -> Text -> CreateDBProxy
- data CreateDBProxyResponse = CreateDBProxyResponse' (Maybe DBProxy) Int
- newCreateDBProxyResponse :: Int -> CreateDBProxyResponse
- data DeleteDBInstanceAutomatedBackup = DeleteDBInstanceAutomatedBackup' (Maybe Text) (Maybe Text)
- newDeleteDBInstanceAutomatedBackup :: DeleteDBInstanceAutomatedBackup
- data DeleteDBInstanceAutomatedBackupResponse = DeleteDBInstanceAutomatedBackupResponse' (Maybe DBInstanceAutomatedBackup) Int
- newDeleteDBInstanceAutomatedBackupResponse :: Int -> DeleteDBInstanceAutomatedBackupResponse
- data CreateDBClusterParameterGroup = CreateDBClusterParameterGroup' (Maybe [Tag]) Text Text Text
- newCreateDBClusterParameterGroup :: Text -> Text -> Text -> CreateDBClusterParameterGroup
- data CreateDBClusterParameterGroupResponse = CreateDBClusterParameterGroupResponse' (Maybe DBClusterParameterGroup) Int
- newCreateDBClusterParameterGroupResponse :: Int -> CreateDBClusterParameterGroupResponse
- data CreateDBSnapshot = CreateDBSnapshot' (Maybe [Tag]) Text Text
- newCreateDBSnapshot :: Text -> Text -> CreateDBSnapshot
- data CreateDBSnapshotResponse = CreateDBSnapshotResponse' (Maybe DBSnapshot) Int
- newCreateDBSnapshotResponse :: Int -> CreateDBSnapshotResponse
- data DeleteEventSubscription = DeleteEventSubscription' Text
- newDeleteEventSubscription :: Text -> DeleteEventSubscription
- data DeleteEventSubscriptionResponse = DeleteEventSubscriptionResponse' (Maybe EventSubscription) Int
- newDeleteEventSubscriptionResponse :: Int -> DeleteEventSubscriptionResponse
- data DescribeDBClusterBacktracks = DescribeDBClusterBacktracks' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Int) Text
- newDescribeDBClusterBacktracks :: Text -> DescribeDBClusterBacktracks
- data DescribeDBClusterBacktracksResponse = DescribeDBClusterBacktracksResponse' (Maybe Text) (Maybe [DBClusterBacktrack]) Int
- newDescribeDBClusterBacktracksResponse :: Int -> DescribeDBClusterBacktracksResponse
- data DescribeDBParameterGroups = DescribeDBParameterGroups' (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int)
- newDescribeDBParameterGroups :: DescribeDBParameterGroups
- data DescribeDBParameterGroupsResponse = DescribeDBParameterGroupsResponse' (Maybe Text) (Maybe [DBParameterGroup]) Int
- newDescribeDBParameterGroupsResponse :: Int -> DescribeDBParameterGroupsResponse
- data ModifyDBSnapshotAttribute = ModifyDBSnapshotAttribute' (Maybe [Text]) (Maybe [Text]) Text Text
- newModifyDBSnapshotAttribute :: Text -> Text -> ModifyDBSnapshotAttribute
- data ModifyDBSnapshotAttributeResponse = ModifyDBSnapshotAttributeResponse' (Maybe DBSnapshotAttributesResult) Int
- newModifyDBSnapshotAttributeResponse :: Int -> ModifyDBSnapshotAttributeResponse
- data DescribeDBInstanceAutomatedBackups = DescribeDBInstanceAutomatedBackups' (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text)
- newDescribeDBInstanceAutomatedBackups :: DescribeDBInstanceAutomatedBackups
- data DescribeDBInstanceAutomatedBackupsResponse = DescribeDBInstanceAutomatedBackupsResponse' (Maybe [DBInstanceAutomatedBackup]) (Maybe Text) Int
- newDescribeDBInstanceAutomatedBackupsResponse :: Int -> DescribeDBInstanceAutomatedBackupsResponse
- data RemoveFromGlobalCluster = RemoveFromGlobalCluster' (Maybe Text) (Maybe Text)
- newRemoveFromGlobalCluster :: RemoveFromGlobalCluster
- data RemoveFromGlobalClusterResponse = RemoveFromGlobalClusterResponse' (Maybe GlobalCluster) Int
- newRemoveFromGlobalClusterResponse :: Int -> RemoveFromGlobalClusterResponse
- data AddRoleToDBInstance = AddRoleToDBInstance' Text Text Text
- newAddRoleToDBInstance :: Text -> Text -> Text -> AddRoleToDBInstance
- data AddRoleToDBInstanceResponse = AddRoleToDBInstanceResponse' {
- newAddRoleToDBInstanceResponse :: AddRoleToDBInstanceResponse
- data DeleteDBClusterSnapshot = DeleteDBClusterSnapshot' Text
- newDeleteDBClusterSnapshot :: Text -> DeleteDBClusterSnapshot
- data DeleteDBClusterSnapshotResponse = DeleteDBClusterSnapshotResponse' (Maybe DBClusterSnapshot) Int
- newDeleteDBClusterSnapshotResponse :: Int -> DeleteDBClusterSnapshotResponse
- data ModifyDBProxyEndpoint = ModifyDBProxyEndpoint' (Maybe [Text]) (Maybe Text) Text
- newModifyDBProxyEndpoint :: Text -> ModifyDBProxyEndpoint
- data ModifyDBProxyEndpointResponse = ModifyDBProxyEndpointResponse' (Maybe DBProxyEndpoint) Int
- newModifyDBProxyEndpointResponse :: Int -> ModifyDBProxyEndpointResponse
- data DescribeValidDBInstanceModifications = DescribeValidDBInstanceModifications' Text
- newDescribeValidDBInstanceModifications :: Text -> DescribeValidDBInstanceModifications
- data DescribeValidDBInstanceModificationsResponse = DescribeValidDBInstanceModificationsResponse' (Maybe ValidDBInstanceModificationsMessage) Int
- newDescribeValidDBInstanceModificationsResponse :: Int -> DescribeValidDBInstanceModificationsResponse
- data DescribeDBClusterEndpoints = DescribeDBClusterEndpoints' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int)
- newDescribeDBClusterEndpoints :: DescribeDBClusterEndpoints
- data DescribeDBClusterEndpointsResponse = DescribeDBClusterEndpointsResponse' (Maybe [DBClusterEndpoint]) (Maybe Text) Int
- newDescribeDBClusterEndpointsResponse :: Int -> DescribeDBClusterEndpointsResponse
- data DescribeOptionGroupOptions = DescribeOptionGroupOptions' (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int) Text
- newDescribeOptionGroupOptions :: Text -> DescribeOptionGroupOptions
- data DescribeOptionGroupOptionsResponse = DescribeOptionGroupOptionsResponse' (Maybe [OptionGroupOption]) (Maybe Text) Int
- newDescribeOptionGroupOptionsResponse :: Int -> DescribeOptionGroupOptionsResponse
- data DescribeEventSubscriptions = DescribeEventSubscriptions' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeEventSubscriptions :: DescribeEventSubscriptions
- data DescribeEventSubscriptionsResponse = DescribeEventSubscriptionsResponse' (Maybe [EventSubscription]) (Maybe Text) Int
- newDescribeEventSubscriptionsResponse :: Int -> DescribeEventSubscriptionsResponse
- data AddTagsToResource = AddTagsToResource' Text [Tag]
- newAddTagsToResource :: Text -> AddTagsToResource
- data AddTagsToResourceResponse = AddTagsToResourceResponse' {
- newAddTagsToResourceResponse :: AddTagsToResourceResponse
- data DescribeDBParameters = DescribeDBParameters' (Maybe [Filter]) (Maybe Text) (Maybe Int) (Maybe Text) Text
- newDescribeDBParameters :: Text -> DescribeDBParameters
- data DescribeDBParametersResponse = DescribeDBParametersResponse' (Maybe Text) (Maybe [Parameter]) Int
- newDescribeDBParametersResponse :: Int -> DescribeDBParametersResponse
- data StopActivityStream = StopActivityStream' (Maybe Bool) Text
- newStopActivityStream :: Text -> StopActivityStream
- data StopActivityStreamResponse = StopActivityStreamResponse' (Maybe ActivityStreamStatus) (Maybe Text) (Maybe Text) Int
- newStopActivityStreamResponse :: Int -> StopActivityStreamResponse
- data CreateDBClusterSnapshot = CreateDBClusterSnapshot' (Maybe [Tag]) Text Text
- newCreateDBClusterSnapshot :: Text -> Text -> CreateDBClusterSnapshot
- data CreateDBClusterSnapshotResponse = CreateDBClusterSnapshotResponse' (Maybe DBClusterSnapshot) Int
- newCreateDBClusterSnapshotResponse :: Int -> CreateDBClusterSnapshotResponse
- data DescribeDBSnapshots = DescribeDBSnapshots' (Maybe Bool) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Text)
- newDescribeDBSnapshots :: DescribeDBSnapshots
- data DescribeDBSnapshotsResponse = DescribeDBSnapshotsResponse' (Maybe Text) (Maybe [DBSnapshot]) Int
- newDescribeDBSnapshotsResponse :: Int -> DescribeDBSnapshotsResponse
- data ModifyDBProxyTargetGroup = ModifyDBProxyTargetGroup' (Maybe ConnectionPoolConfiguration) (Maybe Text) Text Text
- newModifyDBProxyTargetGroup :: Text -> Text -> ModifyDBProxyTargetGroup
- data ModifyDBProxyTargetGroupResponse = ModifyDBProxyTargetGroupResponse' (Maybe DBProxyTargetGroup) Int
- newModifyDBProxyTargetGroupResponse :: Int -> ModifyDBProxyTargetGroupResponse
- data DescribeDBSubnetGroups = DescribeDBSubnetGroups' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeDBSubnetGroups :: DescribeDBSubnetGroups
- data DescribeDBSubnetGroupsResponse = DescribeDBSubnetGroupsResponse' (Maybe [DBSubnetGroup]) (Maybe Text) Int
- newDescribeDBSubnetGroupsResponse :: Int -> DescribeDBSubnetGroupsResponse
- data ModifyOptionGroup = ModifyOptionGroup' (Maybe [OptionConfiguration]) (Maybe [Text]) (Maybe Bool) Text
- newModifyOptionGroup :: Text -> ModifyOptionGroup
- data ModifyOptionGroupResponse = ModifyOptionGroupResponse' (Maybe OptionGroup) Int
- newModifyOptionGroupResponse :: Int -> ModifyOptionGroupResponse
- data StopDBCluster = StopDBCluster' Text
- newStopDBCluster :: Text -> StopDBCluster
- data StopDBClusterResponse = StopDBClusterResponse' (Maybe DBCluster) Int
- newStopDBClusterResponse :: Int -> StopDBClusterResponse
- data CreateDBParameterGroup = CreateDBParameterGroup' (Maybe [Tag]) Text Text Text
- newCreateDBParameterGroup :: Text -> Text -> Text -> CreateDBParameterGroup
- data CreateDBParameterGroupResponse = CreateDBParameterGroupResponse' (Maybe DBParameterGroup) Int
- newCreateDBParameterGroupResponse :: Int -> CreateDBParameterGroupResponse
- data ModifyDBClusterSnapshotAttribute = ModifyDBClusterSnapshotAttribute' (Maybe [Text]) (Maybe [Text]) Text Text
- newModifyDBClusterSnapshotAttribute :: Text -> Text -> ModifyDBClusterSnapshotAttribute
- data ModifyDBClusterSnapshotAttributeResponse = ModifyDBClusterSnapshotAttributeResponse' (Maybe DBClusterSnapshotAttributesResult) Int
- newModifyDBClusterSnapshotAttributeResponse :: Int -> ModifyDBClusterSnapshotAttributeResponse
- data ModifyDBCluster = ModifyDBCluster' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Integer) (Maybe CloudwatchLogsExportConfiguration) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe Text) (Maybe ScalingConfiguration) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) Text
- newModifyDBCluster :: Text -> ModifyDBCluster
- data ModifyDBClusterResponse = ModifyDBClusterResponse' (Maybe DBCluster) Int
- newModifyDBClusterResponse :: Int -> ModifyDBClusterResponse
- data CopyDBClusterParameterGroup = CopyDBClusterParameterGroup' (Maybe [Tag]) Text Text Text
- newCopyDBClusterParameterGroup :: Text -> Text -> Text -> CopyDBClusterParameterGroup
- data CopyDBClusterParameterGroupResponse = CopyDBClusterParameterGroupResponse' (Maybe DBClusterParameterGroup) Int
- newCopyDBClusterParameterGroupResponse :: Int -> CopyDBClusterParameterGroupResponse
- data DescribeEventCategories = DescribeEventCategories' (Maybe Text) (Maybe [Filter])
- newDescribeEventCategories :: DescribeEventCategories
- data DescribeEventCategoriesResponse = DescribeEventCategoriesResponse' (Maybe [EventCategoriesMap]) Int
- newDescribeEventCategoriesResponse :: Int -> DescribeEventCategoriesResponse
- data DescribeGlobalClusters = DescribeGlobalClusters' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeGlobalClusters :: DescribeGlobalClusters
- data DescribeGlobalClustersResponse = DescribeGlobalClustersResponse' (Maybe [GlobalCluster]) (Maybe Text) Int
- newDescribeGlobalClustersResponse :: Int -> DescribeGlobalClustersResponse
- data StartDBInstance = StartDBInstance' Text
- newStartDBInstance :: Text -> StartDBInstance
- data StartDBInstanceResponse = StartDBInstanceResponse' (Maybe DBInstance) Int
- newStartDBInstanceResponse :: Int -> StartDBInstanceResponse
- data DescribeExportTasks = DescribeExportTasks' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Natural)
- newDescribeExportTasks :: DescribeExportTasks
- data DescribeExportTasksResponse = DescribeExportTasksResponse' (Maybe Text) (Maybe [ExportTask]) Int
- newDescribeExportTasksResponse :: Int -> DescribeExportTasksResponse
- data CancelExportTask = CancelExportTask' Text
- newCancelExportTask :: Text -> CancelExportTask
- data ExportTask = ExportTask' (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text)
- newExportTask :: ExportTask
- data ModifyDBClusterParameterGroup = ModifyDBClusterParameterGroup' Text [Parameter]
- newModifyDBClusterParameterGroup :: Text -> ModifyDBClusterParameterGroup
- data DBClusterParameterGroupNameMessage = DBClusterParameterGroupNameMessage' (Maybe Text)
- newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage
- data RestoreDBInstanceToPointInTime = RestoreDBInstanceToPointInTime' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe ISO8601) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [ProcessorFeature]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) Text
- newRestoreDBInstanceToPointInTime :: Text -> RestoreDBInstanceToPointInTime
- data RestoreDBInstanceToPointInTimeResponse = RestoreDBInstanceToPointInTimeResponse' (Maybe DBInstance) Int
- newRestoreDBInstanceToPointInTimeResponse :: Int -> RestoreDBInstanceToPointInTimeResponse
- data DescribeDBClusterSnapshotAttributes = DescribeDBClusterSnapshotAttributes' Text
- newDescribeDBClusterSnapshotAttributes :: Text -> DescribeDBClusterSnapshotAttributes
- data DescribeDBClusterSnapshotAttributesResponse = DescribeDBClusterSnapshotAttributesResponse' (Maybe DBClusterSnapshotAttributesResult) Int
- newDescribeDBClusterSnapshotAttributesResponse :: Int -> DescribeDBClusterSnapshotAttributesResponse
- data ModifyDBSnapshot = ModifyDBSnapshot' (Maybe Text) (Maybe Text) Text
- newModifyDBSnapshot :: Text -> ModifyDBSnapshot
- data ModifyDBSnapshotResponse = ModifyDBSnapshotResponse' (Maybe DBSnapshot) Int
- newModifyDBSnapshotResponse :: Int -> ModifyDBSnapshotResponse
- data DescribeDBProxyTargetGroups = DescribeDBProxyTargetGroups' (Maybe [Filter]) (Maybe Text) (Maybe Natural) (Maybe Text) Text
- newDescribeDBProxyTargetGroups :: Text -> DescribeDBProxyTargetGroups
- data DescribeDBProxyTargetGroupsResponse = DescribeDBProxyTargetGroupsResponse' (Maybe Text) (Maybe [DBProxyTargetGroup]) Int
- newDescribeDBProxyTargetGroupsResponse :: Int -> DescribeDBProxyTargetGroupsResponse
- data ModifyDBProxy = ModifyDBProxy' (Maybe Bool) (Maybe [Text]) (Maybe [UserAuthConfig]) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Text) Text
- newModifyDBProxy :: Text -> ModifyDBProxy
- data ModifyDBProxyResponse = ModifyDBProxyResponse' (Maybe DBProxy) Int
- newModifyDBProxyResponse :: Int -> ModifyDBProxyResponse
- data DescribePendingMaintenanceActions = DescribePendingMaintenanceActions' (Maybe [Filter]) (Maybe Text) (Maybe Int) (Maybe Text)
- newDescribePendingMaintenanceActions :: DescribePendingMaintenanceActions
- data DescribePendingMaintenanceActionsResponse = DescribePendingMaintenanceActionsResponse' (Maybe [ResourcePendingMaintenanceActions]) (Maybe Text) Int
- newDescribePendingMaintenanceActionsResponse :: Int -> DescribePendingMaintenanceActionsResponse
- data AddRoleToDBCluster = AddRoleToDBCluster' (Maybe Text) Text Text
- newAddRoleToDBCluster :: Text -> Text -> AddRoleToDBCluster
- data AddRoleToDBClusterResponse = AddRoleToDBClusterResponse' {
- newAddRoleToDBClusterResponse :: AddRoleToDBClusterResponse
- data CopyDBClusterSnapshot = CopyDBClusterSnapshot' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text
- newCopyDBClusterSnapshot :: Text -> Text -> CopyDBClusterSnapshot
- data CopyDBClusterSnapshotResponse = CopyDBClusterSnapshotResponse' (Maybe DBClusterSnapshot) Int
- newCopyDBClusterSnapshotResponse :: Int -> CopyDBClusterSnapshotResponse
- data ImportInstallationMedia = ImportInstallationMedia' Text Text Text Text Text
- newImportInstallationMedia :: Text -> Text -> Text -> Text -> Text -> ImportInstallationMedia
- data InstallationMedia = InstallationMedia' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InstallationMediaFailureCause)
- newInstallationMedia :: InstallationMedia
- data CreateGlobalCluster = CreateGlobalCluster' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newCreateGlobalCluster :: CreateGlobalCluster
- data CreateGlobalClusterResponse = CreateGlobalClusterResponse' (Maybe GlobalCluster) Int
- newCreateGlobalClusterResponse :: Int -> CreateGlobalClusterResponse
- data ResetDBParameterGroup = ResetDBParameterGroup' (Maybe Bool) (Maybe [Parameter]) Text
- newResetDBParameterGroup :: Text -> ResetDBParameterGroup
- data DBParameterGroupNameMessage = DBParameterGroupNameMessage' (Maybe Text)
- newDBParameterGroupNameMessage :: DBParameterGroupNameMessage
- data FailoverGlobalCluster = FailoverGlobalCluster' Text Text
- newFailoverGlobalCluster :: Text -> Text -> FailoverGlobalCluster
- data FailoverGlobalClusterResponse = FailoverGlobalClusterResponse' (Maybe GlobalCluster) Int
- newFailoverGlobalClusterResponse :: Int -> FailoverGlobalClusterResponse
- data DescribeInstallationMedia = DescribeInstallationMedia' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeInstallationMedia :: DescribeInstallationMedia
- data DescribeInstallationMediaResponse = DescribeInstallationMediaResponse' (Maybe Text) (Maybe [InstallationMedia]) Int
- newDescribeInstallationMediaResponse :: Int -> DescribeInstallationMediaResponse
- data DeregisterDBProxyTargets = DeregisterDBProxyTargets' (Maybe [Text]) (Maybe [Text]) (Maybe Text) Text
- newDeregisterDBProxyTargets :: Text -> DeregisterDBProxyTargets
- data DeregisterDBProxyTargetsResponse = DeregisterDBProxyTargetsResponse' Int
- newDeregisterDBProxyTargetsResponse :: Int -> DeregisterDBProxyTargetsResponse
- data CreateDBCluster = CreateDBCluster' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ScalingConfiguration) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe [Text]) Text Text
- newCreateDBCluster :: Text -> Text -> CreateDBCluster
- data CreateDBClusterResponse = CreateDBClusterResponse' (Maybe DBCluster) Int
- newCreateDBClusterResponse :: Int -> CreateDBClusterResponse
- data RemoveRoleFromDBCluster = RemoveRoleFromDBCluster' (Maybe Text) Text Text
- newRemoveRoleFromDBCluster :: Text -> Text -> RemoveRoleFromDBCluster
- data RemoveRoleFromDBClusterResponse = RemoveRoleFromDBClusterResponse' {
- newRemoveRoleFromDBClusterResponse :: RemoveRoleFromDBClusterResponse
- data FailoverDBCluster = FailoverDBCluster' (Maybe Text) Text
- newFailoverDBCluster :: Text -> FailoverDBCluster
- data FailoverDBClusterResponse = FailoverDBClusterResponse' (Maybe DBCluster) Int
- newFailoverDBClusterResponse :: Int -> FailoverDBClusterResponse
- data RevokeDBSecurityGroupIngress = RevokeDBSecurityGroupIngress' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newRevokeDBSecurityGroupIngress :: Text -> RevokeDBSecurityGroupIngress
- data RevokeDBSecurityGroupIngressResponse = RevokeDBSecurityGroupIngressResponse' (Maybe DBSecurityGroup) Int
- newRevokeDBSecurityGroupIngressResponse :: Int -> RevokeDBSecurityGroupIngressResponse
- data ModifyDBParameterGroup = ModifyDBParameterGroup' Text [Parameter]
- newModifyDBParameterGroup :: Text -> ModifyDBParameterGroup
- data DBParameterGroupNameMessage = DBParameterGroupNameMessage' (Maybe Text)
- newDBParameterGroupNameMessage :: DBParameterGroupNameMessage
- data ApplyPendingMaintenanceAction = ApplyPendingMaintenanceAction' Text Text Text
- newApplyPendingMaintenanceAction :: Text -> Text -> Text -> ApplyPendingMaintenanceAction
- data ApplyPendingMaintenanceActionResponse = ApplyPendingMaintenanceActionResponse' (Maybe ResourcePendingMaintenanceActions) Int
- newApplyPendingMaintenanceActionResponse :: Int -> ApplyPendingMaintenanceActionResponse
- data DeleteDBProxyEndpoint = DeleteDBProxyEndpoint' Text
- newDeleteDBProxyEndpoint :: Text -> DeleteDBProxyEndpoint
- data DeleteDBProxyEndpointResponse = DeleteDBProxyEndpointResponse' (Maybe DBProxyEndpoint) Int
- newDeleteDBProxyEndpointResponse :: Int -> DeleteDBProxyEndpointResponse
- data StopDBInstanceAutomatedBackupsReplication = StopDBInstanceAutomatedBackupsReplication' Text
- newStopDBInstanceAutomatedBackupsReplication :: Text -> StopDBInstanceAutomatedBackupsReplication
- data StopDBInstanceAutomatedBackupsReplicationResponse = StopDBInstanceAutomatedBackupsReplicationResponse' (Maybe DBInstanceAutomatedBackup) Int
- newStopDBInstanceAutomatedBackupsReplicationResponse :: Int -> StopDBInstanceAutomatedBackupsReplicationResponse
- data CreateOptionGroup = CreateOptionGroup' (Maybe [Tag]) Text Text Text Text
- newCreateOptionGroup :: Text -> Text -> Text -> Text -> CreateOptionGroup
- data CreateOptionGroupResponse = CreateOptionGroupResponse' (Maybe OptionGroup) Int
- newCreateOptionGroupResponse :: Int -> CreateOptionGroupResponse
- data DescribeAccountAttributes = DescribeAccountAttributes' {
- newDescribeAccountAttributes :: DescribeAccountAttributes
- data DescribeAccountAttributesResponse = DescribeAccountAttributesResponse' (Maybe [AccountQuota]) Int
- newDescribeAccountAttributesResponse :: Int -> DescribeAccountAttributesResponse
- data DeleteDBSnapshot = DeleteDBSnapshot' Text
- newDeleteDBSnapshot :: Text -> DeleteDBSnapshot
- data DeleteDBSnapshotResponse = DeleteDBSnapshotResponse' (Maybe DBSnapshot) Int
- newDeleteDBSnapshotResponse :: Int -> DeleteDBSnapshotResponse
- data DescribeDBClusterParameters = DescribeDBClusterParameters' (Maybe [Filter]) (Maybe Text) (Maybe Int) (Maybe Text) Text
- newDescribeDBClusterParameters :: Text -> DescribeDBClusterParameters
- data DescribeDBClusterParametersResponse = DescribeDBClusterParametersResponse' (Maybe Text) (Maybe [Parameter]) Int
- newDescribeDBClusterParametersResponse :: Int -> DescribeDBClusterParametersResponse
- data DeleteDBSubnetGroup = DeleteDBSubnetGroup' Text
- newDeleteDBSubnetGroup :: Text -> DeleteDBSubnetGroup
- data DeleteDBSubnetGroupResponse = DeleteDBSubnetGroupResponse' {
- newDeleteDBSubnetGroupResponse :: DeleteDBSubnetGroupResponse
- data CreateDBSecurityGroup = CreateDBSecurityGroup' (Maybe [Tag]) Text Text
- newCreateDBSecurityGroup :: Text -> Text -> CreateDBSecurityGroup
- data CreateDBSecurityGroupResponse = CreateDBSecurityGroupResponse' (Maybe DBSecurityGroup) Int
- newCreateDBSecurityGroupResponse :: Int -> CreateDBSecurityGroupResponse
- data ModifyCertificates = ModifyCertificates' (Maybe Text) (Maybe Bool)
- newModifyCertificates :: ModifyCertificates
- data ModifyCertificatesResponse = ModifyCertificatesResponse' (Maybe Certificate) Int
- newModifyCertificatesResponse :: Int -> ModifyCertificatesResponse
- data DescribeDBClusterSnapshots = DescribeDBClusterSnapshots' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool)
- newDescribeDBClusterSnapshots :: DescribeDBClusterSnapshots
- data DescribeDBClusterSnapshotsResponse = DescribeDBClusterSnapshotsResponse' (Maybe Text) (Maybe [DBClusterSnapshot]) Int
- newDescribeDBClusterSnapshotsResponse :: Int -> DescribeDBClusterSnapshotsResponse
- data RebootDBInstance = RebootDBInstance' (Maybe Bool) Text
- newRebootDBInstance :: Text -> RebootDBInstance
- data RebootDBInstanceResponse = RebootDBInstanceResponse' (Maybe DBInstance) Int
- newRebootDBInstanceResponse :: Int -> RebootDBInstanceResponse
- data CreateDBSubnetGroup = CreateDBSubnetGroup' (Maybe [Tag]) Text Text [Text]
- newCreateDBSubnetGroup :: Text -> Text -> CreateDBSubnetGroup
- data CreateDBSubnetGroupResponse = CreateDBSubnetGroupResponse' (Maybe DBSubnetGroup) Int
- newCreateDBSubnetGroupResponse :: Int -> CreateDBSubnetGroupResponse
- data DescribeReservedDBInstancesOfferings = DescribeReservedDBInstancesOfferings' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text)
- newDescribeReservedDBInstancesOfferings :: DescribeReservedDBInstancesOfferings
- data DescribeReservedDBInstancesOfferingsResponse = DescribeReservedDBInstancesOfferingsResponse' (Maybe Text) (Maybe [ReservedDBInstancesOffering]) Int
- newDescribeReservedDBInstancesOfferingsResponse :: Int -> DescribeReservedDBInstancesOfferingsResponse
- data DeleteDBSecurityGroup = DeleteDBSecurityGroup' Text
- newDeleteDBSecurityGroup :: Text -> DeleteDBSecurityGroup
- data DeleteDBSecurityGroupResponse = DeleteDBSecurityGroupResponse' {
- newDeleteDBSecurityGroupResponse :: DeleteDBSecurityGroupResponse
- data DeleteDBInstance = DeleteDBInstance' (Maybe Text) (Maybe Bool) (Maybe Bool) Text
- newDeleteDBInstance :: Text -> DeleteDBInstance
- data DeleteDBInstanceResponse = DeleteDBInstanceResponse' (Maybe DBInstance) Int
- newDeleteDBInstanceResponse :: Int -> DeleteDBInstanceResponse
- data StartActivityStream = StartActivityStream' (Maybe Bool) (Maybe Bool) Text ActivityStreamMode Text
- newStartActivityStream :: Text -> ActivityStreamMode -> Text -> StartActivityStream
- data StartActivityStreamResponse = StartActivityStreamResponse' (Maybe ActivityStreamStatus) (Maybe Text) (Maybe Bool) (Maybe ActivityStreamMode) (Maybe Text) (Maybe Bool) Int
- newStartActivityStreamResponse :: Int -> StartActivityStreamResponse
- data CreateDBInstanceReadReplica = CreateDBInstanceReadReplica' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe ReplicaMode) (Maybe Int) (Maybe Text) (Maybe [ProcessorFeature]) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [Text]) Text Text
- newCreateDBInstanceReadReplica :: Text -> Text -> CreateDBInstanceReadReplica
- data CreateDBInstanceReadReplicaResponse = CreateDBInstanceReadReplicaResponse' (Maybe DBInstance) Int
- newCreateDBInstanceReadReplicaResponse :: Int -> CreateDBInstanceReadReplicaResponse
- data DeleteDBParameterGroup = DeleteDBParameterGroup' Text
- newDeleteDBParameterGroup :: Text -> DeleteDBParameterGroup
- data DeleteDBParameterGroupResponse = DeleteDBParameterGroupResponse' {
- newDeleteDBParameterGroupResponse :: DeleteDBParameterGroupResponse
- data ModifyCurrentDBClusterCapacity = ModifyCurrentDBClusterCapacity' (Maybe Text) (Maybe Int) (Maybe Int) Text
- newModifyCurrentDBClusterCapacity :: Text -> ModifyCurrentDBClusterCapacity
- data ModifyCurrentDBClusterCapacityResponse = ModifyCurrentDBClusterCapacityResponse' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Int) Int
- newModifyCurrentDBClusterCapacityResponse :: Int -> ModifyCurrentDBClusterCapacityResponse
- data ModifyGlobalCluster = ModifyGlobalCluster' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text)
- newModifyGlobalCluster :: ModifyGlobalCluster
- data ModifyGlobalClusterResponse = ModifyGlobalClusterResponse' (Maybe GlobalCluster) Int
- newModifyGlobalClusterResponse :: Int -> ModifyGlobalClusterResponse
- data RegisterDBProxyTargets = RegisterDBProxyTargets' (Maybe [Text]) (Maybe [Text]) (Maybe Text) Text
- newRegisterDBProxyTargets :: Text -> RegisterDBProxyTargets
- data RegisterDBProxyTargetsResponse = RegisterDBProxyTargetsResponse' (Maybe [DBProxyTarget]) Int
- newRegisterDBProxyTargetsResponse :: Int -> RegisterDBProxyTargetsResponse
- data DescribeDBSecurityGroups = DescribeDBSecurityGroups' (Maybe [Filter]) (Maybe Text) (Maybe Int) (Maybe Text)
- newDescribeDBSecurityGroups :: DescribeDBSecurityGroups
- data DescribeDBSecurityGroupsResponse = DescribeDBSecurityGroupsResponse' (Maybe [DBSecurityGroup]) (Maybe Text) Int
- newDescribeDBSecurityGroupsResponse :: Int -> DescribeDBSecurityGroupsResponse
- data CopyOptionGroup = CopyOptionGroup' (Maybe [Tag]) Text Text Text
- newCopyOptionGroup :: Text -> Text -> Text -> CopyOptionGroup
- data CopyOptionGroupResponse = CopyOptionGroupResponse' (Maybe OptionGroup) Int
- newCopyOptionGroupResponse :: Int -> CopyOptionGroupResponse
- data RestoreDBClusterToPointInTime = RestoreDBClusterToPointInTime' (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe ScalingConfiguration) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe [Text]) Text Text
- newRestoreDBClusterToPointInTime :: Text -> Text -> RestoreDBClusterToPointInTime
- data RestoreDBClusterToPointInTimeResponse = RestoreDBClusterToPointInTimeResponse' (Maybe DBCluster) Int
- newRestoreDBClusterToPointInTimeResponse :: Int -> RestoreDBClusterToPointInTimeResponse
- data DeleteInstallationMedia = DeleteInstallationMedia' Text
- newDeleteInstallationMedia :: Text -> DeleteInstallationMedia
- data InstallationMedia = InstallationMedia' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InstallationMediaFailureCause)
- newInstallationMedia :: InstallationMedia
- data DescribeDBInstances = DescribeDBInstances' (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int)
- newDescribeDBInstances :: DescribeDBInstances
- data DescribeDBInstancesResponse = DescribeDBInstancesResponse' (Maybe [DBInstance]) (Maybe Text) Int
- newDescribeDBInstancesResponse :: Int -> DescribeDBInstancesResponse
- data RestoreDBInstanceFromS3 = RestoreDBInstanceFromS3' (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe [ProcessorFeature]) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) Text Text Text Text Text Text Text
- newRestoreDBInstanceFromS3 :: Text -> Text -> Text -> Text -> Text -> Text -> Text -> RestoreDBInstanceFromS3
- data RestoreDBInstanceFromS3Response = RestoreDBInstanceFromS3Response' (Maybe DBInstance) Int
- newRestoreDBInstanceFromS3Response :: Int -> RestoreDBInstanceFromS3Response
- data DownloadDBLogFilePortion = DownloadDBLogFilePortion' (Maybe Int) (Maybe Text) Text Text
- newDownloadDBLogFilePortion :: Text -> Text -> DownloadDBLogFilePortion
- data DownloadDBLogFilePortionResponse = DownloadDBLogFilePortionResponse' (Maybe Text) (Maybe Bool) (Maybe Text) Int
- newDownloadDBLogFilePortionResponse :: Int -> DownloadDBLogFilePortionResponse
- data DescribeDBProxies = DescribeDBProxies' (Maybe [Filter]) (Maybe Text) (Maybe Natural) (Maybe Text)
- newDescribeDBProxies :: DescribeDBProxies
- data DescribeDBProxiesResponse = DescribeDBProxiesResponse' (Maybe [DBProxy]) (Maybe Text) Int
- newDescribeDBProxiesResponse :: Int -> DescribeDBProxiesResponse
- data StartExportTask = StartExportTask' (Maybe [Text]) (Maybe Text) Text Text Text Text Text
- newStartExportTask :: Text -> Text -> Text -> Text -> Text -> StartExportTask
- data ExportTask = ExportTask' (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text)
- newExportTask :: ExportTask
- newtype ActivityStreamMode where
- ActivityStreamMode' { }
- pattern ActivityStreamMode_Async :: ActivityStreamMode
- pattern ActivityStreamMode_Sync :: ActivityStreamMode
- newtype ActivityStreamStatus where
- newtype ApplyMethod where
- ApplyMethod' { }
- pattern ApplyMethod_Immediate :: ApplyMethod
- pattern ApplyMethod_Pending_reboot :: ApplyMethod
- newtype AuthScheme where
- AuthScheme' { }
- pattern AuthScheme_SECRETS :: AuthScheme
- newtype DBProxyEndpointStatus where
- DBProxyEndpointStatus' { }
- pattern DBProxyEndpointStatus_Available :: DBProxyEndpointStatus
- pattern DBProxyEndpointStatus_Creating :: DBProxyEndpointStatus
- pattern DBProxyEndpointStatus_Deleting :: DBProxyEndpointStatus
- pattern DBProxyEndpointStatus_Incompatible_network :: DBProxyEndpointStatus
- pattern DBProxyEndpointStatus_Insufficient_resource_limits :: DBProxyEndpointStatus
- pattern DBProxyEndpointStatus_Modifying :: DBProxyEndpointStatus
- newtype DBProxyEndpointTargetRole where
- newtype DBProxyStatus where
- DBProxyStatus' { }
- pattern DBProxyStatus_Available :: DBProxyStatus
- pattern DBProxyStatus_Creating :: DBProxyStatus
- pattern DBProxyStatus_Deleting :: DBProxyStatus
- pattern DBProxyStatus_Incompatible_network :: DBProxyStatus
- pattern DBProxyStatus_Insufficient_resource_limits :: DBProxyStatus
- pattern DBProxyStatus_Modifying :: DBProxyStatus
- pattern DBProxyStatus_Reactivating :: DBProxyStatus
- pattern DBProxyStatus_Suspended :: DBProxyStatus
- pattern DBProxyStatus_Suspending :: DBProxyStatus
- newtype EngineFamily where
- EngineFamily' { }
- pattern EngineFamily_MYSQL :: EngineFamily
- pattern EngineFamily_POSTGRESQL :: EngineFamily
- newtype FailoverStatus where
- FailoverStatus' { }
- pattern FailoverStatus_Cancelling :: FailoverStatus
- pattern FailoverStatus_Failing_over :: FailoverStatus
- pattern FailoverStatus_Pending :: FailoverStatus
- newtype IAMAuthMode where
- IAMAuthMode' { }
- pattern IAMAuthMode_DISABLED :: IAMAuthMode
- pattern IAMAuthMode_REQUIRED :: IAMAuthMode
- newtype ReplicaMode where
- ReplicaMode' { }
- pattern ReplicaMode_Mounted :: ReplicaMode
- pattern ReplicaMode_Open_read_only :: ReplicaMode
- newtype SourceType where
- SourceType' { }
- pattern SourceType_Db_cluster :: SourceType
- pattern SourceType_Db_cluster_snapshot :: SourceType
- pattern SourceType_Db_instance :: SourceType
- pattern SourceType_Db_parameter_group :: SourceType
- pattern SourceType_Db_security_group :: SourceType
- pattern SourceType_Db_snapshot :: SourceType
- newtype TargetHealthReason where
- TargetHealthReason' { }
- pattern TargetHealthReason_AUTH_FAILURE :: TargetHealthReason
- pattern TargetHealthReason_CONNECTION_FAILED :: TargetHealthReason
- pattern TargetHealthReason_INVALID_REPLICATION_STATE :: TargetHealthReason
- pattern TargetHealthReason_PENDING_PROXY_CAPACITY :: TargetHealthReason
- pattern TargetHealthReason_UNREACHABLE :: TargetHealthReason
- newtype TargetRole where
- TargetRole' { }
- pattern TargetRole_READ_ONLY :: TargetRole
- pattern TargetRole_READ_WRITE :: TargetRole
- pattern TargetRole_UNKNOWN :: TargetRole
- newtype TargetState where
- TargetState' { }
- pattern TargetState_AVAILABLE :: TargetState
- pattern TargetState_REGISTERING :: TargetState
- pattern TargetState_UNAVAILABLE :: TargetState
- newtype TargetType where
- TargetType' { }
- pattern TargetType_RDS_INSTANCE :: TargetType
- pattern TargetType_RDS_SERVERLESS_ENDPOINT :: TargetType
- pattern TargetType_TRACKED_CLUSTER :: TargetType
- newtype WriteForwardingStatus where
- WriteForwardingStatus' { }
- pattern WriteForwardingStatus_Disabled :: WriteForwardingStatus
- pattern WriteForwardingStatus_Disabling :: WriteForwardingStatus
- pattern WriteForwardingStatus_Enabled :: WriteForwardingStatus
- pattern WriteForwardingStatus_Enabling :: WriteForwardingStatus
- pattern WriteForwardingStatus_Unknown :: WriteForwardingStatus
- data AccountQuota = AccountQuota' (Maybe Integer) (Maybe Integer) (Maybe Text)
- newAccountQuota :: AccountQuota
- data AvailabilityZone = AvailabilityZone' (Maybe Text)
- newAvailabilityZone :: AvailabilityZone
- data AvailableProcessorFeature = AvailableProcessorFeature' (Maybe Text) (Maybe Text) (Maybe Text)
- newAvailableProcessorFeature :: AvailableProcessorFeature
- data Certificate = Certificate' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe ISO8601) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe ISO8601)
- newCertificate :: Certificate
- data CharacterSet = CharacterSet' (Maybe Text) (Maybe Text)
- newCharacterSet :: CharacterSet
- data CloudwatchLogsExportConfiguration = CloudwatchLogsExportConfiguration' (Maybe [Text]) (Maybe [Text])
- newCloudwatchLogsExportConfiguration :: CloudwatchLogsExportConfiguration
- data ClusterPendingModifiedValues = ClusterPendingModifiedValues' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe PendingCloudwatchLogsExports)
- newClusterPendingModifiedValues :: ClusterPendingModifiedValues
- data ConnectionPoolConfiguration = ConnectionPoolConfiguration' (Maybe Int) (Maybe [Text]) (Maybe Int) (Maybe Int) (Maybe Text)
- newConnectionPoolConfiguration :: ConnectionPoolConfiguration
- data ConnectionPoolConfigurationInfo = ConnectionPoolConfigurationInfo' (Maybe Int) (Maybe [Text]) (Maybe Int) (Maybe Int) (Maybe Text)
- newConnectionPoolConfigurationInfo :: ConnectionPoolConfigurationInfo
- data CustomAvailabilityZone = CustomAvailabilityZone' (Maybe VpnDetails) (Maybe Text) (Maybe Text) (Maybe Text)
- newCustomAvailabilityZone :: CustomAvailabilityZone
- data DBCluster = DBCluster' (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ISO8601) (Maybe Bool) (Maybe Text) (Maybe [DBClusterMember]) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe ISO8601) (Maybe Integer) (Maybe [Tag]) (Maybe Text) (Maybe ISO8601) (Maybe [Text]) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [DBClusterRole]) (Maybe [VpcSecurityGroupMembership]) (Maybe Int) (Maybe Text) (Maybe ActivityStreamMode) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe ActivityStreamStatus) (Maybe Int) (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe ScalingConfigurationInfo) (Maybe Text) (Maybe Text) (Maybe ClusterPendingModifiedValues) (Maybe Text) (Maybe WriteForwardingStatus) (Maybe Int) (Maybe [DomainMembership]) (Maybe [DBClusterOptionGroupStatus])
- newDBCluster :: DBCluster
- data DBClusterBacktrack = DBClusterBacktrack' (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe ISO8601)
- newDBClusterBacktrack :: DBClusterBacktrack
- data DBClusterEndpoint = DBClusterEndpoint' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text])
- newDBClusterEndpoint :: DBClusterEndpoint
- data DBClusterMember = DBClusterMember' (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Text)
- newDBClusterMember :: DBClusterMember
- data DBClusterOptionGroupStatus = DBClusterOptionGroupStatus' (Maybe Text) (Maybe Text)
- newDBClusterOptionGroupStatus :: DBClusterOptionGroupStatus
- data DBClusterParameterGroup = DBClusterParameterGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newDBClusterParameterGroup :: DBClusterParameterGroup
- data DBClusterParameterGroupNameMessage = DBClusterParameterGroupNameMessage' (Maybe Text)
- newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage
- data DBClusterRole = DBClusterRole' (Maybe Text) (Maybe Text) (Maybe Text)
- newDBClusterRole :: DBClusterRole
- data DBClusterSnapshot = DBClusterSnapshot' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Int) (Maybe Text) (Maybe ISO8601) (Maybe Int) (Maybe Int)
- newDBClusterSnapshot :: DBClusterSnapshot
- data DBClusterSnapshotAttribute = DBClusterSnapshotAttribute' (Maybe [Text]) (Maybe Text)
- newDBClusterSnapshotAttribute :: DBClusterSnapshotAttribute
- data DBClusterSnapshotAttributesResult = DBClusterSnapshotAttributesResult' (Maybe Text) (Maybe [DBClusterSnapshotAttribute])
- newDBClusterSnapshotAttributesResult :: DBClusterSnapshotAttributesResult
- data DBEngineVersion = DBEngineVersion' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe CharacterSet) (Maybe Text) (Maybe Text) (Maybe [CharacterSet]) (Maybe Text) (Maybe Bool) (Maybe [UpgradeTarget]) (Maybe Bool) (Maybe [CharacterSet]) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe [Timezone]) (Maybe [Text])
- newDBEngineVersion :: DBEngineVersion
- data DBInstance = DBInstance' (Maybe Text) (Maybe [DBSecurityGroupMembership]) (Maybe Bool) (Maybe ISO8601) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe ISO8601) (Maybe [Tag]) (Maybe Text) (Maybe ReplicaMode) (Maybe Int) (Maybe Text) (Maybe [ProcessorFeature]) (Maybe ISO8601) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [DBInstanceRole]) (Maybe Text) (Maybe [VpcSecurityGroupMembership]) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe DBSubnetGroup) (Maybe ActivityStreamMode) (Maybe Bool) (Maybe Endpoint) (Maybe [OptionGroupMembership]) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe ActivityStreamStatus) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe [DBParameterGroupStatus]) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [DBInstanceAutomatedBackupsReplication]) (Maybe Endpoint) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe PendingModifiedValues) (Maybe [Text]) (Maybe Text) (Maybe [DBInstanceStatusInfo]) (Maybe [DomainMembership]) (Maybe Text)
- newDBInstance :: DBInstance
- data DBInstanceAutomatedBackup = DBInstanceAutomatedBackup' (Maybe RestoreWindow) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [DBInstanceAutomatedBackupsReplication]) (Maybe Text) (Maybe Int) (Maybe Text)
- newDBInstanceAutomatedBackup :: DBInstanceAutomatedBackup
- data DBInstanceAutomatedBackupsReplication = DBInstanceAutomatedBackupsReplication' (Maybe Text)
- newDBInstanceAutomatedBackupsReplication :: DBInstanceAutomatedBackupsReplication
- data DBInstanceRole = DBInstanceRole' (Maybe Text) (Maybe Text) (Maybe Text)
- newDBInstanceRole :: DBInstanceRole
- data DBInstanceStatusInfo = DBInstanceStatusInfo' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text)
- newDBInstanceStatusInfo :: DBInstanceStatusInfo
- data DBParameterGroup = DBParameterGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newDBParameterGroup :: DBParameterGroup
- data DBParameterGroupNameMessage = DBParameterGroupNameMessage' (Maybe Text)
- newDBParameterGroupNameMessage :: DBParameterGroupNameMessage
- data DBParameterGroupStatus = DBParameterGroupStatus' (Maybe Text) (Maybe Text)
- newDBParameterGroupStatus :: DBParameterGroupStatus
- data DBProxy = DBProxy' (Maybe DBProxyStatus) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe [UserAuthConfigInfo]) (Maybe Bool) (Maybe Int) (Maybe ISO8601) (Maybe ISO8601) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text)
- newDBProxy :: DBProxy
- data DBProxyEndpoint = DBProxyEndpoint' (Maybe DBProxyEndpointStatus) (Maybe Text) (Maybe DBProxyEndpointTargetRole) (Maybe [Text]) (Maybe Text) (Maybe ISO8601) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool)
- newDBProxyEndpoint :: DBProxyEndpoint
- data DBProxyTarget = DBProxyTarget' (Maybe Text) (Maybe TargetHealth) (Maybe Text) (Maybe TargetRole) (Maybe Text) (Maybe TargetType) (Maybe Text) (Maybe Int)
- newDBProxyTarget :: DBProxyTarget
- data DBProxyTargetGroup = DBProxyTargetGroup' (Maybe Text) (Maybe ConnectionPoolConfigurationInfo) (Maybe Text) (Maybe ISO8601) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Bool)
- newDBProxyTargetGroup :: DBProxyTargetGroup
- data DBSecurityGroup = DBSecurityGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [IPRange]) (Maybe Text) (Maybe [EC2SecurityGroup]) (Maybe Text)
- newDBSecurityGroup :: DBSecurityGroup
- data DBSecurityGroupMembership = DBSecurityGroupMembership' (Maybe Text) (Maybe Text)
- newDBSecurityGroupMembership :: DBSecurityGroupMembership
- data DBSnapshot = DBSnapshot' (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe ISO8601) (Maybe [Tag]) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [ProcessorFeature]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text)
- newDBSnapshot :: DBSnapshot
- data DBSnapshotAttribute = DBSnapshotAttribute' (Maybe [Text]) (Maybe Text)
- newDBSnapshotAttribute :: DBSnapshotAttribute
- data DBSnapshotAttributesResult = DBSnapshotAttributesResult' (Maybe Text) (Maybe [DBSnapshotAttribute])
- newDBSnapshotAttributesResult :: DBSnapshotAttributesResult
- data DBSubnetGroup = DBSubnetGroup' (Maybe Text) (Maybe Text) (Maybe [Subnet]) (Maybe Text) (Maybe Text) (Maybe Text)
- newDBSubnetGroup :: DBSubnetGroup
- data DescribeDBLogFilesDetails = DescribeDBLogFilesDetails' (Maybe Integer) (Maybe Integer) (Maybe Text)
- newDescribeDBLogFilesDetails :: DescribeDBLogFilesDetails
- data DomainMembership = DomainMembership' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newDomainMembership :: DomainMembership
- data DoubleRange = DoubleRange' (Maybe Double) (Maybe Double)
- newDoubleRange :: DoubleRange
- data EC2SecurityGroup = EC2SecurityGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newEC2SecurityGroup :: EC2SecurityGroup
- data Endpoint = Endpoint' (Maybe Text) (Maybe Text) (Maybe Int)
- newEndpoint :: Endpoint
- data EngineDefaults = EngineDefaults' (Maybe Text) (Maybe Text) (Maybe [Parameter])
- newEngineDefaults :: EngineDefaults
- data Event = Event' (Maybe SourceType) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe [Text]) (Maybe Text)
- newEvent :: Event
- data EventCategoriesMap = EventCategoriesMap' (Maybe Text) (Maybe [Text])
- newEventCategoriesMap :: EventCategoriesMap
- data EventSubscription = EventSubscription' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe [Text])
- newEventSubscription :: EventSubscription
- data ExportTask = ExportTask' (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text)
- newExportTask :: ExportTask
- data FailoverState = FailoverState' (Maybe FailoverStatus) (Maybe Text) (Maybe Text)
- newFailoverState :: FailoverState
- data Filter = Filter' Text [Text]
- newFilter :: Text -> Filter
- data GlobalCluster = GlobalCluster' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [GlobalClusterMember]) (Maybe FailoverState) (Maybe Text)
- newGlobalCluster :: GlobalCluster
- data GlobalClusterMember = GlobalClusterMember' (Maybe [Text]) (Maybe Text) (Maybe Bool) (Maybe WriteForwardingStatus)
- newGlobalClusterMember :: GlobalClusterMember
- data IPRange = IPRange' (Maybe Text) (Maybe Text)
- newIPRange :: IPRange
- data InstallationMedia = InstallationMedia' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InstallationMediaFailureCause)
- newInstallationMedia :: InstallationMedia
- data InstallationMediaFailureCause = InstallationMediaFailureCause' (Maybe Text)
- newInstallationMediaFailureCause :: InstallationMediaFailureCause
- data MinimumEngineVersionPerAllowedValue = MinimumEngineVersionPerAllowedValue' (Maybe Text) (Maybe Text)
- newMinimumEngineVersionPerAllowedValue :: MinimumEngineVersionPerAllowedValue
- data Option = Option' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [OptionSetting]) (Maybe [VpcSecurityGroupMembership]) (Maybe [DBSecurityGroupMembership]) (Maybe Text) (Maybe Int)
- newOption :: Option
- data OptionConfiguration = OptionConfiguration' (Maybe [OptionSetting]) (Maybe [Text]) (Maybe [Text]) (Maybe Text) (Maybe Int) Text
- newOptionConfiguration :: Text -> OptionConfiguration
- data OptionGroup = OptionGroup' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Option]) (Maybe Text)
- newOptionGroup :: OptionGroup
- data OptionGroupMembership = OptionGroupMembership' (Maybe Text) (Maybe Text)
- newOptionGroupMembership :: OptionGroupMembership
- data OptionGroupOption = OptionGroupOption' (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Bool) (Maybe [OptionVersion]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe [OptionGroupOptionSetting]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Bool)
- newOptionGroupOption :: OptionGroupOption
- data OptionGroupOptionSetting = OptionGroupOptionSetting' (Maybe Text) (Maybe [MinimumEngineVersionPerAllowedValue]) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool)
- newOptionGroupOptionSetting :: OptionGroupOptionSetting
- data OptionSetting = OptionSetting' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text)
- newOptionSetting :: OptionSetting
- data OptionVersion = OptionVersion' (Maybe Text) (Maybe Bool)
- newOptionVersion :: OptionVersion
- data OrderableDBInstanceOption = OrderableDBInstanceOption' (Maybe Text) (Maybe Double) (Maybe Bool) (Maybe Int) (Maybe Bool) (Maybe Int) (Maybe [Text]) (Maybe Text) (Maybe [AvailableProcessorFeature]) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [AvailabilityZone]) (Maybe [Text]) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Double) (Maybe Bool) (Maybe Bool) (Maybe Int) (Maybe Text)
- newOrderableDBInstanceOption :: OrderableDBInstanceOption
- data Outpost = Outpost' (Maybe Text)
- newOutpost :: Outpost
- data Parameter = Parameter' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe ApplyMethod) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newParameter :: Parameter
- data PendingCloudwatchLogsExports = PendingCloudwatchLogsExports' (Maybe [Text]) (Maybe [Text])
- newPendingCloudwatchLogsExports :: PendingCloudwatchLogsExports
- data PendingMaintenanceAction = PendingMaintenanceAction' (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe ISO8601)
- newPendingMaintenanceAction :: PendingMaintenanceAction
- data PendingModifiedValues = PendingModifiedValues' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe [ProcessorFeature]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe PendingCloudwatchLogsExports) (Maybe Int) (Maybe Bool) (Maybe Int) (Maybe Int) (Maybe Text)
- newPendingModifiedValues :: PendingModifiedValues
- data ProcessorFeature = ProcessorFeature' (Maybe Text) (Maybe Text)
- newProcessorFeature :: ProcessorFeature
- data Range = Range' (Maybe Int) (Maybe Int) (Maybe Int)
- newRange :: Range
- data RecurringCharge = RecurringCharge' (Maybe Text) (Maybe Double)
- newRecurringCharge :: RecurringCharge
- data ReservedDBInstance = ReservedDBInstance' (Maybe Int) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [RecurringCharge]) (Maybe Text) (Maybe Double) (Maybe Double) (Maybe Int)
- newReservedDBInstance :: ReservedDBInstance
- data ReservedDBInstancesOffering = ReservedDBInstancesOffering' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [RecurringCharge]) (Maybe Text) (Maybe Double) (Maybe Double) (Maybe Int)
- newReservedDBInstancesOffering :: ReservedDBInstancesOffering
- data ResourcePendingMaintenanceActions = ResourcePendingMaintenanceActions' (Maybe [PendingMaintenanceAction]) (Maybe Text)
- newResourcePendingMaintenanceActions :: ResourcePendingMaintenanceActions
- data RestoreWindow = RestoreWindow' (Maybe ISO8601) (Maybe ISO8601)
- newRestoreWindow :: RestoreWindow
- data ScalingConfiguration = ScalingConfiguration' (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Int) (Maybe Int)
- newScalingConfiguration :: ScalingConfiguration
- data ScalingConfigurationInfo = ScalingConfigurationInfo' (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Int) (Maybe Int)
- newScalingConfigurationInfo :: ScalingConfigurationInfo
- data SourceRegion = SourceRegion' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text)
- newSourceRegion :: SourceRegion
- data Subnet = Subnet' (Maybe Text) (Maybe Text) (Maybe AvailabilityZone) (Maybe Outpost)
- newSubnet :: Subnet
- data Tag = Tag' (Maybe Text) (Maybe Text)
- newTag :: Tag
- data TargetHealth = TargetHealth' (Maybe TargetState) (Maybe TargetHealthReason) (Maybe Text)
- newTargetHealth :: TargetHealth
- data Timezone = Timezone' (Maybe Text)
- newTimezone :: Timezone
- data UpgradeTarget = UpgradeTarget' (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text)
- newUpgradeTarget :: UpgradeTarget
- data UserAuthConfig = UserAuthConfig' (Maybe IAMAuthMode) (Maybe Text) (Maybe AuthScheme) (Maybe Text) (Maybe Text)
- newUserAuthConfig :: UserAuthConfig
- data UserAuthConfigInfo = UserAuthConfigInfo' (Maybe IAMAuthMode) (Maybe Text) (Maybe AuthScheme) (Maybe Text) (Maybe Text)
- newUserAuthConfigInfo :: UserAuthConfigInfo
- data ValidDBInstanceModificationsMessage = ValidDBInstanceModificationsMessage' (Maybe [AvailableProcessorFeature]) (Maybe [ValidStorageOptions])
- newValidDBInstanceModificationsMessage :: ValidDBInstanceModificationsMessage
- data ValidStorageOptions = ValidStorageOptions' (Maybe [Range]) (Maybe [Range]) (Maybe [DoubleRange]) (Maybe Bool) (Maybe Text)
- newValidStorageOptions :: ValidStorageOptions
- data VpcSecurityGroupMembership = VpcSecurityGroupMembership' (Maybe Text) (Maybe Text)
- newVpcSecurityGroupMembership :: VpcSecurityGroupMembership
- data VpnDetails = VpnDetails' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text)
- newVpnDetails :: VpnDetails
Service Configuration
defaultService :: Service Source #
API version 2014-10-31
of the Amazon Relational Database Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by RDS
.
PointInTimeRestoreNotEnabledFault
_PointInTimeRestoreNotEnabledFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
SourceDBInstanceIdentifier
refers to a DB instance with
BackupRetentionPeriod
equal to 0.
InvalidDBParameterGroupStateFault
_InvalidDBParameterGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
ReservedDBInstanceQuotaExceededFault
_ReservedDBInstanceQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Request would exceed the user's DB Instance quota.
SourceNotFoundFault
_SourceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested source could not be found.
CertificateNotFoundFault
_CertificateNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
CertificateIdentifier
doesn't refer to an existing certificate.
AuthorizationQuotaExceededFault
_AuthorizationQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DB security group authorization quota has been reached.
DBClusterSnapshotAlreadyExistsFault
_DBClusterSnapshotAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The user already has a DB cluster snapshot with the given identifier.
DBParameterGroupAlreadyExistsFault
_DBParameterGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
A DB parameter group with the same name exists.
DBInstanceRoleQuotaExceededFault
_DBInstanceRoleQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.
DBInstanceRoleAlreadyExistsFault
_DBInstanceRoleAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified RoleArn
or FeatureName
value is already associated
with the DB instance.
DBParameterGroupQuotaExceededFault
_DBParameterGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request would result in the user exceeding the allowed number of DB parameter groups.
BackupPolicyNotFoundFault
_BackupPolicyNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for BackupPolicyNotFoundFault' errors.
InsufficientDBClusterCapacityFault
_InsufficientDBClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DB cluster doesn't have enough capacity for the current operation.
ReservedDBInstanceAlreadyExistsFault
_ReservedDBInstanceAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
User already has a reservation with the given identifier.
ProvisionedIopsNotAvailableInAZFault
_ProvisionedIopsNotAvailableInAZFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Provisioned IOPS not available in the specified Availability Zone.
DBProxyTargetAlreadyRegisteredFault
_DBProxyTargetAlreadyRegisteredFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.
AuthorizationAlreadyExistsFault
_AuthorizationAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB security group.
SubscriptionCategoryNotFoundFault
_SubscriptionCategoryNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The supplied category does not exist.
DBProxyTargetNotFoundFault
_DBProxyTargetNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
SubscriptionNotFoundFault
_SubscriptionNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The subscription name does not exist.
InvalidSubnet
_InvalidSubnet :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
SharedSnapshotQuotaExceededFault
_SharedSnapshotQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
DBSubnetQuotaExceededFault
_DBSubnetQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.
GlobalClusterAlreadyExistsFault
_GlobalClusterAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The GlobalClusterIdentifier
already exists. Choose a new global
database identifier (unique name) to create a new global database
cluster.
OptionGroupNotFoundFault
_OptionGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified option group could not be found.
DBClusterNotFoundFault
_DBClusterNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBClusterIdentifier
doesn't refer to an existing DB cluster.
InvalidDBProxyEndpointStateFault
_InvalidDBProxyEndpointStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can't perform this operation while the DB proxy endpoint is in a particular state.
DBLogFileNotFoundFault
_DBLogFileNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
LogFileName
doesn't refer to an existing DB log file.
DBProxyTargetGroupNotFoundFault
_DBProxyTargetGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
InvalidS3BucketFault
_InvalidS3BucketFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.
DBProxyQuotaExceededFault
_DBProxyQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web Services Region.
IamRoleNotFoundFault
_IamRoleNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The IAM role is missing for exporting to an Amazon S3 bucket.
DBClusterAlreadyExistsFault
_DBClusterAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The user already has a DB cluster with the given identifier.
StorageTypeNotSupportedFault
_StorageTypeNotSupportedFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Storage of the StorageType
specified can't be associated with the DB
instance.
DBSecurityGroupQuotaExceededFault
_DBSecurityGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request would result in the user exceeding the allowed number of DB security groups.
DBProxyEndpointNotFoundFault
_DBProxyEndpointNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DB proxy endpoint doesn't exist.
OptionGroupAlreadyExistsFault
_OptionGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The option group you are trying to create already exists.
ExportTaskNotFoundFault
_ExportTaskNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The export task doesn't exist.
InsufficientAvailableIPsInSubnetFault
_InsufficientAvailableIPsInSubnetFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested operation can't be performed because there aren't enough available IP addresses in the proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required from the subnets.
DBProxyNotFoundFault
_DBProxyNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
OptionGroupQuotaExceededFault
_OptionGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The quota of 20 option groups was exceeded for this Amazon Web Services account.
DBSecurityGroupAlreadyExistsFault
_DBSecurityGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
A DB security group with the name specified in DBSecurityGroupName
already exists.
SNSTopicArnNotFoundFault
_SNSTopicArnNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The SNS topic ARN does not exist.
InvalidDBClusterEndpointStateFault
_InvalidDBClusterEndpointStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested operation can't be performed on the endpoint while the endpoint is in this state.
InvalidEventSubscriptionStateFault
_InvalidEventSubscriptionStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
This error can occur if someone else is modifying a subscription. You should retry the action.
InvalidDBInstanceAutomatedBackupStateFault
_InvalidDBInstanceAutomatedBackupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.
KMSKeyNotAccessibleFault
_KMSKeyNotAccessibleFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error occurred accessing an Amazon Web Services KMS key.
DBSnapshotNotFoundFault
_DBSnapshotNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.
DBClusterParameterGroupNotFoundFault
_DBClusterParameterGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBClusterParameterGroupName
doesn't refer to an existing DB cluster
parameter group.
DBClusterQuotaExceededFault
_DBClusterQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
InvalidExportOnlyFault
_InvalidExportOnlyFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The export is invalid for exporting to an Amazon S3 bucket.
SnapshotQuotaExceededFault
_SnapshotQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request would result in the user exceeding the allowed number of DB snapshots.
InvalidDBClusterCapacityFault
_InvalidDBClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Capacity
isn't a valid Aurora Serverless DB cluster capacity. Valid
capacity values are 2
, 4
, 8
, 16
, 32
, 64
, 128
, and 256
.
DBSubnetGroupAlreadyExistsFault
_DBSubnetGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBSubnetGroupName
is already used by an existing DB subnet group.
SNSNoAuthorizationFault
_SNSNoAuthorizationFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You do not have permission to publish to the SNS topic ARN.
DBSecurityGroupNotFoundFault
_DBSecurityGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBSecurityGroupName
doesn't refer to an existing DB security group.
DBSecurityGroupNotSupportedFault
_DBSecurityGroupNotSupportedFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
A DB security group isn't allowed for this action.
InvalidDBProxyStateFault
_InvalidDBProxyStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested operation can't be performed while the proxy is in this state.
DBProxyEndpointQuotaExceededFault
_DBProxyEndpointQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DB proxy already has the maximum number of endpoints.
InstanceQuotaExceededFault
_InstanceQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request would result in the user exceeding the allowed number of DB instances.
DBClusterBacktrackNotFoundFault
_DBClusterBacktrackNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
BacktrackIdentifier
doesn't refer to an existing backtrack.
DomainNotFoundFault
_DomainNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Domain
doesn't refer to an existing Active Directory domain.
DBParameterGroupNotFoundFault
_DBParameterGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBParameterGroupName
doesn't refer to an existing DB parameter group.
InvalidDBSubnetGroupFault
_InvalidDBSubnetGroupFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.
ReservedDBInstancesOfferingNotFoundFault
_ReservedDBInstancesOfferingNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Specified offering does not exist.
InvalidDBSubnetStateFault
_InvalidDBSubnetStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DB subnet isn't in the available state.
DBClusterSnapshotNotFoundFault
_DBClusterSnapshotNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster
snapshot.
SNSInvalidTopicFault
_SNSInvalidTopicFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
SNS has responded that there is a problem with the SND topic specified.
InsufficientDBInstanceCapacityFault
_InsufficientDBInstanceCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified DB instance class isn't available in the specified Availability Zone.
InvalidDBClusterSnapshotStateFault
_InvalidDBClusterSnapshotStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The supplied value isn't a valid DB cluster snapshot state.
InstallationMediaAlreadyExistsFault
_InstallationMediaAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified installation medium has already been imported.
SubscriptionAlreadyExistFault
_SubscriptionAlreadyExistFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The supplied subscription name already exists.
DBClusterRoleAlreadyExistsFault
_DBClusterRoleAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.
IamRoleMissingPermissionsFault
_IamRoleMissingPermissionsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The IAM role requires additional permissions to export to an Amazon S3 bucket.
DBClusterRoleQuotaExceededFault
_DBClusterRoleQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.
InvalidVPCNetworkStateFault
_InvalidVPCNetworkStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
DBInstanceRoleNotFoundFault
_DBInstanceRoleNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified RoleArn
value doesn't match the specified feature for
the DB instance.
AuthorizationNotFoundFault
_AuthorizationNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
ReservedDBInstanceNotFoundFault
_ReservedDBInstanceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified reserved DB Instance not found.
DBSubnetGroupQuotaExceededFault
_DBSubnetGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request would result in the user exceeding the allowed number of DB subnet groups.
CustomAvailabilityZoneNotFoundFault
_CustomAvailabilityZoneNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
CustomAvailabilityZoneId
doesn't refer to an existing custom
Availability Zone identifier.
DBProxyEndpointAlreadyExistsFault
_DBProxyEndpointAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.
InvalidGlobalClusterStateFault
_InvalidGlobalClusterStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The global cluster is in an invalid state and can't perform the requested operation.
DBSubnetGroupNotAllowedFault
_DBSubnetGroupNotAllowedFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the source instance.
InvalidExportTaskStateFault
_InvalidExportTaskStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can't cancel an export task that has completed.
InvalidExportSourceStateFault
_InvalidExportSourceStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.
ExportTaskAlreadyExistsFault
_ExportTaskAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can't start an export task that's already running.
EventSubscriptionQuotaExceededFault
_EventSubscriptionQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have reached the maximum number of event subscriptions.
InsufficientStorageClusterCapacityFault
_InsufficientStorageClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
DBClusterEndpointQuotaExceededFault
_DBClusterEndpointQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The cluster already has the maximum number of custom endpoints.
InvalidOptionGroupStateFault
_InvalidOptionGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The option group isn't in the available state.
DBInstanceAutomatedBackupQuotaExceededFault
_DBInstanceAutomatedBackupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB Instance quota.
CustomAvailabilityZoneAlreadyExistsFault
_CustomAvailabilityZoneAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
CustomAvailabilityZoneName
is already used by an existing custom
Availability Zone.
InvalidDBClusterStateFault
_InvalidDBClusterStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested operation can't be performed while the cluster is in this state.
GlobalClusterNotFoundFault
_GlobalClusterNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The GlobalClusterIdentifier
doesn't refer to an existing global
database cluster.
DBInstanceAlreadyExistsFault
_DBInstanceAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The user already has a DB instance with the given identifier.
InvalidRestoreFault
_InvalidRestoreFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Cannot restore from VPC backup to non-VPC DB instance.
InvalidDBSecurityGroupStateFault
_InvalidDBSecurityGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The state of the DB security group doesn't allow deletion.
ResourceNotFoundFault
_ResourceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource ID was not found.
DBSubnetGroupNotFoundFault
_DBSubnetGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBSubnetGroupName
doesn't refer to an existing DB subnet group.
DBUpgradeDependencyFailureFault
_DBUpgradeDependencyFailureFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DB upgrade failed because a resource the DB depends on can't be modified.
CustomAvailabilityZoneQuotaExceededFault
_CustomAvailabilityZoneQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have exceeded the maximum number of custom Availability Zones.
InvalidDBInstanceStateFault
_InvalidDBInstanceStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DB instance isn't in a valid state.
DBClusterEndpointAlreadyExistsFault
_DBClusterEndpointAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified custom endpoint can't be created because it already exists.
DBSnapshotAlreadyExistsFault
_DBSnapshotAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBSnapshotIdentifier
is already used by an existing snapshot.
DBInstanceNotFoundFault
_DBInstanceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBInstanceIdentifier
doesn't refer to an existing DB instance.
StorageQuotaExceededFault
_StorageQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request would result in the user exceeding the allowed amount of storage available across all DB instances.
DBProxyAlreadyExistsFault
_DBProxyAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
DBInstanceAutomatedBackupNotFoundFault
_DBInstanceAutomatedBackupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
No automated backup for this DB instance was found.
InvalidDBSnapshotStateFault
_InvalidDBSnapshotStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The state of the DB snapshot doesn't allow deletion.
InvalidDBSubnetGroupStateFault
_InvalidDBSubnetGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DB subnet group cannot be deleted because it's in use.
GlobalClusterQuotaExceededFault
_GlobalClusterQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of global database clusters for this account is already at the maximum allowed.
DBClusterEndpointNotFoundFault
_DBClusterEndpointNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified custom endpoint doesn't exist.
InstallationMediaNotFoundFault
_InstallationMediaNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
InstallationMediaID
doesn't refer to an existing installation medium.
DBSubnetGroupDoesNotCoverEnoughAZs
_DBSubnetGroupDoesNotCoverEnoughAZs :: AsError a => Getting (First ServiceError) a ServiceError Source #
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
SubnetAlreadyInUse
_SubnetAlreadyInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DB subnet is already in use in the Availability Zone.
DBClusterRoleNotFoundFault
_DBClusterRoleNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
DBInstanceAvailable
newDBInstanceAvailable :: Wait DescribeDBInstances Source #
Polls DescribeDBInstances
every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
DBSnapshotCompleted
newDBSnapshotCompleted :: Wait DescribeDBSnapshots Source #
Polls DescribeDBSnapshots
every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
DBSnapshotDeleted
newDBSnapshotDeleted :: Wait DescribeDBSnapshots Source #
Polls DescribeDBSnapshots
every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
DBInstanceDeleted
newDBInstanceDeleted :: Wait DescribeDBInstances Source #
Polls DescribeDBInstances
every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
DBClusterSnapshotDeleted
newDBClusterSnapshotDeleted :: Wait DescribeDBClusterSnapshots Source #
Polls DescribeDBClusterSnapshots
every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
DBSnapshotAvailable
newDBSnapshotAvailable :: Wait DescribeDBSnapshots Source #
Polls DescribeDBSnapshots
every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
DBClusterSnapshotAvailable
newDBClusterSnapshotAvailable :: Wait DescribeDBClusterSnapshots Source #
Polls DescribeDBClusterSnapshots
every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
StartDBCluster
data StartDBCluster Source #
See: newStartDBCluster
smart constructor.
Constructors
StartDBCluster' Text |
Instances
Arguments
:: Text | |
-> StartDBCluster |
Create a value of StartDBCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterIdentifier:StartDBCluster'
, startDBCluster_dbClusterIdentifier
- The DB cluster identifier of the Amazon Aurora DB cluster to be started.
This parameter is stored as a lowercase string.
data StartDBClusterResponse Source #
See: newStartDBClusterResponse
smart constructor.
Constructors
StartDBClusterResponse' (Maybe DBCluster) Int |
Instances
newStartDBClusterResponse Source #
Create a value of StartDBClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbCluster:StartDBClusterResponse'
, startDBClusterResponse_dbCluster
- Undocumented member.
$sel:httpStatus:StartDBClusterResponse'
, startDBClusterResponse_httpStatus
- The response's http status code.
DescribeDBClusterParameterGroups (Paginated)
data DescribeDBClusterParameterGroups Source #
See: newDescribeDBClusterParameterGroups
smart constructor.
Constructors
DescribeDBClusterParameterGroups' (Maybe [Filter]) (Maybe Text) (Maybe Int) (Maybe Text) |
Instances
newDescribeDBClusterParameterGroups :: DescribeDBClusterParameterGroups Source #
Create a value of DescribeDBClusterParameterGroups
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeDBClusterParameterGroups'
, describeDBClusterParameterGroups_filters
- This parameter isn't currently supported.
$sel:marker:DescribeDBClusterParameterGroups'
, describeDBClusterParameterGroups_marker
- 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
.
$sel:maxRecords:DescribeDBClusterParameterGroups'
, describeDBClusterParameterGroups_maxRecords
- 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.
$sel:dbClusterParameterGroupName:DescribeDBClusterParameterGroups'
, describeDBClusterParameterGroups_dbClusterParameterGroupName
- The name of a specific DB cluster parameter group to return details for.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.
data DescribeDBClusterParameterGroupsResponse Source #
See: newDescribeDBClusterParameterGroupsResponse
smart constructor.
Constructors
DescribeDBClusterParameterGroupsResponse' (Maybe Text) (Maybe [DBClusterParameterGroup]) Int |
Instances
newDescribeDBClusterParameterGroupsResponse Source #
Arguments
:: Int | |
-> DescribeDBClusterParameterGroupsResponse |
Create a value of DescribeDBClusterParameterGroupsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeDBClusterParameterGroups'
, describeDBClusterParameterGroupsResponse_marker
- 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
.
$sel:dbClusterParameterGroups:DescribeDBClusterParameterGroupsResponse'
, describeDBClusterParameterGroupsResponse_dbClusterParameterGroups
- A list of DB cluster parameter groups.
$sel:httpStatus:DescribeDBClusterParameterGroupsResponse'
, describeDBClusterParameterGroupsResponse_httpStatus
- The response's http status code.
PromoteReadReplica
data PromoteReadReplica Source #
See: newPromoteReadReplica
smart constructor.
Instances
newPromoteReadReplica Source #
Create a value of PromoteReadReplica
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:preferredBackupWindow:PromoteReadReplica'
, promoteReadReplica_preferredBackupWindow
- 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.
$sel:backupRetentionPeriod:PromoteReadReplica'
, promoteReadReplica_backupRetentionPeriod
- 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.
$sel:dbInstanceIdentifier:PromoteReadReplica'
, promoteReadReplica_dbInstanceIdentifier
- 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
data PromoteReadReplicaResponse Source #
See: newPromoteReadReplicaResponse
smart constructor.
Constructors
PromoteReadReplicaResponse' (Maybe DBInstance) Int |
Instances
newPromoteReadReplicaResponse Source #
Create a value of PromoteReadReplicaResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstance:PromoteReadReplicaResponse'
, promoteReadReplicaResponse_dbInstance
- Undocumented member.
$sel:httpStatus:PromoteReadReplicaResponse'
, promoteReadReplicaResponse_httpStatus
- The response's http status code.
DescribeDBEngineVersions (Paginated)
data DescribeDBEngineVersions Source #
See: newDescribeDBEngineVersions
smart constructor.
Constructors
DescribeDBEngineVersions' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Int) |
Instances
newDescribeDBEngineVersions :: DescribeDBEngineVersions Source #
Create a value of DescribeDBEngineVersions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:DescribeDBEngineVersions'
, describeDBEngineVersions_engineVersion
- The database engine version to return.
Example: 5.1.49
$sel:listSupportedTimezones:DescribeDBEngineVersions'
, describeDBEngineVersions_listSupportedTimezones
- A value that indicates whether to list the supported time zones for each
engine version.
If this parameter is enabled and the requested engine supports the
TimeZone
parameter for CreateDBInstance
, the response includes a
list of supported time zones for each engine version.
$sel:defaultOnly:DescribeDBEngineVersions'
, describeDBEngineVersions_defaultOnly
- A value that indicates whether only the default version of the specified
engine or engine and major version combination is returned.
$sel:includeAll:DescribeDBEngineVersions'
, describeDBEngineVersions_includeAll
- A value that indicates whether to include engine versions that aren't
available in the list. The default is to list only available engine
versions.
$sel:filters:DescribeDBEngineVersions'
, describeDBEngineVersions_filters
- This parameter isn't currently supported.
$sel:engine:DescribeDBEngineVersions'
, describeDBEngineVersions_engine
- The database engine to return.
Valid Values:
aurora
(for MySQL 5.6-compatible Aurora)aurora-mysql
(for MySQL 5.7-compatible Aurora)aurora-postgresql
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
$sel:dbParameterGroupFamily:DescribeDBEngineVersions'
, describeDBEngineVersions_dbParameterGroupFamily
- The name of a specific DB parameter group family to return details for.
Constraints:
- If supplied, must match an existing DBParameterGroupFamily.
$sel:listSupportedCharacterSets:DescribeDBEngineVersions'
, describeDBEngineVersions_listSupportedCharacterSets
- A value that indicates whether to list the supported character sets for
each engine version.
If this parameter is enabled and the requested engine supports the
CharacterSetName
parameter for CreateDBInstance
, the response
includes a list of supported character sets for each engine version.
$sel:marker:DescribeDBEngineVersions'
, describeDBEngineVersions_marker
- 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
.
$sel:maxRecords:DescribeDBEngineVersions'
, describeDBEngineVersions_maxRecords
- 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.
data DescribeDBEngineVersionsResponse Source #
Contains the result of a successful invocation of the
DescribeDBEngineVersions
action.
See: newDescribeDBEngineVersionsResponse
smart constructor.
Constructors
DescribeDBEngineVersionsResponse' (Maybe Text) (Maybe [DBEngineVersion]) Int |
Instances
newDescribeDBEngineVersionsResponse Source #
Create a value of DescribeDBEngineVersionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeDBEngineVersions'
, describeDBEngineVersionsResponse_marker
- 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
.
$sel:dbEngineVersions:DescribeDBEngineVersionsResponse'
, describeDBEngineVersionsResponse_dbEngineVersions
- A list of DBEngineVersion
elements.
$sel:httpStatus:DescribeDBEngineVersionsResponse'
, describeDBEngineVersionsResponse_httpStatus
- The response's http status code.
StopDBInstance
data StopDBInstance Source #
See: newStopDBInstance
smart constructor.
Constructors
StopDBInstance' (Maybe Text) Text |
Instances
Arguments
:: Text | |
-> StopDBInstance |
Create a value of StopDBInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSnapshotIdentifier:StopDBInstance'
, stopDBInstance_dbSnapshotIdentifier
- The user-supplied instance identifier of the DB Snapshot created
immediately before the DB instance is stopped.
$sel:dbInstanceIdentifier:StopDBInstance'
, stopDBInstance_dbInstanceIdentifier
- The user-supplied instance identifier.
data StopDBInstanceResponse Source #
See: newStopDBInstanceResponse
smart constructor.
Constructors
StopDBInstanceResponse' (Maybe DBInstance) Int |
Instances
newStopDBInstanceResponse Source #
Create a value of StopDBInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstance:StopDBInstanceResponse'
, stopDBInstanceResponse_dbInstance
- Undocumented member.
$sel:httpStatus:StopDBInstanceResponse'
, stopDBInstanceResponse_httpStatus
- The response's http status code.
ModifyDBClusterEndpoint
data ModifyDBClusterEndpoint Source #
See: newModifyDBClusterEndpoint
smart constructor.
Instances
newModifyDBClusterEndpoint Source #
Create a value of ModifyDBClusterEndpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:staticMembers:ModifyDBClusterEndpoint'
, modifyDBClusterEndpoint_staticMembers
- List of DB instance identifiers that are part of the custom endpoint
group.
$sel:endpointType:ModifyDBClusterEndpoint'
, modifyDBClusterEndpoint_endpointType
- The type of the endpoint. One of: READER
, WRITER
, ANY
.
$sel:excludedMembers:ModifyDBClusterEndpoint'
, modifyDBClusterEndpoint_excludedMembers
- 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.
$sel:dbClusterEndpointIdentifier:ModifyDBClusterEndpoint'
, modifyDBClusterEndpoint_dbClusterEndpointIdentifier
- The identifier of the endpoint to modify. This parameter is stored as a
lowercase string.
data DBClusterEndpoint Source #
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
.
See: newDBClusterEndpoint
smart constructor.
Constructors
DBClusterEndpoint' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) |
Instances
newDBClusterEndpoint :: DBClusterEndpoint Source #
Create a value of DBClusterEndpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DBClusterEndpoint'
, dbClusterEndpoint_status
- 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.
$sel:dbClusterIdentifier:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterIdentifier
- The DB cluster identifier of the DB cluster associated with the
endpoint. This parameter is stored as a lowercase string.
$sel:dbClusterEndpointArn:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterEndpointArn
- The Amazon Resource Name (ARN) for the endpoint.
$sel:customEndpointType:DBClusterEndpoint'
, dbClusterEndpoint_customEndpointType
- The type associated with a custom endpoint. One of: READER
, WRITER
,
ANY
.
$sel:staticMembers:DBClusterEndpoint'
, dbClusterEndpoint_staticMembers
- List of DB instance identifiers that are part of the custom endpoint
group.
$sel:endpointType:DBClusterEndpoint'
, dbClusterEndpoint_endpointType
- The type of the endpoint. One of: READER
, WRITER
, CUSTOM
.
$sel:dbClusterEndpointIdentifier:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterEndpointIdentifier
- The identifier associated with the endpoint. This parameter is stored as
a lowercase string.
$sel:endpoint:DBClusterEndpoint'
, dbClusterEndpoint_endpoint
- The DNS address of the endpoint.
$sel:dbClusterEndpointResourceIdentifier:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterEndpointResourceIdentifier
- A unique system-generated identifier for an endpoint. It remains the
same for the whole life of the endpoint.
$sel:excludedMembers:DBClusterEndpoint'
, dbClusterEndpoint_excludedMembers
- 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.
DescribeDBProxyEndpoints (Paginated)
data DescribeDBProxyEndpoints Source #
See: newDescribeDBProxyEndpoints
smart constructor.
Constructors
DescribeDBProxyEndpoints' (Maybe [Filter]) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) |
Instances
newDescribeDBProxyEndpoints :: DescribeDBProxyEndpoints Source #
Create a value of DescribeDBProxyEndpoints
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeDBProxyEndpoints'
, describeDBProxyEndpoints_filters
- This parameter is not currently supported.
$sel:marker:DescribeDBProxyEndpoints'
, describeDBProxyEndpoints_marker
- 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
.
$sel:maxRecords:DescribeDBProxyEndpoints'
, describeDBProxyEndpoints_maxRecords
- 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.
$sel:dbProxyName:DescribeDBProxyEndpoints'
, describeDBProxyEndpoints_dbProxyName
- 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.
$sel:dbProxyEndpointName:DescribeDBProxyEndpoints'
, describeDBProxyEndpoints_dbProxyEndpointName
- 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.
data DescribeDBProxyEndpointsResponse Source #
See: newDescribeDBProxyEndpointsResponse
smart constructor.
Constructors
DescribeDBProxyEndpointsResponse' (Maybe [DBProxyEndpoint]) (Maybe Text) Int |
Instances
newDescribeDBProxyEndpointsResponse Source #
Create a value of DescribeDBProxyEndpointsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbProxyEndpoints:DescribeDBProxyEndpointsResponse'
, describeDBProxyEndpointsResponse_dbProxyEndpoints
- The list of ProxyEndpoint
objects returned by the API operation.
$sel:marker:DescribeDBProxyEndpoints'
, describeDBProxyEndpointsResponse_marker
- 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
.
$sel:httpStatus:DescribeDBProxyEndpointsResponse'
, describeDBProxyEndpointsResponse_httpStatus
- The response's http status code.
CopyDBSnapshot
data CopyDBSnapshot Source #
See: newCopyDBSnapshot
smart constructor.
Constructors
CopyDBSnapshot' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> CopyDBSnapshot |
Create a value of CopyDBSnapshot
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetCustomAvailabilityZone:CopyDBSnapshot'
, copyDBSnapshot_targetCustomAvailabilityZone
- The external custom Availability Zone (CAZ) identifier for the target
CAZ.
Example: rds-caz-aiqhTgQv
.
$sel:preSignedUrl:CopyDBSnapshot'
, copyDBSnapshot_preSignedUrl
- The URL that contains a Signature Version 4 signed request for the
CopyDBSnapshot
API action in the source Amazon Web Services Region
that contains the source DB snapshot to copy.
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 CopyDBSnapshot
API
action that can be executed in the source Amazon Web Services Region
that contains the encrypted DB snapshot to be copied. 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 theCopyDBSnapshot
action 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
action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to theCopyDBSnapshot
action in the us-west-2 Amazon Web Services Region. For this example, theDestinationRegion
in the presigned URL must be set to the us-east-1 Amazon Web Services Region.KmsKeyId
- The Amazon Web Services KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both theCopyDBSnapshot
action that is called in the destination Amazon Web Services Region, and the action 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 yourSourceDBSnapshotIdentifier
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 pre-signed URL that is a valid request for the operation
that can be executed in the source Amazon Web Services Region.
$sel:copyTags:CopyDBSnapshot'
, copyDBSnapshot_copyTags
- A value that indicates whether to copy all tags from the source DB
snapshot to the target DB snapshot. By default, tags are not copied.
$sel:destinationRegion:CopyDBSnapshot'
, copyDBSnapshot_destinationRegion
- Pseudo-parameter used when populating the PreSignedUrl
of a
cross-region CopyDBSnapshot
request. To replicate from region SRC
to
region DST
, send a request to region DST
. In that request, pass a
PreSignedUrl
for region SRC
with DestinationRegion
set to region
DST
.
$sel:kmsKeyId:CopyDBSnapshot'
, copyDBSnapshot_kmsKeyId
- 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 Amazon Web Services KMS customer master key
(CMK).
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 Amazon Web Services KMS CMK. 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 a Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.
$sel:optionGroupName:CopyDBSnapshot'
, copyDBSnapshot_optionGroupName
- 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.
$sel:tags:CopyDBSnapshot'
, copyDBSnapshot_tags
- Undocumented member.
$sel:sourceDBSnapshotIdentifier:CopyDBSnapshot'
, copyDBSnapshot_sourceDBSnapshotIdentifier
- 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, and must match the
SourceDBSnapshotIdentifier
in the PreSignedUrl
parameter.
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
$sel:targetDBSnapshotIdentifier:CopyDBSnapshot'
, copyDBSnapshot_targetDBSnapshotIdentifier
- 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
data CopyDBSnapshotResponse Source #
See: newCopyDBSnapshotResponse
smart constructor.
Constructors
CopyDBSnapshotResponse' (Maybe DBSnapshot) Int |
Instances
newCopyDBSnapshotResponse Source #
Create a value of CopyDBSnapshotResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSnapshot:CopyDBSnapshotResponse'
, copyDBSnapshotResponse_dbSnapshot
- Undocumented member.
$sel:httpStatus:CopyDBSnapshotResponse'
, copyDBSnapshotResponse_httpStatus
- The response's http status code.
AddSourceIdentifierToSubscription
data AddSourceIdentifierToSubscription Source #
See: newAddSourceIdentifierToSubscription
smart constructor.
Constructors
AddSourceIdentifierToSubscription' Text Text |
Instances
newAddSourceIdentifierToSubscription Source #
Arguments
:: Text | |
-> Text | |
-> AddSourceIdentifierToSubscription |
Create a value of AddSourceIdentifierToSubscription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subscriptionName:AddSourceIdentifierToSubscription'
, addSourceIdentifierToSubscription_subscriptionName
- The name of the RDS event notification subscription you want to add a
source identifier to.
$sel:sourceIdentifier:AddSourceIdentifierToSubscription'
, addSourceIdentifierToSubscription_sourceIdentifier
- 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.
data AddSourceIdentifierToSubscriptionResponse Source #
See: newAddSourceIdentifierToSubscriptionResponse
smart constructor.
Constructors
AddSourceIdentifierToSubscriptionResponse' (Maybe EventSubscription) Int |
Instances
newAddSourceIdentifierToSubscriptionResponse Source #
Arguments
:: Int | |
-> AddSourceIdentifierToSubscriptionResponse |
Create a value of AddSourceIdentifierToSubscriptionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventSubscription:AddSourceIdentifierToSubscriptionResponse'
, addSourceIdentifierToSubscriptionResponse_eventSubscription
- Undocumented member.
$sel:httpStatus:AddSourceIdentifierToSubscriptionResponse'
, addSourceIdentifierToSubscriptionResponse_httpStatus
- The response's http status code.
ModifyDBInstance
data ModifyDBInstance Source #
See: newModifyDBInstance
smart constructor.
Constructors
ModifyDBInstance' (Maybe Text) (Maybe [Text]) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ReplicaMode) (Maybe Int) (Maybe CloudwatchLogsExportConfiguration) (Maybe Bool) (Maybe Text) (Maybe [ProcessorFeature]) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) Text |
Instances
Create a value of ModifyDBInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:ModifyDBInstance'
, modifyDBInstance_engineVersion
- The version number of the database engine to upgrade to. Changing this
parameter results in an outage and the change is applied during the next
maintenance window unless the ApplyImmediately
parameter is enabled
for this request.
For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
If you specify only a major version, Amazon RDS will update the DB
instance to the default minor version if the current minor version is
lower. For information about valid engine versions, see
CreateDBInstance
, or call DescribeDBEngineVersions
.
$sel:dbSecurityGroups:ModifyDBInstance'
, modifyDBInstance_dbSecurityGroups
- 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.
Constraints:
- If supplied, must match existing DBSecurityGroups.
$sel:dbPortNumber:ModifyDBInstance'
, modifyDBInstance_dbPortNumber
- 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.
Your database will restart when you change the DBPortNumber
value
regardless of the value of the ApplyImmediately
parameter.
MySQL
Default: 3306
Valid values: 1150-65535
MariaDB
Default: 3306
Valid values: 1150-65535
PostgreSQL
Default: 5432
Valid values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid values: 1150-65535
SQL Server
Default: 1433
Valid values: 1150-65535
except 1234
, 1434
, 3260
, 3343
,
3389
, 47001
, and 49152-49156
.
Amazon Aurora
Default: 3306
Valid values: 1150-65535
$sel:deletionProtection:ModifyDBInstance'
, modifyDBInstance_deletionProtection
- A value that indicates whether the DB instance has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled. For more
information, see
Deleting a DB Instance.
$sel:masterUserPassword:ModifyDBInstance'
, modifyDBInstance_masterUserPassword
- The new password for the master user. The password can include any
printable ASCII character except "/", """, or "@".
Changing this parameter doesn't result in an outage and the change is
asynchronously applied as soon as possible. Between the time of the
request and the completion of the request, the MasterUserPassword
element exists in the PendingModifiedValues
element of the operation
response.
Amazon Aurora
Not applicable. The password for the master user is managed by the DB
cluster. For more information, see ModifyDBCluster
.
Default: Uses existing setting
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
$sel:publiclyAccessible:ModifyDBInstance'
, modifyDBInstance_publiclyAccessible
- A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.
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.
$sel:autoMinorVersionUpgrade:ModifyDBInstance'
, modifyDBInstance_autoMinorVersionUpgrade
- A value that indicates whether minor version upgrades are applied
automatically to the DB instance during the maintenance window. Changing
this parameter doesn't result in an outage except in the following case
and the change is asynchronously applied as soon as possible. An outage
results if this parameter is enabled during the maintenance window, and
a newer minor version is available, and RDS has enabled auto patching
for that engine version.
$sel:dbSubnetGroupName:ModifyDBInstance'
, modifyDBInstance_dbSubnetGroupName
- 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
.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetGroup
$sel:monitoringRoleArn:ModifyDBInstance'
, modifyDBInstance_monitoringRoleArn
- 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.
$sel:iops:ModifyDBInstance'
, modifyDBInstance_iops
- The new Provisioned IOPS (I/O operations per second) value for the RDS
instance.
Changing this setting doesn't result in an outage and the change is
applied during the next maintenance window unless the ApplyImmediately
parameter is enabled for this request. If you are migrating from
Provisioned IOPS to standard storage, set this value to 0. The DB
instance will require a reboot for the change in storage type to take
effect.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Default: Uses existing setting
$sel:allowMajorVersionUpgrade:ModifyDBInstance'
, modifyDBInstance_allowMajorVersionUpgrade
- A value that indicates whether major version upgrades are allowed.
Changing this parameter doesn't result in an outage and the change is
asynchronously applied as soon as possible.
Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
$sel:newDBInstanceIdentifier':ModifyDBInstance'
, modifyDBInstance_newDBInstanceIdentifier
- The new DB instance identifier for the DB instance when renaming a DB
instance. When you change the DB instance identifier, an instance reboot
occurs immediately if you enable ApplyImmediately
, or will occur
during the next maintenance window if you disable Apply Immediately.
This value is stored as a lowercase string.
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
$sel:domain:ModifyDBInstance'
, modifyDBInstance_domain
- The Active Directory directory ID to move the DB instance to. Specify
none
to remove the instance from its current domain. 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.
$sel:enableCustomerOwnedIp:ModifyDBInstance'
, modifyDBInstance_enableCustomerOwnedIp
- A value that indicates whether to enable a customer-owned IP address
(CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
$sel:replicaMode:ModifyDBInstance'
, modifyDBInstance_replicaMode
- 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.
$sel:monitoringInterval:ModifyDBInstance'
, modifyDBInstance_monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance. To disable collecting
Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn
is specified, then you must also set
MonitoringInterval
to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
$sel:cloudwatchLogsExportConfiguration:ModifyDBInstance'
, modifyDBInstance_cloudwatchLogsExportConfiguration
- The configuration setting for the log types to be enabled for export to
CloudWatch Logs for a specific DB instance.
A change to the CloudwatchLogsExportConfiguration
parameter is always
applied to the DB instance immediately. Therefore, the
ApplyImmediately
parameter has no effect.
$sel:certificateRotationRestart:ModifyDBInstance'
, modifyDBInstance_certificateRotationRestart
- A value that indicates whether the DB instance is restarted when you
rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
- For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. 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.
$sel:tdeCredentialPassword:ModifyDBInstance'
, modifyDBInstance_tdeCredentialPassword
- The password for the given ARN from the key store in order to access the
device.
$sel:processorFeatures:ModifyDBInstance'
, modifyDBInstance_processorFeatures
- The number of CPU cores and the number of threads per core for the DB
instance class of the DB instance.
$sel:dbInstanceClass:ModifyDBInstance'
, modifyDBInstance_dbInstanceClass
- 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.
If you modify the DB instance class, an outage occurs during the change.
The change is applied during the next maintenance window, unless
ApplyImmediately
is enabled for this request.
Default: Uses existing setting
$sel:promotionTier:ModifyDBInstance'
, modifyDBInstance_promotionTier
- A value that specifies the order in which an Aurora Replica is promoted
to the primary instance after a failure of the existing primary
instance. For more information, see
Fault Tolerance for an Aurora DB Cluster
in the Amazon Aurora User Guide.
Default: 1
Valid Values: 0 - 15
$sel:awsBackupRecoveryPointArn:ModifyDBInstance'
, modifyDBInstance_awsBackupRecoveryPointArn
- The Amazon Resource Name (ARN) of the recovery point in Amazon Web
Services Backup.
$sel:licenseModel:ModifyDBInstance'
, modifyDBInstance_licenseModel
- The license model for the DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
$sel:preferredMaintenanceWindow:ModifyDBInstance'
, modifyDBInstance_preferredMaintenanceWindow
- The weekly time range (in UTC) during which system maintenance can
occur, which might result in an outage. Changing this parameter doesn't
result in an outage, except in the following situation, and the change
is asynchronously applied as soon as possible. If there are pending
actions that cause a reboot, and the maintenance window is changed to
include the current time, then changing this parameter will cause a
reboot of the DB instance. If moving this window to the current time,
there must be at least 30 minutes between the current time and end of
the window to ensure pending changes are applied.
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
$sel:performanceInsightsRetentionPeriod:ModifyDBInstance'
, modifyDBInstance_performanceInsightsRetentionPeriod
- The amount of time, in days, to retain Performance Insights data. Valid
values are 7 or 731 (2 years).
$sel:cACertificateIdentifier:ModifyDBInstance'
, modifyDBInstance_cACertificateIdentifier
- Indicates the certificate that needs to be associated with the instance.
$sel:maxAllocatedStorage:ModifyDBInstance'
, modifyDBInstance_maxAllocatedStorage
- 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.
$sel:enablePerformanceInsights:ModifyDBInstance'
, modifyDBInstance_enablePerformanceInsights
- A value that indicates whether to enable Performance Insights for the DB
instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
$sel:dbParameterGroupName:ModifyDBInstance'
, modifyDBInstance_dbParameterGroupName
- 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
isn't applied during the next maintenance window.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
$sel:preferredBackupWindow:ModifyDBInstance'
, modifyDBInstance_preferredBackupWindow
- 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.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is
managed by the DB cluster. For more information, see ModifyDBCluster
.
Constraints:
- Must be in the format hh24:mi-hh24:mi
- Must be in Universal Time Coordinated (UTC)
- Must not conflict with the preferred maintenance window
- Must be at least 30 minutes
$sel:backupRetentionPeriod:ModifyDBInstance'
, modifyDBInstance_backupRetentionPeriod
- The number of days to retain automated backups. Setting this parameter
to a positive number enables backups. Setting this parameter to 0
disables automated backups.
Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
These changes are applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request. If you change
the parameter from one non-zero value to another non-zero value, the
change is asynchronously applied as soon as possible.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by
the DB cluster. For more information, see ModifyDBCluster
.
Default: Uses existing setting
Constraints:
- Must be a value from 0 to 35
- Can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later
- Can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5
- Can't be set to 0 if the DB instance is a source to read replicas
$sel:performanceInsightsKMSKeyId:ModifyDBInstance'
, modifyDBInstance_performanceInsightsKMSKeyId
- 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 Amazon Web Services KMS customer master key (CMK).
If you do not specify a value for PerformanceInsightsKMSKeyId
, then
Amazon RDS uses your default CMK. There is a default CMK for your Amazon
Web Services account. Your Amazon Web Services account has a different
default CMK for each Amazon Web Services Region.
$sel:vpcSecurityGroupIds:ModifyDBInstance'
, modifyDBInstance_vpcSecurityGroupIds
- A list of EC2 VPC security groups to authorize on this DB instance. This
change is asynchronously applied as soon as possible.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is
managed by the DB cluster. For more information, see ModifyDBCluster
.
Constraints:
- If supplied, must match existing VpcSecurityGroupIds.
$sel:multiAZ:ModifyDBInstance'
, modifyDBInstance_multiAZ
- A value that indicates whether the DB instance is a Multi-AZ deployment.
Changing this parameter 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.
$sel:allocatedStorage:ModifyDBInstance'
, modifyDBInstance_allocatedStorage
- The new amount of storage in gibibytes (GiB) to allocate for the DB
instance.
For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
For the valid values for allocated storage for each engine, see
CreateDBInstance
.
$sel:applyImmediately:ModifyDBInstance'
, modifyDBInstance_applyImmediately
- A value that indicates whether the modifications in this request and any
pending modifications are asynchronously applied as soon as possible,
regardless of the PreferredMaintenanceWindow
setting for the DB
instance. By default, this parameter is disabled.
If this parameter is disabled, changes to the DB instance are applied
during the next maintenance window. Some parameter changes can cause an
outage and are applied on the next call to RebootDBInstance, or the next
failure reboot. Review the table of parameters in
Modifying a DB Instance
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.
$sel:optionGroupName:ModifyDBInstance'
, modifyDBInstance_optionGroupName
- A value that indicates the DB instance should be associated with the
specified option group. Changing this parameter doesn't result in an
outage except in the following case and the change is applied during the
next maintenance window unless the ApplyImmediately
parameter is
enabled for this request. If the parameter change results in an option
group that enables OEM, this change can cause a brief (sub-second)
period during which new connections are rejected but existing
connections are not interrupted.
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
$sel:copyTagsToSnapshot:ModifyDBInstance'
, modifyDBInstance_copyTagsToSnapshot
- A value that indicates whether to copy all tags from the DB instance to
snapshots of the DB instance. By default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster.
Setting this value for an Aurora DB instance has no effect on the DB
cluster setting. For more information, see ModifyDBCluster
.
$sel:tdeCredentialArn:ModifyDBInstance'
, modifyDBInstance_tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE
encryption.
$sel:domainIAMRoleName:ModifyDBInstance'
, modifyDBInstance_domainIAMRoleName
- The name of the IAM role to use when making API calls to the Directory
Service.
$sel:enableIAMDatabaseAuthentication:ModifyDBInstance'
, modifyDBInstance_enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services
Identity and Access Management (IAM) accounts to database accounts. By
default, mapping is disabled.
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.
$sel:useDefaultProcessorFeatures:ModifyDBInstance'
, modifyDBInstance_useDefaultProcessorFeatures
- A value that indicates whether the DB instance class of the DB instance
uses its default processor features.
$sel:storageType:ModifyDBInstance'
, modifyDBInstance_storageType
- Specifies the storage type to be associated with the DB instance.
If you specify Provisioned IOPS (io1
), you must also include a value
for the Iops
parameter.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Valid values: standard | gp2 | io1
Default: io1
if the Iops
parameter is specified, otherwise gp2
$sel:dbInstanceIdentifier:ModifyDBInstance'
, modifyDBInstance_dbInstanceIdentifier
- The DB instance identifier. This value is stored as a lowercase string.
Constraints:
- Must match the identifier of an existing DBInstance.
data ModifyDBInstanceResponse Source #
See: newModifyDBInstanceResponse
smart constructor.
Constructors
ModifyDBInstanceResponse' (Maybe DBInstance) Int |
Instances
newModifyDBInstanceResponse Source #
Create a value of ModifyDBInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstance:ModifyDBInstanceResponse'
, modifyDBInstanceResponse_dbInstance
- Undocumented member.
$sel:httpStatus:ModifyDBInstanceResponse'
, modifyDBInstanceResponse_httpStatus
- The response's http status code.
ModifyEventSubscription
data ModifyEventSubscription Source #
See: newModifyEventSubscription
smart constructor.
Instances
newModifyEventSubscription Source #
Create a value of ModifyEventSubscription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:snsTopicArn:ModifyEventSubscription'
, modifyEventSubscription_snsTopicArn
- 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.
$sel:enabled:ModifyEventSubscription'
, modifyEventSubscription_enabled
- A value that indicates whether to activate the subscription.
$sel:sourceType:ModifyEventSubscription'
, modifyEventSubscription_sourceType
- 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. 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
$sel:eventCategories:ModifyEventSubscription'
, modifyEventSubscription_eventCategories
- 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.
$sel:subscriptionName:ModifyEventSubscription'
, modifyEventSubscription_subscriptionName
- The name of the RDS event notification subscription.
data ModifyEventSubscriptionResponse Source #
See: newModifyEventSubscriptionResponse
smart constructor.
Constructors
ModifyEventSubscriptionResponse' (Maybe EventSubscription) Int |
Instances
newModifyEventSubscriptionResponse Source #
Create a value of ModifyEventSubscriptionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventSubscription:ModifyEventSubscriptionResponse'
, modifyEventSubscriptionResponse_eventSubscription
- Undocumented member.
$sel:httpStatus:ModifyEventSubscriptionResponse'
, modifyEventSubscriptionResponse_httpStatus
- The response's http status code.
ResetDBClusterParameterGroup
data ResetDBClusterParameterGroup Source #
See: newResetDBClusterParameterGroup
smart constructor.
Instances
newResetDBClusterParameterGroup Source #
Arguments
:: Text |
|
-> ResetDBClusterParameterGroup |
Create a value of ResetDBClusterParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resetAllParameters:ResetDBClusterParameterGroup'
, resetDBClusterParameterGroup_resetAllParameters
- A value that indicates whether to reset all parameters in the DB cluster
parameter group to their default values. You can't use this parameter
if there is a list of parameter names specified for the Parameters
parameter.
$sel:parameters:ResetDBClusterParameterGroup'
, resetDBClusterParameterGroup_parameters
- 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.
$sel:dbClusterParameterGroupName:ResetDBClusterParameterGroup'
, resetDBClusterParameterGroup_dbClusterParameterGroupName
- The name of the DB cluster parameter group to reset.
data DBClusterParameterGroupNameMessage Source #
See: newDBClusterParameterGroupNameMessage
smart constructor.
Constructors
DBClusterParameterGroupNameMessage' (Maybe Text) |
Instances
newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage Source #
Create a value of DBClusterParameterGroupNameMessage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterParameterGroupName:DBClusterParameterGroupNameMessage'
, dbClusterParameterGroupNameMessage_dbClusterParameterGroupName
- 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.
DescribeCustomAvailabilityZones (Paginated)
data DescribeCustomAvailabilityZones Source #
See: newDescribeCustomAvailabilityZones
smart constructor.
Instances
newDescribeCustomAvailabilityZones :: DescribeCustomAvailabilityZones Source #
Create a value of DescribeCustomAvailabilityZones
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeCustomAvailabilityZones'
, describeCustomAvailabilityZones_filters
- A filter that specifies one or more custom AZs to describe.
$sel:customAvailabilityZoneId:DescribeCustomAvailabilityZones'
, describeCustomAvailabilityZones_customAvailabilityZoneId
- The custom AZ identifier. If this parameter is specified, information
from only the specific custom AZ is returned.
$sel:marker:DescribeCustomAvailabilityZones'
, describeCustomAvailabilityZones_marker
- An optional pagination token provided by a previous
DescribeCustomAvailabilityZones
request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords
.
$sel:maxRecords:DescribeCustomAvailabilityZones'
, describeCustomAvailabilityZones_maxRecords
- 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.
data DescribeCustomAvailabilityZonesResponse Source #
See: newDescribeCustomAvailabilityZonesResponse
smart constructor.
Constructors
DescribeCustomAvailabilityZonesResponse' (Maybe [CustomAvailabilityZone]) (Maybe Text) Int |
Instances
newDescribeCustomAvailabilityZonesResponse Source #
Arguments
:: Int | |
-> DescribeCustomAvailabilityZonesResponse |
Create a value of DescribeCustomAvailabilityZonesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customAvailabilityZones:DescribeCustomAvailabilityZonesResponse'
, describeCustomAvailabilityZonesResponse_customAvailabilityZones
- The list of CustomAvailabilityZone objects for the Amazon Web Services
account.
$sel:marker:DescribeCustomAvailabilityZones'
, describeCustomAvailabilityZonesResponse_marker
- An optional pagination token provided by a previous
DescribeCustomAvailabilityZones
request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords
.
$sel:httpStatus:DescribeCustomAvailabilityZonesResponse'
, describeCustomAvailabilityZonesResponse_httpStatus
- The response's http status code.
RestoreDBClusterFromS3
data RestoreDBClusterFromS3 Source #
See: newRestoreDBClusterFromS3
smart constructor.
Constructors
RestoreDBClusterFromS3' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe [Text]) Text Text Text Text Text Text Text Text |
Instances
newRestoreDBClusterFromS3 Source #
Create a value of RestoreDBClusterFromS3
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_engineVersion
- The version number of the database engine to use.
To list all of the available engine versions for aurora
(for MySQL
5.6-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for
MySQL 5.7-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
,
use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
Aurora PostgreSQL
Example: 9.6.3
, 10.7
$sel:deletionProtection:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_deletionProtection
- A value that indicates whether the DB cluster has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled.
$sel:storageEncrypted:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_storageEncrypted
- A value that indicates whether the restored DB cluster is encrypted.
$sel:dbSubnetGroupName:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_dbSubnetGroupName
- A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
$sel:domain:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_domain
- 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.
$sel:backtrackWindow:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_backtrackWindow
- 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).
$sel:preferredMaintenanceWindow:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_preferredMaintenanceWindow
- 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.
$sel:availabilityZones:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_availabilityZones
- A list of Availability Zones (AZs) where instances in the restored DB
cluster can be created.
$sel:characterSetName:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_characterSetName
- A value that indicates that the restored DB cluster should be associated
with the specified CharacterSet.
$sel:kmsKeyId:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_kmsKeyId
- 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 Amazon Web Services KMS customer master key (CMK). To use a CMK 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 CMK. There is a default CMK for your Amazon Web Services
account. Your Amazon Web Services account has a different default CMK
for each Amazon Web Services Region.
$sel:preferredBackupWindow:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_preferredBackupWindow
- 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.
$sel:backupRetentionPeriod:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_backupRetentionPeriod
- 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
$sel:vpcSecurityGroupIds:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with the restored DB
cluster.
$sel:databaseName:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_databaseName
- The database name for the restored DB cluster.
$sel:dbClusterParameterGroupName:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_dbClusterParameterGroupName
- The name of the DB cluster parameter group to associate with the
restored DB cluster. If this argument is omitted, default.aurora5.6
is
used.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.
$sel:s3Prefix:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_s3Prefix
- 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.
$sel:optionGroupName:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_optionGroupName
- 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.
$sel:copyTagsToSnapshot:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_copyTagsToSnapshot
- A value that indicates whether to copy all tags from the restored DB
cluster to snapshots of the restored DB cluster. The default is not to
copy them.
$sel:domainIAMRoleName:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the
Directory Service.
$sel:tags:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_tags
- Undocumented member.
$sel:port:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_port
- The port number on which the instances in the restored DB cluster accept
connections.
Default: 3306
$sel:enableIAMDatabaseAuthentication:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services
Identity and Access Management (IAM) accounts to database accounts. By
default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
$sel:enableCloudwatchLogsExports:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_enableCloudwatchLogsExports
- 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. For
more information, see
Publishing Database Logs to Amazon CloudWatch Logs
in the Amazon Aurora User Guide.
$sel:dbClusterIdentifier:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_dbClusterIdentifier
- 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
$sel:engine:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_engine
- The name of the database engine to be used for this DB cluster.
Valid Values: aurora
(for MySQL 5.6-compatible Aurora), aurora-mysql
(for MySQL 5.7-compatible Aurora), and aurora-postgresql
$sel:masterUsername:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_masterUsername
- 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.
$sel:masterUserPassword:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_masterUserPassword
- 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.
$sel:sourceEngine:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_sourceEngine
- The identifier for the database engine that was backed up to create the
files stored in the Amazon S3 bucket.
Valid values: mysql
$sel:sourceEngineVersion:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_sourceEngineVersion
- The version of the database that the backup files were created from.
MySQL versions 5.5, 5.6, and 5.7 are supported.
Example: 5.6.40
, 5.7.28
$sel:s3BucketName:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_s3BucketName
- The name of the Amazon S3 bucket that contains the data used to create
the Amazon Aurora DB cluster.
$sel:s3IngestionRoleArn:RestoreDBClusterFromS3'
, restoreDBClusterFromS3_s3IngestionRoleArn
- 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.
data RestoreDBClusterFromS3Response Source #
See: newRestoreDBClusterFromS3Response
smart constructor.
Constructors
RestoreDBClusterFromS3Response' (Maybe DBCluster) Int |
Instances
newRestoreDBClusterFromS3Response Source #
Create a value of RestoreDBClusterFromS3Response
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbCluster:RestoreDBClusterFromS3Response'
, restoreDBClusterFromS3Response_dbCluster
- Undocumented member.
$sel:httpStatus:RestoreDBClusterFromS3Response'
, restoreDBClusterFromS3Response_httpStatus
- The response's http status code.
DescribeEvents (Paginated)
data DescribeEvents Source #
See: newDescribeEvents
smart constructor.
Constructors
DescribeEvents' (Maybe ISO8601) (Maybe SourceType) (Maybe [Filter]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Int) (Maybe ISO8601) (Maybe Int) |
Instances
newDescribeEvents :: DescribeEvents Source #
Create a value of DescribeEvents
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:startTime:DescribeEvents'
, describeEvents_startTime
- 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
$sel:sourceType:DescribeEvents'
, describeEvents_sourceType
- The event source to retrieve events for. If no value is specified, all
events are returned.
$sel:filters:DescribeEvents'
, describeEvents_filters
- This parameter isn't currently supported.
$sel:sourceIdentifier:DescribeEvents'
, describeEvents_sourceIdentifier
- 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. - Can't end with a hyphen or contain two consecutive hyphens.
$sel:eventCategories:DescribeEvents'
, describeEvents_eventCategories
- A list of event categories that trigger notifications for a event
notification subscription.
$sel:marker:DescribeEvents'
, describeEvents_marker
- 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
.
$sel:maxRecords:DescribeEvents'
, describeEvents_maxRecords
- 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.
$sel:endTime:DescribeEvents'
, describeEvents_endTime
- 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
$sel:duration:DescribeEvents'
, describeEvents_duration
- The number of minutes to retrieve events for.
Default: 60
data DescribeEventsResponse Source #
Contains the result of a successful invocation of the DescribeEvents
action.
See: newDescribeEventsResponse
smart constructor.
Instances
newDescribeEventsResponse Source #
Create a value of DescribeEventsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:events:DescribeEventsResponse'
, describeEventsResponse_events
- A list of Event
instances.
$sel:marker:DescribeEvents'
, describeEventsResponse_marker
- 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
.
$sel:httpStatus:DescribeEventsResponse'
, describeEventsResponse_httpStatus
- The response's http status code.
DescribeEngineDefaultParameters (Paginated)
data DescribeEngineDefaultParameters Source #
See: newDescribeEngineDefaultParameters
smart constructor.
Instances
newDescribeEngineDefaultParameters Source #
Arguments
:: Text |
|
-> DescribeEngineDefaultParameters |
Create a value of DescribeEngineDefaultParameters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeEngineDefaultParameters'
, describeEngineDefaultParameters_filters
- This parameter isn't currently supported.
$sel:marker:DescribeEngineDefaultParameters'
, describeEngineDefaultParameters_marker
- 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
.
$sel:maxRecords:DescribeEngineDefaultParameters'
, describeEngineDefaultParameters_maxRecords
- 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.
$sel:dbParameterGroupFamily:DescribeEngineDefaultParameters'
, describeEngineDefaultParameters_dbParameterGroupFamily
- The name of the DB parameter group family.
data DescribeEngineDefaultParametersResponse Source #
See: newDescribeEngineDefaultParametersResponse
smart constructor.
Instances
newDescribeEngineDefaultParametersResponse Source #
Arguments
:: Int | |
-> EngineDefaults |
|
-> DescribeEngineDefaultParametersResponse |
Create a value of DescribeEngineDefaultParametersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeEngineDefaultParametersResponse'
, describeEngineDefaultParametersResponse_httpStatus
- The response's http status code.
$sel:engineDefaults:DescribeEngineDefaultParametersResponse'
, describeEngineDefaultParametersResponse_engineDefaults
- Undocumented member.
DescribeOptionGroups (Paginated)
data DescribeOptionGroups Source #
See: newDescribeOptionGroups
smart constructor.
Constructors
DescribeOptionGroups' (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) |
Instances
newDescribeOptionGroups :: DescribeOptionGroups Source #
Create a value of DescribeOptionGroups
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeOptionGroups'
, describeOptionGroups_filters
- This parameter isn't currently supported.
$sel:engineName:DescribeOptionGroups'
, describeOptionGroups_engineName
- Filters the list of option groups to only include groups associated with
a specific database engine.
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
$sel:majorEngineVersion:DescribeOptionGroups'
, describeOptionGroups_majorEngineVersion
- 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.
$sel:marker:DescribeOptionGroups'
, describeOptionGroups_marker
- 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
.
$sel:maxRecords:DescribeOptionGroups'
, describeOptionGroups_maxRecords
- 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.
$sel:optionGroupName:DescribeOptionGroups'
, describeOptionGroups_optionGroupName
- The name of the option group to describe. Can't be supplied together
with EngineName or MajorEngineVersion.
data DescribeOptionGroupsResponse Source #
List of option groups.
See: newDescribeOptionGroupsResponse
smart constructor.
Constructors
DescribeOptionGroupsResponse' (Maybe Text) (Maybe [OptionGroup]) Int |
Instances
newDescribeOptionGroupsResponse Source #
Create a value of DescribeOptionGroupsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeOptionGroups'
, describeOptionGroupsResponse_marker
- 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
.
$sel:optionGroupsList:DescribeOptionGroupsResponse'
, describeOptionGroupsResponse_optionGroupsList
- List of option groups.
$sel:httpStatus:DescribeOptionGroupsResponse'
, describeOptionGroupsResponse_httpStatus
- The response's http status code.
DescribeDBLogFiles (Paginated)
data DescribeDBLogFiles Source #
See: newDescribeDBLogFiles
smart constructor.
Constructors
DescribeDBLogFiles' (Maybe Text) (Maybe [Filter]) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe Int) Text |
Instances
newDescribeDBLogFiles Source #
Create a value of DescribeDBLogFiles
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filenameContains:DescribeDBLogFiles'
, describeDBLogFiles_filenameContains
- Filters the available log files for log file names that contain the
specified string.
$sel:filters:DescribeDBLogFiles'
, describeDBLogFiles_filters
- This parameter isn't currently supported.
$sel:fileSize:DescribeDBLogFiles'
, describeDBLogFiles_fileSize
- Filters the available log files for files larger than the specified
size.
$sel:fileLastWritten:DescribeDBLogFiles'
, describeDBLogFiles_fileLastWritten
- Filters the available log files for files written since the specified
date, in POSIX timestamp format with milliseconds.
$sel:marker:DescribeDBLogFiles'
, describeDBLogFiles_marker
- The pagination token provided in the previous request. If this parameter
is specified the response includes only records beyond the marker, up to
MaxRecords.
$sel:maxRecords:DescribeDBLogFiles'
, describeDBLogFiles_maxRecords
- 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.
$sel:dbInstanceIdentifier:DescribeDBLogFiles'
, describeDBLogFiles_dbInstanceIdentifier
- 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.
data DescribeDBLogFilesResponse Source #
The response from a call to DescribeDBLogFiles
.
See: newDescribeDBLogFilesResponse
smart constructor.
Constructors
DescribeDBLogFilesResponse' (Maybe [DescribeDBLogFilesDetails]) (Maybe Text) Int |
Instances
newDescribeDBLogFilesResponse Source #
Create a value of DescribeDBLogFilesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:describeDBLogFiles:DescribeDBLogFilesResponse'
, describeDBLogFilesResponse_describeDBLogFiles
- The DB log files returned.
$sel:marker:DescribeDBLogFiles'
, describeDBLogFilesResponse_marker
- A pagination token that can be used in a later DescribeDBLogFiles
request.
$sel:httpStatus:DescribeDBLogFilesResponse'
, describeDBLogFilesResponse_httpStatus
- The response's http status code.
DescribeDBClusters (Paginated)
data DescribeDBClusters Source #
See: newDescribeDBClusters
smart constructor.
Instances
newDescribeDBClusters :: DescribeDBClusters Source #
Create a value of DescribeDBClusters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterIdentifier:DescribeDBClusters'
, describeDBClusters_dbClusterIdentifier
- 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.
$sel:includeShared:DescribeDBClusters'
, describeDBClusters_includeShared
- Optional Boolean parameter that specifies whether the output includes
information about clusters shared from other Amazon Web Services
accounts.
$sel:filters:DescribeDBClusters'
, describeDBClusters_filters
- A filter that specifies one or more DB clusters to describe.
Supported filters:
clone-group-id
- Accepts clone group identifiers. The results list will only include 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 will only include information about the DB clusters identified by these ARNs.domain
- Accepts Active Directory directory IDs. The results list will only include information about the DB clusters associated with these domains.engine
- Accepts engine names. The results list will only include information about the DB clusters for these engines.
$sel:marker:DescribeDBClusters'
, describeDBClusters_marker
- 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
.
$sel:maxRecords:DescribeDBClusters'
, describeDBClusters_maxRecords
- 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.
data DescribeDBClustersResponse Source #
Contains the result of a successful invocation of the
DescribeDBClusters
action.
See: newDescribeDBClustersResponse
smart constructor.
Instances
newDescribeDBClustersResponse Source #
Create a value of DescribeDBClustersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusters:DescribeDBClustersResponse'
, describeDBClustersResponse_dbClusters
- Contains a list of DB clusters for the user.
$sel:marker:DescribeDBClusters'
, describeDBClustersResponse_marker
- A pagination token that can be used in a later DescribeDBClusters
request.
$sel:httpStatus:DescribeDBClustersResponse'
, describeDBClustersResponse_httpStatus
- The response's http status code.
ModifyDBSubnetGroup
data ModifyDBSubnetGroup Source #
See: newModifyDBSubnetGroup
smart constructor.
Constructors
ModifyDBSubnetGroup' (Maybe Text) Text [Text] |
Instances
newModifyDBSubnetGroup Source #
Create a value of ModifyDBSubnetGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSubnetGroupDescription:ModifyDBSubnetGroup'
, modifyDBSubnetGroup_dbSubnetGroupDescription
- The description for the DB subnet group.
$sel:dbSubnetGroupName:ModifyDBSubnetGroup'
, modifyDBSubnetGroup_dbSubnetGroupName
- 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: mySubnetgroup
$sel:subnetIds:ModifyDBSubnetGroup'
, modifyDBSubnetGroup_subnetIds
- The EC2 subnet IDs for the DB subnet group.
data ModifyDBSubnetGroupResponse Source #
See: newModifyDBSubnetGroupResponse
smart constructor.
Constructors
ModifyDBSubnetGroupResponse' (Maybe DBSubnetGroup) Int |
Instances
newModifyDBSubnetGroupResponse Source #
Create a value of ModifyDBSubnetGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSubnetGroup:ModifyDBSubnetGroupResponse'
, modifyDBSubnetGroupResponse_dbSubnetGroup
- Undocumented member.
$sel:httpStatus:ModifyDBSubnetGroupResponse'
, modifyDBSubnetGroupResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Constructors
ListTagsForResource' (Maybe [Filter]) Text |
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListTagsForResource'
, listTagsForResource_filters
- This parameter isn't currently supported.
$sel:resourceName:ListTagsForResource'
, listTagsForResource_resourceName
- 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.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Constructors
ListTagsForResourceResponse' (Maybe [Tag]) Int |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tagList:ListTagsForResourceResponse'
, listTagsForResourceResponse_tagList
- List of tags returned by the ListTagsForResource operation.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
DeleteOptionGroup
data DeleteOptionGroup Source #
See: newDeleteOptionGroup
smart constructor.
Constructors
DeleteOptionGroup' Text |
Instances
Arguments
:: Text | |
-> DeleteOptionGroup |
Create a value of DeleteOptionGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:optionGroupName:DeleteOptionGroup'
, deleteOptionGroup_optionGroupName
- The name of the option group to be deleted.
You can't delete default option groups.
data DeleteOptionGroupResponse Source #
See: newDeleteOptionGroupResponse
smart constructor.
Constructors
DeleteOptionGroupResponse' | |
Instances
newDeleteOptionGroupResponse :: DeleteOptionGroupResponse Source #
Create a value of DeleteOptionGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateDBProxyEndpoint
data CreateDBProxyEndpoint Source #
See: newCreateDBProxyEndpoint
smart constructor.
Constructors
CreateDBProxyEndpoint' (Maybe DBProxyEndpointTargetRole) (Maybe [Text]) (Maybe [Tag]) Text Text [Text] |
Instances
newCreateDBProxyEndpoint Source #
Arguments
:: Text | |
-> Text | |
-> CreateDBProxyEndpoint |
Create a value of CreateDBProxyEndpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetRole:CreateDBProxyEndpoint'
, createDBProxyEndpoint_targetRole
- A value that indicates whether the DB proxy endpoint can be used for
read/write or read-only operations. The default is READ_WRITE
.
$sel:vpcSecurityGroupIds:CreateDBProxyEndpoint'
, createDBProxyEndpoint_vpcSecurityGroupIds
- 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.
$sel:tags:CreateDBProxyEndpoint'
, createDBProxyEndpoint_tags
- Undocumented member.
$sel:dbProxyName:CreateDBProxyEndpoint'
, createDBProxyEndpoint_dbProxyName
- The name of the DB proxy associated with the DB proxy endpoint that you
create.
$sel:dbProxyEndpointName:CreateDBProxyEndpoint'
, createDBProxyEndpoint_dbProxyEndpointName
- The name of the DB proxy endpoint to create.
$sel:vpcSubnetIds:CreateDBProxyEndpoint'
, createDBProxyEndpoint_vpcSubnetIds
- 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.
data CreateDBProxyEndpointResponse Source #
See: newCreateDBProxyEndpointResponse
smart constructor.
Constructors
CreateDBProxyEndpointResponse' (Maybe DBProxyEndpoint) Int |
Instances
newCreateDBProxyEndpointResponse Source #
Create a value of CreateDBProxyEndpointResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbProxyEndpoint:CreateDBProxyEndpointResponse'
, createDBProxyEndpointResponse_dbProxyEndpoint
- 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.
$sel:httpStatus:CreateDBProxyEndpointResponse'
, createDBProxyEndpointResponse_httpStatus
- The response's http status code.
DeleteDBCluster
data DeleteDBCluster Source #
See: newDeleteDBCluster
smart constructor.
Instances
Arguments
:: Text | |
-> DeleteDBCluster |
Create a value of DeleteDBCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:finalDBSnapshotIdentifier:DeleteDBCluster'
, deleteDBCluster_finalDBSnapshotIdentifier
- The DB cluster snapshot identifier of the new DB cluster snapshot
created when SkipFinalSnapshot
is disabled.
Specifying this parameter and also skipping the creation of a final DB
cluster snapshot with the SkipFinalShapshot
parameter results in an
error.
Constraints:
- Must be 1 to 255 letters, numbers, or hyphens.
- First character must be a letter
- Can't end with a hyphen or contain two consecutive hyphens
$sel:skipFinalSnapshot:DeleteDBCluster'
, deleteDBCluster_skipFinalSnapshot
- A value that indicates whether to skip the creation of a final DB
cluster snapshot before the DB cluster is deleted. If skip is specified,
no DB cluster snapshot is created. If skip isn't specified, a DB
cluster snapshot is created before the DB cluster is deleted. By
default, skip isn't specified, and the DB cluster snapshot is created.
By default, this parameter is disabled.
You must specify a FinalDBSnapshotIdentifier
parameter if
SkipFinalSnapshot
is disabled.
$sel:dbClusterIdentifier:DeleteDBCluster'
, deleteDBCluster_dbClusterIdentifier
- The DB cluster identifier for the DB cluster to be deleted. This
parameter isn't case-sensitive.
Constraints:
- Must match an existing DBClusterIdentifier.
data DeleteDBClusterResponse Source #
See: newDeleteDBClusterResponse
smart constructor.
Constructors
DeleteDBClusterResponse' (Maybe DBCluster) Int |
Instances
newDeleteDBClusterResponse Source #
Create a value of DeleteDBClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbCluster:DeleteDBClusterResponse'
, deleteDBClusterResponse_dbCluster
- Undocumented member.
$sel:httpStatus:DeleteDBClusterResponse'
, deleteDBClusterResponse_httpStatus
- The response's http status code.
DescribeReservedDBInstances (Paginated)
data DescribeReservedDBInstances Source #
See: newDescribeReservedDBInstances
smart constructor.
Constructors
DescribeReservedDBInstances' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newDescribeReservedDBInstances :: DescribeReservedDBInstances Source #
Create a value of DescribeReservedDBInstances
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:productDescription:DescribeReservedDBInstances'
, describeReservedDBInstances_productDescription
- The product description filter value. Specify this parameter to show
only those reservations matching the specified product description.
$sel:filters:DescribeReservedDBInstances'
, describeReservedDBInstances_filters
- This parameter isn't currently supported.
$sel:leaseId:DescribeReservedDBInstances'
, describeReservedDBInstances_leaseId
- 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.
$sel:reservedDBInstanceId:DescribeReservedDBInstances'
, describeReservedDBInstances_reservedDBInstanceId
- The reserved DB instance identifier filter value. Specify this parameter
to show only the reservation that matches the specified reservation ID.
$sel:dbInstanceClass:DescribeReservedDBInstances'
, describeReservedDBInstances_dbInstanceClass
- The DB instance class filter value. Specify this parameter to show only
those reservations matching the specified DB instances class.
$sel:marker:DescribeReservedDBInstances'
, describeReservedDBInstances_marker
- 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
.
$sel:maxRecords:DescribeReservedDBInstances'
, describeReservedDBInstances_maxRecords
- 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.
$sel:multiAZ:DescribeReservedDBInstances'
, describeReservedDBInstances_multiAZ
- A value that indicates whether to show only those reservations that
support Multi-AZ.
$sel:reservedDBInstancesOfferingId:DescribeReservedDBInstances'
, describeReservedDBInstances_reservedDBInstancesOfferingId
- The offering identifier filter value. Specify this parameter to show
only purchased reservations matching the specified offering identifier.
$sel:offeringType:DescribeReservedDBInstances'
, describeReservedDBInstances_offeringType
- 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"
$sel:duration:DescribeReservedDBInstances'
, describeReservedDBInstances_duration
- 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
data DescribeReservedDBInstancesResponse Source #
Contains the result of a successful invocation of the
DescribeReservedDBInstances
action.
See: newDescribeReservedDBInstancesResponse
smart constructor.
Constructors
DescribeReservedDBInstancesResponse' (Maybe [ReservedDBInstance]) (Maybe Text) Int |
Instances
newDescribeReservedDBInstancesResponse Source #
Arguments
:: Int | |
-> DescribeReservedDBInstancesResponse |
Create a value of DescribeReservedDBInstancesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:reservedDBInstances:DescribeReservedDBInstancesResponse'
, describeReservedDBInstancesResponse_reservedDBInstances
- A list of reserved DB instances.
$sel:marker:DescribeReservedDBInstances'
, describeReservedDBInstancesResponse_marker
- 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
.
$sel:httpStatus:DescribeReservedDBInstancesResponse'
, describeReservedDBInstancesResponse_httpStatus
- The response's http status code.
CopyDBParameterGroup
data CopyDBParameterGroup Source #
See: newCopyDBParameterGroup
smart constructor.
Instances
newCopyDBParameterGroup Source #
Arguments
:: Text | |
-> Text | |
-> Text |
|
-> CopyDBParameterGroup |
Create a value of CopyDBParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CopyDBParameterGroup'
, copyDBParameterGroup_tags
- Undocumented member.
$sel:sourceDBParameterGroupIdentifier:CopyDBParameterGroup'
, copyDBParameterGroup_sourceDBParameterGroupIdentifier
- 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.
$sel:targetDBParameterGroupIdentifier:CopyDBParameterGroup'
, copyDBParameterGroup_targetDBParameterGroupIdentifier
- 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
$sel:targetDBParameterGroupDescription:CopyDBParameterGroup'
, copyDBParameterGroup_targetDBParameterGroupDescription
- A description for the copied DB parameter group.
data CopyDBParameterGroupResponse Source #
See: newCopyDBParameterGroupResponse
smart constructor.
Constructors
CopyDBParameterGroupResponse' (Maybe DBParameterGroup) Int |
Instances
newCopyDBParameterGroupResponse Source #
Create a value of CopyDBParameterGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroup:CopyDBParameterGroupResponse'
, copyDBParameterGroupResponse_dbParameterGroup
- Undocumented member.
$sel:httpStatus:CopyDBParameterGroupResponse'
, copyDBParameterGroupResponse_httpStatus
- The response's http status code.
RemoveSourceIdentifierFromSubscription
data RemoveSourceIdentifierFromSubscription Source #
See: newRemoveSourceIdentifierFromSubscription
smart constructor.
Constructors
RemoveSourceIdentifierFromSubscription' Text Text |
Instances
newRemoveSourceIdentifierFromSubscription Source #
Arguments
:: Text |
|
-> Text |
|
-> RemoveSourceIdentifierFromSubscription |
Create a value of RemoveSourceIdentifierFromSubscription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subscriptionName:RemoveSourceIdentifierFromSubscription'
, removeSourceIdentifierFromSubscription_subscriptionName
- The name of the RDS event notification subscription you want to remove a
source identifier from.
$sel:sourceIdentifier:RemoveSourceIdentifierFromSubscription'
, removeSourceIdentifierFromSubscription_sourceIdentifier
- 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.
data RemoveSourceIdentifierFromSubscriptionResponse Source #
See: newRemoveSourceIdentifierFromSubscriptionResponse
smart constructor.
Instances
newRemoveSourceIdentifierFromSubscriptionResponse Source #
Arguments
:: Int |
|
-> RemoveSourceIdentifierFromSubscriptionResponse |
Create a value of RemoveSourceIdentifierFromSubscriptionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventSubscription:RemoveSourceIdentifierFromSubscriptionResponse'
, removeSourceIdentifierFromSubscriptionResponse_eventSubscription
- Undocumented member.
$sel:httpStatus:RemoveSourceIdentifierFromSubscriptionResponse'
, removeSourceIdentifierFromSubscriptionResponse_httpStatus
- The response's http status code.
DeleteCustomAvailabilityZone
data DeleteCustomAvailabilityZone Source #
See: newDeleteCustomAvailabilityZone
smart constructor.
Constructors
DeleteCustomAvailabilityZone' Text |
Instances
newDeleteCustomAvailabilityZone Source #
Arguments
:: Text | |
-> DeleteCustomAvailabilityZone |
Create a value of DeleteCustomAvailabilityZone
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customAvailabilityZoneId:DeleteCustomAvailabilityZone'
, deleteCustomAvailabilityZone_customAvailabilityZoneId
- The custom AZ identifier.
data DeleteCustomAvailabilityZoneResponse Source #
See: newDeleteCustomAvailabilityZoneResponse
smart constructor.
Constructors
DeleteCustomAvailabilityZoneResponse' (Maybe CustomAvailabilityZone) Int |
Instances
newDeleteCustomAvailabilityZoneResponse Source #
Arguments
:: Int | |
-> DeleteCustomAvailabilityZoneResponse |
Create a value of DeleteCustomAvailabilityZoneResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customAvailabilityZone:DeleteCustomAvailabilityZoneResponse'
, deleteCustomAvailabilityZoneResponse_customAvailabilityZone
- Undocumented member.
$sel:httpStatus:DeleteCustomAvailabilityZoneResponse'
, deleteCustomAvailabilityZoneResponse_httpStatus
- The response's http status code.
DescribeDBProxyTargets (Paginated)
data DescribeDBProxyTargets Source #
See: newDescribeDBProxyTargets
smart constructor.
Instances
newDescribeDBProxyTargets Source #
Create a value of DescribeDBProxyTargets
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeDBProxyTargets'
, describeDBProxyTargets_filters
- This parameter is not currently supported.
$sel:marker:DescribeDBProxyTargets'
, describeDBProxyTargets_marker
- 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
.
$sel:maxRecords:DescribeDBProxyTargets'
, describeDBProxyTargets_maxRecords
- 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.
$sel:targetGroupName:DescribeDBProxyTargets'
, describeDBProxyTargets_targetGroupName
- The identifier of the DBProxyTargetGroup
to describe.
$sel:dbProxyName:DescribeDBProxyTargets'
, describeDBProxyTargets_dbProxyName
- The identifier of the DBProxyTarget
to describe.
data DescribeDBProxyTargetsResponse Source #
See: newDescribeDBProxyTargetsResponse
smart constructor.
Constructors
DescribeDBProxyTargetsResponse' (Maybe [DBProxyTarget]) (Maybe Text) Int |
Instances
newDescribeDBProxyTargetsResponse Source #
Create a value of DescribeDBProxyTargetsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targets:DescribeDBProxyTargetsResponse'
, describeDBProxyTargetsResponse_targets
- An arbitrary number of DBProxyTarget
objects, containing details of
the corresponding targets.
$sel:marker:DescribeDBProxyTargets'
, describeDBProxyTargetsResponse_marker
- 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
.
$sel:httpStatus:DescribeDBProxyTargetsResponse'
, describeDBProxyTargetsResponse_httpStatus
- The response's http status code.
StartDBInstanceAutomatedBackupsReplication
data StartDBInstanceAutomatedBackupsReplication Source #
See: newStartDBInstanceAutomatedBackupsReplication
smart constructor.
Constructors
StartDBInstanceAutomatedBackupsReplication' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) Text |
Instances
newStartDBInstanceAutomatedBackupsReplication Source #
Arguments
:: Text |
|
-> StartDBInstanceAutomatedBackupsReplication |
Create a value of StartDBInstanceAutomatedBackupsReplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:preSignedUrl:StartDBInstanceAutomatedBackupsReplication'
, startDBInstanceAutomatedBackupsReplication_preSignedUrl
- A URL that contains a Signature Version 4 signed request for the
StartDBInstanceAutomatedBackupsReplication action to be called in the
Amazon Web Services Region of the source DB instance. The presigned URL
must be a valid request for the
StartDBInstanceAutomatedBackupsReplication API action that can be
executed in the Amazon Web Services Region that contains the source DB
instance.
$sel:destinationRegion:StartDBInstanceAutomatedBackupsReplication'
, startDBInstanceAutomatedBackupsReplication_destinationRegion
- Pseudo-parameter used when populating the PreSignedUrl
of a
cross-region StartDBInstanceAutomatedBackupsReplication
request. To
replicate from region SRC
to region DST
, send a request to region
DST
. In that request, pass a PreSignedUrl
for region SRC
with
DestinationRegion
set to region DST
.
$sel:kmsKeyId:StartDBInstanceAutomatedBackupsReplication'
, startDBInstanceAutomatedBackupsReplication_kmsKeyId
- 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
.
$sel:backupRetentionPeriod:StartDBInstanceAutomatedBackupsReplication'
, startDBInstanceAutomatedBackupsReplication_backupRetentionPeriod
- The retention period for the replicated automated backups.
$sel:sourceDBInstanceArn:StartDBInstanceAutomatedBackupsReplication'
, startDBInstanceAutomatedBackupsReplication_sourceDBInstanceArn
- 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
.
data StartDBInstanceAutomatedBackupsReplicationResponse Source #
See: newStartDBInstanceAutomatedBackupsReplicationResponse
smart constructor.
Constructors
StartDBInstanceAutomatedBackupsReplicationResponse' (Maybe DBInstanceAutomatedBackup) Int |
Instances
newStartDBInstanceAutomatedBackupsReplicationResponse Source #
Arguments
:: Int |
|
-> StartDBInstanceAutomatedBackupsReplicationResponse |
Create a value of StartDBInstanceAutomatedBackupsReplicationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstanceAutomatedBackup:StartDBInstanceAutomatedBackupsReplicationResponse'
, startDBInstanceAutomatedBackupsReplicationResponse_dbInstanceAutomatedBackup
- Undocumented member.
$sel:httpStatus:StartDBInstanceAutomatedBackupsReplicationResponse'
, startDBInstanceAutomatedBackupsReplicationResponse_httpStatus
- The response's http status code.
DescribeEngineDefaultClusterParameters (Paginated)
data DescribeEngineDefaultClusterParameters Source #
See: newDescribeEngineDefaultClusterParameters
smart constructor.
Instances
newDescribeEngineDefaultClusterParameters Source #
Arguments
:: Text |
|
-> DescribeEngineDefaultClusterParameters |
Create a value of DescribeEngineDefaultClusterParameters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeEngineDefaultClusterParameters'
, describeEngineDefaultClusterParameters_filters
- This parameter isn't currently supported.
$sel:marker:DescribeEngineDefaultClusterParameters'
, describeEngineDefaultClusterParameters_marker
- 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
.
$sel:maxRecords:DescribeEngineDefaultClusterParameters'
, describeEngineDefaultClusterParameters_maxRecords
- 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.
$sel:dbParameterGroupFamily:DescribeEngineDefaultClusterParameters'
, describeEngineDefaultClusterParameters_dbParameterGroupFamily
- The name of the DB cluster parameter group family to return engine
parameter information for.
data DescribeEngineDefaultClusterParametersResponse Source #
See: newDescribeEngineDefaultClusterParametersResponse
smart constructor.
Instances
newDescribeEngineDefaultClusterParametersResponse Source #
Arguments
:: Int |
|
-> DescribeEngineDefaultClusterParametersResponse |
Create a value of DescribeEngineDefaultClusterParametersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineDefaults:DescribeEngineDefaultClusterParametersResponse'
, describeEngineDefaultClusterParametersResponse_engineDefaults
- Undocumented member.
$sel:httpStatus:DescribeEngineDefaultClusterParametersResponse'
, describeEngineDefaultClusterParametersResponse_httpStatus
- The response's http status code.
DescribeDBSnapshotAttributes
data DescribeDBSnapshotAttributes Source #
See: newDescribeDBSnapshotAttributes
smart constructor.
Constructors
DescribeDBSnapshotAttributes' Text |
Instances
newDescribeDBSnapshotAttributes Source #
Arguments
:: Text | |
-> DescribeDBSnapshotAttributes |
Create a value of DescribeDBSnapshotAttributes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSnapshotIdentifier:DescribeDBSnapshotAttributes'
, describeDBSnapshotAttributes_dbSnapshotIdentifier
- The identifier for the DB snapshot to describe the attributes for.
data DescribeDBSnapshotAttributesResponse Source #
See: newDescribeDBSnapshotAttributesResponse
smart constructor.
Instances
newDescribeDBSnapshotAttributesResponse Source #
Arguments
:: Int | |
-> DescribeDBSnapshotAttributesResponse |
Create a value of DescribeDBSnapshotAttributesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSnapshotAttributesResult:DescribeDBSnapshotAttributesResponse'
, describeDBSnapshotAttributesResponse_dbSnapshotAttributesResult
- Undocumented member.
$sel:httpStatus:DescribeDBSnapshotAttributesResponse'
, describeDBSnapshotAttributesResponse_httpStatus
- The response's http status code.
CreateCustomAvailabilityZone
data CreateCustomAvailabilityZone Source #
See: newCreateCustomAvailabilityZone
smart constructor.
Instances
newCreateCustomAvailabilityZone Source #
Arguments
:: Text |
|
-> CreateCustomAvailabilityZone |
Create a value of CreateCustomAvailabilityZone
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:vpnTunnelOriginatorIP:CreateCustomAvailabilityZone'
, createCustomAvailabilityZone_vpnTunnelOriginatorIP
- The IP address of network traffic from your on-premises data center. A
custom AZ receives the network traffic.
Specify this parameter only if ExistingVpnId
isn't specified.
$sel:newVpnTunnelName':CreateCustomAvailabilityZone'
, createCustomAvailabilityZone_newVpnTunnelName
- The name of a new VPN tunnel between the Amazon RDS website and the
VMware vSphere cluster.
Specify this parameter only if ExistingVpnId
isn't specified.
$sel:existingVpnId:CreateCustomAvailabilityZone'
, createCustomAvailabilityZone_existingVpnId
- The ID of an existing virtual private network (VPN) between the Amazon
RDS website and the VMware vSphere cluster.
$sel:customAvailabilityZoneName:CreateCustomAvailabilityZone'
, createCustomAvailabilityZone_customAvailabilityZoneName
- The name of the custom Availability Zone (AZ).
data CreateCustomAvailabilityZoneResponse Source #
See: newCreateCustomAvailabilityZoneResponse
smart constructor.
Constructors
CreateCustomAvailabilityZoneResponse' (Maybe CustomAvailabilityZone) Int |
Instances
newCreateCustomAvailabilityZoneResponse Source #
Arguments
:: Int | |
-> CreateCustomAvailabilityZoneResponse |
Create a value of CreateCustomAvailabilityZoneResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customAvailabilityZone:CreateCustomAvailabilityZoneResponse'
, createCustomAvailabilityZoneResponse_customAvailabilityZone
- Undocumented member.
$sel:httpStatus:CreateCustomAvailabilityZoneResponse'
, createCustomAvailabilityZoneResponse_httpStatus
- The response's http status code.
BacktrackDBCluster
data BacktrackDBCluster Source #
See: newBacktrackDBCluster
smart constructor.
Instances
newBacktrackDBCluster Source #
Arguments
:: Text | |
-> UTCTime | |
-> BacktrackDBCluster |
Create a value of BacktrackDBCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:force:BacktrackDBCluster'
, backtrackDBCluster_force
- A value that indicates whether to force the DB cluster to backtrack when
binary logging is enabled. Otherwise, an error occurs when binary
logging is enabled.
$sel:useEarliestTimeOnPointInTimeUnavailable:BacktrackDBCluster'
, backtrackDBCluster_useEarliestTimeOnPointInTimeUnavailable
- A value that indicates whether to backtrack the DB cluster to the
earliest possible backtrack time when BacktrackTo is set to a
timestamp earlier than the earliest backtrack time. When this parameter
is disabled and BacktrackTo is set to a timestamp earlier than the
earliest backtrack time, an error occurs.
$sel:dbClusterIdentifier:BacktrackDBCluster'
, backtrackDBCluster_dbClusterIdentifier
- 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
$sel:backtrackTo:BacktrackDBCluster'
, backtrackDBCluster_backtrackTo
- 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
data DBClusterBacktrack Source #
This data type is used as a response element in the
DescribeDBClusterBacktracks
action.
See: newDBClusterBacktrack
smart constructor.
Constructors
DBClusterBacktrack' (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe ISO8601) |
Instances
newDBClusterBacktrack :: DBClusterBacktrack Source #
Create a value of DBClusterBacktrack
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DBClusterBacktrack'
, dbClusterBacktrack_status
- 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.
$sel:backtrackIdentifier:DBClusterBacktrack'
, dbClusterBacktrack_backtrackIdentifier
- Contains the backtrack identifier.
$sel:backtrackTo:DBClusterBacktrack'
, dbClusterBacktrack_backtrackTo
- The timestamp of the time to which the DB cluster was backtracked.
$sel:dbClusterIdentifier:DBClusterBacktrack'
, dbClusterBacktrack_dbClusterIdentifier
- Contains a user-supplied DB cluster identifier. This identifier is the
unique key that identifies a DB cluster.
$sel:backtrackedFrom:DBClusterBacktrack'
, dbClusterBacktrack_backtrackedFrom
- The timestamp of the time from which the DB cluster was backtracked.
$sel:backtrackRequestCreationTime:DBClusterBacktrack'
, dbClusterBacktrack_backtrackRequestCreationTime
- The timestamp of the time at which the backtrack was requested.
DeleteGlobalCluster
data DeleteGlobalCluster Source #
See: newDeleteGlobalCluster
smart constructor.
Constructors
DeleteGlobalCluster' Text |
Instances
newDeleteGlobalCluster Source #
Create a value of DeleteGlobalCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalClusterIdentifier:DeleteGlobalCluster'
, deleteGlobalCluster_globalClusterIdentifier
- The cluster identifier of the global database cluster being deleted.
data DeleteGlobalClusterResponse Source #
See: newDeleteGlobalClusterResponse
smart constructor.
Constructors
DeleteGlobalClusterResponse' (Maybe GlobalCluster) Int |
Instances
newDeleteGlobalClusterResponse Source #
Create a value of DeleteGlobalClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalCluster:DeleteGlobalClusterResponse'
, deleteGlobalClusterResponse_globalCluster
- Undocumented member.
$sel:httpStatus:DeleteGlobalClusterResponse'
, deleteGlobalClusterResponse_httpStatus
- The response's http status code.
PromoteReadReplicaDBCluster
data PromoteReadReplicaDBCluster Source #
See: newPromoteReadReplicaDBCluster
smart constructor.
Constructors
PromoteReadReplicaDBCluster' Text |
Instances
newPromoteReadReplicaDBCluster Source #
Create a value of PromoteReadReplicaDBCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterIdentifier:PromoteReadReplicaDBCluster'
, promoteReadReplicaDBCluster_dbClusterIdentifier
- 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
data PromoteReadReplicaDBClusterResponse Source #
See: newPromoteReadReplicaDBClusterResponse
smart constructor.
Constructors
PromoteReadReplicaDBClusterResponse' (Maybe DBCluster) Int |
Instances
newPromoteReadReplicaDBClusterResponse Source #
Arguments
:: Int | |
-> PromoteReadReplicaDBClusterResponse |
Create a value of PromoteReadReplicaDBClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbCluster:PromoteReadReplicaDBClusterResponse'
, promoteReadReplicaDBClusterResponse_dbCluster
- Undocumented member.
$sel:httpStatus:PromoteReadReplicaDBClusterResponse'
, promoteReadReplicaDBClusterResponse_httpStatus
- The response's http status code.
RemoveTagsFromResource
data RemoveTagsFromResource Source #
See: newRemoveTagsFromResource
smart constructor.
Constructors
RemoveTagsFromResource' Text [Text] |
Instances
newRemoveTagsFromResource Source #
Create a value of RemoveTagsFromResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceName:RemoveTagsFromResource'
, removeTagsFromResource_resourceName
- 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.
$sel:tagKeys:RemoveTagsFromResource'
, removeTagsFromResource_tagKeys
- The tag key (name) of the tag to be removed.
data RemoveTagsFromResourceResponse Source #
See: newRemoveTagsFromResourceResponse
smart constructor.
Constructors
RemoveTagsFromResourceResponse' | |
Instances
Eq RemoveTagsFromResourceResponse Source # | |
Defined in Amazonka.RDS.RemoveTagsFromResource | |
Read RemoveTagsFromResourceResponse Source # | |
Show RemoveTagsFromResourceResponse Source # | |
Defined in Amazonka.RDS.RemoveTagsFromResource Methods showsPrec :: Int -> RemoveTagsFromResourceResponse -> ShowS # show :: RemoveTagsFromResourceResponse -> String # showList :: [RemoveTagsFromResourceResponse] -> ShowS # | |
Generic RemoveTagsFromResourceResponse Source # | |
Defined in Amazonka.RDS.RemoveTagsFromResource Associated Types type Rep RemoveTagsFromResourceResponse :: Type -> Type # | |
NFData RemoveTagsFromResourceResponse Source # | |
Defined in Amazonka.RDS.RemoveTagsFromResource Methods rnf :: RemoveTagsFromResourceResponse -> () # | |
type Rep RemoveTagsFromResourceResponse Source # | |
Defined in Amazonka.RDS.RemoveTagsFromResource |
newRemoveTagsFromResourceResponse :: RemoveTagsFromResourceResponse Source #
Create a value of RemoveTagsFromResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
RestoreDBInstanceFromDBSnapshot
data RestoreDBInstanceFromDBSnapshot Source #
See: newRestoreDBInstanceFromDBSnapshot
smart constructor.
Constructors
RestoreDBInstanceFromDBSnapshot' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [ProcessorFeature]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) Text Text |
Instances
newRestoreDBInstanceFromDBSnapshot Source #
Arguments
:: Text | |
-> Text | |
-> RestoreDBInstanceFromDBSnapshot |
Create a value of RestoreDBInstanceFromDBSnapshot
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deletionProtection:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_deletionProtection
- A value that indicates whether the DB instance has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled. For more
information, see
Deleting a DB Instance.
$sel:publiclyAccessible:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_publiclyAccessible
- A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.
$sel:autoMinorVersionUpgrade:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_autoMinorVersionUpgrade
- A value that indicates whether minor version upgrades are applied
automatically to the DB instance during the maintenance window.
$sel:dbSubnetGroupName:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_dbSubnetGroupName
- The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
$sel:iops:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_iops
- Specifies the amount of provisioned IOPS for the DB instance, expressed
in I/O operations per second. If this parameter isn't specified, the
IOPS value is taken from the backup. If this parameter is set to 0, the
new instance is converted to a non-PIOPS instance. The conversion takes
additional time, though your DB instance is available for connections
before the conversion starts.
The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
Constraints: Must be an integer greater than 1000.
$sel:domain:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_domain
- Specify the Active Directory directory ID to restore the DB instance 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.
$sel:enableCustomerOwnedIp:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_enableCustomerOwnedIp
- A value that indicates whether to enable a customer-owned IP address
(CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
$sel:engine:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_engine
- The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
$sel:tdeCredentialPassword:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_tdeCredentialPassword
- The password for the given ARN from the key store in order to access the
device.
$sel:processorFeatures:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_processorFeatures
- The number of CPU cores and the number of threads per core for the DB
instance class of the DB instance.
$sel:dbInstanceClass:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_dbInstanceClass
- 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.
$sel:licenseModel:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_licenseModel
- License model information for the restored DB instance.
Default: Same as source.
Valid values: license-included
| bring-your-own-license
|
general-public-license
$sel:dbParameterGroupName:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_dbParameterGroupName
- 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.
Constraints:
- If supplied, must match the name of an existing DBParameterGroup.
- Must be 1 to 255 letters, numbers, or hyphens.
- First character must be a letter.
- Can't end with a hyphen or contain two consecutive hyphens.
$sel:availabilityZone:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_availabilityZone
- 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
$sel:vpcSecurityGroupIds:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_vpcSecurityGroupIds
- 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.
$sel:multiAZ:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_multiAZ
- A value that indicates whether the DB instance is a Multi-AZ deployment.
Constraint: You can't specify the AvailabilityZone
parameter if the
DB instance is a Multi-AZ deployment.
$sel:optionGroupName:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_optionGroupName
- 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 once it is associated with a DB instance
$sel:copyTagsToSnapshot:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_copyTagsToSnapshot
- A value that indicates whether to copy all tags from the restored DB
instance to snapshots of the DB instance. By default, tags are not
copied.
$sel:tdeCredentialArn:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE
encryption.
$sel:domainIAMRoleName:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the
Directory Service.
$sel:tags:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_tags
- Undocumented member.
$sel:port:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_port
- The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be 1150-65535
$sel:enableIAMDatabaseAuthentication:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services
Identity and Access Management (IAM) accounts to database accounts. By
default, mapping is disabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
$sel:useDefaultProcessorFeatures:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_useDefaultProcessorFeatures
- A value that indicates whether the DB instance class of the DB instance
uses its default processor features.
$sel:storageType:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_storageType
- Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise gp2
$sel:enableCloudwatchLogsExports:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_enableCloudwatchLogsExports
- 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.
$sel:dbName:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_dbName
- The database name for the restored DB instance.
This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.
$sel:dbInstanceIdentifier:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_dbInstanceIdentifier
- 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
$sel:dbSnapshotIdentifier:RestoreDBInstanceFromDBSnapshot'
, restoreDBInstanceFromDBSnapshot_dbSnapshotIdentifier
- The identifier for the DB snapshot to restore from.
Constraints:
- Must match the identifier of an existing DBSnapshot.
- If you are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB snapshot.
data RestoreDBInstanceFromDBSnapshotResponse Source #
See: newRestoreDBInstanceFromDBSnapshotResponse
smart constructor.
Constructors
RestoreDBInstanceFromDBSnapshotResponse' (Maybe DBInstance) Int |
Instances
newRestoreDBInstanceFromDBSnapshotResponse Source #
Arguments
:: Int | |
-> RestoreDBInstanceFromDBSnapshotResponse |
Create a value of RestoreDBInstanceFromDBSnapshotResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstance:RestoreDBInstanceFromDBSnapshotResponse'
, restoreDBInstanceFromDBSnapshotResponse_dbInstance
- Undocumented member.
$sel:httpStatus:RestoreDBInstanceFromDBSnapshotResponse'
, restoreDBInstanceFromDBSnapshotResponse_httpStatus
- The response's http status code.
DeleteDBProxy
data DeleteDBProxy Source #
See: newDeleteDBProxy
smart constructor.
Constructors
DeleteDBProxy' Text |
Instances
Arguments
:: Text | |
-> DeleteDBProxy |
Create a value of DeleteDBProxy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbProxyName:DeleteDBProxy'
, deleteDBProxy_dbProxyName
- The name of the DB proxy to delete.
data DeleteDBProxyResponse Source #
See: newDeleteDBProxyResponse
smart constructor.
Constructors
DeleteDBProxyResponse' (Maybe DBProxy) Int |
Instances
newDeleteDBProxyResponse Source #
Create a value of DeleteDBProxyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbProxy:DeleteDBProxyResponse'
, deleteDBProxyResponse_dbProxy
- The data structure representing the details of the DB proxy that you
delete.
$sel:httpStatus:DeleteDBProxyResponse'
, deleteDBProxyResponse_httpStatus
- The response's http status code.
CreateEventSubscription
data CreateEventSubscription Source #
See: newCreateEventSubscription
smart constructor.
Constructors
CreateEventSubscription' (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe [Tag]) Text Text |
Instances
newCreateEventSubscription Source #
Arguments
:: Text | |
-> Text | |
-> CreateEventSubscription |
Create a value of CreateEventSubscription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:CreateEventSubscription'
, createEventSubscription_enabled
- A value that indicates whether to activate the subscription. If the
event notification subscription isn't activated, the subscription is
created but not active.
$sel:sourceType:CreateEventSubscription'
, createEventSubscription_sourceType
- 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
. 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
$sel:eventCategories:CreateEventSubscription'
, createEventSubscription_eventCategories
- 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
Events
in the Amazon RDS User Guide or by using the DescribeEventCategories
operation.
$sel:sourceIds:CreateEventSubscription'
, createEventSubscription_sourceIds
- 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.
$sel:tags:CreateEventSubscription'
, createEventSubscription_tags
- Undocumented member.
$sel:subscriptionName:CreateEventSubscription'
, createEventSubscription_subscriptionName
- The name of the subscription.
Constraints: The name must be less than 255 characters.
$sel:snsTopicArn:CreateEventSubscription'
, createEventSubscription_snsTopicArn
- 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.
data CreateEventSubscriptionResponse Source #
See: newCreateEventSubscriptionResponse
smart constructor.
Constructors
CreateEventSubscriptionResponse' (Maybe EventSubscription) Int |
Instances
newCreateEventSubscriptionResponse Source #
Create a value of CreateEventSubscriptionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventSubscription:CreateEventSubscriptionResponse'
, createEventSubscriptionResponse_eventSubscription
- Undocumented member.
$sel:httpStatus:CreateEventSubscriptionResponse'
, createEventSubscriptionResponse_httpStatus
- The response's http status code.
PurchaseReservedDBInstancesOffering
data PurchaseReservedDBInstancesOffering Source #
See: newPurchaseReservedDBInstancesOffering
smart constructor.
Instances
newPurchaseReservedDBInstancesOffering Source #
Arguments
:: Text |
|
-> PurchaseReservedDBInstancesOffering |
Create a value of PurchaseReservedDBInstancesOffering
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstanceCount:PurchaseReservedDBInstancesOffering'
, purchaseReservedDBInstancesOffering_dbInstanceCount
- The number of instances to reserve.
Default: 1
$sel:reservedDBInstanceId:PurchaseReservedDBInstancesOffering'
, purchaseReservedDBInstancesOffering_reservedDBInstanceId
- Customer-specified identifier to track this reservation.
Example: myreservationID
$sel:tags:PurchaseReservedDBInstancesOffering'
, purchaseReservedDBInstancesOffering_tags
- Undocumented member.
$sel:reservedDBInstancesOfferingId:PurchaseReservedDBInstancesOffering'
, purchaseReservedDBInstancesOffering_reservedDBInstancesOfferingId
- The ID of the Reserved DB instance offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
data PurchaseReservedDBInstancesOfferingResponse Source #
See: newPurchaseReservedDBInstancesOfferingResponse
smart constructor.
Instances
newPurchaseReservedDBInstancesOfferingResponse Source #
Arguments
:: Int |
|
-> PurchaseReservedDBInstancesOfferingResponse |
Create a value of PurchaseReservedDBInstancesOfferingResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:reservedDBInstance:PurchaseReservedDBInstancesOfferingResponse'
, purchaseReservedDBInstancesOfferingResponse_reservedDBInstance
- Undocumented member.
$sel:httpStatus:PurchaseReservedDBInstancesOfferingResponse'
, purchaseReservedDBInstancesOfferingResponse_httpStatus
- The response's http status code.
CreateDBInstance
data CreateDBInstance Source #
See: newCreateDBInstance
smart constructor.
Constructors
CreateDBInstance' (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe [ProcessorFeature]) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) Text Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> Text | |
-> CreateDBInstance |
Create a value of CreateDBInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:CreateDBInstance'
, createDBInstance_engineVersion
- The version number of the database engine to use.
For a list of valid engine versions, use the DescribeDBEngineVersions
action.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
MariaDB
See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.
Microsoft SQL Server
See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.
MySQL
See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
Oracle
See Oracle Database Engine Release Notes in the Amazon RDS User Guide.
PostgreSQL
See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
$sel:dbSecurityGroups:CreateDBInstance'
, createDBInstance_dbSecurityGroups
- A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
$sel:deletionProtection:CreateDBInstance'
, createDBInstance_deletionProtection
- A value that indicates whether the DB instance has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled. For more
information, see
Deleting a DB Instance.
Amazon Aurora
Not applicable. You can enable or disable deletion protection for the DB
cluster. For more information, see CreateDBCluster
. DB instances in a
DB cluster can be deleted even when deletion protection is enabled for
the DB cluster.
$sel:storageEncrypted:CreateDBInstance'
, createDBInstance_storageEncrypted
- A value that indicates whether the DB instance is encrypted. By default,
it isn't encrypted.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
$sel:dbClusterIdentifier:CreateDBInstance'
, createDBInstance_dbClusterIdentifier
- The identifier of the DB cluster that the instance will belong to.
$sel:masterUserPassword:CreateDBInstance'
, createDBInstance_masterUserPassword
- The password for the master user. The password can include any printable
ASCII character except "/", """, or "@".
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
$sel:publiclyAccessible:CreateDBInstance'
, createDBInstance_publiclyAccessible
- A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.
$sel:autoMinorVersionUpgrade:CreateDBInstance'
, createDBInstance_autoMinorVersionUpgrade
- A value that indicates whether minor engine upgrades are applied
automatically to the DB instance during the maintenance window. By
default, minor engine upgrades are applied automatically.
$sel:masterUsername:CreateDBInstance'
, createDBInstance_masterUsername
- The name for the master user.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster.
MariaDB
Constraints:
- Required for MariaDB.
- Must be 1 to 16 letters or numbers.
- Can't be a reserved word for the chosen database engine.
Microsoft SQL Server
Constraints:
- Required for SQL Server.
- Must be 1 to 128 letters or numbers.
- The first character must be a letter.
- Can't be a reserved word for the chosen database engine.
MySQL
Constraints:
- Required for MySQL.
- 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.
Oracle
Constraints:
- Required for Oracle.
- Must be 1 to 30 letters or numbers.
- First character must be a letter.
- Can't be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
- Required for PostgreSQL.
- Must be 1 to 63 letters or numbers.
- First character must be a letter.
- Can't be a reserved word for the chosen database engine.
$sel:dbSubnetGroupName:CreateDBInstance'
, createDBInstance_dbSubnetGroupName
- A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
$sel:monitoringRoleArn:CreateDBInstance'
, createDBInstance_monitoringRoleArn
- 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
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.
$sel:iops:CreateDBInstance'
, createDBInstance_iops
- The amount of Provisioned IOPS (input/output operations per second) to
be initially allocated for the DB instance. For information about valid
Iops values, see
Amazon RDS Provisioned IOPS Storage to Improve Performance
in the Amazon RDS User Guide.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.
$sel:domain:CreateDBInstance'
, createDBInstance_domain
- 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.
$sel:enableCustomerOwnedIp:CreateDBInstance'
, createDBInstance_enableCustomerOwnedIp
- A value that indicates whether to enable a customer-owned IP address
(CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
$sel:monitoringInterval:CreateDBInstance'
, createDBInstance_monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance. To disable collecting
Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn
is specified, then you must also set
MonitoringInterval
to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
$sel:tdeCredentialPassword:CreateDBInstance'
, createDBInstance_tdeCredentialPassword
- The password for the given ARN from the key store in order to access the
device.
$sel:processorFeatures:CreateDBInstance'
, createDBInstance_processorFeatures
- The number of CPU cores and the number of threads per core for the DB
instance class of the DB instance.
$sel:promotionTier:CreateDBInstance'
, createDBInstance_promotionTier
- A value that specifies the order in which an Aurora Replica is promoted
to the primary instance after a failure of the existing primary
instance. For more information, see
Fault Tolerance for an Aurora DB Cluster
in the Amazon Aurora User Guide.
Default: 1
Valid Values: 0 - 15
$sel:licenseModel:CreateDBInstance'
, createDBInstance_licenseModel
- License model information for this DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
$sel:preferredMaintenanceWindow:CreateDBInstance'
, createDBInstance_preferredMaintenanceWindow
- The time range each week during which system maintenance can occur, in
Universal Coordinated Time (UTC). For more information, see
Amazon RDS Maintenance Window.
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
$sel:performanceInsightsRetentionPeriod:CreateDBInstance'
, createDBInstance_performanceInsightsRetentionPeriod
- The amount of time, in days, to retain Performance Insights data. Valid
values are 7 or 731 (2 years).
$sel:characterSetName:CreateDBInstance'
, createDBInstance_characterSetName
- For supported engines, indicates that the DB instance should be
associated with the specified CharacterSet.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more
information, see CreateDBCluster
.
$sel:maxAllocatedStorage:CreateDBInstance'
, createDBInstance_maxAllocatedStorage
- 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.
$sel:enablePerformanceInsights:CreateDBInstance'
, createDBInstance_enablePerformanceInsights
- A value that indicates whether to enable Performance Insights for the DB
instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
$sel:kmsKeyId:CreateDBInstance'
, createDBInstance_kmsKeyId
- 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 Amazon Web Services KMS customer master key (CMK). To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.
Amazon Aurora
Not applicable. The Amazon Web Services KMS key identifier is managed by
the DB cluster. For more information, see CreateDBCluster
.
If StorageEncrypted
is enabled, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS uses your default CMK. There is a
default CMK for your Amazon Web Services account. Your Amazon Web
Services account has a different default CMK for each Amazon Web
Services Region.
$sel:dbParameterGroupName:CreateDBInstance'
, createDBInstance_dbParameterGroupName
- The name of the DB parameter group to associate with this DB instance.
If you do not specify a value, then the default DB parameter group for
the specified DB engine and version is used.
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
$sel:preferredBackupWindow:CreateDBInstance'
, createDBInstance_preferredBackupWindow
- 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.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
Constraints:
- Must be in the format
hh24:mi-hh24:mi
. - Must be in Universal Coordinated Time (UTC).
- Must not conflict with the preferred maintenance window.
- Must be at least 30 minutes.
$sel:availabilityZone:CreateDBInstance'
, createDBInstance_availabilityZone
- 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.
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.
If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.
For more information about RDS on VMware, see the RDS on VMware User Guide.
$sel:backupRetentionPeriod:CreateDBInstance'
, createDBInstance_backupRetentionPeriod
- The number of days for which automated backups are retained. Setting
this parameter to a positive number enables backups. Setting this
parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
- Must be a value from 0 to 35
- Can't be set to 0 if the DB instance is a source to read replicas
$sel:ncharCharacterSetName:CreateDBInstance'
, createDBInstance_ncharCharacterSetName
- The name of the NCHAR character set for the Oracle DB instance.
$sel:performanceInsightsKMSKeyId:CreateDBInstance'
, createDBInstance_performanceInsightsKMSKeyId
- 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 Amazon Web Services KMS customer master key (CMK).
If you do not specify a value for PerformanceInsightsKMSKeyId
, then
Amazon RDS uses your default CMK. There is a default CMK for your Amazon
Web Services account. Your Amazon Web Services account has a different
default CMK for each Amazon Web Services Region.
$sel:vpcSecurityGroupIds:CreateDBInstance'
, createDBInstance_vpcSecurityGroupIds
- A list of Amazon EC2 VPC security groups to associate with this DB
instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
$sel:multiAZ:CreateDBInstance'
, createDBInstance_multiAZ
- A value that indicates whether the DB instance is a Multi-AZ deployment.
You can't set the AvailabilityZone
parameter if the DB instance is a
Multi-AZ deployment.
$sel:allocatedStorage:CreateDBInstance'
, createDBInstance_allocatedStorage
- The amount of storage in gibibytes (GiB) to allocate for the DB
instance.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
MySQL
Constraints to the amount of storage for each storage type are the following:
- General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
- Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDB
Constraints to the amount of storage for each storage type are the following:
- General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
- Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
- General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
- Magnetic storage (standard): Must be an integer from 5 to 3072.
Oracle
Constraints to the amount of storage for each storage type are the following:
- General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
- Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL Server
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2):
- Enterprise and Standard editions: Must be an integer from 200 to 16384.
- Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1):
- Enterprise and Standard editions: Must be an integer from 200 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 200 to 1024.
- Web and Express editions: Must be an integer from 20 to 1024.
$sel:optionGroupName:CreateDBInstance'
, createDBInstance_optionGroupName
- A value that indicates that the DB instance should be associated with
the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance
$sel:copyTagsToSnapshot:CreateDBInstance'
, createDBInstance_copyTagsToSnapshot
- A value that indicates whether to copy tags from the DB instance to
snapshots of the DB instance. By default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
$sel:timezone:CreateDBInstance'
, createDBInstance_timezone
- The time zone of the DB instance. The time zone parameter is currently
supported only by
Microsoft SQL Server.
$sel:tdeCredentialArn:CreateDBInstance'
, createDBInstance_tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE
encryption.
$sel:domainIAMRoleName:CreateDBInstance'
, createDBInstance_domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the
Directory Service.
$sel:tags:CreateDBInstance'
, createDBInstance_tags
- Tags to assign to the DB instance.
$sel:port:CreateDBInstance'
, createDBInstance_port
- The port number on which the database accepts connections.
MySQL
Default: 3306
Valid values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid values: 1150-65535
SQL Server
Default: 1433
Valid values: 1150-65535
except 1234
, 1434
, 3260
, 3343
,
3389
, 47001
, and 49152-49156
.
Amazon Aurora
Default: 3306
Valid values: 1150-65535
Type: Integer
$sel:enableIAMDatabaseAuthentication:CreateDBInstance'
, createDBInstance_enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services
Identity and Access Management (IAM) accounts to database accounts. By
default, mapping is disabled.
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, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
$sel:storageType:CreateDBInstance'
, createDBInstance_storageType
- Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise gp2
$sel:enableCloudwatchLogsExports:CreateDBInstance'
, createDBInstance_enableCloudwatchLogsExports
- The list of log types that need to be enabled for exporting to
CloudWatch Logs. The values in the list depend on the DB engine being
used. For more information, see
Publishing Database Logs to Amazon CloudWatch Logs
in the Amazon Relational Database Service User Guide.
Amazon Aurora
Not applicable. CloudWatch Logs exports are managed by the DB cluster.
MariaDB
Possible values are audit
, error
, general
, and slowquery
.
Microsoft SQL Server
Possible values are agent
and error
.
MySQL
Possible values are audit
, error
, general
, and slowquery
.
Oracle
Possible values are alert
, audit
, listener
, trace
, and
oemagent
.
PostgreSQL
Possible values are postgresql
and upgrade
.
$sel:dbName:CreateDBInstance'
, createDBInstance_dbName
- The meaning of this parameter differs according to the database engine
you use.
MySQL
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
- Must contain 1 to 64 letters or numbers.
- Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
- Can't be a word reserved by the specified database engine
MariaDB
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
- Must contain 1 to 64 letters or numbers.
- Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
- Can't be a word reserved by the specified database engine
PostgreSQL
The name of the database to create when the DB instance is created. If
this parameter isn't specified, a database named postgres
is created
in the DB instance.
Constraints:
- Must contain 1 to 63 letters, numbers, or underscores.
- Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
- Can't be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify
null
, the default value ORCL
is used. You can't specify the string
NULL, or any other reserved word, for DBName
.
Default: ORCL
Constraints:
- Can't be longer than 8 characters
SQL Server
Not applicable. Must be null.
Amazon Aurora MySQL
The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.
Constraints:
- It must contain 1 to 64 alphanumeric characters.
- It can't be a word reserved by the database engine.
Amazon Aurora PostgreSQL
The name of the database to create when the primary DB instance of the
Aurora PostgreSQL DB cluster is created. If this parameter isn't
specified for an Aurora PostgreSQL DB cluster, a database named
postgres
is created in the DB cluster.
Constraints:
- It must contain 1 to 63 alphanumeric characters.
- It must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0 to 9).
- It can't be a word reserved by the database engine.
$sel:dbInstanceIdentifier:CreateDBInstance'
, createDBInstance_dbInstanceIdentifier
- 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
$sel:dbInstanceClass:CreateDBInstance'
, createDBInstance_dbInstanceClass
- 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.
$sel:engine:CreateDBInstance'
, createDBInstance_engine
- The name of the database engine to be used for this instance.
Not every database engine is available for every Amazon Web Services Region.
Valid Values:
aurora
(for MySQL 5.6-compatible Aurora)aurora-mysql
(for MySQL 5.7-compatible Aurora)aurora-postgresql
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
data CreateDBInstanceResponse Source #
See: newCreateDBInstanceResponse
smart constructor.
Constructors
CreateDBInstanceResponse' (Maybe DBInstance) Int |
Instances
newCreateDBInstanceResponse Source #
Create a value of CreateDBInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstance:CreateDBInstanceResponse'
, createDBInstanceResponse_dbInstance
- Undocumented member.
$sel:httpStatus:CreateDBInstanceResponse'
, createDBInstanceResponse_httpStatus
- The response's http status code.
DeleteDBClusterParameterGroup
data DeleteDBClusterParameterGroup Source #
See: newDeleteDBClusterParameterGroup
smart constructor.
Constructors
DeleteDBClusterParameterGroup' Text |
Instances
newDeleteDBClusterParameterGroup Source #
Arguments
:: Text |
|
-> DeleteDBClusterParameterGroup |
Create a value of DeleteDBClusterParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterParameterGroupName:DeleteDBClusterParameterGroup'
, deleteDBClusterParameterGroup_dbClusterParameterGroupName
- 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.
data DeleteDBClusterParameterGroupResponse Source #
See: newDeleteDBClusterParameterGroupResponse
smart constructor.
Constructors
DeleteDBClusterParameterGroupResponse' | |
Instances
newDeleteDBClusterParameterGroupResponse :: DeleteDBClusterParameterGroupResponse Source #
Create a value of DeleteDBClusterParameterGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeCertificates (Paginated)
data DescribeCertificates Source #
See: newDescribeCertificates
smart constructor.
Instances
newDescribeCertificates :: DescribeCertificates Source #
Create a value of DescribeCertificates
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeCertificates'
, describeCertificates_filters
- This parameter isn't currently supported.
$sel:certificateIdentifier:DescribeCertificates'
, describeCertificates_certificateIdentifier
- 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.
$sel:marker:DescribeCertificates'
, describeCertificates_marker
- 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
.
$sel:maxRecords:DescribeCertificates'
, describeCertificates_maxRecords
- 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.
data DescribeCertificatesResponse Source #
Data returned by the DescribeCertificates action.
See: newDescribeCertificatesResponse
smart constructor.
Constructors
DescribeCertificatesResponse' (Maybe [Certificate]) (Maybe Text) Int |
Instances
newDescribeCertificatesResponse Source #
Create a value of DescribeCertificatesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:certificates:DescribeCertificatesResponse'
, describeCertificatesResponse_certificates
- The list of Certificate
objects for the Amazon Web Services account.
$sel:marker:DescribeCertificates'
, describeCertificatesResponse_marker
- 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
.
$sel:httpStatus:DescribeCertificatesResponse'
, describeCertificatesResponse_httpStatus
- The response's http status code.
AuthorizeDBSecurityGroupIngress
data AuthorizeDBSecurityGroupIngress Source #
See: newAuthorizeDBSecurityGroupIngress
smart constructor.
Constructors
AuthorizeDBSecurityGroupIngress' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text |
Instances
newAuthorizeDBSecurityGroupIngress Source #
Arguments
:: Text | |
-> AuthorizeDBSecurityGroupIngress |
Create a value of AuthorizeDBSecurityGroupIngress
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eC2SecurityGroupOwnerId:AuthorizeDBSecurityGroupIngress'
, authorizeDBSecurityGroupIngress_eC2SecurityGroupOwnerId
- 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.
$sel:eC2SecurityGroupName:AuthorizeDBSecurityGroupIngress'
, authorizeDBSecurityGroupIngress_eC2SecurityGroupName
- 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.
$sel:cidrip:AuthorizeDBSecurityGroupIngress'
, authorizeDBSecurityGroupIngress_cidrip
- The IP range to authorize.
$sel:eC2SecurityGroupId:AuthorizeDBSecurityGroupIngress'
, authorizeDBSecurityGroupIngress_eC2SecurityGroupId
- 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.
$sel:dbSecurityGroupName:AuthorizeDBSecurityGroupIngress'
, authorizeDBSecurityGroupIngress_dbSecurityGroupName
- The name of the DB security group to add authorization to.
data AuthorizeDBSecurityGroupIngressResponse Source #
See: newAuthorizeDBSecurityGroupIngressResponse
smart constructor.
Constructors
AuthorizeDBSecurityGroupIngressResponse' (Maybe DBSecurityGroup) Int |
Instances
newAuthorizeDBSecurityGroupIngressResponse Source #
Arguments
:: Int | |
-> AuthorizeDBSecurityGroupIngressResponse |
Create a value of AuthorizeDBSecurityGroupIngressResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSecurityGroup:AuthorizeDBSecurityGroupIngressResponse'
, authorizeDBSecurityGroupIngressResponse_dbSecurityGroup
- Undocumented member.
$sel:httpStatus:AuthorizeDBSecurityGroupIngressResponse'
, authorizeDBSecurityGroupIngressResponse_httpStatus
- The response's http status code.
RemoveRoleFromDBInstance
data RemoveRoleFromDBInstance Source #
See: newRemoveRoleFromDBInstance
smart constructor.
Constructors
RemoveRoleFromDBInstance' Text Text Text |
Instances
newRemoveRoleFromDBInstance Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> RemoveRoleFromDBInstance |
Create a value of RemoveRoleFromDBInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstanceIdentifier:RemoveRoleFromDBInstance'
, removeRoleFromDBInstance_dbInstanceIdentifier
- The name of the DB instance to disassociate the IAM role from.
$sel:roleArn:RemoveRoleFromDBInstance'
, removeRoleFromDBInstance_roleArn
- The Amazon Resource Name (ARN) of the IAM role to disassociate from the
DB instance, for example, arn:aws:iam::123456789012:role/AccessRole
.
$sel:featureName:RemoveRoleFromDBInstance'
, removeRoleFromDBInstance_featureName
- The name of the feature for the DB instance that the IAM role is to be
disassociated from. For the list of supported feature names, see
DBEngineVersion
.
data RemoveRoleFromDBInstanceResponse Source #
See: newRemoveRoleFromDBInstanceResponse
smart constructor.
Constructors
RemoveRoleFromDBInstanceResponse' | |
Instances
Eq RemoveRoleFromDBInstanceResponse Source # | |
Read RemoveRoleFromDBInstanceResponse Source # | |
Show RemoveRoleFromDBInstanceResponse Source # | |
Defined in Amazonka.RDS.RemoveRoleFromDBInstance Methods showsPrec :: Int -> RemoveRoleFromDBInstanceResponse -> ShowS # | |
Generic RemoveRoleFromDBInstanceResponse Source # | |
Defined in Amazonka.RDS.RemoveRoleFromDBInstance Associated Types type Rep RemoveRoleFromDBInstanceResponse :: Type -> Type # | |
NFData RemoveRoleFromDBInstanceResponse Source # | |
Defined in Amazonka.RDS.RemoveRoleFromDBInstance Methods rnf :: RemoveRoleFromDBInstanceResponse -> () # | |
type Rep RemoveRoleFromDBInstanceResponse Source # | |
Defined in Amazonka.RDS.RemoveRoleFromDBInstance |
newRemoveRoleFromDBInstanceResponse :: RemoveRoleFromDBInstanceResponse Source #
Create a value of RemoveRoleFromDBInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeSourceRegions (Paginated)
data DescribeSourceRegions Source #
See: newDescribeSourceRegions
smart constructor.
Instances
newDescribeSourceRegions :: DescribeSourceRegions Source #
Create a value of DescribeSourceRegions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:regionName:DescribeSourceRegions'
, describeSourceRegions_regionName
- The source Amazon Web Services Region name. For example, us-east-1
.
Constraints:
- Must specify a valid Amazon Web Services Region name.
$sel:filters:DescribeSourceRegions'
, describeSourceRegions_filters
- This parameter isn't currently supported.
$sel:marker:DescribeSourceRegions'
, describeSourceRegions_marker
- 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
.
$sel:maxRecords:DescribeSourceRegions'
, describeSourceRegions_maxRecords
- 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.
data DescribeSourceRegionsResponse Source #
Contains the result of a successful invocation of the
DescribeSourceRegions
action.
See: newDescribeSourceRegionsResponse
smart constructor.
Constructors
DescribeSourceRegionsResponse' (Maybe Text) (Maybe [SourceRegion]) Int |
Instances
newDescribeSourceRegionsResponse Source #
Create a value of DescribeSourceRegionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeSourceRegions'
, describeSourceRegionsResponse_marker
- 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
.
$sel:sourceRegions:DescribeSourceRegionsResponse'
, describeSourceRegionsResponse_sourceRegions
- 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.
$sel:httpStatus:DescribeSourceRegionsResponse'
, describeSourceRegionsResponse_httpStatus
- The response's http status code.
CreateDBClusterEndpoint
data CreateDBClusterEndpoint Source #
See: newCreateDBClusterEndpoint
smart constructor.
Instances
newCreateDBClusterEndpoint Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> CreateDBClusterEndpoint |
Create a value of CreateDBClusterEndpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:staticMembers:CreateDBClusterEndpoint'
, createDBClusterEndpoint_staticMembers
- List of DB instance identifiers that are part of the custom endpoint
group.
$sel:excludedMembers:CreateDBClusterEndpoint'
, createDBClusterEndpoint_excludedMembers
- 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.
$sel:tags:CreateDBClusterEndpoint'
, createDBClusterEndpoint_tags
- The tags to be assigned to the Amazon RDS resource.
$sel:dbClusterIdentifier:CreateDBClusterEndpoint'
, createDBClusterEndpoint_dbClusterIdentifier
- The DB cluster identifier of the DB cluster associated with the
endpoint. This parameter is stored as a lowercase string.
$sel:dbClusterEndpointIdentifier:CreateDBClusterEndpoint'
, createDBClusterEndpoint_dbClusterEndpointIdentifier
- The identifier to use for the new endpoint. This parameter is stored as
a lowercase string.
$sel:endpointType:CreateDBClusterEndpoint'
, createDBClusterEndpoint_endpointType
- The type of the endpoint. One of: READER
, WRITER
, ANY
.
data DBClusterEndpoint Source #
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
.
See: newDBClusterEndpoint
smart constructor.
Constructors
DBClusterEndpoint' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) |
Instances
newDBClusterEndpoint :: DBClusterEndpoint Source #
Create a value of DBClusterEndpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DBClusterEndpoint'
, dbClusterEndpoint_status
- 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.
$sel:dbClusterIdentifier:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterIdentifier
- The DB cluster identifier of the DB cluster associated with the
endpoint. This parameter is stored as a lowercase string.
$sel:dbClusterEndpointArn:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterEndpointArn
- The Amazon Resource Name (ARN) for the endpoint.
$sel:customEndpointType:DBClusterEndpoint'
, dbClusterEndpoint_customEndpointType
- The type associated with a custom endpoint. One of: READER
, WRITER
,
ANY
.
$sel:staticMembers:DBClusterEndpoint'
, dbClusterEndpoint_staticMembers
- List of DB instance identifiers that are part of the custom endpoint
group.
$sel:endpointType:DBClusterEndpoint'
, dbClusterEndpoint_endpointType
- The type of the endpoint. One of: READER
, WRITER
, CUSTOM
.
$sel:dbClusterEndpointIdentifier:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterEndpointIdentifier
- The identifier associated with the endpoint. This parameter is stored as
a lowercase string.
$sel:endpoint:DBClusterEndpoint'
, dbClusterEndpoint_endpoint
- The DNS address of the endpoint.
$sel:dbClusterEndpointResourceIdentifier:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterEndpointResourceIdentifier
- A unique system-generated identifier for an endpoint. It remains the
same for the whole life of the endpoint.
$sel:excludedMembers:DBClusterEndpoint'
, dbClusterEndpoint_excludedMembers
- 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.
RestoreDBClusterFromSnapshot
data RestoreDBClusterFromSnapshot Source #
See: newRestoreDBClusterFromSnapshot
smart constructor.
Constructors
RestoreDBClusterFromSnapshot' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ScalingConfiguration) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe [Text]) Text Text Text |
Instances
newRestoreDBClusterFromSnapshot Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> RestoreDBClusterFromSnapshot |
Create a value of RestoreDBClusterFromSnapshot
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_engineVersion
- The version of the database engine to use for the new DB cluster.
To list all of the available engine versions for aurora
(for MySQL
5.6-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for
MySQL 5.7-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
,
use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
If you aren't using the default engine version, then you must specify the engine version.
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
Aurora PostgreSQL
Example: 9.6.3
, 10.7
$sel:deletionProtection:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_deletionProtection
- A value that indicates whether the DB cluster has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled.
$sel:dbSubnetGroupName:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_dbSubnetGroupName
- 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: mySubnetgroup
$sel:domain:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_domain
- Specify the Active Directory directory ID to restore the DB cluster in.
The domain must be created prior to this operation. Currently, only
MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be
created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
$sel:backtrackWindow:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_backtrackWindow
- 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).
$sel:availabilityZones:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_availabilityZones
- Provides the list of Availability Zones (AZs) where instances in the
restored DB cluster can be created.
$sel:kmsKeyId:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_kmsKeyId
- 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 Amazon Web Services KMS customer master key (CMK). To use a CMK 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 Amazon Web Services KMS CMK 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.
$sel:vpcSecurityGroupIds:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_vpcSecurityGroupIds
- A list of VPC security groups that the new DB cluster will belong to.
$sel:databaseName:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_databaseName
- The database name for the restored DB cluster.
$sel:dbClusterParameterGroupName:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_dbClusterParameterGroupName
- 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.
$sel:engineMode:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_engineMode
- The DB engine mode of the DB cluster, either provisioned
,
serverless
, parallelquery
, global
, or multimaster
.
For more information, see CreateDBCluster.
$sel:scalingConfiguration:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_scalingConfiguration
- For DB clusters in serverless
DB engine mode, the scaling properties
of the DB cluster.
$sel:optionGroupName:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_optionGroupName
- The name of the option group to use for the restored DB cluster.
$sel:copyTagsToSnapshot:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_copyTagsToSnapshot
- A value that indicates whether to copy all tags from the restored DB
cluster to snapshots of the restored DB cluster. The default is not to
copy them.
$sel:domainIAMRoleName:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the
Directory Service.
$sel:tags:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_tags
- The tags to be assigned to the restored DB cluster.
$sel:port:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_port
- 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.
$sel:enableIAMDatabaseAuthentication:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services
Identity and Access Management (IAM) accounts to database accounts. By
default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
$sel:enableCloudwatchLogsExports:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_enableCloudwatchLogsExports
- 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. For more information, see
Publishing Database Logs to Amazon CloudWatch Logs
in the Amazon Aurora User Guide.
$sel:dbClusterIdentifier:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_dbClusterIdentifier
- 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
$sel:snapshotIdentifier:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_snapshotIdentifier
- 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.
$sel:engine:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_engine
- 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
data RestoreDBClusterFromSnapshotResponse Source #
See: newRestoreDBClusterFromSnapshotResponse
smart constructor.
Constructors
RestoreDBClusterFromSnapshotResponse' (Maybe DBCluster) Int |
Instances
newRestoreDBClusterFromSnapshotResponse Source #
Arguments
:: Int | |
-> RestoreDBClusterFromSnapshotResponse |
Create a value of RestoreDBClusterFromSnapshotResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbCluster:RestoreDBClusterFromSnapshotResponse'
, restoreDBClusterFromSnapshotResponse_dbCluster
- Undocumented member.
$sel:httpStatus:RestoreDBClusterFromSnapshotResponse'
, restoreDBClusterFromSnapshotResponse_httpStatus
- The response's http status code.
DescribeOrderableDBInstanceOptions (Paginated)
data DescribeOrderableDBInstanceOptions Source #
See: newDescribeOrderableDBInstanceOptions
smart constructor.
Constructors
DescribeOrderableDBInstanceOptions' (Maybe Text) (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) Text |
Instances
newDescribeOrderableDBInstanceOptions Source #
Arguments
:: Text | |
-> DescribeOrderableDBInstanceOptions |
Create a value of DescribeOrderableDBInstanceOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptions_engineVersion
- The engine version filter value. Specify this parameter to show only the
available offerings matching the specified engine version.
$sel:availabilityZoneGroup:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptions_availabilityZoneGroup
- The Availability Zone group associated with a Local Zone. Specify this
parameter to retrieve available offerings for the Local Zones in the
group.
Omit this parameter to show the available offerings in the specified Amazon Web Services Region.
$sel:filters:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptions_filters
- This parameter isn't currently supported.
$sel:dbInstanceClass:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptions_dbInstanceClass
- The DB instance class filter value. Specify this parameter to show only
the available offerings matching the specified DB instance class.
$sel:licenseModel:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptions_licenseModel
- The license model filter value. Specify this parameter to show only the
available offerings matching the specified license model.
$sel:marker:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptions_marker
- 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
.
$sel:maxRecords:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptions_maxRecords
- 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.
$sel:vpc:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptions_vpc
- A value that indicates whether to show only VPC or non-VPC offerings.
$sel:engine:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptions_engine
- The name of the engine to retrieve DB instance options for.
Valid Values:
aurora
(for MySQL 5.6-compatible Aurora)aurora-mysql
(for MySQL 5.7-compatible Aurora)aurora-postgresql
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
data DescribeOrderableDBInstanceOptionsResponse Source #
Contains the result of a successful invocation of the
DescribeOrderableDBInstanceOptions
action.
See: newDescribeOrderableDBInstanceOptionsResponse
smart constructor.
Constructors
DescribeOrderableDBInstanceOptionsResponse' (Maybe [OrderableDBInstanceOption]) (Maybe Text) Int |
Instances
newDescribeOrderableDBInstanceOptionsResponse Source #
Arguments
:: Int | |
-> DescribeOrderableDBInstanceOptionsResponse |
Create a value of DescribeOrderableDBInstanceOptionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:orderableDBInstanceOptions:DescribeOrderableDBInstanceOptionsResponse'
, describeOrderableDBInstanceOptionsResponse_orderableDBInstanceOptions
- An OrderableDBInstanceOption
structure containing information about
orderable options for the DB instance.
$sel:marker:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptionsResponse_marker
- 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
.
$sel:httpStatus:DescribeOrderableDBInstanceOptionsResponse'
, describeOrderableDBInstanceOptionsResponse_httpStatus
- The response's http status code.
DeleteDBClusterEndpoint
data DeleteDBClusterEndpoint Source #
See: newDeleteDBClusterEndpoint
smart constructor.
Constructors
DeleteDBClusterEndpoint' Text |
Instances
newDeleteDBClusterEndpoint Source #
Create a value of DeleteDBClusterEndpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterEndpointIdentifier:DeleteDBClusterEndpoint'
, deleteDBClusterEndpoint_dbClusterEndpointIdentifier
- The identifier associated with the custom endpoint. This parameter is
stored as a lowercase string.
data DBClusterEndpoint Source #
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
.
See: newDBClusterEndpoint
smart constructor.
Constructors
DBClusterEndpoint' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) |
Instances
newDBClusterEndpoint :: DBClusterEndpoint Source #
Create a value of DBClusterEndpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DBClusterEndpoint'
, dbClusterEndpoint_status
- 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.
$sel:dbClusterIdentifier:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterIdentifier
- The DB cluster identifier of the DB cluster associated with the
endpoint. This parameter is stored as a lowercase string.
$sel:dbClusterEndpointArn:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterEndpointArn
- The Amazon Resource Name (ARN) for the endpoint.
$sel:customEndpointType:DBClusterEndpoint'
, dbClusterEndpoint_customEndpointType
- The type associated with a custom endpoint. One of: READER
, WRITER
,
ANY
.
$sel:staticMembers:DBClusterEndpoint'
, dbClusterEndpoint_staticMembers
- List of DB instance identifiers that are part of the custom endpoint
group.
$sel:endpointType:DBClusterEndpoint'
, dbClusterEndpoint_endpointType
- The type of the endpoint. One of: READER
, WRITER
, CUSTOM
.
$sel:dbClusterEndpointIdentifier:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterEndpointIdentifier
- The identifier associated with the endpoint. This parameter is stored as
a lowercase string.
$sel:endpoint:DBClusterEndpoint'
, dbClusterEndpoint_endpoint
- The DNS address of the endpoint.
$sel:dbClusterEndpointResourceIdentifier:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterEndpointResourceIdentifier
- A unique system-generated identifier for an endpoint. It remains the
same for the whole life of the endpoint.
$sel:excludedMembers:DBClusterEndpoint'
, dbClusterEndpoint_excludedMembers
- 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.
CreateDBProxy
data CreateDBProxy Source #
See: newCreateDBProxy
smart constructor.
Constructors
CreateDBProxy' (Maybe Bool) (Maybe Bool) (Maybe Int) (Maybe [Text]) (Maybe [Tag]) Text EngineFamily [UserAuthConfig] Text [Text] |
Instances
Arguments
:: Text | |
-> EngineFamily | |
-> Text | |
-> CreateDBProxy |
Create a value of CreateDBProxy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:debugLogging:CreateDBProxy'
, createDBProxy_debugLogging
- 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.
$sel:requireTLS:CreateDBProxy'
, createDBProxy_requireTLS
- A Boolean parameter that specifies whether Transport Layer Security
(TLS) encryption is required for connections to the proxy. By enabling
this setting, you can enforce encrypted TLS connections to the proxy.
$sel:idleClientTimeout:CreateDBProxy'
, createDBProxy_idleClientTimeout
- 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.
$sel:vpcSecurityGroupIds:CreateDBProxy'
, createDBProxy_vpcSecurityGroupIds
- One or more VPC security group IDs to associate with the new proxy.
$sel:tags:CreateDBProxy'
, createDBProxy_tags
- An optional set of key-value pairs to associate arbitrary data of your
choosing with the proxy.
$sel:dbProxyName:CreateDBProxy'
, createDBProxy_dbProxyName
- 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.
$sel:engineFamily:CreateDBProxy'
, createDBProxy_engineFamily
- 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. The engine family
applies to MySQL and PostgreSQL for both RDS and Aurora.
$sel:auth:CreateDBProxy'
, createDBProxy_auth
- The authorization mechanism that the proxy uses.
$sel:roleArn:CreateDBProxy'
, createDBProxy_roleArn
- The Amazon Resource Name (ARN) of the IAM role that the proxy uses to
access secrets in Amazon Web Services Secrets Manager.
$sel:vpcSubnetIds:CreateDBProxy'
, createDBProxy_vpcSubnetIds
- One or more VPC subnet IDs to associate with the new proxy.
data CreateDBProxyResponse Source #
See: newCreateDBProxyResponse
smart constructor.
Constructors
CreateDBProxyResponse' (Maybe DBProxy) Int |
Instances
newCreateDBProxyResponse Source #
Create a value of CreateDBProxyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbProxy:CreateDBProxyResponse'
, createDBProxyResponse_dbProxy
- The DBProxy
structure corresponding to the new proxy.
$sel:httpStatus:CreateDBProxyResponse'
, createDBProxyResponse_httpStatus
- The response's http status code.
DeleteDBInstanceAutomatedBackup
data DeleteDBInstanceAutomatedBackup Source #
Parameter input for the DeleteDBInstanceAutomatedBackup
operation.
See: newDeleteDBInstanceAutomatedBackup
smart constructor.
Constructors
DeleteDBInstanceAutomatedBackup' (Maybe Text) (Maybe Text) |
Instances
newDeleteDBInstanceAutomatedBackup :: DeleteDBInstanceAutomatedBackup Source #
Create a value of DeleteDBInstanceAutomatedBackup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbiResourceId:DeleteDBInstanceAutomatedBackup'
, deleteDBInstanceAutomatedBackup_dbiResourceId
- The identifier for the source DB instance, which can't be changed and
which is unique to an Amazon Web Services Region.
$sel:dbInstanceAutomatedBackupsArn:DeleteDBInstanceAutomatedBackup'
, deleteDBInstanceAutomatedBackup_dbInstanceAutomatedBackupsArn
- The Amazon Resource Name (ARN) of the automated backups to delete, for
example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
data DeleteDBInstanceAutomatedBackupResponse Source #
See: newDeleteDBInstanceAutomatedBackupResponse
smart constructor.
Instances
newDeleteDBInstanceAutomatedBackupResponse Source #
Arguments
:: Int | |
-> DeleteDBInstanceAutomatedBackupResponse |
Create a value of DeleteDBInstanceAutomatedBackupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstanceAutomatedBackup:DeleteDBInstanceAutomatedBackupResponse'
, deleteDBInstanceAutomatedBackupResponse_dbInstanceAutomatedBackup
- Undocumented member.
$sel:httpStatus:DeleteDBInstanceAutomatedBackupResponse'
, deleteDBInstanceAutomatedBackupResponse_httpStatus
- The response's http status code.
CreateDBClusterParameterGroup
data CreateDBClusterParameterGroup Source #
See: newCreateDBClusterParameterGroup
smart constructor.
Instances
newCreateDBClusterParameterGroup Source #
Arguments
:: Text |
|
-> Text | |
-> Text | |
-> CreateDBClusterParameterGroup |
Create a value of CreateDBClusterParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateDBClusterParameterGroup'
, createDBClusterParameterGroup_tags
- Tags to assign to the DB cluster parameter group.
$sel:dbClusterParameterGroupName:CreateDBClusterParameterGroup'
, createDBClusterParameterGroup_dbClusterParameterGroupName
- The name of the DB cluster parameter group.
Constraints:
- Must match the name of an existing DB cluster parameter group.
This value is stored as a lowercase string.
$sel:dbParameterGroupFamily:CreateDBClusterParameterGroup'
, createDBClusterParameterGroup_dbParameterGroupFamily
- The DB cluster parameter group family name. A DB cluster parameter group
can be associated with one and only one DB cluster parameter group
family, and can be applied only to a DB cluster running a database
engine and engine version compatible with that DB cluster parameter
group family.
Aurora MySQL
Example: aurora5.6
, aurora-mysql5.7
Aurora PostgreSQL
Example: aurora-postgresql9.6
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql
The output contains duplicates.
The following are the valid DB engine values:
aurora
(for MySQL 5.6-compatible Aurora)aurora-mysql
(for MySQL 5.7-compatible Aurora)aurora-postgresql
$sel:description:CreateDBClusterParameterGroup'
, createDBClusterParameterGroup_description
- The description for the DB cluster parameter group.
data CreateDBClusterParameterGroupResponse Source #
See: newCreateDBClusterParameterGroupResponse
smart constructor.
Instances
newCreateDBClusterParameterGroupResponse Source #
Arguments
:: Int | |
-> CreateDBClusterParameterGroupResponse |
Create a value of CreateDBClusterParameterGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterParameterGroup:CreateDBClusterParameterGroupResponse'
, createDBClusterParameterGroupResponse_dbClusterParameterGroup
- Undocumented member.
$sel:httpStatus:CreateDBClusterParameterGroupResponse'
, createDBClusterParameterGroupResponse_httpStatus
- The response's http status code.
CreateDBSnapshot
data CreateDBSnapshot Source #
See: newCreateDBSnapshot
smart constructor.
Constructors
CreateDBSnapshot' (Maybe [Tag]) Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> CreateDBSnapshot |
Create a value of CreateDBSnapshot
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateDBSnapshot'
, createDBSnapshot_tags
- Undocumented member.
$sel:dbSnapshotIdentifier:CreateDBSnapshot'
, createDBSnapshot_dbSnapshotIdentifier
- 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
$sel:dbInstanceIdentifier:CreateDBSnapshot'
, createDBSnapshot_dbInstanceIdentifier
- The identifier of the DB instance that you want to create the snapshot
of.
Constraints:
- Must match the identifier of an existing DBInstance.
data CreateDBSnapshotResponse Source #
See: newCreateDBSnapshotResponse
smart constructor.
Constructors
CreateDBSnapshotResponse' (Maybe DBSnapshot) Int |
Instances
newCreateDBSnapshotResponse Source #
Create a value of CreateDBSnapshotResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSnapshot:CreateDBSnapshotResponse'
, createDBSnapshotResponse_dbSnapshot
- Undocumented member.
$sel:httpStatus:CreateDBSnapshotResponse'
, createDBSnapshotResponse_httpStatus
- The response's http status code.
DeleteEventSubscription
data DeleteEventSubscription Source #
See: newDeleteEventSubscription
smart constructor.
Constructors
DeleteEventSubscription' Text |
Instances
newDeleteEventSubscription Source #
Create a value of DeleteEventSubscription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subscriptionName:DeleteEventSubscription'
, deleteEventSubscription_subscriptionName
- The name of the RDS event notification subscription you want to delete.
data DeleteEventSubscriptionResponse Source #
See: newDeleteEventSubscriptionResponse
smart constructor.
Constructors
DeleteEventSubscriptionResponse' (Maybe EventSubscription) Int |
Instances
newDeleteEventSubscriptionResponse Source #
Create a value of DeleteEventSubscriptionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventSubscription:DeleteEventSubscriptionResponse'
, deleteEventSubscriptionResponse_eventSubscription
- Undocumented member.
$sel:httpStatus:DeleteEventSubscriptionResponse'
, deleteEventSubscriptionResponse_httpStatus
- The response's http status code.
DescribeDBClusterBacktracks (Paginated)
data DescribeDBClusterBacktracks Source #
See: newDescribeDBClusterBacktracks
smart constructor.
Constructors
DescribeDBClusterBacktracks' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Int) Text |
Instances
newDescribeDBClusterBacktracks Source #
Create a value of DescribeDBClusterBacktracks
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backtrackIdentifier:DescribeDBClusterBacktracks'
, describeDBClusterBacktracks_backtrackIdentifier
- If specified, this value is the backtrack identifier of the backtrack to
be described.
Constraints:
- Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see A Universally Unique Identifier (UUID) URN Namespace.
Example: 123e4567-e89b-12d3-a456-426655440000
$sel:filters:DescribeDBClusterBacktracks'
, describeDBClusterBacktracks_filters
- 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.
$sel:marker:DescribeDBClusterBacktracks'
, describeDBClusterBacktracks_marker
- 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
.
$sel:maxRecords:DescribeDBClusterBacktracks'
, describeDBClusterBacktracks_maxRecords
- 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.
$sel:dbClusterIdentifier:DescribeDBClusterBacktracks'
, describeDBClusterBacktracks_dbClusterIdentifier
- 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
data DescribeDBClusterBacktracksResponse Source #
Contains the result of a successful invocation of the
DescribeDBClusterBacktracks
action.
See: newDescribeDBClusterBacktracksResponse
smart constructor.
Constructors
DescribeDBClusterBacktracksResponse' (Maybe Text) (Maybe [DBClusterBacktrack]) Int |
Instances
newDescribeDBClusterBacktracksResponse Source #
Arguments
:: Int | |
-> DescribeDBClusterBacktracksResponse |
Create a value of DescribeDBClusterBacktracksResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeDBClusterBacktracks'
, describeDBClusterBacktracksResponse_marker
- A pagination token that can be used in a later
DescribeDBClusterBacktracks
request.
$sel:dbClusterBacktracks:DescribeDBClusterBacktracksResponse'
, describeDBClusterBacktracksResponse_dbClusterBacktracks
- Contains a list of backtracks for the user.
$sel:httpStatus:DescribeDBClusterBacktracksResponse'
, describeDBClusterBacktracksResponse_httpStatus
- The response's http status code.
DescribeDBParameterGroups (Paginated)
data DescribeDBParameterGroups Source #
See: newDescribeDBParameterGroups
smart constructor.
Instances
newDescribeDBParameterGroups :: DescribeDBParameterGroups Source #
Create a value of DescribeDBParameterGroups
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeDBParameterGroups'
, describeDBParameterGroups_filters
- This parameter isn't currently supported.
$sel:dbParameterGroupName:DescribeDBParameterGroups'
, describeDBParameterGroups_dbParameterGroupName
- The name of a specific DB parameter group to return details for.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.
$sel:marker:DescribeDBParameterGroups'
, describeDBParameterGroups_marker
- 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
.
$sel:maxRecords:DescribeDBParameterGroups'
, describeDBParameterGroups_maxRecords
- 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.
data DescribeDBParameterGroupsResponse Source #
Contains the result of a successful invocation of the
DescribeDBParameterGroups
action.
See: newDescribeDBParameterGroupsResponse
smart constructor.
Constructors
DescribeDBParameterGroupsResponse' (Maybe Text) (Maybe [DBParameterGroup]) Int |
Instances
newDescribeDBParameterGroupsResponse Source #
Arguments
:: Int | |
-> DescribeDBParameterGroupsResponse |
Create a value of DescribeDBParameterGroupsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeDBParameterGroups'
, describeDBParameterGroupsResponse_marker
- 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
.
$sel:dbParameterGroups:DescribeDBParameterGroupsResponse'
, describeDBParameterGroupsResponse_dbParameterGroups
- A list of DBParameterGroup
instances.
$sel:httpStatus:DescribeDBParameterGroupsResponse'
, describeDBParameterGroupsResponse_httpStatus
- The response's http status code.
ModifyDBSnapshotAttribute
data ModifyDBSnapshotAttribute Source #
See: newModifyDBSnapshotAttribute
smart constructor.
Instances
newModifyDBSnapshotAttribute Source #
Arguments
:: Text | |
-> Text | |
-> ModifyDBSnapshotAttribute |
Create a value of ModifyDBSnapshotAttribute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:valuesToAdd:ModifyDBSnapshotAttribute'
, modifyDBSnapshotAttribute_valuesToAdd
- 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.
$sel:valuesToRemove:ModifyDBSnapshotAttribute'
, modifyDBSnapshotAttribute_valuesToRemove
- 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.
$sel:dbSnapshotIdentifier:ModifyDBSnapshotAttribute'
, modifyDBSnapshotAttribute_dbSnapshotIdentifier
- The identifier for the DB snapshot to modify the attributes for.
$sel:attributeName:ModifyDBSnapshotAttribute'
, modifyDBSnapshotAttribute_attributeName
- 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 action.
data ModifyDBSnapshotAttributeResponse Source #
See: newModifyDBSnapshotAttributeResponse
smart constructor.
Constructors
ModifyDBSnapshotAttributeResponse' (Maybe DBSnapshotAttributesResult) Int |
Instances
newModifyDBSnapshotAttributeResponse Source #
Arguments
:: Int | |
-> ModifyDBSnapshotAttributeResponse |
Create a value of ModifyDBSnapshotAttributeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSnapshotAttributesResult:ModifyDBSnapshotAttributeResponse'
, modifyDBSnapshotAttributeResponse_dbSnapshotAttributesResult
- Undocumented member.
$sel:httpStatus:ModifyDBSnapshotAttributeResponse'
, modifyDBSnapshotAttributeResponse_httpStatus
- The response's http status code.
DescribeDBInstanceAutomatedBackups (Paginated)
data DescribeDBInstanceAutomatedBackups Source #
Parameter input for DescribeDBInstanceAutomatedBackups.
See: newDescribeDBInstanceAutomatedBackups
smart constructor.
Constructors
DescribeDBInstanceAutomatedBackups' (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) |
Instances
newDescribeDBInstanceAutomatedBackups :: DescribeDBInstanceAutomatedBackups Source #
Create a value of DescribeDBInstanceAutomatedBackups
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeDBInstanceAutomatedBackups'
, describeDBInstanceAutomatedBackups_filters
- A filter that specifies which resources to return based on status.
Supported filters are the following:
status
active
- automated backups for current instancesretained
- automated backups for deleted instances and after backup replication is stoppedcreating
- automated backups that are waiting for the first automated snapshot to be available
db-instance-id
- Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.dbi-resource-id
- Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.
$sel:dbInstanceIdentifier:DescribeDBInstanceAutomatedBackups'
, describeDBInstanceAutomatedBackups_dbInstanceIdentifier
- (Optional) The user-supplied instance identifier. If this parameter is
specified, it must match the identifier of an existing DB instance. It
returns information from the specific DB instance' automated backup.
This parameter isn't case-sensitive.
$sel:marker:DescribeDBInstanceAutomatedBackups'
, describeDBInstanceAutomatedBackups_marker
- The pagination token provided in the previous request. If this parameter
is specified the response includes only records beyond the marker, up to
MaxRecords
.
$sel:maxRecords:DescribeDBInstanceAutomatedBackups'
, describeDBInstanceAutomatedBackups_maxRecords
- 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.
$sel:dbiResourceId:DescribeDBInstanceAutomatedBackups'
, describeDBInstanceAutomatedBackups_dbiResourceId
- The resource ID of the DB instance that is the source of the automated
backup. This parameter isn't case-sensitive.
$sel:dbInstanceAutomatedBackupsArn:DescribeDBInstanceAutomatedBackups'
, describeDBInstanceAutomatedBackups_dbInstanceAutomatedBackupsArn
- The Amazon Resource Name (ARN) of the replicated automated backups, for
example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
data DescribeDBInstanceAutomatedBackupsResponse Source #
Contains the result of a successful invocation of the
DescribeDBInstanceAutomatedBackups
action.
See: newDescribeDBInstanceAutomatedBackupsResponse
smart constructor.
Constructors
DescribeDBInstanceAutomatedBackupsResponse' (Maybe [DBInstanceAutomatedBackup]) (Maybe Text) Int |
Instances
newDescribeDBInstanceAutomatedBackupsResponse Source #
Arguments
:: Int | |
-> DescribeDBInstanceAutomatedBackupsResponse |
Create a value of DescribeDBInstanceAutomatedBackupsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstanceAutomatedBackups:DescribeDBInstanceAutomatedBackupsResponse'
, describeDBInstanceAutomatedBackupsResponse_dbInstanceAutomatedBackups
- A list of DBInstanceAutomatedBackup
instances.
$sel:marker:DescribeDBInstanceAutomatedBackups'
, describeDBInstanceAutomatedBackupsResponse_marker
- 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
.
$sel:httpStatus:DescribeDBInstanceAutomatedBackupsResponse'
, describeDBInstanceAutomatedBackupsResponse_httpStatus
- The response's http status code.
RemoveFromGlobalCluster
data RemoveFromGlobalCluster Source #
See: newRemoveFromGlobalCluster
smart constructor.
Constructors
RemoveFromGlobalCluster' (Maybe Text) (Maybe Text) |
Instances
newRemoveFromGlobalCluster :: RemoveFromGlobalCluster Source #
Create a value of RemoveFromGlobalCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterIdentifier:RemoveFromGlobalCluster'
, removeFromGlobalCluster_dbClusterIdentifier
- The Amazon Resource Name (ARN) identifying the cluster that was detached
from the Aurora global database cluster.
$sel:globalClusterIdentifier:RemoveFromGlobalCluster'
, removeFromGlobalCluster_globalClusterIdentifier
- The cluster identifier to detach from the Aurora global database
cluster.
data RemoveFromGlobalClusterResponse Source #
See: newRemoveFromGlobalClusterResponse
smart constructor.
Constructors
RemoveFromGlobalClusterResponse' (Maybe GlobalCluster) Int |
Instances
newRemoveFromGlobalClusterResponse Source #
Create a value of RemoveFromGlobalClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalCluster:RemoveFromGlobalClusterResponse'
, removeFromGlobalClusterResponse_globalCluster
- Undocumented member.
$sel:httpStatus:RemoveFromGlobalClusterResponse'
, removeFromGlobalClusterResponse_httpStatus
- The response's http status code.
AddRoleToDBInstance
data AddRoleToDBInstance Source #
See: newAddRoleToDBInstance
smart constructor.
Constructors
AddRoleToDBInstance' Text Text Text |
Instances
newAddRoleToDBInstance Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> AddRoleToDBInstance |
Create a value of AddRoleToDBInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstanceIdentifier:AddRoleToDBInstance'
, addRoleToDBInstance_dbInstanceIdentifier
- The name of the DB instance to associate the IAM role with.
$sel:roleArn:AddRoleToDBInstance'
, addRoleToDBInstance_roleArn
- The Amazon Resource Name (ARN) of the IAM role to associate with the DB
instance, for example arn:aws:iam::123456789012:role/AccessRole
.
$sel:featureName:AddRoleToDBInstance'
, addRoleToDBInstance_featureName
- The name of the feature for the DB instance that the IAM role is to be
associated with. For the list of supported feature names, see
DBEngineVersion.
data AddRoleToDBInstanceResponse Source #
See: newAddRoleToDBInstanceResponse
smart constructor.
Constructors
AddRoleToDBInstanceResponse' | |
Instances
newAddRoleToDBInstanceResponse :: AddRoleToDBInstanceResponse Source #
Create a value of AddRoleToDBInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteDBClusterSnapshot
data DeleteDBClusterSnapshot Source #
See: newDeleteDBClusterSnapshot
smart constructor.
Constructors
DeleteDBClusterSnapshot' Text |
Instances
newDeleteDBClusterSnapshot Source #
Create a value of DeleteDBClusterSnapshot
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterSnapshotIdentifier:DeleteDBClusterSnapshot'
, deleteDBClusterSnapshot_dbClusterSnapshotIdentifier
- The identifier of the DB cluster snapshot to delete.
Constraints: Must be the name of an existing DB cluster snapshot in the
available
state.
data DeleteDBClusterSnapshotResponse Source #
See: newDeleteDBClusterSnapshotResponse
smart constructor.
Constructors
DeleteDBClusterSnapshotResponse' (Maybe DBClusterSnapshot) Int |
Instances
newDeleteDBClusterSnapshotResponse Source #
Create a value of DeleteDBClusterSnapshotResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterSnapshot:DeleteDBClusterSnapshotResponse'
, deleteDBClusterSnapshotResponse_dbClusterSnapshot
- Undocumented member.
$sel:httpStatus:DeleteDBClusterSnapshotResponse'
, deleteDBClusterSnapshotResponse_httpStatus
- The response's http status code.
ModifyDBProxyEndpoint
data ModifyDBProxyEndpoint Source #
See: newModifyDBProxyEndpoint
smart constructor.
Instances
newModifyDBProxyEndpoint Source #
Create a value of ModifyDBProxyEndpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:vpcSecurityGroupIds:ModifyDBProxyEndpoint'
, modifyDBProxyEndpoint_vpcSecurityGroupIds
- 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.
$sel:newDBProxyEndpointName':ModifyDBProxyEndpoint'
, modifyDBProxyEndpoint_newDBProxyEndpointName
- 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.
$sel:dbProxyEndpointName:ModifyDBProxyEndpoint'
, modifyDBProxyEndpoint_dbProxyEndpointName
- The name of the DB proxy sociated with the DB proxy endpoint that you
want to modify.
data ModifyDBProxyEndpointResponse Source #
See: newModifyDBProxyEndpointResponse
smart constructor.
Constructors
ModifyDBProxyEndpointResponse' (Maybe DBProxyEndpoint) Int |
Instances
newModifyDBProxyEndpointResponse Source #
Create a value of ModifyDBProxyEndpointResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbProxyEndpoint:ModifyDBProxyEndpointResponse'
, modifyDBProxyEndpointResponse_dbProxyEndpoint
- The DBProxyEndpoint
object representing the new settings for the DB
proxy endpoint.
$sel:httpStatus:ModifyDBProxyEndpointResponse'
, modifyDBProxyEndpointResponse_httpStatus
- The response's http status code.
DescribeValidDBInstanceModifications
data DescribeValidDBInstanceModifications Source #
See: newDescribeValidDBInstanceModifications
smart constructor.
Constructors
DescribeValidDBInstanceModifications' Text |
Instances
newDescribeValidDBInstanceModifications Source #
Arguments
:: Text |
|
-> DescribeValidDBInstanceModifications |
Create a value of DescribeValidDBInstanceModifications
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstanceIdentifier:DescribeValidDBInstanceModifications'
, describeValidDBInstanceModifications_dbInstanceIdentifier
- The customer identifier or the ARN of your DB instance.
data DescribeValidDBInstanceModificationsResponse Source #
See: newDescribeValidDBInstanceModificationsResponse
smart constructor.
Constructors
DescribeValidDBInstanceModificationsResponse' (Maybe ValidDBInstanceModificationsMessage) Int |
Instances
newDescribeValidDBInstanceModificationsResponse Source #
Arguments
:: Int |
|
-> DescribeValidDBInstanceModificationsResponse |
Create a value of DescribeValidDBInstanceModificationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:validDBInstanceModificationsMessage:DescribeValidDBInstanceModificationsResponse'
, describeValidDBInstanceModificationsResponse_validDBInstanceModificationsMessage
- Undocumented member.
$sel:httpStatus:DescribeValidDBInstanceModificationsResponse'
, describeValidDBInstanceModificationsResponse_httpStatus
- The response's http status code.
DescribeDBClusterEndpoints (Paginated)
data DescribeDBClusterEndpoints Source #
See: newDescribeDBClusterEndpoints
smart constructor.
Constructors
DescribeDBClusterEndpoints' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int) |
Instances
newDescribeDBClusterEndpoints :: DescribeDBClusterEndpoints Source #
Create a value of DescribeDBClusterEndpoints
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterIdentifier:DescribeDBClusterEndpoints'
, describeDBClusterEndpoints_dbClusterIdentifier
- The DB cluster identifier of the DB cluster associated with the
endpoint. This parameter is stored as a lowercase string.
$sel:filters:DescribeDBClusterEndpoints'
, describeDBClusterEndpoints_filters
- 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
.
$sel:dbClusterEndpointIdentifier:DescribeDBClusterEndpoints'
, describeDBClusterEndpoints_dbClusterEndpointIdentifier
- The identifier of the endpoint to describe. This parameter is stored as
a lowercase string.
$sel:marker:DescribeDBClusterEndpoints'
, describeDBClusterEndpoints_marker
- 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
.
$sel:maxRecords:DescribeDBClusterEndpoints'
, describeDBClusterEndpoints_maxRecords
- 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.
data DescribeDBClusterEndpointsResponse Source #
See: newDescribeDBClusterEndpointsResponse
smart constructor.
Constructors
DescribeDBClusterEndpointsResponse' (Maybe [DBClusterEndpoint]) (Maybe Text) Int |
Instances
newDescribeDBClusterEndpointsResponse Source #
Arguments
:: Int | |
-> DescribeDBClusterEndpointsResponse |
Create a value of DescribeDBClusterEndpointsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterEndpoints:DescribeDBClusterEndpointsResponse'
, describeDBClusterEndpointsResponse_dbClusterEndpoints
- Contains the details of the endpoints associated with the cluster and
matching any filter conditions.
$sel:marker:DescribeDBClusterEndpoints'
, describeDBClusterEndpointsResponse_marker
- 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
.
$sel:httpStatus:DescribeDBClusterEndpointsResponse'
, describeDBClusterEndpointsResponse_httpStatus
- The response's http status code.
DescribeOptionGroupOptions (Paginated)
data DescribeOptionGroupOptions Source #
See: newDescribeOptionGroupOptions
smart constructor.
Instances
newDescribeOptionGroupOptions Source #
Create a value of DescribeOptionGroupOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeOptionGroupOptions'
, describeOptionGroupOptions_filters
- This parameter isn't currently supported.
$sel:majorEngineVersion:DescribeOptionGroupOptions'
, describeOptionGroupOptions_majorEngineVersion
- If specified, filters the results to include only options for the
specified major engine version.
$sel:marker:DescribeOptionGroupOptions'
, describeOptionGroupOptions_marker
- 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
.
$sel:maxRecords:DescribeOptionGroupOptions'
, describeOptionGroupOptions_maxRecords
- 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.
$sel:engineName:DescribeOptionGroupOptions'
, describeOptionGroupOptions_engineName
- A required parameter. Options available for the given engine name are
described.
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
data DescribeOptionGroupOptionsResponse Source #
See: newDescribeOptionGroupOptionsResponse
smart constructor.
Constructors
DescribeOptionGroupOptionsResponse' (Maybe [OptionGroupOption]) (Maybe Text) Int |
Instances
newDescribeOptionGroupOptionsResponse Source #
Arguments
:: Int | |
-> DescribeOptionGroupOptionsResponse |
Create a value of DescribeOptionGroupOptionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:optionGroupOptions:DescribeOptionGroupOptionsResponse'
, describeOptionGroupOptionsResponse_optionGroupOptions
- Undocumented member.
$sel:marker:DescribeOptionGroupOptions'
, describeOptionGroupOptionsResponse_marker
- 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
.
$sel:httpStatus:DescribeOptionGroupOptionsResponse'
, describeOptionGroupOptionsResponse_httpStatus
- The response's http status code.
DescribeEventSubscriptions (Paginated)
data DescribeEventSubscriptions Source #
See: newDescribeEventSubscriptions
smart constructor.
Instances
newDescribeEventSubscriptions :: DescribeEventSubscriptions Source #
Create a value of DescribeEventSubscriptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subscriptionName:DescribeEventSubscriptions'
, describeEventSubscriptions_subscriptionName
- The name of the RDS event notification subscription you want to
describe.
$sel:filters:DescribeEventSubscriptions'
, describeEventSubscriptions_filters
- This parameter isn't currently supported.
$sel:marker:DescribeEventSubscriptions'
, describeEventSubscriptions_marker
- 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
.
$sel:maxRecords:DescribeEventSubscriptions'
, describeEventSubscriptions_maxRecords
- 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.
data DescribeEventSubscriptionsResponse Source #
Data returned by the DescribeEventSubscriptions action.
See: newDescribeEventSubscriptionsResponse
smart constructor.
Constructors
DescribeEventSubscriptionsResponse' (Maybe [EventSubscription]) (Maybe Text) Int |
Instances
newDescribeEventSubscriptionsResponse Source #
Arguments
:: Int | |
-> DescribeEventSubscriptionsResponse |
Create a value of DescribeEventSubscriptionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventSubscriptionsList:DescribeEventSubscriptionsResponse'
, describeEventSubscriptionsResponse_eventSubscriptionsList
- A list of EventSubscriptions data types.
$sel:marker:DescribeEventSubscriptions'
, describeEventSubscriptionsResponse_marker
- 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
.
$sel:httpStatus:DescribeEventSubscriptionsResponse'
, describeEventSubscriptionsResponse_httpStatus
- The response's http status code.
AddTagsToResource
data AddTagsToResource Source #
See: newAddTagsToResource
smart constructor.
Constructors
AddTagsToResource' Text [Tag] |
Instances
Arguments
:: Text | |
-> AddTagsToResource |
Create a value of AddTagsToResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceName:AddTagsToResource'
, addTagsToResource_resourceName
- 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).
$sel:tags:AddTagsToResource'
, addTagsToResource_tags
- The tags to be assigned to the Amazon RDS resource.
data AddTagsToResourceResponse Source #
See: newAddTagsToResourceResponse
smart constructor.
Constructors
AddTagsToResourceResponse' | |
Instances
newAddTagsToResourceResponse :: AddTagsToResourceResponse Source #
Create a value of AddTagsToResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeDBParameters (Paginated)
data DescribeDBParameters Source #
See: newDescribeDBParameters
smart constructor.
Instances
newDescribeDBParameters Source #
Create a value of DescribeDBParameters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeDBParameters'
, describeDBParameters_filters
- This parameter isn't currently supported.
$sel:marker:DescribeDBParameters'
, describeDBParameters_marker
- 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
.
$sel:maxRecords:DescribeDBParameters'
, describeDBParameters_maxRecords
- 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.
$sel:source:DescribeDBParameters'
, describeDBParameters_source
- The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
$sel:dbParameterGroupName:DescribeDBParameters'
, describeDBParameters_dbParameterGroupName
- The name of a specific DB parameter group to return details for.
Constraints:
- If supplied, must match the name of an existing DBParameterGroup.
data DescribeDBParametersResponse Source #
Contains the result of a successful invocation of the
DescribeDBParameters
action.
See: newDescribeDBParametersResponse
smart constructor.
Instances
newDescribeDBParametersResponse Source #
Create a value of DescribeDBParametersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeDBParameters'
, describeDBParametersResponse_marker
- 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
.
$sel:parameters:DescribeDBParametersResponse'
, describeDBParametersResponse_parameters
- A list of Parameter
values.
$sel:httpStatus:DescribeDBParametersResponse'
, describeDBParametersResponse_httpStatus
- The response's http status code.
StopActivityStream
data StopActivityStream Source #
See: newStopActivityStream
smart constructor.
Constructors
StopActivityStream' (Maybe Bool) Text |
Instances
newStopActivityStream Source #
Arguments
:: Text | |
-> StopActivityStream |
Create a value of StopActivityStream
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applyImmediately:StopActivityStream'
, stopActivityStream_applyImmediately
- Specifies whether or not the database activity stream is to stop as soon
as possible, regardless of the maintenance window for the database.
$sel:resourceArn:StopActivityStream'
, stopActivityStream_resourceArn
- 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
.
data StopActivityStreamResponse Source #
See: newStopActivityStreamResponse
smart constructor.
Constructors
StopActivityStreamResponse' (Maybe ActivityStreamStatus) (Maybe Text) (Maybe Text) Int |
Instances
newStopActivityStreamResponse Source #
Create a value of StopActivityStreamResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:StopActivityStreamResponse'
, stopActivityStreamResponse_status
- The status of the database activity stream.
$sel:kinesisStreamName:StopActivityStreamResponse'
, stopActivityStreamResponse_kinesisStreamName
- The name of the Amazon Kinesis data stream used for the database
activity stream.
$sel:kmsKeyId:StopActivityStreamResponse'
, stopActivityStreamResponse_kmsKeyId
- 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 Amazon Web Services KMS customer master key (CMK).
$sel:httpStatus:StopActivityStreamResponse'
, stopActivityStreamResponse_httpStatus
- The response's http status code.
CreateDBClusterSnapshot
data CreateDBClusterSnapshot Source #
See: newCreateDBClusterSnapshot
smart constructor.
Constructors
CreateDBClusterSnapshot' (Maybe [Tag]) Text Text |
Instances
newCreateDBClusterSnapshot Source #
Arguments
:: Text | |
-> Text | |
-> CreateDBClusterSnapshot |
Create a value of CreateDBClusterSnapshot
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateDBClusterSnapshot'
, createDBClusterSnapshot_tags
- The tags to be assigned to the DB cluster snapshot.
$sel:dbClusterSnapshotIdentifier:CreateDBClusterSnapshot'
, createDBClusterSnapshot_dbClusterSnapshotIdentifier
- 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
$sel:dbClusterIdentifier:CreateDBClusterSnapshot'
, createDBClusterSnapshot_dbClusterIdentifier
- 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
data CreateDBClusterSnapshotResponse Source #
See: newCreateDBClusterSnapshotResponse
smart constructor.
Constructors
CreateDBClusterSnapshotResponse' (Maybe DBClusterSnapshot) Int |
Instances
newCreateDBClusterSnapshotResponse Source #
Create a value of CreateDBClusterSnapshotResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterSnapshot:CreateDBClusterSnapshotResponse'
, createDBClusterSnapshotResponse_dbClusterSnapshot
- Undocumented member.
$sel:httpStatus:CreateDBClusterSnapshotResponse'
, createDBClusterSnapshotResponse_httpStatus
- The response's http status code.
DescribeDBSnapshots (Paginated)
data DescribeDBSnapshots Source #
See: newDescribeDBSnapshots
smart constructor.
Constructors
DescribeDBSnapshots' (Maybe Bool) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Text) |
Instances
newDescribeDBSnapshots :: DescribeDBSnapshots Source #
Create a value of DescribeDBSnapshots
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:includeShared:DescribeDBSnapshots'
, describeDBSnapshots_includeShared
- A value that indicates whether to include shared manual DB cluster
snapshots from other Amazon Web Services accounts that this Amazon Web
Services account has been given permission to copy or restore. By
default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a
manual DB snapshot from another Amazon Web Services account by using the
ModifyDBSnapshotAttribute
API action.
$sel:filters:DescribeDBSnapshots'
, describeDBSnapshots_filters
- 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.
$sel:dbSnapshotIdentifier:DescribeDBSnapshots'
, describeDBSnapshots_dbSnapshotIdentifier
- A specific DB snapshot identifier to describe. This parameter can't be
used in conjunction with DBInstanceIdentifier
. 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.
$sel:snapshotType:DescribeDBSnapshots'
, describeDBSnapshots_snapshotType
- 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
.
$sel:dbInstanceIdentifier:DescribeDBSnapshots'
, describeDBSnapshots_dbInstanceIdentifier
- The ID of the DB instance to retrieve the list of DB snapshots for. This
parameter can't be used in conjunction with DBSnapshotIdentifier
.
This parameter isn't case-sensitive.
Constraints:
- If supplied, must match the identifier of an existing DBInstance.
$sel:marker:DescribeDBSnapshots'
, describeDBSnapshots_marker
- 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
.
$sel:maxRecords:DescribeDBSnapshots'
, describeDBSnapshots_maxRecords
- 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.
$sel:includePublic:DescribeDBSnapshots'
, describeDBSnapshots_includePublic
- A value that indicates whether to include manual DB cluster snapshots
that are public and can be copied or restored by any Amazon Web Services
account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
$sel:dbiResourceId:DescribeDBSnapshots'
, describeDBSnapshots_dbiResourceId
- A specific DB resource ID to describe.
data DescribeDBSnapshotsResponse Source #
Contains the result of a successful invocation of the
DescribeDBSnapshots
action.
See: newDescribeDBSnapshotsResponse
smart constructor.
Constructors
DescribeDBSnapshotsResponse' (Maybe Text) (Maybe [DBSnapshot]) Int |
Instances
newDescribeDBSnapshotsResponse Source #
Create a value of DescribeDBSnapshotsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeDBSnapshots'
, describeDBSnapshotsResponse_marker
- 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
.
$sel:dbSnapshots:DescribeDBSnapshotsResponse'
, describeDBSnapshotsResponse_dbSnapshots
- A list of DBSnapshot
instances.
$sel:httpStatus:DescribeDBSnapshotsResponse'
, describeDBSnapshotsResponse_httpStatus
- The response's http status code.
ModifyDBProxyTargetGroup
data ModifyDBProxyTargetGroup Source #
See: newModifyDBProxyTargetGroup
smart constructor.
Constructors
ModifyDBProxyTargetGroup' (Maybe ConnectionPoolConfiguration) (Maybe Text) Text Text |
Instances
newModifyDBProxyTargetGroup Source #
Arguments
:: Text | |
-> Text | |
-> ModifyDBProxyTargetGroup |
Create a value of ModifyDBProxyTargetGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:connectionPoolConfig:ModifyDBProxyTargetGroup'
, modifyDBProxyTargetGroup_connectionPoolConfig
- The settings that determine the size and behavior of the connection pool
for the target group.
$sel:newName':ModifyDBProxyTargetGroup'
, modifyDBProxyTargetGroup_newName
- 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.
$sel:targetGroupName:ModifyDBProxyTargetGroup'
, modifyDBProxyTargetGroup_targetGroupName
- The name of the new target group to assign to the proxy.
$sel:dbProxyName:ModifyDBProxyTargetGroup'
, modifyDBProxyTargetGroup_dbProxyName
- The name of the new proxy to which to assign the target group.
data ModifyDBProxyTargetGroupResponse Source #
See: newModifyDBProxyTargetGroupResponse
smart constructor.
Constructors
ModifyDBProxyTargetGroupResponse' (Maybe DBProxyTargetGroup) Int |
Instances
newModifyDBProxyTargetGroupResponse Source #
Create a value of ModifyDBProxyTargetGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbProxyTargetGroup:ModifyDBProxyTargetGroupResponse'
, modifyDBProxyTargetGroupResponse_dbProxyTargetGroup
- The settings of the modified DBProxyTarget
.
$sel:httpStatus:ModifyDBProxyTargetGroupResponse'
, modifyDBProxyTargetGroupResponse_httpStatus
- The response's http status code.
DescribeDBSubnetGroups (Paginated)
data DescribeDBSubnetGroups Source #
See: newDescribeDBSubnetGroups
smart constructor.
Instances
newDescribeDBSubnetGroups :: DescribeDBSubnetGroups Source #
Create a value of DescribeDBSubnetGroups
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSubnetGroupName:DescribeDBSubnetGroups'
, describeDBSubnetGroups_dbSubnetGroupName
- The name of the DB subnet group to return details for.
$sel:filters:DescribeDBSubnetGroups'
, describeDBSubnetGroups_filters
- This parameter isn't currently supported.
$sel:marker:DescribeDBSubnetGroups'
, describeDBSubnetGroups_marker
- 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
.
$sel:maxRecords:DescribeDBSubnetGroups'
, describeDBSubnetGroups_maxRecords
- 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.
data DescribeDBSubnetGroupsResponse Source #
Contains the result of a successful invocation of the
DescribeDBSubnetGroups
action.
See: newDescribeDBSubnetGroupsResponse
smart constructor.
Constructors
DescribeDBSubnetGroupsResponse' (Maybe [DBSubnetGroup]) (Maybe Text) Int |
Instances
newDescribeDBSubnetGroupsResponse Source #
Create a value of DescribeDBSubnetGroupsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSubnetGroups:DescribeDBSubnetGroupsResponse'
, describeDBSubnetGroupsResponse_dbSubnetGroups
- A list of DBSubnetGroup
instances.
$sel:marker:DescribeDBSubnetGroups'
, describeDBSubnetGroupsResponse_marker
- 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
.
$sel:httpStatus:DescribeDBSubnetGroupsResponse'
, describeDBSubnetGroupsResponse_httpStatus
- The response's http status code.
ModifyOptionGroup
data ModifyOptionGroup Source #
See: newModifyOptionGroup
smart constructor.
Constructors
ModifyOptionGroup' (Maybe [OptionConfiguration]) (Maybe [Text]) (Maybe Bool) Text |
Instances
Arguments
:: Text | |
-> ModifyOptionGroup |
Create a value of ModifyOptionGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:optionsToInclude:ModifyOptionGroup'
, modifyOptionGroup_optionsToInclude
- Options in this list are added to the option group or, if already
present, the specified configuration is used to update the existing
configuration.
$sel:optionsToRemove:ModifyOptionGroup'
, modifyOptionGroup_optionsToRemove
- Options in this list are removed from the option group.
$sel:applyImmediately:ModifyOptionGroup'
, modifyOptionGroup_applyImmediately
- A value that indicates whether to apply the change immediately or during
the next maintenance window for each instance associated with the option
group.
$sel:optionGroupName:ModifyOptionGroup'
, modifyOptionGroup_optionGroupName
- 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
data ModifyOptionGroupResponse Source #
See: newModifyOptionGroupResponse
smart constructor.
Constructors
ModifyOptionGroupResponse' (Maybe OptionGroup) Int |
Instances
newModifyOptionGroupResponse Source #
Create a value of ModifyOptionGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:optionGroup:ModifyOptionGroupResponse'
, modifyOptionGroupResponse_optionGroup
- Undocumented member.
$sel:httpStatus:ModifyOptionGroupResponse'
, modifyOptionGroupResponse_httpStatus
- The response's http status code.
StopDBCluster
data StopDBCluster Source #
See: newStopDBCluster
smart constructor.
Constructors
StopDBCluster' Text |
Instances
Arguments
:: Text | |
-> StopDBCluster |
Create a value of StopDBCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterIdentifier:StopDBCluster'
, stopDBCluster_dbClusterIdentifier
- The DB cluster identifier of the Amazon Aurora DB cluster to be stopped.
This parameter is stored as a lowercase string.
data StopDBClusterResponse Source #
See: newStopDBClusterResponse
smart constructor.
Constructors
StopDBClusterResponse' (Maybe DBCluster) Int |
Instances
newStopDBClusterResponse Source #
Create a value of StopDBClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbCluster:StopDBClusterResponse'
, stopDBClusterResponse_dbCluster
- Undocumented member.
$sel:httpStatus:StopDBClusterResponse'
, stopDBClusterResponse_httpStatus
- The response's http status code.
CreateDBParameterGroup
data CreateDBParameterGroup Source #
See: newCreateDBParameterGroup
smart constructor.
Instances
newCreateDBParameterGroup Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> CreateDBParameterGroup |
Create a value of CreateDBParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateDBParameterGroup'
, createDBParameterGroup_tags
- Tags to assign to the DB parameter group.
$sel:dbParameterGroupName:CreateDBParameterGroup'
, createDBParameterGroup_dbParameterGroupName
- 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.
$sel:dbParameterGroupFamily:CreateDBParameterGroup'
, createDBParameterGroup_dbParameterGroupFamily
- The DB parameter group family name. A DB parameter group can be
associated with one and only one DB parameter group family, and can be
applied only to a DB instance running a database engine and engine
version compatible with that DB parameter group family.
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql
The output contains duplicates.
The following are the valid DB engine values:
aurora
(for MySQL 5.6-compatible Aurora)aurora-mysql
(for MySQL 5.7-compatible Aurora)aurora-postgresql
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
$sel:description:CreateDBParameterGroup'
, createDBParameterGroup_description
- The description for the DB parameter group.
data CreateDBParameterGroupResponse Source #
See: newCreateDBParameterGroupResponse
smart constructor.
Constructors
CreateDBParameterGroupResponse' (Maybe DBParameterGroup) Int |
Instances
newCreateDBParameterGroupResponse Source #
Create a value of CreateDBParameterGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroup:CreateDBParameterGroupResponse'
, createDBParameterGroupResponse_dbParameterGroup
- Undocumented member.
$sel:httpStatus:CreateDBParameterGroupResponse'
, createDBParameterGroupResponse_httpStatus
- The response's http status code.
ModifyDBClusterSnapshotAttribute
data ModifyDBClusterSnapshotAttribute Source #
See: newModifyDBClusterSnapshotAttribute
smart constructor.
Instances
newModifyDBClusterSnapshotAttribute Source #
Arguments
:: Text |
|
-> Text | |
-> ModifyDBClusterSnapshotAttribute |
Create a value of ModifyDBClusterSnapshotAttribute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:valuesToAdd:ModifyDBClusterSnapshotAttribute'
, modifyDBClusterSnapshotAttribute_valuesToAdd
- 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.
$sel:valuesToRemove:ModifyDBClusterSnapshotAttribute'
, modifyDBClusterSnapshotAttribute_valuesToRemove
- 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.
$sel:dbClusterSnapshotIdentifier:ModifyDBClusterSnapshotAttribute'
, modifyDBClusterSnapshotAttribute_dbClusterSnapshotIdentifier
- The identifier for the DB cluster snapshot to modify the attributes for.
$sel:attributeName:ModifyDBClusterSnapshotAttribute'
, modifyDBClusterSnapshotAttribute_attributeName
- 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 action.
data ModifyDBClusterSnapshotAttributeResponse Source #
See: newModifyDBClusterSnapshotAttributeResponse
smart constructor.
Instances
newModifyDBClusterSnapshotAttributeResponse Source #
Arguments
:: Int | |
-> ModifyDBClusterSnapshotAttributeResponse |
Create a value of ModifyDBClusterSnapshotAttributeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterSnapshotAttributesResult:ModifyDBClusterSnapshotAttributeResponse'
, modifyDBClusterSnapshotAttributeResponse_dbClusterSnapshotAttributesResult
- Undocumented member.
$sel:httpStatus:ModifyDBClusterSnapshotAttributeResponse'
, modifyDBClusterSnapshotAttributeResponse_httpStatus
- The response's http status code.
ModifyDBCluster
data ModifyDBCluster Source #
See: newModifyDBCluster
smart constructor.
Constructors
ModifyDBCluster' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Integer) (Maybe CloudwatchLogsExportConfiguration) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe Text) (Maybe ScalingConfiguration) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) Text |
Instances
Arguments
:: Text | |
-> ModifyDBCluster |
Create a value of ModifyDBCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:ModifyDBCluster'
, modifyDBCluster_engineVersion
- The version number of the database engine to which you want to upgrade.
Changing this parameter results in an outage. The change is applied
during the next maintenance window unless ApplyImmediately
is enabled.
To list all of the available engine versions for aurora
(for MySQL
5.6-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for
MySQL 5.7-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
,
use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
$sel:enableGlobalWriteForwarding:ModifyDBCluster'
, modifyDBCluster_enableGlobalWriteForwarding
- A value that indicates whether to enable this DB cluster to forward
write operations to the primary cluster of an Aurora global database
(GlobalCluster). By default, write operations are not allowed on Aurora
DB clusters that are secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.
$sel:deletionProtection:ModifyDBCluster'
, modifyDBCluster_deletionProtection
- A value that indicates whether the DB cluster has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled.
$sel:masterUserPassword:ModifyDBCluster'
, modifyDBCluster_masterUserPassword
- The new password for the master database user. This password can contain
any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
$sel:enableHttpEndpoint:ModifyDBCluster'
, modifyDBCluster_enableHttpEndpoint
- A value that indicates whether to enable the HTTP endpoint for an Aurora
Serverless DB cluster. By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
$sel:allowMajorVersionUpgrade:ModifyDBCluster'
, modifyDBCluster_allowMajorVersionUpgrade
- A value that indicates whether major version upgrades are allowed.
Constraints: You must allow major version upgrades when specifying a
value for the EngineVersion
parameter that is a different major
version than the DB cluster's current version.
$sel:domain:ModifyDBCluster'
, modifyDBCluster_domain
- 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.
$sel:backtrackWindow:ModifyDBCluster'
, modifyDBCluster_backtrackWindow
- 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).
$sel:cloudwatchLogsExportConfiguration:ModifyDBCluster'
, modifyDBCluster_cloudwatchLogsExportConfiguration
- The configuration setting for the log types to be enabled for export to
CloudWatch Logs for a specific DB cluster.
$sel:preferredMaintenanceWindow:ModifyDBCluster'
, modifyDBCluster_preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in
Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
$sel:preferredBackupWindow:ModifyDBCluster'
, modifyDBCluster_preferredBackupWindow
- 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.
$sel:backupRetentionPeriod:ModifyDBCluster'
, modifyDBCluster_backupRetentionPeriod
- The number of days for which automated backups are retained. You must
specify a minimum value of 1.
Default: 1
Constraints:
- Must be a value from 1 to 35
$sel:vpcSecurityGroupIds:ModifyDBCluster'
, modifyDBCluster_vpcSecurityGroupIds
- A list of VPC security groups that the DB cluster will belong to.
$sel:dbClusterParameterGroupName:ModifyDBCluster'
, modifyDBCluster_dbClusterParameterGroupName
- The name of the DB cluster parameter group to use for the DB cluster.
$sel:scalingConfiguration:ModifyDBCluster'
, modifyDBCluster_scalingConfiguration
- The scaling properties of the DB cluster. You can only modify scaling
properties for DB clusters in serverless
DB engine mode.
$sel:applyImmediately:ModifyDBCluster'
, modifyDBCluster_applyImmediately
- A value that indicates whether the modifications in this request and any
pending modifications are asynchronously applied as soon as possible,
regardless of the PreferredMaintenanceWindow
setting for the DB
cluster. If this parameter is disabled, changes to the DB cluster are
applied during the next maintenance window.
The ApplyImmediately
parameter only affects the
EnableIAMDatabaseAuthentication
, MasterUserPassword
, and
NewDBClusterIdentifier
values. If the ApplyImmediately
parameter is
disabled, then changes to the EnableIAMDatabaseAuthentication
,
MasterUserPassword
, and NewDBClusterIdentifier
values are applied
during the next maintenance window. All other changes are applied
immediately, regardless of the value of the ApplyImmediately
parameter.
By default, this parameter is disabled.
$sel:optionGroupName:ModifyDBCluster'
, modifyDBCluster_optionGroupName
- A value that indicates that the DB cluster should be associated with the
specified option group. Changing this parameter doesn't result in an
outage except in the following case, and the change is applied during
the next maintenance window unless the ApplyImmediately
is enabled for
this request. If the parameter change results in an option group that
enables OEM, this change can cause a brief (sub-second) period during
which new connections are rejected but existing connections are not
interrupted.
Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
$sel:copyTagsToSnapshot:ModifyDBCluster'
, modifyDBCluster_copyTagsToSnapshot
- A value that indicates whether to copy all tags from the DB cluster to
snapshots of the DB cluster. The default is not to copy them.
$sel:newDBClusterIdentifier':ModifyDBCluster'
, modifyDBCluster_newDBClusterIdentifier
- The new DB cluster identifier for the DB cluster when renaming a DB
cluster. This value is stored as a lowercase string.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens
- The first character must be a letter
- Can't end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
$sel:dbInstanceParameterGroupName:ModifyDBCluster'
, modifyDBCluster_dbInstanceParameterGroupName
- 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 aren't applied during the next
maintenance window but instead are applied immediately.
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 only valid in combination with theAllowMajorVersionUpgrade
parameter.
$sel:domainIAMRoleName:ModifyDBCluster'
, modifyDBCluster_domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the
Directory Service.
$sel:port:ModifyDBCluster'
, modifyDBCluster_port
- The port number on which the DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
$sel:enableIAMDatabaseAuthentication:ModifyDBCluster'
, modifyDBCluster_enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services
Identity and Access Management (IAM) accounts to database accounts. By
default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
$sel:dbClusterIdentifier:ModifyDBCluster'
, modifyDBCluster_dbClusterIdentifier
- The DB cluster identifier for the cluster being modified. This parameter
isn't case-sensitive.
Constraints: This identifier must match the identifier of an existing DB cluster.
data ModifyDBClusterResponse Source #
See: newModifyDBClusterResponse
smart constructor.
Constructors
ModifyDBClusterResponse' (Maybe DBCluster) Int |
Instances
newModifyDBClusterResponse Source #
Create a value of ModifyDBClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbCluster:ModifyDBClusterResponse'
, modifyDBClusterResponse_dbCluster
- Undocumented member.
$sel:httpStatus:ModifyDBClusterResponse'
, modifyDBClusterResponse_httpStatus
- The response's http status code.
CopyDBClusterParameterGroup
data CopyDBClusterParameterGroup Source #
See: newCopyDBClusterParameterGroup
smart constructor.
Instances
newCopyDBClusterParameterGroup Source #
Arguments
Create a value of CopyDBClusterParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CopyDBClusterParameterGroup'
, copyDBClusterParameterGroup_tags
- Undocumented member.
$sel:sourceDBClusterParameterGroupIdentifier:CopyDBClusterParameterGroup'
, copyDBClusterParameterGroup_sourceDBClusterParameterGroupIdentifier
- 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.
$sel:targetDBClusterParameterGroupIdentifier:CopyDBClusterParameterGroup'
, copyDBClusterParameterGroup_targetDBClusterParameterGroupIdentifier
- 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
$sel:targetDBClusterParameterGroupDescription:CopyDBClusterParameterGroup'
, copyDBClusterParameterGroup_targetDBClusterParameterGroupDescription
- A description for the copied DB cluster parameter group.
data CopyDBClusterParameterGroupResponse Source #
See: newCopyDBClusterParameterGroupResponse
smart constructor.
Constructors
CopyDBClusterParameterGroupResponse' (Maybe DBClusterParameterGroup) Int |
Instances
newCopyDBClusterParameterGroupResponse Source #
Arguments
:: Int | |
-> CopyDBClusterParameterGroupResponse |
Create a value of CopyDBClusterParameterGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterParameterGroup:CopyDBClusterParameterGroupResponse'
, copyDBClusterParameterGroupResponse_dbClusterParameterGroup
- Undocumented member.
$sel:httpStatus:CopyDBClusterParameterGroupResponse'
, copyDBClusterParameterGroupResponse_httpStatus
- The response's http status code.
DescribeEventCategories
data DescribeEventCategories Source #
See: newDescribeEventCategories
smart constructor.
Constructors
DescribeEventCategories' (Maybe Text) (Maybe [Filter]) |
Instances
newDescribeEventCategories :: DescribeEventCategories Source #
Create a value of DescribeEventCategories
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceType:DescribeEventCategories'
, describeEventCategories_sourceType
- The type of source that is generating the events.
Valid values: db-instance
| db-cluster
| db-parameter-group
|
db-security-group
| db-snapshot
| db-cluster-snapshot
$sel:filters:DescribeEventCategories'
, describeEventCategories_filters
- This parameter isn't currently supported.
data DescribeEventCategoriesResponse Source #
Data returned from the DescribeEventCategories
operation.
See: newDescribeEventCategoriesResponse
smart constructor.
Constructors
DescribeEventCategoriesResponse' (Maybe [EventCategoriesMap]) Int |
Instances
newDescribeEventCategoriesResponse Source #
Create a value of DescribeEventCategoriesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventCategoriesMapList:DescribeEventCategoriesResponse'
, describeEventCategoriesResponse_eventCategoriesMapList
- A list of EventCategoriesMap data types.
$sel:httpStatus:DescribeEventCategoriesResponse'
, describeEventCategoriesResponse_httpStatus
- The response's http status code.
DescribeGlobalClusters (Paginated)
data DescribeGlobalClusters Source #
See: newDescribeGlobalClusters
smart constructor.
Instances
newDescribeGlobalClusters :: DescribeGlobalClusters Source #
Create a value of DescribeGlobalClusters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalClusterIdentifier:DescribeGlobalClusters'
, describeGlobalClusters_globalClusterIdentifier
- 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.
$sel:filters:DescribeGlobalClusters'
, describeGlobalClusters_filters
- This parameter isn't currently supported.
$sel:marker:DescribeGlobalClusters'
, describeGlobalClusters_marker
- 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
.
$sel:maxRecords:DescribeGlobalClusters'
, describeGlobalClusters_maxRecords
- 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.
data DescribeGlobalClustersResponse Source #
See: newDescribeGlobalClustersResponse
smart constructor.
Constructors
DescribeGlobalClustersResponse' (Maybe [GlobalCluster]) (Maybe Text) Int |
Instances
newDescribeGlobalClustersResponse Source #
Create a value of DescribeGlobalClustersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalClusters:DescribeGlobalClustersResponse'
, describeGlobalClustersResponse_globalClusters
- The list of global clusters returned by this request.
$sel:marker:DescribeGlobalClusters'
, describeGlobalClustersResponse_marker
- 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
.
$sel:httpStatus:DescribeGlobalClustersResponse'
, describeGlobalClustersResponse_httpStatus
- The response's http status code.
StartDBInstance
data StartDBInstance Source #
See: newStartDBInstance
smart constructor.
Constructors
StartDBInstance' Text |
Instances
Create a value of StartDBInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstanceIdentifier:StartDBInstance'
, startDBInstance_dbInstanceIdentifier
- The user-supplied instance identifier.
data StartDBInstanceResponse Source #
See: newStartDBInstanceResponse
smart constructor.
Constructors
StartDBInstanceResponse' (Maybe DBInstance) Int |
Instances
newStartDBInstanceResponse Source #
Create a value of StartDBInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstance:StartDBInstanceResponse'
, startDBInstanceResponse_dbInstance
- Undocumented member.
$sel:httpStatus:StartDBInstanceResponse'
, startDBInstanceResponse_httpStatus
- The response's http status code.
DescribeExportTasks (Paginated)
data DescribeExportTasks Source #
See: newDescribeExportTasks
smart constructor.
Constructors
DescribeExportTasks' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Natural) |
Instances
newDescribeExportTasks :: DescribeExportTasks Source #
Create a value of DescribeExportTasks
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceArn:DescribeExportTasks'
, describeExportTasks_sourceArn
- The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
$sel:filters:DescribeExportTasks'
, describeExportTasks_filters
- Filters specify one or more snapshot exports to describe. The filters
are specified as name-value pairs that define what to include in the
output. Filter names and values are case-sensitive.
Supported filters include the following:
export-task-identifier
- An identifier for the snapshot export task.s3-bucket
- The Amazon S3 bucket the snapshot is exported to.source-arn
- The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3status
- The status of the export task. Must be lowercase, for example,complete
.
$sel:marker:DescribeExportTasks'
, describeExportTasks_marker
- 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.
$sel:exportTaskIdentifier:DescribeExportTasks'
, describeExportTasks_exportTaskIdentifier
- The identifier of the snapshot export task to be described.
$sel:maxRecords:DescribeExportTasks'
, describeExportTasks_maxRecords
- 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.
data DescribeExportTasksResponse Source #
See: newDescribeExportTasksResponse
smart constructor.
Constructors
DescribeExportTasksResponse' (Maybe Text) (Maybe [ExportTask]) Int |
Instances
newDescribeExportTasksResponse Source #
Create a value of DescribeExportTasksResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeExportTasks'
, describeExportTasksResponse_marker
- 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
.
$sel:exportTasks:DescribeExportTasksResponse'
, describeExportTasksResponse_exportTasks
- Information about an export of a snapshot to Amazon S3.
$sel:httpStatus:DescribeExportTasksResponse'
, describeExportTasksResponse_httpStatus
- The response's http status code.
CancelExportTask
data CancelExportTask Source #
See: newCancelExportTask
smart constructor.
Constructors
CancelExportTask' Text |
Instances
Create a value of CancelExportTask
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exportTaskIdentifier:CancelExportTask'
, cancelExportTask_exportTaskIdentifier
- The identifier of the snapshot export task to cancel.
data ExportTask Source #
Contains the details of a snapshot export to Amazon S3.
This data type is used as a response element in the
DescribeExportTasks
action.
See: newExportTask
smart constructor.
Constructors
ExportTask' (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) |
Instances
newExportTask :: ExportTask Source #
Create a value of ExportTask
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:totalExtractedDataInGB:ExportTask'
, exportTask_totalExtractedDataInGB
- The total amount of data exported, in gigabytes.
$sel:status:ExportTask'
, exportTask_status
- The progress status of the export task.
$sel:iamRoleArn:ExportTask'
, exportTask_iamRoleArn
- The name of the IAM role that is used to write to Amazon S3 when
exporting a snapshot.
$sel:sourceArn:ExportTask'
, exportTask_sourceArn
- The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
$sel:exportOnly:ExportTask'
, exportTask_exportOnly
- The data exported from the snapshot. Valid values are the following:
database
- Export all the data from a specified database.database.table
table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.database.schema
schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.database.schema.table
table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
$sel:taskStartTime:ExportTask'
, exportTask_taskStartTime
- The time that the snapshot export task started.
$sel:warningMessage:ExportTask'
, exportTask_warningMessage
- A warning about the snapshot export task.
$sel:snapshotTime:ExportTask'
, exportTask_snapshotTime
- The time that the snapshot was created.
$sel:kmsKeyId:ExportTask'
, exportTask_kmsKeyId
- The key identifier of the Amazon Web Services KMS customer master key
(CMK) that is used to encrypt the snapshot when it's exported to Amazon
S3. The Amazon Web Services KMS CMK identifier is its key ARN, key ID,
alias ARN, or alias name. The IAM role used for the snapshot export must
have encryption and decryption permissions to use this Amazon Web
Services KMS CMK.
$sel:taskEndTime:ExportTask'
, exportTask_taskEndTime
- The time that the snapshot export task completed.
$sel:exportTaskIdentifier:ExportTask'
, exportTask_exportTaskIdentifier
- A unique identifier for the snapshot export task. This ID isn't an
identifier for the Amazon S3 bucket where the snapshot is exported to.
$sel:s3Prefix:ExportTask'
, exportTask_s3Prefix
- The Amazon S3 bucket prefix that is the file name and path of the
exported snapshot.
$sel:percentProgress:ExportTask'
, exportTask_percentProgress
- The progress of the snapshot export task as a percentage.
$sel:s3Bucket:ExportTask'
, exportTask_s3Bucket
- The Amazon S3 bucket that the snapshot is exported to.
$sel:failureCause:ExportTask'
, exportTask_failureCause
- The reason the export failed, if it failed.
ModifyDBClusterParameterGroup
data ModifyDBClusterParameterGroup Source #
See: newModifyDBClusterParameterGroup
smart constructor.
Constructors
ModifyDBClusterParameterGroup' Text [Parameter] |
Instances
newModifyDBClusterParameterGroup Source #
Arguments
:: Text |
|
-> ModifyDBClusterParameterGroup |
Create a value of ModifyDBClusterParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterParameterGroupName:ModifyDBClusterParameterGroup'
, modifyDBClusterParameterGroup_dbClusterParameterGroupName
- The name of the DB cluster parameter group to modify.
$sel:parameters:ModifyDBClusterParameterGroup'
, modifyDBClusterParameterGroup_parameters
- 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.
data DBClusterParameterGroupNameMessage Source #
See: newDBClusterParameterGroupNameMessage
smart constructor.
Constructors
DBClusterParameterGroupNameMessage' (Maybe Text) |
Instances
newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage Source #
Create a value of DBClusterParameterGroupNameMessage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterParameterGroupName:DBClusterParameterGroupNameMessage'
, dbClusterParameterGroupNameMessage_dbClusterParameterGroupName
- 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.
RestoreDBInstanceToPointInTime
data RestoreDBInstanceToPointInTime Source #
See: newRestoreDBInstanceToPointInTime
smart constructor.
Constructors
RestoreDBInstanceToPointInTime' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe ISO8601) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [ProcessorFeature]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) Text |
Instances
newRestoreDBInstanceToPointInTime Source #
Arguments
:: Text |
|
-> RestoreDBInstanceToPointInTime |
Create a value of RestoreDBInstanceToPointInTime
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deletionProtection:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_deletionProtection
- A value that indicates whether the DB instance has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled. For more
information, see
Deleting a DB Instance.
$sel:useLatestRestorableTime:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_useLatestRestorableTime
- A value that indicates whether the DB instance is restored from the
latest backup time. By default, the DB instance isn't restored from the
latest backup time.
Constraints: Can't be specified if the RestoreTime
parameter is
provided.
$sel:publiclyAccessible:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_publiclyAccessible
- A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.
$sel:autoMinorVersionUpgrade:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_autoMinorVersionUpgrade
- A value that indicates whether minor version upgrades are applied
automatically to the DB instance during the maintenance window.
$sel:dbSubnetGroupName:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_dbSubnetGroupName
- The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
$sel:restoreTime:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_restoreTime
- The date and time to restore from.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
- Must be before the latest restorable time for the DB instance
- Can't be specified if the
UseLatestRestorableTime
parameter is enabled
Example: 2009-09-07T23:45:00Z
$sel:iops:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_iops
- The amount of Provisioned IOPS (input/output operations per second) to
be initially allocated for the DB instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine isn't supported.
$sel:domain:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_domain
- Specify the Active Directory directory ID to restore the DB instance 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.
$sel:enableCustomerOwnedIp:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_enableCustomerOwnedIp
- A value that indicates whether to enable a customer-owned IP address
(CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
$sel:engine:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_engine
- The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
$sel:tdeCredentialPassword:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_tdeCredentialPassword
- The password for the given ARN from the key store in order to access the
device.
$sel:sourceDBInstanceIdentifier:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_sourceDBInstanceIdentifier
- The identifier of the source DB instance from which to restore.
Constraints:
- Must match the identifier of an existing DB instance.
$sel:processorFeatures:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_processorFeatures
- The number of CPU cores and the number of threads per core for the DB
instance class of the DB instance.
$sel:dbInstanceClass:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_dbInstanceClass
- 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.
$sel:licenseModel:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_licenseModel
- License model information for the restored DB instance.
Default: Same as source.
Valid values: license-included
| bring-your-own-license
|
general-public-license
$sel:sourceDBInstanceAutomatedBackupsArn:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_sourceDBInstanceAutomatedBackupsArn
- The Amazon Resource Name (ARN) of the replicated automated backups from
which to restore, for example,
arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
$sel:maxAllocatedStorage:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_maxAllocatedStorage
- 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.
$sel:dbParameterGroupName:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_dbParameterGroupName
- 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.
Constraints:
- If supplied, must match the name of an existing DBParameterGroup.
- Must be 1 to 255 letters, numbers, or hyphens.
- First character must be a letter.
- Can't end with a hyphen or contain two consecutive hyphens.
$sel:availabilityZone:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_availabilityZone
- 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
$sel:vpcSecurityGroupIds:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_vpcSecurityGroupIds
- 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.
$sel:multiAZ:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_multiAZ
- A value that indicates whether the DB instance is a Multi-AZ deployment.
Constraint: You can't specify the AvailabilityZone
parameter if the
DB instance is a Multi-AZ deployment.
$sel:sourceDbiResourceId:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_sourceDbiResourceId
- The resource ID of the source DB instance from which to restore.
$sel:optionGroupName:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_optionGroupName
- 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 once it is associated with a DB instance
$sel:copyTagsToSnapshot:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_copyTagsToSnapshot
- A value that indicates whether to copy all tags from the restored DB
instance to snapshots of the DB instance. By default, tags are not
copied.
$sel:tdeCredentialArn:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE
encryption.
$sel:domainIAMRoleName:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the
Directory Service.
$sel:tags:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_tags
- Undocumented member.
$sel:port:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_port
- The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
$sel:enableIAMDatabaseAuthentication:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services
Identity and Access Management (IAM) accounts to database accounts. By
default, mapping is disabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
$sel:useDefaultProcessorFeatures:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_useDefaultProcessorFeatures
- A value that indicates whether the DB instance class of the DB instance
uses its default processor features.
$sel:storageType:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_storageType
- Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise gp2
$sel:enableCloudwatchLogsExports:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_enableCloudwatchLogsExports
- 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.
$sel:dbName:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_dbName
- The database name for the restored DB instance.
This parameter isn't used for the MySQL or MariaDB engines.
$sel:targetDBInstanceIdentifier:RestoreDBInstanceToPointInTime'
, restoreDBInstanceToPointInTime_targetDBInstanceIdentifier
- The name of the new DB instance to be created.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens
- First character must be a letter
- Can't end with a hyphen or contain two consecutive hyphens
data RestoreDBInstanceToPointInTimeResponse Source #
See: newRestoreDBInstanceToPointInTimeResponse
smart constructor.
Constructors
RestoreDBInstanceToPointInTimeResponse' (Maybe DBInstance) Int |
Instances
newRestoreDBInstanceToPointInTimeResponse Source #
Arguments
:: Int | |
-> RestoreDBInstanceToPointInTimeResponse |
Create a value of RestoreDBInstanceToPointInTimeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstance:RestoreDBInstanceToPointInTimeResponse'
, restoreDBInstanceToPointInTimeResponse_dbInstance
- Undocumented member.
$sel:httpStatus:RestoreDBInstanceToPointInTimeResponse'
, restoreDBInstanceToPointInTimeResponse_httpStatus
- The response's http status code.
DescribeDBClusterSnapshotAttributes
data DescribeDBClusterSnapshotAttributes Source #
See: newDescribeDBClusterSnapshotAttributes
smart constructor.
Constructors
DescribeDBClusterSnapshotAttributes' Text |
Instances
newDescribeDBClusterSnapshotAttributes Source #
Arguments
:: Text |
|
-> DescribeDBClusterSnapshotAttributes |
Create a value of DescribeDBClusterSnapshotAttributes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterSnapshotIdentifier:DescribeDBClusterSnapshotAttributes'
, describeDBClusterSnapshotAttributes_dbClusterSnapshotIdentifier
- The identifier for the DB cluster snapshot to describe the attributes
for.
data DescribeDBClusterSnapshotAttributesResponse Source #
See: newDescribeDBClusterSnapshotAttributesResponse
smart constructor.
Constructors
DescribeDBClusterSnapshotAttributesResponse' (Maybe DBClusterSnapshotAttributesResult) Int |
Instances
newDescribeDBClusterSnapshotAttributesResponse Source #
Arguments
:: Int |
|
-> DescribeDBClusterSnapshotAttributesResponse |
Create a value of DescribeDBClusterSnapshotAttributesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterSnapshotAttributesResult:DescribeDBClusterSnapshotAttributesResponse'
, describeDBClusterSnapshotAttributesResponse_dbClusterSnapshotAttributesResult
- Undocumented member.
$sel:httpStatus:DescribeDBClusterSnapshotAttributesResponse'
, describeDBClusterSnapshotAttributesResponse_httpStatus
- The response's http status code.
ModifyDBSnapshot
data ModifyDBSnapshot Source #
See: newModifyDBSnapshot
smart constructor.
Instances
Create a value of ModifyDBSnapshot
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:ModifyDBSnapshot'
, modifyDBSnapshot_engineVersion
- The engine version to upgrade the DB snapshot to.
The following are the database engines and engine versions that are available when you upgrade a DB snapshot.
MySQL
5.5.46
(supported for 5.1 DB snapshots)
Oracle
12.1.0.2.v8
(supported for 12.1.0.1 DB snapshots)11.2.0.4.v12
(supported for 11.2.0.2 DB snapshots)11.2.0.4.v11
(supported for 11.2.0.3 DB snapshots)
PostgreSQL
For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS.
$sel:optionGroupName:ModifyDBSnapshot'
, modifyDBSnapshot_optionGroupName
- 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.
$sel:dbSnapshotIdentifier:ModifyDBSnapshot'
, modifyDBSnapshot_dbSnapshotIdentifier
- The identifier of the DB snapshot to modify.
data ModifyDBSnapshotResponse Source #
See: newModifyDBSnapshotResponse
smart constructor.
Constructors
ModifyDBSnapshotResponse' (Maybe DBSnapshot) Int |
Instances
newModifyDBSnapshotResponse Source #
Create a value of ModifyDBSnapshotResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSnapshot:ModifyDBSnapshotResponse'
, modifyDBSnapshotResponse_dbSnapshot
- Undocumented member.
$sel:httpStatus:ModifyDBSnapshotResponse'
, modifyDBSnapshotResponse_httpStatus
- The response's http status code.
DescribeDBProxyTargetGroups (Paginated)
data DescribeDBProxyTargetGroups Source #
See: newDescribeDBProxyTargetGroups
smart constructor.
Constructors
DescribeDBProxyTargetGroups' (Maybe [Filter]) (Maybe Text) (Maybe Natural) (Maybe Text) Text |
Instances
newDescribeDBProxyTargetGroups Source #
Create a value of DescribeDBProxyTargetGroups
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeDBProxyTargetGroups'
, describeDBProxyTargetGroups_filters
- This parameter is not currently supported.
$sel:marker:DescribeDBProxyTargetGroups'
, describeDBProxyTargetGroups_marker
- 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
.
$sel:maxRecords:DescribeDBProxyTargetGroups'
, describeDBProxyTargetGroups_maxRecords
- 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.
$sel:targetGroupName:DescribeDBProxyTargetGroups'
, describeDBProxyTargetGroups_targetGroupName
- The identifier of the DBProxyTargetGroup
to describe.
$sel:dbProxyName:DescribeDBProxyTargetGroups'
, describeDBProxyTargetGroups_dbProxyName
- The identifier of the DBProxy
associated with the target group.
data DescribeDBProxyTargetGroupsResponse Source #
See: newDescribeDBProxyTargetGroupsResponse
smart constructor.
Constructors
DescribeDBProxyTargetGroupsResponse' (Maybe Text) (Maybe [DBProxyTargetGroup]) Int |
Instances
newDescribeDBProxyTargetGroupsResponse Source #
Arguments
:: Int | |
-> DescribeDBProxyTargetGroupsResponse |
Create a value of DescribeDBProxyTargetGroupsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeDBProxyTargetGroups'
, describeDBProxyTargetGroupsResponse_marker
- 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
.
$sel:targetGroups:DescribeDBProxyTargetGroupsResponse'
, describeDBProxyTargetGroupsResponse_targetGroups
- An arbitrary number of DBProxyTargetGroup
objects, containing details
of the corresponding target groups.
$sel:httpStatus:DescribeDBProxyTargetGroupsResponse'
, describeDBProxyTargetGroupsResponse_httpStatus
- The response's http status code.
ModifyDBProxy
data ModifyDBProxy Source #
See: newModifyDBProxy
smart constructor.
Constructors
ModifyDBProxy' (Maybe Bool) (Maybe [Text]) (Maybe [UserAuthConfig]) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Text) Text |
Instances
Arguments
:: Text | |
-> ModifyDBProxy |
Create a value of ModifyDBProxy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:debugLogging:ModifyDBProxy'
, modifyDBProxy_debugLogging
- 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.
$sel:securityGroups:ModifyDBProxy'
, modifyDBProxy_securityGroups
- The new list of security groups for the DBProxy
.
$sel:auth:ModifyDBProxy'
, modifyDBProxy_auth
- The new authentication settings for the DBProxy
.
$sel:requireTLS:ModifyDBProxy'
, modifyDBProxy_requireTLS
- 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.
$sel:idleClientTimeout:ModifyDBProxy'
, modifyDBProxy_idleClientTimeout
- 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.
$sel:newDBProxyName':ModifyDBProxy'
, modifyDBProxy_newDBProxyName
- 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.
$sel:roleArn:ModifyDBProxy'
, modifyDBProxy_roleArn
- The Amazon Resource Name (ARN) of the IAM role that the proxy uses to
access secrets in Amazon Web Services Secrets Manager.
$sel:dbProxyName:ModifyDBProxy'
, modifyDBProxy_dbProxyName
- The identifier for the DBProxy
to modify.
data ModifyDBProxyResponse Source #
See: newModifyDBProxyResponse
smart constructor.
Constructors
ModifyDBProxyResponse' (Maybe DBProxy) Int |
Instances
newModifyDBProxyResponse Source #
Create a value of ModifyDBProxyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbProxy:ModifyDBProxyResponse'
, modifyDBProxyResponse_dbProxy
- The DBProxy
object representing the new settings for the proxy.
$sel:httpStatus:ModifyDBProxyResponse'
, modifyDBProxyResponse_httpStatus
- The response's http status code.
DescribePendingMaintenanceActions (Paginated)
data DescribePendingMaintenanceActions Source #
See: newDescribePendingMaintenanceActions
smart constructor.
Constructors
DescribePendingMaintenanceActions' (Maybe [Filter]) (Maybe Text) (Maybe Int) (Maybe Text) |
Instances
newDescribePendingMaintenanceActions :: DescribePendingMaintenanceActions Source #
Create a value of DescribePendingMaintenanceActions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribePendingMaintenanceActions'
, describePendingMaintenanceActions_filters
- 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 will only include 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 will only include pending maintenance actions for the DB instances identified by these ARNs.
$sel:marker:DescribePendingMaintenanceActions'
, describePendingMaintenanceActions_marker
- 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
.
$sel:maxRecords:DescribePendingMaintenanceActions'
, describePendingMaintenanceActions_maxRecords
- 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.
$sel:resourceIdentifier:DescribePendingMaintenanceActions'
, describePendingMaintenanceActions_resourceIdentifier
- The ARN of a resource to return pending maintenance actions for.
data DescribePendingMaintenanceActionsResponse Source #
Data returned from the DescribePendingMaintenanceActions action.
See: newDescribePendingMaintenanceActionsResponse
smart constructor.
Constructors
DescribePendingMaintenanceActionsResponse' (Maybe [ResourcePendingMaintenanceActions]) (Maybe Text) Int |
Instances
newDescribePendingMaintenanceActionsResponse Source #
Arguments
:: Int | |
-> DescribePendingMaintenanceActionsResponse |
Create a value of DescribePendingMaintenanceActionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pendingMaintenanceActions:DescribePendingMaintenanceActionsResponse'
, describePendingMaintenanceActionsResponse_pendingMaintenanceActions
- A list of the pending maintenance actions for the resource.
$sel:marker:DescribePendingMaintenanceActions'
, describePendingMaintenanceActionsResponse_marker
- 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
.
$sel:httpStatus:DescribePendingMaintenanceActionsResponse'
, describePendingMaintenanceActionsResponse_httpStatus
- The response's http status code.
AddRoleToDBCluster
data AddRoleToDBCluster Source #
See: newAddRoleToDBCluster
smart constructor.
Constructors
AddRoleToDBCluster' (Maybe Text) Text Text |
Instances
newAddRoleToDBCluster Source #
Arguments
:: Text | |
-> Text | |
-> AddRoleToDBCluster |
Create a value of AddRoleToDBCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:featureName:AddRoleToDBCluster'
, addRoleToDBCluster_featureName
- The name of the feature for the DB cluster that the IAM role is to be
associated with. For the list of supported feature names, see
DBEngineVersion.
$sel:dbClusterIdentifier:AddRoleToDBCluster'
, addRoleToDBCluster_dbClusterIdentifier
- The name of the DB cluster to associate the IAM role with.
$sel:roleArn:AddRoleToDBCluster'
, addRoleToDBCluster_roleArn
- The Amazon Resource Name (ARN) of the IAM role to associate with the
Aurora DB cluster, for example,
arn:aws:iam::123456789012:role/AuroraAccessRole
.
data AddRoleToDBClusterResponse Source #
See: newAddRoleToDBClusterResponse
smart constructor.
Constructors
AddRoleToDBClusterResponse' | |
Instances
newAddRoleToDBClusterResponse :: AddRoleToDBClusterResponse Source #
Create a value of AddRoleToDBClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CopyDBClusterSnapshot
data CopyDBClusterSnapshot Source #
See: newCopyDBClusterSnapshot
smart constructor.
Constructors
CopyDBClusterSnapshot' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text |
Instances
newCopyDBClusterSnapshot Source #
Arguments
:: Text |
|
-> Text |
|
-> CopyDBClusterSnapshot |
Create a value of CopyDBClusterSnapshot
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:preSignedUrl:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_preSignedUrl
- The URL that contains a Signature Version 4 signed request for the
CopyDBClusterSnapshot
API action in the Amazon Web Services Region
that contains the source DB cluster snapshot to copy. The PreSignedUrl
parameter must be used when copying an encrypted DB cluster snapshot
from another Amazon Web Services Region. Don't specify PreSignedUrl
when you are copying an encrypted DB cluster snapshot in the same Amazon
Web Services Region.
The pre-signed URL must be a valid request for the
CopyDBClusterSnapshot
API action that can be executed in the source
Amazon Web Services Region that contains the encrypted DB cluster
snapshot to be copied. The pre-signed URL request must contain the
following parameter values:
KmsKeyId
- The Amazon Web Services KMS key identifier for the customer master key (CMK) 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 theCopyDBClusterSnapshot
action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed 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 yourSourceDBClusterSnapshotIdentifier
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 pre-signed URL that is a valid request for the operation
that can be executed in the source Amazon Web Services Region.
$sel:copyTags:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_copyTags
- A value that indicates whether to copy all tags from the source DB
cluster snapshot to the target DB cluster snapshot. By default, tags are
not copied.
$sel:destinationRegion:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_destinationRegion
- Pseudo-parameter used when populating the PreSignedUrl
of a
cross-region CopyDBClusterSnapshot
request. To replicate from region
SRC
to region DST
, send a request to region DST
. In that request,
pass a PreSignedUrl
for region SRC
with DestinationRegion
set to
region DST
.
$sel:kmsKeyId:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_kmsKeyId
- 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 customer
master key (CMK).
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 Amazon Web Services KMS CMK. If you don't specify a
value for KmsKeyId
, then the copy of the DB cluster snapshot is
encrypted with the same Amazon Web Services 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. Amazon Web
Services KMS CMKs are specific to the Amazon Web Services Region that
they are created in, and you can't use CMKs 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.
$sel:tags:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_tags
- Undocumented member.
$sel:sourceDBClusterSnapshotIdentifier:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_sourceDBClusterSnapshotIdentifier
- 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
$sel:targetDBClusterSnapshotIdentifier:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_targetDBClusterSnapshotIdentifier
- 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
data CopyDBClusterSnapshotResponse Source #
See: newCopyDBClusterSnapshotResponse
smart constructor.
Constructors
CopyDBClusterSnapshotResponse' (Maybe DBClusterSnapshot) Int |
Instances
newCopyDBClusterSnapshotResponse Source #
Create a value of CopyDBClusterSnapshotResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterSnapshot:CopyDBClusterSnapshotResponse'
, copyDBClusterSnapshotResponse_dbClusterSnapshot
- Undocumented member.
$sel:httpStatus:CopyDBClusterSnapshotResponse'
, copyDBClusterSnapshotResponse_httpStatus
- The response's http status code.
ImportInstallationMedia
data ImportInstallationMedia Source #
See: newImportInstallationMedia
smart constructor.
Instances
newImportInstallationMedia Source #
Create a value of ImportInstallationMedia
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customAvailabilityZoneId:ImportInstallationMedia'
, importInstallationMedia_customAvailabilityZoneId
- The identifier of the custom Availability Zone (AZ) to import the
installation media to.
$sel:engine:ImportInstallationMedia'
, importInstallationMedia_engine
- The name of the database engine to be used for this instance.
The list only includes supported DB engines that require an on-premises customer provided license.
Valid Values:
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
$sel:engineVersion:ImportInstallationMedia'
, importInstallationMedia_engineVersion
- The version number of the database engine to use.
For a list of valid engine versions, call DescribeDBEngineVersions.
The following are the database engines and links to information about the major and minor versions. The list only includes DB engines that require an on-premises customer provided license.
Microsoft SQL Server
See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.
$sel:engineInstallationMediaPath:ImportInstallationMedia'
, importInstallationMedia_engineInstallationMediaPath
- The path to the installation medium for the specified DB engine.
Example:
SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso
$sel:oSInstallationMediaPath:ImportInstallationMedia'
, importInstallationMedia_oSInstallationMediaPath
- The path to the installation medium for the operating system associated
with the specified DB engine.
Example: WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso
data InstallationMedia Source #
Contains the installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
See: newInstallationMedia
smart constructor.
Constructors
InstallationMedia' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InstallationMediaFailureCause) |
Instances
newInstallationMedia :: InstallationMedia Source #
Create a value of InstallationMedia
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:InstallationMedia'
, installationMedia_engineVersion
- The engine version of the DB engine.
$sel:status:InstallationMedia'
, installationMedia_status
- The status of the installation medium.
$sel:installationMediaId:InstallationMedia'
, installationMedia_installationMediaId
- The installation medium ID.
$sel:engineInstallationMediaPath:InstallationMedia'
, installationMedia_engineInstallationMediaPath
- The path to the installation medium for the DB engine.
$sel:engine:InstallationMedia'
, installationMedia_engine
- The DB engine.
$sel:oSInstallationMediaPath:InstallationMedia'
, installationMedia_oSInstallationMediaPath
- The path to the installation medium for the operating system associated
with the DB engine.
$sel:customAvailabilityZoneId:InstallationMedia'
, installationMedia_customAvailabilityZoneId
- The custom Availability Zone (AZ) that contains the installation media.
$sel:failureCause:InstallationMedia'
, installationMedia_failureCause
- If an installation media failure occurred, the cause of the failure.
CreateGlobalCluster
data CreateGlobalCluster Source #
See: newCreateGlobalCluster
smart constructor.
Constructors
CreateGlobalCluster' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newCreateGlobalCluster :: CreateGlobalCluster Source #
Create a value of CreateGlobalCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:CreateGlobalCluster'
, createGlobalCluster_engineVersion
- The engine version of the Aurora global database.
$sel:deletionProtection:CreateGlobalCluster'
, createGlobalCluster_deletionProtection
- The deletion protection setting for the new global database. The global
database can't be deleted when deletion protection is enabled.
$sel:storageEncrypted:CreateGlobalCluster'
, createGlobalCluster_storageEncrypted
- The storage encryption setting for the new global database cluster.
$sel:sourceDBClusterIdentifier:CreateGlobalCluster'
, createGlobalCluster_sourceDBClusterIdentifier
- The Amazon Resource Name (ARN) to use as the primary cluster of the
global database. This parameter is optional.
$sel:globalClusterIdentifier:CreateGlobalCluster'
, createGlobalCluster_globalClusterIdentifier
- The cluster identifier of the new global database cluster.
$sel:engine:CreateGlobalCluster'
, createGlobalCluster_engine
- The name of the database engine to be used for this DB cluster.
$sel:databaseName:CreateGlobalCluster'
, createGlobalCluster_databaseName
- The name for your database of up to 64 alpha-numeric characters. If you
do not provide a name, Amazon Aurora will not create a database in the
global database cluster you are creating.
data CreateGlobalClusterResponse Source #
See: newCreateGlobalClusterResponse
smart constructor.
Constructors
CreateGlobalClusterResponse' (Maybe GlobalCluster) Int |
Instances
newCreateGlobalClusterResponse Source #
Create a value of CreateGlobalClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalCluster:CreateGlobalClusterResponse'
, createGlobalClusterResponse_globalCluster
- Undocumented member.
$sel:httpStatus:CreateGlobalClusterResponse'
, createGlobalClusterResponse_httpStatus
- The response's http status code.
ResetDBParameterGroup
data ResetDBParameterGroup Source #
See: newResetDBParameterGroup
smart constructor.
Instances
newResetDBParameterGroup Source #
Create a value of ResetDBParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resetAllParameters:ResetDBParameterGroup'
, resetDBParameterGroup_resetAllParameters
- A value that indicates whether to reset all parameters in the DB
parameter group to default values. By default, all parameters in the DB
parameter group are reset to default values.
$sel:parameters:ResetDBParameterGroup'
, resetDBParameterGroup_parameters
- 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
$sel:dbParameterGroupName:ResetDBParameterGroup'
, resetDBParameterGroup_dbParameterGroupName
- The name of the DB parameter group.
Constraints:
- Must match the name of an existing
DBParameterGroup
.
data DBParameterGroupNameMessage Source #
Contains the result of a successful invocation of the
ModifyDBParameterGroup
or ResetDBParameterGroup
action.
See: newDBParameterGroupNameMessage
smart constructor.
Constructors
DBParameterGroupNameMessage' (Maybe Text) |
Instances
newDBParameterGroupNameMessage :: DBParameterGroupNameMessage Source #
Create a value of DBParameterGroupNameMessage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroupName:DBParameterGroupNameMessage'
, dbParameterGroupNameMessage_dbParameterGroupName
- The name of the DB parameter group.
FailoverGlobalCluster
data FailoverGlobalCluster Source #
See: newFailoverGlobalCluster
smart constructor.
Constructors
FailoverGlobalCluster' Text Text |
Instances
newFailoverGlobalCluster Source #
Arguments
:: Text | |
-> Text | |
-> FailoverGlobalCluster |
Create a value of FailoverGlobalCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalClusterIdentifier:FailoverGlobalCluster'
, failoverGlobalCluster_globalClusterIdentifier
- Identifier of the Aurora global database (GlobalCluster) that should be
failed over. The identifier is the unique key assigned by the user when
the Aurora global database was created. In other words, it's the name
of the Aurora global database that you want to fail over.
Constraints:
- Must match the identifier of an existing GlobalCluster (Aurora global database).
$sel:targetDbClusterIdentifier:FailoverGlobalCluster'
, failoverGlobalCluster_targetDbClusterIdentifier
- Identifier of the secondary Aurora DB cluster that you want to promote
to primary for the Aurora global database (GlobalCluster.) Use the
Amazon Resource Name (ARN) for the identifier so that Aurora can locate
the cluster in its Amazon Web Services Region.
data FailoverGlobalClusterResponse Source #
See: newFailoverGlobalClusterResponse
smart constructor.
Constructors
FailoverGlobalClusterResponse' (Maybe GlobalCluster) Int |
Instances
newFailoverGlobalClusterResponse Source #
Create a value of FailoverGlobalClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalCluster:FailoverGlobalClusterResponse'
, failoverGlobalClusterResponse_globalCluster
- Undocumented member.
$sel:httpStatus:FailoverGlobalClusterResponse'
, failoverGlobalClusterResponse_httpStatus
- The response's http status code.
DescribeInstallationMedia (Paginated)
data DescribeInstallationMedia Source #
See: newDescribeInstallationMedia
smart constructor.
Instances
newDescribeInstallationMedia :: DescribeInstallationMedia Source #
Create a value of DescribeInstallationMedia
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:installationMediaId:DescribeInstallationMedia'
, describeInstallationMedia_installationMediaId
- The installation medium ID.
$sel:filters:DescribeInstallationMedia'
, describeInstallationMedia_filters
- A filter that specifies one or more installation media to describe.
Supported filters include the following:
custom-availability-zone-id
- Accepts custom Availability Zone (AZ) identifiers. The results list includes information about only the custom AZs identified by these identifiers.engine
- Accepts database engines. The results list includes information about only the database engines identified by these identifiers.For more information about the valid engines for installation media, see ImportInstallationMedia.
$sel:marker:DescribeInstallationMedia'
, describeInstallationMedia_marker
- 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
.
$sel:maxRecords:DescribeInstallationMedia'
, describeInstallationMedia_maxRecords
- An optional pagination token provided by a previous
DescribeInstallationMedia request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords
.
data DescribeInstallationMediaResponse Source #
See: newDescribeInstallationMediaResponse
smart constructor.
Constructors
DescribeInstallationMediaResponse' (Maybe Text) (Maybe [InstallationMedia]) Int |
Instances
newDescribeInstallationMediaResponse Source #
Arguments
:: Int | |
-> DescribeInstallationMediaResponse |
Create a value of DescribeInstallationMediaResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeInstallationMedia'
, describeInstallationMediaResponse_marker
- An optional pagination token provided by a previous
DescribeInstallationMedia request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords
.
$sel:installationMedia:DescribeInstallationMediaResponse'
, describeInstallationMediaResponse_installationMedia
- The list of InstallationMedia objects for the Amazon Web Services
account.
$sel:httpStatus:DescribeInstallationMediaResponse'
, describeInstallationMediaResponse_httpStatus
- The response's http status code.
DeregisterDBProxyTargets
data DeregisterDBProxyTargets Source #
See: newDeregisterDBProxyTargets
smart constructor.
Instances
newDeregisterDBProxyTargets Source #
Create a value of DeregisterDBProxyTargets
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterIdentifiers:DeregisterDBProxyTargets'
, deregisterDBProxyTargets_dbClusterIdentifiers
- One or more DB cluster identifiers.
$sel:dbInstanceIdentifiers:DeregisterDBProxyTargets'
, deregisterDBProxyTargets_dbInstanceIdentifiers
- One or more DB instance identifiers.
$sel:targetGroupName:DeregisterDBProxyTargets'
, deregisterDBProxyTargets_targetGroupName
- The identifier of the DBProxyTargetGroup
.
$sel:dbProxyName:DeregisterDBProxyTargets'
, deregisterDBProxyTargets_dbProxyName
- The identifier of the DBProxy
that is associated with the
DBProxyTargetGroup
.
data DeregisterDBProxyTargetsResponse Source #
See: newDeregisterDBProxyTargetsResponse
smart constructor.
Constructors
DeregisterDBProxyTargetsResponse' Int |
Instances
newDeregisterDBProxyTargetsResponse Source #
Create a value of DeregisterDBProxyTargetsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeregisterDBProxyTargetsResponse'
, deregisterDBProxyTargetsResponse_httpStatus
- The response's http status code.
CreateDBCluster
data CreateDBCluster Source #
See: newCreateDBCluster
smart constructor.
Constructors
CreateDBCluster' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ScalingConfiguration) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe [Text]) Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> CreateDBCluster |
Create a value of CreateDBCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:CreateDBCluster'
, createDBCluster_engineVersion
- The version number of the database engine to use.
To list all of the available engine versions for aurora
(for MySQL
5.6-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for
MySQL 5.7-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
,
use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
Aurora PostgreSQL
Example: 9.6.3
, 10.7
$sel:enableGlobalWriteForwarding:CreateDBCluster'
, createDBCluster_enableGlobalWriteForwarding
- A value that indicates whether to enable this DB cluster to forward
write operations to the primary cluster of an Aurora global database
(GlobalCluster). By default, write operations are not allowed on Aurora
DB clusters that are secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.
$sel:deletionProtection:CreateDBCluster'
, createDBCluster_deletionProtection
- A value that indicates whether the DB cluster has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled.
$sel:storageEncrypted:CreateDBCluster'
, createDBCluster_storageEncrypted
- A value that indicates whether the DB cluster is encrypted.
$sel:masterUserPassword:CreateDBCluster'
, createDBCluster_masterUserPassword
- 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.
$sel:replicationSourceIdentifier:CreateDBCluster'
, createDBCluster_replicationSourceIdentifier
- The Amazon Resource Name (ARN) of the source DB instance or DB cluster
if this DB cluster is created as a read replica.
$sel:enableHttpEndpoint:CreateDBCluster'
, createDBCluster_enableHttpEndpoint
- A value that indicates whether to enable the HTTP endpoint for an Aurora
Serverless DB cluster. By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
$sel:globalClusterIdentifier:CreateDBCluster'
, createDBCluster_globalClusterIdentifier
- The global cluster ID of an Aurora cluster that becomes the primary
cluster in the new global database cluster.
$sel:masterUsername:CreateDBCluster'
, createDBCluster_masterUsername
- The name of the master user for the DB cluster.
Constraints:
- Must be 1 to 16 letters or numbers.
- First character must be a letter.
- Can't be a reserved word for the chosen database engine.
$sel:dbSubnetGroupName:CreateDBCluster'
, createDBCluster_dbSubnetGroupName
- A DB subnet group to associate with this DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
$sel:domain:CreateDBCluster'
, createDBCluster_domain
- 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.
$sel:backtrackWindow:CreateDBCluster'
, createDBCluster_backtrackWindow
- 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).
$sel:preSignedUrl:CreateDBCluster'
, createDBCluster_preSignedUrl
- A URL that contains a Signature Version 4 signed request for the
CreateDBCluster
action to be called in the source Amazon Web Services
Region where the DB cluster is replicated from. You only need to specify
PreSignedUrl
when you are performing cross-region replication from an
encrypted DB cluster.
The pre-signed URL must be a valid request for the CreateDBCluster
API
action that can be executed in the source Amazon Web Services Region
that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId
- The Amazon Web Services KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same Amazon Web Services KMS CMK for both theCreateDBCluster
action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed 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 yourReplicationSourceIdentifier
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 pre-signed URL that is a valid request for the operation
that can be executed in the source Amazon Web Services Region.
$sel:preferredMaintenanceWindow:CreateDBCluster'
, createDBCluster_preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in
Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
$sel:availabilityZones:CreateDBCluster'
, createDBCluster_availabilityZones
- A list of Availability Zones (AZs) where instances in the DB cluster can
be created. For information on Amazon Web Services Regions and
Availability Zones, see
Choosing the Regions and Availability Zones
in the Amazon Aurora User Guide.
$sel:destinationRegion:CreateDBCluster'
, createDBCluster_destinationRegion
- Pseudo-parameter used when populating the PreSignedUrl
of a
cross-region CreateDBCluster
request. To replicate from region SRC
to region DST
, send a request to region DST
. In that request, pass a
PreSignedUrl
for region SRC
with DestinationRegion
set to region
DST
.
$sel:characterSetName:CreateDBCluster'
, createDBCluster_characterSetName
- A value that indicates that the DB cluster should be associated with the
specified CharacterSet.
$sel:kmsKeyId:CreateDBCluster'
, createDBCluster_kmsKeyId
- 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 Amazon Web Services KMS customer master key (CMK). To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.
When a CMK isn't specified in KmsKeyId
:
- If
ReplicationSourceIdentifier
identifies an encrypted source, then Amazon RDS will use the CMK used to encrypt the source. Otherwise, Amazon RDS will use your default CMK. - If the
StorageEncrypted
parameter is enabled andReplicationSourceIdentifier
isn't specified, then Amazon RDS will use your default CMK.
There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.
If you create a read replica of an encrypted DB cluster in another
Amazon Web Services Region, you must set KmsKeyId
to a Amazon Web
Services KMS key identifier that is valid in the destination Amazon Web
Services Region. This CMK is used to encrypt the read replica in that
Amazon Web Services Region.
$sel:preferredBackupWindow:CreateDBCluster'
, createDBCluster_preferredBackupWindow
- 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.
$sel:backupRetentionPeriod:CreateDBCluster'
, createDBCluster_backupRetentionPeriod
- The number of days for which automated backups are retained.
Default: 1
Constraints:
- Must be a value from 1 to 35
$sel:vpcSecurityGroupIds:CreateDBCluster'
, createDBCluster_vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB cluster.
$sel:databaseName:CreateDBCluster'
, createDBCluster_databaseName
- The name for your database of up to 64 alphanumeric characters. If you
do not provide a name, Amazon RDS doesn't create a database in the DB
cluster you are creating.
$sel:dbClusterParameterGroupName:CreateDBCluster'
, createDBCluster_dbClusterParameterGroupName
- The name of the DB cluster parameter group to associate with this DB
cluster. If you do not specify a value, then the default DB cluster
parameter group for the specified DB engine and version is used.
Constraints:
- If supplied, must match the name of an existing DB cluster parameter group.
$sel:engineMode:CreateDBCluster'
, createDBCluster_engineMode
- The DB engine mode of the DB cluster, either provisioned
,
serverless
, parallelquery
, global
, or multimaster
.
The parallelquery
engine mode isn't required for Aurora MySQL version
1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.
The global
engine mode isn't required for Aurora MySQL version 1.22
and higher 1.x versions, and global
engine mode isn't required for
any 2.x versions.
The multimaster
engine mode only applies for DB clusters created with
Aurora MySQL version 5.6.10a.
For Aurora PostgreSQL, the global
engine mode isn't required, and
both the parallelquery
and the multimaster
engine modes currently
aren't supported.
Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the /Amazon Aurora User Guide/:
- Limitations of Aurora Serverless
- Limitations of Parallel Query
- Limitations of Aurora Global Databases
- Limitations of Multi-Master Clusters
$sel:scalingConfiguration:CreateDBCluster'
, createDBCluster_scalingConfiguration
- For DB clusters in serverless
DB engine mode, the scaling properties
of the DB cluster.
$sel:optionGroupName:CreateDBCluster'
, createDBCluster_optionGroupName
- A value that indicates that the DB cluster should be associated with the
specified option group.
Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
$sel:copyTagsToSnapshot:CreateDBCluster'
, createDBCluster_copyTagsToSnapshot
- A value that indicates whether to copy all tags from the DB cluster to
snapshots of the DB cluster. The default is not to copy them.
$sel:domainIAMRoleName:CreateDBCluster'
, createDBCluster_domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the
Directory Service.
$sel:tags:CreateDBCluster'
, createDBCluster_tags
- Tags to assign to the DB cluster.
$sel:port:CreateDBCluster'
, createDBCluster_port
- The port number on which the instances in the DB cluster accept
connections.
Default: 3306
if engine is set as aurora or 5432
if set to
aurora-postgresql.
$sel:enableIAMDatabaseAuthentication:CreateDBCluster'
, createDBCluster_enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services
Identity and Access Management (IAM) accounts to database accounts. By
default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
$sel:enableCloudwatchLogsExports:CreateDBCluster'
, createDBCluster_enableCloudwatchLogsExports
- The list of log types that need to be enabled for exporting to
CloudWatch Logs. The values in the list depend on the DB engine being
used. For more information, see
Publishing Database Logs to Amazon CloudWatch Logs
in the Amazon Aurora User Guide.
Aurora MySQL
Possible values are audit
, error
, general
, and slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
$sel:dbClusterIdentifier:CreateDBCluster'
, createDBCluster_dbClusterIdentifier
- The DB cluster identifier. This parameter is stored as a lowercase
string.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- First character must be a letter.
- Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
$sel:engine:CreateDBCluster'
, createDBCluster_engine
- The name of the database engine to be used for this DB cluster.
Valid Values: aurora
(for MySQL 5.6-compatible Aurora), aurora-mysql
(for MySQL 5.7-compatible Aurora), and aurora-postgresql
data CreateDBClusterResponse Source #
See: newCreateDBClusterResponse
smart constructor.
Constructors
CreateDBClusterResponse' (Maybe DBCluster) Int |
Instances
newCreateDBClusterResponse Source #
Create a value of CreateDBClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbCluster:CreateDBClusterResponse'
, createDBClusterResponse_dbCluster
- Undocumented member.
$sel:httpStatus:CreateDBClusterResponse'
, createDBClusterResponse_httpStatus
- The response's http status code.
RemoveRoleFromDBCluster
data RemoveRoleFromDBCluster Source #
See: newRemoveRoleFromDBCluster
smart constructor.
Constructors
RemoveRoleFromDBCluster' (Maybe Text) Text Text |
Instances
newRemoveRoleFromDBCluster Source #
Arguments
:: Text | |
-> Text | |
-> RemoveRoleFromDBCluster |
Create a value of RemoveRoleFromDBCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:featureName:RemoveRoleFromDBCluster'
, removeRoleFromDBCluster_featureName
- The name of the feature for the DB cluster that the IAM role is to be
disassociated from. For the list of supported feature names, see
DBEngineVersion.
$sel:dbClusterIdentifier:RemoveRoleFromDBCluster'
, removeRoleFromDBCluster_dbClusterIdentifier
- The name of the DB cluster to disassociate the IAM role from.
$sel:roleArn:RemoveRoleFromDBCluster'
, removeRoleFromDBCluster_roleArn
- The Amazon Resource Name (ARN) of the IAM role to disassociate from the
Aurora DB cluster, for example
arn:aws:iam::123456789012:role/AuroraAccessRole
.
data RemoveRoleFromDBClusterResponse Source #
See: newRemoveRoleFromDBClusterResponse
smart constructor.
Constructors
RemoveRoleFromDBClusterResponse' | |
Instances
Eq RemoveRoleFromDBClusterResponse Source # | |
Defined in Amazonka.RDS.RemoveRoleFromDBCluster | |
Read RemoveRoleFromDBClusterResponse Source # | |
Show RemoveRoleFromDBClusterResponse Source # | |
Defined in Amazonka.RDS.RemoveRoleFromDBCluster Methods showsPrec :: Int -> RemoveRoleFromDBClusterResponse -> ShowS # | |
Generic RemoveRoleFromDBClusterResponse Source # | |
Defined in Amazonka.RDS.RemoveRoleFromDBCluster Associated Types type Rep RemoveRoleFromDBClusterResponse :: Type -> Type # | |
NFData RemoveRoleFromDBClusterResponse Source # | |
Defined in Amazonka.RDS.RemoveRoleFromDBCluster Methods rnf :: RemoveRoleFromDBClusterResponse -> () # | |
type Rep RemoveRoleFromDBClusterResponse Source # | |
Defined in Amazonka.RDS.RemoveRoleFromDBCluster |
newRemoveRoleFromDBClusterResponse :: RemoveRoleFromDBClusterResponse Source #
Create a value of RemoveRoleFromDBClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
FailoverDBCluster
data FailoverDBCluster Source #
See: newFailoverDBCluster
smart constructor.
Constructors
FailoverDBCluster' (Maybe Text) Text |
Instances
Create a value of FailoverDBCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetDBInstanceIdentifier:FailoverDBCluster'
, failoverDBCluster_targetDBInstanceIdentifier
- The name of the instance to promote to the primary instance.
You must specify the instance identifier for an Aurora Replica in the DB
cluster. For example, mydbcluster-replica1
.
$sel:dbClusterIdentifier:FailoverDBCluster'
, failoverDBCluster_dbClusterIdentifier
- A DB cluster identifier to force a failover for. This parameter isn't
case-sensitive.
Constraints:
- Must match the identifier of an existing DBCluster.
data FailoverDBClusterResponse Source #
See: newFailoverDBClusterResponse
smart constructor.
Constructors
FailoverDBClusterResponse' (Maybe DBCluster) Int |
Instances
newFailoverDBClusterResponse Source #
Create a value of FailoverDBClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbCluster:FailoverDBClusterResponse'
, failoverDBClusterResponse_dbCluster
- Undocumented member.
$sel:httpStatus:FailoverDBClusterResponse'
, failoverDBClusterResponse_httpStatus
- The response's http status code.
RevokeDBSecurityGroupIngress
data RevokeDBSecurityGroupIngress Source #
See: newRevokeDBSecurityGroupIngress
smart constructor.
Instances
newRevokeDBSecurityGroupIngress Source #
Arguments
:: Text | |
-> RevokeDBSecurityGroupIngress |
Create a value of RevokeDBSecurityGroupIngress
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eC2SecurityGroupOwnerId:RevokeDBSecurityGroupIngress'
, revokeDBSecurityGroupIngress_eC2SecurityGroupOwnerId
- 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.
$sel:eC2SecurityGroupName:RevokeDBSecurityGroupIngress'
, revokeDBSecurityGroupIngress_eC2SecurityGroupName
- 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.
$sel:cidrip:RevokeDBSecurityGroupIngress'
, revokeDBSecurityGroupIngress_cidrip
- 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.
$sel:eC2SecurityGroupId:RevokeDBSecurityGroupIngress'
, revokeDBSecurityGroupIngress_eC2SecurityGroupId
- 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.
$sel:dbSecurityGroupName:RevokeDBSecurityGroupIngress'
, revokeDBSecurityGroupIngress_dbSecurityGroupName
- The name of the DB security group to revoke ingress from.
data RevokeDBSecurityGroupIngressResponse Source #
See: newRevokeDBSecurityGroupIngressResponse
smart constructor.
Constructors
RevokeDBSecurityGroupIngressResponse' (Maybe DBSecurityGroup) Int |
Instances
newRevokeDBSecurityGroupIngressResponse Source #
Arguments
:: Int | |
-> RevokeDBSecurityGroupIngressResponse |
Create a value of RevokeDBSecurityGroupIngressResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSecurityGroup:RevokeDBSecurityGroupIngressResponse'
, revokeDBSecurityGroupIngressResponse_dbSecurityGroup
- Undocumented member.
$sel:httpStatus:RevokeDBSecurityGroupIngressResponse'
, revokeDBSecurityGroupIngressResponse_httpStatus
- The response's http status code.
ModifyDBParameterGroup
data ModifyDBParameterGroup Source #
See: newModifyDBParameterGroup
smart constructor.
Constructors
ModifyDBParameterGroup' Text [Parameter] |
Instances
newModifyDBParameterGroup Source #
Create a value of ModifyDBParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroupName:ModifyDBParameterGroup'
, modifyDBParameterGroup_dbParameterGroupName
- The name of the DB parameter group.
Constraints:
- If supplied, must match the name of an existing
DBParameterGroup
.
$sel:parameters:ModifyDBParameterGroup'
, modifyDBParameterGroup_parameters
- An array of parameter names, values, and the application methods for the
parameter update. At least one parameter name, value, and application
method 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.
data DBParameterGroupNameMessage Source #
Contains the result of a successful invocation of the
ModifyDBParameterGroup
or ResetDBParameterGroup
action.
See: newDBParameterGroupNameMessage
smart constructor.
Constructors
DBParameterGroupNameMessage' (Maybe Text) |
Instances
newDBParameterGroupNameMessage :: DBParameterGroupNameMessage Source #
Create a value of DBParameterGroupNameMessage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroupName:DBParameterGroupNameMessage'
, dbParameterGroupNameMessage_dbParameterGroupName
- The name of the DB parameter group.
ApplyPendingMaintenanceAction
data ApplyPendingMaintenanceAction Source #
See: newApplyPendingMaintenanceAction
smart constructor.
Constructors
ApplyPendingMaintenanceAction' Text Text Text |
Instances
newApplyPendingMaintenanceAction Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> ApplyPendingMaintenanceAction |
Create a value of ApplyPendingMaintenanceAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceIdentifier:ApplyPendingMaintenanceAction'
, applyPendingMaintenanceAction_resourceIdentifier
- 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).
$sel:applyAction:ApplyPendingMaintenanceAction'
, applyPendingMaintenanceAction_applyAction
- The pending maintenance action to apply to this resource.
Valid values: system-update
, db-upgrade
, hardware-maintenance
,
ca-certificate-rotation
$sel:optInType:ApplyPendingMaintenanceAction'
, applyPendingMaintenanceAction_optInType
- 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 existingnext-maintenance
opt-in requests.
data ApplyPendingMaintenanceActionResponse Source #
See: newApplyPendingMaintenanceActionResponse
smart constructor.
Instances
newApplyPendingMaintenanceActionResponse Source #
Arguments
:: Int | |
-> ApplyPendingMaintenanceActionResponse |
Create a value of ApplyPendingMaintenanceActionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourcePendingMaintenanceActions:ApplyPendingMaintenanceActionResponse'
, applyPendingMaintenanceActionResponse_resourcePendingMaintenanceActions
- Undocumented member.
$sel:httpStatus:ApplyPendingMaintenanceActionResponse'
, applyPendingMaintenanceActionResponse_httpStatus
- The response's http status code.
DeleteDBProxyEndpoint
data DeleteDBProxyEndpoint Source #
See: newDeleteDBProxyEndpoint
smart constructor.
Constructors
DeleteDBProxyEndpoint' Text |
Instances
newDeleteDBProxyEndpoint Source #
Create a value of DeleteDBProxyEndpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbProxyEndpointName:DeleteDBProxyEndpoint'
, deleteDBProxyEndpoint_dbProxyEndpointName
- The name of the DB proxy endpoint to delete.
data DeleteDBProxyEndpointResponse Source #
See: newDeleteDBProxyEndpointResponse
smart constructor.
Constructors
DeleteDBProxyEndpointResponse' (Maybe DBProxyEndpoint) Int |
Instances
newDeleteDBProxyEndpointResponse Source #
Create a value of DeleteDBProxyEndpointResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbProxyEndpoint:DeleteDBProxyEndpointResponse'
, deleteDBProxyEndpointResponse_dbProxyEndpoint
- The data structure representing the details of the DB proxy endpoint
that you delete.
$sel:httpStatus:DeleteDBProxyEndpointResponse'
, deleteDBProxyEndpointResponse_httpStatus
- The response's http status code.
StopDBInstanceAutomatedBackupsReplication
data StopDBInstanceAutomatedBackupsReplication Source #
See: newStopDBInstanceAutomatedBackupsReplication
smart constructor.
Constructors
StopDBInstanceAutomatedBackupsReplication' Text |
Instances
newStopDBInstanceAutomatedBackupsReplication Source #
Arguments
:: Text |
|
-> StopDBInstanceAutomatedBackupsReplication |
Create a value of StopDBInstanceAutomatedBackupsReplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceDBInstanceArn:StopDBInstanceAutomatedBackupsReplication'
, stopDBInstanceAutomatedBackupsReplication_sourceDBInstanceArn
- The Amazon Resource Name (ARN) of the source DB instance for which to
stop replicating automated backups, for example,
arn:aws:rds:us-west-2:123456789012:db:mydatabase
.
data StopDBInstanceAutomatedBackupsReplicationResponse Source #
See: newStopDBInstanceAutomatedBackupsReplicationResponse
smart constructor.
Constructors
StopDBInstanceAutomatedBackupsReplicationResponse' (Maybe DBInstanceAutomatedBackup) Int |
Instances
newStopDBInstanceAutomatedBackupsReplicationResponse Source #
Arguments
:: Int |
|
-> StopDBInstanceAutomatedBackupsReplicationResponse |
Create a value of StopDBInstanceAutomatedBackupsReplicationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstanceAutomatedBackup:StopDBInstanceAutomatedBackupsReplicationResponse'
, stopDBInstanceAutomatedBackupsReplicationResponse_dbInstanceAutomatedBackup
- Undocumented member.
$sel:httpStatus:StopDBInstanceAutomatedBackupsReplicationResponse'
, stopDBInstanceAutomatedBackupsReplicationResponse_httpStatus
- The response's http status code.
CreateOptionGroup
data CreateOptionGroup Source #
See: newCreateOptionGroup
smart constructor.
Instances
Arguments
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> CreateOptionGroup |
Create a value of CreateOptionGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateOptionGroup'
, createOptionGroup_tags
- Tags to assign to the option group.
$sel:optionGroupName:CreateOptionGroup'
, createOptionGroup_optionGroupName
- 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
$sel:engineName:CreateOptionGroup'
, createOptionGroup_engineName
- Specifies the name of the engine that this option group should be
associated with.
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
$sel:majorEngineVersion:CreateOptionGroup'
, createOptionGroup_majorEngineVersion
- Specifies the major version of the engine that this option group should
be associated with.
$sel:optionGroupDescription:CreateOptionGroup'
, createOptionGroup_optionGroupDescription
- The description of the option group.
data CreateOptionGroupResponse Source #
See: newCreateOptionGroupResponse
smart constructor.
Constructors
CreateOptionGroupResponse' (Maybe OptionGroup) Int |
Instances
newCreateOptionGroupResponse Source #
Create a value of CreateOptionGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:optionGroup:CreateOptionGroupResponse'
, createOptionGroupResponse_optionGroup
- Undocumented member.
$sel:httpStatus:CreateOptionGroupResponse'
, createOptionGroupResponse_httpStatus
- The response's http status code.
DescribeAccountAttributes
data DescribeAccountAttributes Source #
See: newDescribeAccountAttributes
smart constructor.
Constructors
DescribeAccountAttributes' | |
Instances
newDescribeAccountAttributes :: DescribeAccountAttributes Source #
Create a value of DescribeAccountAttributes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeAccountAttributesResponse Source #
Data returned by the DescribeAccountAttributes action.
See: newDescribeAccountAttributesResponse
smart constructor.
Constructors
DescribeAccountAttributesResponse' (Maybe [AccountQuota]) Int |
Instances
newDescribeAccountAttributesResponse Source #
Arguments
:: Int | |
-> DescribeAccountAttributesResponse |
Create a value of DescribeAccountAttributesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountQuotas:DescribeAccountAttributesResponse'
, describeAccountAttributesResponse_accountQuotas
- 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.
$sel:httpStatus:DescribeAccountAttributesResponse'
, describeAccountAttributesResponse_httpStatus
- The response's http status code.
DeleteDBSnapshot
data DeleteDBSnapshot Source #
See: newDeleteDBSnapshot
smart constructor.
Constructors
DeleteDBSnapshot' Text |
Instances
Create a value of DeleteDBSnapshot
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSnapshotIdentifier:DeleteDBSnapshot'
, deleteDBSnapshot_dbSnapshotIdentifier
- The DB snapshot identifier.
Constraints: Must be the name of an existing DB snapshot in the
available
state.
data DeleteDBSnapshotResponse Source #
See: newDeleteDBSnapshotResponse
smart constructor.
Constructors
DeleteDBSnapshotResponse' (Maybe DBSnapshot) Int |
Instances
newDeleteDBSnapshotResponse Source #
Create a value of DeleteDBSnapshotResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSnapshot:DeleteDBSnapshotResponse'
, deleteDBSnapshotResponse_dbSnapshot
- Undocumented member.
$sel:httpStatus:DeleteDBSnapshotResponse'
, deleteDBSnapshotResponse_httpStatus
- The response's http status code.
DescribeDBClusterParameters (Paginated)
data DescribeDBClusterParameters Source #
See: newDescribeDBClusterParameters
smart constructor.
Constructors
DescribeDBClusterParameters' (Maybe [Filter]) (Maybe Text) (Maybe Int) (Maybe Text) Text |
Instances
newDescribeDBClusterParameters Source #
Arguments
:: Text |
|
-> DescribeDBClusterParameters |
Create a value of DescribeDBClusterParameters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeDBClusterParameters'
, describeDBClusterParameters_filters
- This parameter isn't currently supported.
$sel:marker:DescribeDBClusterParameters'
, describeDBClusterParameters_marker
- 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
.
$sel:maxRecords:DescribeDBClusterParameters'
, describeDBClusterParameters_maxRecords
- 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.
$sel:source:DescribeDBClusterParameters'
, describeDBClusterParameters_source
- A value that indicates to return only parameters for a specific source.
Parameter sources can be engine
, service
, or customer
.
$sel:dbClusterParameterGroupName:DescribeDBClusterParameters'
, describeDBClusterParameters_dbClusterParameterGroupName
- 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.
data DescribeDBClusterParametersResponse Source #
Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.
See: newDescribeDBClusterParametersResponse
smart constructor.
Instances
newDescribeDBClusterParametersResponse Source #
Arguments
:: Int | |
-> DescribeDBClusterParametersResponse |
Create a value of DescribeDBClusterParametersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeDBClusterParameters'
, describeDBClusterParametersResponse_marker
- 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
.
$sel:parameters:DescribeDBClusterParametersResponse'
, describeDBClusterParametersResponse_parameters
- Provides a list of parameters for the DB cluster parameter group.
$sel:httpStatus:DescribeDBClusterParametersResponse'
, describeDBClusterParametersResponse_httpStatus
- The response's http status code.
DeleteDBSubnetGroup
data DeleteDBSubnetGroup Source #
See: newDeleteDBSubnetGroup
smart constructor.
Constructors
DeleteDBSubnetGroup' Text |
Instances
newDeleteDBSubnetGroup Source #
Create a value of DeleteDBSubnetGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSubnetGroupName:DeleteDBSubnetGroup'
, deleteDBSubnetGroup_dbSubnetGroupName
- The name of the database subnet group to delete.
You can't delete the default subnet group.
Constraints:
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
data DeleteDBSubnetGroupResponse Source #
See: newDeleteDBSubnetGroupResponse
smart constructor.
Constructors
DeleteDBSubnetGroupResponse' | |
Instances
newDeleteDBSubnetGroupResponse :: DeleteDBSubnetGroupResponse Source #
Create a value of DeleteDBSubnetGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateDBSecurityGroup
data CreateDBSecurityGroup Source #
See: newCreateDBSecurityGroup
smart constructor.
Constructors
CreateDBSecurityGroup' (Maybe [Tag]) Text Text |
Instances
newCreateDBSecurityGroup Source #
Arguments
:: Text | |
-> Text | |
-> CreateDBSecurityGroup |
Create a value of CreateDBSecurityGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateDBSecurityGroup'
, createDBSecurityGroup_tags
- Tags to assign to the DB security group.
$sel:dbSecurityGroupName:CreateDBSecurityGroup'
, createDBSecurityGroup_dbSecurityGroupName
- 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
$sel:dbSecurityGroupDescription:CreateDBSecurityGroup'
, createDBSecurityGroup_dbSecurityGroupDescription
- The description for the DB security group.
data CreateDBSecurityGroupResponse Source #
See: newCreateDBSecurityGroupResponse
smart constructor.
Constructors
CreateDBSecurityGroupResponse' (Maybe DBSecurityGroup) Int |
Instances
newCreateDBSecurityGroupResponse Source #
Create a value of CreateDBSecurityGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSecurityGroup:CreateDBSecurityGroupResponse'
, createDBSecurityGroupResponse_dbSecurityGroup
- Undocumented member.
$sel:httpStatus:CreateDBSecurityGroupResponse'
, createDBSecurityGroupResponse_httpStatus
- The response's http status code.
ModifyCertificates
data ModifyCertificates Source #
See: newModifyCertificates
smart constructor.
Constructors
ModifyCertificates' (Maybe Text) (Maybe Bool) |
Instances
newModifyCertificates :: ModifyCertificates Source #
Create a value of ModifyCertificates
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:certificateIdentifier:ModifyCertificates'
, modifyCertificates_certificateIdentifier
- 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.
$sel:removeCustomerOverride:ModifyCertificates'
, modifyCertificates_removeCustomerOverride
- A value that indicates whether to remove the override for the default
certificate. If the override is removed, the default certificate is the
system default.
data ModifyCertificatesResponse Source #
See: newModifyCertificatesResponse
smart constructor.
Constructors
ModifyCertificatesResponse' (Maybe Certificate) Int |
Instances
newModifyCertificatesResponse Source #
Create a value of ModifyCertificatesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:certificate:ModifyCertificatesResponse'
, modifyCertificatesResponse_certificate
- Undocumented member.
$sel:httpStatus:ModifyCertificatesResponse'
, modifyCertificatesResponse_httpStatus
- The response's http status code.
DescribeDBClusterSnapshots (Paginated)
data DescribeDBClusterSnapshots Source #
See: newDescribeDBClusterSnapshots
smart constructor.
Constructors
DescribeDBClusterSnapshots' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) |
Instances
newDescribeDBClusterSnapshots :: DescribeDBClusterSnapshots Source #
Create a value of DescribeDBClusterSnapshots
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterIdentifier:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_dbClusterIdentifier
- 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.
$sel:includeShared:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_includeShared
- A value that indicates whether to include shared manual DB cluster
snapshots from other Amazon Web Services accounts that this Amazon Web
Services account has been given permission to copy or restore. By
default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a
manual DB cluster snapshot from another Amazon Web Services account by
the ModifyDBClusterSnapshotAttribute
API action.
$sel:dbClusterSnapshotIdentifier:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_dbClusterSnapshotIdentifier
- 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.
$sel:filters:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_filters
- 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.
$sel:snapshotType:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_snapshotType
- 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
.
$sel:marker:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_marker
- 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
.
$sel:maxRecords:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_maxRecords
- 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.
$sel:includePublic:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_includePublic
- A value that indicates whether to include manual DB cluster snapshots
that are public and can be copied or restored by any Amazon Web Services
account. By default, the public snapshots are not included.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
data DescribeDBClusterSnapshotsResponse Source #
Provides a list of DB cluster snapshots for the user as the result of a
call to the DescribeDBClusterSnapshots
action.
See: newDescribeDBClusterSnapshotsResponse
smart constructor.
Constructors
DescribeDBClusterSnapshotsResponse' (Maybe Text) (Maybe [DBClusterSnapshot]) Int |
Instances
newDescribeDBClusterSnapshotsResponse Source #
Arguments
:: Int | |
-> DescribeDBClusterSnapshotsResponse |
Create a value of DescribeDBClusterSnapshotsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeDBClusterSnapshots'
, describeDBClusterSnapshotsResponse_marker
- 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
.
$sel:dbClusterSnapshots:DescribeDBClusterSnapshotsResponse'
, describeDBClusterSnapshotsResponse_dbClusterSnapshots
- Provides a list of DB cluster snapshots for the user.
$sel:httpStatus:DescribeDBClusterSnapshotsResponse'
, describeDBClusterSnapshotsResponse_httpStatus
- The response's http status code.
RebootDBInstance
data RebootDBInstance Source #
See: newRebootDBInstance
smart constructor.
Constructors
RebootDBInstance' (Maybe Bool) Text |
Instances
Create a value of RebootDBInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:forceFailover:RebootDBInstance'
, rebootDBInstance_forceFailover
- A value that indicates whether the reboot is conducted through a
Multi-AZ failover.
Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
$sel:dbInstanceIdentifier:RebootDBInstance'
, rebootDBInstance_dbInstanceIdentifier
- The DB instance identifier. This parameter is stored as a lowercase
string.
Constraints:
- Must match the identifier of an existing DBInstance.
data RebootDBInstanceResponse Source #
See: newRebootDBInstanceResponse
smart constructor.
Constructors
RebootDBInstanceResponse' (Maybe DBInstance) Int |
Instances
newRebootDBInstanceResponse Source #
Create a value of RebootDBInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstance:RebootDBInstanceResponse'
, rebootDBInstanceResponse_dbInstance
- Undocumented member.
$sel:httpStatus:RebootDBInstanceResponse'
, rebootDBInstanceResponse_httpStatus
- The response's http status code.
CreateDBSubnetGroup
data CreateDBSubnetGroup Source #
See: newCreateDBSubnetGroup
smart constructor.
Instances
newCreateDBSubnetGroup Source #
Arguments
:: Text | |
-> Text | |
-> CreateDBSubnetGroup |
Create a value of CreateDBSubnetGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateDBSubnetGroup'
, createDBSubnetGroup_tags
- Tags to assign to the DB subnet group.
$sel:dbSubnetGroupName:CreateDBSubnetGroup'
, createDBSubnetGroup_dbSubnetGroupName
- 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.
Example: mySubnetgroup
$sel:dbSubnetGroupDescription:CreateDBSubnetGroup'
, createDBSubnetGroup_dbSubnetGroupDescription
- The description for the DB subnet group.
$sel:subnetIds:CreateDBSubnetGroup'
, createDBSubnetGroup_subnetIds
- The EC2 Subnet IDs for the DB subnet group.
data CreateDBSubnetGroupResponse Source #
See: newCreateDBSubnetGroupResponse
smart constructor.
Constructors
CreateDBSubnetGroupResponse' (Maybe DBSubnetGroup) Int |
Instances
newCreateDBSubnetGroupResponse Source #
Create a value of CreateDBSubnetGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSubnetGroup:CreateDBSubnetGroupResponse'
, createDBSubnetGroupResponse_dbSubnetGroup
- Undocumented member.
$sel:httpStatus:CreateDBSubnetGroupResponse'
, createDBSubnetGroupResponse_httpStatus
- The response's http status code.
DescribeReservedDBInstancesOfferings (Paginated)
data DescribeReservedDBInstancesOfferings Source #
See: newDescribeReservedDBInstancesOfferings
smart constructor.
Constructors
DescribeReservedDBInstancesOfferings' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newDescribeReservedDBInstancesOfferings :: DescribeReservedDBInstancesOfferings Source #
Create a value of DescribeReservedDBInstancesOfferings
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:productDescription:DescribeReservedDBInstancesOfferings'
, describeReservedDBInstancesOfferings_productDescription
- 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.
$sel:filters:DescribeReservedDBInstancesOfferings'
, describeReservedDBInstancesOfferings_filters
- This parameter isn't currently supported.
$sel:dbInstanceClass:DescribeReservedDBInstancesOfferings'
, describeReservedDBInstancesOfferings_dbInstanceClass
- The DB instance class filter value. Specify this parameter to show only
the available offerings matching the specified DB instance class.
$sel:marker:DescribeReservedDBInstancesOfferings'
, describeReservedDBInstancesOfferings_marker
- 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
.
$sel:maxRecords:DescribeReservedDBInstancesOfferings'
, describeReservedDBInstancesOfferings_maxRecords
- 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.
$sel:multiAZ:DescribeReservedDBInstancesOfferings'
, describeReservedDBInstancesOfferings_multiAZ
- A value that indicates whether to show only those reservations that
support Multi-AZ.
$sel:reservedDBInstancesOfferingId:DescribeReservedDBInstancesOfferings'
, describeReservedDBInstancesOfferings_reservedDBInstancesOfferingId
- 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
$sel:offeringType:DescribeReservedDBInstancesOfferings'
, describeReservedDBInstancesOfferings_offeringType
- 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"
$sel:duration:DescribeReservedDBInstancesOfferings'
, describeReservedDBInstancesOfferings_duration
- Duration filter value, specified in years or seconds. Specify this
parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
data DescribeReservedDBInstancesOfferingsResponse Source #
Contains the result of a successful invocation of the
DescribeReservedDBInstancesOfferings
action.
See: newDescribeReservedDBInstancesOfferingsResponse
smart constructor.
Constructors
DescribeReservedDBInstancesOfferingsResponse' (Maybe Text) (Maybe [ReservedDBInstancesOffering]) Int |
Instances
newDescribeReservedDBInstancesOfferingsResponse Source #
Arguments
:: Int |
|
-> DescribeReservedDBInstancesOfferingsResponse |
Create a value of DescribeReservedDBInstancesOfferingsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeReservedDBInstancesOfferings'
, describeReservedDBInstancesOfferingsResponse_marker
- 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
.
$sel:reservedDBInstancesOfferings:DescribeReservedDBInstancesOfferingsResponse'
, describeReservedDBInstancesOfferingsResponse_reservedDBInstancesOfferings
- A list of reserved DB instance offerings.
$sel:httpStatus:DescribeReservedDBInstancesOfferingsResponse'
, describeReservedDBInstancesOfferingsResponse_httpStatus
- The response's http status code.
DeleteDBSecurityGroup
data DeleteDBSecurityGroup Source #
See: newDeleteDBSecurityGroup
smart constructor.
Constructors
DeleteDBSecurityGroup' Text |
Instances
newDeleteDBSecurityGroup Source #
Create a value of DeleteDBSecurityGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSecurityGroupName:DeleteDBSecurityGroup'
, deleteDBSecurityGroup_dbSecurityGroupName
- 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"
data DeleteDBSecurityGroupResponse Source #
See: newDeleteDBSecurityGroupResponse
smart constructor.
Constructors
DeleteDBSecurityGroupResponse' | |
Instances
Eq DeleteDBSecurityGroupResponse Source # | |
Defined in Amazonka.RDS.DeleteDBSecurityGroup | |
Read DeleteDBSecurityGroupResponse Source # | |
Show DeleteDBSecurityGroupResponse Source # | |
Defined in Amazonka.RDS.DeleteDBSecurityGroup Methods showsPrec :: Int -> DeleteDBSecurityGroupResponse -> ShowS # show :: DeleteDBSecurityGroupResponse -> String # showList :: [DeleteDBSecurityGroupResponse] -> ShowS # | |
Generic DeleteDBSecurityGroupResponse Source # | |
Defined in Amazonka.RDS.DeleteDBSecurityGroup Associated Types type Rep DeleteDBSecurityGroupResponse :: Type -> Type # | |
NFData DeleteDBSecurityGroupResponse Source # | |
Defined in Amazonka.RDS.DeleteDBSecurityGroup Methods rnf :: DeleteDBSecurityGroupResponse -> () # | |
type Rep DeleteDBSecurityGroupResponse Source # | |
Defined in Amazonka.RDS.DeleteDBSecurityGroup |
newDeleteDBSecurityGroupResponse :: DeleteDBSecurityGroupResponse Source #
Create a value of DeleteDBSecurityGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteDBInstance
data DeleteDBInstance Source #
See: newDeleteDBInstance
smart constructor.
Instances
Create a value of DeleteDBInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:finalDBSnapshotIdentifier:DeleteDBInstance'
, deleteDBInstance_finalDBSnapshotIdentifier
- The DBSnapshotIdentifier
of the new DBSnapshot
created when the
SkipFinalSnapshot
parameter is disabled.
Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.
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.
$sel:deleteAutomatedBackups:DeleteDBInstance'
, deleteDBInstance_deleteAutomatedBackups
- A value that indicates whether to remove automated backups immediately
after the DB instance is deleted. This parameter isn't case-sensitive.
The default is to remove automated backups immediately after the DB
instance is deleted.
$sel:skipFinalSnapshot:DeleteDBInstance'
, deleteDBInstance_skipFinalSnapshot
- A value that indicates whether to skip the creation of a final DB
snapshot before the DB instance is deleted. If skip is specified, no DB
snapshot is created. If skip isn't specified, a DB snapshot is created
before the DB instance is deleted. By default, skip isn't specified,
and the DB snapshot is created.
When a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.
Specify skip when deleting a read replica.
The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.
$sel:dbInstanceIdentifier:DeleteDBInstance'
, deleteDBInstance_dbInstanceIdentifier
- 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.
data DeleteDBInstanceResponse Source #
See: newDeleteDBInstanceResponse
smart constructor.
Constructors
DeleteDBInstanceResponse' (Maybe DBInstance) Int |
Instances
newDeleteDBInstanceResponse Source #
Create a value of DeleteDBInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstance:DeleteDBInstanceResponse'
, deleteDBInstanceResponse_dbInstance
- Undocumented member.
$sel:httpStatus:DeleteDBInstanceResponse'
, deleteDBInstanceResponse_httpStatus
- The response's http status code.
StartActivityStream
data StartActivityStream Source #
See: newStartActivityStream
smart constructor.
Constructors
StartActivityStream' (Maybe Bool) (Maybe Bool) Text ActivityStreamMode Text |
Instances
newStartActivityStream Source #
Arguments
:: Text | |
-> ActivityStreamMode | |
-> Text | |
-> StartActivityStream |
Create a value of StartActivityStream
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineNativeAuditFieldsIncluded:StartActivityStream'
, startActivityStream_engineNativeAuditFieldsIncluded
- Specifies whether the database activity stream includes engine-native
audit fields. This option only applies to an Oracle DB instance. By
default, no engine-native audit fields are included.
$sel:applyImmediately:StartActivityStream'
, startActivityStream_applyImmediately
- Specifies whether or not the database activity stream is to start as
soon as possible, regardless of the maintenance window for the database.
$sel:resourceArn:StartActivityStream'
, startActivityStream_resourceArn
- The Amazon Resource Name (ARN) of the DB cluster, for example,
arn:aws:rds:us-east-1:12345667890:cluster:das-cluster
.
$sel:mode:StartActivityStream'
, startActivityStream_mode
- 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.
$sel:kmsKeyId:StartActivityStream'
, startActivityStream_kmsKeyId
- 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 Amazon Web
Services KMS customer master key (CMK).
data StartActivityStreamResponse Source #
See: newStartActivityStreamResponse
smart constructor.
Constructors
StartActivityStreamResponse' (Maybe ActivityStreamStatus) (Maybe Text) (Maybe Bool) (Maybe ActivityStreamMode) (Maybe Text) (Maybe Bool) Int |
Instances
newStartActivityStreamResponse Source #
Create a value of StartActivityStreamResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:StartActivityStreamResponse'
, startActivityStreamResponse_status
- The status of the database activity stream.
$sel:kinesisStreamName:StartActivityStreamResponse'
, startActivityStreamResponse_kinesisStreamName
- The name of the Amazon Kinesis data stream to be used for the database
activity stream.
$sel:engineNativeAuditFieldsIncluded:StartActivityStream'
, startActivityStreamResponse_engineNativeAuditFieldsIncluded
- Indicates whether engine-native audit fields are included in the
database activity stream.
$sel:mode:StartActivityStream'
, startActivityStreamResponse_mode
- The mode of the database activity stream.
$sel:kmsKeyId:StartActivityStream'
, startActivityStreamResponse_kmsKeyId
- The Amazon Web Services KMS key identifier for encryption of messages in
the database activity stream.
$sel:applyImmediately:StartActivityStream'
, startActivityStreamResponse_applyImmediately
- Indicates whether or not the database activity stream will start as soon
as possible, regardless of the maintenance window for the database.
$sel:httpStatus:StartActivityStreamResponse'
, startActivityStreamResponse_httpStatus
- The response's http status code.
CreateDBInstanceReadReplica
data CreateDBInstanceReadReplica Source #
See: newCreateDBInstanceReadReplica
smart constructor.
Constructors
CreateDBInstanceReadReplica' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe ReplicaMode) (Maybe Int) (Maybe Text) (Maybe [ProcessorFeature]) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [Text]) Text Text |
Instances
newCreateDBInstanceReadReplica Source #
Arguments
:: Text | |
-> Text |
|
-> CreateDBInstanceReadReplica |
Create a value of CreateDBInstanceReadReplica
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deletionProtection:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_deletionProtection
- A value that indicates whether the DB instance has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled. For more
information, see
Deleting a DB Instance.
$sel:publiclyAccessible:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_publiclyAccessible
- A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.
$sel:autoMinorVersionUpgrade:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_autoMinorVersionUpgrade
- A value that indicates whether minor engine upgrades are applied
automatically to the read replica during the maintenance window.
Default: Inherits from the source DB instance
$sel:dbSubnetGroupName:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_dbSubnetGroupName
- Specifies a DB subnet group for the DB instance. The new DB instance is
created in the VPC associated with the DB subnet group. If no DB subnet
group is specified, then the new DB instance isn't created in a VPC.
Constraints:
- Can only be specified if the source DB instance identifier specifies a DB instance in another Amazon Web Services Region.
- If supplied, must match the name of an existing DBSubnetGroup.
- The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.
All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:>
- Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.
- Not specify a DB subnet group. All these read replicas are created outside of any VPC.
Example: mySubnetgroup
$sel:monitoringRoleArn:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_monitoringRoleArn
- 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.
$sel:iops:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_iops
- The amount of Provisioned IOPS (input/output operations per second) to
be initially allocated for the DB instance.
$sel:domain:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_domain
- 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.
$sel:replicaMode:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_replicaMode
- 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 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.
$sel:monitoringInterval:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the read replica. To disable collecting
Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn
is specified, then you must also set
MonitoringInterval
to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
$sel:preSignedUrl:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_preSignedUrl
- The URL that contains a Signature Version 4 signed request for the
CreateDBInstanceReadReplica
API action in the source Amazon Web
Services Region that contains the source DB instance.
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 action that can be executed 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 theCreateDBInstanceReadReplica
action 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
action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to theCreateDBInstanceReadReplica
action in the us-west-2 Amazon Web Services Region. For this example, theDestinationRegion
in the presigned URL must be set to the us-east-1 Amazon Web Services Region.KmsKeyId
- The Amazon Web Services 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 theCreateDBInstanceReadReplica
action that is called in the destination Amazon Web Services Region, and the action 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 yourSourceDBInstanceIdentifier
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 be executed in the source Amazon Web Services Region.
SourceRegion
isn't supported for SQL Server, because SQL Server on
Amazon RDS doesn't support cross-region read replicas.
$sel:processorFeatures:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_processorFeatures
- The number of CPU cores and the number of threads per core for the DB
instance class of the DB instance.
$sel:dbInstanceClass:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_dbInstanceClass
- 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 from the source DB instance.
$sel:performanceInsightsRetentionPeriod:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_performanceInsightsRetentionPeriod
- The amount of time, in days, to retain Performance Insights data. Valid
values are 7 or 731 (2 years).
$sel:destinationRegion:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_destinationRegion
- Pseudo-parameter used when populating the PreSignedUrl
of a
cross-region CreateDBInstanceReadReplica
request. To replicate from
region SRC
to region DST
, send a request to region DST
. In that
request, pass a PreSignedUrl
for region SRC
with DestinationRegion
set to region DST
.
$sel:maxAllocatedStorage:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_maxAllocatedStorage
- 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.
$sel:enablePerformanceInsights:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_enablePerformanceInsights
- A value that indicates whether to enable Performance Insights for the
read replica.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
$sel:kmsKeyId:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_kmsKeyId
- 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 Amazon Web Services KMS CMK.
If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance, then do not specify a value for this parameter. A read replica in the same Region is always encrypted with the same Amazon Web Services KMS CMK as the source DB instance.
If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs 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.
$sel:dbParameterGroupName:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_dbParameterGroupName
- The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName
, then Amazon
RDS uses the DBParameterGroup
of source DB instance for a same region
read replica, or the default DBParameterGroup
for the specified DB
engine for a cross region read replica.
Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.
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
$sel:availabilityZone:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_availabilityZone
- 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
$sel:performanceInsightsKMSKeyId:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_performanceInsightsKMSKeyId
- 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 Amazon Web Services KMS customer master key (CMK).
If you do not specify a value for PerformanceInsightsKMSKeyId
, then
Amazon RDS uses your default CMK. There is a default CMK for your Amazon
Web Services account. Your Amazon Web Services account has a different
default CMK for each Amazon Web Services Region.
$sel:vpcSecurityGroupIds:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with the read replica.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
$sel:multiAZ:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_multiAZ
- A value that indicates whether the read replica is in a Multi-AZ
deployment.
You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.
$sel:optionGroupName:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_optionGroupName
- The option group the DB instance is associated with. If omitted, the
option group associated with the source instance is used.
For SQL Server, you must use the option group associated with the source instance.
$sel:copyTagsToSnapshot:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_copyTagsToSnapshot
- A value that indicates whether to copy all tags from the read replica to
snapshots of the read replica. By default, tags are not copied.
$sel:domainIAMRoleName:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the
Directory Service.
$sel:tags:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_tags
- Undocumented member.
$sel:port:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_port
- The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
$sel:enableIAMDatabaseAuthentication:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services
Identity and Access Management (IAM) accounts to database accounts. By
default, mapping is disabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
$sel:useDefaultProcessorFeatures:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_useDefaultProcessorFeatures
- A value that indicates whether the DB instance class of the DB instance
uses its default processor features.
$sel:storageType:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_storageType
- Specifies the storage type to be associated with the read replica.
Valid values: standard | gp2 | io1
If you specify io1
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise gp2
$sel:enableCloudwatchLogsExports:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_enableCloudwatchLogsExports
- 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.
$sel:dbInstanceIdentifier:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_dbInstanceIdentifier
- 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.
$sel:sourceDBInstanceIdentifier:CreateDBInstanceReadReplica'
, createDBInstanceReadReplica_sourceDBInstanceIdentifier
- The identifier of the DB instance that will act as the source for the
read replica. Each DB instance can have up to five read replicas.
Constraints:
- Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.
- Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later.
- For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide.
- For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide.
- Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).
- The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.
- If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.
- If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server, which doesn't support cross-region replicas.
data CreateDBInstanceReadReplicaResponse Source #
See: newCreateDBInstanceReadReplicaResponse
smart constructor.
Constructors
CreateDBInstanceReadReplicaResponse' (Maybe DBInstance) Int |
Instances
newCreateDBInstanceReadReplicaResponse Source #
Arguments
:: Int | |
-> CreateDBInstanceReadReplicaResponse |
Create a value of CreateDBInstanceReadReplicaResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstance:CreateDBInstanceReadReplicaResponse'
, createDBInstanceReadReplicaResponse_dbInstance
- Undocumented member.
$sel:httpStatus:CreateDBInstanceReadReplicaResponse'
, createDBInstanceReadReplicaResponse_httpStatus
- The response's http status code.
DeleteDBParameterGroup
data DeleteDBParameterGroup Source #
See: newDeleteDBParameterGroup
smart constructor.
Constructors
DeleteDBParameterGroup' Text |
Instances
newDeleteDBParameterGroup Source #
Create a value of DeleteDBParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroupName:DeleteDBParameterGroup'
, deleteDBParameterGroup_dbParameterGroupName
- 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
data DeleteDBParameterGroupResponse Source #
See: newDeleteDBParameterGroupResponse
smart constructor.
Constructors
DeleteDBParameterGroupResponse' | |
Instances
Eq DeleteDBParameterGroupResponse Source # | |
Defined in Amazonka.RDS.DeleteDBParameterGroup | |
Read DeleteDBParameterGroupResponse Source # | |
Show DeleteDBParameterGroupResponse Source # | |
Defined in Amazonka.RDS.DeleteDBParameterGroup Methods showsPrec :: Int -> DeleteDBParameterGroupResponse -> ShowS # show :: DeleteDBParameterGroupResponse -> String # showList :: [DeleteDBParameterGroupResponse] -> ShowS # | |
Generic DeleteDBParameterGroupResponse Source # | |
Defined in Amazonka.RDS.DeleteDBParameterGroup Associated Types type Rep DeleteDBParameterGroupResponse :: Type -> Type # | |
NFData DeleteDBParameterGroupResponse Source # | |
Defined in Amazonka.RDS.DeleteDBParameterGroup Methods rnf :: DeleteDBParameterGroupResponse -> () # | |
type Rep DeleteDBParameterGroupResponse Source # | |
Defined in Amazonka.RDS.DeleteDBParameterGroup |
newDeleteDBParameterGroupResponse :: DeleteDBParameterGroupResponse Source #
Create a value of DeleteDBParameterGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ModifyCurrentDBClusterCapacity
data ModifyCurrentDBClusterCapacity Source #
See: newModifyCurrentDBClusterCapacity
smart constructor.
Instances
newModifyCurrentDBClusterCapacity Source #
Arguments
:: Text | |
-> ModifyCurrentDBClusterCapacity |
Create a value of ModifyCurrentDBClusterCapacity
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:timeoutAction:ModifyCurrentDBClusterCapacity'
, modifyCurrentDBClusterCapacity_timeoutAction
- 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.
$sel:capacity:ModifyCurrentDBClusterCapacity'
, modifyCurrentDBClusterCapacity_capacity
- The DB cluster capacity.
When you change the capacity of a paused Aurora Serverless DB cluster, it automatically resumes.
Constraints:
- For Aurora MySQL, valid capacity values are
1
,2
,4
,8
,16
,32
,64
,128
, and256
. - For Aurora PostgreSQL, valid capacity values are
2
,4
,8
,16
,32
,64
,192
, and384
.
$sel:secondsBeforeTimeout:ModifyCurrentDBClusterCapacity'
, modifyCurrentDBClusterCapacity_secondsBeforeTimeout
- The amount of time, in seconds, that Aurora Serverless 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.
$sel:dbClusterIdentifier:ModifyCurrentDBClusterCapacity'
, modifyCurrentDBClusterCapacity_dbClusterIdentifier
- 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.
data ModifyCurrentDBClusterCapacityResponse Source #
See: newModifyCurrentDBClusterCapacityResponse
smart constructor.
Constructors
ModifyCurrentDBClusterCapacityResponse' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Int) Int |
Instances
newModifyCurrentDBClusterCapacityResponse Source #
Arguments
:: Int | |
-> ModifyCurrentDBClusterCapacityResponse |
Create a value of ModifyCurrentDBClusterCapacityResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterIdentifier:ModifyCurrentDBClusterCapacity'
, modifyCurrentDBClusterCapacityResponse_dbClusterIdentifier
- A user-supplied DB cluster identifier. This identifier is the unique key
that identifies a DB cluster.
$sel:timeoutAction:ModifyCurrentDBClusterCapacity'
, modifyCurrentDBClusterCapacityResponse_timeoutAction
- The timeout action of a call to ModifyCurrentDBClusterCapacity
, either
ForceApplyCapacityChange
or RollbackCapacityChange
.
$sel:currentCapacity:ModifyCurrentDBClusterCapacityResponse'
, modifyCurrentDBClusterCapacityResponse_currentCapacity
- The current capacity of the DB cluster.
$sel:pendingCapacity:ModifyCurrentDBClusterCapacityResponse'
, modifyCurrentDBClusterCapacityResponse_pendingCapacity
- A value that specifies the capacity that the DB cluster scales to next.
$sel:secondsBeforeTimeout:ModifyCurrentDBClusterCapacity'
, modifyCurrentDBClusterCapacityResponse_secondsBeforeTimeout
- The number of seconds before a call to ModifyCurrentDBClusterCapacity
times out.
$sel:httpStatus:ModifyCurrentDBClusterCapacityResponse'
, modifyCurrentDBClusterCapacityResponse_httpStatus
- The response's http status code.
ModifyGlobalCluster
data ModifyGlobalCluster Source #
See: newModifyGlobalCluster
smart constructor.
Instances
newModifyGlobalCluster :: ModifyGlobalCluster Source #
Create a value of ModifyGlobalCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:ModifyGlobalCluster'
, modifyGlobalCluster_engineVersion
- The version number of the database engine to which you want to upgrade.
Changing this parameter results in an outage. The change is applied
during the next maintenance window unless ApplyImmediately
is enabled.
To list all of the available engine versions for aurora
(for MySQL
5.6-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
To list all of the available engine versions for aurora-mysql
(for
MySQL 5.7-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
To list all of the available engine versions for aurora-postgresql
,
use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
$sel:deletionProtection:ModifyGlobalCluster'
, modifyGlobalCluster_deletionProtection
- Indicates if the global database cluster has deletion protection
enabled. The global database cluster can't be deleted when deletion
protection is enabled.
$sel:globalClusterIdentifier:ModifyGlobalCluster'
, modifyGlobalCluster_globalClusterIdentifier
- The DB cluster identifier for the global cluster being modified. This
parameter isn't case-sensitive.
Constraints:
- Must match the identifier of an existing global database cluster.
$sel:allowMajorVersionUpgrade:ModifyGlobalCluster'
, modifyGlobalCluster_allowMajorVersionUpgrade
- A value that indicates whether major version upgrades are allowed.
Constraints: You must allow major version upgrades when specifying a
value for the EngineVersion
parameter that is a different major
version than the DB cluster's current version.
If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.
$sel:newGlobalClusterIdentifier':ModifyGlobalCluster'
, modifyGlobalCluster_newGlobalClusterIdentifier
- The new cluster identifier for the global database cluster when
modifying a global database cluster. This value is stored as a lowercase
string.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens
- The first character must be a letter
- Can't end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
data ModifyGlobalClusterResponse Source #
See: newModifyGlobalClusterResponse
smart constructor.
Constructors
ModifyGlobalClusterResponse' (Maybe GlobalCluster) Int |
Instances
newModifyGlobalClusterResponse Source #
Create a value of ModifyGlobalClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalCluster:ModifyGlobalClusterResponse'
, modifyGlobalClusterResponse_globalCluster
- Undocumented member.
$sel:httpStatus:ModifyGlobalClusterResponse'
, modifyGlobalClusterResponse_httpStatus
- The response's http status code.
RegisterDBProxyTargets
data RegisterDBProxyTargets Source #
See: newRegisterDBProxyTargets
smart constructor.
Instances
newRegisterDBProxyTargets Source #
Create a value of RegisterDBProxyTargets
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterIdentifiers:RegisterDBProxyTargets'
, registerDBProxyTargets_dbClusterIdentifiers
- One or more DB cluster identifiers.
$sel:dbInstanceIdentifiers:RegisterDBProxyTargets'
, registerDBProxyTargets_dbInstanceIdentifiers
- One or more DB instance identifiers.
$sel:targetGroupName:RegisterDBProxyTargets'
, registerDBProxyTargets_targetGroupName
- The identifier of the DBProxyTargetGroup
.
$sel:dbProxyName:RegisterDBProxyTargets'
, registerDBProxyTargets_dbProxyName
- The identifier of the DBProxy
that is associated with the
DBProxyTargetGroup
.
data RegisterDBProxyTargetsResponse Source #
See: newRegisterDBProxyTargetsResponse
smart constructor.
Constructors
RegisterDBProxyTargetsResponse' (Maybe [DBProxyTarget]) Int |
Instances
newRegisterDBProxyTargetsResponse Source #
Create a value of RegisterDBProxyTargetsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbProxyTargets:RegisterDBProxyTargetsResponse'
, registerDBProxyTargetsResponse_dbProxyTargets
- One or more DBProxyTarget
objects that are created when you register
targets with a target group.
$sel:httpStatus:RegisterDBProxyTargetsResponse'
, registerDBProxyTargetsResponse_httpStatus
- The response's http status code.
DescribeDBSecurityGroups (Paginated)
data DescribeDBSecurityGroups Source #
See: newDescribeDBSecurityGroups
smart constructor.
Instances
newDescribeDBSecurityGroups :: DescribeDBSecurityGroups Source #
Create a value of DescribeDBSecurityGroups
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeDBSecurityGroups'
, describeDBSecurityGroups_filters
- This parameter isn't currently supported.
$sel:marker:DescribeDBSecurityGroups'
, describeDBSecurityGroups_marker
- 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
.
$sel:maxRecords:DescribeDBSecurityGroups'
, describeDBSecurityGroups_maxRecords
- 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.
$sel:dbSecurityGroupName:DescribeDBSecurityGroups'
, describeDBSecurityGroups_dbSecurityGroupName
- The name of the DB security group to return details for.
data DescribeDBSecurityGroupsResponse Source #
Contains the result of a successful invocation of the
DescribeDBSecurityGroups
action.
See: newDescribeDBSecurityGroupsResponse
smart constructor.
Constructors
DescribeDBSecurityGroupsResponse' (Maybe [DBSecurityGroup]) (Maybe Text) Int |
Instances
newDescribeDBSecurityGroupsResponse Source #
Create a value of DescribeDBSecurityGroupsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSecurityGroups:DescribeDBSecurityGroupsResponse'
, describeDBSecurityGroupsResponse_dbSecurityGroups
- A list of DBSecurityGroup
instances.
$sel:marker:DescribeDBSecurityGroups'
, describeDBSecurityGroupsResponse_marker
- 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
.
$sel:httpStatus:DescribeDBSecurityGroupsResponse'
, describeDBSecurityGroupsResponse_httpStatus
- The response's http status code.
CopyOptionGroup
data CopyOptionGroup Source #
See: newCopyOptionGroup
smart constructor.
Instances
Arguments
:: Text | |
-> Text | |
-> Text | |
-> CopyOptionGroup |
Create a value of CopyOptionGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CopyOptionGroup'
, copyOptionGroup_tags
- Undocumented member.
$sel:sourceOptionGroupIdentifier:CopyOptionGroup'
, copyOptionGroup_sourceOptionGroupIdentifier
- The identifier for the source option group.
Constraints:
- Must specify a valid option group.
$sel:targetOptionGroupIdentifier:CopyOptionGroup'
, copyOptionGroup_targetOptionGroupIdentifier
- 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
$sel:targetOptionGroupDescription:CopyOptionGroup'
, copyOptionGroup_targetOptionGroupDescription
- The description for the copied option group.
data CopyOptionGroupResponse Source #
See: newCopyOptionGroupResponse
smart constructor.
Constructors
CopyOptionGroupResponse' (Maybe OptionGroup) Int |
Instances
newCopyOptionGroupResponse Source #
Create a value of CopyOptionGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:optionGroup:CopyOptionGroupResponse'
, copyOptionGroupResponse_optionGroup
- Undocumented member.
$sel:httpStatus:CopyOptionGroupResponse'
, copyOptionGroupResponse_httpStatus
- The response's http status code.
RestoreDBClusterToPointInTime
data RestoreDBClusterToPointInTime Source #
See: newRestoreDBClusterToPointInTime
smart constructor.
Constructors
RestoreDBClusterToPointInTime' (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe ScalingConfiguration) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe [Text]) Text Text |
Instances
newRestoreDBClusterToPointInTime Source #
Arguments
:: Text | |
-> Text |
|
-> RestoreDBClusterToPointInTime |
Create a value of RestoreDBClusterToPointInTime
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deletionProtection:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_deletionProtection
- A value that indicates whether the DB cluster has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled.
$sel:useLatestRestorableTime:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_useLatestRestorableTime
- A value that indicates whether to restore the DB cluster to the latest
restorable backup time. By default, the DB cluster isn't restored to
the latest restorable backup time.
Constraints: Can't be specified if RestoreToTime
parameter is
provided.
$sel:dbSubnetGroupName:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_dbSubnetGroupName
- The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
$sel:domain:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_domain
- 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.
$sel:backtrackWindow:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_backtrackWindow
- 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).
$sel:kmsKeyId:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_kmsKeyId
- 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 Amazon Web Services KMS customer master key (CMK). To use a CMK 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 Amazon Web Services KMS CMK that is different than the Amazon Web
Services KMS key used to encrypt the source DB cluster. The new DB
cluster is encrypted with the Amazon Web Services KMS CMK 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 Amazon Web Services KMS CMK 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.
$sel:vpcSecurityGroupIds:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_vpcSecurityGroupIds
- A list of VPC security groups that the new DB cluster belongs to.
$sel:dbClusterParameterGroupName:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_dbClusterParameterGroupName
- The name of the DB cluster parameter group to associate with this DB
cluster. If this argument is omitted, the default DB cluster parameter
group for the specified engine is used.
Constraints:
- If supplied, must match the name of an existing DB cluster parameter group.
- Must be 1 to 255 letters, numbers, or hyphens.
- First character must be a letter.
- Can't end with a hyphen or contain two consecutive hyphens.
$sel:engineMode:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_engineMode
- 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 clone from a provisioned cluster, or a
provisioned clone from an Aurora Serverless cluster. To create a clone
that is an Aurora Serverless cluster, the original cluster must be an
Aurora Serverless cluster or an encrypted provisioned cluster.
$sel:scalingConfiguration:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_scalingConfiguration
- For DB clusters in serverless
DB engine mode, the scaling properties
of the DB cluster.
$sel:restoreType:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_restoreType
- The type of restore to be performed. You can specify one of the
following values:
full-copy
- The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write
- The new DB cluster is restored as a clone of the source DB cluster.
Constraints: You can't specify copy-on-write
if the engine version of
the source DB cluster is earlier than 1.11.
If you don't specify a RestoreType
value, then the new DB cluster is
restored as a full copy of the source DB cluster.
$sel:optionGroupName:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_optionGroupName
- The name of the option group for the new DB cluster.
$sel:copyTagsToSnapshot:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_copyTagsToSnapshot
- A value that indicates whether to copy all tags from the restored DB
cluster to snapshots of the restored DB cluster. The default is not to
copy them.
$sel:restoreToTime:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_restoreToTime
- 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 iscopy-on-write
Example: 2015-03-07T23:45:00Z
$sel:domainIAMRoleName:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the
Directory Service.
$sel:tags:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_tags
- Undocumented member.
$sel:port:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_port
- The port number on which the new DB cluster accepts connections.
Constraints: A value from 1150-65535
.
Default: The default port for the engine.
$sel:enableIAMDatabaseAuthentication:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services
Identity and Access Management (IAM) accounts to database accounts. By
default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
$sel:enableCloudwatchLogsExports:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_enableCloudwatchLogsExports
- 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. For
more information, see
Publishing Database Logs to Amazon CloudWatch Logs
in the Amazon Aurora User Guide.
$sel:dbClusterIdentifier:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_dbClusterIdentifier
- 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
$sel:sourceDBClusterIdentifier:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_sourceDBClusterIdentifier
- The identifier of the source DB cluster from which to restore.
Constraints:
- Must match the identifier of an existing DBCluster.
data RestoreDBClusterToPointInTimeResponse Source #
See: newRestoreDBClusterToPointInTimeResponse
smart constructor.
Constructors
RestoreDBClusterToPointInTimeResponse' (Maybe DBCluster) Int |
Instances
newRestoreDBClusterToPointInTimeResponse Source #
Arguments
:: Int | |
-> RestoreDBClusterToPointInTimeResponse |
Create a value of RestoreDBClusterToPointInTimeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbCluster:RestoreDBClusterToPointInTimeResponse'
, restoreDBClusterToPointInTimeResponse_dbCluster
- Undocumented member.
$sel:httpStatus:RestoreDBClusterToPointInTimeResponse'
, restoreDBClusterToPointInTimeResponse_httpStatus
- The response's http status code.
DeleteInstallationMedia
data DeleteInstallationMedia Source #
See: newDeleteInstallationMedia
smart constructor.
Constructors
DeleteInstallationMedia' Text |
Instances
newDeleteInstallationMedia Source #
Create a value of DeleteInstallationMedia
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:installationMediaId:DeleteInstallationMedia'
, deleteInstallationMedia_installationMediaId
- The installation medium ID.
data InstallationMedia Source #
Contains the installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
See: newInstallationMedia
smart constructor.
Constructors
InstallationMedia' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InstallationMediaFailureCause) |
Instances
newInstallationMedia :: InstallationMedia Source #
Create a value of InstallationMedia
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:InstallationMedia'
, installationMedia_engineVersion
- The engine version of the DB engine.
$sel:status:InstallationMedia'
, installationMedia_status
- The status of the installation medium.
$sel:installationMediaId:InstallationMedia'
, installationMedia_installationMediaId
- The installation medium ID.
$sel:engineInstallationMediaPath:InstallationMedia'
, installationMedia_engineInstallationMediaPath
- The path to the installation medium for the DB engine.
$sel:engine:InstallationMedia'
, installationMedia_engine
- The DB engine.
$sel:oSInstallationMediaPath:InstallationMedia'
, installationMedia_oSInstallationMediaPath
- The path to the installation medium for the operating system associated
with the DB engine.
$sel:customAvailabilityZoneId:InstallationMedia'
, installationMedia_customAvailabilityZoneId
- The custom Availability Zone (AZ) that contains the installation media.
$sel:failureCause:InstallationMedia'
, installationMedia_failureCause
- If an installation media failure occurred, the cause of the failure.
DescribeDBInstances (Paginated)
data DescribeDBInstances Source #
See: newDescribeDBInstances
smart constructor.
Instances
newDescribeDBInstances :: DescribeDBInstances Source #
Create a value of DescribeDBInstances
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeDBInstances'
, describeDBInstances_filters
- 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 will only include 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 will only include information about the DB instances identified by these ARNs.dbi-resource-id
- Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.domain
- Accepts Active Directory directory IDs. The results list will only include information about the DB instances associated with these domains.engine
- Accepts engine names. The results list will only include information about the DB instances for these engines.
$sel:dbInstanceIdentifier:DescribeDBInstances'
, describeDBInstances_dbInstanceIdentifier
- The user-supplied instance identifier. If this parameter is specified,
information from only the specific DB instance is returned. This
parameter isn't case-sensitive.
Constraints:
- If supplied, must match the identifier of an existing DBInstance.
$sel:marker:DescribeDBInstances'
, describeDBInstances_marker
- 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
.
$sel:maxRecords:DescribeDBInstances'
, describeDBInstances_maxRecords
- 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.
data DescribeDBInstancesResponse Source #
Contains the result of a successful invocation of the
DescribeDBInstances
action.
See: newDescribeDBInstancesResponse
smart constructor.
Constructors
DescribeDBInstancesResponse' (Maybe [DBInstance]) (Maybe Text) Int |
Instances
newDescribeDBInstancesResponse Source #
Create a value of DescribeDBInstancesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstances:DescribeDBInstancesResponse'
, describeDBInstancesResponse_dbInstances
- A list of DBInstance
instances.
$sel:marker:DescribeDBInstances'
, describeDBInstancesResponse_marker
- 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
.
$sel:httpStatus:DescribeDBInstancesResponse'
, describeDBInstancesResponse_httpStatus
- The response's http status code.
RestoreDBInstanceFromS3
data RestoreDBInstanceFromS3 Source #
See: newRestoreDBInstanceFromS3
smart constructor.
Constructors
RestoreDBInstanceFromS3' (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe [ProcessorFeature]) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) Text Text Text Text Text Text Text |
Instances
newRestoreDBInstanceFromS3 Source #
Create a value of RestoreDBInstanceFromS3
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_engineVersion
- 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
.
$sel:dbSecurityGroups:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_dbSecurityGroups
- A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
$sel:deletionProtection:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_deletionProtection
- A value that indicates whether the DB instance has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled. For more
information, see
Deleting a DB Instance.
$sel:storageEncrypted:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_storageEncrypted
- A value that indicates whether the new DB instance is encrypted or not.
$sel:masterUserPassword:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_masterUserPassword
- The password for the master user. The password can include any printable
ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
$sel:publiclyAccessible:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_publiclyAccessible
- A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.
$sel:autoMinorVersionUpgrade:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_autoMinorVersionUpgrade
- A value that indicates whether minor engine upgrades are applied
automatically to the DB instance during the maintenance window. By
default, minor engine upgrades are not applied automatically.
$sel:masterUsername:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_masterUsername
- 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.
$sel:dbSubnetGroupName:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_dbSubnetGroupName
- A DB subnet group to associate with this DB instance.
$sel:monitoringRoleArn:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_monitoringRoleArn
- 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.
$sel:iops:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_iops
- The amount of Provisioned IOPS (input/output operations per second) to
allocate initially for the DB instance. For information about valid Iops
values, see
Amazon RDS Provisioned IOPS Storage to Improve Performance
in the Amazon RDS User Guide.
$sel:monitoringInterval:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_monitoringInterval
- 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
$sel:processorFeatures:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_processorFeatures
- The number of CPU cores and the number of threads per core for the DB
instance class of the DB instance.
$sel:licenseModel:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_licenseModel
- The license model for this DB instance. Use general-public-license
.
$sel:preferredMaintenanceWindow:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_preferredMaintenanceWindow
- 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.
$sel:performanceInsightsRetentionPeriod:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_performanceInsightsRetentionPeriod
- The amount of time, in days, to retain Performance Insights data. Valid
values are 7 or 731 (2 years).
$sel:maxAllocatedStorage:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_maxAllocatedStorage
- 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.
$sel:enablePerformanceInsights:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_enablePerformanceInsights
- A value that indicates whether to enable Performance Insights for the DB
instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
$sel:kmsKeyId:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_kmsKeyId
- 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 Amazon Web Services KMS customer master key (CMK). To use a CMK 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 CMK. There is a default CMK for your Amazon Web Services
account. Your Amazon Web Services account has a different default CMK
for each Amazon Web Services Region.
$sel:dbParameterGroupName:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_dbParameterGroupName
- 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.
$sel:preferredBackupWindow:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_preferredBackupWindow
- 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.
$sel:availabilityZone:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_availabilityZone
- 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.
$sel:backupRetentionPeriod:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_backupRetentionPeriod
- The number of days for which automated backups are retained. Setting
this parameter to a positive number enables backups. For more
information, see CreateDBInstance
.
$sel:performanceInsightsKMSKeyId:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_performanceInsightsKMSKeyId
- 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 Amazon Web Services KMS customer master key (CMK).
If you do not specify a value for PerformanceInsightsKMSKeyId
, then
Amazon RDS uses your default CMK. There is a default CMK for your Amazon
Web Services account. Your Amazon Web Services account has a different
default CMK for each Amazon Web Services Region.
$sel:vpcSecurityGroupIds:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_vpcSecurityGroupIds
- A list of VPC security groups to associate with this DB instance.
$sel:multiAZ:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_multiAZ
- A value that indicates whether the DB instance is a Multi-AZ deployment.
If the DB instance is a Multi-AZ deployment, you can't set the
AvailabilityZone
parameter.
$sel:s3Prefix:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_s3Prefix
- The prefix of your Amazon S3 bucket.
$sel:allocatedStorage:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_allocatedStorage
- The amount of storage (in gigabytes) to allocate initially for the DB
instance. Follow the allocation rules specified in CreateDBInstance
.
Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.
$sel:optionGroupName:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_optionGroupName
- 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.
$sel:copyTagsToSnapshot:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_copyTagsToSnapshot
- A value that indicates whether to copy all tags from the DB instance to
snapshots of the DB instance. By default, tags are not copied.
$sel:tags:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_tags
- A list of tags to associate with this DB instance. For more information,
see
Tagging Amazon RDS Resources
in the Amazon RDS User Guide.
$sel:port:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_port
- The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150
-65535
Default: 3306
$sel:enableIAMDatabaseAuthentication:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services
Identity and Access Management (IAM) accounts to database accounts. By
default, mapping is disabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
$sel:useDefaultProcessorFeatures:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_useDefaultProcessorFeatures
- A value that indicates whether the DB instance class of the DB instance
uses its default processor features.
$sel:storageType:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_storageType
- Specifies the storage type to be associated with the DB instance.
Valid values: standard
| gp2
| io1
If you specify io1
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified; otherwise gp2
$sel:enableCloudwatchLogsExports:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_enableCloudwatchLogsExports
- 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.
$sel:dbName:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_dbName
- The name of the database to create when the DB instance is created.
Follow the naming rules specified in CreateDBInstance
.
$sel:dbInstanceIdentifier:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_dbInstanceIdentifier
- 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
$sel:dbInstanceClass:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_dbInstanceClass
- 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.
$sel:engine:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_engine
- The name of the database engine to be used for this instance.
Valid Values: mysql
$sel:sourceEngine:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_sourceEngine
- The name of the engine of your source database.
Valid Values: mysql
$sel:sourceEngineVersion:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_sourceEngineVersion
- 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
$sel:s3BucketName:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_s3BucketName
- The name of your Amazon S3 bucket that contains your database backup
file.
$sel:s3IngestionRoleArn:RestoreDBInstanceFromS3'
, restoreDBInstanceFromS3_s3IngestionRoleArn
- An Amazon Web Services Identity and Access Management (IAM) role to
allow Amazon RDS to access your Amazon S3 bucket.
data RestoreDBInstanceFromS3Response Source #
See: newRestoreDBInstanceFromS3Response
smart constructor.
Constructors
RestoreDBInstanceFromS3Response' (Maybe DBInstance) Int |
Instances
newRestoreDBInstanceFromS3Response Source #
Create a value of RestoreDBInstanceFromS3Response
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstance:RestoreDBInstanceFromS3Response'
, restoreDBInstanceFromS3Response_dbInstance
- Undocumented member.
$sel:httpStatus:RestoreDBInstanceFromS3Response'
, restoreDBInstanceFromS3Response_httpStatus
- The response's http status code.
DownloadDBLogFilePortion (Paginated)
data DownloadDBLogFilePortion Source #
See: newDownloadDBLogFilePortion
smart constructor.
Instances
newDownloadDBLogFilePortion Source #
Arguments
:: Text | |
-> Text | |
-> DownloadDBLogFilePortion |
Create a value of DownloadDBLogFilePortion
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:numberOfLines:DownloadDBLogFilePortion'
, downloadDBLogFilePortion_numberOfLines
- 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.
$sel:marker:DownloadDBLogFilePortion'
, downloadDBLogFilePortion_marker
- 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.
$sel:dbInstanceIdentifier:DownloadDBLogFilePortion'
, downloadDBLogFilePortion_dbInstanceIdentifier
- 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.
$sel:logFileName:DownloadDBLogFilePortion'
, downloadDBLogFilePortion_logFileName
- The name of the log file to be downloaded.
data DownloadDBLogFilePortionResponse Source #
This data type is used as a response element to
DownloadDBLogFilePortion
.
See: newDownloadDBLogFilePortionResponse
smart constructor.
Instances
newDownloadDBLogFilePortionResponse Source #
Create a value of DownloadDBLogFilePortionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logFileData:DownloadDBLogFilePortionResponse'
, downloadDBLogFilePortionResponse_logFileData
- Entries from the specified log file.
$sel:additionalDataPending:DownloadDBLogFilePortionResponse'
, downloadDBLogFilePortionResponse_additionalDataPending
- Boolean value that if true, indicates there is more data to be
downloaded.
$sel:marker:DownloadDBLogFilePortion'
, downloadDBLogFilePortionResponse_marker
- A pagination token that can be used in a later DownloadDBLogFilePortion
request.
$sel:httpStatus:DownloadDBLogFilePortionResponse'
, downloadDBLogFilePortionResponse_httpStatus
- The response's http status code.
DescribeDBProxies (Paginated)
data DescribeDBProxies Source #
See: newDescribeDBProxies
smart constructor.
Instances
newDescribeDBProxies :: DescribeDBProxies Source #
Create a value of DescribeDBProxies
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeDBProxies'
, describeDBProxies_filters
- This parameter is not currently supported.
$sel:marker:DescribeDBProxies'
, describeDBProxies_marker
- 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
.
$sel:maxRecords:DescribeDBProxies'
, describeDBProxies_maxRecords
- 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.
$sel:dbProxyName:DescribeDBProxies'
, describeDBProxies_dbProxyName
- 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.
data DescribeDBProxiesResponse Source #
See: newDescribeDBProxiesResponse
smart constructor.
Instances
newDescribeDBProxiesResponse Source #
Create a value of DescribeDBProxiesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbProxies:DescribeDBProxiesResponse'
, describeDBProxiesResponse_dbProxies
- A return value representing an arbitrary number of DBProxy
data
structures.
$sel:marker:DescribeDBProxies'
, describeDBProxiesResponse_marker
- 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
.
$sel:httpStatus:DescribeDBProxiesResponse'
, describeDBProxiesResponse_httpStatus
- The response's http status code.
StartExportTask
data StartExportTask Source #
See: newStartExportTask
smart constructor.
Instances
Create a value of StartExportTask
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exportOnly:StartExportTask'
, startExportTask_exportOnly
- The data to be exported from the snapshot. If this parameter is not
provided, all the snapshot data is exported. Valid values are the
following:
database
- Export all the data from a specified database.database.table
table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.database.schema
schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.database.schema.table
table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
$sel:s3Prefix:StartExportTask'
, startExportTask_s3Prefix
- The Amazon S3 bucket prefix to use as the file name and path of the
exported snapshot.
$sel:exportTaskIdentifier:StartExportTask'
, startExportTask_exportTaskIdentifier
- A unique identifier for the snapshot export task. This ID isn't an
identifier for the Amazon S3 bucket where the snapshot is to be exported
to.
$sel:sourceArn:StartExportTask'
, startExportTask_sourceArn
- The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.
$sel:s3BucketName:StartExportTask'
, startExportTask_s3BucketName
- The name of the Amazon S3 bucket to export the snapshot to.
$sel:iamRoleArn:StartExportTask'
, startExportTask_iamRoleArn
- The name of the IAM role to use for writing to the Amazon S3 bucket when
exporting a snapshot.
$sel:kmsKeyId:StartExportTask'
, startExportTask_kmsKeyId
- The ID of the Amazon Web Services KMS customer master key (CMK) to use
to encrypt the snapshot exported to Amazon S3. The Amazon Web Services
KMS key identifier is the key ARN, key ID, alias ARN, or alias name for
the Amazon Web Services KMS customer master key (CMK). The caller of
this operation must be authorized to execute the following operations.
These can be set in the Amazon Web Services KMS key policy:
- GrantOperation.Encrypt
- GrantOperation.Decrypt
- GrantOperation.GenerateDataKey
- GrantOperation.GenerateDataKeyWithoutPlaintext
- GrantOperation.ReEncryptFrom
- GrantOperation.ReEncryptTo
- GrantOperation.CreateGrant
- GrantOperation.DescribeKey
- GrantOperation.RetireGrant
data ExportTask Source #
Contains the details of a snapshot export to Amazon S3.
This data type is used as a response element in the
DescribeExportTasks
action.
See: newExportTask
smart constructor.
Constructors
ExportTask' (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) |
Instances
newExportTask :: ExportTask Source #
Create a value of ExportTask
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:totalExtractedDataInGB:ExportTask'
, exportTask_totalExtractedDataInGB
- The total amount of data exported, in gigabytes.
$sel:status:ExportTask'
, exportTask_status
- The progress status of the export task.
$sel:iamRoleArn:ExportTask'
, exportTask_iamRoleArn
- The name of the IAM role that is used to write to Amazon S3 when
exporting a snapshot.
$sel:sourceArn:ExportTask'
, exportTask_sourceArn
- The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
$sel:exportOnly:ExportTask'
, exportTask_exportOnly
- The data exported from the snapshot. Valid values are the following:
database
- Export all the data from a specified database.database.table
table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.database.schema
schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.database.schema.table
table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
$sel:taskStartTime:ExportTask'
, exportTask_taskStartTime
- The time that the snapshot export task started.
$sel:warningMessage:ExportTask'
, exportTask_warningMessage
- A warning about the snapshot export task.
$sel:snapshotTime:ExportTask'
, exportTask_snapshotTime
- The time that the snapshot was created.
$sel:kmsKeyId:ExportTask'
, exportTask_kmsKeyId
- The key identifier of the Amazon Web Services KMS customer master key
(CMK) that is used to encrypt the snapshot when it's exported to Amazon
S3. The Amazon Web Services KMS CMK identifier is its key ARN, key ID,
alias ARN, or alias name. The IAM role used for the snapshot export must
have encryption and decryption permissions to use this Amazon Web
Services KMS CMK.
$sel:taskEndTime:ExportTask'
, exportTask_taskEndTime
- The time that the snapshot export task completed.
$sel:exportTaskIdentifier:ExportTask'
, exportTask_exportTaskIdentifier
- A unique identifier for the snapshot export task. This ID isn't an
identifier for the Amazon S3 bucket where the snapshot is exported to.
$sel:s3Prefix:ExportTask'
, exportTask_s3Prefix
- The Amazon S3 bucket prefix that is the file name and path of the
exported snapshot.
$sel:percentProgress:ExportTask'
, exportTask_percentProgress
- The progress of the snapshot export task as a percentage.
$sel:s3Bucket:ExportTask'
, exportTask_s3Bucket
- The Amazon S3 bucket that the snapshot is exported to.
$sel:failureCause:ExportTask'
, exportTask_failureCause
- The reason the export failed, if it failed.
Types
ActivityStreamMode
newtype ActivityStreamMode Source #
Constructors
ActivityStreamMode' | |
Fields |
Bundled Patterns
pattern ActivityStreamMode_Async :: ActivityStreamMode | |
pattern ActivityStreamMode_Sync :: ActivityStreamMode |
Instances
ActivityStreamStatus
newtype ActivityStreamStatus Source #
Constructors
ActivityStreamStatus' | |
Fields |
Bundled Patterns
pattern ActivityStreamStatus_Started :: ActivityStreamStatus | |
pattern ActivityStreamStatus_Starting :: ActivityStreamStatus | |
pattern ActivityStreamStatus_Stopped :: ActivityStreamStatus | |
pattern ActivityStreamStatus_Stopping :: ActivityStreamStatus |
Instances
ApplyMethod
newtype ApplyMethod Source #
Constructors
ApplyMethod' | |
Fields |
Bundled Patterns
pattern ApplyMethod_Immediate :: ApplyMethod | |
pattern ApplyMethod_Pending_reboot :: ApplyMethod |
Instances
AuthScheme
newtype AuthScheme Source #
Constructors
AuthScheme' | |
Fields |
Bundled Patterns
pattern AuthScheme_SECRETS :: AuthScheme |
Instances
DBProxyEndpointStatus
newtype DBProxyEndpointStatus Source #
Constructors
DBProxyEndpointStatus' | |
Fields |
Bundled Patterns
Instances
DBProxyEndpointTargetRole
newtype DBProxyEndpointTargetRole Source #
Constructors
DBProxyEndpointTargetRole' | |
Fields |
Bundled Patterns
pattern DBProxyEndpointTargetRole_READ_ONLY :: DBProxyEndpointTargetRole | |
pattern DBProxyEndpointTargetRole_READ_WRITE :: DBProxyEndpointTargetRole |
Instances
DBProxyStatus
newtype DBProxyStatus Source #
Constructors
DBProxyStatus' | |
Fields |
Bundled Patterns
pattern DBProxyStatus_Available :: DBProxyStatus | |
pattern DBProxyStatus_Creating :: DBProxyStatus | |
pattern DBProxyStatus_Deleting :: DBProxyStatus | |
pattern DBProxyStatus_Incompatible_network :: DBProxyStatus | |
pattern DBProxyStatus_Insufficient_resource_limits :: DBProxyStatus | |
pattern DBProxyStatus_Modifying :: DBProxyStatus | |
pattern DBProxyStatus_Reactivating :: DBProxyStatus | |
pattern DBProxyStatus_Suspended :: DBProxyStatus | |
pattern DBProxyStatus_Suspending :: DBProxyStatus |
Instances
EngineFamily
newtype EngineFamily Source #
Constructors
EngineFamily' | |
Fields |
Bundled Patterns
pattern EngineFamily_MYSQL :: EngineFamily | |
pattern EngineFamily_POSTGRESQL :: EngineFamily |
Instances
FailoverStatus
newtype FailoverStatus Source #
Constructors
FailoverStatus' | |
Fields |
Bundled Patterns
pattern FailoverStatus_Cancelling :: FailoverStatus | |
pattern FailoverStatus_Failing_over :: FailoverStatus | |
pattern FailoverStatus_Pending :: FailoverStatus |
Instances
IAMAuthMode
newtype IAMAuthMode Source #
Constructors
IAMAuthMode' | |
Fields |
Bundled Patterns
pattern IAMAuthMode_DISABLED :: IAMAuthMode | |
pattern IAMAuthMode_REQUIRED :: IAMAuthMode |
Instances
ReplicaMode
newtype ReplicaMode Source #
Constructors
ReplicaMode' | |
Fields |
Bundled Patterns
pattern ReplicaMode_Mounted :: ReplicaMode | |
pattern ReplicaMode_Open_read_only :: ReplicaMode |
Instances
SourceType
newtype SourceType Source #
Constructors
SourceType' | |
Fields |
Bundled Patterns
pattern SourceType_Db_cluster :: SourceType | |
pattern SourceType_Db_cluster_snapshot :: SourceType | |
pattern SourceType_Db_instance :: SourceType | |
pattern SourceType_Db_parameter_group :: SourceType | |
pattern SourceType_Db_security_group :: SourceType | |
pattern SourceType_Db_snapshot :: SourceType |
Instances
TargetHealthReason
newtype TargetHealthReason Source #
Constructors
TargetHealthReason' | |
Fields |
Bundled Patterns
Instances
TargetRole
newtype TargetRole Source #
Constructors
TargetRole' | |
Fields |
Bundled Patterns
pattern TargetRole_READ_ONLY :: TargetRole | |
pattern TargetRole_READ_WRITE :: TargetRole | |
pattern TargetRole_UNKNOWN :: TargetRole |
Instances
TargetState
newtype TargetState Source #
Constructors
TargetState' | |
Fields |
Bundled Patterns
pattern TargetState_AVAILABLE :: TargetState | |
pattern TargetState_REGISTERING :: TargetState | |
pattern TargetState_UNAVAILABLE :: TargetState |
Instances
TargetType
newtype TargetType Source #
Constructors
TargetType' | |
Fields |
Bundled Patterns
pattern TargetType_RDS_INSTANCE :: TargetType | |
pattern TargetType_RDS_SERVERLESS_ENDPOINT :: TargetType | |
pattern TargetType_TRACKED_CLUSTER :: TargetType |
Instances
WriteForwardingStatus
newtype WriteForwardingStatus Source #
Constructors
WriteForwardingStatus' | |
Fields |
Bundled Patterns
pattern WriteForwardingStatus_Disabled :: WriteForwardingStatus | |
pattern WriteForwardingStatus_Disabling :: WriteForwardingStatus | |
pattern WriteForwardingStatus_Enabled :: WriteForwardingStatus | |
pattern WriteForwardingStatus_Enabling :: WriteForwardingStatus | |
pattern WriteForwardingStatus_Unknown :: WriteForwardingStatus |
Instances
AccountQuota
data AccountQuota Source #
Describes a quota for an Amazon Web Services account.
The following are account quotas:
AllocatedStorage
- The total allocated storage per account, in GiB. The used value is the total allocated storage in the account, in GiB.AuthorizationsPerDBSecurityGroup
- The number of ingress rules per DB security group. The used value is the highest number of ingress rules in a DB security group in the account. Other DB security groups in the account might have a lower number of ingress rules.CustomEndpointsPerDBCluster
- The number of custom endpoints per DB cluster. The used value is the highest number of custom endpoints in a DB clusters in the account. Other DB clusters in the account might have a lower number of custom endpoints.DBClusterParameterGroups
- The number of DB cluster parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB cluster parameter groups in the account.DBClusterRoles
- The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. The used value is the highest number of associated IAM roles for a DB cluster in the account. Other DB clusters in the account might have a lower number of associated IAM roles.DBClusters
- The number of DB clusters per account. The used value is the count of DB clusters in the account.DBInstanceRoles
- The number of associated IAM roles per DB instance. The used value is the highest number of associated IAM roles for a DB instance in the account. Other DB instances in the account might have a lower number of associated IAM roles.DBInstances
- The number of DB instances per account. The used value is the count of the DB instances in the account.Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB instances apply to this quota.
DBParameterGroups
- The number of DB parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB parameter groups in the account.DBSecurityGroups
- The number of DB security groups (not VPC security groups) per account, excluding the default security group. The used value is the count of nondefault DB security groups in the account.DBSubnetGroups
- The number of DB subnet groups per account. The used value is the count of the DB subnet groups in the account.EventSubscriptions
- The number of event subscriptions per account. The used value is the count of the event subscriptions in the account.ManualClusterSnapshots
- The number of manual DB cluster snapshots per account. The used value is the count of the manual DB cluster snapshots in the account.ManualSnapshots
- The number of manual DB instance snapshots per account. The used value is the count of the manual DB instance snapshots in the account.OptionGroups
- The number of DB option groups per account, excluding default option groups. The used value is the count of nondefault DB option groups in the account.ReadReplicasPerMaster
- The number of read replicas per DB instance. The used value is the highest number of read replicas for a DB instance in the account. Other DB instances in the account might have a lower number of read replicas.ReservedDBInstances
- The number of reserved DB instances per account. The used value is the count of the active reserved DB instances in the account.SubnetsPerDBSubnetGroup
- The number of subnets per DB subnet group. The used value is highest number of subnets for a DB subnet group in the account. Other DB subnet groups in the account might have a lower number of subnets.
For more information, see Quotas for Amazon RDS in the Amazon RDS User Guide and Quotas for Amazon Aurora in the Amazon Aurora User Guide.
See: newAccountQuota
smart constructor.
Instances
newAccountQuota :: AccountQuota Source #
Create a value of AccountQuota
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:max:AccountQuota'
, accountQuota_max
- The maximum allowed value for the quota.
$sel:used:AccountQuota'
, accountQuota_used
- The amount currently used toward the quota maximum.
$sel:accountQuotaName:AccountQuota'
, accountQuota_accountQuotaName
- The name of the Amazon RDS quota for this Amazon Web Services account.
AvailabilityZone
data AvailabilityZone Source #
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption
data type.
See: newAvailabilityZone
smart constructor.
Constructors
AvailabilityZone' (Maybe Text) |
Instances
newAvailabilityZone :: AvailabilityZone Source #
Create a value of AvailabilityZone
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:AvailabilityZone'
, availabilityZone_name
- The name of the Availability Zone.
AvailableProcessorFeature
data AvailableProcessorFeature Source #
Contains the available processor feature information for the DB instance class of a DB instance.
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
See: newAvailableProcessorFeature
smart constructor.
Instances
newAvailableProcessorFeature :: AvailableProcessorFeature Source #
Create a value of AvailableProcessorFeature
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:AvailableProcessorFeature'
, availableProcessorFeature_name
- The name of the processor feature. Valid names are coreCount
and
threadsPerCore
.
$sel:defaultValue:AvailableProcessorFeature'
, availableProcessorFeature_defaultValue
- The default value for the processor feature of the DB instance class.
$sel:allowedValues:AvailableProcessorFeature'
, availableProcessorFeature_allowedValues
- The allowed values for the processor feature of the DB instance class.
Certificate
data Certificate Source #
A CA certificate for an Amazon Web Services account.
See: newCertificate
smart constructor.
Constructors
Certificate' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe ISO8601) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe ISO8601) |
Instances
newCertificate :: Certificate Source #
Create a value of Certificate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:certificateType:Certificate'
, certificate_certificateType
- The type of the certificate.
$sel:customerOverride:Certificate'
, certificate_customerOverride
- Whether there is an override for the default certificate identifier.
$sel:certificateArn:Certificate'
, certificate_certificateArn
- The Amazon Resource Name (ARN) for the certificate.
$sel:customerOverrideValidTill:Certificate'
, certificate_customerOverrideValidTill
- If there is an override for the default certificate identifier, when the
override expires.
$sel:validTill:Certificate'
, certificate_validTill
- The final date that the certificate continues to be valid.
$sel:certificateIdentifier:Certificate'
, certificate_certificateIdentifier
- The unique key that identifies a certificate.
$sel:thumbprint:Certificate'
, certificate_thumbprint
- The thumbprint of the certificate.
$sel:validFrom:Certificate'
, certificate_validFrom
- The starting date from which the certificate is valid.
CharacterSet
data CharacterSet Source #
This data type is used as a response element in the action
DescribeDBEngineVersions
.
See: newCharacterSet
smart constructor.
Constructors
CharacterSet' (Maybe Text) (Maybe Text) |
Instances
newCharacterSet :: CharacterSet Source #
Create a value of CharacterSet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:characterSetName:CharacterSet'
, characterSet_characterSetName
- The name of the character set.
$sel:characterSetDescription:CharacterSet'
, characterSet_characterSetDescription
- The description of the character set.
CloudwatchLogsExportConfiguration
data CloudwatchLogsExportConfiguration Source #
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
The EnableLogTypes
and DisableLogTypes
arrays determine which logs
will be exported (or not exported) to CloudWatch Logs. The values within
these arrays depend on the DB engine being used.
For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
See: newCloudwatchLogsExportConfiguration
smart constructor.
Constructors
CloudwatchLogsExportConfiguration' (Maybe [Text]) (Maybe [Text]) |
Instances
newCloudwatchLogsExportConfiguration :: CloudwatchLogsExportConfiguration Source #
Create a value of CloudwatchLogsExportConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:disableLogTypes:CloudwatchLogsExportConfiguration'
, cloudwatchLogsExportConfiguration_disableLogTypes
- The list of log types to disable.
$sel:enableLogTypes:CloudwatchLogsExportConfiguration'
, cloudwatchLogsExportConfiguration_enableLogTypes
- The list of log types to enable.
ClusterPendingModifiedValues
data ClusterPendingModifiedValues Source #
This data type is used as a response element in the ModifyDBCluster
operation and contains changes that will be applied during the next
maintenance window.
See: newClusterPendingModifiedValues
smart constructor.
Constructors
ClusterPendingModifiedValues' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe PendingCloudwatchLogsExports) |
Instances
newClusterPendingModifiedValues :: ClusterPendingModifiedValues Source #
Create a value of ClusterPendingModifiedValues
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:ClusterPendingModifiedValues'
, clusterPendingModifiedValues_engineVersion
- The database engine version.
$sel:dbClusterIdentifier:ClusterPendingModifiedValues'
, clusterPendingModifiedValues_dbClusterIdentifier
- The DBClusterIdentifier value for the DB cluster.
$sel:masterUserPassword:ClusterPendingModifiedValues'
, clusterPendingModifiedValues_masterUserPassword
- The master credentials for the DB cluster.
$sel:iAMDatabaseAuthenticationEnabled:ClusterPendingModifiedValues'
, clusterPendingModifiedValues_iAMDatabaseAuthenticationEnabled
- A value that indicates whether mapping of Amazon Web Services Identity
and Access Management (IAM) accounts to database accounts is enabled.
$sel:pendingCloudwatchLogsExports:ClusterPendingModifiedValues'
, clusterPendingModifiedValues_pendingCloudwatchLogsExports
- Undocumented member.
ConnectionPoolConfiguration
data ConnectionPoolConfiguration Source #
Specifies the settings that control the size and behavior of the
connection pool associated with a DBProxyTargetGroup
.
See: newConnectionPoolConfiguration
smart constructor.
Constructors
ConnectionPoolConfiguration' (Maybe Int) (Maybe [Text]) (Maybe Int) (Maybe Int) (Maybe Text) |
Instances
newConnectionPoolConfiguration :: ConnectionPoolConfiguration Source #
Create a value of ConnectionPoolConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxIdleConnectionsPercent:ConnectionPoolConfiguration'
, connectionPoolConfiguration_maxIdleConnectionsPercent
- Controls how actively the proxy closes idle database connections in the
connection pool. A high value enables the proxy to leave a high
percentage of idle connections open. A low value causes the proxy to
close idle client connections and return the underlying database
connections to the connection pool. For Aurora MySQL, it is expressed as
a percentage of the max_connections
setting for the RDS DB instance or
Aurora DB cluster used by the target group.
Default: 50
Constraints: between 0 and MaxConnectionsPercent
$sel:sessionPinningFilters:ConnectionPoolConfiguration'
, connectionPoolConfiguration_sessionPinningFilters
- Each item in the list represents a class of SQL operations that normally
cause all later statements in a session using a proxy to be pinned to
the same underlying database connection. Including an item in the list
exempts that class of SQL operations from the pinning behavior.
Default: no session pinning filters
$sel:maxConnectionsPercent:ConnectionPoolConfiguration'
, connectionPoolConfiguration_maxConnectionsPercent
- The maximum size of the connection pool for each target in a target
group. For Aurora MySQL, it is expressed as a percentage of the
max_connections
setting for the RDS DB instance or Aurora DB cluster
used by the target group.
Default: 100
Constraints: between 1 and 100
$sel:connectionBorrowTimeout:ConnectionPoolConfiguration'
, connectionPoolConfiguration_connectionBorrowTimeout
- The number of seconds for a proxy to wait for a connection to become
available in the connection pool. Only applies when the proxy has opened
its maximum number of connections and all connections are busy with
client sessions.
Default: 120
Constraints: between 1 and 3600, or 0 representing unlimited
$sel:initQuery:ConnectionPoolConfiguration'
, connectionPoolConfiguration_initQuery
- One or more SQL statements for the proxy to run when opening each new
database connection. Typically used with SET
statements to make sure
that each connection has identical settings such as time zone and
character set. For multiple statements, use semicolons as the separator.
You can also include multiple variables in a single SET
statement,
such as SET x=1, y=2
.
Default: no initialization query
ConnectionPoolConfigurationInfo
data ConnectionPoolConfigurationInfo Source #
Displays the settings that control the size and behavior of the
connection pool associated with a DBProxyTarget
.
See: newConnectionPoolConfigurationInfo
smart constructor.
Constructors
ConnectionPoolConfigurationInfo' (Maybe Int) (Maybe [Text]) (Maybe Int) (Maybe Int) (Maybe Text) |
Instances
newConnectionPoolConfigurationInfo :: ConnectionPoolConfigurationInfo Source #
Create a value of ConnectionPoolConfigurationInfo
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxIdleConnectionsPercent:ConnectionPoolConfigurationInfo'
, connectionPoolConfigurationInfo_maxIdleConnectionsPercent
- Controls how actively the proxy closes idle database connections in the
connection pool. A high value enables the proxy to leave a high
percentage of idle connections open. A low value causes the proxy to
close idle client connections and return the underlying database
connections to the connection pool. For Aurora MySQL, it is expressed as
a percentage of the max_connections
setting for the RDS DB instance or
Aurora DB cluster used by the target group.
$sel:sessionPinningFilters:ConnectionPoolConfigurationInfo'
, connectionPoolConfigurationInfo_sessionPinningFilters
- Each item in the list represents a class of SQL operations that normally
cause all later statements in a session using a proxy to be pinned to
the same underlying database connection. Including an item in the list
exempts that class of SQL operations from the pinning behavior.
Currently, the only allowed value is EXCLUDE_VARIABLE_SETS
.
$sel:maxConnectionsPercent:ConnectionPoolConfigurationInfo'
, connectionPoolConfigurationInfo_maxConnectionsPercent
- The maximum size of the connection pool for each target in a target
group. For Aurora MySQL, it is expressed as a percentage of the
max_connections
setting for the RDS DB instance or Aurora DB cluster
used by the target group.
$sel:connectionBorrowTimeout:ConnectionPoolConfigurationInfo'
, connectionPoolConfigurationInfo_connectionBorrowTimeout
- The number of seconds for a proxy to wait for a connection to become
available in the connection pool. Only applies when the proxy has opened
its maximum number of connections and all connections are busy with
client sessions.
$sel:initQuery:ConnectionPoolConfigurationInfo'
, connectionPoolConfigurationInfo_initQuery
- One or more SQL statements for the proxy to run when opening each new
database connection. Typically used with SET
statements to make sure
that each connection has identical settings such as time zone and
character set. This setting is empty by default. For multiple
statements, use semicolons as the separator. You can also include
multiple variables in a single SET
statement, such as SET x=1, y=2
.
CustomAvailabilityZone
data CustomAvailabilityZone Source #
A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.
For more information about RDS on VMware, see the RDS on VMware User Guide.
See: newCustomAvailabilityZone
smart constructor.
Constructors
CustomAvailabilityZone' (Maybe VpnDetails) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newCustomAvailabilityZone :: CustomAvailabilityZone Source #
Create a value of CustomAvailabilityZone
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:vpnDetails:CustomAvailabilityZone'
, customAvailabilityZone_vpnDetails
- Information about the virtual private network (VPN) between the VMware
vSphere cluster and the Amazon Web Services website.
$sel:customAvailabilityZoneName:CustomAvailabilityZone'
, customAvailabilityZone_customAvailabilityZoneName
- The name of the custom AZ.
$sel:customAvailabilityZoneId:CustomAvailabilityZone'
, customAvailabilityZone_customAvailabilityZoneId
- The identifier of the custom AZ.
Amazon RDS generates a unique identifier when a custom AZ is created.
$sel:customAvailabilityZoneStatus:CustomAvailabilityZone'
, customAvailabilityZone_customAvailabilityZoneStatus
- The status of the custom AZ.
DBCluster
Contains the details of an Amazon Aurora DB cluster.
This data type is used as a response element in the
DescribeDBClusters
, StopDBCluster
, and StartDBCluster
actions.
See: newDBCluster
smart constructor.
Constructors
DBCluster' (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ISO8601) (Maybe Bool) (Maybe Text) (Maybe [DBClusterMember]) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe ISO8601) (Maybe Integer) (Maybe [Tag]) (Maybe Text) (Maybe ISO8601) (Maybe [Text]) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [DBClusterRole]) (Maybe [VpcSecurityGroupMembership]) (Maybe Int) (Maybe Text) (Maybe ActivityStreamMode) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe ActivityStreamStatus) (Maybe Int) (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe ScalingConfigurationInfo) (Maybe Text) (Maybe Text) (Maybe ClusterPendingModifiedValues) (Maybe Text) (Maybe WriteForwardingStatus) (Maybe Int) (Maybe [DomainMembership]) (Maybe [DBClusterOptionGroupStatus]) |
Instances
newDBCluster :: DBCluster Source #
Create a value of DBCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backtrackConsumedChangeRecords:DBCluster'
, dbCluster_backtrackConsumedChangeRecords
- The number of change records stored for Backtrack.
$sel:engineVersion:DBCluster'
, dbCluster_engineVersion
- Indicates the database engine version.
$sel:status:DBCluster'
, dbCluster_status
- Specifies the current state of this DB cluster.
$sel:deletionProtection:DBCluster'
, dbCluster_deletionProtection
- Indicates if the DB cluster has deletion protection enabled. The
database can't be deleted when deletion protection is enabled.
$sel:automaticRestartTime:DBCluster'
, dbCluster_automaticRestartTime
- The time when a stopped DB cluster is restarted automatically.
$sel:storageEncrypted:DBCluster'
, dbCluster_storageEncrypted
- Specifies whether the DB cluster is encrypted.
$sel:dbClusterIdentifier:DBCluster'
, dbCluster_dbClusterIdentifier
- Contains a user-supplied DB cluster identifier. This identifier is the
unique key that identifies a DB cluster.
$sel:dbClusterMembers:DBCluster'
, dbCluster_dbClusterMembers
- Provides the list of instances that make up the DB cluster.
$sel:readReplicaIdentifiers:DBCluster'
, dbCluster_readReplicaIdentifiers
- Contains one or more identifiers of the read replicas associated with
this DB cluster.
$sel:replicationSourceIdentifier:DBCluster'
, dbCluster_replicationSourceIdentifier
- Contains the identifier of the source DB cluster if this DB cluster is a
read replica.
$sel:activityStreamKinesisStreamName:DBCluster'
, dbCluster_activityStreamKinesisStreamName
- The name of the Amazon Kinesis data stream used for the database
activity stream.
$sel:hostedZoneId:DBCluster'
, dbCluster_hostedZoneId
- Specifies the ID that Amazon Route 53 assigns when you create a hosted
zone.
$sel:dbClusterParameterGroup:DBCluster'
, dbCluster_dbClusterParameterGroup
- Specifies the name of the DB cluster parameter group for the DB cluster.
$sel:masterUsername:DBCluster'
, dbCluster_masterUsername
- Contains the master username for the DB cluster.
$sel:iAMDatabaseAuthenticationEnabled:DBCluster'
, dbCluster_iAMDatabaseAuthenticationEnabled
- A value that indicates whether the mapping of Amazon Web Services
Identity and Access Management (IAM) accounts to database accounts is
enabled.
$sel:globalWriteForwardingRequested:DBCluster'
, dbCluster_globalWriteForwardingRequested
- Specifies whether you have requested to enable write forwarding for a
secondary cluster in an Aurora global database. Because write forwarding
takes time to enable, check the value of GlobalWriteForwardingStatus
to confirm that the request has completed before using the write
forwarding feature for this cluster.
$sel:earliestBacktrackTime:DBCluster'
, dbCluster_earliestBacktrackTime
- The earliest time to which a DB cluster can be backtracked.
$sel:backtrackWindow:DBCluster'
, dbCluster_backtrackWindow
- The target backtrack window, in seconds. If this value is set to 0,
backtracking is disabled for the DB cluster. Otherwise, backtracking is
enabled.
$sel:tagList:DBCluster'
, dbCluster_tagList
- Undocumented member.
$sel:dbClusterResourceId:DBCluster'
, dbCluster_dbClusterResourceId
- The Amazon Web Services Region-unique, immutable identifier for the DB
cluster. This identifier is found in Amazon Web Services CloudTrail log
entries whenever the Amazon Web Services KMS CMK for the DB cluster is
accessed.
$sel:earliestRestorableTime:DBCluster'
, dbCluster_earliestRestorableTime
- The earliest time to which a database can be restored with point-in-time
restore.
$sel:customEndpoints:DBCluster'
, dbCluster_customEndpoints
- Identifies all custom endpoints associated with the cluster.
$sel:engine:DBCluster'
, dbCluster_engine
- The name of the database engine to be used for this DB cluster.
$sel:httpEndpointEnabled:DBCluster'
, dbCluster_httpEndpointEnabled
- A value that indicates whether the HTTP endpoint for an Aurora
Serverless DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
$sel:dbClusterArn:DBCluster'
, dbCluster_dbClusterArn
- The Amazon Resource Name (ARN) for the DB cluster.
$sel:cloneGroupId:DBCluster'
, dbCluster_cloneGroupId
- Identifies the clone group to which the DB cluster is associated.
$sel:latestRestorableTime:DBCluster'
, dbCluster_latestRestorableTime
- Specifies the latest time to which a database can be restored with
point-in-time restore.
$sel:crossAccountClone:DBCluster'
, dbCluster_crossAccountClone
- Specifies whether the DB cluster is a clone of a DB cluster owned by a
different Amazon Web Services account.
$sel:capacity:DBCluster'
, dbCluster_capacity
- The current capacity of an Aurora Serverless DB cluster. The capacity is
0 (zero) when the cluster is paused.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
$sel:preferredMaintenanceWindow:DBCluster'
, dbCluster_preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC).
$sel:availabilityZones:DBCluster'
, dbCluster_availabilityZones
- Provides the list of Availability Zones (AZs) where instances in the DB
cluster can be created.
$sel:characterSetName:DBCluster'
, dbCluster_characterSetName
- If present, specifies the name of the character set that this cluster is
associated with.
$sel:kmsKeyId:DBCluster'
, dbCluster_kmsKeyId
- If StorageEncrypted
is enabled, the Amazon Web Services KMS key
identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
$sel:preferredBackupWindow:DBCluster'
, dbCluster_preferredBackupWindow
- Specifies the daily time range during which automated backups are
created if automated backups are enabled, as determined by the
BackupRetentionPeriod
.
$sel:associatedRoles:DBCluster'
, dbCluster_associatedRoles
- Provides a list of the Amazon Web Services Identity and Access
Management (IAM) roles that are associated with the DB cluster. IAM
roles that are associated with a DB cluster grant permission for the DB
cluster to access other Amazon Web Services on your behalf.
$sel:vpcSecurityGroups:DBCluster'
, dbCluster_vpcSecurityGroups
- Provides a list of VPC security groups that the DB cluster belongs to.
$sel:backupRetentionPeriod:DBCluster'
, dbCluster_backupRetentionPeriod
- Specifies the number of days for which automatic DB snapshots are
retained.
$sel:dbSubnetGroup:DBCluster'
, dbCluster_dbSubnetGroup
- Specifies information on the subnet group associated with the DB
cluster, including the name, description, and subnets in the subnet
group.
$sel:activityStreamMode:DBCluster'
, dbCluster_activityStreamMode
- 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.
$sel:databaseName:DBCluster'
, dbCluster_databaseName
- Contains the name of the initial database of this DB cluster that was
provided at create time, if one was specified when the DB cluster was
created. This same name is returned for the life of the DB cluster.
$sel:multiAZ:DBCluster'
, dbCluster_multiAZ
- Specifies whether the DB cluster has instances in multiple Availability
Zones.
$sel:engineMode:DBCluster'
, dbCluster_engineMode
- The DB engine mode of the DB cluster, either provisioned
,
serverless
, parallelquery
, global
, or multimaster
.
For more information, see CreateDBCluster.
$sel:enabledCloudwatchLogsExports:DBCluster'
, dbCluster_enabledCloudwatchLogsExports
- A list of log types that this DB cluster is configured to export to
CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
$sel:activityStreamStatus:DBCluster'
, dbCluster_activityStreamStatus
- The status of the database activity stream.
$sel:allocatedStorage:DBCluster'
, dbCluster_allocatedStorage
- For all database engines except Amazon Aurora, AllocatedStorage
specifies the allocated storage size in gibibytes (GiB). For Aurora,
AllocatedStorage
always returns 1, because Aurora DB cluster storage
size isn't fixed, but instead automatically adjusts as needed.
$sel:copyTagsToSnapshot:DBCluster'
, dbCluster_copyTagsToSnapshot
- Specifies whether tags are copied from the DB cluster to snapshots of
the DB cluster.
$sel:clusterCreateTime:DBCluster'
, dbCluster_clusterCreateTime
- Specifies the time when the DB cluster was created, in Universal
Coordinated Time (UTC).
$sel:endpoint:DBCluster'
, dbCluster_endpoint
- Specifies the connection endpoint for the primary instance of the DB
cluster.
$sel:scalingConfigurationInfo:DBCluster'
, dbCluster_scalingConfigurationInfo
- Undocumented member.
$sel:activityStreamKmsKeyId:DBCluster'
, dbCluster_activityStreamKmsKeyId
- 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 Amazon Web Services KMS customer master key (CMK).
$sel:percentProgress:DBCluster'
, dbCluster_percentProgress
- Specifies the progress of the operation as a percentage.
$sel:pendingModifiedValues:DBCluster'
, dbCluster_pendingModifiedValues
- A value that specifies that changes to the DB cluster are pending. This
element is only included when changes are pending. Specific changes are
identified by subelements.
$sel:readerEndpoint:DBCluster'
, dbCluster_readerEndpoint
- The reader endpoint for the DB cluster. The reader endpoint for a DB
cluster load-balances connections across the Aurora Replicas that are
available in a DB cluster. As clients request new connections to the
reader endpoint, Aurora distributes the connection requests among the
Aurora Replicas in the DB cluster. This functionality can help balance
your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
$sel:globalWriteForwardingStatus:DBCluster'
, dbCluster_globalWriteForwardingStatus
- Specifies whether a secondary cluster in an Aurora global database has
write forwarding enabled, not enabled, or is in the process of enabling
it.
$sel:port:DBCluster'
, dbCluster_port
- Specifies the port that the database engine is listening on.
$sel:domainMemberships:DBCluster'
, dbCluster_domainMemberships
- The Active Directory Domain membership records associated with the DB
cluster.
$sel:dbClusterOptionGroupMemberships:DBCluster'
, dbCluster_dbClusterOptionGroupMemberships
- Provides the list of option group memberships for this DB cluster.
DBClusterBacktrack
data DBClusterBacktrack Source #
This data type is used as a response element in the
DescribeDBClusterBacktracks
action.
See: newDBClusterBacktrack
smart constructor.
Constructors
DBClusterBacktrack' (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe ISO8601) |
Instances
newDBClusterBacktrack :: DBClusterBacktrack Source #
Create a value of DBClusterBacktrack
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DBClusterBacktrack'
, dbClusterBacktrack_status
- 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.
$sel:backtrackIdentifier:DBClusterBacktrack'
, dbClusterBacktrack_backtrackIdentifier
- Contains the backtrack identifier.
$sel:backtrackTo:DBClusterBacktrack'
, dbClusterBacktrack_backtrackTo
- The timestamp of the time to which the DB cluster was backtracked.
$sel:dbClusterIdentifier:DBClusterBacktrack'
, dbClusterBacktrack_dbClusterIdentifier
- Contains a user-supplied DB cluster identifier. This identifier is the
unique key that identifies a DB cluster.
$sel:backtrackedFrom:DBClusterBacktrack'
, dbClusterBacktrack_backtrackedFrom
- The timestamp of the time from which the DB cluster was backtracked.
$sel:backtrackRequestCreationTime:DBClusterBacktrack'
, dbClusterBacktrack_backtrackRequestCreationTime
- The timestamp of the time at which the backtrack was requested.
DBClusterEndpoint
data DBClusterEndpoint Source #
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
.
See: newDBClusterEndpoint
smart constructor.
Constructors
DBClusterEndpoint' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) |
Instances
newDBClusterEndpoint :: DBClusterEndpoint Source #
Create a value of DBClusterEndpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DBClusterEndpoint'
, dbClusterEndpoint_status
- 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.
$sel:dbClusterIdentifier:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterIdentifier
- The DB cluster identifier of the DB cluster associated with the
endpoint. This parameter is stored as a lowercase string.
$sel:dbClusterEndpointArn:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterEndpointArn
- The Amazon Resource Name (ARN) for the endpoint.
$sel:customEndpointType:DBClusterEndpoint'
, dbClusterEndpoint_customEndpointType
- The type associated with a custom endpoint. One of: READER
, WRITER
,
ANY
.
$sel:staticMembers:DBClusterEndpoint'
, dbClusterEndpoint_staticMembers
- List of DB instance identifiers that are part of the custom endpoint
group.
$sel:endpointType:DBClusterEndpoint'
, dbClusterEndpoint_endpointType
- The type of the endpoint. One of: READER
, WRITER
, CUSTOM
.
$sel:dbClusterEndpointIdentifier:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterEndpointIdentifier
- The identifier associated with the endpoint. This parameter is stored as
a lowercase string.
$sel:endpoint:DBClusterEndpoint'
, dbClusterEndpoint_endpoint
- The DNS address of the endpoint.
$sel:dbClusterEndpointResourceIdentifier:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterEndpointResourceIdentifier
- A unique system-generated identifier for an endpoint. It remains the
same for the whole life of the endpoint.
$sel:excludedMembers:DBClusterEndpoint'
, dbClusterEndpoint_excludedMembers
- 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.
DBClusterMember
data DBClusterMember Source #
Contains information about an instance that is part of a DB cluster.
See: newDBClusterMember
smart constructor.
Instances
newDBClusterMember :: DBClusterMember Source #
Create a value of DBClusterMember
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:promotionTier:DBClusterMember'
, dbClusterMember_promotionTier
- A value that specifies the order in which an Aurora Replica is promoted
to the primary instance after a failure of the existing primary
instance. For more information, see
Fault Tolerance for an Aurora DB Cluster
in the Amazon Aurora User Guide.
$sel:dbInstanceIdentifier:DBClusterMember'
, dbClusterMember_dbInstanceIdentifier
- Specifies the instance identifier for this member of the DB cluster.
$sel:isClusterWriter:DBClusterMember'
, dbClusterMember_isClusterWriter
- Value that is true
if the cluster member is the primary instance for
the DB cluster and false
otherwise.
$sel:dbClusterParameterGroupStatus:DBClusterMember'
, dbClusterMember_dbClusterParameterGroupStatus
- Specifies the status of the DB cluster parameter group for this member
of the DB cluster.
DBClusterOptionGroupStatus
data DBClusterOptionGroupStatus Source #
Contains status information for a DB cluster option group.
See: newDBClusterOptionGroupStatus
smart constructor.
Constructors
DBClusterOptionGroupStatus' (Maybe Text) (Maybe Text) |
Instances
newDBClusterOptionGroupStatus :: DBClusterOptionGroupStatus Source #
Create a value of DBClusterOptionGroupStatus
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DBClusterOptionGroupStatus'
, dbClusterOptionGroupStatus_status
- Specifies the status of the DB cluster option group.
$sel:dbClusterOptionGroupName:DBClusterOptionGroupStatus'
, dbClusterOptionGroupStatus_dbClusterOptionGroupName
- Specifies the name of the DB cluster option group.
DBClusterParameterGroup
data DBClusterParameterGroup Source #
Contains the details of an Amazon RDS DB cluster parameter group.
This data type is used as a response element in the
DescribeDBClusterParameterGroups
action.
See: newDBClusterParameterGroup
smart constructor.
Instances
newDBClusterParameterGroup :: DBClusterParameterGroup Source #
Create a value of DBClusterParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterParameterGroupArn:DBClusterParameterGroup'
, dbClusterParameterGroup_dbClusterParameterGroupArn
- The Amazon Resource Name (ARN) for the DB cluster parameter group.
$sel:dbParameterGroupFamily:DBClusterParameterGroup'
, dbClusterParameterGroup_dbParameterGroupFamily
- The name of the DB parameter group family that this DB cluster parameter
group is compatible with.
$sel:dbClusterParameterGroupName:DBClusterParameterGroup'
, dbClusterParameterGroup_dbClusterParameterGroupName
- The name of the DB cluster parameter group.
$sel:description:DBClusterParameterGroup'
, dbClusterParameterGroup_description
- Provides the customer-specified description for this DB cluster
parameter group.
DBClusterParameterGroupNameMessage
data DBClusterParameterGroupNameMessage Source #
See: newDBClusterParameterGroupNameMessage
smart constructor.
Constructors
DBClusterParameterGroupNameMessage' (Maybe Text) |
Instances
newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage Source #
Create a value of DBClusterParameterGroupNameMessage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterParameterGroupName:DBClusterParameterGroupNameMessage'
, dbClusterParameterGroupNameMessage_dbClusterParameterGroupName
- 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.
DBClusterRole
data DBClusterRole Source #
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
See: newDBClusterRole
smart constructor.
Instances
newDBClusterRole :: DBClusterRole Source #
Create a value of DBClusterRole
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DBClusterRole'
, dbClusterRole_status
- Describes the state of association between the IAM role and the DB
cluster. The Status property returns one of the following values:
ACTIVE
- the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.PENDING
- the IAM role ARN is being associated with the DB cluster.INVALID
- the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.
$sel:featureName:DBClusterRole'
, dbClusterRole_featureName
- The name of the feature associated with the Amazon Web Services Identity
and Access Management (IAM) role. For the list of supported feature
names, see DBEngineVersion.
$sel:roleArn:DBClusterRole'
, dbClusterRole_roleArn
- The Amazon Resource Name (ARN) of the IAM role that is associated with
the DB cluster.
DBClusterSnapshot
data DBClusterSnapshot Source #
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the
DescribeDBClusterSnapshots
action.
See: newDBClusterSnapshot
smart constructor.
Constructors
DBClusterSnapshot' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Int) (Maybe Text) (Maybe ISO8601) (Maybe Int) (Maybe Int) |
Instances
newDBClusterSnapshot :: DBClusterSnapshot Source #
Create a value of DBClusterSnapshot
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:DBClusterSnapshot'
, dbClusterSnapshot_engineVersion
- Provides the version of the database engine for this DB cluster
snapshot.
$sel:status:DBClusterSnapshot'
, dbClusterSnapshot_status
- Specifies the status of this DB cluster snapshot.
$sel:storageEncrypted:DBClusterSnapshot'
, dbClusterSnapshot_storageEncrypted
- Specifies whether the DB cluster snapshot is encrypted.
$sel:dbClusterIdentifier:DBClusterSnapshot'
, dbClusterSnapshot_dbClusterIdentifier
- Specifies the DB cluster identifier of the DB cluster that this DB
cluster snapshot was created from.
$sel:masterUsername:DBClusterSnapshot'
, dbClusterSnapshot_masterUsername
- Provides the master username for this DB cluster snapshot.
$sel:iAMDatabaseAuthenticationEnabled:DBClusterSnapshot'
, dbClusterSnapshot_iAMDatabaseAuthenticationEnabled
- True if mapping of Amazon Web Services Identity and Access Management
(IAM) accounts to database accounts is enabled, and otherwise false.
$sel:dbClusterSnapshotArn:DBClusterSnapshot'
, dbClusterSnapshot_dbClusterSnapshotArn
- The Amazon Resource Name (ARN) for the DB cluster snapshot.
$sel:vpcId:DBClusterSnapshot'
, dbClusterSnapshot_vpcId
- Provides the VPC ID associated with the DB cluster snapshot.
$sel:tagList:DBClusterSnapshot'
, dbClusterSnapshot_tagList
- Undocumented member.
$sel:dbClusterSnapshotIdentifier:DBClusterSnapshot'
, dbClusterSnapshot_dbClusterSnapshotIdentifier
- Specifies the identifier for the DB cluster snapshot.
$sel:engine:DBClusterSnapshot'
, dbClusterSnapshot_engine
- Specifies the name of the database engine for this DB cluster snapshot.
$sel:licenseModel:DBClusterSnapshot'
, dbClusterSnapshot_licenseModel
- Provides the license model information for this DB cluster snapshot.
$sel:availabilityZones:DBClusterSnapshot'
, dbClusterSnapshot_availabilityZones
- Provides the list of Availability Zones (AZs) where instances in the DB
cluster snapshot can be restored.
$sel:snapshotType:DBClusterSnapshot'
, dbClusterSnapshot_snapshotType
- Provides the type of the DB cluster snapshot.
$sel:kmsKeyId:DBClusterSnapshot'
, dbClusterSnapshot_kmsKeyId
- If StorageEncrypted
is true, the Amazon Web Services KMS key
identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
$sel:engineMode:DBClusterSnapshot'
, dbClusterSnapshot_engineMode
- Provides the engine mode of the database engine for this DB cluster
snapshot.
$sel:snapshotCreateTime:DBClusterSnapshot'
, dbClusterSnapshot_snapshotCreateTime
- Provides the time when the snapshot was taken, in Universal Coordinated
Time (UTC).
$sel:allocatedStorage:DBClusterSnapshot'
, dbClusterSnapshot_allocatedStorage
- Specifies the allocated storage size in gibibytes (GiB).
$sel:sourceDBClusterSnapshotArn:DBClusterSnapshot'
, dbClusterSnapshot_sourceDBClusterSnapshotArn
- If the DB cluster snapshot was copied from a source DB cluster snapshot,
the Amazon Resource Name (ARN) for the source DB cluster snapshot,
otherwise, a null value.
$sel:clusterCreateTime:DBClusterSnapshot'
, dbClusterSnapshot_clusterCreateTime
- Specifies the time when the DB cluster was created, in Universal
Coordinated Time (UTC).
$sel:percentProgress:DBClusterSnapshot'
, dbClusterSnapshot_percentProgress
- Specifies the percentage of the estimated data that has been
transferred.
$sel:port:DBClusterSnapshot'
, dbClusterSnapshot_port
- Specifies the port that the DB cluster was listening on at the time of
the snapshot.
DBClusterSnapshotAttribute
data DBClusterSnapshotAttribute Source #
Contains the name and values of a manual DB cluster snapshot attribute.
Manual DB cluster snapshot attributes are used to authorize other Amazon
Web Services accounts to restore a manual DB cluster snapshot. For more
information, see the ModifyDBClusterSnapshotAttribute
API action.
See: newDBClusterSnapshotAttribute
smart constructor.
Constructors
DBClusterSnapshotAttribute' (Maybe [Text]) (Maybe Text) |
Instances
newDBClusterSnapshotAttribute :: DBClusterSnapshotAttribute Source #
Create a value of DBClusterSnapshotAttribute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeValues:DBClusterSnapshotAttribute'
, dbClusterSnapshotAttribute_attributeValues
- The value(s) for the manual DB cluster snapshot attribute.
If the AttributeName
field is set to restore
, then this element
returns a list of IDs of the Amazon Web Services accounts that are
authorized to copy or restore the manual DB cluster snapshot. If a value
of all
is in the list, then the manual DB cluster snapshot is public
and available for any Amazon Web Services account to copy or restore.
$sel:attributeName:DBClusterSnapshotAttribute'
, dbClusterSnapshotAttribute_attributeName
- The name of the manual DB cluster snapshot attribute.
The attribute named restore
refers to the list of Amazon Web Services
accounts that have permission to copy or restore the manual DB cluster
snapshot. For more information, see the
ModifyDBClusterSnapshotAttribute
API action.
DBClusterSnapshotAttributesResult
data DBClusterSnapshotAttributesResult Source #
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.
See: newDBClusterSnapshotAttributesResult
smart constructor.
Constructors
DBClusterSnapshotAttributesResult' (Maybe Text) (Maybe [DBClusterSnapshotAttribute]) |
Instances
newDBClusterSnapshotAttributesResult :: DBClusterSnapshotAttributesResult Source #
Create a value of DBClusterSnapshotAttributesResult
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterSnapshotIdentifier:DBClusterSnapshotAttributesResult'
, dbClusterSnapshotAttributesResult_dbClusterSnapshotIdentifier
- The identifier of the manual DB cluster snapshot that the attributes
apply to.
$sel:dbClusterSnapshotAttributes:DBClusterSnapshotAttributesResult'
, dbClusterSnapshotAttributesResult_dbClusterSnapshotAttributes
- The list of attributes and values for the manual DB cluster snapshot.
DBEngineVersion
data DBEngineVersion Source #
This data type is used as a response element in the action
DescribeDBEngineVersions
.
See: newDBEngineVersion
smart constructor.
Constructors
DBEngineVersion' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe CharacterSet) (Maybe Text) (Maybe Text) (Maybe [CharacterSet]) (Maybe Text) (Maybe Bool) (Maybe [UpgradeTarget]) (Maybe Bool) (Maybe [CharacterSet]) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe [Timezone]) (Maybe [Text]) |
Instances
newDBEngineVersion :: DBEngineVersion Source #
Create a value of DBEngineVersion
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:DBEngineVersion'
, dbEngineVersion_engineVersion
- The version number of the database engine.
$sel:status:DBEngineVersion'
, dbEngineVersion_status
- The status of the DB engine version, either available
or deprecated
.
$sel:dbEngineVersionDescription:DBEngineVersion'
, dbEngineVersion_dbEngineVersionDescription
- The description of the database engine version.
$sel:supportedEngineModes:DBEngineVersion'
, dbEngineVersion_supportedEngineModes
- A list of the supported DB engine modes.
$sel:defaultCharacterSet:DBEngineVersion'
, dbEngineVersion_defaultCharacterSet
- The default character set for new instances of this engine version, if
the CharacterSetName
parameter of the CreateDBInstance API isn't
specified.
$sel:engine:DBEngineVersion'
, dbEngineVersion_engine
- The name of the database engine.
$sel:dbParameterGroupFamily:DBEngineVersion'
, dbEngineVersion_dbParameterGroupFamily
- The name of the DB parameter group family for the database engine.
$sel:supportedCharacterSets:DBEngineVersion'
, dbEngineVersion_supportedCharacterSets
- A list of the character sets supported by this engine for the
CharacterSetName
parameter of the CreateDBInstance
operation.
$sel:dbEngineDescription:DBEngineVersion'
, dbEngineVersion_dbEngineDescription
- The description of the database engine.
$sel:supportsGlobalDatabases:DBEngineVersion'
, dbEngineVersion_supportsGlobalDatabases
- A value that indicates whether you can use Aurora global databases with
a specific DB engine version.
$sel:validUpgradeTarget:DBEngineVersion'
, dbEngineVersion_validUpgradeTarget
- A list of engine versions that this database engine version can be
upgraded to.
$sel:supportsParallelQuery:DBEngineVersion'
, dbEngineVersion_supportsParallelQuery
- A value that indicates whether you can use Aurora parallel query with a
specific DB engine version.
$sel:supportedNcharCharacterSets:DBEngineVersion'
, dbEngineVersion_supportedNcharCharacterSets
- A list of the character sets supported by the Oracle DB engine for the
NcharCharacterSetName
parameter of the CreateDBInstance
operation.
$sel:supportsLogExportsToCloudwatchLogs:DBEngineVersion'
, dbEngineVersion_supportsLogExportsToCloudwatchLogs
- A value that indicates whether the engine version supports exporting the
log types specified by ExportableLogTypes to CloudWatch Logs.
$sel:supportsReadReplica:DBEngineVersion'
, dbEngineVersion_supportsReadReplica
- Indicates whether the database engine version supports read replicas.
$sel:supportedFeatureNames:DBEngineVersion'
, dbEngineVersion_supportedFeatureNames
- A list of features supported by the DB engine. Supported feature names
include the following.
- s3Import
$sel:supportedTimezones:DBEngineVersion'
, dbEngineVersion_supportedTimezones
- A list of the time zones supported by this engine for the Timezone
parameter of the CreateDBInstance
action.
$sel:exportableLogTypes:DBEngineVersion'
, dbEngineVersion_exportableLogTypes
- The types of logs that the database engine has available for export to
CloudWatch Logs.
DBInstance
data DBInstance Source #
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the
DescribeDBInstances
action.
See: newDBInstance
smart constructor.
Constructors
Instances
newDBInstance :: DBInstance Source #
Create a value of DBInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:DBInstance'
, dbInstance_engineVersion
- Indicates the database engine version.
$sel:dbSecurityGroups:DBInstance'
, dbInstance_dbSecurityGroups
- A list of DB security group elements containing DBSecurityGroup.Name
and DBSecurityGroup.Status
subelements.
$sel:deletionProtection:DBInstance'
, dbInstance_deletionProtection
- Indicates if the DB instance has deletion protection enabled. The
database can't be deleted when deletion protection is enabled. For more
information, see
Deleting a DB Instance.
$sel:automaticRestartTime:DBInstance'
, dbInstance_automaticRestartTime
- The time when a stopped DB instance is restarted automatically.
$sel:storageEncrypted:DBInstance'
, dbInstance_storageEncrypted
- Specifies whether the DB instance is encrypted.
$sel:dbClusterIdentifier:DBInstance'
, dbInstance_dbClusterIdentifier
- If the DB instance is a member of a DB cluster, contains the name of the
DB cluster that the DB instance is a member of.
$sel:publiclyAccessible:DBInstance'
, dbInstance_publiclyAccessible
- Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.
$sel:autoMinorVersionUpgrade:DBInstance'
, dbInstance_autoMinorVersionUpgrade
- A value that indicates that minor version patches are applied
automatically.
$sel:dbInstanceArn:DBInstance'
, dbInstance_dbInstanceArn
- The Amazon Resource Name (ARN) for the DB instance.
$sel:activityStreamKinesisStreamName:DBInstance'
, dbInstance_activityStreamKinesisStreamName
- The name of the Amazon Kinesis data stream used for the database
activity stream.
$sel:activityStreamEngineNativeAuditFieldsIncluded:DBInstance'
, dbInstance_activityStreamEngineNativeAuditFieldsIncluded
- Indicates whether engine-native audit fields are included in the
database activity stream.
$sel:masterUsername:DBInstance'
, dbInstance_masterUsername
- Contains the master username for the DB instance.
$sel:readReplicaDBInstanceIdentifiers:DBInstance'
, dbInstance_readReplicaDBInstanceIdentifiers
- Contains one or more identifiers of the read replicas associated with
this DB instance.
$sel:iAMDatabaseAuthenticationEnabled:DBInstance'
, dbInstance_iAMDatabaseAuthenticationEnabled
- True if mapping of Amazon Web Services Identity and Access Management
(IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
- For MySQL 5.6, minor version 5.6.34 or higher
- For MySQL 5.7, minor version 5.7.16 or higher
- Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
$sel:monitoringRoleArn:DBInstance'
, dbInstance_monitoringRoleArn
- The ARN for the IAM role that permits RDS to send Enhanced Monitoring
metrics to Amazon CloudWatch Logs.
$sel:iops:DBInstance'
, dbInstance_iops
- Specifies the Provisioned IOPS (I/O operations per second) value.
$sel:instanceCreateTime:DBInstance'
, dbInstance_instanceCreateTime
- Provides the date and time the DB instance was created.
$sel:tagList:DBInstance'
, dbInstance_tagList
- Undocumented member.
$sel:readReplicaSourceDBInstanceIdentifier:DBInstance'
, dbInstance_readReplicaSourceDBInstanceIdentifier
- Contains the identifier of the source DB instance if this DB instance is
a read replica.
$sel:replicaMode:DBInstance'
, dbInstance_replicaMode
- The open mode of an Oracle read replica. The default is
open-read-only
. For more information, see
Working with Oracle Read Replicas for Amazon RDS
in the Amazon RDS User Guide.
This attribute is only supported in RDS for Oracle.
$sel:monitoringInterval:DBInstance'
, dbInstance_monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance.
$sel:engine:DBInstance'
, dbInstance_engine
- The name of the database engine to be used for this DB instance.
$sel:processorFeatures:DBInstance'
, dbInstance_processorFeatures
- The number of CPU cores and the number of threads per core for the DB
instance class of the DB instance.
$sel:latestRestorableTime:DBInstance'
, dbInstance_latestRestorableTime
- Specifies the latest time to which a database can be restored with
point-in-time restore.
$sel:dbInstanceClass:DBInstance'
, dbInstance_dbInstanceClass
- Contains the name of the compute and memory capacity class of the DB
instance.
$sel:promotionTier:DBInstance'
, dbInstance_promotionTier
- A value that specifies the order in which an Aurora Replica is promoted
to the primary instance after a failure of the existing primary
instance. For more information, see
Fault Tolerance for an Aurora DB Cluster
in the Amazon Aurora User Guide.
$sel:awsBackupRecoveryPointArn:DBInstance'
, dbInstance_awsBackupRecoveryPointArn
- The Amazon Resource Name (ARN) of the recovery point in Amazon Web
Services Backup.
$sel:licenseModel:DBInstance'
, dbInstance_licenseModel
- License model information for this DB instance.
$sel:preferredMaintenanceWindow:DBInstance'
, dbInstance_preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC).
$sel:performanceInsightsRetentionPeriod:DBInstance'
, dbInstance_performanceInsightsRetentionPeriod
- The amount of time, in days, to retain Performance Insights data. Valid
values are 7 or 731 (2 years).
$sel:cACertificateIdentifier:DBInstance'
, dbInstance_cACertificateIdentifier
- The identifier of the CA certificate for this DB instance.
$sel:dbInstanceIdentifier:DBInstance'
, dbInstance_dbInstanceIdentifier
- Contains a user-supplied database identifier. This identifier is the
unique key that identifies a DB instance.
$sel:characterSetName:DBInstance'
, dbInstance_characterSetName
- If present, specifies the name of the character set that this instance
is associated with.
$sel:maxAllocatedStorage:DBInstance'
, dbInstance_maxAllocatedStorage
- The upper limit in gibibytes (GiB) to which Amazon RDS can automatically
scale the storage of the DB instance.
$sel:customerOwnedIpEnabled:DBInstance'
, dbInstance_customerOwnedIpEnabled
- Specifies whether a customer-owned IP address (CoIP) is enabled for an
RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
$sel:kmsKeyId:DBInstance'
, dbInstance_kmsKeyId
- If StorageEncrypted
is true, the Amazon Web Services KMS key
identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
$sel:preferredBackupWindow:DBInstance'
, dbInstance_preferredBackupWindow
- Specifies the daily time range during which automated backups are
created if automated backups are enabled, as determined by the
BackupRetentionPeriod
.
$sel:associatedRoles:DBInstance'
, dbInstance_associatedRoles
- The Amazon Web Services Identity and Access Management (IAM) roles
associated with the DB instance.
$sel:availabilityZone:DBInstance'
, dbInstance_availabilityZone
- Specifies the name of the Availability Zone the DB instance is located
in.
$sel:vpcSecurityGroups:DBInstance'
, dbInstance_vpcSecurityGroups
- Provides a list of VPC security group elements that the DB instance
belongs to.
$sel:backupRetentionPeriod:DBInstance'
, dbInstance_backupRetentionPeriod
- Specifies the number of days for which automatic DB snapshots are
retained.
$sel:ncharCharacterSetName:DBInstance'
, dbInstance_ncharCharacterSetName
- The name of the NCHAR character set for the Oracle DB instance. This
character set specifies the Unicode encoding for data stored in table
columns of type NCHAR, NCLOB, or NVARCHAR2.
$sel:performanceInsightsKMSKeyId:DBInstance'
, dbInstance_performanceInsightsKMSKeyId
- 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 Amazon Web Services KMS customer master key (CMK).
$sel:dbSubnetGroup:DBInstance'
, dbInstance_dbSubnetGroup
- Specifies information on the subnet group associated with the DB
instance, including the name, description, and subnets in the subnet
group.
$sel:activityStreamMode:DBInstance'
, dbInstance_activityStreamMode
- The mode of the database activity stream. Database events such as a
change or access generate an activity stream event. RDS for Oracle
always handles these events asynchronously.
$sel:multiAZ:DBInstance'
, dbInstance_multiAZ
- Specifies if the DB instance is a Multi-AZ deployment.
$sel:listenerEndpoint:DBInstance'
, dbInstance_listenerEndpoint
- Specifies the listener connection endpoint for SQL Server Always On.
$sel:optionGroupMemberships:DBInstance'
, dbInstance_optionGroupMemberships
- Provides the list of option group memberships for this DB instance.
$sel:enabledCloudwatchLogsExports:DBInstance'
, dbInstance_enabledCloudwatchLogsExports
- A list of log types that this DB instance is configured to export to
CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
$sel:enhancedMonitoringResourceArn:DBInstance'
, dbInstance_enhancedMonitoringResourceArn
- The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream
that receives the Enhanced Monitoring metrics data for the DB instance.
$sel:secondaryAvailabilityZone:DBInstance'
, dbInstance_secondaryAvailabilityZone
- If present, specifies the name of the secondary Availability Zone for a
DB instance with multi-AZ support.
$sel:activityStreamStatus:DBInstance'
, dbInstance_activityStreamStatus
- The status of the database activity stream.
$sel:performanceInsightsEnabled:DBInstance'
, dbInstance_performanceInsightsEnabled
- True if Performance Insights is enabled for the DB instance, and
otherwise false.
$sel:allocatedStorage:DBInstance'
, dbInstance_allocatedStorage
- Specifies the allocated storage size specified in gibibytes (GiB).
$sel:dbiResourceId:DBInstance'
, dbInstance_dbiResourceId
- The Amazon Web Services Region-unique, immutable identifier for the DB
instance. This identifier is found in Amazon Web Services CloudTrail log
entries whenever the Amazon Web Services KMS customer master key (CMK)
for the DB instance is accessed.
$sel:dbParameterGroups:DBInstance'
, dbInstance_dbParameterGroups
- Provides the list of DB parameter groups applied to this DB instance.
$sel:copyTagsToSnapshot:DBInstance'
, dbInstance_copyTagsToSnapshot
- Specifies whether tags are copied from the DB instance to snapshots of
the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster.
Setting this value for an Aurora DB instance has no effect on the DB
cluster setting. For more information, see DBCluster
.
$sel:timezone:DBInstance'
, dbInstance_timezone
- The time zone of the DB instance. In most cases, the Timezone
element
is empty. Timezone
content appears only for Microsoft SQL Server DB
instances that were created with a time zone specified.
$sel:tdeCredentialArn:DBInstance'
, dbInstance_tdeCredentialArn
- The ARN from the key store with which the instance is associated for TDE
encryption.
$sel:dbInstanceAutomatedBackupsReplications:DBInstance'
, dbInstance_dbInstanceAutomatedBackupsReplications
- The list of replicated automated backups associated with the DB
instance.
$sel:endpoint:DBInstance'
, dbInstance_endpoint
- Specifies the connection endpoint.
The endpoint might not be shown for instances whose status is
creating
.
$sel:dbInstanceStatus:DBInstance'
, dbInstance_dbInstanceStatus
- Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
$sel:dbInstancePort:DBInstance'
, dbInstance_dbInstancePort
- Specifies the port that the DB instance listens on. If the DB instance
is part of a DB cluster, this can be a different port than the DB
cluster port.
$sel:activityStreamKmsKeyId:DBInstance'
, dbInstance_activityStreamKmsKeyId
- 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
Amazon Web Services KMS customer master key (CMK).
$sel:pendingModifiedValues:DBInstance'
, dbInstance_pendingModifiedValues
- A value that specifies that changes to the DB instance are pending. This
element is only included when changes are pending. Specific changes are
identified by subelements.
$sel:readReplicaDBClusterIdentifiers:DBInstance'
, dbInstance_readReplicaDBClusterIdentifiers
- Contains one or more identifiers of Aurora DB clusters to which the RDS
DB instance is replicated as a read replica. For example, when you
create an Aurora read replica of an RDS MySQL DB instance, the Aurora
MySQL DB cluster for the Aurora read replica is shown. This output does
not contain information about cross region Aurora read replicas.
Currently, each RDS DB instance can have only one Aurora read replica.
$sel:storageType:DBInstance'
, dbInstance_storageType
- Specifies the storage type associated with DB instance.
$sel:statusInfos:DBInstance'
, dbInstance_statusInfos
- The status of a read replica. If the instance isn't a read replica,
this is blank.
$sel:domainMemberships:DBInstance'
, dbInstance_domainMemberships
- The Active Directory Domain membership records associated with the DB
instance.
$sel:dbName:DBInstance'
, dbInstance_dbName
- The meaning of this parameter differs according to the database engine
you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
DBInstanceAutomatedBackup
data DBInstanceAutomatedBackup Source #
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.
See: newDBInstanceAutomatedBackup
smart constructor.
Constructors
DBInstanceAutomatedBackup' (Maybe RestoreWindow) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [DBInstanceAutomatedBackupsReplication]) (Maybe Text) (Maybe Int) (Maybe Text) |
Instances
newDBInstanceAutomatedBackup :: DBInstanceAutomatedBackup Source #
Create a value of DBInstanceAutomatedBackup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:restoreWindow:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_restoreWindow
- Earliest and latest time an instance can be restored to.
$sel:engineVersion:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_engineVersion
- The version of the database engine for the automated backup.
$sel:status:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_status
- Provides a list of status information for an automated backup:
active
- automated backups for current instancesretained
- automated backups for deleted instancescreating
- automated backups that are waiting for the first automated snapshot to be available.
$sel:dbInstanceArn:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_dbInstanceArn
- The Amazon Resource Name (ARN) for the automated backups.
$sel:masterUsername:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_masterUsername
- The license model of an automated backup.
$sel:iAMDatabaseAuthenticationEnabled:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_iAMDatabaseAuthenticationEnabled
- True if mapping of Amazon Web Services Identity and Access Management
(IAM) accounts to database accounts is enabled, and otherwise false.
$sel:iops:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_iops
- The IOPS (I/O operations per second) value for the automated backup.
$sel:vpcId:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_vpcId
- Provides the VPC ID associated with the DB instance
$sel:instanceCreateTime:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_instanceCreateTime
- Provides the date and time that the DB instance was created.
$sel:engine:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_engine
- The name of the database engine for this automated backup.
$sel:encrypted:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_encrypted
- Specifies whether the automated backup is encrypted.
$sel:licenseModel:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_licenseModel
- License model information for the automated backup.
$sel:dbInstanceIdentifier:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_dbInstanceIdentifier
- The customer id of the instance that is/was associated with the
automated backup.
$sel:kmsKeyId:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_kmsKeyId
- The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
$sel:availabilityZone:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_availabilityZone
- The Availability Zone that the automated backup was created in. For
information on Amazon Web Services Regions and Availability Zones, see
Regions and Availability Zones.
$sel:backupRetentionPeriod:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_backupRetentionPeriod
- The retention period for the automated backups.
$sel:region:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_region
- The Amazon Web Services Region associated with the automated backup.
$sel:allocatedStorage:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_allocatedStorage
- Specifies the allocated storage size in gibibytes (GiB).
$sel:dbiResourceId:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_dbiResourceId
- The identifier for the source DB instance, which can't be changed and
which is unique to an Amazon Web Services Region.
$sel:optionGroupName:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_optionGroupName
- The option group the automated backup is associated with. If omitted,
the default option group for the engine specified is used.
$sel:timezone:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_timezone
- The time zone of the automated backup. In most cases, the Timezone
element is empty. Timezone
content appears only for Microsoft SQL
Server DB instances that were created with a time zone specified.
$sel:tdeCredentialArn:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_tdeCredentialArn
- The ARN from the key store with which the automated backup is associated
for TDE encryption.
$sel:dbInstanceAutomatedBackupsReplications:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_dbInstanceAutomatedBackupsReplications
- The list of replications to different Amazon Web Services Regions
associated with the automated backup.
$sel:dbInstanceAutomatedBackupsArn:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_dbInstanceAutomatedBackupsArn
- The Amazon Resource Name (ARN) for the replicated automated backups.
$sel:port:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_port
- The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
$sel:storageType:DBInstanceAutomatedBackup'
, dbInstanceAutomatedBackup_storageType
- Specifies the storage type associated with the automated backup.
DBInstanceAutomatedBackupsReplication
data DBInstanceAutomatedBackupsReplication Source #
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
See: newDBInstanceAutomatedBackupsReplication
smart constructor.
Constructors
DBInstanceAutomatedBackupsReplication' (Maybe Text) |
Instances
newDBInstanceAutomatedBackupsReplication :: DBInstanceAutomatedBackupsReplication Source #
Create a value of DBInstanceAutomatedBackupsReplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstanceAutomatedBackupsArn:DBInstanceAutomatedBackupsReplication'
, dbInstanceAutomatedBackupsReplication_dbInstanceAutomatedBackupsArn
- The Amazon Resource Name (ARN) of the replicated automated backups.
DBInstanceRole
data DBInstanceRole Source #
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
See: newDBInstanceRole
smart constructor.
Instances
newDBInstanceRole :: DBInstanceRole Source #
Create a value of DBInstanceRole
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DBInstanceRole'
, dbInstanceRole_status
- Describes the state of association between the IAM role and the DB
instance. The Status property returns one of the following values:
ACTIVE
- the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.PENDING
- the IAM role ARN is being associated with the DB instance.INVALID
- the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
$sel:featureName:DBInstanceRole'
, dbInstanceRole_featureName
- The name of the feature associated with the Amazon Web Services Identity
and Access Management (IAM) role. For the list of supported feature
names, see DBEngineVersion
.
$sel:roleArn:DBInstanceRole'
, dbInstanceRole_roleArn
- The Amazon Resource Name (ARN) of the IAM role that is associated with
the DB instance.
DBInstanceStatusInfo
data DBInstanceStatusInfo Source #
Provides a list of status information for a DB instance.
See: newDBInstanceStatusInfo
smart constructor.
Instances
newDBInstanceStatusInfo :: DBInstanceStatusInfo Source #
Create a value of DBInstanceStatusInfo
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DBInstanceStatusInfo'
, dbInstanceStatusInfo_status
- Status of the DB instance. For a StatusType of read replica, the values
can be replicating, replication stop point set, replication stop point
reached, error, stopped, or terminated.
$sel:normal:DBInstanceStatusInfo'
, dbInstanceStatusInfo_normal
- Boolean value that is true if the instance is operating normally, or
false if the instance is in an error state.
$sel:statusType:DBInstanceStatusInfo'
, dbInstanceStatusInfo_statusType
- This value is currently "read replication."
$sel:message:DBInstanceStatusInfo'
, dbInstanceStatusInfo_message
- Details of the error if there is an error for the instance. If the
instance isn't in an error state, this value is blank.
DBParameterGroup
data DBParameterGroup Source #
Contains the details of an Amazon RDS DB parameter group.
This data type is used as a response element in the
DescribeDBParameterGroups
action.
See: newDBParameterGroup
smart constructor.
Instances
newDBParameterGroup :: DBParameterGroup Source #
Create a value of DBParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroupArn:DBParameterGroup'
, dbParameterGroup_dbParameterGroupArn
- The Amazon Resource Name (ARN) for the DB parameter group.
$sel:dbParameterGroupFamily:DBParameterGroup'
, dbParameterGroup_dbParameterGroupFamily
- The name of the DB parameter group family that this DB parameter group
is compatible with.
$sel:dbParameterGroupName:DBParameterGroup'
, dbParameterGroup_dbParameterGroupName
- The name of the DB parameter group.
$sel:description:DBParameterGroup'
, dbParameterGroup_description
- Provides the customer-specified description for this DB parameter group.
DBParameterGroupNameMessage
data DBParameterGroupNameMessage Source #
Contains the result of a successful invocation of the
ModifyDBParameterGroup
or ResetDBParameterGroup
action.
See: newDBParameterGroupNameMessage
smart constructor.
Constructors
DBParameterGroupNameMessage' (Maybe Text) |
Instances
newDBParameterGroupNameMessage :: DBParameterGroupNameMessage Source #
Create a value of DBParameterGroupNameMessage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroupName:DBParameterGroupNameMessage'
, dbParameterGroupNameMessage_dbParameterGroupName
- The name of the DB parameter group.
DBParameterGroupStatus
data DBParameterGroupStatus Source #
The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstance
CreateDBInstanceReadReplica
DeleteDBInstance
ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot
See: newDBParameterGroupStatus
smart constructor.
Constructors
DBParameterGroupStatus' (Maybe Text) (Maybe Text) |
Instances
newDBParameterGroupStatus :: DBParameterGroupStatus Source #
Create a value of DBParameterGroupStatus
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroupName:DBParameterGroupStatus'
, dbParameterGroupStatus_dbParameterGroupName
- The name of the DB parameter group.
$sel:parameterApplyStatus:DBParameterGroupStatus'
, dbParameterGroupStatus_parameterApplyStatus
- The status of parameter updates.
DBProxy
The data structure representing a proxy managed by the RDS Proxy.
This data type is used as a response element in the DescribeDBProxies
action.
See: newDBProxy
smart constructor.
Constructors
DBProxy' (Maybe DBProxyStatus) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe [UserAuthConfigInfo]) (Maybe Bool) (Maybe Int) (Maybe ISO8601) (Maybe ISO8601) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newDBProxy :: DBProxy Source #
Create a value of DBProxy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DBProxy'
, dbProxy_status
- The current status of this proxy. A status of available
means the
proxy is ready to handle requests. Other values indicate that you must
wait for the proxy to be ready, or take some action to resolve an issue.
$sel:dbProxyArn:DBProxy'
, dbProxy_dbProxyArn
- The Amazon Resource Name (ARN) for the proxy.
$sel:debugLogging:DBProxy'
, dbProxy_debugLogging
- 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.
$sel:vpcSubnetIds:DBProxy'
, dbProxy_vpcSubnetIds
- The EC2 subnet IDs for the proxy.
$sel:vpcId:DBProxy'
, dbProxy_vpcId
- Provides the VPC ID of the DB proxy.
$sel:engineFamily:DBProxy'
, dbProxy_engineFamily
- The engine family applies to MySQL and PostgreSQL for both RDS and
Aurora.
$sel:auth:DBProxy'
, dbProxy_auth
- One or more data structures specifying the authorization mechanism to
connect to the associated RDS DB instance or Aurora DB cluster.
$sel:requireTLS:DBProxy'
, dbProxy_requireTLS
- Indicates whether Transport Layer Security (TLS) encryption is required
for connections to the proxy.
$sel:idleClientTimeout:DBProxy'
, dbProxy_idleClientTimeout
- The number of seconds a connection to the proxy can have no activity
before the proxy drops the client connection. The proxy keeps the
underlying database connection open and puts it back into the connection
pool for reuse by later connection requests.
Default: 1800 (30 minutes)
Constraints: 1 to 28,800
$sel:updatedDate:DBProxy'
, dbProxy_updatedDate
- The date and time when the proxy was last updated.
$sel:createdDate:DBProxy'
, dbProxy_createdDate
- The date and time when the proxy was first created.
$sel:vpcSecurityGroupIds:DBProxy'
, dbProxy_vpcSecurityGroupIds
- Provides a list of VPC security groups that the proxy belongs to.
$sel:dbProxyName:DBProxy'
, dbProxy_dbProxyName
- 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.
$sel:endpoint:DBProxy'
, dbProxy_endpoint
- The endpoint that you can use to connect to the DB proxy. You include
the endpoint value in the connection string for a database client
application.
$sel:roleArn:DBProxy'
, dbProxy_roleArn
- The Amazon Resource Name (ARN) for the IAM role that the proxy uses to
access Amazon Secrets Manager.
DBProxyEndpoint
data DBProxyEndpoint Source #
The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy.
This data type is used as a response element in the
DescribeDBProxyEndpoints
operation.
See: newDBProxyEndpoint
smart constructor.
Constructors
DBProxyEndpoint' (Maybe DBProxyEndpointStatus) (Maybe Text) (Maybe DBProxyEndpointTargetRole) (Maybe [Text]) (Maybe Text) (Maybe ISO8601) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) |
Instances
newDBProxyEndpoint :: DBProxyEndpoint Source #
Create a value of DBProxyEndpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DBProxyEndpoint'
, dbProxyEndpoint_status
- The current status of this DB proxy endpoint. A status of available
means the endpoint is ready to handle requests. Other values indicate
that you must wait for the endpoint to be ready, or take some action to
resolve an issue.
$sel:dbProxyEndpointArn:DBProxyEndpoint'
, dbProxyEndpoint_dbProxyEndpointArn
- The Amazon Resource Name (ARN) for the DB proxy endpoint.
$sel:targetRole:DBProxyEndpoint'
, dbProxyEndpoint_targetRole
- A value that indicates whether the DB proxy endpoint can be used for
read/write or read-only operations.
$sel:vpcSubnetIds:DBProxyEndpoint'
, dbProxyEndpoint_vpcSubnetIds
- The EC2 subnet IDs for the DB proxy endpoint.
$sel:vpcId:DBProxyEndpoint'
, dbProxyEndpoint_vpcId
- Provides the VPC ID of the DB proxy endpoint.
$sel:createdDate:DBProxyEndpoint'
, dbProxyEndpoint_createdDate
- The date and time when the DB proxy endpoint was first created.
$sel:vpcSecurityGroupIds:DBProxyEndpoint'
, dbProxyEndpoint_vpcSecurityGroupIds
- Provides a list of VPC security groups that the DB proxy endpoint
belongs to.
$sel:dbProxyName:DBProxyEndpoint'
, dbProxyEndpoint_dbProxyName
- The identifier for the DB proxy that is associated with this DB proxy
endpoint.
$sel:endpoint:DBProxyEndpoint'
, dbProxyEndpoint_endpoint
- The endpoint that you can use to connect to the DB proxy. You include
the endpoint value in the connection string for a database client
application.
$sel:dbProxyEndpointName:DBProxyEndpoint'
, dbProxyEndpoint_dbProxyEndpointName
- The name for the DB proxy endpoint. An identifier must begin with a
letter and must contain only ASCII letters, digits, and hyphens; it
can't end with a hyphen or contain two consecutive hyphens.
$sel:isDefault:DBProxyEndpoint'
, dbProxyEndpoint_isDefault
- A value that indicates whether this endpoint is the default endpoint for
the associated DB proxy. Default DB proxy endpoints always have
read/write capability. Other endpoints that you associate with the DB
proxy can be either read/write or read-only.
DBProxyTarget
data DBProxyTarget Source #
Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.
This data type is used as a response element in the
DescribeDBProxyTargets
action.
See: newDBProxyTarget
smart constructor.
Constructors
DBProxyTarget' (Maybe Text) (Maybe TargetHealth) (Maybe Text) (Maybe TargetRole) (Maybe Text) (Maybe TargetType) (Maybe Text) (Maybe Int) |
Instances
newDBProxyTarget :: DBProxyTarget Source #
Create a value of DBProxyTarget
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetArn:DBProxyTarget'
, dbProxyTarget_targetArn
- The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB
cluster.
$sel:targetHealth:DBProxyTarget'
, dbProxyTarget_targetHealth
- Information about the connection health of the RDS Proxy target.
$sel:trackedClusterId:DBProxyTarget'
, dbProxyTarget_trackedClusterId
- The DB cluster identifier when the target represents an Aurora DB
cluster. This field is blank when the target represents an RDS DB
instance.
$sel:role':DBProxyTarget'
, dbProxyTarget_role
- A value that indicates whether the target of the proxy can be used for
read/write or read-only operations.
$sel:rdsResourceId:DBProxyTarget'
, dbProxyTarget_rdsResourceId
- The identifier representing the target. It can be the instance
identifier for an RDS DB instance, or the cluster identifier for an
Aurora DB cluster.
$sel:type':DBProxyTarget'
, dbProxyTarget_type
- Specifies the kind of database, such as an RDS DB instance or an Aurora
DB cluster, that the target represents.
$sel:endpoint:DBProxyTarget'
, dbProxyTarget_endpoint
- The writer endpoint for the RDS DB instance or Aurora DB cluster.
$sel:port:DBProxyTarget'
, dbProxyTarget_port
- The port that the RDS Proxy uses to connect to the target RDS DB
instance or Aurora DB cluster.
DBProxyTargetGroup
data DBProxyTargetGroup Source #
Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster.
This data type is used as a response element in the
DescribeDBProxyTargetGroups
action.
See: newDBProxyTargetGroup
smart constructor.
Constructors
DBProxyTargetGroup' (Maybe Text) (Maybe ConnectionPoolConfigurationInfo) (Maybe Text) (Maybe ISO8601) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Bool) |
Instances
newDBProxyTargetGroup :: DBProxyTargetGroup Source #
Create a value of DBProxyTargetGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DBProxyTargetGroup'
, dbProxyTargetGroup_status
- The current status of this target group. A status of available
means
the target group is correctly associated with a database. Other values
indicate that you must wait for the target group to be ready, or take
some action to resolve an issue.
$sel:connectionPoolConfig:DBProxyTargetGroup'
, dbProxyTargetGroup_connectionPoolConfig
- The settings that determine the size and behavior of the connection pool
for the target group.
$sel:targetGroupArn:DBProxyTargetGroup'
, dbProxyTargetGroup_targetGroupArn
- The Amazon Resource Name (ARN) representing the target group.
$sel:updatedDate:DBProxyTargetGroup'
, dbProxyTargetGroup_updatedDate
- The date and time when the target group was last updated.
$sel:createdDate:DBProxyTargetGroup'
, dbProxyTargetGroup_createdDate
- The date and time when the target group was first created.
$sel:dbProxyName:DBProxyTargetGroup'
, dbProxyTargetGroup_dbProxyName
- The identifier for the RDS proxy associated with this target group.
$sel:targetGroupName:DBProxyTargetGroup'
, dbProxyTargetGroup_targetGroupName
- The identifier for the target group. This name must be unique for all
target groups owned by your Amazon Web Services account in the specified
Amazon Web Services Region.
$sel:isDefault:DBProxyTargetGroup'
, dbProxyTargetGroup_isDefault
- Whether this target group is the first one used for connection requests
by the associated proxy. Because each proxy is currently associated with
a single target group, currently this setting is always true
.
DBSecurityGroup
data DBSecurityGroup Source #
Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the
DescribeDBSecurityGroups
action.
See: newDBSecurityGroup
smart constructor.
Constructors
DBSecurityGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [IPRange]) (Maybe Text) (Maybe [EC2SecurityGroup]) (Maybe Text) |
Instances
newDBSecurityGroup :: DBSecurityGroup Source #
Create a value of DBSecurityGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:vpcId:DBSecurityGroup'
, dbSecurityGroup_vpcId
- Provides the VpcId of the DB security group.
$sel:ownerId:DBSecurityGroup'
, dbSecurityGroup_ownerId
- Provides the Amazon Web Services ID of the owner of a specific DB
security group.
$sel:dbSecurityGroupArn:DBSecurityGroup'
, dbSecurityGroup_dbSecurityGroupArn
- The Amazon Resource Name (ARN) for the DB security group.
$sel:iPRanges:DBSecurityGroup'
, dbSecurityGroup_iPRanges
- Contains a list of IPRange
elements.
$sel:dbSecurityGroupName:DBSecurityGroup'
, dbSecurityGroup_dbSecurityGroupName
- Specifies the name of the DB security group.
$sel:eC2SecurityGroups:DBSecurityGroup'
, dbSecurityGroup_eC2SecurityGroups
- Contains a list of EC2SecurityGroup
elements.
$sel:dbSecurityGroupDescription:DBSecurityGroup'
, dbSecurityGroup_dbSecurityGroupDescription
- Provides the description of the DB security group.
DBSecurityGroupMembership
data DBSecurityGroupMembership Source #
This data type is used as a response element in the following actions:
ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceToPointInTime
See: newDBSecurityGroupMembership
smart constructor.
Constructors
DBSecurityGroupMembership' (Maybe Text) (Maybe Text) |
Instances
newDBSecurityGroupMembership :: DBSecurityGroupMembership Source #
Create a value of DBSecurityGroupMembership
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DBSecurityGroupMembership'
, dbSecurityGroupMembership_status
- The status of the DB security group.
$sel:dbSecurityGroupName:DBSecurityGroupMembership'
, dbSecurityGroupMembership_dbSecurityGroupName
- The name of the DB security group.
DBSnapshot
data DBSnapshot Source #
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the
DescribeDBSnapshots
action.
See: newDBSnapshot
smart constructor.
Constructors
DBSnapshot' (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe ISO8601) (Maybe [Tag]) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [ProcessorFeature]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text) |
Instances
newDBSnapshot :: DBSnapshot Source #
Create a value of DBSnapshot
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:originalSnapshotCreateTime:DBSnapshot'
, dbSnapshot_originalSnapshotCreateTime
- Specifies the time of the CreateDBSnapshot operation in Coordinated
Universal Time (UTC). Doesn't change when the snapshot is copied.
$sel:engineVersion:DBSnapshot'
, dbSnapshot_engineVersion
- Specifies the version of the database engine.
$sel:status:DBSnapshot'
, dbSnapshot_status
- Specifies the status of this DB snapshot.
$sel:dbSnapshotArn:DBSnapshot'
, dbSnapshot_dbSnapshotArn
- The Amazon Resource Name (ARN) for the DB snapshot.
$sel:masterUsername:DBSnapshot'
, dbSnapshot_masterUsername
- Provides the master username for the DB snapshot.
$sel:sourceRegion:DBSnapshot'
, dbSnapshot_sourceRegion
- The Amazon Web Services Region that the DB snapshot was created in or
copied from.
$sel:iAMDatabaseAuthenticationEnabled:DBSnapshot'
, dbSnapshot_iAMDatabaseAuthenticationEnabled
- True if mapping of Amazon Web Services Identity and Access Management
(IAM) accounts to database accounts is enabled, and otherwise false.
$sel:iops:DBSnapshot'
, dbSnapshot_iops
- Specifies the Provisioned IOPS (I/O operations per second) value of the
DB instance at the time of the snapshot.
$sel:vpcId:DBSnapshot'
, dbSnapshot_vpcId
- Provides the VPC ID associated with the DB snapshot.
$sel:instanceCreateTime:DBSnapshot'
, dbSnapshot_instanceCreateTime
- Specifies the time in Coordinated Universal Time (UTC) when the DB
instance, from which the snapshot was taken, was created.
$sel:tagList:DBSnapshot'
, dbSnapshot_tagList
- Undocumented member.
$sel:engine:DBSnapshot'
, dbSnapshot_engine
- Specifies the name of the database engine.
$sel:encrypted:DBSnapshot'
, dbSnapshot_encrypted
- Specifies whether the DB snapshot is encrypted.
$sel:dbSnapshotIdentifier:DBSnapshot'
, dbSnapshot_dbSnapshotIdentifier
- Specifies the identifier for the DB snapshot.
$sel:processorFeatures:DBSnapshot'
, dbSnapshot_processorFeatures
- The number of CPU cores and the number of threads per core for the DB
instance class of the DB instance when the DB snapshot was created.
$sel:licenseModel:DBSnapshot'
, dbSnapshot_licenseModel
- License model information for the restored DB instance.
$sel:sourceDBSnapshotIdentifier:DBSnapshot'
, dbSnapshot_sourceDBSnapshotIdentifier
- The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was
copied from. It only has a value in the case of a cross-account or
cross-Region copy.
$sel:snapshotType:DBSnapshot'
, dbSnapshot_snapshotType
- Provides the type of the DB snapshot.
$sel:dbInstanceIdentifier:DBSnapshot'
, dbSnapshot_dbInstanceIdentifier
- Specifies the DB instance identifier of the DB instance this DB snapshot
was created from.
$sel:kmsKeyId:DBSnapshot'
, dbSnapshot_kmsKeyId
- If Encrypted
is true, the Amazon Web Services KMS key identifier for
the encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
$sel:availabilityZone:DBSnapshot'
, dbSnapshot_availabilityZone
- Specifies the name of the Availability Zone the DB instance was located
in at the time of the DB snapshot.
$sel:snapshotCreateTime:DBSnapshot'
, dbSnapshot_snapshotCreateTime
- Specifies when the snapshot was taken in Coordinated Universal Time
(UTC). Changes for the copy when the snapshot is copied.
$sel:allocatedStorage:DBSnapshot'
, dbSnapshot_allocatedStorage
- Specifies the allocated storage size in gibibytes (GiB).
$sel:dbiResourceId:DBSnapshot'
, dbSnapshot_dbiResourceId
- The identifier for the source DB instance, which can't be changed and
which is unique to an Amazon Web Services Region.
$sel:optionGroupName:DBSnapshot'
, dbSnapshot_optionGroupName
- Provides the option group name for the DB snapshot.
$sel:timezone:DBSnapshot'
, dbSnapshot_timezone
- The time zone of the DB snapshot. In most cases, the Timezone
element
is empty. Timezone
content appears only for snapshots taken from
Microsoft SQL Server DB instances that were created with a time zone
specified.
$sel:tdeCredentialArn:DBSnapshot'
, dbSnapshot_tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE
encryption.
$sel:percentProgress:DBSnapshot'
, dbSnapshot_percentProgress
- The percentage of the estimated data that has been transferred.
$sel:port:DBSnapshot'
, dbSnapshot_port
- Specifies the port that the database engine was listening on at the time
of the snapshot.
$sel:storageType:DBSnapshot'
, dbSnapshot_storageType
- Specifies the storage type associated with DB snapshot.
DBSnapshotAttribute
data DBSnapshotAttribute Source #
Contains the name and values of a manual DB snapshot attribute
Manual DB snapshot attributes are used to authorize other Amazon Web
Services accounts to restore a manual DB snapshot. For more information,
see the ModifyDBSnapshotAttribute
API.
See: newDBSnapshotAttribute
smart constructor.
Constructors
DBSnapshotAttribute' (Maybe [Text]) (Maybe Text) |
Instances
newDBSnapshotAttribute :: DBSnapshotAttribute Source #
Create a value of DBSnapshotAttribute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeValues:DBSnapshotAttribute'
, dbSnapshotAttribute_attributeValues
- The value or values for the manual DB snapshot attribute.
If the AttributeName
field is set to restore
, then this element
returns a list of IDs of the Amazon Web Services accounts that are
authorized to copy or restore the manual DB snapshot. If a value of
all
is in the list, then the manual DB snapshot is public and
available for any Amazon Web Services account to copy or restore.
$sel:attributeName:DBSnapshotAttribute'
, dbSnapshotAttribute_attributeName
- The name of the manual DB snapshot attribute.
The attribute named restore
refers to the list of Amazon Web Services
accounts that have permission to copy or restore the manual DB cluster
snapshot. For more information, see the ModifyDBSnapshotAttribute
API
action.
DBSnapshotAttributesResult
data DBSnapshotAttributesResult Source #
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.
See: newDBSnapshotAttributesResult
smart constructor.
Constructors
DBSnapshotAttributesResult' (Maybe Text) (Maybe [DBSnapshotAttribute]) |
Instances
newDBSnapshotAttributesResult :: DBSnapshotAttributesResult Source #
Create a value of DBSnapshotAttributesResult
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSnapshotIdentifier:DBSnapshotAttributesResult'
, dbSnapshotAttributesResult_dbSnapshotIdentifier
- The identifier of the manual DB snapshot that the attributes apply to.
$sel:dbSnapshotAttributes:DBSnapshotAttributesResult'
, dbSnapshotAttributesResult_dbSnapshotAttributes
- The list of attributes and values for the manual DB snapshot.
DBSubnetGroup
data DBSubnetGroup Source #
Contains the details of an Amazon RDS DB subnet group.
This data type is used as a response element in the
DescribeDBSubnetGroups
action.
See: newDBSubnetGroup
smart constructor.
Constructors
DBSubnetGroup' (Maybe Text) (Maybe Text) (Maybe [Subnet]) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newDBSubnetGroup :: DBSubnetGroup Source #
Create a value of DBSubnetGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSubnetGroupName:DBSubnetGroup'
, dbSubnetGroup_dbSubnetGroupName
- The name of the DB subnet group.
$sel:vpcId:DBSubnetGroup'
, dbSubnetGroup_vpcId
- Provides the VpcId of the DB subnet group.
$sel:subnets:DBSubnetGroup'
, dbSubnetGroup_subnets
- Contains a list of Subnet
elements.
$sel:dbSubnetGroupDescription:DBSubnetGroup'
, dbSubnetGroup_dbSubnetGroupDescription
- Provides the description of the DB subnet group.
$sel:dbSubnetGroupArn:DBSubnetGroup'
, dbSubnetGroup_dbSubnetGroupArn
- The Amazon Resource Name (ARN) for the DB subnet group.
$sel:subnetGroupStatus:DBSubnetGroup'
, dbSubnetGroup_subnetGroupStatus
- Provides the status of the DB subnet group.
DescribeDBLogFilesDetails
data DescribeDBLogFilesDetails Source #
This data type is used as a response element to DescribeDBLogFiles
.
See: newDescribeDBLogFilesDetails
smart constructor.
Instances
newDescribeDBLogFilesDetails :: DescribeDBLogFilesDetails Source #
Create a value of DescribeDBLogFilesDetails
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastWritten:DescribeDBLogFilesDetails'
, describeDBLogFilesDetails_lastWritten
- A POSIX timestamp when the last log entry was written.
$sel:size:DescribeDBLogFilesDetails'
, describeDBLogFilesDetails_size
- The size, in bytes, of the log file for the specified DB instance.
$sel:logFileName:DescribeDBLogFilesDetails'
, describeDBLogFilesDetails_logFileName
- The name of the log file for the specified DB instance.
DomainMembership
data DomainMembership Source #
An Active Directory Domain membership record associated with the DB instance or cluster.
See: newDomainMembership
smart constructor.
Instances
newDomainMembership :: DomainMembership Source #
Create a value of DomainMembership
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DomainMembership'
, domainMembership_status
- The status of the Active Directory Domain membership for the DB instance
or cluster. Values include joined, pending-join, failed, and so on.
$sel:fqdn:DomainMembership'
, domainMembership_fqdn
- The fully qualified domain name of the Active Directory Domain.
$sel:domain:DomainMembership'
, domainMembership_domain
- The identifier of the Active Directory Domain.
$sel:iAMRoleName:DomainMembership'
, domainMembership_iAMRoleName
- The name of the IAM role to be used when making API calls to the
Directory Service.
DoubleRange
data DoubleRange Source #
A range of double values.
See: newDoubleRange
smart constructor.
Constructors
DoubleRange' (Maybe Double) (Maybe Double) |
Instances
newDoubleRange :: DoubleRange Source #
Create a value of DoubleRange
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:to:DoubleRange'
, doubleRange_to
- The maximum value in the range.
$sel:from:DoubleRange'
, doubleRange_from
- The minimum value in the range.
EC2SecurityGroup
data EC2SecurityGroup Source #
This data type is used as a response element in the following actions:
AuthorizeDBSecurityGroupIngress
DescribeDBSecurityGroups
RevokeDBSecurityGroupIngress
See: newEC2SecurityGroup
smart constructor.
Instances
newEC2SecurityGroup :: EC2SecurityGroup Source #
Create a value of EC2SecurityGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:EC2SecurityGroup'
, eC2SecurityGroup_status
- Provides the status of the EC2 security group. Status can be
"authorizing", "authorized", "revoking", and "revoked".
$sel:eC2SecurityGroupOwnerId:EC2SecurityGroup'
, eC2SecurityGroup_eC2SecurityGroupOwnerId
- Specifies the Amazon Web Services ID of the owner of the EC2 security
group specified in the EC2SecurityGroupName
field.
$sel:eC2SecurityGroupName:EC2SecurityGroup'
, eC2SecurityGroup_eC2SecurityGroupName
- Specifies the name of the EC2 security group.
$sel:eC2SecurityGroupId:EC2SecurityGroup'
, eC2SecurityGroup_eC2SecurityGroupId
- Specifies the id of the EC2 security group.
Endpoint
This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:
CreateDBInstance
DescribeDBInstances
DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster
endpoints, see DBClusterEndpoint
.
See: newEndpoint
smart constructor.
Instances
Eq Endpoint Source # | |
Read Endpoint Source # | |
Show Endpoint Source # | |
Generic Endpoint Source # | |
NFData Endpoint Source # | |
Defined in Amazonka.RDS.Types.Endpoint | |
Hashable Endpoint Source # | |
Defined in Amazonka.RDS.Types.Endpoint | |
FromXML Endpoint Source # | |
type Rep Endpoint Source # | |
Defined in Amazonka.RDS.Types.Endpoint type Rep Endpoint = D1 ('MetaData "Endpoint" "Amazonka.RDS.Types.Endpoint" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "Endpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) |
newEndpoint :: Endpoint Source #
Create a value of Endpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hostedZoneId:Endpoint'
, endpoint_hostedZoneId
- Specifies the ID that Amazon Route 53 assigns when you create a hosted
zone.
$sel:address:Endpoint'
, endpoint_address
- Specifies the DNS address of the DB instance.
$sel:port:Endpoint'
, endpoint_port
- Specifies the port that the database engine is listening on.
EngineDefaults
data EngineDefaults Source #
Contains the result of a successful invocation of the
DescribeEngineDefaultParameters
action.
See: newEngineDefaults
smart constructor.
Instances
newEngineDefaults :: EngineDefaults Source #
Create a value of EngineDefaults
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroupFamily:EngineDefaults'
, engineDefaults_dbParameterGroupFamily
- Specifies the name of the DB parameter group family that the engine
default parameters apply to.
$sel:marker:EngineDefaults'
, engineDefaults_marker
- An optional pagination token provided by a previous EngineDefaults
request. If this parameter is specified, the response includes only
records beyond the marker, up to the value specified by MaxRecords
.
$sel:parameters:EngineDefaults'
, engineDefaults_parameters
- Contains a list of engine default parameters.
Event
This data type is used as a response element in the DescribeEvents
action.
See: newEvent
smart constructor.
Constructors
Event' (Maybe SourceType) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe [Text]) (Maybe Text) |
Instances
Create a value of Event
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceType:Event'
, event_sourceType
- Specifies the source type for this event.
$sel:sourceArn:Event'
, event_sourceArn
- The Amazon Resource Name (ARN) for the event.
$sel:sourceIdentifier:Event'
, event_sourceIdentifier
- Provides the identifier for the source of the event.
$sel:date:Event'
, event_date
- Specifies the date and time of the event.
$sel:eventCategories:Event'
, event_eventCategories
- Specifies the category for the event.
$sel:message:Event'
, event_message
- Provides the text of this event.
EventCategoriesMap
data EventCategoriesMap Source #
Contains the results of a successful invocation of the
DescribeEventCategories
operation.
See: newEventCategoriesMap
smart constructor.
Constructors
EventCategoriesMap' (Maybe Text) (Maybe [Text]) |
Instances
newEventCategoriesMap :: EventCategoriesMap Source #
Create a value of EventCategoriesMap
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceType:EventCategoriesMap'
, eventCategoriesMap_sourceType
- The source type that the returned categories belong to
$sel:eventCategories:EventCategoriesMap'
, eventCategoriesMap_eventCategories
- The event categories for the specified source type
EventSubscription
data EventSubscription Source #
Contains the results of a successful invocation of the
DescribeEventSubscriptions
action.
See: newEventSubscription
smart constructor.
Constructors
EventSubscription' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe [Text]) |
Instances
newEventSubscription :: EventSubscription Source #
Create a value of EventSubscription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:EventSubscription'
, eventSubscription_status
- The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
$sel:customerAwsId:EventSubscription'
, eventSubscription_customerAwsId
- The Amazon Web Services customer account associated with the RDS event
notification subscription.
$sel:custSubscriptionId:EventSubscription'
, eventSubscription_custSubscriptionId
- The RDS event notification subscription Id.
$sel:snsTopicArn:EventSubscription'
, eventSubscription_snsTopicArn
- The topic ARN of the RDS event notification subscription.
$sel:eventSubscriptionArn:EventSubscription'
, eventSubscription_eventSubscriptionArn
- The Amazon Resource Name (ARN) for the event subscription.
$sel:enabled:EventSubscription'
, eventSubscription_enabled
- A Boolean value indicating if the subscription is enabled. True
indicates the subscription is enabled.
$sel:sourceType:EventSubscription'
, eventSubscription_sourceType
- The source type for the RDS event notification subscription.
$sel:subscriptionCreationTime:EventSubscription'
, eventSubscription_subscriptionCreationTime
- The time the RDS event notification subscription was created.
$sel:eventCategoriesList:EventSubscription'
, eventSubscription_eventCategoriesList
- A list of event categories for the RDS event notification subscription.
$sel:sourceIdsList:EventSubscription'
, eventSubscription_sourceIdsList
- A list of source IDs for the RDS event notification subscription.
ExportTask
data ExportTask Source #
Contains the details of a snapshot export to Amazon S3.
This data type is used as a response element in the
DescribeExportTasks
action.
See: newExportTask
smart constructor.
Constructors
ExportTask' (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) |
Instances
newExportTask :: ExportTask Source #
Create a value of ExportTask
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:totalExtractedDataInGB:ExportTask'
, exportTask_totalExtractedDataInGB
- The total amount of data exported, in gigabytes.
$sel:status:ExportTask'
, exportTask_status
- The progress status of the export task.
$sel:iamRoleArn:ExportTask'
, exportTask_iamRoleArn
- The name of the IAM role that is used to write to Amazon S3 when
exporting a snapshot.
$sel:sourceArn:ExportTask'
, exportTask_sourceArn
- The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
$sel:exportOnly:ExportTask'
, exportTask_exportOnly
- The data exported from the snapshot. Valid values are the following:
database
- Export all the data from a specified database.database.table
table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.database.schema
schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.database.schema.table
table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
$sel:taskStartTime:ExportTask'
, exportTask_taskStartTime
- The time that the snapshot export task started.
$sel:warningMessage:ExportTask'
, exportTask_warningMessage
- A warning about the snapshot export task.
$sel:snapshotTime:ExportTask'
, exportTask_snapshotTime
- The time that the snapshot was created.
$sel:kmsKeyId:ExportTask'
, exportTask_kmsKeyId
- The key identifier of the Amazon Web Services KMS customer master key
(CMK) that is used to encrypt the snapshot when it's exported to Amazon
S3. The Amazon Web Services KMS CMK identifier is its key ARN, key ID,
alias ARN, or alias name. The IAM role used for the snapshot export must
have encryption and decryption permissions to use this Amazon Web
Services KMS CMK.
$sel:taskEndTime:ExportTask'
, exportTask_taskEndTime
- The time that the snapshot export task completed.
$sel:exportTaskIdentifier:ExportTask'
, exportTask_exportTaskIdentifier
- A unique identifier for the snapshot export task. This ID isn't an
identifier for the Amazon S3 bucket where the snapshot is exported to.
$sel:s3Prefix:ExportTask'
, exportTask_s3Prefix
- The Amazon S3 bucket prefix that is the file name and path of the
exported snapshot.
$sel:percentProgress:ExportTask'
, exportTask_percentProgress
- The progress of the snapshot export task as a percentage.
$sel:s3Bucket:ExportTask'
, exportTask_s3Bucket
- The Amazon S3 bucket that the snapshot is exported to.
$sel:failureCause:ExportTask'
, exportTask_failureCause
- The reason the export failed, if it failed.
FailoverState
data FailoverState Source #
Contains the state of scheduled or in-process failover operations on an Aurora global database (GlobalCluster). This Data type is empty unless a failover operation is scheduled or is currently underway on the Aurora global database.
See: newFailoverState
smart constructor.
Constructors
FailoverState' (Maybe FailoverStatus) (Maybe Text) (Maybe Text) |
Instances
newFailoverState :: FailoverState Source #
Create a value of FailoverState
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:FailoverState'
, failoverState_status
- The current status of the Aurora global database (GlobalCluster).
Possible values are as follows:
- pending – A request to fail over the Aurora global database
(GlobalCluster) has been received by the service. The
GlobalCluster
's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start. - failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.
- cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.
$sel:toDbClusterArn:FailoverState'
, failoverState_toDbClusterArn
- The Amazon Resource Name (ARN) of the Aurora DB cluster that is
currently being promoted, and which is associated with this state.
$sel:fromDbClusterArn:FailoverState'
, failoverState_fromDbClusterArn
- The Amazon Resource Name (ARN) of the Aurora DB cluster that is
currently being demoted, and which is associated with this state.
Filter
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribePendingMaintenanceActions
See: newFilter
smart constructor.
Instances
Eq Filter Source # | |
Read Filter Source # | |
Show Filter Source # | |
Generic Filter Source # | |
NFData Filter Source # | |
Defined in Amazonka.RDS.Types.Filter | |
Hashable Filter Source # | |
Defined in Amazonka.RDS.Types.Filter | |
ToQuery Filter Source # | |
Defined in Amazonka.RDS.Types.Filter Methods toQuery :: Filter -> QueryString # | |
type Rep Filter Source # | |
Defined in Amazonka.RDS.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.RDS.Types.Filter" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))) |
Create a value of Filter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Filter'
, filter_name
- The name of the filter. Filter names are case-sensitive.
$sel:values:Filter'
, filter_values
- One or more filter values. Filter values are case-sensitive.
GlobalCluster
data GlobalCluster Source #
A data type representing an Aurora global database.
See: newGlobalCluster
smart constructor.
Constructors
GlobalCluster' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [GlobalClusterMember]) (Maybe FailoverState) (Maybe Text) |
Instances
newGlobalCluster :: GlobalCluster Source #
Create a value of GlobalCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:GlobalCluster'
, globalCluster_engineVersion
- Indicates the database engine version.
$sel:status:GlobalCluster'
, globalCluster_status
- Specifies the current state of this global database cluster.
$sel:deletionProtection:GlobalCluster'
, globalCluster_deletionProtection
- The deletion protection setting for the new global database cluster.
$sel:storageEncrypted:GlobalCluster'
, globalCluster_storageEncrypted
- The storage encryption setting for the global database cluster.
$sel:globalClusterIdentifier:GlobalCluster'
, globalCluster_globalClusterIdentifier
- Contains a user-supplied global database cluster identifier. This
identifier is the unique key that identifies a global database cluster.
$sel:engine:GlobalCluster'
, globalCluster_engine
- The Aurora database engine used by the global database cluster.
$sel:globalClusterArn:GlobalCluster'
, globalCluster_globalClusterArn
- The Amazon Resource Name (ARN) for the global database cluster.
$sel:databaseName:GlobalCluster'
, globalCluster_databaseName
- The default database name within the new global database cluster.
$sel:globalClusterMembers:GlobalCluster'
, globalCluster_globalClusterMembers
- The list of cluster IDs for secondary clusters within the global
database cluster. Currently limited to 1 item.
$sel:failoverState:GlobalCluster'
, globalCluster_failoverState
- A data object containing all properties for the current state of an
in-process or pending failover process for this Aurora global database.
This object is empty unless the FailoverGlobalCluster API operation has
been called on this Aurora global database (GlobalCluster).
$sel:globalClusterResourceId:GlobalCluster'
, globalCluster_globalClusterResourceId
- The Amazon Web Services Region-unique, immutable identifier for the
global database cluster. This identifier is found in Amazon Web Services
CloudTrail log entries whenever the Amazon Web Services KMS customer
master key (CMK) for the DB cluster is accessed.
GlobalClusterMember
data GlobalClusterMember Source #
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
See: newGlobalClusterMember
smart constructor.
Constructors
GlobalClusterMember' (Maybe [Text]) (Maybe Text) (Maybe Bool) (Maybe WriteForwardingStatus) |
Instances
newGlobalClusterMember :: GlobalClusterMember Source #
Create a value of GlobalClusterMember
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:readers:GlobalClusterMember'
, globalClusterMember_readers
- The Amazon Resource Name (ARN) for each read-only secondary cluster
associated with the Aurora global database.
$sel:dbClusterArn:GlobalClusterMember'
, globalClusterMember_dbClusterArn
- The Amazon Resource Name (ARN) for each Aurora cluster.
$sel:isWriter:GlobalClusterMember'
, globalClusterMember_isWriter
- Specifies whether the Aurora cluster is the primary cluster (that is,
has read-write capability) for the Aurora global database with which it
is associated.
$sel:globalWriteForwardingStatus:GlobalClusterMember'
, globalClusterMember_globalWriteForwardingStatus
- Specifies whether a secondary cluster in an Aurora global database has
write forwarding enabled, not enabled, or is in the process of enabling
it.
IPRange
This data type is used as a response element in the
DescribeDBSecurityGroups
action.
See: newIPRange
smart constructor.
Instances
Eq IPRange Source # | |
Read IPRange Source # | |
Show IPRange Source # | |
Generic IPRange Source # | |
NFData IPRange Source # | |
Defined in Amazonka.RDS.Types.IPRange | |
Hashable IPRange Source # | |
Defined in Amazonka.RDS.Types.IPRange | |
FromXML IPRange Source # | |
type Rep IPRange Source # | |
Defined in Amazonka.RDS.Types.IPRange type Rep IPRange = D1 ('MetaData "IPRange" "Amazonka.RDS.Types.IPRange" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "IPRange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cidrip") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newIPRange :: IPRange Source #
Create a value of IPRange
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:IPRange'
, iPRange_status
- Specifies the status of the IP range. Status can be "authorizing",
"authorized", "revoking", and "revoked".
$sel:cidrip:IPRange'
, iPRange_cidrip
- Specifies the IP range.
InstallationMedia
data InstallationMedia Source #
Contains the installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
See: newInstallationMedia
smart constructor.
Constructors
InstallationMedia' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InstallationMediaFailureCause) |
Instances
newInstallationMedia :: InstallationMedia Source #
Create a value of InstallationMedia
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:InstallationMedia'
, installationMedia_engineVersion
- The engine version of the DB engine.
$sel:status:InstallationMedia'
, installationMedia_status
- The status of the installation medium.
$sel:installationMediaId:InstallationMedia'
, installationMedia_installationMediaId
- The installation medium ID.
$sel:engineInstallationMediaPath:InstallationMedia'
, installationMedia_engineInstallationMediaPath
- The path to the installation medium for the DB engine.
$sel:engine:InstallationMedia'
, installationMedia_engine
- The DB engine.
$sel:oSInstallationMediaPath:InstallationMedia'
, installationMedia_oSInstallationMediaPath
- The path to the installation medium for the operating system associated
with the DB engine.
$sel:customAvailabilityZoneId:InstallationMedia'
, installationMedia_customAvailabilityZoneId
- The custom Availability Zone (AZ) that contains the installation media.
$sel:failureCause:InstallationMedia'
, installationMedia_failureCause
- If an installation media failure occurred, the cause of the failure.
InstallationMediaFailureCause
data InstallationMediaFailureCause Source #
Contains the cause of an installation media failure. Installation media is used for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
See: newInstallationMediaFailureCause
smart constructor.
Constructors
InstallationMediaFailureCause' (Maybe Text) |
Instances
newInstallationMediaFailureCause :: InstallationMediaFailureCause Source #
Create a value of InstallationMediaFailureCause
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:InstallationMediaFailureCause'
, installationMediaFailureCause_message
- The reason that an installation media import failed.
MinimumEngineVersionPerAllowedValue
data MinimumEngineVersionPerAllowedValue Source #
The minimum DB engine version required for each corresponding allowed value for an option setting.
See: newMinimumEngineVersionPerAllowedValue
smart constructor.
Constructors
MinimumEngineVersionPerAllowedValue' (Maybe Text) (Maybe Text) |
Instances
newMinimumEngineVersionPerAllowedValue :: MinimumEngineVersionPerAllowedValue Source #
Create a value of MinimumEngineVersionPerAllowedValue
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:minimumEngineVersion:MinimumEngineVersionPerAllowedValue'
, minimumEngineVersionPerAllowedValue_minimumEngineVersion
- The minimum DB engine version required for the allowed value.
$sel:allowedValue:MinimumEngineVersionPerAllowedValue'
, minimumEngineVersionPerAllowedValue_allowedValue
- The allowed value for an option setting.
Option
Option details.
See: newOption
smart constructor.
Constructors
Option' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [OptionSetting]) (Maybe [VpcSecurityGroupMembership]) (Maybe [DBSecurityGroupMembership]) (Maybe Text) (Maybe Int) |
Instances
Create a value of Option
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:optionName:Option'
, option_optionName
- The name of the option.
$sel:permanent:Option'
, option_permanent
- Indicate if this option is permanent.
$sel:persistent:Option'
, option_persistent
- Indicate if this option is persistent.
$sel:optionDescription:Option'
, option_optionDescription
- The description of the option.
$sel:optionSettings:Option'
, option_optionSettings
- The option settings for this option.
$sel:vpcSecurityGroupMemberships:Option'
, option_vpcSecurityGroupMemberships
- If the option requires access to a port, then this VPC security group
allows access to the port.
$sel:dbSecurityGroupMemberships:Option'
, option_dbSecurityGroupMemberships
- If the option requires access to a port, then this DB security group
allows access to the port.
$sel:optionVersion:Option'
, option_optionVersion
- The version of the option.
$sel:port:Option'
, option_port
- If required, the port configured for this option to use.
OptionConfiguration
data OptionConfiguration Source #
A list of all available options
See: newOptionConfiguration
smart constructor.
Constructors
OptionConfiguration' (Maybe [OptionSetting]) (Maybe [Text]) (Maybe [Text]) (Maybe Text) (Maybe Int) Text |
Instances
newOptionConfiguration Source #
Arguments
:: Text | |
-> OptionConfiguration |
Create a value of OptionConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:optionSettings:OptionConfiguration'
, optionConfiguration_optionSettings
- The option settings to include in an option group.
$sel:vpcSecurityGroupMemberships:OptionConfiguration'
, optionConfiguration_vpcSecurityGroupMemberships
- A list of VpcSecurityGroupMembership name strings used for this option.
$sel:dbSecurityGroupMemberships:OptionConfiguration'
, optionConfiguration_dbSecurityGroupMemberships
- A list of DBSecurityGroupMembership name strings used for this option.
$sel:optionVersion:OptionConfiguration'
, optionConfiguration_optionVersion
- The version for the option.
$sel:port:OptionConfiguration'
, optionConfiguration_port
- The optional port for the option.
$sel:optionName:OptionConfiguration'
, optionConfiguration_optionName
- The configuration of options to include in a group.
OptionGroup
data OptionGroup Source #
See: newOptionGroup
smart constructor.
Constructors
OptionGroup' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Option]) (Maybe Text) |
Instances
newOptionGroup :: OptionGroup Source #
Create a value of OptionGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:optionGroupDescription:OptionGroup'
, optionGroup_optionGroupDescription
- Provides a description of the option group.
$sel:vpcId:OptionGroup'
, optionGroup_vpcId
- If AllowsVpcAndNonVpcInstanceMemberships is false
, this field is
blank. If AllowsVpcAndNonVpcInstanceMemberships is true
and this
field is blank, then this option group can be applied to both VPC and
non-VPC instances. If this field contains a value, then this option
group can only be applied to instances that are in the VPC indicated by
this field.
$sel:allowsVpcAndNonVpcInstanceMemberships:OptionGroup'
, optionGroup_allowsVpcAndNonVpcInstanceMemberships
- Indicates whether this option group can be applied to both VPC and
non-VPC instances. The value true
indicates the option group can be
applied to both VPC and non-VPC instances.
$sel:engineName:OptionGroup'
, optionGroup_engineName
- Indicates the name of the engine that this option group can be applied
to.
$sel:optionGroupArn:OptionGroup'
, optionGroup_optionGroupArn
- The Amazon Resource Name (ARN) for the option group.
$sel:majorEngineVersion:OptionGroup'
, optionGroup_majorEngineVersion
- Indicates the major engine version associated with this option group.
$sel:options:OptionGroup'
, optionGroup_options
- Indicates what options are available in the option group.
$sel:optionGroupName:OptionGroup'
, optionGroup_optionGroupName
- Specifies the name of the option group.
OptionGroupMembership
data OptionGroupMembership Source #
Provides information on the option groups the DB instance is a member of.
See: newOptionGroupMembership
smart constructor.
Constructors
OptionGroupMembership' (Maybe Text) (Maybe Text) |
Instances
newOptionGroupMembership :: OptionGroupMembership Source #
Create a value of OptionGroupMembership
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:OptionGroupMembership'
, optionGroupMembership_status
- The status of the DB instance's option group membership. Valid values
are: in-sync
, pending-apply
, pending-removal
,
pending-maintenance-apply
, pending-maintenance-removal
, applying
,
removing
, and failed
.
$sel:optionGroupName:OptionGroupMembership'
, optionGroupMembership_optionGroupName
- The name of the option group that the instance belongs to.
OptionGroupOption
data OptionGroupOption Source #
Available option.
See: newOptionGroupOption
smart constructor.
Constructors
OptionGroupOption' (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Bool) (Maybe [OptionVersion]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe [OptionGroupOptionSetting]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Bool) |
Instances
newOptionGroupOption :: OptionGroupOption Source #
Create a value of OptionGroupOption
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:minimumRequiredMinorEngineVersion:OptionGroupOption'
, optionGroupOption_minimumRequiredMinorEngineVersion
- The minimum required engine version for the option to be applied.
$sel:optionsConflictsWith:OptionGroupOption'
, optionGroupOption_optionsConflictsWith
- The options that conflict with this option.
$sel:permanent:OptionGroupOption'
, optionGroupOption_permanent
- Permanent options can never be removed from an option group. An option
group containing a permanent option can't be removed from a DB
instance.
$sel:persistent:OptionGroupOption'
, optionGroupOption_persistent
- Persistent options can't be removed from an option group while DB
instances are associated with the option group. If you disassociate all
DB instances from the option group, your can remove the persistent
option from the option group.
$sel:optionGroupOptionVersions:OptionGroupOption'
, optionGroupOption_optionGroupOptionVersions
- The versions that are available for the option.
$sel:engineName:OptionGroupOption'
, optionGroupOption_engineName
- The name of the engine that this option can be applied to.
$sel:majorEngineVersion:OptionGroupOption'
, optionGroupOption_majorEngineVersion
- Indicates the major engine version that the option is available for.
$sel:name:OptionGroupOption'
, optionGroupOption_name
- The name of the option.
$sel:supportsOptionVersionDowngrade:OptionGroupOption'
, optionGroupOption_supportsOptionVersionDowngrade
- If true, you can change the option to an earlier version of the option.
This only applies to options that have different versions available.
$sel:defaultPort:OptionGroupOption'
, optionGroupOption_defaultPort
- If the option requires a port, specifies the default port for the
option.
$sel:optionGroupOptionSettings:OptionGroupOption'
, optionGroupOption_optionGroupOptionSettings
- The option settings that are available (and the default value) for each
option in an option group.
$sel:requiresAutoMinorEngineVersionUpgrade:OptionGroupOption'
, optionGroupOption_requiresAutoMinorEngineVersionUpgrade
- If true, you must enable the Auto Minor Version Upgrade setting for your
DB instance before you can use this option. You can enable Auto Minor
Version Upgrade when you first create your DB instance, or by modifying
your DB instance later.
$sel:portRequired:OptionGroupOption'
, optionGroupOption_portRequired
- Specifies whether the option requires a port.
$sel:description:OptionGroupOption'
, optionGroupOption_description
- The description of the option.
$sel:optionsDependedOn:OptionGroupOption'
, optionGroupOption_optionsDependedOn
- The options that are prerequisites for this option.
$sel:vpcOnly:OptionGroupOption'
, optionGroupOption_vpcOnly
- If true, you can only use this option with a DB instance that is in a
VPC.
OptionGroupOptionSetting
data OptionGroupOptionSetting Source #
Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.
See: newOptionGroupOptionSetting
smart constructor.
Constructors
OptionGroupOptionSetting' (Maybe Text) (Maybe [MinimumEngineVersionPerAllowedValue]) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) |
Instances
newOptionGroupOptionSetting :: OptionGroupOptionSetting Source #
Create a value of OptionGroupOptionSetting
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applyType:OptionGroupOptionSetting'
, optionGroupOptionSetting_applyType
- The DB engine specific parameter type for the option group option.
$sel:minimumEngineVersionPerAllowedValue:OptionGroupOptionSetting'
, optionGroupOptionSetting_minimumEngineVersionPerAllowedValue
- The minimum DB engine version required for the corresponding allowed
value for this option setting.
$sel:settingName:OptionGroupOptionSetting'
, optionGroupOptionSetting_settingName
- The name of the option group option.
$sel:defaultValue:OptionGroupOptionSetting'
, optionGroupOptionSetting_defaultValue
- The default value for the option group option.
$sel:isModifiable:OptionGroupOptionSetting'
, optionGroupOptionSetting_isModifiable
- Boolean value where true indicates that this option group option can be
changed from the default value.
$sel:settingDescription:OptionGroupOptionSetting'
, optionGroupOptionSetting_settingDescription
- The description of the option group option.
$sel:allowedValues:OptionGroupOptionSetting'
, optionGroupOptionSetting_allowedValues
- Indicates the acceptable values for the option group option.
$sel:isRequired:OptionGroupOptionSetting'
, optionGroupOptionSetting_isRequired
- Boolean value where true indicates that a value must be specified for
this option setting of the option group option.
OptionSetting
data OptionSetting Source #
Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
See: newOptionSetting
smart constructor.
Constructors
OptionSetting' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newOptionSetting :: OptionSetting Source #
Create a value of OptionSetting
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:isCollection:OptionSetting'
, optionSetting_isCollection
- Indicates if the option setting is part of a collection.
$sel:applyType:OptionSetting'
, optionSetting_applyType
- The DB engine specific parameter type.
$sel:value:OptionSetting'
, optionSetting_value
- The current value of the option setting.
$sel:name:OptionSetting'
, optionSetting_name
- The name of the option that has settings that you can set.
$sel:defaultValue:OptionSetting'
, optionSetting_defaultValue
- The default value of the option setting.
$sel:isModifiable:OptionSetting'
, optionSetting_isModifiable
- A Boolean value that, when true, indicates the option setting can be
modified from the default.
$sel:dataType:OptionSetting'
, optionSetting_dataType
- The data type of the option setting.
$sel:allowedValues:OptionSetting'
, optionSetting_allowedValues
- The allowed values of the option setting.
$sel:description:OptionSetting'
, optionSetting_description
- The description of the option setting.
OptionVersion
data OptionVersion Source #
The version for an option. Option group option versions are returned by
the DescribeOptionGroupOptions
action.
See: newOptionVersion
smart constructor.
Constructors
OptionVersion' (Maybe Text) (Maybe Bool) |
Instances
newOptionVersion :: OptionVersion Source #
Create a value of OptionVersion
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:version:OptionVersion'
, optionVersion_version
- The version of the option.
$sel:isDefault:OptionVersion'
, optionVersion_isDefault
- True if the version is the default version of the option, and otherwise
false.
OrderableDBInstanceOption
data OrderableDBInstanceOption Source #
Contains a list of available options for a DB instance.
This data type is used as a response element in the
DescribeOrderableDBInstanceOptions
action.
See: newOrderableDBInstanceOption
smart constructor.
Constructors
OrderableDBInstanceOption' (Maybe Text) (Maybe Double) (Maybe Bool) (Maybe Int) (Maybe Bool) (Maybe Int) (Maybe [Text]) (Maybe Text) (Maybe [AvailableProcessorFeature]) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [AvailabilityZone]) (Maybe [Text]) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Double) (Maybe Bool) (Maybe Bool) (Maybe Int) (Maybe Text) |
Instances
newOrderableDBInstanceOption :: OrderableDBInstanceOption Source #
Create a value of OrderableDBInstanceOption
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:OrderableDBInstanceOption'
, orderableDBInstanceOption_engineVersion
- The engine version of a DB instance.
$sel:minIopsPerGib:OrderableDBInstanceOption'
, orderableDBInstanceOption_minIopsPerGib
- Minimum provisioned IOPS per GiB for a DB instance.
$sel:supportsIAMDatabaseAuthentication:OrderableDBInstanceOption'
, orderableDBInstanceOption_supportsIAMDatabaseAuthentication
- Indicates whether a DB instance supports IAM database authentication.
$sel:minIopsPerDbInstance:OrderableDBInstanceOption'
, orderableDBInstanceOption_minIopsPerDbInstance
- Minimum total provisioned IOPS for a DB instance.
$sel:multiAZCapable:OrderableDBInstanceOption'
, orderableDBInstanceOption_multiAZCapable
- Indicates whether a DB instance is Multi-AZ capable.
$sel:maxStorageSize:OrderableDBInstanceOption'
, orderableDBInstanceOption_maxStorageSize
- Maximum storage size for a DB instance.
$sel:supportedEngineModes:OrderableDBInstanceOption'
, orderableDBInstanceOption_supportedEngineModes
- A list of the supported DB engine modes.
$sel:availabilityZoneGroup:OrderableDBInstanceOption'
, orderableDBInstanceOption_availabilityZoneGroup
- The Availability Zone group for a DB instance.
$sel:availableProcessorFeatures:OrderableDBInstanceOption'
, orderableDBInstanceOption_availableProcessorFeatures
- A list of the available processor features for the DB instance class of
a DB instance.
$sel:engine:OrderableDBInstanceOption'
, orderableDBInstanceOption_engine
- The engine type of a DB instance.
$sel:minStorageSize:OrderableDBInstanceOption'
, orderableDBInstanceOption_minStorageSize
- Minimum storage size for a DB instance.
$sel:outpostCapable:OrderableDBInstanceOption'
, orderableDBInstanceOption_outpostCapable
- Whether a DB instance supports RDS on Outposts.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
$sel:supportsIops:OrderableDBInstanceOption'
, orderableDBInstanceOption_supportsIops
- Indicates whether a DB instance supports provisioned IOPS.
$sel:supportsKerberosAuthentication:OrderableDBInstanceOption'
, orderableDBInstanceOption_supportsKerberosAuthentication
- Whether a DB instance supports Kerberos Authentication.
$sel:supportsPerformanceInsights:OrderableDBInstanceOption'
, orderableDBInstanceOption_supportsPerformanceInsights
- True if a DB instance supports Performance Insights, otherwise false.
$sel:dbInstanceClass:OrderableDBInstanceOption'
, orderableDBInstanceOption_dbInstanceClass
- The DB instance class for a DB instance.
$sel:supportsGlobalDatabases:OrderableDBInstanceOption'
, orderableDBInstanceOption_supportsGlobalDatabases
- A value that indicates whether you can use Aurora global databases with
a specific combination of other DB engine attributes.
$sel:licenseModel:OrderableDBInstanceOption'
, orderableDBInstanceOption_licenseModel
- The license model for a DB instance.
$sel:availabilityZones:OrderableDBInstanceOption'
, orderableDBInstanceOption_availabilityZones
- A list of Availability Zones for a DB instance.
$sel:supportedActivityStreamModes:OrderableDBInstanceOption'
, orderableDBInstanceOption_supportedActivityStreamModes
- The list of supported modes for Database Activity Streams. Aurora
PostgreSQL returns the value [sync, async]
. Aurora MySQL and RDS for
Oracle return [async]
only. If Database Activity Streams isn't
supported, the return value is an empty list.
$sel:supportsStorageAutoscaling:OrderableDBInstanceOption'
, orderableDBInstanceOption_supportsStorageAutoscaling
- Whether Amazon RDS can automatically scale storage for DB instances that
use the specified DB instance class.
$sel:supportsStorageEncryption:OrderableDBInstanceOption'
, orderableDBInstanceOption_supportsStorageEncryption
- Indicates whether a DB instance supports encrypted storage.
$sel:readReplicaCapable:OrderableDBInstanceOption'
, orderableDBInstanceOption_readReplicaCapable
- Indicates whether a DB instance can have a read replica.
$sel:maxIopsPerGib:OrderableDBInstanceOption'
, orderableDBInstanceOption_maxIopsPerGib
- Maximum provisioned IOPS per GiB for a DB instance.
$sel:vpc:OrderableDBInstanceOption'
, orderableDBInstanceOption_vpc
- Indicates whether a DB instance is in a VPC.
$sel:supportsEnhancedMonitoring:OrderableDBInstanceOption'
, orderableDBInstanceOption_supportsEnhancedMonitoring
- Indicates whether a DB instance supports Enhanced Monitoring at
intervals from 1 to 60 seconds.
$sel:maxIopsPerDbInstance:OrderableDBInstanceOption'
, orderableDBInstanceOption_maxIopsPerDbInstance
- Maximum total provisioned IOPS for a DB instance.
$sel:storageType:OrderableDBInstanceOption'
, orderableDBInstanceOption_storageType
- Indicates the storage type for a DB instance.
Outpost
A data type that represents an Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
See: newOutpost
smart constructor.
Instances
Eq Outpost Source # | |
Read Outpost Source # | |
Show Outpost Source # | |
Generic Outpost Source # | |
NFData Outpost Source # | |
Defined in Amazonka.RDS.Types.Outpost | |
Hashable Outpost Source # | |
Defined in Amazonka.RDS.Types.Outpost | |
FromXML Outpost Source # | |
type Rep Outpost Source # | |
Defined in Amazonka.RDS.Types.Outpost |
newOutpost :: Outpost Source #
Create a value of Outpost
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Outpost'
, outpost_arn
- The Amazon Resource Name (ARN) of the Outpost.
Parameter
This data type is used as a request parameter in the
ModifyDBParameterGroup
and ResetDBParameterGroup
actions.
This data type is used as a response element in the
DescribeEngineDefaultParameters
and DescribeDBParameters
actions.
See: newParameter
smart constructor.
Constructors
Parameter' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe ApplyMethod) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newParameter :: Parameter Source #
Create a value of Parameter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applyType:Parameter'
, parameter_applyType
- Specifies the engine specific parameters type.
$sel:parameterValue:Parameter'
, parameter_parameterValue
- Specifies the value of the parameter.
$sel:supportedEngineModes:Parameter'
, parameter_supportedEngineModes
- The valid DB engine modes.
$sel:applyMethod:Parameter'
, parameter_applyMethod
- Indicates when to apply parameter updates.
$sel:minimumEngineVersion:Parameter'
, parameter_minimumEngineVersion
- The earliest engine version to which the parameter can apply.
$sel:source:Parameter'
, parameter_source
- Indicates the source of the parameter value.
$sel:isModifiable:Parameter'
, parameter_isModifiable
- Indicates whether (true
) or not (false
) the parameter can be
modified. Some parameters have security or operational implications that
prevent them from being changed.
$sel:dataType:Parameter'
, parameter_dataType
- Specifies the valid data type for the parameter.
$sel:allowedValues:Parameter'
, parameter_allowedValues
- Specifies the valid range of values for the parameter.
$sel:parameterName:Parameter'
, parameter_parameterName
- Specifies the name of the parameter.
$sel:description:Parameter'
, parameter_description
- Provides a description of the parameter.
PendingCloudwatchLogsExports
data PendingCloudwatchLogsExports Source #
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
See: newPendingCloudwatchLogsExports
smart constructor.
Constructors
PendingCloudwatchLogsExports' (Maybe [Text]) (Maybe [Text]) |
Instances
newPendingCloudwatchLogsExports :: PendingCloudwatchLogsExports Source #
Create a value of PendingCloudwatchLogsExports
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logTypesToEnable:PendingCloudwatchLogsExports'
, pendingCloudwatchLogsExports_logTypesToEnable
- Log types that are in the process of being deactivated. After they are
deactivated, these log types aren't exported to CloudWatch Logs.
$sel:logTypesToDisable:PendingCloudwatchLogsExports'
, pendingCloudwatchLogsExports_logTypesToDisable
- Log types that are in the process of being enabled. After they are
enabled, these log types are exported to CloudWatch Logs.
PendingMaintenanceAction
data PendingMaintenanceAction Source #
Provides information about a pending maintenance action for a resource.
See: newPendingMaintenanceAction
smart constructor.
Constructors
PendingMaintenanceAction' (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe ISO8601) |
Instances
newPendingMaintenanceAction :: PendingMaintenanceAction Source #
Create a value of PendingMaintenanceAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoAppliedAfterDate:PendingMaintenanceAction'
, pendingMaintenanceAction_autoAppliedAfterDate
- The date of the maintenance window when the action is applied. The
maintenance action is applied to the resource during its first
maintenance window after this date.
$sel:action:PendingMaintenanceAction'
, pendingMaintenanceAction_action
- The type of pending maintenance action that is available for the
resource. Valid actions are system-update
, db-upgrade
,
hardware-maintenance
, and ca-certificate-rotation
.
$sel:optInStatus:PendingMaintenanceAction'
, pendingMaintenanceAction_optInStatus
- Indicates the type of opt-in request that has been received for the
resource.
$sel:description:PendingMaintenanceAction'
, pendingMaintenanceAction_description
- A description providing more detail about the maintenance action.
$sel:forcedApplyDate:PendingMaintenanceAction'
, pendingMaintenanceAction_forcedApplyDate
- The date when the maintenance action is automatically applied.
On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied.
$sel:currentApplyDate:PendingMaintenanceAction'
, pendingMaintenanceAction_currentApplyDate
- The effective date when the pending maintenance action is applied to the
resource. This date takes into account opt-in requests received from the
ApplyPendingMaintenanceAction
API, the AutoAppliedAfterDate
, and the
ForcedApplyDate
. This value is blank if an opt-in request has not been
received and nothing has been specified as AutoAppliedAfterDate
or
ForcedApplyDate
.
PendingModifiedValues
data PendingModifiedValues Source #
This data type is used as a response element in the ModifyDBInstance
operation and contains changes that will be applied during the next
maintenance window.
See: newPendingModifiedValues
smart constructor.
Constructors
PendingModifiedValues' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe [ProcessorFeature]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe PendingCloudwatchLogsExports) (Maybe Int) (Maybe Bool) (Maybe Int) (Maybe Int) (Maybe Text) |
Instances
newPendingModifiedValues :: PendingModifiedValues Source #
Create a value of PendingModifiedValues
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:PendingModifiedValues'
, pendingModifiedValues_engineVersion
- The database engine version.
$sel:masterUserPassword:PendingModifiedValues'
, pendingModifiedValues_masterUserPassword
- The master credentials for the DB instance.
$sel:dbSubnetGroupName:PendingModifiedValues'
, pendingModifiedValues_dbSubnetGroupName
- The DB subnet group for the DB instance.
$sel:iAMDatabaseAuthenticationEnabled:PendingModifiedValues'
, pendingModifiedValues_iAMDatabaseAuthenticationEnabled
- Whether mapping of Amazon Web Services Identity and Access Management
(IAM) accounts to database accounts is enabled.
$sel:iops:PendingModifiedValues'
, pendingModifiedValues_iops
- The Provisioned IOPS value for the DB instance.
$sel:processorFeatures:PendingModifiedValues'
, pendingModifiedValues_processorFeatures
- The number of CPU cores and the number of threads per core for the DB
instance class of the DB instance.
$sel:dbInstanceClass:PendingModifiedValues'
, pendingModifiedValues_dbInstanceClass
- The name of the compute and memory capacity class for the DB instance.
$sel:licenseModel:PendingModifiedValues'
, pendingModifiedValues_licenseModel
- The license model for the DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
$sel:cACertificateIdentifier:PendingModifiedValues'
, pendingModifiedValues_cACertificateIdentifier
- The identifier of the CA certificate for the DB instance.
$sel:dbInstanceIdentifier:PendingModifiedValues'
, pendingModifiedValues_dbInstanceIdentifier
- The database identifier for the DB instance.
$sel:pendingCloudwatchLogsExports:PendingModifiedValues'
, pendingModifiedValues_pendingCloudwatchLogsExports
- Undocumented member.
$sel:backupRetentionPeriod:PendingModifiedValues'
, pendingModifiedValues_backupRetentionPeriod
- The number of days for which automated backups are retained.
$sel:multiAZ:PendingModifiedValues'
, pendingModifiedValues_multiAZ
- A value that indicates that the Single-AZ DB instance will change to a
Multi-AZ deployment.
$sel:allocatedStorage:PendingModifiedValues'
, pendingModifiedValues_allocatedStorage
- The allocated storage size for the DB instance specified in gibibytes
(GiB).
$sel:port:PendingModifiedValues'
, pendingModifiedValues_port
- The port for the DB instance.
$sel:storageType:PendingModifiedValues'
, pendingModifiedValues_storageType
- The storage type of the DB instance.
ProcessorFeature
data ProcessorFeature Source #
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount
feature name for
the Name
parameter. To specify the number of threads per core, use the
threadsPerCore
feature name for the Name
parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class
by calling the DescribeOrderableDBInstanceOptions
action and
specifying the instance class for the DBInstanceClass
parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call DescribeDBInstances
, ProcessorFeature
returns non-null
values only if the following conditions are met:
- You are accessing an Oracle DB instance.
- Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.
- The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
See: newProcessorFeature
smart constructor.
Constructors
ProcessorFeature' (Maybe Text) (Maybe Text) |
Instances
newProcessorFeature :: ProcessorFeature Source #
Create a value of ProcessorFeature
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:ProcessorFeature'
, processorFeature_value
- The value of a processor feature name.
$sel:name:ProcessorFeature'
, processorFeature_name
- The name of the processor feature. Valid names are coreCount
and
threadsPerCore
.
Range
A range of integer values.
See: newRange
smart constructor.
Instances
Eq Range Source # | |
Read Range Source # | |
Show Range Source # | |
Generic Range Source # | |
NFData Range Source # | |
Defined in Amazonka.RDS.Types.Range | |
Hashable Range Source # | |
Defined in Amazonka.RDS.Types.Range | |
FromXML Range Source # | |
type Rep Range Source # | |
Defined in Amazonka.RDS.Types.Range type Rep Range = D1 ('MetaData "Range" "Amazonka.RDS.Types.Range" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "Range'" 'PrefixI 'True) (S1 ('MetaSel ('Just "to") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "from") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "step") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) |
Create a value of Range
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:to:Range'
, range_to
- The maximum value in the range.
$sel:from:Range'
, range_from
- The minimum value in the range.
$sel:step:Range'
, range_step
- The step value for the range. For example, if you have a range of 5,000
to 10,000, with a step value of 1,000, the valid values start at 5,000
and step up by 1,000. Even though 7,500 is within the range, it isn't a
valid value for the range. The valid values are 5,000, 6,000, 7,000,
8,000...
RecurringCharge
data RecurringCharge Source #
This data type is used as a response element in the
DescribeReservedDBInstances
and DescribeReservedDBInstancesOfferings
actions.
See: newRecurringCharge
smart constructor.
Constructors
RecurringCharge' (Maybe Text) (Maybe Double) |
Instances
newRecurringCharge :: RecurringCharge Source #
Create a value of RecurringCharge
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:recurringChargeFrequency:RecurringCharge'
, recurringCharge_recurringChargeFrequency
- The frequency of the recurring charge.
$sel:recurringChargeAmount:RecurringCharge'
, recurringCharge_recurringChargeAmount
- The amount of the recurring charge.
ReservedDBInstance
data ReservedDBInstance Source #
This data type is used as a response element in the
DescribeReservedDBInstances
and PurchaseReservedDBInstancesOffering
actions.
See: newReservedDBInstance
smart constructor.
Constructors
ReservedDBInstance' (Maybe Int) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [RecurringCharge]) (Maybe Text) (Maybe Double) (Maybe Double) (Maybe Int) |
Instances
newReservedDBInstance :: ReservedDBInstance Source #
Create a value of ReservedDBInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstanceCount:ReservedDBInstance'
, reservedDBInstance_dbInstanceCount
- The number of reserved DB instances.
$sel:state:ReservedDBInstance'
, reservedDBInstance_state
- The state of the reserved DB instance.
$sel:currencyCode:ReservedDBInstance'
, reservedDBInstance_currencyCode
- The currency code for the reserved DB instance.
$sel:startTime:ReservedDBInstance'
, reservedDBInstance_startTime
- The time the reservation started.
$sel:productDescription:ReservedDBInstance'
, reservedDBInstance_productDescription
- The description of the reserved DB instance.
$sel:leaseId:ReservedDBInstance'
, reservedDBInstance_leaseId
- The unique identifier for the lease associated with the reserved DB
instance.
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
$sel:reservedDBInstanceId:ReservedDBInstance'
, reservedDBInstance_reservedDBInstanceId
- The unique identifier for the reservation.
$sel:reservedDBInstanceArn:ReservedDBInstance'
, reservedDBInstance_reservedDBInstanceArn
- The Amazon Resource Name (ARN) for the reserved DB instance.
$sel:dbInstanceClass:ReservedDBInstance'
, reservedDBInstance_dbInstanceClass
- The DB instance class for the reserved DB instance.
$sel:multiAZ:ReservedDBInstance'
, reservedDBInstance_multiAZ
- Indicates if the reservation applies to Multi-AZ deployments.
$sel:reservedDBInstancesOfferingId:ReservedDBInstance'
, reservedDBInstance_reservedDBInstancesOfferingId
- The offering identifier.
$sel:recurringCharges:ReservedDBInstance'
, reservedDBInstance_recurringCharges
- The recurring price charged to run this reserved DB instance.
$sel:offeringType:ReservedDBInstance'
, reservedDBInstance_offeringType
- The offering type of this reserved DB instance.
$sel:usagePrice:ReservedDBInstance'
, reservedDBInstance_usagePrice
- The hourly price charged for this reserved DB instance.
$sel:fixedPrice:ReservedDBInstance'
, reservedDBInstance_fixedPrice
- The fixed price charged for this reserved DB instance.
$sel:duration:ReservedDBInstance'
, reservedDBInstance_duration
- The duration of the reservation in seconds.
ReservedDBInstancesOffering
data ReservedDBInstancesOffering Source #
This data type is used as a response element in the
DescribeReservedDBInstancesOfferings
action.
See: newReservedDBInstancesOffering
smart constructor.
Constructors
ReservedDBInstancesOffering' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [RecurringCharge]) (Maybe Text) (Maybe Double) (Maybe Double) (Maybe Int) |
Instances
newReservedDBInstancesOffering :: ReservedDBInstancesOffering Source #
Create a value of ReservedDBInstancesOffering
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:currencyCode:ReservedDBInstancesOffering'
, reservedDBInstancesOffering_currencyCode
- The currency code for the reserved DB instance offering.
$sel:productDescription:ReservedDBInstancesOffering'
, reservedDBInstancesOffering_productDescription
- The database engine used by the offering.
$sel:dbInstanceClass:ReservedDBInstancesOffering'
, reservedDBInstancesOffering_dbInstanceClass
- The DB instance class for the reserved DB instance.
$sel:multiAZ:ReservedDBInstancesOffering'
, reservedDBInstancesOffering_multiAZ
- Indicates if the offering applies to Multi-AZ deployments.
$sel:reservedDBInstancesOfferingId:ReservedDBInstancesOffering'
, reservedDBInstancesOffering_reservedDBInstancesOfferingId
- The offering identifier.
$sel:recurringCharges:ReservedDBInstancesOffering'
, reservedDBInstancesOffering_recurringCharges
- The recurring price charged to run this reserved DB instance.
$sel:offeringType:ReservedDBInstancesOffering'
, reservedDBInstancesOffering_offeringType
- The offering type.
$sel:usagePrice:ReservedDBInstancesOffering'
, reservedDBInstancesOffering_usagePrice
- The hourly price charged for this offering.
$sel:fixedPrice:ReservedDBInstancesOffering'
, reservedDBInstancesOffering_fixedPrice
- The fixed price charged for this offering.
$sel:duration:ReservedDBInstancesOffering'
, reservedDBInstancesOffering_duration
- The duration of the offering in seconds.
ResourcePendingMaintenanceActions
data ResourcePendingMaintenanceActions Source #
Describes the pending maintenance actions for a resource.
See: newResourcePendingMaintenanceActions
smart constructor.
Constructors
ResourcePendingMaintenanceActions' (Maybe [PendingMaintenanceAction]) (Maybe Text) |
Instances
newResourcePendingMaintenanceActions :: ResourcePendingMaintenanceActions Source #
Create a value of ResourcePendingMaintenanceActions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pendingMaintenanceActionDetails:ResourcePendingMaintenanceActions'
, resourcePendingMaintenanceActions_pendingMaintenanceActionDetails
- A list that provides details about the pending maintenance actions for
the resource.
$sel:resourceIdentifier:ResourcePendingMaintenanceActions'
, resourcePendingMaintenanceActions_resourceIdentifier
- The ARN of the resource that has pending maintenance actions.
RestoreWindow
data RestoreWindow Source #
Earliest and latest time an instance can be restored to:
See: newRestoreWindow
smart constructor.
Constructors
RestoreWindow' (Maybe ISO8601) (Maybe ISO8601) |
Instances
newRestoreWindow :: RestoreWindow Source #
Create a value of RestoreWindow
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:latestTime:RestoreWindow'
, restoreWindow_latestTime
- The latest time you can restore an instance to.
$sel:earliestTime:RestoreWindow'
, restoreWindow_earliestTime
- The earliest time you can restore an instance to.
ScalingConfiguration
data ScalingConfiguration Source #
Contains the scaling configuration of an Aurora Serverless DB cluster.
For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
See: newScalingConfiguration
smart constructor.
Constructors
ScalingConfiguration' (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Int) (Maybe Int) |
Instances
newScalingConfiguration :: ScalingConfiguration Source #
Create a value of ScalingConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:secondsUntilAutoPause:ScalingConfiguration'
, scalingConfiguration_secondsUntilAutoPause
- The time, in seconds, before an Aurora DB cluster in serverless
mode
is paused.
Specify a value between 300 and 86,400 seconds.
$sel:timeoutAction:ScalingConfiguration'
, scalingConfiguration_timeoutAction
- The action to take when the timeout is reached, either
ForceApplyCapacityChange
or RollbackCapacityChange
.
ForceApplyCapacityChange
sets the capacity to the specified value as
soon as possible.
RollbackCapacityChange
, the default, ignores the capacity change if a
scaling point isn't found in the timeout period.
If you specify ForceApplyCapacityChange
, connections that prevent
Aurora Serverless from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.
$sel:autoPause:ScalingConfiguration'
, scalingConfiguration_autoPause
- A value that indicates whether to allow or disallow automatic pause for
an Aurora DB cluster in serverless
DB engine mode. A DB cluster can be
paused only when it's idle (it has no connections).
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
$sel:maxCapacity:ScalingConfiguration'
, scalingConfiguration_maxCapacity
- The maximum capacity for an Aurora DB cluster in serverless
DB engine
mode.
For Aurora MySQL, valid capacity values are 1
, 2
, 4
, 8
, 16
,
32
, 64
, 128
, and 256
.
For Aurora PostgreSQL, valid capacity values are 2
, 4
, 8
, 16
,
32
, 64
, 192
, and 384
.
The maximum capacity must be greater than or equal to the minimum capacity.
$sel:minCapacity:ScalingConfiguration'
, scalingConfiguration_minCapacity
- The minimum capacity for an Aurora DB cluster in serverless
DB engine
mode.
For Aurora MySQL, valid capacity values are 1
, 2
, 4
, 8
, 16
,
32
, 64
, 128
, and 256
.
For Aurora PostgreSQL, valid capacity values are 2
, 4
, 8
, 16
,
32
, 64
, 192
, and 384
.
The minimum capacity must be less than or equal to the maximum capacity.
$sel:secondsBeforeTimeout:ScalingConfiguration'
, scalingConfiguration_secondsBeforeTimeout
- The amount of time, in seconds, that Aurora Serverless tries to find a
scaling point to perform seamless scaling before enforcing the timeout
action. The default is 300.
Specify a value between 60 and 600 seconds.
ScalingConfigurationInfo
data ScalingConfigurationInfo Source #
Shows the scaling configuration for an Aurora DB cluster in serverless
DB engine mode.
For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
See: newScalingConfigurationInfo
smart constructor.
Constructors
ScalingConfigurationInfo' (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Int) (Maybe Int) |
Instances
newScalingConfigurationInfo :: ScalingConfigurationInfo Source #
Create a value of ScalingConfigurationInfo
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:secondsUntilAutoPause:ScalingConfigurationInfo'
, scalingConfigurationInfo_secondsUntilAutoPause
- The remaining amount of time, in seconds, before the Aurora DB cluster
in serverless
mode is paused. A DB cluster can be paused only when
it's idle (it has no connections).
$sel:timeoutAction:ScalingConfigurationInfo'
, scalingConfigurationInfo_timeoutAction
- The action that occurs when Aurora times out while attempting to change
the capacity of an Aurora Serverless cluster. The value is either
ForceApplyCapacityChange
or RollbackCapacityChange
.
ForceApplyCapacityChange
, the default, sets the capacity to the
specified value as soon as possible.
RollbackCapacityChange
ignores the capacity change if a scaling point
isn't found in the timeout period.
$sel:autoPause:ScalingConfigurationInfo'
, scalingConfigurationInfo_autoPause
- A value that indicates whether automatic pause is allowed for the Aurora
DB cluster in serverless
DB engine mode.
When the value is set to false for an Aurora Serverless DB cluster, the DB cluster automatically resumes.
$sel:maxCapacity:ScalingConfigurationInfo'
, scalingConfigurationInfo_maxCapacity
- The maximum capacity for an Aurora DB cluster in serverless
DB engine
mode.
$sel:minCapacity:ScalingConfigurationInfo'
, scalingConfigurationInfo_minCapacity
- The maximum capacity for the Aurora DB cluster in serverless
DB engine
mode.
$sel:secondsBeforeTimeout:ScalingConfigurationInfo'
, scalingConfigurationInfo_secondsBeforeTimeout
- The number of seconds before scaling times out. What happens when an
attempted scaling action times out is determined by the TimeoutAction
setting.
SourceRegion
data SourceRegion Source #
Contains an Amazon Web Services Region name as the result of a
successful call to the DescribeSourceRegions
action.
See: newSourceRegion
smart constructor.
Instances
newSourceRegion :: SourceRegion Source #
Create a value of SourceRegion
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:supportsDBInstanceAutomatedBackupsReplication:SourceRegion'
, sourceRegion_supportsDBInstanceAutomatedBackupsReplication
- Whether the source Amazon Web Services Region supports replicating
automated backups to the current Amazon Web Services Region.
$sel:status:SourceRegion'
, sourceRegion_status
- The status of the source Amazon Web Services Region.
$sel:regionName:SourceRegion'
, sourceRegion_regionName
- The name of the source Amazon Web Services Region.
$sel:endpoint:SourceRegion'
, sourceRegion_endpoint
- The endpoint for the source Amazon Web Services Region endpoint.
Subnet
This data type is used as a response element for the
DescribeDBSubnetGroups
operation.
See: newSubnet
smart constructor.
Instances
Eq Subnet Source # | |
Read Subnet Source # | |
Show Subnet Source # | |
Generic Subnet Source # | |
NFData Subnet Source # | |
Defined in Amazonka.RDS.Types.Subnet | |
Hashable Subnet Source # | |
Defined in Amazonka.RDS.Types.Subnet | |
FromXML Subnet Source # | |
type Rep Subnet Source # | |
Defined in Amazonka.RDS.Types.Subnet type Rep Subnet = D1 ('MetaData "Subnet" "Amazonka.RDS.Types.Subnet" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "Subnet'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "subnetStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subnetIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "subnetAvailabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AvailabilityZone)) :*: S1 ('MetaSel ('Just "subnetOutpost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Outpost))))) |
Create a value of Subnet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subnetStatus:Subnet'
, subnet_subnetStatus
- The status of the subnet.
$sel:subnetIdentifier:Subnet'
, subnet_subnetIdentifier
- The identifier of the subnet.
$sel:subnetAvailabilityZone:Subnet'
, subnet_subnetAvailabilityZone
- Undocumented member.
$sel:subnetOutpost:Subnet'
, subnet_subnetOutpost
- If the subnet is associated with an Outpost, this value specifies the
Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Tag
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
See: newTag
smart constructor.
Instances
Eq Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
Generic Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.RDS.Types.Tag | |
Hashable Tag Source # | |
Defined in Amazonka.RDS.Types.Tag | |
ToQuery Tag Source # | |
Defined in Amazonka.RDS.Types.Tag Methods toQuery :: Tag -> QueryString # | |
FromXML Tag Source # | |
type Rep Tag Source # | |
Defined in Amazonka.RDS.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.RDS.Types.Tag" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:Tag'
, tag_value
- A value is the optional value of the tag. The string value can be from 1
to 256 Unicode characters in length and can't be prefixed with aws:
or rds:
. The string can only contain only the set of Unicode letters,
digits, white-space, '_', '.', ':', '/', '=', '+', '-',
'@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").
$sel:key:Tag'
, tag_key
- A key is the required name of the tag. The string value can be from 1 to
128 Unicode characters in length and can't be prefixed with aws:
or
rds:
. The string can only contain only the set of Unicode letters,
digits, white-space, '_', '.', ':', '/', '=', '+', '-',
'@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").
TargetHealth
data TargetHealth Source #
Information about the connection health of an RDS Proxy target.
See: newTargetHealth
smart constructor.
Constructors
TargetHealth' (Maybe TargetState) (Maybe TargetHealthReason) (Maybe Text) |
Instances
newTargetHealth :: TargetHealth Source #
Create a value of TargetHealth
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:state:TargetHealth'
, targetHealth_state
- The current state of the connection health lifecycle for the RDS Proxy
target. The following is a typical lifecycle example for the states of
an RDS Proxy target:
registering
> unavailable
> available
> unavailable
>
available
$sel:reason:TargetHealth'
, targetHealth_reason
- The reason for the current health State
of the RDS Proxy target.
$sel:description:TargetHealth'
, targetHealth_description
- A description of the health of the RDS Proxy target. If the State
is
AVAILABLE
, a description is not included.
Timezone
A time zone associated with a DBInstance
or a DBSnapshot
. This data
type is an element in the response to the DescribeDBInstances
, the
DescribeDBSnapshots
, and the DescribeDBEngineVersions
actions.
See: newTimezone
smart constructor.
Instances
Eq Timezone Source # | |
Read Timezone Source # | |
Show Timezone Source # | |
Generic Timezone Source # | |
NFData Timezone Source # | |
Defined in Amazonka.RDS.Types.Timezone | |
Hashable Timezone Source # | |
Defined in Amazonka.RDS.Types.Timezone | |
FromXML Timezone Source # | |
type Rep Timezone Source # | |
Defined in Amazonka.RDS.Types.Timezone |
newTimezone :: Timezone Source #
Create a value of Timezone
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:timezoneName:Timezone'
, timezone_timezoneName
- The name of the time zone.
UpgradeTarget
data UpgradeTarget Source #
The version of the database engine that a DB instance can be upgraded to.
See: newUpgradeTarget
smart constructor.
Constructors
UpgradeTarget' (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) |
Instances
newUpgradeTarget :: UpgradeTarget Source #
Create a value of UpgradeTarget
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:UpgradeTarget'
, upgradeTarget_engineVersion
- The version number of the upgrade target database engine.
$sel:supportedEngineModes:UpgradeTarget'
, upgradeTarget_supportedEngineModes
- A list of the supported DB engine modes for the target engine version.
$sel:isMajorVersionUpgrade:UpgradeTarget'
, upgradeTarget_isMajorVersionUpgrade
- A value that indicates whether upgrading to the target version requires
upgrading the major version of the database engine.
$sel:engine:UpgradeTarget'
, upgradeTarget_engine
- The name of the upgrade target database engine.
$sel:supportsGlobalDatabases:UpgradeTarget'
, upgradeTarget_supportsGlobalDatabases
- A value that indicates whether you can use Aurora global databases with
the target engine version.
$sel:autoUpgrade:UpgradeTarget'
, upgradeTarget_autoUpgrade
- A value that indicates whether the target version is applied to any
source DB instances that have AutoMinorVersionUpgrade
set to true.
$sel:supportsParallelQuery:UpgradeTarget'
, upgradeTarget_supportsParallelQuery
- A value that indicates whether you can use Aurora parallel query with
the target engine version.
$sel:description:UpgradeTarget'
, upgradeTarget_description
- The version of the database engine that a DB instance can be upgraded
to.
UserAuthConfig
data UserAuthConfig Source #
Specifies the details of authentication used by a proxy to log in as a specific database user.
See: newUserAuthConfig
smart constructor.
Constructors
UserAuthConfig' (Maybe IAMAuthMode) (Maybe Text) (Maybe AuthScheme) (Maybe Text) (Maybe Text) |
Instances
newUserAuthConfig :: UserAuthConfig Source #
Create a value of UserAuthConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:iAMAuth:UserAuthConfig'
, userAuthConfig_iAMAuth
- Whether to require or disallow Amazon Web Services Identity and Access
Management (IAM) authentication for connections to the proxy.
$sel:userName:UserAuthConfig'
, userAuthConfig_userName
- The name of the database user to which the proxy connects.
$sel:authScheme:UserAuthConfig'
, userAuthConfig_authScheme
- The type of authentication that the proxy uses for connections from the
proxy to the underlying database.
$sel:secretArn:UserAuthConfig'
, userAuthConfig_secretArn
- The Amazon Resource Name (ARN) representing the secret that the proxy
uses to authenticate to the RDS DB instance or Aurora DB cluster. These
secrets are stored within Amazon Secrets Manager.
$sel:description:UserAuthConfig'
, userAuthConfig_description
- A user-specified description about the authentication used by a proxy to
log in as a specific database user.
UserAuthConfigInfo
data UserAuthConfigInfo Source #
Returns the details of authentication used by a proxy to log in as a specific database user.
See: newUserAuthConfigInfo
smart constructor.
Constructors
UserAuthConfigInfo' (Maybe IAMAuthMode) (Maybe Text) (Maybe AuthScheme) (Maybe Text) (Maybe Text) |
Instances
newUserAuthConfigInfo :: UserAuthConfigInfo Source #
Create a value of UserAuthConfigInfo
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:iAMAuth:UserAuthConfigInfo'
, userAuthConfigInfo_iAMAuth
- Whether to require or disallow Amazon Web Services Identity and Access
Management (IAM) authentication for connections to the proxy.
$sel:userName:UserAuthConfigInfo'
, userAuthConfigInfo_userName
- The name of the database user to which the proxy connects.
$sel:authScheme:UserAuthConfigInfo'
, userAuthConfigInfo_authScheme
- The type of authentication that the proxy uses for connections from the
proxy to the underlying database.
$sel:secretArn:UserAuthConfigInfo'
, userAuthConfigInfo_secretArn
- The Amazon Resource Name (ARN) representing the secret that the proxy
uses to authenticate to the RDS DB instance or Aurora DB cluster. These
secrets are stored within Amazon Secrets Manager.
$sel:description:UserAuthConfigInfo'
, userAuthConfigInfo_description
- A user-specified description about the authentication used by a proxy to
log in as a specific database user.
ValidDBInstanceModificationsMessage
data ValidDBInstanceModificationsMessage Source #
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
.
See: newValidDBInstanceModificationsMessage
smart constructor.
Constructors
ValidDBInstanceModificationsMessage' (Maybe [AvailableProcessorFeature]) (Maybe [ValidStorageOptions]) |
Instances
newValidDBInstanceModificationsMessage :: ValidDBInstanceModificationsMessage Source #
Create a value of ValidDBInstanceModificationsMessage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:validProcessorFeatures:ValidDBInstanceModificationsMessage'
, validDBInstanceModificationsMessage_validProcessorFeatures
- Valid processor features for your DB instance.
$sel:storage:ValidDBInstanceModificationsMessage'
, validDBInstanceModificationsMessage_storage
- Valid storage options for your DB instance.
ValidStorageOptions
data ValidStorageOptions Source #
Information about valid modifications that you can make to your DB
instance. Contains the result of a successful call to the
DescribeValidDBInstanceModifications
action.
See: newValidStorageOptions
smart constructor.
Constructors
ValidStorageOptions' (Maybe [Range]) (Maybe [Range]) (Maybe [DoubleRange]) (Maybe Bool) (Maybe Text) |
Instances
newValidStorageOptions :: ValidStorageOptions Source #
Create a value of ValidStorageOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:storageSize:ValidStorageOptions'
, validStorageOptions_storageSize
- The valid range of storage in gibibytes (GiB). For example, 100 to
16384.
$sel:provisionedIops:ValidStorageOptions'
, validStorageOptions_provisionedIops
- The valid range of provisioned IOPS. For example, 1000-20000.
$sel:iopsToStorageRatio:ValidStorageOptions'
, validStorageOptions_iopsToStorageRatio
- The valid range of Provisioned IOPS to gibibytes of storage multiplier.
For example, 3-10, which means that provisioned IOPS can be between 3
and 10 times storage.
$sel:supportsStorageAutoscaling:ValidStorageOptions'
, validStorageOptions_supportsStorageAutoscaling
- Whether or not Amazon RDS can automatically scale storage for DB
instances that use the new instance class.
$sel:storageType:ValidStorageOptions'
, validStorageOptions_storageType
- The valid storage types for your DB instance. For example, gp2, io1.
VpcSecurityGroupMembership
data VpcSecurityGroupMembership Source #
This data type is used as a response element for queries on VPC security group membership.
See: newVpcSecurityGroupMembership
smart constructor.
Constructors
VpcSecurityGroupMembership' (Maybe Text) (Maybe Text) |
Instances
newVpcSecurityGroupMembership :: VpcSecurityGroupMembership Source #
Create a value of VpcSecurityGroupMembership
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:VpcSecurityGroupMembership'
, vpcSecurityGroupMembership_status
- The status of the VPC security group.
$sel:vpcSecurityGroupId:VpcSecurityGroupMembership'
, vpcSecurityGroupMembership_vpcSecurityGroupId
- The name of the VPC security group.
VpnDetails
data VpnDetails Source #
Information about the virtual private network (VPN) between the VMware vSphere cluster and the Amazon Web Services website.
For more information about RDS on VMware, see the RDS on VMware User Guide.
See: newVpnDetails
smart constructor.
Constructors
VpnDetails' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) |
Instances
newVpnDetails :: VpnDetails Source #
Create a value of VpnDetails
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:vpnName:VpnDetails'
, vpnDetails_vpnName
- The name of the VPN.
$sel:vpnTunnelOriginatorIP:VpnDetails'
, vpnDetails_vpnTunnelOriginatorIP
- The IP address of network traffic from your on-premises data center. A
custom AZ receives the network traffic.
$sel:vpnId:VpnDetails'
, vpnDetails_vpnId
- The ID of the VPN.
$sel:vpnState:VpnDetails'
, vpnDetails_vpnState
- The state of the VPN.
$sel:vpnPSK:VpnDetails'
, vpnDetails_vpnPSK
- The preshared key (PSK) for the VPN.
$sel:vpnGatewayIp:VpnDetails'
, vpnDetails_vpnGatewayIp
- The IP address of network traffic from Amazon Web Services to your
on-premises data center.