Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- AuthorizationNotFoundFault
- CertificateNotFoundFault
- DBClusterAlreadyExistsFault
- DBClusterNotFoundFault
- DBClusterParameterGroupNotFoundFault
- DBClusterQuotaExceededFault
- DBClusterSnapshotAlreadyExistsFault
- DBClusterSnapshotNotFoundFault
- DBInstanceAlreadyExistsFault
- DBInstanceNotFoundFault
- DBParameterGroupAlreadyExistsFault
- DBParameterGroupNotFoundFault
- DBParameterGroupQuotaExceededFault
- DBSecurityGroupNotFoundFault
- DBSnapshotAlreadyExistsFault
- DBSnapshotNotFoundFault
- DBSubnetGroupAlreadyExistsFault
- DBSubnetGroupDoesNotCoverEnoughAZs
- DBSubnetGroupNotFoundFault
- DBSubnetGroupQuotaExceededFault
- DBSubnetQuotaExceededFault
- DBUpgradeDependencyFailureFault
- EventSubscriptionQuotaExceededFault
- GlobalClusterAlreadyExistsFault
- GlobalClusterNotFoundFault
- GlobalClusterQuotaExceededFault
- InstanceQuotaExceededFault
- InsufficientDBClusterCapacityFault
- InsufficientDBInstanceCapacityFault
- InsufficientStorageClusterCapacityFault
- InvalidDBClusterSnapshotStateFault
- InvalidDBClusterStateFault
- InvalidDBInstanceStateFault
- InvalidDBParameterGroupStateFault
- InvalidDBSecurityGroupStateFault
- InvalidDBSnapshotStateFault
- InvalidDBSubnetGroupStateFault
- InvalidDBSubnetStateFault
- InvalidEventSubscriptionStateFault
- InvalidGlobalClusterStateFault
- InvalidRestoreFault
- InvalidSubnet
- InvalidVPCNetworkStateFault
- KMSKeyNotAccessibleFault
- ResourceNotFoundFault
- SNSInvalidTopicFault
- SNSNoAuthorizationFault
- SNSTopicArnNotFoundFault
- SharedSnapshotQuotaExceededFault
- SnapshotQuotaExceededFault
- SourceNotFoundFault
- StorageQuotaExceededFault
- StorageTypeNotSupportedFault
- SubnetAlreadyInUse
- SubscriptionAlreadyExistFault
- SubscriptionCategoryNotFoundFault
- SubscriptionNotFoundFault
- Waiters
- Operations
- AddSourceIdentifierToSubscription
- AddTagsToResource
- ApplyPendingMaintenanceAction
- CopyDBClusterParameterGroup
- CopyDBClusterSnapshot
- CreateDBCluster
- CreateDBClusterParameterGroup
- CreateDBClusterSnapshot
- CreateDBInstance
- CreateDBSubnetGroup
- CreateEventSubscription
- CreateGlobalCluster
- DeleteDBCluster
- DeleteDBClusterParameterGroup
- DeleteDBClusterSnapshot
- DeleteDBInstance
- DeleteDBSubnetGroup
- DeleteEventSubscription
- DeleteGlobalCluster
- DescribeCertificates (Paginated)
- DescribeDBClusterParameterGroups (Paginated)
- DescribeDBClusterParameters (Paginated)
- DescribeDBClusterSnapshotAttributes
- DescribeDBClusterSnapshots (Paginated)
- DescribeDBClusters (Paginated)
- DescribeDBEngineVersions (Paginated)
- DescribeDBInstances (Paginated)
- DescribeDBSubnetGroups (Paginated)
- DescribeEngineDefaultClusterParameters
- DescribeEventCategories
- DescribeEventSubscriptions (Paginated)
- DescribeEvents (Paginated)
- DescribeGlobalClusters (Paginated)
- DescribeOrderableDBInstanceOptions (Paginated)
- DescribePendingMaintenanceActions (Paginated)
- FailoverDBCluster
- ListTagsForResource
- ModifyDBCluster
- ModifyDBClusterParameterGroup
- ModifyDBClusterSnapshotAttribute
- ModifyDBInstance
- ModifyDBSubnetGroup
- ModifyEventSubscription
- ModifyGlobalCluster
- RebootDBInstance
- RemoveFromGlobalCluster
- RemoveSourceIdentifierFromSubscription
- RemoveTagsFromResource
- ResetDBClusterParameterGroup
- RestoreDBClusterFromSnapshot
- RestoreDBClusterToPointInTime
- StartDBCluster
- StopDBCluster
- Types
- ApplyMethod
- SourceType
- AvailabilityZone
- Certificate
- CloudwatchLogsExportConfiguration
- DBCluster
- DBClusterMember
- DBClusterParameterGroup
- DBClusterParameterGroupNameMessage
- DBClusterRole
- DBClusterSnapshot
- DBClusterSnapshotAttribute
- DBClusterSnapshotAttributesResult
- DBEngineVersion
- DBInstance
- DBInstanceStatusInfo
- DBSubnetGroup
- Endpoint
- EngineDefaults
- Event
- EventCategoriesMap
- EventSubscription
- Filter
- GlobalCluster
- GlobalClusterMember
- OrderableDBInstanceOption
- Parameter
- PendingCloudwatchLogsExports
- PendingMaintenanceAction
- PendingModifiedValues
- ResourcePendingMaintenanceActions
- Subnet
- Tag
- UpgradeTarget
- VpcSecurityGroupMembership
Derived from API version 2014-10-31
of the AWS service descriptions, licensed under Apache 2.0.
Amazon DocumentDB API documentation
Synopsis
- defaultService :: Service
- _AuthorizationNotFoundFault :: AsError a => Fold a ServiceError
- _CertificateNotFoundFault :: AsError a => Fold a ServiceError
- _DBClusterAlreadyExistsFault :: AsError a => Fold a ServiceError
- _DBClusterNotFoundFault :: AsError a => Fold a ServiceError
- _DBClusterParameterGroupNotFoundFault :: AsError a => Fold a ServiceError
- _DBClusterQuotaExceededFault :: AsError a => Fold a ServiceError
- _DBClusterSnapshotAlreadyExistsFault :: AsError a => Fold a ServiceError
- _DBClusterSnapshotNotFoundFault :: AsError a => Fold a ServiceError
- _DBInstanceAlreadyExistsFault :: AsError a => Fold a ServiceError
- _DBInstanceNotFoundFault :: AsError a => Fold a ServiceError
- _DBParameterGroupAlreadyExistsFault :: AsError a => Fold a ServiceError
- _DBParameterGroupNotFoundFault :: AsError a => Fold a ServiceError
- _DBParameterGroupQuotaExceededFault :: AsError a => Fold a ServiceError
- _DBSecurityGroupNotFoundFault :: AsError a => Fold a ServiceError
- _DBSnapshotAlreadyExistsFault :: AsError a => Fold a ServiceError
- _DBSnapshotNotFoundFault :: AsError a => Fold a ServiceError
- _DBSubnetGroupAlreadyExistsFault :: AsError a => Fold a ServiceError
- _DBSubnetGroupDoesNotCoverEnoughAZs :: AsError a => Fold a ServiceError
- _DBSubnetGroupNotFoundFault :: AsError a => Fold a ServiceError
- _DBSubnetGroupQuotaExceededFault :: AsError a => Fold a ServiceError
- _DBSubnetQuotaExceededFault :: AsError a => Fold a ServiceError
- _DBUpgradeDependencyFailureFault :: AsError a => Fold a ServiceError
- _EventSubscriptionQuotaExceededFault :: AsError a => Fold a ServiceError
- _GlobalClusterAlreadyExistsFault :: AsError a => Fold a ServiceError
- _GlobalClusterNotFoundFault :: AsError a => Fold a ServiceError
- _GlobalClusterQuotaExceededFault :: AsError a => Fold a ServiceError
- _InstanceQuotaExceededFault :: AsError a => Fold a ServiceError
- _InsufficientDBClusterCapacityFault :: AsError a => Fold a ServiceError
- _InsufficientDBInstanceCapacityFault :: AsError a => Fold a ServiceError
- _InsufficientStorageClusterCapacityFault :: AsError a => Fold a ServiceError
- _InvalidDBClusterSnapshotStateFault :: AsError a => Fold a ServiceError
- _InvalidDBClusterStateFault :: AsError a => Fold a ServiceError
- _InvalidDBInstanceStateFault :: AsError a => Fold a ServiceError
- _InvalidDBParameterGroupStateFault :: AsError a => Fold a ServiceError
- _InvalidDBSecurityGroupStateFault :: AsError a => Fold a ServiceError
- _InvalidDBSnapshotStateFault :: AsError a => Fold a ServiceError
- _InvalidDBSubnetGroupStateFault :: AsError a => Fold a ServiceError
- _InvalidDBSubnetStateFault :: AsError a => Fold a ServiceError
- _InvalidEventSubscriptionStateFault :: AsError a => Fold a ServiceError
- _InvalidGlobalClusterStateFault :: AsError a => Fold a ServiceError
- _InvalidRestoreFault :: AsError a => Fold a ServiceError
- _InvalidSubnet :: AsError a => Fold a ServiceError
- _InvalidVPCNetworkStateFault :: AsError a => Fold a ServiceError
- _KMSKeyNotAccessibleFault :: AsError a => Fold a ServiceError
- _ResourceNotFoundFault :: AsError a => Fold a ServiceError
- _SNSInvalidTopicFault :: AsError a => Fold a ServiceError
- _SNSNoAuthorizationFault :: AsError a => Fold a ServiceError
- _SNSTopicArnNotFoundFault :: AsError a => Fold a ServiceError
- _SharedSnapshotQuotaExceededFault :: AsError a => Fold a ServiceError
- _SnapshotQuotaExceededFault :: AsError a => Fold a ServiceError
- _SourceNotFoundFault :: AsError a => Fold a ServiceError
- _StorageQuotaExceededFault :: AsError a => Fold a ServiceError
- _StorageTypeNotSupportedFault :: AsError a => Fold a ServiceError
- _SubnetAlreadyInUse :: AsError a => Fold a ServiceError
- _SubscriptionAlreadyExistFault :: AsError a => Fold a ServiceError
- _SubscriptionCategoryNotFoundFault :: AsError a => Fold a ServiceError
- _SubscriptionNotFoundFault :: AsError a => Fold a ServiceError
- newDBInstanceAvailable :: Wait DescribeDBInstances
- newDBInstanceDeleted :: Wait DescribeDBInstances
- data AddSourceIdentifierToSubscription = AddSourceIdentifierToSubscription' Text Text
- newAddSourceIdentifierToSubscription :: Text -> Text -> AddSourceIdentifierToSubscription
- data AddSourceIdentifierToSubscriptionResponse = AddSourceIdentifierToSubscriptionResponse' (Maybe EventSubscription) Int
- newAddSourceIdentifierToSubscriptionResponse :: Int -> AddSourceIdentifierToSubscriptionResponse
- data AddTagsToResource = AddTagsToResource' Text [Tag]
- newAddTagsToResource :: Text -> AddTagsToResource
- data AddTagsToResourceResponse = AddTagsToResourceResponse' {
- newAddTagsToResourceResponse :: AddTagsToResourceResponse
- data ApplyPendingMaintenanceAction = ApplyPendingMaintenanceAction' Text Text Text
- newApplyPendingMaintenanceAction :: Text -> Text -> Text -> ApplyPendingMaintenanceAction
- data ApplyPendingMaintenanceActionResponse = ApplyPendingMaintenanceActionResponse' (Maybe ResourcePendingMaintenanceActions) Int
- newApplyPendingMaintenanceActionResponse :: Int -> ApplyPendingMaintenanceActionResponse
- data CopyDBClusterParameterGroup = CopyDBClusterParameterGroup' (Maybe [Tag]) Text Text Text
- newCopyDBClusterParameterGroup :: Text -> Text -> Text -> CopyDBClusterParameterGroup
- data CopyDBClusterParameterGroupResponse = CopyDBClusterParameterGroupResponse' (Maybe DBClusterParameterGroup) Int
- newCopyDBClusterParameterGroupResponse :: Int -> CopyDBClusterParameterGroupResponse
- data CopyDBClusterSnapshot = CopyDBClusterSnapshot' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text
- newCopyDBClusterSnapshot :: Text -> Text -> CopyDBClusterSnapshot
- data CopyDBClusterSnapshotResponse = CopyDBClusterSnapshotResponse' (Maybe DBClusterSnapshot) Int
- newCopyDBClusterSnapshotResponse :: Int -> CopyDBClusterSnapshotResponse
- data CreateDBCluster = CreateDBCluster' (Maybe [Text]) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Tag]) (Maybe [Text]) Text Text
- newCreateDBCluster :: Text -> Text -> CreateDBCluster
- data CreateDBClusterResponse = CreateDBClusterResponse' (Maybe DBCluster) Int
- newCreateDBClusterResponse :: Int -> CreateDBClusterResponse
- data CreateDBClusterParameterGroup = CreateDBClusterParameterGroup' (Maybe [Tag]) Text Text Text
- newCreateDBClusterParameterGroup :: Text -> Text -> Text -> CreateDBClusterParameterGroup
- data CreateDBClusterParameterGroupResponse = CreateDBClusterParameterGroupResponse' (Maybe DBClusterParameterGroup) Int
- newCreateDBClusterParameterGroupResponse :: Int -> CreateDBClusterParameterGroupResponse
- data CreateDBClusterSnapshot = CreateDBClusterSnapshot' (Maybe [Tag]) Text Text
- newCreateDBClusterSnapshot :: Text -> Text -> CreateDBClusterSnapshot
- data CreateDBClusterSnapshotResponse = CreateDBClusterSnapshotResponse' (Maybe DBClusterSnapshot) Int
- newCreateDBClusterSnapshotResponse :: Int -> CreateDBClusterSnapshotResponse
- data CreateDBInstance = CreateDBInstance' (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Tag]) Text Text Text Text
- newCreateDBInstance :: Text -> Text -> Text -> Text -> CreateDBInstance
- data CreateDBInstanceResponse = CreateDBInstanceResponse' (Maybe DBInstance) Int
- newCreateDBInstanceResponse :: Int -> CreateDBInstanceResponse
- data CreateDBSubnetGroup = CreateDBSubnetGroup' (Maybe [Tag]) Text Text [Text]
- newCreateDBSubnetGroup :: Text -> Text -> CreateDBSubnetGroup
- data CreateDBSubnetGroupResponse = CreateDBSubnetGroupResponse' (Maybe DBSubnetGroup) Int
- newCreateDBSubnetGroupResponse :: Int -> CreateDBSubnetGroupResponse
- 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 CreateGlobalCluster = CreateGlobalCluster' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) Text
- newCreateGlobalCluster :: Text -> CreateGlobalCluster
- data CreateGlobalClusterResponse = CreateGlobalClusterResponse' (Maybe GlobalCluster) Int
- newCreateGlobalClusterResponse :: Int -> CreateGlobalClusterResponse
- data DeleteDBCluster = DeleteDBCluster' (Maybe Text) (Maybe Bool) Text
- newDeleteDBCluster :: Text -> DeleteDBCluster
- data DeleteDBClusterResponse = DeleteDBClusterResponse' (Maybe DBCluster) Int
- newDeleteDBClusterResponse :: Int -> DeleteDBClusterResponse
- data DeleteDBClusterParameterGroup = DeleteDBClusterParameterGroup' Text
- newDeleteDBClusterParameterGroup :: Text -> DeleteDBClusterParameterGroup
- data DeleteDBClusterParameterGroupResponse = DeleteDBClusterParameterGroupResponse' {
- newDeleteDBClusterParameterGroupResponse :: DeleteDBClusterParameterGroupResponse
- data DeleteDBClusterSnapshot = DeleteDBClusterSnapshot' Text
- newDeleteDBClusterSnapshot :: Text -> DeleteDBClusterSnapshot
- data DeleteDBClusterSnapshotResponse = DeleteDBClusterSnapshotResponse' (Maybe DBClusterSnapshot) Int
- newDeleteDBClusterSnapshotResponse :: Int -> DeleteDBClusterSnapshotResponse
- data DeleteDBInstance = DeleteDBInstance' Text
- newDeleteDBInstance :: Text -> DeleteDBInstance
- data DeleteDBInstanceResponse = DeleteDBInstanceResponse' (Maybe DBInstance) Int
- newDeleteDBInstanceResponse :: Int -> DeleteDBInstanceResponse
- data DeleteDBSubnetGroup = DeleteDBSubnetGroup' Text
- newDeleteDBSubnetGroup :: Text -> DeleteDBSubnetGroup
- data DeleteDBSubnetGroupResponse = DeleteDBSubnetGroupResponse' {
- newDeleteDBSubnetGroupResponse :: DeleteDBSubnetGroupResponse
- data DeleteEventSubscription = DeleteEventSubscription' Text
- newDeleteEventSubscription :: Text -> DeleteEventSubscription
- data DeleteEventSubscriptionResponse = DeleteEventSubscriptionResponse' (Maybe EventSubscription) Int
- newDeleteEventSubscriptionResponse :: Int -> DeleteEventSubscriptionResponse
- data DeleteGlobalCluster = DeleteGlobalCluster' Text
- newDeleteGlobalCluster :: Text -> DeleteGlobalCluster
- data DeleteGlobalClusterResponse = DeleteGlobalClusterResponse' (Maybe GlobalCluster) Int
- newDeleteGlobalClusterResponse :: Int -> DeleteGlobalClusterResponse
- data DescribeCertificates = DescribeCertificates' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeCertificates :: DescribeCertificates
- data DescribeCertificatesResponse = DescribeCertificatesResponse' (Maybe [Certificate]) (Maybe Text) Int
- newDescribeCertificatesResponse :: Int -> DescribeCertificatesResponse
- data DescribeDBClusterParameterGroups = DescribeDBClusterParameterGroups' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeDBClusterParameterGroups :: DescribeDBClusterParameterGroups
- data DescribeDBClusterParameterGroupsResponse = DescribeDBClusterParameterGroupsResponse' (Maybe [DBClusterParameterGroup]) (Maybe Text) Int
- newDescribeDBClusterParameterGroupsResponse :: Int -> DescribeDBClusterParameterGroupsResponse
- 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 DescribeDBClusterSnapshotAttributes = DescribeDBClusterSnapshotAttributes' Text
- newDescribeDBClusterSnapshotAttributes :: Text -> DescribeDBClusterSnapshotAttributes
- data DescribeDBClusterSnapshotAttributesResponse = DescribeDBClusterSnapshotAttributesResponse' (Maybe DBClusterSnapshotAttributesResult) Int
- newDescribeDBClusterSnapshotAttributesResponse :: Int -> DescribeDBClusterSnapshotAttributesResponse
- data DescribeDBClusterSnapshots = DescribeDBClusterSnapshots' (Maybe Text) (Maybe Text) (Maybe [Filter]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text)
- newDescribeDBClusterSnapshots :: DescribeDBClusterSnapshots
- data DescribeDBClusterSnapshotsResponse = DescribeDBClusterSnapshotsResponse' (Maybe [DBClusterSnapshot]) (Maybe Text) Int
- newDescribeDBClusterSnapshotsResponse :: Int -> DescribeDBClusterSnapshotsResponse
- data DescribeDBClusters = DescribeDBClusters' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeDBClusters :: DescribeDBClusters
- data DescribeDBClustersResponse = DescribeDBClustersResponse' (Maybe [DBCluster]) (Maybe Text) Int
- newDescribeDBClustersResponse :: Int -> DescribeDBClustersResponse
- data DescribeDBEngineVersions = DescribeDBEngineVersions' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Filter]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Int)
- newDescribeDBEngineVersions :: DescribeDBEngineVersions
- data DescribeDBEngineVersionsResponse = DescribeDBEngineVersionsResponse' (Maybe [DBEngineVersion]) (Maybe Text) Int
- newDescribeDBEngineVersionsResponse :: Int -> DescribeDBEngineVersionsResponse
- data DescribeDBInstances = DescribeDBInstances' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeDBInstances :: DescribeDBInstances
- data DescribeDBInstancesResponse = DescribeDBInstancesResponse' (Maybe [DBInstance]) (Maybe Text) Int
- newDescribeDBInstancesResponse :: Int -> DescribeDBInstancesResponse
- 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 DescribeEngineDefaultClusterParameters = DescribeEngineDefaultClusterParameters' (Maybe [Filter]) (Maybe Text) (Maybe Int) Text
- newDescribeEngineDefaultClusterParameters :: Text -> DescribeEngineDefaultClusterParameters
- data DescribeEngineDefaultClusterParametersResponse = DescribeEngineDefaultClusterParametersResponse' (Maybe EngineDefaults) Int
- newDescribeEngineDefaultClusterParametersResponse :: Int -> DescribeEngineDefaultClusterParametersResponse
- data DescribeEventCategories = DescribeEventCategories' (Maybe [Filter]) (Maybe Text)
- newDescribeEventCategories :: DescribeEventCategories
- data DescribeEventCategoriesResponse = DescribeEventCategoriesResponse' (Maybe [EventCategoriesMap]) Int
- newDescribeEventCategoriesResponse :: Int -> DescribeEventCategoriesResponse
- data DescribeEventSubscriptions = DescribeEventSubscriptions' (Maybe [Filter]) (Maybe Text) (Maybe Int) (Maybe Text)
- newDescribeEventSubscriptions :: DescribeEventSubscriptions
- data DescribeEventSubscriptionsResponse = DescribeEventSubscriptionsResponse' (Maybe [EventSubscription]) (Maybe Text) Int
- newDescribeEventSubscriptionsResponse :: Int -> DescribeEventSubscriptionsResponse
- data DescribeEvents = DescribeEvents' (Maybe Int) (Maybe ISO8601) (Maybe [Text]) (Maybe [Filter]) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe SourceType) (Maybe ISO8601)
- newDescribeEvents :: DescribeEvents
- data DescribeEventsResponse = DescribeEventsResponse' (Maybe [Event]) (Maybe Text) Int
- newDescribeEventsResponse :: Int -> DescribeEventsResponse
- data DescribeGlobalClusters = DescribeGlobalClusters' (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int)
- newDescribeGlobalClusters :: DescribeGlobalClusters
- data DescribeGlobalClustersResponse = DescribeGlobalClustersResponse' (Maybe [GlobalCluster]) (Maybe Text) Int
- newDescribeGlobalClustersResponse :: Int -> DescribeGlobalClustersResponse
- data DescribeOrderableDBInstanceOptions = DescribeOrderableDBInstanceOptions' (Maybe Text) (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) Text
- newDescribeOrderableDBInstanceOptions :: Text -> DescribeOrderableDBInstanceOptions
- data DescribeOrderableDBInstanceOptionsResponse = DescribeOrderableDBInstanceOptionsResponse' (Maybe Text) (Maybe [OrderableDBInstanceOption]) Int
- newDescribeOrderableDBInstanceOptionsResponse :: Int -> DescribeOrderableDBInstanceOptionsResponse
- data DescribePendingMaintenanceActions = DescribePendingMaintenanceActions' (Maybe [Filter]) (Maybe Text) (Maybe Int) (Maybe Text)
- newDescribePendingMaintenanceActions :: DescribePendingMaintenanceActions
- data DescribePendingMaintenanceActionsResponse = DescribePendingMaintenanceActionsResponse' (Maybe Text) (Maybe [ResourcePendingMaintenanceActions]) Int
- newDescribePendingMaintenanceActionsResponse :: Int -> DescribePendingMaintenanceActionsResponse
- data FailoverDBCluster = FailoverDBCluster' (Maybe Text) (Maybe Text)
- newFailoverDBCluster :: FailoverDBCluster
- data FailoverDBClusterResponse = FailoverDBClusterResponse' (Maybe DBCluster) Int
- newFailoverDBClusterResponse :: Int -> FailoverDBClusterResponse
- data ListTagsForResource = ListTagsForResource' (Maybe [Filter]) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ModifyDBCluster = ModifyDBCluster' (Maybe Bool) (Maybe Int) (Maybe CloudwatchLogsExportConfiguration) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe [Text]) Text
- newModifyDBCluster :: Text -> ModifyDBCluster
- data ModifyDBClusterResponse = ModifyDBClusterResponse' (Maybe DBCluster) Int
- newModifyDBClusterResponse :: Int -> ModifyDBClusterResponse
- data ModifyDBClusterParameterGroup = ModifyDBClusterParameterGroup' Text [Parameter]
- newModifyDBClusterParameterGroup :: Text -> ModifyDBClusterParameterGroup
- data DBClusterParameterGroupNameMessage = DBClusterParameterGroupNameMessage' (Maybe Text)
- newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage
- data ModifyDBClusterSnapshotAttribute = ModifyDBClusterSnapshotAttribute' (Maybe [Text]) (Maybe [Text]) Text Text
- newModifyDBClusterSnapshotAttribute :: Text -> Text -> ModifyDBClusterSnapshotAttribute
- data ModifyDBClusterSnapshotAttributeResponse = ModifyDBClusterSnapshotAttributeResponse' (Maybe DBClusterSnapshotAttributesResult) Int
- newModifyDBClusterSnapshotAttributeResponse :: Int -> ModifyDBClusterSnapshotAttributeResponse
- data ModifyDBInstance = ModifyDBInstance' (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) Text
- newModifyDBInstance :: Text -> ModifyDBInstance
- data ModifyDBInstanceResponse = ModifyDBInstanceResponse' (Maybe DBInstance) Int
- newModifyDBInstanceResponse :: Int -> ModifyDBInstanceResponse
- data ModifyDBSubnetGroup = ModifyDBSubnetGroup' (Maybe Text) Text [Text]
- newModifyDBSubnetGroup :: Text -> ModifyDBSubnetGroup
- data ModifyDBSubnetGroupResponse = ModifyDBSubnetGroupResponse' (Maybe DBSubnetGroup) Int
- newModifyDBSubnetGroupResponse :: Int -> ModifyDBSubnetGroupResponse
- data ModifyEventSubscription = ModifyEventSubscription' (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) Text
- newModifyEventSubscription :: Text -> ModifyEventSubscription
- data ModifyEventSubscriptionResponse = ModifyEventSubscriptionResponse' (Maybe EventSubscription) Int
- newModifyEventSubscriptionResponse :: Int -> ModifyEventSubscriptionResponse
- data ModifyGlobalCluster = ModifyGlobalCluster' (Maybe Bool) (Maybe Text) Text
- newModifyGlobalCluster :: Text -> ModifyGlobalCluster
- data ModifyGlobalClusterResponse = ModifyGlobalClusterResponse' (Maybe GlobalCluster) Int
- newModifyGlobalClusterResponse :: Int -> ModifyGlobalClusterResponse
- data RebootDBInstance = RebootDBInstance' (Maybe Bool) Text
- newRebootDBInstance :: Text -> RebootDBInstance
- data RebootDBInstanceResponse = RebootDBInstanceResponse' (Maybe DBInstance) Int
- newRebootDBInstanceResponse :: Int -> RebootDBInstanceResponse
- data RemoveFromGlobalCluster = RemoveFromGlobalCluster' Text Text
- newRemoveFromGlobalCluster :: Text -> Text -> RemoveFromGlobalCluster
- data RemoveFromGlobalClusterResponse = RemoveFromGlobalClusterResponse' (Maybe GlobalCluster) Int
- newRemoveFromGlobalClusterResponse :: Int -> RemoveFromGlobalClusterResponse
- data RemoveSourceIdentifierFromSubscription = RemoveSourceIdentifierFromSubscription' Text Text
- newRemoveSourceIdentifierFromSubscription :: Text -> Text -> RemoveSourceIdentifierFromSubscription
- data RemoveSourceIdentifierFromSubscriptionResponse = RemoveSourceIdentifierFromSubscriptionResponse' (Maybe EventSubscription) Int
- newRemoveSourceIdentifierFromSubscriptionResponse :: Int -> RemoveSourceIdentifierFromSubscriptionResponse
- data RemoveTagsFromResource = RemoveTagsFromResource' Text [Text]
- newRemoveTagsFromResource :: Text -> RemoveTagsFromResource
- data RemoveTagsFromResourceResponse = RemoveTagsFromResourceResponse' {
- newRemoveTagsFromResourceResponse :: RemoveTagsFromResourceResponse
- data ResetDBClusterParameterGroup = ResetDBClusterParameterGroup' (Maybe [Parameter]) (Maybe Bool) Text
- newResetDBClusterParameterGroup :: Text -> ResetDBClusterParameterGroup
- data DBClusterParameterGroupNameMessage = DBClusterParameterGroupNameMessage' (Maybe Text)
- newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage
- data RestoreDBClusterFromSnapshot = RestoreDBClusterFromSnapshot' (Maybe [Text]) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Tag]) (Maybe [Text]) Text Text Text
- newRestoreDBClusterFromSnapshot :: Text -> Text -> Text -> RestoreDBClusterFromSnapshot
- data RestoreDBClusterFromSnapshotResponse = RestoreDBClusterFromSnapshotResponse' (Maybe DBCluster) Int
- newRestoreDBClusterFromSnapshotResponse :: Int -> RestoreDBClusterFromSnapshotResponse
- data RestoreDBClusterToPointInTime = RestoreDBClusterToPointInTime' (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Int) (Maybe ISO8601) (Maybe Text) (Maybe [Tag]) (Maybe Bool) (Maybe [Text]) Text Text
- newRestoreDBClusterToPointInTime :: Text -> Text -> RestoreDBClusterToPointInTime
- data RestoreDBClusterToPointInTimeResponse = RestoreDBClusterToPointInTimeResponse' (Maybe DBCluster) Int
- newRestoreDBClusterToPointInTimeResponse :: Int -> RestoreDBClusterToPointInTimeResponse
- data StartDBCluster = StartDBCluster' Text
- newStartDBCluster :: Text -> StartDBCluster
- data StartDBClusterResponse = StartDBClusterResponse' (Maybe DBCluster) Int
- newStartDBClusterResponse :: Int -> StartDBClusterResponse
- data StopDBCluster = StopDBCluster' Text
- newStopDBCluster :: Text -> StopDBCluster
- data StopDBClusterResponse = StopDBClusterResponse' (Maybe DBCluster) Int
- newStopDBClusterResponse :: Int -> StopDBClusterResponse
- newtype ApplyMethod where
- ApplyMethod' { }
- pattern ApplyMethod_Immediate :: ApplyMethod
- pattern ApplyMethod_Pending_reboot :: ApplyMethod
- 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
- data AvailabilityZone = AvailabilityZone' (Maybe Text)
- newAvailabilityZone :: AvailabilityZone
- data Certificate = Certificate' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe ISO8601)
- newCertificate :: Certificate
- data CloudwatchLogsExportConfiguration = CloudwatchLogsExportConfiguration' (Maybe [Text]) (Maybe [Text])
- newCloudwatchLogsExportConfiguration :: CloudwatchLogsExportConfiguration
- data DBCluster = DBCluster' (Maybe [DBClusterRole]) (Maybe [Text]) (Maybe Int) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe [DBClusterMember]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ISO8601) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [VpcSecurityGroupMembership])
- newDBCluster :: DBCluster
- data DBClusterMember = DBClusterMember' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Int)
- newDBClusterMember :: DBClusterMember
- 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)
- newDBClusterRole :: DBClusterRole
- data DBClusterSnapshot = DBClusterSnapshot' (Maybe [Text]) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text)
- newDBClusterSnapshot :: DBClusterSnapshot
- data DBClusterSnapshotAttribute = DBClusterSnapshotAttribute' (Maybe Text) (Maybe [Text])
- newDBClusterSnapshotAttribute :: DBClusterSnapshotAttribute
- data DBClusterSnapshotAttributesResult = DBClusterSnapshotAttributesResult' (Maybe [DBClusterSnapshotAttribute]) (Maybe Text)
- newDBClusterSnapshotAttributesResult :: DBClusterSnapshotAttributesResult
- data DBEngineVersion = DBEngineVersion' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe [UpgradeTarget])
- newDBEngineVersion :: DBEngineVersion
- data DBInstance = DBInstance' (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DBSubnetGroup) (Maybe Text) (Maybe [Text]) (Maybe Endpoint) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe PendingModifiedValues) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe [DBInstanceStatusInfo]) (Maybe Bool) (Maybe [VpcSecurityGroupMembership])
- newDBInstance :: DBInstance
- data DBInstanceStatusInfo = DBInstanceStatusInfo' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text)
- newDBInstanceStatusInfo :: DBInstanceStatusInfo
- data DBSubnetGroup = DBSubnetGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Subnet]) (Maybe Text)
- newDBSubnetGroup :: DBSubnetGroup
- 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 ISO8601) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SourceType)
- newEvent :: Event
- data EventCategoriesMap = EventCategoriesMap' (Maybe [Text]) (Maybe Text)
- newEventCategoriesMap :: EventCategoriesMap
- data EventSubscription = EventSubscription' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text)
- newEventSubscription :: EventSubscription
- data Filter = Filter' Text [Text]
- newFilter :: Text -> Filter
- data GlobalCluster = GlobalCluster' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [GlobalClusterMember]) (Maybe Text) (Maybe Text) (Maybe Bool)
- newGlobalCluster :: GlobalCluster
- data GlobalClusterMember = GlobalClusterMember' (Maybe Text) (Maybe Bool) (Maybe [Text])
- newGlobalClusterMember :: GlobalClusterMember
- data OrderableDBInstanceOption = OrderableDBInstanceOption' (Maybe [AvailabilityZone]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool)
- newOrderableDBInstanceOption :: OrderableDBInstanceOption
- data Parameter = Parameter' (Maybe Text) (Maybe ApplyMethod) (Maybe Text) (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 Text) (Maybe ISO8601) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe Text)
- newPendingMaintenanceAction :: PendingMaintenanceAction
- data PendingModifiedValues = PendingModifiedValues' (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe PendingCloudwatchLogsExports) (Maybe Int) (Maybe Text)
- newPendingModifiedValues :: PendingModifiedValues
- data ResourcePendingMaintenanceActions = ResourcePendingMaintenanceActions' (Maybe [PendingMaintenanceAction]) (Maybe Text)
- newResourcePendingMaintenanceActions :: ResourcePendingMaintenanceActions
- data Subnet = Subnet' (Maybe AvailabilityZone) (Maybe Text) (Maybe Text)
- newSubnet :: Subnet
- data Tag = Tag' (Maybe Text) (Maybe Text)
- newTag :: Tag
- data UpgradeTarget = UpgradeTarget' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool)
- newUpgradeTarget :: UpgradeTarget
- data VpcSecurityGroupMembership = VpcSecurityGroupMembership' (Maybe Text) (Maybe Text)
- newVpcSecurityGroupMembership :: VpcSecurityGroupMembership
Service Configuration
defaultService :: Service Source #
API version 2014-10-31
of the Amazon DocumentDB with MongoDB compatibility 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 DocumentDB
.
AuthorizationNotFoundFault
_AuthorizationNotFoundFault :: AsError a => Fold a ServiceError Source #
The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.
Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.
CertificateNotFoundFault
_CertificateNotFoundFault :: AsError a => Fold a ServiceError Source #
CertificateIdentifier
doesn't refer to an existing certificate.
DBClusterAlreadyExistsFault
_DBClusterAlreadyExistsFault :: AsError a => Fold a ServiceError Source #
You already have a cluster with the given identifier.
DBClusterNotFoundFault
_DBClusterNotFoundFault :: AsError a => Fold a ServiceError Source #
DBClusterIdentifier
doesn't refer to an existing cluster.
DBClusterParameterGroupNotFoundFault
_DBClusterParameterGroupNotFoundFault :: AsError a => Fold a ServiceError Source #
DBClusterParameterGroupName
doesn't refer to an existing cluster
parameter group.
DBClusterQuotaExceededFault
_DBClusterQuotaExceededFault :: AsError a => Fold a ServiceError Source #
The cluster can't be created because you have reached the maximum allowed quota of clusters.
DBClusterSnapshotAlreadyExistsFault
_DBClusterSnapshotAlreadyExistsFault :: AsError a => Fold a ServiceError Source #
You already have a cluster snapshot with the given identifier.
DBClusterSnapshotNotFoundFault
_DBClusterSnapshotNotFoundFault :: AsError a => Fold a ServiceError Source #
DBClusterSnapshotIdentifier
doesn't refer to an existing cluster
snapshot.
DBInstanceAlreadyExistsFault
_DBInstanceAlreadyExistsFault :: AsError a => Fold a ServiceError Source #
You already have a instance with the given identifier.
DBInstanceNotFoundFault
_DBInstanceNotFoundFault :: AsError a => Fold a ServiceError Source #
DBInstanceIdentifier
doesn't refer to an existing instance.
DBParameterGroupAlreadyExistsFault
_DBParameterGroupAlreadyExistsFault :: AsError a => Fold a ServiceError Source #
A parameter group with the same name already exists.
DBParameterGroupNotFoundFault
_DBParameterGroupNotFoundFault :: AsError a => Fold a ServiceError Source #
DBParameterGroupName
doesn't refer to an existing parameter group.
DBParameterGroupQuotaExceededFault
_DBParameterGroupQuotaExceededFault :: AsError a => Fold a ServiceError Source #
This request would cause you to exceed the allowed number of parameter groups.
DBSecurityGroupNotFoundFault
_DBSecurityGroupNotFoundFault :: AsError a => Fold a ServiceError Source #
DBSecurityGroupName
doesn't refer to an existing security group.
DBSnapshotAlreadyExistsFault
_DBSnapshotAlreadyExistsFault :: AsError a => Fold a ServiceError Source #
DBSnapshotIdentifier
is already being used by an existing snapshot.
DBSnapshotNotFoundFault
_DBSnapshotNotFoundFault :: AsError a => Fold a ServiceError Source #
DBSnapshotIdentifier
doesn't refer to an existing snapshot.
DBSubnetGroupAlreadyExistsFault
_DBSubnetGroupAlreadyExistsFault :: AsError a => Fold a ServiceError Source #
DBSubnetGroupName
is already being used by an existing subnet group.
DBSubnetGroupDoesNotCoverEnoughAZs
_DBSubnetGroupDoesNotCoverEnoughAZs :: AsError a => Fold a ServiceError Source #
Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
DBSubnetGroupNotFoundFault
_DBSubnetGroupNotFoundFault :: AsError a => Fold a ServiceError Source #
DBSubnetGroupName
doesn't refer to an existing subnet group.
DBSubnetGroupQuotaExceededFault
_DBSubnetGroupQuotaExceededFault :: AsError a => Fold a ServiceError Source #
The request would cause you to exceed the allowed number of subnet groups.
DBSubnetQuotaExceededFault
_DBSubnetQuotaExceededFault :: AsError a => Fold a ServiceError Source #
The request would cause you to exceed the allowed number of subnets in a subnet group.
DBUpgradeDependencyFailureFault
_DBUpgradeDependencyFailureFault :: AsError a => Fold a ServiceError Source #
The upgrade failed because a resource that the depends on can't be modified.
EventSubscriptionQuotaExceededFault
_EventSubscriptionQuotaExceededFault :: AsError a => Fold a ServiceError Source #
You have reached the maximum number of event subscriptions.
GlobalClusterAlreadyExistsFault
_GlobalClusterAlreadyExistsFault :: AsError a => Fold a ServiceError Source #
The GlobalClusterIdentifier
already exists. Choose a new global
cluster identifier (unique name) to create a new global cluster.
GlobalClusterNotFoundFault
_GlobalClusterNotFoundFault :: AsError a => Fold a ServiceError Source #
The GlobalClusterIdentifier
doesn't refer to an existing global
cluster.
GlobalClusterQuotaExceededFault
_GlobalClusterQuotaExceededFault :: AsError a => Fold a ServiceError Source #
The number of global clusters for this account is already at the maximum allowed.
InstanceQuotaExceededFault
_InstanceQuotaExceededFault :: AsError a => Fold a ServiceError Source #
The request would cause you to exceed the allowed number of instances.
InsufficientDBClusterCapacityFault
_InsufficientDBClusterCapacityFault :: AsError a => Fold a ServiceError Source #
The cluster doesn't have enough capacity for the current operation.
InsufficientDBInstanceCapacityFault
_InsufficientDBInstanceCapacityFault :: AsError a => Fold a ServiceError Source #
The specified instance class isn't available in the specified Availability Zone.
InsufficientStorageClusterCapacityFault
_InsufficientStorageClusterCapacityFault :: AsError a => Fold a ServiceError Source #
There is not enough 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.
InvalidDBClusterSnapshotStateFault
_InvalidDBClusterSnapshotStateFault :: AsError a => Fold a ServiceError Source #
The provided value isn't a valid cluster snapshot state.
InvalidDBClusterStateFault
_InvalidDBClusterStateFault :: AsError a => Fold a ServiceError Source #
The cluster isn't in a valid state.
InvalidDBInstanceStateFault
_InvalidDBInstanceStateFault :: AsError a => Fold a ServiceError Source #
The specified instance isn't in the available state.
InvalidDBParameterGroupStateFault
_InvalidDBParameterGroupStateFault :: AsError a => Fold a ServiceError Source #
The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.
InvalidDBSecurityGroupStateFault
_InvalidDBSecurityGroupStateFault :: AsError a => Fold a ServiceError Source #
The state of the security group doesn't allow deletion.
InvalidDBSnapshotStateFault
_InvalidDBSnapshotStateFault :: AsError a => Fold a ServiceError Source #
The state of the snapshot doesn't allow deletion.
InvalidDBSubnetGroupStateFault
_InvalidDBSubnetGroupStateFault :: AsError a => Fold a ServiceError Source #
The subnet group can't be deleted because it's in use.
InvalidDBSubnetStateFault
_InvalidDBSubnetStateFault :: AsError a => Fold a ServiceError Source #
The subnet isn't in the available state.
InvalidEventSubscriptionStateFault
_InvalidEventSubscriptionStateFault :: AsError a => Fold a ServiceError Source #
Someone else might be modifying a subscription. Wait a few seconds, and try again.
InvalidGlobalClusterStateFault
_InvalidGlobalClusterStateFault :: AsError a => Fold a ServiceError Source #
The requested operation can't be performed while the cluster is in this state.
InvalidRestoreFault
_InvalidRestoreFault :: AsError a => Fold a ServiceError Source #
You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.
InvalidSubnet
_InvalidSubnet :: AsError a => Fold a ServiceError Source #
The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).
InvalidVPCNetworkStateFault
_InvalidVPCNetworkStateFault :: AsError a => Fold a ServiceError Source #
The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.
KMSKeyNotAccessibleFault
_KMSKeyNotAccessibleFault :: AsError a => Fold a ServiceError Source #
An error occurred when accessing an KMS key.
ResourceNotFoundFault
_ResourceNotFoundFault :: AsError a => Fold a ServiceError Source #
The specified resource ID was not found.
SNSInvalidTopicFault
_SNSInvalidTopicFault :: AsError a => Fold a ServiceError Source #
Amazon SNS has responded that there is a problem with the specified topic.
SNSNoAuthorizationFault
_SNSNoAuthorizationFault :: AsError a => Fold a ServiceError Source #
You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).
SNSTopicArnNotFoundFault
_SNSTopicArnNotFoundFault :: AsError a => Fold a ServiceError Source #
The SNS topic Amazon Resource Name (ARN) does not exist.
SharedSnapshotQuotaExceededFault
_SharedSnapshotQuotaExceededFault :: AsError a => Fold a ServiceError Source #
You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
SnapshotQuotaExceededFault
_SnapshotQuotaExceededFault :: AsError a => Fold a ServiceError Source #
The request would cause you to exceed the allowed number of snapshots.
SourceNotFoundFault
_SourceNotFoundFault :: AsError a => Fold a ServiceError Source #
The requested source could not be found.
StorageQuotaExceededFault
_StorageQuotaExceededFault :: AsError a => Fold a ServiceError Source #
The request would cause you to exceed the allowed amount of storage available across all instances.
StorageTypeNotSupportedFault
_StorageTypeNotSupportedFault :: AsError a => Fold a ServiceError Source #
Storage of the specified StorageType
can't be associated with the DB
instance.
SubnetAlreadyInUse
_SubnetAlreadyInUse :: AsError a => Fold a ServiceError Source #
The subnet is already in use in the Availability Zone.
SubscriptionAlreadyExistFault
_SubscriptionAlreadyExistFault :: AsError a => Fold a ServiceError Source #
The provided subscription name already exists.
SubscriptionCategoryNotFoundFault
_SubscriptionCategoryNotFoundFault :: AsError a => Fold a ServiceError Source #
The provided category does not exist.
SubscriptionNotFoundFault
_SubscriptionNotFoundFault :: AsError a => Fold a ServiceError Source #
The subscription name does not exist.
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.
DBInstanceDeleted
newDBInstanceDeleted :: Wait DescribeDBInstances Source #
Polls DescribeDBInstances
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.
AddSourceIdentifierToSubscription
data AddSourceIdentifierToSubscription Source #
Represents the input to AddSourceIdentifierToSubscription.
See: newAddSourceIdentifierToSubscription
smart constructor.
Instances
newAddSourceIdentifierToSubscription Source #
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 Amazon DocumentDB event notification subscription that
you want to add a source identifier to.
AddSourceIdentifierToSubscription
, addSourceIdentifierToSubscription_sourceIdentifier
- The identifier of the event source to be added:
- If the source type is an instance, a
DBInstanceIdentifier
must be provided. - If the source type is a security group, a
DBSecurityGroupName
must be provided. - If the source type is a parameter group, a
DBParameterGroupName
must be provided. - If the source type is a snapshot, a
DBSnapshotIdentifier
must be provided.
data AddSourceIdentifierToSubscriptionResponse Source #
See: newAddSourceIdentifierToSubscriptionResponse
smart constructor.
Instances
newAddSourceIdentifierToSubscriptionResponse Source #
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.
AddTagsToResource
data AddTagsToResource Source #
Represents the input to AddTagsToResource.
See: newAddTagsToResource
smart constructor.
Instances
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 DocumentDB resource that the tags are added to. This value is
an Amazon Resource Name .
$sel:tags:AddTagsToResource'
, addTagsToResource_tags
- The tags to be assigned to the Amazon DocumentDB resource.
data AddTagsToResourceResponse Source #
See: newAddTagsToResourceResponse
smart constructor.
Instances
Generic AddTagsToResourceResponse Source # | |
Defined in Amazonka.DocumentDB.AddTagsToResource type Rep AddTagsToResourceResponse :: Type -> Type # | |
Read AddTagsToResourceResponse Source # | |
Show AddTagsToResourceResponse Source # | |
Defined in Amazonka.DocumentDB.AddTagsToResource showsPrec :: Int -> AddTagsToResourceResponse -> ShowS # show :: AddTagsToResourceResponse -> String # showList :: [AddTagsToResourceResponse] -> ShowS # | |
NFData AddTagsToResourceResponse Source # | |
Defined in Amazonka.DocumentDB.AddTagsToResource rnf :: AddTagsToResourceResponse -> () # | |
Eq AddTagsToResourceResponse Source # | |
type Rep AddTagsToResourceResponse Source # | |
Defined in Amazonka.DocumentDB.AddTagsToResource |
newAddTagsToResourceResponse :: AddTagsToResourceResponse Source #
Create a value of AddTagsToResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ApplyPendingMaintenanceAction
data ApplyPendingMaintenanceAction Source #
Represents the input to ApplyPendingMaintenanceAction.
See: newApplyPendingMaintenanceAction
smart constructor.
Instances
newApplyPendingMaintenanceAction Source #
:: 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:
ApplyPendingMaintenanceAction
, applyPendingMaintenanceAction_resourceIdentifier
- The Amazon Resource Name (ARN) of the resource that the pending
maintenance action applies to.
$sel:applyAction:ApplyPendingMaintenanceAction'
, applyPendingMaintenanceAction_applyAction
- The pending maintenance action to apply to this resource.
Valid values: system-update
, db-upgrade
$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 #
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.
CopyDBClusterParameterGroup
data CopyDBClusterParameterGroup Source #
Represents the input to CopyDBClusterParameterGroup.
See: newCopyDBClusterParameterGroup
smart constructor.
Instances
newCopyDBClusterParameterGroup Source #
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
- The tags that are to be assigned to the parameter group.
$sel:sourceDBClusterParameterGroupIdentifier:CopyDBClusterParameterGroup'
, copyDBClusterParameterGroup_sourceDBClusterParameterGroupIdentifier
- The identifier or Amazon Resource Name (ARN) for the source cluster
parameter group.
Constraints:
- Must specify a valid cluster parameter group.
- If the source cluster parameter group is in the same Amazon Web
Services Region as the copy, specify a valid parameter group
identifier; for example,
my-db-cluster-param-group
, or a valid ARN. - If the source parameter group is in a different Amazon Web Services
Region than the copy, specify a valid cluster parameter group ARN;
for example,
arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group
.
$sel:targetDBClusterParameterGroupIdentifier:CopyDBClusterParameterGroup'
, copyDBClusterParameterGroup_targetDBClusterParameterGroupIdentifier
- The identifier for the copied cluster parameter group.
Constraints:
- Cannot be null, empty, or blank.
- Must contain from 1 to 255 letters, numbers, or hyphens.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster-param-group1
$sel:targetDBClusterParameterGroupDescription:CopyDBClusterParameterGroup'
, copyDBClusterParameterGroup_targetDBClusterParameterGroupDescription
- A description for the copied cluster parameter group.
data CopyDBClusterParameterGroupResponse Source #
See: newCopyDBClusterParameterGroupResponse
smart constructor.
Instances
newCopyDBClusterParameterGroupResponse Source #
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:
CopyDBClusterParameterGroupResponse
, copyDBClusterParameterGroupResponse_dbClusterParameterGroup
- Undocumented member.
$sel:httpStatus:CopyDBClusterParameterGroupResponse'
, copyDBClusterParameterGroupResponse_httpStatus
- The response's http status code.
CopyDBClusterSnapshot
data CopyDBClusterSnapshot Source #
Represents the input to CopyDBClusterSnapshot.
See: newCopyDBClusterSnapshot
smart constructor.
Instances
newCopyDBClusterSnapshot Source #
:: 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:copyTags:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_copyTags
- Set to true
to copy all tags from the source cluster snapshot to the
target cluster snapshot, and otherwise false
. The default is false
.
CopyDBClusterSnapshot
, copyDBClusterSnapshot_kmsKeyId
- The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the
Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for
the KMS encryption key.
If you copy an encrypted cluster snapshot from your Amazon Web Services
account, you can specify a value for KmsKeyId
to encrypt the copy with
a new KMS encryption key. If you don't specify a value for KmsKeyId
,
then the copy of the cluster snapshot is encrypted with the same KMS key
as the source cluster snapshot.
If you copy an encrypted cluster snapshot that is shared from another
Amazon Web Services account, then you must specify a value for
KmsKeyId
.
To copy an encrypted cluster snapshot to another Amazon Web Services
Region, set KmsKeyId
to the KMS key ID that you want to use to encrypt
the copy of the cluster snapshot in the destination Region. KMS
encryption keys are specific to the Amazon Web Services Region that they
are created in, and you can't use encryption keys from one Amazon Web
Services Region in another Amazon Web Services Region.
If you copy an unencrypted cluster snapshot and specify a value for the
KmsKeyId
parameter, an error is returned.
$sel:preSignedUrl:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_preSignedUrl
- The URL that contains a Signature Version 4 signed request for
theCopyDBClusterSnapshot
API action in the Amazon Web Services Region
that contains the source cluster snapshot to copy. You must use the
PreSignedUrl
parameter when copying a cluster snapshot from another
Amazon Web Services Region.
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.
The presigned 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 cluster snapshot to be
copied. The presigned URL request must contain the following parameter
values:
SourceRegion
- The ID of the region that contains the snapshot to be copied.SourceDBClusterSnapshotIdentifier
- The identifier for the the encrypted 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 cluster snapshot from the us-east-1 Amazon Web Services Region, then yourSourceDBClusterSnapshotIdentifier
looks something like the following:arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot
.TargetDBClusterSnapshotIdentifier
- The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.
$sel:tags:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_tags
- The tags to be assigned to the cluster snapshot.
$sel:sourceDBClusterSnapshotIdentifier:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_sourceDBClusterSnapshotIdentifier
- The identifier of the cluster snapshot to copy. This parameter is not
case sensitive.
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 snapshot identifier.
- If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster snapshot ARN.
Example: my-cluster-snapshot1
$sel:targetDBClusterSnapshotIdentifier:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_targetDBClusterSnapshotIdentifier
- The identifier of the new cluster snapshot to create from the source
cluster snapshot. This parameter is not case sensitive.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster-snapshot2
data CopyDBClusterSnapshotResponse Source #
See: newCopyDBClusterSnapshotResponse
smart constructor.
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.
CreateDBCluster
data CreateDBCluster Source #
Represents the input to CreateDBCluster.
See: newCreateDBCluster
smart constructor.
CreateDBCluster' (Maybe [Text]) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Tag]) (Maybe [Text]) Text Text |
Instances
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:
CreateDBCluster
, createDBCluster_availabilityZones
- A list of Amazon EC2 Availability Zones that instances in the cluster
can be created in.
CreateDBCluster
, createDBCluster_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.
CreateDBCluster
, createDBCluster_dbClusterParameterGroupName
- The name of the cluster parameter group to associate with this cluster.
CreateDBCluster
, createDBCluster_dbSubnetGroupName
- A subnet group to associate with this cluster.
Constraints: Must match the name of an existing DBSubnetGroup
. Must
not be default.
Example: mySubnetgroup
CreateDBCluster
, createDBCluster_deletionProtection
- Specifies whether this cluster can be deleted. If DeletionProtection
is enabled, the cluster cannot be deleted unless it is modified and
DeletionProtection
is disabled. DeletionProtection
protects clusters
from being accidentally deleted.
$sel:enableCloudwatchLogsExports:CreateDBCluster'
, createDBCluster_enableCloudwatchLogsExports
- A list of log types that need to be enabled for exporting to Amazon
CloudWatch Logs. You can enable audit logs or profiler logs. For more
information, see
Auditing Amazon DocumentDB Events
and
Profiling Amazon DocumentDB Operations.
CreateDBCluster
, createDBCluster_engineVersion
- The version number of the database engine to use. The --engine-version
will default to the latest major engine version. For production
workloads, we recommend explicitly declaring this parameter with the
intended major engine version.
CreateDBCluster
, createDBCluster_globalClusterIdentifier
- The cluster identifier of the new global cluster.
CreateDBCluster
, createDBCluster_kmsKeyId
- The KMS key identifier for an encrypted cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.
If an encryption key is not specified in KmsKeyId
:
- If the
StorageEncrypted
parameter istrue
, Amazon DocumentDB uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.
CreateDBCluster
, createDBCluster_masterUserPassword
- The password for the master database user. This password can contain any
printable ASCII character except forward slash (/), double quote ("),
or the "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
CreateDBCluster
, createDBCluster_masterUsername
- The name of the master user for the cluster.
Constraints:
- Must be from 1 to 63 letters or numbers.
- The first character must be a letter.
- Cannot be a reserved word for the chosen database engine.
CreateDBCluster
, createDBCluster_port
- The port number on which the instances in the cluster accept
connections.
$sel:preSignedUrl:CreateDBCluster'
, createDBCluster_preSignedUrl
- Not currently supported.
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.
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.
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.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
CreateDBCluster
, createDBCluster_storageEncrypted
- Specifies whether the cluster is encrypted.
$sel:tags:CreateDBCluster'
, createDBCluster_tags
- The tags to be assigned to the cluster.
$sel:vpcSecurityGroupIds:CreateDBCluster'
, createDBCluster_vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this cluster.
CreateDBCluster
, createDBCluster_dbClusterIdentifier
- The cluster identifier. This parameter is stored as a lowercase string.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster
CreateDBCluster
, createDBCluster_engine
- The name of the database engine to be used for this cluster.
Valid values: docdb
data CreateDBClusterResponse Source #
See: newCreateDBClusterResponse
smart constructor.
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.
CreateDBClusterParameterGroup
data CreateDBClusterParameterGroup Source #
Represents the input of CreateDBClusterParameterGroup.
See: newCreateDBClusterParameterGroup
smart constructor.
Instances
newCreateDBClusterParameterGroup Source #
:: 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
- The tags to be assigned to the cluster parameter group.
CreateDBClusterParameterGroup
, createDBClusterParameterGroup_dbClusterParameterGroupName
- The name of the cluster parameter group.
Constraints:
- Must not match the name of an existing
DBClusterParameterGroup
.
This value is stored as a lowercase string.
CreateDBClusterParameterGroup
, createDBClusterParameterGroup_dbParameterGroupFamily
- The cluster parameter group family name.
CreateDBClusterParameterGroup
, createDBClusterParameterGroup_description
- The description for the cluster parameter group.
data CreateDBClusterParameterGroupResponse Source #
See: newCreateDBClusterParameterGroupResponse
smart constructor.
Instances
newCreateDBClusterParameterGroupResponse Source #
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:
CreateDBClusterParameterGroupResponse
, createDBClusterParameterGroupResponse_dbClusterParameterGroup
- Undocumented member.
$sel:httpStatus:CreateDBClusterParameterGroupResponse'
, createDBClusterParameterGroupResponse_httpStatus
- The response's http status code.
CreateDBClusterSnapshot
data CreateDBClusterSnapshot Source #
Represents the input of CreateDBClusterSnapshot.
See: newCreateDBClusterSnapshot
smart constructor.
Instances
newCreateDBClusterSnapshot Source #
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 cluster snapshot.
CreateDBClusterSnapshot
, createDBClusterSnapshot_dbClusterSnapshotIdentifier
- The identifier of the cluster snapshot. This parameter is stored as a
lowercase string.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster-snapshot1
CreateDBClusterSnapshot
, createDBClusterSnapshot_dbClusterIdentifier
- The identifier of the cluster to create a snapshot for. This parameter
is not case sensitive.
Constraints:
- Must match the identifier of an existing
DBCluster
.
Example: my-cluster
data CreateDBClusterSnapshotResponse Source #
See: newCreateDBClusterSnapshotResponse
smart constructor.
Instances
Generic CreateDBClusterSnapshotResponse Source # | |
Read CreateDBClusterSnapshotResponse Source # | |
Show CreateDBClusterSnapshotResponse Source # | |
Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot | |
NFData CreateDBClusterSnapshotResponse Source # | |
Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot rnf :: CreateDBClusterSnapshotResponse -> () # | |
Eq CreateDBClusterSnapshotResponse Source # | |
type Rep CreateDBClusterSnapshotResponse Source # | |
Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot type Rep CreateDBClusterSnapshotResponse = D1 ('MetaData "CreateDBClusterSnapshotResponse" "Amazonka.DocumentDB.CreateDBClusterSnapshot" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CreateDBClusterSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBClusterSnapshot)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
CreateDBInstance
data CreateDBInstance Source #
Represents the input to CreateDBInstance.
See: newCreateDBInstance
smart constructor.
CreateDBInstance' (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Tag]) Text Text Text Text |
Instances
:: Text | |
-> 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:
CreateDBInstance
, createDBInstance_autoMinorVersionUpgrade
- This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB
does not perform minor version upgrades regardless of the value set.
Default: false
CreateDBInstance
, createDBInstance_availabilityZone
- The Amazon EC2 Availability Zone that the instance is created in.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
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.
$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.
$sel:performanceInsightsKMSKeyId:CreateDBInstance'
, createDBInstance_performanceInsightsKMSKeyId
- The KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
CreateDBInstance
, createDBInstance_preferredMaintenanceWindow
- The time range each week 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.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
CreateDBInstance
, createDBInstance_promotionTier
- A value that specifies the order in which an Amazon DocumentDB replica
is promoted to the primary instance after a failure of the existing
primary instance.
Default: 1
Valid values: 0-15
$sel:tags:CreateDBInstance'
, createDBInstance_tags
- The tags to be assigned to the instance. You can assign up to 10 tags to
an instance.
CreateDBInstance
, createDBInstance_dbInstanceIdentifier
- The instance identifier. This parameter is stored as a lowercase string.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
CreateDBInstance
, createDBInstance_dbInstanceClass
- The compute and memory capacity of the instance; for example,
db.r5.large
.
CreateDBInstance
, createDBInstance_engine
- The name of the database engine to be used for this instance.
Valid value: docdb
CreateDBInstance
, createDBInstance_dbClusterIdentifier
- The identifier of the cluster that the instance will belong to.
data CreateDBInstanceResponse Source #
See: newCreateDBInstanceResponse
smart constructor.
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.
CreateDBSubnetGroup
data CreateDBSubnetGroup Source #
Represents the input to CreateDBSubnetGroup.
See: newCreateDBSubnetGroup
smart constructor.
Instances
newCreateDBSubnetGroup Source #
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
- The tags to be assigned to the subnet group.
CreateDBSubnetGroup
, createDBSubnetGroup_dbSubnetGroupName
- The name for the 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
CreateDBSubnetGroup
, createDBSubnetGroup_dbSubnetGroupDescription
- The description for the subnet group.
$sel:subnetIds:CreateDBSubnetGroup'
, createDBSubnetGroup_subnetIds
- The Amazon EC2 subnet IDs for the subnet group.
data CreateDBSubnetGroupResponse Source #
See: newCreateDBSubnetGroupResponse
smart constructor.
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:
CreateDBSubnetGroupResponse
, createDBSubnetGroupResponse_dbSubnetGroup
- Undocumented member.
$sel:httpStatus:CreateDBSubnetGroupResponse'
, createDBSubnetGroupResponse_httpStatus
- The response's http status code.
CreateEventSubscription
data CreateEventSubscription Source #
Represents the input to CreateEventSubscription.
See: newCreateEventSubscription
smart constructor.
CreateEventSubscription' (Maybe Bool) (Maybe [Text]) (Maybe [Text]) (Maybe Text) (Maybe [Tag]) Text Text |
Instances
newCreateEventSubscription Source #
:: 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:
CreateEventSubscription
, createEventSubscription_enabled
- A Boolean value; set to true
to activate the subscription, set to
false
to create the subscription but not active it.
CreateEventSubscription
, createEventSubscription_eventCategories
- A list of event categories for a SourceType
that you want to subscribe
to.
$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 provided,SourceType
must also be provided. - If the source type is an instance, a
DBInstanceIdentifier
must be provided. - If the source type is a security group, a
DBSecurityGroupName
must be provided. - If the source type is a parameter group, a
DBParameterGroupName
must be provided. - If the source type is a snapshot, a
DBSnapshotIdentifier
must be provided.
CreateEventSubscription
, createEventSubscription_sourceType
- The type of source that is generating the events. For example, if you
want to be notified of events generated by an instance, you would set
this parameter to db-instance
. If this value is not specified, all
events are returned.
Valid values: db-instance
, db-cluster
, db-parameter-group
,
db-security-group
, db-cluster-snapshot
$sel:tags:CreateEventSubscription'
, createEventSubscription_tags
- The tags to be assigned to the event subscription.
$sel:subscriptionName:CreateEventSubscription'
, createEventSubscription_subscriptionName
- The name of the subscription.
Constraints: The name must be fewer than 255 characters.
CreateEventSubscription
, createEventSubscription_snsTopicArn
- The Amazon Resource Name (ARN) of the SNS topic created for event
notification. Amazon SNS creates the ARN when you create a topic and
subscribe to it.
data CreateEventSubscriptionResponse Source #
See: newCreateEventSubscriptionResponse
smart constructor.
Instances
Generic CreateEventSubscriptionResponse Source # | |
Read CreateEventSubscriptionResponse Source # | |
Show CreateEventSubscriptionResponse Source # | |
Defined in Amazonka.DocumentDB.CreateEventSubscription | |
NFData CreateEventSubscriptionResponse Source # | |
Defined in Amazonka.DocumentDB.CreateEventSubscription rnf :: CreateEventSubscriptionResponse -> () # | |
Eq CreateEventSubscriptionResponse Source # | |
type Rep CreateEventSubscriptionResponse Source # | |
Defined in Amazonka.DocumentDB.CreateEventSubscription type Rep CreateEventSubscriptionResponse = D1 ('MetaData "CreateEventSubscriptionResponse" "Amazonka.DocumentDB.CreateEventSubscription" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CreateEventSubscriptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventSubscription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventSubscription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
CreateGlobalCluster
data CreateGlobalCluster Source #
Represents the input to CreateGlobalCluster.
See: newCreateGlobalCluster
smart constructor.
CreateGlobalCluster' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) Text |
Instances
newCreateGlobalCluster 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:
CreateGlobalCluster
, createGlobalCluster_databaseName
- The name for your database of up to 64 alpha-numeric characters. If you
do not provide a name, Amazon DocumentDB will not create a database in
the global cluster you are creating.
CreateGlobalCluster
, createGlobalCluster_deletionProtection
- The deletion protection setting for the new global cluster. The global
cluster can't be deleted when deletion protection is enabled.
CreateGlobalCluster
, createGlobalCluster_engine
- The name of the database engine to be used for this cluster.
CreateGlobalCluster
, createGlobalCluster_engineVersion
- The engine version of the global cluster.
$sel:sourceDBClusterIdentifier:CreateGlobalCluster'
, createGlobalCluster_sourceDBClusterIdentifier
- The Amazon Resource Name (ARN) to use as the primary cluster of the
global cluster. This parameter is optional.
CreateGlobalCluster
, createGlobalCluster_storageEncrypted
- The storage encryption setting for the new global cluster.
CreateGlobalCluster
, createGlobalCluster_globalClusterIdentifier
- The cluster identifier of the new global cluster.
data CreateGlobalClusterResponse Source #
See: newCreateGlobalClusterResponse
smart constructor.
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.
DeleteDBCluster
data DeleteDBCluster Source #
Represents the input to DeleteDBCluster.
See: newDeleteDBCluster
smart constructor.
Instances
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 cluster snapshot identifier of the new cluster snapshot created when
SkipFinalSnapshot
is set to false
.
Specifying this parameter and also setting the SkipFinalShapshot
parameter to true
results in an error.
Constraints:
- Must be from 1 to 255 letters, numbers, or hyphens.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
$sel:skipFinalSnapshot:DeleteDBCluster'
, deleteDBCluster_skipFinalSnapshot
- Determines whether a final cluster snapshot is created before the
cluster is deleted. If true
is specified, no cluster snapshot is
created. If false
is specified, a cluster snapshot is created before
the DB cluster is deleted.
If SkipFinalSnapshot
is false
, you must specify a
FinalDBSnapshotIdentifier
parameter.
Default: false
DeleteDBCluster
, deleteDBCluster_dbClusterIdentifier
- The cluster identifier for the cluster to be deleted. This parameter
isn't case sensitive.
Constraints:
- Must match an existing
DBClusterIdentifier
.
data DeleteDBClusterResponse Source #
See: newDeleteDBClusterResponse
smart constructor.
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.
DeleteDBClusterParameterGroup
data DeleteDBClusterParameterGroup Source #
Represents the input to DeleteDBClusterParameterGroup.
See: newDeleteDBClusterParameterGroup
smart constructor.
Instances
newDeleteDBClusterParameterGroup Source #
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:
DeleteDBClusterParameterGroup
, deleteDBClusterParameterGroup_dbClusterParameterGroupName
- The name of the cluster parameter group.
Constraints:
- Must be the name of an existing cluster parameter group.
- You can't delete a default cluster parameter group.
- Cannot be associated with any clusters.
data DeleteDBClusterParameterGroupResponse Source #
See: newDeleteDBClusterParameterGroupResponse
smart constructor.
Instances
Generic DeleteDBClusterParameterGroupResponse Source # | |
Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup type Rep DeleteDBClusterParameterGroupResponse :: Type -> Type # | |
Read DeleteDBClusterParameterGroupResponse Source # | |
Show DeleteDBClusterParameterGroupResponse Source # | |
NFData DeleteDBClusterParameterGroupResponse Source # | |
Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup rnf :: DeleteDBClusterParameterGroupResponse -> () # | |
Eq DeleteDBClusterParameterGroupResponse Source # | |
type Rep DeleteDBClusterParameterGroupResponse Source # | |
Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup type Rep DeleteDBClusterParameterGroupResponse = D1 ('MetaData "DeleteDBClusterParameterGroupResponse" "Amazonka.DocumentDB.DeleteDBClusterParameterGroup" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DeleteDBClusterParameterGroupResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newDeleteDBClusterParameterGroupResponse :: DeleteDBClusterParameterGroupResponse Source #
Create a value of DeleteDBClusterParameterGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteDBClusterSnapshot
data DeleteDBClusterSnapshot Source #
Represents the input to DeleteDBClusterSnapshot.
See: newDeleteDBClusterSnapshot
smart constructor.
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:
DeleteDBClusterSnapshot
, deleteDBClusterSnapshot_dbClusterSnapshotIdentifier
- The identifier of the cluster snapshot to delete.
Constraints: Must be the name of an existing cluster snapshot in the
available
state.
data DeleteDBClusterSnapshotResponse Source #
See: newDeleteDBClusterSnapshotResponse
smart constructor.
Instances
Generic DeleteDBClusterSnapshotResponse Source # | |
Read DeleteDBClusterSnapshotResponse Source # | |
Show DeleteDBClusterSnapshotResponse Source # | |
Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot | |
NFData DeleteDBClusterSnapshotResponse Source # | |
Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot rnf :: DeleteDBClusterSnapshotResponse -> () # | |
Eq DeleteDBClusterSnapshotResponse Source # | |
type Rep DeleteDBClusterSnapshotResponse Source # | |
Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot type Rep DeleteDBClusterSnapshotResponse = D1 ('MetaData "DeleteDBClusterSnapshotResponse" "Amazonka.DocumentDB.DeleteDBClusterSnapshot" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DeleteDBClusterSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBClusterSnapshot)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
DeleteDBInstance
data DeleteDBInstance Source #
Represents the input to DeleteDBInstance.
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:
DeleteDBInstance
, deleteDBInstance_dbInstanceIdentifier
- The instance identifier for the instance to be deleted. This parameter
isn't case sensitive.
Constraints:
- Must match the name of an existing instance.
data DeleteDBInstanceResponse Source #
See: newDeleteDBInstanceResponse
smart constructor.
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.
DeleteDBSubnetGroup
data DeleteDBSubnetGroup Source #
Represents the input to DeleteDBSubnetGroup.
See: newDeleteDBSubnetGroup
smart constructor.
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:
DeleteDBSubnetGroup
, deleteDBSubnetGroup_dbSubnetGroupName
- The name of the database subnet group to delete.
You can't delete the default subnet group.
Constraints:
Must match the name of an existing DBSubnetGroup
. Must not be default.
Example: mySubnetgroup
data DeleteDBSubnetGroupResponse Source #
See: newDeleteDBSubnetGroupResponse
smart constructor.
Instances
newDeleteDBSubnetGroupResponse :: DeleteDBSubnetGroupResponse Source #
Create a value of DeleteDBSubnetGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteEventSubscription
data DeleteEventSubscription Source #
Represents the input to DeleteEventSubscription.
See: newDeleteEventSubscription
smart constructor.
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 Amazon DocumentDB event notification subscription that
you want to delete.
data DeleteEventSubscriptionResponse Source #
See: newDeleteEventSubscriptionResponse
smart constructor.
Instances
Generic DeleteEventSubscriptionResponse Source # | |
Read DeleteEventSubscriptionResponse Source # | |
Show DeleteEventSubscriptionResponse Source # | |
Defined in Amazonka.DocumentDB.DeleteEventSubscription | |
NFData DeleteEventSubscriptionResponse Source # | |
Defined in Amazonka.DocumentDB.DeleteEventSubscription rnf :: DeleteEventSubscriptionResponse -> () # | |
Eq DeleteEventSubscriptionResponse Source # | |
type Rep DeleteEventSubscriptionResponse Source # | |
Defined in Amazonka.DocumentDB.DeleteEventSubscription type Rep DeleteEventSubscriptionResponse = D1 ('MetaData "DeleteEventSubscriptionResponse" "Amazonka.DocumentDB.DeleteEventSubscription" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DeleteEventSubscriptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventSubscription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventSubscription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
DeleteGlobalCluster
data DeleteGlobalCluster Source #
Represents the input to DeleteGlobalCluster.
See: newDeleteGlobalCluster
smart constructor.
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:
DeleteGlobalCluster
, deleteGlobalCluster_globalClusterIdentifier
- The cluster identifier of the global cluster being deleted.
data DeleteGlobalClusterResponse Source #
See: newDeleteGlobalClusterResponse
smart constructor.
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.
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:
DescribeCertificates
, describeCertificates_certificateIdentifier
- The user-supplied certificate identifier. If this parameter is
specified, information for only the specified certificate is returned.
If this parameter is omitted, a list of up to MaxRecords
certificates
is returned. This parameter is not case sensitive.
Constraints
- Must match an existing
CertificateIdentifier
.
$sel:filters:DescribeCertificates'
, describeCertificates_filters
- This parameter is not currently supported.
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 that the remaining
results can be retrieved.
Default: 100
Constraints:
- Minimum: 20
- Maximum: 100
data DescribeCertificatesResponse Source #
See: newDescribeCertificatesResponse
smart constructor.
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
- A list of certificates for this Amazon Web Services account.
DescribeCertificates
, describeCertificatesResponse_marker
- An optional pagination token provided if the number of records retrieved
is greater than MaxRecords
. If this parameter is specified, the marker
specifies the next record in the list. Including the value of Marker
in the next call to DescribeCertificates
results in the next page of
certificates.
$sel:httpStatus:DescribeCertificatesResponse'
, describeCertificatesResponse_httpStatus
- The response's http status code.
DescribeDBClusterParameterGroups (Paginated)
data DescribeDBClusterParameterGroups Source #
Represents the input to DescribeDBClusterParameterGroups.
See: newDescribeDBClusterParameterGroups
smart constructor.
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:
DescribeDBClusterParameterGroups
, describeDBClusterParameterGroups_dbClusterParameterGroupName
- The name of a specific cluster parameter group to return details for.
Constraints:
- If provided, must match the name of an existing
DBClusterParameterGroup
.
$sel:filters:DescribeDBClusterParameterGroups'
, describeDBClusterParameterGroups_filters
- This parameter is not currently supported.
DescribeDBClusterParameterGroups
, describeDBClusterParameterGroups_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: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
(marker) is included in the response so that the remaining results can
be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeDBClusterParameterGroupsResponse Source #
Represents the output of DBClusterParameterGroups.
See: newDescribeDBClusterParameterGroupsResponse
smart constructor.
Instances
newDescribeDBClusterParameterGroupsResponse Source #
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:dbClusterParameterGroups:DescribeDBClusterParameterGroupsResponse'
, describeDBClusterParameterGroupsResponse_dbClusterParameterGroups
- A list of cluster parameter groups.
DescribeDBClusterParameterGroups
, describeDBClusterParameterGroupsResponse_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:DescribeDBClusterParameterGroupsResponse'
, describeDBClusterParameterGroupsResponse_httpStatus
- The response's http status code.
DescribeDBClusterParameters (Paginated)
data DescribeDBClusterParameters Source #
Represents the input to DescribeDBClusterParameters.
See: newDescribeDBClusterParameters
smart constructor.
Instances
newDescribeDBClusterParameters Source #
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 is not currently supported.
DescribeDBClusterParameters
, describeDBClusterParameters_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: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
(marker) is included in the response so that the remaining results can
be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBClusterParameters
, describeDBClusterParameters_source
- A value that indicates to return only parameters for a specific source.
Parameter sources can be engine
, service
, or customer
.
DescribeDBClusterParameters
, describeDBClusterParameters_dbClusterParameterGroupName
- The name of a specific cluster parameter group to return parameter
details for.
Constraints:
- If provided, must match the name of an existing
DBClusterParameterGroup
.
data DescribeDBClusterParametersResponse Source #
Represents the output of DBClusterParameterGroup.
See: newDescribeDBClusterParametersResponse
smart constructor.
Instances
newDescribeDBClusterParametersResponse Source #
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:
DescribeDBClusterParameters
, describeDBClusterParametersResponse_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
.
DescribeDBClusterParametersResponse
, describeDBClusterParametersResponse_parameters
- Provides a list of parameters for the cluster parameter group.
$sel:httpStatus:DescribeDBClusterParametersResponse'
, describeDBClusterParametersResponse_httpStatus
- The response's http status code.
DescribeDBClusterSnapshotAttributes
data DescribeDBClusterSnapshotAttributes Source #
Represents the input to DescribeDBClusterSnapshotAttributes.
See: newDescribeDBClusterSnapshotAttributes
smart constructor.
Instances
newDescribeDBClusterSnapshotAttributes Source #
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:
DescribeDBClusterSnapshotAttributes
, describeDBClusterSnapshotAttributes_dbClusterSnapshotIdentifier
- The identifier for the cluster snapshot to describe the attributes for.
data DescribeDBClusterSnapshotAttributesResponse Source #
See: newDescribeDBClusterSnapshotAttributesResponse
smart constructor.
Instances
Generic DescribeDBClusterSnapshotAttributesResponse Source # | |
Read DescribeDBClusterSnapshotAttributesResponse Source # | |
Show DescribeDBClusterSnapshotAttributesResponse Source # | |
NFData DescribeDBClusterSnapshotAttributesResponse Source # | |
Eq DescribeDBClusterSnapshotAttributesResponse Source # | |
type Rep DescribeDBClusterSnapshotAttributesResponse Source # | |
Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes type Rep DescribeDBClusterSnapshotAttributesResponse = D1 ('MetaData "DescribeDBClusterSnapshotAttributesResponse" "Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBClusterSnapshotAttributesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshotAttributesResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBClusterSnapshotAttributesResult)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDescribeDBClusterSnapshotAttributesResponse Source #
:: 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.
DescribeDBClusterSnapshots (Paginated)
data DescribeDBClusterSnapshots Source #
Represents the input to DescribeDBClusterSnapshots.
See: newDescribeDBClusterSnapshots
smart constructor.
DescribeDBClusterSnapshots' (Maybe Text) (Maybe Text) (Maybe [Filter]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) |
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:
DescribeDBClusterSnapshots
, describeDBClusterSnapshots_dbClusterIdentifier
- The ID of the cluster to retrieve the list of cluster snapshots for.
This parameter can't be used with the DBClusterSnapshotIdentifier
parameter. This parameter is not case sensitive.
Constraints:
- If provided, must match the identifier of an existing
DBCluster
.
DescribeDBClusterSnapshots
, describeDBClusterSnapshots_dbClusterSnapshotIdentifier
- A specific cluster snapshot identifier to describe. This parameter
can't be used with the DBClusterIdentifier
parameter. This value is
stored as a lowercase string.
Constraints:
- If provided, 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
- This parameter is not currently supported.
$sel:includePublic:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_includePublic
- Set to true
to include manual cluster snapshots that are public and
can be copied or restored by any Amazon Web Services account, and
otherwise false
. The default is false
.
$sel:includeShared:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_includeShared
- Set to true
to include shared manual cluster snapshots from other
Amazon Web Services accounts that this Amazon Web Services account has
been given permission to copy or restore, and otherwise false
. The
default is false
.
DescribeDBClusterSnapshots
, describeDBClusterSnapshots_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: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
(marker) is included in the response so that the remaining results can
be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBClusterSnapshots
, describeDBClusterSnapshots_snapshotType
- The type of cluster snapshots to be returned. You can specify one of the
following values:
automated
- Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.manual
- Return all cluster snapshots that you have manually created for your Amazon Web Services account.shared
- Return all manual cluster snapshots that have been shared to your Amazon Web Services account.public
- Return all cluster snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and
manual cluster snapshots are returned. You can include shared cluster
snapshots with these results by setting the IncludeShared
parameter to
true
. You can include public cluster snapshots with these results by
setting theIncludePublic
parameter to true
.
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
.
data DescribeDBClusterSnapshotsResponse Source #
Represents the output of DescribeDBClusterSnapshots.
See: newDescribeDBClusterSnapshotsResponse
smart constructor.
Instances
newDescribeDBClusterSnapshotsResponse Source #
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:dbClusterSnapshots:DescribeDBClusterSnapshotsResponse'
, describeDBClusterSnapshotsResponse_dbClusterSnapshots
- Provides a list of cluster snapshots.
DescribeDBClusterSnapshots
, describeDBClusterSnapshotsResponse_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:DescribeDBClusterSnapshotsResponse'
, describeDBClusterSnapshotsResponse_httpStatus
- The response's http status code.
DescribeDBClusters (Paginated)
data DescribeDBClusters Source #
Represents the input to DescribeDBClusters.
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:
DescribeDBClusters
, describeDBClusters_dbClusterIdentifier
- The user-provided cluster identifier. If this parameter is specified,
information from only the specific cluster is returned. This parameter
isn't case sensitive.
Constraints:
- If provided, must match an existing
DBClusterIdentifier
.
$sel:filters:DescribeDBClusters'
, describeDBClusters_filters
- A filter that specifies one or more clusters to describe.
Supported filters:
db-cluster-id
- Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.
DescribeDBClusters
, describeDBClusters_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: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
(marker) is included in the response so that the remaining results can
be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeDBClustersResponse Source #
Represents the output of DescribeDBClusters.
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
- A list of clusters.
DescribeDBClusters
, describeDBClustersResponse_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:DescribeDBClustersResponse'
, describeDBClustersResponse_httpStatus
- The response's http status code.
DescribeDBEngineVersions (Paginated)
data DescribeDBEngineVersions Source #
Represents the input to DescribeDBEngineVersions.
See: newDescribeDBEngineVersions
smart constructor.
DescribeDBEngineVersions' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Filter]) (Maybe Bool) (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:
DescribeDBEngineVersions
, describeDBEngineVersions_dbParameterGroupFamily
- The name of a specific parameter group family to return details for.
Constraints:
- If provided, must match an existing
DBParameterGroupFamily
.
$sel:defaultOnly:DescribeDBEngineVersions'
, describeDBEngineVersions_defaultOnly
- Indicates that only the default version of the specified engine or
engine and major version combination is returned.
DescribeDBEngineVersions
, describeDBEngineVersions_engine
- The database engine to return.
DescribeDBEngineVersions
, describeDBEngineVersions_engineVersion
- The database engine version to return.
Example: 3.6.0
$sel:filters:DescribeDBEngineVersions'
, describeDBEngineVersions_filters
- This parameter is not currently supported.
$sel:listSupportedCharacterSets:DescribeDBEngineVersions'
, describeDBEngineVersions_listSupportedCharacterSets
- If this parameter is specified and the requested engine supports the
CharacterSetName
parameter for CreateDBInstance
, the response
includes a list of supported character sets for each engine version.
$sel:listSupportedTimezones:DescribeDBEngineVersions'
, describeDBEngineVersions_listSupportedTimezones
- If this parameter is specified and the requested engine supports the
TimeZone
parameter for CreateDBInstance
, the response includes a
list of supported time zones for each engine version.
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
records exist than the specified MaxRecords
value, a pagination token
(marker) is included in the response so that the remaining results can
be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeDBEngineVersionsResponse Source #
Represents the output of DescribeDBEngineVersions.
See: newDescribeDBEngineVersionsResponse
smart constructor.
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:dbEngineVersions:DescribeDBEngineVersionsResponse'
, describeDBEngineVersionsResponse_dbEngineVersions
- Detailed information about one or more engine versions.
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:httpStatus:DescribeDBEngineVersionsResponse'
, describeDBEngineVersionsResponse_httpStatus
- The response's http status code.
DescribeDBInstances (Paginated)
data DescribeDBInstances Source #
Represents the input to DescribeDBInstances.
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:
DescribeDBInstances
, describeDBInstances_dbInstanceIdentifier
- The user-provided instance identifier. If this parameter is specified,
information from only the specific instance is returned. This parameter
isn't case sensitive.
Constraints:
- If provided, must match the identifier of an existing
DBInstance
.
$sel:filters:DescribeDBInstances'
, describeDBInstances_filters
- A filter that specifies one or more instances to describe.
Supported filters:
db-cluster-id
- Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.db-instance-id
- Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.
DescribeDBInstances
, describeDBInstances_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: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
(marker) is included in the response so that the remaining results can
be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeDBInstancesResponse Source #
Represents the output of DescribeDBInstances.
See: newDescribeDBInstancesResponse
smart constructor.
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
- Detailed information about one or more instances.
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.
DescribeDBSubnetGroups (Paginated)
data DescribeDBSubnetGroups Source #
Represents the input to DescribeDBSubnetGroups.
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:
DescribeDBSubnetGroups
, describeDBSubnetGroups_dbSubnetGroupName
- The name of the subnet group to return details for.
$sel:filters:DescribeDBSubnetGroups'
, describeDBSubnetGroups_filters
- This parameter is not currently supported.
DescribeDBSubnetGroups
, describeDBSubnetGroups_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: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
(marker) is included in the response so that the remaining results can
be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeDBSubnetGroupsResponse Source #
Represents the output of DescribeDBSubnetGroups.
See: newDescribeDBSubnetGroupsResponse
smart constructor.
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
- Detailed information about one or more subnet groups.
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.
DescribeEngineDefaultClusterParameters
data DescribeEngineDefaultClusterParameters Source #
Represents the input to DescribeEngineDefaultClusterParameters.
See: newDescribeEngineDefaultClusterParameters
smart constructor.
Instances
newDescribeEngineDefaultClusterParameters Source #
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 is not currently supported.
DescribeEngineDefaultClusterParameters
, describeEngineDefaultClusterParameters_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: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
(marker) is included in the response so that the remaining results can
be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeEngineDefaultClusterParameters
, describeEngineDefaultClusterParameters_dbParameterGroupFamily
- The name of the cluster parameter group family to return the engine
parameter information for.
data DescribeEngineDefaultClusterParametersResponse Source #
See: newDescribeEngineDefaultClusterParametersResponse
smart constructor.
Instances
Generic DescribeEngineDefaultClusterParametersResponse Source # | |
Read DescribeEngineDefaultClusterParametersResponse Source # | |
Show DescribeEngineDefaultClusterParametersResponse Source # | |
NFData DescribeEngineDefaultClusterParametersResponse Source # | |
Eq DescribeEngineDefaultClusterParametersResponse Source # | |
type Rep DescribeEngineDefaultClusterParametersResponse Source # | |
Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters type Rep DescribeEngineDefaultClusterParametersResponse = D1 ('MetaData "DescribeEngineDefaultClusterParametersResponse" "Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeEngineDefaultClusterParametersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "engineDefaults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EngineDefaults)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDescribeEngineDefaultClusterParametersResponse Source #
:: 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.
DescribeEventCategories
data DescribeEventCategories Source #
Represents the input to DescribeEventCategories.
See: newDescribeEventCategories
smart constructor.
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:filters:DescribeEventCategories'
, describeEventCategories_filters
- This parameter is not currently supported.
DescribeEventCategories
, describeEventCategories_sourceType
- The type of source that is generating the events.
Valid values: db-instance
, db-parameter-group
, db-security-group
data DescribeEventCategoriesResponse Source #
Represents the output of DescribeEventCategories.
See: newDescribeEventCategoriesResponse
smart constructor.
Instances
Generic DescribeEventCategoriesResponse Source # | |
Read DescribeEventCategoriesResponse Source # | |
Show DescribeEventCategoriesResponse Source # | |
Defined in Amazonka.DocumentDB.DescribeEventCategories | |
NFData DescribeEventCategoriesResponse Source # | |
Defined in Amazonka.DocumentDB.DescribeEventCategories rnf :: DescribeEventCategoriesResponse -> () # | |
Eq DescribeEventCategoriesResponse Source # | |
type Rep DescribeEventCategoriesResponse Source # | |
Defined in Amazonka.DocumentDB.DescribeEventCategories type Rep DescribeEventCategoriesResponse = D1 ('MetaData "DescribeEventCategoriesResponse" "Amazonka.DocumentDB.DescribeEventCategories" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeEventCategoriesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventCategoriesMapList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EventCategoriesMap])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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 event category maps.
$sel:httpStatus:DescribeEventCategoriesResponse'
, describeEventCategoriesResponse_httpStatus
- The response's http status code.
DescribeEventSubscriptions (Paginated)
data DescribeEventSubscriptions Source #
Represents the input to DescribeEventSubscriptions.
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:filters:DescribeEventSubscriptions'
, describeEventSubscriptions_filters
- This parameter is not currently supported.
DescribeEventSubscriptions
, describeEventSubscriptions_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: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
(marker) is included in the response so that the remaining results can
be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
$sel:subscriptionName:DescribeEventSubscriptions'
, describeEventSubscriptions_subscriptionName
- The name of the Amazon DocumentDB event notification subscription that
you want to describe.
data DescribeEventSubscriptionsResponse Source #
Represents the output of DescribeEventSubscriptions.
See: newDescribeEventSubscriptionsResponse
smart constructor.
Instances
newDescribeEventSubscriptionsResponse Source #
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 event subscriptions.
DescribeEventSubscriptions
, describeEventSubscriptionsResponse_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:DescribeEventSubscriptionsResponse'
, describeEventSubscriptionsResponse_httpStatus
- The response's http status code.
DescribeEvents (Paginated)
data DescribeEvents Source #
Represents the input to DescribeEvents.
See: newDescribeEvents
smart constructor.
DescribeEvents' (Maybe Int) (Maybe ISO8601) (Maybe [Text]) (Maybe [Filter]) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe SourceType) (Maybe ISO8601) |
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:duration:DescribeEvents'
, describeEvents_duration
- The number of minutes to retrieve events for.
Default: 60
$sel:endTime:DescribeEvents'
, describeEvents_endTime
- The end of the time interval for which to retrieve events, specified in
ISO 8601 format.
Example: 2009-07-08T18:00Z
DescribeEvents
, describeEvents_eventCategories
- A list of event categories that trigger notifications for an event
notification subscription.
$sel:filters:DescribeEvents'
, describeEvents_filters
- This parameter is not currently supported.
DescribeEvents
, describeEvents_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: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
(marker) is included in the response so that the remaining results can
be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
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 provided,SourceType
must also be provided. - If the source type is
DBInstance
, aDBInstanceIdentifier
must be provided. - If the source type is
DBSecurityGroup
, aDBSecurityGroupName
must be provided. - If the source type is
DBParameterGroup
, aDBParameterGroupName
must be provided. - If the source type is
DBSnapshot
, aDBSnapshotIdentifier
must be provided. - Cannot end with a hyphen or contain two consecutive hyphens.
DescribeEvents
, describeEvents_sourceType
- The event source to retrieve events for. If no value is specified, all
events are returned.
$sel:startTime:DescribeEvents'
, describeEvents_startTime
- The beginning of the time interval to retrieve events for, specified in
ISO 8601 format.
Example: 2009-07-08T18:00Z
data DescribeEventsResponse Source #
Represents the output of DescribeEvents.
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
- Detailed information about one or more events.
DescribeEvents
, describeEventsResponse_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:DescribeEventsResponse'
, describeEventsResponse_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:filters:DescribeGlobalClusters'
, describeGlobalClusters_filters
- A filter that specifies one or more global DB clusters to describe.
Supported filters: db-cluster-id
accepts cluster identifiers and
cluster Amazon Resource Names (ARNs). The results list will only include
information about the clusters identified by these ARNs.
DescribeGlobalClusters
, describeGlobalClusters_globalClusterIdentifier
- The user-supplied cluster identifier. If this parameter is specified,
information from only the specific cluster is returned. This parameter
isn't case-sensitive.
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.
data DescribeGlobalClustersResponse Source #
See: newDescribeGlobalClustersResponse
smart constructor.
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
-
DescribeGlobalClusters
, describeGlobalClustersResponse_marker
-
$sel:httpStatus:DescribeGlobalClustersResponse'
, describeGlobalClustersResponse_httpStatus
- The response's http status code.
DescribeOrderableDBInstanceOptions (Paginated)
data DescribeOrderableDBInstanceOptions Source #
Represents the input to DescribeOrderableDBInstanceOptions.
See: newDescribeOrderableDBInstanceOptions
smart constructor.
DescribeOrderableDBInstanceOptions' (Maybe Text) (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) Text |
Instances
newDescribeOrderableDBInstanceOptions Source #
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:
DescribeOrderableDBInstanceOptions
, describeOrderableDBInstanceOptions_dbInstanceClass
- The instance class filter value. Specify this parameter to show only the
available offerings that match the specified instance class.
DescribeOrderableDBInstanceOptions
, describeOrderableDBInstanceOptions_engineVersion
- The engine version filter value. Specify this parameter to show only the
available offerings that match the specified engine version.
$sel:filters:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptions_filters
- This parameter is not currently supported.
DescribeOrderableDBInstanceOptions
, describeOrderableDBInstanceOptions_licenseModel
- The license model filter value. Specify this parameter to show only the
available offerings that match the specified license model.
DescribeOrderableDBInstanceOptions
, describeOrderableDBInstanceOptions_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: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
(marker) is included in the response so that the remaining results can
be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeOrderableDBInstanceOptions
, describeOrderableDBInstanceOptions_vpc
- The virtual private cloud (VPC) filter value. Specify this parameter to
show only the available VPC or non-VPC offerings.
DescribeOrderableDBInstanceOptions
, describeOrderableDBInstanceOptions_engine
- The name of the engine to retrieve instance options for.
data DescribeOrderableDBInstanceOptionsResponse Source #
Represents the output of DescribeOrderableDBInstanceOptions.
See: newDescribeOrderableDBInstanceOptionsResponse
smart constructor.
Instances
newDescribeOrderableDBInstanceOptionsResponse Source #
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:
DescribeOrderableDBInstanceOptions
, describeOrderableDBInstanceOptionsResponse_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:orderableDBInstanceOptions:DescribeOrderableDBInstanceOptionsResponse'
, describeOrderableDBInstanceOptionsResponse_orderableDBInstanceOptions
- The options that are available for a particular orderable instance.
$sel:httpStatus:DescribeOrderableDBInstanceOptionsResponse'
, describeOrderableDBInstanceOptionsResponse_httpStatus
- The response's http status code.
DescribePendingMaintenanceActions (Paginated)
data DescribePendingMaintenanceActions Source #
Represents the input to DescribePendingMaintenanceActions.
See: newDescribePendingMaintenanceActions
smart constructor.
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 cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs.db-instance-id
- Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.
DescribePendingMaintenanceActions
, describePendingMaintenanceActions_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: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
(marker) is included in the response so that the remaining results can
be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribePendingMaintenanceActions
, describePendingMaintenanceActions_resourceIdentifier
- The ARN of a resource to return pending maintenance actions for.
data DescribePendingMaintenanceActionsResponse Source #
Represents the output of DescribePendingMaintenanceActions.
See: newDescribePendingMaintenanceActionsResponse
smart constructor.
DescribePendingMaintenanceActionsResponse' (Maybe Text) (Maybe [ResourcePendingMaintenanceActions]) Int |
Instances
newDescribePendingMaintenanceActionsResponse Source #
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:
DescribePendingMaintenanceActions
, describePendingMaintenanceActionsResponse_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:pendingMaintenanceActions:DescribePendingMaintenanceActionsResponse'
, describePendingMaintenanceActionsResponse_pendingMaintenanceActions
- The maintenance actions to be applied.
$sel:httpStatus:DescribePendingMaintenanceActionsResponse'
, describePendingMaintenanceActionsResponse_httpStatus
- The response's http status code.
FailoverDBCluster
data FailoverDBCluster Source #
Represents the input to FailoverDBCluster.
See: newFailoverDBCluster
smart constructor.
Instances
newFailoverDBCluster :: FailoverDBCluster Source #
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:
FailoverDBCluster
, failoverDBCluster_dbClusterIdentifier
- A cluster identifier to force a failover for. This parameter is not case
sensitive.
Constraints:
- Must match the identifier of an existing
DBCluster
.
$sel:targetDBInstanceIdentifier:FailoverDBCluster'
, failoverDBCluster_targetDBInstanceIdentifier
- The name of the instance to promote to the primary instance.
You must specify the instance identifier for an Amazon DocumentDB
replica in the cluster. For example, mydbcluster-replica1
.
data FailoverDBClusterResponse Source #
See: newFailoverDBClusterResponse
smart constructor.
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.
ListTagsForResource
data ListTagsForResource Source #
Represents the input to ListTagsForResource.
See: newListTagsForResource
smart constructor.
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 is not currently supported.
$sel:resourceName:ListTagsForResource'
, listTagsForResource_resourceName
- The Amazon DocumentDB resource with tags to be listed. This value is an
Amazon Resource Name (ARN).
data ListTagsForResourceResponse Source #
Represents the output of ListTagsForResource.
See: newListTagsForResourceResponse
smart constructor.
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
- A list of one or more tags.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ModifyDBCluster
data ModifyDBCluster Source #
Represents the input to ModifyDBCluster.
See: newModifyDBCluster
smart constructor.
ModifyDBCluster' (Maybe Bool) (Maybe Int) (Maybe CloudwatchLogsExportConfiguration) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe [Text]) Text |
Instances
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:applyImmediately:ModifyDBCluster'
, modifyDBCluster_applyImmediately
- A value that specifies whether the changes in this request and any
pending changes are asynchronously applied as soon as possible,
regardless of the PreferredMaintenanceWindow
setting for the cluster.
If this parameter is set to false
, changes to the cluster are applied
during the next maintenance window.
The ApplyImmediately
parameter affects only the
NewDBClusterIdentifier
and MasterUserPassword
values. If you set
this parameter value to false
, the changes to the
NewDBClusterIdentifier
and MasterUserPassword
values are applied
during the next maintenance window. All other changes are applied
immediately, regardless of the value of the ApplyImmediately
parameter.
Default: false
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:cloudwatchLogsExportConfiguration:ModifyDBCluster'
, modifyDBCluster_cloudwatchLogsExportConfiguration
- The configuration setting for the log types to be enabled for export to
Amazon CloudWatch Logs for a specific instance or cluster. The
EnableLogTypes
and DisableLogTypes
arrays determine which logs are
exported (or not exported) to CloudWatch Logs.
ModifyDBCluster
, modifyDBCluster_dbClusterParameterGroupName
- The name of the cluster parameter group to use for the cluster.
ModifyDBCluster
, modifyDBCluster_deletionProtection
- Specifies whether this cluster can be deleted. If DeletionProtection
is enabled, the cluster cannot be deleted unless it is modified and
DeletionProtection
is disabled. DeletionProtection
protects clusters
from being accidentally deleted.
ModifyDBCluster
, modifyDBCluster_engineVersion
- The version number of the database engine to which you want to upgrade.
Modifying engine version is not supported on Amazon DocumentDB.
ModifyDBCluster
, modifyDBCluster_masterUserPassword
- The password for the master database user. This password can contain any
printable ASCII character except forward slash (/), double quote ("),
or the "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
$sel:newDBClusterIdentifier':ModifyDBCluster'
, modifyDBCluster_newDBClusterIdentifier
- The new cluster identifier for the cluster when renaming a 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.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
ModifyDBCluster
, modifyDBCluster_port
- The port number on which the cluster accepts connections.
Constraints: Must be a value from 1150
to 65535
.
Default: The same port as the original cluster.
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.
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.
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.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
$sel:vpcSecurityGroupIds:ModifyDBCluster'
, modifyDBCluster_vpcSecurityGroupIds
- A list of virtual private cloud (VPC) security groups that the cluster
will belong to.
ModifyDBCluster
, modifyDBCluster_dbClusterIdentifier
- The cluster identifier for the cluster that is being modified. This
parameter is not case sensitive.
Constraints:
- Must match the identifier of an existing
DBCluster
.
data ModifyDBClusterResponse Source #
See: newModifyDBClusterResponse
smart constructor.
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.
ModifyDBClusterParameterGroup
data ModifyDBClusterParameterGroup Source #
Represents the input to ModifyDBClusterParameterGroup.
See: newModifyDBClusterParameterGroup
smart constructor.
Instances
newModifyDBClusterParameterGroup Source #
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:
ModifyDBClusterParameterGroup
, modifyDBClusterParameterGroup_dbClusterParameterGroupName
- The name of the cluster parameter group to modify.
ModifyDBClusterParameterGroup
, modifyDBClusterParameterGroup_parameters
- A list of parameters in the cluster parameter group to modify.
data DBClusterParameterGroupNameMessage Source #
Contains the name of a cluster parameter group.
See: newDBClusterParameterGroupNameMessage
smart constructor.
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 a cluster parameter group.
Constraints:
- Must be from 1 to 255 letters or numbers.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
This value is stored as a lowercase string.
ModifyDBClusterSnapshotAttribute
data ModifyDBClusterSnapshotAttribute Source #
Represents the input to ModifyDBClusterSnapshotAttribute.
See: newModifyDBClusterSnapshotAttribute
smart constructor.
Instances
newModifyDBClusterSnapshotAttribute Source #
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 cluster snapshot attributes to add to the attribute specified
by AttributeName
.
To authorize other Amazon Web Services accounts to copy or restore a
manual cluster snapshot, set this list to include one or more Amazon Web
Services account IDs. To make the manual cluster snapshot restorable by
any Amazon Web Services account, set it to all
. Do not add the all
value for any manual cluster snapshots that contain private information
that you don't want to be available to all Amazon Web Services
accounts.
$sel:valuesToRemove:ModifyDBClusterSnapshotAttribute'
, modifyDBClusterSnapshotAttribute_valuesToRemove
- A list of 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 cluster snapshot, set this list to include one or
more Amazon Web Services account identifiers. To remove authorization
for any Amazon Web Services account to copy or restore the cluster
snapshot, set it to all
. 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 cluster snapshot.
ModifyDBClusterSnapshotAttribute
, modifyDBClusterSnapshotAttribute_dbClusterSnapshotIdentifier
- The identifier for the cluster snapshot to modify the attributes for.
ModifyDBClusterSnapshotAttribute
, modifyDBClusterSnapshotAttribute_attributeName
- The name of the cluster snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy
or restore a manual cluster snapshot, set this value to restore
.
data ModifyDBClusterSnapshotAttributeResponse Source #
See: newModifyDBClusterSnapshotAttributeResponse
smart constructor.
Instances
newModifyDBClusterSnapshotAttributeResponse Source #
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.
ModifyDBInstance
data ModifyDBInstance Source #
Represents the input to ModifyDBInstance.
See: newModifyDBInstance
smart constructor.
ModifyDBInstance' (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) 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:applyImmediately:ModifyDBInstance'
, modifyDBInstance_applyImmediately
- Specifies whether the modifications in this request and any pending
modifications are asynchronously applied as soon as possible, regardless
of the PreferredMaintenanceWindow
setting for the instance.
If this parameter is set to false
, changes to the instance are applied
during the next maintenance window. Some parameter changes can cause an
outage and are applied on the next reboot.
Default: false
ModifyDBInstance
, modifyDBInstance_autoMinorVersionUpgrade
- This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB
does not perform minor version upgrades regardless of the value set.
ModifyDBInstance
, modifyDBInstance_cACertificateIdentifier
- Indicates the certificate that needs to be associated with the instance.
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.
ModifyDBInstance
, modifyDBInstance_dbInstanceClass
- The new compute and memory capacity of the instance; for example,
db.r5.large
. Not all instance classes are available in all Amazon Web
Services Regions.
If you modify the instance class, an outage occurs during the change.
The change is applied during the next maintenance window, unless
ApplyImmediately
is specified as true
for this request.
Default: Uses existing setting.
$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.
$sel:newDBInstanceIdentifier':ModifyDBInstance'
, modifyDBInstance_newDBInstanceIdentifier
- The new instance identifier for the instance when renaming an instance.
When you change the instance identifier, an instance reboot occurs
immediately if you set Apply Immediately
to true
. It occurs during
the next maintenance window if you set Apply Immediately
to false
.
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.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
$sel:performanceInsightsKMSKeyId:ModifyDBInstance'
, modifyDBInstance_performanceInsightsKMSKeyId
- The KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
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, changing this parameter causes a reboot of the
instance. If you are 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 that pending changes are applied.
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.
ModifyDBInstance
, modifyDBInstance_promotionTier
- A value that specifies the order in which an Amazon DocumentDB replica
is promoted to the primary instance after a failure of the existing
primary instance.
Default: 1
Valid values: 0-15
ModifyDBInstance
, modifyDBInstance_dbInstanceIdentifier
- The 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.
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.
ModifyDBSubnetGroup
data ModifyDBSubnetGroup Source #
Represents the input to ModifyDBSubnetGroup.
See: newModifyDBSubnetGroup
smart constructor.
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:
ModifyDBSubnetGroup
, modifyDBSubnetGroup_dbSubnetGroupDescription
- The description for the subnet group.
ModifyDBSubnetGroup
, modifyDBSubnetGroup_dbSubnetGroupName
- The name for the 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 Amazon EC2 subnet IDs for the subnet group.
data ModifyDBSubnetGroupResponse Source #
See: newModifyDBSubnetGroupResponse
smart constructor.
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:
ModifyDBSubnetGroupResponse
, modifyDBSubnetGroupResponse_dbSubnetGroup
- Undocumented member.
$sel:httpStatus:ModifyDBSubnetGroupResponse'
, modifyDBSubnetGroupResponse_httpStatus
- The response's http status code.
ModifyEventSubscription
data ModifyEventSubscription Source #
Represents the input to ModifyEventSubscription.
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:
ModifyEventSubscription
, modifyEventSubscription_enabled
- A Boolean value; set to true
to activate the subscription.
ModifyEventSubscription
, modifyEventSubscription_eventCategories
- A list of event categories for a SourceType
that you want to subscribe
to.
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.
ModifyEventSubscription
, modifyEventSubscription_sourceType
- The type of source that is generating the events. For example, if you
want to be notified of events generated by an instance, set this
parameter to db-instance
. If this value is not specified, all events
are returned.
Valid values: db-instance
, db-parameter-group
, db-security-group
$sel:subscriptionName:ModifyEventSubscription'
, modifyEventSubscription_subscriptionName
- The name of the Amazon DocumentDB event notification subscription.
data ModifyEventSubscriptionResponse Source #
See: newModifyEventSubscriptionResponse
smart constructor.
Instances
Generic ModifyEventSubscriptionResponse Source # | |
Read ModifyEventSubscriptionResponse Source # | |
Show ModifyEventSubscriptionResponse Source # | |
Defined in Amazonka.DocumentDB.ModifyEventSubscription | |
NFData ModifyEventSubscriptionResponse Source # | |
Defined in Amazonka.DocumentDB.ModifyEventSubscription rnf :: ModifyEventSubscriptionResponse -> () # | |
Eq ModifyEventSubscriptionResponse Source # | |
type Rep ModifyEventSubscriptionResponse Source # | |
Defined in Amazonka.DocumentDB.ModifyEventSubscription type Rep ModifyEventSubscriptionResponse = D1 ('MetaData "ModifyEventSubscriptionResponse" "Amazonka.DocumentDB.ModifyEventSubscription" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyEventSubscriptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventSubscription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventSubscription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
ModifyGlobalCluster
data ModifyGlobalCluster Source #
Represents the input to ModifyGlobalCluster.
See: newModifyGlobalCluster
smart constructor.
Instances
newModifyGlobalCluster 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:
ModifyGlobalCluster
, modifyGlobalCluster_deletionProtection
- Indicates if the global cluster has deletion protection enabled. The
global cluster can't be deleted when deletion protection is enabled.
$sel:newGlobalClusterIdentifier':ModifyGlobalCluster'
, modifyGlobalCluster_newGlobalClusterIdentifier
- The new identifier for a global cluster when you modify a global
cluster. This value is stored as a lowercase string.
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
ModifyGlobalCluster
, modifyGlobalCluster_globalClusterIdentifier
- The identifier for the global cluster being modified. This parameter
isn't case-sensitive.
Constraints:
- Must match the identifier of an existing global cluster.
data ModifyGlobalClusterResponse Source #
See: newModifyGlobalClusterResponse
smart constructor.
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.
RebootDBInstance
data RebootDBInstance Source #
Represents the input to RebootDBInstance.
See: newRebootDBInstance
smart constructor.
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
- When true
, the reboot is conducted through a Multi-AZ failover.
Constraint: You can't specify true
if the instance is not configured
for Multi-AZ.
RebootDBInstance
, rebootDBInstance_dbInstanceIdentifier
- The 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.
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.
RemoveFromGlobalCluster
data RemoveFromGlobalCluster Source #
Represents the input to RemoveFromGlobalCluster.
See: newRemoveFromGlobalCluster
smart constructor.
Instances
newRemoveFromGlobalCluster 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:
RemoveFromGlobalCluster
, removeFromGlobalCluster_globalClusterIdentifier
- The cluster identifier to detach from the Amazon DocumentDB global
cluster.
RemoveFromGlobalCluster
, removeFromGlobalCluster_dbClusterIdentifier
- The Amazon Resource Name (ARN) identifying the cluster that was detached
from the Amazon DocumentDB global cluster.
data RemoveFromGlobalClusterResponse Source #
See: newRemoveFromGlobalClusterResponse
smart constructor.
Instances
Generic RemoveFromGlobalClusterResponse Source # | |
Read RemoveFromGlobalClusterResponse Source # | |
Show RemoveFromGlobalClusterResponse Source # | |
Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster | |
NFData RemoveFromGlobalClusterResponse Source # | |
Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster rnf :: RemoveFromGlobalClusterResponse -> () # | |
Eq RemoveFromGlobalClusterResponse Source # | |
type Rep RemoveFromGlobalClusterResponse Source # | |
Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster type Rep RemoveFromGlobalClusterResponse = D1 ('MetaData "RemoveFromGlobalClusterResponse" "Amazonka.DocumentDB.RemoveFromGlobalCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "RemoveFromGlobalClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GlobalCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
RemoveSourceIdentifierFromSubscription
data RemoveSourceIdentifierFromSubscription Source #
Represents the input to RemoveSourceIdentifierFromSubscription.
See: newRemoveSourceIdentifierFromSubscription
smart constructor.
Instances
newRemoveSourceIdentifierFromSubscription Source #
:: 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 Amazon DocumentDB event notification subscription that
you want to remove a source identifier from.
RemoveSourceIdentifierFromSubscription
, removeSourceIdentifierFromSubscription_sourceIdentifier
- The source identifier to be removed from the subscription, such as the
instance identifier for an instance, or the name of a security group.
data RemoveSourceIdentifierFromSubscriptionResponse Source #
See: newRemoveSourceIdentifierFromSubscriptionResponse
smart constructor.
Instances
Generic RemoveSourceIdentifierFromSubscriptionResponse Source # | |
Read RemoveSourceIdentifierFromSubscriptionResponse Source # | |
Show RemoveSourceIdentifierFromSubscriptionResponse Source # | |
NFData RemoveSourceIdentifierFromSubscriptionResponse Source # | |
Eq RemoveSourceIdentifierFromSubscriptionResponse Source # | |
type Rep RemoveSourceIdentifierFromSubscriptionResponse Source # | |
Defined in Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription type Rep RemoveSourceIdentifierFromSubscriptionResponse = D1 ('MetaData "RemoveSourceIdentifierFromSubscriptionResponse" "Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "RemoveSourceIdentifierFromSubscriptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventSubscription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventSubscription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newRemoveSourceIdentifierFromSubscriptionResponse Source #
:: 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.
RemoveTagsFromResource
data RemoveTagsFromResource Source #
Represents the input to RemoveTagsFromResource.
See: newRemoveTagsFromResource
smart constructor.
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 DocumentDB resource that the tags are removed from. This
value is an Amazon Resource Name (ARN).
$sel:tagKeys:RemoveTagsFromResource'
, removeTagsFromResource_tagKeys
- The tag key (name) of the tag to be removed.
data RemoveTagsFromResourceResponse Source #
See: newRemoveTagsFromResourceResponse
smart constructor.
Instances
newRemoveTagsFromResourceResponse :: RemoveTagsFromResourceResponse Source #
Create a value of RemoveTagsFromResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ResetDBClusterParameterGroup
data ResetDBClusterParameterGroup Source #
Represents the input to ResetDBClusterParameterGroup.
See: newResetDBClusterParameterGroup
smart constructor.
Instances
newResetDBClusterParameterGroup Source #
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:
ResetDBClusterParameterGroup
, resetDBClusterParameterGroup_parameters
- A list of parameter names in the cluster parameter group to reset to the
default values. You can't use this parameter if the
ResetAllParameters
parameter is set to true
.
$sel:resetAllParameters:ResetDBClusterParameterGroup'
, resetDBClusterParameterGroup_resetAllParameters
- A value that is set to true
to reset all parameters in the cluster
parameter group to their default values, and false
otherwise. You
can't use this parameter if there is a list of parameter names
specified for the Parameters
parameter.
ResetDBClusterParameterGroup
, resetDBClusterParameterGroup_dbClusterParameterGroupName
- The name of the cluster parameter group to reset.
data DBClusterParameterGroupNameMessage Source #
Contains the name of a cluster parameter group.
See: newDBClusterParameterGroupNameMessage
smart constructor.
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 a cluster parameter group.
Constraints:
- Must be from 1 to 255 letters or numbers.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
This value is stored as a lowercase string.
RestoreDBClusterFromSnapshot
data RestoreDBClusterFromSnapshot Source #
Represents the input to RestoreDBClusterFromSnapshot.
See: newRestoreDBClusterFromSnapshot
smart constructor.
RestoreDBClusterFromSnapshot' (Maybe [Text]) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Tag]) (Maybe [Text]) Text Text Text |
Instances
newRestoreDBClusterFromSnapshot Source #
:: 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:
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_availabilityZones
- Provides the list of Amazon EC2 Availability Zones that instances in the
restored DB cluster can be created in.
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_dbSubnetGroupName
- The name of the subnet group to use for the new cluster.
Constraints: If provided, must match the name of an existing
DBSubnetGroup
.
Example: mySubnetgroup
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_deletionProtection
- Specifies whether this cluster can be deleted. If DeletionProtection
is enabled, the cluster cannot be deleted unless it is modified and
DeletionProtection
is disabled. DeletionProtection
protects clusters
from being accidentally deleted.
$sel:enableCloudwatchLogsExports:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_enableCloudwatchLogsExports
- A list of log types that must be enabled for exporting to Amazon
CloudWatch Logs.
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_engineVersion
- The version of the database engine to use for the new cluster.
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_kmsKeyId
- The KMS key identifier to use when restoring an encrypted cluster from a
DB snapshot or cluster snapshot.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If you do not specify a value for the KmsKeyId
parameter, then the
following occurs:
- If the snapshot or cluster snapshot in
SnapshotIdentifier
is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot. - If the snapshot or the cluster snapshot in
SnapshotIdentifier
is not encrypted, then the restored DB cluster is not encrypted.
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_port
- The port number on which the new cluster accepts connections.
Constraints: Must be a value from 1150
to 65535
.
Default: The same port as the original cluster.
$sel:tags:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_tags
- The tags to be assigned to the restored cluster.
$sel:vpcSecurityGroupIds:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_vpcSecurityGroupIds
- A list of virtual private cloud (VPC) security groups that the new
cluster will belong to.
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_dbClusterIdentifier
- The name of the cluster to create from the snapshot or cluster snapshot.
This parameter isn't case sensitive.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-snapshot-id
$sel:snapshotIdentifier:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_snapshotIdentifier
- The identifier for the snapshot or cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.
Constraints:
- Must match the identifier of an existing snapshot.
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_engine
- The database engine to use for the new cluster.
Default: The same as source.
Constraint: Must be compatible with the engine of the source.
data RestoreDBClusterFromSnapshotResponse Source #
See: newRestoreDBClusterFromSnapshotResponse
smart constructor.
Instances
newRestoreDBClusterFromSnapshotResponse Source #
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.
RestoreDBClusterToPointInTime
data RestoreDBClusterToPointInTime Source #
Represents the input to RestoreDBClusterToPointInTime.
See: newRestoreDBClusterToPointInTime
smart constructor.
RestoreDBClusterToPointInTime' (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Int) (Maybe ISO8601) (Maybe Text) (Maybe [Tag]) (Maybe Bool) (Maybe [Text]) Text Text |
Instances
newRestoreDBClusterToPointInTime Source #
:: 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:
RestoreDBClusterToPointInTime
, restoreDBClusterToPointInTime_dbSubnetGroupName
- The subnet group name to use for the new cluster.
Constraints: If provided, must match the name of an existing
DBSubnetGroup
.
Example: mySubnetgroup
RestoreDBClusterToPointInTime
, restoreDBClusterToPointInTime_deletionProtection
- Specifies whether this cluster can be deleted. If DeletionProtection
is enabled, the cluster cannot be deleted unless it is modified and
DeletionProtection
is disabled. DeletionProtection
protects clusters
from being accidentally deleted.
$sel:enableCloudwatchLogsExports:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_enableCloudwatchLogsExports
- A list of log types that must be enabled for exporting to Amazon
CloudWatch Logs.
RestoreDBClusterToPointInTime
, restoreDBClusterToPointInTime_kmsKeyId
- The KMS key identifier to use when restoring an encrypted cluster from
an encrypted cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
You can restore to a new cluster and encrypt the new cluster with an KMS
key that is different from the KMS key used to encrypt the source
cluster. The new DB cluster is encrypted with the KMS key identified by
the KmsKeyId
parameter.
If you do not specify a value for the KmsKeyId
parameter, then the
following occurs:
- If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.
- If the cluster is not encrypted, then the restored cluster is not encrypted.
If DBClusterIdentifier
refers to a cluster that is not encrypted, then
the restore request is rejected.
RestoreDBClusterToPointInTime
, restoreDBClusterToPointInTime_port
- The port number on which the new cluster accepts connections.
Constraints: Must be a value from 1150
to 65535
.
Default: The default port for the engine.
$sel:restoreToTime:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_restoreToTime
- The date and time to restore the cluster to.
Valid values: A time in Universal Coordinated Time (UTC) format.
Constraints:
- Must be before the latest restorable time for the instance.
- Must be specified if the
UseLatestRestorableTime
parameter is not provided. - Cannot be specified if the
UseLatestRestorableTime
parameter istrue
. - Cannot be specified if the
RestoreType
parameter iscopy-on-write
.
Example: 2015-03-07T23:45:00Z
$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.
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:tags:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_tags
- The tags to be assigned to the restored cluster.
$sel:useLatestRestorableTime:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_useLatestRestorableTime
- A value that is set to true
to restore the cluster to the latest
restorable backup time, and false
otherwise.
Default: false
Constraints: Cannot be specified if the RestoreToTime
parameter is
provided.
$sel:vpcSecurityGroupIds:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_vpcSecurityGroupIds
- A list of VPC security groups that the new cluster belongs to.
RestoreDBClusterToPointInTime
, restoreDBClusterToPointInTime_dbClusterIdentifier
- The name of the new cluster to be created.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
$sel:sourceDBClusterIdentifier:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_sourceDBClusterIdentifier
- The identifier of the source cluster from which to restore.
Constraints:
- Must match the identifier of an existing
DBCluster
.
data RestoreDBClusterToPointInTimeResponse Source #
See: newRestoreDBClusterToPointInTimeResponse
smart constructor.
Instances
newRestoreDBClusterToPointInTimeResponse Source #
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.
StartDBCluster
data StartDBCluster Source #
See: newStartDBCluster
smart constructor.
Instances
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:
StartDBCluster
, startDBCluster_dbClusterIdentifier
- The identifier of the cluster to restart. Example:
docdb-2019-05-28-15-24-52
data StartDBClusterResponse Source #
See: newStartDBClusterResponse
smart constructor.
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.
StopDBCluster
data StopDBCluster Source #
See: newStopDBCluster
smart constructor.
Instances
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:
StopDBCluster
, stopDBCluster_dbClusterIdentifier
- The identifier of the cluster to stop. Example:
docdb-2019-05-28-15-24-52
data StopDBClusterResponse Source #
See: newStopDBClusterResponse
smart constructor.
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.
Types
ApplyMethod
newtype ApplyMethod Source #
pattern ApplyMethod_Immediate :: ApplyMethod | |
pattern ApplyMethod_Pending_reboot :: ApplyMethod |
Instances
SourceType
newtype SourceType Source #
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
AvailabilityZone
data AvailabilityZone Source #
Information about an Availability Zone.
See: newAvailabilityZone
smart constructor.
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.
Certificate
data Certificate Source #
A certificate authority (CA) certificate for an Amazon Web Services account.
See: newCertificate
smart constructor.
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:certificateArn:Certificate'
, certificate_certificateArn
- The Amazon Resource Name (ARN) for the certificate.
Example: arn:aws:rds:us-east-1::cert:rds-ca-2019
$sel:certificateIdentifier:Certificate'
, certificate_certificateIdentifier
- The unique key that identifies a certificate.
Example: rds-ca-2019
$sel:certificateType:Certificate'
, certificate_certificateType
- The type of the certificate.
Example: CA
$sel:thumbprint:Certificate'
, certificate_thumbprint
- The thumbprint of the certificate.
$sel:validFrom:Certificate'
, certificate_validFrom
- The starting date-time from which the certificate is valid.
Example: 2019-07-31T17:57:09Z
$sel:validTill:Certificate'
, certificate_validTill
- The date-time after which the certificate is no longer valid.
Example: 2024-07-31T17:57:09Z
CloudwatchLogsExportConfiguration
data CloudwatchLogsExportConfiguration Source #
The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster.
The EnableLogTypes
and DisableLogTypes
arrays determine which logs
are exported (or not exported) to CloudWatch Logs. The values within
these arrays depend on the engine that is being used.
See: newCloudwatchLogsExportConfiguration
smart constructor.
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.
DBCluster
Detailed information about a cluster.
See: newDBCluster
smart constructor.
DBCluster' (Maybe [DBClusterRole]) (Maybe [Text]) (Maybe Int) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe [DBClusterMember]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ISO8601) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [VpcSecurityGroupMembership]) |
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:associatedRoles:DBCluster'
, dbCluster_associatedRoles
- Provides a list of the Identity and Access Management (IAM) roles that
are associated with the cluster. (IAM) roles that are associated with a
cluster grant permission for the cluster to access other Amazon Web
Services services on your behalf.
$sel:availabilityZones:DBCluster'
, dbCluster_availabilityZones
- Provides the list of Amazon EC2 Availability Zones that instances in the
cluster can be created in.
$sel:backupRetentionPeriod:DBCluster'
, dbCluster_backupRetentionPeriod
- Specifies the number of days for which automatic snapshots are retained.
$sel:cloneGroupId:DBCluster'
, dbCluster_cloneGroupId
- Identifies the clone group to which the DB cluster is associated.
$sel:clusterCreateTime:DBCluster'
, dbCluster_clusterCreateTime
- Specifies the time when the cluster was created, in Universal
Coordinated Time (UTC).
$sel:dbClusterArn:DBCluster'
, dbCluster_dbClusterArn
- The Amazon Resource Name (ARN) for the cluster.
$sel:dbClusterIdentifier:DBCluster'
, dbCluster_dbClusterIdentifier
- Contains a user-supplied cluster identifier. This identifier is the
unique key that identifies a cluster.
$sel:dbClusterMembers:DBCluster'
, dbCluster_dbClusterMembers
- Provides the list of instances that make up the cluster.
$sel:dbClusterParameterGroup:DBCluster'
, dbCluster_dbClusterParameterGroup
- Specifies the name of the cluster parameter group for the cluster.
$sel:dbSubnetGroup:DBCluster'
, dbCluster_dbSubnetGroup
- Specifies information on the subnet group that is associated with the
cluster, including the name, description, and subnets in the subnet
group.
$sel:dbClusterResourceId:DBCluster'
, dbCluster_dbClusterResourceId
- The Amazon Web Services Region-unique, immutable identifier for the
cluster. This identifier is found in CloudTrail log entries whenever the
KMS key for the cluster is accessed.
$sel:deletionProtection:DBCluster'
, dbCluster_deletionProtection
- Specifies whether this cluster can be deleted. If DeletionProtection
is enabled, the cluster cannot be deleted unless it is modified and
DeletionProtection
is disabled. DeletionProtection
protects clusters
from being accidentally deleted.
$sel:earliestRestorableTime:DBCluster'
, dbCluster_earliestRestorableTime
- The earliest time to which a database can be restored with point-in-time
restore.
$sel:enabledCloudwatchLogsExports:DBCluster'
, dbCluster_enabledCloudwatchLogsExports
- A list of log types that this cluster is configured to export to Amazon
CloudWatch Logs.
$sel:endpoint:DBCluster'
, dbCluster_endpoint
- Specifies the connection endpoint for the primary instance of the
cluster.
$sel:engine:DBCluster'
, dbCluster_engine
- Provides the name of the database engine to be used for this cluster.
$sel:engineVersion:DBCluster'
, dbCluster_engineVersion
- Indicates the database engine version.
$sel:hostedZoneId:DBCluster'
, dbCluster_hostedZoneId
- Specifies the ID that Amazon Route 53 assigns when you create a hosted
zone.
$sel:kmsKeyId:DBCluster'
, dbCluster_kmsKeyId
- If StorageEncrypted
is true
, the KMS key identifier for the
encrypted cluster.
$sel:latestRestorableTime:DBCluster'
, dbCluster_latestRestorableTime
- Specifies the latest time to which a database can be restored with
point-in-time restore.
$sel:masterUsername:DBCluster'
, dbCluster_masterUsername
- Contains the master user name for the cluster.
$sel:multiAZ:DBCluster'
, dbCluster_multiAZ
- Specifies whether the cluster has instances in multiple Availability
Zones.
$sel:percentProgress:DBCluster'
, dbCluster_percentProgress
- Specifies the progress of the operation as a percentage.
$sel:port:DBCluster'
, dbCluster_port
- Specifies the port that the database engine is listening on.
$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:preferredMaintenanceWindow:DBCluster'
, dbCluster_preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC).
$sel:readReplicaIdentifiers:DBCluster'
, dbCluster_readReplicaIdentifiers
- Contains one or more identifiers of the secondary clusters that are
associated with this cluster.
$sel:readerEndpoint:DBCluster'
, dbCluster_readerEndpoint
- The reader endpoint for the cluster. The reader endpoint for a cluster
load balances connections across the Amazon DocumentDB replicas that are
available in a cluster. As clients request new connections to the reader
endpoint, Amazon DocumentDB distributes the connection requests among
the Amazon DocumentDB replicas in the cluster. This functionality can
help balance your read workload across multiple Amazon DocumentDB
replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB 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 Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
$sel:replicationSourceIdentifier:DBCluster'
, dbCluster_replicationSourceIdentifier
- Contains the identifier of the source cluster if this cluster is a
secondary cluster.
DBCluster
, dbCluster_status
- Specifies the current state of this cluster.
$sel:storageEncrypted:DBCluster'
, dbCluster_storageEncrypted
- Specifies whether the cluster is encrypted.
$sel:vpcSecurityGroups:DBCluster'
, dbCluster_vpcSecurityGroups
- Provides a list of virtual private cloud (VPC) security groups that the
cluster belongs to.
DBClusterMember
data DBClusterMember Source #
Contains information about an instance that is part of a 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:dbClusterParameterGroupStatus:DBClusterMember'
, dbClusterMember_dbClusterParameterGroupStatus
- Specifies the status of the cluster parameter group for this member of
the DB cluster.
$sel:dbInstanceIdentifier:DBClusterMember'
, dbClusterMember_dbInstanceIdentifier
- Specifies the instance identifier for this member of the cluster.
$sel:isClusterWriter:DBClusterMember'
, dbClusterMember_isClusterWriter
- A value that is true
if the cluster member is the primary instance for
the cluster and false
otherwise.
$sel:promotionTier:DBClusterMember'
, dbClusterMember_promotionTier
- A value that specifies the order in which an Amazon DocumentDB replica
is promoted to the primary instance after a failure of the existing
primary instance.
DBClusterParameterGroup
data DBClusterParameterGroup Source #
Detailed information about a cluster parameter group.
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 cluster parameter group.
$sel:dbClusterParameterGroupName:DBClusterParameterGroup'
, dbClusterParameterGroup_dbClusterParameterGroupName
- Provides the name of the cluster parameter group.
$sel:dbParameterGroupFamily:DBClusterParameterGroup'
, dbClusterParameterGroup_dbParameterGroupFamily
- Provides the name of the parameter group family that this cluster
parameter group is compatible with.
$sel:description:DBClusterParameterGroup'
, dbClusterParameterGroup_description
- Provides the customer-specified description for this cluster parameter
group.
DBClusterParameterGroupNameMessage
data DBClusterParameterGroupNameMessage Source #
Contains the name of a cluster parameter group.
See: newDBClusterParameterGroupNameMessage
smart constructor.
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 a cluster parameter group.
Constraints:
- Must be from 1 to 255 letters or numbers.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
This value is stored as a lowercase string.
DBClusterRole
data DBClusterRole Source #
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
See: newDBClusterRole
smart constructor.
DBClusterRole' (Maybe Text) (Maybe Text) |
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:roleArn:DBClusterRole'
, dbClusterRole_roleArn
- The Amazon Resource Name (ARN) of the IAMrole that is associated with
the DB cluster.
$sel:status:DBClusterRole'
, dbClusterRole_status
- Describes the state of association between the IAMrole and the cluster.
The Status
property returns one of the following values:
ACTIVE
- The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.PENDING
- The IAMrole ARN is being associated with the cluster.INVALID
- The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.
DBClusterSnapshot
data DBClusterSnapshot Source #
Detailed information about a cluster snapshot.
See: newDBClusterSnapshot
smart constructor.
DBClusterSnapshot' (Maybe [Text]) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) |
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:availabilityZones:DBClusterSnapshot'
, dbClusterSnapshot_availabilityZones
- Provides the list of Amazon EC2 Availability Zones that instances in the
cluster snapshot can be restored in.
$sel:clusterCreateTime:DBClusterSnapshot'
, dbClusterSnapshot_clusterCreateTime
- Specifies the time when the cluster was created, in Universal
Coordinated Time (UTC).
$sel:dbClusterIdentifier:DBClusterSnapshot'
, dbClusterSnapshot_dbClusterIdentifier
- Specifies the cluster identifier of the cluster that this cluster
snapshot was created from.
$sel:dbClusterSnapshotArn:DBClusterSnapshot'
, dbClusterSnapshot_dbClusterSnapshotArn
- The Amazon Resource Name (ARN) for the cluster snapshot.
$sel:dbClusterSnapshotIdentifier:DBClusterSnapshot'
, dbClusterSnapshot_dbClusterSnapshotIdentifier
- Specifies the identifier for the cluster snapshot.
$sel:engine:DBClusterSnapshot'
, dbClusterSnapshot_engine
- Specifies the name of the database engine.
$sel:engineVersion:DBClusterSnapshot'
, dbClusterSnapshot_engineVersion
- Provides the version of the database engine for this cluster snapshot.
$sel:kmsKeyId:DBClusterSnapshot'
, dbClusterSnapshot_kmsKeyId
- If StorageEncrypted
is true
, the KMS key identifier for the
encrypted cluster snapshot.
$sel:masterUsername:DBClusterSnapshot'
, dbClusterSnapshot_masterUsername
- Provides the master user name for the cluster snapshot.
$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 cluster was listening on at the time of the
snapshot.
$sel:snapshotCreateTime:DBClusterSnapshot'
, dbClusterSnapshot_snapshotCreateTime
- Provides the time when the snapshot was taken, in UTC.
$sel:snapshotType:DBClusterSnapshot'
, dbClusterSnapshot_snapshotType
- Provides the type of the cluster snapshot.
$sel:sourceDBClusterSnapshotArn:DBClusterSnapshot'
, dbClusterSnapshot_sourceDBClusterSnapshotArn
- If the cluster snapshot was copied from a source cluster snapshot, the
ARN for the source cluster snapshot; otherwise, a null value.
$sel:status:DBClusterSnapshot'
, dbClusterSnapshot_status
- Specifies the status of this cluster snapshot.
$sel:storageEncrypted:DBClusterSnapshot'
, dbClusterSnapshot_storageEncrypted
- Specifies whether the cluster snapshot is encrypted.
$sel:vpcId:DBClusterSnapshot'
, dbClusterSnapshot_vpcId
- Provides the virtual private cloud (VPC) ID that is associated with the
cluster snapshot.
DBClusterSnapshotAttribute
data DBClusterSnapshotAttribute Source #
Contains the name and values of a manual cluster snapshot attribute.
Manual cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual cluster snapshot.
See: newDBClusterSnapshotAttribute
smart constructor.
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:attributeName:DBClusterSnapshotAttribute'
, dbClusterSnapshotAttribute_attributeName
- The name of the manual 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 cluster
snapshot.
$sel:attributeValues:DBClusterSnapshotAttribute'
, dbClusterSnapshotAttribute_attributeValues
- The values for the manual 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 cluster snapshot. If a value of
all
is in the list, then the manual cluster snapshot is public and
available for any Amazon Web Services account to copy or restore.
DBClusterSnapshotAttributesResult
data DBClusterSnapshotAttributesResult Source #
Detailed information about the attributes that are associated with a cluster snapshot.
See: newDBClusterSnapshotAttributesResult
smart constructor.
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:dbClusterSnapshotAttributes:DBClusterSnapshotAttributesResult'
, dbClusterSnapshotAttributesResult_dbClusterSnapshotAttributes
- The list of attributes and values for the cluster snapshot.
$sel:dbClusterSnapshotIdentifier:DBClusterSnapshotAttributesResult'
, dbClusterSnapshotAttributesResult_dbClusterSnapshotIdentifier
- The identifier of the cluster snapshot that the attributes apply to.
DBEngineVersion
data DBEngineVersion Source #
Detailed information about an engine version.
See: newDBEngineVersion
smart constructor.
DBEngineVersion' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe [UpgradeTarget]) |
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:dbEngineDescription:DBEngineVersion'
, dbEngineVersion_dbEngineDescription
- The description of the database engine.
$sel:dbEngineVersionDescription:DBEngineVersion'
, dbEngineVersion_dbEngineVersionDescription
- The description of the database engine version.
$sel:dbParameterGroupFamily:DBEngineVersion'
, dbEngineVersion_dbParameterGroupFamily
- The name of the parameter group family for the database engine.
DBEngineVersion
, dbEngineVersion_engine
- The name of the database engine.
DBEngineVersion
, dbEngineVersion_engineVersion
- The version number of the database engine.
$sel:exportableLogTypes:DBEngineVersion'
, dbEngineVersion_exportableLogTypes
- The types of logs that the database engine has available for export to
Amazon CloudWatch Logs.
$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:validUpgradeTarget:DBEngineVersion'
, dbEngineVersion_validUpgradeTarget
- A list of engine versions that this database engine version can be
upgraded to.
DBInstance
data DBInstance Source #
Detailed information about an instance.
See: newDBInstance
smart constructor.
DBInstance' (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DBSubnetGroup) (Maybe Text) (Maybe [Text]) (Maybe Endpoint) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe PendingModifiedValues) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe [DBInstanceStatusInfo]) (Maybe Bool) (Maybe [VpcSecurityGroupMembership]) |
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:autoMinorVersionUpgrade:DBInstance'
, dbInstance_autoMinorVersionUpgrade
- Does not apply. This parameter does not apply to Amazon DocumentDB.
Amazon DocumentDB does not perform minor version upgrades regardless of
the value set.
$sel:availabilityZone:DBInstance'
, dbInstance_availabilityZone
- Specifies the name of the Availability Zone that the instance is located
in.
DBInstance
, dbInstance_backupRetentionPeriod
- Specifies the number of days for which automatic snapshots are retained.
DBInstance
, dbInstance_cACertificateIdentifier
- The identifier of the CA certificate for this DB instance.
$sel:copyTagsToSnapshot:DBInstance'
, dbInstance_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.
$sel:dbClusterIdentifier:DBInstance'
, dbInstance_dbClusterIdentifier
- Contains the name of the cluster that the instance is a member of if the
instance is a member of a cluster.
$sel:dbInstanceArn:DBInstance'
, dbInstance_dbInstanceArn
- The Amazon Resource Name (ARN) for the instance.
DBInstance
, dbInstance_dbInstanceClass
- Contains the name of the compute and memory capacity class of the
instance.
DBInstance
, dbInstance_dbInstanceIdentifier
- Contains a user-provided database identifier. This identifier is the
unique key that identifies an instance.
$sel:dbInstanceStatus:DBInstance'
, dbInstance_dbInstanceStatus
- Specifies the current state of this database.
$sel:dbSubnetGroup:DBInstance'
, dbInstance_dbSubnetGroup
- Specifies information on the subnet group that is associated with the
instance, including the name, description, and subnets in the subnet
group.
$sel:dbiResourceId:DBInstance'
, dbInstance_dbiResourceId
- The Amazon Web Services Region-unique, immutable identifier for the
instance. This identifier is found in CloudTrail log entries whenever
the KMS key for the instance is accessed.
$sel:enabledCloudwatchLogsExports:DBInstance'
, dbInstance_enabledCloudwatchLogsExports
- A list of log types that this instance is configured to export to
CloudWatch Logs.
$sel:endpoint:DBInstance'
, dbInstance_endpoint
- Specifies the connection endpoint.
$sel:engine:DBInstance'
, dbInstance_engine
- Provides the name of the database engine to be used for this instance.
DBInstance
, dbInstance_engineVersion
- Indicates the database engine version.
$sel:instanceCreateTime:DBInstance'
, dbInstance_instanceCreateTime
- Provides the date and time that the instance was created.
$sel:kmsKeyId:DBInstance'
, dbInstance_kmsKeyId
- If StorageEncrypted
is true
, the KMS key identifier for the
encrypted instance.
$sel:latestRestorableTime:DBInstance'
, dbInstance_latestRestorableTime
- Specifies the latest time to which a database can be restored with
point-in-time restore.
$sel:pendingModifiedValues:DBInstance'
, dbInstance_pendingModifiedValues
- Specifies that changes to the instance are pending. This element is
included only when changes are pending. Specific changes are identified
by subelements.
$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:preferredMaintenanceWindow:DBInstance'
, dbInstance_preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC).
$sel:promotionTier:DBInstance'
, dbInstance_promotionTier
- A value that specifies the order in which an Amazon DocumentDB replica
is promoted to the primary instance after a failure of the existing
primary instance.
$sel:publiclyAccessible:DBInstance'
, dbInstance_publiclyAccessible
- Not supported. Amazon DocumentDB does not currently support public
endpoints. The value of PubliclyAccessible
is always false
.
$sel:statusInfos:DBInstance'
, dbInstance_statusInfos
- The status of a read replica. If the instance is not a read replica,
this is blank.
$sel:storageEncrypted:DBInstance'
, dbInstance_storageEncrypted
- Specifies whether or not the instance is encrypted.
$sel:vpcSecurityGroups:DBInstance'
, dbInstance_vpcSecurityGroups
- Provides a list of VPC security group elements that the instance belongs
to.
DBInstanceStatusInfo
data DBInstanceStatusInfo Source #
Provides a list of status information for an 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:message:DBInstanceStatusInfo'
, dbInstanceStatusInfo_message
- Details of the error if there is an error for the instance. If the
instance is not in an error state, this value is blank.
$sel:normal:DBInstanceStatusInfo'
, dbInstanceStatusInfo_normal
- A Boolean value that is true
if the instance is operating normally, or
false
if the instance is in an error state.
$sel:status:DBInstanceStatusInfo'
, dbInstanceStatusInfo_status
- Status of the instance. For a StatusType
of read replica, the values
can be replicating
, error, stopped
, or terminated
.
$sel:statusType:DBInstanceStatusInfo'
, dbInstanceStatusInfo_statusType
- This value is currently "read replication
."
DBSubnetGroup
data DBSubnetGroup Source #
Detailed information about a subnet group.
See: newDBSubnetGroup
smart constructor.
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:dbSubnetGroupArn:DBSubnetGroup'
, dbSubnetGroup_dbSubnetGroupArn
- The Amazon Resource Name (ARN) for the DB subnet group.
$sel:dbSubnetGroupDescription:DBSubnetGroup'
, dbSubnetGroup_dbSubnetGroupDescription
- Provides the description of the subnet group.
$sel:dbSubnetGroupName:DBSubnetGroup'
, dbSubnetGroup_dbSubnetGroupName
- The name of the subnet group.
$sel:subnetGroupStatus:DBSubnetGroup'
, dbSubnetGroup_subnetGroupStatus
- Provides the status of the subnet group.
$sel:subnets:DBSubnetGroup'
, dbSubnetGroup_subnets
- Detailed information about one or more subnets within a subnet group.
$sel:vpcId:DBSubnetGroup'
, dbSubnetGroup_vpcId
- Provides the virtual private cloud (VPC) ID of the subnet group.
Endpoint
Network information for accessing a cluster or instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.
See: newEndpoint
smart constructor.
Instances
FromXML Endpoint Source # | |
Generic Endpoint Source # | |
Read Endpoint Source # | |
Show Endpoint Source # | |
NFData Endpoint Source # | |
Defined in Amazonka.DocumentDB.Types.Endpoint | |
Eq Endpoint Source # | |
Hashable Endpoint Source # | |
Defined in Amazonka.DocumentDB.Types.Endpoint | |
type Rep Endpoint Source # | |
Defined in Amazonka.DocumentDB.Types.Endpoint type Rep Endpoint = D1 ('MetaData "Endpoint" "Amazonka.DocumentDB.Types.Endpoint" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "Endpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "hostedZoneId") '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:address:Endpoint'
, endpoint_address
- Specifies the DNS address of the instance.
$sel:hostedZoneId:Endpoint'
, endpoint_hostedZoneId
- Specifies the ID that Amazon Route 53 assigns when you create a hosted
zone.
$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
DescribeEngineDefaultClusterParameters
operation.
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
- The name of the cluster parameter group family to return the engine
parameter information for.
$sel:marker:EngineDefaults'
, engineDefaults_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:EngineDefaults'
, engineDefaults_parameters
- The parameters of a particular cluster parameter group family.
Event
Detailed information about an event.
See: newEvent
smart constructor.
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: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.
$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:sourceType:Event'
, event_sourceType
- Specifies the source type for this event.
EventCategoriesMap
data EventCategoriesMap Source #
An event source type, accompanied by one or more event category names.
See: newEventCategoriesMap
smart constructor.
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:eventCategories:EventCategoriesMap'
, eventCategoriesMap_eventCategories
- The event categories for the specified source type.
$sel:sourceType:EventCategoriesMap'
, eventCategoriesMap_sourceType
- The source type that the returned categories belong to.
EventSubscription
data EventSubscription Source #
Detailed information about an event to which you have subscribed.
See: newEventSubscription
smart constructor.
EventSubscription' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (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:custSubscriptionId:EventSubscription'
, eventSubscription_custSubscriptionId
- The Amazon DocumentDB event notification subscription ID.
$sel:customerAwsId:EventSubscription'
, eventSubscription_customerAwsId
- The Amazon Web Services customer account that is associated with the
Amazon DocumentDB event notification subscription.
$sel:enabled:EventSubscription'
, eventSubscription_enabled
- A Boolean value indicating whether the subscription is enabled. A value
of true
indicates that the subscription is enabled.
$sel:eventCategoriesList:EventSubscription'
, eventSubscription_eventCategoriesList
- A list of event categories for the Amazon DocumentDB event notification
subscription.
$sel:eventSubscriptionArn:EventSubscription'
, eventSubscription_eventSubscriptionArn
- The Amazon Resource Name (ARN) for the event subscription.
$sel:snsTopicArn:EventSubscription'
, eventSubscription_snsTopicArn
- The topic ARN of the Amazon DocumentDB event notification subscription.
$sel:sourceIdsList:EventSubscription'
, eventSubscription_sourceIdsList
- A list of source IDs for the Amazon DocumentDB event notification
subscription.
$sel:sourceType:EventSubscription'
, eventSubscription_sourceType
- The source type for the Amazon DocumentDB event notification
subscription.
$sel:status:EventSubscription'
, eventSubscription_status
- The status of the Amazon DocumentDB event notification subscription.
Constraints:
Can be one of the following: creating
, modifying
, deleting
,
active
, no-permission
, topic-not-exist
The no-permission
status indicates that Amazon DocumentDB no longer
has permission to post to the SNS topic. The topic-not-exist
status
indicates that the topic was deleted after the subscription was created.
$sel:subscriptionCreationTime:EventSubscription'
, eventSubscription_subscriptionCreationTime
- The time at which the Amazon DocumentDB event notification subscription
was created.
Filter
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
See: newFilter
smart constructor.
Instances
ToQuery Filter Source # | |
Defined in Amazonka.DocumentDB.Types.Filter toQuery :: Filter -> QueryString # | |
Generic Filter Source # | |
Read Filter Source # | |
Show Filter Source # | |
NFData Filter Source # | |
Defined in Amazonka.DocumentDB.Types.Filter | |
Eq Filter Source # | |
Hashable Filter Source # | |
Defined in Amazonka.DocumentDB.Types.Filter | |
type Rep Filter Source # | |
Defined in Amazonka.DocumentDB.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.DocumentDB.Types.Filter" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 Amazon DocumentDB global cluster.
See: newGlobalCluster
smart constructor.
GlobalCluster' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [GlobalClusterMember]) (Maybe Text) (Maybe Text) (Maybe Bool) |
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:databaseName:GlobalCluster'
, globalCluster_databaseName
- The default database name within the new global cluster.
$sel:deletionProtection:GlobalCluster'
, globalCluster_deletionProtection
- The deletion protection setting for the new global cluster.
$sel:engine:GlobalCluster'
, globalCluster_engine
- The Amazon DocumentDB database engine used by the global cluster.
$sel:engineVersion:GlobalCluster'
, globalCluster_engineVersion
- Indicates the database engine version.
$sel:globalClusterArn:GlobalCluster'
, globalCluster_globalClusterArn
- The Amazon Resource Name (ARN) for the global cluster.
$sel:globalClusterIdentifier:GlobalCluster'
, globalCluster_globalClusterIdentifier
- Contains a user-supplied global cluster identifier. This identifier is
the unique key that identifies a global cluster.
$sel:globalClusterMembers:GlobalCluster'
, globalCluster_globalClusterMembers
- The list of cluster IDs for secondary clusters within the global
cluster. Currently limited to one item.
$sel:globalClusterResourceId:GlobalCluster'
, globalCluster_globalClusterResourceId
- The Amazon Web Services Region-unique, immutable identifier for the
global database cluster. This identifier is found in AWS CloudTrail log
entries whenever the AWS KMS customer master key (CMK) for the cluster
is accessed.
$sel:status:GlobalCluster'
, globalCluster_status
- Specifies the current state of this global cluster.
$sel:storageEncrypted:GlobalCluster'
, globalCluster_storageEncrypted
- The storage encryption setting for the global cluster.
GlobalClusterMember
data GlobalClusterMember Source #
A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
See: newGlobalClusterMember
smart constructor.
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:dbClusterArn:GlobalClusterMember'
, globalClusterMember_dbClusterArn
- The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.
$sel:isWriter:GlobalClusterMember'
, globalClusterMember_isWriter
- Specifies whether the Amazon DocumentDB cluster is the primary cluster
(that is, has read-write capability) for the Amazon DocumentDB global
cluster with which it is associated.
$sel:readers:GlobalClusterMember'
, globalClusterMember_readers
- The Amazon Resource Name (ARN) for each read-only secondary cluster
associated with the Aurora global cluster.
OrderableDBInstanceOption
data OrderableDBInstanceOption Source #
The options that are available for an instance.
See: newOrderableDBInstanceOption
smart constructor.
OrderableDBInstanceOption' (Maybe [AvailabilityZone]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) |
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:availabilityZones:OrderableDBInstanceOption'
, orderableDBInstanceOption_availabilityZones
- A list of Availability Zones for an instance.
$sel:dbInstanceClass:OrderableDBInstanceOption'
, orderableDBInstanceOption_dbInstanceClass
- The instance class for an instance.
$sel:engine:OrderableDBInstanceOption'
, orderableDBInstanceOption_engine
- The engine type of an instance.
$sel:engineVersion:OrderableDBInstanceOption'
, orderableDBInstanceOption_engineVersion
- The engine version of an instance.
$sel:licenseModel:OrderableDBInstanceOption'
, orderableDBInstanceOption_licenseModel
- The license model for an instance.
$sel:vpc:OrderableDBInstanceOption'
, orderableDBInstanceOption_vpc
- Indicates whether an instance is in a virtual private cloud (VPC).
Parameter
Detailed information about an individual parameter.
See: newParameter
smart constructor.
Parameter' (Maybe Text) (Maybe ApplyMethod) (Maybe Text) (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:allowedValues:Parameter'
, parameter_allowedValues
- Specifies the valid range of values for the parameter.
$sel:applyMethod:Parameter'
, parameter_applyMethod
- Indicates when to apply parameter updates.
$sel:applyType:Parameter'
, parameter_applyType
- Specifies the engine-specific parameters type.
$sel:dataType:Parameter'
, parameter_dataType
- Specifies the valid data type for the parameter.
$sel:description:Parameter'
, parameter_description
- Provides a description of the parameter.
$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:minimumEngineVersion:Parameter'
, parameter_minimumEngineVersion
- The earliest engine version to which the parameter can apply.
$sel:parameterName:Parameter'
, parameter_parameterName
- Specifies the name of the parameter.
$sel:parameterValue:Parameter'
, parameter_parameterValue
- Specifies the value of the parameter.
$sel:source:Parameter'
, parameter_source
- Indicates the source of the parameter value.
PendingCloudwatchLogsExports
data PendingCloudwatchLogsExports Source #
A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
See: newPendingCloudwatchLogsExports
smart constructor.
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:logTypesToDisable:PendingCloudwatchLogsExports'
, pendingCloudwatchLogsExports_logTypesToDisable
- Log types that are in the process of being enabled. After they are
enabled, these log types are exported to Amazon CloudWatch Logs.
$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.
PendingMaintenanceAction
data PendingMaintenanceAction Source #
Provides information about a pending maintenance action for a resource.
See: newPendingMaintenanceAction
smart constructor.
PendingMaintenanceAction' (Maybe Text) (Maybe ISO8601) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe Text) |
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:action:PendingMaintenanceAction'
, pendingMaintenanceAction_action
- The type of pending maintenance action that is available for the
resource.
$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. If this date is specified, any
next-maintenance
opt-in requests are ignored.
$sel:currentApplyDate:PendingMaintenanceAction'
, pendingMaintenanceAction_currentApplyDate
- The effective date when the pending maintenance action is applied to 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. The
maintenance action is applied to the resource on this date regardless of
the maintenance window for the resource. If this date is specified, any
immediate
opt-in requests are ignored.
$sel:optInStatus:PendingMaintenanceAction'
, pendingMaintenanceAction_optInStatus
- Indicates the type of opt-in request that has been received for the
resource.
PendingModifiedValues
data PendingModifiedValues Source #
One or more modified settings for an instance. These modified settings have been requested, but haven't been applied yet.
See: newPendingModifiedValues
smart constructor.
PendingModifiedValues' (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe PendingCloudwatchLogsExports) (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:allocatedStorage:PendingModifiedValues'
, pendingModifiedValues_allocatedStorage
- Contains the new AllocatedStorage
size for then instance that will be
applied or is currently being applied.
$sel:backupRetentionPeriod:PendingModifiedValues'
, pendingModifiedValues_backupRetentionPeriod
- Specifies the pending number of days for which automated backups are
retained.
$sel:cACertificateIdentifier:PendingModifiedValues'
, pendingModifiedValues_cACertificateIdentifier
- Specifies the identifier of the certificate authority (CA) certificate
for the DB instance.
$sel:dbInstanceClass:PendingModifiedValues'
, pendingModifiedValues_dbInstanceClass
- Contains the new DBInstanceClass
for the instance that will be applied
or is currently being applied.
$sel:dbInstanceIdentifier:PendingModifiedValues'
, pendingModifiedValues_dbInstanceIdentifier
- Contains the new DBInstanceIdentifier
for the instance that will be
applied or is currently being applied.
$sel:dbSubnetGroupName:PendingModifiedValues'
, pendingModifiedValues_dbSubnetGroupName
- The new subnet group for the instance.
$sel:engineVersion:PendingModifiedValues'
, pendingModifiedValues_engineVersion
- Indicates the database engine version.
$sel:iops:PendingModifiedValues'
, pendingModifiedValues_iops
- Specifies the new Provisioned IOPS value for the instance that will be
applied or is currently being applied.
$sel:licenseModel:PendingModifiedValues'
, pendingModifiedValues_licenseModel
- The license model for the instance.
Valid values: license-included
, bring-your-own-license
,
general-public-license
$sel:masterUserPassword:PendingModifiedValues'
, pendingModifiedValues_masterUserPassword
- Contains the pending or currently in-progress change of the master
credentials for the instance.
$sel:multiAZ:PendingModifiedValues'
, pendingModifiedValues_multiAZ
- Indicates that the Single-AZ instance is to change to a Multi-AZ
deployment.
$sel:pendingCloudwatchLogsExports:PendingModifiedValues'
, pendingModifiedValues_pendingCloudwatchLogsExports
- A list of the log types whose configuration is still pending. These log
types are in the process of being activated or deactivated.
$sel:port:PendingModifiedValues'
, pendingModifiedValues_port
- Specifies the pending port for the instance.
$sel:storageType:PendingModifiedValues'
, pendingModifiedValues_storageType
- Specifies the storage type to be associated with the instance.
ResourcePendingMaintenanceActions
data ResourcePendingMaintenanceActions Source #
Represents the output of ApplyPendingMaintenanceAction.
See: newResourcePendingMaintenanceActions
smart constructor.
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 Amazon Resource Name (ARN) of the resource that has pending
maintenance actions.
Subnet
Detailed information about a subnet.
See: newSubnet
smart constructor.
Instances
FromXML Subnet Source # | |
Generic Subnet Source # | |
Read Subnet Source # | |
Show Subnet Source # | |
NFData Subnet Source # | |
Defined in Amazonka.DocumentDB.Types.Subnet | |
Eq Subnet Source # | |
Hashable Subnet Source # | |
Defined in Amazonka.DocumentDB.Types.Subnet | |
type Rep Subnet Source # | |
Defined in Amazonka.DocumentDB.Types.Subnet type Rep Subnet = D1 ('MetaData "Subnet" "Amazonka.DocumentDB.Types.Subnet" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "Subnet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subnetAvailabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AvailabilityZone)) :*: (S1 ('MetaSel ('Just "subnetIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subnetStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) |
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:subnetAvailabilityZone:Subnet'
, subnet_subnetAvailabilityZone
- Specifies the Availability Zone for the subnet.
$sel:subnetIdentifier:Subnet'
, subnet_subnetIdentifier
- Specifies the identifier of the subnet.
$sel:subnetStatus:Subnet'
, subnet_subnetStatus
- Specifies the status of the subnet.
Tag
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
See: newTag
smart constructor.
Instances
ToQuery Tag Source # | |
Defined in Amazonka.DocumentDB.Types.Tag toQuery :: Tag -> QueryString # | |
FromXML Tag Source # | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.DocumentDB.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.DocumentDB.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.DocumentDB.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.DocumentDB.Types.Tag" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") '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:key:Tag'
, tag_key
- 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 contain only the set of Unicode letters,
digits, white space, '_', '.', '/', '=', '+', '-' (Java
regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
$sel:value:Tag'
, tag_value
- 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 contain only the set of Unicode letters,
digits, white space, '_', '.', '/', '=', '+', '-' (Java
regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
UpgradeTarget
data UpgradeTarget Source #
The version of the database engine that an instance can be upgraded to.
See: newUpgradeTarget
smart constructor.
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: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:description:UpgradeTarget'
, upgradeTarget_description
- The version of the database engine that an instance can be upgraded to.
$sel:engine:UpgradeTarget'
, upgradeTarget_engine
- The name of the upgrade target database engine.
$sel:engineVersion:UpgradeTarget'
, upgradeTarget_engineVersion
- The version number of the upgrade target database engine.
$sel:isMajorVersionUpgrade:UpgradeTarget'
, upgradeTarget_isMajorVersionUpgrade
- A value that indicates whether a database engine is upgraded to a major
version.
VpcSecurityGroupMembership
data VpcSecurityGroupMembership Source #
Used as a response element for queries on virtual private cloud (VPC) security group membership.
See: newVpcSecurityGroupMembership
smart constructor.
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.