Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DocumentDB.Types

Contents

Service Configuration
Errors
ApplyMethod
SourceType
AvailabilityZone
Certificate
CloudwatchLogsExportConfiguration
DBCluster
DBClusterMember
DBClusterParameterGroup
DBClusterParameterGroupNameMessage
DBClusterRole
DBClusterSnapshot
DBClusterSnapshotAttribute
DBClusterSnapshotAttributesResult
DBEngineVersion
DBInstance
DBInstanceStatusInfo
DBSubnetGroup
Endpoint
EngineDefaults
Event
EventCategoriesMap
EventSubscription
Filter
GlobalCluster
GlobalClusterMember
OrderableDBInstanceOption
Parameter
PendingCloudwatchLogsExports
PendingMaintenanceAction
PendingModifiedValues
ResourcePendingMaintenanceActions
Subnet
Tag
UpgradeTarget
VpcSecurityGroupMembership

Description

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
_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
_GlobalClusterAlreadyExistsFault :: 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
_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
_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
_InvalidVPCNetworkStateFault :: AsError a => Getting (First ServiceError) a ServiceError
_AuthorizationNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
_DBSubnetGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidGlobalClusterStateFault :: AsError a => Getting (First ServiceError) a ServiceError
_EventSubscriptionQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
_InsufficientStorageClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidDBClusterStateFault :: AsError a => Getting (First ServiceError) a ServiceError
_GlobalClusterNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
_DBInstanceAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidRestoreFault :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidDBSecurityGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError
_ResourceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
_DBSubnetGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
_DBUpgradeDependencyFailureFault :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidDBInstanceStateFault :: 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
_GlobalClusterQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
_DBSubnetGroupDoesNotCoverEnoughAZs :: AsError a => Getting (First ServiceError) a ServiceError
_SubnetAlreadyInUse :: AsError a => Getting (First ServiceError) a ServiceError
newtype ApplyMethod where
- ApplyMethod' {
  - fromApplyMethod :: Text
  }
- pattern ApplyMethod_Immediate :: ApplyMethod
- pattern ApplyMethod_Pending_reboot :: ApplyMethod
newtype SourceType where
- SourceType' {
  - fromSourceType :: Text
  }
- 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' {
- name :: Maybe Text
}
newAvailabilityZone :: AvailabilityZone
availabilityZone_name :: Lens' AvailabilityZone (Maybe Text)
data Certificate = Certificate' {
- certificateType :: Maybe Text
- certificateArn :: Maybe Text
- validTill :: Maybe ISO8601
- certificateIdentifier :: Maybe Text
- thumbprint :: Maybe Text
- validFrom :: Maybe ISO8601
}
newCertificate :: Certificate
certificate_certificateType :: Lens' Certificate (Maybe Text)
certificate_certificateArn :: Lens' Certificate (Maybe Text)
certificate_validTill :: Lens' Certificate (Maybe UTCTime)
certificate_certificateIdentifier :: Lens' Certificate (Maybe Text)
certificate_thumbprint :: Lens' Certificate (Maybe Text)
certificate_validFrom :: Lens' Certificate (Maybe UTCTime)
data CloudwatchLogsExportConfiguration = CloudwatchLogsExportConfiguration' {
- disableLogTypes :: Maybe [Text]
- enableLogTypes :: Maybe [Text]
}
newCloudwatchLogsExportConfiguration :: CloudwatchLogsExportConfiguration
cloudwatchLogsExportConfiguration_disableLogTypes :: Lens' CloudwatchLogsExportConfiguration (Maybe [Text])
cloudwatchLogsExportConfiguration_enableLogTypes :: Lens' CloudwatchLogsExportConfiguration (Maybe [Text])
data DBCluster = DBCluster' {
- engineVersion :: Maybe Text
- status :: Maybe Text
- deletionProtection :: Maybe Bool
- storageEncrypted :: Maybe Bool
- dbClusterIdentifier :: Maybe Text
- dbClusterMembers :: Maybe [DBClusterMember]
- readReplicaIdentifiers :: Maybe [Text]
- replicationSourceIdentifier :: Maybe Text
- hostedZoneId :: Maybe Text
- dbClusterParameterGroup :: Maybe Text
- masterUsername :: Maybe Text
- dbClusterResourceId :: Maybe Text
- earliestRestorableTime :: Maybe ISO8601
- engine :: Maybe Text
- dbClusterArn :: Maybe Text
- latestRestorableTime :: Maybe ISO8601
- preferredMaintenanceWindow :: Maybe Text
- availabilityZones :: Maybe [Text]
- kmsKeyId :: Maybe Text
- preferredBackupWindow :: Maybe Text
- associatedRoles :: Maybe [DBClusterRole]
- vpcSecurityGroups :: Maybe [VpcSecurityGroupMembership]
- backupRetentionPeriod :: Maybe Int
- dbSubnetGroup :: Maybe Text
- multiAZ :: Maybe Bool
- enabledCloudwatchLogsExports :: Maybe [Text]
- clusterCreateTime :: Maybe ISO8601
- endpoint :: Maybe Text
- percentProgress :: Maybe Text
- readerEndpoint :: Maybe Text
- port :: Maybe Int
}
newDBCluster :: DBCluster
dbCluster_engineVersion :: Lens' DBCluster (Maybe Text)
dbCluster_status :: Lens' DBCluster (Maybe Text)
dbCluster_deletionProtection :: Lens' DBCluster (Maybe Bool)
dbCluster_storageEncrypted :: Lens' DBCluster (Maybe Bool)
dbCluster_dbClusterIdentifier :: Lens' DBCluster (Maybe Text)
dbCluster_dbClusterMembers :: Lens' DBCluster (Maybe [DBClusterMember])
dbCluster_readReplicaIdentifiers :: Lens' DBCluster (Maybe [Text])
dbCluster_replicationSourceIdentifier :: Lens' DBCluster (Maybe Text)
dbCluster_hostedZoneId :: Lens' DBCluster (Maybe Text)
dbCluster_dbClusterParameterGroup :: Lens' DBCluster (Maybe Text)
dbCluster_masterUsername :: Lens' DBCluster (Maybe Text)
dbCluster_dbClusterResourceId :: Lens' DBCluster (Maybe Text)
dbCluster_earliestRestorableTime :: Lens' DBCluster (Maybe UTCTime)
dbCluster_engine :: Lens' DBCluster (Maybe Text)
dbCluster_dbClusterArn :: Lens' DBCluster (Maybe Text)
dbCluster_latestRestorableTime :: Lens' DBCluster (Maybe UTCTime)
dbCluster_preferredMaintenanceWindow :: Lens' DBCluster (Maybe Text)
dbCluster_availabilityZones :: Lens' DBCluster (Maybe [Text])
dbCluster_kmsKeyId :: Lens' DBCluster (Maybe Text)
dbCluster_preferredBackupWindow :: Lens' DBCluster (Maybe Text)
dbCluster_associatedRoles :: Lens' DBCluster (Maybe [DBClusterRole])
dbCluster_vpcSecurityGroups :: Lens' DBCluster (Maybe [VpcSecurityGroupMembership])
dbCluster_backupRetentionPeriod :: Lens' DBCluster (Maybe Int)
dbCluster_dbSubnetGroup :: Lens' DBCluster (Maybe Text)
dbCluster_multiAZ :: Lens' DBCluster (Maybe Bool)
dbCluster_enabledCloudwatchLogsExports :: Lens' DBCluster (Maybe [Text])
dbCluster_clusterCreateTime :: Lens' DBCluster (Maybe UTCTime)
dbCluster_endpoint :: Lens' DBCluster (Maybe Text)
dbCluster_percentProgress :: Lens' DBCluster (Maybe Text)
dbCluster_readerEndpoint :: Lens' DBCluster (Maybe Text)
dbCluster_port :: Lens' DBCluster (Maybe Int)
data DBClusterMember = DBClusterMember' {
- promotionTier :: Maybe Int
- dbInstanceIdentifier :: Maybe Text
- isClusterWriter :: Maybe Bool
- dbClusterParameterGroupStatus :: Maybe Text
}
newDBClusterMember :: DBClusterMember
dbClusterMember_promotionTier :: Lens' DBClusterMember (Maybe Int)
dbClusterMember_dbInstanceIdentifier :: Lens' DBClusterMember (Maybe Text)
dbClusterMember_isClusterWriter :: Lens' DBClusterMember (Maybe Bool)
dbClusterMember_dbClusterParameterGroupStatus :: Lens' DBClusterMember (Maybe Text)
data DBClusterParameterGroup = DBClusterParameterGroup' {
- dbClusterParameterGroupArn :: Maybe Text
- dbParameterGroupFamily :: Maybe Text
- dbClusterParameterGroupName :: Maybe Text
- description :: Maybe Text
}
newDBClusterParameterGroup :: DBClusterParameterGroup
dbClusterParameterGroup_dbClusterParameterGroupArn :: Lens' DBClusterParameterGroup (Maybe Text)
dbClusterParameterGroup_dbParameterGroupFamily :: Lens' DBClusterParameterGroup (Maybe Text)
dbClusterParameterGroup_dbClusterParameterGroupName :: Lens' DBClusterParameterGroup (Maybe Text)
dbClusterParameterGroup_description :: Lens' DBClusterParameterGroup (Maybe Text)
data DBClusterParameterGroupNameMessage = DBClusterParameterGroupNameMessage' {
- dbClusterParameterGroupName :: Maybe Text
}
newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage
dbClusterParameterGroupNameMessage_dbClusterParameterGroupName :: Lens' DBClusterParameterGroupNameMessage (Maybe Text)
data DBClusterRole = DBClusterRole' {
- status :: Maybe Text
- roleArn :: Maybe Text
}
newDBClusterRole :: DBClusterRole
dbClusterRole_status :: Lens' DBClusterRole (Maybe Text)
dbClusterRole_roleArn :: Lens' DBClusterRole (Maybe Text)
data DBClusterSnapshot = DBClusterSnapshot' {
- engineVersion :: Maybe Text
- status :: Maybe Text
- storageEncrypted :: Maybe Bool
- dbClusterIdentifier :: Maybe Text
- masterUsername :: Maybe Text
- dbClusterSnapshotArn :: Maybe Text
- vpcId :: Maybe Text
- dbClusterSnapshotIdentifier :: Maybe Text
- engine :: Maybe Text
- availabilityZones :: Maybe [Text]
- snapshotType :: Maybe Text
- kmsKeyId :: Maybe Text
- snapshotCreateTime :: Maybe ISO8601
- sourceDBClusterSnapshotArn :: Maybe Text
- clusterCreateTime :: Maybe ISO8601
- percentProgress :: Maybe Int
- port :: Maybe Int
}
newDBClusterSnapshot :: DBClusterSnapshot
dbClusterSnapshot_engineVersion :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_status :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_storageEncrypted :: Lens' DBClusterSnapshot (Maybe Bool)
dbClusterSnapshot_dbClusterIdentifier :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_masterUsername :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_dbClusterSnapshotArn :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_vpcId :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_dbClusterSnapshotIdentifier :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_engine :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_availabilityZones :: Lens' DBClusterSnapshot (Maybe [Text])
dbClusterSnapshot_snapshotType :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_kmsKeyId :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_snapshotCreateTime :: Lens' DBClusterSnapshot (Maybe UTCTime)
dbClusterSnapshot_sourceDBClusterSnapshotArn :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_clusterCreateTime :: Lens' DBClusterSnapshot (Maybe UTCTime)
dbClusterSnapshot_percentProgress :: Lens' DBClusterSnapshot (Maybe Int)
dbClusterSnapshot_port :: Lens' DBClusterSnapshot (Maybe Int)
data DBClusterSnapshotAttribute = DBClusterSnapshotAttribute' {
- attributeValues :: Maybe [Text]
- attributeName :: Maybe Text
}
newDBClusterSnapshotAttribute :: DBClusterSnapshotAttribute
dbClusterSnapshotAttribute_attributeValues :: Lens' DBClusterSnapshotAttribute (Maybe [Text])
dbClusterSnapshotAttribute_attributeName :: Lens' DBClusterSnapshotAttribute (Maybe Text)
data DBClusterSnapshotAttributesResult = DBClusterSnapshotAttributesResult' {
- dbClusterSnapshotIdentifier :: Maybe Text
- dbClusterSnapshotAttributes :: Maybe [DBClusterSnapshotAttribute]
}
newDBClusterSnapshotAttributesResult :: DBClusterSnapshotAttributesResult
dbClusterSnapshotAttributesResult_dbClusterSnapshotIdentifier :: Lens' DBClusterSnapshotAttributesResult (Maybe Text)
dbClusterSnapshotAttributesResult_dbClusterSnapshotAttributes :: Lens' DBClusterSnapshotAttributesResult (Maybe [DBClusterSnapshotAttribute])
data DBEngineVersion = DBEngineVersion' {
- engineVersion :: Maybe Text
- dbEngineVersionDescription :: Maybe Text
- engine :: Maybe Text
- dbParameterGroupFamily :: Maybe Text
- dbEngineDescription :: Maybe Text
- validUpgradeTarget :: Maybe [UpgradeTarget]
- supportsLogExportsToCloudwatchLogs :: Maybe Bool
- exportableLogTypes :: Maybe [Text]
}
newDBEngineVersion :: DBEngineVersion
dbEngineVersion_engineVersion :: Lens' DBEngineVersion (Maybe Text)
dbEngineVersion_dbEngineVersionDescription :: Lens' DBEngineVersion (Maybe Text)
dbEngineVersion_engine :: Lens' DBEngineVersion (Maybe Text)
dbEngineVersion_dbParameterGroupFamily :: Lens' DBEngineVersion (Maybe Text)
dbEngineVersion_dbEngineDescription :: Lens' DBEngineVersion (Maybe Text)
dbEngineVersion_validUpgradeTarget :: Lens' DBEngineVersion (Maybe [UpgradeTarget])
dbEngineVersion_supportsLogExportsToCloudwatchLogs :: Lens' DBEngineVersion (Maybe Bool)
dbEngineVersion_exportableLogTypes :: Lens' DBEngineVersion (Maybe [Text])
data DBInstance = DBInstance' {
- engineVersion :: Maybe Text
- storageEncrypted :: Maybe Bool
- dbClusterIdentifier :: Maybe Text
- publiclyAccessible :: Maybe Bool
- autoMinorVersionUpgrade :: Maybe Bool
- dbInstanceArn :: Maybe Text
- instanceCreateTime :: Maybe ISO8601
- engine :: Maybe Text
- latestRestorableTime :: Maybe ISO8601
- dbInstanceClass :: Maybe Text
- promotionTier :: Maybe Int
- preferredMaintenanceWindow :: Maybe Text
- cACertificateIdentifier :: Maybe Text
- dbInstanceIdentifier :: Maybe Text
- kmsKeyId :: Maybe Text
- preferredBackupWindow :: Maybe Text
- availabilityZone :: Maybe Text
- vpcSecurityGroups :: Maybe [VpcSecurityGroupMembership]
- backupRetentionPeriod :: Maybe Int
- dbSubnetGroup :: Maybe DBSubnetGroup
- enabledCloudwatchLogsExports :: Maybe [Text]
- dbiResourceId :: Maybe Text
- endpoint :: Maybe Endpoint
- dbInstanceStatus :: Maybe Text
- pendingModifiedValues :: Maybe PendingModifiedValues
- statusInfos :: Maybe [DBInstanceStatusInfo]
}
newDBInstance :: DBInstance
dbInstance_engineVersion :: Lens' DBInstance (Maybe Text)
dbInstance_storageEncrypted :: Lens' DBInstance (Maybe Bool)
dbInstance_dbClusterIdentifier :: Lens' DBInstance (Maybe Text)
dbInstance_publiclyAccessible :: Lens' DBInstance (Maybe Bool)
dbInstance_autoMinorVersionUpgrade :: Lens' DBInstance (Maybe Bool)
dbInstance_dbInstanceArn :: Lens' DBInstance (Maybe Text)
dbInstance_instanceCreateTime :: Lens' DBInstance (Maybe UTCTime)
dbInstance_engine :: Lens' DBInstance (Maybe Text)
dbInstance_latestRestorableTime :: Lens' DBInstance (Maybe UTCTime)
dbInstance_dbInstanceClass :: Lens' DBInstance (Maybe Text)
dbInstance_promotionTier :: Lens' DBInstance (Maybe Int)
dbInstance_preferredMaintenanceWindow :: Lens' DBInstance (Maybe Text)
dbInstance_cACertificateIdentifier :: Lens' DBInstance (Maybe Text)
dbInstance_dbInstanceIdentifier :: Lens' DBInstance (Maybe Text)
dbInstance_kmsKeyId :: Lens' DBInstance (Maybe Text)
dbInstance_preferredBackupWindow :: Lens' DBInstance (Maybe Text)
dbInstance_availabilityZone :: Lens' DBInstance (Maybe Text)
dbInstance_vpcSecurityGroups :: Lens' DBInstance (Maybe [VpcSecurityGroupMembership])
dbInstance_backupRetentionPeriod :: Lens' DBInstance (Maybe Int)
dbInstance_dbSubnetGroup :: Lens' DBInstance (Maybe DBSubnetGroup)
dbInstance_enabledCloudwatchLogsExports :: Lens' DBInstance (Maybe [Text])
dbInstance_dbiResourceId :: Lens' DBInstance (Maybe Text)
dbInstance_endpoint :: Lens' DBInstance (Maybe Endpoint)
dbInstance_dbInstanceStatus :: Lens' DBInstance (Maybe Text)
dbInstance_pendingModifiedValues :: Lens' DBInstance (Maybe PendingModifiedValues)
dbInstance_statusInfos :: Lens' DBInstance (Maybe [DBInstanceStatusInfo])
data DBInstanceStatusInfo = DBInstanceStatusInfo' {
- status :: Maybe Text
- normal :: Maybe Bool
- statusType :: Maybe Text
- message :: Maybe Text
}
newDBInstanceStatusInfo :: DBInstanceStatusInfo
dbInstanceStatusInfo_status :: Lens' DBInstanceStatusInfo (Maybe Text)
dbInstanceStatusInfo_normal :: Lens' DBInstanceStatusInfo (Maybe Bool)
dbInstanceStatusInfo_statusType :: Lens' DBInstanceStatusInfo (Maybe Text)
dbInstanceStatusInfo_message :: Lens' DBInstanceStatusInfo (Maybe Text)
data DBSubnetGroup = DBSubnetGroup' {
- dbSubnetGroupName :: Maybe Text
- vpcId :: Maybe Text
- subnets :: Maybe [Subnet]
- dbSubnetGroupDescription :: Maybe Text
- dbSubnetGroupArn :: Maybe Text
- subnetGroupStatus :: Maybe Text
}
newDBSubnetGroup :: DBSubnetGroup
dbSubnetGroup_dbSubnetGroupName :: Lens' DBSubnetGroup (Maybe Text)
dbSubnetGroup_vpcId :: Lens' DBSubnetGroup (Maybe Text)
dbSubnetGroup_subnets :: Lens' DBSubnetGroup (Maybe [Subnet])
dbSubnetGroup_dbSubnetGroupDescription :: Lens' DBSubnetGroup (Maybe Text)
dbSubnetGroup_dbSubnetGroupArn :: Lens' DBSubnetGroup (Maybe Text)
dbSubnetGroup_subnetGroupStatus :: Lens' DBSubnetGroup (Maybe Text)
data Endpoint = Endpoint' {
- hostedZoneId :: Maybe Text
- address :: Maybe Text
- port :: Maybe Int
}
newEndpoint :: Endpoint
endpoint_hostedZoneId :: Lens' Endpoint (Maybe Text)
endpoint_address :: Lens' Endpoint (Maybe Text)
endpoint_port :: Lens' Endpoint (Maybe Int)
data EngineDefaults = EngineDefaults' {
- dbParameterGroupFamily :: Maybe Text
- marker :: Maybe Text
- parameters :: Maybe [Parameter]
}
newEngineDefaults :: EngineDefaults
engineDefaults_dbParameterGroupFamily :: Lens' EngineDefaults (Maybe Text)
engineDefaults_marker :: Lens' EngineDefaults (Maybe Text)
engineDefaults_parameters :: Lens' EngineDefaults (Maybe [Parameter])
data Event = Event' {
- sourceType :: Maybe SourceType
- sourceArn :: Maybe Text
- sourceIdentifier :: Maybe Text
- date :: Maybe ISO8601
- eventCategories :: Maybe [Text]
- message :: Maybe Text
}
newEvent :: Event
event_sourceType :: Lens' Event (Maybe SourceType)
event_sourceArn :: Lens' Event (Maybe Text)
event_sourceIdentifier :: Lens' Event (Maybe Text)
event_date :: Lens' Event (Maybe UTCTime)
event_eventCategories :: Lens' Event (Maybe [Text])
event_message :: Lens' Event (Maybe Text)
data EventCategoriesMap = EventCategoriesMap' {
- sourceType :: Maybe Text
- eventCategories :: Maybe [Text]
}
newEventCategoriesMap :: EventCategoriesMap
eventCategoriesMap_sourceType :: Lens' EventCategoriesMap (Maybe Text)
eventCategoriesMap_eventCategories :: Lens' EventCategoriesMap (Maybe [Text])
data EventSubscription = EventSubscription' {
- status :: Maybe Text
- customerAwsId :: Maybe Text
- custSubscriptionId :: Maybe Text
- snsTopicArn :: Maybe Text
- eventSubscriptionArn :: Maybe Text
- enabled :: Maybe Bool
- sourceType :: Maybe Text
- subscriptionCreationTime :: Maybe Text
- eventCategoriesList :: Maybe [Text]
- sourceIdsList :: Maybe [Text]
}
newEventSubscription :: EventSubscription
eventSubscription_status :: Lens' EventSubscription (Maybe Text)
eventSubscription_customerAwsId :: Lens' EventSubscription (Maybe Text)
eventSubscription_custSubscriptionId :: Lens' EventSubscription (Maybe Text)
eventSubscription_snsTopicArn :: Lens' EventSubscription (Maybe Text)
eventSubscription_eventSubscriptionArn :: Lens' EventSubscription (Maybe Text)
eventSubscription_enabled :: Lens' EventSubscription (Maybe Bool)
eventSubscription_sourceType :: Lens' EventSubscription (Maybe Text)
eventSubscription_subscriptionCreationTime :: Lens' EventSubscription (Maybe Text)
eventSubscription_eventCategoriesList :: Lens' EventSubscription (Maybe [Text])
eventSubscription_sourceIdsList :: Lens' EventSubscription (Maybe [Text])
data Filter = Filter' {
- name :: Text
- values :: [Text]
}
newFilter :: Text -> Filter
filter_name :: Lens' Filter Text
filter_values :: Lens' Filter [Text]
data GlobalCluster = GlobalCluster' {
- engineVersion :: Maybe Text
- status :: Maybe Text
- deletionProtection :: Maybe Bool
- storageEncrypted :: Maybe Bool
- globalClusterIdentifier :: Maybe Text
- engine :: Maybe Text
- globalClusterArn :: Maybe Text
- databaseName :: Maybe Text
- globalClusterMembers :: Maybe [GlobalClusterMember]
- globalClusterResourceId :: Maybe Text
}
newGlobalCluster :: GlobalCluster
globalCluster_engineVersion :: Lens' GlobalCluster (Maybe Text)
globalCluster_status :: Lens' GlobalCluster (Maybe Text)
globalCluster_deletionProtection :: Lens' GlobalCluster (Maybe Bool)
globalCluster_storageEncrypted :: Lens' GlobalCluster (Maybe Bool)
globalCluster_globalClusterIdentifier :: Lens' GlobalCluster (Maybe Text)
globalCluster_engine :: Lens' GlobalCluster (Maybe Text)
globalCluster_globalClusterArn :: Lens' GlobalCluster (Maybe Text)
globalCluster_databaseName :: Lens' GlobalCluster (Maybe Text)
globalCluster_globalClusterMembers :: Lens' GlobalCluster (Maybe [GlobalClusterMember])
globalCluster_globalClusterResourceId :: Lens' GlobalCluster (Maybe Text)
data GlobalClusterMember = GlobalClusterMember' {
- readers :: Maybe [Text]
- dbClusterArn :: Maybe Text
- isWriter :: Maybe Bool
}
newGlobalClusterMember :: GlobalClusterMember
globalClusterMember_readers :: Lens' GlobalClusterMember (Maybe [Text])
globalClusterMember_dbClusterArn :: Lens' GlobalClusterMember (Maybe Text)
globalClusterMember_isWriter :: Lens' GlobalClusterMember (Maybe Bool)
data OrderableDBInstanceOption = OrderableDBInstanceOption' {
- engineVersion :: Maybe Text
- engine :: Maybe Text
- dbInstanceClass :: Maybe Text
- licenseModel :: Maybe Text
- availabilityZones :: Maybe [AvailabilityZone]
- vpc :: Maybe Bool
}
newOrderableDBInstanceOption :: OrderableDBInstanceOption
orderableDBInstanceOption_engineVersion :: Lens' OrderableDBInstanceOption (Maybe Text)
orderableDBInstanceOption_engine :: Lens' OrderableDBInstanceOption (Maybe Text)
orderableDBInstanceOption_dbInstanceClass :: Lens' OrderableDBInstanceOption (Maybe Text)
orderableDBInstanceOption_licenseModel :: Lens' OrderableDBInstanceOption (Maybe Text)
orderableDBInstanceOption_availabilityZones :: Lens' OrderableDBInstanceOption (Maybe [AvailabilityZone])
orderableDBInstanceOption_vpc :: Lens' OrderableDBInstanceOption (Maybe Bool)
data Parameter = Parameter' {
- applyType :: Maybe Text
- parameterValue :: Maybe Text
- applyMethod :: Maybe ApplyMethod
- minimumEngineVersion :: Maybe Text
- source :: Maybe Text
- isModifiable :: Maybe Bool
- dataType :: Maybe Text
- allowedValues :: Maybe Text
- parameterName :: Maybe Text
- description :: Maybe Text
}
newParameter :: Parameter
parameter_applyType :: Lens' Parameter (Maybe Text)
parameter_parameterValue :: Lens' Parameter (Maybe Text)
parameter_applyMethod :: Lens' Parameter (Maybe ApplyMethod)
parameter_minimumEngineVersion :: Lens' Parameter (Maybe Text)
parameter_source :: Lens' Parameter (Maybe Text)
parameter_isModifiable :: Lens' Parameter (Maybe Bool)
parameter_dataType :: Lens' Parameter (Maybe Text)
parameter_allowedValues :: Lens' Parameter (Maybe Text)
parameter_parameterName :: Lens' Parameter (Maybe Text)
parameter_description :: Lens' Parameter (Maybe Text)
data PendingCloudwatchLogsExports = PendingCloudwatchLogsExports' {
- logTypesToEnable :: Maybe [Text]
- logTypesToDisable :: Maybe [Text]
}
newPendingCloudwatchLogsExports :: PendingCloudwatchLogsExports
pendingCloudwatchLogsExports_logTypesToEnable :: Lens' PendingCloudwatchLogsExports (Maybe [Text])
pendingCloudwatchLogsExports_logTypesToDisable :: Lens' PendingCloudwatchLogsExports (Maybe [Text])
data PendingMaintenanceAction = PendingMaintenanceAction' {
- autoAppliedAfterDate :: Maybe ISO8601
- action :: Maybe Text
- optInStatus :: Maybe Text
- description :: Maybe Text
- forcedApplyDate :: Maybe ISO8601
- currentApplyDate :: Maybe ISO8601
}
newPendingMaintenanceAction :: PendingMaintenanceAction
pendingMaintenanceAction_autoAppliedAfterDate :: Lens' PendingMaintenanceAction (Maybe UTCTime)
pendingMaintenanceAction_action :: Lens' PendingMaintenanceAction (Maybe Text)
pendingMaintenanceAction_optInStatus :: Lens' PendingMaintenanceAction (Maybe Text)
pendingMaintenanceAction_description :: Lens' PendingMaintenanceAction (Maybe Text)
pendingMaintenanceAction_forcedApplyDate :: Lens' PendingMaintenanceAction (Maybe UTCTime)
pendingMaintenanceAction_currentApplyDate :: Lens' PendingMaintenanceAction (Maybe UTCTime)
data PendingModifiedValues = PendingModifiedValues' {
- engineVersion :: Maybe Text
- masterUserPassword :: Maybe Text
- dbSubnetGroupName :: Maybe Text
- iops :: Maybe Int
- dbInstanceClass :: Maybe Text
- licenseModel :: Maybe Text
- cACertificateIdentifier :: Maybe Text
- dbInstanceIdentifier :: Maybe Text
- pendingCloudwatchLogsExports :: Maybe PendingCloudwatchLogsExports
- backupRetentionPeriod :: Maybe Int
- multiAZ :: Maybe Bool
- allocatedStorage :: Maybe Int
- port :: Maybe Int
- storageType :: Maybe Text
}
newPendingModifiedValues :: PendingModifiedValues
pendingModifiedValues_engineVersion :: Lens' PendingModifiedValues (Maybe Text)
pendingModifiedValues_masterUserPassword :: Lens' PendingModifiedValues (Maybe Text)
pendingModifiedValues_dbSubnetGroupName :: Lens' PendingModifiedValues (Maybe Text)
pendingModifiedValues_iops :: Lens' PendingModifiedValues (Maybe Int)
pendingModifiedValues_dbInstanceClass :: Lens' PendingModifiedValues (Maybe Text)
pendingModifiedValues_licenseModel :: Lens' PendingModifiedValues (Maybe Text)
pendingModifiedValues_cACertificateIdentifier :: Lens' PendingModifiedValues (Maybe Text)
pendingModifiedValues_dbInstanceIdentifier :: Lens' PendingModifiedValues (Maybe Text)
pendingModifiedValues_pendingCloudwatchLogsExports :: Lens' PendingModifiedValues (Maybe PendingCloudwatchLogsExports)
pendingModifiedValues_backupRetentionPeriod :: Lens' PendingModifiedValues (Maybe Int)
pendingModifiedValues_multiAZ :: Lens' PendingModifiedValues (Maybe Bool)
pendingModifiedValues_allocatedStorage :: Lens' PendingModifiedValues (Maybe Int)
pendingModifiedValues_port :: Lens' PendingModifiedValues (Maybe Int)
pendingModifiedValues_storageType :: Lens' PendingModifiedValues (Maybe Text)
data ResourcePendingMaintenanceActions = ResourcePendingMaintenanceActions' {
- pendingMaintenanceActionDetails :: Maybe [PendingMaintenanceAction]
- resourceIdentifier :: Maybe Text
}
newResourcePendingMaintenanceActions :: ResourcePendingMaintenanceActions
resourcePendingMaintenanceActions_pendingMaintenanceActionDetails :: Lens' ResourcePendingMaintenanceActions (Maybe [PendingMaintenanceAction])
resourcePendingMaintenanceActions_resourceIdentifier :: Lens' ResourcePendingMaintenanceActions (Maybe Text)
data Subnet = Subnet' {
- subnetStatus :: Maybe Text
- subnetIdentifier :: Maybe Text
- subnetAvailabilityZone :: Maybe AvailabilityZone
}
newSubnet :: Subnet
subnet_subnetStatus :: Lens' Subnet (Maybe Text)
subnet_subnetIdentifier :: Lens' Subnet (Maybe Text)
subnet_subnetAvailabilityZone :: Lens' Subnet (Maybe AvailabilityZone)
data Tag = Tag' {
- value :: Maybe Text
- key :: Maybe Text
}
newTag :: Tag
tag_value :: Lens' Tag (Maybe Text)
tag_key :: Lens' Tag (Maybe Text)
data UpgradeTarget = UpgradeTarget' {
- engineVersion :: Maybe Text
- isMajorVersionUpgrade :: Maybe Bool
- engine :: Maybe Text
- autoUpgrade :: Maybe Bool
- description :: Maybe Text
}
newUpgradeTarget :: UpgradeTarget
upgradeTarget_engineVersion :: Lens' UpgradeTarget (Maybe Text)
upgradeTarget_isMajorVersionUpgrade :: Lens' UpgradeTarget (Maybe Bool)
upgradeTarget_engine :: Lens' UpgradeTarget (Maybe Text)
upgradeTarget_autoUpgrade :: Lens' UpgradeTarget (Maybe Bool)
upgradeTarget_description :: Lens' UpgradeTarget (Maybe Text)
data VpcSecurityGroupMembership = VpcSecurityGroupMembership' {
- status :: Maybe Text
- vpcSecurityGroupId :: Maybe Text
}
newVpcSecurityGroupMembership :: VpcSecurityGroupMembership
vpcSecurityGroupMembership_status :: Lens' VpcSecurityGroupMembership (Maybe Text)
vpcSecurityGroupMembership_vpcSecurityGroupId :: Lens' VpcSecurityGroupMembership (Maybe Text)

Service Configuration

defaultService :: Service Source #

API version 2014-10-31 of the Amazon DocumentDB with MongoDB compatibility SDK configuration.

Errors

_InvalidDBParameterGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.

_SourceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The requested source could not be found.

_CertificateNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

CertificateIdentifier doesn't refer to an existing certificate.

_DBClusterSnapshotAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

You already have a cluster snapshot with the given identifier.

_DBParameterGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

A parameter group with the same name already exists.

_DBParameterGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

This request would cause you to exceed the allowed number of parameter groups.

_InsufficientDBClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The cluster doesn't have enough capacity for the current operation.

_SubscriptionCategoryNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The provided category does not exist.

_SubscriptionNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The subscription name does not exist.

_InvalidSubnet :: AsError a => Getting (First ServiceError) a ServiceError Source #

The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request would cause you to exceed the allowed number of subnets in a subnet group.

_GlobalClusterAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The GlobalClusterIdentifier already exists. Choose a new global cluster identifier (unique name) to create a new global cluster.

_DBClusterNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

DBClusterIdentifier doesn't refer to an existing cluster.

_DBClusterAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

You already have a cluster with the given identifier.

_StorageTypeNotSupportedFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

Storage of the specified StorageType can't be associated with the DB instance.

_SNSTopicArnNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The SNS topic Amazon Resource Name (ARN) does not exist.

_InvalidEventSubscriptionStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

Someone else might be modifying a subscription. Wait a few seconds, and try again.

_KMSKeyNotAccessibleFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

An error occurred when accessing an KMS key.

_DBSnapshotNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

DBSnapshotIdentifier doesn't refer to an existing snapshot.

_DBClusterParameterGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.

_DBClusterQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The cluster can't be created because you have reached the maximum allowed quota of clusters.

_SnapshotQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request would cause you to exceed the allowed number of snapshots.

_DBSubnetGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

DBSubnetGroupName is already being used by an existing subnet group.

_SNSNoAuthorizationFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).

_DBSecurityGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

DBSecurityGroupName doesn't refer to an existing security group.

_InstanceQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request would cause you to exceed the allowed number of instances.

_DBParameterGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

DBParameterGroupName doesn't refer to an existing parameter group.

_InvalidDBSubnetStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The subnet isn't in the available state.

_DBClusterSnapshotNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

_SNSInvalidTopicFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

Amazon SNS has responded that there is a problem with the specified topic.

_InsufficientDBInstanceCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified instance class isn't available in the specified Availability Zone.

_InvalidDBClusterSnapshotStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The provided value isn't a valid cluster snapshot state.

_SubscriptionAlreadyExistFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The provided subscription name already exists.

_InvalidVPCNetworkStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

_AuthorizationNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.

Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.

_DBSubnetGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request would cause you to exceed the allowed number of subnet groups.

_InvalidGlobalClusterStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The requested operation can't be performed while the cluster is in this state.

_EventSubscriptionQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

You have reached the maximum number of event subscriptions.

_InsufficientStorageClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

_InvalidDBClusterStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The cluster isn't in a valid state.

_GlobalClusterNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The GlobalClusterIdentifier doesn't refer to an existing global cluster.

_DBInstanceAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

You already have a instance with the given identifier.

_InvalidRestoreFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.

_InvalidDBSecurityGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The state of the security group doesn't allow deletion.

_ResourceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified resource ID was not found.

_DBSubnetGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

DBSubnetGroupName doesn't refer to an existing subnet group.

_DBUpgradeDependencyFailureFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The upgrade failed because a resource that the depends on can't be modified.

_InvalidDBInstanceStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified instance isn't in the available state.

_DBSnapshotAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

DBSnapshotIdentifier is already being used by an existing snapshot.

_DBInstanceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

DBInstanceIdentifier doesn't refer to an existing instance.

_StorageQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request would cause you to exceed the allowed amount of storage available across all instances.

_InvalidDBSnapshotStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The state of the snapshot doesn't allow deletion.

_InvalidDBSubnetGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The subnet group can't be deleted because it's in use.

_GlobalClusterQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #

The number of global clusters for this account is already at the maximum allowed.

_DBSubnetGroupDoesNotCoverEnoughAZs :: AsError a => Getting (First ServiceError) a ServiceError Source #

Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

_SubnetAlreadyInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #

The subnet is already in use in the Availability Zone.

ApplyMethod

newtype ApplyMethod Source #

Constructors

ApplyMethod'
Fields fromApplyMethod :: Text

Bundled Patterns

pattern ApplyMethod_Immediate :: ApplyMethod
pattern ApplyMethod_Pending_reboot :: ApplyMethod

Instances

Instances details

Eq ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod Methods (==) :: ApplyMethod -> ApplyMethod -> Bool # (/=) :: ApplyMethod -> ApplyMethod -> Bool #
Ord ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod Methods compare :: ApplyMethod -> ApplyMethod -> Ordering # (<) :: ApplyMethod -> ApplyMethod -> Bool # (<=) :: ApplyMethod -> ApplyMethod -> Bool # (>) :: ApplyMethod -> ApplyMethod -> Bool # (>=) :: ApplyMethod -> ApplyMethod -> Bool # max :: ApplyMethod -> ApplyMethod -> ApplyMethod # min :: ApplyMethod -> ApplyMethod -> ApplyMethod #
Read ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod Methods readsPrec :: Int -> ReadS ApplyMethod # readList :: ReadS [ApplyMethod] # readPrec :: ReadPrec ApplyMethod # readListPrec :: ReadPrec [ApplyMethod] #
Show ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod Methods showsPrec :: Int -> ApplyMethod -> ShowS # show :: ApplyMethod -> String # showList :: [ApplyMethod] -> ShowS #
Generic ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod Associated Types type Rep ApplyMethod :: Type -> Type # Methods from :: ApplyMethod -> Rep ApplyMethod x # to :: Rep ApplyMethod x -> ApplyMethod #
NFData ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod Methods rnf :: ApplyMethod -> () #
Hashable ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod Methods hashWithSalt :: Int -> ApplyMethod -> Int # hash :: ApplyMethod -> Int #
ToJSON ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod Methods toJSON :: ApplyMethod -> Value # toEncoding :: ApplyMethod -> Encoding # toJSONList :: [ApplyMethod] -> Value # toEncodingList :: [ApplyMethod] -> Encoding #
ToJSONKey ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod Methods toJSONKey :: ToJSONKeyFunction ApplyMethod # toJSONKeyList :: ToJSONKeyFunction [ApplyMethod] #
FromJSON ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod Methods parseJSON :: Value -> Parser ApplyMethod # parseJSONList :: Value -> Parser [ApplyMethod] #
FromJSONKey ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod Methods fromJSONKey :: FromJSONKeyFunction ApplyMethod # fromJSONKeyList :: FromJSONKeyFunction [ApplyMethod] #
ToLog ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod Methods build :: ApplyMethod -> ByteStringBuilder #
ToHeader ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod Methods toHeader :: HeaderName -> ApplyMethod -> [Header] #
ToQuery ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod Methods toQuery :: ApplyMethod -> QueryString #
FromXML ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod Methods parseXML :: [Node] -> Either String ApplyMethod #
ToXML ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod Methods toXML :: ApplyMethod -> XML #
ToByteString ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod Methods toBS :: ApplyMethod -> ByteString #
FromText ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod Methods fromText :: Text -> Either String ApplyMethod #
ToText ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod Methods toText :: ApplyMethod -> Text #
type Rep ApplyMethod Source #
Instance details Defined in Amazonka.DocumentDB.Types.ApplyMethod type Rep ApplyMethod = D1 ('MetaData "ApplyMethod" "Amazonka.DocumentDB.Types.ApplyMethod" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'True) (C1 ('MetaCons "ApplyMethod'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromApplyMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SourceType

newtype SourceType Source #

Constructors

SourceType'
Fields fromSourceType :: Text

Bundled Patterns

pattern SourceType_Db_cluster :: SourceType
pattern SourceType_Db_cluster_snapshot :: SourceType
pattern SourceType_Db_instance :: SourceType
pattern SourceType_Db_parameter_group :: SourceType
pattern SourceType_Db_security_group :: SourceType
pattern SourceType_Db_snapshot :: SourceType

Instances

Instances details

Eq SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType Methods (==) :: SourceType -> SourceType -> Bool # (/=) :: SourceType -> SourceType -> Bool #
Ord SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType Methods compare :: SourceType -> SourceType -> Ordering # (<) :: SourceType -> SourceType -> Bool # (<=) :: SourceType -> SourceType -> Bool # (>) :: SourceType -> SourceType -> Bool # (>=) :: SourceType -> SourceType -> Bool # max :: SourceType -> SourceType -> SourceType # min :: SourceType -> SourceType -> SourceType #
Read SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType Methods readsPrec :: Int -> ReadS SourceType # readList :: ReadS [SourceType] # readPrec :: ReadPrec SourceType # readListPrec :: ReadPrec [SourceType] #
Show SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType Methods showsPrec :: Int -> SourceType -> ShowS # show :: SourceType -> String # showList :: [SourceType] -> ShowS #
Generic SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType Associated Types type Rep SourceType :: Type -> Type # Methods from :: SourceType -> Rep SourceType x # to :: Rep SourceType x -> SourceType #
NFData SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType Methods rnf :: SourceType -> () #
Hashable SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType Methods hashWithSalt :: Int -> SourceType -> Int # hash :: SourceType -> Int #
ToJSON SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType Methods toJSON :: SourceType -> Value # toEncoding :: SourceType -> Encoding # toJSONList :: [SourceType] -> Value # toEncodingList :: [SourceType] -> Encoding #
ToJSONKey SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType Methods toJSONKey :: ToJSONKeyFunction SourceType # toJSONKeyList :: ToJSONKeyFunction [SourceType] #
FromJSON SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType Methods parseJSON :: Value -> Parser SourceType # parseJSONList :: Value -> Parser [SourceType] #
FromJSONKey SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType Methods fromJSONKey :: FromJSONKeyFunction SourceType # fromJSONKeyList :: FromJSONKeyFunction [SourceType] #
ToLog SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType Methods build :: SourceType -> ByteStringBuilder #
ToHeader SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType Methods toHeader :: HeaderName -> SourceType -> [Header] #
ToQuery SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType Methods toQuery :: SourceType -> QueryString #
FromXML SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType Methods parseXML :: [Node] -> Either String SourceType #
ToXML SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType Methods toXML :: SourceType -> XML #
ToByteString SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType Methods toBS :: SourceType -> ByteString #
FromText SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType Methods fromText :: Text -> Either String SourceType #
ToText SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType Methods toText :: SourceType -> Text #
type Rep SourceType Source #
Instance details Defined in Amazonka.DocumentDB.Types.SourceType type Rep SourceType = D1 ('MetaData "SourceType" "Amazonka.DocumentDB.Types.SourceType" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'True) (C1 ('MetaCons "SourceType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AvailabilityZone

data AvailabilityZone Source #

Information about an Availability Zone.

See: newAvailabilityZone smart constructor.

Constructors

AvailabilityZone'
Fields name :: Maybe Text The name of the Availability Zone.

Instances

Instances details

Eq AvailabilityZone Source #
Instance details Defined in Amazonka.DocumentDB.Types.AvailabilityZone Methods (==) :: AvailabilityZone -> AvailabilityZone -> Bool # (/=) :: AvailabilityZone -> AvailabilityZone -> Bool #
Read AvailabilityZone Source #
Instance details Defined in Amazonka.DocumentDB.Types.AvailabilityZone Methods readsPrec :: Int -> ReadS AvailabilityZone # readList :: ReadS [AvailabilityZone] # readPrec :: ReadPrec AvailabilityZone # readListPrec :: ReadPrec [AvailabilityZone] #
Show AvailabilityZone Source #
Instance details Defined in Amazonka.DocumentDB.Types.AvailabilityZone Methods showsPrec :: Int -> AvailabilityZone -> ShowS # show :: AvailabilityZone -> String # showList :: [AvailabilityZone] -> ShowS #
Generic AvailabilityZone Source #
Instance details Defined in Amazonka.DocumentDB.Types.AvailabilityZone Associated Types type Rep AvailabilityZone :: Type -> Type # Methods from :: AvailabilityZone -> Rep AvailabilityZone x # to :: Rep AvailabilityZone x -> AvailabilityZone #
NFData AvailabilityZone Source #
Instance details Defined in Amazonka.DocumentDB.Types.AvailabilityZone Methods rnf :: AvailabilityZone -> () #
Hashable AvailabilityZone Source #
Instance details Defined in Amazonka.DocumentDB.Types.AvailabilityZone Methods hashWithSalt :: Int -> AvailabilityZone -> Int # hash :: AvailabilityZone -> Int #
FromXML AvailabilityZone Source #
Instance details Defined in Amazonka.DocumentDB.Types.AvailabilityZone Methods parseXML :: [Node] -> Either String AvailabilityZone #
type Rep AvailabilityZone Source #
Instance details Defined in Amazonka.DocumentDB.Types.AvailabilityZone type Rep AvailabilityZone = D1 ('MetaData "AvailabilityZone" "Amazonka.DocumentDB.Types.AvailabilityZone" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "AvailabilityZone'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

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.

availabilityZone_name :: Lens' AvailabilityZone (Maybe Text) Source #

The name of the Availability Zone.

Certificate

data Certificate Source #

A certificate authority (CA) certificate for an account.

See: newCertificate smart constructor.

Constructors

Certificate'

Fields

certificateType :: Maybe Text
The type of the certificate.
Example: CA
certificateArn :: Maybe Text
The Amazon Resource Name (ARN) for the certificate.
Example: arn:aws:rds:us-east-1::cert:rds-ca-2019
validTill :: Maybe ISO8601
The date-time after which the certificate is no longer valid.
Example: 2024-07-31T17:57:09Z
certificateIdentifier :: Maybe Text
The unique key that identifies a certificate.
Example: rds-ca-2019
thumbprint :: Maybe Text
The thumbprint of the certificate.
validFrom :: Maybe ISO8601
The starting date-time from which the certificate is valid.
Example: 2019-07-31T17:57:09Z

Instances

Instances details

Eq Certificate Source #
Instance details Defined in Amazonka.DocumentDB.Types.Certificate Methods (==) :: Certificate -> Certificate -> Bool # (/=) :: Certificate -> Certificate -> Bool #
Read Certificate Source #
Instance details Defined in Amazonka.DocumentDB.Types.Certificate Methods readsPrec :: Int -> ReadS Certificate # readList :: ReadS [Certificate] # readPrec :: ReadPrec Certificate # readListPrec :: ReadPrec [Certificate] #
Show Certificate Source #
Instance details Defined in Amazonka.DocumentDB.Types.Certificate Methods showsPrec :: Int -> Certificate -> ShowS # show :: Certificate -> String # showList :: [Certificate] -> ShowS #
Generic Certificate Source #
Instance details Defined in Amazonka.DocumentDB.Types.Certificate Associated Types type Rep Certificate :: Type -> Type # Methods from :: Certificate -> Rep Certificate x # to :: Rep Certificate x -> Certificate #
NFData Certificate Source #
Instance details Defined in Amazonka.DocumentDB.Types.Certificate Methods rnf :: Certificate -> () #
Hashable Certificate Source #
Instance details Defined in Amazonka.DocumentDB.Types.Certificate Methods hashWithSalt :: Int -> Certificate -> Int # hash :: Certificate -> Int #
FromXML Certificate Source #
Instance details Defined in Amazonka.DocumentDB.Types.Certificate Methods parseXML :: [Node] -> Either String Certificate #
type Rep Certificate Source #
Instance details Defined in Amazonka.DocumentDB.Types.Certificate type Rep Certificate = D1 ('MetaData "Certificate" "Amazonka.DocumentDB.Types.Certificate" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "Certificate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "certificateType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "certificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "validTill") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :: (S1 ('MetaSel ('Just "certificateIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "thumbprint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "validFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))))))

newCertificate :: Certificate Source #

Create a value of Certificate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:certificateType:Certificate', certificate_certificateType - The type of the certificate.

Example: CA

$sel:certificateArn:Certificate', certificate_certificateArn - The Amazon Resource Name (ARN) for the certificate.

Example: arn:aws:rds:us-east-1::cert:rds-ca-2019

$sel:validTill:Certificate', certificate_validTill - The date-time after which the certificate is no longer valid.

Example: 2024-07-31T17:57:09Z

$sel:certificateIdentifier:Certificate', certificate_certificateIdentifier - The unique key that identifies a certificate.

Example: rds-ca-2019

$sel:thumbprint:Certificate', certificate_thumbprint - The thumbprint of the certificate.

$sel:validFrom:Certificate', certificate_validFrom - The starting date-time from which the certificate is valid.

Example: 2019-07-31T17:57:09Z

certificate_certificateType :: Lens' Certificate (Maybe Text) Source #

The type of the certificate.

Example: CA

certificate_certificateArn :: Lens' Certificate (Maybe Text) Source #

The Amazon Resource Name (ARN) for the certificate.

Example: arn:aws:rds:us-east-1::cert:rds-ca-2019

certificate_validTill :: Lens' Certificate (Maybe UTCTime) Source #

The date-time after which the certificate is no longer valid.

Example: 2024-07-31T17:57:09Z

certificate_certificateIdentifier :: Lens' Certificate (Maybe Text) Source #

The unique key that identifies a certificate.

Example: rds-ca-2019

certificate_thumbprint :: Lens' Certificate (Maybe Text) Source #

The thumbprint of the certificate.

certificate_validFrom :: Lens' Certificate (Maybe UTCTime) Source #

The starting date-time from which the certificate is valid.

Example: 2019-07-31T17:57:09Z

CloudwatchLogsExportConfiguration

data CloudwatchLogsExportConfiguration Source #

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

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

See: newCloudwatchLogsExportConfiguration smart constructor.

Constructors

CloudwatchLogsExportConfiguration'
Fields disableLogTypes :: Maybe [Text] The list of log types to disable. enableLogTypes :: Maybe [Text] The list of log types to enable.

Instances

Instances details

Eq CloudwatchLogsExportConfiguration Source #
Instance details Defined in Amazonka.DocumentDB.Types.CloudwatchLogsExportConfiguration Methods (==) :: CloudwatchLogsExportConfiguration -> CloudwatchLogsExportConfiguration -> Bool # (/=) :: CloudwatchLogsExportConfiguration -> CloudwatchLogsExportConfiguration -> Bool #
Read CloudwatchLogsExportConfiguration Source #
Instance details Defined in Amazonka.DocumentDB.Types.CloudwatchLogsExportConfiguration Methods readsPrec :: Int -> ReadS CloudwatchLogsExportConfiguration # readList :: ReadS [CloudwatchLogsExportConfiguration] # readPrec :: ReadPrec CloudwatchLogsExportConfiguration # readListPrec :: ReadPrec [CloudwatchLogsExportConfiguration] #
Show CloudwatchLogsExportConfiguration Source #
Instance details Defined in Amazonka.DocumentDB.Types.CloudwatchLogsExportConfiguration Methods showsPrec :: Int -> CloudwatchLogsExportConfiguration -> ShowS # show :: CloudwatchLogsExportConfiguration -> String # showList :: [CloudwatchLogsExportConfiguration] -> ShowS #
Generic CloudwatchLogsExportConfiguration Source #
Instance details Defined in Amazonka.DocumentDB.Types.CloudwatchLogsExportConfiguration Associated Types type Rep CloudwatchLogsExportConfiguration :: Type -> Type # Methods from :: CloudwatchLogsExportConfiguration -> Rep CloudwatchLogsExportConfiguration x # to :: Rep CloudwatchLogsExportConfiguration x -> CloudwatchLogsExportConfiguration #
NFData CloudwatchLogsExportConfiguration Source #
Instance details Defined in Amazonka.DocumentDB.Types.CloudwatchLogsExportConfiguration Methods rnf :: CloudwatchLogsExportConfiguration -> () #
Hashable CloudwatchLogsExportConfiguration Source #
Instance details Defined in Amazonka.DocumentDB.Types.CloudwatchLogsExportConfiguration Methods hashWithSalt :: Int -> CloudwatchLogsExportConfiguration -> Int # hash :: CloudwatchLogsExportConfiguration -> Int #
ToQuery CloudwatchLogsExportConfiguration Source #
Instance details Defined in Amazonka.DocumentDB.Types.CloudwatchLogsExportConfiguration Methods toQuery :: CloudwatchLogsExportConfiguration -> QueryString #
type Rep CloudwatchLogsExportConfiguration Source #
Instance details Defined in Amazonka.DocumentDB.Types.CloudwatchLogsExportConfiguration type Rep CloudwatchLogsExportConfiguration = D1 ('MetaData "CloudwatchLogsExportConfiguration" "Amazonka.DocumentDB.Types.CloudwatchLogsExportConfiguration" "libZSservicesZSamazonka-docdbZSamazonka-docdb" '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.

cloudwatchLogsExportConfiguration_disableLogTypes :: Lens' CloudwatchLogsExportConfiguration (Maybe [Text]) Source #

The list of log types to disable.

cloudwatchLogsExportConfiguration_enableLogTypes :: Lens' CloudwatchLogsExportConfiguration (Maybe [Text]) Source #

The list of log types to enable.

DBCluster

data DBCluster Source #

Detailed information about a cluster.

See: newDBCluster smart constructor.

Constructors

DBCluster'

Fields

engineVersion :: Maybe Text
Indicates the database engine version.
status :: Maybe Text
Specifies the current state of this cluster.
deletionProtection :: Maybe Bool
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
storageEncrypted :: Maybe Bool
Specifies whether the cluster is encrypted.
dbClusterIdentifier :: Maybe Text
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
dbClusterMembers :: Maybe [DBClusterMember]
Provides the list of instances that make up the cluster.
readReplicaIdentifiers :: Maybe [Text]
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
replicationSourceIdentifier :: Maybe Text
Contains the identifier of the source cluster if this cluster is a secondary cluster.
hostedZoneId :: Maybe Text
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
dbClusterParameterGroup :: Maybe Text
Specifies the name of the cluster parameter group for the cluster.
masterUsername :: Maybe Text
Contains the master user name for the cluster.
dbClusterResourceId :: Maybe Text
The Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
earliestRestorableTime :: Maybe ISO8601
The earliest time to which a database can be restored with point-in-time restore.
engine :: Maybe Text
Provides the name of the database engine to be used for this cluster.
dbClusterArn :: Maybe Text
The Amazon Resource Name (ARN) for the cluster.
latestRestorableTime :: Maybe ISO8601
Specifies the latest time to which a database can be restored with point-in-time restore.
preferredMaintenanceWindow :: Maybe Text
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
availabilityZones :: Maybe [Text]
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
kmsKeyId :: Maybe Text
If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.
preferredBackupWindow :: Maybe Text
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
associatedRoles :: Maybe [DBClusterRole]
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
vpcSecurityGroups :: Maybe [VpcSecurityGroupMembership]
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
backupRetentionPeriod :: Maybe Int
Specifies the number of days for which automatic snapshots are retained.
dbSubnetGroup :: Maybe Text
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
multiAZ :: Maybe Bool
Specifies whether the cluster has instances in multiple Availability Zones.
enabledCloudwatchLogsExports :: Maybe [Text]
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
clusterCreateTime :: Maybe ISO8601
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
endpoint :: Maybe Text
Specifies the connection endpoint for the primary instance of the cluster.
percentProgress :: Maybe Text
Specifies the progress of the operation as a percentage.
readerEndpoint :: Maybe Text
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
port :: Maybe Int
Specifies the port that the database engine is listening on.

Instances

Instances details

Eq DBCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBCluster Methods (==) :: DBCluster -> DBCluster -> Bool # (/=) :: DBCluster -> DBCluster -> Bool #
Read DBCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBCluster Methods readsPrec :: Int -> ReadS DBCluster # readList :: ReadS [DBCluster] # readPrec :: ReadPrec DBCluster # readListPrec :: ReadPrec [DBCluster] #
Show DBCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBCluster Methods showsPrec :: Int -> DBCluster -> ShowS # show :: DBCluster -> String # showList :: [DBCluster] -> ShowS #
Generic DBCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBCluster Associated Types type Rep DBCluster :: Type -> Type # Methods from :: DBCluster -> Rep DBCluster x # to :: Rep DBCluster x -> DBCluster #
NFData DBCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBCluster Methods rnf :: DBCluster -> () #
Hashable DBCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBCluster Methods hashWithSalt :: Int -> DBCluster -> Int # hash :: DBCluster -> Int #
FromXML DBCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBCluster Methods parseXML :: [Node] -> Either String DBCluster #
type Rep DBCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBCluster type Rep DBCluster = D1 ('MetaData "DBCluster" "Amazonka.DocumentDB.Types.DBCluster" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DBCluster'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "dbClusterMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBClusterMember])) :: S1 ('MetaSel ('Just "readReplicaIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: (((S1 ('MetaSel ('Just "replicationSourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "hostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "dbClusterParameterGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "masterUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "dbClusterResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "earliestRestorableTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :: (S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbClusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: ((((S1 ('MetaSel ('Just "latestRestorableTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "availabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "preferredBackupWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "associatedRoles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBClusterRole]))) :: (S1 ('MetaSel ('Just "vpcSecurityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VpcSecurityGroupMembership])) :: S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: (((S1 ('MetaSel ('Just "dbSubnetGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "multiAZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "enabledCloudwatchLogsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "clusterCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :: ((S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "percentProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "readerEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))))

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 cluster.

$sel:deletionProtection:DBCluster', dbCluster_deletionProtection - Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

$sel:storageEncrypted:DBCluster', dbCluster_storageEncrypted - Specifies whether the cluster is encrypted.

$sel:dbClusterIdentifier:DBCluster', dbCluster_dbClusterIdentifier - Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

$sel:dbClusterMembers:DBCluster', dbCluster_dbClusterMembers - Provides the list of instances that make up the cluster.

$sel:readReplicaIdentifiers:DBCluster', dbCluster_readReplicaIdentifiers - Contains one or more identifiers of the secondary clusters that are associated with this cluster.

$sel:replicationSourceIdentifier:DBCluster', dbCluster_replicationSourceIdentifier - Contains the identifier of the source cluster if this cluster is a secondary cluster.

$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 cluster parameter group for the cluster.

$sel:masterUsername:DBCluster', dbCluster_masterUsername - Contains the master user name for the cluster.

$sel:dbClusterResourceId:DBCluster', dbCluster_dbClusterResourceId - The Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

$sel:earliestRestorableTime:DBCluster', dbCluster_earliestRestorableTime - 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 cluster.

$sel:dbClusterArn:DBCluster', dbCluster_dbClusterArn - The Amazon Resource Name (ARN) for the cluster.

$sel:latestRestorableTime:DBCluster', dbCluster_latestRestorableTime - Specifies the latest time to which a database can be restored with point-in-time restore.

$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 Amazon EC2 Availability Zones that instances in the cluster can be created in.

$sel:kmsKeyId:DBCluster', dbCluster_kmsKeyId - If StorageEncrypted is true, the KMS key identifier for the encrypted 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 Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

$sel:vpcSecurityGroups:DBCluster', dbCluster_vpcSecurityGroups - Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

$sel:backupRetentionPeriod:DBCluster', dbCluster_backupRetentionPeriod - Specifies the number of days for which automatic snapshots are retained.

$sel:dbSubnetGroup:DBCluster', dbCluster_dbSubnetGroup - Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

$sel:multiAZ:DBCluster', dbCluster_multiAZ - Specifies whether the cluster has instances in multiple Availability Zones.

$sel:enabledCloudwatchLogsExports:DBCluster', dbCluster_enabledCloudwatchLogsExports - A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

$sel:clusterCreateTime:DBCluster', dbCluster_clusterCreateTime - Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

$sel:endpoint:DBCluster', dbCluster_endpoint - Specifies the connection endpoint for the primary instance of the 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 cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

$sel:port:DBCluster', dbCluster_port - Specifies the port that the database engine is listening on.

dbCluster_engineVersion :: Lens' DBCluster (Maybe Text) Source #

Indicates the database engine version.

dbCluster_status :: Lens' DBCluster (Maybe Text) Source #

Specifies the current state of this cluster.

dbCluster_deletionProtection :: Lens' DBCluster (Maybe Bool) Source #

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

dbCluster_storageEncrypted :: Lens' DBCluster (Maybe Bool) Source #

Specifies whether the cluster is encrypted.

dbCluster_dbClusterIdentifier :: Lens' DBCluster (Maybe Text) Source #

Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

dbCluster_dbClusterMembers :: Lens' DBCluster (Maybe [DBClusterMember]) Source #

Provides the list of instances that make up the cluster.

dbCluster_readReplicaIdentifiers :: Lens' DBCluster (Maybe [Text]) Source #

Contains one or more identifiers of the secondary clusters that are associated with this cluster.

dbCluster_replicationSourceIdentifier :: Lens' DBCluster (Maybe Text) Source #

Contains the identifier of the source cluster if this cluster is a secondary cluster.

dbCluster_hostedZoneId :: Lens' DBCluster (Maybe Text) Source #

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

dbCluster_dbClusterParameterGroup :: Lens' DBCluster (Maybe Text) Source #

Specifies the name of the cluster parameter group for the cluster.

dbCluster_masterUsername :: Lens' DBCluster (Maybe Text) Source #

Contains the master user name for the cluster.

dbCluster_dbClusterResourceId :: Lens' DBCluster (Maybe Text) Source #

The Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

dbCluster_earliestRestorableTime :: Lens' DBCluster (Maybe UTCTime) Source #

The earliest time to which a database can be restored with point-in-time restore.

dbCluster_engine :: Lens' DBCluster (Maybe Text) Source #

Provides the name of the database engine to be used for this cluster.

dbCluster_dbClusterArn :: Lens' DBCluster (Maybe Text) Source #

The Amazon Resource Name (ARN) for the cluster.

dbCluster_latestRestorableTime :: Lens' DBCluster (Maybe UTCTime) Source #

Specifies the latest time to which a database can be restored with point-in-time restore.

dbCluster_preferredMaintenanceWindow :: Lens' DBCluster (Maybe Text) Source #

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

dbCluster_availabilityZones :: Lens' DBCluster (Maybe [Text]) Source #

Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

dbCluster_kmsKeyId :: Lens' DBCluster (Maybe Text) Source #

If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

dbCluster_preferredBackupWindow :: Lens' DBCluster (Maybe Text) Source #

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

dbCluster_associatedRoles :: Lens' DBCluster (Maybe [DBClusterRole]) Source #

Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

dbCluster_vpcSecurityGroups :: Lens' DBCluster (Maybe [VpcSecurityGroupMembership]) Source #

Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

dbCluster_backupRetentionPeriod :: Lens' DBCluster (Maybe Int) Source #

Specifies the number of days for which automatic snapshots are retained.

dbCluster_dbSubnetGroup :: Lens' DBCluster (Maybe Text) Source #

Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

dbCluster_multiAZ :: Lens' DBCluster (Maybe Bool) Source #

Specifies whether the cluster has instances in multiple Availability Zones.

dbCluster_enabledCloudwatchLogsExports :: Lens' DBCluster (Maybe [Text]) Source #

A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

dbCluster_clusterCreateTime :: Lens' DBCluster (Maybe UTCTime) Source #

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

dbCluster_endpoint :: Lens' DBCluster (Maybe Text) Source #

Specifies the connection endpoint for the primary instance of the cluster.

dbCluster_percentProgress :: Lens' DBCluster (Maybe Text) Source #

Specifies the progress of the operation as a percentage.

dbCluster_readerEndpoint :: Lens' DBCluster (Maybe Text) Source #

The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

dbCluster_port :: Lens' DBCluster (Maybe Int) Source #

Specifies the port that the database engine is listening on.

DBClusterMember

data DBClusterMember Source #

Contains information about an instance that is part of a cluster.

See: newDBClusterMember smart constructor.

Constructors

DBClusterMember'

Fields

promotionTier :: Maybe Int
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
dbInstanceIdentifier :: Maybe Text
Specifies the instance identifier for this member of the cluster.
isClusterWriter :: Maybe Bool
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
dbClusterParameterGroupStatus :: Maybe Text
Specifies the status of the cluster parameter group for this member of the DB cluster.

Instances

Instances details

Eq DBClusterMember Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterMember Methods (==) :: DBClusterMember -> DBClusterMember -> Bool # (/=) :: DBClusterMember -> DBClusterMember -> Bool #
Read DBClusterMember Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterMember Methods readsPrec :: Int -> ReadS DBClusterMember # readList :: ReadS [DBClusterMember] # readPrec :: ReadPrec DBClusterMember # readListPrec :: ReadPrec [DBClusterMember] #
Show DBClusterMember Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterMember Methods showsPrec :: Int -> DBClusterMember -> ShowS # show :: DBClusterMember -> String # showList :: [DBClusterMember] -> ShowS #
Generic DBClusterMember Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterMember Associated Types type Rep DBClusterMember :: Type -> Type # Methods from :: DBClusterMember -> Rep DBClusterMember x # to :: Rep DBClusterMember x -> DBClusterMember #
NFData DBClusterMember Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterMember Methods rnf :: DBClusterMember -> () #
Hashable DBClusterMember Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterMember Methods hashWithSalt :: Int -> DBClusterMember -> Int # hash :: DBClusterMember -> Int #
FromXML DBClusterMember Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterMember Methods parseXML :: [Node] -> Either String DBClusterMember #
type Rep DBClusterMember Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterMember type Rep DBClusterMember = D1 ('MetaData "DBClusterMember" "Amazonka.DocumentDB.Types.DBClusterMember" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DBClusterMember'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "promotionTier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "isClusterWriter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "dbClusterParameterGroupStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDBClusterMember :: DBClusterMember Source #

Create a value of DBClusterMember with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:promotionTier:DBClusterMember', dbClusterMember_promotionTier - A value that specifies the order in which an Amazon DocumentDB 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 cluster.

$sel:isClusterWriter:DBClusterMember', dbClusterMember_isClusterWriter - A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

$sel:dbClusterParameterGroupStatus:DBClusterMember', dbClusterMember_dbClusterParameterGroupStatus - Specifies the status of the cluster parameter group for this member of the DB cluster.

dbClusterMember_promotionTier :: Lens' DBClusterMember (Maybe Int) Source #

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

dbClusterMember_dbInstanceIdentifier :: Lens' DBClusterMember (Maybe Text) Source #

Specifies the instance identifier for this member of the cluster.

dbClusterMember_isClusterWriter :: Lens' DBClusterMember (Maybe Bool) Source #

A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

dbClusterMember_dbClusterParameterGroupStatus :: Lens' DBClusterMember (Maybe Text) Source #

Specifies the status of the cluster parameter group for this member of the DB cluster.

DBClusterParameterGroup

data DBClusterParameterGroup Source #

Detailed information about a cluster parameter group.

See: newDBClusterParameterGroup smart constructor.

Constructors

DBClusterParameterGroup'

Fields

dbClusterParameterGroupArn :: Maybe Text
The Amazon Resource Name (ARN) for the cluster parameter group.
dbParameterGroupFamily :: Maybe Text
Provides the name of the parameter group family that this cluster parameter group is compatible with.
dbClusterParameterGroupName :: Maybe Text
Provides the name of the cluster parameter group.
description :: Maybe Text
Provides the customer-specified description for this cluster parameter group.

Instances

Instances details

Eq DBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroup Methods (==) :: DBClusterParameterGroup -> DBClusterParameterGroup -> Bool # (/=) :: DBClusterParameterGroup -> DBClusterParameterGroup -> Bool #
Read DBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroup Methods readsPrec :: Int -> ReadS DBClusterParameterGroup # readList :: ReadS [DBClusterParameterGroup] # readPrec :: ReadPrec DBClusterParameterGroup # readListPrec :: ReadPrec [DBClusterParameterGroup] #
Show DBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroup Methods showsPrec :: Int -> DBClusterParameterGroup -> ShowS # show :: DBClusterParameterGroup -> String # showList :: [DBClusterParameterGroup] -> ShowS #
Generic DBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroup Associated Types type Rep DBClusterParameterGroup :: Type -> Type # Methods from :: DBClusterParameterGroup -> Rep DBClusterParameterGroup x # to :: Rep DBClusterParameterGroup x -> DBClusterParameterGroup #
NFData DBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroup Methods rnf :: DBClusterParameterGroup -> () #
Hashable DBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroup Methods hashWithSalt :: Int -> DBClusterParameterGroup -> Int # hash :: DBClusterParameterGroup -> Int #
FromXML DBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroup Methods parseXML :: [Node] -> Either String DBClusterParameterGroup #
type Rep DBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroup type Rep DBClusterParameterGroup = D1 ('MetaData "DBClusterParameterGroup" "Amazonka.DocumentDB.Types.DBClusterParameterGroup" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DBClusterParameterGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbClusterParameterGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbParameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDBClusterParameterGroup :: DBClusterParameterGroup Source #

Create a value of DBClusterParameterGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dbClusterParameterGroupArn:DBClusterParameterGroup', dbClusterParameterGroup_dbClusterParameterGroupArn - The Amazon Resource Name (ARN) for the cluster parameter group.

$sel:dbParameterGroupFamily:DBClusterParameterGroup', dbClusterParameterGroup_dbParameterGroupFamily - Provides the name of the parameter group family that this cluster parameter group is compatible with.

$sel:dbClusterParameterGroupName:DBClusterParameterGroup', dbClusterParameterGroup_dbClusterParameterGroupName - Provides the name of the cluster parameter group.

$sel:description:DBClusterParameterGroup', dbClusterParameterGroup_description - Provides the customer-specified description for this cluster parameter group.

dbClusterParameterGroup_dbClusterParameterGroupArn :: Lens' DBClusterParameterGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) for the cluster parameter group.

dbClusterParameterGroup_dbParameterGroupFamily :: Lens' DBClusterParameterGroup (Maybe Text) Source #

Provides the name of the parameter group family that this cluster parameter group is compatible with.

dbClusterParameterGroup_dbClusterParameterGroupName :: Lens' DBClusterParameterGroup (Maybe Text) Source #

Provides the name of the cluster parameter group.

dbClusterParameterGroup_description :: Lens' DBClusterParameterGroup (Maybe Text) Source #

Provides the customer-specified description for this cluster parameter group.

DBClusterParameterGroupNameMessage

data DBClusterParameterGroupNameMessage Source #

Contains the name of a cluster parameter group.

See: newDBClusterParameterGroupNameMessage smart constructor.

Constructors

DBClusterParameterGroupNameMessage'
Fields dbClusterParameterGroupName :: Maybe Text The name of a cluster parameter group. Constraints: Must be from 1 to 255 letters or numbers. The first character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. This value is stored as a lowercase string.

Instances

Instances details

Eq DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage Methods (==) :: DBClusterParameterGroupNameMessage -> DBClusterParameterGroupNameMessage -> Bool # (/=) :: DBClusterParameterGroupNameMessage -> DBClusterParameterGroupNameMessage -> Bool #
Read DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage Methods readsPrec :: Int -> ReadS DBClusterParameterGroupNameMessage # readList :: ReadS [DBClusterParameterGroupNameMessage] # readPrec :: ReadPrec DBClusterParameterGroupNameMessage # readListPrec :: ReadPrec [DBClusterParameterGroupNameMessage] #
Show DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage Methods showsPrec :: Int -> DBClusterParameterGroupNameMessage -> ShowS # show :: DBClusterParameterGroupNameMessage -> String # showList :: [DBClusterParameterGroupNameMessage] -> ShowS #
Generic DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage Associated Types type Rep DBClusterParameterGroupNameMessage :: Type -> Type # Methods from :: DBClusterParameterGroupNameMessage -> Rep DBClusterParameterGroupNameMessage x # to :: Rep DBClusterParameterGroupNameMessage x -> DBClusterParameterGroupNameMessage #
NFData DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage Methods rnf :: DBClusterParameterGroupNameMessage -> () #
Hashable DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage Methods hashWithSalt :: Int -> DBClusterParameterGroupNameMessage -> Int # hash :: DBClusterParameterGroupNameMessage -> Int #
FromXML DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage Methods parseXML :: [Node] -> Either String DBClusterParameterGroupNameMessage #
type Rep DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage type Rep DBClusterParameterGroupNameMessage = D1 ('MetaData "DBClusterParameterGroupNameMessage" "Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DBClusterParameterGroupNameMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage Source #

Create a value of DBClusterParameterGroupNameMessage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dbClusterParameterGroupName:DBClusterParameterGroupNameMessage', dbClusterParameterGroupNameMessage_dbClusterParameterGroupName - The name of a cluster parameter group.

Constraints:

Must be from 1 to 255 letters or numbers.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

This value is stored as a lowercase string.

dbClusterParameterGroupNameMessage_dbClusterParameterGroupName :: Lens' DBClusterParameterGroupNameMessage (Maybe Text) Source #

The name of a cluster parameter group.

Constraints:

Must be from 1 to 255 letters or numbers.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

This value is stored as a lowercase string.

DBClusterRole

data DBClusterRole Source #

Describes an Identity and Access Management (IAM) role that is associated with a cluster.

See: newDBClusterRole smart constructor.

Constructors

DBClusterRole'

Fields

status :: Maybe Text
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
- ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
- PENDING - The IAMrole ARN is being associated with the cluster.
- INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.
roleArn :: Maybe Text
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

Instances

Instances details

Eq DBClusterRole Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterRole Methods (==) :: DBClusterRole -> DBClusterRole -> Bool # (/=) :: DBClusterRole -> DBClusterRole -> Bool #
Read DBClusterRole Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterRole Methods readsPrec :: Int -> ReadS DBClusterRole # readList :: ReadS [DBClusterRole] # readPrec :: ReadPrec DBClusterRole # readListPrec :: ReadPrec [DBClusterRole] #
Show DBClusterRole Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterRole Methods showsPrec :: Int -> DBClusterRole -> ShowS # show :: DBClusterRole -> String # showList :: [DBClusterRole] -> ShowS #
Generic DBClusterRole Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterRole Associated Types type Rep DBClusterRole :: Type -> Type # Methods from :: DBClusterRole -> Rep DBClusterRole x # to :: Rep DBClusterRole x -> DBClusterRole #
NFData DBClusterRole Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterRole Methods rnf :: DBClusterRole -> () #
Hashable DBClusterRole Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterRole Methods hashWithSalt :: Int -> DBClusterRole -> Int # hash :: DBClusterRole -> Int #
FromXML DBClusterRole Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterRole Methods parseXML :: [Node] -> Either String DBClusterRole #
type Rep DBClusterRole Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterRole type Rep DBClusterRole = D1 ('MetaData "DBClusterRole" "Amazonka.DocumentDB.Types.DBClusterRole" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DBClusterRole'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

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 IAMrole and the cluster. The Status property returns one of the following values:

ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
PENDING - The IAMrole ARN is being associated with the cluster.
INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

$sel:roleArn:DBClusterRole', dbClusterRole_roleArn - The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

dbClusterRole_status :: Lens' DBClusterRole (Maybe Text) Source #

Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
PENDING - The IAMrole ARN is being associated with the cluster.
INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

dbClusterRole_roleArn :: Lens' DBClusterRole (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

DBClusterSnapshot

data DBClusterSnapshot Source #

Detailed information about a cluster snapshot.

See: newDBClusterSnapshot smart constructor.

Constructors

DBClusterSnapshot'

Fields

engineVersion :: Maybe Text
Provides the version of the database engine for this cluster snapshot.
status :: Maybe Text
Specifies the status of this cluster snapshot.
storageEncrypted :: Maybe Bool
Specifies whether the cluster snapshot is encrypted.
dbClusterIdentifier :: Maybe Text
Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
masterUsername :: Maybe Text
Provides the master user name for the cluster snapshot.
dbClusterSnapshotArn :: Maybe Text
The Amazon Resource Name (ARN) for the cluster snapshot.
vpcId :: Maybe Text
Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
dbClusterSnapshotIdentifier :: Maybe Text
Specifies the identifier for the cluster snapshot.
engine :: Maybe Text
Specifies the name of the database engine.
availabilityZones :: Maybe [Text]
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
snapshotType :: Maybe Text
Provides the type of the cluster snapshot.
kmsKeyId :: Maybe Text
If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.
snapshotCreateTime :: Maybe ISO8601
Provides the time when the snapshot was taken, in UTC.
sourceDBClusterSnapshotArn :: Maybe Text
If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
clusterCreateTime :: Maybe ISO8601
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
percentProgress :: Maybe Int
Specifies the percentage of the estimated data that has been transferred.
port :: Maybe Int
Specifies the port that the cluster was listening on at the time of the snapshot.

Instances

Instances details

Eq DBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot Methods (==) :: DBClusterSnapshot -> DBClusterSnapshot -> Bool # (/=) :: DBClusterSnapshot -> DBClusterSnapshot -> Bool #
Read DBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot Methods readsPrec :: Int -> ReadS DBClusterSnapshot # readList :: ReadS [DBClusterSnapshot] # readPrec :: ReadPrec DBClusterSnapshot # readListPrec :: ReadPrec [DBClusterSnapshot] #
Show DBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot Methods showsPrec :: Int -> DBClusterSnapshot -> ShowS # show :: DBClusterSnapshot -> String # showList :: [DBClusterSnapshot] -> ShowS #
Generic DBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot Associated Types type Rep DBClusterSnapshot :: Type -> Type # Methods from :: DBClusterSnapshot -> Rep DBClusterSnapshot x # to :: Rep DBClusterSnapshot x -> DBClusterSnapshot #
NFData DBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot Methods rnf :: DBClusterSnapshot -> () #
Hashable DBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot Methods hashWithSalt :: Int -> DBClusterSnapshot -> Int # hash :: DBClusterSnapshot -> Int #
FromXML DBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot Methods parseXML :: [Node] -> Either String DBClusterSnapshot #
type Rep DBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot type Rep DBClusterSnapshot = D1 ('MetaData "DBClusterSnapshot" "Amazonka.DocumentDB.Types.DBClusterSnapshot" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DBClusterSnapshot'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "masterUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbClusterSnapshotArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbClusterSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "availabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "snapshotType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "snapshotCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "sourceDBClusterSnapshotArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "clusterCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "percentProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))))

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 cluster snapshot.

$sel:status:DBClusterSnapshot', dbClusterSnapshot_status - Specifies the status of this cluster snapshot.

$sel:storageEncrypted:DBClusterSnapshot', dbClusterSnapshot_storageEncrypted - Specifies whether the cluster snapshot is encrypted.

$sel:dbClusterIdentifier:DBClusterSnapshot', dbClusterSnapshot_dbClusterIdentifier - Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

$sel:masterUsername:DBClusterSnapshot', dbClusterSnapshot_masterUsername - Provides the master user name for the cluster snapshot.

$sel:dbClusterSnapshotArn:DBClusterSnapshot', dbClusterSnapshot_dbClusterSnapshotArn - The Amazon Resource Name (ARN) for the cluster snapshot.

$sel:vpcId:DBClusterSnapshot', dbClusterSnapshot_vpcId - Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

$sel:dbClusterSnapshotIdentifier:DBClusterSnapshot', dbClusterSnapshot_dbClusterSnapshotIdentifier - Specifies the identifier for the cluster snapshot.

$sel:engine:DBClusterSnapshot', dbClusterSnapshot_engine - Specifies the name of the database engine.

$sel:availabilityZones:DBClusterSnapshot', dbClusterSnapshot_availabilityZones - Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

$sel:snapshotType:DBClusterSnapshot', dbClusterSnapshot_snapshotType - Provides the type of the cluster snapshot.

$sel:kmsKeyId:DBClusterSnapshot', dbClusterSnapshot_kmsKeyId - If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.

$sel:snapshotCreateTime:DBClusterSnapshot', dbClusterSnapshot_snapshotCreateTime - Provides the time when the snapshot was taken, in UTC.

$sel:sourceDBClusterSnapshotArn:DBClusterSnapshot', dbClusterSnapshot_sourceDBClusterSnapshotArn - If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

$sel:clusterCreateTime:DBClusterSnapshot', dbClusterSnapshot_clusterCreateTime - Specifies the time when the 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 cluster was listening on at the time of the snapshot.

dbClusterSnapshot_engineVersion :: Lens' DBClusterSnapshot (Maybe Text) Source #

Provides the version of the database engine for this cluster snapshot.

dbClusterSnapshot_status :: Lens' DBClusterSnapshot (Maybe Text) Source #

Specifies the status of this cluster snapshot.

dbClusterSnapshot_storageEncrypted :: Lens' DBClusterSnapshot (Maybe Bool) Source #

Specifies whether the cluster snapshot is encrypted.

dbClusterSnapshot_dbClusterIdentifier :: Lens' DBClusterSnapshot (Maybe Text) Source #

Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

dbClusterSnapshot_masterUsername :: Lens' DBClusterSnapshot (Maybe Text) Source #

Provides the master user name for the cluster snapshot.

dbClusterSnapshot_dbClusterSnapshotArn :: Lens' DBClusterSnapshot (Maybe Text) Source #

The Amazon Resource Name (ARN) for the cluster snapshot.

dbClusterSnapshot_vpcId :: Lens' DBClusterSnapshot (Maybe Text) Source #

Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

dbClusterSnapshot_dbClusterSnapshotIdentifier :: Lens' DBClusterSnapshot (Maybe Text) Source #

Specifies the identifier for the cluster snapshot.

dbClusterSnapshot_engine :: Lens' DBClusterSnapshot (Maybe Text) Source #

Specifies the name of the database engine.

dbClusterSnapshot_availabilityZones :: Lens' DBClusterSnapshot (Maybe [Text]) Source #

Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

dbClusterSnapshot_snapshotType :: Lens' DBClusterSnapshot (Maybe Text) Source #

Provides the type of the cluster snapshot.

dbClusterSnapshot_kmsKeyId :: Lens' DBClusterSnapshot (Maybe Text) Source #

If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.

dbClusterSnapshot_snapshotCreateTime :: Lens' DBClusterSnapshot (Maybe UTCTime) Source #

Provides the time when the snapshot was taken, in UTC.

dbClusterSnapshot_sourceDBClusterSnapshotArn :: Lens' DBClusterSnapshot (Maybe Text) Source #

If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

dbClusterSnapshot_clusterCreateTime :: Lens' DBClusterSnapshot (Maybe UTCTime) Source #

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

dbClusterSnapshot_percentProgress :: Lens' DBClusterSnapshot (Maybe Int) Source #

Specifies the percentage of the estimated data that has been transferred.

dbClusterSnapshot_port :: Lens' DBClusterSnapshot (Maybe Int) Source #

Specifies the port that the cluster was listening on at the time of the snapshot.

DBClusterSnapshotAttribute

data DBClusterSnapshotAttribute Source #

Contains the name and values of a manual cluster snapshot attribute.

Manual cluster snapshot attributes are used to authorize other accounts to restore a manual cluster snapshot.

See: newDBClusterSnapshotAttribute smart constructor.

Constructors

DBClusterSnapshotAttribute'

Fields

attributeValues :: Maybe [Text]
The values for the manual cluster snapshot attribute.
If the AttributeName field is set to restore, then this element returns a list of IDs of the accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any account to copy or restore.
attributeName :: Maybe Text
The name of the manual cluster snapshot attribute.
The attribute named restore refers to the list of accounts that have permission to copy or restore the manual cluster snapshot.

Instances

Instances details

Eq DBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttribute Methods (==) :: DBClusterSnapshotAttribute -> DBClusterSnapshotAttribute -> Bool # (/=) :: DBClusterSnapshotAttribute -> DBClusterSnapshotAttribute -> Bool #
Read DBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttribute Methods readsPrec :: Int -> ReadS DBClusterSnapshotAttribute # readList :: ReadS [DBClusterSnapshotAttribute] # readPrec :: ReadPrec DBClusterSnapshotAttribute # readListPrec :: ReadPrec [DBClusterSnapshotAttribute] #
Show DBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttribute Methods showsPrec :: Int -> DBClusterSnapshotAttribute -> ShowS # show :: DBClusterSnapshotAttribute -> String # showList :: [DBClusterSnapshotAttribute] -> ShowS #
Generic DBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttribute Associated Types type Rep DBClusterSnapshotAttribute :: Type -> Type # Methods from :: DBClusterSnapshotAttribute -> Rep DBClusterSnapshotAttribute x # to :: Rep DBClusterSnapshotAttribute x -> DBClusterSnapshotAttribute #
NFData DBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttribute Methods rnf :: DBClusterSnapshotAttribute -> () #
Hashable DBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttribute Methods hashWithSalt :: Int -> DBClusterSnapshotAttribute -> Int # hash :: DBClusterSnapshotAttribute -> Int #
FromXML DBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttribute Methods parseXML :: [Node] -> Either String DBClusterSnapshotAttribute #
type Rep DBClusterSnapshotAttribute Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttribute type Rep DBClusterSnapshotAttribute = D1 ('MetaData "DBClusterSnapshotAttribute" "Amazonka.DocumentDB.Types.DBClusterSnapshotAttribute" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DBClusterSnapshotAttribute'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributeValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "attributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

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 values for the manual cluster snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any account to copy or restore.

$sel:attributeName:DBClusterSnapshotAttribute', dbClusterSnapshotAttribute_attributeName - The name of the manual cluster snapshot attribute.

The attribute named restore refers to the list of accounts that have permission to copy or restore the manual cluster snapshot.

dbClusterSnapshotAttribute_attributeValues :: Lens' DBClusterSnapshotAttribute (Maybe [Text]) Source #

The values for the manual cluster snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any account to copy or restore.

dbClusterSnapshotAttribute_attributeName :: Lens' DBClusterSnapshotAttribute (Maybe Text) Source #

The name of the manual cluster snapshot attribute.

The attribute named restore refers to the list of accounts that have permission to copy or restore the manual cluster snapshot.

DBClusterSnapshotAttributesResult

data DBClusterSnapshotAttributesResult Source #

Detailed information about the attributes that are associated with a cluster snapshot.

See: newDBClusterSnapshotAttributesResult smart constructor.

Constructors

DBClusterSnapshotAttributesResult'
Fields dbClusterSnapshotIdentifier :: Maybe Text The identifier of the cluster snapshot that the attributes apply to. dbClusterSnapshotAttributes :: Maybe [DBClusterSnapshotAttribute] The list of attributes and values for the cluster snapshot.

Instances

Instances details

Eq DBClusterSnapshotAttributesResult Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttributesResult Methods (==) :: DBClusterSnapshotAttributesResult -> DBClusterSnapshotAttributesResult -> Bool # (/=) :: DBClusterSnapshotAttributesResult -> DBClusterSnapshotAttributesResult -> Bool #
Read DBClusterSnapshotAttributesResult Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttributesResult Methods readsPrec :: Int -> ReadS DBClusterSnapshotAttributesResult # readList :: ReadS [DBClusterSnapshotAttributesResult] # readPrec :: ReadPrec DBClusterSnapshotAttributesResult # readListPrec :: ReadPrec [DBClusterSnapshotAttributesResult] #
Show DBClusterSnapshotAttributesResult Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttributesResult Methods showsPrec :: Int -> DBClusterSnapshotAttributesResult -> ShowS # show :: DBClusterSnapshotAttributesResult -> String # showList :: [DBClusterSnapshotAttributesResult] -> ShowS #
Generic DBClusterSnapshotAttributesResult Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttributesResult Associated Types type Rep DBClusterSnapshotAttributesResult :: Type -> Type # Methods from :: DBClusterSnapshotAttributesResult -> Rep DBClusterSnapshotAttributesResult x # to :: Rep DBClusterSnapshotAttributesResult x -> DBClusterSnapshotAttributesResult #
NFData DBClusterSnapshotAttributesResult Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttributesResult Methods rnf :: DBClusterSnapshotAttributesResult -> () #
Hashable DBClusterSnapshotAttributesResult Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttributesResult Methods hashWithSalt :: Int -> DBClusterSnapshotAttributesResult -> Int # hash :: DBClusterSnapshotAttributesResult -> Int #
FromXML DBClusterSnapshotAttributesResult Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttributesResult Methods parseXML :: [Node] -> Either String DBClusterSnapshotAttributesResult #
type Rep DBClusterSnapshotAttributesResult Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttributesResult type Rep DBClusterSnapshotAttributesResult = D1 ('MetaData "DBClusterSnapshotAttributesResult" "Amazonka.DocumentDB.Types.DBClusterSnapshotAttributesResult" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DBClusterSnapshotAttributesResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbClusterSnapshotAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBClusterSnapshotAttribute]))))

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 cluster snapshot that the attributes apply to.

$sel:dbClusterSnapshotAttributes:DBClusterSnapshotAttributesResult', dbClusterSnapshotAttributesResult_dbClusterSnapshotAttributes - The list of attributes and values for the cluster snapshot.

dbClusterSnapshotAttributesResult_dbClusterSnapshotIdentifier :: Lens' DBClusterSnapshotAttributesResult (Maybe Text) Source #

The identifier of the cluster snapshot that the attributes apply to.

dbClusterSnapshotAttributesResult_dbClusterSnapshotAttributes :: Lens' DBClusterSnapshotAttributesResult (Maybe [DBClusterSnapshotAttribute]) Source #

The list of attributes and values for the cluster snapshot.

DBEngineVersion

data DBEngineVersion Source #

Detailed information about an engine version.

See: newDBEngineVersion smart constructor.

Constructors

DBEngineVersion'

Fields

engineVersion :: Maybe Text
The version number of the database engine.
dbEngineVersionDescription :: Maybe Text
The description of the database engine version.
engine :: Maybe Text
The name of the database engine.
dbParameterGroupFamily :: Maybe Text
The name of the parameter group family for the database engine.
dbEngineDescription :: Maybe Text
The description of the database engine.
validUpgradeTarget :: Maybe [UpgradeTarget]
A list of engine versions that this database engine version can be upgraded to.
supportsLogExportsToCloudwatchLogs :: Maybe Bool
A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
exportableLogTypes :: Maybe [Text]
The types of logs that the database engine has available for export to Amazon CloudWatch Logs.

Instances

Instances details

Eq DBEngineVersion Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBEngineVersion Methods (==) :: DBEngineVersion -> DBEngineVersion -> Bool # (/=) :: DBEngineVersion -> DBEngineVersion -> Bool #
Read DBEngineVersion Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBEngineVersion Methods readsPrec :: Int -> ReadS DBEngineVersion # readList :: ReadS [DBEngineVersion] # readPrec :: ReadPrec DBEngineVersion # readListPrec :: ReadPrec [DBEngineVersion] #
Show DBEngineVersion Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBEngineVersion Methods showsPrec :: Int -> DBEngineVersion -> ShowS # show :: DBEngineVersion -> String # showList :: [DBEngineVersion] -> ShowS #
Generic DBEngineVersion Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBEngineVersion Associated Types type Rep DBEngineVersion :: Type -> Type # Methods from :: DBEngineVersion -> Rep DBEngineVersion x # to :: Rep DBEngineVersion x -> DBEngineVersion #
NFData DBEngineVersion Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBEngineVersion Methods rnf :: DBEngineVersion -> () #
Hashable DBEngineVersion Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBEngineVersion Methods hashWithSalt :: Int -> DBEngineVersion -> Int # hash :: DBEngineVersion -> Int #
FromXML DBEngineVersion Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBEngineVersion Methods parseXML :: [Node] -> Either String DBEngineVersion #
type Rep DBEngineVersion Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBEngineVersion type Rep DBEngineVersion = D1 ('MetaData "DBEngineVersion" "Amazonka.DocumentDB.Types.DBEngineVersion" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DBEngineVersion'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbEngineVersionDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbParameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "dbEngineDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "validUpgradeTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UpgradeTarget]))) :: (S1 ('MetaSel ('Just "supportsLogExportsToCloudwatchLogs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "exportableLogTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

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:engine:DBEngineVersion', dbEngineVersion_engine - The name of the database engine.

$sel:dbParameterGroupFamily:DBEngineVersion', dbEngineVersion_dbParameterGroupFamily - The name of the parameter group family for the database engine.

$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:exportableLogTypes:DBEngineVersion', dbEngineVersion_exportableLogTypes - The types of logs that the database engine has available for export to Amazon CloudWatch Logs.

dbEngineVersion_engineVersion :: Lens' DBEngineVersion (Maybe Text) Source #

The version number of the database engine.

dbEngineVersion_dbEngineVersionDescription :: Lens' DBEngineVersion (Maybe Text) Source #

The description of the database engine version.

dbEngineVersion_engine :: Lens' DBEngineVersion (Maybe Text) Source #

The name of the database engine.

dbEngineVersion_dbParameterGroupFamily :: Lens' DBEngineVersion (Maybe Text) Source #

The name of the parameter group family for the database engine.

dbEngineVersion_dbEngineDescription :: Lens' DBEngineVersion (Maybe Text) Source #

The description of the database engine.

dbEngineVersion_validUpgradeTarget :: Lens' DBEngineVersion (Maybe [UpgradeTarget]) Source #

A list of engine versions that this database engine version can be upgraded to.

dbEngineVersion_supportsLogExportsToCloudwatchLogs :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

dbEngineVersion_exportableLogTypes :: Lens' DBEngineVersion (Maybe [Text]) Source #

The types of logs that the database engine has available for export to Amazon CloudWatch Logs.

DBInstance

data DBInstance Source #

Detailed information about an instance.

See: newDBInstance smart constructor.

Constructors

DBInstance'

Fields

engineVersion :: Maybe Text
Indicates the database engine version.
storageEncrypted :: Maybe Bool
Specifies whether or not the instance is encrypted.
dbClusterIdentifier :: Maybe Text
Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
publiclyAccessible :: Maybe Bool
Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.
autoMinorVersionUpgrade :: Maybe Bool
Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
dbInstanceArn :: Maybe Text
The Amazon Resource Name (ARN) for the instance.
instanceCreateTime :: Maybe ISO8601
Provides the date and time that the instance was created.
engine :: Maybe Text
Provides the name of the database engine to be used for this instance.
latestRestorableTime :: Maybe ISO8601
Specifies the latest time to which a database can be restored with point-in-time restore.
dbInstanceClass :: Maybe Text
Contains the name of the compute and memory capacity class of the instance.
promotionTier :: Maybe Int
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
preferredMaintenanceWindow :: Maybe Text
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
cACertificateIdentifier :: Maybe Text
The identifier of the CA certificate for this DB instance.
dbInstanceIdentifier :: Maybe Text
Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.
kmsKeyId :: Maybe Text
If StorageEncrypted is true, the KMS key identifier for the encrypted instance.
preferredBackupWindow :: Maybe Text
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
availabilityZone :: Maybe Text
Specifies the name of the Availability Zone that the instance is located in.
vpcSecurityGroups :: Maybe [VpcSecurityGroupMembership]
Provides a list of VPC security group elements that the instance belongs to.
backupRetentionPeriod :: Maybe Int
Specifies the number of days for which automatic snapshots are retained.
dbSubnetGroup :: Maybe DBSubnetGroup
Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
enabledCloudwatchLogsExports :: Maybe [Text]
A list of log types that this instance is configured to export to CloudWatch Logs.
dbiResourceId :: Maybe Text
The Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
endpoint :: Maybe Endpoint
Specifies the connection endpoint.
dbInstanceStatus :: Maybe Text
Specifies the current state of this database.
pendingModifiedValues :: Maybe PendingModifiedValues
Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
statusInfos :: Maybe [DBInstanceStatusInfo]
The status of a read replica. If the instance is not a read replica, this is blank.

Instances

Instances details

Eq DBInstance Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBInstance Methods (==) :: DBInstance -> DBInstance -> Bool # (/=) :: DBInstance -> DBInstance -> Bool #
Read DBInstance Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBInstance Methods readsPrec :: Int -> ReadS DBInstance # readList :: ReadS [DBInstance] # readPrec :: ReadPrec DBInstance # readListPrec :: ReadPrec [DBInstance] #
Show DBInstance Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBInstance Methods showsPrec :: Int -> DBInstance -> ShowS # show :: DBInstance -> String # showList :: [DBInstance] -> ShowS #
Generic DBInstance Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBInstance Associated Types type Rep DBInstance :: Type -> Type # Methods from :: DBInstance -> Rep DBInstance x # to :: Rep DBInstance x -> DBInstance #
NFData DBInstance Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBInstance Methods rnf :: DBInstance -> () #
Hashable DBInstance Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBInstance Methods hashWithSalt :: Int -> DBInstance -> Int # hash :: DBInstance -> Int #
FromXML DBInstance Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBInstance Methods parseXML :: [Node] -> Either String DBInstance #
type Rep DBInstance Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBInstance type Rep DBInstance = D1 ('MetaData "DBInstance" "Amazonka.DocumentDB.Types.DBInstance" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DBInstance'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "publiclyAccessible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "dbInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "instanceCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "latestRestorableTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :: ((S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "promotionTier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "cACertificateIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: (((S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "preferredBackupWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "vpcSecurityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VpcSecurityGroupMembership])) :: S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: ((S1 ('MetaSel ('Just "dbSubnetGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBSubnetGroup)) :: (S1 ('MetaSel ('Just "enabledCloudwatchLogsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "dbiResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Endpoint)) :: S1 ('MetaSel ('Just "dbInstanceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "pendingModifiedValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PendingModifiedValues)) :*: S1 ('MetaSel ('Just "statusInfos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBInstanceStatusInfo]))))))))

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:storageEncrypted:DBInstance', dbInstance_storageEncrypted - Specifies whether or not the instance is encrypted.

$sel:dbClusterIdentifier:DBInstance', dbInstance_dbClusterIdentifier - Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

$sel:publiclyAccessible:DBInstance', dbInstance_publiclyAccessible - Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

$sel:autoMinorVersionUpgrade:DBInstance', dbInstance_autoMinorVersionUpgrade - Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

$sel:dbInstanceArn:DBInstance', dbInstance_dbInstanceArn - The Amazon Resource Name (ARN) for the instance.

$sel:instanceCreateTime:DBInstance', dbInstance_instanceCreateTime - Provides the date and time that the instance was created.

$sel:engine:DBInstance', dbInstance_engine - Provides the name of the database engine to be used for this 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 instance.

$sel:promotionTier:DBInstance', dbInstance_promotionTier - A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

$sel: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-provided database identifier. This identifier is the unique key that identifies an instance.

$sel:kmsKeyId:DBInstance', dbInstance_kmsKeyId - If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

$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 that the instance is located in.

$sel:vpcSecurityGroups:DBInstance', dbInstance_vpcSecurityGroups - Provides a list of VPC security group elements that the instance belongs to.

$sel:backupRetentionPeriod:DBInstance', dbInstance_backupRetentionPeriod - Specifies the number of days for which automatic snapshots are retained.

$sel:dbSubnetGroup:DBInstance', dbInstance_dbSubnetGroup - Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

$sel:enabledCloudwatchLogsExports:DBInstance', dbInstance_enabledCloudwatchLogsExports - A list of log types that this instance is configured to export to CloudWatch Logs.

$sel:dbiResourceId:DBInstance', dbInstance_dbiResourceId - The Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

$sel:endpoint:DBInstance', dbInstance_endpoint - Specifies the connection endpoint.

$sel:dbInstanceStatus:DBInstance', dbInstance_dbInstanceStatus - Specifies the current state of this database.

$sel:pendingModifiedValues:DBInstance', dbInstance_pendingModifiedValues - Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

$sel:statusInfos:DBInstance', dbInstance_statusInfos - The status of a read replica. If the instance is not a read replica, this is blank.

dbInstance_engineVersion :: Lens' DBInstance (Maybe Text) Source #

Indicates the database engine version.

dbInstance_storageEncrypted :: Lens' DBInstance (Maybe Bool) Source #

Specifies whether or not the instance is encrypted.

dbInstance_dbClusterIdentifier :: Lens' DBInstance (Maybe Text) Source #

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

dbInstance_publiclyAccessible :: Lens' DBInstance (Maybe Bool) Source #

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

dbInstance_autoMinorVersionUpgrade :: Lens' DBInstance (Maybe Bool) Source #

Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

dbInstance_dbInstanceArn :: Lens' DBInstance (Maybe Text) Source #

The Amazon Resource Name (ARN) for the instance.

dbInstance_instanceCreateTime :: Lens' DBInstance (Maybe UTCTime) Source #

Provides the date and time that the instance was created.

dbInstance_engine :: Lens' DBInstance (Maybe Text) Source #

Provides the name of the database engine to be used for this instance.

dbInstance_latestRestorableTime :: Lens' DBInstance (Maybe UTCTime) Source #

Specifies the latest time to which a database can be restored with point-in-time restore.

dbInstance_dbInstanceClass :: Lens' DBInstance (Maybe Text) Source #

Contains the name of the compute and memory capacity class of the instance.

dbInstance_promotionTier :: Lens' DBInstance (Maybe Int) Source #

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

dbInstance_preferredMaintenanceWindow :: Lens' DBInstance (Maybe Text) Source #

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

dbInstance_cACertificateIdentifier :: Lens' DBInstance (Maybe Text) Source #

The identifier of the CA certificate for this DB instance.

dbInstance_dbInstanceIdentifier :: Lens' DBInstance (Maybe Text) Source #

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

dbInstance_kmsKeyId :: Lens' DBInstance (Maybe Text) Source #

If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

dbInstance_preferredBackupWindow :: Lens' DBInstance (Maybe Text) Source #

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

dbInstance_availabilityZone :: Lens' DBInstance (Maybe Text) Source #

Specifies the name of the Availability Zone that the instance is located in.

dbInstance_vpcSecurityGroups :: Lens' DBInstance (Maybe [VpcSecurityGroupMembership]) Source #

Provides a list of VPC security group elements that the instance belongs to.

dbInstance_backupRetentionPeriod :: Lens' DBInstance (Maybe Int) Source #

Specifies the number of days for which automatic snapshots are retained.

dbInstance_dbSubnetGroup :: Lens' DBInstance (Maybe DBSubnetGroup) Source #

Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

dbInstance_enabledCloudwatchLogsExports :: Lens' DBInstance (Maybe [Text]) Source #

A list of log types that this instance is configured to export to CloudWatch Logs.

dbInstance_dbiResourceId :: Lens' DBInstance (Maybe Text) Source #

The Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

dbInstance_endpoint :: Lens' DBInstance (Maybe Endpoint) Source #

Specifies the connection endpoint.

dbInstance_dbInstanceStatus :: Lens' DBInstance (Maybe Text) Source #

Specifies the current state of this database.

dbInstance_pendingModifiedValues :: Lens' DBInstance (Maybe PendingModifiedValues) Source #

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

dbInstance_statusInfos :: Lens' DBInstance (Maybe [DBInstanceStatusInfo]) Source #

The status of a read replica. If the instance is not a read replica, this is blank.

DBInstanceStatusInfo

data DBInstanceStatusInfo Source #

Provides a list of status information for an instance.

See: newDBInstanceStatusInfo smart constructor.

Constructors

DBInstanceStatusInfo'

Fields

status :: Maybe Text
Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.
normal :: Maybe Bool
A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
statusType :: Maybe Text
This value is currently "read replication."
message :: Maybe Text
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.

Instances

Instances details

Eq DBInstanceStatusInfo Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBInstanceStatusInfo Methods (==) :: DBInstanceStatusInfo -> DBInstanceStatusInfo -> Bool # (/=) :: DBInstanceStatusInfo -> DBInstanceStatusInfo -> Bool #
Read DBInstanceStatusInfo Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBInstanceStatusInfo Methods readsPrec :: Int -> ReadS DBInstanceStatusInfo # readList :: ReadS [DBInstanceStatusInfo] # readPrec :: ReadPrec DBInstanceStatusInfo # readListPrec :: ReadPrec [DBInstanceStatusInfo] #
Show DBInstanceStatusInfo Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBInstanceStatusInfo Methods showsPrec :: Int -> DBInstanceStatusInfo -> ShowS # show :: DBInstanceStatusInfo -> String # showList :: [DBInstanceStatusInfo] -> ShowS #
Generic DBInstanceStatusInfo Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBInstanceStatusInfo Associated Types type Rep DBInstanceStatusInfo :: Type -> Type # Methods from :: DBInstanceStatusInfo -> Rep DBInstanceStatusInfo x # to :: Rep DBInstanceStatusInfo x -> DBInstanceStatusInfo #
NFData DBInstanceStatusInfo Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBInstanceStatusInfo Methods rnf :: DBInstanceStatusInfo -> () #
Hashable DBInstanceStatusInfo Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBInstanceStatusInfo Methods hashWithSalt :: Int -> DBInstanceStatusInfo -> Int # hash :: DBInstanceStatusInfo -> Int #
FromXML DBInstanceStatusInfo Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBInstanceStatusInfo Methods parseXML :: [Node] -> Either String DBInstanceStatusInfo #
type Rep DBInstanceStatusInfo Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBInstanceStatusInfo type Rep DBInstanceStatusInfo = D1 ('MetaData "DBInstanceStatusInfo" "Amazonka.DocumentDB.Types.DBInstanceStatusInfo" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DBInstanceStatusInfo'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "normal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "statusType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

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 instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

$sel:normal:DBInstanceStatusInfo', dbInstanceStatusInfo_normal - A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

$sel: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.

dbInstanceStatusInfo_status :: Lens' DBInstanceStatusInfo (Maybe Text) Source #

Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

dbInstanceStatusInfo_normal :: Lens' DBInstanceStatusInfo (Maybe Bool) Source #

A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

dbInstanceStatusInfo_statusType :: Lens' DBInstanceStatusInfo (Maybe Text) Source #

This value is currently "read replication."

dbInstanceStatusInfo_message :: Lens' DBInstanceStatusInfo (Maybe Text) Source #

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.

DBSubnetGroup

data DBSubnetGroup Source #

Detailed information about a subnet group.

See: newDBSubnetGroup smart constructor.

Constructors

DBSubnetGroup'

Fields

dbSubnetGroupName :: Maybe Text
The name of the subnet group.
vpcId :: Maybe Text
Provides the virtual private cloud (VPC) ID of the subnet group.
subnets :: Maybe [Subnet]
Detailed information about one or more subnets within a subnet group.
dbSubnetGroupDescription :: Maybe Text
Provides the description of the subnet group.
dbSubnetGroupArn :: Maybe Text
The Amazon Resource Name (ARN) for the DB subnet group.
subnetGroupStatus :: Maybe Text
Provides the status of the subnet group.

Instances

Instances details

Eq DBSubnetGroup Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBSubnetGroup Methods (==) :: DBSubnetGroup -> DBSubnetGroup -> Bool # (/=) :: DBSubnetGroup -> DBSubnetGroup -> Bool #
Read DBSubnetGroup Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBSubnetGroup Methods readsPrec :: Int -> ReadS DBSubnetGroup # readList :: ReadS [DBSubnetGroup] # readPrec :: ReadPrec DBSubnetGroup # readListPrec :: ReadPrec [DBSubnetGroup] #
Show DBSubnetGroup Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBSubnetGroup Methods showsPrec :: Int -> DBSubnetGroup -> ShowS # show :: DBSubnetGroup -> String # showList :: [DBSubnetGroup] -> ShowS #
Generic DBSubnetGroup Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBSubnetGroup Associated Types type Rep DBSubnetGroup :: Type -> Type # Methods from :: DBSubnetGroup -> Rep DBSubnetGroup x # to :: Rep DBSubnetGroup x -> DBSubnetGroup #
NFData DBSubnetGroup Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBSubnetGroup Methods rnf :: DBSubnetGroup -> () #
Hashable DBSubnetGroup Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBSubnetGroup Methods hashWithSalt :: Int -> DBSubnetGroup -> Int # hash :: DBSubnetGroup -> Int #
FromXML DBSubnetGroup Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBSubnetGroup Methods parseXML :: [Node] -> Either String DBSubnetGroup #
type Rep DBSubnetGroup Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBSubnetGroup type Rep DBSubnetGroup = D1 ('MetaData "DBSubnetGroup" "Amazonka.DocumentDB.Types.DBSubnetGroup" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DBSubnetGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "subnets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Subnet])))) :: (S1 ('MetaSel ('Just "dbSubnetGroupDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "dbSubnetGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subnetGroupStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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 subnet group.

$sel:vpcId:DBSubnetGroup', dbSubnetGroup_vpcId - Provides the virtual private cloud (VPC) ID of the subnet group.

$sel:subnets:DBSubnetGroup', dbSubnetGroup_subnets - Detailed information about one or more subnets within a subnet group.

$sel:dbSubnetGroupDescription:DBSubnetGroup', dbSubnetGroup_dbSubnetGroupDescription - Provides the description of the 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 subnet group.

dbSubnetGroup_dbSubnetGroupName :: Lens' DBSubnetGroup (Maybe Text) Source #

The name of the subnet group.

dbSubnetGroup_vpcId :: Lens' DBSubnetGroup (Maybe Text) Source #

Provides the virtual private cloud (VPC) ID of the subnet group.

dbSubnetGroup_subnets :: Lens' DBSubnetGroup (Maybe [Subnet]) Source #

Detailed information about one or more subnets within a subnet group.

dbSubnetGroup_dbSubnetGroupDescription :: Lens' DBSubnetGroup (Maybe Text) Source #

Provides the description of the subnet group.

dbSubnetGroup_dbSubnetGroupArn :: Lens' DBSubnetGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) for the DB subnet group.

dbSubnetGroup_subnetGroupStatus :: Lens' DBSubnetGroup (Maybe Text) Source #

Provides the status of the subnet group.

Endpoint

data Endpoint Source #

Network information for accessing a cluster or instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.

See: newEndpoint smart constructor.

Constructors

Endpoint'
Fields hostedZoneId :: Maybe Text Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. address :: Maybe Text Specifies the DNS address of the instance. port :: Maybe Int Specifies the port that the database engine is listening on.

Instances

Instances details

Eq Endpoint Source #
Instance details Defined in Amazonka.DocumentDB.Types.Endpoint Methods (==) :: Endpoint -> Endpoint -> Bool # (/=) :: Endpoint -> Endpoint -> Bool #
Read Endpoint Source #
Instance details Defined in Amazonka.DocumentDB.Types.Endpoint Methods readsPrec :: Int -> ReadS Endpoint # readList :: ReadS [Endpoint] # readPrec :: ReadPrec Endpoint # readListPrec :: ReadPrec [Endpoint] #
Show Endpoint Source #
Instance details Defined in Amazonka.DocumentDB.Types.Endpoint Methods showsPrec :: Int -> Endpoint -> ShowS # show :: Endpoint -> String # showList :: [Endpoint] -> ShowS #
Generic Endpoint Source #
Instance details Defined in Amazonka.DocumentDB.Types.Endpoint Associated Types type Rep Endpoint :: Type -> Type # Methods from :: Endpoint -> Rep Endpoint x # to :: Rep Endpoint x -> Endpoint #
NFData Endpoint Source #
Instance details Defined in Amazonka.DocumentDB.Types.Endpoint Methods rnf :: Endpoint -> () #
Hashable Endpoint Source #
Instance details Defined in Amazonka.DocumentDB.Types.Endpoint Methods hashWithSalt :: Int -> Endpoint -> Int # hash :: Endpoint -> Int #
FromXML Endpoint Source #
Instance details Defined in Amazonka.DocumentDB.Types.Endpoint Methods parseXML :: [Node] -> Either String Endpoint #
type Rep Endpoint Source #
Instance details Defined in Amazonka.DocumentDB.Types.Endpoint type Rep Endpoint = D1 ('MetaData "Endpoint" "Amazonka.DocumentDB.Types.Endpoint" "libZSservicesZSamazonka-docdbZSamazonka-docdb" '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 instance.

$sel:port:Endpoint', endpoint_port - Specifies the port that the database engine is listening on.

endpoint_hostedZoneId :: Lens' Endpoint (Maybe Text) Source #

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

endpoint_address :: Lens' Endpoint (Maybe Text) Source #

Specifies the DNS address of the instance.

endpoint_port :: Lens' Endpoint (Maybe Int) Source #

Specifies the port that the database engine is listening on.

EngineDefaults

data EngineDefaults Source #

Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.

See: newEngineDefaults smart constructor.

Constructors

EngineDefaults'

Fields

dbParameterGroupFamily :: Maybe Text
The name of the cluster parameter group family to return the engine parameter information for.
marker :: Maybe Text
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.
parameters :: Maybe [Parameter]
The parameters of a particular cluster parameter group family.

Instances

Instances details

Eq EngineDefaults Source #
Instance details Defined in Amazonka.DocumentDB.Types.EngineDefaults Methods (==) :: EngineDefaults -> EngineDefaults -> Bool # (/=) :: EngineDefaults -> EngineDefaults -> Bool #
Read EngineDefaults Source #
Instance details Defined in Amazonka.DocumentDB.Types.EngineDefaults Methods readsPrec :: Int -> ReadS EngineDefaults # readList :: ReadS [EngineDefaults] # readPrec :: ReadPrec EngineDefaults # readListPrec :: ReadPrec [EngineDefaults] #
Show EngineDefaults Source #
Instance details Defined in Amazonka.DocumentDB.Types.EngineDefaults Methods showsPrec :: Int -> EngineDefaults -> ShowS # show :: EngineDefaults -> String # showList :: [EngineDefaults] -> ShowS #
Generic EngineDefaults Source #
Instance details Defined in Amazonka.DocumentDB.Types.EngineDefaults Associated Types type Rep EngineDefaults :: Type -> Type # Methods from :: EngineDefaults -> Rep EngineDefaults x # to :: Rep EngineDefaults x -> EngineDefaults #
NFData EngineDefaults Source #
Instance details Defined in Amazonka.DocumentDB.Types.EngineDefaults Methods rnf :: EngineDefaults -> () #
Hashable EngineDefaults Source #
Instance details Defined in Amazonka.DocumentDB.Types.EngineDefaults Methods hashWithSalt :: Int -> EngineDefaults -> Int # hash :: EngineDefaults -> Int #
FromXML EngineDefaults Source #
Instance details Defined in Amazonka.DocumentDB.Types.EngineDefaults Methods parseXML :: [Node] -> Either String EngineDefaults #
type Rep EngineDefaults Source #
Instance details Defined in Amazonka.DocumentDB.Types.EngineDefaults type Rep EngineDefaults = D1 ('MetaData "EngineDefaults" "Amazonka.DocumentDB.Types.EngineDefaults" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "EngineDefaults'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbParameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parameter])))))

newEngineDefaults :: EngineDefaults Source #

Create a value of EngineDefaults with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dbParameterGroupFamily:EngineDefaults', engineDefaults_dbParameterGroupFamily - The name of the cluster parameter group family to return the engine parameter information for.

$sel:marker:EngineDefaults', engineDefaults_marker - An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:parameters:EngineDefaults', engineDefaults_parameters - The parameters of a particular cluster parameter group family.

engineDefaults_dbParameterGroupFamily :: Lens' EngineDefaults (Maybe Text) Source #

The name of the cluster parameter group family to return the engine parameter information for.

engineDefaults_marker :: Lens' EngineDefaults (Maybe Text) Source #

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.

engineDefaults_parameters :: Lens' EngineDefaults (Maybe [Parameter]) Source #

The parameters of a particular cluster parameter group family.

Event

data Event Source #

Detailed information about an event.

See: newEvent smart constructor.

Constructors

Event'

Fields

sourceType :: Maybe SourceType
Specifies the source type for this event.
sourceArn :: Maybe Text
The Amazon Resource Name (ARN) for the event.
sourceIdentifier :: Maybe Text
Provides the identifier for the source of the event.
date :: Maybe ISO8601
Specifies the date and time of the event.
eventCategories :: Maybe [Text]
Specifies the category for the event.
message :: Maybe Text
Provides the text of this event.

Instances

Instances details

Eq Event Source #
Instance details Defined in Amazonka.DocumentDB.Types.Event Methods (==) :: Event -> Event -> Bool # (/=) :: Event -> Event -> Bool #
Read Event Source #
Instance details Defined in Amazonka.DocumentDB.Types.Event Methods readsPrec :: Int -> ReadS Event # readList :: ReadS [Event] # readPrec :: ReadPrec Event # readListPrec :: ReadPrec [Event] #
Show Event Source #
Instance details Defined in Amazonka.DocumentDB.Types.Event Methods showsPrec :: Int -> Event -> ShowS # show :: Event -> String # showList :: [Event] -> ShowS #
Generic Event Source #
Instance details Defined in Amazonka.DocumentDB.Types.Event Associated Types type Rep Event :: Type -> Type # Methods from :: Event -> Rep Event x # to :: Rep Event x -> Event #
NFData Event Source #
Instance details Defined in Amazonka.DocumentDB.Types.Event Methods rnf :: Event -> () #
Hashable Event Source #
Instance details Defined in Amazonka.DocumentDB.Types.Event Methods hashWithSalt :: Int -> Event -> Int # hash :: Event -> Int #
FromXML Event Source #
Instance details Defined in Amazonka.DocumentDB.Types.Event Methods parseXML :: [Node] -> Either String Event #
type Rep Event Source #
Instance details Defined in Amazonka.DocumentDB.Types.Event type Rep Event = D1 ('MetaData "Event" "Amazonka.DocumentDB.Types.Event" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "Event'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceType)) :: (S1 ('MetaSel ('Just "sourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "date") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "eventCategories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newEvent :: Event Source #

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.

event_sourceType :: Lens' Event (Maybe SourceType) Source #

Specifies the source type for this event.

event_sourceArn :: Lens' Event (Maybe Text) Source #

The Amazon Resource Name (ARN) for the event.

event_sourceIdentifier :: Lens' Event (Maybe Text) Source #

Provides the identifier for the source of the event.

event_date :: Lens' Event (Maybe UTCTime) Source #

Specifies the date and time of the event.

event_eventCategories :: Lens' Event (Maybe [Text]) Source #

Specifies the category for the event.

event_message :: Lens' Event (Maybe Text) Source #

Provides the text of this event.

EventCategoriesMap

data EventCategoriesMap Source #

An event source type, accompanied by one or more event category names.

See: newEventCategoriesMap smart constructor.

Constructors

EventCategoriesMap'
Fields sourceType :: Maybe Text The source type that the returned categories belong to. eventCategories :: Maybe [Text] The event categories for the specified source type.

Instances

Instances details

Eq EventCategoriesMap Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventCategoriesMap Methods (==) :: EventCategoriesMap -> EventCategoriesMap -> Bool # (/=) :: EventCategoriesMap -> EventCategoriesMap -> Bool #
Read EventCategoriesMap Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventCategoriesMap Methods readsPrec :: Int -> ReadS EventCategoriesMap # readList :: ReadS [EventCategoriesMap] # readPrec :: ReadPrec EventCategoriesMap # readListPrec :: ReadPrec [EventCategoriesMap] #
Show EventCategoriesMap Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventCategoriesMap Methods showsPrec :: Int -> EventCategoriesMap -> ShowS # show :: EventCategoriesMap -> String # showList :: [EventCategoriesMap] -> ShowS #
Generic EventCategoriesMap Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventCategoriesMap Associated Types type Rep EventCategoriesMap :: Type -> Type # Methods from :: EventCategoriesMap -> Rep EventCategoriesMap x # to :: Rep EventCategoriesMap x -> EventCategoriesMap #
NFData EventCategoriesMap Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventCategoriesMap Methods rnf :: EventCategoriesMap -> () #
Hashable EventCategoriesMap Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventCategoriesMap Methods hashWithSalt :: Int -> EventCategoriesMap -> Int # hash :: EventCategoriesMap -> Int #
FromXML EventCategoriesMap Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventCategoriesMap Methods parseXML :: [Node] -> Either String EventCategoriesMap #
type Rep EventCategoriesMap Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventCategoriesMap type Rep EventCategoriesMap = D1 ('MetaData "EventCategoriesMap" "Amazonka.DocumentDB.Types.EventCategoriesMap" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "EventCategoriesMap'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "eventCategories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))

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.

eventCategoriesMap_sourceType :: Lens' EventCategoriesMap (Maybe Text) Source #

The source type that the returned categories belong to.

eventCategoriesMap_eventCategories :: Lens' EventCategoriesMap (Maybe [Text]) Source #

The event categories for the specified source type.

EventSubscription

data EventSubscription Source #

Detailed information about an event to which you have subscribed.

See: newEventSubscription smart constructor.

Constructors

EventSubscription'

Fields

status :: Maybe Text
The status of the Amazon DocumentDB event notification subscription.
Constraints:
Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist
The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.
customerAwsId :: Maybe Text
The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.
custSubscriptionId :: Maybe Text
The Amazon DocumentDB event notification subscription ID.
snsTopicArn :: Maybe Text
The topic ARN of the Amazon DocumentDB event notification subscription.
eventSubscriptionArn :: Maybe Text
The Amazon Resource Name (ARN) for the event subscription.
enabled :: Maybe Bool
A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.
sourceType :: Maybe Text
The source type for the Amazon DocumentDB event notification subscription.
subscriptionCreationTime :: Maybe Text
The time at which the Amazon DocumentDB event notification subscription was created.
eventCategoriesList :: Maybe [Text]
A list of event categories for the Amazon DocumentDB event notification subscription.
sourceIdsList :: Maybe [Text]
A list of source IDs for the Amazon DocumentDB event notification subscription.

Instances

Instances details

Eq EventSubscription Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventSubscription Methods (==) :: EventSubscription -> EventSubscription -> Bool # (/=) :: EventSubscription -> EventSubscription -> Bool #
Read EventSubscription Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventSubscription Methods readsPrec :: Int -> ReadS EventSubscription # readList :: ReadS [EventSubscription] # readPrec :: ReadPrec EventSubscription # readListPrec :: ReadPrec [EventSubscription] #
Show EventSubscription Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventSubscription Methods showsPrec :: Int -> EventSubscription -> ShowS # show :: EventSubscription -> String # showList :: [EventSubscription] -> ShowS #
Generic EventSubscription Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventSubscription Associated Types type Rep EventSubscription :: Type -> Type # Methods from :: EventSubscription -> Rep EventSubscription x # to :: Rep EventSubscription x -> EventSubscription #
NFData EventSubscription Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventSubscription Methods rnf :: EventSubscription -> () #
Hashable EventSubscription Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventSubscription Methods hashWithSalt :: Int -> EventSubscription -> Int # hash :: EventSubscription -> Int #
FromXML EventSubscription Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventSubscription Methods parseXML :: [Node] -> Either String EventSubscription #
type Rep EventSubscription Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventSubscription type Rep EventSubscription = D1 ('MetaData "EventSubscription" "Amazonka.DocumentDB.Types.EventSubscription" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "EventSubscription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "customerAwsId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "custSubscriptionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "snsTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "eventSubscriptionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "subscriptionCreationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "eventCategoriesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "sourceIdsList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))))

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 Amazon DocumentDB event notification subscription.

Constraints:

Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist

The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.

$sel:customerAwsId:EventSubscription', eventSubscription_customerAwsId - The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.

$sel:custSubscriptionId:EventSubscription', eventSubscription_custSubscriptionId - The Amazon DocumentDB event notification subscription ID.

$sel:snsTopicArn:EventSubscription', eventSubscription_snsTopicArn - The topic ARN of the Amazon DocumentDB 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 whether the subscription is enabled. A value of true indicates that the subscription is enabled.

$sel:sourceType:EventSubscription', eventSubscription_sourceType - The source type for the Amazon DocumentDB event notification subscription.

$sel:subscriptionCreationTime:EventSubscription', eventSubscription_subscriptionCreationTime - The time at which the Amazon DocumentDB event notification subscription was created.

$sel:eventCategoriesList:EventSubscription', eventSubscription_eventCategoriesList - A list of event categories for the Amazon DocumentDB event notification subscription.

$sel:sourceIdsList:EventSubscription', eventSubscription_sourceIdsList - A list of source IDs for the Amazon DocumentDB event notification subscription.

eventSubscription_status :: Lens' EventSubscription (Maybe Text) Source #

The status of the Amazon DocumentDB event notification subscription.

Constraints:

Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist

The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.

eventSubscription_customerAwsId :: Lens' EventSubscription (Maybe Text) Source #

The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.

eventSubscription_custSubscriptionId :: Lens' EventSubscription (Maybe Text) Source #

The Amazon DocumentDB event notification subscription ID.

eventSubscription_snsTopicArn :: Lens' EventSubscription (Maybe Text) Source #

The topic ARN of the Amazon DocumentDB event notification subscription.

eventSubscription_eventSubscriptionArn :: Lens' EventSubscription (Maybe Text) Source #

The Amazon Resource Name (ARN) for the event subscription.

eventSubscription_enabled :: Lens' EventSubscription (Maybe Bool) Source #

A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.

eventSubscription_sourceType :: Lens' EventSubscription (Maybe Text) Source #

The source type for the Amazon DocumentDB event notification subscription.

eventSubscription_subscriptionCreationTime :: Lens' EventSubscription (Maybe Text) Source #

The time at which the Amazon DocumentDB event notification subscription was created.

eventSubscription_eventCategoriesList :: Lens' EventSubscription (Maybe [Text]) Source #

A list of event categories for the Amazon DocumentDB event notification subscription.

eventSubscription_sourceIdsList :: Lens' EventSubscription (Maybe [Text]) Source #

A list of source IDs for the Amazon DocumentDB event notification subscription.

Filter

data Filter Source #

A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

Wildcards are not supported in filters.

See: newFilter smart constructor.

Constructors

Filter'
Fields name :: Text The name of the filter. Filter names are case sensitive. values :: [Text] One or more filter values. Filter values are case sensitive.

Instances

Instances details

Eq Filter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Filter Methods (==) :: Filter -> Filter -> Bool # (/=) :: Filter -> Filter -> Bool #
Read Filter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Filter Methods readsPrec :: Int -> ReadS Filter # readList :: ReadS [Filter] # readPrec :: ReadPrec Filter # readListPrec :: ReadPrec [Filter] #
Show Filter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Filter Methods showsPrec :: Int -> Filter -> ShowS # show :: Filter -> String # showList :: [Filter] -> ShowS #
Generic Filter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Filter Associated Types type Rep Filter :: Type -> Type # Methods from :: Filter -> Rep Filter x # to :: Rep Filter x -> Filter #
NFData Filter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Filter Methods rnf :: Filter -> () #
Hashable Filter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Filter Methods hashWithSalt :: Int -> Filter -> Int # hash :: Filter -> Int #
ToQuery Filter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Filter Methods toQuery :: Filter -> QueryString #
type Rep Filter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.DocumentDB.Types.Filter" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newFilter Source #

Arguments

:: Text	`$sel:name:Filter'`
-> Filter

Create a value of Filter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:Filter', filter_name - The name of the filter. Filter names are case sensitive.

$sel:values:Filter', filter_values - One or more filter values. Filter values are case sensitive.

filter_name :: Lens' Filter Text Source #

The name of the filter. Filter names are case sensitive.

filter_values :: Lens' Filter [Text] Source #

One or more filter values. Filter values are case sensitive.

GlobalCluster

data GlobalCluster Source #

A data type representing an Amazon DocumentDB global cluster.

See: newGlobalCluster smart constructor.

Constructors

GlobalCluster'

Fields

engineVersion :: Maybe Text
Indicates the database engine version.
status :: Maybe Text
Specifies the current state of this global cluster.
deletionProtection :: Maybe Bool
The deletion protection setting for the new global cluster.
storageEncrypted :: Maybe Bool
The storage encryption setting for the global cluster.
globalClusterIdentifier :: Maybe Text
Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.
engine :: Maybe Text
The Amazon DocumentDB database engine used by the global cluster.
globalClusterArn :: Maybe Text
The Amazon Resource Name (ARN) for the global cluster.
databaseName :: Maybe Text
The default database name within the new global cluster.
globalClusterMembers :: Maybe [GlobalClusterMember]
The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
globalClusterResourceId :: Maybe Text
The Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.

Instances

Instances details

Eq GlobalCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalCluster Methods (==) :: GlobalCluster -> GlobalCluster -> Bool # (/=) :: GlobalCluster -> GlobalCluster -> Bool #
Read GlobalCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalCluster Methods readsPrec :: Int -> ReadS GlobalCluster # readList :: ReadS [GlobalCluster] # readPrec :: ReadPrec GlobalCluster # readListPrec :: ReadPrec [GlobalCluster] #
Show GlobalCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalCluster Methods showsPrec :: Int -> GlobalCluster -> ShowS # show :: GlobalCluster -> String # showList :: [GlobalCluster] -> ShowS #
Generic GlobalCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalCluster Associated Types type Rep GlobalCluster :: Type -> Type # Methods from :: GlobalCluster -> Rep GlobalCluster x # to :: Rep GlobalCluster x -> GlobalCluster #
NFData GlobalCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalCluster Methods rnf :: GlobalCluster -> () #
Hashable GlobalCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalCluster Methods hashWithSalt :: Int -> GlobalCluster -> Int # hash :: GlobalCluster -> Int #
FromXML GlobalCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalCluster Methods parseXML :: [Node] -> Either String GlobalCluster #
type Rep GlobalCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalCluster type Rep GlobalCluster = D1 ('MetaData "GlobalCluster" "Amazonka.DocumentDB.Types.GlobalCluster" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "GlobalCluster'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "globalClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "globalClusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "globalClusterMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GlobalClusterMember])) :*: S1 ('MetaSel ('Just "globalClusterResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newGlobalCluster :: GlobalCluster Source #

Create a value of GlobalCluster with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:engineVersion:GlobalCluster', globalCluster_engineVersion - Indicates the database engine version.

$sel:status:GlobalCluster', globalCluster_status - Specifies the current state of this global cluster.

$sel:deletionProtection:GlobalCluster', globalCluster_deletionProtection - The deletion protection setting for the new global cluster.

$sel:storageEncrypted:GlobalCluster', globalCluster_storageEncrypted - The storage encryption setting for the global cluster.

$sel:globalClusterIdentifier:GlobalCluster', globalCluster_globalClusterIdentifier - Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

$sel:engine:GlobalCluster', globalCluster_engine - The Amazon DocumentDB database engine used by the global cluster.

$sel:globalClusterArn:GlobalCluster', globalCluster_globalClusterArn - The Amazon Resource Name (ARN) for the global cluster.

$sel:databaseName:GlobalCluster', globalCluster_databaseName - The default database name within the new global cluster.

$sel:globalClusterMembers:GlobalCluster', globalCluster_globalClusterMembers - The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

$sel:globalClusterResourceId:GlobalCluster', globalCluster_globalClusterResourceId - The Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.

globalCluster_engineVersion :: Lens' GlobalCluster (Maybe Text) Source #

Indicates the database engine version.

globalCluster_status :: Lens' GlobalCluster (Maybe Text) Source #

Specifies the current state of this global cluster.

globalCluster_deletionProtection :: Lens' GlobalCluster (Maybe Bool) Source #

The deletion protection setting for the new global cluster.

globalCluster_storageEncrypted :: Lens' GlobalCluster (Maybe Bool) Source #

The storage encryption setting for the global cluster.

globalCluster_globalClusterIdentifier :: Lens' GlobalCluster (Maybe Text) Source #

Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

globalCluster_engine :: Lens' GlobalCluster (Maybe Text) Source #

The Amazon DocumentDB database engine used by the global cluster.

globalCluster_globalClusterArn :: Lens' GlobalCluster (Maybe Text) Source #

The Amazon Resource Name (ARN) for the global cluster.

globalCluster_databaseName :: Lens' GlobalCluster (Maybe Text) Source #

The default database name within the new global cluster.

globalCluster_globalClusterMembers :: Lens' GlobalCluster (Maybe [GlobalClusterMember]) Source #

The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

globalCluster_globalClusterResourceId :: Lens' GlobalCluster (Maybe Text) Source #

The Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.

GlobalClusterMember

data GlobalClusterMember Source #

A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.

See: newGlobalClusterMember smart constructor.

Constructors

GlobalClusterMember'

Fields

readers :: Maybe [Text]
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.
dbClusterArn :: Maybe Text
The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.
isWriter :: Maybe Bool
Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.

Instances

Instances details

Eq GlobalClusterMember Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalClusterMember Methods (==) :: GlobalClusterMember -> GlobalClusterMember -> Bool # (/=) :: GlobalClusterMember -> GlobalClusterMember -> Bool #
Read GlobalClusterMember Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalClusterMember Methods readsPrec :: Int -> ReadS GlobalClusterMember # readList :: ReadS [GlobalClusterMember] # readPrec :: ReadPrec GlobalClusterMember # readListPrec :: ReadPrec [GlobalClusterMember] #
Show GlobalClusterMember Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalClusterMember Methods showsPrec :: Int -> GlobalClusterMember -> ShowS # show :: GlobalClusterMember -> String # showList :: [GlobalClusterMember] -> ShowS #
Generic GlobalClusterMember Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalClusterMember Associated Types type Rep GlobalClusterMember :: Type -> Type # Methods from :: GlobalClusterMember -> Rep GlobalClusterMember x # to :: Rep GlobalClusterMember x -> GlobalClusterMember #
NFData GlobalClusterMember Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalClusterMember Methods rnf :: GlobalClusterMember -> () #
Hashable GlobalClusterMember Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalClusterMember Methods hashWithSalt :: Int -> GlobalClusterMember -> Int # hash :: GlobalClusterMember -> Int #
FromXML GlobalClusterMember Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalClusterMember Methods parseXML :: [Node] -> Either String GlobalClusterMember #
type Rep GlobalClusterMember Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalClusterMember type Rep GlobalClusterMember = D1 ('MetaData "GlobalClusterMember" "Amazonka.DocumentDB.Types.GlobalClusterMember" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "GlobalClusterMember'" 'PrefixI 'True) (S1 ('MetaSel ('Just "readers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "dbClusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "isWriter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newGlobalClusterMember :: GlobalClusterMember Source #

Create a value of GlobalClusterMember with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:readers:GlobalClusterMember', globalClusterMember_readers - The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.

$sel:dbClusterArn:GlobalClusterMember', globalClusterMember_dbClusterArn - The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.

$sel:isWriter:GlobalClusterMember', globalClusterMember_isWriter - Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.

globalClusterMember_readers :: Lens' GlobalClusterMember (Maybe [Text]) Source #

The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.

globalClusterMember_dbClusterArn :: Lens' GlobalClusterMember (Maybe Text) Source #

The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.

globalClusterMember_isWriter :: Lens' GlobalClusterMember (Maybe Bool) Source #

Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.

OrderableDBInstanceOption

data OrderableDBInstanceOption Source #

The options that are available for an instance.

See: newOrderableDBInstanceOption smart constructor.

Constructors

OrderableDBInstanceOption'

Fields

engineVersion :: Maybe Text
The engine version of an instance.
engine :: Maybe Text
The engine type of an instance.
dbInstanceClass :: Maybe Text
The instance class for an instance.
licenseModel :: Maybe Text
The license model for an instance.
availabilityZones :: Maybe [AvailabilityZone]
A list of Availability Zones for an instance.
vpc :: Maybe Bool
Indicates whether an instance is in a virtual private cloud (VPC).

Instances

Instances details

Eq OrderableDBInstanceOption Source #
Instance details Defined in Amazonka.DocumentDB.Types.OrderableDBInstanceOption Methods (==) :: OrderableDBInstanceOption -> OrderableDBInstanceOption -> Bool # (/=) :: OrderableDBInstanceOption -> OrderableDBInstanceOption -> Bool #
Read OrderableDBInstanceOption Source #
Instance details Defined in Amazonka.DocumentDB.Types.OrderableDBInstanceOption Methods readsPrec :: Int -> ReadS OrderableDBInstanceOption # readList :: ReadS [OrderableDBInstanceOption] # readPrec :: ReadPrec OrderableDBInstanceOption # readListPrec :: ReadPrec [OrderableDBInstanceOption] #
Show OrderableDBInstanceOption Source #
Instance details Defined in Amazonka.DocumentDB.Types.OrderableDBInstanceOption Methods showsPrec :: Int -> OrderableDBInstanceOption -> ShowS # show :: OrderableDBInstanceOption -> String # showList :: [OrderableDBInstanceOption] -> ShowS #
Generic OrderableDBInstanceOption Source #
Instance details Defined in Amazonka.DocumentDB.Types.OrderableDBInstanceOption Associated Types type Rep OrderableDBInstanceOption :: Type -> Type # Methods from :: OrderableDBInstanceOption -> Rep OrderableDBInstanceOption x # to :: Rep OrderableDBInstanceOption x -> OrderableDBInstanceOption #
NFData OrderableDBInstanceOption Source #
Instance details Defined in Amazonka.DocumentDB.Types.OrderableDBInstanceOption Methods rnf :: OrderableDBInstanceOption -> () #
Hashable OrderableDBInstanceOption Source #
Instance details Defined in Amazonka.DocumentDB.Types.OrderableDBInstanceOption Methods hashWithSalt :: Int -> OrderableDBInstanceOption -> Int # hash :: OrderableDBInstanceOption -> Int #
FromXML OrderableDBInstanceOption Source #
Instance details Defined in Amazonka.DocumentDB.Types.OrderableDBInstanceOption Methods parseXML :: [Node] -> Either String OrderableDBInstanceOption #
type Rep OrderableDBInstanceOption Source #
Instance details Defined in Amazonka.DocumentDB.Types.OrderableDBInstanceOption type Rep OrderableDBInstanceOption = D1 ('MetaData "OrderableDBInstanceOption" "Amazonka.DocumentDB.Types.OrderableDBInstanceOption" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "OrderableDBInstanceOption'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "licenseModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "availabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AvailabilityZone])) :*: S1 ('MetaSel ('Just "vpc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))

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 an instance.

$sel:engine:OrderableDBInstanceOption', orderableDBInstanceOption_engine - The engine type of an instance.

$sel:dbInstanceClass:OrderableDBInstanceOption', orderableDBInstanceOption_dbInstanceClass - The instance class for an instance.

$sel:licenseModel:OrderableDBInstanceOption', orderableDBInstanceOption_licenseModel - The license model for an instance.

$sel:availabilityZones:OrderableDBInstanceOption', orderableDBInstanceOption_availabilityZones - A list of Availability Zones for an instance.

$sel:vpc:OrderableDBInstanceOption', orderableDBInstanceOption_vpc - Indicates whether an instance is in a virtual private cloud (VPC).

orderableDBInstanceOption_engineVersion :: Lens' OrderableDBInstanceOption (Maybe Text) Source #

The engine version of an instance.

orderableDBInstanceOption_engine :: Lens' OrderableDBInstanceOption (Maybe Text) Source #

The engine type of an instance.

orderableDBInstanceOption_dbInstanceClass :: Lens' OrderableDBInstanceOption (Maybe Text) Source #

The instance class for an instance.

orderableDBInstanceOption_licenseModel :: Lens' OrderableDBInstanceOption (Maybe Text) Source #

The license model for an instance.

orderableDBInstanceOption_availabilityZones :: Lens' OrderableDBInstanceOption (Maybe [AvailabilityZone]) Source #

A list of Availability Zones for an instance.

orderableDBInstanceOption_vpc :: Lens' OrderableDBInstanceOption (Maybe Bool) Source #

Indicates whether an instance is in a virtual private cloud (VPC).

Parameter

data Parameter Source #

Detailed information about an individual parameter.

See: newParameter smart constructor.

Constructors

Parameter'

Fields

applyType :: Maybe Text
Specifies the engine-specific parameters type.
parameterValue :: Maybe Text
Specifies the value of the parameter.
applyMethod :: Maybe ApplyMethod
Indicates when to apply parameter updates.
minimumEngineVersion :: Maybe Text
The earliest engine version to which the parameter can apply.
source :: Maybe Text
Indicates the source of the parameter value.
isModifiable :: Maybe Bool
Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
dataType :: Maybe Text
Specifies the valid data type for the parameter.
allowedValues :: Maybe Text
Specifies the valid range of values for the parameter.
parameterName :: Maybe Text
Specifies the name of the parameter.
description :: Maybe Text
Provides a description of the parameter.

Instances

Instances details

Eq Parameter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Parameter Methods (==) :: Parameter -> Parameter -> Bool # (/=) :: Parameter -> Parameter -> Bool #
Read Parameter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Parameter Methods readsPrec :: Int -> ReadS Parameter # readList :: ReadS [Parameter] # readPrec :: ReadPrec Parameter # readListPrec :: ReadPrec [Parameter] #
Show Parameter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Parameter Methods showsPrec :: Int -> Parameter -> ShowS # show :: Parameter -> String # showList :: [Parameter] -> ShowS #
Generic Parameter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Parameter Associated Types type Rep Parameter :: Type -> Type # Methods from :: Parameter -> Rep Parameter x # to :: Rep Parameter x -> Parameter #
NFData Parameter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Parameter Methods rnf :: Parameter -> () #
Hashable Parameter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Parameter Methods hashWithSalt :: Int -> Parameter -> Int # hash :: Parameter -> Int #
ToQuery Parameter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Parameter Methods toQuery :: Parameter -> QueryString #
FromXML Parameter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Parameter Methods parseXML :: [Node] -> Either String Parameter #
type Rep Parameter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Parameter type Rep Parameter = D1 ('MetaData "Parameter" "Amazonka.DocumentDB.Types.Parameter" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "Parameter'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "applyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parameterValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "applyMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApplyMethod)) :: (S1 ('MetaSel ('Just "minimumEngineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "isModifiable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "dataType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "allowedValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "parameterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

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.

parameter_applyType :: Lens' Parameter (Maybe Text) Source #

Specifies the engine-specific parameters type.

parameter_parameterValue :: Lens' Parameter (Maybe Text) Source #

Specifies the value of the parameter.

parameter_applyMethod :: Lens' Parameter (Maybe ApplyMethod) Source #

Indicates when to apply parameter updates.

parameter_minimumEngineVersion :: Lens' Parameter (Maybe Text) Source #

The earliest engine version to which the parameter can apply.

parameter_source :: Lens' Parameter (Maybe Text) Source #

Indicates the source of the parameter value.

parameter_isModifiable :: Lens' Parameter (Maybe Bool) Source #

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

parameter_dataType :: Lens' Parameter (Maybe Text) Source #

Specifies the valid data type for the parameter.

parameter_allowedValues :: Lens' Parameter (Maybe Text) Source #

Specifies the valid range of values for the parameter.

parameter_parameterName :: Lens' Parameter (Maybe Text) Source #

Specifies the name of the parameter.

parameter_description :: Lens' Parameter (Maybe Text) Source #

Provides a description of the parameter.

PendingCloudwatchLogsExports

data PendingCloudwatchLogsExports Source #

A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

See: newPendingCloudwatchLogsExports smart constructor.

Constructors

PendingCloudwatchLogsExports'
Fields logTypesToEnable :: Maybe [Text] Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs. logTypesToDisable :: Maybe [Text] Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.

Instances

Instances details

Eq PendingCloudwatchLogsExports Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingCloudwatchLogsExports Methods (==) :: PendingCloudwatchLogsExports -> PendingCloudwatchLogsExports -> Bool # (/=) :: PendingCloudwatchLogsExports -> PendingCloudwatchLogsExports -> Bool #
Read PendingCloudwatchLogsExports Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingCloudwatchLogsExports Methods readsPrec :: Int -> ReadS PendingCloudwatchLogsExports # readList :: ReadS [PendingCloudwatchLogsExports] # readPrec :: ReadPrec PendingCloudwatchLogsExports # readListPrec :: ReadPrec [PendingCloudwatchLogsExports] #
Show PendingCloudwatchLogsExports Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingCloudwatchLogsExports Methods showsPrec :: Int -> PendingCloudwatchLogsExports -> ShowS # show :: PendingCloudwatchLogsExports -> String # showList :: [PendingCloudwatchLogsExports] -> ShowS #
Generic PendingCloudwatchLogsExports Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingCloudwatchLogsExports Associated Types type Rep PendingCloudwatchLogsExports :: Type -> Type # Methods from :: PendingCloudwatchLogsExports -> Rep PendingCloudwatchLogsExports x # to :: Rep PendingCloudwatchLogsExports x -> PendingCloudwatchLogsExports #
NFData PendingCloudwatchLogsExports Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingCloudwatchLogsExports Methods rnf :: PendingCloudwatchLogsExports -> () #
Hashable PendingCloudwatchLogsExports Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingCloudwatchLogsExports Methods hashWithSalt :: Int -> PendingCloudwatchLogsExports -> Int # hash :: PendingCloudwatchLogsExports -> Int #
FromXML PendingCloudwatchLogsExports Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingCloudwatchLogsExports Methods parseXML :: [Node] -> Either String PendingCloudwatchLogsExports #
type Rep PendingCloudwatchLogsExports Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingCloudwatchLogsExports type Rep PendingCloudwatchLogsExports = D1 ('MetaData "PendingCloudwatchLogsExports" "Amazonka.DocumentDB.Types.PendingCloudwatchLogsExports" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "PendingCloudwatchLogsExports'" 'PrefixI 'True) (S1 ('MetaSel ('Just "logTypesToEnable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "logTypesToDisable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))

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 Amazon CloudWatch Logs.

pendingCloudwatchLogsExports_logTypesToEnable :: Lens' PendingCloudwatchLogsExports (Maybe [Text]) Source #

Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

pendingCloudwatchLogsExports_logTypesToDisable :: Lens' PendingCloudwatchLogsExports (Maybe [Text]) Source #

Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.

PendingMaintenanceAction

data PendingMaintenanceAction Source #

Provides information about a pending maintenance action for a resource.

See: newPendingMaintenanceAction smart constructor.

Constructors

PendingMaintenanceAction'

Fields

autoAppliedAfterDate :: Maybe ISO8601
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.
action :: Maybe Text
The type of pending maintenance action that is available for the resource.
optInStatus :: Maybe Text
Indicates the type of opt-in request that has been received for the resource.
description :: Maybe Text
A description providing more detail about the maintenance action.
forcedApplyDate :: Maybe ISO8601
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.
currentApplyDate :: Maybe ISO8601
The effective date when the pending maintenance action is applied to the resource.

Instances

Instances details

Eq PendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingMaintenanceAction Methods (==) :: PendingMaintenanceAction -> PendingMaintenanceAction -> Bool # (/=) :: PendingMaintenanceAction -> PendingMaintenanceAction -> Bool #
Read PendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingMaintenanceAction Methods readsPrec :: Int -> ReadS PendingMaintenanceAction # readList :: ReadS [PendingMaintenanceAction] # readPrec :: ReadPrec PendingMaintenanceAction # readListPrec :: ReadPrec [PendingMaintenanceAction] #
Show PendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingMaintenanceAction Methods showsPrec :: Int -> PendingMaintenanceAction -> ShowS # show :: PendingMaintenanceAction -> String # showList :: [PendingMaintenanceAction] -> ShowS #
Generic PendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingMaintenanceAction Associated Types type Rep PendingMaintenanceAction :: Type -> Type # Methods from :: PendingMaintenanceAction -> Rep PendingMaintenanceAction x # to :: Rep PendingMaintenanceAction x -> PendingMaintenanceAction #
NFData PendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingMaintenanceAction Methods rnf :: PendingMaintenanceAction -> () #
Hashable PendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingMaintenanceAction Methods hashWithSalt :: Int -> PendingMaintenanceAction -> Int # hash :: PendingMaintenanceAction -> Int #
FromXML PendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingMaintenanceAction Methods parseXML :: [Node] -> Either String PendingMaintenanceAction #
type Rep PendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingMaintenanceAction type Rep PendingMaintenanceAction = D1 ('MetaData "PendingMaintenanceAction" "Amazonka.DocumentDB.Types.PendingMaintenanceAction" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "PendingMaintenanceAction'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "autoAppliedAfterDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "optInStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "forcedApplyDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "currentApplyDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))))))

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.

pendingMaintenanceAction_autoAppliedAfterDate :: Lens' PendingMaintenanceAction (Maybe UTCTime) Source #

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.

pendingMaintenanceAction_action :: Lens' PendingMaintenanceAction (Maybe Text) Source #

The type of pending maintenance action that is available for the resource.

pendingMaintenanceAction_optInStatus :: Lens' PendingMaintenanceAction (Maybe Text) Source #

Indicates the type of opt-in request that has been received for the resource.

pendingMaintenanceAction_description :: Lens' PendingMaintenanceAction (Maybe Text) Source #

A description providing more detail about the maintenance action.

pendingMaintenanceAction_forcedApplyDate :: Lens' PendingMaintenanceAction (Maybe UTCTime) Source #

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.

pendingMaintenanceAction_currentApplyDate :: Lens' PendingMaintenanceAction (Maybe UTCTime) Source #

The effective date when the pending maintenance action is applied to the resource.

PendingModifiedValues

data PendingModifiedValues Source #

One or more modified settings for an instance. These modified settings have been requested, but haven't been applied yet.

See: newPendingModifiedValues smart constructor.

Constructors

PendingModifiedValues'

Fields

engineVersion :: Maybe Text
Indicates the database engine version.
masterUserPassword :: Maybe Text
Contains the pending or currently in-progress change of the master credentials for the instance.
dbSubnetGroupName :: Maybe Text
The new subnet group for the instance.
iops :: Maybe Int
Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.
dbInstanceClass :: Maybe Text
Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.
licenseModel :: Maybe Text
The license model for the instance.
Valid values: license-included, bring-your-own-license, general-public-license
cACertificateIdentifier :: Maybe Text
Specifies the identifier of the certificate authority (CA) certificate for the DB instance.
dbInstanceIdentifier :: Maybe Text
Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.
pendingCloudwatchLogsExports :: Maybe PendingCloudwatchLogsExports
A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
backupRetentionPeriod :: Maybe Int
Specifies the pending number of days for which automated backups are retained.
multiAZ :: Maybe Bool
Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.
allocatedStorage :: Maybe Int
Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.
port :: Maybe Int
Specifies the pending port for the instance.
storageType :: Maybe Text
Specifies the storage type to be associated with the instance.

Instances

Instances details

Eq PendingModifiedValues Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingModifiedValues Methods (==) :: PendingModifiedValues -> PendingModifiedValues -> Bool # (/=) :: PendingModifiedValues -> PendingModifiedValues -> Bool #
Read PendingModifiedValues Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingModifiedValues Methods readsPrec :: Int -> ReadS PendingModifiedValues # readList :: ReadS [PendingModifiedValues] # readPrec :: ReadPrec PendingModifiedValues # readListPrec :: ReadPrec [PendingModifiedValues] #
Show PendingModifiedValues Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingModifiedValues Methods showsPrec :: Int -> PendingModifiedValues -> ShowS # show :: PendingModifiedValues -> String # showList :: [PendingModifiedValues] -> ShowS #
Generic PendingModifiedValues Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingModifiedValues Associated Types type Rep PendingModifiedValues :: Type -> Type # Methods from :: PendingModifiedValues -> Rep PendingModifiedValues x # to :: Rep PendingModifiedValues x -> PendingModifiedValues #
NFData PendingModifiedValues Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingModifiedValues Methods rnf :: PendingModifiedValues -> () #
Hashable PendingModifiedValues Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingModifiedValues Methods hashWithSalt :: Int -> PendingModifiedValues -> Int # hash :: PendingModifiedValues -> Int #
FromXML PendingModifiedValues Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingModifiedValues Methods parseXML :: [Node] -> Either String PendingModifiedValues #
type Rep PendingModifiedValues Source #
Instance details Defined in Amazonka.DocumentDB.Types.PendingModifiedValues type Rep PendingModifiedValues = D1 ('MetaData "PendingModifiedValues" "Amazonka.DocumentDB.Types.PendingModifiedValues" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "PendingModifiedValues'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "masterUserPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "iops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "licenseModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "cACertificateIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "pendingCloudwatchLogsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PendingCloudwatchLogsExports)) :: S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "multiAZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "allocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

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 - Contains the pending or currently in-progress change of the master credentials for the instance.

$sel:dbSubnetGroupName:PendingModifiedValues', pendingModifiedValues_dbSubnetGroupName - The new subnet group for the instance.

$sel:iops:PendingModifiedValues', pendingModifiedValues_iops - Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.

$sel:dbInstanceClass:PendingModifiedValues', pendingModifiedValues_dbInstanceClass - Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.

$sel:licenseModel:PendingModifiedValues', pendingModifiedValues_licenseModel - The license model for the instance.

Valid values: license-included, bring-your-own-license, general-public-license

$sel:cACertificateIdentifier:PendingModifiedValues', pendingModifiedValues_cACertificateIdentifier - Specifies the identifier of the certificate authority (CA) certificate for the DB instance.

$sel:dbInstanceIdentifier:PendingModifiedValues', pendingModifiedValues_dbInstanceIdentifier - Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.

$sel:pendingCloudwatchLogsExports:PendingModifiedValues', pendingModifiedValues_pendingCloudwatchLogsExports - A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

$sel: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 instance is to change to a Multi-AZ deployment.

$sel:allocatedStorage:PendingModifiedValues', pendingModifiedValues_allocatedStorage - Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.

$sel:port:PendingModifiedValues', pendingModifiedValues_port - Specifies the pending port for the instance.

$sel:storageType:PendingModifiedValues', pendingModifiedValues_storageType - Specifies the storage type to be associated with the instance.

pendingModifiedValues_engineVersion :: Lens' PendingModifiedValues (Maybe Text) Source #

Indicates the database engine version.

pendingModifiedValues_masterUserPassword :: Lens' PendingModifiedValues (Maybe Text) Source #

Contains the pending or currently in-progress change of the master credentials for the instance.

pendingModifiedValues_dbSubnetGroupName :: Lens' PendingModifiedValues (Maybe Text) Source #

The new subnet group for the instance.

pendingModifiedValues_iops :: Lens' PendingModifiedValues (Maybe Int) Source #

Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.

pendingModifiedValues_dbInstanceClass :: Lens' PendingModifiedValues (Maybe Text) Source #

Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.

pendingModifiedValues_licenseModel :: Lens' PendingModifiedValues (Maybe Text) Source #

The license model for the instance.

Valid values: license-included, bring-your-own-license, general-public-license

pendingModifiedValues_cACertificateIdentifier :: Lens' PendingModifiedValues (Maybe Text) Source #

Specifies the identifier of the certificate authority (CA) certificate for the DB instance.

pendingModifiedValues_dbInstanceIdentifier :: Lens' PendingModifiedValues (Maybe Text) Source #

Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.

pendingModifiedValues_pendingCloudwatchLogsExports :: Lens' PendingModifiedValues (Maybe PendingCloudwatchLogsExports) Source #

A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

pendingModifiedValues_backupRetentionPeriod :: Lens' PendingModifiedValues (Maybe Int) Source #

Specifies the pending number of days for which automated backups are retained.

pendingModifiedValues_multiAZ :: Lens' PendingModifiedValues (Maybe Bool) Source #

Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

pendingModifiedValues_allocatedStorage :: Lens' PendingModifiedValues (Maybe Int) Source #

Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.

pendingModifiedValues_port :: Lens' PendingModifiedValues (Maybe Int) Source #

Specifies the pending port for the instance.

pendingModifiedValues_storageType :: Lens' PendingModifiedValues (Maybe Text) Source #

Specifies the storage type to be associated with the instance.

ResourcePendingMaintenanceActions

data ResourcePendingMaintenanceActions Source #

Represents the output of ApplyPendingMaintenanceAction.

See: newResourcePendingMaintenanceActions smart constructor.

Constructors

ResourcePendingMaintenanceActions'
Fields pendingMaintenanceActionDetails :: Maybe [PendingMaintenanceAction] A list that provides details about the pending maintenance actions for the resource. resourceIdentifier :: Maybe Text The Amazon Resource Name (ARN) of the resource that has pending maintenance actions.

Instances

Instances details

Eq ResourcePendingMaintenanceActions Source #
Instance details Defined in Amazonka.DocumentDB.Types.ResourcePendingMaintenanceActions Methods (==) :: ResourcePendingMaintenanceActions -> ResourcePendingMaintenanceActions -> Bool # (/=) :: ResourcePendingMaintenanceActions -> ResourcePendingMaintenanceActions -> Bool #
Read ResourcePendingMaintenanceActions Source #
Instance details Defined in Amazonka.DocumentDB.Types.ResourcePendingMaintenanceActions Methods readsPrec :: Int -> ReadS ResourcePendingMaintenanceActions # readList :: ReadS [ResourcePendingMaintenanceActions] # readPrec :: ReadPrec ResourcePendingMaintenanceActions # readListPrec :: ReadPrec [ResourcePendingMaintenanceActions] #
Show ResourcePendingMaintenanceActions Source #
Instance details Defined in Amazonka.DocumentDB.Types.ResourcePendingMaintenanceActions Methods showsPrec :: Int -> ResourcePendingMaintenanceActions -> ShowS # show :: ResourcePendingMaintenanceActions -> String # showList :: [ResourcePendingMaintenanceActions] -> ShowS #
Generic ResourcePendingMaintenanceActions Source #
Instance details Defined in Amazonka.DocumentDB.Types.ResourcePendingMaintenanceActions Associated Types type Rep ResourcePendingMaintenanceActions :: Type -> Type # Methods from :: ResourcePendingMaintenanceActions -> Rep ResourcePendingMaintenanceActions x # to :: Rep ResourcePendingMaintenanceActions x -> ResourcePendingMaintenanceActions #
NFData ResourcePendingMaintenanceActions Source #
Instance details Defined in Amazonka.DocumentDB.Types.ResourcePendingMaintenanceActions Methods rnf :: ResourcePendingMaintenanceActions -> () #
Hashable ResourcePendingMaintenanceActions Source #
Instance details Defined in Amazonka.DocumentDB.Types.ResourcePendingMaintenanceActions Methods hashWithSalt :: Int -> ResourcePendingMaintenanceActions -> Int # hash :: ResourcePendingMaintenanceActions -> Int #
FromXML ResourcePendingMaintenanceActions Source #
Instance details Defined in Amazonka.DocumentDB.Types.ResourcePendingMaintenanceActions Methods parseXML :: [Node] -> Either String ResourcePendingMaintenanceActions #
type Rep ResourcePendingMaintenanceActions Source #
Instance details Defined in Amazonka.DocumentDB.Types.ResourcePendingMaintenanceActions type Rep ResourcePendingMaintenanceActions = D1 ('MetaData "ResourcePendingMaintenanceActions" "Amazonka.DocumentDB.Types.ResourcePendingMaintenanceActions" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "ResourcePendingMaintenanceActions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pendingMaintenanceActionDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PendingMaintenanceAction])) :*: S1 ('MetaSel ('Just "resourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newResourcePendingMaintenanceActions :: ResourcePendingMaintenanceActions Source #

Create a value of ResourcePendingMaintenanceActions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:pendingMaintenanceActionDetails:ResourcePendingMaintenanceActions', resourcePendingMaintenanceActions_pendingMaintenanceActionDetails - A list that provides details about the pending maintenance actions for the resource.

$sel:resourceIdentifier:ResourcePendingMaintenanceActions', resourcePendingMaintenanceActions_resourceIdentifier - The Amazon Resource Name (ARN) of the resource that has pending maintenance actions.

resourcePendingMaintenanceActions_pendingMaintenanceActionDetails :: Lens' ResourcePendingMaintenanceActions (Maybe [PendingMaintenanceAction]) Source #

A list that provides details about the pending maintenance actions for the resource.

resourcePendingMaintenanceActions_resourceIdentifier :: Lens' ResourcePendingMaintenanceActions (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource that has pending maintenance actions.

Subnet

data Subnet Source #

Detailed information about a subnet.

See: newSubnet smart constructor.

Constructors

Subnet'
Fields subnetStatus :: Maybe Text Specifies the status of the subnet. subnetIdentifier :: Maybe Text Specifies the identifier of the subnet. subnetAvailabilityZone :: Maybe AvailabilityZone Specifies the Availability Zone for the subnet.

Instances

Instances details

Eq Subnet Source #
Instance details Defined in Amazonka.DocumentDB.Types.Subnet Methods (==) :: Subnet -> Subnet -> Bool # (/=) :: Subnet -> Subnet -> Bool #
Read Subnet Source #
Instance details Defined in Amazonka.DocumentDB.Types.Subnet Methods readsPrec :: Int -> ReadS Subnet # readList :: ReadS [Subnet] # readPrec :: ReadPrec Subnet # readListPrec :: ReadPrec [Subnet] #
Show Subnet Source #
Instance details Defined in Amazonka.DocumentDB.Types.Subnet Methods showsPrec :: Int -> Subnet -> ShowS # show :: Subnet -> String # showList :: [Subnet] -> ShowS #
Generic Subnet Source #
Instance details Defined in Amazonka.DocumentDB.Types.Subnet Associated Types type Rep Subnet :: Type -> Type # Methods from :: Subnet -> Rep Subnet x # to :: Rep Subnet x -> Subnet #
NFData Subnet Source #
Instance details Defined in Amazonka.DocumentDB.Types.Subnet Methods rnf :: Subnet -> () #
Hashable Subnet Source #
Instance details Defined in Amazonka.DocumentDB.Types.Subnet Methods hashWithSalt :: Int -> Subnet -> Int # hash :: Subnet -> Int #
FromXML Subnet Source #
Instance details Defined in Amazonka.DocumentDB.Types.Subnet Methods parseXML :: [Node] -> Either String Subnet #
type Rep Subnet Source #
Instance details Defined in Amazonka.DocumentDB.Types.Subnet type Rep Subnet = D1 ('MetaData "Subnet" "Amazonka.DocumentDB.Types.Subnet" "libZSservicesZSamazonka-docdbZSamazonka-docdb" '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)))))

newSubnet :: Subnet Source #

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 Availability Zone for the subnet.

subnet_subnetStatus :: Lens' Subnet (Maybe Text) Source #

Specifies the status of the subnet.

subnet_subnetIdentifier :: Lens' Subnet (Maybe Text) Source #

Specifies the identifier of the subnet.

subnet_subnetAvailabilityZone :: Lens' Subnet (Maybe AvailabilityZone) Source #

Specifies the Availability Zone for the subnet.

Tag

data Tag Source #

Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.

See: newTag smart constructor.

Constructors

Tag'

Fields

value :: Maybe Text
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
key :: Maybe Text
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

Instances

Instances details

Eq Tag Source #
Instance details Defined in Amazonka.DocumentDB.Types.Tag Methods (==) :: Tag -> Tag -> Bool # (/=) :: Tag -> Tag -> Bool #
Read Tag Source #
Instance details Defined in Amazonka.DocumentDB.Types.Tag Methods readsPrec :: Int -> ReadS Tag # readList :: ReadS [Tag] # readPrec :: ReadPrec Tag # readListPrec :: ReadPrec [Tag] #
Show Tag Source #
Instance details Defined in Amazonka.DocumentDB.Types.Tag Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #
Generic Tag Source #
Instance details Defined in Amazonka.DocumentDB.Types.Tag Associated Types type Rep Tag :: Type -> Type # Methods from :: Tag -> Rep Tag x # to :: Rep Tag x -> Tag #
NFData Tag Source #
Instance details Defined in Amazonka.DocumentDB.Types.Tag Methods rnf :: Tag -> () #
Hashable Tag Source #
Instance details Defined in Amazonka.DocumentDB.Types.Tag Methods hashWithSalt :: Int -> Tag -> Int # hash :: Tag -> Int #
ToQuery Tag Source #
Instance details Defined in Amazonka.DocumentDB.Types.Tag Methods toQuery :: Tag -> QueryString #
FromXML Tag Source #
Instance details Defined in Amazonka.DocumentDB.Types.Tag Methods parseXML :: [Node] -> Either String Tag #
type Rep Tag Source #
Instance details Defined in Amazonka.DocumentDB.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.DocumentDB.Types.Tag" "libZSservicesZSamazonka-docdbZSamazonka-docdb" '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))))

newTag :: Tag Source #

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 - The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

$sel:key:Tag', tag_key - The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

tag_value :: Lens' Tag (Maybe Text) Source #

The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

tag_key :: Lens' Tag (Maybe Text) Source #

The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

UpgradeTarget

data UpgradeTarget Source #

The version of the database engine that an instance can be upgraded to.

See: newUpgradeTarget smart constructor.

Constructors

UpgradeTarget'

Fields

engineVersion :: Maybe Text
The version number of the upgrade target database engine.
isMajorVersionUpgrade :: Maybe Bool
A value that indicates whether a database engine is upgraded to a major version.
engine :: Maybe Text
The name of the upgrade target database engine.
autoUpgrade :: Maybe Bool
A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
description :: Maybe Text
The version of the database engine that an instance can be upgraded to.

Instances

Instances details

Eq UpgradeTarget Source #
Instance details Defined in Amazonka.DocumentDB.Types.UpgradeTarget Methods (==) :: UpgradeTarget -> UpgradeTarget -> Bool # (/=) :: UpgradeTarget -> UpgradeTarget -> Bool #
Read UpgradeTarget Source #
Instance details Defined in Amazonka.DocumentDB.Types.UpgradeTarget Methods readsPrec :: Int -> ReadS UpgradeTarget # readList :: ReadS [UpgradeTarget] # readPrec :: ReadPrec UpgradeTarget # readListPrec :: ReadPrec [UpgradeTarget] #
Show UpgradeTarget Source #
Instance details Defined in Amazonka.DocumentDB.Types.UpgradeTarget Methods showsPrec :: Int -> UpgradeTarget -> ShowS # show :: UpgradeTarget -> String # showList :: [UpgradeTarget] -> ShowS #
Generic UpgradeTarget Source #
Instance details Defined in Amazonka.DocumentDB.Types.UpgradeTarget Associated Types type Rep UpgradeTarget :: Type -> Type # Methods from :: UpgradeTarget -> Rep UpgradeTarget x # to :: Rep UpgradeTarget x -> UpgradeTarget #
NFData UpgradeTarget Source #
Instance details Defined in Amazonka.DocumentDB.Types.UpgradeTarget Methods rnf :: UpgradeTarget -> () #
Hashable UpgradeTarget Source #
Instance details Defined in Amazonka.DocumentDB.Types.UpgradeTarget Methods hashWithSalt :: Int -> UpgradeTarget -> Int # hash :: UpgradeTarget -> Int #
FromXML UpgradeTarget Source #
Instance details Defined in Amazonka.DocumentDB.Types.UpgradeTarget Methods parseXML :: [Node] -> Either String UpgradeTarget #
type Rep UpgradeTarget Source #
Instance details Defined in Amazonka.DocumentDB.Types.UpgradeTarget type Rep UpgradeTarget = D1 ('MetaData "UpgradeTarget" "Amazonka.DocumentDB.Types.UpgradeTarget" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "UpgradeTarget'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "isMajorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "autoUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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 an instance can be upgraded to.

upgradeTarget_engineVersion :: Lens' UpgradeTarget (Maybe Text) Source #

The version number of the upgrade target database engine.

upgradeTarget_isMajorVersionUpgrade :: Lens' UpgradeTarget (Maybe Bool) Source #

A value that indicates whether a database engine is upgraded to a major version.

upgradeTarget_engine :: Lens' UpgradeTarget (Maybe Text) Source #

The name of the upgrade target database engine.

upgradeTarget_autoUpgrade :: Lens' UpgradeTarget (Maybe Bool) Source #

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

upgradeTarget_description :: Lens' UpgradeTarget (Maybe Text) Source #

The version of the database engine that an instance can be upgraded to.

VpcSecurityGroupMembership

data VpcSecurityGroupMembership Source #

Used as a response element for queries on virtual private cloud (VPC) security group membership.

See: newVpcSecurityGroupMembership smart constructor.

Constructors

VpcSecurityGroupMembership'
Fields status :: Maybe Text The status of the VPC security group. vpcSecurityGroupId :: Maybe Text The name of the VPC security group.

Instances

Instances details

Eq VpcSecurityGroupMembership Source #
Instance details Defined in Amazonka.DocumentDB.Types.VpcSecurityGroupMembership Methods (==) :: VpcSecurityGroupMembership -> VpcSecurityGroupMembership -> Bool # (/=) :: VpcSecurityGroupMembership -> VpcSecurityGroupMembership -> Bool #
Read VpcSecurityGroupMembership Source #
Instance details Defined in Amazonka.DocumentDB.Types.VpcSecurityGroupMembership Methods readsPrec :: Int -> ReadS VpcSecurityGroupMembership # readList :: ReadS [VpcSecurityGroupMembership] # readPrec :: ReadPrec VpcSecurityGroupMembership # readListPrec :: ReadPrec [VpcSecurityGroupMembership] #
Show VpcSecurityGroupMembership Source #
Instance details Defined in Amazonka.DocumentDB.Types.VpcSecurityGroupMembership Methods showsPrec :: Int -> VpcSecurityGroupMembership -> ShowS # show :: VpcSecurityGroupMembership -> String # showList :: [VpcSecurityGroupMembership] -> ShowS #
Generic VpcSecurityGroupMembership Source #
Instance details Defined in Amazonka.DocumentDB.Types.VpcSecurityGroupMembership Associated Types type Rep VpcSecurityGroupMembership :: Type -> Type # Methods from :: VpcSecurityGroupMembership -> Rep VpcSecurityGroupMembership x # to :: Rep VpcSecurityGroupMembership x -> VpcSecurityGroupMembership #
NFData VpcSecurityGroupMembership Source #
Instance details Defined in Amazonka.DocumentDB.Types.VpcSecurityGroupMembership Methods rnf :: VpcSecurityGroupMembership -> () #
Hashable VpcSecurityGroupMembership Source #
Instance details Defined in Amazonka.DocumentDB.Types.VpcSecurityGroupMembership Methods hashWithSalt :: Int -> VpcSecurityGroupMembership -> Int # hash :: VpcSecurityGroupMembership -> Int #
FromXML VpcSecurityGroupMembership Source #
Instance details Defined in Amazonka.DocumentDB.Types.VpcSecurityGroupMembership Methods parseXML :: [Node] -> Either String VpcSecurityGroupMembership #
type Rep VpcSecurityGroupMembership Source #
Instance details Defined in Amazonka.DocumentDB.Types.VpcSecurityGroupMembership type Rep VpcSecurityGroupMembership = D1 ('MetaData "VpcSecurityGroupMembership" "Amazonka.DocumentDB.Types.VpcSecurityGroupMembership" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "VpcSecurityGroupMembership'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcSecurityGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

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.

vpcSecurityGroupMembership_status :: Lens' VpcSecurityGroupMembership (Maybe Text) Source #

The status of the VPC security group.

vpcSecurityGroupMembership_vpcSecurityGroupId :: Lens' VpcSecurityGroupMembership (Maybe Text) Source #

The name of the VPC security group.