Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Service Configuration
- Errors
- InvalidDBParameterGroupStateFault
- SourceNotFoundFault
- CertificateNotFoundFault
- DBClusterSnapshotAlreadyExistsFault
- DBParameterGroupAlreadyExistsFault
- DBParameterGroupQuotaExceededFault
- InsufficientDBClusterCapacityFault
- ProvisionedIopsNotAvailableInAZFault
- SubscriptionCategoryNotFoundFault
- SubscriptionNotFoundFault
- InvalidSubnet
- SharedSnapshotQuotaExceededFault
- DBSubnetQuotaExceededFault
- OptionGroupNotFoundFault
- DBClusterNotFoundFault
- DBClusterAlreadyExistsFault
- StorageTypeNotSupportedFault
- SNSTopicArnNotFoundFault
- InvalidDBClusterEndpointStateFault
- InvalidEventSubscriptionStateFault
- KMSKeyNotAccessibleFault
- DBSnapshotNotFoundFault
- DBClusterParameterGroupNotFoundFault
- DBClusterQuotaExceededFault
- SnapshotQuotaExceededFault
- DBSubnetGroupAlreadyExistsFault
- SNSNoAuthorizationFault
- DBSecurityGroupNotFoundFault
- InstanceQuotaExceededFault
- DomainNotFoundFault
- DBParameterGroupNotFoundFault
- InvalidDBSubnetStateFault
- DBClusterSnapshotNotFoundFault
- SNSInvalidTopicFault
- InsufficientDBInstanceCapacityFault
- InvalidDBClusterSnapshotStateFault
- SubscriptionAlreadyExistFault
- DBClusterRoleAlreadyExistsFault
- DBClusterRoleQuotaExceededFault
- InvalidVPCNetworkStateFault
- AuthorizationNotFoundFault
- DBSubnetGroupQuotaExceededFault
- EventSubscriptionQuotaExceededFault
- InsufficientStorageClusterCapacityFault
- DBClusterEndpointQuotaExceededFault
- InvalidDBClusterStateFault
- DBInstanceAlreadyExistsFault
- InvalidRestoreFault
- InvalidDBSecurityGroupStateFault
- ResourceNotFoundFault
- DBSubnetGroupNotFoundFault
- DBUpgradeDependencyFailureFault
- InvalidDBInstanceStateFault
- DBClusterEndpointAlreadyExistsFault
- DBSnapshotAlreadyExistsFault
- DBInstanceNotFoundFault
- StorageQuotaExceededFault
- InvalidDBSnapshotStateFault
- InvalidDBSubnetGroupStateFault
- DBClusterEndpointNotFoundFault
- DBSubnetGroupDoesNotCoverEnoughAZs
- SubnetAlreadyInUse
- DBClusterRoleNotFoundFault
- Waiters
- Operations
- StartDBCluster
- DescribeDBClusterParameterGroups (Paginated)
- DescribeDBEngineVersions (Paginated)
- ModifyDBClusterEndpoint
- AddSourceIdentifierToSubscription
- ModifyDBInstance
- ModifyEventSubscription
- ResetDBClusterParameterGroup
- DescribeEvents (Paginated)
- DescribeEngineDefaultParameters (Paginated)
- DescribeDBClusters (Paginated)
- ModifyDBSubnetGroup
- ListTagsForResource
- DeleteDBCluster
- CopyDBParameterGroup
- RemoveSourceIdentifierFromSubscription
- DescribeEngineDefaultClusterParameters
- PromoteReadReplicaDBCluster
- RemoveTagsFromResource
- CreateEventSubscription
- CreateDBInstance
- DeleteDBClusterParameterGroup
- CreateDBClusterEndpoint
- RestoreDBClusterFromSnapshot
- DescribeOrderableDBInstanceOptions (Paginated)
- DeleteDBClusterEndpoint
- CreateDBClusterParameterGroup
- DeleteEventSubscription
- DescribeDBParameterGroups (Paginated)
- DeleteDBClusterSnapshot
- DescribeValidDBInstanceModifications
- DescribeDBClusterEndpoints (Paginated)
- DescribeEventSubscriptions (Paginated)
- AddTagsToResource
- DescribeDBParameters (Paginated)
- CreateDBClusterSnapshot
- DescribeDBSubnetGroups (Paginated)
- StopDBCluster
- CreateDBParameterGroup
- ModifyDBClusterSnapshotAttribute
- ModifyDBCluster
- CopyDBClusterParameterGroup
- DescribeEventCategories
- ModifyDBClusterParameterGroup
- DescribeDBClusterSnapshotAttributes
- DescribePendingMaintenanceActions (Paginated)
- AddRoleToDBCluster
- CopyDBClusterSnapshot
- ResetDBParameterGroup
- CreateDBCluster
- RemoveRoleFromDBCluster
- FailoverDBCluster
- ModifyDBParameterGroup
- ApplyPendingMaintenanceAction
- DescribeDBClusterParameters (Paginated)
- DeleteDBSubnetGroup
- DescribeDBClusterSnapshots (Paginated)
- RebootDBInstance
- CreateDBSubnetGroup
- DeleteDBInstance
- DeleteDBParameterGroup
- RestoreDBClusterToPointInTime
- DescribeDBInstances (Paginated)
- Types
- ApplyMethod
- SourceType
- AvailabilityZone
- CharacterSet
- CloudwatchLogsExportConfiguration
- DBCluster
- DBClusterEndpoint
- DBClusterMember
- DBClusterOptionGroupStatus
- DBClusterParameterGroup
- DBClusterParameterGroupNameMessage
- DBClusterRole
- DBClusterSnapshot
- DBClusterSnapshotAttribute
- DBClusterSnapshotAttributesResult
- DBEngineVersion
- DBInstance
- DBInstanceStatusInfo
- DBParameterGroup
- DBParameterGroupNameMessage
- DBParameterGroupStatus
- DBSecurityGroupMembership
- DBSubnetGroup
- DomainMembership
- DoubleRange
- Endpoint
- EngineDefaults
- Event
- EventCategoriesMap
- EventSubscription
- Filter
- OptionGroupMembership
- OrderableDBInstanceOption
- Parameter
- PendingCloudwatchLogsExports
- PendingMaintenanceAction
- PendingModifiedValues
- Range
- ResourcePendingMaintenanceActions
- Subnet
- Tag
- Timezone
- UpgradeTarget
- ValidDBInstanceModificationsMessage
- ValidStorageOptions
- VpcSecurityGroupMembership
Derived from API version 2014-10-31
of the AWS service descriptions, licensed under Apache 2.0.
Amazon Neptune
Amazon Neptune is a fast, reliable, fully-managed graph database service that makes it easy to build and run applications that work with highly connected datasets. The core of Amazon Neptune is a purpose-built, high-performance graph database engine optimized for storing billions of relationships and querying the graph with milliseconds latency. Amazon Neptune supports popular graph models Property Graph and W3C's RDF, and their respective query languages Apache TinkerPop Gremlin and SPARQL, allowing you to easily build queries that efficiently navigate highly connected datasets. Neptune powers graph use cases such as recommendation engines, fraud detection, knowledge graphs, drug discovery, and network security.
This interface reference for Amazon Neptune contains documentation for a programming or command line interface you can use to manage Amazon Neptune. Note that Amazon Neptune is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.
Synopsis
- defaultService :: Service
- _InvalidDBParameterGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SourceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CertificateNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterSnapshotAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBParameterGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBParameterGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientDBClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ProvisionedIopsNotAvailableInAZFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SubscriptionCategoryNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SubscriptionNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSubnet :: AsError a => Getting (First ServiceError) a ServiceError
- _SharedSnapshotQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSubnetQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _OptionGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _StorageTypeNotSupportedFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SNSTopicArnNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBClusterEndpointStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidEventSubscriptionStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSKeyNotAccessibleFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSnapshotNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterParameterGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SnapshotQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSubnetGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SNSNoAuthorizationFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSecurityGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InstanceQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DomainNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBParameterGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBSubnetStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterSnapshotNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SNSInvalidTopicFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientDBInstanceCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBClusterSnapshotStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SubscriptionAlreadyExistFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterRoleAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterRoleQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidVPCNetworkStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _AuthorizationNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSubnetGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _EventSubscriptionQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientStorageClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterEndpointQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBClusterStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBInstanceAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidRestoreFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBSecurityGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSubnetGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBUpgradeDependencyFailureFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBInstanceStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterEndpointAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSnapshotAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBInstanceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _StorageQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBSnapshotStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDBSubnetGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterEndpointNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DBSubnetGroupDoesNotCoverEnoughAZs :: AsError a => Getting (First ServiceError) a ServiceError
- _SubnetAlreadyInUse :: AsError a => Getting (First ServiceError) a ServiceError
- _DBClusterRoleNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- newDBInstanceAvailable :: Wait DescribeDBInstances
- newDBInstanceDeleted :: Wait DescribeDBInstances
- data StartDBCluster = StartDBCluster' Text
- newStartDBCluster :: Text -> StartDBCluster
- data StartDBClusterResponse = StartDBClusterResponse' (Maybe DBCluster) Int
- newStartDBClusterResponse :: Int -> StartDBClusterResponse
- data DescribeDBClusterParameterGroups = DescribeDBClusterParameterGroups' (Maybe [Filter]) (Maybe Text) (Maybe Int) (Maybe Text)
- newDescribeDBClusterParameterGroups :: DescribeDBClusterParameterGroups
- data DescribeDBClusterParameterGroupsResponse = DescribeDBClusterParameterGroupsResponse' (Maybe Text) (Maybe [DBClusterParameterGroup]) Int
- newDescribeDBClusterParameterGroupsResponse :: Int -> DescribeDBClusterParameterGroupsResponse
- data DescribeDBEngineVersions = DescribeDBEngineVersions' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Int)
- newDescribeDBEngineVersions :: DescribeDBEngineVersions
- data DescribeDBEngineVersionsResponse = DescribeDBEngineVersionsResponse' (Maybe Text) (Maybe [DBEngineVersion]) Int
- newDescribeDBEngineVersionsResponse :: Int -> DescribeDBEngineVersionsResponse
- data ModifyDBClusterEndpoint = ModifyDBClusterEndpoint' (Maybe [Text]) (Maybe Text) (Maybe [Text]) Text
- newModifyDBClusterEndpoint :: Text -> ModifyDBClusterEndpoint
- data ModifyDBClusterEndpointResponse = ModifyDBClusterEndpointResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) Int
- newModifyDBClusterEndpointResponse :: Int -> ModifyDBClusterEndpointResponse
- data AddSourceIdentifierToSubscription = AddSourceIdentifierToSubscription' Text Text
- newAddSourceIdentifierToSubscription :: Text -> Text -> AddSourceIdentifierToSubscription
- data AddSourceIdentifierToSubscriptionResponse = AddSourceIdentifierToSubscriptionResponse' (Maybe EventSubscription) Int
- newAddSourceIdentifierToSubscriptionResponse :: Int -> AddSourceIdentifierToSubscriptionResponse
- data ModifyDBInstance = ModifyDBInstance' (Maybe Text) (Maybe [Text]) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe CloudwatchLogsExportConfiguration) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) Text
- newModifyDBInstance :: Text -> ModifyDBInstance
- data ModifyDBInstanceResponse = ModifyDBInstanceResponse' (Maybe DBInstance) Int
- newModifyDBInstanceResponse :: Int -> ModifyDBInstanceResponse
- data ModifyEventSubscription = ModifyEventSubscription' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Text]) Text
- newModifyEventSubscription :: Text -> ModifyEventSubscription
- data ModifyEventSubscriptionResponse = ModifyEventSubscriptionResponse' (Maybe EventSubscription) Int
- newModifyEventSubscriptionResponse :: Int -> ModifyEventSubscriptionResponse
- data ResetDBClusterParameterGroup = ResetDBClusterParameterGroup' (Maybe Bool) (Maybe [Parameter]) Text
- newResetDBClusterParameterGroup :: Text -> ResetDBClusterParameterGroup
- data DBClusterParameterGroupNameMessage = DBClusterParameterGroupNameMessage' (Maybe Text)
- newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage
- data DescribeEvents = DescribeEvents' (Maybe ISO8601) (Maybe SourceType) (Maybe [Filter]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Int) (Maybe ISO8601) (Maybe Int)
- newDescribeEvents :: DescribeEvents
- data DescribeEventsResponse = DescribeEventsResponse' (Maybe [Event]) (Maybe Text) Int
- newDescribeEventsResponse :: Int -> DescribeEventsResponse
- data DescribeEngineDefaultParameters = DescribeEngineDefaultParameters' (Maybe [Filter]) (Maybe Text) (Maybe Int) Text
- newDescribeEngineDefaultParameters :: Text -> DescribeEngineDefaultParameters
- data DescribeEngineDefaultParametersResponse = DescribeEngineDefaultParametersResponse' (Maybe EngineDefaults) Int
- newDescribeEngineDefaultParametersResponse :: Int -> DescribeEngineDefaultParametersResponse
- 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 ModifyDBSubnetGroup = ModifyDBSubnetGroup' (Maybe Text) Text [Text]
- newModifyDBSubnetGroup :: Text -> ModifyDBSubnetGroup
- data ModifyDBSubnetGroupResponse = ModifyDBSubnetGroupResponse' (Maybe DBSubnetGroup) Int
- newModifyDBSubnetGroupResponse :: Int -> ModifyDBSubnetGroupResponse
- data ListTagsForResource = ListTagsForResource' (Maybe [Filter]) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data DeleteDBCluster = DeleteDBCluster' (Maybe Text) (Maybe Bool) Text
- newDeleteDBCluster :: Text -> DeleteDBCluster
- data DeleteDBClusterResponse = DeleteDBClusterResponse' (Maybe DBCluster) Int
- newDeleteDBClusterResponse :: Int -> DeleteDBClusterResponse
- data CopyDBParameterGroup = CopyDBParameterGroup' (Maybe [Tag]) Text Text Text
- newCopyDBParameterGroup :: Text -> Text -> Text -> CopyDBParameterGroup
- data CopyDBParameterGroupResponse = CopyDBParameterGroupResponse' (Maybe DBParameterGroup) Int
- newCopyDBParameterGroupResponse :: Int -> CopyDBParameterGroupResponse
- data RemoveSourceIdentifierFromSubscription = RemoveSourceIdentifierFromSubscription' Text Text
- newRemoveSourceIdentifierFromSubscription :: Text -> Text -> RemoveSourceIdentifierFromSubscription
- data RemoveSourceIdentifierFromSubscriptionResponse = RemoveSourceIdentifierFromSubscriptionResponse' (Maybe EventSubscription) Int
- newRemoveSourceIdentifierFromSubscriptionResponse :: Int -> RemoveSourceIdentifierFromSubscriptionResponse
- data DescribeEngineDefaultClusterParameters = DescribeEngineDefaultClusterParameters' (Maybe [Filter]) (Maybe Text) (Maybe Int) Text
- newDescribeEngineDefaultClusterParameters :: Text -> DescribeEngineDefaultClusterParameters
- data DescribeEngineDefaultClusterParametersResponse = DescribeEngineDefaultClusterParametersResponse' (Maybe EngineDefaults) Int
- newDescribeEngineDefaultClusterParametersResponse :: Int -> DescribeEngineDefaultClusterParametersResponse
- data PromoteReadReplicaDBCluster = PromoteReadReplicaDBCluster' Text
- newPromoteReadReplicaDBCluster :: Text -> PromoteReadReplicaDBCluster
- data PromoteReadReplicaDBClusterResponse = PromoteReadReplicaDBClusterResponse' (Maybe DBCluster) Int
- newPromoteReadReplicaDBClusterResponse :: Int -> PromoteReadReplicaDBClusterResponse
- data RemoveTagsFromResource = RemoveTagsFromResource' Text [Text]
- newRemoveTagsFromResource :: Text -> RemoveTagsFromResource
- data RemoveTagsFromResourceResponse = RemoveTagsFromResourceResponse' {
- newRemoveTagsFromResourceResponse :: RemoveTagsFromResourceResponse
- data 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 CreateDBInstance = CreateDBInstance' (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) Text Text Text
- newCreateDBInstance :: Text -> Text -> Text -> CreateDBInstance
- data CreateDBInstanceResponse = CreateDBInstanceResponse' (Maybe DBInstance) Int
- newCreateDBInstanceResponse :: Int -> CreateDBInstanceResponse
- data DeleteDBClusterParameterGroup = DeleteDBClusterParameterGroup' Text
- newDeleteDBClusterParameterGroup :: Text -> DeleteDBClusterParameterGroup
- data DeleteDBClusterParameterGroupResponse = DeleteDBClusterParameterGroupResponse' {
- newDeleteDBClusterParameterGroupResponse :: DeleteDBClusterParameterGroupResponse
- data CreateDBClusterEndpoint = CreateDBClusterEndpoint' (Maybe [Text]) (Maybe [Text]) (Maybe [Tag]) Text Text Text
- newCreateDBClusterEndpoint :: Text -> Text -> Text -> CreateDBClusterEndpoint
- data CreateDBClusterEndpointResponse = CreateDBClusterEndpointResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) Int
- newCreateDBClusterEndpointResponse :: Int -> CreateDBClusterEndpointResponse
- data RestoreDBClusterFromSnapshot = RestoreDBClusterFromSnapshot' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe [Text]) Text Text Text
- newRestoreDBClusterFromSnapshot :: Text -> Text -> Text -> RestoreDBClusterFromSnapshot
- data RestoreDBClusterFromSnapshotResponse = RestoreDBClusterFromSnapshotResponse' (Maybe DBCluster) Int
- newRestoreDBClusterFromSnapshotResponse :: Int -> RestoreDBClusterFromSnapshotResponse
- data DescribeOrderableDBInstanceOptions = DescribeOrderableDBInstanceOptions' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) Text
- newDescribeOrderableDBInstanceOptions :: Text -> DescribeOrderableDBInstanceOptions
- data DescribeOrderableDBInstanceOptionsResponse = DescribeOrderableDBInstanceOptionsResponse' (Maybe [OrderableDBInstanceOption]) (Maybe Text) Int
- newDescribeOrderableDBInstanceOptionsResponse :: Int -> DescribeOrderableDBInstanceOptionsResponse
- data DeleteDBClusterEndpoint = DeleteDBClusterEndpoint' Text
- newDeleteDBClusterEndpoint :: Text -> DeleteDBClusterEndpoint
- data DeleteDBClusterEndpointResponse = DeleteDBClusterEndpointResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) Int
- newDeleteDBClusterEndpointResponse :: Int -> DeleteDBClusterEndpointResponse
- data CreateDBClusterParameterGroup = CreateDBClusterParameterGroup' (Maybe [Tag]) Text Text Text
- newCreateDBClusterParameterGroup :: Text -> Text -> Text -> CreateDBClusterParameterGroup
- data CreateDBClusterParameterGroupResponse = CreateDBClusterParameterGroupResponse' (Maybe DBClusterParameterGroup) Int
- newCreateDBClusterParameterGroupResponse :: Int -> CreateDBClusterParameterGroupResponse
- data DeleteEventSubscription = DeleteEventSubscription' Text
- newDeleteEventSubscription :: Text -> DeleteEventSubscription
- data DeleteEventSubscriptionResponse = DeleteEventSubscriptionResponse' (Maybe EventSubscription) Int
- newDeleteEventSubscriptionResponse :: Int -> DeleteEventSubscriptionResponse
- data DescribeDBParameterGroups = DescribeDBParameterGroups' (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int)
- newDescribeDBParameterGroups :: DescribeDBParameterGroups
- data DescribeDBParameterGroupsResponse = DescribeDBParameterGroupsResponse' (Maybe Text) (Maybe [DBParameterGroup]) Int
- newDescribeDBParameterGroupsResponse :: Int -> DescribeDBParameterGroupsResponse
- data DeleteDBClusterSnapshot = DeleteDBClusterSnapshot' Text
- newDeleteDBClusterSnapshot :: Text -> DeleteDBClusterSnapshot
- data DeleteDBClusterSnapshotResponse = DeleteDBClusterSnapshotResponse' (Maybe DBClusterSnapshot) Int
- newDeleteDBClusterSnapshotResponse :: Int -> DeleteDBClusterSnapshotResponse
- data DescribeValidDBInstanceModifications = DescribeValidDBInstanceModifications' Text
- newDescribeValidDBInstanceModifications :: Text -> DescribeValidDBInstanceModifications
- data DescribeValidDBInstanceModificationsResponse = DescribeValidDBInstanceModificationsResponse' (Maybe ValidDBInstanceModificationsMessage) Int
- newDescribeValidDBInstanceModificationsResponse :: Int -> DescribeValidDBInstanceModificationsResponse
- data DescribeDBClusterEndpoints = DescribeDBClusterEndpoints' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int)
- newDescribeDBClusterEndpoints :: DescribeDBClusterEndpoints
- data DescribeDBClusterEndpointsResponse = DescribeDBClusterEndpointsResponse' (Maybe [DBClusterEndpoint]) (Maybe Text) Int
- newDescribeDBClusterEndpointsResponse :: Int -> DescribeDBClusterEndpointsResponse
- data DescribeEventSubscriptions = DescribeEventSubscriptions' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeEventSubscriptions :: DescribeEventSubscriptions
- data DescribeEventSubscriptionsResponse = DescribeEventSubscriptionsResponse' (Maybe [EventSubscription]) (Maybe Text) Int
- newDescribeEventSubscriptionsResponse :: Int -> DescribeEventSubscriptionsResponse
- data AddTagsToResource = AddTagsToResource' Text [Tag]
- newAddTagsToResource :: Text -> AddTagsToResource
- data AddTagsToResourceResponse = AddTagsToResourceResponse' {
- newAddTagsToResourceResponse :: AddTagsToResourceResponse
- data DescribeDBParameters = DescribeDBParameters' (Maybe [Filter]) (Maybe Text) (Maybe Int) (Maybe Text) Text
- newDescribeDBParameters :: Text -> DescribeDBParameters
- data DescribeDBParametersResponse = DescribeDBParametersResponse' (Maybe Text) (Maybe [Parameter]) Int
- newDescribeDBParametersResponse :: Int -> DescribeDBParametersResponse
- data CreateDBClusterSnapshot = CreateDBClusterSnapshot' (Maybe [Tag]) Text Text
- newCreateDBClusterSnapshot :: Text -> Text -> CreateDBClusterSnapshot
- data CreateDBClusterSnapshotResponse = CreateDBClusterSnapshotResponse' (Maybe DBClusterSnapshot) Int
- newCreateDBClusterSnapshotResponse :: Int -> CreateDBClusterSnapshotResponse
- 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 StopDBCluster = StopDBCluster' Text
- newStopDBCluster :: Text -> StopDBCluster
- data StopDBClusterResponse = StopDBClusterResponse' (Maybe DBCluster) Int
- newStopDBClusterResponse :: Int -> StopDBClusterResponse
- data CreateDBParameterGroup = CreateDBParameterGroup' (Maybe [Tag]) Text Text Text
- newCreateDBParameterGroup :: Text -> Text -> Text -> CreateDBParameterGroup
- data CreateDBParameterGroupResponse = CreateDBParameterGroupResponse' (Maybe DBParameterGroup) Int
- newCreateDBParameterGroupResponse :: Int -> CreateDBParameterGroupResponse
- data ModifyDBClusterSnapshotAttribute = ModifyDBClusterSnapshotAttribute' (Maybe [Text]) (Maybe [Text]) Text Text
- newModifyDBClusterSnapshotAttribute :: Text -> Text -> ModifyDBClusterSnapshotAttribute
- data ModifyDBClusterSnapshotAttributeResponse = ModifyDBClusterSnapshotAttributeResponse' (Maybe DBClusterSnapshotAttributesResult) Int
- newModifyDBClusterSnapshotAttributeResponse :: Int -> ModifyDBClusterSnapshotAttributeResponse
- data ModifyDBCluster = ModifyDBCluster' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe CloudwatchLogsExportConfiguration) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Bool) Text
- newModifyDBCluster :: Text -> ModifyDBCluster
- data ModifyDBClusterResponse = ModifyDBClusterResponse' (Maybe DBCluster) Int
- newModifyDBClusterResponse :: Int -> ModifyDBClusterResponse
- data CopyDBClusterParameterGroup = CopyDBClusterParameterGroup' (Maybe [Tag]) Text Text Text
- newCopyDBClusterParameterGroup :: Text -> Text -> Text -> CopyDBClusterParameterGroup
- data CopyDBClusterParameterGroupResponse = CopyDBClusterParameterGroupResponse' (Maybe DBClusterParameterGroup) Int
- newCopyDBClusterParameterGroupResponse :: Int -> CopyDBClusterParameterGroupResponse
- data DescribeEventCategories = DescribeEventCategories' (Maybe Text) (Maybe [Filter])
- newDescribeEventCategories :: DescribeEventCategories
- data DescribeEventCategoriesResponse = DescribeEventCategoriesResponse' (Maybe [EventCategoriesMap]) Int
- newDescribeEventCategoriesResponse :: Int -> DescribeEventCategoriesResponse
- data ModifyDBClusterParameterGroup = ModifyDBClusterParameterGroup' Text [Parameter]
- newModifyDBClusterParameterGroup :: Text -> ModifyDBClusterParameterGroup
- data DBClusterParameterGroupNameMessage = DBClusterParameterGroupNameMessage' (Maybe Text)
- newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage
- data DescribeDBClusterSnapshotAttributes = DescribeDBClusterSnapshotAttributes' Text
- newDescribeDBClusterSnapshotAttributes :: Text -> DescribeDBClusterSnapshotAttributes
- data DescribeDBClusterSnapshotAttributesResponse = DescribeDBClusterSnapshotAttributesResponse' (Maybe DBClusterSnapshotAttributesResult) Int
- newDescribeDBClusterSnapshotAttributesResponse :: Int -> DescribeDBClusterSnapshotAttributesResponse
- data DescribePendingMaintenanceActions = DescribePendingMaintenanceActions' (Maybe [Filter]) (Maybe Text) (Maybe Int) (Maybe Text)
- newDescribePendingMaintenanceActions :: DescribePendingMaintenanceActions
- data DescribePendingMaintenanceActionsResponse = DescribePendingMaintenanceActionsResponse' (Maybe [ResourcePendingMaintenanceActions]) (Maybe Text) Int
- newDescribePendingMaintenanceActionsResponse :: Int -> DescribePendingMaintenanceActionsResponse
- data AddRoleToDBCluster = AddRoleToDBCluster' (Maybe Text) Text Text
- newAddRoleToDBCluster :: Text -> Text -> AddRoleToDBCluster
- data AddRoleToDBClusterResponse = AddRoleToDBClusterResponse' {
- newAddRoleToDBClusterResponse :: AddRoleToDBClusterResponse
- data CopyDBClusterSnapshot = CopyDBClusterSnapshot' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Tag]) Text Text
- newCopyDBClusterSnapshot :: Text -> Text -> CopyDBClusterSnapshot
- data CopyDBClusterSnapshotResponse = CopyDBClusterSnapshotResponse' (Maybe DBClusterSnapshot) Int
- newCopyDBClusterSnapshotResponse :: Int -> CopyDBClusterSnapshotResponse
- data ResetDBParameterGroup = ResetDBParameterGroup' (Maybe Bool) (Maybe [Parameter]) Text
- newResetDBParameterGroup :: Text -> ResetDBParameterGroup
- data DBParameterGroupNameMessage = DBParameterGroupNameMessage' (Maybe Text)
- newDBParameterGroupNameMessage :: DBParameterGroupNameMessage
- data CreateDBCluster = CreateDBCluster' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe [Text]) Text Text
- newCreateDBCluster :: Text -> Text -> CreateDBCluster
- data CreateDBClusterResponse = CreateDBClusterResponse' (Maybe DBCluster) Int
- newCreateDBClusterResponse :: Int -> CreateDBClusterResponse
- data RemoveRoleFromDBCluster = RemoveRoleFromDBCluster' (Maybe Text) Text Text
- newRemoveRoleFromDBCluster :: Text -> Text -> RemoveRoleFromDBCluster
- data RemoveRoleFromDBClusterResponse = RemoveRoleFromDBClusterResponse' {
- newRemoveRoleFromDBClusterResponse :: RemoveRoleFromDBClusterResponse
- data FailoverDBCluster = FailoverDBCluster' (Maybe Text) (Maybe Text)
- newFailoverDBCluster :: FailoverDBCluster
- data FailoverDBClusterResponse = FailoverDBClusterResponse' (Maybe DBCluster) Int
- newFailoverDBClusterResponse :: Int -> FailoverDBClusterResponse
- data ModifyDBParameterGroup = ModifyDBParameterGroup' Text [Parameter]
- newModifyDBParameterGroup :: Text -> ModifyDBParameterGroup
- data DBParameterGroupNameMessage = DBParameterGroupNameMessage' (Maybe Text)
- newDBParameterGroupNameMessage :: DBParameterGroupNameMessage
- data ApplyPendingMaintenanceAction = ApplyPendingMaintenanceAction' Text Text Text
- newApplyPendingMaintenanceAction :: Text -> Text -> Text -> ApplyPendingMaintenanceAction
- data ApplyPendingMaintenanceActionResponse = ApplyPendingMaintenanceActionResponse' (Maybe ResourcePendingMaintenanceActions) Int
- newApplyPendingMaintenanceActionResponse :: Int -> ApplyPendingMaintenanceActionResponse
- data DescribeDBClusterParameters = DescribeDBClusterParameters' (Maybe [Filter]) (Maybe Text) (Maybe Int) (Maybe Text) Text
- newDescribeDBClusterParameters :: Text -> DescribeDBClusterParameters
- data DescribeDBClusterParametersResponse = DescribeDBClusterParametersResponse' (Maybe Text) (Maybe [Parameter]) Int
- newDescribeDBClusterParametersResponse :: Int -> DescribeDBClusterParametersResponse
- data DeleteDBSubnetGroup = DeleteDBSubnetGroup' Text
- newDeleteDBSubnetGroup :: Text -> DeleteDBSubnetGroup
- data DeleteDBSubnetGroupResponse = DeleteDBSubnetGroupResponse' {
- newDeleteDBSubnetGroupResponse :: DeleteDBSubnetGroupResponse
- data DescribeDBClusterSnapshots = DescribeDBClusterSnapshots' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool)
- newDescribeDBClusterSnapshots :: DescribeDBClusterSnapshots
- data DescribeDBClusterSnapshotsResponse = DescribeDBClusterSnapshotsResponse' (Maybe Text) (Maybe [DBClusterSnapshot]) Int
- newDescribeDBClusterSnapshotsResponse :: Int -> DescribeDBClusterSnapshotsResponse
- data RebootDBInstance = RebootDBInstance' (Maybe Bool) Text
- newRebootDBInstance :: Text -> RebootDBInstance
- data RebootDBInstanceResponse = RebootDBInstanceResponse' (Maybe DBInstance) Int
- newRebootDBInstanceResponse :: Int -> RebootDBInstanceResponse
- data CreateDBSubnetGroup = CreateDBSubnetGroup' (Maybe [Tag]) Text Text [Text]
- newCreateDBSubnetGroup :: Text -> Text -> CreateDBSubnetGroup
- data CreateDBSubnetGroupResponse = CreateDBSubnetGroupResponse' (Maybe DBSubnetGroup) Int
- newCreateDBSubnetGroupResponse :: Int -> CreateDBSubnetGroupResponse
- data DeleteDBInstance = DeleteDBInstance' (Maybe Text) (Maybe Bool) Text
- newDeleteDBInstance :: Text -> DeleteDBInstance
- data DeleteDBInstanceResponse = DeleteDBInstanceResponse' (Maybe DBInstance) Int
- newDeleteDBInstanceResponse :: Int -> DeleteDBInstanceResponse
- data DeleteDBParameterGroup = DeleteDBParameterGroup' Text
- newDeleteDBParameterGroup :: Text -> DeleteDBParameterGroup
- data DeleteDBParameterGroupResponse = DeleteDBParameterGroupResponse' {
- newDeleteDBParameterGroupResponse :: DeleteDBParameterGroupResponse
- data RestoreDBClusterToPointInTime = RestoreDBClusterToPointInTime' (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe [Text]) Text Text
- newRestoreDBClusterToPointInTime :: Text -> Text -> RestoreDBClusterToPointInTime
- data RestoreDBClusterToPointInTimeResponse = RestoreDBClusterToPointInTimeResponse' (Maybe DBCluster) Int
- newRestoreDBClusterToPointInTimeResponse :: Int -> RestoreDBClusterToPointInTimeResponse
- data DescribeDBInstances = DescribeDBInstances' (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int)
- newDescribeDBInstances :: DescribeDBInstances
- data DescribeDBInstancesResponse = DescribeDBInstancesResponse' (Maybe [DBInstance]) (Maybe Text) Int
- newDescribeDBInstancesResponse :: Int -> DescribeDBInstancesResponse
- 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 CharacterSet = CharacterSet' (Maybe Text) (Maybe Text)
- newCharacterSet :: CharacterSet
- data CloudwatchLogsExportConfiguration = CloudwatchLogsExportConfiguration' (Maybe [Text]) (Maybe [Text])
- newCloudwatchLogsExportConfiguration :: CloudwatchLogsExportConfiguration
- data DBCluster = DBCluster' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ISO8601) (Maybe Bool) (Maybe Text) (Maybe [DBClusterMember]) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [DBClusterRole]) (Maybe [VpcSecurityGroupMembership]) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Int) (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [DBClusterOptionGroupStatus])
- newDBCluster :: DBCluster
- data DBClusterEndpoint = DBClusterEndpoint' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text])
- newDBClusterEndpoint :: DBClusterEndpoint
- data DBClusterMember = DBClusterMember' (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Text)
- newDBClusterMember :: DBClusterMember
- data DBClusterOptionGroupStatus = DBClusterOptionGroupStatus' (Maybe Text) (Maybe Text)
- newDBClusterOptionGroupStatus :: DBClusterOptionGroupStatus
- data DBClusterParameterGroup = DBClusterParameterGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newDBClusterParameterGroup :: DBClusterParameterGroup
- data DBClusterParameterGroupNameMessage = DBClusterParameterGroupNameMessage' (Maybe Text)
- newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage
- data DBClusterRole = DBClusterRole' (Maybe Text) (Maybe Text) (Maybe Text)
- newDBClusterRole :: DBClusterRole
- data DBClusterSnapshot = DBClusterSnapshot' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Int) (Maybe Text) (Maybe ISO8601) (Maybe Int) (Maybe Int)
- newDBClusterSnapshot :: DBClusterSnapshot
- data DBClusterSnapshotAttribute = DBClusterSnapshotAttribute' (Maybe [Text]) (Maybe Text)
- newDBClusterSnapshotAttribute :: DBClusterSnapshotAttribute
- data DBClusterSnapshotAttributesResult = DBClusterSnapshotAttributesResult' (Maybe Text) (Maybe [DBClusterSnapshotAttribute])
- newDBClusterSnapshotAttributesResult :: DBClusterSnapshotAttributesResult
- data DBEngineVersion = DBEngineVersion' (Maybe Text) (Maybe Text) (Maybe CharacterSet) (Maybe Text) (Maybe Text) (Maybe [CharacterSet]) (Maybe Text) (Maybe [UpgradeTarget]) (Maybe Bool) (Maybe Bool) (Maybe [Timezone]) (Maybe [Text])
- newDBEngineVersion :: DBEngineVersion
- data DBInstance = DBInstance' (Maybe Text) (Maybe [DBSecurityGroupMembership]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe ISO8601) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [VpcSecurityGroupMembership]) (Maybe Int) (Maybe Text) (Maybe DBSubnetGroup) (Maybe Bool) (Maybe [OptionGroupMembership]) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe [DBParameterGroupStatus]) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Endpoint) (Maybe Text) (Maybe Int) (Maybe PendingModifiedValues) (Maybe [Text]) (Maybe Text) (Maybe [DBInstanceStatusInfo]) (Maybe [DomainMembership]) (Maybe Text)
- newDBInstance :: DBInstance
- data DBInstanceStatusInfo = DBInstanceStatusInfo' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text)
- newDBInstanceStatusInfo :: DBInstanceStatusInfo
- data DBParameterGroup = DBParameterGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newDBParameterGroup :: DBParameterGroup
- data DBParameterGroupNameMessage = DBParameterGroupNameMessage' (Maybe Text)
- newDBParameterGroupNameMessage :: DBParameterGroupNameMessage
- data DBParameterGroupStatus = DBParameterGroupStatus' (Maybe Text) (Maybe Text)
- newDBParameterGroupStatus :: DBParameterGroupStatus
- data DBSecurityGroupMembership = DBSecurityGroupMembership' (Maybe Text) (Maybe Text)
- newDBSecurityGroupMembership :: DBSecurityGroupMembership
- data DBSubnetGroup = DBSubnetGroup' (Maybe Text) (Maybe Text) (Maybe [Subnet]) (Maybe Text) (Maybe Text) (Maybe Text)
- newDBSubnetGroup :: DBSubnetGroup
- data DomainMembership = DomainMembership' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newDomainMembership :: DomainMembership
- data DoubleRange = DoubleRange' (Maybe Double) (Maybe Double)
- newDoubleRange :: DoubleRange
- data Endpoint = Endpoint' (Maybe Text) (Maybe Text) (Maybe Int)
- newEndpoint :: Endpoint
- data EngineDefaults = EngineDefaults' (Maybe Text) (Maybe Text) (Maybe [Parameter])
- newEngineDefaults :: EngineDefaults
- data Event = Event' (Maybe SourceType) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe [Text]) (Maybe Text)
- newEvent :: Event
- data EventCategoriesMap = EventCategoriesMap' (Maybe Text) (Maybe [Text])
- newEventCategoriesMap :: EventCategoriesMap
- data EventSubscription = EventSubscription' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe [Text])
- newEventSubscription :: EventSubscription
- data Filter = Filter' Text [Text]
- newFilter :: Text -> Filter
- data OptionGroupMembership = OptionGroupMembership' (Maybe Text) (Maybe Text)
- newOptionGroupMembership :: OptionGroupMembership
- data OrderableDBInstanceOption = OrderableDBInstanceOption' (Maybe Text) (Maybe Double) (Maybe Bool) (Maybe Int) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [AvailabilityZone]) (Maybe Bool) (Maybe Bool) (Maybe Double) (Maybe Bool) (Maybe Bool) (Maybe Int) (Maybe Text)
- newOrderableDBInstanceOption :: OrderableDBInstanceOption
- data Parameter = Parameter' (Maybe Text) (Maybe Text) (Maybe ApplyMethod) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newParameter :: Parameter
- data PendingCloudwatchLogsExports = PendingCloudwatchLogsExports' (Maybe [Text]) (Maybe [Text])
- newPendingCloudwatchLogsExports :: PendingCloudwatchLogsExports
- data PendingMaintenanceAction = PendingMaintenanceAction' (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe ISO8601)
- newPendingMaintenanceAction :: PendingMaintenanceAction
- data PendingModifiedValues = PendingModifiedValues' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe PendingCloudwatchLogsExports) (Maybe Int) (Maybe Bool) (Maybe Int) (Maybe Int) (Maybe Text)
- newPendingModifiedValues :: PendingModifiedValues
- data Range = Range' (Maybe Int) (Maybe Int) (Maybe Int)
- newRange :: Range
- data ResourcePendingMaintenanceActions = ResourcePendingMaintenanceActions' (Maybe [PendingMaintenanceAction]) (Maybe Text)
- newResourcePendingMaintenanceActions :: ResourcePendingMaintenanceActions
- data Subnet = Subnet' (Maybe Text) (Maybe Text) (Maybe AvailabilityZone)
- newSubnet :: Subnet
- data Tag = Tag' (Maybe Text) (Maybe Text)
- newTag :: Tag
- data Timezone = Timezone' (Maybe Text)
- newTimezone :: Timezone
- data UpgradeTarget = UpgradeTarget' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text)
- newUpgradeTarget :: UpgradeTarget
- data ValidDBInstanceModificationsMessage = ValidDBInstanceModificationsMessage' (Maybe [ValidStorageOptions])
- newValidDBInstanceModificationsMessage :: ValidDBInstanceModificationsMessage
- data ValidStorageOptions = ValidStorageOptions' (Maybe [Range]) (Maybe [Range]) (Maybe [DoubleRange]) (Maybe Text)
- newValidStorageOptions :: ValidStorageOptions
- data VpcSecurityGroupMembership = VpcSecurityGroupMembership' (Maybe Text) (Maybe Text)
- newVpcSecurityGroupMembership :: VpcSecurityGroupMembership
Service Configuration
defaultService :: Service Source #
API version 2014-10-31
of the Amazon Neptune 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 Neptune
.
InvalidDBParameterGroupStateFault
_InvalidDBParameterGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.
SourceNotFoundFault
_SourceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The source could not be found.
CertificateNotFoundFault
_CertificateNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
CertificateIdentifier does not refer to an existing certificate.
DBClusterSnapshotAlreadyExistsFault
_DBClusterSnapshotAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
User already has a DB cluster snapshot with the given identifier.
DBParameterGroupAlreadyExistsFault
_DBParameterGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
A DB parameter group with the same name exists.
DBParameterGroupQuotaExceededFault
_DBParameterGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Request would result in user exceeding the allowed number of DB parameter groups.
InsufficientDBClusterCapacityFault
_InsufficientDBClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DB cluster does not have enough capacity for the current operation.
ProvisionedIopsNotAvailableInAZFault
_ProvisionedIopsNotAvailableInAZFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Provisioned IOPS not available in the specified Availability Zone.
SubscriptionCategoryNotFoundFault
_SubscriptionCategoryNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The designated subscription category could not be found.
SubscriptionNotFoundFault
_SubscriptionNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The designated subscription could not be found.
InvalidSubnet
_InvalidSubnet :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
SharedSnapshotQuotaExceededFault
_SharedSnapshotQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
DBSubnetQuotaExceededFault
_DBSubnetQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Request would result in user exceeding the allowed number of subnets in a DB subnet groups.
OptionGroupNotFoundFault
_OptionGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The designated option group could not be found.
DBClusterNotFoundFault
_DBClusterNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBClusterIdentifier does not refer to an existing DB cluster.
DBClusterAlreadyExistsFault
_DBClusterAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
User already has a DB cluster with the given identifier.
StorageTypeNotSupportedFault
_StorageTypeNotSupportedFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
StorageType specified cannot be associated with the DB Instance.
SNSTopicArnNotFoundFault
_SNSTopicArnNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The ARN of the SNS topic could not be found.
InvalidDBClusterEndpointStateFault
_InvalidDBClusterEndpointStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested operation cannot be performed on the endpoint while the endpoint is in this state.
InvalidEventSubscriptionStateFault
_InvalidEventSubscriptionStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The event subscription is in an invalid state.
KMSKeyNotAccessibleFault
_KMSKeyNotAccessibleFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Error accessing KMS key.
DBSnapshotNotFoundFault
_DBSnapshotNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBSnapshotIdentifier does not refer to an existing DB snapshot.
DBClusterParameterGroupNotFoundFault
_DBClusterParameterGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.
DBClusterQuotaExceededFault
_DBClusterQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
SnapshotQuotaExceededFault
_SnapshotQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Request would result in user exceeding the allowed number of DB snapshots.
DBSubnetGroupAlreadyExistsFault
_DBSubnetGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBSubnetGroupName is already used by an existing DB subnet group.
SNSNoAuthorizationFault
_SNSNoAuthorizationFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
There is no SNS authorization.
DBSecurityGroupNotFoundFault
_DBSecurityGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBSecurityGroupName does not refer to an existing DB security group.
InstanceQuotaExceededFault
_InstanceQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Request would result in user exceeding the allowed number of DB instances.
DomainNotFoundFault
_DomainNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Domain does not refer to an existing Active Directory Domain.
DBParameterGroupNotFoundFault
_DBParameterGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBParameterGroupName does not refer to an existing DB parameter group.
InvalidDBSubnetStateFault
_InvalidDBSubnetStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DB subnet is not in the available state.
DBClusterSnapshotNotFoundFault
_DBClusterSnapshotNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
SNSInvalidTopicFault
_SNSInvalidTopicFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The SNS topic is invalid.
InsufficientDBInstanceCapacityFault
_InsufficientDBInstanceCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Specified DB instance class is not available in the specified Availability Zone.
InvalidDBClusterSnapshotStateFault
_InvalidDBClusterSnapshotStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The supplied value is not a valid DB cluster snapshot state.
SubscriptionAlreadyExistFault
_SubscriptionAlreadyExistFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
This subscription already exists.
DBClusterRoleAlreadyExistsFault
_DBClusterRoleAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.
DBClusterRoleQuotaExceededFault
_DBClusterRoleQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.
InvalidVPCNetworkStateFault
_InvalidVPCNetworkStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DB subnet group does not cover all Availability Zones after it is created because users' change.
AuthorizationNotFoundFault
_AuthorizationNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
Neptune may not also be authorized via IAM to perform necessary actions on your behalf.
DBSubnetGroupQuotaExceededFault
_DBSubnetGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Request would result in user exceeding the allowed number of DB subnet groups.
EventSubscriptionQuotaExceededFault
_EventSubscriptionQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have exceeded the number of events you can subscribe to.
InsufficientStorageClusterCapacityFault
_InsufficientStorageClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
DBClusterEndpointQuotaExceededFault
_DBClusterEndpointQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The cluster already has the maximum number of custom endpoints.
InvalidDBClusterStateFault
_InvalidDBClusterStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DB cluster is not in a valid state.
DBInstanceAlreadyExistsFault
_DBInstanceAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
User already has a DB instance with the given identifier.
InvalidRestoreFault
_InvalidRestoreFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Cannot restore from vpc backup to non-vpc DB instance.
InvalidDBSecurityGroupStateFault
_InvalidDBSecurityGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The state of the DB security group does not allow deletion.
ResourceNotFoundFault
_ResourceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource ID was not found.
DBSubnetGroupNotFoundFault
_DBSubnetGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBSubnetGroupName does not refer to an existing DB subnet group.
DBUpgradeDependencyFailureFault
_DBUpgradeDependencyFailureFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DB upgrade failed because a resource the DB depends on could not be modified.
InvalidDBInstanceStateFault
_InvalidDBInstanceStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified DB instance is not in the available state.
DBClusterEndpointAlreadyExistsFault
_DBClusterEndpointAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified custom endpoint cannot be created because it already exists.
DBSnapshotAlreadyExistsFault
_DBSnapshotAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBSnapshotIdentifier is already used by an existing snapshot.
DBInstanceNotFoundFault
_DBInstanceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DBInstanceIdentifier does not refer to an existing DB instance.
StorageQuotaExceededFault
_StorageQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Request would result in user exceeding the allowed amount of storage available across all DB instances.
InvalidDBSnapshotStateFault
_InvalidDBSnapshotStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The state of the DB snapshot does not allow deletion.
InvalidDBSubnetGroupStateFault
_InvalidDBSubnetGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DB subnet group cannot be deleted because it is in use.
DBClusterEndpointNotFoundFault
_DBClusterEndpointNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified custom endpoint doesn't exist.
DBSubnetGroupDoesNotCoverEnoughAZs
_DBSubnetGroupDoesNotCoverEnoughAZs :: AsError a => Getting (First ServiceError) a ServiceError Source #
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
SubnetAlreadyInUse
_SubnetAlreadyInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #
The DB subnet is already in use in the Availability Zone.
DBClusterRoleNotFoundFault
_DBClusterRoleNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified IAM role Amazon Resource Name (ARN) is not associated with the specified DB cluster.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
DBInstanceAvailable
newDBInstanceAvailable :: Wait DescribeDBInstances Source #
Polls DescribeDBInstances
every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
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.
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:
$sel:dbClusterIdentifier:StartDBCluster'
, startDBCluster_dbClusterIdentifier
- The DB cluster identifier of the Neptune DB cluster to be started. This
parameter is stored as a lowercase string.
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.
DescribeDBClusterParameterGroups (Paginated)
data DescribeDBClusterParameterGroups Source #
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:
$sel:filters:DescribeDBClusterParameterGroups'
, describeDBClusterParameterGroups_filters
- This parameter is not currently supported.
$sel:marker:DescribeDBClusterParameterGroups'
, describeDBClusterParameterGroups_marker
- An optional pagination token provided by a previous
DescribeDBClusterParameterGroups
request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords
.
$sel:maxRecords:DescribeDBClusterParameterGroups'
, describeDBClusterParameterGroups_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
$sel:dbClusterParameterGroupName:DescribeDBClusterParameterGroups'
, describeDBClusterParameterGroups_dbClusterParameterGroupName
- The name of a specific DB cluster parameter group to return details for.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.
data DescribeDBClusterParameterGroupsResponse Source #
See: newDescribeDBClusterParameterGroupsResponse
smart constructor.
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:marker:DescribeDBClusterParameterGroups'
, describeDBClusterParameterGroupsResponse_marker
- An optional pagination token provided by a previous
DescribeDBClusterParameterGroups
request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords
.
$sel:dbClusterParameterGroups:DescribeDBClusterParameterGroupsResponse'
, describeDBClusterParameterGroupsResponse_dbClusterParameterGroups
- A list of DB cluster parameter groups.
$sel:httpStatus:DescribeDBClusterParameterGroupsResponse'
, describeDBClusterParameterGroupsResponse_httpStatus
- The response's http status code.
DescribeDBEngineVersions (Paginated)
data DescribeDBEngineVersions Source #
See: newDescribeDBEngineVersions
smart constructor.
DescribeDBEngineVersions' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Int) |
Instances
newDescribeDBEngineVersions :: DescribeDBEngineVersions Source #
Create a value of DescribeDBEngineVersions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:DescribeDBEngineVersions'
, describeDBEngineVersions_engineVersion
- The database engine version to return.
Example: 5.1.49
$sel:listSupportedTimezones:DescribeDBEngineVersions'
, describeDBEngineVersions_listSupportedTimezones
- 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.
$sel:defaultOnly:DescribeDBEngineVersions'
, describeDBEngineVersions_defaultOnly
- Indicates that only the default version of the specified engine or
engine and major version combination is returned.
$sel:filters:DescribeDBEngineVersions'
, describeDBEngineVersions_filters
- Not currently supported.
$sel:engine:DescribeDBEngineVersions'
, describeDBEngineVersions_engine
- The database engine to return.
$sel:dbParameterGroupFamily:DescribeDBEngineVersions'
, describeDBEngineVersions_dbParameterGroupFamily
- The name of a specific DB parameter group family to return details for.
Constraints:
- If supplied, must match an existing DBParameterGroupFamily.
$sel:listSupportedCharacterSets:DescribeDBEngineVersions'
, describeDBEngineVersions_listSupportedCharacterSets
- 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:marker:DescribeDBEngineVersions'
, describeDBEngineVersions_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeDBEngineVersions'
, describeDBEngineVersions_maxRecords
- The maximum number of records to include in the response. If more than
the MaxRecords
value is available, a pagination token called a marker
is included in the response so that the following results can be
retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeDBEngineVersionsResponse Source #
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:marker:DescribeDBEngineVersions'
, describeDBEngineVersionsResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:dbEngineVersions:DescribeDBEngineVersionsResponse'
, describeDBEngineVersionsResponse_dbEngineVersions
- A list of DBEngineVersion
elements.
$sel:httpStatus:DescribeDBEngineVersionsResponse'
, describeDBEngineVersionsResponse_httpStatus
- The response's http status code.
ModifyDBClusterEndpoint
data ModifyDBClusterEndpoint Source #
See: newModifyDBClusterEndpoint
smart constructor.
Instances
newModifyDBClusterEndpoint Source #
Create a value of ModifyDBClusterEndpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:staticMembers:ModifyDBClusterEndpoint'
, modifyDBClusterEndpoint_staticMembers
- List of DB instance identifiers that are part of the custom endpoint
group.
$sel:endpointType:ModifyDBClusterEndpoint'
, modifyDBClusterEndpoint_endpointType
- The type of the endpoint. One of: READER
, WRITER
, ANY
.
$sel:excludedMembers:ModifyDBClusterEndpoint'
, modifyDBClusterEndpoint_excludedMembers
- List of DB instance identifiers that aren't part of the custom endpoint
group. All other eligible instances are reachable through the custom
endpoint. Only relevant if the list of static members is empty.
$sel:dbClusterEndpointIdentifier:ModifyDBClusterEndpoint'
, modifyDBClusterEndpoint_dbClusterEndpointIdentifier
- The identifier of the endpoint to modify. This parameter is stored as a
lowercase string.
data ModifyDBClusterEndpointResponse Source #
This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpoint
DescribeDBClusterEndpoints
ModifyDBClusterEndpoint
DeleteDBClusterEndpoint
For the data structure that represents Amazon RDS DB instance endpoints,
see Endpoint
.
See: newModifyDBClusterEndpointResponse
smart constructor.
ModifyDBClusterEndpointResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) Int |
Instances
newModifyDBClusterEndpointResponse Source #
Create a value of ModifyDBClusterEndpointResponse
with all optional fields omitted.
Use 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:ModifyDBClusterEndpointResponse'
, modifyDBClusterEndpointResponse_status
- The current status of the endpoint. One of: creating
, available
,
deleting
, inactive
, modifying
. The inactive
state applies to an
endpoint that cannot be used for a certain kind of cluster, such as a
writer
endpoint for a read-only secondary cluster in a global
database.
$sel:dbClusterIdentifier:ModifyDBClusterEndpointResponse'
, modifyDBClusterEndpointResponse_dbClusterIdentifier
- The DB cluster identifier of the DB cluster associated with the
endpoint. This parameter is stored as a lowercase string.
$sel:dbClusterEndpointArn:ModifyDBClusterEndpointResponse'
, modifyDBClusterEndpointResponse_dbClusterEndpointArn
- The Amazon Resource Name (ARN) for the endpoint.
$sel:customEndpointType:ModifyDBClusterEndpointResponse'
, modifyDBClusterEndpointResponse_customEndpointType
- The type associated with a custom endpoint. One of: READER
, WRITER
,
ANY
.
$sel:staticMembers:ModifyDBClusterEndpoint'
, modifyDBClusterEndpointResponse_staticMembers
- List of DB instance identifiers that are part of the custom endpoint
group.
$sel:endpointType:ModifyDBClusterEndpoint'
, modifyDBClusterEndpointResponse_endpointType
- The type of the endpoint. One of: READER
, WRITER
, CUSTOM
.
$sel:dbClusterEndpointIdentifier:ModifyDBClusterEndpoint'
, modifyDBClusterEndpointResponse_dbClusterEndpointIdentifier
- The identifier associated with the endpoint. This parameter is stored as
a lowercase string.
$sel:endpoint:ModifyDBClusterEndpointResponse'
, modifyDBClusterEndpointResponse_endpoint
- The DNS address of the endpoint.
$sel:dbClusterEndpointResourceIdentifier:ModifyDBClusterEndpointResponse'
, modifyDBClusterEndpointResponse_dbClusterEndpointResourceIdentifier
- A unique system-generated identifier for an endpoint. It remains the
same for the whole life of the endpoint.
$sel:excludedMembers:ModifyDBClusterEndpoint'
, modifyDBClusterEndpointResponse_excludedMembers
- List of DB instance identifiers that aren't part of the custom endpoint
group. All other eligible instances are reachable through the custom
endpoint. Only relevant if the list of static members is empty.
$sel:httpStatus:ModifyDBClusterEndpointResponse'
, modifyDBClusterEndpointResponse_httpStatus
- The response's http status code.
AddSourceIdentifierToSubscription
data AddSourceIdentifierToSubscription Source #
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 event notification subscription you want to add a source
identifier to.
$sel:sourceIdentifier:AddSourceIdentifierToSubscription'
, addSourceIdentifierToSubscription_sourceIdentifier
- The identifier of the event source to be added.
Constraints:
- If the source type is a DB instance, then a
DBInstanceIdentifier
must be supplied. - If the source type is a DB security group, a
DBSecurityGroupName
must be supplied. - If the source type is a DB parameter group, a
DBParameterGroupName
must be supplied. - If the source type is a DB snapshot, a
DBSnapshotIdentifier
must be supplied.
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.
ModifyDBInstance
data ModifyDBInstance Source #
See: newModifyDBInstance
smart constructor.
ModifyDBInstance' (Maybe Text) (Maybe [Text]) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe CloudwatchLogsExportConfiguration) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) Text |
Instances
Create a value of ModifyDBInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:ModifyDBInstance'
, modifyDBInstance_engineVersion
- The version number of the database engine to upgrade to. Currently,
setting this parameter has no effect. To upgrade your database engine to
the most recent release, use the ApplyPendingMaintenanceAction API.
$sel:dbSecurityGroups:ModifyDBInstance'
, modifyDBInstance_dbSecurityGroups
- A list of DB security groups to authorize on this DB instance. Changing
this setting doesn't result in an outage and the change is
asynchronously applied as soon as possible.
Constraints:
- If supplied, must match existing DBSecurityGroups.
$sel:dbPortNumber:ModifyDBInstance'
, modifyDBInstance_dbPortNumber
- The port number on which the database accepts connections.
The value of the DBPortNumber
parameter must not match any of the port
values specified for options in the option group for the DB instance.
Your database will restart when you change the DBPortNumber
value
regardless of the value of the ApplyImmediately
parameter.
Default: 8182
$sel:deletionProtection:ModifyDBInstance'
, modifyDBInstance_deletionProtection
- A value that indicates whether the DB instance has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled. See
Deleting a DB Instance.
$sel:masterUserPassword:ModifyDBInstance'
, modifyDBInstance_masterUserPassword
- Not supported by Neptune.
$sel:publiclyAccessible:ModifyDBInstance'
, modifyDBInstance_publiclyAccessible
- This flag should no longer be used.
$sel:autoMinorVersionUpgrade:ModifyDBInstance'
, modifyDBInstance_autoMinorVersionUpgrade
- Indicates that minor version upgrades are applied automatically to the
DB instance during the maintenance window. Changing this parameter
doesn't result in an outage except in the following case and the change
is asynchronously applied as soon as possible. An outage will result if
this parameter is set to true
during the maintenance window, and a
newer minor version is available, and Neptune has enabled auto patching
for that engine version.
$sel:dbSubnetGroupName:ModifyDBInstance'
, modifyDBInstance_dbSubnetGroupName
- The new DB subnet group for the DB instance. You can use this parameter
to move your DB instance to a different VPC.
Changing the subnet group causes an outage during the change. The change
is applied during the next maintenance window, unless you specify true
for the ApplyImmediately
parameter.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetGroup
$sel:monitoringRoleArn:ModifyDBInstance'
, modifyDBInstance_monitoringRoleArn
- The ARN for the IAM role that permits Neptune to send enhanced
monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
.
If MonitoringInterval
is set to a value other than 0, then you must
supply a MonitoringRoleArn
value.
$sel:iops:ModifyDBInstance'
, modifyDBInstance_iops
- The new Provisioned IOPS (I/O operations per second) value for the
instance.
Changing this setting doesn't result in an outage and the change is
applied during the next maintenance window unless the ApplyImmediately
parameter is set to true
for this request.
Default: Uses existing setting
$sel:allowMajorVersionUpgrade:ModifyDBInstance'
, modifyDBInstance_allowMajorVersionUpgrade
- Indicates that major version upgrades are allowed. Changing this
parameter doesn't result in an outage and the change is asynchronously
applied as soon as possible.
$sel:newDBInstanceIdentifier':ModifyDBInstance'
, modifyDBInstance_newDBInstanceIdentifier
- The new DB instance identifier for the DB instance when renaming a DB
instance. When you change the DB instance identifier, an instance reboot
will occur immediately if you set Apply Immediately
to true, or will
occur during the next maintenance window if 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:domain:ModifyDBInstance'
, modifyDBInstance_domain
- Not supported.
$sel:monitoringInterval:ModifyDBInstance'
, modifyDBInstance_monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance. To disable collecting
Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn
is specified, then you must also set
MonitoringInterval
to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
$sel:cloudwatchLogsExportConfiguration:ModifyDBInstance'
, modifyDBInstance_cloudwatchLogsExportConfiguration
- The configuration setting for the log types to be enabled for export to
CloudWatch Logs for a specific DB instance or DB cluster.
$sel:tdeCredentialPassword:ModifyDBInstance'
, modifyDBInstance_tdeCredentialPassword
- The password for the given ARN from the key store in order to access the
device.
$sel:dbInstanceClass:ModifyDBInstance'
, modifyDBInstance_dbInstanceClass
- The new compute and memory capacity of the DB instance, for example,
db.m4.large
. Not all DB instance classes are available in all AWS
Regions.
If you modify the DB instance class, an outage occurs during the change.
The change is applied during the next maintenance window, unless
ApplyImmediately
is specified as true
for this request.
Default: Uses existing setting
$sel:promotionTier:ModifyDBInstance'
, modifyDBInstance_promotionTier
- A value that specifies the order in which a Read Replica is promoted to
the primary instance after a failure of the existing primary instance.
Default: 1
Valid Values: 0 - 15
$sel:licenseModel:ModifyDBInstance'
, modifyDBInstance_licenseModel
- Not supported by Neptune.
$sel:preferredMaintenanceWindow:ModifyDBInstance'
, modifyDBInstance_preferredMaintenanceWindow
- The weekly time range (in UTC) during which system maintenance can
occur, which might result in an outage. Changing this parameter doesn't
result in an outage, except in the following situation, and the change
is asynchronously applied as soon as possible. If there are pending
actions that cause a reboot, and the maintenance window is changed to
include the current time, then changing this parameter will cause a
reboot of the DB instance. If moving this window to the current time,
there must be at least 30 minutes between the current time and end of
the window to ensure pending changes are applied.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
$sel:cACertificateIdentifier:ModifyDBInstance'
, modifyDBInstance_cACertificateIdentifier
- Indicates the certificate that needs to be associated with the instance.
$sel:enablePerformanceInsights:ModifyDBInstance'
, modifyDBInstance_enablePerformanceInsights
- (Not supported by Neptune)
$sel:dbParameterGroupName:ModifyDBInstance'
, modifyDBInstance_dbParameterGroupName
- The name of the DB parameter group to apply to the DB instance. Changing
this setting doesn't result in an outage. The parameter group name
itself is changed immediately, but the actual parameter changes are not
applied until you reboot the instance without failover. The db instance
will NOT be rebooted automatically and the parameter changes will NOT be
applied during the next maintenance window.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
$sel:preferredBackupWindow:ModifyDBInstance'
, modifyDBInstance_preferredBackupWindow
- The daily time range during which automated backups are created if
automated backups are enabled.
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
- Must be in the format hh24:mi-hh24:mi
- Must be in Universal Time Coordinated (UTC)
- Must not conflict with the preferred maintenance window
- Must be at least 30 minutes
$sel:backupRetentionPeriod:ModifyDBInstance'
, modifyDBInstance_backupRetentionPeriod
- Not applicable. The retention period for automated backups is managed by
the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
$sel:performanceInsightsKMSKeyId:ModifyDBInstance'
, modifyDBInstance_performanceInsightsKMSKeyId
- (Not supported by Neptune)
$sel:vpcSecurityGroupIds:ModifyDBInstance'
, modifyDBInstance_vpcSecurityGroupIds
- A list of EC2 VPC security groups to authorize on this DB instance. This
change is asynchronously applied as soon as possible.
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
- If supplied, must match existing VpcSecurityGroupIds.
$sel:multiAZ:ModifyDBInstance'
, modifyDBInstance_multiAZ
- Specifies if the DB instance is a Multi-AZ deployment. Changing this
parameter doesn't result in an outage and the change is applied during
the next maintenance window unless the ApplyImmediately
parameter is
set to true
for this request.
$sel:allocatedStorage:ModifyDBInstance'
, modifyDBInstance_allocatedStorage
- Not supported by Neptune.
$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 DB instance.
If this parameter is set to false
, changes to the DB instance are
applied during the next maintenance window. Some parameter changes can
cause an outage and are applied on the next call to RebootDBInstance, or
the next failure reboot.
Default: false
$sel:optionGroupName:ModifyDBInstance'
, modifyDBInstance_optionGroupName
- (Not supported by Neptune)
$sel:copyTagsToSnapshot:ModifyDBInstance'
, modifyDBInstance_copyTagsToSnapshot
- True to copy all tags from the DB instance to snapshots of the DB
instance, and otherwise false. The default is false.
$sel:tdeCredentialArn:ModifyDBInstance'
, modifyDBInstance_tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE
encryption.
$sel:domainIAMRoleName:ModifyDBInstance'
, modifyDBInstance_domainIAMRoleName
- Not supported
$sel:enableIAMDatabaseAuthentication:ModifyDBInstance'
, modifyDBInstance_enableIAMDatabaseAuthentication
- True to enable mapping of Amazon Identity and Access Management (IAM)
accounts to database accounts, and otherwise false.
You can enable IAM database authentication for the following database engines
Not applicable. Mapping Amazon IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: false
$sel:storageType:ModifyDBInstance'
, modifyDBInstance_storageType
- Not supported.
$sel:dbInstanceIdentifier:ModifyDBInstance'
, modifyDBInstance_dbInstanceIdentifier
- The DB instance identifier. This value is stored as a lowercase string.
Constraints:
- Must match the identifier of an existing DBInstance.
data ModifyDBInstanceResponse Source #
See: newModifyDBInstanceResponse
smart constructor.
Instances
newModifyDBInstanceResponse Source #
Create a value of ModifyDBInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstance:ModifyDBInstanceResponse'
, modifyDBInstanceResponse_dbInstance
- Undocumented member.
$sel:httpStatus:ModifyDBInstanceResponse'
, modifyDBInstanceResponse_httpStatus
- The response's http status code.
ModifyEventSubscription
data ModifyEventSubscription Source #
See: newModifyEventSubscription
smart constructor.
Instances
newModifyEventSubscription Source #
Create a value of ModifyEventSubscription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:snsTopicArn:ModifyEventSubscription'
, modifyEventSubscription_snsTopicArn
- The Amazon Resource Name (ARN) of the SNS topic created for event
notification. The ARN is created by Amazon SNS when you create a topic
and subscribe to it.
$sel:enabled:ModifyEventSubscription'
, modifyEventSubscription_enabled
- A Boolean value; set to true to activate the subscription.
$sel:sourceType:ModifyEventSubscription'
, modifyEventSubscription_sourceType
- The type of source that is generating the events. For example, if you
want to be notified of events generated by a DB instance, you would set
this parameter to db-instance. if this value is not specified, all
events are returned.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
$sel:eventCategories:ModifyEventSubscription'
, modifyEventSubscription_eventCategories
- A list of event categories for a SourceType that you want to subscribe
to. You can see a list of the categories for a given SourceType by using
the DescribeEventCategories action.
$sel:subscriptionName:ModifyEventSubscription'
, modifyEventSubscription_subscriptionName
- The name of the event notification subscription.
data ModifyEventSubscriptionResponse Source #
See: newModifyEventSubscriptionResponse
smart constructor.
Instances
Eq ModifyEventSubscriptionResponse Source # | |
Read ModifyEventSubscriptionResponse Source # | |
Show ModifyEventSubscriptionResponse Source # | |
Defined in Amazonka.Neptune.ModifyEventSubscription | |
Generic ModifyEventSubscriptionResponse Source # | |
NFData ModifyEventSubscriptionResponse Source # | |
Defined in Amazonka.Neptune.ModifyEventSubscription rnf :: ModifyEventSubscriptionResponse -> () # | |
type Rep ModifyEventSubscriptionResponse Source # | |
Defined in Amazonka.Neptune.ModifyEventSubscription type Rep ModifyEventSubscriptionResponse = D1 ('MetaData "ModifyEventSubscriptionResponse" "Amazonka.Neptune.ModifyEventSubscription" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" '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.
ResetDBClusterParameterGroup
data ResetDBClusterParameterGroup Source #
See: newResetDBClusterParameterGroup
smart constructor.
Instances
newResetDBClusterParameterGroup Source #
:: Text |
|
-> ResetDBClusterParameterGroup |
Create a value of ResetDBClusterParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resetAllParameters:ResetDBClusterParameterGroup'
, resetDBClusterParameterGroup_resetAllParameters
- A value that is set to true
to reset all parameters in the DB 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.
$sel:parameters:ResetDBClusterParameterGroup'
, resetDBClusterParameterGroup_parameters
- A list of parameter names in the DB cluster parameter group to reset to
the default values. You can't use this parameter if the
ResetAllParameters
parameter is set to true
.
$sel:dbClusterParameterGroupName:ResetDBClusterParameterGroup'
, resetDBClusterParameterGroup_dbClusterParameterGroupName
- The name of the DB cluster parameter group to reset.
data DBClusterParameterGroupNameMessage Source #
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 the DB cluster parameter group.
Constraints:
- Must be 1 to 255 letters or numbers.
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
DescribeEvents (Paginated)
data DescribeEvents Source #
See: newDescribeEvents
smart constructor.
DescribeEvents' (Maybe ISO8601) (Maybe SourceType) (Maybe [Filter]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Int) (Maybe ISO8601) (Maybe Int) |
Instances
newDescribeEvents :: DescribeEvents Source #
Create a value of DescribeEvents
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:startTime:DescribeEvents'
, describeEvents_startTime
- The beginning of the time interval to retrieve events for, specified in
ISO 8601 format. For more information about ISO 8601, go to the
ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
$sel:sourceType:DescribeEvents'
, describeEvents_sourceType
- The event source to retrieve events for. If no value is specified, all
events are returned.
$sel:filters:DescribeEvents'
, describeEvents_filters
- This parameter is not currently supported.
$sel:sourceIdentifier:DescribeEvents'
, describeEvents_sourceIdentifier
- The identifier of the event source for which events are returned. If not
specified, then all sources are included in the response.
Constraints:
- If SourceIdentifier is supplied, SourceType must also be provided.
- If the source type is
DBInstance
, then aDBInstanceIdentifier
must be supplied. - If the source type is
DBSecurityGroup
, aDBSecurityGroupName
must be supplied. - If the source type is
DBParameterGroup
, aDBParameterGroupName
must be supplied. - If the source type is
DBSnapshot
, aDBSnapshotIdentifier
must be supplied. - Cannot end with a hyphen or contain two consecutive hyphens.
$sel:eventCategories:DescribeEvents'
, describeEvents_eventCategories
- A list of event categories that trigger notifications for a event
notification subscription.
$sel:marker:DescribeEvents'
, describeEvents_marker
- An optional pagination token provided by a previous DescribeEvents
request. If this parameter is specified, the response includes only
records beyond the marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeEvents'
, describeEvents_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
$sel:endTime:DescribeEvents'
, describeEvents_endTime
- The end of the time interval for which to retrieve events, specified in
ISO 8601 format. For more information about ISO 8601, go to the
ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
$sel:duration:DescribeEvents'
, describeEvents_duration
- The number of minutes to retrieve events for.
Default: 60
data DescribeEventsResponse Source #
See: newDescribeEventsResponse
smart constructor.
Instances
newDescribeEventsResponse Source #
Create a value of DescribeEventsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:events:DescribeEventsResponse'
, describeEventsResponse_events
- A list of Event instances.
$sel:marker:DescribeEvents'
, describeEventsResponse_marker
- An optional pagination token provided by a previous Events request. If
this parameter is specified, the response includes only records beyond
the marker, up to the value specified by MaxRecords
.
$sel:httpStatus:DescribeEventsResponse'
, describeEventsResponse_httpStatus
- The response's http status code.
DescribeEngineDefaultParameters (Paginated)
data DescribeEngineDefaultParameters Source #
See: newDescribeEngineDefaultParameters
smart constructor.
Instances
newDescribeEngineDefaultParameters Source #
:: Text |
|
-> DescribeEngineDefaultParameters |
Create a value of DescribeEngineDefaultParameters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeEngineDefaultParameters'
, describeEngineDefaultParameters_filters
- Not currently supported.
$sel:marker:DescribeEngineDefaultParameters'
, describeEngineDefaultParameters_marker
- An optional pagination token provided by a previous
DescribeEngineDefaultParameters
request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords
.
$sel:maxRecords:DescribeEngineDefaultParameters'
, describeEngineDefaultParameters_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
$sel:dbParameterGroupFamily:DescribeEngineDefaultParameters'
, describeEngineDefaultParameters_dbParameterGroupFamily
- The name of the DB parameter group family.
data DescribeEngineDefaultParametersResponse Source #
See: newDescribeEngineDefaultParametersResponse
smart constructor.
Instances
newDescribeEngineDefaultParametersResponse Source #
Create a value of DescribeEngineDefaultParametersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineDefaults:DescribeEngineDefaultParametersResponse'
, describeEngineDefaultParametersResponse_engineDefaults
- Undocumented member.
$sel:httpStatus:DescribeEngineDefaultParametersResponse'
, describeEngineDefaultParametersResponse_httpStatus
- The response's http status code.
DescribeDBClusters (Paginated)
data DescribeDBClusters Source #
See: newDescribeDBClusters
smart constructor.
Instances
newDescribeDBClusters :: DescribeDBClusters Source #
Create a value of DescribeDBClusters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterIdentifier:DescribeDBClusters'
, describeDBClusters_dbClusterIdentifier
- The user-supplied DB cluster identifier. If this parameter is specified,
information from only the specific DB cluster is returned. This
parameter isn't case-sensitive.
Constraints:
- If supplied, must match an existing DBClusterIdentifier.
$sel:filters:DescribeDBClusters'
, describeDBClusters_filters
- A filter that specifies one or more DB clusters to describe.
Supported filters:
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.engine
- Accepts an engine name (such asneptune
), and restricts the results list to DB clusters created by that engine.
For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB clusters are returned, you could use the following command:
$sel:marker:DescribeDBClusters'
, describeDBClusters_marker
- An optional pagination token provided by a previous DescribeDBClusters
request. If this parameter is specified, the response includes only
records beyond the marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeDBClusters'
, describeDBClusters_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeDBClustersResponse Source #
See: newDescribeDBClustersResponse
smart constructor.
Instances
newDescribeDBClustersResponse Source #
Create a value of DescribeDBClustersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusters:DescribeDBClustersResponse'
, describeDBClustersResponse_dbClusters
- Contains a list of DB clusters for the user.
$sel:marker:DescribeDBClusters'
, describeDBClustersResponse_marker
- A pagination token that can be used in a subsequent DescribeDBClusters
request.
$sel:httpStatus:DescribeDBClustersResponse'
, describeDBClustersResponse_httpStatus
- The response's http status code.
ModifyDBSubnetGroup
data ModifyDBSubnetGroup Source #
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:
$sel:dbSubnetGroupDescription:ModifyDBSubnetGroup'
, modifyDBSubnetGroup_dbSubnetGroupDescription
- The description for the DB subnet group.
$sel:dbSubnetGroupName:ModifyDBSubnetGroup'
, modifyDBSubnetGroup_dbSubnetGroupName
- The name for the DB subnet group. This value is stored as a lowercase
string. You can't modify the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
$sel:subnetIds:ModifyDBSubnetGroup'
, modifyDBSubnetGroup_subnetIds
- The EC2 subnet IDs for the DB subnet group.
data ModifyDBSubnetGroupResponse Source #
See: newModifyDBSubnetGroupResponse
smart constructor.
Instances
newModifyDBSubnetGroupResponse Source #
Create a value of ModifyDBSubnetGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSubnetGroup:ModifyDBSubnetGroupResponse'
, modifyDBSubnetGroupResponse_dbSubnetGroup
- Undocumented member.
$sel:httpStatus:ModifyDBSubnetGroupResponse'
, modifyDBSubnetGroupResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
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 Neptune resource with tags to be listed. This value is an
Amazon Resource Name (ARN). For information about creating an ARN, see
Constructing an Amazon Resource Name (ARN).
data ListTagsForResourceResponse Source #
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
- List of tags returned by the ListTagsForResource operation.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
DeleteDBCluster
data DeleteDBCluster Source #
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 DB cluster snapshot identifier of the new DB 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 1 to 255 letters, numbers, or hyphens.
- 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 DB cluster snapshot is created before the DB
cluster is deleted. If true
is specified, no DB cluster snapshot is
created. If false
is specified, a DB cluster snapshot is created
before the DB cluster is deleted.
You must specify a FinalDBSnapshotIdentifier
parameter if
SkipFinalSnapshot
is false
.
Default: false
$sel:dbClusterIdentifier:DeleteDBCluster'
, deleteDBCluster_dbClusterIdentifier
- The DB cluster identifier for the DB cluster to be deleted. This
parameter isn't case-sensitive.
Constraints:
- Must match an existing DBClusterIdentifier.
data DeleteDBClusterResponse Source #
See: newDeleteDBClusterResponse
smart constructor.
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.
CopyDBParameterGroup
data CopyDBParameterGroup Source #
See: newCopyDBParameterGroup
smart constructor.
Instances
newCopyDBParameterGroup Source #
:: Text | |
-> Text | |
-> Text |
|
-> CopyDBParameterGroup |
Create a value of CopyDBParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CopyDBParameterGroup'
, copyDBParameterGroup_tags
- The tags to be assigned to the copied DB parameter group.
$sel:sourceDBParameterGroupIdentifier:CopyDBParameterGroup'
, copyDBParameterGroup_sourceDBParameterGroupIdentifier
- The identifier or ARN for the source DB parameter group. For information
about creating an ARN, see
Constructing an Amazon Resource Name (ARN).
Constraints:
- Must specify a valid DB parameter group.
- Must specify a valid DB parameter group identifier, for example
my-db-param-group
, or a valid ARN.
$sel:targetDBParameterGroupIdentifier:CopyDBParameterGroup'
, copyDBParameterGroup_targetDBParameterGroupIdentifier
- The identifier for the copied DB parameter group.
Constraints:
- Cannot be null, empty, or blank.
- Must contain from 1 to 255 letters, numbers, or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-db-parameter-group
$sel:targetDBParameterGroupDescription:CopyDBParameterGroup'
, copyDBParameterGroup_targetDBParameterGroupDescription
- A description for the copied DB parameter group.
data CopyDBParameterGroupResponse Source #
See: newCopyDBParameterGroupResponse
smart constructor.
Instances
newCopyDBParameterGroupResponse Source #
Create a value of CopyDBParameterGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroup:CopyDBParameterGroupResponse'
, copyDBParameterGroupResponse_dbParameterGroup
- Undocumented member.
$sel:httpStatus:CopyDBParameterGroupResponse'
, copyDBParameterGroupResponse_httpStatus
- The response's http status code.
RemoveSourceIdentifierFromSubscription
data RemoveSourceIdentifierFromSubscription Source #
See: newRemoveSourceIdentifierFromSubscription
smart constructor.
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 event notification subscription you want to remove a
source identifier from.
$sel:sourceIdentifier:RemoveSourceIdentifierFromSubscription'
, removeSourceIdentifierFromSubscription_sourceIdentifier
- The source identifier to be removed from the subscription, such as the
DB instance identifier for a DB instance or the name of a security
group.
data RemoveSourceIdentifierFromSubscriptionResponse Source #
See: newRemoveSourceIdentifierFromSubscriptionResponse
smart constructor.
Instances
newRemoveSourceIdentifierFromSubscriptionResponse Source #
:: 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.
DescribeEngineDefaultClusterParameters
data DescribeEngineDefaultClusterParameters Source #
See: newDescribeEngineDefaultClusterParameters
smart constructor.
Instances
newDescribeEngineDefaultClusterParameters Source #
:: Text |
|
-> DescribeEngineDefaultClusterParameters |
Create a value of DescribeEngineDefaultClusterParameters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeEngineDefaultClusterParameters'
, describeEngineDefaultClusterParameters_filters
- This parameter is not currently supported.
$sel:marker:DescribeEngineDefaultClusterParameters'
, describeEngineDefaultClusterParameters_marker
- An optional pagination token provided by a previous
DescribeEngineDefaultClusterParameters
request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords
.
$sel:maxRecords:DescribeEngineDefaultClusterParameters'
, describeEngineDefaultClusterParameters_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
$sel:dbParameterGroupFamily:DescribeEngineDefaultClusterParameters'
, describeEngineDefaultClusterParameters_dbParameterGroupFamily
- The name of the DB cluster parameter group family to return engine
parameter information for.
data DescribeEngineDefaultClusterParametersResponse Source #
See: newDescribeEngineDefaultClusterParametersResponse
smart constructor.
Instances
Eq DescribeEngineDefaultClusterParametersResponse Source # | |
Read DescribeEngineDefaultClusterParametersResponse Source # | |
Show DescribeEngineDefaultClusterParametersResponse Source # | |
Generic DescribeEngineDefaultClusterParametersResponse Source # | |
NFData DescribeEngineDefaultClusterParametersResponse Source # | |
type Rep DescribeEngineDefaultClusterParametersResponse Source # | |
Defined in Amazonka.Neptune.DescribeEngineDefaultClusterParameters type Rep DescribeEngineDefaultClusterParametersResponse = D1 ('MetaData "DescribeEngineDefaultClusterParametersResponse" "Amazonka.Neptune.DescribeEngineDefaultClusterParameters" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" '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.
PromoteReadReplicaDBCluster
data PromoteReadReplicaDBCluster Source #
See: newPromoteReadReplicaDBCluster
smart constructor.
Instances
newPromoteReadReplicaDBCluster Source #
Create a value of PromoteReadReplicaDBCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterIdentifier:PromoteReadReplicaDBCluster'
, promoteReadReplicaDBCluster_dbClusterIdentifier
- Not supported.
data PromoteReadReplicaDBClusterResponse Source #
See: newPromoteReadReplicaDBClusterResponse
smart constructor.
Instances
Eq PromoteReadReplicaDBClusterResponse Source # | |
Read PromoteReadReplicaDBClusterResponse Source # | |
Show PromoteReadReplicaDBClusterResponse Source # | |
Generic PromoteReadReplicaDBClusterResponse Source # | |
NFData PromoteReadReplicaDBClusterResponse Source # | |
Defined in Amazonka.Neptune.PromoteReadReplicaDBCluster rnf :: PromoteReadReplicaDBClusterResponse -> () # | |
type Rep PromoteReadReplicaDBClusterResponse Source # | |
Defined in Amazonka.Neptune.PromoteReadReplicaDBCluster type Rep PromoteReadReplicaDBClusterResponse = D1 ('MetaData "PromoteReadReplicaDBClusterResponse" "Amazonka.Neptune.PromoteReadReplicaDBCluster" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" 'False) (C1 ('MetaCons "PromoteReadReplicaDBClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newPromoteReadReplicaDBClusterResponse Source #
Create a value of PromoteReadReplicaDBClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbCluster:PromoteReadReplicaDBClusterResponse'
, promoteReadReplicaDBClusterResponse_dbCluster
- Undocumented member.
$sel:httpStatus:PromoteReadReplicaDBClusterResponse'
, promoteReadReplicaDBClusterResponse_httpStatus
- The response's http status code.
RemoveTagsFromResource
data RemoveTagsFromResource Source #
See: newRemoveTagsFromResource
smart constructor.
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 Neptune resource that the tags are removed from. This value
is an Amazon Resource Name (ARN). For information about creating an ARN,
see
Constructing 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.
CreateEventSubscription
data CreateEventSubscription Source #
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:
$sel:enabled:CreateEventSubscription'
, createEventSubscription_enabled
- A Boolean value; set to true to activate the subscription, set to
false to create the subscription but not active it.
$sel:sourceType:CreateEventSubscription'
, createEventSubscription_sourceType
- The type of source that is generating the events. For example, if you
want to be notified of events generated by a DB instance, you 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-snapshot
| db-cluster-snapshot
$sel:eventCategories:CreateEventSubscription'
, createEventSubscription_eventCategories
- A list of event categories for a SourceType that you want to subscribe
to. You can see a list of the categories for a given SourceType by using
the DescribeEventCategories action.
$sel:sourceIds:CreateEventSubscription'
, createEventSubscription_sourceIds
- The list of identifiers of the event sources for which events are
returned. If not specified, then all sources are included in the
response. An identifier must begin with a letter and must contain only
ASCII letters, digits, and hyphens; it can't end with a hyphen or
contain two consecutive hyphens.
Constraints:
- If SourceIds are supplied, SourceType must also be provided.
- If the source type is a DB instance, then a
DBInstanceIdentifier
must be supplied. - If the source type is a DB security group, a
DBSecurityGroupName
must be supplied. - If the source type is a DB parameter group, a
DBParameterGroupName
must be supplied. - If the source type is a DB snapshot, a
DBSnapshotIdentifier
must be supplied.
$sel:tags:CreateEventSubscription'
, createEventSubscription_tags
- The tags to be applied to the new event subscription.
$sel:subscriptionName:CreateEventSubscription'
, createEventSubscription_subscriptionName
- The name of the subscription.
Constraints: The name must be less than 255 characters.
$sel:snsTopicArn:CreateEventSubscription'
, createEventSubscription_snsTopicArn
- The Amazon Resource Name (ARN) of the SNS topic created for event
notification. The ARN is created by Amazon SNS when you create a topic
and subscribe to it.
data CreateEventSubscriptionResponse Source #
See: newCreateEventSubscriptionResponse
smart constructor.
Instances
Eq CreateEventSubscriptionResponse Source # | |
Read CreateEventSubscriptionResponse Source # | |
Show CreateEventSubscriptionResponse Source # | |
Defined in Amazonka.Neptune.CreateEventSubscription | |
Generic CreateEventSubscriptionResponse Source # | |
NFData CreateEventSubscriptionResponse Source # | |
Defined in Amazonka.Neptune.CreateEventSubscription rnf :: CreateEventSubscriptionResponse -> () # | |
type Rep CreateEventSubscriptionResponse Source # | |
Defined in Amazonka.Neptune.CreateEventSubscription type Rep CreateEventSubscriptionResponse = D1 ('MetaData "CreateEventSubscriptionResponse" "Amazonka.Neptune.CreateEventSubscription" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" '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.
CreateDBInstance
data CreateDBInstance Source #
See: newCreateDBInstance
smart constructor.
CreateDBInstance' (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) Text Text Text |
Instances
:: Text | |
-> Text | |
-> Text | |
-> CreateDBInstance |
Create a value of CreateDBInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:CreateDBInstance'
, createDBInstance_engineVersion
- The version number of the database engine to use. Currently, setting
this parameter has no effect.
$sel:dbSecurityGroups:CreateDBInstance'
, createDBInstance_dbSecurityGroups
- A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
$sel:deletionProtection:CreateDBInstance'
, createDBInstance_deletionProtection
- A value that indicates whether the DB instance has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled. See
Deleting a DB Instance.
DB instances in a DB cluster can be deleted even when deletion protection is enabled in their parent DB cluster.
$sel:storageEncrypted:CreateDBInstance'
, createDBInstance_storageEncrypted
- Specifies whether the DB instance is encrypted.
Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.
Default: false
$sel:dbClusterIdentifier:CreateDBInstance'
, createDBInstance_dbClusterIdentifier
- The identifier of the DB cluster that the instance will belong to.
For information on creating a DB cluster, see CreateDBCluster.
Type: String
$sel:masterUserPassword:CreateDBInstance'
, createDBInstance_masterUserPassword
- Not supported by Neptune.
$sel:publiclyAccessible:CreateDBInstance'
, createDBInstance_publiclyAccessible
- This flag should no longer be used.
$sel:autoMinorVersionUpgrade:CreateDBInstance'
, createDBInstance_autoMinorVersionUpgrade
- Indicates that minor engine upgrades are applied automatically to the DB
instance during the maintenance window.
Default: true
$sel:masterUsername:CreateDBInstance'
, createDBInstance_masterUsername
- Not supported by Neptune.
$sel:dbSubnetGroupName:CreateDBInstance'
, createDBInstance_dbSubnetGroupName
- A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
$sel:monitoringRoleArn:CreateDBInstance'
, createDBInstance_monitoringRoleArn
- The ARN for the IAM role that permits Neptune to send enhanced
monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
.
If MonitoringInterval
is set to a value other than 0, then you must
supply a MonitoringRoleArn
value.
$sel:iops:CreateDBInstance'
, createDBInstance_iops
- The amount of Provisioned IOPS (input/output operations per second) to
be initially allocated for the DB instance.
$sel:domain:CreateDBInstance'
, createDBInstance_domain
- Specify the Active Directory Domain to create the instance in.
$sel:monitoringInterval:CreateDBInstance'
, createDBInstance_monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance. To disable collecting
Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn
is specified, then you must also set
MonitoringInterval
to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
$sel:tdeCredentialPassword:CreateDBInstance'
, createDBInstance_tdeCredentialPassword
- The password for the given ARN from the key store in order to access the
device.
$sel:promotionTier:CreateDBInstance'
, createDBInstance_promotionTier
- A value that specifies the order in which an Read Replica is promoted to
the primary instance after a failure of the existing primary instance.
Default: 1
Valid Values: 0 - 15
$sel:licenseModel:CreateDBInstance'
, createDBInstance_licenseModel
- License model information for this DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
$sel:preferredMaintenanceWindow:CreateDBInstance'
, createDBInstance_preferredMaintenanceWindow
- The time range each week during which system maintenance can occur, in
Universal Coordinated Time (UTC).
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 Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
$sel:characterSetName:CreateDBInstance'
, createDBInstance_characterSetName
- (Not supported by Neptune)
$sel:enablePerformanceInsights:CreateDBInstance'
, createDBInstance_enablePerformanceInsights
- (Not supported by Neptune)
$sel:kmsKeyId:CreateDBInstance'
, createDBInstance_kmsKeyId
- The Amazon KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same Amazon account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.
If the StorageEncrypted
parameter is true, and you do not specify a
value for the KmsKeyId
parameter, then Amazon Neptune will use your
default encryption key. Amazon KMS creates the default encryption key
for your Amazon account. Your Amazon account has a different default
encryption key for each Amazon Region.
$sel:dbParameterGroupName:CreateDBInstance'
, createDBInstance_dbParameterGroupName
- The name of the DB parameter group to associate with this DB instance.
If this argument is omitted, the default DBParameterGroup for the
specified engine is used.
Constraints:
- Must be 1 to 255 letters, numbers, or hyphens.
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
$sel:preferredBackupWindow:CreateDBInstance'
, createDBInstance_preferredBackupWindow
- The daily time range during which automated backups are created.
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
$sel:availabilityZone:CreateDBInstance'
, createDBInstance_availabilityZone
- The EC2 Availability Zone that the DB instance is created in
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter can't be specified if the
MultiAZ parameter is set to true
. The specified Availability Zone must
be in the same Amazon Region as the current endpoint.
$sel:backupRetentionPeriod:CreateDBInstance'
, createDBInstance_backupRetentionPeriod
- The number of days for which automated backups are retained.
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: 1
Constraints:
- Must be a value from 0 to 35
- Cannot be set to 0 if the DB instance is a source to Read Replicas
$sel:performanceInsightsKMSKeyId:CreateDBInstance'
, createDBInstance_performanceInsightsKMSKeyId
- (Not supported by Neptune)
$sel:vpcSecurityGroupIds:CreateDBInstance'
, createDBInstance_vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB instance.
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
$sel:multiAZ:CreateDBInstance'
, createDBInstance_multiAZ
- Specifies if the DB instance is a Multi-AZ deployment. You can't set
the AvailabilityZone parameter if the MultiAZ parameter is set to true.
$sel:allocatedStorage:CreateDBInstance'
, createDBInstance_allocatedStorage
- Not supported by Neptune.
$sel:optionGroupName:CreateDBInstance'
, createDBInstance_optionGroupName
- (Not supported by Neptune)
$sel:copyTagsToSnapshot:CreateDBInstance'
, createDBInstance_copyTagsToSnapshot
- True to copy all tags from the DB instance to snapshots of the DB
instance, and otherwise false. The default is false.
$sel:timezone:CreateDBInstance'
, createDBInstance_timezone
- The time zone of the DB instance.
$sel:tdeCredentialArn:CreateDBInstance'
, createDBInstance_tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE
encryption.
$sel:domainIAMRoleName:CreateDBInstance'
, createDBInstance_domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the
Directory Service.
$sel:tags:CreateDBInstance'
, createDBInstance_tags
- The tags to assign to the new instance.
$sel:port:CreateDBInstance'
, createDBInstance_port
- The port number on which the database accepts connections.
Not applicable. The port is managed by the DB cluster. For more information, see CreateDBCluster.
Default: 8182
Type: Integer
$sel:enableIAMDatabaseAuthentication:CreateDBInstance'
, createDBInstance_enableIAMDatabaseAuthentication
- Not supported by Neptune (ignored).
$sel:storageType:CreateDBInstance'
, createDBInstance_storageType
- Specifies the storage type to be associated with the DB instance.
Not applicable. Storage is managed by the DB Cluster.
$sel:enableCloudwatchLogsExports:CreateDBInstance'
, createDBInstance_enableCloudwatchLogsExports
- The list of log types that need to be enabled for exporting to
CloudWatch Logs.
$sel:dbName:CreateDBInstance'
, createDBInstance_dbName
- Not supported.
$sel:dbInstanceIdentifier:CreateDBInstance'
, createDBInstance_dbInstanceIdentifier
- The DB instance identifier. This parameter is stored as a lowercase
string.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
$sel:dbInstanceClass:CreateDBInstance'
, createDBInstance_dbInstanceClass
- The compute and memory capacity of the DB instance, for example,
db.m4.large
. Not all DB instance classes are available in all Amazon
Regions.
$sel:engine:CreateDBInstance'
, createDBInstance_engine
- The name of the database engine to be used for this instance.
Valid Values: neptune
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.
DeleteDBClusterParameterGroup
data DeleteDBClusterParameterGroup Source #
See: newDeleteDBClusterParameterGroup
smart constructor.
Instances
newDeleteDBClusterParameterGroup Source #
:: Text |
|
-> DeleteDBClusterParameterGroup |
Create a value of DeleteDBClusterParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterParameterGroupName:DeleteDBClusterParameterGroup'
, deleteDBClusterParameterGroup_dbClusterParameterGroupName
- The name of the DB cluster parameter group.
Constraints:
- Must be the name of an existing DB cluster parameter group.
- You can't delete a default DB cluster parameter group.
- Cannot be associated with any DB clusters.
data DeleteDBClusterParameterGroupResponse Source #
See: newDeleteDBClusterParameterGroupResponse
smart constructor.
Instances
Eq DeleteDBClusterParameterGroupResponse Source # | |
Read DeleteDBClusterParameterGroupResponse Source # | |
Show DeleteDBClusterParameterGroupResponse Source # | |
Generic DeleteDBClusterParameterGroupResponse Source # | |
Defined in Amazonka.Neptune.DeleteDBClusterParameterGroup type Rep DeleteDBClusterParameterGroupResponse :: Type -> Type # | |
NFData DeleteDBClusterParameterGroupResponse Source # | |
Defined in Amazonka.Neptune.DeleteDBClusterParameterGroup rnf :: DeleteDBClusterParameterGroupResponse -> () # | |
type Rep DeleteDBClusterParameterGroupResponse Source # | |
Defined in Amazonka.Neptune.DeleteDBClusterParameterGroup type Rep DeleteDBClusterParameterGroupResponse = D1 ('MetaData "DeleteDBClusterParameterGroupResponse" "Amazonka.Neptune.DeleteDBClusterParameterGroup" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" '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.
CreateDBClusterEndpoint
data CreateDBClusterEndpoint Source #
See: newCreateDBClusterEndpoint
smart constructor.
Instances
newCreateDBClusterEndpoint Source #
:: Text | |
-> Text | |
-> Text | |
-> CreateDBClusterEndpoint |
Create a value of CreateDBClusterEndpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:staticMembers:CreateDBClusterEndpoint'
, createDBClusterEndpoint_staticMembers
- List of DB instance identifiers that are part of the custom endpoint
group.
$sel:excludedMembers:CreateDBClusterEndpoint'
, createDBClusterEndpoint_excludedMembers
- List of DB instance identifiers that aren't part of the custom endpoint
group. All other eligible instances are reachable through the custom
endpoint. Only relevant if the list of static members is empty.
$sel:tags:CreateDBClusterEndpoint'
, createDBClusterEndpoint_tags
- The tags to be assigned to the Amazon Neptune resource.
$sel:dbClusterIdentifier:CreateDBClusterEndpoint'
, createDBClusterEndpoint_dbClusterIdentifier
- The DB cluster identifier of the DB cluster associated with the
endpoint. This parameter is stored as a lowercase string.
$sel:dbClusterEndpointIdentifier:CreateDBClusterEndpoint'
, createDBClusterEndpoint_dbClusterEndpointIdentifier
- The identifier to use for the new endpoint. This parameter is stored as
a lowercase string.
$sel:endpointType:CreateDBClusterEndpoint'
, createDBClusterEndpoint_endpointType
- The type of the endpoint. One of: READER
, WRITER
, ANY
.
data CreateDBClusterEndpointResponse Source #
This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpoint
DescribeDBClusterEndpoints
ModifyDBClusterEndpoint
DeleteDBClusterEndpoint
For the data structure that represents Amazon Neptune DB instance
endpoints, see Endpoint
.
See: newCreateDBClusterEndpointResponse
smart constructor.
CreateDBClusterEndpointResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) Int |
Instances
newCreateDBClusterEndpointResponse Source #
Create a value of CreateDBClusterEndpointResponse
with all optional fields omitted.
Use 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:CreateDBClusterEndpointResponse'
, createDBClusterEndpointResponse_status
- The current status of the endpoint. One of: creating
, available
,
deleting
, inactive
, modifying
. The inactive
state applies to an
endpoint that cannot be used for a certain kind of cluster, such as a
writer
endpoint for a read-only secondary cluster in a global
database.
$sel:dbClusterIdentifier:CreateDBClusterEndpoint'
, createDBClusterEndpointResponse_dbClusterIdentifier
- The DB cluster identifier of the DB cluster associated with the
endpoint. This parameter is stored as a lowercase string.
$sel:dbClusterEndpointArn:CreateDBClusterEndpointResponse'
, createDBClusterEndpointResponse_dbClusterEndpointArn
- The Amazon Resource Name (ARN) for the endpoint.
$sel:customEndpointType:CreateDBClusterEndpointResponse'
, createDBClusterEndpointResponse_customEndpointType
- The type associated with a custom endpoint. One of: READER
, WRITER
,
ANY
.
$sel:staticMembers:CreateDBClusterEndpoint'
, createDBClusterEndpointResponse_staticMembers
- List of DB instance identifiers that are part of the custom endpoint
group.
$sel:endpointType:CreateDBClusterEndpoint'
, createDBClusterEndpointResponse_endpointType
- The type of the endpoint. One of: READER
, WRITER
, CUSTOM
.
$sel:dbClusterEndpointIdentifier:CreateDBClusterEndpoint'
, createDBClusterEndpointResponse_dbClusterEndpointIdentifier
- The identifier associated with the endpoint. This parameter is stored as
a lowercase string.
$sel:endpoint:CreateDBClusterEndpointResponse'
, createDBClusterEndpointResponse_endpoint
- The DNS address of the endpoint.
$sel:dbClusterEndpointResourceIdentifier:CreateDBClusterEndpointResponse'
, createDBClusterEndpointResponse_dbClusterEndpointResourceIdentifier
- A unique system-generated identifier for an endpoint. It remains the
same for the whole life of the endpoint.
$sel:excludedMembers:CreateDBClusterEndpoint'
, createDBClusterEndpointResponse_excludedMembers
- List of DB instance identifiers that aren't part of the custom endpoint
group. All other eligible instances are reachable through the custom
endpoint. Only relevant if the list of static members is empty.
$sel:httpStatus:CreateDBClusterEndpointResponse'
, createDBClusterEndpointResponse_httpStatus
- The response's http status code.
RestoreDBClusterFromSnapshot
data RestoreDBClusterFromSnapshot Source #
See: newRestoreDBClusterFromSnapshot
smart constructor.
RestoreDBClusterFromSnapshot' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (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:
$sel:engineVersion:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_engineVersion
- The version of the database engine to use for the new DB cluster.
$sel:deletionProtection:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_deletionProtection
- A value that indicates whether the DB cluster has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled.
$sel:dbSubnetGroupName:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_dbSubnetGroupName
- The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
$sel:availabilityZones:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_availabilityZones
- Provides the list of EC2 Availability Zones that instances in the
restored DB cluster can be created in.
$sel:kmsKeyId:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_kmsKeyId
- The Amazon KMS key identifier to use when restoring an encrypted DB
cluster from a DB snapshot or DB cluster snapshot.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB 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 will occur:
- If the DB snapshot or DB cluster snapshot in
SnapshotIdentifier
is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. - If the DB snapshot or DB cluster snapshot in
SnapshotIdentifier
is not encrypted, then the restored DB cluster is not encrypted.
$sel:vpcSecurityGroupIds:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_vpcSecurityGroupIds
- A list of VPC security groups that the new DB cluster will belong to.
$sel:databaseName:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_databaseName
- Not supported.
$sel:dbClusterParameterGroupName:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_dbClusterParameterGroupName
- The name of the DB cluster parameter group to associate with the new DB
cluster.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.
$sel:optionGroupName:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_optionGroupName
- (Not supported by Neptune)
$sel:copyTagsToSnapshot:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_copyTagsToSnapshot
- /If set to true
, tags are copied to any snapshot of the restored DB
cluster that is created./
$sel:tags:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_tags
- The tags to be assigned to the restored DB cluster.
$sel:port:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_port
- The port number on which the new DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
$sel:enableIAMDatabaseAuthentication:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_enableIAMDatabaseAuthentication
- True to enable mapping of Amazon Identity and Access Management (IAM)
accounts to database accounts, and otherwise false.
Default: false
$sel:enableCloudwatchLogsExports:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_enableCloudwatchLogsExports
- The list of logs that the restored DB cluster is to export to Amazon
CloudWatch Logs.
$sel:dbClusterIdentifier:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_dbClusterIdentifier
- The name of the DB cluster to create from the DB snapshot or DB cluster
snapshot. This parameter isn't case-sensitive.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
$sel:snapshotIdentifier:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_snapshotIdentifier
- The identifier for the DB snapshot or DB cluster snapshot to restore
from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
- Must match the identifier of an existing Snapshot.
$sel:engine:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_engine
- The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
data RestoreDBClusterFromSnapshotResponse Source #
See: newRestoreDBClusterFromSnapshotResponse
smart constructor.
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.
DescribeOrderableDBInstanceOptions (Paginated)
data DescribeOrderableDBInstanceOptions Source #
See: newDescribeOrderableDBInstanceOptions
smart constructor.
DescribeOrderableDBInstanceOptions' (Maybe Text) (Maybe [Filter]) (Maybe Text) (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:
$sel:engineVersion:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptions_engineVersion
- The engine version filter value. Specify this parameter to show only the
available offerings matching the specified engine version.
$sel:filters:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptions_filters
- This parameter is not currently supported.
$sel:dbInstanceClass:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptions_dbInstanceClass
- The DB instance class filter value. Specify this parameter to show only
the available offerings matching the specified DB instance class.
$sel:licenseModel:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptions_licenseModel
- The license model filter value. Specify this parameter to show only the
available offerings matching the specified license model.
$sel:marker:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptions_marker
- An optional pagination token provided by a previous
DescribeOrderableDBInstanceOptions request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords
.
$sel:maxRecords:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptions_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
$sel:vpc:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptions_vpc
- The VPC filter value. Specify this parameter to show only the available
VPC or non-VPC offerings.
$sel:engine:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptions_engine
- The name of the engine to retrieve DB instance options for.
data DescribeOrderableDBInstanceOptionsResponse Source #
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:
$sel:orderableDBInstanceOptions:DescribeOrderableDBInstanceOptionsResponse'
, describeOrderableDBInstanceOptionsResponse_orderableDBInstanceOptions
- An OrderableDBInstanceOption structure containing information about
orderable options for the DB instance.
$sel:marker:DescribeOrderableDBInstanceOptions'
, describeOrderableDBInstanceOptionsResponse_marker
- An optional pagination token provided by a previous
OrderableDBInstanceOptions request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords
.
$sel:httpStatus:DescribeOrderableDBInstanceOptionsResponse'
, describeOrderableDBInstanceOptionsResponse_httpStatus
- The response's http status code.
DeleteDBClusterEndpoint
data DeleteDBClusterEndpoint Source #
See: newDeleteDBClusterEndpoint
smart constructor.
Instances
newDeleteDBClusterEndpoint Source #
Create a value of DeleteDBClusterEndpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterEndpointIdentifier:DeleteDBClusterEndpoint'
, deleteDBClusterEndpoint_dbClusterEndpointIdentifier
- The identifier associated with the custom endpoint. This parameter is
stored as a lowercase string.
data DeleteDBClusterEndpointResponse Source #
This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpoint
DescribeDBClusterEndpoints
ModifyDBClusterEndpoint
DeleteDBClusterEndpoint
For the data structure that represents Amazon RDS DB instance endpoints,
see Endpoint
.
See: newDeleteDBClusterEndpointResponse
smart constructor.
DeleteDBClusterEndpointResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) Int |
Instances
newDeleteDBClusterEndpointResponse Source #
Create a value of DeleteDBClusterEndpointResponse
with all optional fields omitted.
Use 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:DeleteDBClusterEndpointResponse'
, deleteDBClusterEndpointResponse_status
- The current status of the endpoint. One of: creating
, available
,
deleting
, inactive
, modifying
. The inactive
state applies to an
endpoint that cannot be used for a certain kind of cluster, such as a
writer
endpoint for a read-only secondary cluster in a global
database.
$sel:dbClusterIdentifier:DeleteDBClusterEndpointResponse'
, deleteDBClusterEndpointResponse_dbClusterIdentifier
- The DB cluster identifier of the DB cluster associated with the
endpoint. This parameter is stored as a lowercase string.
$sel:dbClusterEndpointArn:DeleteDBClusterEndpointResponse'
, deleteDBClusterEndpointResponse_dbClusterEndpointArn
- The Amazon Resource Name (ARN) for the endpoint.
$sel:customEndpointType:DeleteDBClusterEndpointResponse'
, deleteDBClusterEndpointResponse_customEndpointType
- The type associated with a custom endpoint. One of: READER
, WRITER
,
ANY
.
$sel:staticMembers:DeleteDBClusterEndpointResponse'
, deleteDBClusterEndpointResponse_staticMembers
- List of DB instance identifiers that are part of the custom endpoint
group.
$sel:endpointType:DeleteDBClusterEndpointResponse'
, deleteDBClusterEndpointResponse_endpointType
- The type of the endpoint. One of: READER
, WRITER
, CUSTOM
.
$sel:dbClusterEndpointIdentifier:DeleteDBClusterEndpoint'
, deleteDBClusterEndpointResponse_dbClusterEndpointIdentifier
- The identifier associated with the endpoint. This parameter is stored as
a lowercase string.
$sel:endpoint:DeleteDBClusterEndpointResponse'
, deleteDBClusterEndpointResponse_endpoint
- The DNS address of the endpoint.
$sel:dbClusterEndpointResourceIdentifier:DeleteDBClusterEndpointResponse'
, deleteDBClusterEndpointResponse_dbClusterEndpointResourceIdentifier
- A unique system-generated identifier for an endpoint. It remains the
same for the whole life of the endpoint.
$sel:excludedMembers:DeleteDBClusterEndpointResponse'
, deleteDBClusterEndpointResponse_excludedMembers
- List of DB instance identifiers that aren't part of the custom endpoint
group. All other eligible instances are reachable through the custom
endpoint. Only relevant if the list of static members is empty.
$sel:httpStatus:DeleteDBClusterEndpointResponse'
, deleteDBClusterEndpointResponse_httpStatus
- The response's http status code.
CreateDBClusterParameterGroup
data CreateDBClusterParameterGroup Source #
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 new DB cluster parameter group.
$sel:dbClusterParameterGroupName:CreateDBClusterParameterGroup'
, createDBClusterParameterGroup_dbClusterParameterGroupName
- The name of the DB cluster parameter group.
Constraints:
- Must match the name of an existing DBClusterParameterGroup.
This value is stored as a lowercase string.
$sel:dbParameterGroupFamily:CreateDBClusterParameterGroup'
, createDBClusterParameterGroup_dbParameterGroupFamily
- The DB cluster parameter group family name. A DB cluster parameter group
can be associated with one and only one DB cluster parameter group
family, and can be applied only to a DB cluster running a database
engine and engine version compatible with that DB cluster parameter
group family.
$sel:description:CreateDBClusterParameterGroup'
, createDBClusterParameterGroup_description
- The description for the DB 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:
$sel:dbClusterParameterGroup:CreateDBClusterParameterGroupResponse'
, createDBClusterParameterGroupResponse_dbClusterParameterGroup
- Undocumented member.
$sel:httpStatus:CreateDBClusterParameterGroupResponse'
, createDBClusterParameterGroupResponse_httpStatus
- The response's http status code.
DeleteEventSubscription
data DeleteEventSubscription Source #
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 event notification subscription you want to delete.
data DeleteEventSubscriptionResponse Source #
See: newDeleteEventSubscriptionResponse
smart constructor.
Instances
Eq DeleteEventSubscriptionResponse Source # | |
Read DeleteEventSubscriptionResponse Source # | |
Show DeleteEventSubscriptionResponse Source # | |
Defined in Amazonka.Neptune.DeleteEventSubscription | |
Generic DeleteEventSubscriptionResponse Source # | |
NFData DeleteEventSubscriptionResponse Source # | |
Defined in Amazonka.Neptune.DeleteEventSubscription rnf :: DeleteEventSubscriptionResponse -> () # | |
type Rep DeleteEventSubscriptionResponse Source # | |
Defined in Amazonka.Neptune.DeleteEventSubscription type Rep DeleteEventSubscriptionResponse = D1 ('MetaData "DeleteEventSubscriptionResponse" "Amazonka.Neptune.DeleteEventSubscription" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" '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.
DescribeDBParameterGroups (Paginated)
data DescribeDBParameterGroups Source #
See: newDescribeDBParameterGroups
smart constructor.
Instances
newDescribeDBParameterGroups :: DescribeDBParameterGroups Source #
Create a value of DescribeDBParameterGroups
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeDBParameterGroups'
, describeDBParameterGroups_filters
- This parameter is not currently supported.
$sel:dbParameterGroupName:DescribeDBParameterGroups'
, describeDBParameterGroups_dbParameterGroupName
- The name of a specific DB parameter group to return details for.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.
$sel:marker:DescribeDBParameterGroups'
, describeDBParameterGroups_marker
- An optional pagination token provided by a previous
DescribeDBParameterGroups
request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords
.
$sel:maxRecords:DescribeDBParameterGroups'
, describeDBParameterGroups_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeDBParameterGroupsResponse Source #
See: newDescribeDBParameterGroupsResponse
smart constructor.
Instances
newDescribeDBParameterGroupsResponse Source #
Create a value of DescribeDBParameterGroupsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeDBParameterGroups'
, describeDBParameterGroupsResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:dbParameterGroups:DescribeDBParameterGroupsResponse'
, describeDBParameterGroupsResponse_dbParameterGroups
- A list of DBParameterGroup instances.
$sel:httpStatus:DescribeDBParameterGroupsResponse'
, describeDBParameterGroupsResponse_httpStatus
- The response's http status code.
DeleteDBClusterSnapshot
data DeleteDBClusterSnapshot Source #
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:
$sel:dbClusterSnapshotIdentifier:DeleteDBClusterSnapshot'
, deleteDBClusterSnapshot_dbClusterSnapshotIdentifier
- The identifier of the DB cluster snapshot to delete.
Constraints: Must be the name of an existing DB cluster snapshot in the
available
state.
data DeleteDBClusterSnapshotResponse Source #
See: newDeleteDBClusterSnapshotResponse
smart constructor.
Instances
Eq DeleteDBClusterSnapshotResponse Source # | |
Read DeleteDBClusterSnapshotResponse Source # | |
Show DeleteDBClusterSnapshotResponse Source # | |
Defined in Amazonka.Neptune.DeleteDBClusterSnapshot | |
Generic DeleteDBClusterSnapshotResponse Source # | |
NFData DeleteDBClusterSnapshotResponse Source # | |
Defined in Amazonka.Neptune.DeleteDBClusterSnapshot rnf :: DeleteDBClusterSnapshotResponse -> () # | |
type Rep DeleteDBClusterSnapshotResponse Source # | |
Defined in Amazonka.Neptune.DeleteDBClusterSnapshot type Rep DeleteDBClusterSnapshotResponse = D1 ('MetaData "DeleteDBClusterSnapshotResponse" "Amazonka.Neptune.DeleteDBClusterSnapshot" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" '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.
DescribeValidDBInstanceModifications
data DescribeValidDBInstanceModifications Source #
See: newDescribeValidDBInstanceModifications
smart constructor.
Instances
newDescribeValidDBInstanceModifications Source #
:: Text |
|
-> DescribeValidDBInstanceModifications |
Create a value of DescribeValidDBInstanceModifications
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstanceIdentifier:DescribeValidDBInstanceModifications'
, describeValidDBInstanceModifications_dbInstanceIdentifier
- The customer identifier or the ARN of your DB instance.
data DescribeValidDBInstanceModificationsResponse Source #
See: newDescribeValidDBInstanceModificationsResponse
smart constructor.
Instances
newDescribeValidDBInstanceModificationsResponse Source #
:: Int |
|
-> DescribeValidDBInstanceModificationsResponse |
Create a value of DescribeValidDBInstanceModificationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:validDBInstanceModificationsMessage:DescribeValidDBInstanceModificationsResponse'
, describeValidDBInstanceModificationsResponse_validDBInstanceModificationsMessage
- Undocumented member.
$sel:httpStatus:DescribeValidDBInstanceModificationsResponse'
, describeValidDBInstanceModificationsResponse_httpStatus
- The response's http status code.
DescribeDBClusterEndpoints (Paginated)
data DescribeDBClusterEndpoints Source #
See: newDescribeDBClusterEndpoints
smart constructor.
Instances
newDescribeDBClusterEndpoints :: DescribeDBClusterEndpoints Source #
Create a value of DescribeDBClusterEndpoints
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterIdentifier:DescribeDBClusterEndpoints'
, describeDBClusterEndpoints_dbClusterIdentifier
- The DB cluster identifier of the DB cluster associated with the
endpoint. This parameter is stored as a lowercase string.
$sel:filters:DescribeDBClusterEndpoints'
, describeDBClusterEndpoints_filters
- A set of name-value pairs that define which endpoints to include in the
output. The filters are specified as name-value pairs, in the format
Name=endpoint_type,Values=endpoint_type1,endpoint_type2,...
. Name
can be one of: db-cluster-endpoint-type
,
db-cluster-endpoint-custom-type
, db-cluster-endpoint-id
,
db-cluster-endpoint-status
. Values
for the
db-cluster-endpoint-type
filter can be one or more of: reader
,
writer
, custom
. Values
for the db-cluster-endpoint-custom-type
filter can be one or more of: reader
, any
. Values
for the
db-cluster-endpoint-status
filter can be one or more of: available
,
creating
, deleting
, inactive
, modifying
.
$sel:dbClusterEndpointIdentifier:DescribeDBClusterEndpoints'
, describeDBClusterEndpoints_dbClusterEndpointIdentifier
- The identifier of the endpoint to describe. This parameter is stored as
a lowercase string.
$sel:marker:DescribeDBClusterEndpoints'
, describeDBClusterEndpoints_marker
- An optional pagination token provided by a previous
DescribeDBClusterEndpoints
request. If this parameter is specified,
the response includes only records beyond the marker, up to the value
specified by MaxRecords
.
$sel:maxRecords:DescribeDBClusterEndpoints'
, describeDBClusterEndpoints_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so you can retrieve the
remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeDBClusterEndpointsResponse Source #
See: newDescribeDBClusterEndpointsResponse
smart constructor.
Instances
newDescribeDBClusterEndpointsResponse Source #
Create a value of DescribeDBClusterEndpointsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterEndpoints:DescribeDBClusterEndpointsResponse'
, describeDBClusterEndpointsResponse_dbClusterEndpoints
- Contains the details of the endpoints associated with the cluster and
matching any filter conditions.
$sel:marker:DescribeDBClusterEndpoints'
, describeDBClusterEndpointsResponse_marker
- An optional pagination token provided by a previous
DescribeDBClusterEndpoints
request. If this parameter is specified,
the response includes only records beyond the marker, up to the value
specified by MaxRecords
.
$sel:httpStatus:DescribeDBClusterEndpointsResponse'
, describeDBClusterEndpointsResponse_httpStatus
- The response's http status code.
DescribeEventSubscriptions (Paginated)
data DescribeEventSubscriptions Source #
See: newDescribeEventSubscriptions
smart constructor.
Instances
newDescribeEventSubscriptions :: DescribeEventSubscriptions Source #
Create a value of DescribeEventSubscriptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subscriptionName:DescribeEventSubscriptions'
, describeEventSubscriptions_subscriptionName
- The name of the event notification subscription you want to describe.
$sel:filters:DescribeEventSubscriptions'
, describeEventSubscriptions_filters
- This parameter is not currently supported.
$sel:marker:DescribeEventSubscriptions'
, describeEventSubscriptions_marker
- An optional pagination token provided by a previous
DescribeOrderableDBInstanceOptions request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords
.
$sel:maxRecords:DescribeEventSubscriptions'
, describeEventSubscriptions_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeEventSubscriptionsResponse Source #
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 EventSubscriptions data types.
$sel:marker:DescribeEventSubscriptions'
, describeEventSubscriptionsResponse_marker
- An optional pagination token provided by a previous
DescribeOrderableDBInstanceOptions request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords
.
$sel:httpStatus:DescribeEventSubscriptionsResponse'
, describeEventSubscriptionsResponse_httpStatus
- The response's http status code.
AddTagsToResource
data AddTagsToResource Source #
See: newAddTagsToResource
smart constructor.
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 Neptune resource that the tags are added to. This value is an
Amazon Resource Name (ARN). For information about creating an ARN, see
Constructing an Amazon Resource Name (ARN).
$sel:tags:AddTagsToResource'
, addTagsToResource_tags
- The tags to be assigned to the Amazon Neptune resource.
data AddTagsToResourceResponse Source #
See: newAddTagsToResourceResponse
smart constructor.
Instances
Eq AddTagsToResourceResponse Source # | |
Defined in Amazonka.Neptune.AddTagsToResource | |
Read AddTagsToResourceResponse Source # | |
Show AddTagsToResourceResponse Source # | |
Defined in Amazonka.Neptune.AddTagsToResource showsPrec :: Int -> AddTagsToResourceResponse -> ShowS # show :: AddTagsToResourceResponse -> String # showList :: [AddTagsToResourceResponse] -> ShowS # | |
Generic AddTagsToResourceResponse Source # | |
Defined in Amazonka.Neptune.AddTagsToResource type Rep AddTagsToResourceResponse :: Type -> Type # | |
NFData AddTagsToResourceResponse Source # | |
Defined in Amazonka.Neptune.AddTagsToResource rnf :: AddTagsToResourceResponse -> () # | |
type Rep AddTagsToResourceResponse Source # | |
Defined in Amazonka.Neptune.AddTagsToResource |
newAddTagsToResourceResponse :: AddTagsToResourceResponse Source #
Create a value of AddTagsToResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeDBParameters (Paginated)
data DescribeDBParameters Source #
See: newDescribeDBParameters
smart constructor.
Instances
newDescribeDBParameters Source #
Create a value of DescribeDBParameters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeDBParameters'
, describeDBParameters_filters
- This parameter is not currently supported.
$sel:marker:DescribeDBParameters'
, describeDBParameters_marker
- An optional pagination token provided by a previous
DescribeDBParameters
request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords
.
$sel:maxRecords:DescribeDBParameters'
, describeDBParameters_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
$sel:source:DescribeDBParameters'
, describeDBParameters_source
- The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
$sel:dbParameterGroupName:DescribeDBParameters'
, describeDBParameters_dbParameterGroupName
- The name of a specific DB parameter group to return details for.
Constraints:
- If supplied, must match the name of an existing DBParameterGroup.
data DescribeDBParametersResponse Source #
See: newDescribeDBParametersResponse
smart constructor.
Instances
newDescribeDBParametersResponse Source #
Create a value of DescribeDBParametersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeDBParameters'
, describeDBParametersResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:parameters:DescribeDBParametersResponse'
, describeDBParametersResponse_parameters
- A list of Parameter values.
$sel:httpStatus:DescribeDBParametersResponse'
, describeDBParametersResponse_httpStatus
- The response's http status code.
CreateDBClusterSnapshot
data CreateDBClusterSnapshot Source #
See: newCreateDBClusterSnapshot
smart constructor.
Instances
newCreateDBClusterSnapshot Source #
:: Text | |
-> Text | |
-> CreateDBClusterSnapshot |
Create a value of CreateDBClusterSnapshot
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateDBClusterSnapshot'
, createDBClusterSnapshot_tags
- The tags to be assigned to the DB cluster snapshot.
$sel:dbClusterSnapshotIdentifier:CreateDBClusterSnapshot'
, createDBClusterSnapshot_dbClusterSnapshotIdentifier
- The identifier of the DB cluster snapshot. This parameter is stored as a
lowercase string.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1-snapshot1
$sel:dbClusterIdentifier:CreateDBClusterSnapshot'
, createDBClusterSnapshot_dbClusterIdentifier
- The identifier of the DB cluster to create a snapshot for. This
parameter is not case-sensitive.
Constraints:
- Must match the identifier of an existing DBCluster.
Example: my-cluster1
data CreateDBClusterSnapshotResponse Source #
See: newCreateDBClusterSnapshotResponse
smart constructor.
Instances
Eq CreateDBClusterSnapshotResponse Source # | |
Read CreateDBClusterSnapshotResponse Source # | |
Show CreateDBClusterSnapshotResponse Source # | |
Defined in Amazonka.Neptune.CreateDBClusterSnapshot | |
Generic CreateDBClusterSnapshotResponse Source # | |
NFData CreateDBClusterSnapshotResponse Source # | |
Defined in Amazonka.Neptune.CreateDBClusterSnapshot rnf :: CreateDBClusterSnapshotResponse -> () # | |
type Rep CreateDBClusterSnapshotResponse Source # | |
Defined in Amazonka.Neptune.CreateDBClusterSnapshot type Rep CreateDBClusterSnapshotResponse = D1 ('MetaData "CreateDBClusterSnapshotResponse" "Amazonka.Neptune.CreateDBClusterSnapshot" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" '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.
DescribeDBSubnetGroups (Paginated)
data DescribeDBSubnetGroups Source #
See: newDescribeDBSubnetGroups
smart constructor.
Instances
newDescribeDBSubnetGroups :: DescribeDBSubnetGroups Source #
Create a value of DescribeDBSubnetGroups
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSubnetGroupName:DescribeDBSubnetGroups'
, describeDBSubnetGroups_dbSubnetGroupName
- The name of the DB subnet group to return details for.
$sel:filters:DescribeDBSubnetGroups'
, describeDBSubnetGroups_filters
- This parameter is not currently supported.
$sel:marker:DescribeDBSubnetGroups'
, describeDBSubnetGroups_marker
- An optional pagination token provided by a previous
DescribeDBSubnetGroups request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords
.
$sel:maxRecords:DescribeDBSubnetGroups'
, describeDBSubnetGroups_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeDBSubnetGroupsResponse Source #
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
- A list of DBSubnetGroup instances.
$sel:marker:DescribeDBSubnetGroups'
, describeDBSubnetGroupsResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:httpStatus:DescribeDBSubnetGroupsResponse'
, describeDBSubnetGroupsResponse_httpStatus
- The response's http status code.
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:
$sel:dbClusterIdentifier:StopDBCluster'
, stopDBCluster_dbClusterIdentifier
- The DB cluster identifier of the Neptune DB cluster to be stopped. This
parameter is stored as a lowercase string.
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.
CreateDBParameterGroup
data CreateDBParameterGroup Source #
See: newCreateDBParameterGroup
smart constructor.
Instances
newCreateDBParameterGroup Source #
:: Text | |
-> Text | |
-> Text | |
-> CreateDBParameterGroup |
Create a value of CreateDBParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateDBParameterGroup'
, createDBParameterGroup_tags
- The tags to be assigned to the new DB parameter group.
$sel:dbParameterGroupName:CreateDBParameterGroup'
, createDBParameterGroup_dbParameterGroupName
- The name of the DB parameter group.
Constraints:
- Must be 1 to 255 letters, numbers, or hyphens.
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
$sel:dbParameterGroupFamily:CreateDBParameterGroup'
, createDBParameterGroup_dbParameterGroupFamily
- The DB parameter group family name. A DB parameter group can be
associated with one and only one DB parameter group family, and can be
applied only to a DB instance running a database engine and engine
version compatible with that DB parameter group family.
$sel:description:CreateDBParameterGroup'
, createDBParameterGroup_description
- The description for the DB parameter group.
data CreateDBParameterGroupResponse Source #
See: newCreateDBParameterGroupResponse
smart constructor.
Instances
Eq CreateDBParameterGroupResponse Source # | |
Read CreateDBParameterGroupResponse Source # | |
Show CreateDBParameterGroupResponse Source # | |
Defined in Amazonka.Neptune.CreateDBParameterGroup | |
Generic CreateDBParameterGroupResponse Source # | |
NFData CreateDBParameterGroupResponse Source # | |
Defined in Amazonka.Neptune.CreateDBParameterGroup rnf :: CreateDBParameterGroupResponse -> () # | |
type Rep CreateDBParameterGroupResponse Source # | |
Defined in Amazonka.Neptune.CreateDBParameterGroup type Rep CreateDBParameterGroupResponse = D1 ('MetaData "CreateDBParameterGroupResponse" "Amazonka.Neptune.CreateDBParameterGroup" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" 'False) (C1 ('MetaCons "CreateDBParameterGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbParameterGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBParameterGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCreateDBParameterGroupResponse Source #
Create a value of CreateDBParameterGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroup:CreateDBParameterGroupResponse'
, createDBParameterGroupResponse_dbParameterGroup
- Undocumented member.
$sel:httpStatus:CreateDBParameterGroupResponse'
, createDBParameterGroupResponse_httpStatus
- The response's http status code.
ModifyDBClusterSnapshotAttribute
data ModifyDBClusterSnapshotAttribute Source #
See: newModifyDBClusterSnapshotAttribute
smart constructor.
Instances
newModifyDBClusterSnapshotAttribute Source #
:: Text |
|
-> Text | |
-> ModifyDBClusterSnapshotAttribute |
Create a value of ModifyDBClusterSnapshotAttribute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:valuesToAdd:ModifyDBClusterSnapshotAttribute'
, modifyDBClusterSnapshotAttribute_valuesToAdd
- A list of DB cluster snapshot attributes to add to the attribute
specified by AttributeName
.
To authorize other Amazon accounts to copy or restore a manual DB
cluster snapshot, set this list to include one or more Amazon account
IDs, or all
to make the manual DB cluster snapshot restorable by any
Amazon account. Do not add the all
value for any manual DB cluster
snapshots that contain private information that you don't want
available to all AWS accounts.
$sel:valuesToRemove:ModifyDBClusterSnapshotAttribute'
, modifyDBClusterSnapshotAttribute_valuesToRemove
- A list of DB cluster snapshot attributes to remove from the attribute
specified by AttributeName
.
To remove authorization for other Amazon accounts to copy or restore a
manual DB cluster snapshot, set this list to include one or more Amazon
account identifiers, or all
to remove authorization for any Amazon
account to copy or restore the DB cluster snapshot. If you specify
all
, an Amazon account whose account ID is explicitly added to the
restore
attribute can still copy or restore a manual DB cluster
snapshot.
$sel:dbClusterSnapshotIdentifier:ModifyDBClusterSnapshotAttribute'
, modifyDBClusterSnapshotAttribute_dbClusterSnapshotIdentifier
- The identifier for the DB cluster snapshot to modify the attributes for.
$sel:attributeName:ModifyDBClusterSnapshotAttribute'
, modifyDBClusterSnapshotAttribute_attributeName
- The name of the DB cluster snapshot attribute to modify.
To manage authorization for other Amazon accounts to copy or restore a
manual DB 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.
ModifyDBCluster
data ModifyDBCluster Source #
See: newModifyDBCluster
smart constructor.
ModifyDBCluster' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe CloudwatchLogsExportConfiguration) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Bool) 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:engineVersion:ModifyDBCluster'
, modifyDBCluster_engineVersion
- The version number of the database engine to which you want to upgrade.
Changing this parameter results in an outage. The change is applied
during the next maintenance window unless the ApplyImmediately
parameter is set to true.
For a list of valid engine versions, see Engine Releases for Amazon Neptune, or call DescribeDBEngineVersions.
$sel:deletionProtection:ModifyDBCluster'
, modifyDBCluster_deletionProtection
- A value that indicates whether the DB cluster has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled.
$sel:masterUserPassword:ModifyDBCluster'
, modifyDBCluster_masterUserPassword
- Not supported by Neptune.
$sel:cloudwatchLogsExportConfiguration:ModifyDBCluster'
, modifyDBCluster_cloudwatchLogsExportConfiguration
- The configuration setting for the log types to be enabled for export to
CloudWatch Logs for a specific DB cluster.
$sel:preferredMaintenanceWindow:ModifyDBCluster'
, modifyDBCluster_preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in
Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
$sel:preferredBackupWindow:ModifyDBCluster'
, modifyDBCluster_preferredBackupWindow
- The daily time range during which automated backups are created if
automated backups are enabled, using the BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon 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.
$sel:backupRetentionPeriod:ModifyDBCluster'
, modifyDBCluster_backupRetentionPeriod
- The number of days for which automated backups are retained. You must
specify a minimum value of 1.
Default: 1
Constraints:
- Must be a value from 1 to 35
$sel:vpcSecurityGroupIds:ModifyDBCluster'
, modifyDBCluster_vpcSecurityGroupIds
- A list of VPC security groups that the DB cluster will belong to.
$sel:dbClusterParameterGroupName:ModifyDBCluster'
, modifyDBCluster_dbClusterParameterGroupName
- The name of the DB cluster parameter group to use for the DB cluster.
$sel:applyImmediately:ModifyDBCluster'
, modifyDBCluster_applyImmediately
- A value that specifies whether the modifications in this request and any
pending modifications are asynchronously applied as soon as possible,
regardless of the PreferredMaintenanceWindow
setting for the DB
cluster. If this parameter is set to false
, changes to the DB cluster
are applied during the next maintenance window.
The ApplyImmediately
parameter only affects NewDBClusterIdentifier
values. If you set the ApplyImmediately
parameter value to false, then
changes to NewDBClusterIdentifier
values are applied during the next
maintenance window. All other changes are applied immediately,
regardless of the value of the ApplyImmediately
parameter.
Default: false
$sel:optionGroupName:ModifyDBCluster'
, modifyDBCluster_optionGroupName
- Not supported by Neptune.
$sel:copyTagsToSnapshot:ModifyDBCluster'
, modifyDBCluster_copyTagsToSnapshot
- /If set to true
, tags are copied to any snapshot of the DB cluster
that is created./
$sel:newDBClusterIdentifier':ModifyDBCluster'
, modifyDBCluster_newDBClusterIdentifier
- The new DB cluster identifier for the DB cluster when renaming a DB
cluster. This value is stored as a lowercase string.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens
- The first character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
$sel:port:ModifyDBCluster'
, modifyDBCluster_port
- The port number on which the DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
$sel:enableIAMDatabaseAuthentication:ModifyDBCluster'
, modifyDBCluster_enableIAMDatabaseAuthentication
- True to enable mapping of Amazon Identity and Access Management (IAM)
accounts to database accounts, and otherwise false.
Default: false
$sel:dbClusterIdentifier:ModifyDBCluster'
, modifyDBCluster_dbClusterIdentifier
- The DB cluster identifier for the cluster 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.
CopyDBClusterParameterGroup
data CopyDBClusterParameterGroup Source #
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 to be assigned to the copied DB cluster parameter group.
$sel:sourceDBClusterParameterGroupIdentifier:CopyDBClusterParameterGroup'
, copyDBClusterParameterGroup_sourceDBClusterParameterGroupIdentifier
- The identifier or Amazon Resource Name (ARN) for the source DB cluster
parameter group. For information about creating an ARN, see
Constructing an Amazon Resource Name (ARN).
Constraints:
- Must specify a valid DB cluster parameter group.
- If the source DB cluster parameter group is in the same Amazon
Region as the copy, specify a valid DB parameter group identifier,
for example
my-db-cluster-param-group
, or a valid ARN. - If the source DB parameter group is in a different Amazon Region
than the copy, specify a valid DB cluster parameter group ARN, for
example
arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1
.
$sel:targetDBClusterParameterGroupIdentifier:CopyDBClusterParameterGroup'
, copyDBClusterParameterGroup_targetDBClusterParameterGroupIdentifier
- The identifier for the copied DB cluster parameter group.
Constraints:
- Cannot be null, empty, or blank
- Must contain from 1 to 255 letters, numbers, or hyphens
- 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 DB cluster parameter group.
data CopyDBClusterParameterGroupResponse Source #
See: newCopyDBClusterParameterGroupResponse
smart constructor.
Instances
Eq CopyDBClusterParameterGroupResponse Source # | |
Read CopyDBClusterParameterGroupResponse Source # | |
Show CopyDBClusterParameterGroupResponse Source # | |
Generic CopyDBClusterParameterGroupResponse Source # | |
NFData CopyDBClusterParameterGroupResponse Source # | |
Defined in Amazonka.Neptune.CopyDBClusterParameterGroup rnf :: CopyDBClusterParameterGroupResponse -> () # | |
type Rep CopyDBClusterParameterGroupResponse Source # | |
Defined in Amazonka.Neptune.CopyDBClusterParameterGroup type Rep CopyDBClusterParameterGroupResponse = D1 ('MetaData "CopyDBClusterParameterGroupResponse" "Amazonka.Neptune.CopyDBClusterParameterGroup" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" 'False) (C1 ('MetaCons "CopyDBClusterParameterGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterParameterGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBClusterParameterGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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:
$sel:dbClusterParameterGroup:CopyDBClusterParameterGroupResponse'
, copyDBClusterParameterGroupResponse_dbClusterParameterGroup
- Undocumented member.
$sel:httpStatus:CopyDBClusterParameterGroupResponse'
, copyDBClusterParameterGroupResponse_httpStatus
- The response's http status code.
DescribeEventCategories
data DescribeEventCategories Source #
See: newDescribeEventCategories
smart constructor.
Instances
newDescribeEventCategories :: DescribeEventCategories Source #
Create a value of DescribeEventCategories
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceType:DescribeEventCategories'
, describeEventCategories_sourceType
- The type of source that is generating the events.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
$sel:filters:DescribeEventCategories'
, describeEventCategories_filters
- This parameter is not currently supported.
data DescribeEventCategoriesResponse Source #
See: newDescribeEventCategoriesResponse
smart constructor.
Instances
Eq DescribeEventCategoriesResponse Source # | |
Read DescribeEventCategoriesResponse Source # | |
Show DescribeEventCategoriesResponse Source # | |
Defined in Amazonka.Neptune.DescribeEventCategories | |
Generic DescribeEventCategoriesResponse Source # | |
NFData DescribeEventCategoriesResponse Source # | |
Defined in Amazonka.Neptune.DescribeEventCategories rnf :: DescribeEventCategoriesResponse -> () # | |
type Rep DescribeEventCategoriesResponse Source # | |
Defined in Amazonka.Neptune.DescribeEventCategories type Rep DescribeEventCategoriesResponse = D1 ('MetaData "DescribeEventCategoriesResponse" "Amazonka.Neptune.DescribeEventCategories" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" '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 EventCategoriesMap data types.
$sel:httpStatus:DescribeEventCategoriesResponse'
, describeEventCategoriesResponse_httpStatus
- The response's http status code.
ModifyDBClusterParameterGroup
data ModifyDBClusterParameterGroup Source #
See: newModifyDBClusterParameterGroup
smart constructor.
Instances
newModifyDBClusterParameterGroup Source #
:: Text |
|
-> ModifyDBClusterParameterGroup |
Create a value of ModifyDBClusterParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterParameterGroupName:ModifyDBClusterParameterGroup'
, modifyDBClusterParameterGroup_dbClusterParameterGroupName
- The name of the DB cluster parameter group to modify.
$sel:parameters:ModifyDBClusterParameterGroup'
, modifyDBClusterParameterGroup_parameters
- A list of parameters in the DB cluster parameter group to modify.
data DBClusterParameterGroupNameMessage Source #
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 the DB cluster parameter group.
Constraints:
- Must be 1 to 255 letters or numbers.
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
DescribeDBClusterSnapshotAttributes
data DescribeDBClusterSnapshotAttributes Source #
See: newDescribeDBClusterSnapshotAttributes
smart constructor.
Instances
newDescribeDBClusterSnapshotAttributes Source #
:: Text |
|
-> DescribeDBClusterSnapshotAttributes |
Create a value of DescribeDBClusterSnapshotAttributes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterSnapshotIdentifier:DescribeDBClusterSnapshotAttributes'
, describeDBClusterSnapshotAttributes_dbClusterSnapshotIdentifier
- The identifier for the DB cluster snapshot to describe the attributes
for.
data DescribeDBClusterSnapshotAttributesResponse Source #
See: newDescribeDBClusterSnapshotAttributesResponse
smart constructor.
Instances
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.
DescribePendingMaintenanceActions (Paginated)
data DescribePendingMaintenanceActions Source #
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 DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB clusters identified by these ARNs.db-instance-id
- Accepts DB instance identifiers and DB instance ARNs. The results list will only include pending maintenance actions for the DB instances identified by these ARNs.
$sel:marker:DescribePendingMaintenanceActions'
, describePendingMaintenanceActions_marker
- An optional pagination token provided by a previous
DescribePendingMaintenanceActions
request. If this parameter is
specified, the response includes only records beyond the marker, up to a
number of records specified by MaxRecords
.
$sel:maxRecords:DescribePendingMaintenanceActions'
, describePendingMaintenanceActions_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
$sel:resourceIdentifier:DescribePendingMaintenanceActions'
, describePendingMaintenanceActions_resourceIdentifier
- The ARN of a resource to return pending maintenance actions for.
data DescribePendingMaintenanceActionsResponse Source #
See: newDescribePendingMaintenanceActionsResponse
smart constructor.
DescribePendingMaintenanceActionsResponse' (Maybe [ResourcePendingMaintenanceActions]) (Maybe Text) 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:
$sel:pendingMaintenanceActions:DescribePendingMaintenanceActionsResponse'
, describePendingMaintenanceActionsResponse_pendingMaintenanceActions
- A list of the pending maintenance actions for the resource.
$sel:marker:DescribePendingMaintenanceActions'
, describePendingMaintenanceActionsResponse_marker
- An optional pagination token provided by a previous
DescribePendingMaintenanceActions
request. If this parameter is
specified, the response includes only records beyond the marker, up to a
number of records specified by MaxRecords
.
$sel:httpStatus:DescribePendingMaintenanceActionsResponse'
, describePendingMaintenanceActionsResponse_httpStatus
- The response's http status code.
AddRoleToDBCluster
data AddRoleToDBCluster Source #
See: newAddRoleToDBCluster
smart constructor.
Instances
newAddRoleToDBCluster Source #
:: Text | |
-> Text | |
-> AddRoleToDBCluster |
Create a value of AddRoleToDBCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:featureName:AddRoleToDBCluster'
, addRoleToDBCluster_featureName
- The name of the feature for the Neptune DB cluster that the IAM role is
to be associated with. For the list of supported feature names, see
DBEngineVersion.
$sel:dbClusterIdentifier:AddRoleToDBCluster'
, addRoleToDBCluster_dbClusterIdentifier
- The name of the DB cluster to associate the IAM role with.
$sel:roleArn:AddRoleToDBCluster'
, addRoleToDBCluster_roleArn
- The Amazon Resource Name (ARN) of the IAM role to associate with the
Neptune DB cluster, for example
arn:aws:iam::123456789012:role/NeptuneAccessRole
.
data AddRoleToDBClusterResponse Source #
See: newAddRoleToDBClusterResponse
smart constructor.
Instances
newAddRoleToDBClusterResponse :: AddRoleToDBClusterResponse Source #
Create a value of AddRoleToDBClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CopyDBClusterSnapshot
data CopyDBClusterSnapshot Source #
See: newCopyDBClusterSnapshot
smart constructor.
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:preSignedUrl:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_preSignedUrl
- Not currently supported.
$sel:copyTags:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_copyTags
- True to copy all tags from the source DB cluster snapshot to the target
DB cluster snapshot, and otherwise false. The default is false.
$sel:kmsKeyId:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_kmsKeyId
- The Amazon Amazon KMS key ID for an encrypted DB 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 DB cluster snapshot from your Amazon 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 DB cluster snapshot is encrypted with the same KMS key
as the source DB cluster snapshot.
If you copy an encrypted DB cluster snapshot that is shared from another
Amazon account, then you must specify a value for KmsKeyId
.
KMS encryption keys are specific to the Amazon Region that they are created in, and you can't use encryption keys from one Amazon Region in another Amazon Region.
You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
$sel:tags:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_tags
- The tags to assign to the new DB cluster snapshot copy.
$sel:sourceDBClusterSnapshotIdentifier:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_sourceDBClusterSnapshotIdentifier
- The identifier of the DB cluster snapshot to copy. This parameter is not
case-sensitive.
Constraints:
- Must specify a valid system snapshot in the "available" state.
- Specify a valid DB snapshot identifier.
Example: my-cluster-snapshot1
$sel:targetDBClusterSnapshotIdentifier:CopyDBClusterSnapshot'
, copyDBClusterSnapshot_targetDBClusterSnapshotIdentifier
- The identifier of the new DB cluster snapshot to create from the source
DB cluster snapshot. This parameter is not case-sensitive.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- 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.
ResetDBParameterGroup
data ResetDBParameterGroup Source #
See: newResetDBParameterGroup
smart constructor.
Instances
newResetDBParameterGroup Source #
Create a value of ResetDBParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resetAllParameters:ResetDBParameterGroup'
, resetDBParameterGroup_resetAllParameters
- Specifies whether (true
) or not (false
) to reset all parameters in
the DB parameter group to default values.
Default: true
$sel:parameters:ResetDBParameterGroup'
, resetDBParameterGroup_parameters
- To reset the entire DB parameter group, specify the DBParameterGroup
name and ResetAllParameters
parameters. To reset specific parameters,
provide a list of the following: ParameterName
and ApplyMethod
. A
maximum of 20 parameters can be modified in a single request.
Valid Values (for Apply method): pending-reboot
$sel:dbParameterGroupName:ResetDBParameterGroup'
, resetDBParameterGroup_dbParameterGroupName
- The name of the DB parameter group.
Constraints:
- Must match the name of an existing DBParameterGroup.
data DBParameterGroupNameMessage Source #
See: newDBParameterGroupNameMessage
smart constructor.
Instances
newDBParameterGroupNameMessage :: DBParameterGroupNameMessage Source #
Create a value of DBParameterGroupNameMessage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroupName:DBParameterGroupNameMessage'
, dbParameterGroupNameMessage_dbParameterGroupName
- Provides the name of the DB parameter group.
CreateDBCluster
data CreateDBCluster Source #
See: newCreateDBCluster
smart constructor.
CreateDBCluster' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Tag]) (Maybe Int) (Maybe Bool) (Maybe [Text]) Text Text |
Instances
:: Text | |
-> Text | |
-> CreateDBCluster |
Create a value of CreateDBCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:CreateDBCluster'
, createDBCluster_engineVersion
- The version number of the database engine to use for the new DB cluster.
Example: 1.0.2.1
$sel:deletionProtection:CreateDBCluster'
, createDBCluster_deletionProtection
- A value that indicates whether the DB cluster has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is enabled.
$sel:storageEncrypted:CreateDBCluster'
, createDBCluster_storageEncrypted
- Specifies whether the DB cluster is encrypted.
$sel:masterUserPassword:CreateDBCluster'
, createDBCluster_masterUserPassword
- Not supported by Neptune.
$sel:replicationSourceIdentifier:CreateDBCluster'
, createDBCluster_replicationSourceIdentifier
- The Amazon Resource Name (ARN) of the source DB instance or DB cluster
if this DB cluster is created as a Read Replica.
$sel:masterUsername:CreateDBCluster'
, createDBCluster_masterUsername
- Not supported by Neptune.
$sel:dbSubnetGroupName:CreateDBCluster'
, createDBCluster_dbSubnetGroupName
- A DB subnet group to associate with this DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
$sel:preSignedUrl:CreateDBCluster'
, createDBCluster_preSignedUrl
- This parameter is not currently supported.
$sel:preferredMaintenanceWindow:CreateDBCluster'
, createDBCluster_preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in
Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
$sel:availabilityZones:CreateDBCluster'
, createDBCluster_availabilityZones
- A list of EC2 Availability Zones that instances in the DB cluster can be
created in.
$sel:characterSetName:CreateDBCluster'
, createDBCluster_characterSetName
- (Not supported by Neptune)
$sel:kmsKeyId:CreateDBCluster'
, createDBCluster_kmsKeyId
- The Amazon KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then 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
ReplicationSourceIdentifier
identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key. - If the
StorageEncrypted
parameter is true andReplicationSourceIdentifier
is not specified, then Amazon Neptune will use your default encryption key.
Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region.
If you create a Read Replica of an encrypted DB cluster in another
Amazon Region, you must set KmsKeyId
to a KMS key ID that is valid in
the destination Amazon Region. This key is used to encrypt the Read
Replica in that Amazon Region.
$sel:preferredBackupWindow:CreateDBCluster'
, createDBCluster_preferredBackupWindow
- The daily time range during which automated backups are created if
automated backups are enabled using the BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.
Constraints:
- Must be in the format
hh24:mi-hh24:mi
. - Must be in Universal Coordinated Time (UTC).
- Must not conflict with the preferred maintenance window.
- Must be at least 30 minutes.
$sel:backupRetentionPeriod:CreateDBCluster'
, createDBCluster_backupRetentionPeriod
- The number of days for which automated backups are retained. You must
specify a minimum value of 1.
Default: 1
Constraints:
- Must be a value from 1 to 35
$sel:vpcSecurityGroupIds:CreateDBCluster'
, createDBCluster_vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB cluster.
$sel:databaseName:CreateDBCluster'
, createDBCluster_databaseName
- The name for your database of up to 64 alpha-numeric characters. If you
do not provide a name, Amazon Neptune will not create a database in the
DB cluster you are creating.
$sel:dbClusterParameterGroupName:CreateDBCluster'
, createDBCluster_dbClusterParameterGroupName
- The name of the DB cluster parameter group to associate with this DB
cluster. If this argument is omitted, the default is used.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.
$sel:optionGroupName:CreateDBCluster'
, createDBCluster_optionGroupName
- (Not supported by Neptune)
$sel:copyTagsToSnapshot:CreateDBCluster'
, createDBCluster_copyTagsToSnapshot
- /If set to true
, tags are copied to any snapshot of the DB cluster
that is created./
$sel:tags:CreateDBCluster'
, createDBCluster_tags
- The tags to assign to the new DB cluster.
$sel:port:CreateDBCluster'
, createDBCluster_port
- The port number on which the instances in the DB cluster accept
connections.
Default: 8182
$sel:enableIAMDatabaseAuthentication:CreateDBCluster'
, createDBCluster_enableIAMDatabaseAuthentication
- If set to true
, enables Amazon Identity and Access Management (IAM)
authentication for the entire DB cluster (this cannot be set at an
instance level).
Default: false
.
$sel:enableCloudwatchLogsExports:CreateDBCluster'
, createDBCluster_enableCloudwatchLogsExports
- The list of log types that need to be enabled for exporting to
CloudWatch Logs.
$sel:dbClusterIdentifier:CreateDBCluster'
, createDBCluster_dbClusterIdentifier
- The DB cluster identifier. This parameter is stored as a lowercase
string.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
$sel:engine:CreateDBCluster'
, createDBCluster_engine
- The name of the database engine to be used for this DB cluster.
Valid Values: neptune
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.
RemoveRoleFromDBCluster
data RemoveRoleFromDBCluster Source #
See: newRemoveRoleFromDBCluster
smart constructor.
Instances
newRemoveRoleFromDBCluster Source #
:: Text | |
-> Text | |
-> RemoveRoleFromDBCluster |
Create a value of RemoveRoleFromDBCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:featureName:RemoveRoleFromDBCluster'
, removeRoleFromDBCluster_featureName
- The name of the feature for the DB cluster that the IAM role is to be
disassociated from. For the list of supported feature names, see
DBEngineVersion.
$sel:dbClusterIdentifier:RemoveRoleFromDBCluster'
, removeRoleFromDBCluster_dbClusterIdentifier
- The name of the DB cluster to disassociate the IAM role from.
$sel:roleArn:RemoveRoleFromDBCluster'
, removeRoleFromDBCluster_roleArn
- The Amazon Resource Name (ARN) of the IAM role to disassociate from the
DB cluster, for example
arn:aws:iam::123456789012:role/NeptuneAccessRole
.
data RemoveRoleFromDBClusterResponse Source #
See: newRemoveRoleFromDBClusterResponse
smart constructor.
Instances
newRemoveRoleFromDBClusterResponse :: RemoveRoleFromDBClusterResponse Source #
Create a value of RemoveRoleFromDBClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
FailoverDBCluster
data FailoverDBCluster Source #
See: newFailoverDBCluster
smart constructor.
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:
$sel:dbClusterIdentifier:FailoverDBCluster'
, failoverDBCluster_dbClusterIdentifier
- A DB 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 Read Replica in the DB
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.
ModifyDBParameterGroup
data ModifyDBParameterGroup Source #
See: newModifyDBParameterGroup
smart constructor.
Instances
newModifyDBParameterGroup Source #
Create a value of ModifyDBParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroupName:ModifyDBParameterGroup'
, modifyDBParameterGroup_dbParameterGroupName
- The name of the DB parameter group.
Constraints:
- If supplied, must match the name of an existing DBParameterGroup.
$sel:parameters:ModifyDBParameterGroup'
, modifyDBParameterGroup_parameters
- An array of parameter names, values, and the apply method for the
parameter update. At least one parameter name, value, and apply method
must be supplied; subsequent arguments are optional. A maximum of 20
parameters can be modified in a single request.
Valid Values (for the application method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.
data DBParameterGroupNameMessage Source #
See: newDBParameterGroupNameMessage
smart constructor.
Instances
newDBParameterGroupNameMessage :: DBParameterGroupNameMessage Source #
Create a value of DBParameterGroupNameMessage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroupName:DBParameterGroupNameMessage'
, dbParameterGroupNameMessage_dbParameterGroupName
- Provides the name of the DB parameter group.
ApplyPendingMaintenanceAction
data ApplyPendingMaintenanceAction Source #
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:
$sel:resourceIdentifier:ApplyPendingMaintenanceAction'
, applyPendingMaintenanceAction_resourceIdentifier
- The Amazon Resource Name (ARN) of the resource that the pending
maintenance action applies to. For information about creating an ARN,
see
Constructing an Amazon Resource Name (ARN).
$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.
DescribeDBClusterParameters (Paginated)
data DescribeDBClusterParameters Source #
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.
$sel:marker:DescribeDBClusterParameters'
, describeDBClusterParameters_marker
- An optional pagination token provided by a previous
DescribeDBClusterParameters
request. If this parameter is specified,
the response includes only records beyond the marker, up to the value
specified by MaxRecords
.
$sel:maxRecords:DescribeDBClusterParameters'
, describeDBClusterParameters_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
$sel:source:DescribeDBClusterParameters'
, describeDBClusterParameters_source
- A value that indicates to return only parameters for a specific source.
Parameter sources can be engine
, service
, or customer
.
$sel:dbClusterParameterGroupName:DescribeDBClusterParameters'
, describeDBClusterParameters_dbClusterParameterGroupName
- The name of a specific DB cluster parameter group to return parameter
details for.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.
data DescribeDBClusterParametersResponse Source #
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:
$sel:marker:DescribeDBClusterParameters'
, describeDBClusterParametersResponse_marker
- An optional pagination token provided by a previous
DescribeDBClusterParameters request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords
.
$sel:parameters:DescribeDBClusterParametersResponse'
, describeDBClusterParametersResponse_parameters
- Provides a list of parameters for the DB cluster parameter group.
$sel:httpStatus:DescribeDBClusterParametersResponse'
, describeDBClusterParametersResponse_httpStatus
- The response's http status code.
DeleteDBSubnetGroup
data DeleteDBSubnetGroup Source #
See: newDeleteDBSubnetGroup
smart constructor.
Instances
newDeleteDBSubnetGroup Source #
Create a value of DeleteDBSubnetGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSubnetGroupName:DeleteDBSubnetGroup'
, deleteDBSubnetGroup_dbSubnetGroupName
- The name of the database subnet group to delete.
You can't delete the default subnet group.
Constraints:
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
data DeleteDBSubnetGroupResponse Source #
See: newDeleteDBSubnetGroupResponse
smart constructor.
Instances
newDeleteDBSubnetGroupResponse :: DeleteDBSubnetGroupResponse Source #
Create a value of DeleteDBSubnetGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeDBClusterSnapshots (Paginated)
data DescribeDBClusterSnapshots Source #
See: newDescribeDBClusterSnapshots
smart constructor.
DescribeDBClusterSnapshots' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) |
Instances
newDescribeDBClusterSnapshots :: DescribeDBClusterSnapshots Source #
Create a value of DescribeDBClusterSnapshots
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterIdentifier:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_dbClusterIdentifier
- The ID of the DB cluster to retrieve the list of DB cluster snapshots
for. This parameter can't be used in conjunction with the
DBClusterSnapshotIdentifier
parameter. This parameter is not
case-sensitive.
Constraints:
- If supplied, must match the identifier of an existing DBCluster.
$sel:includeShared:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_includeShared
- True to include shared manual DB cluster snapshots from other Amazon
accounts that this AWS account has been given permission to copy or
restore, and otherwise false. The default is false
.
You can give an Amazon account permission to restore a manual DB cluster snapshot from another Amazon account by the ModifyDBClusterSnapshotAttribute API action.
$sel:dbClusterSnapshotIdentifier:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_dbClusterSnapshotIdentifier
- A specific DB cluster snapshot identifier to describe. This parameter
can't be used in conjunction with the DBClusterIdentifier
parameter.
This value is stored as a lowercase string.
Constraints:
- If supplied, must match the identifier of an existing DBClusterSnapshot.
- If this identifier is for an automated snapshot, the
SnapshotType
parameter must also be specified.
$sel:filters:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_filters
- This parameter is not currently supported.
$sel:snapshotType:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_snapshotType
- The type of DB cluster snapshots to be returned. You can specify one of
the following values:
automated
- Return all DB cluster snapshots that have been automatically taken by Amazon Neptune for my Amazon account.manual
- Return all DB cluster snapshots that have been taken by my AWS account.shared
- Return all manual DB cluster snapshots that have been shared to my Amazon account.public
- Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and
manual DB cluster snapshots are returned. You can include shared DB
cluster snapshots with these results by setting the IncludeShared
parameter to true
. You can include public DB cluster snapshots with
these results by setting the IncludePublic
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
.
$sel:marker:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_marker
- An optional pagination token provided by a previous
DescribeDBClusterSnapshots
request. If this parameter is specified,
the response includes only records beyond the marker, up to the value
specified by MaxRecords
.
$sel:maxRecords:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
$sel:includePublic:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_includePublic
- True to include manual DB cluster snapshots that are public and can be
copied or restored by any Amazon account, and otherwise false. The
default is false
. The default is false.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
data DescribeDBClusterSnapshotsResponse Source #
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:marker:DescribeDBClusterSnapshots'
, describeDBClusterSnapshotsResponse_marker
- An optional pagination token provided by a previous
DescribeDBClusterSnapshots request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords
.
$sel:dbClusterSnapshots:DescribeDBClusterSnapshotsResponse'
, describeDBClusterSnapshotsResponse_dbClusterSnapshots
- Provides a list of DB cluster snapshots for the user.
$sel:httpStatus:DescribeDBClusterSnapshotsResponse'
, describeDBClusterSnapshotsResponse_httpStatus
- The response's http status code.
RebootDBInstance
data RebootDBInstance Source #
See: newRebootDBInstance
smart constructor.
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 MultiAZ failover.
Constraint: You can't specify true
if the instance is not configured
for MultiAZ.
$sel:dbInstanceIdentifier:RebootDBInstance'
, rebootDBInstance_dbInstanceIdentifier
- The DB instance identifier. This parameter is stored as a lowercase
string.
Constraints:
- Must match the identifier of an existing DBInstance.
data RebootDBInstanceResponse Source #
See: newRebootDBInstanceResponse
smart constructor.
Instances
newRebootDBInstanceResponse Source #
Create a value of RebootDBInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstance:RebootDBInstanceResponse'
, rebootDBInstanceResponse_dbInstance
- Undocumented member.
$sel:httpStatus:RebootDBInstanceResponse'
, rebootDBInstanceResponse_httpStatus
- The response's http status code.
CreateDBSubnetGroup
data CreateDBSubnetGroup Source #
See: newCreateDBSubnetGroup
smart constructor.
Instances
newCreateDBSubnetGroup Source #
:: Text | |
-> Text | |
-> CreateDBSubnetGroup |
Create a value of CreateDBSubnetGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateDBSubnetGroup'
, createDBSubnetGroup_tags
- The tags to be assigned to the new DB subnet group.
$sel:dbSubnetGroupName:CreateDBSubnetGroup'
, createDBSubnetGroup_dbSubnetGroupName
- The name for the DB subnet group. This value is stored as a lowercase
string.
Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
$sel:dbSubnetGroupDescription:CreateDBSubnetGroup'
, createDBSubnetGroup_dbSubnetGroupDescription
- The description for the DB subnet group.
$sel:subnetIds:CreateDBSubnetGroup'
, createDBSubnetGroup_subnetIds
- The EC2 Subnet IDs for the DB subnet group.
data CreateDBSubnetGroupResponse Source #
See: newCreateDBSubnetGroupResponse
smart constructor.
Instances
newCreateDBSubnetGroupResponse Source #
Create a value of CreateDBSubnetGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbSubnetGroup:CreateDBSubnetGroupResponse'
, createDBSubnetGroupResponse_dbSubnetGroup
- Undocumented member.
$sel:httpStatus:CreateDBSubnetGroupResponse'
, createDBSubnetGroupResponse_httpStatus
- The response's http status code.
DeleteDBInstance
data DeleteDBInstance Source #
See: newDeleteDBInstance
smart constructor.
Instances
Create a value of DeleteDBInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:finalDBSnapshotIdentifier:DeleteDBInstance'
, deleteDBInstance_finalDBSnapshotIdentifier
- The DBSnapshotIdentifier of the new DBSnapshot created when
SkipFinalSnapshot is set to false
.
Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.
Constraints:
- Must be 1 to 255 letters or numbers.
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Cannot be specified when deleting a Read Replica.
$sel:skipFinalSnapshot:DeleteDBInstance'
, deleteDBInstance_skipFinalSnapshot
- Determines whether a final DB snapshot is created before the DB instance
is deleted. If true
is specified, no DBSnapshot is created. If false
is specified, a DB snapshot is created before the DB instance is
deleted.
Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".
Specify true
when deleting a Read Replica.
The FinalDBSnapshotIdentifier parameter must be specified if
SkipFinalSnapshot is false
.
Default: false
$sel:dbInstanceIdentifier:DeleteDBInstance'
, deleteDBInstance_dbInstanceIdentifier
- The DB instance identifier for the DB instance to be deleted. This
parameter isn't case-sensitive.
Constraints:
- Must match the name of an existing DB instance.
data DeleteDBInstanceResponse Source #
See: newDeleteDBInstanceResponse
smart constructor.
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.
DeleteDBParameterGroup
data DeleteDBParameterGroup Source #
See: newDeleteDBParameterGroup
smart constructor.
Instances
newDeleteDBParameterGroup Source #
Create a value of DeleteDBParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroupName:DeleteDBParameterGroup'
, deleteDBParameterGroup_dbParameterGroupName
- The name of the DB parameter group.
Constraints:
- Must be the name of an existing DB parameter group
- You can't delete a default DB parameter group
- Cannot be associated with any DB instances
data DeleteDBParameterGroupResponse Source #
See: newDeleteDBParameterGroupResponse
smart constructor.
Instances
newDeleteDBParameterGroupResponse :: DeleteDBParameterGroupResponse Source #
Create a value of DeleteDBParameterGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
RestoreDBClusterToPointInTime
data RestoreDBClusterToPointInTime Source #
See: newRestoreDBClusterToPointInTime
smart constructor.
RestoreDBClusterToPointInTime' (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe [Tag]) (Maybe Int) (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:
$sel:deletionProtection:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_deletionProtection
- A value that indicates whether the DB cluster has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled.
$sel:useLatestRestorableTime:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_useLatestRestorableTime
- A value that is set to true
to restore the DB cluster to the latest
restorable backup time, and false
otherwise.
Default: false
Constraints: Cannot be specified if RestoreToTime
parameter is
provided.
$sel:dbSubnetGroupName:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_dbSubnetGroupName
- The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
$sel:kmsKeyId:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_kmsKeyId
- The Amazon KMS key identifier to use when restoring an encrypted DB
cluster from an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
You can restore to a new DB cluster and encrypt the new DB cluster with
a KMS key that is different than the KMS key used to encrypt the source
DB cluster. The new DB cluster is encrypted with the KMS key identified
by the KmsKeyId
parameter.
If you do not specify a value for the KmsKeyId
parameter, then the
following will occur:
- If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
- If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.
If DBClusterIdentifier
refers to a DB cluster that is not encrypted,
then the restore request is rejected.
$sel:vpcSecurityGroupIds:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_vpcSecurityGroupIds
- A list of VPC security groups that the new DB cluster belongs to.
$sel:dbClusterParameterGroupName:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_dbClusterParameterGroupName
- The name of the DB cluster parameter group to associate with the new DB
cluster.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.
$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:optionGroupName:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_optionGroupName
- (Not supported by Neptune)
$sel:restoreToTime:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_restoreToTime
- The date and time to restore the DB cluster to.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
- Must be before the latest restorable time for the DB instance
- Must be specified if
UseLatestRestorableTime
parameter is not provided - Cannot be specified if
UseLatestRestorableTime
parameter is true - Cannot be specified if
RestoreType
parameter iscopy-on-write
Example: 2015-03-07T23:45:00Z
$sel:tags:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_tags
- The tags to be applied to the restored DB cluster.
$sel:port:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_port
- The port number on which the new DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
$sel:enableIAMDatabaseAuthentication:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_enableIAMDatabaseAuthentication
- True to enable mapping of Amazon Identity and Access Management (IAM)
accounts to database accounts, and otherwise false.
Default: false
$sel:enableCloudwatchLogsExports:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_enableCloudwatchLogsExports
- The list of logs that the restored DB cluster is to export to CloudWatch
Logs.
$sel:dbClusterIdentifier:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_dbClusterIdentifier
- The name of the new DB cluster to be created.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
$sel:sourceDBClusterIdentifier:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_sourceDBClusterIdentifier
- The identifier of the source DB cluster from which to restore.
Constraints:
- Must match the identifier of an existing DBCluster.
data RestoreDBClusterToPointInTimeResponse Source #
See: newRestoreDBClusterToPointInTimeResponse
smart constructor.
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.
DescribeDBInstances (Paginated)
data DescribeDBInstances Source #
See: newDescribeDBInstances
smart constructor.
Instances
newDescribeDBInstances :: DescribeDBInstances Source #
Create a value of DescribeDBInstances
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeDBInstances'
, describeDBInstances_filters
- A filter that specifies one or more DB instances to describe.
Supported filters:
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.engine
- Accepts an engine name (such asneptune
), and restricts the results list to DB instances created by that engine.
For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB instances are returned, you could use the following command:
$sel:dbInstanceIdentifier:DescribeDBInstances'
, describeDBInstances_dbInstanceIdentifier
- The user-supplied instance identifier. If this parameter is specified,
information from only the specific DB instance is returned. This
parameter isn't case-sensitive.
Constraints:
- If supplied, must match the identifier of an existing DBInstance.
$sel:marker:DescribeDBInstances'
, describeDBInstances_marker
- An optional pagination token provided by a previous
DescribeDBInstances
request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords
.
$sel:maxRecords:DescribeDBInstances'
, describeDBInstances_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeDBInstancesResponse Source #
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
- A list of DBInstance instances.
$sel:marker:DescribeDBInstances'
, describeDBInstancesResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:httpStatus:DescribeDBInstancesResponse'
, describeDBInstancesResponse_httpStatus
- The response's http status code.
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 #
Specifies 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.
CharacterSet
data CharacterSet Source #
Specifies a character set.
See: newCharacterSet
smart constructor.
CharacterSet' (Maybe Text) (Maybe Text) |
Instances
newCharacterSet :: CharacterSet Source #
Create a value of CharacterSet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:characterSetName:CharacterSet'
, characterSet_characterSetName
- The name of the character set.
$sel:characterSetDescription:CharacterSet'
, characterSet_characterSetDescription
- The description of the character set.
CloudwatchLogsExportConfiguration
data CloudwatchLogsExportConfiguration Source #
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
The EnableLogTypes
and DisableLogTypes
arrays determine which logs
will be exported (or not exported) to CloudWatch Logs.
See: newCloudwatchLogsExportConfiguration
smart constructor.
Instances
Eq CloudwatchLogsExportConfiguration Source # | |
Read CloudwatchLogsExportConfiguration Source # | |
Show CloudwatchLogsExportConfiguration Source # | |
Generic CloudwatchLogsExportConfiguration Source # | |
NFData CloudwatchLogsExportConfiguration Source # | |
Hashable CloudwatchLogsExportConfiguration Source # | |
ToQuery CloudwatchLogsExportConfiguration Source # | |
type Rep CloudwatchLogsExportConfiguration Source # | |
Defined in Amazonka.Neptune.Types.CloudwatchLogsExportConfiguration type Rep CloudwatchLogsExportConfiguration = D1 ('MetaData "CloudwatchLogsExportConfiguration" "Amazonka.Neptune.Types.CloudwatchLogsExportConfiguration" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" 'False) (C1 ('MetaCons "CloudwatchLogsExportConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "disableLogTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "enableLogTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) |
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
Contains the details of an Amazon Neptune DB cluster.
This data type is used as a response element in the DescribeDBClusters action.
See: newDBCluster
smart constructor.
DBCluster' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe ISO8601) (Maybe Bool) (Maybe Text) (Maybe [DBClusterMember]) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [DBClusterRole]) (Maybe [VpcSecurityGroupMembership]) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Int) (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [DBClusterOptionGroupStatus]) |
Instances
newDBCluster :: DBCluster Source #
Create a value of DBCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:DBCluster'
, dbCluster_engineVersion
- Indicates the database engine version.
$sel:status:DBCluster'
, dbCluster_status
- Specifies the current state of this DB cluster.
$sel:deletionProtection:DBCluster'
, dbCluster_deletionProtection
- Indicates whether or not the DB cluster has deletion protection enabled.
The database can't be deleted when deletion protection is enabled.
$sel:automaticRestartTime:DBCluster'
, dbCluster_automaticRestartTime
- Time at which the DB cluster will be automatically restarted.
$sel:storageEncrypted:DBCluster'
, dbCluster_storageEncrypted
- Specifies whether the DB cluster is encrypted.
$sel:dbClusterIdentifier:DBCluster'
, dbCluster_dbClusterIdentifier
- Contains a user-supplied DB cluster identifier. This identifier is the
unique key that identifies a DB cluster.
$sel:dbClusterMembers:DBCluster'
, dbCluster_dbClusterMembers
- Provides the list of instances that make up the DB cluster.
$sel:readReplicaIdentifiers:DBCluster'
, dbCluster_readReplicaIdentifiers
- Contains one or more identifiers of the Read Replicas associated with
this DB cluster.
$sel:replicationSourceIdentifier:DBCluster'
, dbCluster_replicationSourceIdentifier
- Not supported by Neptune.
$sel:hostedZoneId:DBCluster'
, dbCluster_hostedZoneId
- Specifies the ID that Amazon Route 53 assigns when you create a hosted
zone.
$sel:dbClusterParameterGroup:DBCluster'
, dbCluster_dbClusterParameterGroup
- Specifies the name of the DB cluster parameter group for the DB cluster.
$sel:masterUsername:DBCluster'
, dbCluster_masterUsername
- Not supported by Neptune.
$sel:iAMDatabaseAuthenticationEnabled:DBCluster'
, dbCluster_iAMDatabaseAuthenticationEnabled
- True if mapping of Amazon Identity and Access Management (IAM) accounts
to database accounts is enabled, and otherwise false.
$sel:dbClusterResourceId:DBCluster'
, dbCluster_dbClusterResourceId
- The Amazon Region-unique, immutable identifier for the DB cluster. This
identifier is found in Amazon CloudTrail log entries whenever the Amazon
KMS key for the DB cluster is accessed.
$sel:earliestRestorableTime:DBCluster'
, dbCluster_earliestRestorableTime
- Specifies the earliest time to which a database can be restored with
point-in-time restore.
$sel:engine:DBCluster'
, dbCluster_engine
- Provides the name of the database engine to be used for this DB cluster.
$sel:dbClusterArn:DBCluster'
, dbCluster_dbClusterArn
- The Amazon Resource Name (ARN) for the DB cluster.
$sel:cloneGroupId:DBCluster'
, dbCluster_cloneGroupId
- Identifies the clone group to which the DB cluster is associated.
$sel:latestRestorableTime:DBCluster'
, dbCluster_latestRestorableTime
- Specifies the latest time to which a database can be restored with
point-in-time restore.
$sel:crossAccountClone:DBCluster'
, dbCluster_crossAccountClone
- If set to true
, the DB cluster can be cloned across accounts.
$sel:preferredMaintenanceWindow:DBCluster'
, dbCluster_preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC).
$sel:availabilityZones:DBCluster'
, dbCluster_availabilityZones
- Provides the list of EC2 Availability Zones that instances in the DB
cluster can be created in.
$sel:characterSetName:DBCluster'
, dbCluster_characterSetName
- Not supported by Neptune.
$sel:kmsKeyId:DBCluster'
, dbCluster_kmsKeyId
- If StorageEncrypted
is true, the Amazon KMS key identifier for the
encrypted DB cluster.
$sel:preferredBackupWindow:DBCluster'
, dbCluster_preferredBackupWindow
- Specifies the daily time range during which automated backups are
created if automated backups are enabled, as determined by the
BackupRetentionPeriod
.
$sel:associatedRoles:DBCluster'
, dbCluster_associatedRoles
- Provides a list of the Amazon Identity and Access Management (IAM) roles
that are associated with the DB cluster. IAM roles that are associated
with a DB cluster grant permission for the DB cluster to access other
Amazon services on your behalf.
$sel:vpcSecurityGroups:DBCluster'
, dbCluster_vpcSecurityGroups
- Provides a list of VPC security groups that the DB cluster belongs to.
$sel:backupRetentionPeriod:DBCluster'
, dbCluster_backupRetentionPeriod
- Specifies the number of days for which automatic DB snapshots are
retained.
$sel:dbSubnetGroup:DBCluster'
, dbCluster_dbSubnetGroup
- Specifies information on the subnet group associated with the DB
cluster, including the name, description, and subnets in the subnet
group.
$sel:databaseName:DBCluster'
, dbCluster_databaseName
- Contains the name of the initial database of this DB cluster that was
provided at create time, if one was specified when the DB cluster was
created. This same name is returned for the life of the DB cluster.
$sel:multiAZ:DBCluster'
, dbCluster_multiAZ
- Specifies whether the DB cluster has instances in multiple Availability
Zones.
$sel:enabledCloudwatchLogsExports:DBCluster'
, dbCluster_enabledCloudwatchLogsExports
- A list of log types that this DB cluster is configured to export to
CloudWatch Logs.
$sel:allocatedStorage:DBCluster'
, dbCluster_allocatedStorage
- AllocatedStorage
always returns 1, because Neptune DB cluster storage
size is not fixed, but instead automatically adjusts as needed.
$sel:copyTagsToSnapshot:DBCluster'
, dbCluster_copyTagsToSnapshot
- /If set to true
, tags are copied to any snapshot of the DB cluster
that is created./
$sel:clusterCreateTime:DBCluster'
, dbCluster_clusterCreateTime
- Specifies the time when the DB cluster was created, in Universal
Coordinated Time (UTC).
$sel:endpoint:DBCluster'
, dbCluster_endpoint
- Specifies the connection endpoint for the primary instance of the DB
cluster.
$sel:percentProgress:DBCluster'
, dbCluster_percentProgress
- Specifies the progress of the operation as a percentage.
$sel:readerEndpoint:DBCluster'
, dbCluster_readerEndpoint
- The reader endpoint for the DB cluster. The reader endpoint for a DB
cluster load-balances connections across the Read Replicas that are
available in a DB cluster. As clients request new connections to the
reader endpoint, Neptune distributes the connection requests among the
Read Replicas in the DB cluster. This functionality can help balance
your read workload across multiple Read Replicas in your DB cluster.
If a failover occurs, and the Read 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 Read Replicas in the cluster, you can then reconnect to the reader endpoint.
$sel:port:DBCluster'
, dbCluster_port
- Specifies the port that the database engine is listening on.
$sel:dbClusterOptionGroupMemberships:DBCluster'
, dbCluster_dbClusterOptionGroupMemberships
- Not supported by Neptune.
DBClusterEndpoint
data DBClusterEndpoint Source #
This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpoint
DescribeDBClusterEndpoints
ModifyDBClusterEndpoint
DeleteDBClusterEndpoint
For the data structure that represents Amazon Neptune DB instance
endpoints, see Endpoint
.
See: newDBClusterEndpoint
smart constructor.
DBClusterEndpoint' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) |
Instances
newDBClusterEndpoint :: DBClusterEndpoint Source #
Create a value of DBClusterEndpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DBClusterEndpoint'
, dbClusterEndpoint_status
- The current status of the endpoint. One of: creating
, available
,
deleting
, inactive
, modifying
. The inactive
state applies to an
endpoint that cannot be used for a certain kind of cluster, such as a
writer
endpoint for a read-only secondary cluster in a global
database.
$sel:dbClusterIdentifier:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterIdentifier
- The DB cluster identifier of the DB cluster associated with the
endpoint. This parameter is stored as a lowercase string.
$sel:dbClusterEndpointArn:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterEndpointArn
- The Amazon Resource Name (ARN) for the endpoint.
$sel:customEndpointType:DBClusterEndpoint'
, dbClusterEndpoint_customEndpointType
- The type associated with a custom endpoint. One of: READER
, WRITER
,
ANY
.
$sel:staticMembers:DBClusterEndpoint'
, dbClusterEndpoint_staticMembers
- List of DB instance identifiers that are part of the custom endpoint
group.
$sel:endpointType:DBClusterEndpoint'
, dbClusterEndpoint_endpointType
- The type of the endpoint. One of: READER
, WRITER
, CUSTOM
.
$sel:dbClusterEndpointIdentifier:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterEndpointIdentifier
- The identifier associated with the endpoint. This parameter is stored as
a lowercase string.
$sel:endpoint:DBClusterEndpoint'
, dbClusterEndpoint_endpoint
- The DNS address of the endpoint.
$sel:dbClusterEndpointResourceIdentifier:DBClusterEndpoint'
, dbClusterEndpoint_dbClusterEndpointResourceIdentifier
- A unique system-generated identifier for an endpoint. It remains the
same for the whole life of the endpoint.
$sel:excludedMembers:DBClusterEndpoint'
, dbClusterEndpoint_excludedMembers
- List of DB instance identifiers that aren't part of the custom endpoint
group. All other eligible instances are reachable through the custom
endpoint. Only relevant if the list of static members is empty.
DBClusterMember
data DBClusterMember Source #
Contains information about an instance that is part of a DB cluster.
See: newDBClusterMember
smart constructor.
Instances
newDBClusterMember :: DBClusterMember Source #
Create a value of DBClusterMember
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:promotionTier:DBClusterMember'
, dbClusterMember_promotionTier
- A value that specifies the order in which a Read Replica is promoted to
the primary instance after a failure of the existing primary instance.
$sel:dbInstanceIdentifier:DBClusterMember'
, dbClusterMember_dbInstanceIdentifier
- Specifies the instance identifier for this member of the DB cluster.
$sel:isClusterWriter:DBClusterMember'
, dbClusterMember_isClusterWriter
- Value that is true
if the cluster member is the primary instance for
the DB cluster and false
otherwise.
$sel:dbClusterParameterGroupStatus:DBClusterMember'
, dbClusterMember_dbClusterParameterGroupStatus
- Specifies the status of the DB cluster parameter group for this member
of the DB cluster.
DBClusterOptionGroupStatus
data DBClusterOptionGroupStatus Source #
Not supported by Neptune.
See: newDBClusterOptionGroupStatus
smart constructor.
Instances
newDBClusterOptionGroupStatus :: DBClusterOptionGroupStatus Source #
Create a value of DBClusterOptionGroupStatus
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DBClusterOptionGroupStatus'
, dbClusterOptionGroupStatus_status
- Not supported by Neptune.
$sel:dbClusterOptionGroupName:DBClusterOptionGroupStatus'
, dbClusterOptionGroupStatus_dbClusterOptionGroupName
- Not supported by Neptune.
DBClusterParameterGroup
data DBClusterParameterGroup Source #
Contains the details of an Amazon Neptune DB cluster parameter group.
This data type is used as a response element in the DescribeDBClusterParameterGroups action.
See: newDBClusterParameterGroup
smart constructor.
Instances
newDBClusterParameterGroup :: DBClusterParameterGroup Source #
Create a value of DBClusterParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterParameterGroupArn:DBClusterParameterGroup'
, dbClusterParameterGroup_dbClusterParameterGroupArn
- The Amazon Resource Name (ARN) for the DB cluster parameter group.
$sel:dbParameterGroupFamily:DBClusterParameterGroup'
, dbClusterParameterGroup_dbParameterGroupFamily
- Provides the name of the DB parameter group family that this DB cluster
parameter group is compatible with.
$sel:dbClusterParameterGroupName:DBClusterParameterGroup'
, dbClusterParameterGroup_dbClusterParameterGroupName
- Provides the name of the DB cluster parameter group.
$sel:description:DBClusterParameterGroup'
, dbClusterParameterGroup_description
- Provides the customer-specified description for this DB cluster
parameter group.
DBClusterParameterGroupNameMessage
data DBClusterParameterGroupNameMessage Source #
See: newDBClusterParameterGroupNameMessage
smart constructor.
Instances
newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage Source #
Create a value of DBClusterParameterGroupNameMessage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbClusterParameterGroupName:DBClusterParameterGroupNameMessage'
, dbClusterParameterGroupNameMessage_dbClusterParameterGroupName
- The name of the DB cluster parameter group.
Constraints:
- Must be 1 to 255 letters or numbers.
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
DBClusterRole
data DBClusterRole Source #
Describes an Amazon Identity and Access Management (IAM) role that is associated with a DB cluster.
See: newDBClusterRole
smart constructor.
Instances
newDBClusterRole :: DBClusterRole Source #
Create a value of DBClusterRole
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DBClusterRole'
, dbClusterRole_status
- Describes the state of association between the IAM role and the DB
cluster. The Status property returns one of the following values:
ACTIVE
- the IAM role ARN is associated with the DB cluster and can be used to access other Amazon services on your behalf.PENDING
- the IAM role ARN is being associated with the DB cluster.INVALID
- the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon services on your behalf.
$sel:featureName:DBClusterRole'
, dbClusterRole_featureName
- The name of the feature associated with the Amazon Identity and Access
Management (IAM) role. For the list of supported feature names, see
DBEngineVersion.
$sel:roleArn:DBClusterRole'
, dbClusterRole_roleArn
- The Amazon Resource Name (ARN) of the IAM role that is associated with
the DB cluster.
DBClusterSnapshot
data DBClusterSnapshot Source #
Contains the details for an Amazon Neptune DB cluster snapshot
This data type is used as a response element in the DescribeDBClusterSnapshots action.
See: newDBClusterSnapshot
smart constructor.
DBClusterSnapshot' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Int) (Maybe Text) (Maybe ISO8601) (Maybe Int) (Maybe Int) |
Instances
newDBClusterSnapshot :: DBClusterSnapshot Source #
Create a value of DBClusterSnapshot
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:DBClusterSnapshot'
, dbClusterSnapshot_engineVersion
- Provides the version of the database engine for this DB cluster
snapshot.
$sel:status:DBClusterSnapshot'
, dbClusterSnapshot_status
- Specifies the status of this DB cluster snapshot.
$sel:storageEncrypted:DBClusterSnapshot'
, dbClusterSnapshot_storageEncrypted
- Specifies whether the DB cluster snapshot is encrypted.
$sel:dbClusterIdentifier:DBClusterSnapshot'
, dbClusterSnapshot_dbClusterIdentifier
- Specifies the DB cluster identifier of the DB cluster that this DB
cluster snapshot was created from.
$sel:masterUsername:DBClusterSnapshot'
, dbClusterSnapshot_masterUsername
- Not supported by Neptune.
$sel:iAMDatabaseAuthenticationEnabled:DBClusterSnapshot'
, dbClusterSnapshot_iAMDatabaseAuthenticationEnabled
- True if mapping of Amazon Identity and Access Management (IAM) accounts
to database accounts is enabled, and otherwise false.
$sel:dbClusterSnapshotArn:DBClusterSnapshot'
, dbClusterSnapshot_dbClusterSnapshotArn
- The Amazon Resource Name (ARN) for the DB cluster snapshot.
$sel:vpcId:DBClusterSnapshot'
, dbClusterSnapshot_vpcId
- Provides the VPC ID associated with the DB cluster snapshot.
$sel:dbClusterSnapshotIdentifier:DBClusterSnapshot'
, dbClusterSnapshot_dbClusterSnapshotIdentifier
- Specifies the identifier for a DB cluster snapshot. Must match the
identifier of an existing snapshot.
After you restore a DB cluster using a DBClusterSnapshotIdentifier
,
you must specify the same DBClusterSnapshotIdentifier
for any future
updates to the DB cluster. When you specify this property for an update,
the DB cluster is not restored from the snapshot again, and the data in
the database is not changed.
However, if you don't specify the DBClusterSnapshotIdentifier
, an
empty DB cluster is created, and the original DB cluster is deleted. If
you specify a property that is different from the previous snapshot
restore property, the DB cluster is restored from the snapshot specified
by the DBClusterSnapshotIdentifier
, and the original DB cluster is
deleted.
$sel:engine:DBClusterSnapshot'
, dbClusterSnapshot_engine
- Specifies the name of the database engine.
$sel:licenseModel:DBClusterSnapshot'
, dbClusterSnapshot_licenseModel
- Provides the license model information for this DB cluster snapshot.
$sel:availabilityZones:DBClusterSnapshot'
, dbClusterSnapshot_availabilityZones
- Provides the list of EC2 Availability Zones that instances in the DB
cluster snapshot can be restored in.
$sel:snapshotType:DBClusterSnapshot'
, dbClusterSnapshot_snapshotType
- Provides the type of the DB cluster snapshot.
$sel:kmsKeyId:DBClusterSnapshot'
, dbClusterSnapshot_kmsKeyId
- If StorageEncrypted
is true, the Amazon KMS key identifier for the
encrypted DB cluster snapshot.
$sel:snapshotCreateTime:DBClusterSnapshot'
, dbClusterSnapshot_snapshotCreateTime
- Provides the time when the snapshot was taken, in Universal Coordinated
Time (UTC).
$sel:allocatedStorage:DBClusterSnapshot'
, dbClusterSnapshot_allocatedStorage
- Specifies the allocated storage size in gibibytes (GiB).
$sel:sourceDBClusterSnapshotArn:DBClusterSnapshot'
, dbClusterSnapshot_sourceDBClusterSnapshotArn
- If the DB cluster snapshot was copied from a source DB cluster snapshot,
the Amazon Resource Name (ARN) for the source DB cluster snapshot,
otherwise, a null value.
$sel:clusterCreateTime:DBClusterSnapshot'
, dbClusterSnapshot_clusterCreateTime
- Specifies the time when the DB cluster was created, in Universal
Coordinated Time (UTC).
$sel:percentProgress:DBClusterSnapshot'
, dbClusterSnapshot_percentProgress
- Specifies the percentage of the estimated data that has been
transferred.
$sel:port:DBClusterSnapshot'
, dbClusterSnapshot_port
- Specifies the port that the DB cluster was listening on at the time of
the snapshot.
DBClusterSnapshotAttribute
data DBClusterSnapshotAttribute Source #
Contains the name and values of a manual DB cluster snapshot attribute.
Manual DB cluster snapshot attributes are used to authorize other Amazon accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
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:attributeValues:DBClusterSnapshotAttribute'
, dbClusterSnapshotAttribute_attributeValues
- The value(s) for the manual DB cluster snapshot attribute.
If the AttributeName
field is set to restore
, then this element
returns a list of IDs of the Amazon accounts that are authorized to copy
or restore the manual DB cluster snapshot. If a value of all
is in the
list, then the manual DB cluster snapshot is public and available for
any Amazon account to copy or restore.
$sel:attributeName:DBClusterSnapshotAttribute'
, dbClusterSnapshotAttribute_attributeName
- The name of the manual DB cluster snapshot attribute.
The attribute named restore
refers to the list of Amazon accounts that
have permission to copy or restore the manual DB cluster snapshot. For
more information, see the ModifyDBClusterSnapshotAttribute API action.
DBClusterSnapshotAttributesResult
data DBClusterSnapshotAttributesResult Source #
Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.
Manual DB cluster snapshot attributes are used to authorize other Amazon accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
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:dbClusterSnapshotIdentifier:DBClusterSnapshotAttributesResult'
, dbClusterSnapshotAttributesResult_dbClusterSnapshotIdentifier
- The identifier of the manual DB cluster snapshot that the attributes
apply to.
$sel:dbClusterSnapshotAttributes:DBClusterSnapshotAttributesResult'
, dbClusterSnapshotAttributesResult_dbClusterSnapshotAttributes
- The list of attributes and values for the manual DB cluster snapshot.
DBEngineVersion
data DBEngineVersion Source #
This data type is used as a response element in the action DescribeDBEngineVersions.
See: newDBEngineVersion
smart constructor.
DBEngineVersion' (Maybe Text) (Maybe Text) (Maybe CharacterSet) (Maybe Text) (Maybe Text) (Maybe [CharacterSet]) (Maybe Text) (Maybe [UpgradeTarget]) (Maybe Bool) (Maybe Bool) (Maybe [Timezone]) (Maybe [Text]) |
Instances
newDBEngineVersion :: DBEngineVersion Source #
Create a value of DBEngineVersion
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:DBEngineVersion'
, dbEngineVersion_engineVersion
- The version number of the database engine.
$sel:dbEngineVersionDescription:DBEngineVersion'
, dbEngineVersion_dbEngineVersionDescription
- The description of the database engine version.
$sel:defaultCharacterSet:DBEngineVersion'
, dbEngineVersion_defaultCharacterSet
- (Not supported by Neptune)
$sel:engine:DBEngineVersion'
, dbEngineVersion_engine
- The name of the database engine.
$sel:dbParameterGroupFamily:DBEngineVersion'
, dbEngineVersion_dbParameterGroupFamily
- The name of the DB parameter group family for the database engine.
$sel:supportedCharacterSets:DBEngineVersion'
, dbEngineVersion_supportedCharacterSets
- (Not supported by Neptune)
$sel:dbEngineDescription:DBEngineVersion'
, dbEngineVersion_dbEngineDescription
- The description of the database engine.
$sel:validUpgradeTarget:DBEngineVersion'
, dbEngineVersion_validUpgradeTarget
- A list of engine versions that this database engine version can be
upgraded to.
$sel:supportsLogExportsToCloudwatchLogs:DBEngineVersion'
, dbEngineVersion_supportsLogExportsToCloudwatchLogs
- A value that indicates whether the engine version supports exporting the
log types specified by ExportableLogTypes to CloudWatch Logs.
$sel:supportsReadReplica:DBEngineVersion'
, dbEngineVersion_supportsReadReplica
- Indicates whether the database engine version supports read replicas.
$sel:supportedTimezones:DBEngineVersion'
, dbEngineVersion_supportedTimezones
- A list of the time zones supported by this engine for the Timezone
parameter of the CreateDBInstance
action.
$sel:exportableLogTypes:DBEngineVersion'
, dbEngineVersion_exportableLogTypes
- The types of logs that the database engine has available for export to
CloudWatch Logs.
DBInstance
data DBInstance Source #
Contains the details of an Amazon Neptune DB instance.
This data type is used as a response element in the DescribeDBInstances action.
See: newDBInstance
smart constructor.
DBInstance' (Maybe Text) (Maybe [DBSecurityGroupMembership]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe ISO8601) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [VpcSecurityGroupMembership]) (Maybe Int) (Maybe Text) (Maybe DBSubnetGroup) (Maybe Bool) (Maybe [OptionGroupMembership]) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe [DBParameterGroupStatus]) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Endpoint) (Maybe Text) (Maybe Int) (Maybe PendingModifiedValues) (Maybe [Text]) (Maybe Text) (Maybe [DBInstanceStatusInfo]) (Maybe [DomainMembership]) (Maybe Text) |
Instances
newDBInstance :: DBInstance Source #
Create a value of DBInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:DBInstance'
, dbInstance_engineVersion
- Indicates the database engine version.
$sel:dbSecurityGroups:DBInstance'
, dbInstance_dbSecurityGroups
- Provides List of DB security group elements containing only
DBSecurityGroup.Name
and DBSecurityGroup.Status
subelements.
$sel:deletionProtection:DBInstance'
, dbInstance_deletionProtection
- Indicates whether or not the DB instance has deletion protection
enabled. The instance can't be deleted when deletion protection is
enabled. See
Deleting a DB Instance.
$sel:storageEncrypted:DBInstance'
, dbInstance_storageEncrypted
- Not supported: The encryption for DB instances is managed by the DB
cluster.
$sel:dbClusterIdentifier:DBInstance'
, dbInstance_dbClusterIdentifier
- If the DB instance is a member of a DB cluster, contains the name of the
DB cluster that the DB instance is a member of.
$sel:publiclyAccessible:DBInstance'
, dbInstance_publiclyAccessible
- This flag should no longer be used.
$sel:autoMinorVersionUpgrade:DBInstance'
, dbInstance_autoMinorVersionUpgrade
- Indicates that minor version patches are applied automatically.
$sel:dbInstanceArn:DBInstance'
, dbInstance_dbInstanceArn
- The Amazon Resource Name (ARN) for the DB instance.
$sel:masterUsername:DBInstance'
, dbInstance_masterUsername
- Not supported by Neptune.
$sel:readReplicaDBInstanceIdentifiers:DBInstance'
, dbInstance_readReplicaDBInstanceIdentifiers
- Contains one or more identifiers of the Read Replicas associated with
this DB instance.
$sel:iAMDatabaseAuthenticationEnabled:DBInstance'
, dbInstance_iAMDatabaseAuthenticationEnabled
- True if Amazon Identity and Access Management (IAM) authentication is
enabled, and otherwise false.
$sel:monitoringRoleArn:DBInstance'
, dbInstance_monitoringRoleArn
- The ARN for the IAM role that permits Neptune to send Enhanced
Monitoring metrics to Amazon CloudWatch Logs.
$sel:iops:DBInstance'
, dbInstance_iops
- Specifies the Provisioned IOPS (I/O operations per second) value.
$sel:instanceCreateTime:DBInstance'
, dbInstance_instanceCreateTime
- Provides the date and time the DB instance was created.
$sel:readReplicaSourceDBInstanceIdentifier:DBInstance'
, dbInstance_readReplicaSourceDBInstanceIdentifier
- Contains the identifier of the source DB instance if this DB instance is
a Read Replica.
$sel:monitoringInterval:DBInstance'
, dbInstance_monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance.
$sel:engine:DBInstance'
, dbInstance_engine
- Provides the name of the database engine to be used for this DB
instance.
$sel:latestRestorableTime:DBInstance'
, dbInstance_latestRestorableTime
- Specifies the latest time to which a database can be restored with
point-in-time restore.
$sel:dbInstanceClass:DBInstance'
, dbInstance_dbInstanceClass
- Contains the name of the compute and memory capacity class of the DB
instance.
$sel:promotionTier:DBInstance'
, dbInstance_promotionTier
- A value that specifies the order in which a Read Replica is promoted to
the primary instance after a failure of the existing primary instance.
$sel:licenseModel:DBInstance'
, dbInstance_licenseModel
- License model information for this DB instance.
$sel:preferredMaintenanceWindow:DBInstance'
, dbInstance_preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC).
$sel:cACertificateIdentifier:DBInstance'
, dbInstance_cACertificateIdentifier
- The identifier of the CA certificate for this DB instance.
$sel:dbInstanceIdentifier:DBInstance'
, dbInstance_dbInstanceIdentifier
- Contains a user-supplied database identifier. This identifier is the
unique key that identifies a DB instance.
$sel:characterSetName:DBInstance'
, dbInstance_characterSetName
- (Not supported by Neptune)
$sel:kmsKeyId:DBInstance'
, dbInstance_kmsKeyId
- Not supported: The encryption for DB instances is managed by the DB
cluster.
$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:availabilityZone:DBInstance'
, dbInstance_availabilityZone
- Specifies the name of the Availability Zone the DB instance is located
in.
$sel:vpcSecurityGroups:DBInstance'
, dbInstance_vpcSecurityGroups
- Provides a list of VPC security group elements that the DB instance
belongs to.
$sel:backupRetentionPeriod:DBInstance'
, dbInstance_backupRetentionPeriod
- Specifies the number of days for which automatic DB snapshots are
retained.
$sel:performanceInsightsKMSKeyId:DBInstance'
, dbInstance_performanceInsightsKMSKeyId
- (Not supported by Neptune)
$sel:dbSubnetGroup:DBInstance'
, dbInstance_dbSubnetGroup
- Specifies information on the subnet group associated with the DB
instance, including the name, description, and subnets in the subnet
group.
$sel:multiAZ:DBInstance'
, dbInstance_multiAZ
- Specifies if the DB instance is a Multi-AZ deployment.
$sel:optionGroupMemberships:DBInstance'
, dbInstance_optionGroupMemberships
- (Not supported by Neptune)
$sel:enabledCloudwatchLogsExports:DBInstance'
, dbInstance_enabledCloudwatchLogsExports
- A list of log types that this DB instance is configured to export to
CloudWatch Logs.
$sel:enhancedMonitoringResourceArn:DBInstance'
, dbInstance_enhancedMonitoringResourceArn
- The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream
that receives the Enhanced Monitoring metrics data for the DB instance.
$sel:secondaryAvailabilityZone:DBInstance'
, dbInstance_secondaryAvailabilityZone
- If present, specifies the name of the secondary Availability Zone for a
DB instance with multi-AZ support.
$sel:performanceInsightsEnabled:DBInstance'
, dbInstance_performanceInsightsEnabled
- (Not supported by Neptune)
$sel:allocatedStorage:DBInstance'
, dbInstance_allocatedStorage
- Not supported by Neptune.
$sel:dbiResourceId:DBInstance'
, dbInstance_dbiResourceId
- The Amazon Region-unique, immutable identifier for the DB instance. This
identifier is found in Amazon CloudTrail log entries whenever the Amazon
KMS key for the DB instance is accessed.
$sel:dbParameterGroups:DBInstance'
, dbInstance_dbParameterGroups
- Provides the list of DB parameter groups applied to this DB instance.
$sel:copyTagsToSnapshot:DBInstance'
, dbInstance_copyTagsToSnapshot
- Specifies whether tags are copied from the DB instance to snapshots of
the DB instance.
$sel:timezone:DBInstance'
, dbInstance_timezone
- Not supported.
$sel:tdeCredentialArn:DBInstance'
, dbInstance_tdeCredentialArn
- The ARN from the key store with which the instance is associated for TDE
encryption.
$sel:endpoint:DBInstance'
, dbInstance_endpoint
- Specifies the connection endpoint.
$sel:dbInstanceStatus:DBInstance'
, dbInstance_dbInstanceStatus
- Specifies the current state of this database.
$sel:dbInstancePort:DBInstance'
, dbInstance_dbInstancePort
- Specifies the port that the DB instance listens on. If the DB instance
is part of a DB cluster, this can be a different port than the DB
cluster port.
$sel:pendingModifiedValues:DBInstance'
, dbInstance_pendingModifiedValues
- Specifies that changes to the DB instance are pending. This element is
only included when changes are pending. Specific changes are identified
by subelements.
$sel:readReplicaDBClusterIdentifiers:DBInstance'
, dbInstance_readReplicaDBClusterIdentifiers
- Contains one or more identifiers of DB clusters that are Read Replicas
of this DB instance.
$sel:storageType:DBInstance'
, dbInstance_storageType
- Specifies the storage type associated with DB instance.
$sel:statusInfos:DBInstance'
, dbInstance_statusInfos
- The status of a Read Replica. If the instance is not a Read Replica,
this is blank.
$sel:domainMemberships:DBInstance'
, dbInstance_domainMemberships
- Not supported
$sel:dbName:DBInstance'
, dbInstance_dbName
- The database name.
DBInstanceStatusInfo
data DBInstanceStatusInfo Source #
Provides a list of status information for a DB instance.
See: newDBInstanceStatusInfo
smart constructor.
Instances
newDBInstanceStatusInfo :: DBInstanceStatusInfo Source #
Create a value of DBInstanceStatusInfo
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DBInstanceStatusInfo'
, dbInstanceStatusInfo_status
- Status of the DB instance. For a StatusType of read replica, the values
can be replicating, error, stopped, or terminated.
$sel:normal:DBInstanceStatusInfo'
, dbInstanceStatusInfo_normal
- Boolean value that is true if the instance is operating normally, or
false if the instance is in an error state.
$sel:statusType:DBInstanceStatusInfo'
, dbInstanceStatusInfo_statusType
- This value is currently "read replication."
$sel:message:DBInstanceStatusInfo'
, dbInstanceStatusInfo_message
- Details of the error if there is an error for the instance. If the
instance is not in an error state, this value is blank.
DBParameterGroup
data DBParameterGroup Source #
Contains the details of an Amazon Neptune DB parameter group.
This data type is used as a response element in the DescribeDBParameterGroups action.
See: newDBParameterGroup
smart constructor.
Instances
newDBParameterGroup :: DBParameterGroup Source #
Create a value of DBParameterGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroupArn:DBParameterGroup'
, dbParameterGroup_dbParameterGroupArn
- The Amazon Resource Name (ARN) for the DB parameter group.
$sel:dbParameterGroupFamily:DBParameterGroup'
, dbParameterGroup_dbParameterGroupFamily
- Provides the name of the DB parameter group family that this DB
parameter group is compatible with.
$sel:dbParameterGroupName:DBParameterGroup'
, dbParameterGroup_dbParameterGroupName
- Provides the name of the DB parameter group.
$sel:description:DBParameterGroup'
, dbParameterGroup_description
- Provides the customer-specified description for this DB parameter group.
DBParameterGroupNameMessage
data DBParameterGroupNameMessage Source #
See: newDBParameterGroupNameMessage
smart constructor.
Instances
newDBParameterGroupNameMessage :: DBParameterGroupNameMessage Source #
Create a value of DBParameterGroupNameMessage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroupName:DBParameterGroupNameMessage'
, dbParameterGroupNameMessage_dbParameterGroupName
- Provides the name of the DB parameter group.
DBParameterGroupStatus
data DBParameterGroupStatus Source #
The status of the DB parameter group.
This data type is used as a response element in the following actions:
- CreateDBInstance
- DeleteDBInstance
- ModifyDBInstance
- RebootDBInstance
See: newDBParameterGroupStatus
smart constructor.
Instances
newDBParameterGroupStatus :: DBParameterGroupStatus Source #
Create a value of DBParameterGroupStatus
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroupName:DBParameterGroupStatus'
, dbParameterGroupStatus_dbParameterGroupName
- The name of the DP parameter group.
$sel:parameterApplyStatus:DBParameterGroupStatus'
, dbParameterGroupStatus_parameterApplyStatus
- The status of parameter updates.
DBSecurityGroupMembership
data DBSecurityGroupMembership Source #
Specifies membership in a designated DB security group.
See: newDBSecurityGroupMembership
smart constructor.
Instances
newDBSecurityGroupMembership :: DBSecurityGroupMembership Source #
Create a value of DBSecurityGroupMembership
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DBSecurityGroupMembership'
, dbSecurityGroupMembership_status
- The status of the DB security group.
$sel:dbSecurityGroupName:DBSecurityGroupMembership'
, dbSecurityGroupMembership_dbSecurityGroupName
- The name of the DB security group.
DBSubnetGroup
data DBSubnetGroup Source #
Contains the details of an Amazon Neptune DB subnet group.
This data type is used as a response element in the DescribeDBSubnetGroups action.
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:dbSubnetGroupName:DBSubnetGroup'
, dbSubnetGroup_dbSubnetGroupName
- The name of the DB subnet group.
$sel:vpcId:DBSubnetGroup'
, dbSubnetGroup_vpcId
- Provides the VpcId of the DB subnet group.
$sel:subnets:DBSubnetGroup'
, dbSubnetGroup_subnets
- Contains a list of Subnet elements.
$sel:dbSubnetGroupDescription:DBSubnetGroup'
, dbSubnetGroup_dbSubnetGroupDescription
- Provides the description of the DB subnet group.
$sel:dbSubnetGroupArn:DBSubnetGroup'
, dbSubnetGroup_dbSubnetGroupArn
- The Amazon Resource Name (ARN) for the DB subnet group.
$sel:subnetGroupStatus:DBSubnetGroup'
, dbSubnetGroup_subnetGroupStatus
- Provides the status of the DB subnet group.
DomainMembership
data DomainMembership Source #
An Active Directory Domain membership record associated with a DB instance.
See: newDomainMembership
smart constructor.
Instances
newDomainMembership :: DomainMembership Source #
Create a value of DomainMembership
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DomainMembership'
, domainMembership_status
- The status of the DB instance's Active Directory Domain membership,
such as joined, pending-join, failed etc).
$sel:fqdn:DomainMembership'
, domainMembership_fqdn
- The fully qualified domain name of the Active Directory Domain.
$sel:domain:DomainMembership'
, domainMembership_domain
- The identifier of the Active Directory Domain.
$sel:iAMRoleName:DomainMembership'
, domainMembership_iAMRoleName
- The name of the IAM role to be used when making API calls to the
Directory Service.
DoubleRange
data DoubleRange Source #
A range of double values.
See: newDoubleRange
smart constructor.
Instances
newDoubleRange :: DoubleRange Source #
Create a value of DoubleRange
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:to:DoubleRange'
, doubleRange_to
- The maximum value in the range.
$sel:from:DoubleRange'
, doubleRange_from
- The minimum value in the range.
Endpoint
Specifies a connection endpoint.
For the data structure that represents Amazon Neptune DB cluster
endpoints, see DBClusterEndpoint
.
See: newEndpoint
smart constructor.
Instances
Eq Endpoint Source # | |
Read Endpoint Source # | |
Show Endpoint Source # | |
Generic Endpoint Source # | |
NFData Endpoint Source # | |
Defined in Amazonka.Neptune.Types.Endpoint | |
Hashable Endpoint Source # | |
Defined in Amazonka.Neptune.Types.Endpoint | |
FromXML Endpoint Source # | |
type Rep Endpoint Source # | |
Defined in Amazonka.Neptune.Types.Endpoint type Rep Endpoint = D1 ('MetaData "Endpoint" "Amazonka.Neptune.Types.Endpoint" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" 'False) (C1 ('MetaCons "Endpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) |
newEndpoint :: Endpoint Source #
Create a value of Endpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hostedZoneId:Endpoint'
, endpoint_hostedZoneId
- Specifies the ID that Amazon Route 53 assigns when you create a hosted
zone.
$sel:address:Endpoint'
, endpoint_address
- Specifies the DNS address of the DB instance.
$sel:port:Endpoint'
, endpoint_port
- Specifies the port that the database engine is listening on.
EngineDefaults
data EngineDefaults Source #
Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
See: newEngineDefaults
smart constructor.
Instances
newEngineDefaults :: EngineDefaults Source #
Create a value of EngineDefaults
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroupFamily:EngineDefaults'
, engineDefaults_dbParameterGroupFamily
- Specifies the name of the DB parameter group family that the engine
default parameters apply to.
$sel:marker:EngineDefaults'
, engineDefaults_marker
- An optional pagination token provided by a previous EngineDefaults
request. If this parameter is specified, the response includes only
records beyond the marker, up to the value specified by MaxRecords
.
$sel:parameters:EngineDefaults'
, engineDefaults_parameters
- Contains a list of engine default parameters.
Event
This data type is used as a response element in the DescribeEvents action.
See: newEvent
smart constructor.
Instances
Create a value of Event
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceType:Event'
, event_sourceType
- Specifies the source type for this event.
$sel:sourceArn:Event'
, event_sourceArn
- The Amazon Resource Name (ARN) for the event.
$sel:sourceIdentifier:Event'
, event_sourceIdentifier
- Provides the identifier for the source of the event.
$sel:date:Event'
, event_date
- Specifies the date and time of the event.
$sel:eventCategories:Event'
, event_eventCategories
- Specifies the category for the event.
$sel:message:Event'
, event_message
- Provides the text of this event.
EventCategoriesMap
data EventCategoriesMap Source #
Contains the results of a successful invocation of the DescribeEventCategories action.
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:sourceType:EventCategoriesMap'
, eventCategoriesMap_sourceType
- The source type that the returned categories belong to
$sel:eventCategories:EventCategoriesMap'
, eventCategoriesMap_eventCategories
- The event categories for the specified source type
EventSubscription
data EventSubscription Source #
Contains the results of a successful invocation of the DescribeEventSubscriptions action.
See: newEventSubscription
smart constructor.
EventSubscription' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe [Text]) |
Instances
newEventSubscription :: EventSubscription Source #
Create a value of EventSubscription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:EventSubscription'
, eventSubscription_status
- The status of the event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that Neptune no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
$sel:customerAwsId:EventSubscription'
, eventSubscription_customerAwsId
- The Amazon customer account associated with the event notification
subscription.
$sel:custSubscriptionId:EventSubscription'
, eventSubscription_custSubscriptionId
- The event notification subscription Id.
$sel:snsTopicArn:EventSubscription'
, eventSubscription_snsTopicArn
- The topic ARN of the event notification subscription.
$sel:eventSubscriptionArn:EventSubscription'
, eventSubscription_eventSubscriptionArn
- The Amazon Resource Name (ARN) for the event subscription.
$sel:enabled:EventSubscription'
, eventSubscription_enabled
- A Boolean value indicating if the subscription is enabled. True
indicates the subscription is enabled.
$sel:sourceType:EventSubscription'
, eventSubscription_sourceType
- The source type for the event notification subscription.
$sel:subscriptionCreationTime:EventSubscription'
, eventSubscription_subscriptionCreationTime
- The time the event notification subscription was created.
$sel:eventCategoriesList:EventSubscription'
, eventSubscription_eventCategoriesList
- A list of event categories for the event notification subscription.
$sel:sourceIdsList:EventSubscription'
, eventSubscription_sourceIdsList
- A list of source IDs for the event notification subscription.
Filter
This type is not currently supported.
See: newFilter
smart constructor.
Instances
Eq Filter Source # | |
Read Filter Source # | |
Show Filter Source # | |
Generic Filter Source # | |
NFData Filter Source # | |
Defined in Amazonka.Neptune.Types.Filter | |
Hashable Filter Source # | |
Defined in Amazonka.Neptune.Types.Filter | |
ToQuery Filter Source # | |
Defined in Amazonka.Neptune.Types.Filter toQuery :: Filter -> QueryString # | |
type Rep Filter Source # | |
Defined in Amazonka.Neptune.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.Neptune.Types.Filter" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" '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
- This parameter is not currently supported.
$sel:values:Filter'
, filter_values
- This parameter is not currently supported.
OptionGroupMembership
data OptionGroupMembership Source #
Not supported by Neptune.
See: newOptionGroupMembership
smart constructor.
Instances
newOptionGroupMembership :: OptionGroupMembership Source #
Create a value of OptionGroupMembership
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:OptionGroupMembership'
, optionGroupMembership_status
- Not supported by Neptune.
$sel:optionGroupName:OptionGroupMembership'
, optionGroupMembership_optionGroupName
- Not supported by Neptune.
OrderableDBInstanceOption
data OrderableDBInstanceOption Source #
Contains a list of available options for a DB instance.
This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.
See: newOrderableDBInstanceOption
smart constructor.
OrderableDBInstanceOption' (Maybe Text) (Maybe Double) (Maybe Bool) (Maybe Int) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [AvailabilityZone]) (Maybe Bool) (Maybe Bool) (Maybe Double) (Maybe Bool) (Maybe Bool) (Maybe Int) (Maybe Text) |
Instances
newOrderableDBInstanceOption :: OrderableDBInstanceOption Source #
Create a value of OrderableDBInstanceOption
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:OrderableDBInstanceOption'
, orderableDBInstanceOption_engineVersion
- The engine version of a DB instance.
$sel:minIopsPerGib:OrderableDBInstanceOption'
, orderableDBInstanceOption_minIopsPerGib
- Minimum provisioned IOPS per GiB for a DB instance.
$sel:supportsIAMDatabaseAuthentication:OrderableDBInstanceOption'
, orderableDBInstanceOption_supportsIAMDatabaseAuthentication
- Indicates whether a DB instance supports IAM database authentication.
$sel:minIopsPerDbInstance:OrderableDBInstanceOption'
, orderableDBInstanceOption_minIopsPerDbInstance
- Minimum total provisioned IOPS for a DB instance.
$sel:multiAZCapable:OrderableDBInstanceOption'
, orderableDBInstanceOption_multiAZCapable
- Indicates whether a DB instance is Multi-AZ capable.
$sel:maxStorageSize:OrderableDBInstanceOption'
, orderableDBInstanceOption_maxStorageSize
- Maximum storage size for a DB instance.
$sel:engine:OrderableDBInstanceOption'
, orderableDBInstanceOption_engine
- The engine type of a DB instance.
$sel:minStorageSize:OrderableDBInstanceOption'
, orderableDBInstanceOption_minStorageSize
- Minimum storage size for a DB instance.
$sel:supportsIops:OrderableDBInstanceOption'
, orderableDBInstanceOption_supportsIops
- Indicates whether a DB instance supports provisioned IOPS.
$sel:supportsPerformanceInsights:OrderableDBInstanceOption'
, orderableDBInstanceOption_supportsPerformanceInsights
- (Not supported by Neptune)
$sel:dbInstanceClass:OrderableDBInstanceOption'
, orderableDBInstanceOption_dbInstanceClass
- The DB instance class for a DB instance.
$sel:licenseModel:OrderableDBInstanceOption'
, orderableDBInstanceOption_licenseModel
- The license model for a DB instance.
$sel:availabilityZones:OrderableDBInstanceOption'
, orderableDBInstanceOption_availabilityZones
- A list of Availability Zones for a DB instance.
$sel:supportsStorageEncryption:OrderableDBInstanceOption'
, orderableDBInstanceOption_supportsStorageEncryption
- Indicates whether a DB instance supports encrypted storage.
$sel:readReplicaCapable:OrderableDBInstanceOption'
, orderableDBInstanceOption_readReplicaCapable
- Indicates whether a DB instance can have a Read Replica.
$sel:maxIopsPerGib:OrderableDBInstanceOption'
, orderableDBInstanceOption_maxIopsPerGib
- Maximum provisioned IOPS per GiB for a DB instance.
$sel:vpc:OrderableDBInstanceOption'
, orderableDBInstanceOption_vpc
- Indicates whether a DB instance is in a VPC.
$sel:supportsEnhancedMonitoring:OrderableDBInstanceOption'
, orderableDBInstanceOption_supportsEnhancedMonitoring
- Indicates whether a DB instance supports Enhanced Monitoring at
intervals from 1 to 60 seconds.
$sel:maxIopsPerDbInstance:OrderableDBInstanceOption'
, orderableDBInstanceOption_maxIopsPerDbInstance
- Maximum total provisioned IOPS for a DB instance.
$sel:storageType:OrderableDBInstanceOption'
, orderableDBInstanceOption_storageType
- Indicates the storage type for a DB instance.
Parameter
Specifies a parameter.
See: newParameter
smart constructor.
Parameter' (Maybe Text) (Maybe Text) (Maybe ApplyMethod) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newParameter :: Parameter Source #
Create a value of Parameter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applyType:Parameter'
, parameter_applyType
- Specifies the engine specific parameters type.
$sel:parameterValue:Parameter'
, parameter_parameterValue
- Specifies the value of the parameter.
$sel:applyMethod:Parameter'
, parameter_applyMethod
- Indicates when to apply parameter updates.
$sel:minimumEngineVersion:Parameter'
, parameter_minimumEngineVersion
- The earliest engine version to which the parameter can apply.
$sel:source:Parameter'
, parameter_source
- Indicates the source of the parameter value.
$sel:isModifiable:Parameter'
, parameter_isModifiable
- Indicates whether (true
) or not (false
) the parameter can be
modified. Some parameters have security or operational implications that
prevent them from being changed.
$sel:dataType:Parameter'
, parameter_dataType
- Specifies the valid data type for the parameter.
$sel:allowedValues:Parameter'
, parameter_allowedValues
- Specifies the valid range of values for the parameter.
$sel:parameterName:Parameter'
, parameter_parameterName
- Specifies the name of the parameter.
$sel:description:Parameter'
, parameter_description
- Provides a description of the parameter.
PendingCloudwatchLogsExports
data PendingCloudwatchLogsExports Source #
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
See: newPendingCloudwatchLogsExports
smart constructor.
PendingCloudwatchLogsExports' (Maybe [Text]) (Maybe [Text]) |
Instances
newPendingCloudwatchLogsExports :: PendingCloudwatchLogsExports Source #
Create a value of PendingCloudwatchLogsExports
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logTypesToEnable:PendingCloudwatchLogsExports'
, pendingCloudwatchLogsExports_logTypesToEnable
- Log types that are in the process of being deactivated. After they are
deactivated, these log types aren't exported to CloudWatch Logs.
$sel:logTypesToDisable:PendingCloudwatchLogsExports'
, pendingCloudwatchLogsExports_logTypesToDisable
- Log types that are in the process of being enabled. After they are
enabled, these log types are exported to CloudWatch Logs.
PendingMaintenanceAction
data PendingMaintenanceAction Source #
Provides information about a pending maintenance action for a resource.
See: newPendingMaintenanceAction
smart constructor.
PendingMaintenanceAction' (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe ISO8601) |
Instances
newPendingMaintenanceAction :: PendingMaintenanceAction Source #
Create a value of PendingMaintenanceAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoAppliedAfterDate:PendingMaintenanceAction'
, pendingMaintenanceAction_autoAppliedAfterDate
- The date of the maintenance window when the action is applied. The
maintenance action is applied to the resource during its first
maintenance window after this date. If this date is specified, any
next-maintenance
opt-in requests are ignored.
$sel:action:PendingMaintenanceAction'
, pendingMaintenanceAction_action
- The type of pending maintenance action that is available for the
resource.
$sel:optInStatus:PendingMaintenanceAction'
, pendingMaintenanceAction_optInStatus
- Indicates the type of opt-in request that has been received for the
resource.
$sel:description:PendingMaintenanceAction'
, pendingMaintenanceAction_description
- A description providing more detail about the maintenance action.
$sel:forcedApplyDate:PendingMaintenanceAction'
, pendingMaintenanceAction_forcedApplyDate
- The date when the maintenance action is automatically applied. 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:currentApplyDate:PendingMaintenanceAction'
, pendingMaintenanceAction_currentApplyDate
- The effective date when the pending maintenance action is applied to the
resource. This date takes into account opt-in requests received from the
ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate
, and the
ForcedApplyDate
. This value is blank if an opt-in request has not been
received and nothing has been specified as AutoAppliedAfterDate
or
ForcedApplyDate
.
PendingModifiedValues
data PendingModifiedValues Source #
This data type is used as a response element in the ModifyDBInstance action.
See: newPendingModifiedValues
smart constructor.
PendingModifiedValues' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe PendingCloudwatchLogsExports) (Maybe Int) (Maybe Bool) (Maybe Int) (Maybe Int) (Maybe Text) |
Instances
newPendingModifiedValues :: PendingModifiedValues Source #
Create a value of PendingModifiedValues
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:PendingModifiedValues'
, pendingModifiedValues_engineVersion
- Indicates the database engine version.
$sel:masterUserPassword:PendingModifiedValues'
, pendingModifiedValues_masterUserPassword
- Not supported by Neptune.
$sel:dbSubnetGroupName:PendingModifiedValues'
, pendingModifiedValues_dbSubnetGroupName
- The new DB subnet group for the DB instance.
$sel:iops:PendingModifiedValues'
, pendingModifiedValues_iops
- Specifies the new Provisioned IOPS value for the DB instance that will
be applied or is currently being applied.
$sel:dbInstanceClass:PendingModifiedValues'
, pendingModifiedValues_dbInstanceClass
- Contains the new DBInstanceClass
for the DB instance that will be
applied or is currently being applied.
$sel:licenseModel:PendingModifiedValues'
, pendingModifiedValues_licenseModel
- Not supported by Neptune.
$sel:cACertificateIdentifier:PendingModifiedValues'
, pendingModifiedValues_cACertificateIdentifier
- Specifies the identifier of the CA certificate for the DB instance.
$sel:dbInstanceIdentifier:PendingModifiedValues'
, pendingModifiedValues_dbInstanceIdentifier
- Contains the new DBInstanceIdentifier
for the DB instance that will be
applied or is currently being applied.
$sel:pendingCloudwatchLogsExports:PendingModifiedValues'
, pendingModifiedValues_pendingCloudwatchLogsExports
- This PendingCloudwatchLogsExports
structure specifies pending changes
to which CloudWatch logs are enabled and which are disabled.
$sel:backupRetentionPeriod:PendingModifiedValues'
, pendingModifiedValues_backupRetentionPeriod
- Specifies the pending number of days for which automated backups are
retained.
$sel:multiAZ:PendingModifiedValues'
, pendingModifiedValues_multiAZ
- Indicates that the Single-AZ DB instance is to change to a Multi-AZ
deployment.
$sel:allocatedStorage:PendingModifiedValues'
, pendingModifiedValues_allocatedStorage
- Contains the new AllocatedStorage
size for the DB instance that will
be applied or is currently being applied.
$sel:port:PendingModifiedValues'
, pendingModifiedValues_port
- Specifies the pending port for the DB instance.
$sel:storageType:PendingModifiedValues'
, pendingModifiedValues_storageType
- Specifies the storage type to be associated with the DB instance.
Range
A range of integer values.
See: newRange
smart constructor.
Instances
Eq Range Source # | |
Read Range Source # | |
Show Range Source # | |
Generic Range Source # | |
NFData Range Source # | |
Defined in Amazonka.Neptune.Types.Range | |
Hashable Range Source # | |
Defined in Amazonka.Neptune.Types.Range | |
FromXML Range Source # | |
type Rep Range Source # | |
Defined in Amazonka.Neptune.Types.Range type Rep Range = D1 ('MetaData "Range" "Amazonka.Neptune.Types.Range" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" 'False) (C1 ('MetaCons "Range'" 'PrefixI 'True) (S1 ('MetaSel ('Just "to") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "from") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "step") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) |
Create a value of Range
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:to:Range'
, range_to
- The maximum value in the range.
$sel:from:Range'
, range_from
- The minimum value in the range.
$sel:step:Range'
, range_step
- The step value for the range. For example, if you have a range of 5,000
to 10,000, with a step value of 1,000, the valid values start at 5,000
and step up by 1,000. Even though 7,500 is within the range, it isn't a
valid value for the range. The valid values are 5,000, 6,000, 7,000,
8,000...
ResourcePendingMaintenanceActions
data ResourcePendingMaintenanceActions Source #
Describes the pending maintenance actions for a resource.
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 ARN of the resource that has pending maintenance actions.
Subnet
Specifies a subnet.
This data type is used as a response element in the DescribeDBSubnetGroups action.
See: newSubnet
smart constructor.
Instances
Eq Subnet Source # | |
Read Subnet Source # | |
Show Subnet Source # | |
Generic Subnet Source # | |
NFData Subnet Source # | |
Defined in Amazonka.Neptune.Types.Subnet | |
Hashable Subnet Source # | |
Defined in Amazonka.Neptune.Types.Subnet | |
FromXML Subnet Source # | |
type Rep Subnet Source # | |
Defined in Amazonka.Neptune.Types.Subnet type Rep Subnet = D1 ('MetaData "Subnet" "Amazonka.Neptune.Types.Subnet" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" 'False) (C1 ('MetaCons "Subnet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subnetStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "subnetIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subnetAvailabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AvailabilityZone))))) |
Create a value of Subnet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subnetStatus:Subnet'
, subnet_subnetStatus
- Specifies the status of the subnet.
$sel:subnetIdentifier:Subnet'
, subnet_subnetIdentifier
- Specifies the identifier of the subnet.
$sel:subnetAvailabilityZone:Subnet'
, subnet_subnetAvailabilityZone
- Specifies the EC2 Availability Zone that the subnet is in.
Tag
Metadata assigned to an Amazon Neptune resource consisting of a key-value pair.
See: newTag
smart constructor.
Instances
Eq Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
Generic Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.Neptune.Types.Tag | |
Hashable Tag Source # | |
Defined in Amazonka.Neptune.Types.Tag | |
ToQuery Tag Source # | |
Defined in Amazonka.Neptune.Types.Tag toQuery :: Tag -> QueryString # | |
FromXML Tag Source # | |
type Rep Tag Source # | |
Defined in Amazonka.Neptune.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Neptune.Types.Tag" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:Tag'
, tag_value
- A value is the optional value of the tag. The string value can be from 1
to 256 Unicode characters in length and can't be prefixed with "aws:"
or "rds:". The string can only contain only the set of Unicode
letters, digits, white-space, '_', '.', '/', '=', '+', '-'
(Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
$sel:key:Tag'
, tag_key
- A key is the required name of the tag. The string value can be from 1 to
128 Unicode characters in length and can't be prefixed with "aws:" or
"rds:". The string can only contain only the set of Unicode letters,
digits, white-space, '_', '.', '/', '=', '+', '-' (Java
regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
Timezone
A time zone associated with a DBInstance.
See: newTimezone
smart constructor.
Instances
Eq Timezone Source # | |
Read Timezone Source # | |
Show Timezone Source # | |
Generic Timezone Source # | |
NFData Timezone Source # | |
Defined in Amazonka.Neptune.Types.Timezone | |
Hashable Timezone Source # | |
Defined in Amazonka.Neptune.Types.Timezone | |
FromXML Timezone Source # | |
type Rep Timezone Source # | |
Defined in Amazonka.Neptune.Types.Timezone |
newTimezone :: Timezone Source #
Create a value of Timezone
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:timezoneName:Timezone'
, timezone_timezoneName
- The name of the time zone.
UpgradeTarget
data UpgradeTarget Source #
The version of the database engine that a DB instance can be upgraded to.
See: newUpgradeTarget
smart constructor.
Instances
newUpgradeTarget :: UpgradeTarget Source #
Create a value of UpgradeTarget
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:UpgradeTarget'
, upgradeTarget_engineVersion
- The version number of the upgrade target database engine.
$sel:isMajorVersionUpgrade:UpgradeTarget'
, upgradeTarget_isMajorVersionUpgrade
- A value that indicates whether a database engine is upgraded to a major
version.
$sel:engine:UpgradeTarget'
, upgradeTarget_engine
- The name of the upgrade target database engine.
$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 a DB instance can be upgraded
to.
ValidDBInstanceModificationsMessage
data ValidDBInstanceModificationsMessage Source #
Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.
See: newValidDBInstanceModificationsMessage
smart constructor.
Instances
newValidDBInstanceModificationsMessage :: ValidDBInstanceModificationsMessage Source #
Create a value of ValidDBInstanceModificationsMessage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:storage:ValidDBInstanceModificationsMessage'
, validDBInstanceModificationsMessage_storage
- Valid storage options for your DB instance.
ValidStorageOptions
data ValidStorageOptions Source #
Information about valid modifications that you can make to your DB instance.
Contains the result of a successful call to the DescribeValidDBInstanceModifications action.
See: newValidStorageOptions
smart constructor.
ValidStorageOptions' (Maybe [Range]) (Maybe [Range]) (Maybe [DoubleRange]) (Maybe Text) |
Instances
newValidStorageOptions :: ValidStorageOptions Source #
Create a value of ValidStorageOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:storageSize:ValidStorageOptions'
, validStorageOptions_storageSize
- The valid range of storage in gibibytes. For example, 100 to 16384.
$sel:provisionedIops:ValidStorageOptions'
, validStorageOptions_provisionedIops
- The valid range of provisioned IOPS. For example, 1000-20000.
$sel:iopsToStorageRatio:ValidStorageOptions'
, validStorageOptions_iopsToStorageRatio
- The valid range of Provisioned IOPS to gibibytes of storage multiplier.
For example, 3-10, which means that provisioned IOPS can be between 3
and 10 times storage.
$sel:storageType:ValidStorageOptions'
, validStorageOptions_storageType
- The valid storage types for your DB instance. For example, gp2, io1.
VpcSecurityGroupMembership
data VpcSecurityGroupMembership Source #
This data type is used as a response element for queries on VPC security group membership.
See: newVpcSecurityGroupMembership
smart constructor.
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.